Модуль community.general.clc_server_snapshot — Создание, удаление и восстановление снимков серверов в CenturyLink Cloud

Примечание

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

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

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

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

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

Обзор

Модуль Ansible для создания, удаления и восстановления снимков серверов в CenturyLink Cloud.

Требования

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

python = 2.7
requests >= 2.5.0
clc-sdk

Параметры

Параметр	Комментарии
expiration_days целое число	Количество дней, в течение которых сохраняется снимок сервера, прежде чем он истечет. По умолчанию: `7`
server_ids список / элементы=строка / обязательно	Список идентификаторов серверов CLC.
state строка	Состояние, в котором должны быть предоставленные ресурсы. Варианты: `"present"` ← (по умолчанию) `"absent"` `"restore"`
wait строка	Ожидать завершения задач развертывания перед возвратом. По умолчанию: `"True"`

Атрибуты

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

Примечания

Примечание

Для использования этого модуля необходимо задать переменные окружения, обеспечивающие доступ к CenturyLink Cloud: CLC_V2_API_USERNAME (идентификатор входа в учетную запись), CLC_V2_API_PASSWORD (пароль учетной записи).
Альтернативно, модуль принимает токен API и псевдоним учетной записи. Токен API можно получить, используя вход в учетную запись CLC и пароль через вызов HTTP API по адресу https://api.ctl.io/v2/authentication/login (CLC_V2_API_TOKEN). Псевдоним учетной записи (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: Create server snapshot
  community.general.clc_server_snapshot:
    server_ids:
        - UC1TEST-SVR01
        - UC1TEST-SVR02
    expiration_days: 10
    wait: true
    state: present

- name: Restore server snapshot
  community.general.clc_server_snapshot:
    server_ids:
        - UC1TEST-SVR01
        - UC1TEST-SVR02
    wait: true
    state: restore

- name: Delete server snapshot
  community.general.clc_server_snapshot:
    server_ids:
        - UC1TEST-SVR01
        - UC1TEST-SVR02
    wait: true
    state: absent

Возвращаемые значения

Общие возвращаемые значения описаны здесь. Следующие поля уникальны для этого модуля:

Ключ	Описание
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_server_snapshot_module.html