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

Примечание

Этот модуль является частью коллекции netapp.ontap (версия 22.12.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 или более поздняя версия.
При использовании ZAPI, netapp-lib 2018.11.13 или более поздняя версия (установка с помощью 'pip install netapp-lib'), настоятельно рекомендуется использовать netapp-lib 2020.3.12, поскольку она обеспечивает лучшие сообщения об ошибках при подключении.
физическая или виртуальная кластеризованная система 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_rest string	Использовать REST или ZAPI. always – всегда будет использовать REST API, если модуль его поддерживает. Выдается предупреждение, если модуль не поддерживает REST. Выдается ошибка, если опция модуля не поддерживается в REST. never – всегда будет использовать ZAPI, если модуль его поддерживает. Может быть выдана ошибка, если опция REST не поддерживается в ZAPI. auto – попробует использовать REST API, если модуль его поддерживает, и опции модулей поддерживаются. В противном случае переходит к ZAPI. По умолчанию: `"auto"`
username aliases: user string	Это может быть учетная запись уровня кластера или SVM, в зависимости от того, требуется ли API уровня кластера или SVM. Дополнительную информацию можно найти в документации https://mysupport.netapp.com/NOW/download/software/nmsdk/9.4/. Поддерживаются два метода аутентификации базовая аутентификация с использованием имени пользователя и пароля, аутентификация с помощью сертификата SSL с использованием файла сертификата клиента ssl и, необязательно, файла закрытого ключа. Для использования сертификата он должен быть установлен в кластере ONTAP, и должна быть включена аутентификация по сертификатам.
validate_certs boolean	Если установлено значение `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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/netapp/ontap/na_ontap_snmp_module.html