router¶

一个 router（路由器）是一个在网络之间转发数据包的逻辑组件。它还提供第 3 层和 NAT 转发，为项目网络上的服务器提供外部网络访问。

Network v2

router add gateway¶

添加路由器网关

openstack router add gateway
    [--fixed-ip subnet=<subnet>,ip-address=<ip-address>]
    <router>
    <network>

--fixed-ip subnet=<subnet>,ip-address=<ip-address>¶: 外部网关上的所需 IP 地址和/或子网：subnet=<subnet>,ip-address=<ip-address>（重复该选项以设置多个固定 IP 地址）

router¶: 要修改的路由器（名称或 ID）

network¶: 要附加路由器网关的外部网络（名称或 ID）

router add port¶

将端口添加到路由器

openstack router add port <router> <port>

router¶: 将添加端口的路由器（名称或 ID）

port¶: 要添加的端口（名称或 ID）

router add route¶

将额外的静态路由添加到路由器的路由表中。

openstack router add route
    [--route destination=<subnet>,gateway=<ip-address>]
    <router>

--route destination=<subnet>,gateway=<ip-address>¶: 将额外的静态路由添加到路由器。destination：目标子网（以 CIDR 表示法），gateway：下一跳 IP 地址。重复该选项以添加多个路由。尝试添加已存在于路由表中的路由（完全相同，包括目标地址和下一跳）是被允许的，并且被视为成功的操作。

router¶: 将添加额外静态路由的路由器（名称或 ID）

router add subnet¶

将子网添加到路由器

openstack router add subnet <router> <subnet>

router¶: 将添加子网的路由器（名称或 ID）

subnet¶: 要添加的子网（名称或 ID）

router create¶

创建一个新的路由器

openstack router create
    [--extra-property type=<property_type>,name=<property_name>,value=<property_value>]
    [--enable | --disable]
    [--distributed | --centralized]
    [--ha | --no-ha]
    [--description <description>]
    [--project <project>]
    [--project-domain <project-domain>]
    [--availability-zone-hint <availability-zone>]
    [--tag <tag> | --no-tag]
    [--external-gateway <network>]
    [--fixed-ip subnet=<subnet>,ip-address=<ip-address>]
    [--enable-snat | --disable-snat]
    [--enable-ndp-proxy | --disable-ndp-proxy]
    [--flavor <flavor-id>]
    [--enable-default-route-bfd]
    [--disable-default-route-bfd]
    [--enable-default-route-ecmp]
    [--disable-default-route-ecmp]
    [--qos-policy <qos-policy>]
    <name>

--extra-property type=<property_type>,name=<property_name>,value=<property_value>¶: 可以使用此属性传递额外的参数。额外属性的默认类型是字符串（‘str’），但也可以使用其他类型。可用类型包括：‘dict’、‘list’、‘str’、‘bool’、‘int’。对于 ‘list’ 类型，‘value’ 可以是分号分隔的值列表。对于 ‘dict’ 类型，value 是分号分隔的键值对列表。

--enable¶: 启用路由器（默认）

--disable¶: 禁用路由器

--distributed¶: 创建一个分布式路由器

--centralized¶: 创建一个集中式路由器

--ha¶: 创建一个高可用性路由器

--no-ha¶: 创建一个遗留路由器

--description <description>¶: 设置路由器描述

--project <project>¶: 所有者的项目（名称或 ID）

--project-domain <project-domain>¶: 项目所属的域（名称或 ID）。如果项目名称之间存在冲突，可以使用此选项。

--availability-zone-hint <availability-zone>¶: 要在其中创建此路由器的可用区（需要路由器可用区扩展，重复该选项以设置多个可用区）

--tag <tag>¶: 要添加到路由器的标签（重复该选项以设置多个标签）

--no-tag¶: 路由器没有关联的标签

--external-gateway <network>¶: 用作路由器网关的外部网络（名称或 ID）（如果正在使用的 L3 服务插件支持，则重复该选项以设置每个路由器的多个网关）

--fixed-ip subnet=<subnet>,ip-address=<ip-address>¶: 外部网关上的所需 IP 地址和/或子网：subnet=<subnet>,ip-address=<ip-address>（重复该选项以设置多个固定 IP 地址）

--enable-snat¶: 启用外部网关上的源 NAT

--disable-snat¶: 禁用外部网关上的源 NAT

--enable-ndp-proxy¶: 启用外部网关上的 IPv6 NDP 代理

--disable-ndp-proxy¶: 禁用外部网关上的 IPv6 NDP 代理

--flavor <flavor-id>¶: 将路由器关联到 flavor（按名称或 ID）

--enable-default-route-bfd¶: 为从外部网关端口子网推断的默认路由启用 BFD 会话

--disable-default-route-bfd¶: 禁用从外部网关端口子网推断的默认路由的 BFD 会话

--enable-default-route-ecmp¶: 如果通过不同的网关端口有多个可用，则添加 ECMP 默认路由

--disable-default-route-ecmp¶: 仅为第一个网关端口添加默认路由

--qos-policy <qos-policy>¶: 将 QoS 策略附加到路由器网关 IP

name¶: 新的路由器名称

router delete¶

删除路由器

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

router¶: 要删除的路由器（名称或 ID）

router list¶

列出路由器

openstack router list
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [--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>,...]]

--sort-column SORT_COLUMN¶: 指定要对数据进行排序的列（首先指定的列具有优先级，不存在的列将被忽略），可以重复

--sort-ascending¶: 按升序对列进行排序

--sort-descending¶: 按降序对列进行排序

--name <name>¶: 根据名称列出路由器

--enable¶: 列出启用的路由器

--disable¶: 列出禁用的路由器

--long¶: 在输出中列出附加字段

--project <project>¶: 根据项目（名称或 ID）列出路由器

--project-domain <project-domain>¶: 项目所属的域（名称或 ID）。如果项目名称之间存在冲突，可以使用此选项。

--agent <agent-id>¶: 列出由代理（仅 ID）托管的路由器

--tags <tag>[,<tag>,...]¶: 列出具有所有给定标签的路由器（逗号分隔的标签列表）

--any-tags <tag>[,<tag>,...]¶: 列出具有任何给定标签的路由器（逗号分隔的标签列表）

--not-tags <tag>[,<tag>,...]¶: 排除具有所有给定标签的路由器（逗号分隔的标签列表）

--not-any-tags <tag>[,<tag>,...]¶: 排除具有任何给定标签的路由器（逗号分隔的标签列表）

router ndp proxy create¶

创建 NDP 代理

openstack router ndp proxy create
    [--name <name>]
    --port <port>
    [--ip-address <ip-address>]
    [--description <description>]
    <router>

--name <name>¶: 新的 NDP 代理名称

--port <port>¶: 与 NDP 代理关联的网络端口的名称或 ID

--ip-address <ip-address>¶: 要代理的 IPv6 地址。如果端口分配了多个地址，请使用此选项选择要使用的地址。

--description <description>¶: 用于描述/关联 NDP 代理配置的文本

router¶: 路由器的名称或 ID

router ndp proxy delete¶

删除 NDP 代理

openstack router ndp proxy delete <ndp-proxy> [<ndp-proxy> ...]

ndp-proxy¶: 要删除的 NDP 代理（名称或 ID）

router ndp proxy list¶

列出 NDP 代理

openstack router ndp proxy list
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [--router <router>]
    [--port <port>]
    [--ip-address <ip-address>]
    [--project <project>]
    [--name <name>]
    [--project-domain <project-domain>]

--sort-column SORT_COLUMN¶: 指定要对数据进行排序的列（首先指定的列具有优先级，不存在的列将被忽略），可以重复

--sort-ascending¶: 按升序对列进行排序

--sort-descending¶: 按降序对列进行排序

--router <router>¶: 仅列出属于此路由器的 NDP 代理（名称或 ID）

--port <port>¶: 仅列出与此端口关联的 NDP 代理（名称或 ID）

--ip-address <ip-address>¶: 仅列出与此 IPv6 地址关联的 NDP 代理

--project <project>¶: 仅列出给定项目的 NDP 代理（名称或 ID）

--name <name>¶: 仅列出给定名称的 NDP 代理

--project-domain <project-domain>¶: 项目所属的域（名称或 ID）。如果项目名称之间存在冲突，可以使用此选项。

路由器 ndp 代理设置¶

设置 NDP 代理属性

openstack router ndp proxy set
    [--name <name>]
    [--description <description>]
    <ndp-proxy>

--name <name>¶: 设置 NDP 代理名称

--description <description>¶: 用于描述/关联 NDP 代理配置的文本

ndp-proxy¶: 要更新的 NDP 代理的 ID 或名称

路由器 ndp 代理显示¶

显示 NDP 代理详细信息

openstack router ndp proxy show <ndp-proxy>

ndp-proxy¶: NDP 代理的 ID 或名称

路由器移除网关¶

移除路由器网关

openstack router remove gateway
    [--fixed-ip subnet=<subnet>,ip-address=<ip-address>]
    <router>
    <network>

--fixed-ip subnet=<subnet>,ip-address=<ip-address>¶: 用于标识特定网关（如果多个网关连接到同一网络）的外部网关上的 IP 地址和/或子网：subnet=<subnet>,ip-address=<ip-address>

router¶: 要修改的路由器（名称或 ID）。

network¶: 要移除路由器网关的外部网络（名称或 ID）

路由器移除端口¶

从路由器移除端口

openstack router remove port <router> <port>

router¶: 要移除端口的路由器（名称或 ID）

port¶: 要移除和删除的端口（名称或 ID）

路由器移除路由¶

移除路由器路由表中的额外静态路由。

openstack router remove route
    [--route destination=<subnet>,gateway=<ip-address>]
    <router>

--route destination=<subnet>,gateway=<ip-address>¶: 从路由器移除额外的静态路由。 destination：目标子网（以 CIDR 表示法），gateway：下一跳 IP 地址。重复该选项以移除多个路由。尝试移除路由表已经缺失（包括目标和下一跳）的路由是被允许的，并被视为成功的操作。

router¶: 要移除额外静态路由的路由器（名称或 ID）

路由器移除子网¶

从路由器移除子网

openstack router remove subnet <router> <subnet>

router¶: 要移除子网的路由器（名称或 ID）

subnet¶: 要移除的子网（名称或 ID）

路由器设置¶

设置路由器属性

openstack router set
    [--extra-property type=<property_type>,name=<property_name>,value=<property_value>]
    [--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]
    [--enable-ndp-proxy | --disable-ndp-proxy]
    [--qos-policy <qos-policy> | --no-qos-policy]
    [--tag <tag>]
    [--no-tag]
    [--enable-default-route-bfd]
    [--disable-default-route-bfd]
    [--enable-default-route-ecmp]
    [--disable-default-route-ecmp]
    <router>

--extra-property type=<property_type>,name=<property_name>,value=<property_value>¶: 可以使用此属性传递额外的参数。额外属性的默认类型是字符串（‘str’），但也可以使用其他类型。可用类型包括：‘dict’、‘list’、‘str’、‘bool’、‘int’。对于 ‘list’ 类型，‘value’ 可以是分号分隔的值列表。对于 ‘dict’ 类型，value 是分号分隔的键值对列表。

--name <name>¶: 设置路由器名称

--description <description>¶: 设置路由器描述

--enable¶: 启用路由器

--disable¶: 禁用路由器

--distributed¶: 将路由器设置为分布式模式（仅禁用路由器）

--centralized¶: 将路由器设置为集中式模式（仅禁用路由器）

--route destination=<subnet>,gateway=<ip-address>¶: 向路由器添加路由。 destination：目标子网（以 CIDR 表示法） gateway：下一跳 IP 地址（重复该选项以添加多个路由）。由于在不与 –no-route 一起使用时容易出现并发客户端之间的竞争条件，因此不推荐使用此方法，而推荐使用 ‘router add/remove route’。

--no-route¶: 清除与路由器关联的路由。同时指定 –route 和 –no-route 以覆盖 ‘routes’ 的当前值。

--ha¶: 将路由器设置为高可用性（仅禁用路由器）

--no-ha¶: 清除路由器的 HA 属性（仅禁用路由器）

--external-gateway <network>¶: 用作路由器网关的外部网络（名称或 ID）（如果使用的 L3 服务插件支持，则重复该选项以设置路由器上的多个网关）。

--fixed-ip subnet=<subnet>,ip-address=<ip-address>¶: 外部网关上的所需 IP 地址和/或子网：subnet=<subnet>,ip-address=<ip-address>（重复该选项以设置多个固定 IP 地址）

--enable-snat¶: 启用外部网关上的源 NAT

--disable-snat¶: 禁用外部网关上的源 NAT

--enable-ndp-proxy¶: 启用外部网关上的 IPv6 NDP 代理

--disable-ndp-proxy¶: 禁用外部网关上的 IPv6 NDP 代理

--qos-policy <qos-policy>¶: 将 QoS 策略附加到路由器网关 IP

--no-qos-policy¶: 移除路由器网关 IP 上的 QoS 策略

--tag <tag>¶: 要添加到路由器的标签（重复该选项以设置多个标签）

--no-tag¶: 清除与路由器关联的标签。同时指定 –tag 和 –no-tag 以覆盖当前标签

--enable-default-route-bfd¶: 为从外部网关端口子网推断的默认路由启用 BFD 会话

--disable-default-route-bfd¶: 禁用从外部网关端口子网推断的默认路由的 BFD 会话

--enable-default-route-ecmp¶: 如果通过不同的网关端口有多个可用，则添加 ECMP 默认路由

--disable-default-route-ecmp¶: 仅为第一个网关端口添加默认路由

router¶: 要修改的路由器（名称或 ID）

路由器显示¶

显示路由器详细信息

openstack router show <router>

router¶: 要显示的路由器（名称或 ID）

路由器取消设置¶

取消设置路由器属性

openstack router unset
    [--extra-property type=<property_type>,name=<property_name>,value=<property_value>]
    [--route destination=<subnet>,gateway=<ip-address>]
    [--external-gateway]
    [--qos-policy]
    [--tag <tag> | --all-tag]
    <router>

--extra-property type=<property_type>,name=<property_name>,value=<property_value>¶: 可以使用此属性传递额外的参数。额外属性的默认类型是字符串（‘str’），但也可以使用其他类型。可用类型包括：‘dict’、‘list’、‘str’、‘bool’、‘int’。对于 ‘list’ 类型，‘value’ 可以是分号分隔的值列表。对于 ‘dict’ 类型，value 是分号分隔的键值对列表。

--route destination=<subnet>,gateway=<ip-address>¶: 要从路由器移除的路由。 destination：目标子网（以 CIDR 表示法） gateway：下一跳 IP 地址（重复该选项以取消设置多个路由）

--external-gateway¶: 从路由器移除外部网关信息

--qos-policy¶: 移除路由器网关 IP 上的 QoS 策略

--tag <tag>¶: 要从路由器移除的标签（重复该选项以移除多个标签）

--all-tag¶: 清除与路由器关联的所有标签

router¶: 要修改的路由器（名称或 ID）

router