nxos_snmp_host — Управление конфигурацией хоста SNMP.
Новая версия 2.2.
Описание
- Управление параметрами конфигурации хоста SNMP.
Параметры
| параметр | обязательный | значение по умолчанию | значения | комментарии |
|---|---|---|---|---|
| auth_pass (добавлен в 2.4.4)
| нет | отсутствует | Указывает пароль для входа в привилегированный режим на удалённом устройстве, если это необходимо. Если authorize равен false, этот аргумент не используется. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTH_PASS. | |
| authorize (добавлен в 2.4.4)
| нет |
| Указывает модулю войти в привилегированный режим на удалённом устройстве перед отправкой команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTHORIZE. | |
| community | нет | Строка сообщества или имя пользователя v3. | ||
| host | да | Указывает имя хоста DNS или адрес для подключения к удалённому устройству по указанному транспорту. Значение параметра host используется в качестве адреса назначения для транспорта. | ||
| password | нет | Указывает пароль для аутентификации подключения к удалённому устройству. Это общий аргумент, используемый для транспортов cli или nxapi. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_PASSWORD. | ||
| port | нет | 0 (использование стандартного порта) | Указывает порт для подключения к удалённому устройству. Это значение относится к транспорту cli или nxapi. Значение порта по умолчанию соответствует общему порту транспорта, если в задаче не указано другое значение. (cli=22, http=80, https=443). | |
| provider | нет | Удобный метод, позволяющий передавать все аргументы nxos в виде объекта словаря. Все ограничения (обязательные, варианты и т. д.) должны быть выполнены либо отдельными аргументами, либо значениями в этом словаре. | ||
| snmp_host | да | IP-адрес или имя хоста целевого узла. | ||
| src_intf | нет | Источник интерфейса. | ||
| ssh_keyfile | нет | Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Этот аргумент используется только для транспорта cli. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_SSH_KEYFILE. | ||
| state | да | present |
| Управление состоянием ресурса. |
| timeout (добавлен в 2.3)
| нет | 10 | Устанавливает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истечёт до завершения операции, модуль вернёт ошибку. NX-API может медленно возвращать результаты при выполнении длительных команд (sh mac, sh bgp и т. д.). | |
| transport | да | cli | Настраивает транспортное соединение для подключения к удалённому устройству. Аргумент transport поддерживает подключение к устройству через cli (ssh) или nxapi. | |
| type | нет | traps |
| Тип сообщения, отправляемого хосту. |
| udp | нет | Номер порта UDP (0-65535). | ||
| use_ssl | нет |
| Настраивает транспорт transport на использование SSL, если значение равно true только когда transport=nxapi, в противном случае это значение игнорируется. | |
| username | нет | Устанавливает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации входа CLI или аутентификации nxapi в зависимости от используемого транспорта. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_USERNAME. | ||
| validate_certs | нет |
| Если no, сертификаты SSL не будут проверены. Это следует использовать только на сайтах, контролируемых лично, с использованием самозаверенных сертификатов. Если аргумент transport не равен nxapi, это значение игнорируется. | |
| version | нет | v2c |
| Версия SNMP. |
| vrf | нет | VRF для отправки трафика в источник. | ||
| vrf_filter | нет | Имя VRF для фильтрации. |
Примеры
# ensure snmp host is configured
- nxos_snmp_host:
snmp_host: 3.3.3.3
community: TESTING
state: present
Возвращаемые значения
Общие возвращаемые значения описаны здесь Возвращаемые значения, следующие поля уникальны для этого модуля:
| название | описание | возвращаемое | тип | пример |
|---|---|---|---|---|
| commands | команды, отправленные на устройство | всегда | список | ['snmp-server host 3.3.3.3 filter-vrf another_test_vrf'] |
Примечания
Примечание
- Тестировалось с NXOSv 7.3.(0)D1(1) на VIRL
-
state=absentудаляет конфигурацию хоста, если она настроена.
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантированно будет обратной совместимостью.
Информация о поддержке
Дополнительную информацию о поддержке этого модуля компанией 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_snmp_host_module.html
