Модуль community.general.scaleway_ip — модуль управления IP-адресами Scaleway

Примечание

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

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

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

Чтобы использовать модуль в плейбуке, укажите: community.general.scaleway_ip.

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

Краткое описание

Этот модуль управляет IP-адресами в учетной записи Scaleway https://developer.scaleway.com.

Требования

Следующие требования необходимы на хосте, где выполняется этот модуль.

PyYAML (если используется profile)

Параметры

Параметр	Комментарии
api_timeout псевдонимы: timeout integer	Тайм-аут HTTP-запроса к API Scaleway в секундах. По умолчанию: `30`
api_token псевдонимы: oauth_token string	Токен OAuth Scaleway. Обязателен, если не указан `profile`.
api_url псевдонимы: base_url string	URL API Scaleway. По умолчанию: `"https://api.scaleway.com"`
id string	ID IP-адреса Scaleway (UUID).
organization string	Идентификатор организации Scaleway. Необходимо указать ровно один из параметров `project` и `organization`.
profile псевдонимы: scw_profile string добавлено в community.general 12.2.0	Профиль конфигурации в файле конфигурации, из которого следует загрузить токен OAuth Scaleway; используйте его вместо `api_token`. Также можно задать `SCW_PROFILE`, чтобы использовать профиль конфигурации SCW CLI.
project string добавлено в community.general 12.3.0	Идентификатор проекта. Необходимо указать ровно один из параметров `project` и `organization`.
query_parameters dictionary	Список параметров, передаваемых в строке запроса. По умолчанию: `{}`
region string / обязательный	Используемый регион Scaleway (например, par1). Варианты: `"ams1"` `"EMEA-NL-EVS"` `"ams2"` `"ams3"` `"par1"` `"EMEA-FR-PAR1"` `"par2"` `"EMEA-FR-PAR2"` `"par3"` `"waw1"` `"EMEA-PL-WAW1"` `"waw2"` `"waw3"`
reverse string	Обратная запись, назначаемая IP-адресу.
server string	ID сервера, к которому нужно прикрепить IP-адрес. Чтобы отсоединить IP-адрес, не указывайте этот параметр.
state string	Требуемое состояние IP-адреса. Варианты: `"present"` ← (по умолчанию) `"absent"`
validate_certs boolean	Проверять SSL-сертификаты API Scaleway. Варианты: `false` `true` ← (по умолчанию)

Атрибуты

Атрибут	Поддержка	Описание
action_group	Группа действий: community.general.scaleway добавлено в community.general 11.3.0	Используйте `group/community.general.scaleway` в `module_defaults`, чтобы задать значения по умолчанию для этого модуля.
check_mode	Поддержка: full	Модуль может работать в режиме `check_mode` и возвращать прогноз изменения состояния, не изменяя целевой объект.
diff_mode	Поддержка: none	При работе в режиме diff возвращает сведения об изменениях (или о том, что, возможно, нужно изменить в `check_mode`).

Примечания

Примечание

См. также документацию 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 with a project ID
  community.general.scaleway_ip:
    project: '{{ project_id }}'
    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

- name: Create an IP in the default project with an organization ID (deprecated)
  community.general.scaleway_ip:
    organization: '{{ scw_org }}'
    state: present
    region: par1
  register: ip_creation_task

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

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

Ключ	Описание
data dictionary	Присутствует только при `state=present`. Возвращается: при `state=present` Пример: `{"ips": [{"address": "212.47.232.136", "id": "dd9e8df6-6775-4863-b517-e0b0ee3d7477", "organization": "951df375-e094-4d26-97c1-ba548eeb9c42", "reverse": null, "server": {"id": "3f1568ca-b1a2-4e98-b6f7-31a0588157f1", "name": "ansible_tuto-1"}}]}`

Авторы

Remy Leone (@remyleone)

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

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