nxos_snmp_host - Управляет конфигурацией хоста SNMP.
Новая версия 2.2.
Обзор
- Управляет параметрами конфигурации хоста SNMP.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| community | Строка сообщества или имя пользователя v3. | ||
| 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 будут игнорироваться. | |
| snmp_host обязательно | IP-адрес или имя хоста целевого хоста. | ||
| snmp_type |
| Тип сообщения, отправляемого на хост. Если не указано, используется тип trap. | |
| src_intf | Источник интерфейса. Должно быть полное имя интерфейса. Если state = absent, интерфейс удаляется. | ||
| state |
| Управлять состоянием ресурса. Если state = present, хост добавляется в конфигурацию. Если указаны только vrf и/или vrf_filter и/или src_intf, они будут добавлены к существующей конфигурации хоста. Если state = absent, хост удаляется, если указан параметр community. Можно удалить только vrf и/или src_int и/или vrf_filter, указав только эти параметры и не указывая параметр community. | |
| udp | По умолчанию: 162 | Номер UDP-порта (0-65535). | |
| v3 |
| Используйте это значение при версии v3. Уровень безопасности SNMPv3. | |
| version |
| Версия SNMP. Если не указано, используется v1. | |
| vrf | VRF для источника трафика. Если state = absent, vrf удаляется. | ||
| vrf_filter | Имя VRF для фильтрации. Если state = absent, vrf удаляется из фильтра. | ||
Примечания
Примечание
- Тестировалось на NXOSv 7.3.(0)D1(1) на VIRL
-
state=absentудаляет конфигурацию хоста, если она настроена. - Дополнительную информацию об использовании CLI и NX-API см. в руководстве NXOS Platform Options
- Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в руководстве Ansible Network Guide
- Дополнительную информацию об использовании Ansible для управления устройствами Cisco см. на странице интеграции Cisco.
Примеры
# 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'] |
Статус
Этот модуль помечен как preview, что означает, что его интерфейс не гарантируется обратной совместимости.
Техническое обслуживание
Этот модуль помечен как сетевой, что означает, что он поддерживается командой Ansible по сетевым технологиям. Дополнительную информацию см. в разделе Техническое обслуживание и поддержка модулей.
Список других модулей, поддерживаемых командой Ansible по сетевым технологиям, см. здесь.
Поддержка
Для получения дополнительной информации о поддержке этого модуля компанией Red Hat, обратитесь к этой статье базы знаний.
Автор
- 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.6/modules/nxos_snmp_host_module.html
