Модуль netapp.ontap.na_ontap_snmp — пользователь SNMP NetApp ONTAP

Примечание

Этот модуль входит в коллекцию netapp.ontap (версия 23.5.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install netapp.ontap. Для использования этого модуля необходимы дополнительные требования; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: netapp.ontap.na_ontap_snmp.

Добавлено в netapp.ontap 2.6.0

Краткое описание
Требования
Параметры
Примечания
Примеры

Краткое описание

Создание или удаление пользователя SNMP.

Требования

Следующие требования должны быть выполнены на узле, на котором запускается этот модуль.

Ansible 2.9 или более поздней версии — рекомендуется версия 2.12 или более поздняя.
Python3 — рекомендуется версия 3.9 или более поздняя.
netapp-lib требуется только при использовании ZAPI (установка командой ‘pip install netapp-lib’). Обратите внимание: netapp-lib устарела и больше не поддерживается. Используйте её на свой страх и риск.
Физическая или виртуальная кластерная система Data ONTAP; модули поддерживают Data ONTAP 9.1 и более поздние версии, для поддержки REST требуется ONTAP 9.6 или более поздняя версия.

Параметры

Параметр	Комментарии
access_control строка	Управление доступом для сообщества. Поддерживается только значение ‘ro’ (только чтение). Игнорируется при использовании REST. Возможные значения: `"ro"` ← (по умолчанию)
authentication_method строка добавлено в netapp.ontap 22.8.0	Метод аутентификации для пользователя SNMP. Поддерживается только REST. Значение по умолчанию — community. Возможные значения: `"community"` `"usm"` `"both"`
cert_filepath строка добавлено в netapp.ontap 20.6.0	Путь к файлу сертификата клиента SSL (.pem). Не поддерживается в Python 2.6.
feature_flags словарь добавлено в netapp.ontap 20.5.0	Включение или отключение новой функции. Этот параметр можно использовать для включения экспериментальной функции или отключения новой функции, нарушающей обратную совместимость. Поддерживаемые ключи и значения могут изменяться без предварительного уведомления. Неизвестные ключи игнорируются.
force_ontap_version строка добавлено в netapp.ontap 21.23.0	Переопределение версии ONTAP кластера при использовании REST. Поведение не определено, если версия не соответствует целевому кластеру. Этот параметр предусмотрен в качестве обходного решения на случай, когда версию кластера не удаётся прочитать из-за проблем с разрешениями. См. https://github.com/ansible-collections/netapp.ontap/wiki/Known-issues. Укажите версию в формате 9.10 или 9.10.1, где каждый компонент является целым числом. Если для `use_rest` задано значение auto, это может привести к переключению на ZAPI в зависимости от версии и возможностей платформы. Игнорируется при использовании ZAPI.
hostname строка / обязательный	Имя хоста или IP-адрес экземпляра ONTAP.
http_port целое число	Переопределение порта по умолчанию (80 или 443) этим портом.
https логический	Включение и отключение HTTPS. Игнорируется при использовании REST, поскольку поддерживается только HTTPS. Игнорируется при использовании аутентификации по SSL-сертификату, так как для неё требуется SSL. Возможные значения: `false` ← (по умолчанию) `true`
key_filepath строка добавлено в netapp.ontap 20.6.0	Путь к файлу ключа клиента SSL.
ontapi целое число	Версия API ONTAP, которую следует использовать.
password псевдонимы: pass строка	Пароль указанного пользователя.
snmp_username строка / обязательный добавлено в netapp.ontap 22.8.0	Имя пользователя SNMP, которым нужно управлять.
snmpv3 словарь добавлено в netapp.ontap 22.8.0	Указывайте только в том случае, если `authentication_method` имеет значение `usm` или `both`. Этот параметр задаёт учётные данные SNMPv3 для пользователя SNMPv3, также называемого пользователем USM. Поддерживается только REST.
authentication_password строка / обязательный	Пароль протокола аутентификации.
authentication_protocol строка	Протокол аутентификации для SNMPv3. Возможные значения: `"none"` ← (по умолчанию) `"md5"` `"sha"` `"sha2_256"`
privacy_password строка / обязательный	Пароль протокола конфиденциальности.
privacy_protocol строка	Протокол конфиденциальности для SNMPv3. Возможные значения: `"none"` ← (по умолчанию) `"des"` `"aes128"`
state строка	Указывает, должен ли указанный пользователь SNMP существовать. Возможные значения: `"present"` ← (по умолчанию) `"absent"`
use_lambda логический добавлено в netapp.ontap 23.2.0	Указывает, следует ли использовать функцию прокси AWS Lambda для подключения к системе ONTAP. Поддерживается только REST. Возможные значения: `false` ← (по умолчанию) `true`
use_rest строка	Указывает, использовать REST или ZAPI. always — всегда использовать REST API, если модуль его поддерживает. Если модуль не поддерживает REST, выдаётся предупреждение. Если параметр модуля не поддерживается в REST, выдаётся ошибка. never — всегда использовать ZAPI, если модуль его поддерживает. Если параметр REST не поддерживается в ZAPI, может быть выдана ошибка. auto — пытаться использовать REST API, если модуль поддерживает REST и параметры модуля доступны. В противном случае переключаться на ZAPI. По умолчанию: `"always"`
username псевдонимы: user строка	Это может быть учётная запись уровня кластера или уровня SVM — в зависимости от того, какой API требуется: уровня кластера или уровня SVM. Дополнительную информацию см. в документации: https://docs.netapp.com/us-en/ontap/authentication/create-svm-user-accounts-task.html. Поддерживаются два метода аутентификации: Базовая аутентификация с использованием имени пользователя и пароля. Аутентификация по SSL-сертификату с использованием файла сертификата клиента SSL и, при необходимости, файла закрытого ключа. Для использования сертификата он должен быть установлен в кластере ONTAP, а аутентификация по сертификату должна быть включена.
validate_certs логический	Если задано значение `no`, сертификаты SSL проверяться не будут. Задавайте значение `False` только на контролируемых вами ресурсах, где используются самоподписанные сертификаты. Возможные значения: `false` `true` ← (по умолчанию)

Примечания

Примечание

Модули с префиксом na_ontap предназначены для поддержки платформы хранения ONTAP.
HTTPS включён по умолчанию, и его использование рекомендуется. Чтобы включить HTTP в кластере, выполните следующие команды: ‘set -privilege advanced;’ ‘system services web modify -http-enabled true;’

Примеры

- name: Create SNMP community (ZAPI only)
  netapp.ontap.na_ontap_snmp:
    state: present
    snmp_username: communityName
    access_control: 'ro'
    use_rest: never
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"

- name: Create SNMP community (snmpv1 or snmpv2) (REST only)
  netapp.ontap.na_ontap_snmp:
    state: present
    snmp_username: communityName
    use_rest: always
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"

- name: Create SNMP user (snmpv3) (REST only)
  netapp.ontap.na_ontap_snmp:
    state: present
    snmp_username: username
    use_rest: always
    authentication_method: usm
    snmpv3:
      authentication_protocol: sha
      authentication_password: humTdumt*@t0nAwa21
      privacy_protocol: aes128
      privacy_password: p@**GOandCLCt*300
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"

- name: Delete SNMP community (ZAPI only)
  netapp.ontap.na_ontap_snmp:
    state: absent
    snmp_username: communityName
    access_control: 'ro'
    use_rest: never
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"

- name: Delete SNMP community (snmpv1 or snmpv2) (REST only)
  netapp.ontap.na_ontap_snmp:
    state: absent
    snmp_username: communityName
    use_rest: always
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"

- name: Delete SNMP user (snmpv3) (REST only)
  netapp.ontap.na_ontap_snmp:
    state: absent
    snmp_username: username
    use_rest: always
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"

Авторы

Команда NetApp Ansible (@carchi8py)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/netapp/ontap/na_ontap_snmp_module.html