openstack.cloud.floating_ip_info 模块 – 获取浮动 IP 的信息

注意

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

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

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

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

概要

  • 获取浮动 IP 的生成器。

要求

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

  • 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 的某个部分中一样。

description

字符串

浮动 IP 的描述。

fixed_ip_address

字符串

与浮动 IP 地址关联的固定 IP 地址。

floating_ip_address

字符串

浮动 IP 的 IP 地址。

floating_network

字符串

与浮动 IP 关联的网络的名称或 ID。

interface

别名：endpoint_type

字符串

从服务目录中获取的端点 URL 类型。

选择

  • "admin"

  • "internal"

  • "public" ←（默认）

port

字符串

与浮动 IP 关联的端口的名称或 ID。

project

别名：project_id

字符串

与浮动 IP 关联的项目的名称或 ID。

region_name

字符串

区域的名称。

router

字符串

关联路由器的名称或 ID。

sdk_log_level

字符串

OpenStackSDK 的日志级别

选择

  • "INFO" ←（默认）

  • "DEBUG"

sdk_log_path

字符串

OpenStackSDK 的日志文件的路径。 如果为空，则不写入任何日志

status

字符串

浮动 IP 的状态。

选择

  • "active"

  • "down"

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/ 中找到

示例

# Getting all floating ips
- openstack.cloud.floating_ip_info:
  register: fips

# Getting fip by associated fixed IP address.
- openstack.cloud.floating_ip_info:
    fixed_ip_address: 192.168.10.8
  register: fip

# Getting fip by associated router.
- openstack.cloud.floating_ip_info:
    router: my-router
  register: fip

返回值

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

键

描述

floating_ips

列表 / 元素=字典

浮动 IP 对象列表。

返回：成功

created_at

字符串

浮动 IP 被分配的时间戳。

返回：成功

description

字符串

浮动 IP 的描述。

返回：成功

dns_domain

字符串

DNS 域。

返回：成功

dns_name

字符串

DNS 名称。

返回：成功

fixed_ip_address

字符串

与浮动 IP 地址关联的固定 IP 地址。

返回：成功

floating_ip_address

字符串

浮动 IP 的 IP 地址。

返回：成功

floating_network_id

字符串

与浮动 IP 关联的网络 ID。

返回：成功

id

字符串

浮动 IP 的 ID。

返回：成功

name

字符串

浮动 IP 的名称。

返回：成功

port_details

字典

此浮动 IP 关联的端口的详细信息。如果加载了 fip-port-details 扩展，则存在。

返回：成功

port_id

字符串

浮动 IP 关联的端口 ID。

返回：成功

project_id

字符串

此浮动 IP 关联的项目 ID。

返回：成功

qos_policy_id

字符串

附加到浮动 IP 的 QoS 策略的 ID。

返回：成功

revision_number

字符串

修订号。

返回：成功

router_id

字符串

浮动 IP 关联的路由器 ID。

返回：成功

status

字符串

浮动 IP 的状态，可以是 “ACTIVE” 或 “DOWN”。

返回：成功

subnet_id

字符串

浮动 IP 关联的子网 ID。

返回：成功

tags

列表 / 元素=字符串

标签列表。

返回：成功

updated_at

字符串

上次更新浮动 IP 的时间戳。

返回：成功

作者

  • OpenStack Ansible SIG