Chapter 67. router

<router>

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

<port>

Port to be added (name or id)

-h, --help

Show this help message and exit

<router>

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

<subnet>

Subnet to be added (name or id)

-h, --help

Show this help message and exit

<name>

New router name

-h, --help

Show this help message and exit

--enable

Enable router (default)

--disable

Disable router

--distributed

Create a distributed router

--centralized

Create a centralized router

--ha

Create a highly available router

--no-ha

Create a legacy router

--description <description>

Set router description

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

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

--tag <tag>

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

--no-tag

No tags associated with the router

-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

--noindent

Whether to disable indenting the json

--prefix PREFIX

Add a prefix to all variable names

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

<router>

Router(s) to delete (name or id)

-h, --help

Show this help message and exit

-h, --help

Show this help message and exit

--name <name>

List routers according to their name

--enable

List enabled routers

--disable

List disabled routers

--long

List additional fields in output

--project <project>

List routers 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.

--agent <agent-id>

List routers hosted by an agent (id only)

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

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

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

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

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

-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

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

When to include quotes, defaults to nonnumeric

--noindent

Whether to disable indenting the json

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

<router>

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

<port>

Port to be removed and deleted (name or id)

-h, --help

Show this help message and exit

<router>

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

<subnet>

Subnet to be removed (name or id)

-h, --help

Show this help message and exit

<router>

Router to modify (name or id)

-h, --help

Show this help message and exit

--name <name>

Set router name

--description <description>

Set router description

--enable

Enable router

--disable

Disable router

--distributed

Set router to distributed mode (disabled router only)

--centralized

Set router to centralized 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-route

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

--ha

Set the router as highly available (disabled router only)

--no-ha

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

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

--enable-snat

Enable source nat on external gateway

--disable-snat

Disable source nat on external gateway

--qos-policy <qos-policy>

Attach qos policy to router gateway ips

--no-qos-policy

Remove qos policy from router gateway ips

--tag <tag>

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

--no-tag

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

<router>

Router to display (name or id)

-h, --help

Show this help message and exit

-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

--noindent

Whether to disable indenting the json

--prefix PREFIX

Add a prefix to all variable names

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

<router>

Router to modify (name or id)

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

--external-gateway

Remove external gateway information from the router

--qos-policy

Remove qos policy from router gateway ips

--tag <tag>

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

--all-tag

Clear all tags associated with the router