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

Примечание

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

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

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

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

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

Обзор

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

Параметры

Параметр	Комментарии
annotation строка	Пользовательская строка для аннотации объекта. Если значение не указано в задаче, используется значение переменной среды `ACI_ANNOTATION`. Если значение не указано в задаче и переменная среды `ACI_ANNOTATION`, то используется значение по умолчанию. По умолчанию: `"orchestrator:ansible"`
ap псевдонимы: app_profile, app_profile_name строка	Имя существующего профиля прикладной сети, который будет содержать EPG.
certificate_name псевдонимы: cert_name строка	Имя сертификата X.509, прикрепленного к пользователю APIC AAA, используемому для аутентификации на основе подписи. Если был предоставлен имя файла `private_key`, по умолчанию используется имя файла `private_key`, без расширения. Если для `private_key` был предоставлен PEM-форматированный контент, по умолчанию используется значение `username`. Если значение не указано в задаче, используется значение переменной среды `ACI_CERTIFICATE_NAME`.
deploy_immediacy строка	Срочность развертывания статического EPG на ПК, VPC или интерфейсе. APIC по умолчанию устанавливает `lazy`, если параметр не задан при создании. Выбор: `"immediate"` `"lazy"`
description псевдонимы: descr строка	Описание статического пути привязки к EPG.
encap_id псевдонимы: vlan, vlan_id целое число	Идентификатор инкапсуляции, связывающий `epg` с путем интерфейса. Выступает в роли вторичного `encap_id` при использовании микросегментации. Допустимые значения — все допустимые идентификаторы инкапсуляции для указанной инкапсуляции, в настоящее время диапазон от `1` до `4096`.
epg псевдонимы: epg_name строка	Имя группы конечных точек.
extpaths список / элементы=строка	Часть целого числа `extpaths` значения tDn. `extpaths` используется только если `interface_type` имеет значение `fex`, `fex_vpc` или `fex_port_channel`. Если `interface_type` — `fex_vpc`, `extpaths` — список с обеими ID fex. Обычно что-то вроде `1011`.
host псевдонимы: hostname строка	IP-адрес или имя хоста, разрешимые хостом управления Ansible. Если значение не указано в задаче, используется значение переменной среды `ACI_HOST`.
interface строка	Часть строки `interface` значения tDn. Обычно группа политик, например, `test-IntPolGrp`, или интерфейс следующего формата `1/7`, в зависимости от `interface_type`.
interface_mode псевдонимы: interface_mode_name, mode строка	Определяет, как теги уровня 2 будут читаться и добавляться в кадры. Значения `802.1p` и `native` идентичны. Значения `access` и `untagged` идентичны. Значения `regular`, `tagged` и `trunk` идентичны. APIC по умолчанию устанавливает `trunk` при отсутствии параметра при создании. Выбор: `"802.1p"` `"access"` `"native"` `"regular"` `"tagged"` `"trunk"` `"untagged"`
interface_type строка	Тип интерфейса для развертывания статического EPG. Выбор: `"fex"` `"port_channel"` `"switch_port"` ← (по умолчанию) `"vpc"` `"fex_port_channel"` `"fex_vpc"`
leafs псевдонимы: leaves, nodes, paths, switches список / элементы=строка	Идентификатор(ы) коммутатора, к которому принадлежит `interface`. Если `interface_type` имеет значение `switch_port`, `port_channel`, или `fex`, то `leafs` — строка с ID листа. Если `interface_type` имеет значение `vpc`, то `leafs` — список с обоими ID листа. Значение `leafs` обычно что-то вроде ‘101’ или ‘101-102’, в зависимости от `connection_type`.

output_level string	Влияет на вывод этого модуля ACI. `normal` означает стандартный вывод, включая `current` dict `info` добавляет информационный вывод, включая `previous`, `proposed` и `sent` dicts `debug` добавляет отладочный вывод, включая `filter_string`, `method`, `response`, `status` и `url` информацию Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_OUTPUT_LEVEL`. Варианты: `"debug"` `"info"` `"normal"` ← (по умолчанию)
output_path string	Путь к файлу, который будет использоваться для сохранения сгенерированных модулем объектов конфигурации ACI в формате JSON. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_OUTPUT_PATH`.
password string	Пароль для аутентификации. Эта опция взаимоисключающая с `private_key`. Если также указан `private_key`, он будет использоваться вместо него. Если значение не указано в задаче, вместо него будут использоваться значения переменных среды `ACI_PASSWORD` или `ANSIBLE_NET_PASSWORD`.
pod_id aliases: pod, pod_number integer	Часть номера подсистемы (pod) в tDn. `pod_id` обычно является целым числом меньше `10`.
port integer	Номер порта, который будет использоваться для REST-подключения. Значение по умолчанию зависит от параметра `use_ssl`. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_PORT`.
primary_encap_id aliases: primary_vlan, primary_vlan_id string	Определяет основной идентификатор инкапсуляции, связывающий `epg` с путем к интерфейсу при использовании микросегментации. Допустимые значения - любой допустимый идентификатор инкапсуляции для указанной инкапсуляции, в настоящее время в диапазоне от `1` до `4096` и `unknown`. `unknown` является значением по умолчанию, а использование `unknown` отключает микросегментацию.
private_key aliases: cert_key string	Либо файл закрытого ключа в формате PEM, либо содержимое закрытого ключа, используемого для аутентификации на основе подписи. Это значение также влияет на значение `certificate_name` по умолчанию, которое используется. Эта опция взаимоисключающая с `password`. Если также указан `password`, он будет игнорироваться. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_PRIVATE_KEY` или `ANSIBLE_NET_SSH_KEYFILE`.
state string	Используйте `present` или `absent` для добавления или удаления. Используйте `query` для вывода списка одного или нескольких объектов. Варианты: `"absent"` `"present"` ← (по умолчанию) `"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`
tenant aliases: tenant_name string	Имя существующего тенанта.
timeout integer	Таймаут на уровне сокета в секундах. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_TIMEOUT`. Значение по умолчанию - 30.
use_proxy boolean	Если `false`, прокси использоваться не будет, даже если он определен в переменной среды на целевых хостах. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_USE_PROXY`. Значение по умолчанию - true. Варианты: `false` `true`

use_ssl boolean	Если `false`, будет использовано HTTP-соединение вместо стандартного HTTPS-соединения. Если значение не указано в задаче, будет использовано значение переменной окружения `ACI_USE_SSL`. По умолчанию значение равно true, когда подключение локальное. Варианты: `false` `true`
username aliases: user string	Имя пользователя для аутентификации. Если значение не указано в задаче, будет использовано значение переменных окружения `ACI_USERNAME` или `ANSIBLE_NET_USERNAME`. Значение по умолчанию — admin.
validate_certs boolean	Если `false`, сертификаты SSL не будут проверены. Это значение следует устанавливать в `false` только при работе с сайтами, управляемыми лично, использующими самозаверяющие сертификаты. Если значение не указано в задаче, будет использовано значение переменной окружения `ACI_VALIDATE_CERTS`. Значение по умолчанию — true. Варианты: `false` `true`

Примечания

Примечание

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

См. также

cisco.aci.aci_tenant: Управление арендаторами (fv:Tenant).
cisco.aci.aci_ap: Управление объектами профилей приложений верхнего уровня (AP) (fv:Ap).
cisco.aci.aci_epg: Управление объектами групп конечных точек (EPG) (fv:AEPg).
APIC Management Information Model reference: Дополнительная информация о внутреннем классе APIC fv:RsPathAtt.
Руководство по Cisco ACI: Подробная информация о том, как управлять вашей инфраструктурой Cisco 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": "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 строка	Необработанный результат, возвращённый 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 строка	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)
Marcel Zehnder (@maercu)

Ссылки на сборку

© 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_static_binding_to_epg_module.html