Модуль community.general.hwc_vpc_security_group_rule — создает ресурс VPC/SecurityGroupRule в Huawei Cloud

Примечание

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

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

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

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

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

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

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

Управление группами безопасности VPC.

Требования

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

keystoneauth1 >= 3.6.0

Параметры

Параметр	Комментарии
description строка	Дополнительная информация о правиле группы безопасности. Значение представляет собой строку длиной не более 255 символов, содержащую буквы и цифры.
direction строка / обязательный	Указывает направление управления доступом. Значением может быть egress или ingress.
domain строка / обязательный	Имя домена, к которому выполняется привязка (Identity v3). В настоящее время поддерживаются только имена доменов, но не их идентификаторы.
ethertype строка	Указывает версию протокола IP. Значением может быть IPv4 или IPv6. Если этот параметр не задан, по умолчанию используется IPv4.
id строка	Идентификатор управляемого ресурса.
identity_endpoint строка / обязательный	URL для аутентификации Identity.
password строка / обязательный	Пароль для входа.
port_range_max целое число	Указывает номер конечного порта. Допустимые значения — от 1 до 65535. Если используется протокол, отличный от icmp, значение не может быть меньше значения port_range_min. Пустое значение означает, что выбраны все порты.
port_range_min целое число	Указывает номер начального порта. Допустимые значения — от 1 до 65535. Значение не может быть больше значения port_range_max. Пустое значение означает, что выбраны все порты.
project строка / обязательный	Имя арендатора (Identity v2) или проекта (Identity v3). В настоящее время поддерживаются только имена проектов, но не их идентификаторы.
protocol строка	Указывает тип протокола. Значением может быть icmp, tcp или udp. Если параметр не задан, группа безопасности поддерживает все протоколы.
region строка	Регион, к которому относится проект.
remote_group_id строка	Указывает идентификатор одноранговой группы безопасности. Этот параметр нельзя использовать одновременно с параметром remote_ip_prefix.
remote_ip_prefix строка	Указывает удаленный IP-адрес. Если для направления управления доступом задано egress, параметр указывает IP-адрес источника. Если задано ingress, параметр указывает IP-адрес назначения. Значение может быть указано в формате CIDR или в виде IP-адреса. Этот параметр нельзя использовать одновременно с параметром remote_group_id.
security_group_id строка / обязательный	Указывает идентификатор правила группы безопасности, уникально определяющий это правило.
state строка	Должен ли указанный объект существовать в Huawei Cloud. Варианты: `"present"` ← (по умолчанию) `"absent"`
user строка / обязательный	Имя пользователя для входа. В настоящее время поддерживаются только имена пользователей, но не их идентификаторы.

Атрибуты

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

Примечания

Примечание

Если указан параметр id, он имеет приоритет над security_group_id при выборе правила группы безопасности.
Для выбора правила группы безопасности используется security_group_id. Если существует несколько правил группы безопасности с этими параметрами, выполнение прерывается.
Параметры не поддерживают обновление. Если изменить один из параметров, модуль создаст новый ресурс.
Для аутентификации можно задать identity_endpoint с помощью переменной окружения ANSIBLE_HWC_IDENTITY_ENDPOINT.
Для аутентификации можно задать user с помощью переменной окружения ANSIBLE_HWC_USER.
Для аутентификации можно задать password с помощью переменной окружения ANSIBLE_HWC_PASSWORD.
Для аутентификации можно задать domain с помощью переменной окружения ANSIBLE_HWC_DOMAIN.
Для аутентификации можно задать project с помощью переменной окружения ANSIBLE_HWC_PROJECT.
Для аутентификации можно задать region с помощью переменной окружения ANSIBLE_HWC_REGION.
Значения переменных окружения используются только в том случае, если значения в плейбуке не заданы.

Примеры

# create a security group rule
- name: Create a security group
  hwc_vpc_security_group:
    name: "ansible_network_security_group_test"
  register: sg
- name: Create a security group rule
  community.general.hwc_vpc_security_group_rule:
    direction: "ingress"
    protocol: "tcp"
    ethertype: "IPv4"
    port_range_max: 22
    security_group_id: "{{ sg.id }}"
    port_range_min: 22
    remote_ip_prefix: "0.0.0.0/0"

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

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

Ключ	Описание
description строка	Дополнительная информация о правиле группы безопасности. Значение представляет собой строку длиной не более 255 символов, содержащую буквы и цифры. Возвращается: при успехе
direction строка	Указывает направление управления доступом. Значением может быть egress или ingress. Возвращается: при успехе
ethertype строка	Указывает версию протокола IP. Значением может быть IPv4 или IPv6. Если этот параметр не задан, по умолчанию используется IPv4. Возвращается: при успехе
port_range_max целое число	Указывает номер конечного порта. Допустимые значения — от 1 до 65535. Если используется протокол, отличный от icmp, значение не может быть меньше значения port_range_min. Пустое значение означает, что выбраны все порты. Возвращается: при успехе
port_range_min целое число	Указывает номер начального порта. Допустимые значения — от 1 до 65535. Значение не может быть больше значения port_range_max. Пустое значение означает, что выбраны все порты. Возвращается: при успехе
protocol строка	Указывает тип протокола. Значением может быть icmp, tcp или udp. Если параметр не задан, группа безопасности поддерживает все протоколы. Возвращается: при успехе
remote_group_id строка	Указывает идентификатор одноранговой группы безопасности. Этот параметр нельзя использовать одновременно с параметром remote_ip_prefix. Возвращается: при успехе
remote_ip_prefix строка	Указывает удаленный IP-адрес. Если для направления управления доступом задано egress, параметр указывает IP-адрес источника. Если задано ingress, параметр указывает IP-адрес назначения. Значение может быть указано в формате CIDR или в виде IP-адреса. Этот параметр нельзя использовать одновременно с параметром remote_group_id. Возвращается: при успехе
security_group_id строка	Указывает идентификатор правила группы безопасности, уникально определяющий это правило. Возвращается: при успехе

Авторы

Huawei Inc. (@huaweicloud)

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

© 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/hwc_vpc_security_group_rule_module.html