community.general.scaleway_snapshot_info – Сбор информации о доступных снимках Scaleway.
Примечание
Этот плагин входит в коллекцию community.general (версия 1.3.2).
Для его установки используйте: ansible-galaxy collection install community.general.
Для использования в плейбуке укажите: community.general.scaleway_snapshot_info.
Обзор
- Сбор информации о доступных снимках Scaleway.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_timeout целое число | По умолчанию: 30 | Таймаут HTTP-соединения с API Scaleway в секундах. псевдонимы: timeout |
| api_token строка / обязательно | Токен Scaleway OAuth. псевдонимы: oauth_token | |
| api_url строка | По умолчанию: "https://api.scaleway.com" | URL API Scaleway. псевдонимы: base_url |
| query_parameters словарь | По умолчанию: {} | Список параметров, передаваемых в строку запроса. |
| region строка / обязательно |
| Регион Scaleway для использования (например, par1). |
| 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: Gather Scaleway snapshots information
community.general.scaleway_snapshot_info:
region: par1
register: result
- ansible.builtin.debug:
msg: "{{ result.scaleway_snapshot_info }}"
Возвращаемые значения
Общие значения, возвращаемые модулем, описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| scaleway_snapshot_info сложный тип | успех | Ответ от API Scaleway Пример: {'scaleway_snapshot_info': [{'base_volume': {'id': '68386fae-4f55-4fbf-aabb-953036a85872', 'name': 'snapshot-87fc282d-f252-4262-adad-86979d9074cf-2018-04-26_12:42'}, 'creation_date': '2018-08-14T22:34:35.299461+00:00', 'id': 'b61b4b03-a2e9-4da5-b5ea-e462ac0662d2', 'modification_date': '2018-08-14T22:34:54.520560+00:00', 'name': 'snapshot-87fc282d-f252-4262-adad-86979d9074cf-2018-04-26_12:42 snapshot', 'organization': '3f709602-5e6c-4619-b80c-e841c89734af', 'size': 25000000000, 'state': 'доступно', 'volume_type': 'l_ssd'}]} |
Авторы
- Yanis Guenane (@Spredzy)
- Remy Leone (@sieben)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/general/scaleway_snapshot_info_module.html