netapp.ontap.na_ontap_object_store – NetApp ONTAP manage object store config.

Note

This plugin is part of the netapp.ontap collection (version 21.14.1).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install netapp.ontap.

To use it in a playbook, specify: netapp.ontap.na_ontap_object_store.

New in version 2.9.0: of netapp.ontap

Synopsis

  • Create or delete object store config on ONTAP.

Requirements

The below requirements are needed on the host that executes this module.

  • Ansible 2.9

  • Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’

  • netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues.

  • A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward.

  • REST support requires ONTAP 9.6 or later.

  • To enable http on the cluster you must run the following commands ‘set -privilege advanced;’ ‘system services web modify -http-enabled true;’

Parameters

Parameter

Comments

access_key

string

Access key ID for AWS_S3 and SGWS provider types.

cert_filepath

string

added in 20.6.0 of netapp.ontap

path to SSL client cert file (.pem).

not supported with python 2.6.

certificate_validation_enabled

boolean

added in 21.9.0 of netapp.ontap

Is SSL/TLS certificate validation enabled?

If not specified, ONTAP will default to true.

Choices:

  • no

  • yes

change_password

boolean

added in 21.13.0 of netapp.ontap

By default, the secret_password is used on create but ignored if the resource already exists.

If set to true, the module always attempt to change the paswword as it cannot read the current value.

When this is set to true, the module is not idempotent.

Choices:

  • no ← (default)

  • yes

container

string

Data bucket/container name used in S3 requests.

feature_flags

dictionary

added in 20.5.0 of netapp.ontap

Enable or disable a new feature.

This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility.

Supported keys and values are subject to change without notice. Unknown keys are ignored.

hostname

string / required

The hostname or IP address of the ONTAP instance.

http_port

integer

Override the default port (80 or 443) with this port

https

boolean

Enable and disable https.

Ignored when using REST as only https is supported.

Ignored when using SSL certificate authentication as it requires SSL.

Choices:

  • no ← (default)

  • yes

key_filepath

string

added in 20.6.0 of netapp.ontap

path to SSL client key file.

name

string / required

The name of the object store config to manage.

ontapi

integer

The ontap api version to use

owner

string

added in 21.13.0 of netapp.ontap

Owner of the target. Cannot be modifed.

With REST, allowed values are fabricpool or snapmirror. A target can be used by only one feature.

With ZAPI, the only allowed value is fabricpool.

If absent, fabricpool is assumed on creation.

password

aliases: pass

string

Password for the specified user.

port

integer

added in 21.9.0 of netapp.ontap

Port number of the object store that ONTAP uses when establishing a connection.

provider_type

string

The name of the object store config provider.

secret_password

string

Secret access key for AWS_S3 and SGWS provider types.

server

string

Fully qualified domain name of the object store config.

ssl_enabled

boolean

added in 21.9.0 of netapp.ontap

Is SSL enabled?

If not specified, ONTAP will default to true.

Choices:

  • no

  • yes

state

string

Whether the specified object store config should exist or not.

Choices:

  • present ← (default)

  • absent

use_rest

string

REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI.

always – will always use the REST API

never – will always use the ZAPI

auto – will try to use the REST Api

Default: “auto”

username

aliases: user

string

This can be a Cluster-scoped or SVM-scoped account, depending on whether a Cluster-level or SVM-level API is required.

For more information, please read the documentation https://mysupport.netapp.com/NOW/download/software/nmsdk/9.4/.

Two authentication methods are supported

  1. basic authentication, using username and password,

  2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file.

To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled.

validate_certs

boolean

If set to no, the SSL certificates will not be validated.

This should only set to False used on personally controlled sites using self-signed certificates.

Choices:

  • no

  • yes ← (default)

Notes

Note

  • The modules prefixed with na_ontap are built to support the ONTAP storage platform.

Examples

- name: object store Create
  netapp.ontap.na_ontap_object_store:
    state: present
    name: ansible
    provider_type: SGWS
    server: abc
    container: abc
    access_key: s3.amazonaws.com
    secret_password: abc
    hostname: "{{ hostname }}"
    username: "{{ username }}"
    password: "{{ password }}"

- name: object store Create
  netapp.ontap.na_ontap_object_store:
    state: absent
    name: ansible
    hostname: "{{ hostname }}"
    username: "{{ username }}"
    password: "{{ password }}"

Authors