Chapter 54. network
This chapter describes the commands under the network
command.
54.1. network agent add network
Add network to an agent
Usage:
openstack network agent add network [-h] [--dhcp] <agent-id> <network>
Table 54.1. Positional Arguments
Value | Summary |
---|---|
<agent-id> | Agent to which a network is added (id only) |
<network> | Network to be added to an agent (name or id) |
Table 54.2. Optional Arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
--dhcp | Add network to a dhcp agent |
54.2. network agent add router
Add router to an agent
Usage:
openstack network agent add router [-h] [--l3] <agent-id> <router>
Table 54.3. Positional Arguments
Value | Summary |
---|---|
<agent-id> | Agent to which a router is added (id only) |
<router> | Router to be added to an agent (name or id) |
Table 54.4. Optional Arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
--l3 | Add router to an l3 agent |
54.3. network agent delete
Delete network agent(s)
Usage:
openstack network agent delete [-h] <network-agent> [<network-agent> ...]
Table 54.5. Positional Arguments
Value | Summary |
---|---|
<network-agent> | Network agent(s) to delete (id only) |
Table 54.6. Optional Arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
54.4. network agent list
List network agents
Usage:
openstack network agent list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--agent-type <agent-type>] [--host <host>] [--network <network> | --router <router>] [--long]
Table 54.7. Optional Arguments
Value | Summary |
---|---|
-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 |
Table 54.8. Output Formatters
Value | Summary |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
--sort-column SORT_COLUMN | Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated |
Table 54.9. CSV Formatter
Value | Summary |
---|---|
--quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
Table 54.10. JSON Formatter
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 54.11. Table Formatter
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit 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. |
54.5. network agent remove network
Remove network from an agent.
Usage:
openstack network agent remove network [-h] [--dhcp] <agent-id> <network>
Table 54.12. Positional Arguments
Value | Summary |
---|---|
<agent-id> | Agent to which a network is removed (id only) |
<network> | Network to be removed from an agent (name or id) |
Table 54.13. Optional Arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
--dhcp | Remove network from dhcp agent |
54.6. network agent remove router
Remove router from an agent
Usage:
openstack network agent remove router [-h] [--l3] <agent-id> <router>
Table 54.14. Positional Arguments
Value | Summary |
---|---|
<agent-id> | Agent from which router will be removed (id only) |
<router> | Router to be removed from an agent (name or id) |
Table 54.15. Optional Arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
--l3 | Remove router from an l3 agent |
54.7. network agent set
Set network agent properties
Usage:
openstack network agent set [-h] [--description <description>] [--enable | --disable] <network-agent>
Table 54.16. Positional Arguments
Value | Summary |
---|---|
<network-agent> | Network agent to modify (id only) |
Table 54.17. Optional Arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
--description <description> | Set network agent description |
--enable | Enable network agent |
--disable | Disable network agent |
54.8. network agent show
Display network agent details
Usage:
openstack network agent show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <network-agent>
Table 54.18. Positional Arguments
Value | Summary |
---|---|
<network-agent> | Network agent to display (id only) |
Table 54.19. Optional Arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
Table 54.20. Output Formatters
Value | Summary |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
Table 54.21. JSON Formatter
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 54.22. Shell Formatter
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
Table 54.23. Table Formatter
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit 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. |
54.9. network auto allocated topology create
Create the auto allocated topology for project
Usage:
openstack network auto allocated topology create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--project <project>] [--project-domain <project-domain>] [--check-resources] [--or-show]
Table 54.24. Optional Arguments
Value | Summary |
---|---|
-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) |
Table 54.25. Output Formatters
Value | Summary |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
Table 54.26. JSON Formatter
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 54.27. Shell Formatter
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
Table 54.28. Table Formatter
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit 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. |
54.10. network auto allocated topology delete
Delete auto allocated topology for project
Usage:
openstack network auto allocated topology delete [-h] [--project <project>] [--project-domain <project-domain>]
Table 54.29. Optional Arguments
Value | Summary |
---|---|
-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. |
54.11. network create
Create new network
Usage:
openstack network create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--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>] [--dns-domain <dns-domain>] [--tag <tag> | --no-tag] <name>
Table 54.30. Positional Arguments
Value | Summary |
---|---|
<name> | New network name |
Table 54.31. Optional Arguments
Value | Summary |
---|---|
-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 |
--dns-domain <dns-domain> | Set dns domain for this network (requires dns integration extension) |
--tag <tag> | Tag to be added to the network (repeat option to set multiple tags) |
--no-tag | No tags associated with the network |
Table 54.32. Output Formatters
Value | Summary |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
Table 54.33. JSON Formatter
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 54.34. Shell Formatter
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
Table 54.35. Table Formatter
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit 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. |
54.12. network delete
Delete network(s)
Usage:
openstack network delete [-h] <network> [<network> ...]
Table 54.36. Positional Arguments
Value | Summary |
---|---|
<network> | Network(s) to delete (name or id) |
Table 54.37. Optional Arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
54.13. network flavor add profile
Add a service profile to a network flavor
Usage:
openstack network flavor add profile [-h] <flavor> <service-profile>
Table 54.38. Positional Arguments
Value | Summary |
---|---|
<flavor> | Network flavor (name or id) |
<service-profile> | Service profile (id only) |
Table 54.39. Optional Arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
54.14. network flavor create
Create new network flavor
Usage:
openstack network flavor create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] --service-type <service-type> [--description DESCRIPTION] [--project <project>] [--project-domain <project-domain>] [--enable | --disable] <name>
Table 54.40. Positional Arguments
Value | Summary |
---|---|
<name> | Name for the flavor |
Table 54.41. Optional Arguments
Value | Summary |
---|---|
-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 |
Table 54.42. Output Formatters
Value | Summary |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
Table 54.43. JSON Formatter
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 54.44. Shell Formatter
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
Table 54.45. Table Formatter
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit 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. |
54.15. network flavor delete
Delete network flavors
Usage:
openstack network flavor delete [-h] <flavor> [<flavor> ...]
Table 54.46. Positional Arguments
Value | Summary |
---|---|
<flavor> | Flavor(s) to delete (name or id) |
Table 54.47. Optional Arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
54.16. network flavor list
List network flavors
Usage:
openstack network flavor list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN]
Table 54.48. Optional Arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
Table 54.49. Output Formatters
Value | Summary |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
--sort-column SORT_COLUMN | Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated |
Table 54.50. CSV Formatter
Value | Summary |
---|---|
--quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
Table 54.51. JSON Formatter
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 54.52. Table Formatter
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit 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. |
54.17. network flavor profile create
Create new network flavor profile
Usage:
openstack network flavor profile create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--project <project>] [--project-domain <project-domain>] [--description <description>] [--enable | --disable] [--driver DRIVER] [--metainfo METAINFO]
Table 54.53. Optional Arguments
Value | Summary |
---|---|
-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 |
Table 54.54. Output Formatters
Value | Summary |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
Table 54.55. JSON Formatter
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 54.56. Shell Formatter
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
Table 54.57. Table Formatter
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit 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. |
54.18. network flavor profile delete
Delete network flavor profile
Usage:
openstack network flavor profile delete [-h] <flavor-profile> [<flavor-profile> ...]
Table 54.58. Positional Arguments
Value | Summary |
---|---|
<flavor-profile> | Flavor profile(s) to delete (id only) |
Table 54.59. Optional Arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
54.19. network flavor profile list
List network flavor profile(s)
Usage:
openstack network flavor profile list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN]
Table 54.60. Optional Arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
Table 54.61. Output Formatters
Value | Summary |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
--sort-column SORT_COLUMN | Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated |
Table 54.62. CSV Formatter
Value | Summary |
---|---|
--quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
Table 54.63. JSON Formatter
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 54.64. Table Formatter
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit 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. |
54.20. network flavor profile set
Set network flavor profile properties
Usage:
openstack network flavor profile set [-h] [--project-domain <project-domain>] [--description <description>] [--enable | --disable] [--driver DRIVER] [--metainfo METAINFO] <flavor-profile>
Table 54.65. Positional Arguments
Value | Summary |
---|---|
<flavor-profile> | Flavor profile to update (id only) |
Table 54.66. Optional Arguments
Value | Summary |
---|---|
-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 |
54.21. network flavor profile show
Display network flavor profile details
Usage:
openstack network flavor profile show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <flavor-profile>
Table 54.67. Positional Arguments
Value | Summary |
---|---|
<flavor-profile> | Flavor profile to display (id only) |
Table 54.68. Optional Arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
Table 54.69. Output Formatters
Value | Summary |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
Table 54.70. JSON Formatter
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 54.71. Shell Formatter
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
Table 54.72. Table Formatter
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit 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. |
54.22. network flavor remove profile
Remove service profile from network flavor
Usage:
openstack network flavor remove profile [-h] <flavor> <service-profile>
Table 54.73. Positional Arguments
Value | Summary |
---|---|
<flavor> | Network flavor (name or id) |
<service-profile> | Service profile (id only) |
Table 54.74. Optional Arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
54.23. network flavor set
Set network flavor properties
Usage:
openstack network flavor set [-h] [--description DESCRIPTION] [--disable | --enable] [--name <name>] <flavor>
Table 54.75. Positional Arguments
Value | Summary |
---|---|
<flavor> | Flavor to update (name or id) |
Table 54.76. Optional Arguments
Value | Summary |
---|---|
-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 |
54.24. network flavor show
Display network flavor details
Usage:
openstack network flavor show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <flavor>
Table 54.77. Positional Arguments
Value | Summary |
---|---|
<flavor> | Flavor to display (name or id) |
Table 54.78. Optional Arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
Table 54.79. Output Formatters
Value | Summary |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
Table 54.80. JSON Formatter
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 54.81. Shell Formatter
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
Table 54.82. Table Formatter
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit 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. |
54.25. network list
List networks
Usage:
openstack network list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--external | --internal] [--long] [--name <name>] [--enable | --disable] [--project <project>] [--project-domain <project-domain>] [--share | --no-share] [--status <status>] [--provider-network-type <provider-network-type>] [--provider-physical-network <provider-physical-network>] [--provider-segment <provider-segment>] [--agent <agent-id>] [--tags <tag>[,<tag>,...]] [--any-tags <tag>[,<tag>,...]] [--not-tags <tag>[,<tag>,...]] [--not-any-tags <tag>[,<tag>,...]]
Table 54.83. Optional Arguments
Value | Summary |
---|---|
-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) |
Table 54.84. Output Formatters
Value | Summary |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
--sort-column SORT_COLUMN | Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated |
Table 54.85. CSV Formatter
Value | Summary |
---|---|
--quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
Table 54.86. JSON Formatter
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 54.87. Table Formatter
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit 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. |
54.26. network log create
Create a new network log
Usage:
openstack network log create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--description <description>] [--enable | --disable] [--project <project>] [--project-domain <project-domain>] [--event {ALL,ACCEPT,DROP}] --resource-type <resource-type> [--resource <resource>] [--target <target>] <name>
Table 54.88. Positional Arguments
Value | Summary |
---|---|
<name> | Name for the network log |
Table 54.89. Optional Arguments
Value | Summary |
---|---|
-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 {ALL,ACCEPT,DROP} | 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 resources list |
--resource <resource> | Name or id of resource (security group or firewall group) that used 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. |
Table 54.90. Output Formatters
Value | Summary |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
Table 54.91. JSON Formatter
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 54.92. Shell Formatter
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
Table 54.93. Table Formatter
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit 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. |
54.27. network log delete
Delete network log(s)
Usage:
openstack network log delete [-h] <network-log> [<network-log> ...]
Table 54.94. Positional Arguments
Value | Summary |
---|---|
<network-log> | Network log(s) to delete (name or id) |
Table 54.95. Optional Arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
54.28. network log list
List network logs
Usage:
openstack network log list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--long]
Table 54.96. Optional Arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
--long | List additional fields in output |
Table 54.97. Output Formatters
Value | Summary |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
--sort-column SORT_COLUMN | Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated |
Table 54.98. CSV Formatter
Value | Summary |
---|---|
--quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
Table 54.99. JSON Formatter
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 54.100. Table Formatter
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit 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. |
54.29. network log set
Set network log properties
Usage:
openstack network log set [-h] [--description <description>] [--enable | --disable] [--name <name>] <network-log>
Table 54.101. Positional Arguments
Value | Summary |
---|---|
<network-log> | Network log to set (name or id) |
Table 54.102. Optional Arguments
Value | Summary |
---|---|
-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 |
54.30. network log show
Display network log details
Usage:
openstack network log show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <network-log>
Table 54.103. Positional Arguments
Value | Summary |
---|---|
<network-log> | Network log to show (name or id) |
Table 54.104. Optional Arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
Table 54.105. Output Formatters
Value | Summary |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
Table 54.106. JSON Formatter
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 54.107. Shell Formatter
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
Table 54.108. Table Formatter
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit 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. |
54.31. network loggable resources list
List supported loggable resources
Usage:
openstack network loggable resources list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--long]
Table 54.109. Optional Arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
--long | List additional fields in output |
Table 54.110. Output Formatters
Value | Summary |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
--sort-column SORT_COLUMN | Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated |
Table 54.111. CSV Formatter
Value | Summary |
---|---|
--quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
Table 54.112. JSON Formatter
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 54.113. Table Formatter
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit 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. |
54.32. network meter create
Create network meter
Usage:
openstack network meter create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--description <description>] [--project <project>] [--project-domain <project-domain>] [--share | --no-share] <name>
Table 54.114. Positional Arguments
Value | Summary |
---|---|
<name> | Name of meter |
Table 54.115. Optional Arguments
Value | Summary |
---|---|
-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 |
Table 54.116. Output Formatters
Value | Summary |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
Table 54.117. JSON Formatter
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 54.118. Shell Formatter
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
Table 54.119. Table Formatter
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit 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. |
54.33. network meter delete
Delete network meter
Usage:
openstack network meter delete [-h] <meter> [<meter> ...]
Table 54.120. Positional Arguments
Value | Summary |
---|---|
<meter> | Meter to delete (name or id) |
Table 54.121. Optional Arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
54.34. network meter list
List network meters
Usage:
openstack network meter list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN]
Table 54.122. Optional Arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
Table 54.123. Output Formatters
Value | Summary |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
--sort-column SORT_COLUMN | Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated |
Table 54.124. CSV Formatter
Value | Summary |
---|---|
--quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
Table 54.125. JSON Formatter
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 54.126. Table Formatter
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit 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. |
54.35. network meter rule create
Create a new meter rule
Usage:
openstack network meter rule create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--project <project>] [--project-domain <project-domain>] [--exclude | --include] [--ingress | --egress] --remote-ip-prefix <remote-ip-prefix> <meter>
Table 54.127. Positional Arguments
Value | Summary |
---|---|
<meter> | Label to associate with this metering rule (name or ID) |
Table 54.128. Optional Arguments
Value | Summary |
---|---|
-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 |
Table 54.129. Output Formatters
Value | Summary |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
Table 54.130. JSON Formatter
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 54.131. Shell Formatter
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
Table 54.132. Table Formatter
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit 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. |
54.36. network meter rule delete
Delete meter rule(s)
Usage:
openstack network meter rule delete [-h] <meter-rule-id> [<meter-rule-id> ...]
Table 54.133. Positional Arguments
Value | Summary |
---|---|
<meter-rule-id> | Meter rule to delete (id only) |
Table 54.134. Optional Arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
54.37. network meter rule list
List meter rules
Usage:
openstack network meter rule list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN]
Table 54.135. Optional Arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
Table 54.136. Output Formatters
Value | Summary |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
--sort-column SORT_COLUMN | Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated |
Table 54.137. CSV Formatter
Value | Summary |
---|---|
--quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
Table 54.138. JSON Formatter
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 54.139. Table Formatter
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit 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. |
54.38. network meter rule show
Display meter rules details
Usage:
openstack network meter rule show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <meter-rule-id>
Table 54.140. Positional Arguments
Value | Summary |
---|---|
<meter-rule-id> | Meter rule (id only) |
Table 54.141. Optional Arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
Table 54.142. Output Formatters
Value | Summary |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
Table 54.143. JSON Formatter
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 54.144. Shell Formatter
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
Table 54.145. Table Formatter
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit 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. |
54.39. network meter show
Show network meter
Usage:
openstack network meter show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <meter>
Table 54.146. Positional Arguments
Value | Summary |
---|---|
<meter> | Meter to display (name or id) |
Table 54.147. Optional Arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
Table 54.148. Output Formatters
Value | Summary |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
Table 54.149. JSON Formatter
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 54.150. Shell Formatter
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
Table 54.151. Table Formatter
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit 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. |
54.40. network onboard subnets
Onboard network subnets into a subnet pool
Usage:
openstack network onboard subnets [-h] <network> <subnetpool>
Table 54.152. Positional Arguments
Value | Summary |
---|---|
<network> | Onboard all subnets associated with this network |
<subnetpool> | Target subnet pool for onboarding subnets |
Table 54.153. Optional Arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
54.41. network qos policy create
Create a QoS policy
Usage:
openstack network qos policy create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--description <description>] [--share | --no-share] [--project <project>] [--project-domain <project-domain>] [--default | --no-default] <name>
Table 54.154. Positional Arguments
Value | Summary |
---|---|
<name> | Name of qos policy to create |
Table 54.155. Optional Arguments
Value | Summary |
---|---|
-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 |
Table 54.156. Output Formatters
Value | Summary |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
Table 54.157. JSON Formatter
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 54.158. Shell Formatter
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
Table 54.159. Table Formatter
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit 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. |
54.42. network qos policy delete
Delete Qos Policy(s)
Usage:
openstack network qos policy delete [-h] <qos-policy> [<qos-policy> ...]
Table 54.160. Positional Arguments
Value | Summary |
---|---|
<qos-policy> | Qos policy(s) to delete (name or id) |
Table 54.161. Optional Arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
54.43. network qos policy list
List QoS policies
Usage:
openstack network qos policy list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--project <project>] [--project-domain <project-domain>] [--share | --no-share]
Table 54.162. Optional Arguments
Value | Summary |
---|---|
-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 |
Table 54.163. Output Formatters
Value | Summary |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
--sort-column SORT_COLUMN | Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated |
Table 54.164. CSV Formatter
Value | Summary |
---|---|
--quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
Table 54.165. JSON Formatter
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 54.166. Table Formatter
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit 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. |
54.44. network qos policy set
Set QoS policy properties
Usage:
openstack network qos policy set [-h] [--name <name>] [--description <description>] [--share | --no-share] [--default | --no-default] <qos-policy>
Table 54.167. Positional Arguments
Value | Summary |
---|---|
<qos-policy> | Qos policy to modify (name or id) |
Table 54.168. Optional Arguments
Value | Summary |
---|---|
-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 |
54.45. network qos policy show
Display QoS policy details
Usage:
openstack network qos policy show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <qos-policy>
Table 54.169. Positional Arguments
Value | Summary |
---|---|
<qos-policy> | Qos policy to display (name or id) |
Table 54.170. Optional Arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
Table 54.171. Output Formatters
Value | Summary |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
Table 54.172. JSON Formatter
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 54.173. Shell Formatter
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
Table 54.174. Table Formatter
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit 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. |
54.46. network qos rule create
Create new Network QoS rule
Usage:
openstack network qos rule create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--type <type>] [--max-kbps <max-kbps>] [--max-burst-kbits <max-burst-kbits>] [--dscp-mark <dscp-mark>] [--min-kbps <min-kbps>] [--ingress | --egress] <qos-policy>
Table 54.175. Positional Arguments
Value | Summary |
---|---|
<qos-policy> | Qos policy that contains the rule (name or id) |
Table 54.176. Optional Arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
--type <type> | Qos rule type (minimum-bandwidth, dscp-marking, bandwidth-limit) |
--max-kbps <max-kbps> | Maximum bandwidth in kbps |
--max-burst-kbits <max-burst-kbits> | Maximum burst in kilobits, 0 or not specified means automatic, which is 80% of the bandwidth limit, which works for typical TCP traffic. For details check the QoS user workflow. |
--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 |
Table 54.177. Output Formatters
Value | Summary |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
Table 54.178. JSON Formatter
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 54.179. Shell Formatter
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
Table 54.180. Table Formatter
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit 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. |
54.47. network qos rule delete
Delete Network QoS rule
Usage:
openstack network qos rule delete [-h] <qos-policy> <rule-id>
Table 54.181. Positional Arguments
Value | Summary |
---|---|
<qos-policy> | Qos policy that contains the rule (name or id) |
<rule-id> | Network qos rule to delete (id) |
Table 54.182. Optional Arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
54.48. network qos rule list
List Network QoS rules
Usage:
openstack network qos rule list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] <qos-policy>
Table 54.183. Positional Arguments
Value | Summary |
---|---|
<qos-policy> | Qos policy that contains the rule (name or id) |
Table 54.184. Optional Arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
Table 54.185. Output Formatters
Value | Summary |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
--sort-column SORT_COLUMN | Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated |
Table 54.186. CSV Formatter
Value | Summary |
---|---|
--quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
Table 54.187. JSON Formatter
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 54.188. Table Formatter
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit 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. |
54.49. network qos rule set
Set Network QoS rule properties
Usage:
openstack network qos rule set [-h] [--max-kbps <max-kbps>] [--max-burst-kbits <max-burst-kbits>] [--dscp-mark <dscp-mark>] [--min-kbps <min-kbps>] [--ingress | --egress] <qos-policy> <rule-id>
Table 54.189. Positional Arguments
Value | Summary |
---|---|
<qos-policy> | Qos policy that contains the rule (name or id) |
<rule-id> | Network qos rule to delete (id) |
Table 54.190. Optional Arguments
Value | Summary |
---|---|
-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 or not specified means automatic, which is 80% of the bandwidth limit, which works for typical TCP traffic. For details check the QoS user workflow. |
--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 |
54.50. network qos rule show
Display Network QoS rule details
Usage:
openstack network qos rule show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <qos-policy> <rule-id>
Table 54.191. Positional Arguments
Value | Summary |
---|---|
<qos-policy> | Qos policy that contains the rule (name or id) |
<rule-id> | Network qos rule to delete (id) |
Table 54.192. Optional Arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
Table 54.193. Output Formatters
Value | Summary |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
Table 54.194. JSON Formatter
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 54.195. Shell Formatter
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
Table 54.196. Table Formatter
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit 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. |
54.51. network qos rule type list
List QoS rule types
Usage:
openstack network qos rule type list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN]
Table 54.197. Optional Arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
Table 54.198. Output Formatters
Value | Summary |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
--sort-column SORT_COLUMN | Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated |
Table 54.199. CSV Formatter
Value | Summary |
---|---|
--quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
Table 54.200. JSON Formatter
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 54.201. Table Formatter
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit 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. |
54.52. network qos rule type show
Show details about supported QoS rule type
Usage:
openstack network qos rule type show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <qos-rule-type-name>
Table 54.202. Positional Arguments
Value | Summary |
---|---|
<qos-rule-type-name> | Name of qos rule type |
Table 54.203. Optional Arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
Table 54.204. Output Formatters
Value | Summary |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
Table 54.205. JSON Formatter
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 54.206. Shell Formatter
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
Table 54.207. Table Formatter
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit 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. |
54.53. network rbac create
Create network RBAC policy
Usage:
openstack network rbac create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] --type <type> --action <action> (--target-project <target-project> | --target-all-projects) [--target-project-domain <target-project-domain>] [--project <project>] [--project-domain <project-domain>] <rbac-object>
Table 54.208. Positional Arguments
Value | Summary |
---|---|
<rbac-object> | The object to which this rbac policy affects (name or ID) |
Table 54.209. Optional Arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
--type <type> | Type of the object that rbac policy affects ("security_group", "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. |
Table 54.210. Output Formatters
Value | Summary |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
Table 54.211. JSON Formatter
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 54.212. Shell Formatter
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
Table 54.213. Table Formatter
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit 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. |
54.54. network rbac delete
Delete network RBAC policy(s)
Usage:
openstack network rbac delete [-h] <rbac-policy> [<rbac-policy> ...]
Table 54.214. Positional Arguments
Value | Summary |
---|---|
<rbac-policy> | Rbac policy(s) to delete (id only) |
Table 54.215. Optional Arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
54.55. network rbac list
List network RBAC policies
Usage:
openstack network rbac list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--type <type>] [--action <action>] [--long]
Table 54.216. Optional Arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
--type <type> | List network rbac policies according to given object type ("security_group", "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 |
Table 54.217. Output Formatters
Value | Summary |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
--sort-column SORT_COLUMN | Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated |
Table 54.218. CSV Formatter
Value | Summary |
---|---|
--quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
Table 54.219. JSON Formatter
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 54.220. Table Formatter
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit 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. |
54.56. network rbac set
Set network RBAC policy properties
Usage:
openstack network rbac set [-h] [--target-project <target-project>] [--target-project-domain <target-project-domain>] <rbac-policy>
Table 54.221. Positional Arguments
Value | Summary |
---|---|
<rbac-policy> | Rbac policy to be modified (id only) |
Table 54.222. Optional Arguments
Value | Summary |
---|---|
-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. |
54.57. network rbac show
Display network RBAC policy details
Usage:
openstack network rbac show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <rbac-policy>
Table 54.223. Positional Arguments
Value | Summary |
---|---|
<rbac-policy> | Rbac policy (id only) |
Table 54.224. Optional Arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
Table 54.225. Output Formatters
Value | Summary |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
Table 54.226. JSON Formatter
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 54.227. Shell Formatter
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
Table 54.228. Table Formatter
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit 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. |
54.58. network segment create
Create new network segment
Usage:
openstack network segment create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--description <description>] [--physical-network <physical-network>] [--segment <segment>] --network <network> --network-type <network-type> <name>
Table 54.229. Positional Arguments
Value | Summary |
---|---|
<name> | New network segment name |
Table 54.230. Optional Arguments
Value | Summary |
---|---|
-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) |
Table 54.231. Output Formatters
Value | Summary |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
Table 54.232. JSON Formatter
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 54.233. Shell Formatter
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
Table 54.234. Table Formatter
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit 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. |
54.59. network segment delete
Delete network segment(s)
Usage:
openstack network segment delete [-h] <network-segment> [<network-segment> ...]
Table 54.235. Positional Arguments
Value | Summary |
---|---|
<network-segment> | Network segment(s) to delete (name or id) |
Table 54.236. Optional Arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
54.60. network segment list
List network segments
Usage:
openstack network segment list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--long] [--network <network>]
Table 54.237. Optional Arguments
Value | Summary |
---|---|
-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) |
Table 54.238. Output Formatters
Value | Summary |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
--sort-column SORT_COLUMN | Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated |
Table 54.239. CSV Formatter
Value | Summary |
---|---|
--quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
Table 54.240. JSON Formatter
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 54.241. Table Formatter
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit 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. |
54.61. network segment range create
Create new network segment range
Usage:
openstack network segment range create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--private | --shared] [--project <project>] [--project-domain <project-domain>] --network-type <network-type> [--physical-network <physical-network-name>] --minimum <minimum-segmentation-id> --maximum <maximum-segmentation-id> <name>
Table 54.242. Positional Arguments
Value | Summary |
---|---|
<name> | Name of new network segment range |
Table 54.243. Optional Arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
--private | Network segment range is assigned specifically to the project |
--shared | Network segment range is shared with other projects |
--project <project> | Network segment range owner (name or id). optional when the segment range is shared |
--project-domain <project-domain> | Domain the project belongs to (name or id). this can be used in case collisions between project names exist. |
--network-type <network-type> | Network type of this network segment range (geneve, gre, vlan or vxlan) |
--physical-network <physical-network-name> | Physical network name of this network segment range |
--minimum <minimum-segmentation-id> | Minimum segment identifier for this network segment range which is based on the network type, VLAN ID for vlan network type and tunnel ID for geneve, gre and vxlan network types |
--maximum <maximum-segmentation-id> | Maximum segment identifier for this network segment range which is based on the network type, VLAN ID for vlan network type and tunnel ID for geneve, gre and vxlan network types |
Table 54.244. Output Formatters
Value | Summary |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
Table 54.245. JSON Formatter
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 54.246. Shell Formatter
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
Table 54.247. Table Formatter
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit 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. |
54.62. network segment range delete
Delete network segment range(s)
Usage:
openstack network segment range delete [-h] <network-segment-range> [<network-segment-range> ...]
Table 54.248. Positional Arguments
Value | Summary |
---|---|
<network-segment-range> | Network segment range(s) to delete (name or id) |
Table 54.249. Optional Arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
54.63. network segment range list
List network segment ranges
Usage:
openstack network segment range list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--long] [--used | --unused] [--available | --unavailable]
Table 54.250. Optional Arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
--long | List additional fields in output |
--used | List network segment ranges that have segments in use |
--unused | List network segment ranges that have segments not in use |
--available | List network segment ranges that have available segments |
--unavailable | List network segment ranges without available segments |
Table 54.251. Output Formatters
Value | Summary |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
--sort-column SORT_COLUMN | Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated |
Table 54.252. CSV Formatter
Value | Summary |
---|---|
--quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
Table 54.253. JSON Formatter
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 54.254. Table Formatter
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit 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. |
54.64. network segment range set
Set network segment range properties
Usage:
openstack network segment range set [-h] [--name <name>] [--minimum <minimum-segmentation-id>] [--maximum <maximum-segmentation-id>] <network-segment-range>
Table 54.255. Positional Arguments
Value | Summary |
---|---|
<network-segment-range> | Network segment range to modify (name or id) |
Table 54.256. Optional Arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
--name <name> | Set network segment name |
--minimum <minimum-segmentation-id> | Set network segment range minimum segment identifier |
--maximum <maximum-segmentation-id> | Set network segment range maximum segment identifier |
54.65. network segment range show
Display network segment range details
Usage:
openstack network segment range show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <network-segment-range>
Table 54.257. Positional Arguments
Value | Summary |
---|---|
<network-segment-range> | Network segment range to display (name or id) |
Table 54.258. Optional Arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
Table 54.259. Output Formatters
Value | Summary |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
Table 54.260. JSON Formatter
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 54.261. Shell Formatter
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
Table 54.262. Table Formatter
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit 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. |
54.66. network segment set
Set network segment properties
Usage:
openstack network segment set [-h] [--description <description>] [--name <name>] <network-segment>
Table 54.263. Positional Arguments
Value | Summary |
---|---|
<network-segment> | Network segment to modify (name or id) |
Table 54.264. Optional Arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
--description <description> | Set network segment description |
--name <name> | Set network segment name |
54.67. network segment show
Display network segment details
Usage:
openstack network segment show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <network-segment>
Table 54.265. Positional Arguments
Value | Summary |
---|---|
<network-segment> | Network segment to display (name or id) |
Table 54.266. Optional Arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
Table 54.267. Output Formatters
Value | Summary |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
Table 54.268. JSON Formatter
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 54.269. Shell Formatter
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
Table 54.270. Table Formatter
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit 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. |
54.68. network service provider list
List Service Providers
Usage:
openstack network service provider list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN]
Table 54.271. Optional Arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
Table 54.272. Output Formatters
Value | Summary |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
--sort-column SORT_COLUMN | Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated |
Table 54.273. CSV Formatter
Value | Summary |
---|---|
--quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
Table 54.274. JSON Formatter
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 54.275. Table Formatter
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit 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. |
54.69. network set
Set network properties
Usage:
openstack network set [-h] [--name <name>] [--enable | --disable] [--share | --no-share] [--description <description] [--mtu <mtu] [--enable-port-security | --disable-port-security] [--external | --internal] [--default | --no-default] [--qos-policy <qos-policy> | --no-qos-policy] [--tag <tag>] [--no-tag] [--provider-network-type <provider-network-type>] [--provider-physical-network <provider-physical-network>] [--provider-segment <provider-segment>] [--dns-domain <dns-domain>] <network>
Table 54.276. Positional Arguments
Value | Summary |
---|---|
<network> | Network to modify (name or id) |
Table 54.277. Optional Arguments
Value | Summary |
---|---|
-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 |
--dns-domain <dns-domain> | Set dns domain for this network (requires dns integration extension) |
54.70. network show
Show network details
Usage:
openstack network show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <network>
Table 54.278. Positional Arguments
Value | Summary |
---|---|
<network> | Network to display (name or id) |
Table 54.279. Optional Arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
Table 54.280. Output Formatters
Value | Summary |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
Table 54.281. JSON Formatter
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 54.282. Shell Formatter
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
Table 54.283. Table Formatter
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit 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. |
54.71. network subport list
List all subports for a given network trunk
Usage:
openstack network subport list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] --trunk <trunk>
Table 54.284. Optional Arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
--trunk <trunk> | List subports belonging to this trunk (name or id) |
Table 54.285. Output Formatters
Value | Summary |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
--sort-column SORT_COLUMN | Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated |
Table 54.286. CSV Formatter
Value | Summary |
---|---|
--quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
Table 54.287. JSON Formatter
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 54.288. Table Formatter
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit 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. |
54.72. network trunk create
Create a network trunk for a given project
Usage:
openstack network trunk create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--description <description>] --parent-port <parent-port> [--subport <port=,segmentation-type=,segmentation-id=>] [--enable | --disable] [--project <project>] [--project-domain <project-domain>] <name>
Table 54.289. Positional Arguments
Value | Summary |
---|---|
<name> | Name of the trunk to create |
Table 54.290. Optional Arguments
Value | Summary |
---|---|
-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. |
Table 54.291. Output Formatters
Value | Summary |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
Table 54.292. JSON Formatter
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 54.293. Shell Formatter
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
Table 54.294. Table Formatter
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit 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. |
54.73. network trunk delete
Delete a given network trunk
Usage:
openstack network trunk delete [-h] <trunk> [<trunk> ...]
Table 54.295. Positional Arguments
Value | Summary |
---|---|
<trunk> | Trunk(s) to delete (name or id) |
Table 54.296. Optional Arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
54.74. network trunk list
List all network trunks
Usage:
openstack network trunk list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--long]
Table 54.297. Optional Arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
--long | List additional fields in output |
Table 54.298. Output Formatters
Value | Summary |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
--sort-column SORT_COLUMN | Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated |
Table 54.299. CSV Formatter
Value | Summary |
---|---|
--quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
Table 54.300. JSON Formatter
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 54.301. Table Formatter
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit 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. |
54.75. network trunk set
Set network trunk properties
Usage:
openstack network trunk set [-h] [--name <name>] [--description <description>] [--subport <port=,segmentation-type=,segmentation-id=>] [--enable | --disable] <trunk>
Table 54.302. Positional Arguments
Value | Summary |
---|---|
<trunk> | Trunk to modify (name or id) |
Table 54.303. Optional Arguments
Value | Summary |
---|---|
-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 |
54.76. network trunk show
Show information of a given network trunk
Usage:
openstack network trunk show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <trunk>
Table 54.304. Positional Arguments
Value | Summary |
---|---|
<trunk> | Trunk to display (name or id) |
Table 54.305. Optional Arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
Table 54.306. Output Formatters
Value | Summary |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
Table 54.307. JSON Formatter
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 54.308. Shell Formatter
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
Table 54.309. Table Formatter
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit 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. |
54.77. network trunk unset
Unset subports from a given network trunk
Usage:
openstack network trunk unset [-h] --subport <subport> <trunk>
Table 54.310. Positional Arguments
Value | Summary |
---|---|
<trunk> | Unset subports from this trunk (name or id) |
Table 54.311. Optional Arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
--subport <subport> | Subport to delete (name or id of the port) (--subport) option can be repeated |
54.78. network unset
Unset network properties
Usage:
openstack network unset [-h] [--tag <tag> | --all-tag] <network>
Table 54.312. Positional Arguments
Value | Summary |
---|---|
<network> | Network to modify (name or id) |
Table 54.313. Optional Arguments
Value | Summary |
---|---|
-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 |