Spec-Zone.ru › Ansible 2.4

nxos_udld — Управление параметрами глобальной конфигурации UDLD.

Новая версия 2.2.

  • Обзор
  • Параметры
  • Примеры
  • Возвращаемые значения
  • Примечания
    • Статус
    • Информация о техническом обслуживании

Обзор

  • Управление параметрами глобальной конфигурации UDLD.

Параметры

Параметр Обязательный Значение по умолчанию Допустимые значения Комментарии
aggressive
нет
  • enabled
  • disabled
Включает/выключает агрессивный режим.
auth_pass
(добавлено в 2.4.4)
нет none
Указывает пароль для входа в привилегированный режим на удаленном устройстве, если это требуется. Если authorize равно false, этот аргумент не имеет значения. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTH_PASS.
authorize
(добавлено в 2.4.4)
нет
  • yes
  • no
Указывает модулю войти в привилегированный режим на удаленном устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTHORIZE.
host
да
Указывает имя хоста DNS или адрес для подключения к удаленному устройству через указанный транспорт. Значение host используется в качестве адреса назначения для транспорта.
msg_time
нет
Время сообщения в секундах для пакетов UDLD.
password
нет
Указывает пароль для аутентификации подключения к удаленному устройству. Это общий аргумент, используемый для транспортов cli или nxapi. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_PASSWORD.
port
нет 0 (использовать стандартный порт)
Указывает порт для подключения к удаленному устройству. Это значение относится к cli или nxapi. Значение порта по умолчанию соответствует стандартному порту соответствующего транспорта, если в задаче не указано другое значение (cli=22, http=80, https=443).
provider
нет
Удобный метод, позволяющий передавать все аргументы nxos в виде объекта dict. Все ограничения (обязательность, допустимые значения и т.д.) должны быть удовлетворены либо отдельными аргументами, либо значениями в этом dict.
reset
нет
  • true
  • false
Возможность сброса вниз интерфейсов UDLD.
ssh_keyfile
нет
Указывает SSH-ключ для аутентификации подключения к удаленному устройству. Этот аргумент используется только для транспорта cli. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_SSH_KEYFILE.
state
нет present
  • present
  • absent
Управление состоянием ресурса.
timeout
(добавлено в 2.3)
нет 10
Указывает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истечет до завершения операции, модуль выдаст ошибку. NX-API может медленно отвечать на длительные команды (sh mac, sh bgp и т.д.).
transport
да cli
Настраивает транспортное подключение для соединения с удаленным устройством. Аргумент transport поддерживает подключение к устройству через cli (ssh) или nxapi.
use_ssl
нет
  • yes
  • no
Настраивает transport для использования SSL, если значение true, только если transport=nxapi, в противном случае это значение игнорируется.
username
нет
Настраивает имя пользователя для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации входа в CLI или аутентификации nxapi в зависимости от используемого транспорта. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_USERNAME.
validate_certs
нет
  • yes
  • no
Если no, сертификаты SSL не будут проверяться. Это следует использовать только на сайтах, контролируемых лично, с использованием самозаверяемых сертификатов. Если аргумент transport не равен nxapi, это значение игнорируется.

Примеры

# ensure udld aggressive mode is globally disabled and se global message interval is 20
- nxos_udld:
    aggressive: disabled
    msg_time: 20
    host: "{{ inventory_hostname }}"
    username: "{{ un }}"
    password: "{{ pwd }}"

# Ensure agg mode is globally enabled and msg time is 15
- nxos_udld:
    aggressive: enabled
    msg_time: 15
    host: "{{ inventory_hostname }}"
    username: "{{ un }}"
    password: "{{ pwd }}"

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

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

Имя Описание Возвращается Тип Пример
changed
Проверка, были ли внесены изменения на устройстве
всегда boolean True
end_state
k/v пары конфигурации udld после выполнения модуля
всегда dict {'msg_time': '40', 'aggressive': 'enabled'}
existing
k/v пары существующей конфигурации udld
всегда dict {'msg_time': '15', 'aggressive': 'disabled'}
proposed
k/v пары параметров, переданных в модуль
всегда dict {'msg_time': '40', 'aggressive': 'enabled'}
updates
команда, отправленная устройству
всегда list ['udld message-time 40', 'udld aggressive']

Примечания

Примечание

  • Тестировалось на NXOSv 7.3.(0)D1(1) на VIRL
  • Когда state=absent, он отменяет существующие настройки msg_time и устанавливает их в значение по умолчанию 15. Лучше всегда использовать state=present.
  • Модуль выдаст ошибку, если функция udld не была ранее включена.

Статус

Этот модуль помечен как preview, что означает, что он не гарантирует обратную совместимость интерфейса.

Информация о техническом обслуживании

Дополнительную информацию о поддержке этого модуля компанией Red Hat см. в knowledge base article<https://access.redhat.com/articles/rhel-top-support-policies>.

Для получения помощи в разработке модулей, если вы заинтересованы, пожалуйста, прочитайте Информацию о сообществе и участии в разработке, Тестирование Ansible и Разработка модулей.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/nxos_udld_module.html

Spec-Zone.ru

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