Spec-Zone.ru › Ansible 2.8

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
URL-адрес авторизации Azure AD. Используется при аутентификации с помощью имени пользователя/пароля и собственной авторизацией ADFS.
api_profile
строка
добавлен в 2.5
Значение по умолчанию:
"latest"
Выбирает профиль API для взаимодействия с Azure-сервисами. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать с Azure Stack.
append_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.
create_with_security_group
логическое значение
добавлен в 2.6
    Варианты:
  • нет
  • да ←
Указывает, следует ли создавать группу безопасности вместе с сетевым адаптером.
Если этот флаг установлен в True и не установлена security_group, будет создана группа безопасности по умолчанию.
dns_servers
список
добавлен в 2.7
Какие DNS-серверы должен использовать сетевой адаптер
Список IP-адресов
enable_accelerated_networking
логическое значение
добавлен в 2.7
    Варианты:
  • нет ←
  • да
Указывает, должен ли сетевой адаптер создаваться с функцией ускоренного сетевого подключения или нет
enable_ip_forwarding
логическое значение
добавлен в 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
application_security_groups
-
добавлен в 2.8
Список групп безопасности приложений, в которые включена конфигурация IP-адреса.
Элемент списка может быть идентификатором ресурса группы безопасности приложений или словарем resource_group и name.
load_balancer_backend_address_pools
-
добавлен в 2.6
Список существующих идентификаторов пулов адресов обратной связи балансировщика нагрузки, которые необходимо связать с сетевым адаптером.
Он может быть записан как идентификатор ресурса.
Также может быть словарем с полями name и load_balancer.
name
- / обязательно
Имя конфигурации IP-адреса.
primary
логическое значение
    Варианты:
  • нет ←
  • да
Является ли конфигурация IP-адреса основной в списке.
private_ip_address
-
Приватный IP-адрес для конфигурации IP-адреса.
private_ip_allocation_method
-
    Варианты:
  • Динамический ←
  • Статический
Метод выделения приватного IP-адреса.
public_ip_address_name
-
Имя общедоступного IP-адреса. Отсутствует для отключения IP-адреса.

псевдонимы: public_ip_address, public_ip_name
public_ip_allocation_method
-
    Варианты:
  • Динамический ←
  • Статический
Метод выделения общедоступного IP-адреса.
location
-
Действительное расположение Azure. По умолчанию используется расположение группы ресурсов.
name
- / обязательно
Имя сетевого адаптера.
open_ports
-
При создании группы безопасности по умолчанию для хоста Linux добавляется правило, разрешающее входящие TCP-соединения на стандартный SSH-порт 22, а для хоста Windows правила, разрешающие входящий доступ к портам RDP 3389 и 5986. Измените порты по умолчанию, предоставив список открытых портов.
os_type
-
    Варианты:
  • Windows
  • Linux ←
Определяет правила, которые будут добавлены в группу безопасности по умолчанию. При создании сетевого адаптера, если имя группы безопасности не указано, будет создана группа безопасности по умолчанию. Если os_type равен 'Windows', будет добавлено правило, разрешающее доступ RDP. Если os_type равен 'Linux', будет добавлено правило, разрешающее доступ SSH.
пароль
-
Пароль пользователя 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
-
Существующая группа безопасности, с которой необходимо ассоциировать сетевой интерфейс. Если не указана, по умолчанию будет создана группа безопасности, когда create_with_security_group имеет значение true.
Может быть именем группы безопасности.
Убедитесь, что группа безопасности находится в той же группе ресурсов, если вы предоставляете только ее имя.
Может быть идентификатором ресурса.
Может быть словарем, содержащим name и resource_group группы безопасности.

псевдонимы: security_group_name
state
-
    Варианты:
  • отсутствует
  • присутствует ←
Утвердить состояние сетевого интерфейса. Используйте present для создания или обновления интерфейса и absent для удаления интерфейса.
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, или выполнить вход перед запуском задач или игры с помощью 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.

Примеры

- name: Create a network interface with minimal parameters
  azure_rm_networkinterface:
    name: nic001
    resource_group: myResourceGroup
    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: myResourceGroup
    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: myResourceGroup
    virtual_network: vnet001
    subnet_name: subnet001
    os_type: Windows
    rdp_port: 3399
    security_group: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroup/myResourceGroup/providers/Microsoft.Network/networkSecurit
                     yGroups/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: myResourceGroup
    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: myResourceGroup
    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: myResourceGroup
    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: myResourceGroup
    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: myResourceGroup
    virtual_network: vnet001
    subnet_name: subnet001
    dns_servers:
      - 8.8.8.8

- name: Delete network interface
  azure_rm_networkinterface:
    resource_group: myResourceGroup
    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/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroup/myResourceGroup/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/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroup/myResourceGroup/providers/Microsoft.Network/publicIPAddresse s/publicip001', 'name': 'publicip001'}, 'subnet': {}, 'load_balancer_backend_address_pools': []}], 'location': 'eastus2', 'mac_address': None, 'name': 'nic003', 'network_security_group': {'id': '/subscriptions//xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroup/myResourceGroup/providers/Microsoft.Network/networkSecurityGroups/nsg001', 'name': 'nsg001'}, 'primary': None, 'provisioning_state': 'Успешно', 'tags': None, 'type': 'Microsoft.Network/networkInterfaces'}


Статус

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

Авторы

  • 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.8/modules/azure_rm_networkinterface_module.html

Spec-Zone.ru

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