nxos_udld - Управляет параметрами глобальной конфигурации UDLD.
Новая версия 2.2.
Описание
- Управляет параметрами глобальной конфигурации UDLD.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| aggressive |
| Включает или отключает агрессивный режим. | |
| msg_time | Время сообщения в секундах для пакетов UDLD или ключевое слово 'default'. | ||
| provider | Устарело Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli. Этот параметр нужен только при использовании NX-API. Дополнительную информацию см. в руководстве NXOS Platform Options. Объект словаря, содержащий данные подключения. | ||
| host обязательно | Указывает имя хоста DNS или адрес для подключения к удаленному устройству через указанный транспорт. Значение host используется в качестве адреса назначения для транспорта. | ||
| port | Значение по умолчанию: "0 (использовать общий порт)" | Указывает порт для использования при создании подключения к удаленному устройству. Это значение относится к cli или nxapi. Значение порта по умолчанию соответствует общему порту транспорта, если он не указан в задаче. (cli=22, http=80, https=443). | |
| username | Настраивает имя пользователя для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации входа в CLI или аутентификации nxapi в зависимости от используемого транспорта. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_USERNAME. | ||
| password | Указывает пароль для аутентификации подключения к удаленному устройству. Это общий аргумент, используемый для cli или nxapi транспортов. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_PASSWORD. | ||
| authorize bool (добавлен в 2.5.3) |
| Указывает модулю войти в привилегированный режим на удаленном устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTHORIZE. | |
| auth_pass (добавлен в 2.5.3) | Значение по умолчанию: "none" | Указывает пароль для входа в привилегированный режим на удаленном устройстве, если это необходимо. Если authorize ложь, этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTH_PASS. | |
| timeout (добавлен в 2.3) | Значение по умолчанию: 10 | Указывает таймаут в секундах для связи с сетевым устройством для подключения или отправки команд. Если таймаут превышен до завершения операции, модуль вернет ошибку. NX-API может медленно реагировать на длительные команды (sh mac, sh bgp и т. д.). | |
| ssh_keyfile | Указывает SSH-ключ для аутентификации подключения к удаленному устройству. Этот аргумент используется только для транспорта cli. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_SSH_KEYFILE. | ||
| transport обязательно | Значение по умолчанию: "cli" | Настраивает транспортное подключение для подключения к удаленному устройству. Аргумент transport поддерживает подключение к устройству через cli (ssh) или nxapi. | |
| use_ssl bool |
| Настраивает transport для использования SSL, если установлено значение true только в случае transport=nxapi, в противном случае это значение игнорируется. | |
| validate_certs bool |
| Если no, сертификаты SSL не будут проверяться. Это следует использовать только на контролируемых сайтах, использующих самозаверенные сертификаты. Если аргумент transport не nxapi, это значение игнорируется. | |
| use_proxy bool (добавлен в 2.5) |
| Если no, переменные среды http_proxy и https_proxy будут проигнорированы. | |
| reset bool |
| Возможность сбросить все порты, остановленные UDLD. Параметр 'state' не может быть 'absent', когда он присутствует. | |
| state |
| Управление состоянием ресурса. При установке в 'absent', aggressive и msg_time устанавливаются в значения по умолчанию. | |
Примечания
Примечание
- Проверено на NXOSv 7.3.(0)D1(1) на VIRL
- Модуль завершится ошибкой, если функция udld не была ранее включена.
- Дополнительную информацию об использовании CLI и NX-API см. в руководстве NXOS Platform Options
- Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в руководстве Ansible Network Guide
- Дополнительную информацию об использовании Ansible для управления устройствами Cisco см. на странице интеграции Cisco Cisco integration page.
Примеры
# 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 dict | всегда | Параметры конфигурации udld после выполнения модуля Пример: {'aggressive': 'enabled', 'msg_time': '40'} |
| existing dict | всегда | Параметры существующей конфигурации udld Пример: {'aggressive': 'disabled', 'msg_time': '15'} |
| proposed dict | всегда | Параметры, переданные в модуль Пример: {'aggressive': 'enabled', 'msg_time': '40'} |
| updates list | всегда | Команды, отправленные на устройство Пример: ['udld message-time 40', 'udld aggressive'] |
Статус
Этот модуль помечен как preview, что означает, что он не гарантирует обратную совместимость.
Техническое обслуживание
Этот модуль помечен как сетевой, что означает, что его поддерживает Ansible Network Team. Подробности см. в разделе Module Maintenance & Support.
Для получения списка других модулей, также поддерживаемых командой Ansible Network Team, см. здесь.
Поддержка
Для получения дополнительной информации о поддержке этого модуля Red Hat, пожалуйста, обратитесь к этой статье базы знаний
Автор
- Jason Edelman (@jedelman8)
Подсказка
Если вы заметите какие-либо проблемы в этом документе, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.6/modules/nxos_udld_module.html
