openstack.cloud.networks_info 模块 – 检索一个或多个 OpenStack 网络的信息。

注意

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

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

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

要在 Playbook 中使用它，请指定：openstack.cloud.networks_info。

概要

  • 从 OpenStack 检索一个或多个网络的信息。

要求

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

  • python >= 3.6

  • openstacksdk >= 1.0.0

参数

参数

注释

api_timeout

整数

套接字层在 API 调用超时之前应等待多长时间。如果省略此项，则不会将任何内容传递给 requests 库。

auth

字典

包含云的身份验证插件策略所需的身份验证信息的字典。对于默认的密码插件，这将包含 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

字符串

网络的名称或 ID

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 networks
  openstack.cloud.networks_info:
    auth:
      auth_url: https://identity.example.com
      username: user
      password: password
      project_name: someproject
  register: result

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

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

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

- name: Gather information about a previously created network with filter
  # Note: name and filters parameters are Not mutually exclusive
  openstack.cloud.networks_info:
    auth:
      auth_url: https://identity.example.com
      username: user
      password: password
      project_name: someproject
    filters:
      tenant_id: 55e2ce24b2a245b09f181bf025724cbe
      subnets:
        - 057d4bdf-6d4d-4728-bb0f-5ac45a6f7400
        - 443d4dc0-91d4-4998-b21c-357d10433483
  register: result

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

返回值

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

键

描述

networks

list / 元素=dictionary

包含有关网络的所有 OpenStack 信息

返回： 总是返回，但可以是空列表

availability_zone_hints

字符串

可用区提示

返回： 成功时

availability_zones

字符串

可用区

返回： 成功时

created_at

字符串

创建时间戳

返回： 成功时

description

字符串

描述

返回： 成功时

dns_domain

字符串

DNS 域

返回： 成功时

id

字符串

Id

返回： 成功时

ipv4_address_scope_id

字符串

IPv4 地址范围 ID

返回： 成功时

ipv6_address_scope_id

字符串

IPv6 地址范围 ID

返回： 成功时

is_admin_state_up

字符串

管理员状态是否启用

返回： 成功时

is_default

字符串

是否为默认

返回： 成功时

is_port_security_enabled

字符串

端口安全是否启用

返回： 成功时

is_router_external

字符串

是否为路由器外部网络

返回： 成功时

is_shared

字符串

是否共享

返回： 成功时

is_vlan_transparent

字符串

VLAN 是否透明

返回： 成功时

mtu

字符串

MTU

返回： 成功时

name

字符串

Name

返回： 成功时

project_id

字符串

项目 ID

返回： 成功时

provider_network_type

字符串

提供商网络类型

返回： 成功时

provider_physical_network

字符串

提供商物理网络

返回： 成功时

provider_segmentation_id

字符串

提供商分段 ID

返回： 成功时

qos_policy_id

字符串

QoS 策略 ID

返回： 成功时

revision_number

字符串

修订号

返回： 成功时

segments

字符串

分段

返回： 成功时

status

字符串

状态

返回： 成功时

subnet_ids

字符串

子网 ID

返回： 成功时

tags

字符串

标签

返回： 成功时

updated_at

字符串

更新时间戳

返回： 成功时

作者

  • OpenStack Ansible SIG