Spec-Zone.ru › Ansible

Модуль cisco.aci.aci_interface_policy_eigrp — Управление политиками интерфейсов EIGRP (eigrp:IfPol)

Примечание

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

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

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

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

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

Обзор

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

Параметры

Параметр

Комментарии

annotation

string

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

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

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

Default: "orchestrator:ansible"

bandwidth

integer

Пропускная способность EIGRP в кбит/с, переопределяет пропускную способность, настроенную на интерфейсе.

Это используется для влияния на выбор пути.

Допустимый диапазон значений от 0 до 2560000000.

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

certificate_name

aliases: cert_name

string

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

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

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

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

control_state

list / elements=string

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

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

bfd – Включить двунаправленное обнаружение пересылки.

nexthop_self – Следующий узел — сам.

split_horizon – Разделенный горизонт.

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

APIC по умолчанию использует [split_horizon, nexthop_self] при отсутствии значения во время создания.

Варианты:

  • "bfd"
  • "nexthop_self"
  • "passive"
  • "split_horizon"

delay

integer

Задержка пропускной способности EIGRP, переопределяет задержку, настроенную на интерфейсе.

Это используется для влияния на выбор пути.

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

delay_unit

string

Единицы задержки EIGRP. Широкие метрики могут использовать точность в пикосекундах для задержки.

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

Варианты:

  • "picoseconds"
  • "tens_of_microseconds"

description

aliases: descr

string

Описание политики интерфейса EIGRP.

eigrp

aliases: eigrp_interface, name

string

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

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

hello_interval

integer

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

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

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

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

hold_interval

integer

Период времени в секундах до объявления о том, что соседний узел не работает.

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

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

host

aliases: hostname

string

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

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

name_alias

string

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

output_level

string

Влияет на вывод этого модуля ACI.

normal означает стандартный вывод, включая current dict

info добавляет информационный вывод, включая previous, proposed и sent dicts

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.

private_key

aliases: cert_key

string

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

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

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

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

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

Имя существующего арендатора (Tenant).

timeout

integer

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

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

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

use_proxy

boolean

Если false, прокси использоваться не будет, даже если он определен в переменной окружения на целевых хостах.

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

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

Варианты:

  • false
  • true

use_ssl

boolean

Если false, будет использоваться HTTP-соединение вместо соединения HTTPS по умолчанию.

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

Примечания

Примечание

  • Используемый tenant должен существовать до использования этого модуля в вашем playbook.
  • Для этого можно использовать модуль cisco.aci.aci_tenant.

См. также

См. также

cisco.aci.aci_tenant

Управление клиентами (fv:Tenant).

APIC Management Information Model reference

Дополнительная информация о внутреннем классе APIC eigrp:IfPol.

Руководство по Cisco ACI

Подробная информация о том, как управлять вашей инфраструктурой ACI с помощью Ansible.

Разработка модулей Cisco ACI

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

Примеры

- name: Create an EIGRP interface policy
  cisco.aci.aci_interface_policy_eigrp:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    eigrp: eigrp1
    bandwidth: 10000
    control_state: [split-horizon, nh-self]
    delay: 10
    delay_unit: tens_of_micro
    hello_interval: 5
    hold_interval: 15
    state: present
  delegate_to: localhost

- name: Delete EIGRRP interface policy
  cisco.aci.aci_interface_policy_eigrp:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    eigrp: eigrp1
    state: present
  delegate_to: localhost

- name: Query an EIGRRP interface policy
  cisco.aci.aci_interface_policy_eigrp:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    eigrp: eigrp1
    state: query
  delegate_to: localhost
  register: query_result

- name: Query all EIGRP interface policies in tenant production
  cisco.aci.aci_interface_policy_eigrp:
    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-адрес для запроса к APIC

Возвращаемое значение: ошибка или отладка

Пример: "https://10.11.12.13/api/mo/uni/tn-production.json"

Авторы

  • Gaspard Micol (@gmicol)
  • Lukas Holub (@lukasholub)

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

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

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

Spec-Zone.ru

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