cisco.aci.aci_static_binding_to_epg – Привязать статические пути к EPG (fv:RsPathAtt)

Примечание

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

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

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

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

Обзор

Привязать статические пути к EPG на Cisco ACI фабриках.

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
annotation строка		Пользовательская строка для аннотирования объекта. Если значение не указано в задаче, используется значение переменной окружения `ACI_ANNOTATION`.
ap строка		Имя существующего профиля сетевого приложения, который будет содержать EPG. псевдонимы: app_profile, app_profile_name
certificate_name строка		Имя сертификата X.509, прикрепленного к пользователю APIC AAA, используемому для аутентификации на основе подписи. Если был предоставлен файл с именем `private_key`, по умолчанию используется имя файла `private_key` без расширения. Если для `private_key` был предоставлено содержимое в формате PEM, по умолчанию используется значение `username`. Если значение не указано в задаче, используется значение переменной окружения `ACI_CERTIFICATE_NAME`. псевдонимы: cert_name
deploy_immediacy строка	Варианты: immediate lazy	Немедленность развертывания статического EPG на ПК, VPC или интерфейсе. APIC по умолчанию использует значение `lazy` при создании без указания.
description строка		Описание статического пути привязки к EPG. псевдонимы: descr
encap_id целое число		Идентификатор инкапсуляции, связывающий `epg` с путем интерфейса. Выступает в качестве дополнительного `encap_id` при использовании микросегментации. Допустимые значения — любые допустимые идентификаторы инкапсуляции для указанной инкапсуляции, в настоящее время диапазон от `1` до `4096`. псевдонимы: vlan, vlan_id
epg строка		Имя группы конечных точек. псевдонимы: epg_name
extpaths целое число		Часть целого значения `extpaths` в tDn. `extpaths` используется только если `interface_type` равно `fex`. Обычно имеет вид `1011`.
host строка / обязательно		IP-адрес или имя хоста, разрешаемые хостом управления Ansible. Если значение не указано в задаче, используется значение переменной окружения `ACI_HOST`. псевдонимы: hostname
interface строка		Часть строкового значения `interface` в tDn. Обычно это группа политик, например, `test-IntPolGrp`, или интерфейс в формате `1/7`, в зависимости от `interface_type`.
interface_mode строка	Варианты: 802.1p access native regular tagged trunk untagged	Определяет, как будут считываться и добавляться метки уровня 2 к кадрам. Значения `802.1p` и `native` идентичны. Значения `access` и `untagged` идентичны. Значения `regular`, `tagged` и `trunk` идентичны. APIC по умолчанию использует значение `trunk` при создании без указания. псевдонимы: interface_mode_name, mode
interface_type строка	Варианты: fex port_channel switch_port ← vpc	Тип интерфейса для развертывания статического EPG.
leafs список / элементы=строка		Идентификатор(ы) коммутатора, к которому принадлежит `interface`. Если `interface_type` равно `switch_port`, `fex`, то `leafs` — строка с идентификатором листа. Если `interface_type` равно `vpc`, то `leafs` — список с обоих идентификаторами листа. Значение `leafs` обычно имеет вид '101' или '101-102' в зависимости от `connection_type`. псевдонимы: leaves, nodes, paths, switches
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`.
pod_id целое число		Номер подсети в tDn. `pod_id` обычно представляет собой целое число меньше `10`. псевдонимы: pod, pod_number
port целое число		Номер порта для подключения REST. Значение по умолчанию зависит от параметра `use_ssl`. Если значение не указано в задаче, используется значение переменной окружения `ACI_PORT`.
primary_encap_id целое число		Определяет первичный идентификатор инкапсуляции, связывающий `epg` с путем интерфейса при использовании микросегментации. Допустимые значения — любые допустимые идентификаторы инкапсуляции для указанной инкапсуляции, в настоящее время диапазон от `1` до `4096`. псевдонимы: primary_vlan, primary_vlan_id
private_key строка		Файл закрытого ключа в формате PEM или содержимое закрытого ключа, используемое для аутентификации на основе подписи. Это значение также влияет на значение по умолчанию `certificate_name`. Этот параметр взаимно исключающий с `password`. Если также указан `password`, он будет проигнорирован. Если значение не указано в задаче, используется значение переменной окружения `ACI_PRIVATE_KEY`. псевдонимы: cert_key
state строка	Варианты: absent present ← query	Используйте `present` или `absent` для добавления или удаления. Используйте `query` для перечисления объекта или нескольких объектов.
tenant строка		Имя существующего арендатора. псевдонимы: tenant_name
timeout целое число	По умолчанию: 30	Таймаут на уровне сокета в секундах. Если значение не указано в задаче, используется значение переменной окружения `ACI_TIMEOUT`.
use_proxy булево	Варианты: no yes ←	Если `no`, не будет использоваться прокси, даже если он определён в переменной среды на целевых узлах. Если значение не указано в задаче, используется значение переменной окружения `ACI_USE_PROXY`.
use_ssl булево	Варианты: no yes ←	Если `no`, будет использоваться HTTP-соединение вместо стандартного HTTPS-соединения. Если значение не указано в задаче, используется значение переменной окружения `ACI_USE_SSL`.
username строка	По умолчанию: "admin"	Имя пользователя для аутентификации. Если значение не указано в задаче, используется значение переменных окружения `ACI_USERNAME` или `ANSIBLE_NET_USERNAME`. псевдонимы: user

validate_certs

boolean

Варианты:

no
да ←

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

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

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

Примечания

Примечание

Модули tenant, ap, epg должны существовать перед использованием этого модуля в вашей книге задач. Модули cisco.aci.aci_tenant, cisco.aci.aci_ap, cisco.aci.aci_epg могут быть использованы для этого.

См. также

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

Примеры

- name: Deploy Static Path binding for given EPG
  cisco.aci.aci_static_binding_to_epg:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: accessport-code-cert
    ap: accessport_code_app
    epg: accessport_epg1
    encap_id: 222
    deploy_immediacy: lazy
    interface_mode: untagged
    interface_type: switch_port
    pod_id: 1
    leafs: 101
    interface: '1/7'
    state: present
  delegate_to: localhost

- name: Remove Static Path binding for given EPG
  cisco.aci.aci_static_binding_to_epg:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: accessport-code-cert
    ap: accessport_code_app
    epg: accessport_epg1
    interface_type: switch_port
    pod: 1
    leafs: 101
    interface: '1/7'
    state: absent
  delegate_to: localhost

- name: Get specific Static Path binding for given EPG
  cisco.aci.aci_static_binding_to_epg:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: accessport-code-cert
    ap: accessport_code_app
    epg: accessport_epg1
    interface_type: switch_port
    pod: 1
    leafs: 101
    interface: '1/7'
    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–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/cisco/aci/aci_static_binding_to_epg_module.html