Модуль community.general.scaleway_security_group_rule – Модуль управления правилами группы безопасности Scaleway

Примечание

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

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

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

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

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

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

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

Параметры

Параметр	Комментарии
action строка / обязательно	Действие правила. Варианты: `"accept"` `"drop"`
api_timeout псевдонимы: timeout целое число	Таймаут HTTP для API Scaleway в секундах. По умолчанию: `30`
api_token псевдонимы: oauth_token строка / обязательно	Токен OAuth Scaleway.
api_url псевдонимы: base_url строка	URL API Scaleway. По умолчанию: `"https://api.scaleway.com"`
direction строка / обязательно	Направление правила. Варианты: `"inbound"` `"outbound"`
ip_range строка	Диапазон IP-адресов в нотации CIDR IPv4 для применения к правилу. По умолчанию: `"0.0.0.0/0"`
port целое число / обязательно	Порт, связанный с правилом, значение null для всех портов.
protocol строка / обязательно	Сеть протокола для использования. Варианты: `"TCP"` `"UDP"` `"ICMP"`
query_parameters словарь	Список параметров, передаваемых в строку запроса. По умолчанию: `{}`
region строка / обязательно	Регион Scaleway для использования (например, `par1`). Варианты: `"ams1"` `"EMEA-NL-EVS"` `"par1"` `"EMEA-FR-PAR1"` `"par2"` `"EMEA-FR-PAR2"` `"waw1"` `"EMEA-PL-WAW1"`
security_group строка / обязательно	Уникальный идентификатор группы безопасности.
state строка	Указывает желаемое состояние правила группы безопасности. Варианты: `"present"` ← (по умолчанию) `"absent"`
validate_certs логическое	Проверять SSL-сертификаты API Scaleway. Варианты: `false` `true` ← (по умолчанию)

Атрибуты

Атрибут	Поддержка	Описание
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: Create a Security Group Rule
  community.general.scaleway_security_group_rule:
    state: present
    region: par1
    protocol: TCP
    port: 80
    ip_range: 0.0.0.0/0
    direction: inbound
    action: accept
    security_group: b57210ee-1281-4820-a6db-329f78596ecb
  register: security_group_rule_creation_task

Значения возврата

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

Ключ	Описание
data словарь	Это присутствует только тогда, когда `state=present`. Возвращается: когда `state=present`. Пример: `{"scaleway_security_group_rule": {"action": "accept", "dest_port_from": 80, "dest_port_to": null, "direction": "inbound", "editable": null, "id": "10cb0b9a-80f6-4830-abd7-a31cd828b5e9", "ip_range": "0.0.0.0/0", "position": 2, "protocol": "TCP"}}`

Ключ

Описание

data

словарь

Это присутствует только тогда, когда state=present.

Возвращается: когда state=present.

Пример: {"scaleway_security_group_rule": {"action": "accept", "dest_port_from": 80, "dest_port_to": null, "direction": "inbound", "editable": null, "id": "10cb0b9a-80f6-4830-abd7-a31cd828b5e9", "ip_range": "0.0.0.0/0", "position": 2, "protocol": "TCP"}}

Авторы

Antoine Barbare (@abarbare)

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

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