Инвентаризация azure.azcollection.azure_rm — плагин инвентаризации Azure Resource Manager

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"

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"

batch_fetch

string

Для повышения производительности результаты извлекаются с помощью неподдерживаемого пакетного API. Отключение batch_fetch приводит к гораздо более медленному последовательному извлечению и большему числу обращений к серверу. Обычно этот параметр полезен только для устранения неполадок.

По умолчанию: true

batch_fetch_interval

integer

Интервал проверки завершения пакетных запросов

По умолчанию: 3

batch_fetch_timeout

integer

Тайм-аут ожидания выполнения пакетных запросов

По умолчанию: 5

cache

boolean

Включает или отключает кэширование исходных данных инвентаризации; для работы требуется настроенный подключаемый модуль кэша.

Варианты:

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

Конфигурация:

• Запись INI:

  [inventory]
  cache = false
  

• Переменная окружения: ANSIBLE_INVENTORY_CACHE

cache_connection

string

Данные подключения к кэшу или путь к нему; подробную информацию см. в документации подключаемого модуля кэша.

Конфигурация:

• Записи INI:

  [defaults]
  fact_caching_connection = VALUE
  

  [inventory]
  cache_connection = VALUE
  

• Переменная окружения: ANSIBLE_CACHE_PLUGIN_CONNECTION
• Переменная окружения: ANSIBLE_INVENTORY_CACHE_CONNECTION

cache_plugin

string

Подключаемый модуль кэша для исходных данных инвентаризации.

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

Конфигурация:

• Записи INI:

  [defaults]
  fact_caching = memory
  

  [inventory]
  cache_plugin = memory
  

• Переменная окружения: ANSIBLE_CACHE_PLUGIN
• Переменная окружения: ANSIBLE_INVENTORY_CACHE_PLUGIN

cache_prefix

string

Префикс для файлов/таблиц подключаемого модуля кэша.

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

Конфигурация:

• Записи INI:

  [defaults]
  fact_caching_prefix = ansible_inventory_
  

  [inventory]
  cache_prefix = ansible_inventory_
  

• Переменная окружения: ANSIBLE_CACHE_PLUGIN_PREFIX
• Переменная окружения: ANSIBLE_INVENTORY_CACHE_PLUGIN_PREFIX

cache_timeout

integer

Длительность хранения данных в кэше в секундах.

По умолчанию: 3600

Конфигурация:

• Записи INI:

  [defaults]
  fact_caching_timeout = 3600
  

  [inventory]
  cache_timeout = 3600
  

• Переменная окружения: ANSIBLE_CACHE_PLUGIN_TIMEOUT
• Переменная окружения: ANSIBLE_INVENTORY_CACHE_TIMEOUT

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"

compose

dictionary

Создает переменные на основе выражений Jinja2.

По умолчанию: {}

conditional_groups

string

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

default_host_filters

string

Набор фильтров по умолчанию, применяемый вместе с условиями в exclude_host_filters для исключения выключенных и не полностью подготовленных хостов. Задайте другое значение или пустой список, если необходимо включить хосты в этих состояниях.

По умолчанию: ["powerstate != \"running\"", "provisioning_state != \"succeeded\""]

disable_instance_discovery

boolean

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

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

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

Варианты:

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

exclude_host_filters

string

Исключает хосты из инвентаризации с помощью списка условных выражений Jinja2. Каждое выражение из списка вычисляется для каждого хоста; если выражение истинно, хост исключается из инвентаризации.

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

fail_on_template_errors

string

Если значение false, ошибки шаблонов при обработке групп и фильтров игнорируются без уведомления (например, если выражение фильтра или группы ссылается на неопределенную переменную хоста)

Варианты:

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

groups

dictionary

Добавляет хосты в группу на основе условий Jinja2.

По умолчанию: {}

hostnames

list / элементы=string

Список выражений Jinja2 в порядке приоритета для формирования inventory_hostname.

Выражение игнорируется, если результатом является пустая строка или значение None.

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

Выражение default принудительно использует генератор имени хоста по умолчанию, если ни одно из предыдущих выражений не вернуло допустимое имя хоста.

Используйте default_inventory_hostname, чтобы получить значение генератора имени хоста по умолчанию в любом выражении Jinja2.

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

hostvar_expressions

string

Соответствие имен переменных хоста выражениям Jinja2. Значение для каждого хоста является результатом выражения Jinja2 (которое может ссылаться на любые существующие переменные хоста на момент запуска этого подключаемого модуля инвентаризации).

include_arc_resource_groups

string

Список имен групп ресурсов для поиска компьютеров Azure ARC. Значение ‘\*’ включает все группы ресурсов в подписке.

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

include_hcivm_resource_groups

string

Список имен групп ресурсов для поиска виртуальных машин Azure StackHCI. Значение ‘\*’ включает все группы ресурсов в подписке.

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

include_host_filters

string

Включает хосты в инвентаризацию с помощью списка условных выражений Jinja2. Каждое выражение из списка вычисляется для каждого хоста; если выражение истинно, хост включается в инвентаризацию. По умолчанию в инвентаризацию включаются все хосты.

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

include_vm_resource_groups

string

Список имен групп ресурсов для поиска виртуальных машин. Значение ‘\*’ включает все группы ресурсов в подписке. Список имен групп ресурсов через запятую также можно задать с помощью переменной окружения ANSIBLE_AZURE_VM_RESOURCE_GROUPS.

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

include_vmss_resource_groups

string

Список имен групп ресурсов для поиска масштабируемых наборов виртуальных машин (VMSS). Значение ‘\*’ включает все группы ресурсов в подписке.

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

keyed_groups

list / элементы=dictionary

Создает группы на основе значения переменной хоста. Требуется список словарей с параметрами key (исходная переменная типа словаря), prefix (префикс для имени новой группы) и, при необходимости, separator (по умолчанию — _)

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

default_value

string

добавлено в ansible-core 2.12

Значение по умолчанию, если значение переменной хоста равно None или представляет собой пустую строку.

Этот параметр несовместим с keyed_groups[].trailing_separator.

key

string

Ключ входного словаря, используемый для создания групп.

parent_group

string

Родительская группа для группы с ключом.

prefix

string

Имя группы с ключом будет начинаться с этого префикса.

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

separator

string

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

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

trailing_separator

boolean

добавлено в ansible-core 2.12

Задайте этому параметру значение false, чтобы опустить keyed_groups[].separator после переменной хоста, если ее значение равно None или представляет собой пустую строку.

Этот параметр несовместим с keyed_groups[].default_value.

Варианты:

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

leading_separator

boolean

добавлено в ansible-core 2.11

Используется вместе с keyed_groups.

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

Это происходит потому, что префикс по умолчанию — "", а разделитель по умолчанию — "_".

Задайте этому параметру значение false, чтобы опустить начальный символ подчеркивания (или другой разделитель), если префикс не задан.

Если имя группы формируется из сопоставления, разделитель по-прежнему используется для объединения элементов.

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

Варианты:

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

log_mode

string

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

log_path

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.

password

string

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

plain_host_names

boolean

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

По умолчанию этот плагин использует глобально уникальные имена узлов. Этот параметр позволяет переопределить такое поведение и использовать имена, соответствующие соглашениям об именовании старого скрипта инвентаризации.

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

Варианты:

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

plugin

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

указывает, что это экземпляр плагина ‘azure_rm’

Варианты:

• "azure_rm"
• "azure.azcollection.azure_rm"

profile

string

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

secret

string

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

strict

boolean

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

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

Варианты:

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

subscription_id

string

Идентификатор вашей подписки Azure.

tenant

string

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

thumbprint

string

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

Отпечаток закрытого ключа, указанного в x509_certificate_path.

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

Обязателен, если задан x509_certificate_path.

use_contrib_script_compatible_sanitization

boolean

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

По умолчанию этот плагин использует общую очистку имен групп для создания безопасных и пригодных для использования в Ansible имен. Этот параметр позволяет переопределить такое поведение, чтобы упростить переход со старого скрипта инвентаризации и обеспечить очистку имен групп, соответствующую поведению скрипта при значении параметра replace_dash_in_groups, равном false. Чтобы воспроизвести поведение replace_dash_in_groups = true для сформированных групп, необходимо заменить дефисы на символы подчеркивания с помощью фильтра regex_replace для соответствующих записей.

Для работы этой функции также следует отключить параметр TRANSFORM_INVALID_GROUP_CHARS, иначе основной механизм применит стандартную очистку дополнительно.

По умолчанию эта функция отключена, поскольку такие имена нарушают работу некоторых функций: не все символы допустимы в идентификаторах Python, которыми становятся имена групп.

Варианты:

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

use_extra_vars

boolean

добавлено в ansible-core 2.11

Объединить дополнительные переменные с доступными переменными для формирования значений (наивысший приоритет).

Варианты:

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

Конфигурация:

• Запись INI:

  [inventory_plugins]
  use_extra_vars = false
  

• Переменная среды: ANSIBLE_INVENTORY_USE_EXTRA_VARS

x509_certificate_path

path

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

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

К сертификату необходимо добавить закрытый ключ.

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