azure_rm_subnet - Управление подсетями Azure.
Новая версия с 2.1.
Обзор
- Создание, обновление или удаление подсети в заданной виртуальной сети. Позволяет устанавливать и обновлять префикс адреса CIDR, который должен быть валиден в контексте виртуальной сети. Используйте модуль azure_rm_networkinterface для ассоциации интерфейсов с подсетью и назначения конкретных IP-адресов.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- python >= 2.7
- azure >= 2.0.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| ad_user | Значение по умолчанию: None | Имя пользователя Active Directory. Используется при аутентификации с пользователем Active Directory вместо сервисного принципала. |
| address_prefix_cidr обязательно | CIDR, определяющий пространство IPv4 адресов подсети. Должен быть валиден в контексте виртуальной сети. алиасы: address_prefix | |
| api_profile (добавлен в 2.5) |
| Выбирает профиль API для использования при взаимодействии с Azure-сервисами. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать с Azure Stack. |
| auth_source (добавлен в 2.5) |
| Управляет источником учетных данных для аутентификации. auto будет следовать по умолчанию приоритету параметров модуля -> переменных среды -> профиля по умолчанию в файле учетных данных ~/.azure/credentials. При установке cli, учетные данные будут взяты из профиля Azure CLI по умолчанию.Также можно установить через переменную среды ANSIBLE_AZURE_AUTH_SOURCE. |
| cert_validation_mode (добавлен в 2.5) |
None | Управляет поведением проверки сертификата для Azure-эндпоинтов. По умолчанию все модули проверяют сертификат сервера, но при использовании HTTPS-прокси или при работе с Azure Stack может потребоваться отключить это поведение, передав ignore. Также можно установить через профиль файла учетных данных или переменную среды AZURE_CERT_VALIDATION. |
| client_id | Значение по умолчанию: None | Идентификатор клиента Azure. Используется при аутентификации с помощью сервисного принципала. |
| cloud_environment (добавлен в 2.4) | Значение по умолчанию: AzureCloud | Для облачных сред, отличных от общедоступного облака США, имя среды (как определено Azure Python SDK, например, AzureChinaCloud, AzureUSGovernment), или URL-адрес конечной точки обнаружения метаданных (необходим для Azure Stack). Также можно установить через профиль файла учетных данных или переменную среды AZURE_CLOUD_ENVIRONMENT. |
| name обязательно | Имя подсети. | |
| password | Значение по умолчанию: None | Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory вместо сервисного принципала. |
| profile | Значение по умолчанию: None | Профиль безопасности, найденный в файле ~/.azure/credentials. |
| resource_group обязательно | Имя группы ресурсов. | |
| secret | Значение по умолчанию: None | Секрет клиента Azure. Используется при аутентификации с помощью сервисного принципала. |
| security_group_name | Значение по умолчанию: None | Имя существующей группы безопасности, с которой нужно связать подсеть. алиасы: security_group |
| state |
| Установить состояние подсети. Используйте 'present' для создания или обновления подсети и 'absent' для удаления подсети. |
| subscription_id | Значение по умолчанию: None | Идентификатор вашей подписки Azure. |
| tenant | Значение по умолчанию: None | Идентификатор Azure-аренды. Используется при аутентификации с помощью сервисного принципала. |
| virtual_network_name обязательно | Имя существующей виртуальной сети, с которой подсеть связана или будет связана. алиасы: virtual_network |
Примечания
Примечание
- Для аутентификации в Azure вы можете передавать параметры, устанавливать переменные среды или использовать профиль, хранящийся в файле ~/.azure/credentials. Аутентификация возможна с помощью сервисного принципала или пользователя 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 в среде.
Примеры
- name: Create a subnet
azure_rm_subnet:
name: foobar
virtual_network_name: My_Virtual_Network
resource_group: Testing
address_prefix_cidr: "10.1.0.0/24"
- name: Delete a subnet
azure_rm_subnet:
name: foobar
virtual_network_name: My_Virtual_Network
resource_group: Testing
state: absent
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращено | Описание | ||
|---|---|---|---|---|
| state сложное | успех | Текущее состояние подсети. | ||
| id str | Путь к ресурсу подсети. | |||
| address_prefix str | IP-адрес CIDR. | |||
| network_security_group сложное | | |||
| id str | Идентификатор ресурса группы безопасности. | |||
| name str | Имя группы безопасности. | |||
| name str | Имя подсети. | |||
| provisioning_state str | Результат выполнения операции подготовки. | |||
Статус
Этот модуль помечен как экспериментальный, что означает, что его интерфейс не гарантирует обратной совместимости.
Автор
- 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.5/modules/azure_rm_subnet_module.html