Модуль community.general.clc_publicip — Добавление и удаление публичных IP-адресов на серверах в CenturyLink Cloud

Примечание

Этот модуль является частью коллекции community.general (версия 9.5.0).

Вы, возможно, уже установили эту коллекцию, если используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для её установки используйте: ansible-galaxy collection install community.general. Для использования этого модуля потребуются дополнительные требования, см. Требования для получения подробностей.

Чтобы использовать его в книге задач, укажите: community.general.clc_publicip.

Описание
Требования
Параметры
Атрибуты
Примечания
Примеры
Возвращаемые значения

Описание

Модуль Ansible для добавления или удаления публичных IP-адресов на существующем сервере или серверах в CenturyLink Cloud.

Требования

Ниже перечислены требования к хосту, на котором выполняется этот модуль.

python = 2.7
requests >= 2.5.0
clc-sdk

Параметры

Параметр	Комментарии
ports список / элементы=целое число	Список портов для экспонирования. Требуется, когда состояние «present»
protocol строка	Протокол, который будет прослушивать публичный IP-адрес. Варианты: `"TCP"` ← (по умолчанию) `"UDP"` `"ICMP"`
server_ids список / элементы=строка / обязательно	Список серверов, на которых нужно создать публичные IP-адреса.
state строка	Определяет, нужно ли создавать или удалять публичные IP-адреса. Если присутствует, модуль не создаст второй публичный IP-адрес, если он уже существует. Варианты: `"present"` ← (по умолчанию) `"absent"`
wait булево	Ожидать завершения задач перед возвратом. Варианты: `false` `true` ← (по умолчанию)

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная	Может работать в `check_mode` и возвращать прогноз состояния изменений без модификации цели.
diff_mode	Поддержка: отсутствует	Возвращает подробности о том, что изменилось (или, возможно, должно измениться в `check_mode`), при режиме diff.

Примечания

Примечание

Для использования этого модуля необходимо установить переменные окружения, которые предоставляют доступ к CenturyLink Cloud — CLC_V2_API_USERNAME, идентификатор учетной записи для CenturyLink Cloud — CLC_V2_API_PASSWORD, пароль учетной записи для CenturyLink Cloud
В качестве альтернативы, модуль принимает токен API и псевдоним учетной записи. Токен API можно сгенерировать с помощью входа в учетную запись CLC и пароля через вызов API HTTP по адресу @ https://api.ctl.io/v2/authentication/login — CLC_V2_API_TOKEN, токен API, сгенерированный с помощью https://api.ctl.io/v2/authentication/login — 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 список / элементы=строка	Список идентификаторов серверов, которые были изменены Возвращается: успех Пример: `["UC1TEST-SVR01", "UC1TEST-SVR02"]`

Авторы

CLC Runner (@clc-runner)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/clc_publicip_module.html