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

Примечание

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

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

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

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

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

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

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

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

Требования

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

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

Параметры

Параметр	Комментарии
api_timeout псевдонимы: timeout integer	Тайм-аут запросов к API Scaleway в секундах. По умолчанию: `30`
api_token псевдонимы: oauth_token string	Токен OAuth Scaleway. Обязателен, если не указан `profile`.
api_url псевдонимы: base_url string	URL API Scaleway. По умолчанию: `"https://api.scaleway.com"`
compute_id string / обязательный	Идентификатор вычислительного экземпляра (см. community.general.scaleway_compute).
private_network_id string / обязательный	Идентификатор частной сети (см. community.general.scaleway_private_network).
profile псевдонимы: scw_profile string добавлено в community.general 12.2.0	Профиль конфигурации в файле конфигурации, из которого загружается токен OAuth Scaleway; используется вместо `api_token`. Также можно задать `SCW_PROFILE`, чтобы использовать профиль конфигурации SCW CLI.
project string / обязательный	Идентификатор проекта.
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"`
state string	Задает требуемое состояние VPC. Варианты: `"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	Поддержка: полная	Может работать в режиме `check_mode` и возвращать прогноз изменения состояния, не изменяя целевой объект.
diff_mode	Поддержка: отсутствует	В режиме сравнения возвращает сведения о внесенных изменениях (или возможных изменениях в `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: Plug a VM to a private network
  community.general.scaleway_compute_private_network:
    project: '{{ scw_project }}'
    state: present
    region: par1
    compute_id: "12345678-f1e6-40ec-83e5-12345d67ed89"
    private_network_id: "22345678-f1e6-40ec-83e5-12345d67ed89"
  register: nicsvpc_creation_task

- name: Unplug a VM from a private network
  community.general.scaleway_compute_private_network:
    project: '{{ scw_project }}'
    state: absent
    region: par1
    compute_id: "12345678-f1e6-40ec-83e5-12345d67ed89"
    private_network_id: "22345678-f1e6-40ec-83e5-12345d67ed89"

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

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

Ключ	Описание
scaleway_compute_private_network dictionary	Информация о 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_compute_private_network

dictionary

Информация о 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_compute_private_network_module.html