Модуль netapp.ontap.na_ontap_s3_users – пользователи S3 в NetApp ONTAP

Примечание

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

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

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

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

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

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

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

Создание, удаление и изменение пользователей S3 в NetApp ONTAP.

Требования

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

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_key string добавлено в netapp.ontap 23.5.0	Ключ доступа пользователя S3.
cert_filepath string добавлено в netapp.ontap 20.6.0	Путь к файлу сертификата SSL-клиента (.pem). Не поддерживается в Python 2.6.
comment string	Комментарий о пользователе.
delete_keys boolean добавлено в netapp.ontap 22.13.0	Определяет, следует ли удалять ключи пользователя. Требуется ONTAP 9.14 или более поздняя версия. Варианты: `false` `true`
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, каждый компонент должен быть целым числом.
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-клиента.
lambda_config dictionary добавлено в netapp.ontap 23.4.0	Параметры конфигурации функции прокси-сервера AWS Lambda. Этот параметр и его вложенные параметры поддерживаются только при использовании REST.
aws_profile string	Имя профиля AWS, используемого для аутентификации.
aws_region string / обязательный	Имя региона AWS.
function_name string / обязательный	Имя вызываемой функции AWS Lambda.
name string / обязательный	Имя пользователя S3.
password псевдонимы: pass string	Пароль указанного пользователя.
regenerate_keys boolean добавлено в netapp.ontap 22.13.0	Определяет, следует ли повторно создавать ключи пользователя. Варианты: `false` `true`
secret_key string добавлено в netapp.ontap 23.5.0	Секретный ключ пользователя S3. Требуется ONTAP 9.16.1 или более поздняя версия.
state string	Должен ли указанный пользователь S3 существовать. Варианты: `"present"` ← (по умолчанию) `"absent"`
use_lambda boolean добавлено в netapp.ontap 23.4.0	Определяет, следует ли использовать функцию прокси-сервера AWS Lambda для подключения к системе ONTAP. Поддерживается только при использовании REST. Варианты: `false` ← (по умолчанию) `true`
use_rest string	Этот модуль поддерживает только REST. always — всегда использовать REST API. Если модуль не поддерживает REST, выдаётся предупреждение. По умолчанию: `"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 string / обязательный	Имя используемого vserver.

Примечания

Примечание

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

Примеры

- name: Create or modify s3 user
  netapp.ontap.na_ontap_s3_users:
    state: present
    name: carchi8py
    vserver: ansibleSVM
    comment: not enabled
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    https: true
    validate_certs: false
    use_rest: always

- name: Delete s3 user
  netapp.ontap.na_ontap_s3_users:
    state: absent
    name: carchi8py
    vserver: ansibleSVM
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    https: true
    validate_certs: false
    use_rest: always

Возвращаемые значения

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

Ключ	Описание
access_key string	access_key, созданный для пользователя Возвращается: при создании пользователя
secret_key string	secret_key, созданный для пользователя Возвращается: при создании пользователя

Авторы

Команда 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_s3_users_module.html