Модуль cisco.aci.aci_interface_policy_leaf_policy_group — Управление политиками интерфейсов для узловых точек политики (infra:AccBndlGrp и infra:AccPortGrp)

Примечание

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

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

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

Чтобы использовать её в книге задач, укажите: cisco.aci.aci_interface_policy_leaf_policy_group.

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

Описание

Управление политиками интерфейсов для узловых точек политики на Cisco ACI.

Параметры

Параметр	Комментарии
aep aliases: aep_name string	Имя профиля присоединенного объекта (AEP), используемого группой политик интерфейса уровня leaf.
annotation string	Определяемая пользователем строка для аннотации объекта. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `ACI_ANNOTATION`. Если значение не указано в задаче и переменной окружения `ACI_ANNOTATION`, то будет использовано значение по умолчанию. Default: `"orchestrator:ansible"`
cdp_policy aliases: cdp_policy_name string	Имя политики CDP, используемой группой политик интерфейса уровня leaf.
certificate_name aliases: cert_name string	Имя сертификата X.509, прикрепленного к пользователю APIC AAA, используемому для аутентификации на основе подписи. Если был предоставлен файл `private_key`, это значение по умолчанию будет базовым именем `private_key`, без расширения. Если для `private_key` было предоставлено содержимое в формате PEM, это значение по умолчанию будет равно `username`. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `ACI_CERTIFICATE_NAME`.
copp_policy aliases: copp_policy_name string	Имя политики CoPP, используемой группой политик интерфейса уровня leaf.
description aliases: descr string	Описание группы политик интерфейса уровня leaf.
dwdm aliases: dwdm_name string	Имя DWDM, используемого группой политик интерфейса уровня leaf.
egress_data_plane_policing_policy aliases: egress_data_plane_policing_policy_name string	Имя политики контроля трафика на исходящем канале данных, используемой группой политик интерфейса уровня leaf.
fibre_channel_interface_policy aliases: fibre_channel_interface_policy_name string	Имя политики интерфейса Fibre Channel, используемой группой политик интерфейса уровня leaf.
host aliases: hostname string	IP-адрес или имя хоста APIC, разрешаемое узлом управления Ansible. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `ACI_HOST`.
ingress_data_plane_policing_policy aliases: ingress_data_plane_policing_policy_name string	Имя политики контроля трафика на входящем канале данных, используемой группой политик интерфейса уровня leaf.
l2_interface_policy aliases: l2_interface_policy_name string	Имя политики интерфейса 2 уровня, используемой группой политик интерфейса уровня leaf.
lag_type aliases: lag_type_name string / required	Селектор для типа группы политик интерфейса уровня leaf. `leaf` для группы политик порта доступа уровня leaf `link` для канала портов (PC) `node` для виртуального канала портов (VPC) Варианты: `"leaf"` `"link"` `"node"`
link_flap_policy aliases: link_flap_policy_name string	Имя политики отключения линии связи, используемой группой политик интерфейса уровня leaf.
link_level_flow_control aliases: link_level_flow_control_name string	Имя управления потоком на уровне линии связи, используемого группой политик интерфейса уровня leaf.

link_level_policy aliases: link_level_policy_name строка	Имя политики уровня канала, используемой группой политики интерфейса листа.
lldp_policy aliases: lldp_policy_name строка	Имя политики LLDP, используемой группой политики интерфейса листа.
mac_sec_interface_policy aliases: mac_sec_interface_policy_name строка	Имя политики интерфейса MAC sec, используемой группой политики интерфейса листа.
mcp_policy aliases: mcp_policy_name строка	Имя политики MCP, используемой группой политики интерфейса листа.
monitoring_policy aliases: monitoring_policy_name строка	Имя политики мониторинга, используемой группой политики интерфейса листа.
name_alias строка	Псевдоним текущего объекта. Он относится к полю nameAlias в ACI.
output_level строка	Влияет на вывод этого модуля ACI. `normal` означает стандартный вывод, вкл. `current` dict `info` добавляет информационный вывод, вкл. `previous`, `proposed` и `sent` dicts `debug` добавляет отладочный вывод, вкл. `filter_string`, `method`, `response`, `status` и `url` информации Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_OUTPUT_LEVEL`. Варианты: `"debug"` `"info"` `"normal"` ← (по умолчанию)
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`.
poe_interface_policy aliases: poe_interface_policy_name строка	Имя политики интерфейса PoE, используемой группой политики интерфейса листа.
policy_group aliases: name, policy_group_name строка	Имя группы политики интерфейса листа.
port целое число	Номер порта, используемый для подключения REST. Значение по умолчанию зависит от параметра `use_ssl`. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_PORT`.
port_authentication aliases: port_authentication_name строка	Имя аутентификации порта, используемой группой политики интерфейса листа.
port_channel_policy aliases: port_channel_policy_name строка	Имя политики каналов портов, используемой группой политики интерфейса листа.

END_OF_DOCUMENT_MARKER

port_security_policy aliases: port_security_policy_name строка	Имя политики безопасности порта, используемой группой политик интерфейсов листа.
priority_flow_control_policy aliases: priority_flow_control_policy_name строка	Имя политики приоритетного управления потоком, используемой группой политик интерфейсов листа.
private_key aliases: cert_key строка	Файл закрытого ключа в формате PEM или содержимое закрытого ключа, используемого для аутентификации на основе подписи. Это значение также влияет на используемое значение по умолчанию `certificate_name`. Этот параметр взаимоисключающий с `password`. Если также указано `password`, оно будет проигнорировано. Если значение не указано в задаче, будет использовано значение переменной среды `ACI_PRIVATE_KEY` или `ANSIBLE_NET_SSH_KEYFILE`.
slow_drain_policy aliases: slow_drain_policy_name строка	Имя политики медленного сброса, используемой группой политик интерфейсов листа.
state строка	Используйте `present` или `absent` для добавления или удаления. Используйте `query` для вывода объекта или нескольких объектов. Варианты: `"absent"` `"present"` ← (по умолчанию) `"query"`
storm_control_interface_policy aliases: storm_control_interface_policy_name строка	Имя политики управления штормами интерфейса, используемой группой политик интерфейсов листа.
stp_interface_policy aliases: stp_interface_policy_name строка	Имя политики интерфейса STP, используемой группой политик интерфейсов листа.
suppress_previous aliases: no_previous, ignore_previous булево	Если `true`, GET для проверки предыдущего состояния не будет отправлен перед обновлением POST в APIC. Если значение не указано в задаче, будет использовано значение переменной среды `ACI_SUPPRESS_PREVIOUS`. Значение по умолчанию - `false`. ПРЕДУПРЕЖДЕНИЕ - Это приводит к тому, что предыдущее возвращаемое значение становится пустым. Предыдущее состояние объекта не будет проверяться, и обновление POST будет содержать все свойства. Варианты: `false` `true`
suppress_verification aliases: no_verification, no_verify, suppress_verify, ignore_verify, ignore_verification булево	Если `true`, подтверждающий GET не будет отправлен после обновления POST в APIC. Если значение не указано в задаче, будет использовано значение переменной среды `ACI_SUPPRESS_VERIFICATION`. Значение по умолчанию - `false`. ПРЕДУПРЕЖДЕНИЕ - Это приводит к установке текущего возвращаемого значения в предложенное значение. Текущий объект, включая значения по умолчанию, будет неподтверждаемым в одной задаче. Варианты: `false` `true`
sync_e_interface_policy aliases: sync_e_interface_policy_name строка	Имя политики интерфейса syncE, используемой группой политик интерфейсов листа. Доступно только в версии APIC 5.2 или более поздней.
timeout целое число	Таймаут уровня сокета в секундах. Если значение не указано в задаче, будет использовано значение переменной среды `ACI_TIMEOUT`. Значение по умолчанию - 30.
transceiver_policy словарь	Имя политики трансивера, используемой группой политик интерфейсов листа. Доступно только в версии APIC 6.0(2h) или более поздней.
name aliases: transceiver_policy_name строка / обязательно	Имя политики трансивера.
type aliases: transceiver_policy_type строка / обязательно	Тип политики трансивера. Варианты: `"zr"` `"zrp"`

use_proxy boolean	Если `false`, прокси не будет использоваться, даже если он определен в переменной среды на целевых хостах. Если значение не указано в задаче, будет использовано значение переменной среды `ACI_USE_PROXY`. Значение по умолчанию — true. Выберите: `false` `true`
use_ssl boolean	Если `false`, вместо стандартного HTTPS-соединения будет использовано HTTP-соединение. Если значение не указано в задаче, будет использовано значение переменной среды `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`

Примечания

Примечание

При использовании модуля выберите соответствующий тип агрегирования (lag_type).
link для Port Channel(PC), node для Virtual Port Channel(VPC) и leaf для Leaf Access Port Policy Group.

См. также

Ссылка на справочник моделирования информации управления APIC: Дополнительная информация о внутренних классах APIC infra:AccBndlGrp и infra:AccPortGrp.
Руководство Cisco ACI: Подробная информация о том, как управлять инфраструктурой ACI с помощью Ansible.
Разработка модулей Cisco ACI: Подробное руководство по написанию собственных модулей Cisco ACI для внесения вклада.

Примеры

- name: Create a Port Channel (PC) Interface Policy Group
  cisco.aci.aci_interface_policy_leaf_policy_group:
    host: apic
    username: admin
    password: SomeSecretPassword
    lag_type: link
    policy_group: policygroupname
    description: policygroupname description
    link_level_policy: linklevelpolicy
    cdp_policy: cdppolicy
    lldp_policy: lldppolicy
    port_channel_policy: lacppolicy
    state: present
  delegate_to: localhost

- name: Create a Virtual Port Channel (VPC) Interface Policy Group
  cisco.aci.aci_interface_policy_leaf_policy_group:
    host: apic
    username: admin
    password: SomeSecretPassword
    lag_type: node
    policy_group: policygroupname
    link_level_policy: linklevelpolicy
    cdp_policy: cdppolicy
    lldp_policy: lldppolicy
    port_channel_policy: lacppolicy
    state: present
  delegate_to: localhost

- name: Create a Leaf Access Port Policy Group
  cisco.aci.aci_interface_policy_leaf_policy_group:
    host: apic
    username: admin
    password: SomeSecretPassword
    lag_type: leaf
    policy_group: policygroupname
    link_level_policy: linklevelpolicy
    cdp_policy: cdppolicy
    lldp_policy: lldppolicy
    state: present
  delegate_to: localhost

- name: Query all Leaf Access Port Policy Groups of type link
  cisco.aci.aci_interface_policy_leaf_policy_group:
    host: apic
    username: admin
    password: SomeSecretPassword
    lag_type: link
    state: query
  delegate_to: localhost
  register: query_result

- name: Query a specific Lead Access Port Policy Group
  cisco.aci.aci_interface_policy_leaf_policy_group:
    host: apic
    username: admin
    password: SomeSecretPassword
    lag_type: leaf
    policy_group: policygroupname
    state: query
  delegate_to: localhost
  register: query_result

- name: Delete an Interface policy Leaf Policy Group
  cisco.aci.aci_interface_policy_leaf_policy_group:
    host: apic
    username: admin
    password: SomeSecretPassword
    lag_type: leaf
    policy_group: policygroupname
    state: absent
  delegate_to: localhost

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

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

Ключ	Описание
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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/cisco/aci/aci_interface_policy_leaf_policy_group_module.html