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

ad_user

string

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

adfs_authority_url

string

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

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

api_profile

string

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

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

По умолчанию: "latest"

append_tags

boolean

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

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

Варианты:

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

auth_source

string

добавлено в 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.

Варианты:

• "auto" ← (по умолчанию)
• "cli"
• "credential_file"
• "env"
• "msi"

cert_validation_mode

string

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

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

Варианты:

• "ignore"
• "validate"

client_id

string

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

Также можно задать с помощью переменной среды AZURE_CLIENT_ID.

cloud_environment

string

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

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

По умолчанию: "AzureCloud"

create_with_security_group

boolean

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

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

Варианты:

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

disable_instance_discovery

boolean

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

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

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

Варианты:

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

dns_servers

list / elements=string

Серверы DNS, к которым должен обращаться сетевой интерфейс.

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

enable_accelerated_networking

boolean

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

Варианты:

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

enable_ip_forwarding

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

boolean

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

Варианты:

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

ip_configurations

list / elements=dictionary

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

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

application_gateway_backend_address_pools

list / elements=any

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

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

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

Также можно указать словарь с полями name и application_gateway.

application_security_groups

list / elements=any

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

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

load_balancer_backend_address_pools

list / elements=any

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

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

Также можно указать словарь с полями name и load_balancer.

name

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

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

primary

boolean

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

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

Варианты:

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

private_ip_address

string

Частный IP-адрес конфигурации IP.

private_ip_address_version

string

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

Варианты:

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

private_ip_allocation_method

string

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

Варианты:

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

public_ip_address_name

псевдонимы: public_ip_address, public_ip_name

string

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

public_ip_allocation_method

string

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

Варианты:

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

location

string

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

log_mode

string

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

log_path

string

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

name

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

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

oidc_token

string

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

Токен OpenID Connect (OIDC) (JWT), используемый для аутентификации с помощью удостоверения рабочей нагрузки.

Этот токен обменивается с Azure AD с использованием федеративного удостоверения OIDC.

Полезен в системах CI (например, GitHub Actions, Azure DevOps), где платформа напрямую предоставляет токен OIDC.

Также можно задать с помощью переменной среды AZURE_FEDERATED_TOKEN.

oidc_token_file_path

path

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

Путь к файлу, содержащему токен OpenID Connect (OIDC) (JWT), используемый для аутентификации с помощью удостоверения рабочей нагрузки.

Файл должен содержать только токен в исходном виде.

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

Также можно задать с помощью переменной среды AZURE_FEDERATED_TOKEN_FILE.

open_ports

list / elements=string

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

os_type

string

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

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

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

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

Варианты:

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

password

string

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

profile

string

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

resource_group

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

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

secret

string

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

security_group

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

any

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

Если группа не указана, при 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

dictionary

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

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

Чтобы удалить теги, установите для параметра 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

any

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

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

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

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

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

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

x509_certificate_path

path

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

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

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

Используйте при аутентификации с помощью субъекта-службы.

state

complex

Текущее состояние сетевой карты.

Возвращается: всегда

dns_server

list / elements=string

Список DNS-серверов, к которым должна обращаться сетевая карта.

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

Возвращается: при успешном выполнении

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

dns_setting

dictionary

Настройки 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

boolean

Указывает, следует ли создавать сетевую карту с поддержкой ускоренной сети.

Возвращается: при успешном выполнении

Пример: true

enable_ip_forwarding

boolean

Указывает, следует ли включить переадресацию IP-пакетов.

Возвращается: при успешном выполнении

Пример: true

etag

string

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

Возвращается: при успешном выполнении

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

id

string

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

Возвращается: при успешном выполнении

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

ip_configurations

complex

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

Возвращается: при успешном выполнении

application_gateway_backend_address_pools

list / elements=string

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

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

Возвращается: при успешном выполнении

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

load_balancer_backend_address_pools

list / elements=string

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

Возвращается: при успешном выполнении

name

string

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

Возвращается: при успешном выполнении

Пример: "default"

private_ip_address

string

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

Возвращается: при успешном выполнении

Пример: "10.1.0.10"

private_ip_address_version

string

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

Возвращается: при успешном выполнении

Пример: "IPv4"

private_ip_allocation_method

string

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

Возвращается: при успешном выполнении

Пример: "Static"

public_ip_address

dictionary

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

Возвращается: при успешном выполнении

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

subnet

dictionary

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

Возвращается: при успешном выполнении

Пример: {"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

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

Возвращается: при успешном выполнении

Пример: "eastus"

mac_address

string

MAC-адрес сетевой карты.

Возвращается: при успешном выполнении

name

string

Имя сетевой карты.

Возвращается: при успешном выполнении

Пример: "nic003"

network_security_group

dictionary

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

Возвращается: при успешном выполнении

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

primary

boolean

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

Возвращается: при успешном выполнении

Пример: true

provisioning_state

string

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

Возвращается: при успешном выполнении

Пример: "Succeeded"

tags

dictionary

Теги сетевой карты.

Возвращается: при успешном выполнении

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

type

string

Тип ресурса.

Возвращается: при успешном выполнении

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