Spec-Zone.ru › Ansible

Модуль cisco.aci.aci_bfd_multihop_node_policy — Управление политиками узлов BFD Multihop (bfd:MhNodePol)

Примечание

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

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

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

Для использования в книге задач укажите: cisco.aci.aci_bfd_multihop_node_policy.

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

Описание

  • Управление конфигурацией политики узлов BFD Multihop на устройствах Cisco ACI.
  • Доступно только в версии APIC 5.2 или выше.

Параметры

Параметр

Комментарии

admin_state

string

Административное состояние политики многоходового узла BFD

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

Варианты:

  • "enabled"
  • "disabled"

annotation

string

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

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

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

Значение по умолчанию: "orchestrator:ansible"

certificate_name

aliases: cert_name

string

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

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

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

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

description

string

Описание политики многоходового узла BFD

detection_multiplier

integer

Множитель обнаружения политики многоходового узла BFD

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

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

host

aliases: hostname

string

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

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

min_receive_interval

integer

Минимальный интервал приема (Rx) политики многоходового узла BFD

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

Допустимый диапазон: 250-999

min_transmit_interval

integer

Минимальный интервал передачи (Tx) политики многоходового узла BFD

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

Допустимый диапазон: 250-999

name

aliases: bfd_multihop_node_policy

string

Имя политики многоходового узла BFD

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.

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

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 должен существовать перед использованием данного модуля в вашем плейбуке. Для этого можно использовать модули cisco.aci.aci_tenant

См. также

См. также

APIC Management Information Model reference

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

cisco.aci.aci_tenant

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

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

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

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

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

Примеры

- name: Add a new  BFD Multihop Node policy
  cisco.aci.aci_bfd_multihop_node_policy:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: ansible_tenant
    name: ansible_bfd_multihop_node_policy
    description: Ansible BFD Multihop Node Policy
    state: present
  delegate_to: localhost

- name: Remove a BFD Multihop Node policy
  cisco.aci.aci_bfd_multihop_node_policy:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: ansible_tenant
    name: ansible_bfd_multihop_node_policy
    state: absent
  delegate_to: localhost

- name: Query a BFD Multihop Node policy
  cisco.aci.aci_bfd_multihop_node_policy:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: ansible_tenant
    name: my_dhcp_relay
    state: query
  delegate_to: localhost
  register: query_result

- name: Query all BFD Multihop Node policies in a specific tenant
  cisco.aci.aci_bfd_multihop_node_policy:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: ansible_tenant
    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 \"/></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_bfd_multihop_node_policy_module.html

Spec-Zone.ru

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