netapp.ontap.na_ontap_s3_buckets 模块 – NetApp ONTAP S3 存储桶

注意

此模块是 netapp.ontap 集合（版本 22.13.0）的一部分。

如果您正在使用 ansible 包，则可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install netapp.ontap。您需要其他要求才能使用此模块，有关详细信息，请参阅 要求。

要在 playbook 中使用它，请指定：netapp.ontap.na_ontap_s3_buckets。

netapp.ontap 21.19.0 中的新增功能

概要

  • 在 NetApp ONTAP 上创建、删除或修改 S3 存储桶。

要求

执行此模块的主机上需要以下要求。

  • 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 或更高版本。

参数

参数

注释

aggregates

list / elements=string

用于 S3 存储桶的聚合名称列表。

当 type=nas 时，不支持此选项。

audit_event_selector

dictionary

审计事件选择器允许您指定要审计的访问和权限类型。

当 type=nas 时，不支持此选项。

access

string

指定要审计的事件访问类型，只读、只写或全部（默认为全部）。

选择

  • "read"

  • "write"

  • "all"

permission

string

指定要审计的事件权限类型，仅允许、仅拒绝或全部（默认为全部）。

选择

  • "allow"

  • "deny"

  • "all"

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 中添加

使用 REST 时覆盖集群 ONTAP 版本。

如果版本与目标集群不匹配，则行为未定义。

当由于权限问题而无法读取集群版本时，这将作为一种解决方法提供。请参阅 https://github.com/ansible-collections/netapp.ontap/wiki/Known-issues。

这应该采用 9.10 或 9.10.1 的形式，每个元素都是一个整数。

hostname

string / required

ONTAP 实例的主机名或 IP 地址。

http_port

integer

使用此端口覆盖默认端口（80 或 443）

https

boolean

启用和禁用 https。

当使用 REST 时，由于只支持 https，因此将被忽略。

当使用 SSL 证书身份验证时，由于它需要 SSL，因此将被忽略。

选择

  • false ←（默认）

  • true

key_filepath

string

在 netapp.ontap 20.6.0 中添加

SSL 客户端密钥文件的路径。

name

string / required

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

策略语句使用此结构构建，以指定权限

当 <Condition> 适用时，授予 <Effect> 以允许/拒绝 <Principal> 在 <Resource> 上执行 <Action>

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

用于条件的运算符。

选择

  • "ip_address"

  • "not_ip_address"

  • "string_equals"

  • "string_not_equals"

  • "string_equals_ignore_case"

  • "string_not_equals_ignore_case"

  • "string_like"

  • "string_not_like"

  • "numeric_equals"

  • "numeric_not_equals"

  • "numeric_greater_than"

  • "numeric_greater_than_equals"

  • "numeric_less_than"

  • "numeric_less_than_equals"

前缀

list / elements=string

您要列出的对象的前缀。

source_ips

list / elements=string

请求的源 IP 地址。

用户名

list / elements=string

您希望允许访问存储桶的用户名。

效果

string

该语句可能允许或拒绝访问

选择

  • "allow"

  • "deny"

主体

list / elements=string

一个或多个 S3 用户或组的列表。

资源

list / elements=string

存储桶及其包含的任何对象。

可以使用通配符 * 和 ? 来形成指定资源的正则表达式。

sid

string

语句 ID

qos_policy

dictionary

策略组定义了适用于与该策略组关联的存储对象的可衡量服务级别目标 (SLO)。

如果您没有为存储桶分配策略组，系统将不会监控和控制该存储桶的流量。

当 type=nas 时，不支持此选项。

max_throughput_iops

integer

最大吞吐量（以 IOPS 为单位）。

max_throughput_mbps

integer

最大吞吐量（以 MBPS 为单位）。

min_throughput_iops

integer

最小吞吐量（以 IOPS 为单位）。

min_throughput_mbps

integer

最小吞吐量（以 MBPS 为单位）。

name

string

QoS 策略组名称。 这与其他 QoS 属性互斥。

大小

integer

S3 存储桶的大小（以字节为单位）。

当 type=nas 时，不支持此选项。

状态

string

指定的 S3 存储桶是否应该存在。

选择

  • "present" ← (默认)

  • "absent"

类型

string

在 netapp.ontap 22.6.0 中添加

指定存储桶类型。有效值为“s3”和“nas”。

选择

  • "s3"

  • "nas"

use_rest

string

此模块仅支持 REST。

always – 将始终使用 REST API。如果模块不支持 REST，则会发出警告。

默认值： "always"

username

别名：user

string

这可以是集群范围或 SVM 范围的帐户，具体取决于需要集群级别还是 SVM 级别的 API。

有关更多信息，请阅读文档 https://mysupport.netapp.com/NOW/download/software/nmsdk/9.4/。

支持两种身份验证方法

  1. 基本身份验证，使用用户名和密码，

  2. SSL 证书身份验证，使用 SSL 客户端证书文件，以及可选的私钥文件。

要使用证书，必须在 ONTAP 集群中安装该证书，并且必须启用证书身份验证。

validate_certs

boolean

如果设置为 no，则不会验证 SSL 证书。

此项应仅在个人控制的站点上使用自签名证书时设置为 False。

选择

  • false

  • true ← (默认)

versioning_state

string

在 netapp.ontap 22.13.0 中添加

指定存储桶的版本控制状态。

版本控制状态不能从任何其他状态修改为“disabled”。

需要 ONTAP 9.11.1 或更高版本。

选择

  • "disabled"

  • "enabled"

  • "suspended"

vserver

string / required

要使用的 vserver 的名称。

说明

注意

  • 如果存储桶未配置 audit_event_selector 选项，模块将尝试设置所需的 audit_event_selector，但如果 vserver 中没有审计配置，则可能不会生效。

  • 以 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

作者

  • NetApp Ansible 团队 (@carchi8py)