Spec-Zone.ru › Ansible

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

Примечание

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

Возможно, эта коллекция уже установлена, если вы используете пакет 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, то будет использовано значение по умолчанию.

Default: "orchestrator:ansible"

certificate_name

aliases: cert_name

string

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

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

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

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

controls

list / elements=string

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

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

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

bfd – Двунаправленное обнаружение переадресации

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

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

Варианты:

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

cost

integer

Стоимость интерфейса 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

integer

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

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

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

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

APIC устанавливает значение по умолчанию 40 при отсутствии значения во время создания.

description

aliases: descr

string

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

hello_interval

integer

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

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

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

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

APIC устанавливает значение по умолчанию 10 при отсутствии значения во время создания.

host

aliases: hostname

string

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

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

name_alias

string

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

network_type

string

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

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

APIC устанавливает значение по умолчанию unspecified при отсутствии значения во время создания.

Варианты:

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

ospf

aliases: 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" ← (default)

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

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

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

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

timeout

integer

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

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

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

transmit_delay

integer

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

OSPF увеличивает время существования LSA на величину задержки передачи перед передачей обновления 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

aliases: user

string

Имя пользователя для аутентификации.

Если значение не указано в задаче, будет использовано значение переменных среды ACI_USERNAME или ANSIBLE_NET_USERNAME.

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

validate_certs

boolean

Если false, сертификаты SSL не будут проверены.

Это нужно установить в false только при работе с собственными самоподписанными сертификатами на контролируемых сайтах.

Если значение не указано в задаче, будет использовано значение переменной среды ACI_VALIDATE_CERTS.

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

Варианты:

  • false
  • true

См. также

См. также

APIC Management Information Model reference

Дополнительная информация о внутренней 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": "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"

Авторы

  • Dag Wieers (@dagwieers)

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

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

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

Spec-Zone.ru

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