Spec-Zone.ru › Ansible

модуль netapp.storagegrid.na_sg_grid_tenant — управление учетными записями арендаторов NetApp StorageGRID.

Примечание

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

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

Чтобы установить ее, используйте: ansible-galaxy collection install netapp.storagegrid.

Чтобы использовать ее в плейбуке, укажите: netapp.storagegrid.na_sg_grid_tenant.

Добавлено в netapp.storagegrid 21.15.0

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

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

  • Создание, обновление и удаление учетных записей арендаторов в NetApp StorageGRID.

Параметры

Параметр

Комментарии

account_id

string

Идентификатор учетной записи арендатора.

Может использоваться для операций изменения или удаления.

allow_compliance_mode

boolean

Может ли арендатор использовать режим соответствия требованиям для блокировки объектов и хранения.

Требуется StorageGRID версии 11.9 или более поздней.

Варианты:

  • false
  • true

allow_platform_services

boolean

Разрешает арендатору использовать функции платформенных сервисов, например CloudMirror.

Варианты:

  • false
  • true

allow_select_object_content

boolean

Разрешает арендатору использовать API S3 SelectObjectContent для фильтрации и получения данных объектов.

Варианты:

  • false
  • true

api_url

string / обязательный

URL REST API узла администрирования StorageGRID.

auth_token

string / обязательный

Токен авторизации для запроса API

description

string

Дополнительная информация для идентификации учетной записи арендатора.

management

boolean

Может ли арендатор входить на портал арендаторов StorageGRID.

Варианты:

  • false
  • true ← (по умолчанию)

max_retention_days

integer

Максимальный срок хранения в днях, разрешенный для новых объектов в режиме соответствия требованиям или управления.

Требуется StorageGRID версии 11.9 или более поздней.

name

string

Имя арендатора.

Обязательно для создания или изменения.

protocol

string

Протокол объектного хранилища, используемый арендатором.

Обязательно для создания.

Варианты:

  • "s3"
  • "swift"

quota_size

integer

Квота, применяемая к арендатору; единица измерения задается параметром quota_size_unit.

Если ограничения не нужны, задайте значение 0.

По умолчанию: 0

quota_size_unit

string

Единица измерения для интерпретации параметра размера.

Варианты:

  • "bytes"
  • "b"
  • "kb"
  • "mb"
  • "gb" ← (по умолчанию)
  • "tb"
  • "pb"
  • "eb"
  • "zb"
  • "yb"

root_access_group

string

Существующая федеративная группа, которой будут назначены первоначальные разрешения корневого доступа для арендатора.

Должно начинаться с federated-group/

state

string

Должна ли указанная учетная запись существовать.

Обязательно для всех операций.

Варианты:

  • "present" ← (по умолчанию)
  • "absent"

tenant_password

string

Пароль root для учетной записи арендатора.

Требуются привилегии root.

update_password

string

Выберите, когда обновлять пароль арендатора.

Если задано значение always, пароль арендатора будет обновляться всегда.

Если задано значение on_create, пароль арендатора будет задан только при создании нового пользователя.

Варианты:

  • "on_create" ← (по умолчанию)
  • "always"

use_own_identity_source

boolean

Должна ли учетная запись арендатора настраивать собственный источник идентификации.

Варианты:

  • false
  • true

validate_certs

boolean

Следует ли проверять сертификаты HTTPS?

Варианты:

  • false
  • true ← (по умолчанию)

Примечания

Примечание

  • Модули с префиксом na_sg предназначены для управления NetApp StorageGRID.

Примеры

- name: create a tenant account
  netapp.storagegrid.na_sg_grid_tenant:
    api_url: "https://<storagegrid-endpoint-url>"
    auth_token: "storagegrid-auth-token"
    validate_certs: false
    state: present
    name: storagegrid-tenant-1
    protocol: s3
    management: true
    allow_compliance_mode: true
    max_retention_days: 365
    use_own_identity_source: false
    allow_platform_services: false
    tenant_password: "tenant-password"
    quota_size: 0

- name: update a tenant account
  netapp.storagegrid.na_sg_grid_tenant:
    api_url: "https://<storagegrid-endpoint-url>"
    auth_token: "storagegrid-auth-token"
    validate_certs: false
    state: present
    name: storagegrid-tenant-1
    protocol: s3
    management: true
    allow_compliance_mode: true
    max_retention_days: 500
    use_own_identity_source: false
    allow_platform_services: true
    tenant_password: "tenant-password"
    quota_size: 10240

- name: delete a tenant account
  netapp.storagegrid.na_sg_grid_tenant:
    api_url: "https://<storagegrid-endpoint-url>"
    auth_token: "storagegrid-auth-token"
    validate_certs: false
    state: absent
    name: storagegrid-tenant-1
    protocol: s3

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

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

Ключ

Описание

resp

dictionary

Возвращает информацию об учетной записи арендатора StorageGRID.

Возвращается: при успехе

Пример: {"capabilities": ["management", "s3"], "id": "12345678901234567890", "name": "Example Account", "policy": {"allowPlatformServices": false, "quotaObjectBytes": 100000000000, "useAccountIdentitySource": true}}

Авторы

  • Команда NetApp Ansible (@joshedmonds)

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

  • Домашняя страница
  • Репозиторий (исходный код)

© 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/storagegrid/na_sg_grid_tenant_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API