azure_rm_networkinterface — Управление сетевыми адаптерами Azure.
Новая версия с 2.1.
Обзор
- Создание, обновление или удаление сетевого адаптера. При создании сетевого адаптера необходимо указать имя существующей виртуальной сети и имя существующей подсети в этой виртуальной сети. Безопасность по умолчанию и общедоступный IP-адрес будут созданы автоматически, или вы можете указать имя существующей группы безопасности и общедоступный IP-адрес. Более подробную информацию см. в примерах ниже.
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- python >= 2.7
- azure >= 2.0.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| ad_user | По умолчанию: Нет | Имя пользователя Active Directory. Используйте при аутентификации пользователем Active Directory, а не служебным принципалом. | |
| api_profile (добавлено в 2.5) |
| Выбирает профиль API для взаимодействия с Azure-сервисами. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать с Azure Stack. | |
| append_tags | По умолчанию: да | Управляет тем, является ли поле тегов каноническим или просто добавляется к существующим тегам. При каноническом варианте любые теги, отсутствующие в параметре тегов, будут удалены из метаданных объекта. | |
| auth_source (добавлено в 2.5) |
| Управляет источником учетных данных для аутентификации. auto будет следовать стандартному приоритету параметров модуля -> переменные среды -> профиль по умолчанию в файле учетных данных ~/.azure/credentials. При установке на cli, учетные данные будут взяты из профиля Azure CLI по умолчанию.Также можно задать через переменную среды ANSIBLE_AZURE_AUTH_SOURCE. | |
| cert_validation_mode (добавлено в 2.5) |
Нет | Управляет поведением проверки сертификатов для Azure-точек входа. По умолчанию все модули проверяют сертификат сервера, но при использовании прокси-сервера HTTPS или с Azure Stack может потребоваться отключить это поведение, передав ignore. Также можно задать через профиль файла учетных данных или переменную среды AZURE_CERT_VALIDATION. | |
| client_id | По умолчанию: Нет | ID клиента Azure. Используйте при аутентификации с помощью служебного принципала. | |
| cloud_environment (добавлено в 2.4) | По умолчанию: AzureCloud | Для облачных сред, отличных от общедоступного облака США, имя среды (как определено Azure Python SDK, например, AzureChinaCloud, AzureUSGovernment) или URL-адрес точки входа для обнаружения метаданных (необходимо для Azure Stack). Также можно задать через профиль файла учетных данных или переменную среды AZURE_CLOUD_ENVIRONMENT. | |
| ip_configurations (добавлено в 2.5) | Список ip-конфигураций, если содержит несколько конфигураций, должен содержать объект конфигурации, включающий поле private_ip_address, private_ip_allocation_method, public_ip_address_name, public_ip, subnet_name, virtual_network_name, public_ip_allocation_method, name | ||
| public_ip_address_name | Имя общедоступного IP-адреса. Нет для отключения IP-адреса. | ||
| private_ip_address | Приватный IP-адрес для конфигурации IP. | ||
| name обязательно | Имя конфигурации IP. | ||
| private_ip_allocation_method |
| Метод выделения приватного IP-адреса. | |
| public_ip_allocation_method |
| Метод выделения общедоступного IP-адреса. | |
| primary | По умолчанию: нет | Является ли эта конфигурация IP основной в списке. | |
| location | По умолчанию: местоположение группы ресурсов | Действительное местоположение Azure. По умолчанию равно местоположению группы ресурсов. | |
| name обязательно | Имя сетевого интерфейса. | ||
| open_ports | По умолчанию: Нет | При создании группы безопасности по умолчанию для хоста Linux будет добавлено правило, разрешающее входящие TCP-соединения на стандартный порт SSH 22, а для хоста Windows будут добавлены правила, разрешающие входящий доступ к портам RDP 3389 и 5986. Переопределите порты по умолчанию, указав список открытых портов. | |
| os_type |
| Определяет правила, которые должны быть добавлены в группу безопасности по умолчанию. При создании сетевого интерфейса, если имя группы безопасности не указано, будет создана группа безопасности по умолчанию. Если os_type равно 'Windows', будет добавлено правило, разрешающее доступ RDP. Если os_type равно 'Linux', будет добавлено правило, разрешающее доступ SSH. | |
| password | По умолчанию: Нет | Пароль пользователя Active Directory. Используйте при аутентификации пользователем Active Directory, а не служебным принципалом. | |
| private_ip_address | (Устарело) Действительный IPv4-адрес, попадающий в указанный подсеть. Этот параметр будет устаревшим в версии 2.9, используйте ip_configurations вместо него. | ||
| private_ip_allocation_method |
| (Устарело) Укажите, является ли назначенный IP-адрес постоянным. ПРИМЕЧАНИЕ: при создании сетевого интерфейса с значением 'Статический' необходимо указать значение private_ip_address. Вы можете обновить метод выделения на 'Статический' после назначения динамического приватного IP-адреса. Этот параметр будет устаревшим в версии 2.9, используйте ip_configurations вместо него. | |
| profile | По умолчанию: Нет | Профиль безопасности, найденный в файле ~/.azure/credentials. | |
| public_ip | По умолчанию: да | (Устарело) При создании сетевого интерфейса, если имя общедоступного IP-адреса не указано, будет создан общедоступный IP-адрес по умолчанию. Установите в значение false, если вы не хотите автоматически создавать общедоступный IP-адрес. Этот параметр будет устаревшим в версии 2.9, используйте ip_configurations вместо него. | |
| public_ip_address_name | По умолчанию: Нет | (Устарело) Имя существующего объекта общедоступного IP-адреса для ассоциации с группой безопасности. Этот параметр будет устаревшим в версии 2.9, используйте ip_configurations вместо него. Псевдонимы: public_ip_address, public_ip_name | |
| public_ip_allocation_method |
| (Устарело) Если public_ip_address_name не указан, будет создан общедоступный IP-адрес по умолчанию. Метод выделения определяет, является ли общедоступный IP-адрес, назначенный сетевому интерфейсу, постоянным. Этот параметр будет устаревшим в версии 2.9, используйте ip_configurations вместо него. | |
| resource_group обязательно | Имя группы ресурсов, в которой существует или будет создан сетевой интерфейс. | ||
| secret | По умолчанию: Нет | Секрет клиента Azure. Используйте при аутентификации с помощью служебного принципала. | |
| security_group_name | По умолчанию: Нет | Имя существующей группы безопасности, с которой нужно связать сетевой интерфейс. Если не указано, будет создана группа безопасности по умолчанию. Псевдонимы: security_group | |
| state |
| Утверждение состояния сетевого интерфейса. Используйте 'present' для создания или обновления интерфейса и 'absent' для удаления интерфейса. | |
| subnet_name обязательно | По умолчанию: Нет | Имя существующей подсети в указанной виртуальной сети. Требуется при создании сетевого интерфейса Псевдонимы: subnet | |
| subscription_id | По умолчанию: Нет | Ваш идентификатор подписки Azure. | |
| tags | По умолчанию: Нет | Словарь пар строка:строка для назначения метаданных объекту. Метаданные-теги объекта будут обновлены любыми предоставленными значениями. Для удаления тегов установите параметр append_tags в значение false. | |
| tenant | По умолчанию: Нет | Идентификатор 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 network interface with minimal parameters
azure_rm_networkinterface:
name: nic001
resource_group: Testing
virtual_network_name: vnet001
subnet_name: subnet001
ip_configurations:
- name: ipconfig1
public_ip_address_name: publicip001
primary: True
- 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
ip_configurations:
- name: ipconfig1
primary: True
- 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
ip_configurations:
- name: ipconfig1
public_ip_address_name: publicip001
primary: True
- 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
ip_configurations:
- name: ipconfig1
public_ip_address_name: publicip001
primary: True
- name: Create a network with mutilple ip configurations
azure_rm_networkinterface:
name: nic004
resource_group: Testing
subnet_name: subnet001
virtual_network_name: vnet001
security_group_name: secgroup001
ip_configurations:
- name: ipconfig1
public_ip_address_name: publicip001
primary: True
- name: ipconfig2
- name: Delete network interface
azure_rm_networkinterface:
resource_group: Testing
name: nic003
state: absent
Значения возврата
Общие значения возврата документированы здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| state dict | всегда | Текущее состояние сетевого интерфейса. Пример: {'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_configurations': [{'subnet': {}, 'load_balancer_backend_address_pools': [], 'name': 'default', 'private_ip_allocation_method': 'Static', 'private_ip_address': '10.1.0.10', 'public_ip_address': {'id': '/subscriptions/XXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXX/resourceGroups/Testing/providers/Microsoft.Network/publicIPAddresses/publicip001', 'name': 'publicip001'}}], 'provisioning_state': 'Succeeded', 'type': 'Microsoft.Network/networkInterfaces', 'id': '/subscriptions/XXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXX/resourceGroups/Testing/providers/Microsoft.Network/networkInterfaces/nic003', 'network_security_group': {}} |
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантируется обратной совместимостью.
Автор
- Chris Houseknecht (@chouseknecht)
- Matt Davis (@nitzmahone)
- Yuwei Zhou (@yuwzho)
Подсказка
Если вы заметили какие-либо проблемы в данной документации, вы можете редактировать этот документ, чтобы улучшить его.
© 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_networkinterface_module.html