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 调用超时之前应等待多长时间。如果省略此项，则不会传递任何内容到请求库。

auth

字典

包含云身份验证插件策略所需身份验证信息的字典。对于默认的password插件，这将包含 auth_url、username、password、project_name 以及关于域的任何信息（例如，如果云支持它们，则为 user_domain_name 或 project_domain_name）。对于其他插件，此参数将需要包含该身份验证插件所需的任何参数。如果提供了命名云或存在 OpenStack OS_* 环境变量，则不需要此参数。

auth_type

字符串

要使用的身份验证插件的名称。如果云使用密码身份验证以外的其他方式，则应在此处指示插件的名称，并且应相应地更新 auth 参数的内容。

ca_cert

别名：cacert

字符串

可用于验证 SSL API 请求的 CA 证书捆绑包的路径。

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 }}"

返回值

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

键

描述

subnets

list / elements=dictionary

包含有关子网的所有 openstack 信息

返回：始终，但可以为空列表

allocation_pools

list / elements=dictionary

与此子网关联的分配池。

返回：成功

cidr

字符串

子网的 CIDR。

返回：成功

created_at

字符串

资源创建的日期和时间。

返回：成功

description

字符串

子网的描述。

返回：成功

dns_nameservers

list / elements=string

此子网的 DNS 名称服务器。

返回：成功

dns_publish_fixed_ip

字符串

是否发布来自此子网的 IP 的 DNS 记录。

返回：成功

gateway_ip

字符串

子网的网关 IP。

返回：成功

host_routes

list / elements=dictionary

子网的附加路由。

返回：成功

id

字符串

子网的 ID。

返回：成功

ip_version

整数

此子网的 IP 版本。

返回：成功

ipv6_address_mode

字符串

IPv6 地址模式指定了分配 IP 地址的机制。

返回：成功

ipv6_ra_mode

字符串

IPv6 路由器通告指定了网络服务是否应该为一个子网发送 ICMPv6 数据包。

返回：成功

is_dhcp_enabled

布尔值

是否启用 DHCP。

返回：成功

name

字符串

赋予子网的名称。

返回：成功

network_id

字符串

此子网所属的网络 ID。

返回：成功

prefix_length

字符串

从子网池分配子网时使用的前缀长度。

返回：成功

project_id

字符串

项目的 ID。

返回：成功

revision_number

字符串

资源的修订号。

返回：成功

segment_id

字符串

子网关联的网络段的 ID。

返回：成功

service_types

list / elements=string

与子网关联的服务类型。

返回：成功

subnet_pool_id

字符串

与子网关联的子网池的 ID。

返回：成功

tags

list / elements=string

资源上的标签列表。

返回：成功

updated_at

字符串

资源更新的日期和时间。

返回：成功

use_default_subnet_pool

布尔值

是否使用默认子网池获取 CIDR。

返回：成功

作者

  • OpenStack Ansible SIG