nxos_snmp_location – Управляет информацией о местоположении SNMP.
Новая версия 2.2.
Обзор
- Управляет конфигурацией местоположения SNMP.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| location
- / обязательно
|
Информация о местоположении. |
||
| provider
-
|
Устаревший
Начиная с Ansible 2.5, рекомендуется использовать
connection: network_cli. Этот параметр требуется только при использовании NX-API.
Дополнительная информация находится в руководстве NXOS Platform Options.
Объект типа dict, содержащий данные подключения.
|
||
| auth_pass
-
добавлен в 2.5.3
|
Значение по умолчанию: "none" |
Указывает пароль, необходимый для входа в привилегированный режим на удалённом устройстве. Если authorize ложно, этот аргумент не оказывает влияния. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTH_PASS. |
|
| authorize
boolean
добавлен в 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" |
Настраивает транспортное соединение для подключения к удалённому устройству. Аргумент transport поддерживает подключение к устройству по cli (ssh) или nxapi. |
|
| use_proxy
boolean
добавлен в 2.5
|
|
Если no, переменные окружения http_proxy и https_proxy будут проигнорированы. |
|
| use_ssl
boolean
|
|
Настраивает transport для использования SSL, если значение true, только при transport=nxapi, в противном случае это значение игнорируется. |
|
| username
-
|
Настраивает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации входа в CLI или аутентификации nxapi в зависимости от используемого транспорта. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_USERNAME. |
||
| validate_certs
boolean
|
|
Если no, сертификаты SSL не будут проверены. Это следует использовать только на контролируемых сайтах с самоподписанными сертификатами. Если аргумент transport не nxapi, это значение игнорируется. |
|
| state
-
|
|
Управляет состоянием ресурса. |
|
Примечания
Примечание
- Тестировано на NXOSv 7.3.(0)D1(1) на VIRL
- Информация об использовании CLI и NX-API находится в руководстве NXOS Platform Options
- Дополнительная информация об использовании Ansible для управления сетевыми устройствами находится в руководстве Ansible Network Guide
- Дополнительная информация об использовании Ansible для управления устройствами Cisco находится на странице интеграции Cisco.
Примеры
# ensure snmp location is configured
- nxos_snmp_location:
location: Test
state: present
# ensure snmp location is not configured
- nxos_snmp_location:
location: Test
state: absent
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращённое значение | Описание |
|---|---|---|
| commands
список
|
всегда | команды, отправленные устройству
Пример:
['snmp-server location New_Test'] |
Статус
- Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
- Этот модуль поддерживается командой Ansible Network Team. [сеть]
Поддержка Red Hat
Дополнительная информация о поддержке Red Hat этого модуля доступна в этой статье из базы знаний Red Hat Red Hat Knowledge Base article.
Авторы
- Jason Edelman (@jedelman8)
- 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.7/modules/nxos_snmp_location_module.html
