Модуль community.general.scaleway_private_network — управление частной сетью Scaleway

Примечание

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

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

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

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

Добавлено в community.general 4.5.0

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

Обзор

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

Требования

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

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

Параметры

Параметр	Комментарии
api_timeout псевдонимы: timeout целое число	Тайм-аут HTTP-запроса к API Scaleway в секундах. По умолчанию: `30`
api_token псевдонимы: oauth_token строка	Токен OAuth Scaleway. Обязательный параметр, если не указан `profile`.
api_url псевдонимы: base_url строка	URL API Scaleway. По умолчанию: `"https://api.scaleway.com"`
name строка	Имя VPC.
profile псевдонимы: scw_profile строка добавлено в community.general 12.2.0	Профиль конфигурации из файла конфигурации, из которого нужно загрузить токен OAuth Scaleway; используется вместо `api_token`. Также можно задать `SCW_PROFILE`, чтобы использовать профиль конфигурации SCW CLI.
project строка / обязательный	Идентификатор проекта.
query_parameters словарь	Список параметров, передаваемых в строке запроса. По умолчанию: `{}`
region строка / обязательный	Регион Scaleway (например, `par1`). Допустимые значения: `"ams1"` `"EMEA-NL-EVS"` `"ams2"` `"ams3"` `"par1"` `"EMEA-FR-PAR1"` `"par2"` `"EMEA-FR-PAR2"` `"par3"` `"waw1"` `"EMEA-PL-WAW1"` `"waw2"` `"waw3"`
state строка	Указывает требуемое состояние VPC. Допустимые значения: `"present"` ← (по умолчанию) `"absent"`
tags список / элементы=строка	Список тегов, применяемых к экземпляру. По умолчанию: `[]`
validate_certs логическое значение	Проверять сертификаты 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 private network
  community.general.scaleway_private_network:
    project: '{{ scw_project }}'
    name: 'vpc_one'
    state: present
    region: par1
  register: vpc_creation_task

- name: Make sure private network with name 'foo' is deleted in region par1
  community.general.scaleway_private_network:
    name: 'foo'
    state: absent
    region: par1

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

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

Ключ	Описание
scaleway_private_network словарь	Информация о VPC. Возвращается: при успешном выполнении, если `state=present` Пример: `{"created_at": "2022-01-15T11:11:12.676445Z", "id": "12345678-f1e6-40ec-83e5-12345d67ed89", "name": "network", "organization_id": "a123b4cd-ef5g-678h-90i1-jk2345678l90", "project_id": "a123b4cd-ef5g-678h-90i1-jk2345678l90", "tags": ["tag1", "tag2", "tag3", "tag4", "tag5"], "updated_at": "2022-01-15T11:12:04.624837Z", "zone": "fr-par-2"}`

Ключ

Описание

scaleway_private_network

словарь

Информация о VPC.

Возвращается: при успешном выполнении, если state=present

Пример: {"created_at": "2022-01-15T11:11:12.676445Z", "id": "12345678-f1e6-40ec-83e5-12345d67ed89", "name": "network", "organization_id": "a123b4cd-ef5g-678h-90i1-jk2345678l90", "project_id": "a123b4cd-ef5g-678h-90i1-jk2345678l90", "tags": ["tag1", "tag2", "tag3", "tag4", "tag5"], "updated_at": "2022-01-15T11:12:04.624837Z", "zone": "fr-par-2"}

Авторы

Pascal MANGIN (@pastral)

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

© 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_private_network_module.html