ngine_io.cloudstack.cs_ip_address 模块 – 管理基于 Apache CloudStack 的云上的公有 IP 地址关联。

注意

此模块是 ngine_io.cloudstack 集合（版本 2.5.0）的一部分。

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

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

要在 playbook 中使用它，请指定：ngine_io.cloudstack.cs_ip_address。

ngine_io.cloudstack 0.1.0 中的新增功能

概要 

获取并将公有 IP 地址关联到帐户或项目。
由于 API 限制，这不是幂等调用，因此请确保仅在 *state=present* 时有条件地调用此项。
标记 IP 地址也可以使调用具有幂等性。

要求 

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

python >= 2.6
cs >= 0.9.0

参数 

参数	注释
account string	IP 地址关联的帐户。
api_http_method string	用于查询 API 端点的 HTTP 方法。如果未给出，则会考虑 `CLOUDSTACK_METHOD` 环境变量。选择 `"get"` ←（默认） `"post"`
api_key string / 必需	CloudStack API 的 API 密钥。如果未给出，则会考虑 `CLOUDSTACK_KEY` 环境变量。
api_secret string / 必需	CloudStack API 的密钥。如果未设置，则会考虑 `CLOUDSTACK_SECRET` 环境变量。
api_timeout integer	HTTP 超时（秒）。如果未给出，则会考虑 `CLOUDSTACK_TIMEOUT` 环境变量。默认值： `10`
api_url string / 必需	CloudStack API 的 URL，例如 https://cloud.example.com/client/api。如果未给出，则会考虑 `CLOUDSTACK_ENDPOINT` 环境变量。
api_verify_ssl_cert string	验证 CA 机构证书文件。如果未给出，则会考虑 `CLOUDSTACK_VERIFY` 环境变量。
domain string	IP 地址关联的域。
ip_address string	公有 IP 地址。如果 state=absent 且未设置 tags，则为必需。
network string	IP 地址关联的网络。与 vpc 互斥。
poll_async boolean	轮询异步作业，直到作业完成。选择 `false` `true` ←（默认）
project string	IP 地址关联的项目名称。
state string	IP 地址的状态。选择 `"present"` ←（默认） `"absent"`
tags 别名：tag list / elements=dictionary	标签列表。标签是具有键 key 和 value 的字典列表。标签可以用作 IP 地址的唯一标识符。在这种情况下，它们中至少有一个必须是唯一的，以确保幂等性。
validate_certs boolean 在 ngine_io.cloudstack 2.4.0 中添加	如果为 `false`，则不会验证 SSL 证书。如果未给出，则会考虑 `CLOUDSTACK_DANGEROUS_NO_TLS_VERIFY` 环境变量。这应该只用于使用自签名证书的个人控制站点。选择 `false` `true` ←（默认）
vpc string	IP 地址关联的 VPC。与 network 互斥。
zone string / 必需	IP 地址所在的区域的名称。

说明 

注意

有关 cloudstack 模块的详细指南，请参阅CloudStack 云指南。
此模块支持检查模式。

示例 

- name: Associate an IP address conditionally
  ngine_io.cloudstack.cs_ip_address:
    network: My Network
    zone: zone01
  register: ip_address
  when: instance.public_ip is undefined

- name: Disassociate an IP address
  ngine_io.cloudstack.cs_ip_address:
    ip_address: 1.2.3.4
    zone: zone01
    state: absent

- name: Associate an IP address with tags
  ngine_io.cloudstack.cs_ip_address:
    network: My Network
    zone: zone01
    tags:
      - key: myCustomID
        value: 5510c31a-416e-11e8-9013-02000a6b00bf
  register: ip_address

- name: Disassociate an IP address with tags
  ngine_io.cloudstack.cs_ip_address:
    state: absent
    zone: zone01
    tags:
      - key: myCustomID
        value: 5510c31a-416e-11e8-9013-02000a6b00bf

返回值 

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

键	描述
account string	IP 地址关联的帐户。返回值：成功示例： `"示例帐户"`
domain string	IP 地址关联的域。返回值：成功示例： `"示例域"`
id string	公有 IP 地址的 UUID。返回值：成功示例: `"a6f7a5fc-43f8-11e5-a151-feff819cdc9f"`
ip_address string	公有 IP 地址。返回值：成功示例: `"1.2.3.4"`
project string	与 IP 地址相关的项目名称。返回值：成功示例: `"Production"`
标签字典	与 IP 地址关联的资源标签列表。返回值：成功示例: `"[ { \"key\": \"myCustomID\", \"value\": \"5510c31a-416e-11e8-9013-02000a6b00bf\" } ]"`
zone string	与 IP 地址相关的区域名称。返回值：成功示例: `"ch-gva-2"`

作者

Darren Worrall (@dazworrall)
René Moser (@resmo)