nxos_snmp_user – Управляет пользователями SNMP для мониторинга
Новая версия 2.2.
Описание
- Управляет конфигурацией пользователей SNMP.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| authentication - |
| Параметры аутентификации для пользователя. | |
| encrypt boolean |
| Включает шифрование AES-128-бит при использовании пароля конфиденциальности. | |
| group - | Группа, к которой будет принадлежать пользователь. Если состояние = присутствует, и пользователь существует, группа добавляется к пользователю. Если пользователь не существует, запись пользователя создается с этим аргументом группы. Если состояние = отсутствует, только группа удаляется из записи пользователя. Однако для обеспечения обратной совместимости, если существующий пользователь принадлежит только одной группе, и если аргумент группы совпадает с группой существующего пользователя, то запись пользователя также удаляется. | ||
| privacy - | Пароль конфиденциальности для пользователя. Он не идемпотентен | ||
| provider dictionary | Устарело Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli. Этот параметр требуется только при использовании NX-API. Для получения дополнительной информации см. руководство NXOS Platform Options. Объект словаря, содержащий данные подключения. | ||
| auth_pass string добавлено в 2.5.3 | Указывает пароль, который необходимо использовать для входа в привилегированный режим на удаленном устройстве. Если authorize имеет значение false, то этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTH_PASS. | ||
| authorize boolean добавлено в 2.5.3 |
| Инструктирует модуль войти в привилегированный режим на удаленном устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTHORIZE. | |
| host string / обязательно | Указывает имя хоста DNS или адрес для подключения к удаленному устройству через указанный транспорт. Значение host используется в качестве адреса назначения для транспорта. | ||
| password string | Указывает пароль для аутентификации подключения к удаленному устройству. Этот аргумент обычно используется для транспортов cli или nxapi. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_PASSWORD. | ||
| port integer | Значение по умолчанию: "0 (использовать стандартный порт)" | Указывает порт для использования при построении подключения к удаленному устройству. Это значение относится как к cli, так и к nxapi. Значение порта будет по умолчанию соответствовать стандартному порту транспорта, если в задаче не указано другое. (cli=22, http=80, https=443). | |
| ssh_keyfile string | Указывает SSH-ключ для аутентификации подключения к удаленному устройству. Этот аргумент используется только для транспорта cli. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_SSH_KEYFILE. | ||
| timeout integer добавлено в 2.3 | Значение по умолчанию: 10 | Указывает тайм-аут в секундах для связи с сетевым устройством для подключения или отправки команд. Если тайм-аут истекает до завершения операции, модуль вернёт ошибку. NX-API может медленно отвечать на длительные команды (sh mac, sh bgp и т. д.). | |
| transport string / обязательно |
| Настраивает транспортное подключение для подключения к удаленному устройству. Аргумент transport поддерживает подключение к устройству через cli (ssh) или nxapi. | |
| use_proxy boolean добавлено в 2.5 |
| Если no, переменные среды http_proxy и https_proxy будут проигнорированы. | |
| use_ssl boolean |
| Настраивает transport для использования SSL, если установлено yes только при transport=nxapi, в противном случае это значение игнорируется. | |
| username string | Настраивает имя пользователя для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации входа в CLI или аутентификации nxapi в зависимости от используемого транспорта. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_USERNAME. | ||
| validate_certs boolean |
| Если no, сертификаты SSL не будут проверены. Это следует использовать только на сайтах, контролируемых лично, использующих самозаверенные сертификаты. Если аргумент transport не nxapi, это значение игнорируется. | |
| pwd - | Пароль аутентификации при использовании md5 или sha. Он не идемпотентен | ||
| state - |
| Управление состоянием ресурса. | |
| user - / обязательно | Имя пользователя. | ||
Примечания
Примечание
- Проверено на NXOSv 7.3.(0)D1(1) на VIRL
- Параметры аутентификации не идемпотентны.
- Информация об использовании CLI и NX-API см. в руководстве NXOS Platform Options
- Дополнительная информация об использовании Ansible для управления сетевыми устройствами см. в руководстве Ansible Network Guide
- Дополнительная информация об использовании Ansible для управления устройствами Cisco см. на странице интеграции Cisco.
Примеры
- nxos_snmp_user:
user: ntc
group: network-operator
authentication: md5
pwd: test_password
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| commands list | всегда | Команды, отправленные устройству Пример: ['snmp-server user ntc network-operator auth md5 test_password'] |
Статус
- Этот модуль не гарантирует обратной совместимости интерфейса. [preview]
- Этот модуль поддерживается командой Ansible Network. [network]
Поддержка Red Hat
Дополнительную информацию о поддержке этого модуля Red Hat можно найти в этой статье базы знаний Red Hat.
Авторы
- Jason Edelman (@jedelman8)
Подсказка
Если вы обнаружите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/nxos_snmp_user_module.html
