neutron CLI reference¶

Warning

neutron CLI is now deprecated and will be removed in the future. Use openstack CLI instead. See openstack CLI command list and its extensions for advanced networking services. The command mapping from neutron CLI to openstack CLI is available here.

neutron usage¶

Command-line interface to the Neutron APIs (neutron CLI version: 9.0.1)

neutron
    [--version]
    [-v]
    [-q]
    [-r NUM]
    [--os-service-type <os-service-type>]
    [--os-endpoint-type <os-endpoint-type>]
    [--service-type <service-type>]
    [--endpoint-type <endpoint-type>]
    [--os-auth-strategy <auth-strategy>]
    [--os-cloud <cloud>]
    [--os-auth-url <auth-url>]
    [--os-tenant-name <auth-tenant-name> | --os-project-name <auth-project-name>]
    [--os-tenant-id <auth-tenant-id> | --os-project-id <auth-project-id>]
    [--os-username <auth-username>]
    [--os-user-id <auth-user-id>]
    [--os-user-domain-id <auth-user-domain-id>]
    [--os-user-domain-name <auth-user-domain-name>]
    [--os-project-domain-id <auth-project-domain-id>]
    [--os-project-domain-name <auth-project-domain-name>]
    [--os-cert <certificate>]
    [--os-cacert <ca-certificate>]
    [--os-key <key>]
    [--os-password <auth-password>]
    [--os-region-name <auth-region-name>]
    [--os-token <token>]
    [--http-timeout <seconds>]
    [--os-url <url>]
    [--insecure]

--version¶: show program’s version number and exit

-v, --verbose, --debug¶: Increase verbosity of output and show tracebacks on errors. You can repeat this option.

-q, --quiet¶: Suppress output except warnings and errors.

-r NUM, --retries NUM¶: How many times the request to the Neutron server should be retried if it fails. Defaults to 0.

--os-service-type <os-service-type>¶: Defaults to env[OS_NETWORK_SERVICE_TYPE] or “network”.

--os-endpoint-type <os-endpoint-type>¶: Defaults to env[OS_ENDPOINT_TYPE] or “public”.

--service-type <service-type>¶: DEPRECATED! Use –os-service-type.

--endpoint-type <endpoint-type>¶: DEPRECATED! Use –os-endpoint-type.

--os-auth-strategy <auth-strategy>¶: DEPRECATED! Only keystone is supported.

--os-cloud <cloud>¶: Defaults to env[OS_CLOUD].

--os-auth-url <auth-url>¶: Authentication URL, defaults to env[OS_AUTH_URL].

--os-tenant-name <auth-tenant-name>¶: Authentication tenant name, defaults to env[OS_TENANT_NAME].

--os-project-name <auth-project-name>¶: Another way to specify tenant name. This option is mutually exclusive with –os-tenant-name. Defaults to env[OS_PROJECT_NAME].

--os-tenant-id <auth-tenant-id>¶: Authentication tenant ID, defaults to env[OS_TENANT_ID].

--os-project-id <auth-project-id>¶: Another way to specify tenant ID. This option is mutually exclusive with –os-tenant-id. Defaults to env[OS_PROJECT_ID].

--os-username <auth-username>¶: Authentication username, defaults to env[OS_USERNAME].

--os-user-id <auth-user-id>¶: Authentication user ID (Env: OS_USER_ID)

--os-user-domain-id <auth-user-domain-id>¶: OpenStack user domain ID. Defaults to env[OS_USER_DOMAIN_ID].

--os-user-domain-name <auth-user-domain-name>¶: OpenStack user domain name. Defaults to env[OS_USER_DOMAIN_NAME].

--os-project-domain-id <auth-project-domain-id>¶: Defaults to env[OS_PROJECT_DOMAIN_ID].

--os-project-domain-name <auth-project-domain-name>¶: Defaults to env[OS_PROJECT_DOMAIN_NAME].

--os-cert <certificate>¶: Path of certificate file to use in SSL connection. This file can optionally be prepended with the private key. Defaults to env[OS_CERT].

--os-cacert <ca-certificate>¶: Specify a CA bundle file to use in verifying a TLS (https) server certificate. Defaults to env[OS_CACERT].

--os-key <key>¶: Path of client key to use in SSL connection. This option is not necessary if your key is prepended to your certificate file. Defaults to env[OS_KEY].

--os-password <auth-password>¶: Authentication password, defaults to env[OS_PASSWORD].

--os-region-name <auth-region-name>¶: Authentication region name, defaults to env[OS_REGION_NAME].

--os-token <token>¶: Authentication token, defaults to env[OS_TOKEN].

--http-timeout <seconds>¶: Timeout in seconds to wait for an HTTP response. Defaults to env[OS_NETWORK_TIMEOUT] or None if not specified.

--os-url <url>¶: Defaults to env[OS_URL].

--insecure¶: Explicitly allow neutronclient to perform “insecure” SSL (https) requests. The server’s certificate will not be verified against any certificate authorities. This option should be used with caution.

neutron API v2.0 commands¶

address-scope-create¶

Create an address scope for a given tenant.

neutron address-scope-create
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--tenant-id TENANT_ID]
    [--shared]
    NAME
    IP_VERSION

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

--tenant-id TENANT_ID¶: The owner tenant ID.

--shared¶: Set the address scope as shared.

NAME¶: Specify the name of the address scope.

IP_VERSION¶: Specify the address family of the address scope.

This command is provided by the python-neutronclient plugin.

address-scope-delete¶

Delete an address scope.

neutron address-scope-delete ADDRESS_SCOPE [ADDRESS_SCOPE ...]

ADDRESS_SCOPE¶: ID(s) or name(s) of address_scope to delete.

This command is provided by the python-neutronclient plugin.

address-scope-list¶

List address scopes that belong to a given tenant.

neutron address-scope-list
    [-f {csv,json,table,value,yaml}]
    [-c COLUMN]
    [--quote {all,minimal,none,nonnumeric}]
    [--noindent]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [-D]
    [-F FIELD]
    [-P SIZE]
    [--sort-key FIELD]
    [--sort-dir {asc,desc}]

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--quote <QUOTE_MODE>¶: when to include quotes, defaults to nonnumeric

--noindent¶: whether to disable indenting the JSON

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

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

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

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

-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.

This command is provided by the python-neutronclient plugin.

address-scope-show¶

Show information about an address scope.

neutron address-scope-show
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [-D]
    [-F FIELD]
    ADDRESS_SCOPE

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

-D, --show-details¶: Show detailed information.

-F FIELD, --field FIELD¶: Specify the field(s) to be returned by server. You can repeat this option.

ADDRESS_SCOPE¶: ID or name of address_scope to look up.

This command is provided by the python-neutronclient plugin.

address-scope-update¶

Update an address scope.

neutron address-scope-update
    [--name NAME]
    [--shared {True,False}]
    ADDRESS_SCOPE

--name <NAME>¶: Updated name of the address scope.

--shared {True,False}¶: Set sharing of address scope. (True means shared)

ADDRESS_SCOPE¶: ID or name of address_scope to update.

This command is provided by the python-neutronclient plugin.

agent-delete¶

Delete a given agent.

neutron agent-delete AGENT [AGENT ...]

AGENT¶: ID(s) of agent to delete.

This command is provided by the python-neutronclient plugin.

agent-list¶

List agents.

neutron agent-list
    [-f {csv,json,table,value,yaml}]
    [-c COLUMN]
    [--quote {all,minimal,none,nonnumeric}]
    [--noindent]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [-D]
    [-F FIELD]
    [--sort-key FIELD]
    [--sort-dir {asc,desc}]

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--quote <QUOTE_MODE>¶: when to include quotes, defaults to nonnumeric

--noindent¶: whether to disable indenting the JSON

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

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

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

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

-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.

This command is provided by the python-neutronclient plugin.

agent-show¶

Show information of a given agent.

neutron agent-show
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [-D]
    [-F FIELD]
    AGENT

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

-D, --show-details¶: Show detailed information.

-F FIELD, --field FIELD¶: Specify the field(s) to be returned by server. You can repeat this option.

AGENT¶: ID of agent to look up.

This command is provided by the python-neutronclient plugin.

agent-update¶

Updates the admin status and description for a specified agent.

neutron agent-update
    [--admin-state-down]
    [--description DESCRIPTION]
    AGENT

--admin-state-down¶: Set admin state up of the agent to false.

--description <DESCRIPTION>¶: Description for the agent.

AGENT¶: ID of agent to update.

This command is provided by the python-neutronclient plugin.

auto-allocated-topology-delete¶

Delete the auto-allocated topology of a given tenant.

neutron auto-allocated-topology-delete [--tenant-id tenant-id]

--tenant-id tenant-id¶: The owner tenant ID.

This command is provided by the python-neutronclient plugin.

auto-allocated-topology-show¶

Show the auto-allocated topology of a given tenant.

neutron auto-allocated-topology-show
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--dry-run]
    [--tenant-id tenant-id]

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

--dry-run¶: Validate the requirements for auto-allocated-topology. (Does not return a topology.)

--tenant-id tenant-id¶: The owner tenant ID.

This command is provided by the python-neutronclient plugin.

availability-zone-list¶

List availability zones.

neutron availability-zone-list
    [-f {csv,json,table,value,yaml}]
    [-c COLUMN]
    [--quote {all,minimal,none,nonnumeric}]
    [--noindent]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [-D]
    [-F FIELD]
    [-P SIZE]
    [--sort-key FIELD]
    [--sort-dir {asc,desc}]

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--quote <QUOTE_MODE>¶: when to include quotes, defaults to nonnumeric

--noindent¶: whether to disable indenting the JSON

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

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

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

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

-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.

This command is provided by the python-neutronclient plugin.

bash-completion¶

Prints all of the commands and options for bash-completion.

neutron bash-completion

This command is provided by the python-neutronclient plugin.

bgp-dragent-list-hosting-speaker¶

List Dynamic Routing agents hosting a BGP speaker.

neutron bgp-dragent-list-hosting-speaker
    [-f {csv,json,table,value,yaml}]
    [-c COLUMN]
    [--quote {all,minimal,none,nonnumeric}]
    [--noindent]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [-D]
    [-F FIELD]
    BGP_SPEAKER

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--quote <QUOTE_MODE>¶: when to include quotes, defaults to nonnumeric

--noindent¶: whether to disable indenting the JSON

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

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

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

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

-D, --show-details¶: Show detailed information.

-F FIELD, --field FIELD¶: Specify the field(s) to be returned by server. You can repeat this option.

BGP_SPEAKER¶: ID or name of the BGP speaker.

This command is provided by the python-neutronclient plugin.

bgp-dragent-speaker-add¶

Add a BGP speaker to a Dynamic Routing agent.

neutron bgp-dragent-speaker-add BGP_DRAGENT_ID BGP_SPEAKER

BGP_DRAGENT_ID¶: ID of the Dynamic Routing agent.

BGP_SPEAKER¶: ID or name of the BGP speaker.

This command is provided by the python-neutronclient plugin.

bgp-dragent-speaker-remove¶

Removes a BGP speaker from a Dynamic Routing agent.

neutron bgp-dragent-speaker-remove BGP_DRAGENT_ID BGP_SPEAKER

BGP_DRAGENT_ID¶: ID of the Dynamic Routing agent.

BGP_SPEAKER¶: ID or name of the BGP speaker.

This command is provided by the python-neutronclient plugin.

bgp-peer-create¶

Create a BGP Peer.

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

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

--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, 4294967295] is allowed.)

--auth-type PEER_AUTH_TYPE¶: Authentication algorithm. Supported algorithms: none(default), md5

--password AUTH_PASSWORD¶: Authentication password.

NAME¶: Name of the BGP peer to create.

This command is provided by the python-neutronclient plugin.

bgp-peer-delete¶

Delete a BGP peer.

neutron bgp-peer-delete BGP_PEER [BGP_PEER ...]

BGP_PEER¶: ID(s) or name(s) of bgp_peer to delete.

This command is provided by the python-neutronclient plugin.

bgp-peer-list¶

List BGP peers.

neutron bgp-peer-list
    [-f {csv,json,table,value,yaml}]
    [-c COLUMN]
    [--quote {all,minimal,none,nonnumeric}]
    [--noindent]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [-D]
    [-F FIELD]
    [-P SIZE]
    [--sort-key FIELD]
    [--sort-dir {asc,desc}]

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--quote <QUOTE_MODE>¶: when to include quotes, defaults to nonnumeric

--noindent¶: whether to disable indenting the JSON

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

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

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

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

-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.

This command is provided by the python-neutronclient plugin.

bgp-peer-show¶

Show information of a given BGP peer.

neutron bgp-peer-show
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [-D]
    [-F FIELD]
    BGP_PEER

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

-D, --show-details¶: Show detailed information.

-F FIELD, --field FIELD¶: Specify the field(s) to be returned by server. You can repeat this option.

BGP_PEER¶: ID or name of bgp_peer to look up.

This command is provided by the python-neutronclient plugin.

bgp-peer-update¶

Update BGP Peer’s information.

neutron bgp-peer-update
    [--name NAME]
    [--password AUTH_PASSWORD]
    BGP_PEER

--name <NAME>¶: Updated name of the BGP peer.

--password AUTH_PASSWORD¶: Updated authentication password.

BGP_PEER¶: ID or name of bgp_peer to update.

This command is provided by the python-neutronclient plugin.

bgp-speaker-advertiseroute-list¶

List routes advertised by a given BGP speaker.

neutron bgp-speaker-advertiseroute-list
    [-f {csv,json,table,value,yaml}]
    [-c COLUMN]
    [--quote {all,minimal,none,nonnumeric}]
    [--noindent]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [-D]
    [-F FIELD]
    [-P SIZE]
    [--sort-key FIELD]
    [--sort-dir {asc,desc}]
    BGP_SPEAKER

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--quote <QUOTE_MODE>¶: when to include quotes, defaults to nonnumeric

--noindent¶: whether to disable indenting the JSON

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

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

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

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

-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.

BGP_SPEAKER¶: ID or name of the BGP speaker.

This command is provided by the python-neutronclient plugin.

bgp-speaker-create¶

Create a BGP Speaker.

neutron bgp-speaker-create
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--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

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

--tenant-id TENANT_ID¶: The owner tenant ID.

--local-as LOCAL_AS¶: Local AS number. (Integer in [1, 4294967295] is allowed.)

--ip-version <IP_VERSION>¶: 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.

NAME¶: Name of the BGP speaker to create.

This command is provided by the python-neutronclient plugin.

bgp-speaker-delete¶

Delete a BGP speaker.

neutron bgp-speaker-delete BGP_SPEAKER [BGP_SPEAKER ...]

BGP_SPEAKER¶: ID(s) or name(s) of bgp_speaker to delete.

This command is provided by the python-neutronclient plugin.

bgp-speaker-list¶

List BGP speakers.

neutron bgp-speaker-list
    [-f {csv,json,table,value,yaml}]
    [-c COLUMN]
    [--quote {all,minimal,none,nonnumeric}]
    [--noindent]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [-D]
    [-F FIELD]
    [-P SIZE]
    [--sort-key FIELD]
    [--sort-dir {asc,desc}]

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--quote <QUOTE_MODE>¶: when to include quotes, defaults to nonnumeric

--noindent¶: whether to disable indenting the JSON

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

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

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

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

-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.

This command is provided by the python-neutronclient plugin.

bgp-speaker-list-on-dragent¶

List BGP speakers hosted by a Dynamic Routing agent.

neutron bgp-speaker-list-on-dragent
    [-f {csv,json,table,value,yaml}]
    [-c COLUMN]
    [--quote {all,minimal,none,nonnumeric}]
    [--noindent]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [-D]
    [-F FIELD]
    BGP_DRAGENT_ID

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--quote <QUOTE_MODE>¶: when to include quotes, defaults to nonnumeric

--noindent¶: whether to disable indenting the JSON

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

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

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

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

-D, --show-details¶: Show detailed information.

-F FIELD, --field FIELD¶: Specify the field(s) to be returned by server. You can repeat this option.

BGP_DRAGENT_ID¶: ID of the Dynamic Routing agent.

This command is provided by the python-neutronclient plugin.

bgp-speaker-network-add¶

Add a network to the BGP speaker.

neutron bgp-speaker-network-add BGP_SPEAKER NETWORK

BGP_SPEAKER¶: ID or name of the BGP speaker.

NETWORK¶: ID or name of the network to add.

This command is provided by the python-neutronclient plugin.

bgp-speaker-network-remove¶

Remove a network from the BGP speaker.

neutron bgp-speaker-network-remove BGP_SPEAKER NETWORK

BGP_SPEAKER¶: ID or name of the BGP speaker.

NETWORK¶: ID or name of the network to remove.

This command is provided by the python-neutronclient plugin.

bgp-speaker-peer-add¶

Add a peer to the BGP speaker.

neutron bgp-speaker-peer-add BGP_SPEAKER BGP_PEER

BGP_SPEAKER¶: ID or name of the BGP speaker.

BGP_PEER¶: ID or name of the BGP peer to add.

This command is provided by the python-neutronclient plugin.

bgp-speaker-peer-remove¶

Remove a peer from the BGP speaker.

neutron bgp-speaker-peer-remove BGP_SPEAKER BGP_PEER

BGP_SPEAKER¶: ID or name of the BGP speaker.

BGP_PEER¶: ID or name of the BGP peer to remove.

This command is provided by the python-neutronclient plugin.

bgp-speaker-show¶

Show information of a given BGP speaker.

neutron bgp-speaker-show
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [-D]
    [-F FIELD]
    BGP_SPEAKER

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

-D, --show-details¶: Show detailed information.

-F FIELD, --field FIELD¶: Specify the field(s) to be returned by server. You can repeat this option.

BGP_SPEAKER¶: ID or name of bgp_speaker to look up.

This command is provided by the python-neutronclient plugin.

bgp-speaker-update¶

Update BGP Speaker’s information.

neutron bgp-speaker-update
    [--name NAME]
    [--advertise-floating-ip-host-routes {True,False}]
    [--advertise-tenant-networks {True,False}]
    BGP_SPEAKER

--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.

BGP_SPEAKER¶: ID or name of bgp_speaker to update.

This command is provided by the python-neutronclient plugin.

dhcp-agent-list-hosting-net¶

List DHCP agents hosting a network.

neutron dhcp-agent-list-hosting-net
    [-f {csv,json,table,value,yaml}]
    [-c COLUMN]
    [--quote {all,minimal,none,nonnumeric}]
    [--noindent]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [-D]
    [-F FIELD]
    NETWORK

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--quote <QUOTE_MODE>¶: when to include quotes, defaults to nonnumeric

--noindent¶: whether to disable indenting the JSON

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

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

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

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

-D, --show-details¶: Show detailed information.

-F FIELD, --field FIELD¶: Specify the field(s) to be returned by server. You can repeat this option.

NETWORK¶: Network to query.

This command is provided by the python-neutronclient plugin.

dhcp-agent-network-add¶

Add a network to a DHCP agent.

neutron dhcp-agent-network-add DHCP_AGENT NETWORK

DHCP_AGENT¶: ID of the DHCP agent.

NETWORK¶: Network to add.

This command is provided by the python-neutronclient plugin.

dhcp-agent-network-remove¶

Remove a network from a DHCP agent.

neutron dhcp-agent-network-remove DHCP_AGENT NETWORK

DHCP_AGENT¶: ID of the DHCP agent.

NETWORK¶: Network to remove.

This command is provided by the python-neutronclient plugin.

ext-list¶

List all extensions.

neutron ext-list
    [-f {csv,json,table,value,yaml}]
    [-c COLUMN]
    [--quote {all,minimal,none,nonnumeric}]
    [--noindent]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [-D]
    [-F FIELD]

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--quote <QUOTE_MODE>¶: when to include quotes, defaults to nonnumeric

--noindent¶: whether to disable indenting the JSON

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

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

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

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

-D, --show-details¶: Show detailed information.

-F FIELD, --field FIELD¶: Specify the field(s) to be returned by server. You can repeat this option.

This command is provided by the python-neutronclient plugin.

ext-show¶

Show information of a given resource.

neutron ext-show
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [-D]
    [-F FIELD]
    EXTENSION

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

-D, --show-details¶: Show detailed information.

-F FIELD, --field FIELD¶: Specify the field(s) to be returned by server. You can repeat this option.

EXTENSION¶: ID of extension to look up.

This command is provided by the python-neutronclient plugin.

firewall-create¶

Create a firewall.

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

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

--tenant-id TENANT_ID¶: The owner tenant ID.

--name <NAME>¶: Name for the firewall.

--description <DESCRIPTION>¶: Description for the firewall.

--router ROUTER¶: ID or name of the router associated with the firewall (requires FWaaS router insertion extension to be enabled). 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.

POLICY¶: ID or name of the firewall policy associated to this firewall.

This command is provided by the python-neutronclient plugin.

firewall-delete¶

Delete a given firewall.

neutron firewall-delete FIREWALL [FIREWALL ...]

FIREWALL¶: ID(s) or name(s) of firewall to delete.

This command is provided by the python-neutronclient plugin.

firewall-list¶

List firewalls that belong to a given tenant.

neutron firewall-list
    [-f {csv,json,table,value,yaml}]
    [-c COLUMN]
    [--quote {all,minimal,none,nonnumeric}]
    [--noindent]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [-D]
    [-F FIELD]
    [-P SIZE]
    [--sort-key FIELD]
    [--sort-dir {asc,desc}]

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--quote <QUOTE_MODE>¶: when to include quotes, defaults to nonnumeric

--noindent¶: whether to disable indenting the JSON

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

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

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

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

-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.

This command is provided by the python-neutronclient plugin.

firewall-policy-create¶

Create a firewall policy.

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

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

--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”

NAME¶: Name for the firewall policy.

This command is provided by the python-neutronclient plugin.

firewall-policy-delete¶

Delete a given firewall policy.

neutron firewall-policy-delete FIREWALL_POLICY [FIREWALL_POLICY ...]

FIREWALL_POLICY¶: ID(s) or name(s) of firewall_policy to delete.

This command is provided by the python-neutronclient plugin.

firewall-policy-insert-rule¶

Insert a rule into a given firewall policy.

neutron firewall-policy-insert-rule
    [--insert-before FIREWALL_RULE]
    [--insert-after FIREWALL_RULE]
    FIREWALL_POLICY
    FIREWALL_RULE

--insert-before FIREWALL_RULE¶: Insert before this rule.

--insert-after FIREWALL_RULE¶: Insert after this rule.

FIREWALL_POLICY¶: ID or name of firewall_policy to update.

FIREWALL_RULE¶: New rule to insert.

This command is provided by the python-neutronclient plugin.

firewall-policy-list¶

List firewall policies that belong to a given tenant.

neutron firewall-policy-list
    [-f {csv,json,table,value,yaml}]
    [-c COLUMN]
    [--quote {all,minimal,none,nonnumeric}]
    [--noindent]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [-D]
    [-F FIELD]
    [-P SIZE]
    [--sort-key FIELD]
    [--sort-dir {asc,desc}]

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--quote <QUOTE_MODE>¶: when to include quotes, defaults to nonnumeric

--noindent¶: whether to disable indenting the JSON

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

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

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

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

-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.

This command is provided by the python-neutronclient plugin.

firewall-policy-remove-rule¶

Remove a rule from a given firewall policy.

neutron firewall-policy-remove-rule FIREWALL_POLICY FIREWALL_RULE

FIREWALL_POLICY¶: ID or name of firewall_policy to update.

FIREWALL_RULE¶: ID or name of the firewall rule to be removed from the policy.

This command is provided by the python-neutronclient plugin.

firewall-policy-show¶

Show information of a given firewall policy.

neutron firewall-policy-show
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [-D]
    [-F FIELD]
    FIREWALL_POLICY

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

-D, --show-details¶: Show detailed information.

-F FIELD, --field FIELD¶: Specify the field(s) to be returned by server. You can repeat this option.

FIREWALL_POLICY¶: ID or name of firewall_policy to look up.

This command is provided by the python-neutronclient plugin.

firewall-policy-update¶

Update a given firewall policy.

neutron firewall-policy-update
    [--description DESCRIPTION]
    [--firewall-rules FIREWALL_RULES]
    [--name NAME]
    [--shared {True,False}]
    [--audited {True,False}]
    FIREWALL_POLICY

--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).

FIREWALL_POLICY¶: ID or name of firewall_policy to update.

This command is provided by the python-neutronclient plugin.

firewall-rule-create¶

Create a firewall rule.

neutron firewall-rule-create
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--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}]

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

--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 <PROTOCOL>¶: Protocol for the firewall rule.

--action <ACTION>¶: Action for the firewall rule.

--ip-version <IP_VERSION>¶: IP version for the firewall rule (default is 4).

This command is provided by the python-neutronclient plugin.

firewall-rule-delete¶

Delete a given firewall rule.

neutron firewall-rule-delete FIREWALL_RULE [FIREWALL_RULE ...]

FIREWALL_RULE¶: ID(s) or name(s) of firewall_rule to delete.

This command is provided by the python-neutronclient plugin.

firewall-rule-list¶

List firewall rules that belong to a given tenant.

neutron firewall-rule-list
    [-f {csv,json,table,value,yaml}]
    [-c COLUMN]
    [--quote {all,minimal,none,nonnumeric}]
    [--noindent]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [-D]
    [-F FIELD]
    [-P SIZE]
    [--sort-key FIELD]
    [--sort-dir {asc,desc}]

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--quote <QUOTE_MODE>¶: when to include quotes, defaults to nonnumeric

--noindent¶: whether to disable indenting the JSON

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

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

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

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

-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.

This command is provided by the python-neutronclient plugin.

firewall-rule-show¶

Show information of a given firewall rule.

neutron firewall-rule-show
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [-D]
    [-F FIELD]
    FIREWALL_RULE

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

-D, --show-details¶: Show detailed information.

-F FIELD, --field FIELD¶: Specify the field(s) to be returned by server. You can repeat this option.

FIREWALL_RULE¶: ID or name of firewall_rule to look up.

This command is provided by the python-neutronclient plugin.

firewall-rule-update¶

Update a given firewall rule.

neutron firewall-rule-update
    [--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

--shared {True,False}¶: Update the shared flag for the firewall rule.

--ip-version <IP_VERSION>¶: 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 <PROTOCOL>¶: Protocol for the firewall rule.

--action <ACTION>¶: Action for the firewall rule.

FIREWALL_RULE¶: ID or name of firewall_rule to update.

This command is provided by the python-neutronclient plugin.

firewall-show¶

Show information of a given firewall.

neutron firewall-show
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [-D]
    [-F FIELD]
    FIREWALL

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

-D, --show-details¶: Show detailed information.

-F FIELD, --field FIELD¶: Specify the field(s) to be returned by server. You can repeat this option.

FIREWALL¶: ID or name of firewall to look up.

This command is provided by the python-neutronclient plugin.

firewall-update¶

Update a given firewall.

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

--name <NAME>¶: Name for the firewall.

--description <DESCRIPTION>¶: Description for the firewall.

--router ROUTER¶: ID or name of the router associated with the firewall (requires FWaaS router insertion extension to be enabled). This option can be repeated.

--no-routers¶: Associate no routers with the firewall (requires FWaaS router insertion extension).

--policy POLICY¶: ID or name of the firewall policy associated to this firewall.

--admin-state-up {True,False}¶: Update the admin state for the firewall (True means UP).

FIREWALL¶: ID or name of firewall to update.

This command is provided by the python-neutronclient plugin.

flavor-associate¶

Associate a Neutron service flavor with a flavor profile.

neutron flavor-associate FLAVOR FLAVOR_PROFILE

FLAVOR¶: ID or name of the flavor to associate.

FLAVOR_PROFILE¶: ID of the flavor profile to be associated with the flavor.

This command is provided by the python-neutronclient plugin.

flavor-create¶

Create a Neutron service flavor.

neutron flavor-create
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--tenant-id TENANT_ID]
    [--description DESCRIPTION]
    [--enabled {True,False}]
    NAME
    SERVICE_TYPE

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

--tenant-id TENANT_ID¶: The owner tenant ID.

--description <DESCRIPTION>¶: Description for the flavor.

--enabled {True,False}¶: Sets enabled flag.

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.)

This command is provided by the python-neutronclient plugin.

flavor-delete¶

Delete a given Neutron service flavor.

neutron flavor-delete FLAVOR [FLAVOR ...]

FLAVOR¶: ID(s) or name(s) of flavor to delete.

This command is provided by the python-neutronclient plugin.

flavor-disassociate¶

Disassociate a Neutron service flavor from a flavor profile.

neutron flavor-disassociate FLAVOR FLAVOR_PROFILE

FLAVOR¶: ID or name of the flavor to be disassociated.

FLAVOR_PROFILE¶: ID of the flavor profile to be disassociated from the flavor.

This command is provided by the python-neutronclient plugin.

flavor-list¶

List Neutron service flavors.

neutron flavor-list
    [-f {csv,json,table,value,yaml}]
    [-c COLUMN]
    [--quote {all,minimal,none,nonnumeric}]
    [--noindent]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [-D]
    [-F FIELD]
    [-P SIZE]
    [--sort-key FIELD]
    [--sort-dir {asc,desc}]

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--quote <QUOTE_MODE>¶: when to include quotes, defaults to nonnumeric

--noindent¶: whether to disable indenting the JSON

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

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

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

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

-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.

This command is provided by the python-neutronclient plugin.

flavor-profile-create¶

Create a Neutron service flavor profile.

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

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

--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.

This command is provided by the python-neutronclient plugin.

flavor-profile-delete¶

Delete a given Neutron service flavor profile.

neutron flavor-profile-delete SERVICE_PROFILE [SERVICE_PROFILE ...]

SERVICE_PROFILE¶: ID(s) or name(s) of service_profile to delete.

This command is provided by the python-neutronclient plugin.

flavor-profile-list¶

List Neutron service flavor profiles.

neutron flavor-profile-list
    [-f {csv,json,table,value,yaml}]
    [-c COLUMN]
    [--quote {all,minimal,none,nonnumeric}]
    [--noindent]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [-D]
    [-F FIELD]
    [-P SIZE]
    [--sort-key FIELD]
    [--sort-dir {asc,desc}]

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--quote <QUOTE_MODE>¶: when to include quotes, defaults to nonnumeric

--noindent¶: whether to disable indenting the JSON

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

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

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

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

-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.

This command is provided by the python-neutronclient plugin.

flavor-profile-show¶

Show information about a given Neutron service flavor profile.

neutron flavor-profile-show
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [-D]
    [-F FIELD]
    SERVICE_PROFILE

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

-D, --show-details¶: Show detailed information.

-F FIELD, --field FIELD¶: Specify the field(s) to be returned by server. You can repeat this option.

SERVICE_PROFILE¶: ID or name of service_profile to look up.

This command is provided by the python-neutronclient plugin.

flavor-profile-update¶

Update a given Neutron service flavor profile.

neutron flavor-profile-update
    [--description DESCRIPTION]
    [--driver DRIVER]
    [--metainfo METAINFO]
    [--enabled {True,False}]
    SERVICE_PROFILE

--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.

SERVICE_PROFILE¶: ID or name of service_profile to update.

This command is provided by the python-neutronclient plugin.

flavor-show¶

Show information about a given Neutron service flavor.

neutron flavor-show
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [-D]
    [-F FIELD]
    FLAVOR

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

-D, --show-details¶: Show detailed information.

-F FIELD, --field FIELD¶: Specify the field(s) to be returned by server. You can repeat this option.

FLAVOR¶: ID or name of flavor to look up.

This command is provided by the python-neutronclient plugin.

flavor-update¶

Update a Neutron service flavor.

neutron flavor-update
    [--name NAME]
    [--description DESCRIPTION]
    [--enabled {True,False}]
    FLAVOR

--name <NAME>¶: Name for the flavor.

--description <DESCRIPTION>¶: Description for the flavor.

--enabled {True,False}¶: Sets enabled flag.

FLAVOR¶: ID or name of flavor to update.

This command is provided by the python-neutronclient plugin.

floatingip-associate¶

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

neutron floatingip-associate
    [--fixed-ip-address FIXED_IP_ADDRESS]
    FLOATINGIP_ID
    PORT

--fixed-ip-address <FIXED_IP_ADDRESS>¶: IP address on the port (only required if port has multiple IPs).

FLOATINGIP_ID¶: ID of the floating IP to associate.

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

This command is provided by the python-neutronclient plugin.

floatingip-create¶

Create a floating IP for a given tenant.

neutron floatingip-create
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--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

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

--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)

FLOATING_NETWORK¶: ID or name of the network from which the floating IP is allocated.

This command is provided by the python-neutronclient plugin.

floatingip-delete¶

Delete a given floating IP.

neutron floatingip-delete FLOATINGIP [FLOATINGIP ...]

FLOATINGIP¶: ID(s) of floatingip to delete.

This command is provided by the python-neutronclient plugin.

floatingip-disassociate¶

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

neutron floatingip-disassociate FLOATINGIP_ID

FLOATINGIP_ID¶: ID of the floating IP to disassociate.

This command is provided by the python-neutronclient plugin.

floatingip-list¶

List floating IPs that belong to a given tenant.

neutron floatingip-list
    [-f {csv,json,table,value,yaml}]
    [-c COLUMN]
    [--quote {all,minimal,none,nonnumeric}]
    [--noindent]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [-D]
    [-F FIELD]
    [-P SIZE]
    [--sort-key FIELD]
    [--sort-dir {asc,desc}]

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--quote <QUOTE_MODE>¶: when to include quotes, defaults to nonnumeric

--noindent¶: whether to disable indenting the JSON

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

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

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

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

-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.

This command is provided by the python-neutronclient plugin.

floatingip-show¶

Show information of a given floating IP.

neutron floatingip-show
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [-D]
    [-F FIELD]
    FLOATINGIP

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

-D, --show-details¶: Show detailed information.

-F FIELD, --field FIELD¶: Specify the field(s) to be returned by server. You can repeat this option.

FLOATINGIP¶: ID of floatingip to look up.

This command is provided by the python-neutronclient plugin.

ipsec-site-connection-create¶

Create an IPsec site connection.

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

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

--tenant-id TENANT_ID¶: The owner tenant ID.

--admin-state-down¶: Set admin state up to false.

--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.

--name <NAME>¶: Set friendly name for the connection.

--description <DESCRIPTION>¶: Set a description for the connection.

--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.

--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.

--peer-id <PEER_ID>¶: Peer router identity for authentication. Can be IPv4/IPv6 address, e-mail address, key id, or FQDN.

--peer-address <PEER_ADDRESS>¶: Peer gateway public IPv4/IPv6 address or FQDN.

--psk <PSK>¶: Pre-shared key string.

--mtu <MTU>¶: MTU size for the connection, default:1500.

--initiator <INITIATOR>¶: Initiator state in lowercase, default:bi-directional

This command is provided by the python-neutronclient plugin.

ipsec-site-connection-delete¶

Delete a given IPsec site connection.

neutron ipsec-site-connection-delete
    IPSEC_SITE_CONNECTION
    [IPSEC_SITE_CONNECTION ...]

IPSEC_SITE_CONNECTION¶: ID(s) or name(s) of IPsec site connection to delete.

This command is provided by the python-neutronclient plugin.

ipsec-site-connection-list¶

List IPsec site connections that belong to a given tenant.

neutron ipsec-site-connection-list
    [-f {csv,json,table,value,yaml}]
    [-c COLUMN]
    [--quote {all,minimal,none,nonnumeric}]
    [--noindent]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [-D]
    [-F FIELD]
    [-P SIZE]
    [--sort-key FIELD]
    [--sort-dir {asc,desc}]

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--quote <QUOTE_MODE>¶: when to include quotes, defaults to nonnumeric

--noindent¶: whether to disable indenting the JSON

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

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

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

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

-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.

This command is provided by the python-neutronclient plugin.

ipsec-site-connection-show¶

Show information of a given IPsec site connection.

neutron ipsec-site-connection-show
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [-D]
    [-F FIELD]
    IPSEC_SITE_CONNECTION

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

-D, --show-details¶: Show detailed information.

-F FIELD, --field FIELD¶: Specify the field(s) to be returned by server. You can repeat this option.

IPSEC_SITE_CONNECTION¶: ID or name of IPsec site connection to look up.

This command is provided by the python-neutronclient plugin.

ipsec-site-connection-update¶

Update a given IPsec site connection.

neutron ipsec-site-connection-update
    [--admin-state-up {True,False}]
    [--name NAME]
    [--description DESCRIPTION]
    [--dpd action=ACTION,interval=INTERVAL,timeout=TIMEOUT]
    [--local-ep-group LOCAL_EP_GROUP]
    [--peer-ep-group PEER_EP_GROUP]
    [--peer-cidr PEER_CIDRS]
    [--peer-id PEER_ID]
    [--peer-address PEER_ADDRESS]
    [--psk PSK]
    [--mtu MTU]
    [--initiator {bi-directional,response-only}]
    IPSEC_SITE_CONNECTION

--admin-state-up {True,False}¶: Update the administrative state. (True meaning “Up”)

--name <NAME>¶: Set friendly name for the connection.

--description <DESCRIPTION>¶: Set a description for the connection.

--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.

--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.

--peer-id <PEER_ID>¶: Peer router identity for authentication. Can be IPv4/IPv6 address, e-mail address, key id, or FQDN.

--peer-address <PEER_ADDRESS>¶: Peer gateway public IPv4/IPv6 address or FQDN.

--psk <PSK>¶: Pre-shared key string.

--mtu <MTU>¶: MTU size for the connection, default:1500.

--initiator <INITIATOR>¶: Initiator state in lowercase, default:bi-directional

IPSEC_SITE_CONNECTION¶: ID or name of IPsec site connection to update.

This command is provided by the python-neutronclient plugin.

l3-agent-list-hosting-router¶

List L3 agents hosting a router.

neutron l3-agent-list-hosting-router
    [-f {csv,json,table,value,yaml}]
    [-c COLUMN]
    [--quote {all,minimal,none,nonnumeric}]
    [--noindent]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [-D]
    [-F FIELD]
    ROUTER

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--quote <QUOTE_MODE>¶: when to include quotes, defaults to nonnumeric

--noindent¶: whether to disable indenting the JSON

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

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

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

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

-D, --show-details¶: Show detailed information.

-F FIELD, --field FIELD¶: Specify the field(s) to be returned by server. You can repeat this option.

ROUTER¶: Router to query.

This command is provided by the python-neutronclient plugin.

l3-agent-router-add¶

Add a router to a L3 agent.

neutron l3-agent-router-add L3_AGENT ROUTER

L3_AGENT¶: ID of the L3 agent.

ROUTER¶: Router to add.

This command is provided by the python-neutronclient plugin.

l3-agent-router-remove¶

Remove a router from a L3 agent.

neutron l3-agent-router-remove L3_AGENT ROUTER

L3_AGENT¶: ID of the L3 agent.

ROUTER¶: Router to remove.

This command is provided by the python-neutronclient plugin.

lb-agent-hosting-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

neutron lb-agent-hosting-pool
    [-f {csv,json,table,value,yaml}]
    [-c COLUMN]
    [--quote {all,minimal,none,nonnumeric}]
    [--noindent]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [-D]
    [-F FIELD]
    POOL

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--quote <QUOTE_MODE>¶: when to include quotes, defaults to nonnumeric

--noindent¶: whether to disable indenting the JSON

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

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

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

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

-D, --show-details¶: Show detailed information.

-F FIELD, --field FIELD¶: Specify the field(s) to be returned by server. You can repeat this option.

POOL¶: Pool to query.

This command is provided by the python-neutronclient plugin.

lb-healthmonitor-associate¶

Create a mapping between a health monitor and a pool.

neutron lb-healthmonitor-associate HEALTH_MONITOR_ID POOL

HEALTH_MONITOR_ID¶: Health monitor to associate.

POOL¶: ID of the pool to be associated with the health monitor.

This command is provided by the python-neutronclient plugin.

lb-healthmonitor-create¶

Create a health monitor.

neutron lb-healthmonitor-create
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--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}

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

--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 <TYPE>¶: One of the predefined health monitor types.

This command is provided by the python-neutronclient plugin.

lb-healthmonitor-delete¶

Delete a given health monitor.

neutron lb-healthmonitor-delete HEALTH_MONITOR [HEALTH_MONITOR ...]

HEALTH_MONITOR¶: ID(s) of health_monitor to delete.

This command is provided by the python-neutronclient plugin.

lb-healthmonitor-disassociate¶

Remove a mapping from a health monitor to a pool.

neutron lb-healthmonitor-disassociate HEALTH_MONITOR_ID POOL

HEALTH_MONITOR_ID¶: Health monitor to disassociate.

POOL¶: ID of the pool to be disassociated with the health monitor.

This command is provided by the python-neutronclient plugin.

lb-healthmonitor-list¶

List health monitors that belong to a given tenant.

neutron lb-healthmonitor-list
    [-f {csv,json,table,value,yaml}]
    [-c COLUMN]
    [--quote {all,minimal,none,nonnumeric}]
    [--noindent]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [-D]
    [-F FIELD]
    [-P SIZE]
    [--sort-key FIELD]
    [--sort-dir {asc,desc}]

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--quote <QUOTE_MODE>¶: when to include quotes, defaults to nonnumeric

--noindent¶: whether to disable indenting the JSON

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

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

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

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

-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.

This command is provided by the python-neutronclient plugin.

lb-healthmonitor-show¶

Show information of a given health monitor.

neutron lb-healthmonitor-show
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [-D]
    [-F FIELD]
    HEALTH_MONITOR

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

-D, --show-details¶: Show detailed information.

-F FIELD, --field FIELD¶: Specify the field(s) to be returned by server. You can repeat this option.

HEALTH_MONITOR¶: ID of health_monitor to look up.

This command is provided by the python-neutronclient plugin.

lb-healthmonitor-update¶

Update a given health monitor.

neutron lb-healthmonitor-update HEALTH_MONITOR

HEALTH_MONITOR¶: ID of health_monitor to update.

This command is provided by the python-neutronclient plugin.

lb-member-create¶

Create a member.

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

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

--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.

POOL¶: ID or name of the pool this vip belongs to.

This command is provided by the python-neutronclient plugin.

lb-member-delete¶

Delete a given member.

neutron lb-member-delete MEMBER [MEMBER ...]

MEMBER¶: ID(s) or name(s) of member to delete.

This command is provided by the python-neutronclient plugin.

lb-member-list¶

List members that belong to a given tenant.

neutron lb-member-list
    [-f {csv,json,table,value,yaml}]
    [-c COLUMN]
    [--quote {all,minimal,none,nonnumeric}]
    [--noindent]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [-D]
    [-F FIELD]
    [-P SIZE]
    [--sort-key FIELD]
    [--sort-dir {asc,desc}]

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--quote <QUOTE_MODE>¶: when to include quotes, defaults to nonnumeric

--noindent¶: whether to disable indenting the JSON

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

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

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

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

-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.

This command is provided by the python-neutronclient plugin.

lb-member-show¶

Show information of a given member.

neutron lb-member-show
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [-D]
    [-F FIELD]
    MEMBER

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

-D, --show-details¶: Show detailed information.

-F FIELD, --field FIELD¶: Specify the field(s) to be returned by server. You can repeat this option.

MEMBER¶: ID of member to look up.

This command is provided by the python-neutronclient plugin.

lb-member-update¶

Update a given member.

neutron lb-member-update MEMBER

MEMBER¶: ID or name of member to update.

This command is provided by the python-neutronclient plugin.

lb-pool-create¶

Create a pool.

neutron lb-pool-create
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--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]

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

--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 <LB_METHOD>¶: The algorithm used to distribute load between the members of the pool.

--name <NAME>¶: The name of the pool.

--protocol <PROTOCOL>¶: Protocol for balancing.

--subnet-id SUBNET¶: The subnet on which the members of the pool will be located.

--provider <PROVIDER>¶: Provider name of the loadbalancer service.

This command is provided by the python-neutronclient plugin.

lb-pool-delete¶

Delete a given pool.

neutron lb-pool-delete POOL [POOL ...]

POOL¶: ID(s) or name(s) of pool to delete.

This command is provided by the python-neutronclient plugin.

lb-pool-list¶

List pools that belong to a given tenant.

neutron lb-pool-list
    [-f {csv,json,table,value,yaml}]
    [-c COLUMN]
    [--quote {all,minimal,none,nonnumeric}]
    [--noindent]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [-D]
    [-F FIELD]
    [-P SIZE]
    [--sort-key FIELD]
    [--sort-dir {asc,desc}]

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--quote <QUOTE_MODE>¶: when to include quotes, defaults to nonnumeric

--noindent¶: whether to disable indenting the JSON

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

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

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

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

-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.

This command is provided by the python-neutronclient plugin.

lb-pool-list-on-agent¶

List the pools on a loadbalancer agent.

neutron lb-pool-list-on-agent
    [-f {csv,json,table,value,yaml}]
    [-c COLUMN]
    [--quote {all,minimal,none,nonnumeric}]
    [--noindent]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [-D]
    [-F FIELD]
    LBAAS_AGENT

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--quote <QUOTE_MODE>¶: when to include quotes, defaults to nonnumeric

--noindent¶: whether to disable indenting the JSON

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

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

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

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

-D, --show-details¶: Show detailed information.

-F FIELD, --field FIELD¶: Specify the field(s) to be returned by server. You can repeat this option.

LBAAS_AGENT¶: ID of the loadbalancer agent to query.

This command is provided by the python-neutronclient plugin.

lb-pool-show¶

Show information of a given pool.

neutron lb-pool-show
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [-D]
    [-F FIELD]
    POOL

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

-D, --show-details¶: Show detailed information.

-F FIELD, --field FIELD¶: Specify the field(s) to be returned by server. You can repeat this option.

POOL¶: ID or name of pool to look up.

This command is provided by the python-neutronclient plugin.

lb-pool-stats¶

Retrieve stats for a given pool.

neutron lb-pool-stats
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [-D]
    [-F FIELD]
    POOL

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

-D, --show-details¶: Show detailed information.

-F FIELD, --field FIELD¶: Specify the field(s) to be returned by server. You can repeat this option.

POOL¶: ID or name of pool to look up.

This command is provided by the python-neutronclient plugin.

lb-pool-update¶

Update a given pool.

neutron lb-pool-update POOL

POOL¶: ID or name of pool to update.

This command is provided by the python-neutronclient plugin.

lb-vip-create¶

Create a vip.

neutron lb-vip-create
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--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

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

--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. Valid values: a positive integer or -1 for unlimited (default).

--description <DESCRIPTION>¶: Description of the vip to be created.

--name <NAME>¶: Name of the vip to be created.

--protocol-port <PROTOCOL_PORT>¶: TCP port on which to listen for client traffic that is associated with the vip address.

--protocol <PROTOCOL>¶: Protocol for balancing.

--subnet-id SUBNET¶: The subnet on which to allocate the vip address.

POOL¶: ID or name of the pool to which this vip belongs.

This command is provided by the python-neutronclient plugin.

lb-vip-delete¶

Delete a given vip.

neutron lb-vip-delete VIP [VIP ...]

VIP¶: ID(s) or name(s) of vip to delete.

This command is provided by the python-neutronclient plugin.

lb-vip-list¶

List vips that belong to a given tenant.

neutron lb-vip-list
    [-f {csv,json,table,value,yaml}]
    [-c COLUMN]
    [--quote {all,minimal,none,nonnumeric}]
    [--noindent]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [-D]
    [-F FIELD]
    [-P SIZE]
    [--sort-key FIELD]
    [--sort-dir {asc,desc}]

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--quote <QUOTE_MODE>¶: when to include quotes, defaults to nonnumeric

--noindent¶: whether to disable indenting the JSON

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

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

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

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

-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.

This command is provided by the python-neutronclient plugin.

lb-vip-show¶

Show information of a given vip.

neutron lb-vip-show
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [-D]
    [-F FIELD]
    VIP

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

-D, --show-details¶: Show detailed information.

-F FIELD, --field FIELD¶: Specify the field(s) to be returned by server. You can repeat this option.

VIP¶: ID or name of vip to look up.

This command is provided by the python-neutronclient plugin.

lb-vip-update¶

Update a given vip.

neutron lb-vip-update VIP

VIP¶: ID or name of vip to update.

This command is provided by the python-neutronclient plugin.

lbaas-agent-hosting-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

neutron lbaas-agent-hosting-loadbalancer
    [-f {csv,json,table,value,yaml}]
    [-c COLUMN]
    [--quote {all,minimal,none,nonnumeric}]
    [--noindent]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [-D]
    [-F FIELD]
    LOADBALANCER

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--quote <QUOTE_MODE>¶: when to include quotes, defaults to nonnumeric

--noindent¶: whether to disable indenting the JSON

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

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

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

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

-D, --show-details¶: Show detailed information.

-F FIELD, --field FIELD¶: Specify the field(s) to be returned by server. You can repeat this option.

LOADBALANCER¶: LoadBalancer to query.

This command is provided by the python-neutronclient plugin.

lbaas-healthmonitor-create¶

LBaaS v2 Create a healthmonitor.

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

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

--tenant-id TENANT_ID¶: The owner tenant ID.

--delay <DELAY>¶: The time in seconds between sending probes to members.

--name <NAME>¶: Name of the health monitor.

--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.

--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).

--max-retries <MAX_RETRIES>¶: Number of permissible connection failures before changing the member status to INACTIVE. [1..10].

--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”.

--admin-state-down¶: Set admin state up to false.

--type <TYPE>¶: One of the predefined health monitor types.

--pool <POOL>¶: ID or name of the pool that this healthmonitor will monitor.

This command is provided by the python-neutronclient plugin.

lbaas-healthmonitor-delete¶

LBaaS v2 Delete a given healthmonitor.

neutron lbaas-healthmonitor-delete HEALTHMONITOR [HEALTHMONITOR ...]

HEALTHMONITOR¶: ID(s) or name(s) of healthmonitor to delete.

This command is provided by the python-neutronclient plugin.

lbaas-healthmonitor-list¶

LBaaS v2 List healthmonitors that belong to a given tenant.

neutron lbaas-healthmonitor-list
    [-f {csv,json,table,value,yaml}]
    [-c COLUMN]
    [--quote {all,minimal,none,nonnumeric}]
    [--noindent]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [-D]
    [-F FIELD]
    [-P SIZE]
    [--sort-key FIELD]
    [--sort-dir {asc,desc}]

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--quote <QUOTE_MODE>¶: when to include quotes, defaults to nonnumeric

--noindent¶: whether to disable indenting the JSON

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

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

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

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

-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.

This command is provided by the python-neutronclient plugin.

lbaas-healthmonitor-show¶

LBaaS v2 Show information of a given healthmonitor.

neutron lbaas-healthmonitor-show
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [-D]
    [-F FIELD]
    HEALTHMONITOR

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

-D, --show-details¶: Show detailed information.

-F FIELD, --field FIELD¶: Specify the field(s) to be returned by server. You can repeat this option.

HEALTHMONITOR¶: ID or name of healthmonitor to look up.

This command is provided by the python-neutronclient plugin.

lbaas-healthmonitor-update¶

LBaaS v2 Update a given healthmonitor.

neutron lbaas-healthmonitor-update
    [--delay DELAY]
    [--name NAME]
    [--timeout TIMEOUT]
    [--http-method HTTP_METHOD]
    [--url-path URL_PATH]
    [--max-retries MAX_RETRIES]
    [--expected-codes EXPECTED_CODES]
    [--admin-state-up {True,False}]
    HEALTHMONITOR

--delay <DELAY>¶: The time in seconds between sending probes to members.

--name <NAME>¶: Name of the health monitor.

--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.

--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).

--max-retries <MAX_RETRIES>¶: Number of permissible connection failures before changing the member status to INACTIVE. [1..10].

--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”.

--admin-state-up {True,False}¶: Update the administrative state of the health monitor (True meaning “Up”).

HEALTHMONITOR¶: ID or name of healthmonitor to update.

This command is provided by the python-neutronclient plugin.

lbaas-l7policy-create¶

LBaaS v2 Create L7 policy.

neutron lbaas-l7policy-create
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--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

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

--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.

This command is provided by the python-neutronclient plugin.

lbaas-l7policy-delete¶

LBaaS v2 Delete a given L7 policy.

neutron lbaas-l7policy-delete L7POLICY [L7POLICY ...]

L7POLICY¶: ID(s) or name(s) of l7policy to delete.

This command is provided by the python-neutronclient plugin.

lbaas-l7policy-list¶

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

neutron lbaas-l7policy-list
    [-f {csv,json,table,value,yaml}]
    [-c COLUMN]
    [--quote {all,minimal,none,nonnumeric}]
    [--noindent]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [-D]
    [-F FIELD]
    [-P SIZE]
    [--sort-key FIELD]
    [--sort-dir {asc,desc}]

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--quote <QUOTE_MODE>¶: when to include quotes, defaults to nonnumeric

--noindent¶: whether to disable indenting the JSON

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

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

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

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

-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.

This command is provided by the python-neutronclient plugin.

lbaas-l7policy-show¶

LBaaS v2 Show information of a given L7 policy.

neutron lbaas-l7policy-show
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [-D]
    [-F FIELD]
    L7POLICY

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

-D, --show-details¶: Show detailed information.

-F FIELD, --field FIELD¶: Specify the field(s) to be returned by server. You can repeat this option.

L7POLICY¶: ID or name of l7policy to look up.

This command is provided by the python-neutronclient plugin.

lbaas-l7policy-update¶

LBaaS v2 Update a given L7 policy.

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

--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”).

L7POLICY¶: ID or name of l7policy to update.

This command is provided by the python-neutronclient plugin.

lbaas-l7rule-create¶

LBaaS v2 Create L7 rule.

neutron lbaas-l7rule-create
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--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

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

--tenant-id TENANT_ID¶: The owner tenant ID.

--type <TYPE>¶: Rule type.

--compare-type <COMPARE_TYPE>¶: 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

L7POLICY¶: ID or name of L7 policy this rule belongs to.

This command is provided by the python-neutronclient plugin.

lbaas-l7rule-delete¶

LBaaS v2 Delete a given L7 rule.

neutron lbaas-l7rule-delete RULE [RULE ...] L7POLICY

RULE¶: ID(s) or name(s) of rule to delete.

L7POLICY¶: ID or name of L7 policy this rule belongs to.

This command is provided by the python-neutronclient plugin.

lbaas-l7rule-list¶

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

neutron lbaas-l7rule-list
    [-f {csv,json,table,value,yaml}]
    [-c COLUMN]
    [--quote {all,minimal,none,nonnumeric}]
    [--noindent]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [-D]
    [-F FIELD]
    [-P SIZE]
    [--sort-key FIELD]
    [--sort-dir {asc,desc}]
    L7POLICY

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--quote <QUOTE_MODE>¶: when to include quotes, defaults to nonnumeric

--noindent¶: whether to disable indenting the JSON

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

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

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

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

-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.

L7POLICY¶: ID or name of L7 policy this rule belongs to.

This command is provided by the python-neutronclient plugin.

lbaas-l7rule-show¶

LBaaS v2 Show information of a given rule.

neutron lbaas-l7rule-show
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [-D]
    [-F FIELD]
    RULE
    L7POLICY

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

-D, --show-details¶: Show detailed information.

-F FIELD, --field FIELD¶: Specify the field(s) to be returned by server. You can repeat this option.

RULE¶: ID or name of rule to look up.

L7POLICY¶: ID or name of L7 policy this rule belongs to.

This command is provided by the python-neutronclient plugin.

lbaas-l7rule-update¶

LBaaS v2 Update a given L7 rule.

neutron lbaas-l7rule-update
    [--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

--type <TYPE>¶: Rule type.

--compare-type <COMPARE_TYPE>¶: 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”).

RULE¶: ID or name of rule to update.

L7POLICY¶: ID or name of L7 policy this rule belongs to.

This command is provided by the python-neutronclient plugin.

lbaas-listener-create¶

LBaaS v2 Create a listener.

neutron lbaas-listener-create
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--tenant-id TENANT_ID]
    [--description DESCRIPTION]
    [--connection-limit CONNECTION_LIMIT]
    [--default-pool DEFAULT_POOL]
    [--admin-state-down]
    [--name NAME]
    [--default-tls-container-ref DEFAULT_TLS_CONTAINER_REF]
    [--sni-container-refs SNI_CONTAINER_REFS [SNI_CONTAINER_REFS ...]]
    [--loadbalancer LOADBALANCER]
    --protocol
    {TCP,HTTP,HTTPS,TERMINATED_HTTPS}
    --protocol-port PORT

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

--tenant-id TENANT_ID¶: The owner tenant ID.

--description <DESCRIPTION>¶: Description of the listener.

--connection-limit <CONNECTION_LIMIT>¶: The maximum number of connections per second allowed for the listener. Positive integer or -1 for unlimited (default).

--default-pool <DEFAULT_POOL>¶: Default pool for the listener.

--admin-state-down¶: Set admin state up to false.

--name <NAME>¶: The name of the listener. At least one of –default-pool or –loadbalancer must be specified.

--default-tls-container-ref <DEFAULT_TLS_CONTAINER_REF>¶: Default TLS container reference to retrieve TLS information.

--sni-container-refs <SNI_CONTAINER_REFS>¶: List of TLS container references for SNI.

--loadbalancer LOADBALANCER¶: ID or name of the load balancer.

--protocol <PROTOCOL>¶: Protocol for the listener.

--protocol-port PORT¶: Protocol port for the listener.

This command is provided by the python-neutronclient plugin.

lbaas-listener-delete¶

LBaaS v2 Delete a given listener.

neutron lbaas-listener-delete LISTENER [LISTENER ...]

LISTENER¶: ID(s) or name(s) of listener to delete.

This command is provided by the python-neutronclient plugin.

lbaas-listener-list¶

LBaaS v2 List listeners that belong to a given tenant.

neutron lbaas-listener-list
    [-f {csv,json,table,value,yaml}]
    [-c COLUMN]
    [--quote {all,minimal,none,nonnumeric}]
    [--noindent]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [-D]
    [-F FIELD]
    [-P SIZE]
    [--sort-key FIELD]
    [--sort-dir {asc,desc}]

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--quote <QUOTE_MODE>¶: when to include quotes, defaults to nonnumeric

--noindent¶: whether to disable indenting the JSON

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

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

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

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

-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.

This command is provided by the python-neutronclient plugin.

lbaas-listener-show¶

LBaaS v2 Show information of a given listener.

neutron lbaas-listener-show
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [-D]
    [-F FIELD]
    LISTENER

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

-D, --show-details¶: Show detailed information.

-F FIELD, --field FIELD¶: Specify the field(s) to be returned by server. You can repeat this option.

LISTENER¶: ID or name of listener to look up.

This command is provided by the python-neutronclient plugin.

lbaas-listener-update¶

LBaaS v2 Update a given listener.

neutron lbaas-listener-update
    [--description DESCRIPTION]
    [--connection-limit CONNECTION_LIMIT]
    [--default-pool DEFAULT_POOL]
    [--name NAME]
    [--admin-state-up {True,False}]
    LISTENER

--description <DESCRIPTION>¶: Description of the listener.

--connection-limit <CONNECTION_LIMIT>¶: The maximum number of connections per second allowed for the listener. Positive integer or -1 for unlimited (default).

--default-pool <DEFAULT_POOL>¶: Default pool for the listener.

--name <NAME>¶: Name of the listener.

--admin-state-up {True,False}¶: Specify the administrative state of the listener. (True meaning “Up”)

LISTENER¶: ID or name of listener to update.

This command is provided by the python-neutronclient plugin.

lbaas-loadbalancer-create¶

LBaaS v2 Create a loadbalancer.

neutron lbaas-loadbalancer-create
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--tenant-id TENANT_ID]
    [--description DESCRIPTION]
    [--name NAME]
    [--admin-state-down]
    [--provider PROVIDER]
    [--flavor FLAVOR]
    [--vip-address VIP_ADDRESS]
    VIP_SUBNET

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

--tenant-id TENANT_ID¶: The owner tenant ID.

--description <DESCRIPTION>¶: Description of the load balancer.

--name NAME¶: Name of the load balancer.

--admin-state-down¶: Set admin state up to false.

--provider <PROVIDER>¶: Provider name of the load balancer service.

--flavor <FLAVOR>¶: ID or name of the flavor.

--vip-address <VIP_ADDRESS>¶: VIP address for the load balancer.

VIP_SUBNET¶: Load balancer VIP subnet.

This command is provided by the python-neutronclient plugin.

lbaas-loadbalancer-delete¶

LBaaS v2 Delete a given loadbalancer.

neutron lbaas-loadbalancer-delete LOADBALANCER [LOADBALANCER ...]

LOADBALANCER¶: ID(s) or name(s) of loadbalancer to delete.

This command is provided by the python-neutronclient plugin.

lbaas-loadbalancer-list¶

LBaaS v2 List loadbalancers that belong to a given tenant.

neutron lbaas-loadbalancer-list
    [-f {csv,json,table,value,yaml}]
    [-c COLUMN]
    [--quote {all,minimal,none,nonnumeric}]
    [--noindent]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [-D]
    [-F FIELD]
    [-P SIZE]
    [--sort-key FIELD]
    [--sort-dir {asc,desc}]

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--quote <QUOTE_MODE>¶: when to include quotes, defaults to nonnumeric

--noindent¶: whether to disable indenting the JSON

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

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

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

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

-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.

This command is provided by the python-neutronclient plugin.

lbaas-loadbalancer-list-on-agent¶

List the loadbalancers on a loadbalancer v2 agent.

neutron lbaas-loadbalancer-list-on-agent
    [-f {csv,json,table,value,yaml}]
    [-c COLUMN]
    [--quote {all,minimal,none,nonnumeric}]
    [--noindent]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [-D]
    [-F FIELD]
    LBAAS_AGENT

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--quote <QUOTE_MODE>¶: when to include quotes, defaults to nonnumeric

--noindent¶: whether to disable indenting the JSON

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

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

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

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

-D, --show-details¶: Show detailed information.

-F FIELD, --field FIELD¶: Specify the field(s) to be returned by server. You can repeat this option.

LBAAS_AGENT¶: ID of the loadbalancer agent to query.

This command is provided by the python-neutronclient plugin.

lbaas-loadbalancer-show¶

LBaaS v2 Show information of a given loadbalancer.

neutron lbaas-loadbalancer-show
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [-D]
    [-F FIELD]
    LOADBALANCER

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

-D, --show-details¶: Show detailed information.

-F FIELD, --field FIELD¶: Specify the field(s) to be returned by server. You can repeat this option.

LOADBALANCER¶: ID or name of loadbalancer to look up.

This command is provided by the python-neutronclient plugin.

lbaas-loadbalancer-stats¶

Retrieve stats for a given loadbalancer.

neutron lbaas-loadbalancer-stats
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [-D]
    [-F FIELD]
    LOADBALANCER

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

-D, --show-details¶: Show detailed information.

-F FIELD, --field FIELD¶: Specify the field(s) to be returned by server. You can repeat this option.

LOADBALANCER¶: ID or name of loadbalancer to look up.

This command is provided by the python-neutronclient plugin.

lbaas-loadbalancer-status¶

Retrieve status for a given loadbalancer.

The only output is a formatted JSON tree, and the table format does not support this type of data.

neutron lbaas-loadbalancer-status LOADBALANCER

LOADBALANCER¶: ID or name of loadbalancer to show.

This command is provided by the python-neutronclient plugin.

lbaas-loadbalancer-update¶

LBaaS v2 Update a given loadbalancer.

neutron lbaas-loadbalancer-update
    [--admin-state-up {True,False}]
    [--description DESCRIPTION]
    [--name NAME]
    LOADBALANCER

--admin-state-up {True,False}¶: Update the administrative state of the load balancer (True meaning “Up”).

--description <DESCRIPTION>¶: Description of the load balancer.

--name NAME¶: Name of the load balancer.

LOADBALANCER¶: ID or name of loadbalancer to update.

This command is provided by the python-neutronclient plugin.

lbaas-member-create¶

LBaaS v2 Create a member.

neutron lbaas-member-create
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--tenant-id TENANT_ID]
    [--name NAME]
    [--weight WEIGHT]
    [--admin-state-down]
    --subnet SUBNET
    --address ADDRESS
    --protocol-port PROTOCOL_PORT
    POOL

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

--tenant-id TENANT_ID¶: The owner tenant ID.

--name <NAME>¶: Name of the member.

--weight <WEIGHT>¶: Weight of the member in the pool (default:1, [0..256]).

--admin-state-down¶: Set admin state up to false.

--subnet <SUBNET>¶: Subnet ID or name for the member.

--address <ADDRESS>¶: IP address of the pool member in the pool.

--protocol-port <PROTOCOL_PORT>¶: Port on which the pool member listens for requests or connections.

POOL¶: ID or name of the pool that this member belongs to.

This command is provided by the python-neutronclient plugin.

lbaas-member-delete¶

LBaaS v2 Delete a given member.

neutron lbaas-member-delete MEMBER [MEMBER ...] POOL

MEMBER¶: ID(s) or name(s) of member to delete.

POOL¶: ID or name of the pool that this member belongs to.

This command is provided by the python-neutronclient plugin.

lbaas-member-list¶

LBaaS v2 List members that belong to a given pool.

neutron lbaas-member-list
    [-f {csv,json,table,value,yaml}]
    [-c COLUMN]
    [--quote {all,minimal,none,nonnumeric}]
    [--noindent]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [-D]
    [-F FIELD]
    [-P SIZE]
    [--sort-key FIELD]
    [--sort-dir {asc,desc}]
    POOL

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--quote <QUOTE_MODE>¶: when to include quotes, defaults to nonnumeric

--noindent¶: whether to disable indenting the JSON

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

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

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

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

-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.

POOL¶: ID or name of the pool that this member belongs to.

This command is provided by the python-neutronclient plugin.

lbaas-member-show¶

LBaaS v2 Show information of a given member.

neutron lbaas-member-show
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [-D]
    [-F FIELD]
    MEMBER
    POOL

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

-D, --show-details¶: Show detailed information.

-F FIELD, --field FIELD¶: Specify the field(s) to be returned by server. You can repeat this option.

MEMBER¶: ID or name of member to look up.

POOL¶: ID or name of the pool that this member belongs to.

This command is provided by the python-neutronclient plugin.

lbaas-member-update¶

LBaaS v2 Update a given member.

neutron lbaas-member-update
    [--admin-state-up {True,False}]
    [--name NAME]
    [--weight WEIGHT]
    MEMBER
    POOL

--admin-state-up {True,False}¶: Update the administrative state of the member (True meaning “Up”).

--name <NAME>¶: Name of the member.

--weight <WEIGHT>¶: Weight of the member in the pool (default:1, [0..256]).

MEMBER¶: ID or name of member to update.

POOL¶: ID or name of the pool that this member belongs to.

This command is provided by the python-neutronclient plugin.

lbaas-pool-create¶

LBaaS v2 Create a pool.

neutron lbaas-pool-create
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--tenant-id TENANT_ID]
    [--description DESCRIPTION]
    [--name NAME]
    --lb-algorithm
    {ROUND_ROBIN,LEAST_CONNECTIONS,SOURCE_IP}
    [--admin-state-down]
    [--listener LISTENER]
    [--loadbalancer LOADBALANCER]
    --protocol
    {HTTP,HTTPS,TCP}
    [--session-persistence type=TYPE[,cookie_name=COOKIE_NAME]]

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

--tenant-id TENANT_ID¶: The owner tenant ID.

--description <DESCRIPTION>¶: Description of the pool.

--name <NAME>¶: The name of the pool.

--lb-algorithm <LB_ALGORITHM>¶: The algorithm used to distribute load between the members of the pool.

--admin-state-down¶: Set admin state up to false.

--listener <LISTENER>¶: Listener whose default-pool should be set to this pool. At least one of –listener or –loadbalancer must be specified.

--loadbalancer <LOADBALANCER>¶: Loadbalancer with which this pool should be associated. At least one of –listener or –loadbalancer must be specified.

--protocol <PROTOCOL>¶: Protocol for balancing.

--session-persistence type=TYPE[,cookie_name=COOKIE_NAME]¶: The type of session persistence to use and associated cookie name.

This command is provided by the python-neutronclient plugin.

lbaas-pool-delete¶

LBaaS v2 Delete a given pool.

neutron lbaas-pool-delete POOL [POOL ...]

POOL¶: ID(s) or name(s) of pool to delete.

This command is provided by the python-neutronclient plugin.

lbaas-pool-list¶

LBaaS v2 List pools that belong to a given tenant.

neutron lbaas-pool-list
    [-f {csv,json,table,value,yaml}]
    [-c COLUMN]
    [--quote {all,minimal,none,nonnumeric}]
    [--noindent]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [-D]
    [-F FIELD]
    [-P SIZE]
    [--sort-key FIELD]
    [--sort-dir {asc,desc}]

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--quote <QUOTE_MODE>¶: when to include quotes, defaults to nonnumeric

--noindent¶: whether to disable indenting the JSON

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

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

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

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

-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.

This command is provided by the python-neutronclient plugin.

lbaas-pool-show¶

LBaaS v2 Show information of a given pool.

neutron lbaas-pool-show
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [-D]
    [-F FIELD]
    POOL

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

-D, --show-details¶: Show detailed information.

-F FIELD, --field FIELD¶: Specify the field(s) to be returned by server. You can repeat this option.

POOL¶: ID or name of pool to look up.

This command is provided by the python-neutronclient plugin.

lbaas-pool-update¶

LBaaS v2 Update a given pool.

neutron lbaas-pool-update
    [--admin-state-up {True,False}]
    [--session-persistence type=TYPE[,cookie_name=COOKIE_NAME]
    |
    --no-session-persistence
    ]
    [--description DESCRIPTION]
    [--name NAME]
    [--lb-algorithm {ROUND_ROBIN,LEAST_CONNECTIONS,SOURCE_IP}]
    POOL

--admin-state-up {True,False}¶: Update the administrative state of the pool (True meaning “Up”).

--session-persistence type=TYPE[,cookie_name=COOKIE_NAME]¶: The type of session persistence to use and associated cookie name.

--no-session-persistence¶: Clear session persistence for the pool.

--description <DESCRIPTION>¶: Description of the pool.

--name <NAME>¶: The name of the pool.

--lb-algorithm <LB_ALGORITHM>¶: The algorithm used to distribute load between the members of the pool.

POOL¶: ID or name of pool to update.

This command is provided by the python-neutronclient plugin.

meter-label-create¶

Create a metering label for a given tenant.

neutron meter-label-create
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--tenant-id TENANT_ID]
    [--description DESCRIPTION]
    [--shared]
    NAME

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

--tenant-id TENANT_ID¶: The owner tenant ID.

--description <DESCRIPTION>¶: Description of the metering label to be created.

--shared¶: Set the label as shared.

NAME¶: Name of the metering label to be created.

This command is provided by the python-neutronclient plugin.

meter-label-delete¶

Delete a given metering label.

neutron meter-label-delete METERING_LABEL [METERING_LABEL ...]

METERING_LABEL¶: ID(s) or name(s) of metering_label to delete.

This command is provided by the python-neutronclient plugin.

meter-label-list¶

List metering labels that belong to a given tenant.

neutron meter-label-list
    [-f {csv,json,table,value,yaml}]
    [-c COLUMN]
    [--quote {all,minimal,none,nonnumeric}]
    [--noindent]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [-D]
    [-F FIELD]
    [-P SIZE]
    [--sort-key FIELD]
    [--sort-dir {asc,desc}]

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--quote <QUOTE_MODE>¶: when to include quotes, defaults to nonnumeric

--noindent¶: whether to disable indenting the JSON

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

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

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

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

-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.

This command is provided by the python-neutronclient plugin.

meter-label-rule-create¶

Create a metering label rule for a given label.

neutron meter-label-rule-create
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--tenant-id TENANT_ID]
    [--direction {ingress,egress}]
    [--excluded]
    LABEL
    REMOTE_IP_PREFIX

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

--tenant-id TENANT_ID¶: The owner tenant ID.

--direction <DIRECTION>¶: Direction of traffic, default: ingress.

--excluded¶: Exclude this CIDR from the label, default: not excluded.

LABEL¶: ID or name of the label.

REMOTE_IP_PREFIX¶: CIDR to match on.

This command is provided by the python-neutronclient plugin.

meter-label-rule-delete¶

Delete a given metering label.

neutron meter-label-rule-delete
    METERING_LABEL_RULE
    [METERING_LABEL_RULE ...]

METERING_LABEL_RULE¶: ID(s) of metering_label_rule to delete.

This command is provided by the python-neutronclient plugin.

meter-label-rule-list¶

List metering labels that belong to a given label.

neutron meter-label-rule-list
    [-f {csv,json,table,value,yaml}]
    [-c COLUMN]
    [--quote {all,minimal,none,nonnumeric}]
    [--noindent]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [-D]
    [-F FIELD]
    [-P SIZE]
    [--sort-key FIELD]
    [--sort-dir {asc,desc}]

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--quote <QUOTE_MODE>¶: when to include quotes, defaults to nonnumeric

--noindent¶: whether to disable indenting the JSON

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

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

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

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

-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.

This command is provided by the python-neutronclient plugin.

meter-label-rule-show¶

Show information of a given metering label rule.

neutron meter-label-rule-show
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [-D]
    [-F FIELD]
    METERING_LABEL_RULE

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

-D, --show-details¶: Show detailed information.

-F FIELD, --field FIELD¶: Specify the field(s) to be returned by server. You can repeat this option.

METERING_LABEL_RULE¶: ID of metering_label_rule to look up.

This command is provided by the python-neutronclient plugin.

meter-label-show¶

Show information of a given metering label.

neutron meter-label-show
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [-D]
    [-F FIELD]
    METERING_LABEL

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

-D, --show-details¶: Show detailed information.

-F FIELD, --field FIELD¶: Specify the field(s) to be returned by server. You can repeat this option.

METERING_LABEL¶: ID or name of metering_label to look up.

This command is provided by the python-neutronclient plugin.

net-create¶

Create a network for a given tenant.

neutron net-create
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--tenant-id TENANT_ID]
    [--admin-state-down]
    [--shared]
    [--provider:network_type <network_type>]
    [--provider:physical_network <physical_network_name>]
    [--provider:segmentation_id <segmentation_id>]
    [--vlan-transparent {True,False}]
    [--description DESCRIPTION]
    [--qos-policy QOS_POLICY]
    [--availability-zone-hint AVAILABILITY_ZONE]
    [--dns-domain DNS_DOMAIN]
    NAME

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

--tenant-id TENANT_ID¶: The owner tenant ID.

--admin-state-down¶: Set admin state up to false.

--shared¶: Set the network as shared.

--provider:network_type <network_type>¶: The physical mechanism by which the virtual network is implemented.

--provider:physical_network <physical_network_name>¶: Name of the physical network over which the virtual network is implemented.

--provider:segmentation_id <segmentation_id>¶: VLAN ID for VLAN networks or tunnel-id for GRE/VXLAN networks.

--vlan-transparent {True,False}¶: Create a VLAN transparent network.

--description <DESCRIPTION>¶: Description of network.

--qos-policy <QOS_POLICY>¶: ID or name of the QoS policy that shouldbe attached to the resource.

--availability-zone-hint AVAILABILITY_ZONE¶: Availability Zone for the network (requires availability zone extension, this option can be repeated).

--dns-domain <DNS_DOMAIN>¶: Assign DNS domain to the network (requires DNS integration extension)

NAME¶: Name of the network to be created.

This command is provided by the python-neutronclient plugin.

net-delete¶

Delete a given network.

neutron net-delete NETWORK [NETWORK ...]

NETWORK¶: ID(s) or name(s) of network to delete.

This command is provided by the python-neutronclient plugin.

net-external-list¶

List external networks that belong to a given tenant.

neutron net-external-list
    [-f {csv,json,table,value,yaml}]
    [-c COLUMN]
    [--quote {all,minimal,none,nonnumeric}]
    [--noindent]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [-D]
    [-F FIELD]
    [-P SIZE]
    [--sort-key FIELD]
    [--sort-dir {asc,desc}]
    [--tenant-id TENANT_ID]
    [--name NAME]
    [--admin-state-up {True,False}]
    [--status STATUS]
    [--shared {True,False}]
    [--router:external {True,False}]
    [--tags TAG]
    [--tags-any TAG]
    [--not-tags TAG]
    [--not-tags-any TAG]

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--quote <QUOTE_MODE>¶: when to include quotes, defaults to nonnumeric

--noindent¶: whether to disable indenting the JSON

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

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

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

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

-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.

--tenant-id <TENANT_ID>¶: Filter networks belonging to the given tenant.

--name <NAME>¶: Filter networks according to their name.

--admin-state-up {True,False}¶: Filter and list the networks whose administrative state is active

--status <STATUS>¶: Filter networks according to their operation status.(For example: ACTIVE, ERROR etc)

--shared {True,False}¶: Filter and list the networks which are shared.

--router:external {True,False}¶: Filter and list the networks which are external.

--tags TAG¶: Filter and list networks which has all given tags. Multiple tags can be set like –tags <tag[,tag…]>

--tags-any TAG¶: Filter and list networks which has any given tags. Multiple tags can be set like –tags-any <tag[,tag…]>

--not-tags TAG¶: Filter and list networks which does not have all given tags. Multiple tags can be set like –not-tags <tag[,tag…]>

--not-tags-any TAG¶: Filter and list networks which does not have any given tags. Multiple tags can be set like –not-tags-any <tag[,tag…]>

This command is provided by the python-neutronclient plugin.

net-ip-availability-list¶

List IP usage of networks

neutron net-ip-availability-list
    [-f {csv,json,table,value,yaml}]
    [-c COLUMN]
    [--quote {all,minimal,none,nonnumeric}]
    [--noindent]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [-D]
    [-F FIELD]
    [--sort-key FIELD]
    [--sort-dir {asc,desc}]
    [--ip-version {4,6}]
    [--network-id NETWORK_ID]
    [--network-name NETWORK_NAME]
    [--tenant-id TENANT_ID]

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--quote <QUOTE_MODE>¶: when to include quotes, defaults to nonnumeric

--noindent¶: whether to disable indenting the JSON

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

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

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

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

-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.

--ip-version <IP_VERSION>¶: Returns IP availability for the network subnets with a given IP version. Default: 4

--network-id <NETWORK_ID>¶: Returns IP availability for the network matching a given network ID.

--network-name <NETWORK_NAME>¶: Returns IP availability for the network matching a given name.

--tenant-id <TENANT_ID>¶: Returns IP availability for the networks with a given tenant ID.

This command is provided by the python-neutronclient plugin.

net-ip-availability-show¶

Show IP usage of specific network

neutron net-ip-availability-show
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    NETWORK

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

NETWORK¶: ID or name of network to look up.

This command is provided by the python-neutronclient plugin.

net-list¶

List networks that belong to a given tenant.

neutron net-list
    [-f {csv,json,table,value,yaml}]
    [-c COLUMN]
    [--quote {all,minimal,none,nonnumeric}]
    [--noindent]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [-D]
    [-F FIELD]
    [-P SIZE]
    [--sort-key FIELD]
    [--sort-dir {asc,desc}]
    [--tenant-id TENANT_ID]
    [--name NAME]
    [--admin-state-up {True,False}]
    [--status STATUS]
    [--shared {True,False}]
    [--router:external {True,False}]
    [--tags TAG]
    [--tags-any TAG]
    [--not-tags TAG]
    [--not-tags-any TAG]

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--quote <QUOTE_MODE>¶: when to include quotes, defaults to nonnumeric

--noindent¶: whether to disable indenting the JSON

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

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

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

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

-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.

--tenant-id <TENANT_ID>¶: Filter networks belonging to the given tenant.

--name <NAME>¶: Filter networks according to their name.

--admin-state-up {True,False}¶: Filter and list the networks whose administrative state is active

--status <STATUS>¶: Filter networks according to their operation status.(For example: ACTIVE, ERROR etc)

--shared {True,False}¶: Filter and list the networks which are shared.

--router:external {True,False}¶: Filter and list the networks which are external.

--tags TAG¶: Filter and list networks which has all given tags. Multiple tags can be set like –tags <tag[,tag…]>

--tags-any TAG¶: Filter and list networks which has any given tags. Multiple tags can be set like –tags-any <tag[,tag…]>

--not-tags TAG¶: Filter and list networks which does not have all given tags. Multiple tags can be set like –not-tags <tag[,tag…]>

--not-tags-any TAG¶: Filter and list networks which does not have any given tags. Multiple tags can be set like –not-tags-any <tag[,tag…]>

This command is provided by the python-neutronclient plugin.

net-list-on-dhcp-agent¶

List the networks on a DHCP agent.

neutron net-list-on-dhcp-agent
    [-f {csv,json,table,value,yaml}]
    [-c COLUMN]
    [--quote {all,minimal,none,nonnumeric}]
    [--noindent]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [-D]
    [-F FIELD]
    [-P SIZE]
    [--sort-key FIELD]
    [--sort-dir {asc,desc}]
    [--tenant-id TENANT_ID]
    [--name NAME]
    [--admin-state-up {True,False}]
    [--status STATUS]
    [--shared {True,False}]
    [--router:external {True,False}]
    [--tags TAG]
    [--tags-any TAG]
    [--not-tags TAG]
    [--not-tags-any TAG]
    DHCP_AGENT

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--quote <QUOTE_MODE>¶: when to include quotes, defaults to nonnumeric

--noindent¶: whether to disable indenting the JSON

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

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

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

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

-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.

--tenant-id <TENANT_ID>¶: Filter networks belonging to the given tenant.

--name <NAME>¶: Filter networks according to their name.

--admin-state-up {True,False}¶: Filter and list the networks whose administrative state is active

--status <STATUS>¶: Filter networks according to their operation status.(For example: ACTIVE, ERROR etc)

--shared {True,False}¶: Filter and list the networks which are shared.

--router:external {True,False}¶: Filter and list the networks which are external.

--tags TAG¶: Filter and list networks which has all given tags. Multiple tags can be set like –tags <tag[,tag…]>

--tags-any TAG¶: Filter and list networks which has any given tags. Multiple tags can be set like –tags-any <tag[,tag…]>

--not-tags TAG¶: Filter and list networks which does not have all given tags. Multiple tags can be set like –not-tags <tag[,tag…]>

--not-tags-any TAG¶: Filter and list networks which does not have any given tags. Multiple tags can be set like –not-tags-any <tag[,tag…]>

DHCP_AGENT¶: ID of the DHCP agent.

This command is provided by the python-neutronclient plugin.

net-show¶

Show information of a given network.

neutron net-show
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [-D]
    [-F FIELD]
    NETWORK

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

-D, --show-details¶: Show detailed information.

-F FIELD, --field FIELD¶: Specify the field(s) to be returned by server. You can repeat this option.

NETWORK¶: ID or name of network to look up.

This command is provided by the python-neutronclient plugin.

net-update¶

Update network’s information.

neutron net-update
    [--name NAME]
    [--description DESCRIPTION]
    [--qos-policy QOS_POLICY | --no-qos-policy]
    [--dns-domain DNS_DOMAIN | --no-dns-domain]
    NETWORK

--name <NAME>¶: Name of the network.

--description <DESCRIPTION>¶: Description of this network.

--qos-policy <QOS_POLICY>¶: ID or name of the QoS policy that shouldbe attached to the resource.

--no-qos-policy¶: Detach QoS policy from the resource.

--dns-domain <DNS_DOMAIN>¶: Assign DNS domain to the network (requires DNS integration extension.)

--no-dns-domain¶: Unassign DNS domain from the network (requires DNS integration extension.)

NETWORK¶: ID or name of network to update.

This command is provided by the python-neutronclient plugin.

port-create¶

Create a port for a given tenant.

neutron port-create
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--tenant-id TENANT_ID]
    [--name NAME]
    [--description DESCRIPTION]
    [--fixed-ip subnet_id=SUBNET,ip_address=IP_ADDR]
    [--device-id DEVICE_ID]
    [--device-owner DEVICE_OWNER]
    [--admin-state-down]
    [--mac-address MAC_ADDRESS]
    [--vnic-type <direct | direct-physical | macvtap | normal | baremetal | smart-nic>]
    [--binding-profile BINDING_PROFILE]
    [--security-group SECURITY_GROUP | --no-security-groups]
    [--extra-dhcp-opt EXTRA_DHCP_OPTS]
    [--qos-policy QOS_POLICY]
    [--allowed-address-pair ip_address=IP_ADDR|CIDR[,mac_address=MAC_ADDR]
    |
    --no-allowed-address-pairs
    ]
    [--dns-name DNS_NAME]
    NETWORK

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

--tenant-id TENANT_ID¶: The owner tenant ID.

--name <NAME>¶: Name of this port.

--description <DESCRIPTION>¶: Description of this port.

--fixed-ip subnet_id=SUBNET,ip_address=IP_ADDR¶: Desired IP and/or subnet for this port: subnet_id=<name_or_id>,ip_address=<ip>. You can repeat this option.

--device-id <DEVICE_ID>¶: Device ID of this port.

--device-owner <DEVICE_OWNER>¶: Device owner of this port.

--admin-state-down¶: Set admin state up to false.

--mac-address <MAC_ADDRESS>¶: MAC address of this port.

--vnic-type <direct | direct-physical | macvtap | normal | baremetal | smart-nic>¶: VNIC type for this port.

--binding-profile <BINDING_PROFILE>¶: Custom data to be passed as binding:profile.

--security-group SECURITY_GROUP¶: Security group associated with the port. You can repeat this option.

--no-security-groups¶: Associate no security groups with the port.

--extra-dhcp-opt <EXTRA_DHCP_OPTS>¶: Extra dhcp options to be assigned to this port: opt_name=<dhcp_option_name>,opt_value=<value>,ip_version={4,6}. You can repeat this option.

--qos-policy <QOS_POLICY>¶: ID or name of the QoS policy that shouldbe attached to the resource.

--allowed-address-pair ip_address=IP_ADDR|CIDR[,mac_address=MAC_ADDR]¶: Allowed address pair associated with the port. “ip_address” parameter is required. IP address or CIDR can be specified for “ip_address”. “mac_address” parameter is optional. You can repeat this option.

--no-allowed-address-pairs¶: Associate no allowed address pairs with the port.

--dns-name <DNS_NAME>¶: Assign DNS name to the port (requires DNS integration extension)

NETWORK¶: ID or name of the network this port belongs to.

This command is provided by the python-neutronclient plugin.

port-delete¶

Delete a given port.

neutron port-delete PORT [PORT ...]

PORT¶: ID(s) or name(s) of port to delete.

This command is provided by the python-neutronclient plugin.

port-list¶

List ports that belong to a given tenant.

neutron port-list
    [-f {csv,json,table,value,yaml}]
    [-c COLUMN]
    [--quote {all,minimal,none,nonnumeric}]
    [--noindent]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [-D]
    [-F FIELD]
    [-P SIZE]
    [--sort-key FIELD]
    [--sort-dir {asc,desc}]

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--quote <QUOTE_MODE>¶: when to include quotes, defaults to nonnumeric

--noindent¶: whether to disable indenting the JSON

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

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

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

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

-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.

This command is provided by the python-neutronclient plugin.

port-show¶

Show information of a given port.

neutron port-show
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [-D]
    [-F FIELD]
    PORT

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

-D, --show-details¶: Show detailed information.

-F FIELD, --field FIELD¶: Specify the field(s) to be returned by server. You can repeat this option.

PORT¶: ID or name of port to look up.

This command is provided by the python-neutronclient plugin.

port-update¶

Update port’s information.

neutron port-update
    [--name NAME]
    [--description DESCRIPTION]
    [--fixed-ip subnet_id=SUBNET,ip_address=IP_ADDR]
    [--device-id DEVICE_ID]
    [--device-owner DEVICE_OWNER]
    [--admin-state-up {True,False}]
    [--security-group SECURITY_GROUP | --no-security-groups]
    [--extra-dhcp-opt EXTRA_DHCP_OPTS]
    [--qos-policy QOS_POLICY | --no-qos-policy]
    [--allowed-address-pair ip_address=IP_ADDR|CIDR[,mac_address=MAC_ADDR]
    |
    --no-allowed-address-pairs
    ]
    [--dns-name DNS_NAME | --no-dns-name]
    PORT

--name <NAME>¶: Name of this port.

--description <DESCRIPTION>¶: Description of this port.

--fixed-ip subnet_id=SUBNET,ip_address=IP_ADDR¶: Desired IP and/or subnet for this port: subnet_id=<name_or_id>,ip_address=<ip>. You can repeat this option.

--device-id <DEVICE_ID>¶: Device ID of this port.

--device-owner <DEVICE_OWNER>¶: Device owner of this port.

--admin-state-up <ADMIN_STATE_UP>¶: Set admin state up for the port.

--security-group SECURITY_GROUP¶: Security group associated with the port. You can repeat this option.

--no-security-groups¶: Associate no security groups with the port.

--extra-dhcp-opt <EXTRA_DHCP_OPTS>¶: Extra dhcp options to be assigned to this port: opt_name=<dhcp_option_name>,opt_value=<value>,ip_version={4,6}. You can repeat this option.

--qos-policy <QOS_POLICY>¶: ID or name of the QoS policy that shouldbe attached to the resource.

--no-qos-policy¶: Detach QoS policy from the resource.

--allowed-address-pair ip_address=IP_ADDR|CIDR[,mac_address=MAC_ADDR]¶: Allowed address pair associated with the port. “ip_address” parameter is required. IP address or CIDR can be specified for “ip_address”. “mac_address” parameter is optional. You can repeat this option.

--no-allowed-address-pairs¶: Associate no allowed address pairs with the port.

--dns-name <DNS_NAME>¶: Assign DNS name to the port (requires DNS integration extension.)

--no-dns-name¶: Unassign DNS name from the port (requires DNS integration extension.)

PORT¶: ID or name of port to update.

This command is provided by the python-neutronclient plugin.

purge¶

Delete all resources that belong to a given tenant.

neutron purge TENANT

TENANT¶: ID of Tenant owning the resources to be deleted.

This command is provided by the python-neutronclient plugin.

qos-available-rule-types¶

List available qos rule types.

neutron qos-available-rule-types
    [-f {csv,json,table,value,yaml}]
    [-c COLUMN]
    [--quote {all,minimal,none,nonnumeric}]
    [--noindent]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [-D]
    [-F FIELD]
    [-P SIZE]
    [--sort-key FIELD]
    [--sort-dir {asc,desc}]

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--quote <QUOTE_MODE>¶: when to include quotes, defaults to nonnumeric

--noindent¶: whether to disable indenting the JSON

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

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

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

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

-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.

This command is provided by the python-neutronclient plugin.

qos-bandwidth-limit-rule-create¶

Create a qos bandwidth limit rule.

neutron qos-bandwidth-limit-rule-create
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--tenant-id TENANT_ID]
    [--max-kbps MAX_KBPS]
    [--max-burst-kbps MAX_BURST_KBPS]
    QOS_POLICY

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

--tenant-id TENANT_ID¶: The owner tenant ID.

--max-kbps <MAX_KBPS>¶: Maximum bandwidth in kbps.

--max-burst-kbps <MAX_BURST_KBPS>¶: Maximum burst bandwidth in kbps.

QOS_POLICY¶: ID or name of the QoS policy.

This command is provided by the python-neutronclient plugin.

qos-bandwidth-limit-rule-delete¶

Delete a given qos bandwidth limit rule.

neutron qos-bandwidth-limit-rule-delete
    BANDWIDTH_LIMIT_RULE
    [BANDWIDTH_LIMIT_RULE ...]
    QOS_POLICY

BANDWIDTH_LIMIT_RULE¶: ID(s) of bandwidth_limit_rule to delete.

QOS_POLICY¶: ID or name of the QoS policy.

This command is provided by the python-neutronclient plugin.

qos-bandwidth-limit-rule-list¶

List all qos bandwidth limit rules belonging to the specified policy.

neutron qos-bandwidth-limit-rule-list
    [-f {csv,json,table,value,yaml}]
    [-c COLUMN]
    [--quote {all,minimal,none,nonnumeric}]
    [--noindent]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [-D]
    [-F FIELD]
    [-P SIZE]
    [--sort-key FIELD]
    [--sort-dir {asc,desc}]
    QOS_POLICY

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--quote <QUOTE_MODE>¶: when to include quotes, defaults to nonnumeric

--noindent¶: whether to disable indenting the JSON

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

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

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

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

-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.

QOS_POLICY¶: ID or name of the QoS policy.

This command is provided by the python-neutronclient plugin.

qos-bandwidth-limit-rule-show¶

Show information about the given qos bandwidth limit rule.

neutron qos-bandwidth-limit-rule-show
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [-D]
    [-F FIELD]
    BANDWIDTH_LIMIT_RULE
    QOS_POLICY

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

-D, --show-details¶: Show detailed information.

-F FIELD, --field FIELD¶: Specify the field(s) to be returned by server. You can repeat this option.

BANDWIDTH_LIMIT_RULE¶: ID of bandwidth_limit_rule to look up.

QOS_POLICY¶: ID or name of the QoS policy.

This command is provided by the python-neutronclient plugin.

qos-bandwidth-limit-rule-update¶

Update the given qos bandwidth limit rule.

neutron qos-bandwidth-limit-rule-update
    [--max-kbps MAX_KBPS]
    [--max-burst-kbps MAX_BURST_KBPS]
    BANDWIDTH_LIMIT_RULE
    QOS_POLICY

--max-kbps <MAX_KBPS>¶: Maximum bandwidth in kbps.

--max-burst-kbps <MAX_BURST_KBPS>¶: Maximum burst bandwidth in kbps.

BANDWIDTH_LIMIT_RULE¶: ID of bandwidth_limit_rule to update.

QOS_POLICY¶: ID or name of the QoS policy.

This command is provided by the python-neutronclient plugin.

qos-dscp-marking-rule-create¶

Create a QoS DSCP marking rule.

neutron qos-dscp-marking-rule-create
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--tenant-id TENANT_ID]
    --dscp-mark DSCP_MARK
    QOS_POLICY

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

--tenant-id TENANT_ID¶: The owner tenant ID.

--dscp-mark <DSCP_MARK>¶: DSCP mark: value can be 0, even numbers from 8-56, excluding 42, 44, 50, 52, and 54.

QOS_POLICY¶: ID or name of the QoS policy.

This command is provided by the python-neutronclient plugin.

qos-dscp-marking-rule-delete¶

Delete a given qos dscp marking rule.

neutron qos-dscp-marking-rule-delete
    DSCP_MARKING_RULE
    [DSCP_MARKING_RULE ...]
    QOS_POLICY

DSCP_MARKING_RULE¶: ID(s) of dscp_marking_rule to delete.

QOS_POLICY¶: ID or name of the QoS policy.

This command is provided by the python-neutronclient plugin.

qos-dscp-marking-rule-list¶

List all QoS DSCP marking rules belonging to the specified policy.

neutron qos-dscp-marking-rule-list
    [-f {csv,json,table,value,yaml}]
    [-c COLUMN]
    [--quote {all,minimal,none,nonnumeric}]
    [--noindent]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [-D]
    [-F FIELD]
    [-P SIZE]
    [--sort-key FIELD]
    [--sort-dir {asc,desc}]
    QOS_POLICY

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--quote <QUOTE_MODE>¶: when to include quotes, defaults to nonnumeric

--noindent¶: whether to disable indenting the JSON

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

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

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

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

-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.

QOS_POLICY¶: ID or name of the QoS policy.

This command is provided by the python-neutronclient plugin.

qos-dscp-marking-rule-show¶

Show information about the given qos dscp marking rule.

neutron qos-dscp-marking-rule-show
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [-D]
    [-F FIELD]
    DSCP_MARKING_RULE
    QOS_POLICY

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

-D, --show-details¶: Show detailed information.

-F FIELD, --field FIELD¶: Specify the field(s) to be returned by server. You can repeat this option.

DSCP_MARKING_RULE¶: ID of dscp_marking_rule to look up.

QOS_POLICY¶: ID or name of the QoS policy.

This command is provided by the python-neutronclient plugin.

qos-dscp-marking-rule-update¶

Update the given QoS DSCP marking rule.

neutron qos-dscp-marking-rule-update
    --dscp-mark DSCP_MARK
    DSCP_MARKING_RULE
    QOS_POLICY

--dscp-mark <DSCP_MARK>¶: DSCP mark: value can be 0, even numbers from 8-56, excluding 42, 44, 50, 52, and 54.

DSCP_MARKING_RULE¶: ID of dscp_marking_rule to update.

QOS_POLICY¶: ID or name of the QoS policy.

This command is provided by the python-neutronclient plugin.

qos-minimum-bandwidth-rule-create¶

Create a qos minimum bandwidth rule.

neutron qos-minimum-bandwidth-rule-create
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--tenant-id TENANT_ID]
    --min-kbps MIN_KBPS
    --direction
    {egress}
    QOS_POLICY

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

--tenant-id TENANT_ID¶: The owner tenant ID.

--min-kbps <MIN_KBPS>¶: QoS minimum bandwidth assurance, expressed in kilobits per second.

--direction <DIRECTION>¶: Traffic direction.

QOS_POLICY¶: ID or name of the QoS policy.

This command is provided by the python-neutronclient plugin.

qos-minimum-bandwidth-rule-delete¶

Delete a given qos minimum bandwidth rule.

neutron qos-minimum-bandwidth-rule-delete
    MINIMUM_BANDWIDTH_RULE
    [MINIMUM_BANDWIDTH_RULE ...]
    QOS_POLICY

MINIMUM_BANDWIDTH_RULE¶: ID(s) of minimum_bandwidth_rule to delete.

QOS_POLICY¶: ID or name of the QoS policy.

This command is provided by the python-neutronclient plugin.

qos-minimum-bandwidth-rule-list¶

List all qos minimum bandwidth rules belonging to the specified policy.

neutron qos-minimum-bandwidth-rule-list
    [-f {csv,json,table,value,yaml}]
    [-c COLUMN]
    [--quote {all,minimal,none,nonnumeric}]
    [--noindent]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [-D]
    [-F FIELD]
    [-P SIZE]
    [--sort-key FIELD]
    [--sort-dir {asc,desc}]
    QOS_POLICY

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--quote <QUOTE_MODE>¶: when to include quotes, defaults to nonnumeric

--noindent¶: whether to disable indenting the JSON

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

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

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

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

-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.

QOS_POLICY¶: ID or name of the QoS policy.

This command is provided by the python-neutronclient plugin.

qos-minimum-bandwidth-rule-show¶

Show information about the given qos minimum bandwidth rule.

neutron qos-minimum-bandwidth-rule-show
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [-D]
    [-F FIELD]
    MINIMUM_BANDWIDTH_RULE
    QOS_POLICY

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

-D, --show-details¶: Show detailed information.

-F FIELD, --field FIELD¶: Specify the field(s) to be returned by server. You can repeat this option.

MINIMUM_BANDWIDTH_RULE¶: ID of minimum_bandwidth_rule to look up.

QOS_POLICY¶: ID or name of the QoS policy.

This command is provided by the python-neutronclient plugin.

qos-minimum-bandwidth-rule-update¶

Update the given qos minimum bandwidth rule.

neutron qos-minimum-bandwidth-rule-update
    --min-kbps MIN_KBPS
    --direction
    {egress}
    MINIMUM_BANDWIDTH_RULE
    QOS_POLICY

--min-kbps <MIN_KBPS>¶: QoS minimum bandwidth assurance, expressed in kilobits per second.

--direction <DIRECTION>¶: Traffic direction.

MINIMUM_BANDWIDTH_RULE¶: ID of minimum_bandwidth_rule to update.

QOS_POLICY¶: ID or name of the QoS policy.

This command is provided by the python-neutronclient plugin.

qos-policy-create¶

Create a qos policy.

neutron qos-policy-create
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--tenant-id TENANT_ID]
    [--description DESCRIPTION]
    [--shared]
    NAME

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

--tenant-id TENANT_ID¶: The owner tenant ID.

--description <DESCRIPTION>¶: Description of the QoS policy to be created.

--shared¶: Accessible by other tenants. Set shared to True (default is False).

NAME¶: Name of the QoS policy to be created.

This command is provided by the python-neutronclient plugin.

qos-policy-delete¶

Delete a given qos policy.

neutron qos-policy-delete POLICY [POLICY ...]

POLICY¶: ID(s) or name(s) of policy to delete.

This command is provided by the python-neutronclient plugin.

qos-policy-list¶

List QoS policies that belong to a given tenant connection.

neutron qos-policy-list
    [-f {csv,json,table,value,yaml}]
    [-c COLUMN]
    [--quote {all,minimal,none,nonnumeric}]
    [--noindent]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [-D]
    [-F FIELD]
    [-P SIZE]
    [--sort-key FIELD]
    [--sort-dir {asc,desc}]

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--quote <QUOTE_MODE>¶: when to include quotes, defaults to nonnumeric

--noindent¶: whether to disable indenting the JSON

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

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

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

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

-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.

This command is provided by the python-neutronclient plugin.

qos-policy-show¶

Show information of a given qos policy.

neutron qos-policy-show
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [-D]
    [-F FIELD]
    POLICY

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

-D, --show-details¶: Show detailed information.

-F FIELD, --field FIELD¶: Specify the field(s) to be returned by server. You can repeat this option.

POLICY¶: ID or name of policy to look up.

This command is provided by the python-neutronclient plugin.

qos-policy-update¶

Update a given qos policy.

neutron qos-policy-update
    [--name NAME]
    [--description DESCRIPTION]
    [--shared | --no-shared]
    POLICY

--name <NAME>¶: Name of the QoS policy.

--description <DESCRIPTION>¶: Description of the QoS policy.

--shared¶: Accessible by other tenants. Set shared to True (default is False).

--no-shared¶: Not accessible by other tenants. Set shared to False.

POLICY¶: ID or name of policy to update.

This command is provided by the python-neutronclient plugin.

quota-default-show¶

Show default quotas for a given tenant.

neutron quota-default-show
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--tenant-id tenant-id]

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

--tenant-id tenant-id¶: The owner tenant ID.

This command is provided by the python-neutronclient plugin.

quota-delete¶

Delete defined quotas of a given tenant.

neutron quota-delete [--tenant-id tenant-id]

--tenant-id tenant-id¶: The owner tenant ID.

This command is provided by the python-neutronclient plugin.

quota-list¶

List quotas of all tenants who have non-default quota values.

neutron quota-list
    [-f {csv,json,table,value,yaml}]
    [-c COLUMN]
    [--quote {all,minimal,none,nonnumeric}]
    [--noindent]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--quote <QUOTE_MODE>¶: when to include quotes, defaults to nonnumeric

--noindent¶: whether to disable indenting the JSON

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

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

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

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

This command is provided by the python-neutronclient plugin.

quota-show¶

Show quotas for a given tenant.

neutron quota-show
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--tenant-id tenant-id]

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

--tenant-id tenant-id¶: The owner tenant ID.

This command is provided by the python-neutronclient plugin.

quota-update¶

Update a given tenant’s quotas.

neutron quota-update
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--tenant-id tenant-id]
    [--network networks]
    [--subnet subnets]
    [--port ports]
    [--router routers]
    [--floatingip floatingips]
    [--security-group security_groups]
    [--security-group-rule security_group_rules]
    [--vip vips]
    [--pool pools]
    [--member members]
    [--health-monitor health_monitors]
    [--loadbalancer loadbalancers]
    [--listener listeners]
    [--rbac-policy rbac_policies]

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

--tenant-id tenant-id¶: The owner tenant ID.

--network networks¶: The limit of networks.

--subnet subnets¶: The limit of subnets.

--port ports¶: The limit of ports.

--router routers¶: The limit of routers.

--floatingip floatingips¶: The limit of floating IPs.

--security-group security_groups¶: The limit of security groups.

--security-group-rule security_group_rules¶: The limit of security groups rules.

--vip vips¶: The limit of vips.

--pool pools¶: The limit of pools.

--member members¶: The limit of pool members.

--health-monitor health_monitors¶: The limit of health monitors.

--loadbalancer loadbalancers¶: The limit of load balancers.

--listener listeners¶: The limit of listeners.

--rbac-policy rbac_policies¶: The limit of RBAC policies.

This command is provided by the python-neutronclient plugin.

rbac-create¶

Create a RBAC policy for a given tenant.

neutron rbac-create
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--tenant-id TENANT_ID]
    --type
    {network,qos-policy}
    [--target-tenant TARGET_TENANT]
    --action
    {access_as_external,access_as_shared}
    RBAC_OBJECT

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

--tenant-id TENANT_ID¶: The owner tenant ID.

--type <TYPE>¶: Type of the object that RBAC policy affects.

--target-tenant <TARGET_TENANT>¶: ID of the tenant to which the RBAC policy will be enforced.

--action <ACTION>¶: Action for the RBAC policy.

RBAC_OBJECT¶: ID or name of the RBAC object.

This command is provided by the python-neutronclient plugin.

rbac-delete¶

Delete a RBAC policy.

neutron rbac-delete RBAC_POLICY [RBAC_POLICY ...]

RBAC_POLICY¶: ID(s) of rbac_policy to delete.

This command is provided by the python-neutronclient plugin.

rbac-list¶

List RBAC policies that belong to a given tenant.

neutron rbac-list
    [-f {csv,json,table,value,yaml}]
    [-c COLUMN]
    [--quote {all,minimal,none,nonnumeric}]
    [--noindent]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [-D]
    [-F FIELD]
    [-P SIZE]
    [--sort-key FIELD]
    [--sort-dir {asc,desc}]

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--quote <QUOTE_MODE>¶: when to include quotes, defaults to nonnumeric

--noindent¶: whether to disable indenting the JSON

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

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

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

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

-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.

This command is provided by the python-neutronclient plugin.

rbac-show¶

Show information of a given RBAC policy.

neutron rbac-show
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [-D]
    [-F FIELD]
    RBAC_POLICY

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

-D, --show-details¶: Show detailed information.

-F FIELD, --field FIELD¶: Specify the field(s) to be returned by server. You can repeat this option.

RBAC_POLICY¶: ID of rbac_policy to look up.

This command is provided by the python-neutronclient plugin.

rbac-update¶

Update RBAC policy for given tenant.

neutron rbac-update [--target-tenant TARGET_TENANT] RBAC_POLICY

--target-tenant <TARGET_TENANT>¶: ID of the tenant to which the RBAC policy will be enforced.

RBAC_POLICY¶: ID of rbac_policy to update.

This command is provided by the python-neutronclient plugin.

router-create¶

Create a router for a given tenant.

neutron router-create
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--tenant-id TENANT_ID]
    [--admin-state-down]
    [--description DESCRIPTION]
    [--flavor FLAVOR]
    [--distributed {True,False}]
    [--ha {True,False}]
    [--availability-zone-hint AVAILABILITY_ZONE]
    NAME

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

--tenant-id TENANT_ID¶: The owner tenant ID.

--admin-state-down¶: Set admin state up to false.

--description <DESCRIPTION>¶: Description of router.

--flavor <FLAVOR>¶: ID or name of flavor.

--distributed {True,False}¶: Create a distributed router.

--ha {True,False}¶: Create a highly available router.

--availability-zone-hint AVAILABILITY_ZONE¶: Availability Zone for the router (requires availability zone extension, this option can be repeated).

NAME¶: Name of the router to be created.

This command is provided by the python-neutronclient plugin.

router-delete¶

Delete a given router.

neutron router-delete ROUTER [ROUTER ...]

ROUTER¶: ID(s) or name(s) of router to delete.

This command is provided by the python-neutronclient plugin.

router-gateway-clear¶

Remove an external network gateway from a router.

neutron router-gateway-clear ROUTER

ROUTER¶: ID or name of the router.

This command is provided by the python-neutronclient plugin.

router-gateway-set¶

Set the external network gateway for a router.

neutron router-gateway-set
    [--enable-snat]
    [--disable-snat]
    [--fixed-ip subnet_id=SUBNET,ip_address=IP_ADDR]
    ROUTER
    EXTERNAL-NETWORK

--enable-snat¶: Enable source NAT on the router gateway.

--disable-snat¶: Disable source NAT on the router gateway.

--fixed-ip subnet_id=SUBNET,ip_address=IP_ADDR¶: Desired IP and/or subnet on external network: subnet_id=<name_or_id>,ip_address=<ip>. You can specify both of subnet_id and ip_address or specify one of them as well. You can repeat this option.

ROUTER¶: ID or name of the router.

EXTERNAL-NETWORK¶: ID or name of the external network for the gateway.

This command is provided by the python-neutronclient plugin.

router-interface-add¶

Add an internal network interface to a router.

neutron router-interface-add ROUTER INTERFACE

ROUTER¶: ID or name of the router.

INTERFACE¶: The format is “SUBNET|subnet=SUBNET|port=PORT”. Either a subnet or port must be specified. Both ID and name are accepted as SUBNET or PORT. Note that “subnet=” can be omitted when specifying a subnet.

This command is provided by the python-neutronclient plugin.

router-interface-delete¶

Remove an internal network interface from a router.

neutron router-interface-delete ROUTER INTERFACE

ROUTER¶: ID or name of the router.

INTERFACE¶: The format is “SUBNET|subnet=SUBNET|port=PORT”. Either a subnet or port must be specified. Both ID and name are accepted as SUBNET or PORT. Note that “subnet=” can be omitted when specifying a subnet.

This command is provided by the python-neutronclient plugin.

router-list¶

List routers that belong to a given tenant.

neutron router-list
    [-f {csv,json,table,value,yaml}]
    [-c COLUMN]
    [--quote {all,minimal,none,nonnumeric}]
    [--noindent]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [-D]
    [-F FIELD]
    [-P SIZE]
    [--sort-key FIELD]
    [--sort-dir {asc,desc}]

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--quote <QUOTE_MODE>¶: when to include quotes, defaults to nonnumeric

--noindent¶: whether to disable indenting the JSON

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

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

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

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

-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.

This command is provided by the python-neutronclient plugin.

router-list-on-l3-agent¶

List the routers on a L3 agent.

neutron router-list-on-l3-agent
    [-f {csv,json,table,value,yaml}]
    [-c COLUMN]
    [--quote {all,minimal,none,nonnumeric}]
    [--noindent]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [-D]
    [-F FIELD]
    L3_AGENT

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--quote <QUOTE_MODE>¶: when to include quotes, defaults to nonnumeric

--noindent¶: whether to disable indenting the JSON

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

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

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

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

-D, --show-details¶: Show detailed information.

-F FIELD, --field FIELD¶: Specify the field(s) to be returned by server. You can repeat this option.

L3_AGENT¶: ID of the L3 agent to query.

This command is provided by the python-neutronclient plugin.

router-port-list¶

List ports that belong to a given tenant, with specified router.

neutron router-port-list
    [-f {csv,json,table,value,yaml}]
    [-c COLUMN]
    [--quote {all,minimal,none,nonnumeric}]
    [--noindent]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [-D]
    [-F FIELD]
    [-P SIZE]
    [--sort-key FIELD]
    [--sort-dir {asc,desc}]
    ROUTER

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--quote <QUOTE_MODE>¶: when to include quotes, defaults to nonnumeric

--noindent¶: whether to disable indenting the JSON

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

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

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

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

-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.

ROUTER¶: ID or name of the router to look up.

This command is provided by the python-neutronclient plugin.

router-show¶

Show information of a given router.

neutron router-show
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [-D]
    [-F FIELD]
    ROUTER

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

-D, --show-details¶: Show detailed information.

-F FIELD, --field FIELD¶: Specify the field(s) to be returned by server. You can repeat this option.

ROUTER¶: ID or name of router to look up.

This command is provided by the python-neutronclient plugin.

router-update¶

Update router’s information.

neutron router-update
    [--name NAME]
    [--description DESCRIPTION]
    [--admin-state-up {True,False}]
    [--distributed {True,False}]
    [--route destination=CIDR,nexthop=IP_ADDR | --no-routes]
    ROUTER

--name <NAME>¶: Updated name of the router.

--description <DESCRIPTION>¶: Description of router.

--admin-state-up {True,False}¶: Specify the administrative state of the router (True means “Up”).

--distributed {True,False}¶: True means this router should operate in distributed mode.

--route destination=CIDR,nexthop=IP_ADDR¶: Route to associate with the router. You can repeat this option.

--no-routes¶: Remove routes associated with the router.

ROUTER¶: ID or name of router to update.

This command is provided by the python-neutronclient plugin.

security-group-create¶

Create a security group.

neutron security-group-create
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--tenant-id TENANT_ID]
    [--description DESCRIPTION]
    NAME

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

--tenant-id TENANT_ID¶: The owner tenant ID.

--description <DESCRIPTION>¶: Description of the security group to be created.

NAME¶: Name of the security group to be created.

This command is provided by the python-neutronclient plugin.

security-group-delete¶

Delete a given security group.

neutron security-group-delete SECURITY_GROUP [SECURITY_GROUP ...]

SECURITY_GROUP¶: ID(s) or name(s) of security_group to delete.

This command is provided by the python-neutronclient plugin.

security-group-list¶

List security groups that belong to a given tenant.

neutron security-group-list
    [-f {csv,json,table,value,yaml}]
    [-c COLUMN]
    [--quote {all,minimal,none,nonnumeric}]
    [--noindent]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [-D]
    [-F FIELD]
    [-P SIZE]
    [--sort-key FIELD]
    [--sort-dir {asc,desc}]

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--quote <QUOTE_MODE>¶: when to include quotes, defaults to nonnumeric

--noindent¶: whether to disable indenting the JSON

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

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

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

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

-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.

This command is provided by the python-neutronclient plugin.

security-group-rule-create¶

Create a security group rule.

neutron security-group-rule-create
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--tenant-id TENANT_ID]
    [--description DESCRIPTION]
    [--direction {ingress,egress}]
    [--ethertype ETHERTYPE]
    [--protocol PROTOCOL]
    [--port-range-min PORT_RANGE_MIN]
    [--port-range-max PORT_RANGE_MAX]
    [--remote-ip-prefix REMOTE_IP_PREFIX]
    [--remote-group-id REMOTE_GROUP]
    SECURITY_GROUP

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

--tenant-id TENANT_ID¶: The owner tenant ID.

--description <DESCRIPTION>¶: Description of security group rule.

--direction <DIRECTION>¶: Direction of traffic: ingress/egress.

--ethertype <ETHERTYPE>¶: IPv4/IPv6

--protocol <PROTOCOL>¶: Protocol of packet. Allowed values are [icmp, icmpv6, tcp, udp] and integer representations [0-255].

--port-range-min <PORT_RANGE_MIN>¶: Starting port range. For ICMP it is type.

--port-range-max <PORT_RANGE_MAX>¶: Ending port range. For ICMP it is code.

--remote-ip-prefix <REMOTE_IP_PREFIX>¶: CIDR to match on.

--remote-group-id REMOTE_GROUP¶: ID or name of the remote security group to which the rule is applied.

SECURITY_GROUP¶: ID or name of the security group to which the rule is added.

This command is provided by the python-neutronclient plugin.

security-group-rule-delete¶

Delete a given security group rule.

neutron security-group-rule-delete
    SECURITY_GROUP_RULE
    [SECURITY_GROUP_RULE ...]

SECURITY_GROUP_RULE¶: ID(s) of security_group_rule to delete.

This command is provided by the python-neutronclient plugin.

security-group-rule-list¶

List security group rules that belong to a given tenant.

neutron security-group-rule-list
    [-f {csv,json,table,value,yaml}]
    [-c COLUMN]
    [--quote {all,minimal,none,nonnumeric}]
    [--noindent]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [-D]
    [-F FIELD]
    [-P SIZE]
    [--sort-key FIELD]
    [--sort-dir {asc,desc}]
    [--no-nameconv]

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--quote <QUOTE_MODE>¶: when to include quotes, defaults to nonnumeric

--noindent¶: whether to disable indenting the JSON

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

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

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

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

-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.

--no-nameconv¶: Do not convert security group ID to its name.

This command is provided by the python-neutronclient plugin.

security-group-rule-show¶

Show information of a given security group rule.

neutron security-group-rule-show
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [-D]
    [-F FIELD]
    SECURITY_GROUP_RULE

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

-D, --show-details¶: Show detailed information.

-F FIELD, --field FIELD¶: Specify the field(s) to be returned by server. You can repeat this option.

SECURITY_GROUP_RULE¶: ID of security_group_rule to look up.

This command is provided by the python-neutronclient plugin.

security-group-show¶

Show information of a given security group.

neutron security-group-show
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [-D]
    [-F FIELD]
    SECURITY_GROUP

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

-D, --show-details¶: Show detailed information.

-F FIELD, --field FIELD¶: Specify the field(s) to be returned by server. You can repeat this option.

SECURITY_GROUP¶: ID or name of security_group to look up.

This command is provided by the python-neutronclient plugin.

security-group-update¶

Update a given security group.

neutron security-group-update
    [--name NAME]
    [--description DESCRIPTION]
    SECURITY_GROUP

--name <NAME>¶: Updated name of the security group.

--description <DESCRIPTION>¶: Updated description of the security group.

SECURITY_GROUP¶: ID or name of security_group to update.

This command is provided by the python-neutronclient plugin.

service-provider-list¶

List service providers.

neutron service-provider-list
    [-f {csv,json,table,value,yaml}]
    [-c COLUMN]
    [--quote {all,minimal,none,nonnumeric}]
    [--noindent]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [-D]
    [-F FIELD]
    [-P SIZE]
    [--sort-key FIELD]
    [--sort-dir {asc,desc}]

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--quote <QUOTE_MODE>¶: when to include quotes, defaults to nonnumeric

--noindent¶: whether to disable indenting the JSON

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

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

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

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

-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.

This command is provided by the python-neutronclient plugin.

subnet-create¶

Create a subnet for a given tenant.

neutron subnet-create
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--tenant-id TENANT_ID]
    [--name NAME]
    [--description DESCRIPTION]
    [--gateway GATEWAY_IP | --no-gateway]
    [--allocation-pool start=IP_ADDR,end=IP_ADDR]
    [--host-route destination=CIDR,nexthop=IP_ADDR]
    [--dns-nameserver DNS_NAMESERVER]
    [--disable-dhcp]
    [--enable-dhcp]
    [--ip-version {4,6}]
    [--ipv6-ra-mode {dhcpv6-stateful,dhcpv6-stateless,slaac}]
    [--ipv6-address-mode {dhcpv6-stateful,dhcpv6-stateless,slaac}]
    [--subnetpool SUBNETPOOL]
    [--use-default-subnetpool]
    [--prefixlen PREFIX_LENGTH]
    [--segment SEGMENT]
    NETWORK
    [CIDR]

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

--tenant-id TENANT_ID¶: The owner tenant ID.

--name <NAME>¶: Name of this subnet.

--description <DESCRIPTION>¶: Description of this subnet.

--gateway GATEWAY_IP¶: Gateway IP of this subnet.

--no-gateway¶: Do not configure a gateway for this subnet.

--allocation-pool start=IP_ADDR,end=IP_ADDR¶: Allocation pool IP addresses for this subnet (This option can be repeated).

--host-route destination=CIDR,nexthop=IP_ADDR¶: Additional route (This option can be repeated).

--dns-nameserver DNS_NAMESERVER¶: DNS name server for this subnet (This option can be repeated).

--disable-dhcp¶: Disable DHCP for this subnet.

--enable-dhcp¶: Enable DHCP for this subnet.

--ip-version <IP_VERSION>¶: IP version to use, default is 4. Note that when subnetpool is specified, IP version is determined from the subnetpool and this option is ignored.

--ipv6-ra-mode <IPV6_RA_MODE>¶: IPv6 RA (Router Advertisement) mode.

--ipv6-address-mode <IPV6_ADDRESS_MODE>¶: IPv6 address mode.

--subnetpool SUBNETPOOL¶: ID or name of subnetpool from which this subnet will obtain a CIDR.

--use-default-subnetpool¶: Use default subnetpool for ip_version, if it exists.

--prefixlen PREFIX_LENGTH¶: Prefix length for subnet allocation from subnetpool.

--segment SEGMENT¶: ID of segment with which this subnet will be associated.

NETWORK¶: Network ID or name this subnet belongs to.

CIDR¶: CIDR of subnet to create.

This command is provided by the python-neutronclient plugin.

subnet-delete¶

Delete a given subnet.

neutron subnet-delete SUBNET [SUBNET ...]

SUBNET¶: ID(s) or name(s) of subnet to delete.

This command is provided by the python-neutronclient plugin.

subnet-list¶

List subnets that belong to a given tenant.

neutron subnet-list
    [-f {csv,json,table,value,yaml}]
    [-c COLUMN]
    [--quote {all,minimal,none,nonnumeric}]
    [--noindent]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [-D]
    [-F FIELD]
    [-P SIZE]
    [--sort-key FIELD]
    [--sort-dir {asc,desc}]

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--quote <QUOTE_MODE>¶: when to include quotes, defaults to nonnumeric

--noindent¶: whether to disable indenting the JSON

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

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

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

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

-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.

This command is provided by the python-neutronclient plugin.

subnet-show¶

Show information of a given subnet.

neutron subnet-show
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [-D]
    [-F FIELD]
    SUBNET

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

-D, --show-details¶: Show detailed information.

-F FIELD, --field FIELD¶: Specify the field(s) to be returned by server. You can repeat this option.

SUBNET¶: ID or name of subnet to look up.

This command is provided by the python-neutronclient plugin.

subnet-update¶

Update subnet’s information.

neutron subnet-update
    [--name NAME]
    [--description DESCRIPTION]
    [--gateway GATEWAY_IP | --no-gateway]
    [--allocation-pool start=IP_ADDR,end=IP_ADDR]
    [--host-route destination=CIDR,nexthop=IP_ADDR]
    [--dns-nameserver DNS_NAMESERVER]
    [--disable-dhcp]
    [--enable-dhcp]
    SUBNET

--name <NAME>¶: Name of this subnet.

--description <DESCRIPTION>¶: Description of this subnet.

--gateway GATEWAY_IP¶: Gateway IP of this subnet.

--no-gateway¶: Do not configure a gateway for this subnet.

--allocation-pool start=IP_ADDR,end=IP_ADDR¶: Allocation pool IP addresses for this subnet (This option can be repeated).

--host-route destination=CIDR,nexthop=IP_ADDR¶: Additional route (This option can be repeated).

--dns-nameserver DNS_NAMESERVER¶: DNS name server for this subnet (This option can be repeated).

--disable-dhcp¶: Disable DHCP for this subnet.

--enable-dhcp¶: Enable DHCP for this subnet.

SUBNET¶: ID or name of subnet to update.

This command is provided by the python-neutronclient plugin.

subnetpool-create¶

Create a subnetpool for a given tenant.

neutron subnetpool-create
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--tenant-id TENANT_ID]
    [--description DESCRIPTION]
    [--min-prefixlen MIN_PREFIXLEN]
    [--max-prefixlen MAX_PREFIXLEN]
    [--default-prefixlen DEFAULT_PREFIXLEN]
    --pool-prefix PREFIXES
    [--is-default {True,False}]
    [--shared]
    [--address-scope ADDRSCOPE]
    NAME

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

--tenant-id TENANT_ID¶: The owner tenant ID.

--description <DESCRIPTION>¶: Description of subnetpool.

--min-prefixlen <MIN_PREFIXLEN>¶: Subnetpool minimum prefix length.

--max-prefixlen <MAX_PREFIXLEN>¶: Subnetpool maximum prefix length.

--default-prefixlen <DEFAULT_PREFIXLEN>¶: Subnetpool default prefix length.

--pool-prefix <PREFIXES>¶: Subnetpool prefixes (This option can be repeated).

--is-default {True,False}¶: Specify whether this should be the default subnetpool (True meaning default).

--shared¶: Set the subnetpool as shared.

--address-scope ADDRSCOPE¶: ID or name of the address scope with which the subnetpool is associated. Prefixes must be unique across address scopes.

NAME¶: Name of the subnetpool to be created.

This command is provided by the python-neutronclient plugin.

subnetpool-delete¶

Delete a given subnetpool.

neutron subnetpool-delete SUBNETPOOL [SUBNETPOOL ...]

SUBNETPOOL¶: ID(s) or name(s) of subnetpool to delete.

This command is provided by the python-neutronclient plugin.

subnetpool-list¶

List subnetpools that belong to a given tenant.

neutron subnetpool-list
    [-f {csv,json,table,value,yaml}]
    [-c COLUMN]
    [--quote {all,minimal,none,nonnumeric}]
    [--noindent]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [-D]
    [-F FIELD]
    [-P SIZE]
    [--sort-key FIELD]
    [--sort-dir {asc,desc}]

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--quote <QUOTE_MODE>¶: when to include quotes, defaults to nonnumeric

--noindent¶: whether to disable indenting the JSON

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

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

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

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

-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.

This command is provided by the python-neutronclient plugin.

subnetpool-show¶

Show information of a given subnetpool.

neutron subnetpool-show
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [-D]
    [-F FIELD]
    SUBNETPOOL

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

-D, --show-details¶: Show detailed information.

-F FIELD, --field FIELD¶: Specify the field(s) to be returned by server. You can repeat this option.

SUBNETPOOL¶: ID or name of subnetpool to look up.

This command is provided by the python-neutronclient plugin.

subnetpool-update¶

Update subnetpool’s information.

neutron subnetpool-update
    [--description DESCRIPTION]
    [--min-prefixlen MIN_PREFIXLEN]
    [--max-prefixlen MAX_PREFIXLEN]
    [--default-prefixlen DEFAULT_PREFIXLEN]
    [--pool-prefix PREFIXES]
    [--is-default {True,False}]
    [--name NAME]
    [--address-scope ADDRSCOPE | --no-address-scope]
    SUBNETPOOL

--description <DESCRIPTION>¶: Description of subnetpool.

--min-prefixlen <MIN_PREFIXLEN>¶: Subnetpool minimum prefix length.

--max-prefixlen <MAX_PREFIXLEN>¶: Subnetpool maximum prefix length.

--default-prefixlen <DEFAULT_PREFIXLEN>¶: Subnetpool default prefix length.

--pool-prefix <PREFIXES>¶: Subnetpool prefixes (This option can be repeated).

--is-default {True,False}¶: Specify whether this should be the default subnetpool (True meaning default).

--name <NAME>¶: Updated name of the subnetpool.

--address-scope ADDRSCOPE¶: ID or name of the address scope with which the subnetpool is associated. Prefixes must be unique across address scopes.

--no-address-scope¶: Detach subnetpool from the address scope.

SUBNETPOOL¶: ID or name of subnetpool to update.

This command is provided by the python-neutronclient plugin.

tag-add¶

Add a tag into the resource.

neutron tag-add
    --resource-type
    {network,subnet,port,router,subnetpool}
    --resource RESOURCE
    --tag TAG

--resource-type <RESOURCE_TYPE>¶: Resource Type.

--resource <RESOURCE>¶: Resource name or ID.

--tag <TAG>¶: Tag to be added.

This command is provided by the python-neutronclient plugin.

tag-remove¶

Remove a tag on the resource.

neutron tag-remove
    --resource-type
    {network,subnet,port,router,subnetpool}
    --resource RESOURCE
    [--all | --tag TAG]

--resource-type <RESOURCE_TYPE>¶: Resource Type.

--resource <RESOURCE>¶: Resource name or ID.

--all¶: Remove all tags on the resource.

--tag <TAG>¶: Tag to be removed.

This command is provided by the python-neutronclient plugin.

tag-replace¶

Replace all tags on the resource.

neutron tag-replace
    --resource-type
    {network,subnet,port,router,subnetpool}
    --resource RESOURCE
    --tag TAG

--resource-type <RESOURCE_TYPE>¶: Resource Type.

--resource <RESOURCE>¶: Resource name or ID.

--tag TAG¶: Tag (This option can be repeated).

This command is provided by the python-neutronclient plugin.

vpn-endpoint-group-create¶

Create a VPN endpoint group.

neutron vpn-endpoint-group-create
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--tenant-id TENANT_ID]
    [--name NAME]
    [--description DESCRIPTION]
    --type TYPE
    --value ENDPOINTS

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

--tenant-id TENANT_ID¶: The owner tenant ID.

--name <NAME>¶: Set a name for the endpoint group.

--description <DESCRIPTION>¶: Set a description for the endpoint group.

--type <TYPE>¶: Type of endpoints in group (e.g. subnet, cidr, vlan).

--value <ENDPOINTS>¶: Endpoint(s) for the group. Must all be of the same type.

This command is provided by the python-neutronclient plugin.

vpn-endpoint-group-delete¶

Delete a given VPN endpoint group.

neutron vpn-endpoint-group-delete ENDPOINT_GROUP [ENDPOINT_GROUP ...]

ENDPOINT_GROUP¶: ID(s) or name(s) of endpoint_group to delete.

This command is provided by the python-neutronclient plugin.

vpn-endpoint-group-list¶

List VPN endpoint groups that belong to a given tenant.

neutron vpn-endpoint-group-list
    [-f {csv,json,table,value,yaml}]
    [-c COLUMN]
    [--quote {all,minimal,none,nonnumeric}]
    [--noindent]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [-D]
    [-F FIELD]
    [-P SIZE]
    [--sort-key FIELD]
    [--sort-dir {asc,desc}]

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--quote <QUOTE_MODE>¶: when to include quotes, defaults to nonnumeric

--noindent¶: whether to disable indenting the JSON

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

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

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

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

-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.

This command is provided by the python-neutronclient plugin.

vpn-endpoint-group-show¶

Show a specific VPN endpoint group.

neutron vpn-endpoint-group-show
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [-D]
    [-F FIELD]
    ENDPOINT_GROUP

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

-D, --show-details¶: Show detailed information.

-F FIELD, --field FIELD¶: Specify the field(s) to be returned by server. You can repeat this option.

ENDPOINT_GROUP¶: ID or name of endpoint_group to look up.

This command is provided by the python-neutronclient plugin.

vpn-endpoint-group-update¶

Update a given VPN endpoint group.

neutron vpn-endpoint-group-update
    [--name NAME]
    [--description DESCRIPTION]
    ENDPOINT_GROUP

--name <NAME>¶: Set a name for the endpoint group.

--description <DESCRIPTION>¶: Set a description for the endpoint group.

ENDPOINT_GROUP¶: ID or name of endpoint_group to update.

This command is provided by the python-neutronclient plugin.

vpn-ikepolicy-create¶

Create an IKE policy.

neutron vpn-ikepolicy-create
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--tenant-id TENANT_ID]
    [--description DESCRIPTION]
    [--auth-algorithm {sha1,sha256,sha384,sha512}]
    [--encryption-algorithm ENCRYPTION_ALGORITHM]
    [--phase1-negotiation-mode {main}]
    [--ike-version {v1,v2}]
    [--pfs PFS]
    [--lifetime units=UNITS,value=VALUE]
    NAME

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

--tenant-id TENANT_ID¶: The owner tenant ID.

--description <DESCRIPTION>¶: Description of the IKE policy.

--auth-algorithm <AUTH_ALGORITHM>¶: Authentication algorithm, default:sha1.

--encryption-algorithm <ENCRYPTION_ALGORITHM>¶: Encryption algorithm, default:aes-128.

--phase1-negotiation-mode <PHASE1_NEGOTIATION_MODE>¶: IKE Phase1 negotiation mode, default:main.

--ike-version <IKE_VERSION>¶: IKE version for the policy, default:v1.

--pfs <PFS>¶: Perfect Forward Secrecy, default:group5.

--lifetime units=UNITS,value=VALUE¶: IKE lifetime attributes. ‘units’-seconds, default:seconds. ‘value’-non negative integer, default:3600.

NAME¶: Name of the IKE policy.

This command is provided by the python-neutronclient plugin.

vpn-ikepolicy-delete¶

Delete a given IKE policy.

neutron vpn-ikepolicy-delete IKEPOLICY [IKEPOLICY ...]

IKEPOLICY¶: ID(s) or name(s) of IKE policy to delete.

This command is provided by the python-neutronclient plugin.

vpn-ikepolicy-list¶

List IKE policies that belong to a tenant.

neutron vpn-ikepolicy-list
    [-f {csv,json,table,value,yaml}]
    [-c COLUMN]
    [--quote {all,minimal,none,nonnumeric}]
    [--noindent]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [-D]
    [-F FIELD]
    [-P SIZE]
    [--sort-key FIELD]
    [--sort-dir {asc,desc}]

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--quote <QUOTE_MODE>¶: when to include quotes, defaults to nonnumeric

--noindent¶: whether to disable indenting the JSON

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

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

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

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

-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.

This command is provided by the python-neutronclient plugin.

vpn-ikepolicy-show¶

Show information of a given IKE policy.

neutron vpn-ikepolicy-show
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [-D]
    [-F FIELD]
    IKEPOLICY

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

-D, --show-details¶: Show detailed information.

-F FIELD, --field FIELD¶: Specify the field(s) to be returned by server. You can repeat this option.

IKEPOLICY¶: ID or name of IKE policy to look up.

This command is provided by the python-neutronclient plugin.

vpn-ikepolicy-update¶

Update a given IKE policy.

neutron vpn-ikepolicy-update
    [--name NAME]
    [--description DESCRIPTION]
    [--auth-algorithm {sha1,sha256,sha384,sha512}]
    [--encryption-algorithm ENCRYPTION_ALGORITHM]
    [--phase1-negotiation-mode {main}]
    [--ike-version {v1,v2}]
    [--pfs PFS]
    [--lifetime units=UNITS,value=VALUE]
    IKEPOLICY

--name <NAME>¶: Updated name of the IKE policy.

--description <DESCRIPTION>¶: Description of the IKE policy.

--auth-algorithm <AUTH_ALGORITHM>¶: Authentication algorithm, default:sha1.

--encryption-algorithm <ENCRYPTION_ALGORITHM>¶: Encryption algorithm, default:aes-128.

--phase1-negotiation-mode <PHASE1_NEGOTIATION_MODE>¶: IKE Phase1 negotiation mode, default:main.

--ike-version <IKE_VERSION>¶: IKE version for the policy, default:v1.

--pfs <PFS>¶: Perfect Forward Secrecy, default:group5.

--lifetime units=UNITS,value=VALUE¶: IKE lifetime attributes. ‘units’-seconds, default:seconds. ‘value’-non negative integer, default:3600.

IKEPOLICY¶: ID or name of IKE policy to update.

This command is provided by the python-neutronclient plugin.

vpn-ipsecpolicy-create¶

Create an IPsec policy.

neutron vpn-ipsecpolicy-create
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--tenant-id TENANT_ID]
    [--auth-algorithm {sha1,sha256,sha384,sha512}]
    [--description DESCRIPTION]
    [--encapsulation-mode {tunnel,transport}]
    [--encryption-algorithm ENCRYPTION_ALGORITHM]
    [--lifetime units=UNITS,value=VALUE]
    [--pfs PFS]
    [--transform-protocol {esp,ah,ah-esp}]
    NAME

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

--tenant-id TENANT_ID¶: The owner tenant ID.

--auth-algorithm <AUTH_ALGORITHM>¶: Authentication algorithm for IPsec policy, default:sha1.

--description <DESCRIPTION>¶: Description of the IPsec policy.

--encapsulation-mode <ENCAPSULATION_MODE>¶: Encapsulation mode for IPsec policy, default:tunnel.

--encryption-algorithm <ENCRYPTION_ALGORITHM>¶: Encryption algorithm for IPsec policy, default:aes-128.

--lifetime units=UNITS,value=VALUE¶: IPsec lifetime attributes. ‘units’-seconds, default:seconds. ‘value’-non negative integer, default:3600.

--pfs <PFS>¶: Perfect Forward Secrecy for IPsec policy, default:group5.

--transform-protocol <TRANSFORM_PROTOCOL>¶: Transform protocol for IPsec policy, default:esp.

NAME¶: Name of the IPsec policy.

This command is provided by the python-neutronclient plugin.

vpn-ipsecpolicy-delete¶

Delete a given IPsec policy.

neutron vpn-ipsecpolicy-delete IPSECPOLICY [IPSECPOLICY ...]

IPSECPOLICY¶: ID(s) or name(s) of IPsec policy to delete.

This command is provided by the python-neutronclient plugin.

vpn-ipsecpolicy-list¶

List IPsec policies that belong to a given tenant connection.

neutron vpn-ipsecpolicy-list
    [-f {csv,json,table,value,yaml}]
    [-c COLUMN]
    [--quote {all,minimal,none,nonnumeric}]
    [--noindent]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [-D]
    [-F FIELD]
    [-P SIZE]
    [--sort-key FIELD]
    [--sort-dir {asc,desc}]

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--quote <QUOTE_MODE>¶: when to include quotes, defaults to nonnumeric

--noindent¶: whether to disable indenting the JSON

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

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

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

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

-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.

This command is provided by the python-neutronclient plugin.

vpn-ipsecpolicy-show¶

Show information of a given IPsec policy.

neutron vpn-ipsecpolicy-show
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [-D]
    [-F FIELD]
    IPSECPOLICY

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

-D, --show-details¶: Show detailed information.

-F FIELD, --field FIELD¶: Specify the field(s) to be returned by server. You can repeat this option.

IPSECPOLICY¶: ID or name of IPsec policy to look up.

This command is provided by the python-neutronclient plugin.

vpn-ipsecpolicy-update¶

Update a given IPsec policy.

neutron vpn-ipsecpolicy-update
    [--name NAME]
    [--auth-algorithm {sha1,sha256,sha384,sha512}]
    [--description DESCRIPTION]
    [--encapsulation-mode {tunnel,transport}]
    [--encryption-algorithm ENCRYPTION_ALGORITHM]
    [--lifetime units=UNITS,value=VALUE]
    [--pfs PFS]
    [--transform-protocol {esp,ah,ah-esp}]
    IPSECPOLICY

--name <NAME>¶: Updated name of the IPsec policy.

--auth-algorithm <AUTH_ALGORITHM>¶: Authentication algorithm for IPsec policy, default:sha1.

--description <DESCRIPTION>¶: Description of the IPsec policy.

--encapsulation-mode <ENCAPSULATION_MODE>¶: Encapsulation mode for IPsec policy, default:tunnel.

--encryption-algorithm <ENCRYPTION_ALGORITHM>¶: Encryption algorithm for IPsec policy, default:aes-128.

--lifetime units=UNITS,value=VALUE¶: IPsec lifetime attributes. ‘units’-seconds, default:seconds. ‘value’-non negative integer, default:3600.

--pfs <PFS>¶: Perfect Forward Secrecy for IPsec policy, default:group5.

--transform-protocol <TRANSFORM_PROTOCOL>¶: Transform protocol for IPsec policy, default:esp.

IPSECPOLICY¶: ID or name of IPsec policy to update.

This command is provided by the python-neutronclient plugin.

vpn-service-create¶

Create a VPN service.

neutron vpn-service-create
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--tenant-id TENANT_ID]
    [--admin-state-down]
    [--name NAME]
    [--description DESCRIPTION]
    ROUTER
    [SUBNET]

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

--tenant-id TENANT_ID¶: The owner tenant ID.

--admin-state-down¶: Set admin state up to false.

--name <NAME>¶: Name for the VPN service.

--description <DESCRIPTION>¶: Description for the VPN service.

ROUTER¶: Router unique identifier for the VPN service.

SUBNET¶: [DEPRECATED in Mitaka] Unique identifier for the local private subnet.

This command is provided by the python-neutronclient plugin.

vpn-service-delete¶

Delete a given VPN service.

neutron vpn-service-delete VPNSERVICE [VPNSERVICE ...]

VPNSERVICE¶: ID(s) or name(s) of VPN service to delete.

This command is provided by the python-neutronclient plugin.

vpn-service-list¶

List VPN service configurations that belong to a given tenant.

neutron vpn-service-list
    [-f {csv,json,table,value,yaml}]
    [-c COLUMN]
    [--quote {all,minimal,none,nonnumeric}]
    [--noindent]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [-D]
    [-F FIELD]
    [-P SIZE]
    [--sort-key FIELD]
    [--sort-dir {asc,desc}]

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--quote <QUOTE_MODE>¶: when to include quotes, defaults to nonnumeric

--noindent¶: whether to disable indenting the JSON

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

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

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

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

-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.

This command is provided by the python-neutronclient plugin.

vpn-service-show¶

Show information of a given VPN service.

neutron vpn-service-show
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--noindent]
    [--prefix PREFIX]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [-D]
    [-F FIELD]
    VPNSERVICE

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated to show multiple columns

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

-D, --show-details¶: Show detailed information.

-F FIELD, --field FIELD¶: Specify the field(s) to be returned by server. You can repeat this option.

VPNSERVICE¶: ID or name of VPN service to look up.

This command is provided by the python-neutronclient plugin.

vpn-service-update¶

Update a given VPN service.

neutron vpn-service-update
    [--name NAME]
    [--description DESCRIPTION]
    [--admin-state-up {True,False}]
    VPNSERVICE

--name <NAME>¶: Name for the VPN service.

--description <DESCRIPTION>¶: Description for the VPN service.

--admin-state-up {True,False}¶: Update the admin state for the VPN Service.(True means UP)

VPNSERVICE¶: ID or name of VPN service to update.

This command is provided by the python-neutronclient plugin.