Chapter 44. l2gw
This chapter describes the commands under the l2gw
command.
44.1. l2gw connection create
Create l2gateway-connection
Usage:
openstack l2gw connection create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--default-segmentation-id SEG_ID] <GATEWAY-NAME/UUID> <NETWORK-NAME/UUID>
Table 44.1. Positional arguments
Value | Summary |
---|---|
<GATEWAY-NAME/UUID> | Descriptive name for logical gateway. |
<NETWORK-NAME/UUID> | Network name or uuid. |
Table 44.2. Command arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
--default-segmentation-id SEG_ID | Default segmentation-id that will be applied to the interfaces for which segmentation id was not specified in l2-gateway-create command. |
Table 44.3. Output formatter options
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 44.4. JSON formatter options
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 44.5. Shell formatter options
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
Table 44.6. Table formatter options
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. |
44.2. l2gw connection delete
Delete a given l2gateway-connection
Usage:
openstack l2gw connection delete [-h] <L2_GATEWAY_CONNECTIONS> [<L2_GATEWAY_CONNECTIONS> ...]
Table 44.7. Positional arguments
Value | Summary |
---|---|
<L2_GATEWAY_CONNECTIONS> | Id(s) of l2_gateway_connections(s) to delete. |
Table 44.8. Command arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
44.3. l2gw connection list
List l2gateway-connections
Usage:
openstack l2gw connection 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>]
Table 44.9. Command 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. |
Table 44.10. Output formatter options
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 44.11. CSV formatter options
Value | Summary |
---|---|
--quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
Table 44.12. JSON formatter options
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 44.13. Table formatter options
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. |
44.4. l2gw connection show
Show information of a given l2gateway-connection
Usage:
openstack l2gw connection show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <L2_GATEWAY_CONNECTION>
Table 44.14. Positional arguments
Value | Summary |
---|---|
<L2_GATEWAY_CONNECTION> | Id of l2_gateway_connection to look up. |
Table 44.15. Command arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
Table 44.16. Output formatter options
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 44.17. JSON formatter options
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 44.18. Shell formatter options
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
Table 44.19. Table formatter options
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. |
44.5. l2gw create
Create l2gateway resource
Usage:
openstack l2gw 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>] [--device name=name,interface_names=INTERFACE-DETAILS] <GATEWAY-NAME>
Table 44.20. Positional arguments
Value | Summary |
---|---|
<GATEWAY-NAME> | Descriptive name for logical gateway. |
Table 44.21. Command 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. |
--device name=name,interface_names=INTERFACE-DETAILS | Device name and interface-names of l2gateway. INTERFACE-DETAILS is of form "<interface_name1>;[<inte rface_name2>][|<seg_id1>[#<seg_id2>]]" (--device option can be repeated) |
Table 44.22. Output formatter options
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 44.23. JSON formatter options
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 44.24. Shell formatter options
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
Table 44.25. Table formatter options
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. |
44.6. l2gw delete
Delete a given l2gateway
Usage:
openstack l2gw delete [-h] <L2_GATEWAY> [<L2_GATEWAY> ...]
Table 44.26. Positional arguments
Value | Summary |
---|---|
<L2_GATEWAY> | Id(s) or name(s) of l2_gateway to delete. |
Table 44.27. Command arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
44.7. l2gw list
List l2gateway that belongs to a given tenant
Usage:
openstack l2gw 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>]
Table 44.28. Command 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. |
Table 44.29. Output formatter options
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 44.30. CSV formatter options
Value | Summary |
---|---|
--quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
Table 44.31. JSON formatter options
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 44.32. Table formatter options
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. |
44.8. l2gw show
Show information of a given l2gateway
Usage:
openstack l2gw show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <L2_GATEWAY>
Table 44.33. Positional arguments
Value | Summary |
---|---|
<L2_GATEWAY> | Id or name of l2_gateway to look up. |
Table 44.34. Command arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
Table 44.35. Output formatter options
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 44.36. JSON formatter options
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 44.37. Shell formatter options
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
Table 44.38. Table formatter options
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. |
44.9. l2gw update
Update a given l2gateway
Usage:
openstack l2gw update [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--name name] [--device name=name,interface_names=INTERFACE-DETAILS] <L2_GATEWAY>
Table 44.39. Positional arguments
Value | Summary |
---|---|
<L2_GATEWAY> | Id or name of l2_gateway to update. |
Table 44.40. Command arguments
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
--name name | Descriptive name for logical gateway. |
--device name=name,interface_names=INTERFACE-DETAILS | Device name and interface-names of l2gateway. INTERFACE-DETAILS is of form "<interface_name1>;[<inte rface_name2>][|<seg_id1>[#<seg_id2>]]" (--device option can be repeated) |
Table 44.41. Output formatter options
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 44.42. JSON formatter options
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Table 44.43. Shell formatter options
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
Table 44.44. Table formatter options
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. |