Spec-Zone.ru › Ansible 2.9

nxos_udld_interface – Управляет параметрами конфигурации интерфейса UDLD

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

Описание

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

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
interface
- / обязательно
Полное имя интерфейса, например Ethernet1/1-
mode
- / обязательно
    Варианты:
  • enabled
  • disabled
  • aggressive
Управляет режимом 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
целое число
Значение по умолчанию:
10
Указывает таймаут в секундах для связи с сетевым устройством для подключения или отправки команд. Если таймаут истечет до завершения операции, модуль выдаст ошибку. NX-API может медленно возвращать данные при выполнении длительных команд (sh mac, sh bgp и т. д.).
transport
строка / обязательно
    Варианты:
  • cli ←
  • nxapi
Настраивает транспортное соединение для подключения к удаленному устройству. Параметр 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
-
    Варианты:
  • present ←
  • absent
Управляет состоянием ресурса.

Примечания

Примечание

  • Проверено на 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.9/modules/nxos_udld_interface_module.html

Spec-Zone.ru

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