cisco.aci.aci_switch_leaf_selector – Привязка селекторов листов к профилям политики коммутатора (infra:LeafS, infra:NodeBlk, infra:RsAccNodePGrep)

Примечание

Этот плагин является частью коллекции cisco.aci (версия 2.0.0).

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

Для использования в плейбуке укажите: cisco.aci.aci_switch_leaf_selector.

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

Описание

Привязка селекторов листов (с диапазоном блоков узлов и группой политик) к профилям политики коммутатора на тканях Cisco ACI.

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
annotation строка		Пользовательская строка для аннотирования объекта. Если значение не указано в задаче, используется значение переменной окружения `ACI_ANNOTATION`.
certificate_name строка		Имя сертификата X.509, прикрепленного к пользователю APIC AAA, используемому для аутентификации на основе подписи. Если был указан файл `private_key`, по умолчанию используется имя файла `private_key`, без расширения. Если для `private_key` был предоставлен контент в формате PEM, по умолчанию используется значение `username`. Если значение не указано в задаче, используется значение переменной окружения `ACI_CERTIFICATE_NAME`. псевдонимы: cert_name
description строка		Описание, присваиваемое `leaf`.
from целое число		Начало диапазона блока узлов. псевдонимы: node_blk_range_from, from_range, range_from
host строка / обязательно		IP-адрес или имя хоста APIC, разрешаемый управляющим хостом Ansible. Если значение не указано в задаче, используется значение переменной окружения `ACI_HOST`. псевдонимы: hostname
leaf строка		Имя селектора листа. псевдонимы: name, leaf_name, leaf_profile_leaf_name, leaf_selector_name
leaf_node_blk строка		Имя диапазона блока узлов, добавляемого в селектор листа данного профиля листа. псевдонимы: leaf_node_blk_name, node_blk_name
leaf_node_blk_description строка		Описание, присваиваемое `leaf_node_blk`
leaf_profile строка		Имя профиля листа, к которому добавляется селектор. псевдонимы: leaf_profile_name
name_alias строка		Псевдоним для текущего объекта. Это относится к полю nameAlias в ACI.
output_level строка	Варианты: debug info normal ←	Влияет на вывод этого модуля ACI. `normal` означает стандартный вывод, включая `current` dict `info` добавляет информативный вывод, включая `previous`, `proposed` и `sent` dicts `debug` добавляет отладочный вывод, включая `filter_string`, `method`, `response`, `status` и `url` информацию Если значение не указано в задаче, используется значение переменной окружения `ACI_OUTPUT_LEVEL`.
output_path строка		Путь к файлу, который будет использоваться для вывода объектов конфигурации ACI JSON, сгенерированных модулем. Если значение не указано в задаче, используется значение переменной окружения `ACI_OUTPUT_PATH`.
owner_key строка		Пользовательская строка для атрибута ownerKey объекта ACI. Этот атрибут представляет собой ключ для предоставления клиентам права собственности на данные для корреляции сущностей. Если значение не указано в задаче, используется значение переменной окружения `ACI_OWNER_KEY`.
owner_tag строка		Пользовательская строка для атрибута ownerTag объекта ACI. Этот атрибут представляет собой метку для предоставления клиентам возможности добавлять свои собственные данные. Например, для указания того, кто создал этот объект. Если значение не указано в задаче, используется значение переменной окружения `ACI_OWNER_TAG`.
password строка		Пароль для аутентификации. Этот параметр взаимоисключающий с `private_key`. Если также указан `private_key`, используется он. Если значение не указано в задаче, используется значение переменных окружения `ACI_PASSWORD` или `ANSIBLE_NET_PASSWORD`.
policy_group строка		Имя группы политик, добавляемой в селектор листа данного профиля листа. псевдонимы: name, policy_group_name
port целое число		Номер порта, используемого для подключения REST. Значение по умолчанию зависит от параметра `use_ssl`. Если значение не указано в задаче, используется значение переменной окружения `ACI_PORT`.
private_key строка		Файл закрытого ключа в формате PEM или контент закрытого ключа, используемый для аутентификации на основе подписи. Это значение также влияет на значение по умолчанию `certificate_name`, которое используется. Этот параметр взаимоисключающий с `password`. Если также указан `password`, он будет проигнорирован. Если значение не указано в задаче, используется значение переменной окружения `ACI_PRIVATE_KEY`. псевдонимы: cert_key
state строка	Варианты: absent present ← query	Используйте `present` или `absent` для добавления или удаления. Используйте `query` для отображения объекта или нескольких объектов.
timeout целое число	По умолчанию: 30	Таймаут уровня сокета в секундах. Если значение не указано в задаче, используется значение переменной окружения `ACI_TIMEOUT`.
to целое число		Конец диапазона блока узлов. псевдонимы: node_blk_range_to, to_range, range_to
use_proxy булево	Варианты: no yes ←	Если `no`, прокси не будет использоваться, даже если он определен в переменной окружения на целевых хостах. Если значение не указано в задаче, используется значение переменной окружения `ACI_USE_PROXY`.
use_ssl булево	Варианты: no yes ←	Если `no`, вместо стандартного подключения HTTPS будет использоваться HTTP-соединение. Если значение не указано в задаче, используется значение переменной окружения `ACI_USE_SSL`.
username строка	По умолчанию: "admin"	Имя пользователя для аутентификации. Если значение не указано в задаче, используются значения переменных окружения `ACI_USERNAME` или `ANSIBLE_NET_USERNAME`. псевдонимы: user
validate_certs булево	Варианты: no yes ←	Если `no`, сертификаты SSL не будут проверены. Это следует задать только как `no` при работе с лично контролируемыми сайтами, использующими самозаверяющие сертификаты. Если значение не указано в задаче, используется значение переменной окружения `ACI_VALIDATE_CERTS`.

Примечания

Примечание

Этот модуль предназначен для использования с cisco.aci.aci_switch_policy_leaf_profile. Сначала создается профиль листа (infra:NodeP), а затем создается связанный селектор (infra:LeafS).

См. также

cisco.aci.aci_switch_policy_leaf_profile: Официальная документация по модулю cisco.aci.aci_switch_policy_leaf_profile.
APIC Management Information Model reference: Дополнительная информация о внутренних классах APIC infra:LeafS, infra:NodeBlk и infra:RsAccNodePGrp.
Руководство по Cisco ACI: Подробная информация о том, как управлять инфраструктурой ACI с помощью Ansible.
Разработка модулей Cisco ACI: Подробное руководство по написанию собственных модулей Cisco ACI для участия в проекте.

Примеры

- name: adding a switch policy leaf profile selector associated Node Block range (w/ policy group)
  cisco.aci.aci_switch_leaf_selector:
    host: apic
    username: admin
    password: SomeSecretPassword
    leaf_profile: sw_name
    leaf: leaf_selector_name
    leaf_node_blk: node_blk_name
    from: 1011
    to: 1011
    policy_group: somepolicygroupname
    state: present
  delegate_to: localhost

- name: adding a switch policy leaf profile selector associated Node Block range (w/o policy group)
  cisco.aci.aci_switch_leaf_selector:
    host: apic
    username: admin
    password: SomeSecretPassword
    leaf_profile: sw_name
    leaf: leaf_selector_name
    leaf_node_blk: node_blk_name
    from: 1011
    to: 1011
    state: present
  delegate_to: localhost

- name: Removing a switch policy leaf profile selector
  cisco.aci.aci_switch_leaf_selector:
    host: apic
    username: admin
    password: SomeSecretPassword
    leaf_profile: sw_name
    leaf: leaf_selector_name
    state: absent
  delegate_to: localhost

- name: Querying a switch policy leaf profile selector
  cisco.aci.aci_switch_leaf_selector:
    host: apic
    username: admin
    password: SomeSecretPassword
    leaf_profile: sw_name
    leaf: leaf_selector_name
    state: query
  delegate_to: localhost
  register: query_result

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

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

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

Авторы

Bruno Calogero (@brunocalogero)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/cisco/aci/aci_switch_leaf_selector_module.html