nxos_snmp_contact - Управление информацией о контакте SNMP.
Новое в версии 2.2.
Описание
- Управление информацией о контакте SNMP.
Параметры
| параметр | обязателен | значение по умолчанию | значения | комментарии |
|---|---|---|---|---|
| auth_pass (добавлено в 2.4.4)
| нет | нет | Указывает пароль, необходимый для входа в привилегированный режим на удалённом устройстве. Если authorize равно false, этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTH_PASS. | |
| authorize (добавлено в 2.4.4)
| нет |
| Инструктирует модуль войти в привилегированный режим на удалённом устройстве перед отправкой каких-либо команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTHORIZE. | |
| contact | да | Информация о контакте. | ||
| host | да | Указывает имя хоста DNS или адрес для подключения к удалённому устройству через указанный транспорт. Значение host используется в качестве адреса назначения для транспорта. | ||
| password | нет | Указывает пароль для аутентификации подключения к удалённому устройству. Этот аргумент обычно используется для транспортов cli или nxapi. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_PASSWORD. | ||
| port | нет | 0 (использовать стандартный порт) | Указывает порт, используемый при подключении к удалённому устройству. Это значение относится к транспорту cli или nxapi. Значение порта по умолчанию соответствует стандартному порту транспорта, если не указано другое в задаче. (cli=22, http=80, https=443). | |
| provider | нет | Удобный метод, позволяющий передавать все аргументы nxos в виде объекта dict. Все ограничения (обязательность, допустимые значения и т. д.) должны быть соблюдены либо отдельными аргументами, либо значениями в этом словаре. | ||
| 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. | |
| use_ssl | нет |
| Настраивает транспорт transport для использования SSL, если значение равно true только в случае transport=nxapi, в противном случае это значение игнорируется. | |
| username | нет | Настраивает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации входа в CLI или аутентификации nxapi в зависимости от используемого транспорта. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_USERNAME. | ||
| validate_certs | нет |
| Если no, сертификаты SSL не будут проверены. Это следует использовать только на контролируемых локально сайтах, использующих самозаверяющие сертификаты. Если аргумент transport не nxapi, это значение игнорируется. |
Примеры
# ensure snmp contact is configured
- nxos_snmp_contact:
contact: Test
state: present
Возвращаемые значения
Общие возвращаемые значения описаны здесь Возвращаемые значения, следующие поля уникальны для данного модуля:
| имя | описание | возвращается | тип | пример |
|---|---|---|---|---|
| commands | команды, отправленные устройству | всегда | список | ['snmp-server contact New_Test'] |
Примечания
Примечание
- Проверено на 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_contact_module.html
