модуль cisco.aci.aci_l3out_dhcp_relay_label — управление меткой ретрансляции DHCP для внешней сети уровня 3 (L3Out) (dhcp:Lbl)

annotation

string

Пользовательская строка для добавления аннотации к объекту.

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

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

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

certificate_name

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

string

Имя сертификата X.509, прикреплённого к пользователю AAA APIC, которое используется для аутентификации на основе подписи.

Если указан файл private_key, по умолчанию используется имя private_key без расширения.

Если для private_key указано содержимое в формате PEM, по умолчанию используется значение username.

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

description

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

string

Описание метки ретрансляции DHCP.

dhcp_option_policy

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

string

Имя существующей политики параметров DHCP, связываемой с политикой ретрансляции DHCP.

Политика параметров DHCP предоставляет DHCP-клиентам параметры конфигурации, такие как домен, адрес сервера имён и адрес маршрутизатора подсети.

Передача пустой строки удалит текущую связанную политику параметров DHCP. Однако метка ретрансляции DHCP будет связана с политикой параметров DHCP по умолчанию из общего арендатора.

dhcp_relay_label

псевдонимы: name, relay_policy

string

Имя/метка существующей политики ретрансляции DHCP.

host

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

string

IP-адрес или имя узла APIC, доступное для разрешения с управляющего узла Ansible.

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

interface_profile

псевдонимы: interface_profile_name, logical_interface

string

Имя существующего профиля интерфейса.

l3out

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

string

Имя существующего L3Out.

node_profile

псевдонимы: node_profile_name, logical_node

string

Имя существующего профиля узла.

output_level

string

Настройка вывода этого модуля ACI.

normal означает стандартный вывод, включая словарь current

info добавляет информационный вывод, включая previous, proposed и словари sent

debug добавляет отладочный вывод, включая информацию filter_string, method, response, status и url

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

Допустимые значения:

• "debug"
• "info"
• "normal" ← (по умолчанию)

output_path

string

Путь к файлу, в который будут записываться объекты конфигурации ACI в формате JSON, созданные модулем.

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

owner_key

string

Пользовательская строка для атрибута ownerKey объекта ACI.

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

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

owner_tag

string

Пользовательская строка для атрибута ownerTag объекта ACI.

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

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

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

password

string

Пароль для аутентификации.

Этот параметр нельзя использовать одновременно с private_key. Если также задан private_key, будет использован он.

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

port

integer

Номер порта для REST-подключения.

Значение по умолчанию зависит от параметра use_ssl.

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

private_key

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

string

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

Это значение также влияет на используемое по умолчанию значение certificate_name.

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

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

scope

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

string

Область действия указывает владельца сервера ретрансляции.

При создании объекта APIC задаёт значение infra по умолчанию, если оно не указано.

Допустимые значения:

• "infra"
• "tenant"

state

string

Для добавления или удаления используйте present или absent.

Для получения списка одного или нескольких объектов используйте query.

Допустимые значения:

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

suppress_previous

псевдонимы: no_previous, ignore_previous

boolean

Если true, перед обновлением POST в APIC не будет отправлен запрос GET для проверки предыдущего состояния.

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

Значение по умолчанию — false.

ПРЕДУПРЕЖДЕНИЕ — в результате возвращаемое предыдущее значение будет пустым.

Предыдущее состояние объекта проверяться не будет, а запрос POST на обновление будет содержать все свойства.

Допустимые значения:

• false
• true

suppress_verification

псевдонимы: no_verification, no_verify, suppress_verify, ignore_verify, ignore_verification

boolean

Если true, после обновления POST в APIC не будет отправлен проверочный запрос GET.

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

Значение по умолчанию — false.

ПРЕДУПРЕЖДЕНИЕ — в результате для текущего возвращаемого значения будет установлено предложенное значение.

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

Допустимые значения:

• false
• true

tenant

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

string

Имя существующего арендатора.

timeout

integer

Тайм-аут на уровне сокета в секундах.

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

Значение по умолчанию — 30.

use_proxy

boolean

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

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

Значение по умолчанию — true.

Допустимые значения:

• false
• true

use_ssl

boolean

Если false, вместо HTTPS-подключения по умолчанию будет использоваться HTTP-подключение.

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

Значение по умолчанию — true при локальном подключении.

Допустимые значения:

• false
• true

username

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

string

Имя пользователя для аутентификации.

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

Значение по умолчанию — admin.

validate_certs

boolean

Если false, сертификаты SSL проверяться не будут.

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

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

Значение по умолчанию — true.

Допустимые значения:

• false
• true

current

list / elements=string

Текущая конфигурация APIC после завершения работы модуля

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

Пример: [{"fvTenant": {"attributes": {"descr": "Production environment", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]

error

dictionary

Сведения об ошибке, возвращённые APIC

Возвращается: при сбое

Пример: {"code": "122", "text": "unknown managed object class foo"}

filter_string

string

Строка фильтра, использованная в запросе

Возвращается: при сбое или в режиме отладки

Пример: "?rsp-prop-include=config-only"

method

string

Метод HTTP, использованный для запроса к APIC

Возвращается: при сбое или в режиме отладки

Пример: "POST"

previous

list / elements=string

Исходная конфигурация APIC до начала работы модуля

Возвращается: при выводе информации

Пример: [{"fvTenant": {"attributes": {"descr": "Production", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]

proposed

dictionary

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

Возвращается: при выводе информации

Пример: {"fvTenant": {"attributes": {"descr": "Production environment", "name": "production"}}}

raw

string

Необработанные данные, возвращённые REST API APIC (xml или json)

Возвращается: при ошибке разбора

Пример: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><imdata totalCount=\"1\"><error code=\"122\" text=\"unknown managed object class foo\"/></imdata>"

response

string

Ответ HTTP от APIC

Возвращается: при сбое или в режиме отладки

Пример: "OK (30 bytes)"

sent

list / elements=string

Фактическая/минимальная конфигурация, отправленная в APIC

Возвращается: при выводе информации

Пример: {"fvTenant": {"attributes": {"descr": "Production environment"}}}

status

integer

Статус HTTP от APIC

Возвращается: при сбое или в режиме отладки

Пример: 200

url

string

URL HTTP, использованный для запроса к APIC

Возвращается: при сбое или в режиме отладки

Пример: "https://10.11.12.13/api/mo/uni/tn-production.json"