A router is a logical component that forwards data packets between networks. It also provides Layer 3 and NAT forwarding to provide external network access for servers on project networks.
Network v2
Add a port to a router
os router add port
<router>
<port>
Router to which port will be added (name or ID)
Port to be added (name or ID)
Add a subnet to a router
os router add subnet
<router>
<subnet>
Router to which subnet will be added (name or ID)
Subnet to be added (name or ID)
Create new router
os router create
[--project <project> [--project-domain <project-domain>]]
[--enable | --disable]
[--distributed]
[--ha]
[--description <description>]
[--availability-zone-hint <availability-zone>]
<name>
Owner’s project (name or ID)
Domain the project belongs to (name or ID). This can be used in case collisions between project names exist.
Enable router (default)
Disable router
Create a distributed router
Create a highly available router
Set router description
Availability Zone in which to create this router (Router Availability Zone extension required, repeat option to set multiple availability zones)
New router name
Delete router(s)
os router delete
<router> [<router> ...]
Router(s) to delete (name or ID)
List routers
os router list
[--name <name>]
[--enable | --disable]
[--long]
List additional fields in output
List routers according to their name
List enabled routers
List disabled routers
Remove a port from a router
os router remove port
<router>
<port>
Router from which port will be removed (name or ID)
Port to be removed and deleted (name or ID)
Remove a subnet from a router
os router remove subnet
<router>
<subnet>
Router from which subnet will be removed (name or ID)
Subnet to be removed (name or ID)
Set router properties
os router set
[--name <name>]
[--enable | --disable]
[--distributed | --centralized]
[--description <description>]
[--route destination=<subnet>,gateway=<ip-address> | --no-route]
[--ha | --no-ha]
<router>
Set router name
Enable router
Disable router
Set router to distributed mode (disabled router only)
Set router to centralized mode (disabled router only)
Set router description
Routes associated with the router destination: destination subnet (in CIDR notation) gateway: nexthop IP address (repeat option to set multiple routes)
Clear routes associated with the router
Set the router as highly available (disabled router only)
Clear high availablability attribute of the router (disabled router only)
Router to modify (name or ID)
Unset router properties
os router unset
[--route destination=<subnet>,gateway=<ip-address>]
<router>
Routes to be removed from the router destination: destination subnet (in CIDR notation) gateway: nexthop IP address (repeat option to unset multiple routes)
Router to modify (name or ID)