nxos_udld_interface — Управление параметрами конфигурации интерфейса UDLD.
Новая версия 2.2.
Описание
- Управление параметрами конфигурации интерфейса UDLD.
Параметры
| Параметр | Обязательно | По умолчанию | Возможные значения | Комментарии |
|---|---|---|---|---|
| auth_pass (добавлено в 2.4.4) |
нет | нет | Указывает пароль для входа в привилегированный режим на удаленном устройстве, если это необходимо. Если authorize равно false, этот аргумент не используется. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTH_PASS. |
|
| authorize (добавлено в 2.4.4) |
нет |
|
Инструктирует модуль войти в привилегированный режим на удаленном устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTHORIZE. |
|
| host |
да | Указывает имя хоста DNS или адрес для подключения к удаленному устройству по указанному протоколу. Значение host используется в качестве адреса назначения для протокола. |
||
| interface |
да | Полное имя интерфейса, например, Ethernet1/1- |
||
| mode |
да |
|
Управление режимом UDLD для интерфейса. |
|
| password |
нет | Указывает пароль для аутентификации подключения к удаленному устройству. Этот аргумент обычно используется для протоколов cli или nxapi. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_PASSWORD. |
||
| port |
нет | 0 (использовать общий порт) | Указывает порт для подключения к удаленному устройству. Это значение относится к протоколам cli или nxapi. Значение порта по умолчанию соответствует общему порту используемого протокола, если не указано в задаче. (cli=22, http=80, https=443). |
|
| provider |
нет | Удобный метод, который позволяет передавать все аргументы nxos как объект словаря. Все ограничения (обязательные, допустимые значения и т. д.) должны быть выполнены либо отдельными аргументами, либо значениями в этом словаре. |
||
| ssh_keyfile |
нет | Указывает SSH-ключ для аутентификации подключения к удаленному устройству. Этот аргумент используется только для протокола cli. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_SSH_KEYFILE. |
||
| state |
нет | present |
|
Управление состоянием ресурса. |
| timeout (добавлено в 2.3) |
нет | 10 | Указывает время ожидания в секундах для связи с сетевым устройством при подключении или отправке команд. Если время ожидания истекло до завершения операции, модуль вернет ошибку. NX-API может медленно возвращать данные при длительных операциях (sh mac, sh bgp и т. д.). |
|
| transport |
да | cli | Настройка протокола подключения к удаленному устройству. Аргумент transport поддерживает подключение к устройству через cli (ssh) или nxapi. |
|
| use_ssl |
нет |
|
Настройка transport для использования SSL, если значение равно true только при transport=nxapi, в противном случае это значение игнорируется. |
|
| username |
нет | Настройка имени пользователя для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации входа в CLI или аутентификации nxapi в зависимости от используемого протокола. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_USERNAME. |
||
| validate_certs |
нет |
|
Если no, сертификаты SSL не будут проверяться. Это следует использовать только на контролируемых вами сайтах, использующих самозаверенные сертификаты. Если аргумент transport не равен nxapi, это значение игнорируется. |
Примеры
# ensure Ethernet1/1 is configured to be in aggressive mode
- nxos_udld_interface:
interface: Ethernet1/1
mode: aggressive
state: present
host: "{{ inventory_hostname }}"
username: "{{ un }}"
password: "{{ pwd }}"
# Remove the aggressive config only if it's currently in aggressive mode and then disable udld (switch default)
- nxos_udld_interface:
interface: Ethernet1/1
mode: aggressive
state: absent
host: "{{ inventory_hostname }}"
username: "{{ un }}"
password: "{{ pwd }}"
# ensure Ethernet1/1 has aggressive mode enabled
- nxos_udld_interface:
interface: Ethernet1/1
mode: enabled
host: "{{ inventory_hostname }}"
username: "{{ un }}"
password: "{{ pwd }}"
Возвращаемые значения
Общие возвращаемые значения документированы здесь Возвращаемые значения, следующие поля уникальны для данного модуля:
| Имя | Описание | Возвращается | Тип | Пример |
|---|---|---|---|---|
| changed | проверка, были ли внесены изменения на устройстве |
всегда | boolean | True |
| end_state | параметры конфигурации после выполнения модуля |
всегда | dict | {'mode': 'enabled'} |
| existing | существующие параметры конфигурации |
всегда | dict | {'mode': 'aggressive'} |
| proposed | параметры, переданные в модуль |
всегда | dict | {'mode': 'enabled'} |
| updates | команды, отправленные устройству |
всегда | list | ['interface ethernet1/33', 'no udld aggressive ; no udld disable'] |
Примечания
Примечание
- Тестировалось на NXOSv 7.3.(0)D1(1) на VIRL
- Функция 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_interface_module.html