nxos_udld_interface – Управляет параметрами конфигурации интерфейса UDLD
Новая в версии 2.2.
Обзор
- Управляет параметрами конфигурации интерфейса UDLD.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| interface - / обязательно | Полное имя интерфейса, например, Ethernet1/1- | ||
| mode - / обязательно |
| Управляет режимом UDLD для интерфейса. | |
| provider словарь | Устарело Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli. Этот параметр требуется только при использовании NX-API. Для получения дополнительной информации см. руководство NXOS Platform Options. Объект словаря, содержащий сведения о соединении. | ||
| auth_pass строка добавлено в 2.5.3 | Указывает пароль для входа в привилегированный режим на удалённом устройстве, если это необходимо. Если authorize имеет значение false, этот аргумент ничего не делает. Если значение не указано в задаче, будет использовано значение переменной среды ANSIBLE_NET_AUTH_PASS. | ||
| authorize булево добавлено в 2.5.3 |
| Указывает модулю войти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, будет использовано значение переменной среды ANSIBLE_NET_AUTHORIZE. | |
| host строка / обязательно | Указывает имя хоста DNS или адрес для подключения к удалённому устройству по указанному протоколу. Значение параметра host используется в качестве целевого адреса для протокола. | ||
| password строка | Указывает пароль для аутентификации подключения к удалённому устройству. Этот аргумент обычно используется для протоколов cli или nxapi. Если значение не указано в задаче, будет использовано значение переменной среды ANSIBLE_NET_PASSWORD. | ||
| port целое число | Значение по умолчанию: "0 (использовать общий порт)" | Указывает порт для создания соединения с удалённым устройством. Это значение применяется к протоколам cli или nxapi. Значение порта по умолчанию соответствует общему порту соответствующего протокола, если в задаче не указано другое значение. (cli=22, http=80, https=443). | |
| ssh_keyfile строка | Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Этот аргумент используется только для протокола cli. Если значение не указано в задаче, будет использовано значение переменной среды ANSIBLE_NET_SSH_KEYFILE. | ||
| timeout целое число добавлено в 2.3 | Значение по умолчанию: 10 | Указывает время ожидания в секундах для связи с сетевым устройством при подключении или отправке команд. Если время ожидания истечёт до завершения операции, модуль вернёт ошибку. NX-API может медленно возвращать результаты при выполнении длительных команд (sh mac, sh bgp и т. д.). | |
| transport строка / обязательно |
| Настраивает транспортное соединение для подключения к удалённому устройству. Аргумент transport поддерживает подключение к устройству по протоколам cli (ssh) или nxapi. | |
| use_proxy булево добавлено в 2.5 |
| Если no, переменные среды http_proxy и https_proxy будут игнорироваться. | |
| use_ssl булево |
| Настраивает transport для использования SSL, если значение равно yes только когда transport=nxapi, в противном случае это значение игнорируется. | |
| username строка | Настраивает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации входа по CLI или аутентификации nxapi в зависимости от используемого протокола. Если значение не указано в задаче, будет использовано значение переменной среды ANSIBLE_NET_USERNAME. | ||
| validate_certs булево |
| Если no, сертификаты SSL не будут проверены. Это следует использовать только на сайтах под собственным контролем, использующих самозаверяющие сертификаты. Если аргумент transport не равен nxapi, это значение игнорируется. | |
| state - |
| Управление состоянием ресурса. | |
Примечания
Примечание
- Проверено на NXOSv 7.3.(0)D1(1) на VIRL
- Для использования этого модуля функция UDLD должна быть включена на устройстве.
- Сведения о работе с CLI и NX-API см. в руководстве NXOS Platform Options
- Дополнительную информацию о работе с Ansible для управления сетевыми устройствами см. в руководстве Ansible Network Guide
- Дополнительную информацию о работе с Ansible для управления устройствами Cisco см. на странице интеграции Cisco.
Примеры
# 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 словарь | всегда | пара ключ-значение конфигурации после выполнения модуля Пример: {'mode': 'enabled'} |
| existing словарь | всегда | пара ключ-значение существующей конфигурации Пример: {'mode': 'aggressive'} |
| proposed словарь | всегда | пара ключ-значение параметров, переданных в модуль Пример: {'mode': 'enabled'} |
| updates список | всегда | команда, отправленная на устройство Пример: ['interface ethernet1/33', 'no udld aggressive ; no udld disable'] |
Статус
- Этот модуль не гарантирует обратной совместимости интерфейса. [превью]
- Этот модуль поддерживается командой Ansible Network Team. [сетевое]
Поддержка Red Hat
Дополнительную информацию о поддержке данного модуля Red Hat см. в статье базы знаний 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.8/modules/nxos_udld_interface_module.html
