Spec-Zone.ru › Ansible 2.10

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

Примечание

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

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

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

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

Краткое описание

  • Привязка селекторов листьев (с диапазоном блоков узлов и группой политик) к профилям листьев политики коммутатора в fabric 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
info добавляет информационный вывод, включая словари previous, proposed и sent
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

Дополнительная информация о внутренних классах 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': '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


Авторы

  • Bruno Calogero (@brunocalogero)

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

Spec-Zone.ru

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