Spec-Zone.ru › Ansible

azure.azcollection.azure_rm_networkinterface модуль — Управление сетевыми интерфейсами Azure

Примечание

Этот модуль входит в коллекцию azure.azcollection (версия 2.7.0).

Эта коллекция, возможно, уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить её установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install azure.azcollection. Для использования этого модуля необходимы дополнительные требования. Подробности см. в разделе Требования.

Для использования в плейбуке укажите: azure.azcollection.azure_rm_networkinterface.

Добавлена в azure.azcollection 0.1.0

  • Обзор
  • Требования
  • Параметры
  • Примечания
  • См. также
  • Примеры
  • Значения возврата

Обзор

  • Создание, обновление или удаление сетевого интерфейса.
  • При создании сетевого интерфейса необходимо указать имя существующей виртуальной сети и имя существующего подсети в этой виртуальной сети.
  • Группа безопасности и общедоступный IP-адрес по умолчанию будут созданы автоматически.
  • Либо можно указать имя существующей группы безопасности и общедоступный IP-адрес.
  • Более подробную информацию см. в примерах ниже.

Требования

Ниже перечислены требования к хосту, на котором выполняется этот модуль.

  • python >= 2.7
  • На хосте, на котором выполняется этот модуль, должна быть установлена коллекция azure.azcollection через Galaxy.
  • Все пакеты Python, перечисленные в файле requirements.txt коллекции, должны быть установлены через pip на хосте, на котором выполняются модули из azure.azcollection.
  • Полные инструкции по установке см. на странице https://galaxy.ansible.com/azure/azcollection

Параметры

Параметр

Комментарии

ad_user

string

Имя пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с главным субъектом безопасности.

adfs_authority_url

string

added in azure.azcollection 0.0.1

URL-адрес узла Azure AD. Используйте при аутентификации с помощью имени пользователя/пароля и собственным узлом ADFS.

api_profile

string

added in azure.azcollection 0.0.1

Выбирает профиль API для использования при взаимодействии с службами Azure. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать с Azure Stack.

Default: "latest"

append_tags

boolean

Используется для управления тем, является ли поле тегов каноническим или просто добавляется к существующим тегам.

При каноническом значении любые теги, не найденные в параметре тегов, будут удалены из метаданных объекта.

Choices:

  • false
  • true ← (default)

auth_source

string

added in azure.azcollection 0.0.1

Управляет источником учетных данных, используемых для аутентификации.

Также может быть задано через переменную среды ANSIBLE_AZURE_AUTH_SOURCE.

При установке в значение auto (по умолчанию) приоритет имеет: параметры модуля -> env -> credential_file -> cli.

При установке в значение env, учетные данные будут считываться из переменных среды

При установке в значение credential_file, профиль будет считываться из ~/.azure/credentials.

При установке в значение cli, учетные данные будут получены из профиля Azure CLI. subscription_id или переменная среды AZURE_SUBSCRIPTION_ID могут использоваться для идентификации идентификатора подписки, если присутствует более одного, в противном случае используется подписка az cli по умолчанию.

При установке в значение msi, хост-машина должна быть ресурсом Azure с включенным расширением MSI. subscription_id или переменная среды AZURE_SUBSCRIPTION_ID могут использоваться для идентификации идентификатора подписки, если ресурсу предоставлен доступ к более чем одной подписке, в противном случае выбирается первая подписка.

Параметр msi был добавлен в Ansible 2.6.

Choices:

  • "auto" ← (default)
  • "cli"
  • "credential_file"
  • "env"
  • "msi"

cert_validation_mode

string

added in azure.azcollection 0.0.1

Управляет поведением проверки сертификата для конечных точек Azure. По умолчанию все модули будут проверять серверный сертификат, но при использовании прокси-сервера HTTPS или в Azure Stack может потребоваться отключить это поведение, передав ignore. Также может быть задано через профиль файла учетных данных или переменную среды AZURE_CERT_VALIDATION.

Choices:

  • "ignore"
  • "validate"

client_id

string

Идентификатор клиента Azure. Используйте при аутентификации с помощью субъекта безопасности или управляемой идентификации (msi).

Также может быть задано через переменную среды AZURE_CLIENT_ID.

cloud_environment

string

added in azure.azcollection 0.0.1

Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, AzureChinaCloud, AzureUSGovernment), или URL-адрес конечной точки обнаружения метаданных (требуется для Azure Stack). Также может быть задано через профиль файла учетных данных или переменную среды AZURE_CLOUD_ENVIRONMENT.

Default: "AzureCloud"

create_with_security_group

boolean

Следует ли создавать группу безопасности вместе с сетевым интерфейсом.

Если этот флаг установлен в True и не задана security_group, будет создана группа безопасности по умолчанию.

Choices:

  • false
  • true ← (default)

disable_instance_discovery

boolean

added in azure.azcollection 2.3.0

Определяет, выполняется ли обнаружение экземпляров при попытке аутентификации. Установка этого значения в true полностью отключит как обнаружение экземпляров, так и проверку подлинности. Эта функция предназначена для использования в сценариях, когда конечная точка метаданных недоступна, например, в частных облаках или Azure Stack. Процесс обнаружения экземпляров включает в себя получение метаданных узла из https://login.microsoft.com/ для проверки узла. Установив это значение в **True**, проверка узла отключается. В результате необходимо убедиться, что настроенный узел является действительным и заслуживающим доверия.

Устанавливается через профиль файла учетных данных или переменную среды AZURE_DISABLE_INSTANCE_DISCOVERY.

Choices:

  • false ← (default)
  • true

dns_servers

list / elements=string

Какие DNS-серверы должен использовать сетевой интерфейс для поиска.

Список IP-адресов.

enable_accelerated_networking

boolean

Следует ли создавать сетевой интерфейс с функцией ускоренной работы сети или нет.

Choices:

  • false ← (default)
  • true

enable_ip_forwarding

aliases: ip_forwarding

boolean

Включить IP-передачу.

Варианты:

  • false ← (по умолчанию)
  • true

ip_configurations

список / элементы=словарь

Список IP-конфигураций. Каждый объект конфигурации должен включать поле private_ip_address, private_ip_allocation_method, public_ip_address_name, public_ip, public_ip_allocation_method, name.

По умолчанию: []

application_gateway_backend_address_pools

список / элементы=любой

добавлен в azure.azcollection 1.10.0

Список существующих пулов адресов обратной связи шлюза приложений для ассоциации с сетевым интерфейсом.

Можно записать в виде идентификатора ресурса.

Также можно в виде словаря name и application_gateway.

application_security_groups

список / элементы=любой

Список групп безопасности приложений, в которых включена конфигурация IP.

Элементом списка может быть идентификатор ресурса группы безопасности приложений, или имя группы безопасности приложений, расположенной в текущей группе ресурсов, или словарь с группами ресурсов и именами.

load_balancer_backend_address_pools

список / элементы=любой

Список существующих пулов адресов обратной связи балансировщика нагрузки для ассоциации с сетевым интерфейсом.

Можно записать в виде идентификатора ресурса.

Также можно в виде словаря name и load_balancer.

name

строка / обязательно

Имя конфигурации IP.

primary

boolean

Является ли конфигурация IP основной в списке.

Первая конфигурация IP по умолчанию устанавливается с primary=True.

Варианты:

  • false ← (по умолчанию)
  • true

private_ip_address

строка

Приватный IP-адрес для конфигурации IP.

private_ip_address_version

строка

Версия конфигурации IP.

Варианты:

  • "IPv4" ← (по умолчанию)
  • "IPv6"

private_ip_allocation_method

строка

Метод выделения приватного IP-адреса.

Варианты:

  • "Dynamic" ← (по умолчанию)
  • "Static"

public_ip_address_name

aliases: public_ip_address, public_ip_name

строка

Имя публичного IP-адреса. Ничего для отключения IP-адреса.

public_ip_allocation_method

строка

Метод выделения публичного IP-адреса.

Варианты:

  • "Dynamic" ← (по умолчанию)
  • "Static"

location

строка

Действительное расположение Azure. По умолчанию — расположение группы ресурсов.

log_mode

строка

Родительский аргумент.

log_path

строка

Родительский аргумент.

name

строка / обязательно

Имя сетевого интерфейса.

open_ports

список / элементы=строка

При создании группы безопасности по умолчанию для хоста Linux, будет добавлено правило, разрешающее входящие TCP-соединения на стандартный порт SSH 22, а для хоста Windows будут добавлены правила, разрешающие входящий доступ к портам RDP 3389 и 5986. Переопределите порты по умолчанию, указав список открытых портов.

os_type

string

Определяет правила, которые будут добавлены к группе безопасности по умолчанию.

При создании сетевого интерфейса, если имя группы безопасности не указано, будет создана группа безопасности по умолчанию.

Если os_type=Windows, будет добавлено правило, разрешающее доступ по RDP.

Если os_type=Linux, будет добавлено правило, разрешающее доступ по SSH.

Выбираемые значения:

  • "Windows"
  • "Linux" ← (по умолчанию)

password

string

Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory вместо служебного принципала.

profile

string

Профиль безопасности, найденный в файле ~/.azure/credentials.

resource_group

string / обязательно

Имя группы ресурсов, в которой существует или будет создан сетевой интерфейс.

secret

string

Секрет клиента Azure. Используется при аутентификации со служебным принципалом.

security_group

псевдонимы: security_group_name

любой

Существующая группа безопасности, с которой будет связан сетевой интерфейс.

Если не указана, группа безопасности по умолчанию будет создана, когда create_with_security_group=true.

Может быть именем группы безопасности.

Убедитесь, что группа безопасности находится в той же группе ресурсов, если вы указываете только её имя.

Может быть идентификатором ресурса.

Может быть словарем, содержащим name и resource_group группы безопасности.

state

string

Утвердить состояние сетевого интерфейса. Используйте present для создания или обновления интерфейса и absent для удаления интерфейса.

Выбираемые значения:

  • "absent"
  • "present" ← (по умолчанию)

subnet_name

псевдонимы: subnet

string

Имя существующей подсети в указанной виртуальной сети. Обязательно при создании сетевого интерфейса.

Используйте группу ресурсов virtual_network.

Обязательно при создании.

subscription_id

string

Ваш идентификатор подписки Azure.

tags

словарь

Словарь пар строка:строка для назначения метаданных объекту.

Метаданные теги объекта будут обновлены всеми предоставленными значениями.

Чтобы удалить теги, установите параметр append_tags в значение false.

В настоящее время зоны Azure DNS и службы Traffic Manager также не позволяют использовать пробелы в теге.

Azure Front Door не поддерживает использование

Azure Automation и Azure CDN поддерживают только 15 тегов на ресурсах.

tenant

string

Идентификатор Azure-аренды. Используется при аутентификации со служебным принципалом.

thumbprint

string

добавлен в azure.azcollection 1.14.0

Отпечаток цифрового сертификата для частного ключа, указанного в x509_certificate_path.

Используется при аутентификации со служебным принципалом.

Требуется, если определено x509_certificate_path.

virtual_network

псевдонимы: virtual_network_name

любой

Существующая виртуальная сеть, с которой будет связан сетевой интерфейс. Обязательно при создании сетевого интерфейса.

Может быть именем виртуальной сети.

Убедитесь, что ваша виртуальная сеть находится в той же группе ресурсов, что и сетевой интерфейс, когда вы указываете только имя.

Может быть идентификатором ресурса виртуальной сети.

Может быть словарем, содержащим name и resource_group виртуальной сети.

Обязательно при создании.

x509_certificate_path

путь

добавлен в azure.azcollection 1.14.0

Путь к X509 сертификату, используемому для создания служебного принципала в формате PEM.

Сертификат должен быть прикреплен к частному ключу.

Используется при аутентификации со служебным принципалом.

Примечания

Примечание

  • Для аутентификации с 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 multiple 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 network interface attached to application gateway backend address pool
  azure_rm_networkinterface:
    name: nic-appgw
    resource_group: myResourceGroup
    virtual_network: vnet001
    subnet_name: subnet001
    create_with_security_group: false
    ip_configurations:
      - name: default
        primary: true
        application_gateway_backend_address_pools:
          - name: myApplicationGatewayBackendAddressPool
            application_gateway: myApplicationGateway

- 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_server

список / элементы=строка

Какие DNS-серверы должен использовать сетевой адаптер.

Список IP-адресов.

Возвращается: успех

Пример: ["8.9.10.11", "7.8.9.10"]

dns_setting

словарь

Настройки DNS в сетевом интерфейсе.

Возвращается: успех

Пример: {"applied_dns_servers": [], "dns_servers": ["8.9.10.11", "7.8.9.10"], "internal_dns_name_label": null, "internal_fqdn": null}

enable_accelerated_networking

логическое

Нужно ли создавать сетевой интерфейс с функцией ускоренной работы или нет.

Возвращается: успех

Пример: true

enable_ip_forwarding

логическое

Включить или выключить IP-переадресацию.

Возвращается: успех

Пример: true

etag

строка

Уникальная строка только для чтения, которая изменяется всякий раз, когда ресурс обновляется.

Возвращается: успех

Пример: "W/\"be115a43-2148-4545-a324-f33ad444c926\""

id

строка

Идентификатор сетевого интерфейса.

Возвращается: успех

Пример: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroup/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nic003"

ip_configurations

сложный

Список IP-конфигураций.

Возвращается: успех

application_gateway_backend_address_pools

список / элементы=строка

добавлен в azure.azcollection 1.10.0

Список существующих идентификаторов ресурсов пулов обратного адреса шлюза приложений, связанных с сетевым интерфейсом.

Возвращается: успех

Пример: ["/subscriptions/xxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/applicationGateways/myGateway/ backendAddressPools/myBackendAddressPool"]

load_balancer_backend_address_pools

список / элементы=строка

Список существующих пулов обратных адресов бэкенда балансировщика нагрузки, связанных с сетевым интерфейсом.

Возвращается: успех

name

строка

Имя конфигурации IP.

Возвращается: успех

Пример: "default"

private_ip_address

строка

Приватный IP-адрес для конфигурации IP.

Возвращается: успех

Пример: "10.1.0.10"

private_ip_address_version

строка

Версия конфигурации IP.

Возвращается: успех

Пример: "IPv4"

private_ip_allocation_method

строка

Метод выделения приватного IP-адреса.

Возвращается: успех

Пример: "Static"

public_ip_address

словарь

Имя публичного IP-адреса. None для отключения IP-адреса.

Возвращается: успех

Пример: {"id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroup/myResourceGroup/providers/Microsoft.Network/publicIPAddresse s/publicip001", "name": "publicip001"}

subnet

словарь

Ссылка на ресурс подсети.

Возвращается: успех

Пример: {"id": "/subscriptions/xxxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/ myresourcegroup/providers/Microsoft.Network/virtualNetworks/tnb57dc95318/subnets/tnb57dc95318", "name": "tnb57dc95318", "resource_group": "myresourcegroup", "virtual_network_name": "tnb57dc95318"}

location

string

Расположение ресурса сетевого интерфейса.

Возвращаемое значение: success

Пример: "eastus"

mac_address

string

MAC-адрес сетевого интерфейса.

Возвращаемое значение: success

name

string

Имя сетевого интерфейса.

Возвращаемое значение: success

Пример: "nic003"

network_security_group

dictionary

Ссылка на ресурс группы безопасности сети.

Возвращаемое значение: success

Пример: {"id": "/subscriptions//xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroup/ myResourceGroup/providers/Microsoft.Network/networkSecurityGroups/nsg001", "name": "nsg001"}

primary

boolean

Указывает, является ли данный сетевой интерфейс основным для виртуальной машины.

Возвращаемое значение: success

Пример: true

provisioning_state

string

Состояние подготовки ресурса публичного IP-адреса.

Возвращаемое значение: success

Пример: "Succeeded"

tags

dictionary

-Теги сетевого интерфейса.

Возвращаемое значение: success

Пример: {"key": "value"}

type

string

Тип ресурса.

Возвращаемое значение: success

Пример: "Microsoft.Network/networkInterfaces"

Авторы

  • Chris Houseknecht (@chouseknecht)
  • Matt Davis (@nitzmahone)
  • Yuwei Zhou (@yuwzho)

Ссылки на коллекцию

  • Система отслеживания проблем
  • Главная страница
  • Репозиторий (источники)

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/azure/azcollection/azure_rm_networkinterface_module.html

Spec-Zone.ru

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