community.general.clc_publicip 模块 – 在 CenturyLink Cloud 中添加和删除服务器的公网 IP

注意

此模块是 community.general 集合（版本 10.1.0）的一部分。

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

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

要在 playbook 中使用它，请指定：community.general.clc_publicip。

概要 

一个 Ansible 模块，用于在 CenturyLink Cloud 中现有服务器上添加或删除公网 IP 地址。

要求 

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

python = 2.7
requests >= 2.5.0
clc-sdk

参数 

参数	注释
端口列表 / elements=integer	要公开的端口列表。当状态为“present”时，这是必需的
协议字符串	公网 IP 将监听的协议。选项 `"TCP"` ←（默认） `"UDP"` `"ICMP"`
server_ids 列表 / elements=string / 必需	要在其上创建公网 IP 的服务器列表。
状态字符串	确定是创建还是删除公网 IP。如果状态为 present，则如果已存在公网 IP，则模块不会创建第二个公网 IP。选项 `"present"` ←（默认） `"absent"`
等待布尔值	是否等待任务完成后再返回。选项 `false` `true` ←（默认）

属性 

属性	支持	描述
check_mode	支持: 完整	可以在 `check_mode` 中运行，并返回已更改状态预测，而无需修改目标。
diff_mode	支持: 无	在 diff 模式下，将返回有关已更改的内容（或在 `check_mode` 中可能需要更改的内容）的详细信息。

注意 

注意

要使用此模块，需要设置以下环境变量，以启用对 Centurylink Cloud 的访问 - CLC_V2_API_USERNAME，centurylink cloud 的帐户登录 ID - CLC_V2_API_PASSWORD，centurylink cloud 的帐户密码
或者，该模块接受 API 令牌和帐户别名。可以使用 CLC 帐户登录名和密码通过 HTTP API 调用 @ https://api.ctl.io/v2/authentication/login 生成 API 令牌 - CLC_V2_API_TOKEN，从 https://api.ctl.io/v2/authentication/login 生成的 API 令牌 - CLC_ACCT_ALIAS，与 centurylink cloud 关联的帐户别名
用户可以设置 CLC_V2_API_URL 来指定指向不同 CLC 环境的端点。

示例 

# Note - You must set the CLC_V2_API_USERNAME And CLC_V2_API_PASSWD Environment variables before running these examples

- name: Add Public IP to Server
  hosts: localhost
  gather_facts: false
  connection: local
  tasks:
    - name: Create Public IP For Servers
      community.general.clc_publicip:
        protocol: TCP
        ports:
          - 80
        server_ids:
          - UC1TEST-SVR01
          - UC1TEST-SVR02
        state: present
      register: clc

    - name: Debug
      ansible.builtin.debug:
        var: clc

- name: Delete Public IP from Server
  hosts: localhost
  gather_facts: false
  connection: local
  tasks:
    - name: Create Public IP For Servers
      community.general.clc_publicip:
        server_ids:
          - UC1TEST-SVR01
          - UC1TEST-SVR02
        state: absent
      register: clc

    - name: Debug
      ansible.builtin.debug:
        var: clc

返回值 

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

键	描述
server_ids 列表 / elements=string	已更改的服务器 ID 列表已返回: 成功示例: `["UC1TEST-SVR01", "UC1TEST-SVR02"]`

作者

CLC Runner (@clc-runner)

参数	注释
端口列表 / elements=integer	要公开的端口列表。当状态为“present”时，这是必需的
协议字符串	公网 IP 将监听的协议。选项 `"TCP"` ←（默认） `"UDP"` `"ICMP"`
server_ids 列表 / elements=string / 必需	要在其上创建公网 IP 的服务器列表。
状态字符串	确定是创建还是删除公网 IP。如果状态为 present，则如果已存在公网 IP，则模块不会创建第二个公网 IP。选项 `"present"` ←（默认） `"absent"`
等待布尔值	是否等待任务完成后再返回。选项 `false` `true` ←（默认）