Networking service command-line client¶

neutron address-scope-create¶

usage: neutron address-scope-create [-h]
                                    [-f {html,json,shell,table,value,yaml}]
                                    [-c COLUMN] [--max-width <integer>]
                                    [--noindent] [--prefix PREFIX]
                                    [--request-format {json}]
                                    [--tenant-id TENANT_ID] [--shared]
                                    NAME IP_VERSION

Create an address scope for a given tenant.

Positional arguments:

NAME

Specify the name of the address scope.

IP_VERSION

Specify the address family of the address scope.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json}

DEPRECATED! Only JSON request format is supported.

--tenant-id TENANT_ID

The owner tenant ID.

--shared

Set the address scope as shared.

neutron address-scope-delete¶

usage: neutron address-scope-delete [-h] [--request-format {json}]
                                    ADDRESS_SCOPE

Delete an address scope.

Positional arguments:

ADDRESS_SCOPE

ID or name of address_scope to delete.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json}

DEPRECATED! Only JSON request format is supported.

neutron address-scope-list¶

usage: neutron address-scope-list [-h] [-f {csv,html,json,table,value,yaml}]
                                  [-c COLUMN] [--max-width <integer>]
                                  [--noindent]
                                  [--quote {all,minimal,none,nonnumeric}]
                                  [--request-format {json}] [-D] [-F FIELD]
                                  [-P SIZE] [--sort-key FIELD]
                                  [--sort-dir {asc,desc}]

List address scopes that belong to a given tenant.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json}

DEPRECATED! Only JSON request format is supported.

-D, --show-details

Show detailed information.

-F FIELD, --field FIELD

Specify the field(s) to be returned by server. You can repeat this option.

-P SIZE, --page-size SIZE

Specify retrieve unit of each request, then split one request to several requests.

--sort-key FIELD

Sorts the list by the specified fields in the specified directions. You can repeat this option, but you must specify an equal number of sort_dir and sort_key values. Extra sort_dir options are ignored. Missing sort_dir options use the default asc value.

--sort-dir {asc,desc}

Sorts the list in the specified direction. You can repeat this option.

neutron address-scope-show¶

usage: neutron address-scope-show [-h] [-f {html,json,shell,table,value,yaml}]
                                  [-c COLUMN] [--max-width <integer>]
                                  [--noindent] [--prefix PREFIX]
                                  [--request-format {json}] [-D] [-F FIELD]
                                  ADDRESS_SCOPE

Show information about an address scope.

Positional arguments:

ADDRESS_SCOPE

ID or name of address_scope to look up.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json}

DEPRECATED! Only JSON request format is supported.

-D, --show-details

Show detailed information.

-F FIELD, --field FIELD

Specify the field(s) to be returned by server. You can repeat this option.

neutron address-scope-update¶

usage: neutron address-scope-update [-h] [--request-format {json}]
                                    [--name NAME]
                                    ADDRESS_SCOPE

Update an address scope.

Positional arguments:

ADDRESS_SCOPE

ID or name of address_scope to update.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json}

DEPRECATED! Only JSON request format is supported.

--name NAME

Name of the address scope to update.

neutron agent-delete¶

usage: neutron agent-delete [-h] [--request-format {json}] AGENT

Delete a given agent.

Positional arguments:

AGENT

ID of agent to delete.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json}

DEPRECATED! Only JSON request format is supported.

neutron agent-list¶

usage: neutron agent-list [-h] [-f {csv,html,json,table,value,yaml}]
                          [-c COLUMN] [--max-width <integer>] [--noindent]
                          [--quote {all,minimal,none,nonnumeric}]
                          [--request-format {json}] [-D] [-F FIELD]
                          [--sort-key FIELD] [--sort-dir {asc,desc}]

List agents.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json}

DEPRECATED! Only JSON request format is supported.

-D, --show-details

Show detailed information.

-F FIELD, --field FIELD

Specify the field(s) to be returned by server. You can repeat this option.

--sort-key FIELD

Sorts the list by the specified fields in the specified directions. You can repeat this option, but you must specify an equal number of sort_dir and sort_key values. Extra sort_dir options are ignored. Missing sort_dir options use the default asc value.

--sort-dir {asc,desc}

Sorts the list in the specified direction. You can repeat this option.

neutron agent-show¶

usage: neutron agent-show [-h] [-f {html,json,shell,table,value,yaml}]
                          [-c COLUMN] [--max-width <integer>] [--noindent]
                          [--prefix PREFIX] [--request-format {json}] [-D]
                          [-F FIELD]
                          AGENT

Show information of a given agent.

Positional arguments:

AGENT

ID of agent to look up.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json}

DEPRECATED! Only JSON request format is supported.

-D, --show-details

Show detailed information.

-F FIELD, --field FIELD

Specify the field(s) to be returned by server. You can repeat this option.

neutron agent-update¶

usage: neutron agent-update [-h] [--request-format {json}]
                            [--admin-state-down] [--description DESCRIPTION]
                            AGENT

Updates the admin status and description for a specified agent.

Positional arguments:

AGENT

ID of agent to update.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json}

DEPRECATED! Only JSON request format is supported.

--admin-state-down

Set admin state up of the agent to false.

--description DESCRIPTION

Description for the agent.

neutron auto-allocated-topology-show¶

usage: neutron auto-allocated-topology-show [-h]
                                            [-f {html,json,shell,table,value,yaml}]
                                            [-c COLUMN]
                                            [--max-width <integer>]
                                            [--noindent] [--prefix PREFIX]
                                            [--request-format {json}]
                                            [--dry-run]
                                            [--tenant-id tenant-id]

Show the auto-allocated topology of a given tenant.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json}

DEPRECATED! Only JSON request format is supported.

--dry-run

Validate the requirements for auto-allocated-topology. (Does not return a topology.)

--tenant-id

tenant-id The owner tenant ID.

neutron availability-zone-list¶

usage: neutron availability-zone-list [-h]
                                      [-f {csv,html,json,table,value,yaml}]
                                      [-c COLUMN] [--max-width <integer>]
                                      [--noindent]
                                      [--quote {all,minimal,none,nonnumeric}]
                                      [--request-format {json}] [-D]
                                      [-F FIELD] [-P SIZE] [--sort-key FIELD]
                                      [--sort-dir {asc,desc}]

List availability zones.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json}

DEPRECATED! Only JSON request format is supported.

-D, --show-details

Show detailed information.

-F FIELD, --field FIELD

Specify the field(s) to be returned by server. You can repeat this option.

-P SIZE, --page-size SIZE

Specify retrieve unit of each request, then split one request to several requests.

--sort-key FIELD

Sorts the list by the specified fields in the specified directions. You can repeat this option, but you must specify an equal number of sort_dir and sort_key values. Extra sort_dir options are ignored. Missing sort_dir options use the default asc value.

--sort-dir {asc,desc}

Sorts the list in the specified direction. You can repeat this option.

neutron bgp-dragent-list-hosting-speaker¶

usage: neutron bgp-dragent-list-hosting-speaker [-h]
                                                [-f {csv,html,json,table,value,yaml}]
                                                [-c COLUMN]
                                                [--max-width <integer>]
                                                [--noindent]
                                                [--quote {all,minimal,none,nonnumeric}]
                                                [--request-format {json}] [-D]
                                                [-F FIELD]
                                                BGP_SPEAKER

List Dynamic Routing agents hosting a BGP speaker.

Positional arguments:

BGP_SPEAKER

ID or name of the BGP speaker.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json}

DEPRECATED! Only JSON request format is supported.

-D, --show-details

Show detailed information.

-F FIELD, --field FIELD

Specify the field(s) to be returned by server. You can repeat this option.

neutron bgp-dragent-speaker-add¶

usage: neutron bgp-dragent-speaker-add [-h] [--request-format {json}]
                                       BGP_DRAGENT_ID BGP_SPEAKER

Add a BGP speaker to a Dynamic Routing agent.

Positional arguments:

BGP_DRAGENT_ID

ID of the Dynamic Routing agent.

BGP_SPEAKER

ID or name of the BGP speaker.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json}

DEPRECATED! Only JSON request format is supported.

neutron bgp-dragent-speaker-remove¶

usage: neutron bgp-dragent-speaker-remove [-h] [--request-format {json}]
                                          BGP_DRAGENT_ID BGP_SPEAKER

Removes a BGP speaker from a Dynamic Routing agent.

Positional arguments:

BGP_DRAGENT_ID

ID of the Dynamic Routing agent.

BGP_SPEAKER

ID or name of the BGP speaker.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json}

DEPRECATED! Only JSON request format is supported.

neutron bgp-peer-create¶

usage: neutron bgp-peer-create [-h] [-f {html,json,shell,table,value,yaml}]
                               [-c COLUMN] [--max-width <integer>]
                               [--noindent] [--prefix PREFIX]
                               [--request-format {json}]
                               [--tenant-id TENANT_ID] --peer-ip
                               PEER_IP_ADDRESS --remote-as PEER_REMOTE_AS
                               [--auth-type PEER_AUTH_TYPE]
                               [--password AUTH_PASSWORD]
                               NAME

Create a BGP Peer.

Positional arguments:

NAME

Name of the BGP peer to create.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json}

DEPRECATED! Only JSON request format is supported.

--tenant-id TENANT_ID

The owner tenant ID.

--peer-ip PEER_IP_ADDRESS

Peer IP address.

--remote-as PEER_REMOTE_AS

Peer AS number. (Integer in [1, 65535] is allowed.)

--auth-type PEER_AUTH_TYPE

Authentication algorithm. Supported algorithms: none(default), md5

--password AUTH_PASSWORD

Authentication password.

neutron bgp-peer-delete¶

usage: neutron bgp-peer-delete [-h] [--request-format {json}] BGP_PEER

Delete a BGP peer.

Positional arguments:

BGP_PEER

ID or name of bgp_peer to delete.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json}

DEPRECATED! Only JSON request format is supported.

neutron bgp-peer-list¶

usage: neutron bgp-peer-list [-h] [-f {csv,html,json,table,value,yaml}]
                             [-c COLUMN] [--max-width <integer>] [--noindent]
                             [--quote {all,minimal,none,nonnumeric}]
                             [--request-format {json}] [-D] [-F FIELD]
                             [-P SIZE] [--sort-key FIELD]
                             [--sort-dir {asc,desc}]

List BGP peers.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json}

DEPRECATED! Only JSON request format is supported.

-D, --show-details

Show detailed information.

-F FIELD, --field FIELD

Specify the field(s) to be returned by server. You can repeat this option.

-P SIZE, --page-size SIZE

Specify retrieve unit of each request, then split one request to several requests.

--sort-key FIELD

Sorts the list by the specified fields in the specified directions. You can repeat this option, but you must specify an equal number of sort_dir and sort_key values. Extra sort_dir options are ignored. Missing sort_dir options use the default asc value.

--sort-dir {asc,desc}

Sorts the list in the specified direction. You can repeat this option.

neutron bgp-peer-show¶

usage: neutron bgp-peer-show [-h] [-f {html,json,shell,table,value,yaml}]
                             [-c COLUMN] [--max-width <integer>] [--noindent]
                             [--prefix PREFIX] [--request-format {json}] [-D]
                             [-F FIELD]
                             BGP_PEER

Show information of a given BGP peer.

Positional arguments:

BGP_PEER

ID or name of bgp_peer to look up.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json}

DEPRECATED! Only JSON request format is supported.

-D, --show-details

Show detailed information.

-F FIELD, --field FIELD

Specify the field(s) to be returned by server. You can repeat this option.

neutron bgp-peer-update¶

usage: neutron bgp-peer-update [-h] [--request-format {json}] [--name NAME]
                               [--password AUTH_PASSWORD]
                               BGP_PEER

Update BGP Peer’s information.

Positional arguments:

BGP_PEER

ID or name of bgp_peer to update.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json}

DEPRECATED! Only JSON request format is supported.

--name NAME

Updated name of the BGP peer.

--password AUTH_PASSWORD

Updated authentication password.

neutron bgp-speaker-advertiseroute-list¶

usage: neutron bgp-speaker-advertiseroute-list [-h]
                                               [-f {csv,html,json,table,value,yaml}]
                                               [-c COLUMN]
                                               [--max-width <integer>]
                                               [--noindent]
                                               [--quote {all,minimal,none,nonnumeric}]
                                               [--request-format {json}] [-D]
                                               [-F FIELD] [-P SIZE]
                                               [--sort-key FIELD]
                                               [--sort-dir {asc,desc}]
                                               BGP_SPEAKER

List routes advertised by a given BGP speaker.

Positional arguments:

BGP_SPEAKER

ID or name of the BGP speaker.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json}

DEPRECATED! Only JSON request format is supported.

-D, --show-details

Show detailed information.

-F FIELD, --field FIELD

Specify the field(s) to be returned by server. You can repeat this option.

-P SIZE, --page-size SIZE

Specify retrieve unit of each request, then split one request to several requests.

--sort-key FIELD

Sorts the list by the specified fields in the specified directions. You can repeat this option, but you must specify an equal number of sort_dir and sort_key values. Extra sort_dir options are ignored. Missing sort_dir options use the default asc value.

--sort-dir {asc,desc}

Sorts the list in the specified direction. You can repeat this option.

neutron bgp-speaker-create¶

usage: neutron bgp-speaker-create [-h] [-f {html,json,shell,table,value,yaml}]
                                  [-c COLUMN] [--max-width <integer>]
                                  [--noindent] [--prefix PREFIX]
                                  [--request-format {json}]
                                  [--tenant-id TENANT_ID] --local-as LOCAL_AS
                                  [--ip-version {4,6}]
                                  [--advertise-floating-ip-host-routes {True,False}]
                                  [--advertise-tenant-networks {True,False}]
                                  NAME

Create a BGP Speaker.

Positional arguments:

NAME

Name of the BGP speaker to create.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json}

DEPRECATED! Only JSON request format is supported.

--tenant-id TENANT_ID

The owner tenant ID.

--local-as LOCAL_AS

Local AS number. (Integer in [1, 65535] is allowed.)

--ip-version {4,6} IP

version for the BGP speaker (default is 4).

--advertise-floating-ip-host-routes {True,False}

Whether to enable or disable the advertisement of floating-ip host routes by the BGP speaker. By default floating ip host routes will be advertised by the BGP speaker.

--advertise-tenant-networks {True,False}

Whether to enable or disable the advertisement of tenant network routes by the BGP speaker. By default tenant network routes will be advertised by the BGP speaker.

neutron bgp-speaker-delete¶

usage: neutron bgp-speaker-delete [-h] [--request-format {json}] BGP_SPEAKER

Delete a BGP speaker.

Positional arguments:

BGP_SPEAKER

ID or name of bgp_speaker to delete.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json}

DEPRECATED! Only JSON request format is supported.

neutron bgp-speaker-list¶

usage: neutron bgp-speaker-list [-h] [-f {csv,html,json,table,value,yaml}]
                                [-c COLUMN] [--max-width <integer>]
                                [--noindent]
                                [--quote {all,minimal,none,nonnumeric}]
                                [--request-format {json}] [-D] [-F FIELD]
                                [-P SIZE] [--sort-key FIELD]
                                [--sort-dir {asc,desc}]

List BGP speakers.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json}

DEPRECATED! Only JSON request format is supported.

-D, --show-details

Show detailed information.

-F FIELD, --field FIELD

Specify the field(s) to be returned by server. You can repeat this option.

-P SIZE, --page-size SIZE

Specify retrieve unit of each request, then split one request to several requests.

--sort-key FIELD

Sorts the list by the specified fields in the specified directions. You can repeat this option, but you must specify an equal number of sort_dir and sort_key values. Extra sort_dir options are ignored. Missing sort_dir options use the default asc value.

--sort-dir {asc,desc}

Sorts the list in the specified direction. You can repeat this option.

neutron bgp-speaker-list-on-dragent¶

usage: neutron bgp-speaker-list-on-dragent [-h]
                                           [-f {csv,html,json,table,value,yaml}]
                                           [-c COLUMN] [--max-width <integer>]
                                           [--noindent]
                                           [--quote {all,minimal,none,nonnumeric}]
                                           [--request-format {json}] [-D]
                                           [-F FIELD]
                                           BGP_DRAGENT_ID

List BGP speakers hosted by a Dynamic Routing agent.

Positional arguments:

BGP_DRAGENT_ID

ID of the Dynamic Routing agent.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json}

DEPRECATED! Only JSON request format is supported.

-D, --show-details

Show detailed information.

-F FIELD, --field FIELD

Specify the field(s) to be returned by server. You can repeat this option.

neutron bgp-speaker-network-add¶

usage: neutron bgp-speaker-network-add [-h] [--request-format {json}]
                                       BGP_SPEAKER NETWORK

Add a network to the BGP speaker.

Positional arguments:

BGP_SPEAKER

ID or name of the BGP speaker.

NETWORK

ID or name of the network to add.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json}

DEPRECATED! Only JSON request format is supported.

neutron bgp-speaker-network-remove¶

usage: neutron bgp-speaker-network-remove [-h] [--request-format {json}]
                                          BGP_SPEAKER NETWORK

Remove a network from the BGP speaker.

Positional arguments:

BGP_SPEAKER

ID or name of the BGP speaker.

NETWORK

ID or name of the network to remove.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json}

DEPRECATED! Only JSON request format is supported.

neutron bgp-speaker-peer-add¶

usage: neutron bgp-speaker-peer-add [-h] [--request-format {json}]
                                    BGP_SPEAKER BGP_PEER

Add a peer to the BGP speaker.

Positional arguments:

BGP_SPEAKER

ID or name of the BGP speaker.

BGP_PEER

ID or name of the BGP peer to add.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json}

DEPRECATED! Only JSON request format is supported.

neutron bgp-speaker-peer-remove¶

usage: neutron bgp-speaker-peer-remove [-h] [--request-format {json}]
                                       BGP_SPEAKER BGP_PEER

Remove a peer from the BGP speaker.

Positional arguments:

BGP_SPEAKER

ID or name of the BGP speaker.

BGP_PEER

ID or name of the BGP peer to remove.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json}

DEPRECATED! Only JSON request format is supported.

neutron bgp-speaker-show¶

usage: neutron bgp-speaker-show [-h] [-f {html,json,shell,table,value,yaml}]
                                [-c COLUMN] [--max-width <integer>]
                                [--noindent] [--prefix PREFIX]
                                [--request-format {json}] [-D] [-F FIELD]
                                BGP_SPEAKER

Show information of a given BGP speaker.

Positional arguments:

BGP_SPEAKER

ID or name of bgp_speaker to look up.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json}

DEPRECATED! Only JSON request format is supported.

-D, --show-details

Show detailed information.

-F FIELD, --field FIELD

Specify the field(s) to be returned by server. You can repeat this option.

neutron bgp-speaker-update¶

usage: neutron bgp-speaker-update [-h] [--request-format {json}] [--name NAME]
                                  [--advertise-floating-ip-host-routes {True,False}]
                                  [--advertise-tenant-networks {True,False}]
                                  BGP_SPEAKER

Update BGP Speaker’s information.

Positional arguments:

BGP_SPEAKER

ID or name of bgp_speaker to update.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json}

DEPRECATED! Only JSON request format is supported.

--name NAME

Name of the BGP speaker to update.

--advertise-floating-ip-host-routes {True,False}

Whether to enable or disable the advertisement of floating-ip host routes by the BGP speaker. By default floating ip host routes will be advertised by the BGP speaker.

--advertise-tenant-networks {True,False}

Whether to enable or disable the advertisement of tenant network routes by the BGP speaker. By default tenant network routes will be advertised by the BGP speaker.

neutron dhcp-agent-list-hosting-net¶

usage: neutron dhcp-agent-list-hosting-net [-h]
                                           [-f {csv,html,json,table,value,yaml}]
                                           [-c COLUMN] [--max-width <integer>]
                                           [--noindent]
                                           [--quote {all,minimal,none,nonnumeric}]
                                           [--request-format {json}] [-D]
                                           [-F FIELD]
                                           NETWORK

List DHCP agents hosting a network.

Positional arguments:

NETWORK

Network to query.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json}

DEPRECATED! Only JSON request format is supported.

-D, --show-details

Show detailed information.

-F FIELD, --field FIELD

Specify the field(s) to be returned by server. You can repeat this option.

neutron dhcp-agent-network-add¶

usage: neutron dhcp-agent-network-add [-h] [--request-format {json}]
                                      DHCP_AGENT NETWORK

Add a network to a DHCP agent.

Positional arguments:

DHCP_AGENT

ID of the DHCP agent.

NETWORK

Network to add.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json}

DEPRECATED! Only JSON request format is supported.

neutron dhcp-agent-network-remove¶

usage: neutron dhcp-agent-network-remove [-h] [--request-format {json}]
                                         DHCP_AGENT NETWORK

Remove a network from a DHCP agent.

Positional arguments:

DHCP_AGENT

ID of the DHCP agent.

NETWORK

Network to remove.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json}

DEPRECATED! Only JSON request format is supported.

neutron ext-list¶

usage: neutron ext-list [-h] [-f {csv,html,json,table,value,yaml}] [-c COLUMN]
                        [--max-width <integer>] [--noindent]
                        [--quote {all,minimal,none,nonnumeric}]
                        [--request-format {json}] [-D] [-F FIELD]

List all extensions.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json}

DEPRECATED! Only JSON request format is supported.

-D, --show-details

Show detailed information.

-F FIELD, --field FIELD

Specify the field(s) to be returned by server. You can repeat this option.

neutron ext-show¶

usage: neutron ext-show [-h] [-f {html,json,shell,table,value,yaml}]
                        [-c COLUMN] [--max-width <integer>] [--noindent]
                        [--prefix PREFIX] [--request-format {json}] [-D]
                        [-F FIELD]
                        EXTENSION

Show information of a given resource.

Positional arguments:

EXTENSION

ID of extension to look up.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json}

DEPRECATED! Only JSON request format is supported.

-D, --show-details

Show detailed information.

-F FIELD, --field FIELD

Specify the field(s) to be returned by server. You can repeat this option.

neutron firewall-create¶

usage: neutron firewall-create [-h] [-f {html,json,shell,table,value,yaml}]
                               [-c COLUMN] [--max-width <integer>]
                               [--noindent] [--prefix PREFIX]
                               [--request-format {json}]
                               [--tenant-id TENANT_ID] [--name NAME]
                               [--description DESCRIPTION]
                               [--router ROUTER | --no-routers]
                               [--admin-state-down]
                               POLICY

Create a firewall.

Positional arguments:

POLICY

Firewall policy name or ID.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json}

DEPRECATED! Only JSON request format is supported.

--tenant-id TENANT_ID

The owner tenant ID.

--name NAME

Name for the firewall.

--description DESCRIPTION

Description for the firewall.

--router ROUTER

Firewall associated router name or ID (requires FWaaS router insertion extension, this option can be repeated)

--no-routers

Associate no routers with the firewall (requires FWaaS router insertion extension)

--admin-state-down

Set admin state up to false.

neutron firewall-delete¶

usage: neutron firewall-delete [-h] [--request-format {json}] FIREWALL

Delete a given firewall.

Positional arguments:

FIREWALL

ID or name of firewall to delete.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json}

DEPRECATED! Only JSON request format is supported.

neutron firewall-list¶

usage: neutron firewall-list [-h] [-f {csv,html,json,table,value,yaml}]
                             [-c COLUMN] [--max-width <integer>] [--noindent]
                             [--quote {all,minimal,none,nonnumeric}]
                             [--request-format {json}] [-D] [-F FIELD]
                             [-P SIZE] [--sort-key FIELD]
                             [--sort-dir {asc,desc}]

List firewalls that belong to a given tenant.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json}

DEPRECATED! Only JSON request format is supported.

-D, --show-details

Show detailed information.

-F FIELD, --field FIELD

Specify the field(s) to be returned by server. You can repeat this option.

-P SIZE, --page-size SIZE

Specify retrieve unit of each request, then split one request to several requests.

--sort-key FIELD

Sorts the list by the specified fields in the specified directions. You can repeat this option, but you must specify an equal number of sort_dir and sort_key values. Extra sort_dir options are ignored. Missing sort_dir options use the default asc value.

--sort-dir {asc,desc}

Sorts the list in the specified direction. You can repeat this option.

neutron firewall-policy-create¶

usage: neutron firewall-policy-create [-h]
                                      [-f {html,json,shell,table,value,yaml}]
                                      [-c COLUMN] [--max-width <integer>]
                                      [--noindent] [--prefix PREFIX]
                                      [--request-format {json}]
                                      [--tenant-id TENANT_ID] [--shared]
                                      [--audited] [--description DESCRIPTION]
                                      [--firewall-rules FIREWALL_RULES]
                                      NAME

Create a firewall policy.

Positional arguments:

NAME

Name for the firewall policy.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json}

DEPRECATED! Only JSON request format is supported.

--tenant-id TENANT_ID

The owner tenant ID.

--shared

Create a shared policy.

--audited

Sets audited to True.

--description DESCRIPTION

Description for the firewall policy.

--firewall-rules FIREWALL_RULES

Ordered list of whitespace-delimited firewall rule names or IDs; e.g., --firewall-rules “rule1 rule2”

neutron firewall-policy-delete¶

usage: neutron firewall-policy-delete [-h] [--request-format {json}]
                                      FIREWALL_POLICY

Delete a given firewall policy.

Positional arguments:

FIREWALL_POLICY

ID or name of firewall_policy to delete.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json}

DEPRECATED! Only JSON request format is supported.

neutron firewall-policy-insert-rule¶

usage: neutron firewall-policy-insert-rule [-h] [--request-format {json}]
                                           [--insert-before FIREWALL_RULE]
                                           [--insert-after FIREWALL_RULE]
                                           FIREWALL_POLICY FIREWALL_RULE

Insert a rule into a given firewall policy.

Positional arguments:

FIREWALL_POLICY

ID or name of firewall_policy to update.

FIREWALL_RULE

New rule to insert.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json}

DEPRECATED! Only JSON request format is supported.

--insert-before FIREWALL_RULE

Insert before this rule.

--insert-after FIREWALL_RULE

Insert after this rule.

neutron firewall-policy-list¶

usage: neutron firewall-policy-list [-h] [-f {csv,html,json,table,value,yaml}]
                                    [-c COLUMN] [--max-width <integer>]
                                    [--noindent]
                                    [--quote {all,minimal,none,nonnumeric}]
                                    [--request-format {json}] [-D] [-F FIELD]
                                    [-P SIZE] [--sort-key FIELD]
                                    [--sort-dir {asc,desc}]

List firewall policies that belong to a given tenant.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json}

DEPRECATED! Only JSON request format is supported.

-D, --show-details

Show detailed information.

-F FIELD, --field FIELD

Specify the field(s) to be returned by server. You can repeat this option.

-P SIZE, --page-size SIZE

Specify retrieve unit of each request, then split one request to several requests.

--sort-key FIELD

Sorts the list by the specified fields in the specified directions. You can repeat this option, but you must specify an equal number of sort_dir and sort_key values. Extra sort_dir options are ignored. Missing sort_dir options use the default asc value.

--sort-dir {asc,desc}

Sorts the list in the specified direction. You can repeat this option.

neutron firewall-policy-remove-rule¶

usage: neutron firewall-policy-remove-rule [-h] [--request-format {json}]
                                           FIREWALL_POLICY FIREWALL_RULE

Remove a rule from a given firewall policy.

Positional arguments:

FIREWALL_POLICY

ID or name of firewall_policy to update.

FIREWALL_RULE

Firewall rule to remove from policy.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json}

DEPRECATED! Only JSON request format is supported.

neutron firewall-policy-show¶

usage: neutron firewall-policy-show [-h]
                                    [-f {html,json,shell,table,value,yaml}]
                                    [-c COLUMN] [--max-width <integer>]
                                    [--noindent] [--prefix PREFIX]
                                    [--request-format {json}] [-D] [-F FIELD]
                                    FIREWALL_POLICY

Show information of a given firewall policy.

Positional arguments:

FIREWALL_POLICY

ID or name of firewall_policy to look up.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json}

DEPRECATED! Only JSON request format is supported.

-D, --show-details

Show detailed information.

-F FIELD, --field FIELD

Specify the field(s) to be returned by server. You can repeat this option.

neutron firewall-policy-update¶

usage: neutron firewall-policy-update [-h] [--request-format {json}]
                                      [--description DESCRIPTION]
                                      [--firewall-rules FIREWALL_RULES]
                                      [--name NAME] [--shared {True,False}]
                                      [--audited {True,False}]
                                      FIREWALL_POLICY

Update a given firewall policy.

Positional arguments:

FIREWALL_POLICY

ID or name of firewall_policy to update.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json}

DEPRECATED! Only JSON request format is supported.

--description DESCRIPTION

Description for the firewall policy.

--firewall-rules FIREWALL_RULES

Ordered list of whitespace-delimited firewall rule names or IDs; e.g., --firewall-rules “rule1 rule2”

--name NAME

Name for the firewall policy.

--shared {True,False}

Update the sharing status of the policy. (True means shared)

--audited {True,False}

Update the audit status of the policy. (True means auditing is enabled)

neutron firewall-rule-create¶

usage: neutron firewall-rule-create [-h]
                                    [-f {html,json,shell,table,value,yaml}]
                                    [-c COLUMN] [--max-width <integer>]
                                    [--noindent] [--prefix PREFIX]
                                    [--request-format {json}]
                                    [--tenant-id TENANT_ID] [--shared]
                                    [--name NAME] [--description DESCRIPTION]
                                    [--source-ip-address SOURCE_IP_ADDRESS]
                                    [--destination-ip-address DESTINATION_IP_ADDRESS]
                                    [--source-port SOURCE_PORT]
                                    [--destination-port DESTINATION_PORT]
                                    [--enabled {True,False}] --protocol
                                    {tcp,udp,icmp,any} --action
                                    {allow,deny,reject} [--ip-version {4,6}]

Create a firewall rule.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json}

DEPRECATED! Only JSON request format is supported.

--tenant-id TENANT_ID

The owner tenant ID.

--shared

Set shared flag for the firewall rule.

--name NAME

Name for the firewall rule.

--description DESCRIPTION

Description for the firewall rule.

--source-ip-address SOURCE_IP_ADDRESS

Source IP address or subnet.

--destination-ip-address DESTINATION_IP_ADDRESS

Destination IP address or subnet.

--source-port SOURCE_PORT

Source port (integer in [1, 65535] or range in a:b).

--destination-port DESTINATION_PORT

Destination port (integer in [1, 65535] or range in a:b).

--enabled {True,False}

Whether to enable or disable this rule.

--protocol {tcp,udp,icmp,any}

Protocol for the firewall rule.

--action {allow,deny,reject}

Action for the firewall rule.

--ip-version {4,6} IP

version for the firewall rule (default is 4).

neutron firewall-rule-delete¶

usage: neutron firewall-rule-delete [-h] [--request-format {json}]
                                    FIREWALL_RULE

Delete a given firewall rule.

Positional arguments:

FIREWALL_RULE

ID or name of firewall_rule to delete.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json}

DEPRECATED! Only JSON request format is supported.

neutron firewall-rule-list¶

usage: neutron firewall-rule-list [-h] [-f {csv,html,json,table,value,yaml}]
                                  [-c COLUMN] [--max-width <integer>]
                                  [--noindent]
                                  [--quote {all,minimal,none,nonnumeric}]
                                  [--request-format {json}] [-D] [-F FIELD]
                                  [-P SIZE] [--sort-key FIELD]
                                  [--sort-dir {asc,desc}]

List firewall rules that belong to a given tenant.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json}

DEPRECATED! Only JSON request format is supported.

-D, --show-details

Show detailed information.

-F FIELD, --field FIELD

Specify the field(s) to be returned by server. You can repeat this option.

-P SIZE, --page-size SIZE

Specify retrieve unit of each request, then split one request to several requests.

--sort-key FIELD

Sorts the list by the specified fields in the specified directions. You can repeat this option, but you must specify an equal number of sort_dir and sort_key values. Extra sort_dir options are ignored. Missing sort_dir options use the default asc value.

--sort-dir {asc,desc}

Sorts the list in the specified direction. You can repeat this option.

neutron firewall-rule-show¶

usage: neutron firewall-rule-show [-h] [-f {html,json,shell,table,value,yaml}]
                                  [-c COLUMN] [--max-width <integer>]
                                  [--noindent] [--prefix PREFIX]
                                  [--request-format {json}] [-D] [-F FIELD]
                                  FIREWALL_RULE

Show information of a given firewall rule.

Positional arguments:

FIREWALL_RULE

ID or name of firewall_rule to look up.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json}

DEPRECATED! Only JSON request format is supported.

-D, --show-details

Show detailed information.

-F FIELD, --field FIELD

Specify the field(s) to be returned by server. You can repeat this option.

neutron firewall-rule-update¶

usage: neutron firewall-rule-update [-h] [--request-format {json}]
                                    [--shared {True,False}]
                                    [--ip-version {4,6}] [--name NAME]
                                    [--description DESCRIPTION]
                                    [--source-ip-address SOURCE_IP_ADDRESS]
                                    [--destination-ip-address DESTINATION_IP_ADDRESS]
                                    [--source-port SOURCE_PORT]
                                    [--destination-port DESTINATION_PORT]
                                    [--enabled {True,False}]
                                    [--protocol {tcp,udp,icmp,any}]
                                    [--action {allow,deny,reject}]
                                    FIREWALL_RULE

Update a given firewall rule.

Positional arguments:

FIREWALL_RULE

ID or name of firewall_rule to update.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json}

DEPRECATED! Only JSON request format is supported.

--shared {True,False}

Update the shared flag for the firewall rule.

--ip-version {4,6}

Update IP version for the firewall rule.

--name NAME

Name for the firewall rule.

--description DESCRIPTION

Description for the firewall rule.

--source-ip-address SOURCE_IP_ADDRESS

Source IP address or subnet.

--destination-ip-address DESTINATION_IP_ADDRESS

Destination IP address or subnet.

--source-port SOURCE_PORT

Source port (integer in [1, 65535] or range in a:b).

--destination-port DESTINATION_PORT

Destination port (integer in [1, 65535] or range in a:b).

--enabled {True,False}

Whether to enable or disable this rule.

--protocol {tcp,udp,icmp,any}

Protocol for the firewall rule.

--action {allow,deny,reject}

Action for the firewall rule.

neutron firewall-show¶

usage: neutron firewall-show [-h] [-f {html,json,shell,table,value,yaml}]
                             [-c COLUMN] [--max-width <integer>] [--noindent]
                             [--prefix PREFIX] [--request-format {json}] [-D]
                             [-F FIELD]
                             FIREWALL

Show information of a given firewall.

Positional arguments:

FIREWALL

ID or name of firewall to look up.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json}

DEPRECATED! Only JSON request format is supported.

-D, --show-details

Show detailed information.

-F FIELD, --field FIELD

Specify the field(s) to be returned by server. You can repeat this option.

neutron firewall-update¶

usage: neutron firewall-update [-h] [--request-format {json}] [--name NAME]
                               [--description DESCRIPTION]
                               [--router ROUTER | --no-routers]
                               [--policy POLICY]
                               [--admin-state-up {True,False}]
                               FIREWALL

Update a given firewall.

Positional arguments:

FIREWALL

ID or name of firewall to update.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json}

DEPRECATED! Only JSON request format is supported.

--name NAME

Name for the firewall.

--description DESCRIPTION

Description for the firewall.

--router ROUTER

Firewall associated router name or ID (requires FWaaS router insertion extension, this option can be repeated)

--no-routers

Associate no routers with the firewall (requires FWaaS router insertion extension)

--policy POLICY

Firewall policy name or ID.

--admin-state-up {True,False}

Update the admin state for the firewall(True means UP)

neutron flavor-associate¶

usage: neutron flavor-associate [-h] [--request-format {json}]
                                FLAVOR FLAVOR_PROFILE

Associate a Neutron service flavor with a flavor profile.

Positional arguments:

FLAVOR

Name or ID of the flavor to associate.

FLAVOR_PROFILE

ID of the flavor profile to be associated with the flavor.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json}

DEPRECATED! Only JSON request format is supported.

neutron flavor-create¶

usage: neutron flavor-create [-h] [-f {html,json,shell,table,value,yaml}]
                             [-c COLUMN] [--max-width <integer>] [--noindent]
                             [--prefix PREFIX] [--request-format {json}]
                             [--tenant-id TENANT_ID]
                             [--description DESCRIPTION]
                             [--enabled {True,False}]
                             NAME SERVICE_TYPE

Create a Neutron service flavor.

Positional arguments:

NAME

Name for the flavor.

SERVICE_TYPE

Service type to which the flavor applies to: e.g. VPN. (See service-provider-list for loaded examples.)

Optional arguments:

-h, --help

show this help message and exit

--request-format {json}

DEPRECATED! Only JSON request format is supported.

--tenant-id TENANT_ID

The owner tenant ID.

--description DESCRIPTION

Description for the flavor.

--enabled {True,False}

Sets enabled flag.

neutron flavor-delete¶

usage: neutron flavor-delete [-h] [--request-format {json}] FLAVOR

Delete a given Neutron service flavor.

Positional arguments:

FLAVOR

ID or name of flavor to delete.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json}

DEPRECATED! Only JSON request format is supported.

neutron flavor-disassociate¶

usage: neutron flavor-disassociate [-h] [--request-format {json}]
                                   FLAVOR FLAVOR_PROFILE

Disassociate a Neutron service flavor from a flavor profile.

Positional arguments:

FLAVOR

Name or ID of the flavor.

FLAVOR_PROFILE

ID of the flavor profile to be disassociated from the flavor.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json}

DEPRECATED! Only JSON request format is supported.

neutron flavor-list¶

usage: neutron flavor-list [-h] [-f {csv,html,json,table,value,yaml}]
                           [-c COLUMN] [--max-width <integer>] [--noindent]
                           [--quote {all,minimal,none,nonnumeric}]
                           [--request-format {json}] [-D] [-F FIELD] [-P SIZE]
                           [--sort-key FIELD] [--sort-dir {asc,desc}]

List Neutron service flavors.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json}

DEPRECATED! Only JSON request format is supported.

-D, --show-details

Show detailed information.

-F FIELD, --field FIELD

Specify the field(s) to be returned by server. You can repeat this option.

-P SIZE, --page-size SIZE

Specify retrieve unit of each request, then split one request to several requests.

--sort-key FIELD

Sorts the list by the specified fields in the specified directions. You can repeat this option, but you must specify an equal number of sort_dir and sort_key values. Extra sort_dir options are ignored. Missing sort_dir options use the default asc value.

--sort-dir {asc,desc}

Sorts the list in the specified direction. You can repeat this option.

neutron flavor-profile-create¶

usage: neutron flavor-profile-create [-h]
                                     [-f {html,json,shell,table,value,yaml}]
                                     [-c COLUMN] [--max-width <integer>]
                                     [--noindent] [--prefix PREFIX]
                                     [--request-format {json}]
                                     [--tenant-id TENANT_ID]
                                     [--description DESCRIPTION]
                                     [--driver DRIVER] [--metainfo METAINFO]
                                     [--enabled {True,False}]

Create a Neutron service flavor profile.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json}

DEPRECATED! Only JSON request format is supported.

--tenant-id TENANT_ID

The owner tenant ID.

--description DESCRIPTION

Description for the flavor profile.

--driver DRIVER

Python module path to driver.

--metainfo METAINFO

Metainfo for the flavor profile.

--enabled {True,False}

Sets enabled flag.

neutron flavor-profile-delete¶

usage: neutron flavor-profile-delete [-h] [--request-format {json}]
                                     SERVICE_PROFILE

Delete a given Neutron service flavor profile.

Positional arguments:

SERVICE_PROFILE

ID or name of service_profile to delete.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json}

DEPRECATED! Only JSON request format is supported.

neutron flavor-profile-list¶

usage: neutron flavor-profile-list [-h] [-f {csv,html,json,table,value,yaml}]
                                   [-c COLUMN] [--max-width <integer>]
                                   [--noindent]
                                   [--quote {all,minimal,none,nonnumeric}]
                                   [--request-format {json}] [-D] [-F FIELD]
                                   [-P SIZE] [--sort-key FIELD]
                                   [--sort-dir {asc,desc}]

List Neutron service flavor profiles.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json}

DEPRECATED! Only JSON request format is supported.

-D, --show-details

Show detailed information.

-F FIELD, --field FIELD

Specify the field(s) to be returned by server. You can repeat this option.

-P SIZE, --page-size SIZE

Specify retrieve unit of each request, then split one request to several requests.

--sort-key FIELD

Sorts the list by the specified fields in the specified directions. You can repeat this option, but you must specify an equal number of sort_dir and sort_key values. Extra sort_dir options are ignored. Missing sort_dir options use the default asc value.

--sort-dir {asc,desc}

Sorts the list in the specified direction. You can repeat this option.

neutron flavor-profile-show¶

usage: neutron flavor-profile-show [-h]
                                   [-f {html,json,shell,table,value,yaml}]
                                   [-c COLUMN] [--max-width <integer>]
                                   [--noindent] [--prefix PREFIX]
                                   [--request-format {json}] [-D] [-F FIELD]
                                   SERVICE_PROFILE

Show information about a given Neutron service flavor profile.

Positional arguments:

SERVICE_PROFILE

ID or name of service_profile to look up.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json}

DEPRECATED! Only JSON request format is supported.

-D, --show-details

Show detailed information.

-F FIELD, --field FIELD

Specify the field(s) to be returned by server. You can repeat this option.

neutron flavor-profile-update¶

usage: neutron flavor-profile-update [-h] [--request-format {json}]
                                     [--description DESCRIPTION]
                                     [--driver DRIVER] [--metainfo METAINFO]
                                     [--enabled {True,False}]
                                     SERVICE_PROFILE

Update a given Neutron service flavor profile.

Positional arguments:

SERVICE_PROFILE

ID or name of service_profile to update.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json}

DEPRECATED! Only JSON request format is supported.

--description DESCRIPTION

Description for the flavor profile.

--driver DRIVER

Python module path to driver.

--metainfo METAINFO

Metainfo for the flavor profile.

--enabled {True,False}

Sets enabled flag.

neutron flavor-show¶

usage: neutron flavor-show [-h] [-f {html,json,shell,table,value,yaml}]
                           [-c COLUMN] [--max-width <integer>] [--noindent]
                           [--prefix PREFIX] [--request-format {json}] [-D]
                           [-F FIELD]
                           FLAVOR

Show information about a given Neutron service flavor.

Positional arguments:

FLAVOR

ID or name of flavor to look up.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json}

DEPRECATED! Only JSON request format is supported.

-D, --show-details

Show detailed information.

-F FIELD, --field FIELD

Specify the field(s) to be returned by server. You can repeat this option.

neutron flavor-update¶

usage: neutron flavor-update [-h] [--request-format {json}] [--name NAME]
                             [--description DESCRIPTION]
                             [--enabled {True,False}]
                             FLAVOR

Update a Neutron service flavor.

Positional arguments:

FLAVOR

ID or name of flavor to update.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json}

DEPRECATED! Only JSON request format is supported.

--name NAME

Name for the flavor.

--description DESCRIPTION

Description for the flavor.

--enabled {True,False}

Sets enabled flag.

neutron floatingip-associate¶

usage: neutron floatingip-associate [-h] [--request-format {json}]
                                    [--fixed-ip-address FIXED_IP_ADDRESS]
                                    FLOATINGIP_ID PORT

Create a mapping between a floating IP and a fixed IP.

Positional arguments:

FLOATINGIP_ID

ID of the floating IP to associate.

PORT

ID or name of the port to be associated with the floating IP.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json}

DEPRECATED! Only JSON request format is supported.

--fixed-ip-address FIXED_IP_ADDRESS

IP address on the port (only required if port has multiple IPs).

neutron floatingip-create¶

usage: neutron floatingip-create [-h] [-f {html,json,shell,table,value,yaml}]
                                 [-c COLUMN] [--max-width <integer>]
                                 [--noindent] [--prefix PREFIX]
                                 [--request-format {json}]
                                 [--tenant-id TENANT_ID]
                                 [--description DESCRIPTION]
                                 [--port-id PORT_ID]
                                 [--fixed-ip-address FIXED_IP_ADDRESS]
                                 [--floating-ip-address FLOATING_IP_ADDRESS]
                                 [--subnet SUBNET_ID]
                                 [--dns-domain DNS_DOMAIN]
                                 [--dns-name DNS_NAME]
                                 FLOATING_NETWORK

Create a floating IP for a given tenant.

Positional arguments:

FLOATING_NETWORK

Network name or ID to allocate floating IP from.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json}

DEPRECATED! Only JSON request format is supported.

--tenant-id TENANT_ID

The owner tenant ID.

--description DESCRIPTION

Description of the floating IP.

--port-id PORT_ID

ID of the port to be associated with the floating IP.

--fixed-ip-address FIXED_IP_ADDRESS

IP address on the port (only required if port has multiple IPs).

--floating-ip-address FLOATING_IP_ADDRESS

IP address of the floating IP

--subnet SUBNET_ID

Subnet ID on which you want to create the floating IP.

--dns-domain DNS_DOMAIN

Assign DNS domain to the floatingip (requires DNS integration extension)

--dns-name DNS_NAME

Assign DNS name to the floatingip (requires DNS integration extension)

neutron floatingip-delete¶

usage: neutron floatingip-delete [-h] [--request-format {json}] FLOATINGIP

Delete a given floating IP.

Positional arguments:

FLOATINGIP

ID of floatingip to delete.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json}

DEPRECATED! Only JSON request format is supported.

neutron floatingip-disassociate¶

usage: neutron floatingip-disassociate [-h] [--request-format {json}]
                                       FLOATINGIP_ID

Remove a mapping from a floating IP to a fixed IP.

Positional arguments:

FLOATINGIP_ID

ID of the floating IP to disassociate.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json}

DEPRECATED! Only JSON request format is supported.

neutron floatingip-list¶

usage: neutron floatingip-list [-h] [-f {csv,html,json,table,value,yaml}]
                               [-c COLUMN] [--max-width <integer>]
                               [--noindent]
                               [--quote {all,minimal,none,nonnumeric}]
                               [--request-format {json}] [-D] [-F FIELD]
                               [-P SIZE] [--sort-key FIELD]
                               [--sort-dir {asc,desc}]

List floating IPs that belong to a given tenant.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json}

DEPRECATED! Only JSON request format is supported.

-D, --show-details

Show detailed information.

-F FIELD, --field FIELD

Specify the field(s) to be returned by server. You can repeat this option.

-P SIZE, --page-size SIZE

Specify retrieve unit of each request, then split one request to several requests.

--sort-key FIELD

Sorts the list by the specified fields in the specified directions. You can repeat this option, but you must specify an equal number of sort_dir and sort_key values. Extra sort_dir options are ignored. Missing sort_dir options use the default asc value.

--sort-dir {asc,desc}

Sorts the list in the specified direction. You can repeat this option.

neutron floatingip-show¶

usage: neutron floatingip-show [-h] [-f {html,json,shell,table,value,yaml}]
                               [-c COLUMN] [--max-width <integer>]
                               [--noindent] [--prefix PREFIX]
                               [--request-format {json}] [-D] [-F FIELD]
                               FLOATINGIP

Show information of a given floating IP.

Positional arguments:

FLOATINGIP

ID of floatingip to look up.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json}

DEPRECATED! Only JSON request format is supported.

-D, --show-details

Show detailed information.

-F FIELD, --field FIELD

Specify the field(s) to be returned by server. You can repeat this option.

neutron gateway-device-create¶

usage: neutron gateway-device-create [-h]
                                     [-f {html,json,shell,table,value,yaml}]
                                     [-c COLUMN] [--max-width <integer>]
                                     [--noindent] [--prefix PREFIX]
                                     [--request-format {json}]
                                     [--tenant-id TENANT_ID]
                                     [--connector-type {stt,gre,ipsecgre,ipsecstt,bridge,ipsec_gre,ipsec_stt}]
                                     --connector-ip CONNECTOR_IP
                                     (--client-certificate CERT_DATA | --client-certificate-file CERT_FILE)
                                     NAME

Create a network gateway device.

Positional arguments:

NAME

Name of network gateway device to create.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json}

DEPRECATED! Only JSON request format is supported.

--tenant-id TENANT_ID

The owner tenant ID.

--connector-type {stt,gre,ipsecgre,ipsecstt,bridge,ipsec_gre,ipsec_stt}

Type of the transport zone connector to use for this device. Valid values are gre, stt, ipsec_gre, ipsec_stt, and bridge. Defaults to stt. ipsecgre and ipsecstt are also accepted as alternative names

--connector-ip CONNECTOR_IP

IP address for this device’s transport connector. It must correspond to the IP address of the interface used for tenant traffic on the NSX gateway node.

--client-certificate CERT_DATA

PEM certificate used by the NSX gateway transport node to authenticate with the NSX controller.

--client-certificate-file CERT_FILE

File containing the PEM certificate used by the NSX gateway transport node to authenticate with the NSX controller.

neutron gateway-device-delete¶

usage: neutron gateway-device-delete [-h] [--request-format {json}]
                                     GATEWAY_DEVICE

Delete a given network gateway device.

Positional arguments:

GATEWAY_DEVICE

ID or name of gateway_device to delete.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json}

DEPRECATED! Only JSON request format is supported.

neutron gateway-device-list¶

usage: neutron gateway-device-list [-h] [-f {csv,html,json,table,value,yaml}]
                                   [-c COLUMN] [--max-width <integer>]
                                   [--noindent]
                                   [--quote {all,minimal,none,nonnumeric}]
                                   [--request-format {json}] [-D] [-F FIELD]

List network gateway devices for a given tenant.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json}

DEPRECATED! Only JSON request format is supported.

-D, --show-details

Show detailed information.

-F FIELD, --field FIELD

Specify the field(s) to be returned by server. You can repeat this option.

neutron gateway-device-show¶

usage: neutron gateway-device-show [-h]
                                   [-f {html,json,shell,table,value,yaml}]
                                   [-c COLUMN] [--max-width <integer>]
                                   [--noindent] [--prefix PREFIX]
                                   [--request-format {json}] [-D] [-F FIELD]
                                   GATEWAY_DEVICE

Show information for a given network gateway device.

Positional arguments:

GATEWAY_DEVICE

ID or name of gateway_device to look up.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json}

DEPRECATED! Only JSON request format is supported.

-D, --show-details

Show detailed information.

-F FIELD, --field FIELD

Specify the field(s) to be returned by server. You can repeat this option.

neutron gateway-device-update¶

usage: neutron gateway-device-update [-h] [--request-format {json}]
                                     [--name NAME]
                                     [--connector-type {stt,gre,ipsecgre,ipsecstt,bridge,ipsec_gre,ipsec_stt}]
                                     [--connector-ip CONNECTOR_IP]
                                     [--client-certificate CERT_DATA | --client-certificate-file CERT_FILE]
                                     GATEWAY_DEVICE

Update a network gateway device.

Positional arguments:

GATEWAY_DEVICE

ID or name of gateway_device to update.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json}

DEPRECATED! Only JSON request format is supported.

--name NAME

New name for network gateway device.

--connector-type {stt,gre,ipsecgre,ipsecstt,bridge,ipsec_gre,ipsec_stt}

Type of the transport zone connector to use for this device. Valid values are gre, stt, ipsec_gre, ipsec_stt, and bridge. Defaults to stt. ipsecgre and ipsecstt are also accepted as alternative names

--connector-ip CONNECTOR_IP

IP address for this device’s transport connector. It must correspond to the IP address of the interface used for tenant traffic on the NSX gateway node.

--client-certificate CERT_DATA

PEM certificate used by the NSX gateway transport node to authenticate with the NSX controller.

--client-certificate-file CERT_FILE

File containing the PEM certificate used by the NSX gateway transport node to authenticate with the NSX controller.

neutron ipsec-site-connection-create¶

usage: neutron ipsec-site-connection-create [-h]
                                            [-f {html,json,shell,table,value,yaml}]
                                            [-c COLUMN]
                                            [--max-width <integer>]
                                            [--noindent] [--prefix PREFIX]
                                            [--request-format {json}]
                                            [--tenant-id TENANT_ID]
                                            [--admin-state-down] [--name NAME]
                                            [--description DESCRIPTION]
                                            [--mtu MTU]
                                            [--initiator {bi-directional,response-only}]
                                            --vpnservice-id VPNSERVICE
                                            --ikepolicy-id IKEPOLICY
                                            --ipsecpolicy-id IPSECPOLICY
                                            --peer-address PEER_ADDRESS
                                            --peer-id PEER_ID
                                            [--peer-cidr PEER_CIDRS] --psk PSK
                                            [--dpd action=ACTION,interval=INTERVAL,timeout=TIMEOUT]
                                            [--local-ep-group LOCAL_EP_GROUP]
                                            [--peer-ep-group PEER_EP_GROUP]

Create an IPsec site connection.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json}

DEPRECATED! Only JSON request format is supported.

--tenant-id TENANT_ID

The owner tenant ID.

--admin-state-down

Set admin state up to false.

--name NAME

Set friendly name for the connection.

--description DESCRIPTION

Set a description for the connection.

--mtu MTU

MTU size for the connection, default:1500

--initiator {bi-directional,response-only}

Initiator state in lowercase, default:bi-directional

--vpnservice-id VPNSERVICE

VPN service instance ID associated with this connection.

--ikepolicy-id IKEPOLICY

IKE policy ID associated with this connection.

--ipsecpolicy-id IPSECPOLICY

IPsec policy ID associated with this connection.

--peer-address PEER_ADDRESS

Peer gateway public IPv4/IPv6 address or FQDN.

--peer-id PEER_ID

Peer router identity for authentication. Can be IPv4/IPv6 address, e-mail address, key id, or FQDN.

--peer-cidr PEER_CIDRS

[DEPRECATED in Mitaka] Remote subnet(s) in CIDR format. Cannot be specified when using endpoint groups. Only applicable, if subnet provided for VPN service.

--psk PSK

Pre-shared key string.

--dpd

action=ACTION,interval=INTERVAL,timeout=TIMEOUT Ipsec connection. Dead Peer Detection attributes. ‘action’-hold,clear,disabled,restart,restart-by-peer. ‘interval’ and ‘timeout’ are non negative integers. ‘interval’ should be less than ‘timeout’ value. ‘action’, default:hold ‘interval’, default:30, ‘timeout’, default:120.

--local-ep-group LOCAL_EP_GROUP

Local endpoint group ID/name with subnet(s) for IPSec connection.

--peer-ep-group PEER_EP_GROUP

Peer endpoint group ID/name with CIDR(s) for IPsec connection.

neutron ipsec-site-connection-delete¶

usage: neutron ipsec-site-connection-delete [-h] [--request-format {json}]
                                            IPSEC_SITE_CONNECTION

Delete a given IPsec site connection.

Positional arguments:

IPSEC_SITE_CONNECTION

ID or name of IPsec site connection to delete.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json}

DEPRECATED! Only JSON request format is supported.

neutron ipsec-site-connection-list¶

usage: neutron ipsec-site-connection-list [-h]
                                          [-f {csv,html,json,table,value,yaml}]
                                          [-c COLUMN] [--max-width <integer>]
                                          [--noindent]
                                          [--quote {all,minimal,none,nonnumeric}]
                                          [--request-format {json}] [-D]
                                          [-F FIELD] [-P SIZE]
                                          [--sort-key FIELD]
                                          [--sort-dir {asc,desc}]

List IPsec site connections that belong to a given tenant.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json}

DEPRECATED! Only JSON request format is supported.

-D, --show-details

Show detailed information.

-F FIELD, --field FIELD

Specify the field(s) to be returned by server. You can repeat this option.

-P SIZE, --page-size SIZE

Specify retrieve unit of each request, then split one request to several requests.

--sort-key FIELD

Sorts the list by the specified fields in the specified directions. You can repeat this option, but you must specify an equal number of sort_dir and sort_key values. Extra sort_dir options are ignored. Missing sort_dir options use the default asc value.

--sort-dir {asc,desc}

Sorts the list in the specified direction. You can repeat this option.

neutron ipsec-site-connection-show¶

usage: neutron ipsec-site-connection-show [-h]
                                          [-f {html,json,shell,table,value,yaml}]
                                          [-c COLUMN] [--max-width <integer>]
                                          [--noindent] [--prefix PREFIX]
                                          [--request-format {json}] [-D]
                                          [-F FIELD]
                                          IPSEC_SITE_CONNECTION

Show information of a given IPsec site connection.

Positional arguments:

IPSEC_SITE_CONNECTION

ID or name of IPsec site connection to look up.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json}

DEPRECATED! Only JSON request format is supported.

-D, --show-details

Show detailed information.

-F FIELD, --field FIELD

Specify the field(s) to be returned by server. You can repeat this option.

neutron ipsec-site-connection-update¶

usage: neutron ipsec-site-connection-update [-h] [--request-format {json}]
                                            [--dpd action=ACTION,interval=INTERVAL,timeout=TIMEOUT]
                                            [--local-ep-group LOCAL_EP_GROUP]
                                            [--peer-ep-group PEER_EP_GROUP]
                                            IPSEC_SITE_CONNECTION

Update a given IPsec site connection.

Positional arguments:

IPSEC_SITE_CONNECTION

ID or name of IPsec site connection to update.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json}

DEPRECATED! Only JSON request format is supported.

--dpd

action=ACTION,interval=INTERVAL,timeout=TIMEOUT Ipsec connection. Dead Peer Detection attributes. ‘action’-hold,clear,disabled,restart,restart-by-peer. ‘interval’ and ‘timeout’ are non negative integers. ‘interval’ should be less than ‘timeout’ value. ‘action’, default:hold ‘interval’, default:30, ‘timeout’, default:120.

--local-ep-group LOCAL_EP_GROUP

Local endpoint group ID/name with subnet(s) for IPSec connection.

--peer-ep-group PEER_EP_GROUP

Peer endpoint group ID/name with CIDR(s) for IPsec connection.

neutron l3-agent-list-hosting-router¶

usage: neutron l3-agent-list-hosting-router [-h]
                                            [-f {csv,html,json,table,value,yaml}]
                                            [-c COLUMN]
                                            [--max-width <integer>]
                                            [--noindent]
                                            [--quote {all,minimal,none,nonnumeric}]
                                            [--request-format {json}] [-D]
                                            [-F FIELD]
                                            ROUTER

List L3 agents hosting a router.

Positional arguments:

ROUTER

Router to query.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json}

DEPRECATED! Only JSON request format is supported.

-D, --show-details

Show detailed information.

-F FIELD, --field FIELD

Specify the field(s) to be returned by server. You can repeat this option.

neutron l3-agent-router-add¶

usage: neutron l3-agent-router-add [-h] [--request-format {json}]
                                   L3_AGENT ROUTER

Add a router to a L3 agent.

Positional arguments:

L3_AGENT

ID of the L3 agent.

ROUTER

Router to add.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json}

DEPRECATED! Only JSON request format is supported.

neutron l3-agent-router-remove¶

usage: neutron l3-agent-router-remove [-h] [--request-format {json}]
                                      L3_AGENT ROUTER

Remove a router from a L3 agent.

Positional arguments:

L3_AGENT

ID of the L3 agent.

ROUTER

Router to remove.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json}

DEPRECATED! Only JSON request format is supported.

neutron lb-agent-hosting-pool¶

usage: neutron lb-agent-hosting-pool [-h]
                                     [-f {csv,html,json,table,value,yaml}]
                                     [-c COLUMN] [--max-width <integer>]
                                     [--noindent]
                                     [--quote {all,minimal,none,nonnumeric}]
                                     [--request-format {json}] [-D] [-F FIELD]
                                     POOL

Get loadbalancer agent hosting a pool. Deriving from ListCommand though server will return only one agent to keep common output format for all agent schedulers

Positional arguments:

POOL

Pool to query.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json}

DEPRECATED! Only JSON request format is supported.

-D, --show-details

Show detailed information.

-F FIELD, --field FIELD

Specify the field(s) to be returned by server. You can repeat this option.

neutron lb-healthmonitor-associate¶

usage: neutron lb-healthmonitor-associate [-h] [--request-format {json}]
                                          HEALTH_MONITOR_ID POOL

Create a mapping between a health monitor and a pool.

Positional arguments:

HEALTH_MONITOR_ID

Health monitor to associate.

POOL

ID of the pool to be associated with the health monitor.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json}

DEPRECATED! Only JSON request format is supported.

neutron lb-healthmonitor-create¶

usage: neutron lb-healthmonitor-create [-h]
                                       [-f {html,json,shell,table,value,yaml}]
                                       [-c COLUMN] [--max-width <integer>]
                                       [--noindent] [--prefix PREFIX]
                                       [--request-format {json}]
                                       [--tenant-id TENANT_ID]
                                       [--admin-state-down]
                                       [--expected-codes EXPECTED_CODES]
                                       [--http-method HTTP_METHOD]
                                       [--url-path URL_PATH] --delay DELAY
                                       --max-retries MAX_RETRIES --timeout
                                       TIMEOUT --type {PING,TCP,HTTP,HTTPS}

Create a health monitor.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json}

DEPRECATED! Only JSON request format is supported.

--tenant-id TENANT_ID

The owner tenant ID.

--admin-state-down

Set admin state up to false.

--expected-codes EXPECTED_CODES

The list of HTTP status codes expected in response from the member to declare it healthy. This attribute can contain one value, or a list of values separated by comma, or a range of values (e.g. “200-299”). If this attribute is not specified, it defaults to “200”.

--http-method HTTP_METHOD

The HTTP method used for requests by the monitor of type HTTP.

--url-path URL_PATH

The HTTP path used in the HTTP request used by the monitor to test a member health. This must be a string beginning with a / (forward slash).

--delay DELAY

The time in seconds between sending probes to members.

--max-retries MAX_RETRIES

Number of permissible connection failures before changing the member status to INACTIVE. [1..10]

--timeout TIMEOUT

Maximum number of seconds for a monitor to wait for a connection to be established before it times out. The value must be less than the delay value.

--type {PING,TCP,HTTP,HTTPS}

One of the predefined health monitor types.

neutron lb-healthmonitor-delete¶

usage: neutron lb-healthmonitor-delete [-h] [--request-format {json}]
                                       HEALTH_MONITOR

Delete a given health monitor.

Positional arguments:

HEALTH_MONITOR

ID of health_monitor to delete.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json}

DEPRECATED! Only JSON request format is supported.

neutron lb-healthmonitor-disassociate¶

usage: neutron lb-healthmonitor-disassociate [-h] [--request-format {json}]
                                             HEALTH_MONITOR_ID POOL

Remove a mapping from a health monitor to a pool.

Positional arguments:

HEALTH_MONITOR_ID

Health monitor to associate.

POOL

ID of the pool to be associated with the health monitor.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json}

DEPRECATED! Only JSON request format is supported.

neutron lb-healthmonitor-list¶

usage: neutron lb-healthmonitor-list [-h]
                                     [-f {csv,html,json,table,value,yaml}]
                                     [-c COLUMN] [--max-width <integer>]
                                     [--noindent]
                                     [--quote {all,minimal,none,nonnumeric}]
                                     [--request-format {json}] [-D] [-F FIELD]
                                     [-P SIZE] [--sort-key FIELD]
                                     [--sort-dir {asc,desc}]

List health monitors that belong to a given tenant.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json}

DEPRECATED! Only JSON request format is supported.

-D, --show-details

Show detailed information.

-F FIELD, --field FIELD

Specify the field(s) to be returned by server. You can repeat this option.

-P SIZE, --page-size SIZE

Specify retrieve unit of each request, then split one request to several requests.

--sort-key FIELD

Sorts the list by the specified fields in the specified directions. You can repeat this option, but you must specify an equal number of sort_dir and sort_key values. Extra sort_dir options are ignored. Missing sort_dir options use the default asc value.

--sort-dir {asc,desc}

Sorts the list in the specified direction. You can repeat this option.

neutron lb-healthmonitor-show¶

usage: neutron lb-healthmonitor-show [-h]
                                     [-f {html,json,shell,table,value,yaml}]
                                     [-c COLUMN] [--max-width <integer>]
                                     [--noindent] [--prefix PREFIX]
                                     [--request-format {json}] [-D] [-F FIELD]
                                     HEALTH_MONITOR

Show information of a given health monitor.

Positional arguments:

HEALTH_MONITOR

ID of health_monitor to look up.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json}

DEPRECATED! Only JSON request format is supported.

-D, --show-details

Show detailed information.

-F FIELD, --field FIELD

Specify the field(s) to be returned by server. You can repeat this option.

neutron lb-healthmonitor-update¶

usage: neutron lb-healthmonitor-update [-h] [--request-format {json}]
                                       HEALTH_MONITOR

Update a given health monitor.

Positional arguments:

HEALTH_MONITOR

ID of health_monitor to update.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json}

DEPRECATED! Only JSON request format is supported.

neutron lb-member-create¶

usage: neutron lb-member-create [-h] [-f {html,json,shell,table,value,yaml}]
                                [-c COLUMN] [--max-width <integer>]
                                [--noindent] [--prefix PREFIX]
                                [--request-format {json}]
                                [--tenant-id TENANT_ID] [--admin-state-down]
                                [--weight WEIGHT] --address ADDRESS
                                --protocol-port PROTOCOL_PORT
                                POOL

Create a member.

Positional arguments:

POOL

Pool ID or name this vip belongs to.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json}

DEPRECATED! Only JSON request format is supported.

--tenant-id TENANT_ID

The owner tenant ID.

--admin-state-down

Set admin state up to false.

--weight WEIGHT

Weight of pool member in the pool (default:1, [0..256]).

--address ADDRESS

IP address of the pool member on the pool network.

--protocol-port PROTOCOL_PORT

Port on which the pool member listens for requests or connections.

neutron lb-member-delete¶

usage: neutron lb-member-delete [-h] [--request-format {json}] MEMBER

Delete a given member.

Positional arguments:

MEMBER

ID or name of member to delete.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json}

DEPRECATED! Only JSON request format is supported.

neutron lb-member-list¶

usage: neutron lb-member-list [-h] [-f {csv,html,json,table,value,yaml}]
                              [-c COLUMN] [--max-width <integer>] [--noindent]
                              [--quote {all,minimal,none,nonnumeric}]
                              [--request-format {json}] [-D] [-F FIELD]
                              [-P SIZE] [--sort-key FIELD]
                              [--sort-dir {asc,desc}]

List members that belong to a given tenant.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json}

DEPRECATED! Only JSON request format is supported.

-D, --show-details

Show detailed information.

-F FIELD, --field FIELD

Specify the field(s) to be returned by server. You can repeat this option.

-P SIZE, --page-size SIZE

Specify retrieve unit of each request, then split one request to several requests.

--sort-key FIELD

Sorts the list by the specified fields in the specified directions. You can repeat this option, but you must specify an equal number of sort_dir and sort_key values. Extra sort_dir options are ignored. Missing sort_dir options use the default asc value.

--sort-dir {asc,desc}

Sorts the list in the specified direction. You can repeat this option.

neutron lb-member-show¶

usage: neutron lb-member-show [-h] [-f {html,json,shell,table,value,yaml}]
                              [-c COLUMN] [--max-width <integer>] [--noindent]
                              [--prefix PREFIX] [--request-format {json}] [-D]
                              [-F FIELD]
                              MEMBER

Show information of a given member.

Positional arguments:

MEMBER

ID of member to look up.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json}

DEPRECATED! Only JSON request format is supported.

-D, --show-details

Show detailed information.

-F FIELD, --field FIELD

Specify the field(s) to be returned by server. You can repeat this option.

neutron lb-member-update¶

usage: neutron lb-member-update [-h] [--request-format {json}] MEMBER

Update a given member.

Positional arguments:

MEMBER

ID or name of member to update.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json}

DEPRECATED! Only JSON request format is supported.

neutron lb-pool-create¶

usage: neutron lb-pool-create [-h] [-f {html,json,shell,table,value,yaml}]
                              [-c COLUMN] [--max-width <integer>] [--noindent]
                              [--prefix PREFIX] [--request-format {json}]
                              [--tenant-id TENANT_ID] [--admin-state-down]
                              [--description DESCRIPTION] --lb-method
                              {ROUND_ROBIN,LEAST_CONNECTIONS,SOURCE_IP} --name
                              NAME --protocol {HTTP,HTTPS,TCP} --subnet-id
                              SUBNET [--provider PROVIDER]

Create a pool.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json}

DEPRECATED! Only JSON request format is supported.

--tenant-id TENANT_ID

The owner tenant ID.

--admin-state-down

Set admin state up to false.

--description DESCRIPTION

Description of the pool.

--lb-method {ROUND_ROBIN,LEAST_CONNECTIONS,SOURCE_IP}

The algorithm used to distribute load between the members of the pool.

--name NAME

The name of the pool.

--protocol {HTTP,HTTPS,TCP}

Protocol for balancing.

--subnet-id SUBNET

The subnet on which the members of the pool will be located.

--provider PROVIDER

Provider name of loadbalancer service.

neutron lb-pool-delete¶

usage: neutron lb-pool-delete [-h] [--request-format {json}] POOL

Delete a given pool.

Positional arguments:

POOL

ID or name of pool to delete.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json}

DEPRECATED! Only JSON request format is supported.

neutron lb-pool-list¶

usage: neutron lb-pool-list [-h] [-f {csv,html,json,table,value,yaml}]
                            [-c COLUMN] [--max-width <integer>] [--noindent]
                            [--quote {all,minimal,none,nonnumeric}]
                            [--request-format {json}] [-D] [-F FIELD]
                            [-P SIZE] [--sort-key FIELD]
                            [--sort-dir {asc,desc}]

List pools that belong to a given tenant.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json}

DEPRECATED! Only JSON request format is supported.

-D, --show-details

Show detailed information.

-F FIELD, --field FIELD

Specify the field(s) to be returned by server. You can repeat this option.

-P SIZE, --page-size SIZE

Specify retrieve unit of each request, then split one request to several requests.

--sort-key FIELD

Sorts the list by the specified fields in the specified directions. You can repeat this option, but you must specify an equal number of sort_dir and sort_key values. Extra sort_dir options are ignored. Missing sort_dir options use the default asc value.

--sort-dir {asc,desc}

Sorts the list in the specified direction. You can repeat this option.

neutron lb-pool-list-on-agent¶

usage: neutron lb-pool-list-on-agent [-h]
                                     [-f {csv,html,json,table,value,yaml}]
                                     [-c COLUMN] [--max-width <integer>]
                                     [--noindent]
                                     [--quote {all,minimal,none,nonnumeric}]
                                     [--request-format {json}] [-D] [-F FIELD]
                                     LBAAS_AGENT

List the pools on a loadbalancer agent.

Positional arguments:

LBAAS_AGENT

ID of the loadbalancer agent to query.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json}

DEPRECATED! Only JSON request format is supported.

-D, --show-details

Show detailed information.

-F FIELD, --field FIELD

Specify the field(s) to be returned by server. You can repeat this option.

neutron lb-pool-show¶

usage: neutron lb-pool-show [-h] [-f {html,json,shell,table,value,yaml}]
                            [-c COLUMN] [--max-width <integer>] [--noindent]
                            [--prefix PREFIX] [--request-format {json}] [-D]
                            [-F FIELD]
                            POOL

Show information of a given pool.

Positional arguments:

POOL

ID or name of pool to look up.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json}

DEPRECATED! Only JSON request format is supported.

-D, --show-details

Show detailed information.

-F FIELD, --field FIELD

Specify the field(s) to be returned by server. You can repeat this option.

neutron lb-pool-stats¶

usage: neutron lb-pool-stats [-h] [-f {html,json,shell,table,value,yaml}]
                             [-c COLUMN] [--max-width <integer>] [--noindent]
                             [--prefix PREFIX] [--request-format {json}] [-D]
                             [-F FIELD]
                             POOL

Retrieve stats for a given pool.

Positional arguments:

POOL

ID or name of pool to look up.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json}

DEPRECATED! Only JSON request format is supported.

-D, --show-details

Show detailed information.

-F FIELD, --field FIELD

Specify the field(s) to be returned by server. You can repeat this option.

neutron lb-pool-update¶

usage: neutron lb-pool-update [-h] [--request-format {json}] POOL

Update a given pool.

Positional arguments:

POOL

ID or name of pool to update.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json}

DEPRECATED! Only JSON request format is supported.

neutron lb-vip-create¶

usage: neutron lb-vip-create [-h] [-f {html,json,shell,table,value,yaml}]
                             [-c COLUMN] [--max-width <integer>] [--noindent]
                             [--prefix PREFIX] [--request-format {json}]
                             [--tenant-id TENANT_ID] [--address ADDRESS]
                             [--admin-state-down]
                             [--connection-limit CONNECTION_LIMIT]
                             [--description DESCRIPTION] --name NAME
                             --protocol-port PROTOCOL_PORT --protocol
                             {TCP,HTTP,HTTPS} --subnet-id SUBNET
                             POOL

Create a vip.

Positional arguments:

POOL

Pool ID or name this vip belongs to.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json}

DEPRECATED! Only JSON request format is supported.

--tenant-id TENANT_ID

The owner tenant ID.

--address ADDRESS

IP address of the vip.

--admin-state-down

Set admin state up to false.

--connection-limit CONNECTION_LIMIT

The maximum number of connections per second allowed for the vip. Positive integer or -1 for unlimited (default).

--description DESCRIPTION

Description of the vip.

--name NAME

Name of the vip.

--protocol-port PROTOCOL_PORT

TCP port on which to listen for client traffic that is associated with the vip address.

--protocol {TCP,HTTP,HTTPS}

Protocol for balancing.

--subnet-id SUBNET

The subnet on which to allocate the vip address.

neutron lb-vip-delete¶

usage: neutron lb-vip-delete [-h] [--request-format {json}] VIP

Delete a given vip.

Positional arguments:

VIP

ID or name of vip to delete.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json}

DEPRECATED! Only JSON request format is supported.

neutron lb-vip-list¶

usage: neutron lb-vip-list [-h] [-f {csv,html,json,table,value,yaml}]
                           [-c COLUMN] [--max-width <integer>] [--noindent]
                           [--quote {all,minimal,none,nonnumeric}]
                           [--request-format {json}] [-D] [-F FIELD] [-P SIZE]
                           [--sort-key FIELD] [--sort-dir {asc,desc}]

List vips that belong to a given tenant.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json}

DEPRECATED! Only JSON request format is supported.

-D, --show-details

Show detailed information.

-F FIELD, --field FIELD

Specify the field(s) to be returned by server. You can repeat this option.

-P SIZE, --page-size SIZE

Specify retrieve unit of each request, then split one request to several requests.

--sort-key FIELD

Sorts the list by the specified fields in the specified directions. You can repeat this option, but you must specify an equal number of sort_dir and sort_key values. Extra sort_dir options are ignored. Missing sort_dir options use the default asc value.

--sort-dir {asc,desc}

Sorts the list in the specified direction. You can repeat this option.

neutron lb-vip-show¶

usage: neutron lb-vip-show [-h] [-f {html,json,shell,table,value,yaml}]
                           [-c COLUMN] [--max-width <integer>] [--noindent]
                           [--prefix PREFIX] [--request-format {json}] [-D]
                           [-F FIELD]
                           VIP

Show information of a given vip.

Positional arguments:

VIP

ID or name of vip to look up.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json}

DEPRECATED! Only JSON request format is supported.

-D, --show-details

Show detailed information.

-F FIELD, --field FIELD

Specify the field(s) to be returned by server. You can repeat this option.

neutron lb-vip-update¶

usage: neutron lb-vip-update [-h] [--request-format {json}] VIP

Update a given vip.

Positional arguments:

VIP

ID or name of vip to update.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json}

DEPRECATED! Only JSON request format is supported.

neutron lbaas-agent-hosting-loadbalancer¶

usage: neutron lbaas-agent-hosting-loadbalancer [-h]
                                                [-f {csv,html,json,table,value,yaml}]
                                                [-c COLUMN]
                                                [--max-width <integer>]
                                                [--noindent]
                                                [--quote {all,minimal,none,nonnumeric}]
                                                [--request-format {json}] [-D]
                                                [-F FIELD]
                                                LOADBALANCER

Get lbaas v2 agent hosting a loadbalancer. Deriving from ListCommand though server will return only one agent to keep common output format for all agent schedulers

Positional arguments:

LOADBALANCER

LoadBalancer to query.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json}

DEPRECATED! Only JSON request format is supported.

-D, --show-details

Show detailed information.

-F FIELD, --field FIELD

Specify the field(s) to be returned by server. You can repeat this option.

neutron lbaas-healthmonitor-create¶

usage: neutron lbaas-healthmonitor-create [-h]
                                          [-f {html,json,shell,table,value,yaml}]
                                          [-c COLUMN] [--max-width <integer>]
                                          [--noindent] [--prefix PREFIX]
                                          [--request-format {json}]
                                          [--tenant-id TENANT_ID]
                                          [--name NAME] [--admin-state-down]
                                          [--expected-codes EXPECTED_CODES]
                                          [--http-method HTTP_METHOD]
                                          [--url-path URL_PATH] --delay DELAY
                                          --max-retries MAX_RETRIES --timeout
                                          TIMEOUT --type {PING,TCP,HTTP,HTTPS}
                                          --pool POOL

LBaaS v2 Create a healthmonitor.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json}

DEPRECATED! Only JSON request format is supported.

--tenant-id TENANT_ID

The owner tenant ID.

--name NAME

Name of the health monitor to be created.

--admin-state-down

Set admin state up to false.

--expected-codes EXPECTED_CODES

The list of HTTP status codes expected in response from the member to declare it healthy. This attribute can contain one value, or a list of values separated by comma, or a range of values (e.g. “200-299”). If this attribute is not specified, it defaults to “200”.

--http-method HTTP_METHOD

The HTTP method used for requests by the monitor of type HTTP.

--url-path URL_PATH

The HTTP path used in the HTTP request used by the monitor to test a member health. This must be a string beginning with a / (forward slash).

--delay DELAY

The time in seconds between sending probes to members.

--max-retries MAX_RETRIES

Number of permissible connection failures before changing the member status to INACTIVE. [1..10].

--timeout TIMEOUT

Maximum number of seconds for a monitor to wait for a connection to be established before it times out. The value must be less than the delay value.

--type {PING,TCP,HTTP,HTTPS}

One of the predefined health monitor types.

--pool POOL

ID or name of the pool that this healthmonitor will monitor.

neutron lbaas-healthmonitor-delete¶

usage: neutron lbaas-healthmonitor-delete [-h] [--request-format {json}]
                                          HEALTHMONITOR

LBaaS v2 Delete a given healthmonitor.

Positional arguments:

HEALTHMONITOR

ID or name of healthmonitor to delete.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json}

DEPRECATED! Only JSON request format is supported.

neutron lbaas-healthmonitor-list¶

usage: neutron lbaas-healthmonitor-list [-h]
                                        [-f {csv,html,json,table,value,yaml}]
                                        [-c COLUMN] [--max-width <integer>]
                                        [--noindent]
                                        [--quote {all,minimal,none,nonnumeric}]
                                        [--request-format {json}] [-D]
                                        [-F FIELD] [-P SIZE]
                                        [--sort-key FIELD]
                                        [--sort-dir {asc,desc}]

LBaaS v2 List healthmonitors that belong to a given tenant.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json}

DEPRECATED! Only JSON request format is supported.

-D, --show-details

Show detailed information.

-F FIELD, --field FIELD

Specify the field(s) to be returned by server. You can repeat this option.

-P SIZE, --page-size SIZE

Specify retrieve unit of each request, then split one request to several requests.

--sort-key FIELD

Sorts the list by the specified fields in the specified directions. You can repeat this option, but you must specify an equal number of sort_dir and sort_key values. Extra sort_dir options are ignored. Missing sort_dir options use the default asc value.

--sort-dir {asc,desc}

Sorts the list in the specified direction. You can repeat this option.

neutron lbaas-healthmonitor-show¶

usage: neutron lbaas-healthmonitor-show [-h]
                                        [-f {html,json,shell,table,value,yaml}]
                                        [-c COLUMN] [--max-width <integer>]
                                        [--noindent] [--prefix PREFIX]
                                        [--request-format {json}] [-D]
                                        [-F FIELD]
                                        HEALTHMONITOR

LBaaS v2 Show information of a given healthmonitor.

Positional arguments:

HEALTHMONITOR

ID or name of healthmonitor to look up.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json}

DEPRECATED! Only JSON request format is supported.

-D, --show-details

Show detailed information.

-F FIELD, --field FIELD

Specify the field(s) to be returned by server. You can repeat this option.

neutron lbaas-healthmonitor-update¶

usage: neutron lbaas-healthmonitor-update [-h] [--request-format {json}]
                                          [--name NAME]
                                          HEALTHMONITOR

LBaaS v2 Update a given healthmonitor.

Positional arguments:

HEALTHMONITOR

ID or name of healthmonitor to update.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json}

DEPRECATED! Only JSON request format is supported.

--name NAME

Updated name of the health monitor.

neutron lbaas-l7policy-create¶

usage: neutron lbaas-l7policy-create [-h]
                                     [-f {html,json,shell,table,value,yaml}]
                                     [-c COLUMN] [--max-width <integer>]
                                     [--noindent] [--prefix PREFIX]
                                     [--request-format {json}]
                                     [--tenant-id TENANT_ID] [--name NAME]
                                     [--description DESCRIPTION] --action
                                     ACTION [--redirect-pool REDIRECT_POOL]
                                     [--redirect-url REDIRECT_URL]
                                     [--position POSITION]
                                     [--admin-state-down] --listener LISTENER

LBaaS v2 Create L7 policy.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json}

DEPRECATED! Only JSON request format is supported.

--tenant-id TENANT_ID

The owner tenant ID.

--name NAME

Name of the policy.

--description DESCRIPTION

Description of the policy.

--action ACTION

Action type of the policy.

--redirect-pool REDIRECT_POOL

ID or name of the pool for REDIRECT_TO_POOL action type.

--redirect-url REDIRECT_URL

URL for REDIRECT_TO_URL action type. This should be a valid URL string.

--position POSITION

L7 policy position in ordered policies list. This must be an integer starting from 1. Not specifying the position will place the policy at the tail of existing policies list.

--admin-state-down

Set admin state up to false.

--listener LISTENER

ID or name of the listener this policy belongs to.

neutron lbaas-l7policy-delete¶

usage: neutron lbaas-l7policy-delete [-h] [--request-format {json}] L7POLICY

LBaaS v2 Delete a given L7 policy.

Positional arguments:

L7POLICY

ID or name of l7policy to delete.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json}

DEPRECATED! Only JSON request format is supported.

neutron lbaas-l7policy-list¶

usage: neutron lbaas-l7policy-list [-h] [-f {csv,html,json,table,value,yaml}]
                                   [-c COLUMN] [--max-width <integer>]
                                   [--noindent]
                                   [--quote {all,minimal,none,nonnumeric}]
                                   [--request-format {json}] [-D] [-F FIELD]
                                   [-P SIZE] [--sort-key FIELD]
                                   [--sort-dir {asc,desc}]

LBaaS v2 List L7 policies that belong to a given listener.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json}

DEPRECATED! Only JSON request format is supported.

-D, --show-details

Show detailed information.

-F FIELD, --field FIELD

Specify the field(s) to be returned by server. You can repeat this option.

-P SIZE, --page-size SIZE

Specify retrieve unit of each request, then split one request to several requests.

--sort-key FIELD

Sorts the list by the specified fields in the specified directions. You can repeat this option, but you must specify an equal number of sort_dir and sort_key values. Extra sort_dir options are ignored. Missing sort_dir options use the default asc value.

--sort-dir {asc,desc}

Sorts the list in the specified direction. You can repeat this option.

neutron lbaas-l7policy-show¶

usage: neutron lbaas-l7policy-show [-h]
                                   [-f {html,json,shell,table,value,yaml}]
                                   [-c COLUMN] [--max-width <integer>]
                                   [--noindent] [--prefix PREFIX]
                                   [--request-format {json}] [-D] [-F FIELD]
                                   L7POLICY

LBaaS v2 Show information of a given L7 policy.

Positional arguments:

L7POLICY

ID or name of l7policy to look up.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json}

DEPRECATED! Only JSON request format is supported.

-D, --show-details

Show detailed information.

-F FIELD, --field FIELD

Specify the field(s) to be returned by server. You can repeat this option.

neutron lbaas-l7policy-update¶

usage: neutron lbaas-l7policy-update [-h] [--request-format {json}]
                                     [--name NAME] [--description DESCRIPTION]
                                     [--action ACTION]
                                     [--redirect-pool REDIRECT_POOL]
                                     [--redirect-url REDIRECT_URL]
                                     [--position POSITION]
                                     [--admin-state-up {True,False}]
                                     L7POLICY

LBaaS v2 Update a given L7 policy.

Positional arguments:

L7POLICY

ID or name of l7policy to update.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json}

DEPRECATED! Only JSON request format is supported.

--name NAME

Name of the policy.

--description DESCRIPTION

Description of the policy.

--action ACTION

Action type of the policy.

--redirect-pool REDIRECT_POOL

ID or name of the pool for REDIRECT_TO_POOL action type.

--redirect-url REDIRECT_URL

URL for REDIRECT_TO_URL action type. This should be a valid URL string.

--position POSITION

L7 policy position in ordered policies list. This must be an integer starting from 1. Not specifying the position will place the policy at the tail of existing policies list.

--admin-state-up {True,False}

Specify the administrative state of the policy (True meaning “Up”).

neutron lbaas-l7rule-create¶

usage: neutron lbaas-l7rule-create [-h]
                                   [-f {html,json,shell,table,value,yaml}]
                                   [-c COLUMN] [--max-width <integer>]
                                   [--noindent] [--prefix PREFIX]
                                   [--request-format {json}]
                                   [--tenant-id TENANT_ID] --type
                                   {HOST_NAME,PATH,FILE_TYPE,HEADER,COOKIE}
                                   --compare-type
                                   {REGEX,STARTS_WITH,ENDS_WITH,CONTAINS,EQUAL_TO}
                                   [--invert-compare] [--key KEY] --value
                                   VALUE [--admin-state-down]
                                   L7POLICY

LBaaS v2 Create L7 rule.

Positional arguments:

L7POLICY

ID or name of L7 policy this rule belongs to.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json}

DEPRECATED! Only JSON request format is supported.

--tenant-id TENANT_ID

The owner tenant ID.

--type {HOST_NAME,PATH,FILE_TYPE,HEADER,COOKIE}

Rule type.

--compare-type {REGEX,STARTS_WITH,ENDS_WITH,CONTAINS,EQUAL_TO}

Rule compare type.

--invert-compare

Invert the compare type.

--key KEY

Key to compare. Relevant for HEADER and COOKIE types only.

--value VALUE

Value to compare.

--admin-state-down

Set admin state up to false

neutron lbaas-l7rule-delete¶

usage: neutron lbaas-l7rule-delete [-h] [--request-format {json}]
                                   RULE L7POLICY

LBaaS v2 Delete a given L7 rule.

Positional arguments:

RULE

ID or name of rule to delete.

L7POLICY

ID or name of L7 policy this rule belongs to.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json}

DEPRECATED! Only JSON request format is supported.

neutron lbaas-l7rule-list¶

usage: neutron lbaas-l7rule-list [-h] [-f {csv,html,json,table,value,yaml}]
                                 [-c COLUMN] [--max-width <integer>]
                                 [--noindent]
                                 [--quote {all,minimal,none,nonnumeric}]
                                 [--request-format {json}] [-D] [-F FIELD]
                                 [-P SIZE] [--sort-key FIELD]
                                 [--sort-dir {asc,desc}]
                                 L7POLICY

LBaaS v2 List L7 rules that belong to a given L7 policy.

Positional arguments:

L7POLICY

ID or name of L7 policy this rule belongs to.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json}

DEPRECATED! Only JSON request format is supported.

-D, --show-details

Show detailed information.

-F FIELD, --field FIELD

Specify the field(s) to be returned by server. You can repeat this option.

-P SIZE, --page-size SIZE

Specify retrieve unit of each request, then split one request to several requests.

--sort-key FIELD

Sorts the list by the specified fields in the specified directions. You can repeat this option, but you must specify an equal number of sort_dir and sort_key values. Extra sort_dir options are ignored. Missing sort_dir options use the default asc value.

--sort-dir {asc,desc}

Sorts the list in the specified direction. You can repeat this option.

neutron lbaas-l7rule-show¶

usage: neutron lbaas-l7rule-show [-h] [-f {html,json,shell,table,value,yaml}]
                                 [-c COLUMN] [--max-width <integer>]
                                 [--noindent] [--prefix PREFIX]
                                 [--request-format {json}] [-D] [-F FIELD]
                                 RULE L7POLICY

LBaaS v2 Show information of a given rule.

Positional arguments:

RULE

ID or name of rule to look up.

L7POLICY

ID or name of L7 policy this rule belongs to.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json}

DEPRECATED! Only JSON request format is supported.

-D, --show-details

Show detailed information.

-F FIELD, --field FIELD

Specify the field(s) to be returned by server. You can repeat this option.

neutron lbaas-l7rule-update¶

usage: neutron lbaas-l7rule-update [-h] [--request-format {json}]
                                   [--type {HOST_NAME,PATH,FILE_TYPE,HEADER,COOKIE}]
                                   [--compare-type {REGEX,STARTS_WITH,ENDS_WITH,CONTAINS,EQUAL_TO}]
                                   [--invert-compare] [--key KEY]
                                   [--value VALUE]
                                   [--admin-state-up {True,False}]
                                   RULE L7POLICY

LBaaS v2 Update a given L7 rule.

Positional arguments:

RULE

ID or name of rule to update.

L7POLICY

ID or name of L7 policy this rule belongs to.

Optional arguments:

-h, --help

show this help message and exit

--request-format {json}

DEPRECATED! Only JSON request format is supported.

--type {HOST_NAME,PATH,FILE_TYPE,HEADER,COOKIE}

Rule type.

--compare-type {REGEX,STARTS_WITH,ENDS_WITH,CONTAINS,EQUAL_TO}

Rule compare type.

--invert-compare

Invert the compare type.

--key KEY

Key to compare. Relevant for HEADER and COOKIE types only.

--value VALUE

Value to compare.

--admin-state-up {True,False}

Specify the administrative state of the rule (True meaning “Up”).