Search

Chapter 54. router

download PDF

This chapter describes the commands under the router command.

54.1. router add port

Add a port to a router

Usage:

openstack router add port [-h] <router> <port>

Table 54.1. Positional Arguments
ValueSummary

<port>

Port to be added (name or id)

<router>

Router to which port will be added (name or id)

Table 54.2. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

54.2. router add subnet

Add a subnet to a router

Usage:

openstack router add subnet [-h] <router> <subnet>

Table 54.3. Positional Arguments
ValueSummary

<subnet>

Subnet to be added (name or id)

<router>

Router to which subnet will be added (name or id)

Table 54.4. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

54.3. router create

Create a new router

Usage:

openstack router create [-h] [-f {json,shell,table,value,yaml}]
                               [-c COLUMN] [--max-width <integer>]
                               [--fit-width] [--print-empty] [--noindent]
                               [--prefix PREFIX] [--enable | --disable]
                               [--distributed | --centralized]
                               [--ha | --no-ha] [--description <description>]
                               [--project <project>]
                               [--project-domain <project-domain>]
                               [--availability-zone-hint <availability-zone>]
                               [--tag <tag> | --no-tag]
                               <name>

Table 54.5. Table Formatter
ValueSummary

--print-empty

Print empty table if there is no data to show.

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

Table 54.6. Positional Arguments
ValueSummary

<name>

New router name

Table 54.7. Output Formatters
ValueSummary

output formatter options-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.8. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Table 54.9. Optional Arguments
ValueSummary

--availability-zone-hint <availability-zone>

Availability zone in which to create this router (Router Availability Zone extension required, repeat option to set multiple availability zones)

--description <description>

Set router description

--distributed

Create a distributed router

--ha

Create a highly available router

--no-tag

No tags associated with the router

--enable

Enable router (default)

--centralized

Create a centralized router

--project-domain <project-domain>

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

--no-ha

Create a legacy router

-h, --help

Show this help message and exit

--disable

Disable router

--project <project>

Owner’s project (name or id)

--tag <tag>

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

Table 54.10. Shell Formatter
ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

54.4. router delete

Delete router(s)

Usage:

openstack router delete [-h] <router> [<router> ...]

Table 54.11. Positional Arguments
ValueSummary

<router>

Router(s) to delete (name or id)

Table 54.12. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

54.5. router list

List routers

Usage:

openstack router list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
                             [--max-width <integer>] [--fit-width]
                             [--print-empty] [--noindent]
                             [--quote {all,minimal,none,nonnumeric}]
                             [--sort-column SORT_COLUMN] [--name <name>]
                             [--enable | --disable] [--long]
                             [--project <project>]
                             [--project-domain <project-domain>]
                             [--agent <agent-id>] [--tags <tag>[,<tag>,...]]
                             [--any-tags <tag>[,<tag>,...]]
                             [--not-tags <tag>[,<tag>,...]]
                             [--not-any-tags <tag>[,<tag>,...]]

Table 54.13. Table Formatter
ValueSummary

--print-empty

Print empty table if there is no data to show.

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

Table 54.14. CSV Formatter
ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 54.15. Output Formatters
ValueSummary

output formatter options-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.16. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Table 54.17. Optional Arguments
ValueSummary

--agent <agent-id>

List routers hosted by an agent (id only)

--enable

List enabled routers

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

Exclude routers which have any given tag(s) (comma- separated list of tags)

--name <name>

List routers according to their name

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

List routers which have all given tag(s) (comma- separated list of tags)

--long

List additional fields in output

--project-domain <project-domain>

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

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

List routers which have any given tag(s) (comma- separated list of tags)

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

Exclude routers which have all given tag(s) (comma- separated list of tags)

-h, --help

Show this help message and exit

--disable

List disabled routers

--project <project>

List routers according to their project (name or id)

54.6. router remove port

Remove a port from a router

Usage:

openstack router remove port [-h] <router> <port>

Table 54.18. Positional Arguments
ValueSummary

<port>

Port to be removed and deleted (name or id)

<router>

Router from which port will be removed (name or id)

Table 54.19. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

54.7. router remove subnet

Remove a subnet from a router

Usage:

openstack router remove subnet [-h] <router> <subnet>

Table 54.20. Positional Arguments
ValueSummary

<subnet>

Subnet to be removed (name or id)

<router>

Router from which the subnet will be removed (name or id)

Table 54.21. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

54.8. router set

Set router properties

Usage:

openstack router set [-h] [--name <name>] [--description <description>]
                            [--enable | --disable]
                            [--distributed | --centralized]
                            [--route destination=<subnet>,gateway=<ip-address>]
                            [--no-route] [--ha | --no-ha]
                            [--external-gateway <network>]
                            [--fixed-ip subnet=<subnet>,ip-address=<ip-address>]
                            [--enable-snat | --disable-snat] [--tag <tag>]
                            [--no-tag]
                            <router>

Table 54.22. Positional Arguments
ValueSummary

<router>

Router to modify (name or id)

Table 54.23. Optional Arguments
ValueSummary

--description <description>

Set router description

--distributed

Set router to distributed mode (disabled router only)

--route destination=<subnet>,gateway=<ip-address>

Routes associated with the router destination: destination subnet (in CIDR notation) gateway: nexthop IP address (repeat option to set multiple routes)

--no-ha

Clear high availability attribute of the router (disabled router only)

--enable

Enable router

--no-tag

Clear tags associated with the router. specify both --tag and --no-tag to overwrite current tags

--name <name>

Set router name

--ha

Set the router as highly available (disabled router only)

--tag <tag>

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

--centralized

Set router to centralized mode (disabled router only)

--disable-snat

Disable source nat on external gateway

--external-gateway <network>

External network used as router’s gateway (name or id)

--fixed-ip subnet=<subnet>,ip-address=<ip-address>

Desired ip and/or subnet (name or id)on external gateway: subnet=<subnet>,ip-address=<ip-address> (repeat option to set multiple fixed IP addresses)

--no-route

Clear routes associated with the router. specify both --route and --no-route to overwrite current value of route.

-h, --help

Show this help message and exit

--disable

Disable router

--enable-snat

Enable source nat on external gateway

54.9. router show

Display router details

Usage:

openstack router show [-h] [-f {json,shell,table,value,yaml}]
                             [-c COLUMN] [--max-width <integer>] [--fit-width]
                             [--print-empty] [--noindent] [--prefix PREFIX]
                             <router>

Table 54.24. Table Formatter
ValueSummary

--print-empty

Print empty table if there is no data to show.

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

Table 54.25. Positional Arguments
ValueSummary

<router>

Router to display (name or id)

Table 54.26. Output Formatters
ValueSummary

output formatter options-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.27. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Table 54.28. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

Table 54.29. Shell Formatter
ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

54.10. router unset

Unset router properties

Usage:

openstack router unset [-h]
                              [--route destination=<subnet>,gateway=<ip-address>]
                              [--external-gateway] [--tag <tag> | --all-tag]
                              <router>

Table 54.30. Positional Arguments
ValueSummary

<router>

Router to modify (name or id)

Table 54.31. Optional Arguments
ValueSummary

--external-gateway

Remove external gateway information from the router

--all-tag

Clear all tags associated with the router

-h, --help

Show this help message and exit

--route destination=<subnet>,gateway=<ip-address>

Routes to be removed from the router destination: destination subnet (in CIDR notation) gateway: nexthop IP address (repeat option to unset multiple routes)

--tag <tag>

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

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.

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.

© 2024 Red Hat, Inc.