nxos_snmp_contact – Управление информацией о контактах SNMP.
Новая в версии 2.2.
Обзор
- Управление информацией о контактах SNMP.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| contact - / обязательно | Информация о контакте. | ||
| provider - | Устаревший Начиная с Ansible 2.5 рекомендуется использовать connection: network_cli. Этот параметр требуется только при использовании NX-API. Для получения дополнительной информации см. руководство NXOS Platform Options. Объект словаря, содержащий данные соединения. | ||
| auth_pass - добавлен в 2.5.3 | Значение по умолчанию: "none" | Указывает пароль для входа в привилегированный режим на удаленном устройстве. Если authorize равен false, этот параметр не используется. Если значение не указано в задаче, используется значение переменной среды 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 не будут проверены. Это следует использовать только на контролируемых лично сайтах, использующих самозаверяющие сертификаты. Если транспортный аргумент не nxapi, это значение игнорируется. | |
| state - / обязательно |
| Управление состоянием ресурса. | |
Примечания
Примечание
- Проверено на NXOSv 7.3.(0)D1(1) на VIRL
-
state=absentудаляет конфигурацию контакта, если она настроена. - Дополнительную информацию об использовании CLI и NX-API см. в руководстве NXOS Platform Options
- Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в руководстве Ansible Network Guide
- Дополнительную информацию об использовании Ansible для управления устройствами Cisco см. на странице интеграции Cisco.
Примеры
# ensure snmp contact is configured
- nxos_snmp_contact:
contact: Test
state: present
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие являются полями, уникальными для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| commands список | всегда | Команды, отправленные устройству Пример: ['snmp-server contact New_Test'] |
Статус
- Гарантируется, что интерфейс этого модуля не будет совместим с предыдущими версиями. [превью]
- Этот модуль поддерживается командой Ansible Network. [сетевое]
Поддержка Red Hat
Дополнительная информация о поддержке Red Hat этого модуля доступна в этой статье базы знаний 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.7/modules/nxos_snmp_contact_module.html