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

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

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

Описание

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
provider словарь			Устарело Начиная с Ansible 2.5, рекомендуется использовать `connection: network_cli`. Этот параметр необходим только при использовании NX-API. Для получения дополнительной информации см. руководство NXOS Platform Options. Объект словаря, содержащий сведения о подключении.
	auth_pass строка добавлен в 2.5.3		Указывает пароль для входа в привилегированный режим на удалённом устройстве. Если authorize ложно, то этот аргумент не имеет эффекта. Если значение не указано в задаче, используется значение переменной среды `ANSIBLE_NET_AUTH_PASS`.
	authorize логическое значение добавлен в 2.5.3	Варианты: no ← yes	Указывает модулю войти в привилегированный режим на удалённом устройстве перед отправкой команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной среды `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 yes ←	Если `no`, переменные среды `http_proxy` и `https_proxy` будут проигнорированы.
	use_ssl логическое значение	Варианты: no ← yes	Настраивает транспорт transport для использования SSL, если значение `yes`, только когда `transport=nxapi`, в противном случае это значение игнорируется.
	username строка		Настраивает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации входа в CLI или аутентификации nxapi в зависимости от используемого транспорта. Если значение не указано в задаче, используется значение переменной среды `ANSIBLE_NET_USERNAME`.
	validate_certs логическое значение	Варианты: no yes ←	Если `no`, сертификаты SSL не будут проверены. Это следует использовать только на сайтах под собственным контролем, использующих самозаверяющие сертификаты. Если аргумент transport не nxapi, это значение игнорируется.
state -		Варианты: present ← absent	Управление состоянием ресурса
vtp_password -			Пароль VTP

Примечания

Примечание

Тестировалось с 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 должен соответствовать существующему, чтобы его можно было удалить.
Дополнительную информацию об использовании CLI и NX-API см. в руководстве NXOS Platform Options.
Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в руководстве Ansible Network Guide.
Дополнительную информацию об использовании Ansible для управления устройствами Cisco см. на странице интеграции Cisco.

Примеры

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

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

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

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

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

Состояние

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

Поддержка 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_password_module.html