Spec-Zone.ru › Ansible

Модуль cisco.aci.aci_interface_policy_ospf — управление политиками интерфейсов OSPF (ospf:IfPol)

Примечание

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

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

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

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

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

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

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

Параметры

Параметр

Комментарии

annotation

string

Пользовательская строка для добавления аннотации к объекту.

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

Если значение не указано в задаче и переменная окружения ACI_ANNOTATION не задана, будет использоваться значение по умолчанию.

По умолчанию: "orchestrator:ansible"

certificate_name

псевдонимы: cert_name

string

Имя сертификата X.509, связанного с пользователем APIC AAA, который используется для аутентификации на основе подписи.

Если указан файл private_key, по умолчанию используется базовое имя файла private_key без расширения.

Если для private_key передано содержимое в формате PEM, по умолчанию используется значение username.

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

controls

list / элементы=string

Параметры управления политикой интерфейса.

Список из одного или нескольких следующих параметров управления:

advert-subnet — объявлять IP-подсеть вместо маски узла в LSA маршрутизатора.

bfd — двунаправленное обнаружение пересылки (BFD)

mtu-ignore — отключает обнаружение несоответствия MTU на интерфейсе.

passive — интерфейс не участвует в протоколе OSPF и не устанавливает смежности и не отправляет обновления маршрутизации. Однако интерфейс объявляется частью сети маршрутизации.

Варианты:

  • "advert-subnet"
  • "bfd"
  • "mtu-ignore"
  • "passive"
  • "unspecified"

cost

integer

Стоимость интерфейса OSPF.

Стоимость интерфейса в OSPF (также называемая метрикой) показывает накладные расходы на передачу пакетов через этот интерфейс. Стоимость интерфейса обратно пропорциональна его пропускной способности. Чем выше пропускная способность, тем ниже стоимость. Передача данных по последовательной линии 56k связана с большими накладными расходами (более высокой стоимостью) и задержками, чем передача по линии Ethernet 10M. Для расчёта стоимости используется формула cost= 10000 0000/bandwith in bps. Например, стоимость передачи по линии Ethernet 10M составит 10 EXP8/10 EXP7 = 10, а по линии T1 — 10 EXP8/1544000 = 64.

По умолчанию стоимость интерфейса рассчитывается на основе пропускной способности; её можно задать принудительно с помощью команды режима подконфигурации интерфейса ip ospf cost value.

Допустимые значения находятся в диапазоне от 1 до 450.

Если при создании значение не задано, APIC использует значение 0.

dead_interval

integer

Интервал ожидания пакетов hello от соседа, по истечении которого маршрутизатор объявляет соседа недоступным.

Это значение должно быть одинаковым для всех сетевых устройств в конкретной сети.

Уменьшение интервала dead (в секундах) ускоряет обнаружение недоступности соседа и повышает скорость сходимости, но может привести к большей нестабильности маршрутизации.

Допустимые значения находятся в диапазоне от 1 до 65535.

Если при создании значение не задано, APIC использует значение 40.

description

псевдонимы: descr

string

Описание интерфейса OSPF.

hello_interval

integer

Интервал между пакетами hello, которые OSPF отправляет через интерфейс.

Чем меньше интервал hello, тем быстрее обнаруживаются изменения топологии, но при этом возрастает объём трафика маршрутизации.

Это значение должно быть одинаковым для всех маршрутизаторов и серверов доступа в конкретной сети.

Допустимые значения находятся в диапазоне от 1 до 65535.

Если при создании значение не задано, APIC использует значение 10.

host

псевдонимы: hostname

string

IP-адрес или имя узла APIC, доступное для разрешения на управляющем узле Ansible.

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

name_alias

string

Псевдоним текущего объекта. Соответствует полю nameAlias в ACI.

network_type

string

Тип сети политики интерфейса OSPF.

OSPF поддерживает широковещательные сети и соединения точка-точка.

Если при создании значение не задано, APIC использует значение unspecified.

Варианты:

  • "bcast"
  • "p2p"
  • "unspecified"

ospf

псевдонимы: ospf_interface, name

string

Имя политики интерфейса OSPF.

Имя может содержать от 1 до 64 буквенно-цифровых символов.

Обратите внимание: после сохранения объекта изменить это имя нельзя.

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.

prefix_suppression

string

Включено или отключено подавление префиксов.

Если при создании значение не задано, APIC использует значение inherit.

Варианты:

  • "inherit"
  • "enable"
  • "disable"

priority

integer

Приоритет профиля интерфейса OSPF.

Допустимые значения находятся в диапазоне от 0 до 255.

Если при создании значение не задано, APIC использует значение 1.

private_key

псевдонимы: cert_key

string

Файл закрытого ключа в формате PEM или содержимое закрытого ключа, используемое для аутентификации на основе подписи.

Это значение также влияет на значение по умолчанию certificate_name.

Этот параметр взаимоисключающий с password. Если также указан password, он будет проигнорирован.

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

retransmit_interval

integer

Интервал между повторными передачами LSA.

Интервал повторной передачи действует, пока маршрутизатор ожидает от соседнего маршрутизатора подтверждения получения LSA.

Если по истечении интервала подтверждение не получено, LSA отправляется повторно.

Допустимые значения находятся в диапазоне от 1 до 65535.

Если при создании значение не задано, APIC использует значение 5.

state

string

Используйте present или absent для добавления или удаления.

Используйте query для просмотра одного или нескольких объектов.

Варианты:

  • "absent"
  • "present" ← (по умолчанию)
  • "query"

suppress_previous

псевдонимы: no_previous, ignore_previous

boolean

Если true, перед POST-обновлением APIC не будет отправлен GET-запрос для проверки предыдущего состояния.

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

Значение по умолчанию: false.

ПРЕДУПРЕЖДЕНИЕ — в результате возвращаемое предыдущее значение будет пустым.

Предыдущее состояние объекта проверяться не будет, а POST-обновление будет содержать все свойства.

Варианты:

  • false
  • true

suppress_verification

псевдонимы: no_verification, no_verify, suppress_verify, ignore_verify, ignore_verification

boolean

Если true, после POST-обновления APIC проверочный GET-запрос отправляться не будет.

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

Значение по умолчанию: false.

ПРЕДУПРЕЖДЕНИЕ — в результате текущее возвращаемое значение будет установлено равным предложенному значению.

Текущее состояние объекта, включая значения по умолчанию, нельзя будет проверить в рамках одной задачи.

Варианты:

  • false
  • true

tenant

псевдонимы: tenant_name

string

Имя арендатора, которому должна принадлежать политика интерфейса OSPF.

timeout

integer

Тайм-аут на уровне сокета в секундах.

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

Значение по умолчанию — 30.

transmit_delay

integer

Задержка, необходимая для отправки пакета обновления LSA.

Перед передачей обновления LSA протокол OSPF увеличивает время жизни LSA на величину задержки передачи.

При задании этого значения следует учитывать задержки передачи и распространения для интерфейса.

Допустимые значения находятся в диапазоне от 1 до 450.

Если при создании значение не задано, APIC использует значение 1.

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 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

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"

Авторы

  • Dag Wieers (@dagwieers)

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

  • Отслеживание проблем
  • Репозиторий (исходный код)

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API