Spec-Zone.ru › Ansible

cisco.aci.aci_l3out_bfd_multihop_interface_profile модуль – Управление профилями интерфейсов BFD Multihop (bfd:MhIfP)

Примечание

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

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

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

Чтобы использовать его в книге задач, укажите: cisco.aci.aci_l3out_bfd_multihop_interface_profile.

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

Обзор

  • Управление конфигурацией профилей интерфейсов BFD Multihop на Cisco ACI сетях
  • Доступен только в версии APIC 5.2 и выше, и для APIC, не являющихся облачными

Параметры

Параметр

Комментарии

annotation

string

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

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

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

Default: "orchestrator:ansible"

authentication_type

string

Тип аутентификации объекта профиля многоходового интерфейса BFD

APIC устанавливает значение по умолчанию как none.

Choices:

  • "none"
  • "sha1"

bfd_multihop_interface_policy

aliases: multihop_interface_policy, multihop_interface_policy_name

string

Имя политики многоходового интерфейса BFD

certificate_name

aliases: cert_name

string

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

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

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

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

description

aliases: descr

string

Описание объекта профиля многоходового интерфейса BFD

host

aliases: hostname

string

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

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

key

string

Ключ аутентификации объекта профиля многоходового интерфейса BFD.

Предоставление этого параметра всегда приведет к изменению, поскольку это защищенное свойство, которое невозможно получить из APIC.

key_id

integer

Идентификатор ключа аутентификации объекта профиля многоходового интерфейса BFD

APIC устанавливает значение по умолчанию равным 3

Допустимый диапазон 1-255

l3out

aliases: l3out_name

string

Имя существующего L3Out

l3out_logical_interface_profile

aliases: logical_interface_profile, logical_interface_profile_name

string

Имя существующего профиля логического интерфейса L3Out

l3out_logical_node_profile

aliases: logical_node_profile, logical_node_profile_name

string

Имя существующего профиля логического узла L3Out

name

aliases: bfd_multihop_interface_profile

string

Имя объекта профиля многоходового интерфейса BFD

name_alias

string

Псевдоним имени объекта профиля многоходового интерфейса BFD

output_level

string

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

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

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

debug добавляет отладочный вывод, включая информацию filter_string, method, response, status и url

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

Choices:

  • "debug"
  • "info"
  • "normal" ← (default)

output_path

string

Путь к файлу, который будет использоваться для выгрузки сгенерированных модулем объектов конфигурации ACI в формате JSON.

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

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

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

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, c(l3out), l3out_logical_node_profile и l3out_logical_interface_profile. Модули cisco.aci.aci_tenant могут быть использованы для этого.

См. также

См. также

Ссылка на справочник модели управления информацией APIC

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

cisco.aci.aci_tenant

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

cisco.aci.aci_l3out

Управление объектами внешнего уровня 3 (L3Out) (l3ext:Out).

cisco.aci.aci_l3out_logical_node_profile

Управление профилями логических узлов внешнего уровня 3 (L3Out) (l3ext:LNodeP).

cisco.aci.aci_l3out_logical_interface_profile

Управление профилями логических интерфейсов внешнего уровня 3 (L3Out) (l3ext:LIfP).

cisco.aci.aci_interface_policy_bfd_multihop

Управление политиками интерфейсов BFD Multihop (bfd:MhIfPol).

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

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

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

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

Примеры

- name: Add a new L3Out BFD Multihop Interface Profile
  cisco.aci.aci_l3out_bfd_multihop_interface_profile:
    username: admin
    password: SomeSecretPassword
    tenant: ansible_tenant
    l3out: ansible_l3out
    l3out_logical_node_profile: ansible_node_profile
    l3out_logical_interface_profile: ansible_interface_profile
    state: present
  delegate_to: localhost

- name: Query a new L3Out BFD Multihop Interface Profile
  cisco.aci.aci_l3out_bfd_multihop_interface_profile:
    username: admin
    password: SomeSecretPassword
    tenant: ansible_tenant
    l3out: ansible_l3out
    l3out_logical_node_profile: ansible_node_profile
    l3out_logical_interface_profile: ansible_interface_profile
    state: query
  delegate_to: localhost

- name: Query all L3Out BFD Multihop Interface Profile
  cisco.aci.aci_l3out_bfd_multihop_interface_profile:
    username: admin
    password: SomeSecretPassword
    state: query
  delegate_to: localhost

- name: Delete L3Out BFD Multihop Interface Profile
  cisco.aci.aci_l3out_bfd_multihop_interface_profile:
    username: admin
    password: SomeSecretPassword
    tenant: ansible_tenant
    l3out: ansible_l3out
    l3out_logical_node_profile: ansible_node_profile
    l3out_logical_interface_profile: ansible_interface_profile
    state: absent
  delegate_to: localhost

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

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

Ключ

Описание

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 \"/></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"

Авторы

  • Anvitha Jain (@anvjain)

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

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

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

Spec-Zone.ru

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