Spec-Zone.ru › Ansible 2.8

nxos_vtp_domain – Управляет конфигурацией домена VTP

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

  • Обзор
  • Параметры
  • Примечания
  • Примеры
  • Значения возврата
  • Статус

Обзор

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

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
domain
- / обязательно
Имя домена VTP.
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
строка / обязательно
    Варианты:
  • 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 не будут проверяться. Это следует использовать только на контролируемых сайтах, использующих самозаверяемые сертификаты. Если транспорт не nxapi, это значение игнорируется.

Примечания

Примечание

  • Проверено на NXOSv 7.3.(0)D1(1) на VIRL
  • Функция VTP должна быть активна на устройстве, чтобы использовать этот модуль.
  • Этот модуль используется только для управления именами домена VTP.
  • Имена домена VTP чувствительны к регистру.
  • Если ранее никогда не настраивался, версия VTP по умолчанию устанавливается в 1. В противном случае предыдущая настроенная версия остаётся без изменений. Используйте nxos_vtp_version для её изменения.
  • Используйте это в сочетании с nxos_vtp_password и nxos_vtp_version для полного управления операциями VTP.
  • Дополнительная информация об использовании CLI и NX-API приведена в руководстве NXOS Platform Options
  • Дополнительная информация об использовании Ansible для управления сетевыми устройствами приведена в руководстве Ansible Network Guide
  • Дополнительная информация об использовании Ansible для управления устройствами Cisco приведена на странице интеграции Cisco.

Примеры

# ENSURE VTP DOMAIN IS CONFIGURED
- nxos_vtp_domain:
    domain: ntc
    host: "{{ inventory_hostname }}"
    username: "{{ un }}"
    password: "{{ pwd }}"

Значения возврата

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

Ключ Возвращаемое значение Описание
changed
boolean
всегда
проверка, были ли внесены изменения на устройстве

Пример:
True
end_state
словарь
всегда
пара ключ/значение домена vtp после выполнения модуля

Пример:
{'domain': 'ntc', 'version': '2', 'vtp_password': ''}
existing
словарь
всегда
пара ключ/значение существующего домена vtp

Пример:
{'domain': 'testing', 'version': '2', 'vtp_password': ''}
proposed
словарь
всегда
пара ключ/значение параметров, переданных в модуль

Пример:
{'domain': 'ntc'}
updates
список
всегда
команда, отправленная на устройство

Пример:
['vtp domain ntc']


Состояние

  • Этот модуль не гарантирует обратную совместимость. [превью]
  • Этот модуль поддерживается командой Ansible Network Team. [сеть]

Поддержка Red Hat

Дополнительную информацию о поддержке этого модуля Red Hat можно найти в этой статье базы знаний Red Hat.

Авторы

  • Gabriele Gerbino (@GGabriele)

Подсказка

Если вы заметите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.

© 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_vtp_domain_module.html

Spec-Zone.ru

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