Spec-Zone.ru › Ansible 2.7

azure_rm_subnet – Управление подсетями Azure.

Новая в версии 2.1.

  • Описание
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения
  • Статус

Описание

  • Создание, обновление или удаление подсети в заданной виртуальной сети. Позволяет устанавливать и обновлять префикс адреса CIDR, который должен быть валидным в контексте виртуальной сети. Используйте модуль azure_rm_networkinterface для ассоциации интерфейсов с подсетью и назначения конкретных IP-адресов.

Требования

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

  • python >= 2.7
  • azure >= 2.0.0

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
ad_user
-
Имя пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с принципалом службы.
address_prefix_cidr
- / обязательно
CIDR, определяющий адресное пространство IPv4 подсети. Должен быть валидным в контексте виртуальной сети.

псевдонимы: address_prefix
adfs_authority_url
-
добавлено в 2.6
Значение по умолчанию:
null
URL-адрес авторизации Azure AD. Используйте при аутентификации с именем пользователя/паролем и вашей собственной авторизацией ADFS.
api_profile
-
добавлено в 2.5
Значение по умолчанию:
"latest"
Выбирает профиль API для использования при взаимодействии с Azure-сервисами. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать с Azure Stack.
append_tags
boolean
    Варианты:
  • no
  • yes ←
Управляет тем, является ли поле тегов каноническим или оно просто добавляется к существующим тегам. При каноническом поле тегов любые теги, отсутствующие в параметре tags, будут удалены из метаданных объекта.
auth_source
-
добавлено в 2.5
    Варианты:
  • auto
  • 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
    Варианты:
  • validate
  • ignore
Управляет поведением проверки сертификатов для 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.
name
- / обязательно
Имя подсети.
password
-
Пароль пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с принципалом службы.
profile
-
Профиль безопасности, найденный в файле ~/.azure/credentials.
resource_group
- / обязательно
Имя группы ресурсов.
route_table
-
добавлено в 2.7
Ссылка на ресурс RouteTable.
Может принимать как строку, так и словарь.
Строка может быть именем или идентификатором ресурса таблицы маршрутизации.
Словарь может содержать name и resource_group таблицы маршрутизации.
secret
-
Секретный ключ клиента Azure. Используйте при аутентификации с принципалом службы.
security_group
-
Существующая группа безопасности, с которой следует связать подсеть.
Может быть именем группы безопасности, которая находится в той же группе ресурсов.
Может быть идентификатором ресурса.
Может быть словарем, содержащим name и resource_group группы безопасности.

псевдонимы: security_group_name
state
-
    Варианты:
  • absent
  • present ←
Устанавливает состояние подсети. Используйте 'present' для создания или обновления подсети и 'absent' для удаления подсети.
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 subnet
  azure_rm_subnet:
    name: foobar
    virtual_network_name: My_Virtual_Network
    resource_group: Testing
    address_prefix_cidr: "10.1.0.0/24"

- name: Create a subnet refer nsg from other resource group
  azure_rm_subnet:
    name: foobar
    virtual_network_name: My_Virtual_Network
    resource_group: Testing
    address_prefix_cidr: "10.1.0.0/16"
    security_group:
      name: secgroupfoo
      resource_group: Testing1
    route_table: route

- name: Delete a subnet
  azure_rm_subnet:
    name: foobar
    virtual_network_name: My_Virtual_Network
    resource_group: Testing
    state: absent

Возвращаемые значения

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

Ключ Возвращаемое значение Описание
state
complex
success
Текущее состояние подсети.

address_prefix
string
IP адрес CIDR.

id
string
Путь к ресурсу подсети.

name
string
Имя подсети.

network_security_group
complex

id
string
Идентификатор ресурса группы безопасности.

name
string
Имя группы безопасности.

provisioning_state
string
Успешность или неудача события подготовки.



Статус

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

Авторы

  • Chris Houseknecht (@chouseknecht)
  • Matt Davis (@nitzmahone)

Подсказка

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

© 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_subnet_module.html

Spec-Zone.ru

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