Chapter 46. l2gw

This chapter describes the commands under the l2gw command.

46.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 46.1. Positional Arguments

ValueSummary

<GATEWAY-NAME/UUID>

Descriptive name for logical gateway.

<NETWORK-NAME/UUID>

Network name or uuid.

Table 46.2. Optional Arguments

ValueSummary

-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 46.3. Output Formatters

ValueSummary

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 46.4. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 46.5. Shell Formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 46.6. Table Formatter

ValueSummary

--max-width <integer>

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

--fit-width

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

--print-empty

Print empty table if there is no data to show.

46.2. l2gw connection delete

Delete a given l2gateway-connection

Usage:

openstack l2gw connection delete [-h]
                                        <L2_GATEWAY_CONNECTIONS>
                                        [<L2_GATEWAY_CONNECTIONS> ...]

Table 46.7. Positional Arguments

ValueSummary

<L2_GATEWAY_CONNECTIONS>

Id(s) of l2_gateway_connections(s) to delete.

Table 46.8. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

46.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 46.9. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--project <project>

Owner’s project (name or id)

--project-domain <project-domain>

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

Table 46.10. Output Formatters

ValueSummary

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 46.11. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 46.12. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 46.13. Table Formatter

ValueSummary

--max-width <integer>

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

--fit-width

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

--print-empty

Print empty table if there is no data to show.

46.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 46.14. Positional Arguments

ValueSummary

<L2_GATEWAY_CONNECTION>

Id of l2_gateway_connection to look up.

Table 46.15. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 46.16. Output Formatters

ValueSummary

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 46.17. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 46.18. Shell Formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 46.19. Table Formatter

ValueSummary

--max-width <integer>

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

--fit-width

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

--print-empty

Print empty table if there is no data to show.

46.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 46.20. Positional Arguments

ValueSummary

<GATEWAY-NAME>

Descriptive name for logical gateway.

Table 46.21. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--project <project>

Owner’s project (name or id)

--project-domain <project-domain>

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

--device name=name,interface_names=INTERFACE-DETAILS

Device name and interface-names of l2gateway. INTERFACE-DETAILS is of form "<interface_name1>;[<inte rface_name2>][

Table 46.22. Output Formatters

ValueSummary

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 46.23. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 46.24. Shell Formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 46.25. Table Formatter

ValueSummary

--max-width <integer>

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

--fit-width

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

--print-empty

Print empty table if there is no data to show.

46.6. l2gw delete

Delete a given l2gateway

Usage:

openstack l2gw delete [-h] <L2_GATEWAY> [<L2_GATEWAY> ...]

Table 46.26. Positional Arguments

ValueSummary

<L2_GATEWAY>

Id(s) or name(s) of l2_gateway to delete.

Table 46.27. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

46.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 46.28. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--project <project>

Owner’s project (name or id)

--project-domain <project-domain>

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

Table 46.29. Output Formatters

ValueSummary

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

Table 46.30. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 46.31. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 46.32. Table Formatter

ValueSummary

--max-width <integer>

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

--fit-width

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

--print-empty

Print empty table if there is no data to show.

46.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 46.33. Positional Arguments

ValueSummary

<L2_GATEWAY>

Id or name of l2_gateway to look up.

Table 46.34. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 46.35. Output Formatters

ValueSummary

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 46.36. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 46.37. Shell Formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 46.38. Table Formatter

ValueSummary

--max-width <integer>

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

--fit-width

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

--print-empty

Print empty table if there is no data to show.

46.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 46.39. Positional Arguments

ValueSummary

<L2_GATEWAY>

Id or name of l2_gateway to update.

Table 46.40. Optional Arguments

ValueSummary

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

Table 46.41. Output Formatters

ValueSummary

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

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

Table 46.42. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 46.43. Shell Formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 46.44. Table Formatter

ValueSummary

--max-width <integer>

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

--fit-width

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

--print-empty

Print empty table if there is no data to show.