Spec-Zone.ru › Ansible 2.9

azure_rm_securitygroup – Управление группами безопасности сети Azure

  • Описание
  • Требования
  • Параметры
  • Примечания
  • См. также
  • Примеры
  • Возвращаемые значения
  • Статус

Описание

  • Создание, обновление или удаление группы безопасности сети.
  • Группа безопасности содержит правила списка управления доступом (ACL), которые разрешают или запрещают сетевой трафик для подсетей или отдельных сетевых интерфейсов.
  • Группа безопасности создается с набором правил безопасности по умолчанию и пустым набором правил безопасности.
  • Управляйте потоком трафика, добавляя правила в пустой набор правил безопасности.

Требования

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

  • python >= 2.7
  • azure >= 2.0.0

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
ad_user
строка
Имя пользователя Active Directory. Используйте при аутентификации пользователем Active Directory, а не служебным принципалом.
adfs_authority_url
строка
добавлен в 2.6
URL-адрес авторизации Azure AD. Используйте при аутентификации с помощью имени пользователя/пароля и собственной авторизацией ADFS.
api_profile
строка
добавлен в 2.5
 По умолчанию:
"latest"
Выбирает профиль API для взаимодействия с Azure-сервисами. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack.
append_tags
булево
    Варианты:
  • нет
  • да ←
Управляет тем, является ли поле тегов каноническим или оно просто добавляется к существующим тегам.
При каноническом значении любые теги, отсутствующие в параметре tags, будут удалены из метаданных объекта.
auth_source
строка
добавлен в 2.5
    Варианты:
  • авто
  • cli
  • credential_file
  • env
  • msi
Управляет источником учетных данных для аутентификации.
Если не указано, будет использована переменная окружения ANSIBLE_AZURE_AUTH_SOURCE и по умолчанию auto при отсутствии переменной.
auto будет следовать умолчанию для параметров модуля -> переменных окружения -> профиля по умолчанию в файле учетных данных ~/.azure/credentials.
При установке в cli, учетные данные будут взяты из профиля Azure CLI по умолчанию.
Также может быть задано через переменную окружения ANSIBLE_AZURE_AUTH_SOURCE.
При установке в msi, хост-машина должна быть Azure-ресурсом с включённым расширением MSI. subscription_id или переменная окружения AZURE_SUBSCRIPTION_ID может использоваться для определения идентификатора подписки, если ресурсу предоставлен доступ к нескольким подпискам, иначе выбирается первая подписка.
msi был добавлен в Ansible 2.6.
cert_validation_mode
строка
добавлен в 2.5
    Варианты:
  • ignore
  • validate
Управляет поведением проверки сертификатов для Azure-точек входа. По умолчанию все модули проверяют серверный сертификат, но при использовании прокси HTTPS или с Azure Stack может потребоваться отключить это поведение, передав ignore. Также может быть установлено через профиль файла учетных данных или переменную окружения AZURE_CERT_VALIDATION.
client_id
строка
Идентификатор клиента Azure. Используйте при аутентификации служебным принципалом.
cloud_environment
строка
добавлен в 2.4
 По умолчанию:
"AzureCloud"
Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, AzureChinaCloud, AzureUSGovernment) или URL-адрес точки входа для обнаружения метаданных (необходим для Azure Stack). Также может быть установлено через профиль файла учетных данных или переменную окружения AZURE_CLOUD_ENVIRONMENT.
default_rules
-
Набор правил по умолчанию, автоматически добавляемых к группе безопасности при создании.
В целом правила по умолчанию не будут изменены. Изменяйте правила, чтобы настроить поток трафика в подсеть или сетевую карту.
См. правила ниже для структуры словаря правил.
location
-
Допустимое расположение Azure. По умолчанию используется расположение группы ресурсов.
name
-
Имя группы безопасности, с которой нужно работать.
password
строка
Пароль пользователя Active Directory. Используйте при аутентификации пользователем Active Directory, а не служебным принципалом.
profile
строка
Профиль безопасности, найденный в файле ~/.azure/credentials.
purge_default_rules
булево
    Варианты:
  • нет ←
  • да
Удаление любых существующих правил, не соответствующих параметру default_rules.
purge_rules
булево
    Варианты:
  • нет ←
  • да
Удаление любых существующих правил, не соответствующих параметрам rules.
resource_group
- / обязательно
Имя группы ресурсов, к которой принадлежит группа безопасности.
rules
-
Набор правил, определяющих поток трафика в подсеть или сетевую карту. Каждое правило представляет собой словарь.
access
-
    Варианты:
  • Разрешить ←
  • Запретить
Разрешить или запретить поток трафика.
description
-
Краткое описание назначения правила.
destination_address_prefix
-
По умолчанию:
"*"
Префикс адреса назначения.
Диапазон CIDR или IP-адресов назначения.
Звёздочка * также может использоваться для соответствия всем IP-адресам источника.
Также можно использовать теги по умолчанию, такие как VirtualNetwork, AzureLoadBalancer и Internet.
Может принимать строковый тип или список строковых типов.
destination_application_security_groups
список
Список групп безопасности приложений назначения.
Это может быть список идентификаторов ресурсов.
Это может быть список имён в той же группе ресурсов.
Это может быть список словарей, содержащих resource_group и name.
Это взаимоисключающее с destination_address_prefix и destination_address_prefixes.
destination_port_range
-
По умолчанию:
"*"
Порт или диапазон портов, к которым направлен трафик.
Может принимать строковый тип или список строковых типов.
direction
-
    Варианты:
  • Входящий ←
  • Исходящий
Указывает направление потока трафика.
name
- / обязательно
Уникальное имя правила.
priority
- / обязательно
Порядок применения правила. Должно быть уникальным целым числом от 100 до 4096 включительно.
protocol
-
    Варианты:
  • Udp
  • Tcp
  • * ←
Поддерживаемый протокол трафика.
source_address_prefix
-
По умолчанию:
"*"
Диапазон CIDR или IP-адресов источника.
Звёздочка * также может использоваться для соответствия всем IP-адресам источника.
Также можно использовать теги по умолчанию, такие как VirtualNetwork, AzureLoadBalancer и Internet.
Если это правило входа, указывает, откуда исходит сетевой трафик.
Может принимать строковый тип или список строковых типов.
source_application_security_groups
list
Список групп безопасности приложений-источников.
Это может быть список идентификаторов ресурсов.
Это может быть список имён в той же группе ресурсов.
Это может быть список словарей, содержащих resource_group и имя.
Взаимоисключающее с source_address_prefix и source_address_prefixes.
source_port_range
-
Значение по умолчанию:
"*"
Порт или диапазон портов, откуда исходит трафик.
Может принимать строковый тип или список строковых типов.
secret
string
Секретный ключ клиента Azure. Используется при аутентификации с помощью принципала службы.
state
-
    Варианты:
  • absent
  • present ←
Утвердите состояние группы безопасности. Установите значение present, чтобы создать или обновить группу безопасности. Установите значение absent, чтобы удалить группу безопасности.
subscription_id
string
Ваш идентификатор подписки Azure.
tags
dictionary
Словарь пар "строка:строка" для присвоения метаданных объекту.
Метаданные теги объекта будут обновлены любыми предоставленными значениями.
Для удаления тегов установите параметр append_tags в false.
tenant
string
Идентификатор арендатора Azure. Используется при аутентификации с помощью принципала службы.

Примечания

Примечание

  • Для аутентификации с Azure вы можете передавать параметры, устанавливать переменные среды, использовать профиль, хранящийся в ~/.azure/credentials, или войти в систему перед выполнением задач или выполнения playbook с помощью az login.
  • Аутентификация также возможна с использованием принципала службы или пользователя Active Directory.
  • Для аутентификации через принципала службы передайте subscription_id, client_id, secret и tenant или установите переменные среды AZURE_SUBSCRIPTION_ID, AZURE_CLIENT_ID, AZURE_SECRET и AZURE_TENANT.
  • Для аутентификации через пользователя Active Directory передайте ad_user и password или установите AZURE_AD_USER и AZURE_PASSWORD в среде.
  • В качестве альтернативы данные учетных данных могут храниться в ~/.azure/credentials. Это файл ini, содержащий раздел [default] и следующие ключи: subscription_id, client_id, secret и tenant или subscription_id, ad_user и password. Также возможно добавление дополнительных профилей. Укажите профиль, передав profile или установив AZURE_PROFILE в среде.

См. также

См. также

Вход с помощью Azure CLI
Как войти в систему, используя команду az login.

Примеры

# Create a security group
- azure_rm_securitygroup:
      resource_group: myResourceGroup
      name: mysecgroup
      purge_rules: yes
      rules:
          - name: DenySSH
            protocol: Tcp
            destination_port_range: 22
            access: Deny
            priority: 100
            direction: Inbound
          - name: 'AllowSSH'
            protocol: Tcp
            source_address_prefix:
              - '174.109.158.0/24'
              - '174.109.159.0/24'
            destination_port_range: 22
            access: Allow
            priority: 101
            direction: Inbound
          - name: 'AllowMultiplePorts'
            protocol: Tcp
            source_address_prefix:
              - '174.109.158.0/24'
              - '174.109.159.0/24'
            destination_port_range:
              - 80
              - 443
            access: Allow
            priority: 102

# Update rules on existing security group
- azure_rm_securitygroup:
      resource_group: myResourceGroup
      name: mysecgroup
      rules:
          - name: DenySSH
            protocol: Tcp
            destination_port_range: 22-23
            access: Deny
            priority: 100
            direction: Inbound
          - name: AllowSSHFromHome
            protocol: Tcp
            source_address_prefix: '174.109.158.0/24'
            destination_port_range: 22-23
            access: Allow
            priority: 102
            direction: Inbound
      tags:
          testing: testing
          delete: on-exit

# Delete security group
- azure_rm_securitygroup:
      resource_group: myResourceGroup
      name: mysecgroup
      state: absent

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

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

Ключ Возвращаемое значение Описание
state
complex
всегда
Текущее состояние группы безопасности.
default_rules
список
всегда
Правила по умолчанию для группы безопасности сети.

Пример:
[{'access': 'Разрешить', 'description': 'Разрешить входящий трафик со всех ВМ в VNET', 'destination_address_prefix': 'VirtualNetwork', 'destination_port_range': '*', 'direction': 'Входящий', 'etag': 'W/"edf48d56-b315-40ca-a85d-dbcb47f2da7d"', 'id': '/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroup/myResourceGroup/providers/Microsoft.Network/networkSecurityGroups/mysecgroup/defaultSecurityRules/AllowVnetInBound', 'name': 'AllowVnetInBound', 'priority': 65000, 'protocol': '*', 'provisioning_state': 'Успешно', 'source_address_prefix': 'VirtualNetwork', 'source_port_range': '*'}, {'access': 'Разрешить', 'description': 'Разрешить входящий трафик от балансировщика Azure Load Balancer', 'destination_address_prefix': '*', 'destination_port_range': '*', 'direction': 'Входящий', 'etag': 'W/"edf48d56-b315-40ca-a85d-dbcb47f2da7d"', 'id': '/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroup/myResourceGroup/providers/Microsoft.Network/networkSecurityGroups/mysecgroup/defaultSecurityRules/AllowAzureLoadBalancerInBound', 'name': 'AllowAzureLoadBalancerInBound', 'priority': 65001, 'protocol': '*', 'provisioning_state': 'Успешно', 'source_address_prefix': 'AzureLoadBalancer', 'source_port_range': '*'}, {'access': 'Запретить', 'description': 'Запретить весь входящий трафик', 'destination_address_prefix': '*', 'destination_port_range': '*', 'direction': 'Входящий', 'etag': 'W/"edf48d56-b315-40ca-a85d-dbcb47f2da7d"', 'id': '/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroup/myResourceGroup/providers/Microsoft.Network/networkSecurityGroups/mysecgroup/defaultSecurityRules/DenyAllInBound', 'name': 'DenyAllInBound', 'priority': 65500, 'protocol': '*', 'provisioning_state': 'Успешно', 'source_address_prefix': '*', 'source_port_range': '*'}, {'access': 'Разрешить', 'description': 'Разрешить исходящий трафик со всех ВМ во все ВМ в VNET', 'destination_address_prefix': 'VirtualNetwork', 'destination_port_range': '*', 'direction': 'Исходящий', 'etag': 'W/"edf48d56-b315-40ca-a85d-dbcb47f2da7d"', 'id': '/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroup/myResourceGroup/providers/Microsoft.Network/networkSecurityGroups/mysecgroup/defaultSecurityRules/AllowVnetOutBound', 'name': 'AllowVnetOutBound', 'priority': 65000, 'protocol': '*', 'provisioning_state': 'Успешно', 'source_address_prefix': 'VirtualNetwork', 'source_port_range': '*'}, {'access': 'Разрешить', 'description': 'Разрешить исходящий трафик со всех ВМ в Интернет', 'destination_address_prefix': 'Интернет', 'destination_port_range': '*', 'direction': 'Исходящий', 'etag': 'W/"edf48d56-b315-40ca-a85d-dbcb47f2da7d"', 'id': '/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroup/myResourceGroup/providers/Microsoft.Network/networkSecurityGroups/mysecgroup/defaultSecurityRules/AllowInternetOutBound', 'name': 'AllowInternetOutBound', 'priority': 65001, 'protocol': '*', 'provisioning_state': 'Успешно', 'source_address_prefix': '*', 'source_port_range': '*'}, {'access': 'Запретить', 'description': 'Запретить весь исходящий трафик', 'destination_address_prefix': '*', 'destination_port_range': '*', 'direction': 'Исходящий', 'etag': 'W/"edf48d56-b315-40ca-a85d-dbcb47f2da7d"', 'id': '/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroup/myResourceGroup/providers/Microsoft.Network/networkSecurityGroups/mysecgroup/defaultSecurityRules/DenyAllOutBound', 'name': 'DenyAllOutBound', 'priority': 65500, 'protocol': '*', 'provisioning_state': 'Успешно', 'source_address_prefix': '*', 'source_port_range': '*'}]
id
строка
всегда
Идентификатор ресурса.

Пример:
/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroup/myResourceGroup/providers/Microsoft.Network/networkSecurityGroups/mysecgroup
location
строка
всегда
Расположение ресурса.

Пример:
westus
name
строка
всегда
Имя группы безопасности.

Пример:
mysecgroup
network_interfaces
список
всегда
Коллекция ссылок на сетевые интерфейсы.
rules
список
всегда
Коллекция правил безопасности группы безопасности сети.

Пример:
[{'access': 'Запретить', 'description': None, 'destination_address_prefix': '*', 'destination_port_range': '22', 'direction': 'Входящий', 'etag': 'W/"edf48d56-b315-40ca-a85d-dbcb47f2da7d"', 'id': '/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroup/myResourceGroup/providers/Microsoft.Network/networkSecurityGroups/mysecgroup/securityRules/DenySSH', 'name': 'DenySSH', 'priority': 100, 'protocol': 'Tcp', 'provisioning_state': 'Успешно', 'source_address_prefix': '*', 'source_port_range': '*'}, {'access': 'Разрешить', 'description': None, 'destination_address_prefix': '*', 'destination_port_range': '22', 'direction': 'Входящий', 'etag': 'W/"edf48d56-b315-40ca-a85d-dbcb47f2da7d"', 'id': '/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroup/myResourceGroup/providers/Microsoft.Network/networkSecurityGroups/mysecgroup/securityRules/AllowSSH', 'name': 'AllowSSH', 'priority': 101, 'protocol': 'Tcp', 'provisioning_state': 'Успешно', 'source_address_prefix': '174.109.158.0/24', 'source_port_range': '*'}]
subnets
список
всегда
Коллекция ссылок на подсети.
tags
словарь
всегда
Теги для назначения группе безопасности.

Пример:
{'delete': 'on-exit', 'foo': 'bar', 'testing': 'testing'}
type
строка
всегда
Тип ресурса.

Пример:
Microsoft.Network/networkSecurityGroups


Статус

  • Данный модуль не гарантирует обратную совместимость интерфейса. [превью]
  • Этот модуль поддерживается сообществом Ansible. [community]

Авторы

  • Chris Houseknecht (@chouseknecht)
  • Matt Davis (@nitzmahone)

Подсказка

Если вы обнаружите какие-либо проблемы в этом документе, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/azure_rm_securitygroup_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API