openstack.cloud.router 模块 – 从 OpenStack 创建或删除路由器

注意

此模块是 openstack.cloud 集合（版本 2.3.0）的一部分。

如果您正在使用 ansible 包，则可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install openstack.cloud。您需要进一步的要求才能使用此模块，请参阅 要求 了解详细信息。

要在 playbook 中使用它，请指定：openstack.cloud.router。

概要

• 从 OpenStack 创建或删除路由器。虽然 Neutron 允许路由器共享相同的名称，但此模块强制名称唯一性，以便更方便用户使用。

要求

执行此模块的主机需要满足以下要求。

• python >= 3.6

• openstacksdk >= 1.0.0

参数

参数	注释
api_timeout 整数	套接字层在 API 调用超时之前应等待多长时间。如果省略此项，则不会将任何内容传递给 requests 库。
auth 字典	包含云的身份验证插件策略所需的身份验证信息的字典。对于默认的password插件，这将包含 auth_url、username、password、project_name 以及有关域的任何信息（例如，如果云支持，则为 user_domain_name 或 project_domain_name）。对于其他插件，此参数将需要包含该身份验证插件所需的任何参数。如果提供了命名云或存在 OpenStack OS_* 环境变量，则不需要此参数。
auth_type 字符串	要使用的身份验证插件的名称。如果云使用密码身份验证以外的其他方式，则应在此处指示插件的名称，并且应相应地更新auth参数的内容。
ca_cert 别名: cacert 字符串	CA 证书包的路径，可用作验证 SSL API 请求的一部分。
client_cert 别名: cert 字符串	用作 SSL 事务一部分的客户端证书的路径。
client_key 别名: key 字符串	用作 SSL 事务一部分的客户端密钥的路径。
cloud 任意	要操作的命名云或云配置。如果 cloud 是字符串，则它引用在 OpenStack clouds.yaml 文件中定义的命名云配置。为 auth 和 auth_type 提供默认值。如果提供了 auth 或存在 OpenStack OS_* 环境变量，则不需要此参数。如果 cloud 是字典，则它包含完整的云配置，就像 clouds.yaml 的一部分一样。
enable_snat 布尔值	启用源 NAT (SNAT) 属性。 选项 false true
external_fixed_ips 列表 / 元素=字典	外部网关网络的 IP 地址参数。每个都是一个字典，其中包含子网的名称或 ID (subnet) 以及要在子网上分配的 IP 地址 (ip_address)。如果未指定 IP，则会自动从该子网分配一个 IP。
ip_address 别名: ip 字符串	尝试分配的固定 IP 地址。
subnet_id 别名: subnet 字符串 / 必需	要将 IP 地址附加到的子网。
external_gateway_info 字典	有关路由器的外部网关的信息
enable_snat 布尔值	外部网关网络的唯一名称或 ID。 需要提供 interfaces 或 enable_snat。 选项 false true
external_fixed_ips 列表 / 元素=字典	外部网关网络的 IP 地址参数。每个都是一个字典，其中包含子网的名称或 ID (subnet) 以及要在子网上分配的 IP 地址 (ip_address)。如果未指定 IP，则会自动从该子网分配一个 IP。
ip_address 别名: ip 字符串	尝试分配的固定 IP 地址。
subnet_id 别名: subnet 字符串 / 必需	要将 IP 地址附加到的子网。
network 字符串	外部网关网络的唯一名称或 ID。 需要提供 interfaces 或 enable_snat。
interface 别名: endpoint_type 字符串	要从服务目录中获取的端点 URL 类型。 选项 "admin" "internal" "public" ←（默认）
interfaces 列表 / 元素=任意	要附加到路由器内部接口的子网列表。与子网关联的默认网关将自动附加到路由器的内部接口。为了提供与默认网关不同的 IP 地址，参数将作为字典传递，键为网络名称或 ID（net）、子网名称或 ID（subnet）以及来自网络的端口 IP（portip）。当需要将多个路由器连接到已使用默认网关的单个子网时，通常需要用户定义的 portip。
is_admin_state_up 别名: admin_state_up 布尔值	已创建或现有路由器的期望管理状态。 选项 false true ←（默认）
name 字符串 / 必需	要分配给路由器的名称。 此路由器属性无法更新。
network 字符串	外部网关网络的唯一名称或 ID。 如果提供了 external_fixed_ips 或 enable_snat，则为必需。 此路由器属性无法更新。
project 字符串	项目的唯一名称或 ID。 此路由器属性无法更新。
region_name 字符串	区域的名称。
sdk_log_level 字符串	OpenStackSDK 的日志级别 选项 "INFO" ←（默认） "DEBUG"
sdk_log_path 字符串	OpenStackSDK 的日志文件路径。如果为空，则不写入任何日志
state 字符串	指示资源的期望状态 选项 "present" ←（默认） "absent"
timeout 整数	Ansible 应该等待请求的资源多久。 默认值： 180
validate_certs 别名: verify 布尔值	是否应验证 SSL API 请求。 在 Ansible 2.3 之前，默认为 true。 选项 false true
wait 布尔值	Ansible 是否应等待直到请求的资源完成。 选项 false true ←（默认）

说明

注意

• 可以使用标准的 OpenStack 环境变量（例如 OS_USERNAME），而不是提供显式值。

• 身份验证信息由 openstacksdk 驱动，这意味着值可以来自 /etc/ansible/openstack.yaml、/etc/openstack/clouds.yaml 或 ~/.config/openstack/clouds.yaml 中的 YAML 配置文件，然后来自标准环境变量，最后来自剧本中的显式参数。有关更多信息，请访问 https://docs.openstack.org/openstacksdk/

示例

# Create a simple router, not attached to a gateway or subnets.
- openstack.cloud.router:
    cloud: mycloud
    state: present
    name: simple_router

# Create a router, not attached to a gateway or subnets for a given project.
- openstack.cloud.router:
    cloud: mycloud
    state: present
    name: simple_router
    project: myproj

# Creates a router attached to ext_network1 on an IPv4 subnet and with one
# internal subnet interface.
- openstack.cloud.router:
    cloud: mycloud
    state: present
    name: router1
    network: ext_network1
    external_fixed_ips:
      - subnet: public-subnet
        ip_address: 172.24.4.2
    interfaces:
      - private-subnet

# Create a router with two internal subnet interfaces and a user defined port
# ip and another with default gateway.
- openstack.cloud.router:
    cloud: mycloud
    state: present
    name: router2
    network: ext_network1
    interfaces:
      - net: private-net
        subnet: private-subnet
        portip: 10.1.1.10
      - project-subnet

# Create a router with two internal subnet interface. One with user defined
# port ip and and another with default gateway.
- openstack.cloud.router:
    cloud: mycloud
    state: present
    name: router2
    network: ext_network1
    interfaces:
      - net: private-net
        subnet: private-subnet
        portip: 10.1.1.10
      - project-subnet

# Create a router with two internal subnet interface. One with user defined
# port ip and and another  with default gateway.
- openstack.cloud.router:
    cloud: mycloud
    state: present
    name: router2
    network: ext_network1
    interfaces:
      - net: private-net
        subnet: private-subnet
        portip: 10.1.1.10
      - project-subnet

# Update existing router1 external gateway to include the IPv6 subnet.
# Note that since 'interfaces' is not provided, any existing internal
# interfaces on an existing router will be left intact.
- openstack.cloud.router:
    cloud: mycloud
    state: present
    name: router1
    network: ext_network1
    external_fixed_ips:
      - subnet: public-subnet
        ip_address: 172.24.4.2
      - subnet: ipv6-public-subnet
        ip_address: 2001:db8::3

# Delete router1
- openstack.cloud.router:
    cloud: mycloud
    state: absent
    name: router1

返回值

通用返回值记录在此处，以下是此模块独有的字段

键	描述
router 字典	描述路由器的字典。 返回值： 当 state 为 “present” 时成功返回
availability_zone_hints 列表 / 元素=字符串	可用区提示 返回值： 成功
availability_zones 列表 / 元素=字符串	可用区 返回值： 成功
created_at 字符串	路由器创建的日期和时间 返回值： 成功
description 字符串	路由器的描述备注 返回值： 成功
external_gateway_info 字典	路由器的外部网关信息。 返回值： 成功 示例： {"enable_snat": true, "external_fixed_ips": [{"ip_address": "10.6.6.99", "subnet_id": "4272cb52-a456-4c20-8f3c-c26024ecfa81"}]}
flavor_id 字符串	路由器规格的 ID 返回值： 成功
id 字符串	唯一 UUID。 返回值： 成功 示例： "474acfe5-be34-494c-b339-50f06aa143e4"
is_admin_state_up 布尔值	网络管理状态 返回值： 成功
is_distributed 布尔值	指示分布式路由器。 返回值： 成功
is_ha 布尔值	指示高可用路由器。 返回值： 成功
name 字符串	分配给路由器的名称。 返回值： 成功 示例： "router1"
project_id 字符串	与此路由器关联的项目 ID。 返回值： 成功
revision_number 整数	修订号 返回值： 成功
routes 列表 / 元素=字符串	L3 路由器的额外路由配置。 返回值： 成功
status 字符串	路由器状态。 返回值： 成功 示例： "ACTIVE"
tags 列表 / 元素=字符串	标签列表 返回值： 成功
tenant_id 字符串	所有者租户 ID 返回值： 成功
updated_at 字符串	上次更新路由器的时间 返回值： 成功

作者

• OpenStack Ansible SIG

集合链接

• 问题跟踪器
• 存储库（源代码）