cisco.aci.aci_interface_policy_ospf – Управление политиками интерфейсов OSPF (ospf:IfPol)

Примечание

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

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

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

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

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

Управление политиками интерфейсов OSPF на тканях Cisco ACI.

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
annotation строка		Пользовательская строка для аннотирования объекта. Если значение не указано в задаче, используется значение переменной окружения `ACI_ANNOTATION`.
certificate_name строка		Имя сертификата X.509, прикрепленного к пользователю APIC AAA, используемому для аутентификации на основе подписи. Если был предоставлен файл с именем `private_key`, по умолчанию используется имя файла `private_key`, без расширения. Если для `private_key` был предоставлен контент в формате PEM, по умолчанию используется значение `username`. Если значение не указано в задаче, используется значение переменной окружения `ACI_CERTIFICATE_NAME`. псевдонимы: cert_name
controls список / элементы=строка	Варианты: advert-subnet bfd mtu-ignore passive	Управление политикой интерфейса. Это список одного или нескольких следующих элементов управления: `advert-subnet` — Рекламировать IP-подсеть вместо маски хоста в LSA маршрутизатора. `bfd` — Взаимное обнаружение посылаемых пакетов. `mtu-ignore` — Отключает обнаружение несоответствия MTU на интерфейсе. `passive` — Интерфейс не участвует в протоколе OSPF и не будет устанавливать соседства или отправлять обновления маршрутизации. Однако интерфейс объявляется как часть сетевой маршрутизации.
cost целое число		Стоимость OSPF интерфейса. Стоимость (также называемая метрикой) интерфейса в OSPF указывает на затраты на отправку пакетов через определенный интерфейс. Стоимость интерфейса обратно пропорциональна пропускной способности этого интерфейса. Более высокая пропускная способность указывает на меньшую стоимость. Переход по 56k-линии требует больших накладных расходов (большей стоимости) и задержек по сравнению с переходом по 10M Ethernet. Формула для расчета стоимости — `cost= 10000 0000/bandwith in bps`. Например, стоимость перехода по 10M Ethernet составляет 10 EXP8/10 EXP7 = 10, а по T1-линии — 10 EXP8/1544000 = 64. По умолчанию стоимость интерфейса рассчитывается на основе пропускной способности; вы можете установить стоимость интерфейса с помощью команды ip ospf cost value interface subconfiguration mode. Допустимые значения находятся в диапазоне от `1` до `450`. APIC по умолчанию использует `0`, если значение не установлено при создании.
dead_interval целое число		Интервал между пакетами hello от соседа, прежде чем маршрутизатор объявит соседа недоступным. Это значение должно быть одинаковым для всех сетевых устройств в определенной сети. Указание меньшего интервала ожидания (секунд) обеспечит более быстрое обнаружение недоступности соседа и улучшит сходимость, но может привести к большей неустойчивости маршрутизации. Допустимые значения находятся в диапазоне от `1` до `65535`. APIC по умолчанию использует `40`, если значение не установлено при создании.
description строка		Описание интерфейса OSPF. псевдонимы: descr
hello_interval целое число		Интервал между пакетами hello, которые OSPF отправляет по интерфейсу. Обратите внимание, что чем меньше интервал hello, тем быстрее будут обнаружены изменения топологии, но увеличится сетевой трафик. Это значение должно быть одинаковым для всех маршрутизаторов и серверов доступа в определенной сети. Допустимые значения находятся в диапазоне от `1` до `65535`. APIC по умолчанию использует `10`, если значение не установлено при создании.
host строка / обязательно		IP-адрес или имя хоста, разрешимые контрольным узлом Ansible. Если значение не указано в задаче, используется значение переменной окружения `ACI_HOST`. псевдонимы: hostname
name_alias строка		Псевдоним для текущего объекта. Связано с полем nameAlias в ACI.
network_type строка	Варианты: bcast p2p	Тип сети политики интерфейса OSPF. OSPF поддерживает широковещательные и точка-точка. APIC по умолчанию использует `unspecified`, если значение не установлено при создании.
ospf строка		Имя политики интерфейса OSPF. Это имя может содержать от 1 до 64 буквенно-цифровых символов. Обратите внимание, что вы не можете изменить это имя после сохранения объекта. псевдонимы: ospf_interface, name
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`.
port целое число		Номер порта, используемый для подключения REST. Значение по умолчанию зависит от параметра `use_ssl`. Если значение не указано в задаче, используется значение переменной окружения `ACI_PORT`.
prefix_suppression логическое	Варианты: no yes	Включено или выключено подавление префиксов. APIC по умолчанию использует `inherit`, если значение не установлено при создании.
priority целое число		Приоритет профиля интерфейса OSPF. Допустимые значения находятся в диапазоне от `0` до `255`. APIC по умолчанию использует `1`, если значение не установлено при создании.
private_key строка		Файл закрытого ключа в формате PEM или содержимое закрытого ключа, используемого для аутентификации на основе подписи. Это значение также влияет на значение по умолчанию `certificate_name`, которое используется. Этот параметр взаимоисключает `password`. Если также указан `password`, он будет проигнорирован. Если значение не указано в задаче, используется значение переменной окружения `ACI_PRIVATE_KEY`. псевдонимы: cert_key
retransmit_interval целое число		Интервал между повторными отправками LSA. Интервал повторной отправки возникает, когда маршрутизатор ожидает подтверждения от соседнего маршрутизатора о получении LSA. Если подтверждение не получено в конце интервала, LSA отправляется повторно. Допустимые значения находятся в диапазоне от `1` до `65535`. APIC по умолчанию использует `5`, если значение не установлено при создании.
state строка	Варианты: absent present ← query	Используйте `present` или `absent` для добавления или удаления. Используйте `query` для получения списка объекта или нескольких объектов.
tenant строка		Имя арендатора, к которому должна принадлежать политика интерфейса OSPF. псевдонимы: tenant_name
timeout целое число	По умолчанию: 30	Тайм-аут уровня сокета в секундах. Если значение не указано в задаче, используется значение переменной окружения `ACI_TIMEOUT`.
transmit_delay целое число		Время задержки, необходимое для отправки пакета обновления LSA. OSPF увеличивает время жизни LSA на значение задержки передачи перед отправкой обновления LSA. При установке этого значения необходимо учитывать задержки передачи и распространения для интерфейса. Допустимые значения находятся в диапазоне от `1` до `450`. APIC по умолчанию использует `1`, если значение не установлено при создании.

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

См. также

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

Примеры

- name: Ensure ospf interface policy exists
  cisco.aci.aci_interface_policy_ospf:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    ospf: ospf1
    state: present
  delegate_to: localhost

- name: Ensure ospf interface policy does not exist
  cisco.aci.aci_interface_policy_ospf:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    ospf: ospf1
    state: present
  delegate_to: localhost

- name: Query an ospf interface policy
  cisco.aci.aci_interface_policy_ospf:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    ospf: ospf1
    state: query
  delegate_to: localhost
  register: query_result

- name: Query all ospf interface policies in tenant production
  cisco.aci.aci_interface_policy_ospf:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    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 строка	ошибка разбора	Необработанный вывод, возвращённый APIC REST API (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-адрес, используемый для запроса к APIC. Пример: https://10.11.12.13/api/mo/uni/tn-production.json

Авторы

Dag Wieers (@dagwieers)

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