Private Network Address Translation (Private NAT)¶

The Private NAT client is the command-line interface (CLI) for the Private NAT API.

For help on a specific privatenat command, enter:

$ openstack privatenat help SUBCOMMAND

Private NAT Gateway Operations¶

privatenat gateway create¶

Create new Private NAT Gateway

openstack privatenat gateway create
    --name <name>
    [--description <description>]
    [--spec <spec>]
    [--enterprise-project-id <enterprise_project_id>]
    [--downlink-vpc <virsubnet_id=virsubnet_id[,ngport_ip_address=ip]
    >]
    [--tags <tags>]

--name <name>¶: Specifies the name of the Private NAT Gateway.

--description <description>¶: Provides supplementary information about the Private NAT Gateway.

--spec <spec>¶: Specifies the type of the Private NAT Gateway. The value can be: 1: small type, which supports up to 10,000 SNAT connections. 2: medium type, which supports up to 50,000 SNAT connections. 3: large type, which supports up to 200,000 SNAT connections. 4: extra-large type, which supports up to 1,000,000 SNAT connections.

--enterprise-project-id <enterprise_project_id>¶: Specifies the ID of the enterprise project that is associated with the private NAT gateway when the private NAT gateway is created.

--downlink-vpc <virsubnet_id=virsubnet_id[,ngport_ip_address=ip]>¶: Specifies the VPC where the private NAT gateway works.

--tags <tags>¶: Specifies the tag list in KEY=VALUE format.Repeat for multiple values.

This command is provided by the otcextensions plugin.

privatenat gateway delete¶

Delete Private NAT Gateway

openstack privatenat gateway delete <gateway>

gateway¶: Nat Gateway to delete

This command is provided by the otcextensions plugin.

privatenat gateway list¶

List Private NAT Gateways.

openstack privatenat gateway list
    [--sort-column SORT_COLUMN]
    [--sort-ascending
    |
    --sort-descending
    ]
    [--limit <limit>]
    [--marker <marker>]
    [--page-reverse]
    [--id <id> [<id> ...]]
    [--name <name> [<name> ...]]
    [--description <description> [<description> ...]]
    [--spec <spec> [<spec> ...]]
    [--project-id <project_id> [<project_id> ...]]
    [--status <status> [<status> ...]]
    [--vpc-id <vpc_id> [<vpc_id> ...]]
    [--virsubnet-id <virsubnet_id> [<virsubnet_id> ...]]
    [--enterprise-project-id <enterprise_project_id> [<enterprise_project_id> ...]]

--sort-column SORT_COLUMN¶: specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--sort-ascending¶: sort the column(s) in ascending order

--sort-descending¶: sort the column(s) in descending order

--limit <limit>¶: Specifies the number of records displayed on each page.

--marker <marker>¶: Specifies the start resource ID of pagination query.

--page-reverse¶: Specifies whether to query resources on the previous page.

--id <id>¶: Specifies the private NAT gateway IDs.

--name <name>¶: Specifies the private NAT gateway names.

--description <description>¶: Provides supplementary information about the private NAT gateway.

--spec <spec>¶: Specifies the private NAT gateway specifications.

--project-id <project_id>¶: Specifies the project ID. Repeat for multiple values.

--status <status>¶: Specifies the private NAT gateway status.

--vpc-id <vpc_id>¶: Specifies the ID of the VPC.

--virsubnet-id <virsubnet_id>¶: Specifies the ID of the subnet.

--enterprise-project-id <enterprise_project_id>¶: Specifies the enterprise project ID associated with the private NAT gateway.

This command is provided by the otcextensions plugin.

privatenat gateway show¶

Show Private NAT Gateway details

openstack privatenat gateway show <gateway>

gateway¶: Specifies the private NAT gateway ID.

This command is provided by the otcextensions plugin.

privatenat gateway update¶

Update a Private NAT Gateway.

openstack privatenat gateway update
    [--name <name>]
    [--description <description>]
    [--spec <spec>]
    <gateway>

--name <name>¶: Specifies the name of the Private NAT Gateway.

--description <description>¶: Provides supplementary information about the Private NAT gateway.

--spec <spec>¶: Specifies the type of the Private NAT Gateway.

gateway¶: Specifies the Name or ID of the Private NAT Gateway.

This command is provided by the otcextensions plugin.

Private SNAT Rule Operations¶

privatenat snat rule create¶

Create a private SNAT rule.

openstack privatenat snat rule create
    --gateway-id <gateway_id>
    [--cidr <cidr>]
    [--virsubnet-id <virsubnet_id>]
    [--description <description>]
    --transit-ip-id <transit_ip_id>

--gateway-id <gateway_id>¶: Specifies the private NAT gateway ID.

--cidr <cidr>¶: Specifies the CIDR block that matches the SNAT rule.

--virsubnet-id <virsubnet_id>¶: Specifies the ID of the subnet that matches the SNAT rule.

--description <description>¶: Provides supplementary information about the SNAT rule.

--transit-ip-id <transit_ip_id>¶: Specifies the transit IP address ID. Repeat to associate multiple transit IPs.

This command is provided by the otcextensions plugin.

privatenat snat rule delete¶

Delete a private SNAT rule.

openstack privatenat snat rule delete <snat_rule>

snat_rule¶: Specifies the private SNAT rule ID.

This command is provided by the otcextensions plugin.

privatenat snat rule list¶

List private SNAT rules.

openstack privatenat snat rule list
    [--sort-column SORT_COLUMN]
    [--sort-ascending
    |
    --sort-descending
    ]
    [--id <id>]
    [--limit <limit>]
    [--marker <marker>]
    [--page-reverse]
    [--project-id <project_id>]
    [--description <description>]
    [--gateway-id <gateway_id>]
    [--cidr <cidr>]
    [--virsubnet-id <virsubnet_id>]
    [--transit-ip-id <transit_ip_id>]
    [--transit-ip-address <transit_ip_address>]
    [--enterprise-project-id <enterprise_project_id>]

--sort-column SORT_COLUMN¶: specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--sort-ascending¶: sort the column(s) in ascending order

--sort-descending¶: sort the column(s) in descending order

--id <id>¶: Specifies the SNAT rule ID. Repeat to filter by multiple values.

--limit <limit>¶: Specifies the number of records displayed on each page.

--marker <marker>¶: Specifies the start resource ID of pagination query.

--page-reverse¶: Query resources on the previous page.

--project-id <project_id>¶: Specifies the project ID. Repeat to filter by multiple values.

--description <description>¶: Provides supplementary information about the SNAT rule. Repeat to filter by multiple values.

--gateway-id <gateway_id>¶: Specifies the private NAT gateway ID. Repeat to filter by multiple values.

--cidr <cidr>¶: Specifies the CIDR block that matches the SNAT rule. Repeat to filter by multiple values.

--virsubnet-id <virsubnet_id>¶: Specifies the subnet ID that matches the SNAT rule. Repeat to filter by multiple values.

--transit-ip-id <transit_ip_id>¶: Specifies the transit IP address ID. Repeat to filter by multiple values.

--transit-ip-address <transit_ip_address>¶: Specifies the transit IP address. Repeat to filter by multiple values.

--enterprise-project-id <enterprise_project_id>¶: Specifies the enterprise project ID. Repeat to filter by multiple values.

This command is provided by the otcextensions plugin.

privatenat snat rule show¶

Show private SNAT rule details.

openstack privatenat snat rule show <snat_rule>

snat_rule¶: Specifies the private SNAT rule ID.

This command is provided by the otcextensions plugin.

privatenat snat rule update¶

Update a private SNAT rule.

openstack privatenat snat rule update
    [--description <description>]
    [--transit-ip-id <transit_ip_id>]
    <snat_rule>

--description <description>¶: Provides supplementary information about the SNAT rule.

--transit-ip-id <transit_ip_id>¶: Specifies the transit IP address ID. Repeat to associate multiple transit IPs.

snat_rule¶: Specifies the private SNAT rule ID.

This command is provided by the otcextensions plugin.

Private Transit IP Address Operations¶

privatenat transit ip create¶

Assign a private transit IP address.

openstack privatenat transit ip create
    --virsubnet-id <virsubnet_id>
    [--ip-address <ip_address>]
    [--enterprise-project-id <enterprise_project_id>]
    [--tags <tags>]

--virsubnet-id <virsubnet_id>¶: Specifies the subnet ID of the current project.

--ip-address <ip_address>¶: Specifies the transit IP address.

--enterprise-project-id <enterprise_project_id>¶: Specifies the enterprise project ID associated with the transit IP address.

--tags <tags>¶: Specifies the tag list in KEY=VALUE format. Repeat for multiple values.

This command is provided by the otcextensions plugin.

privatenat transit ip delete¶

Delete a private transit IP address.

openstack privatenat transit ip delete <transit_ip>

transit_ip¶: Specifies the transit IP address ID.

This command is provided by the otcextensions plugin.

privatenat transit ip list¶

List private transit IP addresses.

openstack privatenat transit ip list
    [--sort-column SORT_COLUMN]
    [--sort-ascending
    |
    --sort-descending
    ]
    [--id <id>]
    [--project-id <project_id>]
    [--network-interface-id <network_interface_id>]
    [--ip-address <ip_address>]
    [--limit <limit>]
    [--marker <marker>]
    [--page-reverse]
    [--virsubnet-id <virsubnet_id>]
    [--transit-subnet-id <transit_subnet_id>]
    [--gateway-id <gateway_id>]
    [--enterprise-project-id <enterprise_project_id>]
    [--description <description>]

--sort-column SORT_COLUMN¶: specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--sort-ascending¶: sort the column(s) in ascending order

--sort-descending¶: sort the column(s) in descending order

--id <id>¶: Specifies the transit IP address ID. Repeat to filter by multiple values.

--project-id <project_id>¶: Specifies the project ID. Repeat to filter by multiple values.

--network-interface-id <network_interface_id>¶: Specifies the network interface ID of the transit IP address. Repeat to filter by multiple values.

--ip-address <ip_address>¶: Specifies the transit IP address. Repeat to filter by multiple values.

--limit <limit>¶: Specifies the number of records displayed on each page.

--marker <marker>¶: Specifies the start resource ID of pagination query.

--page-reverse¶: Query resources on the previous page.

--virsubnet-id <virsubnet_id>¶: Specifies the subnet ID of the current VPC. Repeat to filter by multiple values.

--transit-subnet-id <transit_subnet_id>¶: Specifies the subnet ID of the transit VPC. Repeat to filter by multiple values.

--gateway-id <gateway_id>¶: Specifies the private NAT gateway ID. Repeat to filter by multiple values.

--enterprise-project-id <enterprise_project_id>¶: Specifies the enterprise project ID. Repeat to filter by multiple values.

--description <description>¶: Provides supplementary information about the transit IP address. Repeat to filter by multiple values.

This command is provided by the otcextensions plugin.

privatenat transit ip show¶

Show private transit IP address details.

openstack privatenat transit ip show <transit_ip>

transit_ip¶: Specifies the transit IP address ID.

This command is provided by the otcextensions plugin.

last updated: UTC - commit: