openstack.cloud.subnets_info 模块 – 获取一个或多个 OpenStack 子网的信息。

注意

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

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

要安装它，请使用： ansible-galaxy collection install openstack.cloud。您需要其他需求才能使用此模块，有关详细信息，请参阅需求。

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

概要 

从 OpenStack 获取一个或多个子网的信息。

需求 

在执行此模块的主机上需要以下需求。

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 的一部分一样。
filters 字典	用于进一步过滤的元数据字典。此字典的元素可能是其他字典。
interface 别名：endpoint_type 字符串	从服务目录中获取的端点 URL 类型。选项 `"admin"` `"internal"` `"public"` ← (默认)
name 别名：subnet 字符串	子网的名称或 ID。在 2.8 版本中添加了别名“subnet”。
region_name 字符串	区域的名称。
sdk_log_level 字符串	OpenStackSDK 的日志级别选项 `"INFO"` ← (默认) `"DEBUG"`
sdk_log_path 字符串	OpenStackSDK 日志文件的路径。如果为空，则不写入日志
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 配置文件，然后来自标准环境变量，最后来自 playbook 中的显式参数。更多信息可在 https://docs.openstack.org/openstacksdk/ 找到

示例 

- name: Gather information about previously created subnets
  openstack.cloud.subnets_info:
    auth:
      auth_url: https://identity.example.com
      username: user
      password: password
      project_name: someproject
  register: result

- name: Show openstack subnets
  debug:
    msg: "{{ result.subnets }}"

- name: Gather information about a previously created subnet by name
  openstack.cloud.subnets_info:
    auth:
      auth_url: https://identity.example.com
      username: user
      password: password
      project_name: someproject
    name: subnet1
  register: result

- name: Show openstack subnets
  debug:
    msg: "{{ result.subnets }}"

- name: Gather information about a previously created subnet with filter
  # Note: name and filters parameters are not mutually exclusive
  openstack.cloud.subnets_info:
    auth:
      auth_url: https://identity.example.com
      username: user
      password: password
      project_name: someproject
    filters:
      project_id: 55e2ce24b2a245b09f181bf025724cbe
  register: result

- name: Show openstack subnets
  debug:
    msg: "{{ result.subnets }}"

返回值 

常见的返回值已在此处记录，以下是此模块特有的字段：

键	描述
子网列表 / 元素=字典	包含关于子网的所有 OpenStack 信息。返回值：始终返回，但可能是空列表。
分配池列表 / 元素=字典	与该子网关联的分配池。返回值：成功
CIDR 字符串	子网的 CIDR。返回值：成功
创建时间字符串	资源创建的日期和时间。返回值：成功
描述字符串	子网的描述。返回值：成功
DNS 服务器列表 / 元素=字符串	此子网的 DNS 域名服务器。返回值：成功
是否发布固定IP的DNS记录字符串	是否为此子网发布 IP 的 DNS 记录。返回值：成功
网关 IP 字符串	子网的网关 IP。返回值：成功
主机路由列表 / 元素=字典	子网的附加路由。返回值：成功
ID 字符串	子网的 ID。返回值：成功
IP 版本整数	此子网的 IP 版本。返回值：成功
IPv6 地址模式字符串	IPv6 地址模式指定分配 IP 地址的机制。返回值：成功
IPv6 路由器通告模式字符串	IPv6 路由器通告指定网络服务是否应为子网传输 ICMPv6 数据包。返回值：成功
是否启用 DHCP 布尔值	是否启用了 DHCP。返回值：成功
名称字符串	赋予子网的名称。返回值：成功
网络 ID 字符串	此子网所属的网络 ID。返回值：成功
前缀长度字符串	从子网池分配子网时要使用的前缀长度。返回值：成功
项目 ID 字符串	项目的 ID。返回值：成功
修订号字符串	资源的修订号。返回值：成功
段 ID 字符串	子网关联的网络段的 ID。返回值：成功
服务类型列表 / 元素=字符串	与子网关联的服务类型。返回值：成功
子网池 ID 字符串	与子网关联的子网池的 ID。返回值：成功
标签列表 / 元素=字符串	资源上的标签列表。返回值：成功
更新时间字符串	资源更新的日期和时间。返回值：成功
使用默认子网池布尔值	是否使用默认子网池获取 CIDR。返回值：成功

作者

OpenStack Ansible SIG