Networking

This section details Networking-related Linode CLI commands.

ip-view 

Returns information about a single IP Address on your Account.

Usage

The format accepted by this command.

linode-cli networking ip-view [-h] [--order-by {}]
    [--order {asc,desc}] address

Sample

Examples of how this command might be used.

linode-cli networking ip-view 97.107.143.141

Parameters

Positional parameters used to define the resource this command should target.

Name	Type	Description
address	str	The address to operate on.

Result Attributes

The attributes returned by this command.

Name	Type	Example	Description
address	str	97.107.143.141	The IP address.
gateway	str	97.107.143.1	The default gateway for this address.
linode_id	int	123	The ID of the Linode this address currently belongs to.
prefix	int	24	The number of bits set in the subnet mask.
public	bool	true	Whether this is a public or private IP address.
rdns	str	test.example.org	The reverse DNS assigned to this address.
region	str	us-east	The Region this IP address resides in.
subnet_mask	str	255.255.255.0	The mask that separates host bits from network bits for this address.
type	str	ipv4	The type of address this is.

vpc_nat_1_1

Name	Type	Example	Description
vpc_nat_1_1.address	str	192.168.0.42	The IPv4 address that is configured as a 1:1 NAT for this VPC interface.
vpc_nat_1_1.subnet_id	int	101	The `id` of the VPC Subnet for this Interface.
vpc_nat_1_1.vpc_id	int	111	The `id` of the VPC configured for this Interface.

ip-add 

Allocates a new IPv4 Address on your Account.

Usage

The format accepted by this command.

linode-cli networking ip-add [-h] [--type type] [--public public]
    [--linode_id linode_id]

Sample

Examples of how this command might be used.

linode-cli networking ip-add \
    --type ipv4 \
    --public true \
    --linode_id 123

Arguments

Additional fields used to execute this request.

Name	Type	Example	Description
--linode_id *	int	123	The ID of a Linode you have access to that this address will be allocated to.
--public *	bool	true	Whether to create a public or private IPv4 address.
--type *	str	ipv4	The type of address you are requesting.

Result Attributes

The attributes returned by this command.

Name	Type	Example	Description
address	str	97.107.143.141	The IP address.
gateway	str	97.107.143.1	The default gateway for this address.
linode_id	int	123	The ID of the Linode this address currently belongs to.
prefix	int	24	The number of bits set in the subnet mask.
public	bool	true	Whether this is a public or private IP address.
rdns	str	test.example.org	The reverse DNS assigned to this address.
region	str	us-east	The Region this IP address resides in.
subnet_mask	str	255.255.255.0	The mask that separates host bits from network bits for this address.
type	str	ipv4	The type of address this is.

vpc_nat_1_1

Name	Type	Example	Description
vpc_nat_1_1.address	str	192.168.0.42	The IPv4 address that is configured as a 1:1 NAT for this VPC interface.
vpc_nat_1_1.subnet_id	int	101	The `id` of the VPC Subnet for this Interface.
vpc_nat_1_1.vpc_id	int	111	The `id` of the VPC configured for this Interface.

ip-update 

Sets RDNS on an IP Address.

Usage

The format accepted by this command.

linode-cli networking ip-update [-h] [--rdns rdns] address

Sample

Examples of how this command might be used.

linode-cli networking ip-update \
    203.0.113.1 \
    --rdns "test.example.org"

Parameters

Positional parameters used to define the resource this command should target.

Name	Type	Description
address	str	The address to operate on.

Arguments

Additional fields used to execute this request.

Name	Type	Example	Description
--rdns *	str	test.example.org	(nullable) The reverse DNS assigned to this address.

Result Attributes

The attributes returned by this command.

Name	Type	Example	Description
address	str	97.107.143.141	The IP address.
gateway	str	97.107.143.1	The default gateway for this address.
linode_id	int	123	The ID of the Linode this address currently belongs to.
prefix	int	24	The number of bits set in the subnet mask.
public	bool	true	Whether this is a public or private IP address.
rdns	str	test.example.org	The reverse DNS assigned to this address.
region	str	us-east	The Region this IP address resides in.
subnet_mask	str	255.255.255.0	The mask that separates host bits from network bits for this address.
type	str	ipv4	The type of address this is.

vpc_nat_1_1

Name	Type	Example	Description
vpc_nat_1_1.address	str	192.168.0.42	The IPv4 address that is configured as a 1:1 NAT for this VPC interface.
vpc_nat_1_1.subnet_id	int	101	The `id` of the VPC Subnet for this Interface.
vpc_nat_1_1.vpc_id	int	111	The `id` of the VPC configured for this Interface.

ip-assign 

Assign multiple IPv4 addresses and/or IPv6 ranges to multiple Linodes in one Region.

Usage

The format accepted by this command.

linode-cli networking ip-assign [-h] [--assignments assignments]
    [--assignments.linode_id linode_id]
    [--assignments.address address] [--region region]

Sample

Examples of how this command might be used.

linode-cli networking ip-assign \
    --region us-east \
    --assignments.address 192.0.2.1 \
    --assignments.linode_id 123 \
    --assignments.address 2001:db8:3c4d:15::/64 \
    --assignments.linode_id 234

Arguments

Additional fields used to execute this request.

Name	Type	Example	Description
--region *	str	us-east	The ID of the Region in which these assignments are to take place.
--assignments (section)	json	N/A	N/A

assignments

Name	Type	Example	Description
--assignments.address *	str	192.0.2.1	The IPv4 address or IPv6 range for this assignment.
--assignments.linode_id *	int	123	The ID of the Linode to assign this address to.

ip-share 

Configure shared IPs.

Usage

The format accepted by this command.

linode-cli networking ip-share [-h] [--ips ips]
    [--linode_id linode_id]

Sample

Examples of how this command might be used.

linode-cli networking ip-share \
    --linode_id 123 \
    --ips 192.0.2.1 \
    --ips 2001:db8:3c4d:15::

Arguments

Additional fields used to execute this request.

Name	Type	Example	Description
--ips *	[]str	192.0.2.1	A list of secondary Linode IPs to share with the primary Linode.
--linode_id *	int	123	The ID of the primary Linode that the addresses will be shared with.

ips-list 

Returns a paginated list of IP addresses on your account, excluding private addresses.

Usage

The format accepted by this command.

linode-cli networking ips-list [-h] [--address address]
    [--region region] [--rdns rdns] [--prefix prefix] [--type type]
    [--order-by {address,region,rdns,prefix,type}]
    [--order {asc,desc}]

Sample

Examples of how this command might be used.

linode-cli networking ips-list

Filterable Attributes

Arguments used to define a filter for response entries.

Name	Type	Description
--address	str	The IP address.
--prefix	int	The number of bits set in the subnet mask.
--rdns	str	The reverse DNS assigned to this address.
--region	str	The Region this IP address resides in.
--type	str	The type of address this is.

Result Attributes

The attributes returned by this command.

Name	Type	Example	Description
address	str	192.0.2.141	The IP address.
gateway	str	192.0.2.1	The default gateway for this address.
linode_id	int	123	The ID of the Linode this address currently belongs to.
prefix	int	24	The number of bits set in the subnet mask.
public	bool	true	Whether this is a public or private IP address.
rdns	str	test.example.org	The reverse DNS assigned to this address.
region	str	us-east	The Region this IP address resides in.
subnet_mask	str	255.255.255.0	The mask that separates host bits from network bits for this address.
type	str	ipv4	The type of address this is.

vpc_nat_1_1

Name	Type	Example	Description
vpc_nat_1_1.address	str	192.168.0.42	The IPv4 address that is configured as a 1:1 NAT for this VPC interface.
vpc_nat_1_1.subnet_id	int	101	The `id` of the VPC Subnet for this Interface.
vpc_nat_1_1.vpc_id	int	111	The `id` of the VPC configured for this Interface.

post-assign-ipv4s 

This operation is equivalent to Assign IP addresses.

Usage

The format accepted by this command.

linode-cli networking post-assign-ipv4s [-h]
    [--assignments assignments] [--assignments.address address]
    [--assignments.linode_id linode_id] [--region region]

Sample

Examples of how this command might be used.

linode-cli networking ip-assign \
    --region us-east \
    --assignments.address 192.0.2.1 \
    --assignments.linode_id 123 \
    --assignments.address 2001:db8:3c4d:15::/64 \
    --assignments.linode_id 234

Arguments

Additional fields used to execute this request.

Name	Type	Example	Description
--region *	str	us-east	The ID of the Region in which these assignments are to take place.
--assignments (section)	json	N/A	N/A

assignments

Name	Type	Example	Description
--assignments.address *	str	192.0.2.1	The IPv4 address or IPv6 range for this assignment.
--assignments.linode_id *	int	123	The ID of the Linode to assign this address to.

post-share-ipv4s 

This operation is equivalent to Share IP addresses.

Usage

The format accepted by this command.

linode-cli networking post-share-ipv4s [-h] [--ips ips]
    [--linode_id linode_id]

Sample

Examples of how this command might be used.

linode-cli networking ip-share \
    --linode_id 123 \
    --ips 192.0.2.1 \
    --ips 192.0.2.2

Arguments

Additional fields used to execute this request.

Name	Type	Example	Description
--ips *	[]str	192.0.2.1	A list of secondary Linode IPs to share with the primary Linode.
--linode_id *	int	123	The ID of the primary Linode that the addresses will be shared with.

v6-pools 

Displays the IPv6 pools on your Account.

Usage

The format accepted by this command.

linode-cli networking v6-pools [-h] [--region region]
    [--order-by {region}] [--order {asc,desc}]

Sample

Examples of how this command might be used.

linode-cli networking v6-pools

Filterable Attributes

Arguments used to define a filter for response entries.

Name	Type	Description
--region	str	The region for this pool of IPv6 addresses.

Result Attributes

The attributes returned by this command.

Name	Type	Example	Description
prefix	int	124	The prefix length of the address.
range	str	2600:3c01::2:5000:0	The IPv6 range of addresses in this pool.
region	str	us-east	The region for this pool of IPv6 addresses.
route_target	str	2600:3c01::2:5000:f	The last address in this block of IPv6 addresses.

v6-range-view 

View IPv6 range information.

Usage

The format accepted by this command.

linode-cli networking v6-range-view [-h] [--order-by {}]
    [--order {asc,desc}] range

Sample

Examples of how this command might be used.

linode-cli networking v6-range-view 2001:0db8::

Parameters

Positional parameters used to define the resource this command should target.

Name	Type	Description
range	str	The IPv6 range to access.

Result Attributes

The attributes returned by this command.

Name	Type	Example	Description
is_bgp	bool	N/A	Whether this IPv6 range is shared.
linodes	[]int	[123]	A list of Linodes targeted by this IPv6 range.
prefix	int	64	The prefix length of the address.
range	str	2600:3c01::	The IPv6 address of this range.
region	str	us-east	The region for this range of IPv6 addresses.

v6-range-create 

Creates an IPv6 Range and assigns it based on the provided Linode or route target IPv6 SLAAC address.

Usage

The format accepted by this command.

linode-cli networking v6-range-create [-h]
    [--prefix_length prefix_length] [--linode_id linode_id]
    [--route_target route_target]

Sample

Examples of how this command might be used.

linode-cli networking v6-range-create \
    --linode_id 123 \
    --prefix_length 64

Arguments

Additional fields used to execute this request.

Name	Type	Example	Description
--prefix_length *	int	N/A	The prefix length of the IPv6 range.
--linode_id	int	123	The ID of the Linode to assign this range to.
--route_target	str	2001:0db8::1	The IPv6 SLAAC address to assign this range to.

Result Attributes

The attributes returned by this command.

Name	Type	Example	Description
range	str	2001:0db8::/64	The IPv6 network range, including subnet and prefix length.
route_target	str	2001:0db8::1	The route target IPV6 SLAAC address for this range.

v6-range-delete 

Removes this IPv6 range from your account and disconnects the range from any assigned Linodes.

Usage

The format accepted by this command.

linode-cli networking v6-range-delete [-h] range

Sample

Examples of how this command might be used.

linode-cli networking v6-range-delete 2001:0db8::

Parameters

Positional parameters used to define the resource this command should target.

Name	Type	Description
range	str	The IPv6 range to access.

v6-ranges 

Displays the IPv6 ranges on your Account.

Usage

The format accepted by this command.

linode-cli networking v6-ranges [-h] [--order-by {}]
    [--order {asc,desc}]

Sample

Examples of how this command might be used.

linode-cli networking v6-ranges

Result Attributes

The attributes returned by this command.

Name	Type	Example	Description
prefix	int	64	The prefix length of the address.
range	str	2600:3c01::	The IPv6 address of this range.
region	str	us-east	The region for this range of IPv6 addresses.
route_target	str	2600:3c01::f…ff:ffff:ffff	The IPv6 SLAAC address.