azure_rm_networkinterface – Управление сетевыми адаптерами Azure.
Новая версия с 2.1.
Описание
- Создание, обновление или удаление сетевого адаптера. При создании сетевого адаптера необходимо указать имя существующей виртуальной сети, имя существующей подсети в виртуальной сети. Автоматически будет создана группа безопасности по умолчанию и общедоступный IP-адрес, или вы можете указать имя существующей группы безопасности и общедоступного IP-адреса. Более подробную информацию см. в примерах ниже.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- python >= 2.7
- azure >= 2.0.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| ad_user - | Имя пользователя Active Directory. Используйте при аутентификации пользователем Active Directory, а не главным сервисом. | ||
| adfs_authority_url - добавлен в 2.6 | По умолчанию: null | URL авторизации Azure AD. Используйте при аутентификации с именем пользователя/паролем и собственной службой ADFS. | |
| api_profile - добавлен в 2.5 | По умолчанию: "latest" | Выбирает профиль API для взаимодействия с Azure-сервисами. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack. | |
| append_tags boolean |
| Управление тем, является ли поле тегов каноническим или оно просто добавляется к существующим тегам. При каноническом значении любые теги, отсутствующие в параметре тегов, будут удалены из метаданных объекта. | |
| auth_source - добавлен в 2.5 |
| Управление источником используемых учетных данных для аутентификации. Если не указано, будет использована переменная среды 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 |
| Управление проверкой сертификатов для 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. | |
| create_with_security_group boolean добавлен в 2.6 |
| Указывает, должен ли быть создан групповой параметр безопасности по умолчанию с сетевым адаптером. Применимо только при создании нового сетевого адаптера. | |
| dns_servers list добавлен в 2.7 | Какие DNS-серверы должен использовать сетевой адаптер Список IP-адресов | ||
| enable_accelerated_networking boolean добавлен в 2.7 |
| Указывает, должен ли сетевой адаптер быть создан с функцией ускоренной обработки сетевого трафика. | |
| enable_ip_forwarding boolean добавлен в 2.7 |
| Включить или нет переадресацию IP-адресов. Псевдонимы: ip_forwarding | |
| ip_configurations - добавлен в 2.5 | Список конфигураций IP-адресов. Если содержит несколько конфигураций, должна содержать объект конфигурации, включающий поля private_ip_address, private_ip_allocation_method, public_ip_address_name, public_ip, public_ip_allocation_method, name. | ||
| load_balancer_backend_address_pools - добавлен в 2.6 | Список идентификаторов существующих пулов обратных адресов балансировщика нагрузки, которые нужно ассоциировать с сетевым адаптером. Может быть записан как идентификатор ресурса. Также может быть словарем с полями name и load_balancer. | ||
| name - / обязательно | Имя конфигурации IP-адреса. | ||
| primary boolean |
| Является ли данная конфигурация IP-адреса основной в списке. | |
| private_ip_address - | Приватный IP-адрес для конфигурации IP-адреса. | ||
| private_ip_allocation_method - |
| Метод распределения приватных IP-адресов. | |
| public_ip_address_name - | Имя публичного IP-адреса. Нет для отключения IP-адреса. | ||
| public_ip_allocation_method - |
| Метод распределения публичных 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 boolean |
| (Устаревает) При создании сетевого интерфейса, если имя публичного 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 - | Существующая группа безопасности, с которой следует связать сетевой интерфейс. Если не указано, по умолчанию будет создана группа безопасности, когда create_with_security_group имеет значение true.Может быть именем группы безопасности. Убедитесь, что группа безопасности находится в той же группе ресурсов, если вы указываете только ее имя. Может быть идентификатором ресурса. Может быть словарем, содержащим name и resource_group группы безопасности.псевдонимы: security_group_name | ||
| state - |
| Утверждение состояния сетевого интерфейса. Используйте 'наличие' для создания или обновления интерфейса, и 'отсутствует' для удаления интерфейса. | |
| subnet_name - / обязательно | Имя существующей подсети в указанной виртуальной сети. Обязательно при создании сетевого интерфейса Используйте группу ресурсов virtual_network. псевдонимы: subnet | ||
| subscription_id - | Ваш идентификатор подписки Azure. | ||
| tags - | Словарь пар строка:строка для назначения в качестве метаданных объекту. Метаданные теги объекта будут обновлены любыми предоставленными значениями. Для удаления тегов установите параметр append_tags в false. | ||
| tenant - | Идентификатор Azure-аренды. Используется при аутентификации с помощью принципала службы. | ||
| virtual_network - / обязательно | Существующая виртуальная сеть, с которой будет связан сетевой интерфейс. Обязательно при создании сетевого интерфейса. Может быть именем виртуальной сети. Убедитесь, что ваша виртуальная сеть находится в той же группе ресурсов, что и сетевой интерфейс, если вы указываете только имя. Может быть идентификатором ресурса виртуальной сети. Может быть словарем, содержащим name и resource_group виртуальной сети.псевдонимы: virtual_network_name | ||
Примечания
Примечание
- Для аутентификации с 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: 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: vnet001
subnet_name: subnet001
create_with_security_group: False
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: vnet001
subnet_name: subnet001
os_type: Windows
rdp_port: 3399
security_group: "/subscriptions/XXXXXXX/resourceGroups/Testing/providers/Microsoft.Network/networkSecurityGroups/nsg001"
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: vnet001
subnet_name: subnet001
security_group: 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: vnet001
security_group:
name: testnic002
resource_group: Testing1
ip_configurations:
- name: ipconfig1
public_ip_address_name: publicip001
primary: True
- name: ipconfig2
load_balancer_backend_address_pools:
- "{{ loadbalancer001.state.backend_address_pools[0].id }}"
- name: backendaddrpool1
load_balancer: loadbalancer001
- name: Create a network interface in accelerated networking mode
azure_rm_networkinterface:
name: nic005
resource_group: Testing
virtual_network_name: vnet001
subnet_name: subnet001
enable_accelerated_networking: True
- name: Create a network interface with IP forwarding
azure_rm_networkinterface:
name: nic001
resource_group: Testing
virtual_network: vnet001
subnet_name: subnet001
ip_forwarding: True
ip_configurations:
- name: ipconfig1
public_ip_address_name: publicip001
primary: True
- name: Create a network interface with dns servers
azure_rm_networkinterface:
name: nic009
resource_group: Testing
virtual_network: vnet001
subnet_name: subnet001
dns_servers:
- 8.8.8.8
- name: Delete network interface
azure_rm_networkinterface:
resource_group: Testing
name: nic003
state: absent
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие являются полями, уникальными для этого модуля:
| Ключ | Возвращаемое | Описание |
|---|---|---|
| state словарь | всегда | Текущее состояние сетевого интерфейса. Пример: {'dns_settings': {'applied_dns_servers': [], 'dns_servers': [], 'internal_dns_name_label': None, 'internal_fqdn': None}, 'enable_ip_forwarding': False, 'etag': 'W/"be115a43-2148-4545-a324-f33ad444c926"', 'id': '/subscriptions/XXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXX/resourceGroups/Testing/providers/Microsoft.Network/networkInterfaces/nic003', 'ip_configurations': [{'name': 'default', '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'}, 'subnet': {}, 'load_balancer_backend_address_pools': []}], 'location': 'eastus2', 'mac_address': None, 'name': 'nic003', 'network_security_group': {'id': '/subscriptions//XXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXX/resourceGroups/Testing/providers/Microsoft.Network/networkSecurityGroups/nsg001', 'name': 'nsg001'}, 'primary': None, 'provisioning_state': 'Succeeded', 'tags': None, 'type': 'Microsoft.Network/networkInterfaces'} |
Статус
- Этот модуль не гарантирует обратной совместимости интерфейса. [предварительная версия]
- Этот модуль поддерживается партнером Ansible. [сертифицированный]
Авторы
- 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.7/modules/azure_rm_networkinterface_module.html