nxos_vtp_password - Управление конфигурацией пароля VTP.
Новая версия 2.2.
Описание
- Управление конфигурацией пароля VTP.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| provider | Устарело Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli. Этот параметр требуется только при использовании NX-API. Для получения дополнительной информации см. руководство NXOS Platform Options. Объект словаря, содержащий данные подключения. | ||
| host обязательно | Указывает имя хоста DNS или адрес для подключения к удалённому устройству по указанному протоколу. Значение host используется в качестве адреса назначения для протокола. | ||
| port | По умолчанию: "0 (использовать стандартный порт)" | Указывает порт, который необходимо использовать при построении соединения с удалённым устройством. Это значение относится к cli или nxapi. Значение порта по умолчанию соответствует соответствующему общему порту протокола, если он не указан в задаче. (cli=22, http=80, https=443). | |
| username | Устанавливает имя пользователя для проверки подлинности подключения к удалённому устройству. Это значение используется для проверки подлинности входа в CLI или проверки подлинности nxapi в зависимости от используемого протокола. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_USERNAME. | ||
| password | Указывает пароль для проверки подлинности подключения к удалённому устройству. Это общий аргумент, используемый для протоколов cli или nxapi. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_PASSWORD. | ||
| authorize bool (добавлено в 2.5.3) |
| Указывает модулю перейти в привилегированный режим на удалённом устройстве перед отправкой каких-либо команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTHORIZE. | |
| auth_pass (добавлено в 2.5.3) | По умолчанию: "none" | Указывает пароль, который необходимо использовать, если требуется переход в привилегированный режим на удалённом устройстве. Если authorize ложно, этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTH_PASS. | |
| timeout (добавлено в 2.3) | По умолчанию: 10 | Указывает таймаут в секундах для связи с сетевым устройством для подключения или отправки команд. Если таймаут истечёт до завершения операции, модуль выдаст ошибку. NX-API может медленно возвращать результаты при выполнении длительных команд (sh mac, sh bgp и т. д.). | |
| ssh_keyfile | Указывает SSH-ключ для проверки подлинности подключения к удалённому устройству. Этот аргумент используется только для протокола cli. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_SSH_KEYFILE. | ||
| transport обязательно | По умолчанию: "cli" | Настраивает протокол подключения для подключения к удалённому устройству. Аргумент transport поддерживает подключение к устройству через cli (ssh) или nxapi. | |
| use_ssl bool |
| Настраивает transport для использования SSL, если значение установлено в true, только если transport=nxapi, в противном случае это значение игнорируется. | |
| validate_certs bool |
| Если no, сертификаты SSL не будут проверяться. Это следует использовать только на сайтах под собственным контролем, использующих самозаверяющие сертификаты. Если аргумент transport не nxapi, это значение игнорируется. | |
| use_proxy bool (добавлено в 2.5) |
| Если no, переменные окружения http_proxy и https_proxy будут проигнорированы. | |
| state |
| Управление состоянием ресурса | |
| 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 dict | всегда | параметры vtp после выполнения модуля Пример: {'domain': 'ntc', 'version': '1', 'vtp_password': 'new_ntc'} |
| existing dict | всегда | параметры существующего vtp Пример: {'domain': 'ntc', 'version': '1', 'vtp_password': 'ntc'} |
| proposed dict | всегда | параметры, переданные в модуль Пример: {'vtp_password': 'new_ntc'} |
| updates list | всегда | команды, отправленные на устройство Пример: ['vtp password new_ntc'] |
Статус
Этот модуль помечен как предварительный, что означает, что его интерфейс не гарантируется как обратный.
Техническое обслуживание
Этот модуль помечен как сетевой, что означает, что его поддерживает команда Ansible Network. Подробнее см. Техническое обслуживание и поддержка модулей.
Список других модулей, поддерживаемых командой Ansible Network, см. в этом разделе.
Поддержка
Дополнительную информацию о поддержке этого модуля 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.6/modules/nxos_vtp_password_module.html
