azure_rm_networkinterface — Управление сетевыми интерфейсами Azure.
Новая версия с 2.1.
- Обзор
- Требования (к хосту, на котором выполняется модуль)
- Параметры
- Примеры
- Значения возврата
- Примечания
Обзор
- Создание, обновление или удаление сетевого интерфейса. При создании сетевого интерфейса необходимо указать имя существующей виртуальной сети, имя существующей подсети в пределах виртуальной сети. Автоматически будет создана группа безопасности по умолчанию и общедоступный IP-адрес, или вы можете указать имя существующей группы безопасности и общедоступного IP-адреса. Более подробную информацию см. в примерах ниже.
Требования (к хосту, на котором выполняется модуль)
- python >= 2.7
- azure >= 2.0.0
Параметры
| параметр | обязательно | по умолчанию | варианты | комментарии |
|---|---|---|---|---|
| ad_user |
нет | Имя пользователя Active Directory. Используется при аутентификации с пользователем Active Directory вместо службы-принципала. |
||
| append_tags |
нет | True | Используется для управления тем, является ли поле тегов каноническим или оно просто добавляется к существующим тегам. При каноническом значении любые теги, отсутствующие в параметре тегов, будут удалены из метаданных объекта. |
|
| client_id |
нет | Идентификатор клиента Azure. Используется при аутентификации с помощью службы-принципала. |
||
| cloud_environment |
нет | AzureCloud | Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, AzureChinaCloud, AzureUSGovernment), или URL-адрес конечной точки обнаружения метаданных (требуется для Azure Stack). Также может быть задан через файл профиля учетных данных или переменную среды AZURE_CLOUD_ENVIRONMENT. |
|
| location |
нет | location ресурсной группы | Допустимое расположение Azure. По умолчанию совпадает с расположением ресурсной группы. |
|
| name |
да | Имя сетевого интерфейса. |
||
| open_ports |
нет | При создании группы безопасности по умолчанию для хоста Linux добавляется правило, разрешающее входящие TCP-соединения на стандартный порт SSH 22, а для хоста Windows добавляются правила, разрешающие входящий доступ к портам RDP 3389 и 5986. Переопределите порты по умолчанию, предоставив список открытых портов. |
||
| os_type |
нет | Linux |
|
Определяет правила, которые будут добавлены в группу безопасности по умолчанию. При создании сетевого интерфейса, если имя группы безопасности не указано, будет создана группа безопасности по умолчанию. Если os_type — "Windows", будет добавлено правило, разрешающее доступ RDP. Если os_type — "Linux", будет добавлено правило, разрешающее доступ SSH. |
| password |
нет | Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory вместо службы-принципала. |
||
| private_ip_address |
нет | Допустимый IPv4-адрес, который входит в указанную подсеть. |
||
| private_ip_allocation_method |
нет | Dynamic |
|
Указывает, является ли назначенный IP-адрес постоянным. ПРИМЕЧАНИЕ: при создании сетевого интерфейса с указанием значения "Static" требуется указать значение private_ip_address. Вы можете обновить метод выделения на "Static" после назначения динамического частного IP-адреса. |
| profile |
нет | Профиль безопасности, найденный в файле ~/.azure/credentials. |
||
| public_ip |
нет | True | При создании сетевого интерфейса, если имя общедоступного IP-адреса не указано, будет создан общедоступный IP-адрес по умолчанию. Установите в значение false, если вы не хотите автоматически создавать общедоступный IP-адрес. |
|
| public_ip_address_name |
нет | Имя существующего объекта общедоступного IP-адреса для ассоциации с группой безопасности. псевдонимы: public_ip_address, public_ip_name |
||
| public_ip_allocation_method |
нет | Dynamic |
|
Если public_ip_address_name не указан, будет создан общедоступный IP-адрес по умолчанию. Метод выделения определяет, является ли постоянным общедоступный IP-адрес, назначенный сетевому интерфейсу. |
| resource_group |
да | Имя ресурсной группы, где существует или будет создан сетевой интерфейс. |
||
| secret |
нет | Секретный ключ клиента Azure. Используется при аутентификации с помощью службы-принципала. |
||
| security_group_name |
нет | Имя существующей группы безопасности, с которой необходимо связать сетевой интерфейс. Если не указано, будет создана группа безопасности по умолчанию. псевдонимы: security_group |
||
| state |
нет | present |
|
Утверждение состояния сетевого интерфейса. Используйте 'present' для создания или обновления интерфейса и 'absent' для удаления интерфейса. |
| subnet_name |
да | Имя существующей подсети в указанной виртуальной сети. Требуется при создании сетевого интерфейса псевдонимы: subnet |
||
| subscription_id |
нет | Идентификатор вашей подписки Azure. |
||
| tags |
нет | Словарь пар строка:строка для назначения в качестве метаданных объекту. Метаданные тегов объекта будут обновлены всеми предоставленными значениями. Для удаления тегов установите параметр append_tags в false. |
||
| tenant |
нет | Идентификатор клиента Azure. Используется при аутентификации с помощью службы-принципала. |
||
| virtual_network_name |
да | Имя существующей виртуальной сети, с которой будет связан сетевой интерфейс. Требуется при создании сетевого интерфейса. псевдонимы: virtual_network |
Примеры
- name: Create a network interface with minimal parameters
azure_rm_networkinterface:
name: nic001
resource_group: Testing
virtual_network_name: vnet001
subnet_name: subnet001
- name: Create a network interface with private IP address only (no Public IP)
azure_rm_networkinterface:
name: nic001
resource_group: Testing
virtual_network_name: vnet001
subnet_name: subnet001
public_ip: no
- name: Create a network interface for use in a Windows host (opens RDP port) with custom RDP port
azure_rm_networkinterface:
name: nic002
resource_group: Testing
virtual_network_name: vnet001
subnet_name: subnet001
os_type: Windows
rdp_port: 3399
- name: Create a network interface using existing security group and public IP
azure_rm_networkinterface:
name: nic003
resource_group: Testing
virtual_network_name: vnet001
subnet_name: subnet001
security_group_name: secgroup001
public_ip_address_name: publicip001
- name: Delete network interface
azure_rm_networkinterface:
resource_group: Testing
name: nic003
state: absent
Значения возврата
Общие значения возврата описаны здесь Значения возврата, следующие поля уникальны для этого модуля:
| имя | описание | возвращается | тип | пример |
|---|---|---|---|---|
| state | Текущее состояние сетевого интерфейса. |
всегда | словарь | {'dns_settings': {'dns_servers': [], 'internal_fqdn': None, 'internal_dns_name_label': None, 'applied_dns_servers': []}, 'name': 'nic003', 'tags': None, 'primary': None, 'enable_ip_forwarding': False, 'etag': 'W/"be115a43-2148-4545-a324-f33ad444c926"', 'location': 'eastus2', 'mac_address': None, 'ip_configuration': {'private_ip_address': '10.1.0.10', 'private_ip_allocation_method': 'Static', 'public_ip_address': {'id': '/subscriptions/XXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXX/resourceGroups/Testing/providers/Microsoft.Network/publicIPAddresses/publicip001', 'name': 'publicip001'}, 'name': 'default', 'subnet': {}}, 'provisioning_state': 'Succeeded', 'type': 'Microsoft.Network/networkInterfaces', 'id': '/subscriptions/XXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXX/resourceGroups/Testing/providers/Microsoft.Network/networkInterfaces/nic003', 'network_security_group': {}} |
Примечания
Примечание
- Для аутентификации в 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 в среде.
Статус
Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость интерфейса.
Для помощи в разработке модулей, если вы заинтересованы, пожалуйста, прочитайте Документация сообщества и участие, Тестирование Ansible и Разработка модулей.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/azure_rm_networkinterface_module.html
