openstack.cloud.floating_ip 模块 – 管理 OpenStack 服务器的浮动 IP 地址

注意

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

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

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

要在剧本中使用它，请指定：openstack.cloud.floating_ip。

概要

  • 向 OpenStack 服务器添加或删除浮动 IP 地址。

  • 仅当 wait 为 true 时，附加时返回浮动 IP。

  • 分离浮动 IP 时，可能会有延迟，直到服务器不再列出浮动 IP。

要求

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

  • 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

字符串

可以用作验证 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 的一部分一样。

fixed_address

字符串

浮动 IP 地址应附加到的服务器的固定 IP 地址。

floating_ip_address

字符串

要附加或分离的浮动 IP 地址。当存在 state 时，可以用于指定要附加的 IP 地址。floating_ip_address 需要设置 network。

interface

别名：endpoint_type

字符串

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

选择

  • "admin"

  • "internal"

  • "public" ← (默认)

nat_destination

别名：fixed_network、internal_network

字符串

要附加浮动 IP 的固定 IP 所在的 Neutron 私有网络的名称或 ID

network

字符串

Neutron 外部网络的名称或 ID，或 Nova 池名称。

purge

布尔值

当 state 不存在时，指示是完全删除浮动 IP，还是仅从服务器分离它。默认为仅分离。

选择

  • false ← (默认)

  • true

region_name

字符串

区域的名称。

reuse

布尔值

当 state 存在且 floating_ip_address 不存在时，可以使用此参数来指定我们是否应尝试重用已分配给项目的浮动 IP 地址。

当 reuse 为 true，network 已定义且 floating_ip_address 未定义时，nat_destination 和 fixed_address 将被忽略。

选择

  • false ← (默认)

  • true

sdk_log_level

字符串

OpenStackSDK 的日志级别。

选择

  • "INFO" ← (默认)

  • "DEBUG"

sdk_log_path

字符串

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

server

string / 必需

要将 IP 地址分配给的服务器的名称或 ID。

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/

示例

# Assign a floating IP to the first interface of `cattle001` from an existing
# external network or nova pool. A new floating IP from the first available
# external network is allocated to the project.
- openstack.cloud.floating_ip:
     cloud: dguerri
     server: cattle001

# Assign a new floating IP to the server fixed ip `192.0.2.3` of
# `cattle001`. If a free floating IP is already allocated to the project, it is
# reused; if not, a new one is created.
- openstack.cloud.floating_ip:
     cloud: dguerri
     state: present
     reuse: true
     server: cattle001
     network: ext_net
     fixed_address: 192.0.2.3
     wait: true
     timeout: 180

# Assign a new floating IP from the network `ext_net` to the server fixed
# ip in network `private_net` of `cattle001`.
- openstack.cloud.floating_ip:
     cloud: dguerri
     state: present
     server: cattle001
     network: ext_net
     nat_destination: private_net
     wait: true
     timeout: 180

# Detach a floating IP address from a server
- openstack.cloud.floating_ip:
     cloud: dguerri
     state: absent
     floating_ip_address: 203.0.113.2
     server: cattle001

返回值

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

键

描述

floating_ip

字典

描述浮动 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