Spec-Zone.ru › Ansible 2.4

nxos_vtp_password - Управление конфигурацией пароля VTP.

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

  • Описание
  • Параметры
  • Примеры
  • Возвращаемые значения
  • Примечания
    • Статус
    • Информация о техническом обслуживании

Описание

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

Параметры

параметр обязательно по умолчанию выбор комментарии
auth_pass
(добавлено в 2.4.4)
нет нет
Указывает пароль, который используется при необходимости входа в привилегированный режим на удалённом устройстве. Если authorize ложно, то этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTH_PASS.
authorize
(добавлено в 2.4.4)
нет
  • да
  • нет
Указывает модулю войти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTHORIZE.
host
да
Указывает имя хоста DNS или адрес для подключения к удалённому устройству по указанному протоколу. Значение host используется в качестве адреса назначения для протокола.
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
  • present
  • absent
Управление состоянием ресурса
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, это значение игнорируется.
vtp_password
нет
Пароль VTP

Примеры

# ENSURE VTP PASSWORD IS SET
- nxos_vtp_password:
    password: ntc
    state: present
    host: "{{ inventory_hostname }}"
    username: "{{ un }}"
    password: "{{ pwd }}"

# ENSURE VTP PASSWORD IS REMOVED
- nxos_vtp_password:
    password: ntc
    state: absent
    host: "{{ inventory_hostname }}"
    username: "{{ un }}"
    password: "{{ pwd }}"

Возвращаемые значения

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

имя описание возвращается тип пример
changed
проверка, были ли внесены изменения на устройстве
всегда булево True
end_state
k/v пары vtp после выполнения модуля
всегда словарь {'domain': 'ntc', 'version': '1', 'vtp_password': 'new_ntc'}
existing
k/v пары существующего vtp
всегда словарь {'domain': 'ntc', 'version': '1', 'vtp_password': 'ntc'}
proposed
k/v пары параметров, переданных в модуль
всегда словарь {'vtp_password': 'new_ntc'}
updates
команда, отправленная устройству
всегда список ['vtp password new_ntc']

Примечания

Примечание

  • Тестировалось с NXOSv 7.3.(0)D1(1) на VIRL
  • Функция VTP должна быть активна на устройстве для использования этого модуля.
  • Этот модуль используется только для управления паролями VTP.
  • Используйте его в сочетании с nxos_vtp_domain и nxos_vtp_version для полного управления операциями VTP.
  • Можно установить/удалить пароль только если домен VTP уже существует.
  • Если state=absent и не указан vtp_password, удаляется текущий пароль VTP.
  • Если state=absent и vtp_password указаны, предложенный vtp_password должен совпадать с существующим, чтобы его можно было удалить.

Статус

Этот модуль помечен как превью, что означает, что его интерфейс не гарантируется как обратная совместимость.

Информация о техническом обслуживании

Для получения дополнительной информации об этой поддержке 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_vtp_password_module.html

Spec-Zone.ru

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