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

Примечание

Этот модуль входит в коллекцию netapp.ontap (версия 22.12.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 или более поздняя версия.
При использовании 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 или более поздней версии.

Параметры

Параметр	Комментарии
cert_filepath строка добавлено в netapp.ontap 20.6.0	путь к файлу SSL-сертификата клиента (.pem). не поддерживается с python 2.6.
comment строка	комментарий к пользователю
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-клиента.
name строка / обязательно	Имя пользователя S3.
ontapi целое число	Версия API ontap для использования
password псевдонимы: pass строка	Пароль указанного пользователя.
state строка	Необходимо ли, чтобы указанный пользователь S3 существовал. Варианты: `"present"` ← (по умолчанию) `"absent"`
use_rest строка	Использовать REST или ZAPI. always – всегда будет использовать REST API, если модуль его поддерживает. Выдаётся предупреждение, если модуль не поддерживает REST. Выдаётся ошибка, если опция модуля не поддерживается в REST. never – всегда будет использовать ZAPI, если модуль его поддерживает. Может быть выдана ошибка, если опция REST не поддерживается в ZAPI. auto – попытается использовать REST API, если модуль его поддерживает и опции модуля поддерживаются. В противном случае переключается на ZAPI. По умолчанию: `"auto"`
username псевдонимы: user строка	Это может быть учётная запись уровня кластера или SVM, в зависимости от того, нужен ли API уровня кластера или SVM. Для получения дополнительной информации, пожалуйста, ознакомьтесь с документацией https://mysupport.netapp.com/NOW/download/software/nmsdk/9.4/. Поддерживаются два метода аутентификации: аутентификация по паролю, используя имя пользователя и пароль, аутентификация по SSL-сертификату, используя файл SSL-сертификата клиента и необязательный файл закрытого ключа. Для использования сертификата он должен быть установлен в кластере ONTAP, и должна быть включена аутентификация по сертификату.
validate_certs булево	Если установлено значение `no`, сертификаты SSL не будут проверены. Это следует устанавливать только в `False` на сайтах с собственным контролем, использующих самозаверяющие сертификаты. Варианты: `false` `true` ← (по умолчанию)
vserver строка / обязательно	Имя vserver для использования.

Примечания

Примечание

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

Примеры

- name: create or modify s3 user
  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
  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 строка	Ключ доступа, сгенерированный для пользователя Возвращается: при создании пользователя
secret_key строка	Секретный ключ, сгенерированный для пользователя Возвращается: при создании пользователя

Авторы

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