此内容没有您所选择的语言版本。

Chapter 48. network


This chapter describes the commands under the network command.

48.1. network agent add network

Usage:

openstack network agent add network [-h] [--dhcp] <agent-id> <network>
Copy to Clipboard Toggle word wrap

Add network to an agent

Expand
Table 48.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)

Expand
Table 48.2. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--dhcp

Add network to a dhcp agent

48.2. network agent add router

Usage:

openstack network agent add router [-h] [--l3] <agent-id> <router>
Copy to Clipboard Toggle word wrap

Add router to an agent

Expand
Table 48.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)

Expand
Table 48.4. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--l3

Add router to an l3 agent

48.3. network agent delete

Usage:

openstack network agent delete [-h]

                                    <network-agent> [<network-agent> ...]
Copy to Clipboard Toggle word wrap

Delete network agent(s)

Expand
Table 48.5. Positional Arguments
ValueSummary

<network-agent>

Network agent(s) to delete (id only)

Expand
Table 48.6. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

48.4. network agent list

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]
Copy to Clipboard Toggle word wrap

List network agents

Expand
Table 48.7. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

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

--host <host>

List only agents running on the specified host

--network <network>

List agents hosting a network (name or id)

--router <router>

List agents hosting this router (name or id)

--long

List additional fields in output

Expand
Table 48.8. Output Formatters
ValueSummary

-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

Expand
Table 48.9. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 48.10. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 48.11. CSV Formatter
ValueSummary

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

when to include quotes, defaults to nonnumeric

48.5. network agent remove network

Usage:

openstack network agent remove network [-h] [--dhcp]

                                            <agent-id> <network>
Copy to Clipboard Toggle word wrap

Remove network from an agent.

Expand
Table 48.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)

Expand
Table 48.13. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--dhcp

Remove network from dhcp agent

48.6. network agent remove router

Usage:

openstack network agent remove router [-h] [--l3] <agent-id> <router>
Copy to Clipboard Toggle word wrap

Remove router from an agent

Expand
Table 48.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)

Expand
Table 48.15. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--l3

Remove router from an l3 agent

48.7. network agent set

Usage:

openstack network agent set [-h] [--description <description>]

                                 [--enable | --disable]
                                 <network-agent>
Copy to Clipboard Toggle word wrap

Set network agent properties

Expand
Table 48.16. Positional Arguments
ValueSummary

<network-agent>

Network agent to modify (id only)

Expand
Table 48.17. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--description <description>

Set network agent description

--enable

Enable network agent

--disable

Disable network agent

48.8. network agent show

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>
Copy to Clipboard Toggle word wrap

Display network agent details

Expand
Table 48.18. Positional Arguments
ValueSummary

<network-agent>

Network agent to display (id only)

Expand
Table 48.19. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

Expand
Table 48.20. Output Formatters
ValueSummary

-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

Expand
Table 48.21. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 48.22. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 48.23. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

48.9. network auto allocated topology create

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]
Copy to Clipboard Toggle word wrap

Create the auto allocated topology for project

Expand
Table 48.24. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

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

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

Expand
Table 48.25. Output Formatters
ValueSummary

-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

Expand
Table 48.26. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 48.27. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 48.28. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

48.10. network auto allocated topology delete

Usage:

openstack network auto allocated topology delete [-h]

                                                      [--project <project>]
                                                      [--project-domain <project-domain>]
Copy to Clipboard Toggle word wrap

Delete auto allocated topology for project

Expand
Table 48.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.

48.11. network create

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>
Copy to Clipboard Toggle word wrap

Create new network

Expand
Table 48.30. Positional Arguments
ValueSummary

<name>

New network name

Expand
Table 48.31. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--share

Share the network between projects

--no-share

Do not share the network between projects

--enable

Enable network (default)

--disable

Disable network

--project <project>

Owner’s project (name or id)

--description <description>

Set network description

--mtu <mtu>

Set network mtu

--project-domain <project-domain>

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

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

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

--disable-port-security

Disable port security by default for ports created on this network

--external

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

--internal

Set this network as an internal network (default)

--default

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

--no-default

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

--qos-policy <qos-policy>

QoS policy to attach to this network (name or ID)

--transparent-vlan

Make the network vlan transparent

--no-transparent-vlan

Do not make the network VLAN transparent

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

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

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

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

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

--no-tag

No tags associated with the network

Expand
Table 48.32. Output Formatters
ValueSummary

-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

Expand
Table 48.33. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 48.34. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 48.35. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

48.12. network delete

Usage:

openstack network delete [-h] <network> [<network> ...]
Copy to Clipboard Toggle word wrap

Delete network(s)

Expand
Table 48.36. Positional Arguments
ValueSummary

<network>

Network(s) to delete (name or id)

Expand
Table 48.37. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

48.13. network flavor add profile

Usage:

openstack network flavor add profile [-h] <flavor> <service-profile>
Copy to Clipboard Toggle word wrap

Add a service profile to a network flavor

Expand
Table 48.38. Positional Arguments
ValueSummary

<flavor>

Network flavor (name or id)

<service-profile>

Service profile (id only)

Expand
Table 48.39. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

48.14. network flavor create

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>
Copy to Clipboard Toggle word wrap

Create new network flavor

Expand
Table 48.40. Positional Arguments
ValueSummary

<name>

Name for the flavor

Expand
Table 48.41. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

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

--project <project>

Owner’s 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.

--enable

Enable the flavor (default)

--disable

Disable the flavor

Expand
Table 48.42. Output Formatters
ValueSummary

-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

Expand
Table 48.43. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 48.44. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 48.45. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

48.15. network flavor delete

Usage:

openstack network flavor delete [-h] <flavor> [<flavor> ...]
Copy to Clipboard Toggle word wrap

Delete network flavors

Expand
Table 48.46. Positional Arguments
ValueSummary

<flavor>

Flavor(s) to delete (name or id)

Expand
Table 48.47. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

48.16. network flavor list

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]
Copy to Clipboard Toggle word wrap

List network flavors

Expand
Table 48.48. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

Expand
Table 48.49. Output Formatters
ValueSummary

-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

Expand
Table 48.50. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 48.51. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 48.52. CSV Formatter
ValueSummary

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

when to include quotes, defaults to nonnumeric

48.17. network flavor profile create

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]
Copy to Clipboard Toggle word wrap

Create new network flavor profile

Expand
Table 48.53. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--project <project>

Owner’s 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.

--description <description>

Description for the flavor profile

--enable

Enable the flavor profile

--disable

Disable the flavor profile

--driver DRIVER

Python module path to driver. this becomes required if

--metainfo is missing and vice versa

 

--metainfo METAINFO

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

Expand
Table 48.54. Output Formatters
ValueSummary

-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

Expand
Table 48.55. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 48.56. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 48.57. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

48.18. network flavor profile delete

Usage:

openstack network flavor profile delete [-h]

                                             <flavor-profile>
                                             [<flavor-profile> ...]
Copy to Clipboard Toggle word wrap

Delete network flavor profile

Expand
Table 48.58. Positional Arguments
ValueSummary

<flavor-profile>

Flavor profile(s) to delete (id only)

Expand
Table 48.59. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

48.19. network flavor profile list

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]
Copy to Clipboard Toggle word wrap

List network flavor profile(s)

Expand
Table 48.60. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

Expand
Table 48.61. Output Formatters
ValueSummary

-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

Expand
Table 48.62. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 48.63. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 48.64. CSV Formatter
ValueSummary

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

when to include quotes, defaults to nonnumeric

48.20. network flavor profile set

Usage:

openstack network flavor profile set [-h]

                                          [--project-domain <project-domain>]
                                          [--description <description>]
                                          [--enable | --disable]
                                          [--driver DRIVER]
                                          [--metainfo METAINFO]
                                          <flavor-profile>
Copy to Clipboard Toggle word wrap

Set network flavor profile properties

Expand
Table 48.65. Positional Arguments
ValueSummary

<flavor-profile>

Flavor profile to update (id only)

Expand
Table 48.66. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--project-domain <project-domain>

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

--description <description>

Description for the flavor profile

--enable

Enable the flavor profile

--disable

Disable the flavor profile

--driver DRIVER

Python module path to driver. this becomes required if

--metainfo is missing and vice versa

 

--metainfo METAINFO

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

48.21. network flavor profile show

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>
Copy to Clipboard Toggle word wrap

Display network flavor profile details

Expand
Table 48.67. Positional Arguments
ValueSummary

<flavor-profile>

Flavor profile to display (id only)

Expand
Table 48.68. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

Expand
Table 48.69. Output Formatters
ValueSummary

-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

Expand
Table 48.70. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 48.71. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 48.72. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

48.22. network flavor remove profile

Usage:

openstack network flavor remove profile [-h] <flavor> <service-profile>
Copy to Clipboard Toggle word wrap

Remove service profile from network flavor

Expand
Table 48.73. Positional Arguments
ValueSummary

<flavor>

Network flavor (name or id)

<service-profile>

Service profile (id only)

Expand
Table 48.74. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

48.23. network flavor set

Usage:

openstack network flavor set [-h] [--description DESCRIPTION]

                                  [--disable | --enable] [--name <name>]
                                  <flavor>
Copy to Clipboard Toggle word wrap

Set network flavor properties

Expand
Table 48.75. Positional Arguments
ValueSummary

<flavor>

Flavor to update (name or id)

Expand
Table 48.76. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--description DESCRIPTION

Set network flavor description

--disable

Disable network flavor

--enable

Enable network flavor

--name <name>

Set flavor name

48.24. network flavor show

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>
Copy to Clipboard Toggle word wrap

Display network flavor details

Expand
Table 48.77. Positional Arguments
ValueSummary

<flavor>

Flavor to display (name or id)

Expand
Table 48.78. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

Expand
Table 48.79. Output Formatters
ValueSummary

-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

Expand
Table 48.80. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 48.81. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 48.82. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

48.25. network list

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>,...]]
Copy to Clipboard Toggle word wrap

List networks

Expand
Table 48.83. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--external

List external networks

--internal

List internal networks

--long

List additional fields in output

--name <name>

List networks according to their name

--enable

List enabled networks

--disable

List disabled networks

--project <project>

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

--share

List networks shared between projects

--no-share

List networks not shared between projects

--status <status>

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

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

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

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

List networks according to name of the physical network

--provider-segment <provider-segment>

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

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

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

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

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

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

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

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

Expand
Table 48.84. Output Formatters
ValueSummary

-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

Expand
Table 48.85. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 48.86. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 48.87. CSV Formatter
ValueSummary

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

when to include quotes, defaults to nonnumeric

48.26. network log create

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>
Copy to Clipboard Toggle word wrap

Create a new network log

Expand
Table 48.88. Positional Arguments
ValueSummary

<name>

Name for the network log

Expand
Table 48.89. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--description <description>

Description of the network log

--enable

Enable this log (default is disabled)

--disable

Disable this log

--project <project>

Owner’s 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.

--event <event>

An event to store with log

--resource-type <resource-type>

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

--resource <resource>

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

--target <target>

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

Expand
Table 48.90. Output Formatters
ValueSummary

-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

Expand
Table 48.91. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 48.92. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 48.93. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

This command is provided by the python-neutronclient plugin.

48.27. network log delete

Usage:

openstack network log delete [-h] <network-log> [<network-log> ...]
Copy to Clipboard Toggle word wrap

Delete network log(s)

Expand
Table 48.94. Positional Arguments
ValueSummary

<network-log>

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

Expand
Table 48.95. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

This command is provided by the python-neutronclient plugin.

48.28. network log list

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]
Copy to Clipboard Toggle word wrap

List network logs

Expand
Table 48.96. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--long

List additional fields in output

Expand
Table 48.97. Output Formatters
ValueSummary

-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

Expand
Table 48.98. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 48.99. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 48.100. CSV Formatter
ValueSummary

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

when to include quotes, defaults to nonnumeric

This command is provided by the python-neutronclient plugin.

48.29. network log set

Usage:

openstack network log set [-h] [--description <description>]

                               [--enable | --disable] [--name <name>]
                               <network-log>
Copy to Clipboard Toggle word wrap

Set network log properties

Expand
Table 48.101. Positional Arguments
ValueSummary

<network-log>

Network log to set (name or id)

Expand
Table 48.102. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--description <description>

Description of the network log

--enable

Enable this log (default is disabled)

--disable

Disable this log

--name <name>

Name of the network log

This command is provided by the python-neutronclient plugin.

48.30. network log show

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>
Copy to Clipboard Toggle word wrap

Display network log details

Expand
Table 48.103. Positional Arguments
ValueSummary

<network-log>

Network log to show (name or id)

Expand
Table 48.104. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

Expand
Table 48.105. Output Formatters
ValueSummary

-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

Expand
Table 48.106. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 48.107. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 48.108. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

This command is provided by the python-neutronclient plugin.

48.31. network loggable resources list

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]
Copy to Clipboard Toggle word wrap

List supported loggable resources

Expand
Table 48.109. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--long

List additional fields in output

Expand
Table 48.110. Output Formatters
ValueSummary

-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

Expand
Table 48.111. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 48.112. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 48.113. CSV Formatter
ValueSummary

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

when to include quotes, defaults to nonnumeric

This command is provided by the python-neutronclient plugin.

48.32. network meter create

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>
Copy to Clipboard Toggle word wrap

Create network meter

Expand
Table 48.114. Positional Arguments
ValueSummary

<name>

Name of meter

Expand
Table 48.115. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--description <description>

Create description for meter

--project <project>

Owner’s 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.

--share

Share meter between projects

--no-share

Do not share meter between projects

Expand
Table 48.116. Output Formatters
ValueSummary

-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

Expand
Table 48.117. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 48.118. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 48.119. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

48.33. network meter delete

Usage:

openstack network meter delete [-h] <meter> [<meter> ...]
Copy to Clipboard Toggle word wrap

Delete network meter

Expand
Table 48.120. Positional Arguments
ValueSummary

<meter>

Meter to delete (name or id)

Expand
Table 48.121. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

48.34. network meter list

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]
Copy to Clipboard Toggle word wrap

List network meters

Expand
Table 48.122. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

Expand
Table 48.123. Output Formatters
ValueSummary

-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

Expand
Table 48.124. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 48.125. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 48.126. CSV Formatter
ValueSummary

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

when to include quotes, defaults to nonnumeric

48.35. network meter rule create

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>
Copy to Clipboard Toggle word wrap

Create a new meter rule

Expand
Table 48.127. Positional Arguments
ValueSummary

<meter>

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

Expand
Table 48.128. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--project <project>

Owner’s 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.

--exclude

Exclude remote ip prefix from traffic count

--include

Include remote ip prefix from traffic count (default)

--ingress

Apply rule to incoming network traffic (default)

--egress

Apply rule to outgoing network traffic

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

The remote IP prefix to associate with this rule

Expand
Table 48.129. Output Formatters
ValueSummary

-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

Expand
Table 48.130. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 48.131. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 48.132. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

48.36. network meter rule delete

Usage:

openstack network meter rule delete [-h]

                                         <meter-rule-id>
                                         [<meter-rule-id> ...]
Copy to Clipboard Toggle word wrap

Delete meter rule(s)

Expand
Table 48.133. Positional Arguments
ValueSummary

<meter-rule-id>

Meter rule to delete (id only)

Expand
Table 48.134. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

48.37. network meter rule list

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]
Copy to Clipboard Toggle word wrap

List meter rules

Expand
Table 48.135. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

Expand
Table 48.136. Output Formatters
ValueSummary

-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

Expand
Table 48.137. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 48.138. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 48.139. CSV Formatter
ValueSummary

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

when to include quotes, defaults to nonnumeric

48.38. network meter rule show

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>
Copy to Clipboard Toggle word wrap

Display meter rules details

Expand
Table 48.140. Positional Arguments
ValueSummary

<meter-rule-id>

Meter rule (id only)

Expand
Table 48.141. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

Expand
Table 48.142. Output Formatters
ValueSummary

-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

Expand
Table 48.143. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 48.144. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 48.145. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

48.39. network meter show

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>
Copy to Clipboard Toggle word wrap

Show network meter

Expand
Table 48.146. Positional Arguments
ValueSummary

<meter>

Meter to display (name or id)

Expand
Table 48.147. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

Expand
Table 48.148. Output Formatters
ValueSummary

-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

Expand
Table 48.149. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 48.150. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 48.151. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

48.40. network qos policy create

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>
Copy to Clipboard Toggle word wrap

Create a QoS policy

Expand
Table 48.152. Positional Arguments
ValueSummary

<name>

Name of qos policy to create

Expand
Table 48.153. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--description <description>

Description of the QoS policy

--share

Make the qos policy accessible by other projects

--no-share

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

--project <project>

Owner’s 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.

--default

Set this as a default network qos policy

--no-default

Set this as a non-default network qos policy

Expand
Table 48.154. Output Formatters
ValueSummary

-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

Expand
Table 48.155. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 48.156. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 48.157. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

48.41. network qos policy delete

Usage:

openstack network qos policy delete [-h]

                                         <qos-policy> [<qos-policy> ...]
Copy to Clipboard Toggle word wrap

Delete Qos Policy(s)

Expand
Table 48.158. Positional Arguments
ValueSummary

<qos-policy>

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

Expand
Table 48.159. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

48.42. network qos policy list

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]
Copy to Clipboard Toggle word wrap

List QoS policies

Expand
Table 48.160. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

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

--share

List qos policies shared between projects

--no-share

List qos policies not shared between projects

Expand
Table 48.161. Output Formatters
ValueSummary

-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

Expand
Table 48.162. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 48.163. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 48.164. CSV Formatter
ValueSummary

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

when to include quotes, defaults to nonnumeric

48.43. network qos policy set

Usage:

openstack network qos policy set [-h] [--name <name>]

                                      [--description <description>]
                                      [--share | --no-share]
                                      [--default | --no-default]
                                      <qos-policy>
Copy to Clipboard Toggle word wrap

Set QoS policy properties

Expand
Table 48.165. Positional Arguments
ValueSummary

<qos-policy>

Qos policy to modify (name or id)

Expand
Table 48.166. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--name <name>

Set qos policy name

--description <description>

Description of the QoS policy

--share

Make the qos policy accessible by other projects

--no-share

Make the qos policy not accessible by other projects

--default

Set this as a default network qos policy

--no-default

Set this as a non-default network qos policy

48.44. network qos policy show

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>
Copy to Clipboard Toggle word wrap

Display QoS policy details

Expand
Table 48.167. Positional Arguments
ValueSummary

<qos-policy>

Qos policy to display (name or id)

Expand
Table 48.168. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

Expand
Table 48.169. Output Formatters
ValueSummary

-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

Expand
Table 48.170. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 48.171. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 48.172. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

48.45. network qos rule create

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>
Copy to Clipboard Toggle word wrap

Create new Network QoS rule

Expand
Table 48.173. Positional Arguments
ValueSummary

<qos-policy>

Qos policy that contains the rule (name or id)

Expand
Table 48.174. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--type <type>

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

--max-kbps <max-kbps>

Maximum bandwidth in kbps

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

Maximum burst in kilobits, 0 means automatic

--dscp-mark <dscp-mark>

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

--min-kbps <min-kbps>

Minimum guaranteed bandwidth in kbps

--ingress

Ingress traffic direction from the project point of view

--egress

Egress traffic direction from the project point of view

Expand
Table 48.175. Output Formatters
ValueSummary

-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

Expand
Table 48.176. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 48.177. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 48.178. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

48.46. network qos rule delete

Usage:

openstack network qos rule delete [-h] <qos-policy> <rule-id>
Copy to Clipboard Toggle word wrap

Delete Network QoS rule

Expand
Table 48.179. Positional Arguments
ValueSummary

<qos-policy>

Qos policy that contains the rule (name or id)

<rule-id>

Network qos rule to delete (id)

Expand
Table 48.180. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

48.47. network qos rule list

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>
Copy to Clipboard Toggle word wrap

List Network QoS rules

Expand
Table 48.181. Positional Arguments
ValueSummary

<qos-policy>

Qos policy that contains the rule (name or id)

Expand
Table 48.182. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

Expand
Table 48.183. Output Formatters
ValueSummary

-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

Expand
Table 48.184. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 48.185. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 48.186. CSV Formatter
ValueSummary

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

when to include quotes, defaults to nonnumeric

48.48. network qos rule set

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>
Copy to Clipboard Toggle word wrap

Set Network QoS rule properties

Expand
Table 48.187. Positional Arguments
ValueSummary

<qos-policy>

Qos policy that contains the rule (name or id)

<rule-id>

Network qos rule to delete (id)

Expand
Table 48.188. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--max-kbps <max-kbps>

Maximum bandwidth in kbps

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

Maximum burst in kilobits, 0 means automatic

--dscp-mark <dscp-mark>

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

--min-kbps <min-kbps>

Minimum guaranteed bandwidth in kbps

--ingress

Ingress traffic direction from the project point of view

--egress

Egress traffic direction from the project point of view

48.49. network qos rule show

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>
Copy to Clipboard Toggle word wrap

Display Network QoS rule details

Expand
Table 48.189. Positional Arguments
ValueSummary

<qos-policy>

Qos policy that contains the rule (name or id)

<rule-id>

Network qos rule to delete (id)

Expand
Table 48.190. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

Expand
Table 48.191. Output Formatters
ValueSummary

-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

Expand
Table 48.192. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 48.193. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 48.194. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

48.50. network qos rule type list

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]
Copy to Clipboard Toggle word wrap

List QoS rule types

Expand
Table 48.195. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

Expand
Table 48.196. Output Formatters
ValueSummary

-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

Expand
Table 48.197. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 48.198. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 48.199. CSV Formatter
ValueSummary

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

when to include quotes, defaults to nonnumeric

48.51. network qos rule type show

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>
Copy to Clipboard Toggle word wrap

Show details about supported QoS rule type

Expand
Table 48.200. Positional Arguments
ValueSummary

<qos-rule-type-name>

Name of qos rule type

Expand
Table 48.201. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

Expand
Table 48.202. Output Formatters
ValueSummary

-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

Expand
Table 48.203. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 48.204. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 48.205. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

48.52. network rbac create

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>
Copy to Clipboard Toggle word wrap

Create network RBAC policy

Expand
Table 48.206. Positional Arguments
ValueSummary

<rbac-object>

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

Expand
Table 48.207. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

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

--target-project <target-project>

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

--target-all-projects

Allow creating RBAC policy for all projects.

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

--project <project>

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

Expand
Table 48.208. Output Formatters
ValueSummary

-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

Expand
Table 48.209. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 48.210. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 48.211. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

48.53. network rbac delete

Usage:

openstack network rbac delete [-h] <rbac-policy> [<rbac-policy> ...]
Copy to Clipboard Toggle word wrap

Delete network RBAC policy(s)

Expand
Table 48.212. Positional Arguments
ValueSummary

<rbac-policy>

Rbac policy(s) to delete (id only)

Expand
Table 48.213. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

48.54. network rbac list

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]
Copy to Clipboard Toggle word wrap

List network RBAC policies

Expand
Table 48.214. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--type <type>

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

--action <action>

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

--long

List additional fields in output

Expand
Table 48.215. Output Formatters
ValueSummary

-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

Expand
Table 48.216. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 48.217. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 48.218. CSV Formatter
ValueSummary

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

when to include quotes, defaults to nonnumeric

48.55. network rbac set

Usage:

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

                                [--target-project-domain <target-project-domain>]
                                <rbac-policy>
Copy to Clipboard Toggle word wrap

Set network RBAC policy properties

Expand
Table 48.219. Positional Arguments
ValueSummary

<rbac-policy>

Rbac policy to be modified (id only)

Expand
Table 48.220. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--target-project <target-project>

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

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

48.56. network rbac show

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>
Copy to Clipboard Toggle word wrap

Display network RBAC policy details

Expand
Table 48.221. Positional Arguments
ValueSummary

<rbac-policy>

Rbac policy (id only)

Expand
Table 48.222. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

Expand
Table 48.223. Output Formatters
ValueSummary

-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

Expand
Table 48.224. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 48.225. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 48.226. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

48.57. network segment create

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>
Copy to Clipboard Toggle word wrap

Create new network segment

Expand
Table 48.227. Positional Arguments
ValueSummary

<name>

New network segment name

Expand
Table 48.228. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--description <description>

Network segment description

--physical-network <physical-network>

Physical network name of this network segment

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

--network-type <network-type>

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

Expand
Table 48.229. Output Formatters
ValueSummary

-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

Expand
Table 48.230. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 48.231. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 48.232. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

48.58. network segment delete

Usage:

openstack network segment delete [-h]

                                      <network-segment>
                                      [<network-segment> ...]
Copy to Clipboard Toggle word wrap

Delete network segment(s)

Expand
Table 48.233. Positional Arguments
ValueSummary

<network-segment>

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

Expand
Table 48.234. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

48.59. network segment list

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>]
Copy to Clipboard Toggle word wrap

List network segments

Expand
Table 48.235. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--long

List additional fields in output

--network <network>

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

Expand
Table 48.236. Output Formatters
ValueSummary

-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

Expand
Table 48.237. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 48.238. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 48.239. CSV Formatter
ValueSummary

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

when to include quotes, defaults to nonnumeric

48.60. network segment set

Usage:

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

                                   [--name <name>]
                                   <network-segment>
Copy to Clipboard Toggle word wrap

Set network segment properties

Expand
Table 48.240. Positional Arguments
ValueSummary

<network-segment>

Network segment to modify (name or id)

Expand
Table 48.241. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--description <description>

Set network segment description

--name <name>

Set network segment name

48.61. network segment show

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>
Copy to Clipboard Toggle word wrap

Display network segment details

Expand
Table 48.242. Positional Arguments
ValueSummary

<network-segment>

Network segment to display (name or id)

Expand
Table 48.243. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

Expand
Table 48.244. Output Formatters
ValueSummary

-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

Expand
Table 48.245. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 48.246. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 48.247. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

48.62. network service provider list

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]
Copy to Clipboard Toggle word wrap

List Service Providers

Expand
Table 48.248. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

Expand
Table 48.249. Output Formatters
ValueSummary

-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

Expand
Table 48.250. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 48.251. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 48.252. CSV Formatter
ValueSummary

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

when to include quotes, defaults to nonnumeric

48.63. network set

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>
Copy to Clipboard Toggle word wrap

Set network properties

Expand
Table 48.253. Positional Arguments
ValueSummary

<network>

Network to modify (name or id)

Expand
Table 48.254. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--name <name>

Set network name

--enable

Enable network

--disable

Disable network

--share

Share the network between projects

--no-share

Do not share the network between projects

--description <description

Set network description

--mtu <mtu

Set network mtu

--enable-port-security

Enable port security by default for ports created on this network

--disable-port-security

Disable port security by default for ports created on this network

--external

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

--internal

Set this network as an internal network

--default

Set the network as the default external network

--no-default

Do not use the network as the default external network

--qos-policy <qos-policy>

QoS policy to attach to this network (name or ID)

--no-qos-policy

Remove the qos policy attached to this network

--tag <tag>

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

--no-tag

Clear tags associated with the network. specify both

--tag and --no-tag to overwrite current tags

 

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

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

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

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

--provider-segment <provider-segment>

VLAN ID for VLAN networks or Tunnel ID for GENEVE/GRE/VXLAN networks

48.64. network show

Usage:

openstack network show [-h] [-f {json,shell,table,value,yaml}]

                            [-c COLUMN] [--max-width <integer>]
                            [--fit-width] [--print-empty] [--noindent]
                            [--prefix PREFIX]
                            <network>
Copy to Clipboard Toggle word wrap

Show network details

Expand
Table 48.255. Positional Arguments
ValueSummary

<network>

Network to display (name or id)

Expand
Table 48.256. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

Expand
Table 48.257. Output Formatters
ValueSummary

-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

Expand
Table 48.258. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 48.259. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 48.260. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

48.65. network subport list

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>
Copy to Clipboard Toggle word wrap

List all subports for a given network trunk

Expand
Table 48.261. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--trunk <trunk>

List subports belonging to this trunk (name or id)

Expand
Table 48.262. Output Formatters
ValueSummary

-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

Expand
Table 48.263. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 48.264. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 48.265. CSV Formatter
ValueSummary

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

when to include quotes, defaults to nonnumeric

This command is provided by the python-neutronclient plugin.

48.66. network trunk create

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>
Copy to Clipboard Toggle word wrap

Create a network trunk for a given project

Expand
Table 48.266. Positional Arguments
ValueSummary

<name>

Name of the trunk to create

Expand
Table 48.267. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--description <description>

A description of the trunk

--parent-port <parent-port>

Parent port belonging to this trunk (name or ID)

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

--enable

Enable trunk (default)

--disable

Disable trunk

--project <project>

Owner’s 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.

Expand
Table 48.268. Output Formatters
ValueSummary

-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

Expand
Table 48.269. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 48.270. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 48.271. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

This command is provided by the python-neutronclient plugin.

48.67. network trunk delete

Usage:

openstack network trunk delete [-h] <trunk> [<trunk> ...]
Copy to Clipboard Toggle word wrap

Delete a given network trunk

Expand
Table 48.272. Positional Arguments
ValueSummary

<trunk>

Trunk(s) to delete (name or id)

Expand
Table 48.273. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

This command is provided by the python-neutronclient plugin.

48.68. network trunk list

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]
Copy to Clipboard Toggle word wrap

List all network trunks

Expand
Table 48.274. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--long

List additional fields in output

Expand
Table 48.275. Output Formatters
ValueSummary

-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

Expand
Table 48.276. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 48.277. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 48.278. CSV Formatter
ValueSummary

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

when to include quotes, defaults to nonnumeric

This command is provided by the python-neutronclient plugin.

48.69. network trunk set

Usage:

openstack network trunk set [-h] [--name <name>]

                                 [--description <description>]
                                 [--subport <port=,segmentation-type=,segmentation-id=>]
                                 [--enable | --disable]
                                 <trunk>
Copy to Clipboard Toggle word wrap

Set network trunk properties

Expand
Table 48.279. Positional Arguments
ValueSummary

<trunk>

Trunk to modify (name or id)

Expand
Table 48.280. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--name <name>

Set trunk name

--description <description>

A description of the trunk

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

--enable

Enable trunk

--disable

Disable trunk

This command is provided by the python-neutronclient plugin.

48.70. network trunk show

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>
Copy to Clipboard Toggle word wrap

Show information of a given network trunk

Expand
Table 48.281. Positional Arguments
ValueSummary

<trunk>

Trunk to display (name or id)

Expand
Table 48.282. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

Expand
Table 48.283. Output Formatters
ValueSummary

-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

Expand
Table 48.284. Table Formatter
ValueSummary

--max-width <integer>

Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

Expand
Table 48.285. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 48.286. shell formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

This command is provided by the python-neutronclient plugin.

48.71. network trunk unset

Usage:

openstack network trunk unset [-h] --subport <subport> <trunk>
Copy to Clipboard Toggle word wrap

Unset subports from a given network trunk

Expand
Table 48.287. Positional Arguments
ValueSummary

<trunk>

Unset subports from this trunk (name or id)

Expand
Table 48.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

This command is provided by the python-neutronclient plugin.

48.72. network unset

Usage:

openstack network unset [-h] [--tag <tag> | --all-tag] <network>
Copy to Clipboard Toggle word wrap

Unset network properties

Expand
Table 48.289. Positional Arguments
ValueSummary

<network>

Network to modify (name or id)

Expand
Table 48.290. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

--tag <tag>

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

--all-tag

Clear all tags associated with the network

返回顶部
Red Hat logoGithubredditYoutubeTwitter

学习

尝试、购买和销售

社区

关于红帽文档

通过我们的产品和服务,以及可以信赖的内容,帮助红帽用户创新并实现他们的目标。 了解我们当前的更新.

让开源更具包容性

红帽致力于替换我们的代码、文档和 Web 属性中存在问题的语言。欲了解更多详情,请参阅红帽博客.

關於紅帽

我们提供强化的解决方案,使企业能够更轻松地跨平台和环境(从核心数据中心到网络边缘)工作。

Theme

© 2025 Red Hat