Модуль cisco.aci.aci_interface_policy_spanning_tree — управление политиками интерфейсов протокола связующего дерева (stp:IfPol)

Примечание

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

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

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

Чтобы использовать её в плейбуке, укажите: cisco.aci.aci_interface_policy_spanning_tree.

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

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

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

Параметры

Параметр	Комментарии
annotation string	Пользовательская строка для аннотирования объекта. Если значение не указано в задаче, вместо него будет использоваться значение переменной среды `ACI_ANNOTATION`. Если значение не указано в задаче и переменная среды `ACI_ANNOTATION`, будет использоваться значение по умолчанию. По умолчанию: `"orchestrator:ansible"`
bpdu_filter boolean	Состояние BPDU-Filter. Варианты: `false` ← (по умолчанию) `true`
bpdu_guard boolean	Состояние BPDU-Guard. Варианты: `false` ← (по умолчанию) `true`
certificate_name псевдонимы: cert_name string	Имя сертификата X.509, связанного с пользователем AAA APIC, который используется для аутентификации на основе подписи. Если указан файл `private_key`, по умолчанию используется имя файла `private_key` без расширения. Если для `private_key` указано содержимое в формате PEM, по умолчанию используется значение `username`. Если значение не указано в задаче, вместо него будет использоваться значение переменной среды `ACI_CERTIFICATE_NAME`.
description псевдонимы: descr string	Описание политики.
host псевдонимы: hostname string	IP-адрес или имя узла APIC, доступное для разрешения на управляющем узле Ansible. Если значение не указано в задаче, вместо него будет использоваться значение переменной среды `ACI_HOST`.
name_alias string	Псевдоним текущего объекта. Соответствует полю nameAlias в ACI.
output_level string	Определяет состав выходных данных этого модуля ACI. `normal` означает стандартный вывод, включая словарь `current` `info` добавляет информационный вывод, включая словари `previous`, `proposed` и `sent` `debug` добавляет отладочный вывод, включая информацию `filter_string`, `method`, `response`, `status` и `url` Если значение не указано в задаче, вместо него будет использоваться значение переменной среды `ACI_OUTPUT_LEVEL`. Варианты: `"debug"` `"info"` `"normal"` ← (по умолчанию)
output_path string	Путь к файлу, в который будут записаны объекты конфигурации ACI в формате JSON, созданные модулем. Если значение не указано в задаче, вместо него будет использоваться значение переменной среды `ACI_OUTPUT_PATH`.
owner_key string	Пользовательская строка для атрибута ownerKey объекта ACI. Этот атрибут представляет собой ключ, позволяющий клиентам владеть своими данными для сопоставления сущностей. Если значение не указано в задаче, вместо него будет использоваться значение переменной среды `ACI_OWNER_KEY`.
owner_tag string	Пользовательская строка для атрибута ownerTag объекта ACI. Этот атрибут представляет собой тег, позволяющий клиентам добавлять собственные данные. Например, чтобы указать, кто создал этот объект. Если значение не указано в задаче, вместо него будет использоваться значение переменной среды `ACI_OWNER_TAG`.
password string	Пароль для аутентификации. Этот параметр взаимоисключающий с `private_key`. Если также указан `private_key`, будет использоваться он. Если значение не указано в задаче, вместо него будет использоваться значение переменных среды `ACI_PASSWORD` или `ANSIBLE_NET_PASSWORD`.
port integer	Номер порта для REST-подключения. Значение по умолчанию зависит от параметра `use_ssl`. Если значение не указано в задаче, вместо него будет использоваться значение переменной среды `ACI_PORT`.
private_key псевдонимы: cert_key string	Файл закрытого ключа в формате PEM или содержимое закрытого ключа, используемое для аутентификации на основе подписи. Это значение также влияет на используемое значение `certificate_name` по умолчанию. Этот параметр взаимоисключающий с `password`. Если также указан `password`, он будет проигнорирован. Если значение не указано в задаче, вместо него будет использоваться значение переменной среды `ACI_PRIVATE_KEY` или `ANSIBLE_NET_SSH_KEYFILE`.
state string	Используйте `present` или `absent` для добавления или удаления. Используйте `query` для просмотра одного или нескольких объектов. Варианты: `"absent"` `"present"` ← (по умолчанию) `"query"`
stp_policy псевдонимы: name string	Имя политики STP.
suppress_previous псевдонимы: no_previous, ignore_previous boolean	Если `true`, перед отправкой обновления POST на APIC не будет отправлен GET-запрос для проверки предыдущего состояния. Если значение не указано в задаче, вместо него будет использоваться значение переменной среды `ACI_SUPPRESS_PREVIOUS`. Значение по умолчанию — `false`. ПРЕДУПРЕЖДЕНИЕ — это приведёт к тому, что возвращаемое значение previous будет пустым. Предыдущее состояние объекта проверяться не будет, а обновление POST будет содержать все свойства. Варианты: `false` `true`
suppress_verification псевдонимы: no_verification, no_verify, suppress_verify, ignore_verify, ignore_verification boolean	Если `true`, после отправки обновления POST на APIC не будет отправлен проверочный GET-запрос. Если значение не указано в задаче, вместо него будет использоваться значение переменной среды `ACI_SUPPRESS_VERIFICATION`. Значение по умолчанию — `false`. ПРЕДУПРЕЖДЕНИЕ — это приведёт к тому, что возвращаемое значение current будет установлено в предложенное значение. Текущий объект, включая значения по умолчанию, нельзя будет проверить в рамках одной задачи. Варианты: `false` `true`
timeout integer	Тайм-аут сокетного уровня в секундах. Если значение не указано в задаче, вместо него будет использоваться значение переменной среды `ACI_TIMEOUT`. Значение по умолчанию — 30.
use_proxy boolean	Если `false`, прокси использоваться не будет, даже если он задан в переменной среды на целевых узлах. Если значение не указано в задаче, вместо него будет использоваться значение переменной среды `ACI_USE_PROXY`. Значение по умолчанию — true. Варианты: `false` `true`
use_ssl boolean	Если `false`, вместо HTTPS-подключения, используемого по умолчанию, будет установлено HTTP-подключение. Если значение не указано в задаче, вместо него будет использоваться значение переменной среды `ACI_USE_SSL`. При локальном подключении значение по умолчанию — true. Варианты: `false` `true`
username псевдонимы: user string	Имя пользователя для аутентификации. Если значение не указано в задаче, вместо него будет использоваться значение переменных среды `ACI_USERNAME` или `ANSIBLE_NET_USERNAME`. Значение по умолчанию — admin.
validate_certs boolean	Если `false`, SSL-сертификаты проверяться не будут. Значение `false` следует задавать только для контролируемых вами сайтов, использующих самоподписанные сертификаты. Если значение не указано в задаче, вместо него будет использоваться значение переменной среды `ACI_VALIDATE_CERTS`. Значение по умолчанию — true. Варианты: `false` `true`

См. также

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

Примеры

- name: Add a spanning interface policy
  cisco.aci.aci_interface_policy_spanning_tree:
    host: '{{ inventory_hostname }}'
    username: '{{ username }}'
    password: '{{ password }}'
    stp_policy: 'my_policy'
    description: 'my_description'
    bpdu_guard: true
    bpdu_filter: false
    state: present
  delegate_to: localhost

- name: Query a specific spanning interface policy
  cisco.aci.aci_interface_policy_spanning_tree:
    host: '{{ inventory_hostname }}'
    username: '{{ username }}'
    password: '{{ password }}'
    stp_policy: 'my_policy'
    state: query
  delegate_to: localhost

- name: Query all spanning interface policies
  cisco.aci.aci_interface_policy_spanning_tree:
    host: '{{ inventory_hostname }}'
    username: '{{ username }}'
    password: '{{ password }}'
    state: query
  delegate_to: localhost

- name: Remove a specific spanning interface policy
  cisco.aci.aci_interface_policy_spanning_tree:
    host: '{{ inventory_hostname }}'
    username: '{{ username }}'
    password: '{{ password }}'
    stp_policy: 'my_policy'
    state: absent
  delegate_to: localhost

Возвращаемые значения

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

Ключ	Описание
current list / elements=string	Текущая конфигурация APIC после завершения работы модуля Возвращается: success Пример: `[{"fvTenant": {"attributes": {"descr": "Production environment", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]`
error dictionary	Сведения об ошибке, полученные от APIC Возвращается: failure Пример: `{"code": "122", "text": "unknown managed object class foo"}`
filter_string string	Строка фильтра, использованная для запроса Возвращается: failure или debug Пример: `"?rsp-prop-include=config-only"`
method string	Метод HTTP, использованный для запроса к APIC Возвращается: failure или debug Пример: `"POST"`
previous list / elements=string	Исходная конфигурация APIC до начала работы модуля Возвращается: info Пример: `[{"fvTenant": {"attributes": {"descr": "Production", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]`
proposed dictionary	Сформированная конфигурация на основе параметров, предоставленных пользователем Возвращается: info Пример: `{"fvTenant": {"attributes": {"descr": "Production environment", "name": "production"}}}`
raw string	Исходные данные, возвращённые REST API APIC (xml или json) Возвращается: parse error Пример: `"<?xml version=\"1.0\" encoding=\"UTF-8\"?><imdata totalCount=\"1\"><error code=\"122\" text=\"unknown managed object class foo\"/></imdata>"`
response string	Ответ HTTP от APIC Возвращается: failure или debug Пример: `"OK (30 bytes)"`
sent list / elements=string	Фактическая/минимальная конфигурация, переданная в APIC Возвращается: info Пример: `{"fvTenant": {"attributes": {"descr": "Production environment"}}}`
status integer	Код состояния HTTP от APIC Возвращается: failure или debug Пример: `200`
url string	URL HTTP, использованный для запроса к APIC Возвращается: failure или debug Пример: `"https://10.11.12.13/api/mo/uni/tn-production.json"`

Авторы

Eric Girard (@netgirard)

Ссылки на коллекцию

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