netapp.ontap.na_ontap_s3_services 模块 – NetApp ONTAP S3 服务

注意

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

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

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

要在剧本中使用它，请指定： netapp.ontap.na_ontap_s3_services。

netapp.ontap 21.20.0 中新增

概要

• 创建、删除或修改 S3 服务

要求

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

• Ansible 2.9 或更高版本 - 建议使用 2.12 或更高版本。

• Python 3 - 建议使用 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 不支持。
certificate_name 字符串	要用于服务的 https 证书的名称
comment 字符串	关于服务的注释
enabled 布尔值	启用或禁用服务 选项 false true
feature_flags 字典 netapp.ontap 20.5.0 中新增	启用或禁用新功能。 这可用于启用实验性功能或禁用破坏向后兼容性的新功能。 支持的键和值可能会在未经通知的情况下更改。未知键将被忽略。
force_ontap_version 字符串 netapp.ontap 21.23.0 中新增	使用 REST 时覆盖集群 ONTAP 版本。 如果版本与目标集群不匹配，则行为未定义。 这是在由于权限问题无法读取集群版本时的解决方法。请参阅 https://github.com/ansible-collections/netapp.ontap/wiki/Known-issues。 这应采用 9.10 或 9.10.1 的形式，每个元素都是整数。
hostname 字符串 / 必需	ONTAP 实例的主机名或 IP 地址。
http_port 整数	使用此端口覆盖默认端口 (80 或 443)
https 布尔值	启用和禁用 https。 使用 REST 时被忽略，因为只支持 https。 使用 SSL 证书身份验证时被忽略，因为它需要 SSL。 选项 false ← (默认) true
is_http_enabled 布尔值 netapp.ontap 22.13.0 中新增	指定在创建或修改的 S3 服务器上是否启用 HTTP 选项 false ← (默认) true
is_https_enabled 布尔值 netapp.ontap 22.13.0 中新增	指定在创建或修改的 S3 服务器上是否启用 HTTPS 选项 false true ← (默认)
key_filepath 字符串 netapp.ontap 20.6.0 中新增	SSL 客户端密钥文件的路径。
name 字符串 / 必需	S3 服务的名称。
password 别名：pass 字符串	指定用户的密码。
port 整数 netapp.ontap 22.13.0 中新增	指定 S3 服务器的 HTTP 侦听器端口 默认值： 80
secure_port 整数 netapp.ontap 22.13.0 中新增	指定 S3 服务器的 HTTPS 侦听器端口 默认值： 443
state 字符串	指定的 S3 存储桶是否存在。 选项 "present" ← (默认) "absent"
use_rest 字符串	此模块仅支持 REST。 always – 将始终使用 REST API。如果模块不支持 REST，则会发出警告。 默认值： "always"
username 别名：user 字符串	这可以是集群范围或 SVM 范围的帐户，具体取决于是否需要集群级或 SVM 级 API。 有关更多信息，请阅读文档 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 service
  na_ontap_s3_services:
    state: present
    name: carchi-test
    vserver: ansibleSVM
    comment: not enabled
    enabled: False
    certificate_name: ansibleSVM_16E1C1284D889609
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    https: true
    validate_certs: false
    use_rest: always

- name: create or modify s3 service with https
  na_ontap_s3_services:
    state: present
    name: carchi-test
    vserver: ansibleSVM
    comment: not enabled
    enabled: True
    is_https_enabled: True
    port: 80
    certificate_name: ansibleSVM_16E1C1284D889609
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    https: true
    validate_certs: false
    use_rest: always

- name: delete s3 service
  na_ontap_s3_services:
    state: absent
    name: carchi-test
    vserver: ansibleSVM
    certificate_name: ansibleSVM_16E1C1284D889609
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    https: true
    validate_certs: false
    use_rest: always

返回值

常见的返回值已在 此处 记录，以下是此模块特有的字段

键	描述
s3_service_info 字典	返回 S3 服务响应。 返回： 在创建或修改 S3 服务时 示例： "{ \"s3_service_info\": { \"name\": \"Service1\", \"enabled\": false, \"certificate_name\": \"testSVM_177966509ABA4EC6\", \"users\": [{\"name\": \"root\"}, {\"name\": \"user1\", \"access_key\": \"IWE711019OW02ZB3WH6Q\"}], \"svm\": {\"name\": \"testSVM\", \"uuid\": \"39c2a5a0-35e2-11ee-b8da-005056b37403\"}} } }"

作者

• NetApp Ansible 团队 (@carchi8py)

资源链接

• 问题跟踪器
• 主页
• 代码库 (源代码)