Red Hat Summit Red Hat SummitSupportConsoleDevelopersStart a trialContact

Chapter 46. l2gw

This chapter describes the commands under the l2gw command.

46.1. l2gw connection create
Copy link

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

Expand
Table 46.1. Positional arguments
ValueSummary

<GATEWAY-NAME/UUID>

Descriptive name for logical gateway.

<NETWORK-NAME/UUID>

Network name or uuid.

Expand
Table 46.2. Command 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.

Expand
Table 46.3. Output formatter options
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 to show multiple columns

Expand
Table 46.4. JSON formatter options
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 46.5. Shell formatter options
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Expand
Table 46.6. Table formatter options
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
Copy link

Delete a given l2gateway-connection

Usage:

openstack l2gw connection delete [-h]
                                        <L2_GATEWAY_CONNECTIONS>
                                        [<L2_GATEWAY_CONNECTIONS> ...]
Copy to Clipboard Toggle word wrap

Expand
Table 46.7. Positional arguments
ValueSummary

<L2_GATEWAY_CONNECTIONS>

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

Expand
Table 46.8. Command arguments
ValueSummary

-h, --help

Show this help message and exit

46.3. l2gw connection list
Copy link

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]
                                      [--sort-ascending | --sort-descending]
                                      [--project <project>]
                                      [--project-domain <project-domain>]
Copy to Clipboard Toggle word wrap

Expand
Table 46.9. Command 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.

Expand
Table 46.10. Output formatter options
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 to show multiple columns

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

--sort-ascending

Sort the column(s) in ascending order

--sort-descending

Sort the column(s) in descending order

Expand
Table 46.11. CSV formatter options
ValueSummary

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

When to include quotes, defaults to nonnumeric

Expand
Table 46.12. JSON formatter options
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 46.13. Table formatter options
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
Copy link

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

Expand
Table 46.14. Positional arguments
ValueSummary

<L2_GATEWAY_CONNECTION>

Id of l2_gateway_connection to look up.

Expand
Table 46.15. Command arguments
ValueSummary

-h, --help

Show this help message and exit

Expand
Table 46.16. Output formatter options
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 to show multiple columns

Expand
Table 46.17. JSON formatter options
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 46.18. Shell formatter options
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Expand
Table 46.19. Table formatter options
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
Copy link

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

Expand
Table 46.20. Positional arguments
ValueSummary

<GATEWAY-NAME>

Descriptive name for logical gateway.

Expand
Table 46.21. Command 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>][|<seg_id1>[#<seg_id2>]]" (--device option can be repeated)

Expand
Table 46.22. Output formatter options
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 to show multiple columns

Expand
Table 46.23. JSON formatter options
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 46.24. Shell formatter options
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Expand
Table 46.25. Table formatter options
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
Copy link

Delete a given l2gateway

Usage:

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

Expand
Table 46.26. Positional arguments
ValueSummary

<L2_GATEWAY>

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

Expand
Table 46.27. Command arguments
ValueSummary

-h, --help

Show this help message and exit

46.7. l2gw list
Copy link

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]
                           [--sort-ascending | --sort-descending]
                           [--project <project>]
                           [--project-domain <project-domain>]
Copy to Clipboard Toggle word wrap

Expand
Table 46.28. Command 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.

Expand
Table 46.29. Output formatter options
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 to show multiple columns

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

--sort-ascending

Sort the column(s) in ascending order

--sort-descending

Sort the column(s) in descending order

Expand
Table 46.30. CSV formatter options
ValueSummary

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

When to include quotes, defaults to nonnumeric

Expand
Table 46.31. JSON formatter options
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 46.32. Table formatter options
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
Copy link

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

Expand
Table 46.33. Positional arguments
ValueSummary

<L2_GATEWAY>

Id or name of l2_gateway to look up.

Expand
Table 46.34. Command arguments
ValueSummary

-h, --help

Show this help message and exit

Expand
Table 46.35. Output formatter options
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 to show multiple columns

Expand
Table 46.36. JSON formatter options
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 46.37. Shell formatter options
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Expand
Table 46.38. Table formatter options
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
Copy link

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

Expand
Table 46.39. Positional arguments
ValueSummary

<L2_GATEWAY>

Id or name of l2_gateway to update.

Expand
Table 46.40. Command 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>][|<seg_id1>[#<seg_id2>]]" (--device option can be repeated)

Expand
Table 46.41. Output formatter options
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 to show multiple columns

Expand
Table 46.42. JSON formatter options
ValueSummary

--noindent

Whether to disable indenting the json

Expand
Table 46.43. Shell formatter options
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Expand
Table 46.44. Table formatter options
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.

Back to top
Red Hat logoGithubredditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust. Explore our recent updates.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

Theme

© 2025 Red Hat