Модуль netapp.ontap.na_ontap_user — настройка и управление пользователями NetApp ONTAP

Примечание

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

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

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

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

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

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

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

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

Требования

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

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 или более поздняя версия.

Параметры

Параметр	Комментарии
application_dicts list / elements=dictionary добавлено в netapp.ontap 21.6.0	Список приложений, которым предоставляется доступ. Обеспечивает более гибкое управление приложениями и методами аутентификации. Создание учетной записи для входа с приложениями console, telnet, rsh и service-processor для SVM данных не поддерживается. Модуль поддерживает варианты service-processor и service_processor. Для ZAPI требуется service-processor, а для REST — service_processor, за исключением проблемы в ONTAP 9.6 и 9.7. snmp не поддерживается в REST. Требуется либо `application_dicts`, либо `application_strs`.
application string / обязательный	Название приложения. Варианты: `"console"` `"http"` `"ontapi"` `"rsh"` `"snmp"` `"service_processor"` `"service-processor"` `"sp"` `"ssh"` `"telnet"`
authentication_methods list / elements=string / обязательный	Список методов аутентификации для приложения (см. `authentication_method`). Варианты: `"community"` `"password"` `"publickey"` `"domain"` `"nsswitch"` `"usm"` `"cert"` `"saml"`
second_authentication_method string	При использовании ssh — дополнительный необязательный метод аутентификации для MFA. Варианты: `"none"` `"password"` `"publickey"` `"nsswitch"` `"totp"`
application_strs псевдонимы: application, applications list / elements=string добавлено в netapp.ontap 21.6.0	Список приложений, которым предоставляется доступ. Этот параметр обеспечивает обратную совместимость с существующим параметром `applications`, но имеет ограничения. Рекомендуется использовать новый параметр `application_dicts`, обеспечивающий большую гибкость. Создание учетной записи для входа с приложениями console, telnet, rsh и service-processor для SVM данных не поддерживается. Модуль поддерживает варианты service-processor и service_processor. Для ZAPI требуется service-processor, а для REST — service_processor, за исключением проблемы в ONTAP 9.6 и 9.7. snmp не поддерживается в REST. Требуется либо `application_dicts`, либо `application_strs`. Варианты: `"console"` `"http"` `"ontapi"` `"rsh"` `"snmp"` `"service_processor"` `"service-processor"` `"sp"` `"ssh"` `"telnet"`
authentication_method string	Метод аутентификации для приложения. Если требуется несколько методов, используйте `application_dicts`. Не все методы аутентификации подходят для каждого приложения. Допустимые методы аутентификации для каждого приложения указаны в authentication_choices_description. Password для приложения console. Password, domain, nsswitch, cert, saml для приложения http. Password, domain, nsswitch, cert, saml для приложения ontapi. SAML поддерживается только в REST, но, похоже, также работает с ZAPI. Community для приложения snmp (при создании пользователей SNMPv1 и SNMPv2). Usm и community для приложения snmp (при создании пользователей SNMPv3). Password для приложения sp. Password для приложения rsh. Password для приложения telnet. Password, publickey, domain, nsswitch для приложения ssh. Обязателен, если указан `application_strs`. Варианты: `"community"` `"password"` `"publickey"` `"domain"` `"nsswitch"` `"usm"` `"cert"` `"saml"`
authentication_password string добавлено в netapp.ontap 20.6.0	Пароль для протокола аутентификации. Длина должна составлять не менее 8 символов. Обязателен для протоколов аутентификации ‘md5’, ‘sha’ и ‘sha2-256’ и не требуется для ‘none’. Доступен только для метода аутентификации ‘usm’ и не может быть изменен.
authentication_protocol string добавлено в netapp.ontap 20.6.0	Протокол аутентификации для пользователя snmp. Если режим FIPS кластера включен, единственными допустимыми значениями являются ‘sha’ и ‘sha2-256’. Если режим FIPS кластера выключен, по умолчанию используется значение ‘none’. Если режим FIPS кластера включен, по умолчанию используется значение ‘sha’. Доступен только для метода аутентификации ‘usm’ и не может быть изменен. Варианты: `"none"` `"md5"` `"sha"` `"sha2-256"`
cert_filepath string добавлено в netapp.ontap 20.6.0	Путь к файлу сертификата клиента SSL (.pem). Не поддерживается в Python 2.6.
engine_id string добавлено в netapp.ontap 20.6.0	EngineID авторитетного объекта для пользователя SNMPv3. Значение необходимо указать в виде шестнадцатеричной строки. Идентификатор Engine ID, у которого первый бит первого октета равен 1, должен содержать не менее 5 и не более 32 октетов. Идентификатор Engine ID, у которого первый бит первого октета равен 0, должен иметь длину 12 октетов. Адрес Engine ID не может состоять только из нулей. Доступен только для метода аутентификации ‘usm’ и не может быть изменен.
feature_flags dictionary добавлено в netapp.ontap 20.5.0	Включает или отключает новую функцию. Можно использовать для включения экспериментальной функции или отключения новой функции, нарушающей обратную совместимость. Поддерживаемые ключи и значения могут изменяться без уведомления. Неизвестные ключи игнорируются.
force_ontap_version string добавлено в 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 string / обязательный	Имя хоста или IP-адрес экземпляра ONTAP.
http_port integer	Переопределяет порт по умолчанию (80 или 443).
https boolean	Включает или отключает https. Игнорируется при использовании REST, поскольку поддерживается только https. Игнорируется при использовании аутентификации с сертификатом SSL, так как для нее требуется SSL. Варианты: `false` ← (по умолчанию) `true`
key_filepath string добавлено в netapp.ontap 20.6.0	Путь к файлу ключа клиента SSL.
lock_user boolean	Определяет, заблокирована ли указанная учетная запись пользователя. Варианты: `false` `true`
name string / обязательный	Имя пользователя, которым нужно управлять.
ontapi integer	Версия API ONTAP, которую следует использовать.
password псевдоним: pass string	Пароль указанного пользователя.
privacy_password string добавлено в netapp.ontap 20.6.0	Пароль для протокола конфиденциальности. Длина должна составлять не менее 8 символов. Обязателен для протоколов конфиденциальности ‘des’ и ‘aes128’ и не требуется для ‘none’. Доступен только для метода аутентификации ‘usm’ и не может быть изменен.
privacy_protocol string добавлено в netapp.ontap 20.6.0	Протокол конфиденциальности для пользователя snmp. Если режим FIPS кластера включен, единственным допустимым значением является ‘aes128’. Если режим FIPS кластера выключен, по умолчанию используется значение ‘none’. Если режим FIPS кластера включен, по умолчанию используется значение ‘aes128’. Доступен только для метода аутентификации ‘usm’ и не может быть изменен. Варианты: `"none"` `"des"` `"aes128"`
remote_switch_ipaddress string добавлено в netapp.ontap 20.6.0	Необязательный IP-адрес удаленного коммутатора. Удаленным коммутатором может быть коммутатор кластера, отслеживаемый Cluster Switch Health Monitor (CSHM), или коммутатор Fibre Channel (FC), отслеживаемый Metro Cluster Health Monitor (MCC-HM). Применимо только к удаленному пользователю SNMPv3, то есть если пользователь является удаленным (не локальным), приложение — snmp, а метод аутентификации — usm.
replace_existing_apps_and_methods string добавлено в netapp.ontap 20.6.0	Если пользователь уже существует, при state=present текущие приложения и методы аутентификации заменяются. Если пользователь уже существует, при state=absent текущие приложения и методы аутентификации удаляются. При использовании application_dicts или REST поддерживается только такое поведение. При использовании application_strs и ZAPI такое поведение применяется, если для параметра задано значение always. При использовании application_strs и ZAPI, если для параметра задано значение auto, приложения, не включенные в список, не удаляются. При использовании application_strs и ZAPI, если для параметра задано значение auto, методы аутентификации, не включенные в список, не удаляются. `auto` сохраняет существующее поведение для обратной совместимости, но обратите внимание, что REST и ZAPI работают непоследовательно. Это еще одна причина рекомендовать использовать `application_dicts`. Варианты: `"always"` `"auto"` ← (по умолчанию)
role_name string	Название роли. Обязательно, если `state=present`
set_password string	Пароль учетной записи пользователя. Игнорируется при создании пользователей snmp, но обязателен при создании пользователей, не относящихся к snmp. Для существующего пользователя это значение будет использоваться как новый пароль.
state string	Должен ли указанный пользователь существовать. Варианты: `"present"` ← (по умолчанию) `"absent"`
use_lambda boolean добавлено в netapp.ontap 23.2.0	Определяет, следует ли использовать прокси-функцию AWS Lambda для подключения к системе ONTAP. Поддерживается только с REST. Варианты: `false` ← (по умолчанию) `true`
use_rest string	Определяет, использовать REST или ZAPI. always — всегда использовать REST API, если модуль поддерживает REST. Если модуль не поддерживает REST, выдается предупреждение. Если параметр модуля не поддерживается в REST, выдается ошибка. never — всегда использовать ZAPI, если модуль поддерживает ZAPI. Может быть выдана ошибка, если параметр REST не поддерживается в ZAPI. auto — пытаться использовать REST API, если модуль поддерживает REST и параметры модуля поддерживаются. В противном случае переключаться на ZAPI. По умолчанию: `"always"`
username псевдоним: user string	Учетная запись может относиться к кластеру или SVM — в зависимости от того, требуется ли API уровня кластера или уровня SVM. Дополнительную информацию см. в документации: https://docs.netapp.com/us-en/ontap/authentication/create-svm-user-accounts-task.html. Поддерживаются два метода аутентификации: Базовая аутентификация с использованием имени пользователя и пароля. Аутентификация с сертификатом SSL с использованием файла сертификата клиента SSL и, при необходимости, файла закрытого ключа. Для использования сертификата он должен быть установлен в кластере ONTAP, а аутентификация по сертификату должна быть включена.
validate_certs boolean	Если задано значение `no`, сертификаты SSL не проверяются. Это следует задавать только как `False` на контролируемых вами узлах, использующих самоподписанные сертификаты. Варианты: `false` `true` ← (по умолчанию)
vserver псевдоним: svm string	Имя используемого vserver. Обязательно при использовании ZAPI. При использовании REST этот параметр игнорируется при создании учетной записи пользователя уровня кластера.

Примечания

Примечание

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

Примеры

- name: Create User
  netapp.ontap.na_ontap_user:
    state: present
    name: SampleUser
    applications: ssh,console
    authentication_method: password
    set_password: apn1242183u1298u41
    lock_user: true
    role_name: vsadmin
    vserver: ansibleVServer
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"

- name: Create cluster scoped user in REST.
  netapp.ontap.na_ontap_user:
    state: present
    name: SampleUser
    applications: ssh,console
    authentication_method: password
    set_password: apn1242183u1298u41
    lock_user: true
    role_name: admin
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"

- name: Delete User
  netapp.ontap.na_ontap_user:
    state: absent
    name: SampleUser
    applications: ssh
    authentication_method: password
    vserver: ansibleVServer
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"

- name: Create user with snmp application (ZAPI)
  netapp.ontap.na_ontap_user:
    state: present
    name: test_cert_snmp
    applications: snmp
    authentication_method: usm
    role_name: admin
    authentication_protocol: md5
    authentication_password: '12345678'
    privacy_protocol: 'aes128'
    privacy_password: '12345678'
    engine_id: '7063514941000000000000'
    remote_switch_ipaddress: 10.0.0.0
    vserver: "{{ vserver }}"
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"

- name: Create user
  netapp.ontap.na_ontap_user:
    state: present
    name: test123
    application_dicts:
      - application: http
        authentication_methods: password
      - application: ssh
        authentication_methods: password,publickey
    role_name: vsadmin
    set_password: bobdole1234566
    vserver: "{{ vserver }}"
    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_user_module.html