Chapter 43. network

<agent-id>

Agent to which a network is added (id only)

<network>

Network to be added to an agent (name or id)

-h, --help

Show this help message and exit

--dhcp

Add network to a dhcp agent

<agent-id>

Agent to which a router is added (id only)

<router>

Router to be added to an agent (name or id)

--l3

Add router to an l3 agent

-h, --help

Show this help message and exit

<network-agent>

Network agent(s) to delete (id only)

-h, --help

Show this help message and exit

--print-empty

Print empty table if there is no data to show.

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

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

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

--noindent

Whether to disable indenting the json

--router <router>

List agents hosting this router (name or id)

--host <host>

List only agents running on the specified host

--long

List additional fields in output

--network <network>

List agents hosting a network (name or id)

--agent-type <agent-type>

List only agents with the specified agent type. the supported agent types are: bgp, dhcp, open-vswitch, linux-bridge, ofa, l3, loadbalancer, metering, metadata, macvtap, nic.

-h, --help

Show this help message and exit

<agent-id>

Agent to which a network is removed (id only)

<network>

Network to be removed from an agent (name or id)

-h, --help

Show this help message and exit

--dhcp

Remove network from dhcp agent

<agent-id>

Agent from which router will be removed (id only)

<router>

Router to be removed from an agent (name or id)

--l3

Remove router from an l3 agent

-h, --help

Show this help message and exit

<network-agent>

Network agent to modify (id only)

--disable

Disable network agent

-h, --help

Show this help message and exit

--description <description>

Set network agent description

--enable

Enable network agent

--print-empty

Print empty table if there is no data to show.

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

<network-agent>

Network agent to display (id only)

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--noindent

Whether to disable indenting the json

-h, --help

Show this help message and exit

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

--print-empty

Print empty table if there is no data to show.

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

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--noindent

Whether to disable indenting the json

-h, --help

Show this help message and exit

--check-resources

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

--or-show

If topology exists returns the topology’s information (Default)

--project <project>

Return the auto allocated topology for a given project. Default is current project

--project-domain <project-domain>

Domain the project belongs to (name or id). this can be used in case collisions between project names exist.

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

-h, --help

Show this help message and exit

--project <project>

Delete auto allocated topology for a given project. Default is the current project

--project-domain <project-domain>

Domain the project belongs to (name or id). this can be used in case collisions between project names exist.

--print-empty

Print empty table if there is no data to show.

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

<name>

New network name

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--noindent

Whether to disable indenting the json

--availability-zone-hint <availability-zone>

Availability zone in which to create this network (Network Availability Zone extension required, repeat option to set multiple availability zones)

--enable

Enable network (default)

--internal

Set this network as an internal network (default)

--disable-port-security

Disable port security by default for ports created on this network

--transparent-vlan

Make the network vlan transparent

--share

Share the network between projects

--enable-port-security

Enable port security by default for ports created on this network (default)

--provider-segment <provider-segment>

Vlan id for vlan networks or tunnel id for GENEVE/GRE/VXLAN networks

--qos-policy <qos-policy>

Qos policy to attach to this network (name or id)

-h, --help

Show this help message and exit

--description <description>

Set network description

--project-domain <project-domain>

Domain the project belongs to (name or id). this can be used in case collisions between project names exist.

--mtu <mtu>

Set network mtu

--no-tag

No tags associated with the network

--no-transparent-vlan

Do not make the network vlan transparent

--no-share

Do not share the network between projects

--external

Set this network as an external network (external-net extension required)

--provider-physical-network <provider-physical-network>

Name of the physical network over which the virtual network is implemented

--default

Specify if this network should be used as the default external network

--provider-network-type <provider-network-type>

The physical mechanism by which the virtual network is implemented. For example: flat, geneve, gre, local, vlan, vxlan.

--project <project>

Owner’s project (name or id)

--tag <tag>

Tag to be added to the network (repeat option to set multiple tags)

--disable

Disable network

--no-default

Do not use the network as the default external network (default)

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

<network>

Network(s) to delete (name or id)

-h, --help

Show this help message and exit

<service-profile>

Service profile (id only)

<flavor>

Network flavor (name or id)

-h, --help

Show this help message and exit

--print-empty

Print empty table if there is no data to show.

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

<name>

Name for the flavor

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--noindent

Whether to disable indenting the json

--enable

Enable the flavor (default)

--project <project>

Owner’s project (name or id)

--service-type <service-type>

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

--description DESCRIPTION

Description for the flavor

-h, --help

Show this help message and exit

--disable

Disable the flavor

--project-domain <project-domain>

Domain the project belongs to (name or id). this can be used in case collisions between project names exist.

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

<flavor>

Flavor(s) to delete (name or id)

-h, --help

Show this help message and exit

--print-empty

Print empty table if there is no data to show.

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

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

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

--noindent

Whether to disable indenting the json

-h, --help

Show this help message and exit

--print-empty

Print empty table if there is no data to show.

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

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--noindent

Whether to disable indenting the json

--description <description>

Description for the flavor profile

--driver DRIVER

Python module path to driver. this becomes required if --metainfo is missing and vice versa

--enable

Enable the flavor profile

--project-domain <project-domain>

Domain the project belongs to (name or id). this can be used in case collisions between project names exist.

-h, --help

Show this help message and exit

--disable

Disable the flavor profile

--project <project>

Owner’s project (name or id)

--metainfo METAINFO

Metainfo for the flavor profile. this becomes required if --driver is missing and vice versa

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

<flavor-profile>

Flavor profile(s) to delete (id only)

-h, --help

Show this help message and exit

--print-empty

Print empty table if there is no data to show.

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

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

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

--noindent

Whether to disable indenting the json

-h, --help

Show this help message and exit

<flavor-profile>

Flavor profile to update (id only)

--description <description>

Description for the flavor profile

--driver DRIVER

Python module path to driver. this becomes required if --metainfo is missing and vice versa

--enable

Enable the flavor profile

-h, --help

Show this help message and exit

--disable

Disable the flavor profile

--project-domain <project-domain>

Domain the project belongs to (name or id). this can be used in case collisions between project names exist.

--metainfo METAINFO

Metainfo for the flavor profile. this becomes required if --driver is missing and vice versa

--print-empty

Print empty table if there is no data to show.

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

<flavor-profile>

Flavor profile to display (id only)

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--noindent

Whether to disable indenting the json

-h, --help

Show this help message and exit

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

<service-profile>

Service profile (id only)

<flavor>

Network flavor (name or id)

-h, --help

Show this help message and exit

<flavor>

Flavor to update (name or id)

--enable

Enable network flavor

--name <name>

Set flavor name

-h, --help

Show this help message and exit

--disable

Disable network flavor

--description DESCRIPTION

Set network flavor description

--print-empty

Print empty table if there is no data to show.

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

<flavor>

Flavor to display (name or id)

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--noindent

Whether to disable indenting the json

-h, --help

Show this help message and exit

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

--print-empty

Print empty table if there is no data to show.

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

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

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

--noindent

Whether to disable indenting the json

--share

List networks shared between projects

--agent <agent-id>

List networks hosted by agent (id only)

--tags <tag>[,<tag>,…​]

List networks which have all given tag(s) (comma- separated list of tags)

--enable

List enabled networks

--not-any-tags <tag>[,<tag>,…​]

Exclude networks which have any given tag(s) (comma- separated list of tags)

--name <name>

List networks according to their name

--internal

List internal networks

--long

List additional fields in output

--project-domain <project-domain>

Domain the project belongs to (name or id). this can be used in case collisions between project names exist.

--any-tags <tag>[,<tag>,…​]

List networks which have any given tag(s) (comma- separated list of tags)

--status <status>

List networks according to their status (active, BUILD, DOWN, ERROR)

--provider-segment <provider-segment>

List networks according to vlan id for vlan networks or Tunnel ID for GENEVE/GRE/VXLAN networks

--no-share

List networks not shared between projects

--external

List external networks

--provider-physical-network <provider-physical-network>

List networks according to name of the physical network

--provider-network-type <provider-network-type>

List networks according to their physical mechanisms. The supported options are: flat, geneve, gre, local, vlan, vxlan.

-h, --help

Show this help message and exit

--disable

List disabled networks

--not-tags <tag>[,<tag>,…​]

Exclude networks which have all given tag(s) (comma- separated list of tags)

--project <project>

List networks according to their project (name or id)

--print-empty

Print empty table if there is no data to show.

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

<name>

Name for the network log

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--noindent

Whether to disable indenting the json

--description <description>

Description of the network log

--enable

Enable this log (default is disabled)

--resource <resource>

Security group (name or id) for logging. you can control for logging target combination with --target option.

--project <project>

Owner’s project (name or id)

--resource-type <resource-type>

Network log type(s). you can see supported type(s) with following command: $ openstack network loggable resource list

--event <event>

An event to store with log

--target <target>

Port (name or id) for logging. you can control for logging target combination with --resource option.

-h, --help

Show this help message and exit

--disable

Disable this log

--project-domain <project-domain>

Domain the project belongs to (name or id). this can be used in case collisions between project names exist.

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

<network-log>

Network log(s) to delete (name or id)

-h, --help

Show this help message and exit

--print-empty

Print empty table if there is no data to show.

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

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

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

--noindent

Whether to disable indenting the json

-h, --help

Show this help message and exit

--long

List additional fields in output

<network-log>

Network log to set (name or id)

--disable

Disable this log

-h, --help

Show this help message and exit

--description <description>

Description of the network log

--name <name>

Name of the network log

--enable

Enable this log (default is disabled)

--print-empty

Print empty table if there is no data to show.

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

<network-log>

Network log to show (name or id)

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--noindent

Whether to disable indenting the json

-h, --help

Show this help message and exit

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

--print-empty

Print empty table if there is no data to show.

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

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

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

--noindent

Whether to disable indenting the json

-h, --help

Show this help message and exit

--long

List additional fields in output

--print-empty

Print empty table if there is no data to show.

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

<name>

Name of meter

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--noindent

Whether to disable indenting the json

--share

Share meter between projects

--project-domain <project-domain>

Domain the project belongs to (name or id). this can be used in case collisions between project names exist.

--no-share

Do not share meter between projects

-h, --help

Show this help message and exit

--description <description>

Create description for meter

--project <project>

Owner’s project (name or id)

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

<meter>

Meter to delete (name or id)

-h, --help

Show this help message and exit

--print-empty

Print empty table if there is no data to show.

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

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

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

--noindent

Whether to disable indenting the json

-h, --help

Show this help message and exit

--print-empty

Print empty table if there is no data to show.

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

<meter>

Label to associate with this metering rule (name or ID)

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--noindent

Whether to disable indenting the json

--exclude

Exclude remote ip prefix from traffic count

--include

Include remote ip prefix from traffic count (default)

--remote-ip-prefix <remote-ip-prefix>

The remote ip prefix to associate with this rule

--ingress

Apply rule to incoming network traffic (default)

--project-domain <project-domain>

Domain the project belongs to (name or id). this can be used in case collisions between project names exist.

-h, --help

Show this help message and exit

--project <project>

Owner’s project (name or id)

--egress

Apply rule to outgoing network traffic

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

<meter-rule-id>

Meter rule to delete (id only)

-h, --help

Show this help message and exit

--print-empty

Print empty table if there is no data to show.

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

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

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

--noindent

Whether to disable indenting the json

-h, --help

Show this help message and exit

--print-empty

Print empty table if there is no data to show.

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

<meter-rule-id>

Meter rule (id only)

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--noindent

Whether to disable indenting the json

-h, --help

Show this help message and exit

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

--print-empty

Print empty table if there is no data to show.

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

<meter>

Meter to display (name or id)

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--noindent

Whether to disable indenting the json

-h, --help

Show this help message and exit

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

--print-empty

Print empty table if there is no data to show.

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

<name>

Name of qos policy to create

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--noindent

Whether to disable indenting the json

--share

Make the qos policy accessible by other projects

--project-domain <project-domain>

Domain the project belongs to (name or id). this can be used in case collisions between project names exist.

--no-share

Make the qos policy not accessible by other projects (default)

--no-default

Set this as a non-default network qos policy

--default

Set this as a default network qos policy

-h, --help

Show this help message and exit

--description <description>

Description of the qos policy

--project <project>

Owner’s project (name or id)

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

<qos-policy>

Qos policy(s) to delete (name or id)

-h, --help

Show this help message and exit

--print-empty

Print empty table if there is no data to show.

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

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

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

--noindent

Whether to disable indenting the json

--share

List qos policies shared between projects

-h, --help

Show this help message and exit

--no-share

List qos policies not shared between projects

--project <project>

List qos policies according to their project (name or ID)

--project-domain <project-domain>

Domain the project belongs to (name or id). this can be used in case collisions between project names exist.

<qos-policy>

Qos policy to modify (name or id)

--share

Make the qos policy accessible by other projects

--name <name>

Set qos policy name

--no-share

Make the qos policy not accessible by other projects

--no-default

Set this as a non-default network qos policy

--default

Set this as a default network qos policy

-h, --help

Show this help message and exit

--description <description>

Description of the qos policy

--print-empty

Print empty table if there is no data to show.

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

<qos-policy>

Qos policy to display (name or id)

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--noindent

Whether to disable indenting the json

-h, --help

Show this help message and exit

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

--print-empty

Print empty table if there is no data to show.

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

<qos-policy>

Qos policy that contains the rule (name or id)

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--noindent

Whether to disable indenting the json

--min-kbps <min-kbps>

Minimum guaranteed bandwidth in kbps

--dscp-mark <dscp-mark>

Dscp mark: value can be 0, even numbers from 8-56, excluding 42, 44, 50, 52, and 54

--max-kbps <max-kbps>

Maximum bandwidth in kbps

--ingress

Ingress traffic direction from the project point of view

--type <type>

Qos rule type (dscp-marking, minimum-bandwidth, bandwidth-limit)

--max-burst-kbits <max-burst-kbits>

Maximum burst in kilobits, 0 means automatic

-h, --help

Show this help message and exit

--egress

Egress traffic direction from the project point of view

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

<qos-policy>

Qos policy that contains the rule (name or id)

<rule-id>

Network qos rule to delete (id)

-h, --help

Show this help message and exit

--print-empty

Print empty table if there is no data to show.

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

<qos-policy>

Qos policy that contains the rule (name or id)

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

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

--noindent

Whether to disable indenting the json

-h, --help

Show this help message and exit

<qos-policy>

Qos policy that contains the rule (name or id)

<rule-id>

Network qos rule to delete (id)

--min-kbps <min-kbps>

Minimum guaranteed bandwidth in kbps

--dscp-mark <dscp-mark>

Dscp mark: value can be 0, even numbers from 8-56, excluding 42, 44, 50, 52, and 54

--max-kbps <max-kbps>

Maximum bandwidth in kbps

--ingress

Ingress traffic direction from the project point of view

--max-burst-kbits <max-burst-kbits>

Maximum burst in kilobits, 0 means automatic

-h, --help

Show this help message and exit

--egress

Egress traffic direction from the project point of view

--print-empty

Print empty table if there is no data to show.

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

<qos-policy>

Qos policy that contains the rule (name or id)

<rule-id>

Network qos rule to delete (id)

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--noindent

Whether to disable indenting the json

-h, --help

Show this help message and exit

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

--print-empty

Print empty table if there is no data to show.

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

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

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

--noindent

Whether to disable indenting the json

-h, --help

Show this help message and exit

--print-empty

Print empty table if there is no data to show.

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

<qos-rule-type-name>

Name of qos rule type

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--noindent

Whether to disable indenting the json

-h, --help

Show this help message and exit

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

--print-empty

Print empty table if there is no data to show.

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

<rbac-object>

The object to which this rbac policy affects (name or ID)

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--noindent

Whether to disable indenting the json

--target-project-domain <target-project-domain>

Domain the target project belongs to (name or id). This can be used in case collisions between project names exist.

--target-project <target-project>

The project to which the rbac policy will be enforced (name or ID)

--project-domain <project-domain>

Domain the project belongs to (name or id). this can be used in case collisions between project names exist.

--type <type>

Type of the object that rbac policy affects ("qos_policy" or "network")

--action <action>

Action for the rbac policy ("access_as_external" or "access_as_shared")

-h, --help

Show this help message and exit

--target-all-projects

Allow creating rbac policy for all projects.

--project <project>

The owner project (name or id)

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

<rbac-policy>

Rbac policy(s) to delete (id only)

-h, --help

Show this help message and exit

--print-empty

Print empty table if there is no data to show.

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

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

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

--noindent

Whether to disable indenting the json

--type <type>

List network rbac policies according to given object type ("qos_policy" or "network")

-h, --help

Show this help message and exit

--action <action>

List network rbac policies according to given action ("access_as_external" or "access_as_shared")

--long

List additional fields in output

<rbac-policy>

Rbac policy to be modified (id only)

-h, --help

Show this help message and exit

--target-project-domain <target-project-domain>

Domain the target project belongs to (name or id). This can be used in case collisions between project names exist.

--target-project <target-project>

The project to which the rbac policy will be enforced (name or ID)

--print-empty

Print empty table if there is no data to show.

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

<rbac-policy>

Rbac policy (id only)

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--noindent

Whether to disable indenting the json

-h, --help

Show this help message and exit

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

--print-empty

Print empty table if there is no data to show.

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

<name>

New network segment name

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--noindent

Whether to disable indenting the json

--network-type <network-type>

Network type of this network segment (flat, geneve, gre, local, vlan or vxlan)

--segment <segment>

Segment identifier for this network segment which is based on the network type, VLAN ID for vlan network type and tunnel ID for geneve, gre and vxlan network types

--network <network>

Network this network segment belongs to (name or id)

--physical-network <physical-network>

Physical network name of this network segment

-h, --help

Show this help message and exit

--description <description>

Network segment description

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

<network-segment>

Network segment(s) to delete (name or id)

-h, --help

Show this help message and exit

--print-empty

Print empty table if there is no data to show.

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

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

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

--noindent

Whether to disable indenting the json

-h, --help

Show this help message and exit

--network <network>

List network segments that belong to this network (name or ID)

--long

List additional fields in output

<network-segment>

Network segment to modify (name or id)

--name <name>

Set network segment name

-h, --help

Show this help message and exit

--description <description>

Set network segment description

--print-empty

Print empty table if there is no data to show.

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

<network-segment>

Network segment to display (name or id)

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--noindent

Whether to disable indenting the json

-h, --help

Show this help message and exit

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

--print-empty

Print empty table if there is no data to show.

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

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

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

--noindent

Whether to disable indenting the json

-h, --help

Show this help message and exit

<network>

Network to modify (name or id)

--share

Share the network between projects

--enable-port-security

Enable port security by default for ports created on this network

--enable

Enable network

--no-tag

Clear tags associated with the network. specify both --tag and --no-tag to overwrite current tags

--name <name>

Set network name

--provider-physical-network <provider-physical-network>

Name of the physical network over which the virtual network is implemented

--internal

Set this network as an internal network

--mtu <mtu

Set network mtu

--description <description

Set network description

--provider-network-type <provider-network-type>

The physical mechanism by which the virtual network is implemented. For example: flat, geneve, gre, local, vlan, vxlan.

--no-share

Do not share the network between projects

--no-qos-policy

Remove the qos policy attached to this network

--external

Set this network as an external network (external-net extension required)

--disable-port-security

Disable port security by default for ports created on this network

--no-default

Do not use the network as the default external network

--default

Set the network as the default external network

--qos-policy <qos-policy>

Qos policy to attach to this network (name or id)

-h, --help

Show this help message and exit

--disable

Disable network

--provider-segment <provider-segment>

Vlan id for vlan networks or tunnel id for GENEVE/GRE/VXLAN networks

--tag <tag>

Tag to be added to the network (repeat option to set multiple tags)

--print-empty

Print empty table if there is no data to show.

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

<network>

Network to display (name or id)

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--noindent

Whether to disable indenting the json

-h, --help

Show this help message and exit

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

--print-empty

Print empty table if there is no data to show.

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

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

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

--noindent

Whether to disable indenting the json

-h, --help

Show this help message and exit

--trunk <trunk>

List subports belonging to this trunk (name or id)

--print-empty

Print empty table if there is no data to show.

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

<name>

Name of the trunk to create

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--noindent

Whether to disable indenting the json

--description <description>

A description of the trunk

--enable

Enable trunk (default)

--subport <port=,segmentation-type=,segmentation-id⇒

Subport to add. subport is of form port=<name or id >,segmentation-type=,segmentation-ID= (--subport) option can be repeated

--project-domain <project-domain>

Domain the project belongs to (name or id). this can be used in case collisions between project names exist.

--parent-port <parent-port>

Parent port belonging to this trunk (name or id)

-h, --help

Show this help message and exit

--disable

Disable trunk

--project <project>

Owner’s project (name or id)

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

<trunk>

Trunk(s) to delete (name or id)

-h, --help

Show this help message and exit

--print-empty

Print empty table if there is no data to show.

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

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

output formatter options-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

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

--noindent

Whether to disable indenting the json

-h, --help

Show this help message and exit

--long

List additional fields in output

<trunk>

Trunk to modify (name or id)

--description <description>

A description of the trunk

--enable

Enable trunk

--name <name>

Set trunk name

--subport <port=,segmentation-type=,segmentation-id⇒

Subport to add. subport is of form port=<name or id >,segmentation-type=,segmentation-ID=(--subport) option can be repeated

-h, --help

Show this help message and exit

--disable

Disable trunk

--print-empty

Print empty table if there is no data to show.

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

<trunk>

Trunk to display (name or id)

output formatter options-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--noindent

Whether to disable indenting the json

-h, --help

Show this help message and exit

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

<trunk>

Unset subports from this trunk (name or id)

-h, --help

Show this help message and exit

--subport <subport>

Subport to delete (name or id of the port) (--subport) option can be repeated

<network>

Network to modify (name or id)

--all-tag

Clear all tags associated with the network

-h, --help

Show this help message and exit

--tag <tag>

Tag to be removed from the network (repeat option to remove multiple tags)