Модуль cisco.aci.aci_fabric_leaf_switch_assoc – Управление связями коммутаторов уровня листа с профилями и группами политик (fabric:LeafS и fabric:RsLeNodePGrp).

Примечание

Этот модуль входит в коллекцию cisco.aci (версия 2.10.1).

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

Для установки используйте: ansible-galaxy collection install cisco.aci.

Чтобы использовать его в playbook, укажите: cisco.aci.aci_fabric_leaf_switch_assoc.

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

Обзор

Управление ассоциациями коммутаторов уровня листа (fabric:LeafS) с существующим профилем коммутатора уровня листа (fabric:leafP) в ACI-матрице и привязкой к группе политик (fabric:RsLeNodePGrp)

Параметры

Параметр	Комментарии
annotation string	Пользовательская строка для аннотации объекта. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_ANNOTATION`. Если значение не указано в задаче и переменной среды `ACI_ANNOTATION`, то будет использовано значение по умолчанию. Default: `"orchestrator:ansible"`
certificate_name aliases: cert_name string	Имя сертификата X.509, прикрепленного к пользователю APIC AAA, используемому для аутентификации на основе подписи. Если указано имя файла `private_key`, значение по умолчанию будет равно `private_key` (без расширения). Если для `private_key` предоставлено содержимое в формате PEM, значение по умолчанию будет равно `username`. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_CERTIFICATE_NAME`.
description aliases: descr string	Описание ассоциации коммутатора Fabric
host aliases: hostname string	IP-адрес или имя хоста APIC, распознаваемое узлом управления Ansible. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_HOST`.
name aliases: association_name, switch_association string	Имя ассоциации коммутатора
output_level string	Влияет на вывод этого модуля ACI. `normal` означает стандартный вывод, включая `current` dict `info` добавляет информационный вывод, включая `previous`, `proposed` и `sent` dicts `debug` добавляет отладочный вывод, включая `filter_string`, `method`, `response`, `status` и `url` информацию Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_OUTPUT_LEVEL`. Choices: `"debug"` `"info"` `"normal"` ← (default)
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`.
policy_group string	Имя существующей группы политик коммутатора leaf
port integer	Номер порта, который будет использоваться для соединения REST. Значение по умолчанию зависит от параметра `use_ssl`. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_PORT`.
private_key aliases: cert_key string	Либо файл закрытого ключа в формате PEM, либо содержимое закрытого ключа, используемое для аутентификации на основе подписи. Это значение также влияет на используемое значение `certificate_name` по умолчанию. Эта опция является взаимоисключающей с `password`. Если также предоставлено `password`, оно будет проигнорировано. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_PRIVATE_KEY` или `ANSIBLE_NET_SSH_KEYFILE`.
profile aliases: leaf_profile, leaf_switch_profile string	Имя существующего профиля коммутатора leaf fabric
state string	Используйте `present` или `absent` для добавления или удаления. Используйте `query` для вывода списка одного объекта или нескольких объектов. Choices: `"absent"` `"present"` ← (default) `"query"`

suppress_previous aliases: no_previous, ignore_previous boolean	Если `true`, запрос GET для проверки предыдущего состояния не будет отправлен перед обновлением POST в APIC. Если значение не указано в задаче, будет использовано значение переменной окружения `ACI_SUPPRESS_PREVIOUS`. Значение по умолчанию `false`. ПРЕДУПРЕЖДЕНИЕ - Это приводит к тому, что предыдущее возвращаемое значение становится пустым. Предыдущее состояние объекта не будет проверено, и обновление POST будет содержать все свойства. Варианты: `false` `true`
suppress_verification aliases: no_verification, no_verify, suppress_verify, ignore_verify, ignore_verification boolean	Если `true`, проверочный запрос GET не будет отправлен после обновления POST в APIC. Если значение не указано в задаче, будет использовано значение переменной окружения `ACI_SUPPRESS_VERIFICATION`. Значение по умолчанию `false`. ПРЕДУПРЕЖДЕНИЕ - Это приводит к установке текущего возвращаемого значения в предложенное значение. Текущий объект, включая значения по умолчанию, не будет проверяем в одной задаче. Варианты: `false` `true`
timeout integer	Таймаут уровня сокета в секундах. Если значение не указано в задаче, будет использовано значение переменной окружения `ACI_TIMEOUT`. Значение по умолчанию 30.
use_proxy boolean	Если `false`, прокси не будет использоваться, даже если он определен в переменной окружения на целевых хостах. Если значение не указано в задаче, будет использовано значение переменной окружения `ACI_USE_PROXY`. Значение по умолчанию true. Варианты: `false` `true`
...

Примечания

Примечание

Перед использованием данного модуля в вашем плейбуке должен быть profile. Для этого можно использовать модуль cisco.aci.aci_fabric_leaf_profile.

См. также

APIC Management Information Model reference: Дополнительная информация о внутренних классах APIC fabricLeafS и fabricRsLeNodePGrp.
Руководство Cisco ACI: Подробная информация о том, как управлять вашей инфраструктурой ACI с помощью Ansible.
Разработка модулей Cisco ACI: Подробное руководство по написанию собственных модулей Cisco ACI для внесения вклада.

Примеры

- name: Create a leaf switch profile association
  cisco.aci.aci_fabric_leaf_switch_assoc:
    host: apic
    username: admin
    password: SomeSecretPassword
    profile: my_leaf_profile
    name: my_leaf_switch_assoc
    policy_group: my_leaf_pol_grp
    state: present
  delegate_to: localhost
- name: Remove a leaf switch profile association
  cisco.aci.aci_fabric_leaf_switch_assoc:
    host: apic
    username: admin
    password: SomeSecretPassword
    profile: my_leaf_profile
    name: my_leaf_switch_assoc
    state: absent
  delegate_to: localhost
- name: Query a leaf profile association
  cisco.aci.aci_fabric_leaf_switch_assoc:
    host: apic
    username: admin
    password: SomeSecretPassword
    profile: my_leaf_profile
    name: my_leaf_switch_assoc
    state: query
  delegate_to: localhost
  register: query_result
- name: Query all leaf profiles
  cisco.aci.aci_fabric_leaf_switch_assoc:
    host: apic
    username: admin
    password: SomeSecretPassword
    state: query
  delegate_to: localhost
  register: query_result

Значения возврата

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

Ключ	Описание
current список / элементы=строка	Существующая конфигурация из APIC после завершения модуля Возвращено: успех Пример: `[{"fvTenant": {"attributes": {"descr": "Production environment", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]`
error словарь	Информация об ошибке, возвращённая из APIC Возвращено: ошибка Пример: `{"code": "122", "text": "unknown managed object class foo"}`
filter_string строка	Строка фильтра, используемая для запроса Возвращено: ошибка или отладка Пример: `"?rsp-prop-include=config-only"`
method строка	HTTP-метод, используемый для запроса к APIC Возвращено: ошибка или отладка Пример: `"POST"`
previous список / элементы=строка	Исходная конфигурация из APIC до запуска модуля Возвращено: информация Пример: `[{"fvTenant": {"attributes": {"descr": "Production", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]`
proposed словарь	Собранная конфигурация из параметров, предоставленных пользователем Возвращено: информация Пример: `{"fvTenant": {"attributes": {"descr": "Production environment", "name": "production"}}}`
raw строка	Необработанный вывод, возвращённый API REST APIC (xml или json) Возвращено: ошибка разбора Пример: `"<?xml version=\"1.0\" encoding=\"UTF-8\"?><imdata totalCount=\"1\"><error code=\"122\" text=\"unknown managed object class foo\"/></imdata>"`
response строка	HTTP-ответ от APIC Возвращено: ошибка или отладка Пример: `"OK (30 bytes)"`
sent список / элементы=строка	Фактическая/минимальная конфигурация, отправленная в APIC Возвращено: информация Пример: `{"fvTenant": {"attributes": {"descr": "Production environment"}}}`
status целое число	HTTP-статус от APIC Возвращено: ошибка или отладка Пример: `200`
url строка	HTTP-URL, используемый для запроса к APIC Возвращено: ошибка или отладка Пример: `"https://10.11.12.13/api/mo/uni/tn-production.json"`

Авторы

Tim Cragg (@timcragg)

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

© 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/cisco/aci/aci_fabric_leaf_switch_assoc_module.html