Модуль netapp.ontap.na_ontap_s3_buckets – бакеты 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_buckets.
Добавлено в netapp.ontap 21.19.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 или новее.
Параметры
Параметр | Комментарии |
|---|---|
aggregates list / elements=string | Список имён агрегатов, используемых для бакета S3. Этот параметр не поддерживается при type=nas. |
audit_event_selector dictionary | Селектор событий аудита позволяет указать типы доступа и разрешений, которые следует проверять. Этот параметр не поддерживается при type=nas. |
|
access string |
задаёт тип доступа к событию, который будет проверяться: только чтение, только запись или все типы (по умолчанию — все). Варианты:
|
|
permission string |
задаёт тип разрешения для события, который будет проверяться: только разрешение, только запрет или все типы (по умолчанию — все). Варианты:
|
cert_filepath string добавлено в netapp.ontap 20.6.0 | путь к файлу сертификата клиента SSL (.pem). не поддерживается в Python 2.6. |
comment string | Комментарий к бакету S3. |
constituents_per_aggregate integer | Количество компонентов в агрегате. Этот параметр не поддерживается при type=nas. |
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. Варианты:
|
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 или NAS. |
nas_path string добавлено в netapp.ontap 22.7.0 | Указывает путь NAS, которому соответствует бакет NAS. |
password псевдонимы: pass string | Пароль указанного пользователя. |
policy dictionary | Политика доступа использует синтаксис языка политик Amazon Web Services (AWS), позволяя клиентам S3 создавать политики доступа к своим данным |
|
statements list / elements=dictionary |
Операторы политики формируются с использованием этой структуры для задания разрешений Предоставить <Effect>, чтобы разрешить или запретить <Principal> выполнять <Action> над <Resource>, если выполняется <Condition> |
|
actions list / elements=string |
Можно указать *, чтобы обозначить все действия, либо перечислить одно или несколько следующих действий GetObject PutObject DeleteObject ListBucket GetBucketAcl GetObjectAcl ListBucketMultipartUploads ListMultipartUploadParts |
|
conditions list / elements=dictionary |
Условия, при которых действует политика. |
|
delimiters list / elements=string |
Разделитель для определения префикса в списке объектов. |
|
max_keys list / elements=string |
Максимальное количество ключей, возвращаемых в ответ на запрос. |
|
operator string |
Оператор, используемый для условия. Варианты:
|
|
prefixes list / elements=string |
Префиксы объектов, которые требуется перечислить. |
|
source_ips list / elements=string |
IP-адрес источника запроса. |
|
usernames list / elements=string |
Имена пользователей, которым разрешён доступ к бакету. |
|
effect string |
Оператор может разрешать или запрещать доступ Варианты:
|
|
principals list / elements=string |
Список из одного или нескольких пользователей или групп S3. |
|
resources list / elements=string |
Бакет и любые содержащиеся в нём объекты. Для задания ресурса с помощью регулярного выражения можно использовать подстановочные символы * и ?. |
|
sid string |
Идентификатор оператора |
qos_policy dictionary | Группа политик определяет измеримые целевые показатели уровня обслуживания (SLO), применяемые к объектам хранения, связанным с этой группой политик. Если не назначить бакету группу политик, система не будет отслеживать и контролировать трафик к нему. Этот параметр не поддерживается при type=nas. |
|
max_throughput_iops integer |
Максимальная пропускная способность в IOPS. |
|
max_throughput_mbps integer |
Максимальная пропускная способность в Мбит/с. |
|
min_throughput_iops integer |
Минимальная пропускная способность в IOPS. |
|
min_throughput_mbps integer |
Минимальная пропускная способность в Мбит/с. |
|
name string |
Имя группы политик QoS. Этот параметр нельзя использовать одновременно с другими атрибутами QoS. |
size integer | Размер бакета S3 в байтах. Этот параметр не поддерживается при type=nas. |
snapshot_policy string добавлено в netapp.ontap 23.1.0 | Задаёт политику создания снимков для бакета. |
state string | Определяет, должен ли указанный бакет S3 существовать. Варианты:
|
type string добавлено в netapp.ontap 22.6.0 | Задаёт тип бакета. Допустимые значения: «s3» и «nas». Варианты:
|
use_lambda boolean добавлено в netapp.ontap 23.4.0 | Указывает, следует ли использовать функцию прокси AWS Lambda для подключения к системе ONTAP. Поддерживается только при использовании REST. Варианты:
|
use_rest string | Этот модуль поддерживает только REST. always — всегда использовать REST API. Если модуль не поддерживает REST, будет выдано предупреждение. По умолчанию: |
username псевдонимы: user string | Это может быть учётная запись уровня кластера или SVM, в зависимости от того, требуется ли API уровня кластера или уровня SVM. Дополнительные сведения см. в документации: https://docs.netapp.com/us-en/ontap/authentication/create-svm-user-accounts-task.html. Поддерживаются два метода аутентификации
Для использования сертификата он должен быть установлен в кластере ONTAP, а аутентификация по сертификату должна быть включена. |
validate_certs boolean | Если задано значение Задавайте это значение только для Варианты:
|
versioning_state string добавлено в netapp.ontap 22.13.0 | Задаёт состояние версионирования бакета. Невозможно изменить состояние версионирования на «disabled» из любого другого состояния. Требуется ONTAP 9.11.1 или новее. Варианты:
|
vserver string / обязательный | Имя используемого vserver. |
Примечания
Примечание
- модуль попытается установить требуемое
audit_event_selector, если для бакета не настроены параметры audit_event_selector, однако это может не вступить в силу, если в vserver отсутствует конфигурация аудита. - Поддерживается функциональность прокси AWS Lambda. Пример использования см. в README.
- Модули с префиксом na_ontap предназначены для поддержки платформы хранения ONTAP.
- HTTPS включён по умолчанию и рекомендуется к использованию. Чтобы включить HTTP в кластере, необходимо выполнить следующие команды: ‘set -privilege advanced;’ ‘system services web modify -http-enabled true;’
Примеры
- name: Create S3 bucket
netapp.ontap.na_ontap_s3_buckets:
state: present
name: carchi-test-bucket
comment: carchi8py was here
size: 838860800
vserver: ansibleSVM
hostname: "{{ netapp_hostname }}"
username: "{{ netapp_username }}"
password: "{{ netapp_password }}"
https: true
validate_certs: false
use_rest: always
- name: Create S3 bucket with a policy
netapp.ontap.na_ontap_s3_buckets:
state: present
name: carchi-test-bucket
comment: carchi8py was here
size: 838860800
policy:
statements:
- sid: FullAccessToUser1
resources:
- bucket1
- bucket1/*
actions:
- GetObject
- PutObject
- DeleteObject
- ListBucket
effect: allow
conditions:
- operator: ip_address
max_keys:
- 1000
delimiters:
- "/"
source_ips:
- 1.1.1.1
- 1.2.2.0/24
prefixes:
- prex
usernames:
- user1
principals:
- user1
- group/grp1
vserver: ansibleSVM
hostname: "{{ netapp_hostname }}"
username: "{{ netapp_username }}"
password: "{{ netapp_password }}"
https: true
validate_certs: false
use_rest: always
- name: Delete S3 bucket
netapp.ontap.na_ontap_s3_buckets:
state: absent
name: carchi-test-bucket
vserver: ansibleSVM
hostname: "{{ netapp_hostname }}"
username: "{{ netapp_username }}"
password: "{{ netapp_password }}"
https: true
validate_certs: false
use_rest: always
Ссылки на коллекцию
© 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_buckets_module.html