Skip to content

Commit dbcff27

Browse files
bbiggerrbbiggerr
authored
Merge pull request #704 from bbiggerr/ipv4-assign-to-ips-assign
Redirect Linodes Assign IPv4s to IP Addresses Assign
2 parents af85f82 + 6573789 commit dbcff27

File tree

1 file changed

+84
-95
lines changed

1 file changed

+84
-95
lines changed

‎openapi.yaml

Lines changed: 84 additions & 95 deletions
Original file line numberDiff line numberDiff line change
@@ -12983,18 +12983,20 @@ paths:
1298312983
x-linode-grant: read_write
1298412984
tags:
1298512985
- Networking
12986-
summary: Linodes Assign IPs
12986+
summary: IP Addresses Assign
1298712987
description: |
12988-
Assign multiple IPv4 addresses and/or IPv6 ranges to multiple Linodes in one Region. This allows
12989-
swapping, shuffling, or otherwise reorganizing IPs to your Linodes.
12988+
Assign multiple IPv4 addresses and/or IPv6 ranges to multiple Linodes in one Region. This allows swapping, shuffling, or otherwise reorganizing IPs to your Linodes.
1299012989

1299112990
The following restrictions apply:
1299212991
* All Linodes involved must have at least one public IPv4 address after assignment.
1299312992
* Linodes may have no more than one assigned private IPv4 address.
1299412993
* Linodes may have no more than one assigned IPv6 range.
12995-
* [Open a Support Ticket](/docs/api/support/#support-ticket-open) to request additional IPv4 addresses or IPv6 ranges.
1299612994

12997-
**Note**: Removing an IP address that has been set as a Managed Linode's `ssh.ip` causes the Managed Linode's SSH access settings to reset to their default values. To view and configure Managed Linode SSH settings, use the **Linode's Managed Settings View** ([GET /managed/linode-settings/{linodeId}](/docs/api/managed/#linodes-managed-settings-view)) and **Linode's Managed Settings Update** ([PUT /managed/linode-settings/{linodeId}](/docs/api/managed/#linodes-managed-settings-update)) commands.
12995+
[Open a Support Ticket](/docs/api/support/#support-ticket-open) to request additional IPv4 addresses or IPv6 ranges beyond standard account limits.
12996+
12997+
**Note**: Removing an IP address that has been set as a Managed Linode's `ssh.ip` causes the Managed Linode's SSH access settings to reset to their default values. To view and configure Managed Linode SSH settings, use the following commands:
12998+
* **Linode's Managed Settings View** ([GET /managed/linode-settings/{linodeId}](/docs/api/managed/#linodes-managed-settings-view))
12999+
* **Linode's Managed Settings Update** ([PUT /managed/linode-settings/{linodeId}](/docs/api/managed/#linodes-managed-settings-update))
1299813000
operationId: assignIPs
1299913001
x-linode-cli-action: ip-assign
1300013002
security:
@@ -13009,46 +13011,7 @@ paths:
1300913011
content:
1301013012
application/json:
1301113013
schema:
13012-
required:
13013-
- region
13014-
- assignments
13015-
properties:
13016-
region:
13017-
type: string
13018-
description: >
13019-
The ID of the Region in which these assignments are to take
13020-
place. All IPs and Linodes must exist in this Region.
13021-
example: us-east
13022-
assignments:
13023-
type: array
13024-
description: >
13025-
The list of assignments to make. You must have read_write
13026-
access to all IPs being assigned and all Linodes being
13027-
assigned to in order for the assignments to succeed.
13028-
required:
13029-
- address
13030-
- linode_id
13031-
items:
13032-
type: object
13033-
properties:
13034-
address:
13035-
type: string
13036-
format: ipv4|ipv6/prefix_length
13037-
description: |
13038-
The IPv4 address or IPv6 range for this assignment.
13039-
* Must be an IPv4 address or an IPv6 range you can access in the Region specified.
13040-
* IPv6 ranges must include a prefix length of `/56` or `/64`, for example: `2001:db8:3c4d:15::/64`.
13041-
* Assignment of an IPv6 range to a Linode updates the route target of the range to the assigned Linode's SLAAC address.
13042-
* May be a public or private address.
13043-
example: 12.34.56.78
13044-
linode_id:
13045-
type: integer
13046-
description: >
13047-
The ID of the Linode to assign this address to. The IP's
13048-
previous Linode will lose this address, and must end up
13049-
with at least one public address and no more than one
13050-
private address once all assignments have been made.
13051-
example: 123
13014+
$ref: "#/components/schemas/IPAddressesAssignRequest"
1305213015
responses:
1305313016
'200':
1305413017
description: All assignments completed successfully.
@@ -13067,7 +13030,7 @@ paths:
1306713030
"region": "us-east",
1306813031
"assignments": [
1306913032
{
13070-
"address": "12.34.56.100",
13033+
"address": "192.0.2.1",
1307113034
"linode_id": 123
1307213035
},
1307313036
{
@@ -13081,8 +13044,10 @@ paths:
1308113044
source: >
1308213045
linode-cli networking ip-assign \
1308313046
--region us-east \
13047+
--assignments.address 192.0.2.1 \
13048+
--assignments.linode_id 123 \
1308413049
--assignments.address 2001:db8:3c4d:15::/64 \
13085-
--assignments.linode_id 123
13050+
--assignments.linode_id 234
1308613051
/networking/ips/share:
1308713052
x-linode-cli-command: networking
1308813053
post:
@@ -13148,13 +13113,21 @@ paths:
1314813113
tags:
1314913114
- Networking
1315013115
summary: Linodes Assign IPv4s
13151-
description: >
13152-
Assign multiple IPv4s to multiple Linodes in one Region. This allows
13153-
swapping, shuffling, or otherwise reorganizing IPv4 Addresses to your
13154-
Linodes. When the assignment is finished, all Linodes must end up with
13155-
at least one public IPv4 and no more than one private IPv4.
13116+
description: |
13117+
This command is equivalent to **IP Addresses Assign** ([POST /networking/ips/assign](#ip-addresses-assign)).
13118+
13119+
Assign multiple IPv4 addresses and/or IPv6 ranges to multiple Linodes in one Region. This allows swapping, shuffling, or otherwise reorganizing IPs to your Linodes.
13120+
13121+
The following restrictions apply:
13122+
* All Linodes involved must have at least one public IPv4 address after assignment.
13123+
* Linodes may have no more than one assigned private IPv4 address.
13124+
* Linodes may have no more than one assigned IPv6 range.
1315613125

13157-
To assign IPv6 ranges or to use the CLI, see the Linodes Assign IPs ([POST /networking/ips/assign](/docs/api/networking/#linodes-assign-ips)) command.
13126+
[Open a Support Ticket](/docs/api/support/#support-ticket-open) to request additional IPv4 addresses or IPv6 ranges beyond standard account limits.
13127+
13128+
**Note**: Removing an IP address that has been set as a Managed Linode's `ssh.ip` causes the Managed Linode's SSH access settings to reset to their default values. To view and configure Managed Linode SSH settings, use the following commands:
13129+
* **Linode's Managed Settings View** ([GET /managed/linode-settings/{linodeId}](/docs/api/managed/#linodes-managed-settings-view))
13130+
* **Linode's Managed Settings Update** ([PUT /managed/linode-settings/{linodeId}](/docs/api/managed/#linodes-managed-settings-update))
1315813131
operationId: assignIPv4s
1315913132
x-linode-cli-skip: true
1316013133
security:
@@ -13169,44 +13142,7 @@ paths:
1316913142
content:
1317013143
application/json:
1317113144
schema:
13172-
required:
13173-
- region
13174-
- assignments
13175-
properties:
13176-
region:
13177-
type: string
13178-
description: >
13179-
The ID of the Region in which these assignments are to take
13180-
place. All IPs and Linodes must exist in this Region.
13181-
example: us-east
13182-
assignments:
13183-
type: array
13184-
description: >
13185-
The list of assignments to make. You must have read_write
13186-
access to all IPs being assigned and all Linodes being
13187-
assigned to in order for the assignments to succeed.
13188-
required:
13189-
- address
13190-
- linode_id
13191-
items:
13192-
type: object
13193-
properties:
13194-
address:
13195-
type: string
13196-
format: ip
13197-
description: >
13198-
Ths IP Address for this assignment. Must be a IPv4
13199-
address you can access in the Region specified. May
13200-
be a public or private address.
13201-
example: 12.34.56.78
13202-
linode_id:
13203-
type: integer
13204-
description: >
13205-
The ID of the Linode to assign this address to. The IP's
13206-
previous Linode will lose this address, and must end up
13207-
with at least one public address and no more than one
13208-
private address once all assignments have been made.
13209-
example: 123
13145+
$ref: "#/components/schemas/IPAddressesAssignRequest"
1321013146
responses:
1321113147
'200':
1321213148
description: All assignments completed successfully.
@@ -13225,16 +13161,24 @@ paths:
1322513161
"region": "us-east",
1322613162
"assignments": [
1322713163
{
13228-
"address": "12.34.56.100",
13164+
"address": "192.0.2.1",
1322913165
"linode_id": 123
1323013166
},
1323113167
{
13232-
"address": "23.45.67.200",
13168+
"address": "2001:db8:3c4d:15::/64",
1323313169
"linode_id": 234
1323413170
}
1323513171
]
1323613172
}' \
1323713173
https://api.linode.com/v4/networking/ipv4/assign
13174+
- lang: CLI
13175+
source: >
13176+
linode-cli networking ip-assign \
13177+
--region us-east \
13178+
--assignments.address 192.0.2.1 \
13179+
--assignments.linode_id 123 \
13180+
--assignments.address 2001:db8:3c4d:15::/64 \
13181+
--assignments.linode_id 234
1323813182
/networking/ipv4/share:
1323913183
x-linode-cli-command: networking
1324013184
post:
@@ -13243,7 +13187,9 @@ paths:
1324313187
- Networking
1324413188
summary: IPv4 Sharing Configure
1324513189
description: |
13246-
Configure shared IPs. This command is equivalent to **IP Addresses Share** ([POST /networking/ips/share](#ip-addresses-share)).
13190+
This command is equivalent to **IP Addresses Share** ([POST /networking/ips/share](#ip-addresses-share)).
13191+
13192+
Configure shared IPs.
1324713193

1324813194
IP sharing allows IP address reassignment (also referred to as IP failover) from one Linode to another if the primary Linode becomes unresponsive. This means that requests to the primary Linode's IP address can be automatically rerouted to secondary Linodes at the configured shared IP addresses.
1324913195

@@ -13399,7 +13345,7 @@ paths:
1339913345
* `linode_id` and `route_target` are mutually exclusive. Submitting values for both properties in a request results in an error.
1340013346
* Upon a successful request, an IPv6 range is created in the [Region](/docs/api/regions/#regions-list) that corresponds to the provided `linode_id` or `route_target`.
1340113347
* Your Linode is responsible for routing individual addresses in the range, or handling traffic for all the addresses in the range.
13402-
* Access the Linodes Assign IPs ([POST /networking/ips/assign](/docs/api/networking/#linodes-assign-ips)) endpoint to re-assign IPv6 Ranges to your Linodes.
13348+
* Access the IP Addresses Assign ([POST /networking/ips/assign](/docs/api/networking/#ip-addresses-assign)) endpoint to re-assign IPv6 Ranges to your Linodes.
1340313349

1340413350
**Note**: The following restrictions apply:
1340513351
* A Linode can only have one IPv6 range targeting its SLAAC address.
@@ -22240,6 +22186,49 @@ components:
2224022186
readOnly: true
2224122187
x-linode-filterable: true
2224222188
x-linode-cli-display: 5
22189+
IPAddressesAssignRequest:
22190+
type: object
22191+
description: Request object for IP Addresses Assign (POST /networking/ips/assign).
22192+
required:
22193+
- region
22194+
- assignments
22195+
properties:
22196+
region:
22197+
type: string
22198+
description: >
22199+
The ID of the Region in which these assignments are to take
22200+
place. All IPs and Linodes must exist in this Region.
22201+
example: us-east
22202+
assignments:
22203+
type: array
22204+
description: >
22205+
The list of assignments to make. You must have read_write
22206+
access to all IPs being assigned and all Linodes being
22207+
assigned to in order for the assignments to succeed.
22208+
required:
22209+
- address
22210+
- linode_id
22211+
items:
22212+
type: object
22213+
properties:
22214+
address:
22215+
type: string
22216+
format: ipv4|ipv6/prefix_length
22217+
description: |
22218+
The IPv4 address or IPv6 range for this assignment.
22219+
* Must be an IPv4 address or an IPv6 range you can access in the Region specified.
22220+
* IPv6 ranges must include a prefix length of `/56` or `/64`, for example: `2001:db8:3c4d:15::/64`.
22221+
* Assignment of an IPv6 range to a Linode updates the route target of the range to the assigned Linode's SLAAC address.
22222+
* May be a public or private address.
22223+
example: 192.0.2.1
22224+
linode_id:
22225+
type: integer
22226+
description: >
22227+
The ID of the Linode to assign this address to. The IP's
22228+
previous Linode will lose this address, and must end up
22229+
with at least one public address and no more than one
22230+
private address once all assignments have been made.
22231+
example: 123
2224322232
IPAddressesShareRequest:
2224422233
type: object
2224522234
description: A request object IP Addresses Share (POST /networking/ips/share)

0 commit comments

Comments
 (0)