community.general.clc_loadbalancer 模块 – 在 CenturyLink 云中创建和删除共享负载均衡器

注意

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

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

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

要在剧本中使用它，请指定：community.general.clc_loadbalancer。

概要

• 一个 Ansible 模块，用于在 CenturyLink 云中创建和删除共享负载均衡器。

要求

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

• python = 2.7

• requests >= 2.5.0

• clc-sdk

参数

参数	注释
别名 字符串 / 必需	您的 CLC 帐户的别名
描述 字符串	负载均衡器的描述
位置 字符串 / 必需	负载均衡器所在的云数据中心位置
方法 字符串	- 负载均衡器池的均衡方法 选项 "leastConnection" "roundRobin"
名称 字符串 / 必需	负载均衡器的名称
节点 列表 / 元素=字典	需要添加到负载均衡器池的节点列表 默认： []
持久性 字符串	负载均衡器的持久性方法 选项 "standard" "sticky"
端口 字符串	在负载均衡器池的公共端配置的端口 选项 "80" "443"
状态 字符串	创建或删除负载均衡器池 选项 "present" ← (默认) "absent" "port_absent" "nodes_present" "nodes_absent"
状态 字符串	负载均衡器的状态 选项 "enabled" ← (默认) "disabled"

属性

属性	支持	描述
check_mode	支持：完全支持	可以在 check_mode 中运行，并在不修改目标的情况下返回更改状态预测。
diff_mode	支持：不支持	在差异模式下，将返回有关已更改内容（或可能需要在 check_mode 中更改的内容）的详细信息。

备注

注意

• 要使用此模块，需要设置以下环境变量，以启用对 CenturyLink 云的访问 - CLC_V2_API_USERNAME，CenturyLink 云的帐户登录 ID - CLC_V2_API_PASSWORD，CenturyLink 云的帐户密码

• 或者，模块接受 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 云关联的帐户别名

• 用户可以设置 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: Create Loadbalancer
  hosts: localhost
  connection: local
  tasks:
    - name: Actually Create things
      community.general.clc_loadbalancer:
        name: test
        description: test
        alias: TEST
        location: WA1
        port: 443
        nodes:
          - ipAddress: 10.11.22.123
            privatePort: 80
        state: present

- name: Add node to an existing loadbalancer pool
  hosts: localhost
  connection: local
  tasks:
    - name: Actually Create things
      community.general.clc_loadbalancer:
        name: test
        description: test
        alias: TEST
        location: WA1
        port: 443
        nodes:
          - ipAddress: 10.11.22.234
            privatePort: 80
        state: nodes_present

- name: Remove node from an existing loadbalancer pool
  hosts: localhost
  connection: local
  tasks:
    - name: Actually Create things
      community.general.clc_loadbalancer:
        name: test
        description: test
        alias: TEST
        location: WA1
        port: 443
        nodes:
          - ipAddress: 10.11.22.234
            privatePort: 80
        state: nodes_absent

- name: Delete LoadbalancerPool
  hosts: localhost
  connection: local
  tasks:
    - name: Actually Delete things
      community.general.clc_loadbalancer:
        name: test
        description: test
        alias: TEST
        location: WA1
        port: 443
        nodes:
          - ipAddress: 10.11.22.123
            privatePort: 80
        state: port_absent

- name: Delete Loadbalancer
  hosts: localhost
  connection: local
  tasks:
    - name: Actually Delete things
      community.general.clc_loadbalancer:
        name: test
        description: test
        alias: TEST
        location: WA1
        port: 443
        nodes:
          - ipAddress: 10.11.22.123
            privatePort: 80
        state: absent

返回值

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

键

描述

负载均衡器 字典

来自 CLC 的负载均衡器结果对象 返回：成功 示例： {"description": "test-lb", "id": "ab5b18cb81e94ab9925b61d1ca043fb5", "ipAddress": "66.150.174.197", "links": [{"href": "/v2/sharedLoadBalancers/wfad/wa1/ab5b18cb81e94ab9925b61d1ca043fb5", "rel": "self", "verbs": ["GET", "PUT", "DELETE"]}, {"href": "/v2/sharedLoadBalancers/wfad/wa1/ab5b18cb81e94ab9925b61d1ca043fb5/pools", "rel": "pools", "verbs": ["GET", "POST"]}], "name": "test-lb", "pools": [], "status": "enabled"}

作者

• CLC Runner (@clc-runner)

资源链接

• 问题追踪器
• 代码仓库 (源码)
• 寻求帮助
• 提交 Bug 报告
• 请求新功能
• 通讯