Модуль community.general.scaleway_private_network – Управление частными сетями Scaleway

Примечание

Этот модуль является частью коллекции community.general collection (версия 9.5.0).

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

Для установки используйте: ansible-galaxy collection install community.general.

Для использования в playbook, укажите: community.general.scaleway_private_network.

Новое в community.general 4.5.0

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

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

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

Параметры

Параметр	Комментарии
api_timeout псевдонимы: timeout целое число	Тайм-аут HTTP для API Scaleway в секундах. По умолчанию: `30`
api_token псевдонимы: oauth_token строка / обязательно	Токен OAuth Scaleway.
api_url псевдонимы: base_url строка	URL API Scaleway. По умолчанию: `"https://api.scaleway.com"`
name строка	Имя VPC.
project строка / обязательно	Идентификатор проекта.
query_parameters словарь	Список параметров, передаваемых в строку запроса. По умолчанию: `{}`
region строка / обязательно	Регион Scaleway для использования (например, `par1`). Варианты: `"ams1"` `"EMEA-NL-EVS"` `"par1"` `"EMEA-FR-PAR1"` `"par2"` `"EMEA-FR-PAR2"` `"waw1"` `"EMEA-PL-WAW1"`
state строка	Указывает желаемое состояние VPC. Варианты: `"present"` ← (по умолчанию) `"absent"`
tags список / элементы=строка	Список тегов для применения к экземпляру. По умолчанию: `[]`
validate_certs логическое значение	Проверять SSL-сертификаты API Scaleway. Варианты: `false` `true` ← (по умолчанию)

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная	Может работать в режиме `check_mode` и возвращать прогноз состояния «изменено» без изменения целевого объекта.
diff_mode	Поддержка: отсутствует	Возвращает подробную информацию о том, что изменилось (или, возможно, должно измениться в режиме `check_mode`), когда находится в режиме diff.

Примечания

Примечание

См. также документацию по 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_vpc:
    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_vpc:
    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"}

Авторы

Паскаль Манжан (@pastral)

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

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