neutron CLI reference¶

address-scope-create¶

Create an address scope for a given tenant.

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

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

--noindent¶

whether to disable indenting the JSON

--prefix <PREFIX>¶

add a prefix to all variable names

--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]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--noindent]
    [--quote {all,minimal,none,nonnumeric}]
    [--sort-column SORT_COLUMN]
    [-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

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

--noindent¶

whether to disable indenting the JSON

--quote <QUOTE_MODE>¶

when to include quotes, defaults to nonnumeric

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

-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]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--noindent]
    [--prefix PREFIX]
    [-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

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

--noindent¶

whether to disable indenting the JSON

--prefix <PREFIX>¶

add a prefix to all variable names

-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]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--noindent]
    [--quote {all,minimal,none,nonnumeric}]
    [--sort-column SORT_COLUMN]
    [-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

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

--noindent¶

whether to disable indenting the JSON

--quote <QUOTE_MODE>¶

when to include quotes, defaults to nonnumeric

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

-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]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--noindent]
    [--prefix PREFIX]
    [-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

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

--noindent¶

whether to disable indenting the JSON

--prefix <PREFIX>¶

add a prefix to all variable names

-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]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--noindent]
    [--prefix PREFIX]
    [--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

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

--noindent¶

whether to disable indenting the JSON

--prefix <PREFIX>¶

add a prefix to all variable names

--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]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--noindent]
    [--quote {all,minimal,none,nonnumeric}]
    [--sort-column SORT_COLUMN]
    [-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

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

--noindent¶

whether to disable indenting the JSON

--quote <QUOTE_MODE>¶

when to include quotes, defaults to nonnumeric

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

-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]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--noindent]
    [--quote {all,minimal,none,nonnumeric}]
    [--sort-column SORT_COLUMN]
    [-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

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

--noindent¶

whether to disable indenting the JSON

--quote <QUOTE_MODE>¶

when to include quotes, defaults to nonnumeric

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

-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]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--noindent]
    [--prefix PREFIX]
    [--tenant-id TENANT_ID]
    --peer
    -i
    p
    PEER_IP_ADDRESS
    --remote
    -a
    s
    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

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

--noindent¶

whether to disable indenting the JSON

--prefix <PREFIX>¶

add a prefix to all variable names

--tenant-id TENANT_ID¶

The owner tenant ID.

--peer-ip PEER_IP_ADDRESS¶

Peer IP address.

--remote-as PEER_REMOTE_AS¶

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

--auth-type PEER_AUTH_TYPE¶

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

--password AUTH_PASSWORD¶

Authentication password.

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]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--noindent]
    [--quote {all,minimal,none,nonnumeric}]
    [--sort-column SORT_COLUMN]
    [-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

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

--noindent¶

whether to disable indenting the JSON

--quote <QUOTE_MODE>¶

when to include quotes, defaults to nonnumeric

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

-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]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--noindent]
    [--prefix PREFIX]
    [-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

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

--noindent¶

whether to disable indenting the JSON

--prefix <PREFIX>¶

add a prefix to all variable names

-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]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--noindent]
    [--quote {all,minimal,none,nonnumeric}]
    [--sort-column SORT_COLUMN]
    [-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

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

--noindent¶

whether to disable indenting the JSON

--quote <QUOTE_MODE>¶

when to include quotes, defaults to nonnumeric

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

-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]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--noindent]
    [--prefix PREFIX]
    [--tenant-id TENANT_ID]
    --local
    -a
    s
    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

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

--noindent¶

whether to disable indenting the JSON

--prefix <PREFIX>¶

add a prefix to all variable names

--tenant-id TENANT_ID¶

The owner tenant ID.

--local-as LOCAL_AS¶

Local AS number. (Integer in [1, 65535] 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]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--noindent]
    [--quote {all,minimal,none,nonnumeric}]
    [--sort-column SORT_COLUMN]
    [-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

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

--noindent¶

whether to disable indenting the JSON

--quote <QUOTE_MODE>¶

when to include quotes, defaults to nonnumeric

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

-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]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--noindent]
    [--quote {all,minimal,none,nonnumeric}]
    [--sort-column SORT_COLUMN]
    [-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

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

--noindent¶

whether to disable indenting the JSON

--quote <QUOTE_MODE>¶

when to include quotes, defaults to nonnumeric

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

-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]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--noindent]
    [--prefix PREFIX]
    [-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

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

--noindent¶

whether to disable indenting the JSON

--prefix <PREFIX>¶

add a prefix to all variable names

-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]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--noindent]
    [--quote {all,minimal,none,nonnumeric}]
    [--sort-column SORT_COLUMN]
    [-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

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

--noindent¶

whether to disable indenting the JSON

--quote <QUOTE_MODE>¶

when to include quotes, defaults to nonnumeric

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

-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]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--noindent]
    [--quote {all,minimal,none,nonnumeric}]
    [--sort-column SORT_COLUMN]
    [-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

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

--noindent¶

whether to disable indenting the JSON

--quote <QUOTE_MODE>¶

when to include quotes, defaults to nonnumeric

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

-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]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--noindent]
    [--prefix PREFIX]
    [-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

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

--noindent¶

whether to disable indenting the JSON

--prefix <PREFIX>¶

add a prefix to all variable names

-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]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--noindent]
    [--prefix PREFIX]
    [--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

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

--noindent¶

whether to disable indenting the JSON

--prefix <PREFIX>¶

add a prefix to all variable names

--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]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--noindent]
    [--quote {all,minimal,none,nonnumeric}]
    [--sort-column SORT_COLUMN]
    [-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

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

--noindent¶

whether to disable indenting the JSON

--quote <QUOTE_MODE>¶

when to include quotes, defaults to nonnumeric

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

-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]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--noindent]
    [--prefix PREFIX]
    [--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

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

--noindent¶

whether to disable indenting the JSON

--prefix <PREFIX>¶

add a prefix to all variable names

--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]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--noindent]
    [--quote {all,minimal,none,nonnumeric}]
    [--sort-column SORT_COLUMN]
    [-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

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

--noindent¶

whether to disable indenting the JSON

--quote <QUOTE_MODE>¶

when to include quotes, defaults to nonnumeric

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

-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]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--noindent]
    [--prefix PREFIX]
    [-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

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

--noindent¶

whether to disable indenting the JSON

--prefix <PREFIX>¶

add a prefix to all variable names

-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]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--noindent]
    [--prefix PREFIX]
    [--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

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

--noindent¶

whether to disable indenting the JSON

--prefix <PREFIX>¶

add a prefix to all variable names

--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]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--noindent]
    [--quote {all,minimal,none,nonnumeric}]
    [--sort-column SORT_COLUMN]
    [-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

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

--noindent¶

whether to disable indenting the JSON

--quote <QUOTE_MODE>¶

when to include quotes, defaults to nonnumeric

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

-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]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--noindent]
    [--prefix PREFIX]
    [-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

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

--noindent¶

whether to disable indenting the JSON

--prefix <PREFIX>¶

add a prefix to all variable names

-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]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--noindent]
    [--prefix PREFIX]
    [-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

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

--noindent¶

whether to disable indenting the JSON

--prefix <PREFIX>¶

add a prefix to all variable names

-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]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--noindent]
    [--prefix PREFIX]
    [--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

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

--noindent¶

whether to disable indenting the JSON

--prefix <PREFIX>¶

add a prefix to all variable names

--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]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--noindent]
    [--quote {all,minimal,none,nonnumeric}]
    [--sort-column SORT_COLUMN]
    [-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

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

--noindent¶

whether to disable indenting the JSON

--quote <QUOTE_MODE>¶

when to include quotes, defaults to nonnumeric

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

-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]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--noindent]
    [--prefix PREFIX]
    [--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

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

--noindent¶

whether to disable indenting the JSON

--prefix <PREFIX>¶

add a prefix to all variable names

--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]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--noindent]
    [--quote {all,minimal,none,nonnumeric}]
    [--sort-column SORT_COLUMN]
    [-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

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

--noindent¶

whether to disable indenting the JSON

--quote <QUOTE_MODE>¶

when to include quotes, defaults to nonnumeric

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

-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]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--noindent]
    [--prefix PREFIX]
    [-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

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

--noindent¶

whether to disable indenting the JSON

--prefix <PREFIX>¶

add a prefix to all variable names

-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]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--noindent]
    [--prefix PREFIX]
    [-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

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

--noindent¶

whether to disable indenting the JSON

--prefix <PREFIX>¶

add a prefix to all variable names

-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]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--noindent]
    [--prefix PREFIX]
    [--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

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

--noindent¶

whether to disable indenting the JSON

--prefix <PREFIX>¶

add a prefix to all variable names

--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]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--noindent]
    [--quote {all,minimal,none,nonnumeric}]
    [--sort-column SORT_COLUMN]
    [-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

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

--noindent¶

whether to disable indenting the JSON

--quote <QUOTE_MODE>¶

when to include quotes, defaults to nonnumeric

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

-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]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--noindent]
    [--prefix PREFIX]
    [-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

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

--noindent¶

whether to disable indenting the JSON

--prefix <PREFIX>¶

add a prefix to all variable names

-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]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--noindent]
    [--prefix PREFIX]
    [--tenant-id TENANT_ID]
    [--admin-state-down]
    --vpnservice
    -i
    d
    VPNSERVICE
    --ikepolicy
    -i
    d
    IKEPOLICY
    --ipsecpolicy
    -i
    d
    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
    -i
    d
    PEER_ID
    --peer
    -a
    ddress
    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

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

--noindent¶

whether to disable indenting the JSON

--prefix <PREFIX>¶

add a prefix to all variable names

--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]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--noindent]
    [--quote {all,minimal,none,nonnumeric}]
    [--sort-column SORT_COLUMN]
    [-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

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

--noindent¶

whether to disable indenting the JSON

--quote <QUOTE_MODE>¶

when to include quotes, defaults to nonnumeric

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

-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]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--noindent]
    [--prefix PREFIX]
    [-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

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

--noindent¶

whether to disable indenting the JSON

--prefix <PREFIX>¶

add a prefix to all variable names

-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]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--noindent]
    [--quote {all,minimal,none,nonnumeric}]
    [--sort-column SORT_COLUMN]
    [-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

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

--noindent¶

whether to disable indenting the JSON

--quote <QUOTE_MODE>¶

when to include quotes, defaults to nonnumeric

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

-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]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--noindent]
    [--quote {all,minimal,none,nonnumeric}]
    [--sort-column SORT_COLUMN]
    [-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

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

--noindent¶

whether to disable indenting the JSON

--quote <QUOTE_MODE>¶

when to include quotes, defaults to nonnumeric

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

-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]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--noindent]
    [--prefix PREFIX]
    [--tenant-id TENANT_ID]
    [--admin-state-down]
    [--expected-codes EXPECTED_CODES]
    [--http-method HTTP_METHOD]
    [--url-path URL_PATH]
    --delay
    DELAY
    --max
    -r
    etries
    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

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

--noindent¶

whether to disable indenting the JSON

--prefix <PREFIX>¶

add a prefix to all variable names

--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]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--noindent]
    [--quote {all,minimal,none,nonnumeric}]
    [--sort-column SORT_COLUMN]
    [-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

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

--noindent¶

whether to disable indenting the JSON

--quote <QUOTE_MODE>¶

when to include quotes, defaults to nonnumeric

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

-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]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--noindent]
    [--prefix PREFIX]
    [-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

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

--noindent¶

whether to disable indenting the JSON

--prefix <PREFIX>¶

add a prefix to all variable names

-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]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--noindent]
    [--prefix PREFIX]
    [--tenant-id TENANT_ID]
    [--admin-state-down]
    [--weight WEIGHT]
    --address
    ADDRESS
    --protocol
    -p
    ort
    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

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

--noindent¶

whether to disable indenting the JSON

--prefix <PREFIX>¶

add a prefix to all variable names

--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]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--noindent]
    [--quote {all,minimal,none,nonnumeric}]
    [--sort-column SORT_COLUMN]
    [-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

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

--noindent¶

whether to disable indenting the JSON

--quote <QUOTE_MODE>¶

when to include quotes, defaults to nonnumeric

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

-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]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--noindent]
    [--prefix PREFIX]
    [-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

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

--noindent¶

whether to disable indenting the JSON

--prefix <PREFIX>¶

add a prefix to all variable names

-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]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--noindent]
    [--prefix PREFIX]
    [--tenant-id TENANT_ID]
    [--admin-state-down]
    [--description DESCRIPTION]
    --lb
    -m
    ethod
    {ROUND_ROBIN,LEAST_CONNECTIONS,SOURCE_IP}
    --name
    NAME
    --protocol
    {HTTP,HTTPS,TCP}
    --subnet
    -i
    d
    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

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

--noindent¶

whether to disable indenting the JSON

--prefix <PREFIX>¶

add a prefix to all variable names