Menu Close

Chapter 43. network

This chapter describes the commands under the network command.

43.1. network agent add network

Add network to an agent

Usage:

openstack network agent add network [-h] [--dhcp] <agent-id> <network>

Table 43.1. Positional Arguments

ValueSummary

<agent-id>

Agent to which a network is added (id only)

<network>

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

Table 43.2. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--dhcp

Add network to a dhcp agent

43.2. network agent add router

Add router to an agent

Usage:

openstack network agent add router [-h] [--l3] <agent-id> <router>

Table 43.3. Positional Arguments

ValueSummary

<agent-id>

Agent to which a router is added (id only)

<router>

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

Table 43.4. Optional Arguments

ValueSummary

--l3

Add router to an l3 agent

-h, --help

Show this help message and exit

43.3. network agent delete

Delete network agent(s)

Usage:

openstack network agent delete [-h]
                                      <network-agent> [<network-agent> ...]

Table 43.5. Positional Arguments

ValueSummary

<network-agent>

Network agent(s) to delete (id only)

Table 43.6. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

43.4. network agent list

List network agents

Usage:

openstack network agent list [-h] [-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]
                                    [--agent-type <agent-type>]
                                    [--host <host>]
                                    [--network <network> | --router <router>]
                                    [--long]

Table 43.7. Table Formatter

ValueSummary

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

Table 43.8. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 43.9. Output Formatters

ValueSummary

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

Table 43.10. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 43.11. Optional Arguments

ValueSummary

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

43.5. network agent remove network

Remove network from an agent.

Usage:

openstack network agent remove network [-h] [--dhcp]
                                              <agent-id> <network>

Table 43.12. Positional Arguments

ValueSummary

<agent-id>

Agent to which a network is removed (id only)

<network>

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

Table 43.13. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--dhcp

Remove network from dhcp agent

43.6. network agent remove router

Remove router from an agent

Usage:

openstack network agent remove router [-h] [--l3] <agent-id> <router>

Table 43.14. Positional Arguments

ValueSummary

<agent-id>

Agent from which router will be removed (id only)

<router>

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

Table 43.15. Optional Arguments

ValueSummary

--l3

Remove router from an l3 agent

-h, --help

Show this help message and exit

43.7. network agent set

Set network agent properties

Usage:

openstack network agent set [-h] [--description <description>]
                                   [--enable | --disable]
                                   <network-agent>

Table 43.16. Positional Arguments

ValueSummary

<network-agent>

Network agent to modify (id only)

Table 43.17. Optional Arguments

ValueSummary

--disable

Disable network agent

-h, --help

Show this help message and exit

--description <description>

Set network agent description

--enable

Enable network agent

43.8. network agent show

Display network agent details

Usage:

openstack network agent show [-h] [-f {json,shell,table,value,yaml}]
                                    [-c COLUMN] [--max-width <integer>]
                                    [--fit-width] [--print-empty] [--noindent]
                                    [--prefix PREFIX]
                                    <network-agent>

Table 43.18. Table Formatter

ValueSummary

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

Table 43.19. Positional Arguments

ValueSummary

<network-agent>

Network agent to display (id only)

Table 43.20. Output Formatters

ValueSummary

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

Table 43.21. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 43.22. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 43.23. Shell Formatter

ValueSummary

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

Add a prefix to all variable names

43.9. network auto allocated topology create

Create the auto allocated topology for project

Usage:

openstack network auto allocated topology create [-h]
                                                        [-f {json,shell,table,value,yaml}]
                                                        [-c COLUMN]
                                                        [--max-width <integer>]
                                                        [--fit-width]
                                                        [--print-empty]
                                                        [--noindent]
                                                        [--prefix PREFIX]
                                                        [--project <project>]
                                                        [--project-domain <project-domain>]
                                                        [--check-resources]
                                                        [--or-show]

Table 43.24. Table Formatter

ValueSummary

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

Table 43.25. Output Formatters

ValueSummary

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

Table 43.26. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 43.27. Optional Arguments

ValueSummary

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

Table 43.28. Shell Formatter

ValueSummary

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

Add a prefix to all variable names

43.10. network auto allocated topology delete

Delete auto allocated topology for project

Usage:

openstack network auto allocated topology delete [-h]
                                                        [--project <project>]
                                                        [--project-domain <project-domain>]

Table 43.29. Optional Arguments

ValueSummary

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

43.11. network create

Create new network

Usage:

openstack network create [-h] [-f {json,shell,table,value,yaml}]
                                [-c COLUMN] [--max-width <integer>]
                                [--fit-width] [--print-empty] [--noindent]
                                [--prefix PREFIX] [--share | --no-share]
                                [--enable | --disable] [--project <project>]
                                [--description <description>] [--mtu <mtu>]
                                [--project-domain <project-domain>]
                                [--availability-zone-hint <availability-zone>]
                                [--enable-port-security | --disable-port-security]
                                [--external | --internal]
                                [--default | --no-default]
                                [--qos-policy <qos-policy>]
                                [--transparent-vlan | --no-transparent-vlan]
                                [--provider-network-type <provider-network-type>]
                                [--provider-physical-network <provider-physical-network>]
                                [--provider-segment <provider-segment>]
                                [--tag <tag> | --no-tag]
                                <name>

Table 43.30. Table Formatter

ValueSummary

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

Table 43.31. Positional Arguments

ValueSummary

<name>

New network name

Table 43.32. Output Formatters

ValueSummary

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

Table 43.33. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 43.34. Optional Arguments

ValueSummary

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

Table 43.35. Shell Formatter

ValueSummary

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

Add a prefix to all variable names

43.12. network delete

Delete network(s)

Usage:

openstack network delete [-h] <network> [<network> ...]

Table 43.36. Positional Arguments

ValueSummary

<network>

Network(s) to delete (name or id)

Table 43.37. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

43.13. network flavor add profile

Add a service profile to a network flavor

Usage:

openstack network flavor add profile [-h] <flavor> <service-profile>

Table 43.38. Positional Arguments

ValueSummary

<service-profile>

Service profile (id only)

<flavor>

Network flavor (name or id)

Table 43.39. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

43.14. network flavor create

Create new network flavor

Usage:

openstack network flavor create [-h] [-f {json,shell,table,value,yaml}]
                                       [-c COLUMN] [--max-width <integer>]
                                       [--fit-width] [--print-empty]
                                       [--noindent] [--prefix PREFIX]
                                       --service-type <service-type>
                                       [--description DESCRIPTION]
                                       [--project <project>]
                                       [--project-domain <project-domain>]
                                       [--enable | --disable]
                                       <name>

Table 43.40. Table Formatter

ValueSummary

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

Table 43.41. Positional Arguments

ValueSummary

<name>

Name for the flavor

Table 43.42. Output Formatters

ValueSummary

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

Table 43.43. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 43.44. Optional Arguments

ValueSummary

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

Table 43.45. Shell Formatter

ValueSummary

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

Add a prefix to all variable names

43.15. network flavor delete

Delete network flavors

Usage:

openstack network flavor delete [-h] <flavor> [<flavor> ...]

Table 43.46. Positional Arguments

ValueSummary

<flavor>

Flavor(s) to delete (name or id)

Table 43.47. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

43.16. network flavor list

List network flavors

Usage:

openstack network flavor list [-h] [-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]

Table 43.48. Table Formatter

ValueSummary

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

Table 43.49. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 43.50. Output Formatters

ValueSummary

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

Table 43.51. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 43.52. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

43.17. network flavor profile create

Create new network flavor profile

Usage:

openstack network flavor profile create [-h]
                                               [-f {json,shell,table,value,yaml}]
                                               [-c COLUMN]
                                               [--max-width <integer>]
                                               [--fit-width] [--print-empty]
                                               [--noindent] [--prefix PREFIX]
                                               [--project <project>]
                                               [--project-domain <project-domain>]
                                               [--description <description>]
                                               [--enable | --disable]
                                               [--driver DRIVER]
                                               [--metainfo METAINFO]

Table 43.53. Table Formatter

ValueSummary

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

Table 43.54. Output Formatters

ValueSummary

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

Table 43.55. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 43.56. Optional Arguments

ValueSummary

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

Table 43.57. Shell Formatter

ValueSummary

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

Add a prefix to all variable names

43.18. network flavor profile delete

Delete network flavor profile

Usage:

openstack network flavor profile delete [-h]
                                               <flavor-profile>
                                               [<flavor-profile> ...]

Table 43.58. Positional Arguments

ValueSummary

<flavor-profile>

Flavor profile(s) to delete (id only)

Table 43.59. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

43.19. network flavor profile list

List network flavor profile(s)

Usage:

openstack network flavor profile list [-h]
                                             [-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]

Table 43.60. Table Formatter

ValueSummary

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

Table 43.61. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 43.62. Output Formatters

ValueSummary

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

Table 43.63. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 43.64. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

43.20. network flavor profile set

Set network flavor profile properties

Usage:

openstack network flavor profile set [-h]
                                            [--project-domain <project-domain>]
                                            [--description <description>]
                                            [--enable | --disable]
                                            [--driver DRIVER]
                                            [--metainfo METAINFO]
                                            <flavor-profile>

Table 43.65. Positional Arguments

ValueSummary

<flavor-profile>

Flavor profile to update (id only)

Table 43.66. Optional Arguments

ValueSummary

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

43.21. network flavor profile show

Display network flavor profile details

Usage:

openstack network flavor profile show [-h]
                                             [-f {json,shell,table,value,yaml}]
                                             [-c COLUMN]
                                             [--max-width <integer>]
                                             [--fit-width] [--print-empty]
                                             [--noindent] [--prefix PREFIX]
                                             <flavor-profile>

Table 43.67. Table Formatter

ValueSummary

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

Table 43.68. Positional Arguments

ValueSummary

<flavor-profile>

Flavor profile to display (id only)

Table 43.69. Output Formatters

ValueSummary

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

Table 43.70. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 43.71. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 43.72. Shell Formatter

ValueSummary

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

Add a prefix to all variable names

43.22. network flavor remove profile

Remove service profile from network flavor

Usage:

openstack network flavor remove profile [-h] <flavor> <service-profile>

Table 43.73. Positional Arguments

ValueSummary

<service-profile>

Service profile (id only)

<flavor>

Network flavor (name or id)

Table 43.74. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

43.23. network flavor set

Set network flavor properties

Usage:

openstack network flavor set [-h] [--description DESCRIPTION]
                                    [--disable | --enable] [--name <name>]
                                    <flavor>

Table 43.75. Positional Arguments

ValueSummary

<flavor>

Flavor to update (name or id)

Table 43.76. Optional Arguments

ValueSummary

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

43.24. network flavor show

Display network flavor details

Usage:

openstack network flavor show [-h] [-f {json,shell,table,value,yaml}]
                                     [-c COLUMN] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--noindent] [--prefix PREFIX]
                                     <flavor>

Table 43.77. Table Formatter

ValueSummary

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

Table 43.78. Positional Arguments

ValueSummary

<flavor>

Flavor to display (name or id)

Table 43.79. Output Formatters

ValueSummary

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

Table 43.80. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 43.81. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 43.82. Shell Formatter

ValueSummary

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

Add a prefix to all variable names

43.25. network list

List networks

Usage:

openstack network list [-h] [-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]
                              [--external | --internal] [--long]
                              [--name <name>] [--enable | --disable]
                              [--project <project>]
                              [--project-domain <project-domain>]
                              [--share | --no-share] [--status <status>]
                              [--provider-network-type <provider-network-type>]
                              [--provider-physical-network <provider-physical-network>]
                              [--provider-segment <provider-segment>]
                              [--agent <agent-id>] [--tags <tag>[,<tag>,...]]
                              [--any-tags <tag>[,<tag>,...]]
                              [--not-tags <tag>[,<tag>,...]]
                              [--not-any-tags <tag>[,<tag>,...]]

Table 43.83. Table Formatter

ValueSummary

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

Table 43.84. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 43.85. Output Formatters

ValueSummary

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

Table 43.86. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 43.87. Optional Arguments

ValueSummary

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

43.26. network log create

Create a new network log

Usage:

openstack network log create [-h] [-f {json,shell,table,value,yaml}]
                                    [-c COLUMN] [--max-width <integer>]
                                    [--fit-width] [--print-empty] [--noindent]
                                    [--prefix PREFIX]
                                    [--description <description>]
                                    [--enable | --disable]
                                    [--project <project>]
                                    [--project-domain <project-domain>]
                                    [--event <event>] --resource-type
                                    <resource-type> [--resource <resource>]
                                    [--target <target>]
                                    <name>

Table 43.88. Table Formatter

ValueSummary

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

Table 43.89. Positional Arguments

ValueSummary

<name>

Name for the network log

Table 43.90. Output Formatters

ValueSummary

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

Table 43.91. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 43.92. Optional Arguments

ValueSummary

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

Table 43.93. Shell Formatter

ValueSummary

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

Add a prefix to all variable names

43.27. network log delete

Delete network log(s)

Usage:

openstack network log delete [-h] <network-log> [<network-log> ...]

Table 43.94. Positional Arguments

ValueSummary

<network-log>

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

Table 43.95. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

43.28. network log list

List network logs

Usage:

openstack network log list [-h] [-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] [--long]

Table 43.96. Table Formatter

ValueSummary

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

Table 43.97. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 43.98. Output Formatters

ValueSummary

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

Table 43.99. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 43.100. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--long

List additional fields in output

43.29. network log set

Set network log properties

Usage:

openstack network log set [-h] [--description <description>]
                                 [--enable | --disable] [--name <name>]
                                 <network-log>

Table 43.101. Positional Arguments

ValueSummary

<network-log>

Network log to set (name or id)

Table 43.102. Optional Arguments

ValueSummary

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

43.30. network log show

Display network log details

Usage:

openstack network log show [-h] [-f {json,shell,table,value,yaml}]
                                  [-c COLUMN] [--max-width <integer>]
                                  [--fit-width] [--print-empty] [--noindent]
                                  [--prefix PREFIX]
                                  <network-log>

Table 43.103. Table Formatter

ValueSummary

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

Table 43.104. Positional Arguments

ValueSummary

<network-log>

Network log to show (name or id)

Table 43.105. Output Formatters

ValueSummary

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

Table 43.106. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 43.107. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 43.108. Shell Formatter

ValueSummary

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

Add a prefix to all variable names

43.31. network loggable resources list

List supported loggable resources

Usage:

openstack network loggable resources list [-h]
                                                 [-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]
                                                 [--long]

Table 43.109. Table Formatter

ValueSummary

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

Table 43.110. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 43.111. Output Formatters

ValueSummary

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

Table 43.112. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 43.113. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--long

List additional fields in output

43.32. network meter create

Create network meter

Usage:

openstack network meter create [-h] [-f {json,shell,table,value,yaml}]
                                      [-c COLUMN] [--max-width <integer>]
                                      [--fit-width] [--print-empty]
                                      [--noindent] [--prefix PREFIX]
                                      [--description <description>]
                                      [--project <project>]
                                      [--project-domain <project-domain>]
                                      [--share | --no-share]
                                      <name>

Table 43.114. Table Formatter

ValueSummary

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

Table 43.115. Positional Arguments

ValueSummary

<name>

Name of meter

Table 43.116. Output Formatters

ValueSummary

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

Table 43.117. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 43.118. Optional Arguments

ValueSummary

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

Table 43.119. Shell Formatter

ValueSummary

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

Add a prefix to all variable names

43.33. network meter delete

Delete network meter

Usage:

openstack network meter delete [-h] <meter> [<meter> ...]

Table 43.120. Positional Arguments

ValueSummary

<meter>

Meter to delete (name or id)

Table 43.121. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

43.34. network meter list

List network meters

Usage:

openstack network meter list [-h] [-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]

Table 43.122. Table Formatter

ValueSummary

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

Table 43.123. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 43.124. Output Formatters

ValueSummary

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

Table 43.125. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 43.126. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

43.35. network meter rule create

Create a new meter rule

Usage:

openstack network meter rule create [-h]
                                           [-f {json,shell,table,value,yaml}]
                                           [-c COLUMN] [--max-width <integer>]
                                           [--fit-width] [--print-empty]
                                           [--noindent] [--prefix PREFIX]
                                           [--project <project>]
                                           [--project-domain <project-domain>]
                                           [--exclude | --include]
                                           [--ingress | --egress]
                                           --remote-ip-prefix
                                           <remote-ip-prefix>
                                           <meter>

Table 43.127. Table Formatter

ValueSummary

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

Table 43.128. Positional Arguments

ValueSummary

<meter>

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

Table 43.129. Output Formatters

ValueSummary

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

Table 43.130. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 43.131. Optional Arguments

ValueSummary

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

Table 43.132. Shell Formatter

ValueSummary

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

Add a prefix to all variable names

43.36. network meter rule delete

Delete meter rule(s)

Usage:

openstack network meter rule delete [-h]
                                           <meter-rule-id>
                                           [<meter-rule-id> ...]

Table 43.133. Positional Arguments

ValueSummary

<meter-rule-id>

Meter rule to delete (id only)

Table 43.134. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

43.37. network meter rule list

List meter rules

Usage:

openstack network meter rule list [-h] [-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]

Table 43.135. Table Formatter

ValueSummary

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

Table 43.136. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 43.137. Output Formatters

ValueSummary

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

Table 43.138. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 43.139. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

43.38. network meter rule show

Display meter rules details

Usage:

openstack network meter rule show [-h]
                                         [-f {json,shell,table,value,yaml}]
                                         [-c COLUMN] [--max-width <integer>]
                                         [--fit-width] [--print-empty]
                                         [--noindent] [--prefix PREFIX]
                                         <meter-rule-id>

Table 43.140. Table Formatter

ValueSummary

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

Table 43.141. Positional Arguments

ValueSummary

<meter-rule-id>

Meter rule (id only)

Table 43.142. Output Formatters

ValueSummary

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

Table 43.143. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 43.144. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 43.145. Shell Formatter

ValueSummary

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

Add a prefix to all variable names

43.39. network meter show

Show network meter

Usage:

openstack network meter show [-h] [-f {json,shell,table,value,yaml}]
                                    [-c COLUMN] [--max-width <integer>]
                                    [--fit-width] [--print-empty] [--noindent]
                                    [--prefix PREFIX]
                                    <meter>

Table 43.146. Table Formatter

ValueSummary

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

Table 43.147. Positional Arguments

ValueSummary

<meter>

Meter to display (name or id)

Table 43.148. Output Formatters

ValueSummary

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

Table 43.149. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 43.150. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 43.151. Shell Formatter

ValueSummary

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

Add a prefix to all variable names

43.40. network qos policy create

Create a QoS policy

Usage:

openstack network qos policy create [-h]
                                           [-f {json,shell,table,value,yaml}]
                                           [-c COLUMN] [--max-width <integer>]
                                           [--fit-width] [--print-empty]
                                           [--noindent] [--prefix PREFIX]
                                           [--description <description>]
                                           [--share | --no-share]
                                           [--project <project>]
                                           [--project-domain <project-domain>]
                                           [--default | --no-default]
                                           <name>

Table 43.152. Table Formatter

ValueSummary

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

Table 43.153. Positional Arguments

ValueSummary

<name>

Name of qos policy to create

Table 43.154. Output Formatters

ValueSummary

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

Table 43.155. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 43.156. Optional Arguments

ValueSummary

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

Table 43.157. Shell Formatter

ValueSummary

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

Add a prefix to all variable names

43.41. network qos policy delete

Delete Qos Policy(s)

Usage:

openstack network qos policy delete [-h]
                                           <qos-policy> [<qos-policy> ...]

Table 43.158. Positional Arguments

ValueSummary

<qos-policy>

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

Table 43.159. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

43.42. network qos policy list

List QoS policies

Usage:

openstack network qos policy list [-h] [-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]
                                         [--project <project>]
                                         [--project-domain <project-domain>]
                                         [--share | --no-share]

Table 43.160. Table Formatter

ValueSummary

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

Table 43.161. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 43.162. Output Formatters

ValueSummary

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

Table 43.163. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 43.164. Optional Arguments

ValueSummary

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

43.43. network qos policy set

Set QoS policy properties

Usage:

openstack network qos policy set [-h] [--name <name>]
                                        [--description <description>]
                                        [--share | --no-share]
                                        [--default | --no-default]
                                        <qos-policy>

Table 43.165. Positional Arguments

ValueSummary

<qos-policy>

Qos policy to modify (name or id)

Table 43.166. Optional Arguments

ValueSummary

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

43.44. network qos policy show

Display QoS policy details

Usage:

openstack network qos policy show [-h]
                                         [-f {json,shell,table,value,yaml}]
                                         [-c COLUMN] [--max-width <integer>]
                                         [--fit-width] [--print-empty]
                                         [--noindent] [--prefix PREFIX]
                                         <qos-policy>

Table 43.167. Table Formatter

ValueSummary

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

Table 43.168. Positional Arguments

ValueSummary

<qos-policy>

Qos policy to display (name or id)

Table 43.169. Output Formatters

ValueSummary

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

Table 43.170. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 43.171. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 43.172. Shell Formatter

ValueSummary

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

Add a prefix to all variable names

43.45. network qos rule create

Create new Network QoS rule

Usage:

openstack network qos rule create [-h]
                                         [-f {json,shell,table,value,yaml}]
                                         [-c COLUMN] [--max-width <integer>]
                                         [--fit-width] [--print-empty]
                                         [--noindent] [--prefix PREFIX]
                                         [--type <type>]
                                         [--max-kbps <max-kbps>]
                                         [--max-burst-kbits <max-burst-kbits>]
                                         [--dscp-mark <dscp-mark>]
                                         [--min-kbps <min-kbps>]
                                         [--ingress | --egress]
                                         <qos-policy>

Table 43.173. Table Formatter

ValueSummary

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

Table 43.174. Positional Arguments

ValueSummary

<qos-policy>

Qos policy that contains the rule (name or id)

Table 43.175. Output Formatters

ValueSummary

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

Table 43.176. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 43.177. Optional Arguments

ValueSummary

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

Table 43.178. Shell Formatter

ValueSummary

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

Add a prefix to all variable names

43.46. network qos rule delete

Delete Network QoS rule

Usage:

openstack network qos rule delete [-h] <qos-policy> <rule-id>

Table 43.179. Positional Arguments

ValueSummary

<qos-policy>

Qos policy that contains the rule (name or id)

<rule-id>

Network qos rule to delete (id)

Table 43.180. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

43.47. network qos rule list

List Network QoS rules

Usage:

openstack network qos rule list [-h] [-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]
                                       <qos-policy>

Table 43.181. Table Formatter

ValueSummary

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

Table 43.182. Positional Arguments

ValueSummary

<qos-policy>

Qos policy that contains the rule (name or id)

Table 43.183. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 43.184. Output Formatters

ValueSummary

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

Table 43.185. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 43.186. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

43.48. network qos rule set

Set Network QoS rule properties

Usage:

openstack network qos rule set [-h] [--max-kbps <max-kbps>]
                                      [--max-burst-kbits <max-burst-kbits>]
                                      [--dscp-mark <dscp-mark>]
                                      [--min-kbps <min-kbps>]
                                      [--ingress | --egress]
                                      <qos-policy> <rule-id>

Table 43.187. Positional Arguments

ValueSummary

<qos-policy>

Qos policy that contains the rule (name or id)

<rule-id>

Network qos rule to delete (id)

Table 43.188. Optional Arguments

ValueSummary

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

43.49. network qos rule show

Display Network QoS rule details

Usage:

openstack network qos rule show [-h] [-f {json,shell,table,value,yaml}]
                                       [-c COLUMN] [--max-width <integer>]
                                       [--fit-width] [--print-empty]
                                       [--noindent] [--prefix PREFIX]
                                       <qos-policy> <rule-id>

Table 43.189. Table Formatter

ValueSummary

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

Table 43.190. Positional Arguments

ValueSummary

<qos-policy>

Qos policy that contains the rule (name or id)

<rule-id>

Network qos rule to delete (id)

Table 43.191. Output Formatters

ValueSummary

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

Table 43.192. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 43.193. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 43.194. Shell Formatter

ValueSummary

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

Add a prefix to all variable names

43.50. network qos rule type list

List QoS rule types

Usage:

openstack network qos rule type list [-h]
                                            [-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]

Table 43.195. Table Formatter

ValueSummary

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

Table 43.196. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 43.197. Output Formatters

ValueSummary

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

Table 43.198. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 43.199. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

43.51. network qos rule type show

Show details about supported QoS rule type

Usage:

openstack network qos rule type show [-h]
                                            [-f {json,shell,table,value,yaml}]
                                            [-c COLUMN]
                                            [--max-width <integer>]
                                            [--fit-width] [--print-empty]
                                            [--noindent] [--prefix PREFIX]
                                            <qos-rule-type-name>

Table 43.200. Table Formatter

ValueSummary

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

Table 43.201. Positional Arguments

ValueSummary

<qos-rule-type-name>

Name of qos rule type

Table 43.202. Output Formatters

ValueSummary

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

Table 43.203. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 43.204. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 43.205. Shell Formatter

ValueSummary

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

Add a prefix to all variable names

43.52. network rbac create

Create network RBAC policy

Usage:

openstack network rbac create [-h] [-f {json,shell,table,value,yaml}]
                                     [-c COLUMN] [--max-width <integer>]
                                     [--fit-width] [--print-empty]
                                     [--noindent] [--prefix PREFIX] --type
                                     <type> --action <action>
                                     (--target-project <target-project> | --target-all-projects)
                                     [--target-project-domain <target-project-domain>]
                                     [--project <project>]
                                     [--project-domain <project-domain>]
                                     <rbac-object>

Table 43.206. Table Formatter

ValueSummary

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

Table 43.207. Positional Arguments

ValueSummary

<rbac-object>

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

Table 43.208. Output Formatters

ValueSummary

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

Table 43.209. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 43.210. Optional Arguments

ValueSummary

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

Table 43.211. Shell Formatter

ValueSummary

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

Add a prefix to all variable names

43.53. network rbac delete

Delete network RBAC policy(s)

Usage:

openstack network rbac delete [-h] <rbac-policy> [<rbac-policy> ...]

Table 43.212. Positional Arguments

ValueSummary

<rbac-policy>

Rbac policy(s) to delete (id only)

Table 43.213. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

43.54. network rbac list

List network RBAC policies

Usage:

openstack network rbac list [-h] [-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] [--type <type>]
                                   [--action <action>] [--long]

Table 43.214. Table Formatter

ValueSummary

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

Table 43.215. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 43.216. Output Formatters

ValueSummary

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

Table 43.217. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 43.218. Optional Arguments

ValueSummary

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

43.55. network rbac set

Set network RBAC policy properties

Usage:

openstack network rbac set [-h] [--target-project <target-project>]
                                  [--target-project-domain <target-project-domain>]
                                  <rbac-policy>

Table 43.219. Positional Arguments

ValueSummary

<rbac-policy>

Rbac policy to be modified (id only)

Table 43.220. Optional Arguments

ValueSummary

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

43.56. network rbac show

Display network RBAC policy details

Usage:

openstack network rbac show [-h] [-f {json,shell,table,value,yaml}]
                                   [-c COLUMN] [--max-width <integer>]
                                   [--fit-width] [--print-empty] [--noindent]
                                   [--prefix PREFIX]
                                   <rbac-policy>

Table 43.221. Table Formatter

ValueSummary

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

Table 43.222. Positional Arguments

ValueSummary

<rbac-policy>

Rbac policy (id only)

Table 43.223. Output Formatters

ValueSummary

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

Table 43.224. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 43.225. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 43.226. Shell Formatter

ValueSummary

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

Add a prefix to all variable names

43.57. network segment create

Create new network segment

Usage:

openstack network segment create [-h]
                                        [-f {json,shell,table,value,yaml}]
                                        [-c COLUMN] [--max-width <integer>]
                                        [--fit-width] [--print-empty]
                                        [--noindent] [--prefix PREFIX]
                                        [--description <description>]
                                        [--physical-network <physical-network>]
                                        [--segment <segment>] --network
                                        <network> --network-type
                                        <network-type>
                                        <name>

Table 43.227. Table Formatter

ValueSummary

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

Table 43.228. Positional Arguments

ValueSummary

<name>

New network segment name

Table 43.229. Output Formatters

ValueSummary

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

Table 43.230. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 43.231. Optional Arguments

ValueSummary

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

Table 43.232. Shell Formatter

ValueSummary

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

Add a prefix to all variable names

43.58. network segment delete

Delete network segment(s)

Usage:

openstack network segment delete [-h]
                                        <network-segment>
                                        [<network-segment> ...]

Table 43.233. Positional Arguments

ValueSummary

<network-segment>

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

Table 43.234. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

43.59. network segment list

List network segments

Usage:

openstack network segment list [-h] [-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] [--long]
                                      [--network <network>]

Table 43.235. Table Formatter

ValueSummary

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

Table 43.236. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 43.237. Output Formatters

ValueSummary

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

Table 43.238. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 43.239. Optional Arguments

ValueSummary

-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

43.60. network segment set

Set network segment properties

Usage:

openstack network segment set [-h] [--description <description>]
                                     [--name <name>]
                                     <network-segment>

Table 43.240. Positional Arguments

ValueSummary

<network-segment>

Network segment to modify (name or id)

Table 43.241. Optional Arguments

ValueSummary

--name <name>

Set network segment name

-h, --help

Show this help message and exit

--description <description>

Set network segment description

43.61. network segment show

Display network segment details

Usage:

openstack network segment show [-h] [-f {json,shell,table,value,yaml}]
                                      [-c COLUMN] [--max-width <integer>]
                                      [--fit-width] [--print-empty]
                                      [--noindent] [--prefix PREFIX]
                                      <network-segment>

Table 43.242. Table Formatter

ValueSummary

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

Table 43.243. Positional Arguments

ValueSummary

<network-segment>

Network segment to display (name or id)

Table 43.244. Output Formatters

ValueSummary

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

Table 43.245. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 43.246. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 43.247. Shell Formatter

ValueSummary

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

Add a prefix to all variable names

43.62. network service provider list

List Service Providers

Usage:

openstack network service provider list [-h]
                                               [-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]

Table 43.248. Table Formatter

ValueSummary

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

Table 43.249. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 43.250. Output Formatters

ValueSummary

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

Table 43.251. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 43.252. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

43.63. network set

Set network properties

Usage:

openstack network set [-h] [--name <name>] [--enable | --disable]
                             [--share | --no-share]
                             [--description <description] [--mtu <mtu]
                             [--enable-port-security | --disable-port-security]
                             [--external | --internal]
                             [--default | --no-default]
                             [--qos-policy <qos-policy> | --no-qos-policy]
                             [--tag <tag>] [--no-tag]
                             [--provider-network-type <provider-network-type>]
                             [--provider-physical-network <provider-physical-network>]
                             [--provider-segment <provider-segment>]
                             <network>

Table 43.253. Positional Arguments

ValueSummary

<network>

Network to modify (name or id)

Table 43.254. Optional Arguments

ValueSummary

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

43.64. network show

Show network details

Usage:

openstack network show [-h] [-f {json,shell,table,value,yaml}]
                              [-c COLUMN] [--max-width <integer>]
                              [--fit-width] [--print-empty] [--noindent]
                              [--prefix PREFIX]
                              <network>

Table 43.255. Table Formatter

ValueSummary

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

Table 43.256. Positional Arguments

ValueSummary

<network>

Network to display (name or id)

Table 43.257. Output Formatters

ValueSummary

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

Table 43.258. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 43.259. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 43.260. Shell Formatter

ValueSummary

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

Add a prefix to all variable names

43.65. network subport list

List all subports for a given network trunk

Usage:

openstack network subport list [-h] [-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] --trunk
                                      <trunk>

Table 43.261. Table Formatter

ValueSummary

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

Table 43.262. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 43.263. Output Formatters

ValueSummary

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

Table 43.264. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 43.265. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--trunk <trunk>

List subports belonging to this trunk (name or id)

43.66. network trunk create

Create a network trunk for a given project

Usage:

openstack network trunk create [-h] [-f {json,shell,table,value,yaml}]
                                      [-c COLUMN] [--max-width <integer>]
                                      [--fit-width] [--print-empty]
                                      [--noindent] [--prefix PREFIX]
                                      [--description <description>]
                                      --parent-port <parent-port>
                                      [--subport <port=,segmentation-type=,segmentation-id=>]
                                      [--enable | --disable]
                                      [--project <project>]
                                      [--project-domain <project-domain>]
                                      <name>

Table 43.266. Table Formatter

ValueSummary

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

Table 43.267. Positional Arguments

ValueSummary

<name>

Name of the trunk to create

Table 43.268. Output Formatters

ValueSummary

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

Table 43.269. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 43.270. Optional Arguments

ValueSummary

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

Table 43.271. Shell Formatter

ValueSummary

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

Add a prefix to all variable names

43.67. network trunk delete

Delete a given network trunk

Usage:

openstack network trunk delete [-h] <trunk> [<trunk> ...]

Table 43.272. Positional Arguments

ValueSummary

<trunk>

Trunk(s) to delete (name or id)

Table 43.273. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

43.68. network trunk list

List all network trunks

Usage:

openstack network trunk list [-h] [-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] [--long]

Table 43.274. Table Formatter

ValueSummary

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

Table 43.275. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 43.276. Output Formatters

ValueSummary

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

Table 43.277. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 43.278. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--long

List additional fields in output

43.69. network trunk set

Set network trunk properties

Usage:

openstack network trunk set [-h] [--name <name>]
                                   [--description <description>]
                                   [--subport <port=,segmentation-type=,segmentation-id=>]
                                   [--enable | --disable]
                                   <trunk>

Table 43.279. Positional Arguments

ValueSummary

<trunk>

Trunk to modify (name or id)

Table 43.280. Optional Arguments

ValueSummary

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

43.70. network trunk show

Show information of a given network trunk

Usage:

openstack network trunk show [-h] [-f {json,shell,table,value,yaml}]
                                    [-c COLUMN] [--max-width <integer>]
                                    [--fit-width] [--print-empty] [--noindent]
                                    [--prefix PREFIX]
                                    <trunk>

Table 43.281. Table Formatter

ValueSummary

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

Table 43.282. Positional Arguments

ValueSummary

<trunk>

Trunk to display (name or id)

Table 43.283. Output Formatters

ValueSummary

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

Table 43.284. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 43.285. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 43.286. Shell Formatter

ValueSummary

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

Add a prefix to all variable names

43.71. network trunk unset

Unset subports from a given network trunk

Usage:

openstack network trunk unset [-h] --subport <subport> <trunk>

Table 43.287. Positional Arguments

ValueSummary

<trunk>

Unset subports from this trunk (name or id)

Table 43.288. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--subport <subport>

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

43.72. network unset

Unset network properties

Usage:

openstack network unset [-h] [--tag <tag> | --all-tag] <network>

Table 43.289. Positional Arguments

ValueSummary

<network>

Network to modify (name or id)

Table 43.290. Optional Arguments

ValueSummary

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