community.general.scaleway_ip – Модуль управления IP-адресами Scaleway
Примечание
Этот плагин входит в коллекцию community.general (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install community.general.
Для использования в playbook, укажите: community.general.scaleway_ip.
Обзор
- Этот модуль управляет IP-адресами на аккаунте Scaleway https://developer.scaleway.com
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_timeout целое число | По умолчанию: 30 | Таймаут HTTP-запросов к API Scaleway в секундах. псевдонимы: timeout |
| api_token строка / обязательно | Токен Scaleway OAuth. псевдонимы: oauth_token | |
| api_url строка | По умолчанию: "https://api.scaleway.com" | URL API Scaleway. псевдонимы: base_url |
| id строка | Идентификатор IP-адреса Scaleway (UUID) | |
| organization строка / обязательно | Идентификатор организации Scaleway | |
| query_parameters словарь | По умолчанию: {} | Список параметров, передаваемых в строку запроса. |
| region строка / обязательно |
| Регион Scaleway для использования (например, par1). |
| reverse строка | Обратный DNS-запись для IP-адреса | |
| server строка | Идентификатор сервера, к которому необходимо прикрепить IP-адрес. Для открепления IP-адреса этот параметр не указывать. | |
| state строка |
| Указывает желаемое состояние IP-адреса. |
| validate_certs логический тип |
| Проверять SSL-сертификаты API Scaleway. |
Примечания
Примечание
- См. также документацию API по https://developer.scaleway.com/
- Если
api_tokenне задано в модуле, можно использовать следующие переменные окружения в порядке убывания приоритетаSCW_TOKEN,SCW_API_KEY,SCW_OAUTH_TOKENилиSCW_API_TOKEN. - Если необходимо использовать другой
api_url, можно также установить переменную окруженияSCW_API_URL.
Примеры
- name: Create an IP
community.general.scaleway_ip:
organization: '{{ scw_org }}'
state: present
region: par1
register: ip_creation_task
- name: Make sure IP deleted
community.general.scaleway_ip:
id: '{{ ip_creation_task.scaleway_ip.id }}'
state: absent
region: par1
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| data словарь | при state=present
| Присутствует только при state=present
Пример: {'ips': [{'address': '212.47.232.136', 'id': 'dd9e8df6-6775-4863-b517-e0b0ee3d7477', 'organization': '951df375-e094-4d26-97c1-ba548eeb9c42', 'reverse': None, 'server': {'id': '3f1568ca-b1a2-4e98-b6f7-31a0588157f1', 'name': 'ansible_tuto-1'}}]} |
Авторы
- Remy Leone (@sieben)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/general/scaleway_ip_module.html