netapp.storagegrid.na_sg_org_endpoints module – NetApp StorageGRID configure Platform Service Endpoint.

Note

This module is part of the netapp.storagegrid collection (version 21.17.0).

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.storagegrid.

To use it in a playbook, specify: netapp.storagegrid.na_sg_org_endpoints.

New in netapp.storagegrid 21.16.0

Synopsis

  • Configure Platform Service Endpoint with in NetApp StorageGRID.

  • If module is run with check_mode, a connectivity test will be performed using the supplied values without changing the configuration.

Parameters

Parameter

Comments

api_url

string / required

The url to the StorageGRID Admin Node REST API.

auth_token

string / required

The authorization token for the API request

auth_type

string

The authentication type for the endpoint.

Choices:

  • "anonymous"

  • "accessKey"

  • "basicHttp"

  • "cap"

  • "sasl"

ca_cert

string

The CA certificate for the endpoint.

cap_credentials

dictionary

The CAP credentials for the endpoint.

client_cert

string / required

The client certificate for the CAP endpoint.

client_key

string / required

The client key for the CAP endpoint.

client_key_passphrase

string

The client key passphrase for the CAP endpoint.

server_ca_cert

string

The server CA certificate for the CAP endpoint.

url

string / required

The URL for the CAP endpoint.

credentials

dictionary

The credentials for the endpoint.

access_key

string

The access key for the endpoint.

secret_key

string

The secret key for the endpoint.

endpoint_uri

string

The URI of the endpoint.

endpoint_urn

string

The URN of the endpoint.

http_credentials

dictionary

The HTTP credentials for the endpoint.

http_password

string

The HTTP password for the endpoint.

http_username

string

The HTTP username for the endpoint.

insecure_tls

boolean

Whether to allow insecure TLS connections to the endpoint.

Choices:

  • false ← (default)

  • true

name

string

The name of the endpoint.

sasl_credentials

dictionary

The SASL credentials for the endpoint.

delegation_token

boolean

Whether to use a delegation token for the SASL endpoint.

Choices:

  • false ← (default)

  • true

mechanism

string / required

The SASL mechanism for the endpoint.

Choices:

  • "PLAIN"

  • "SCRAM-SHA-256"

  • "SCRAM-SHA-512"

sasl_password

string

The SASL password for the endpoint.

sasl_username

string

The SASL username for the endpoint.

state

string

Whether the specified endpoint should exist or not.

Choices:

  • "present" ← (default)

  • "absent"

validate_certs

boolean

Should https certificates be validated?

Choices:

  • false

  • true ← (default)

Notes

Note

  • The modules prefixed with na_sg are built to manage NetApp StorageGRID.

Examples

- name: Configure platform service endpoint
  netapp.storagegrid.na_sg_org_endpoints:
    api_url: "https://<storagegrid-endpoint-url>"
    auth_token: "storagegrid-auth-token"
    validate_certs: false
    state: present
    name: "My_endpoint"
    endpoint_uri: "https://s3-aws-region.amazonaws.com"
    endpoint_urn: "arn:aws:s3:::my-bucket"
    auth_type: "anonymous"
  check_mode: true

- name: Configure platform service endpoint with access key credentials
  netapp.storagegrid.na_sg_org_endpoints:
    api_url: "https://<storagegrid-endpoint-url>"
    auth_token: "storagegrid-auth-token"
    validate_certs: false
    state: present
    name: "My_endpoint"
    endpoint_uri: "https://s3-aws-region.amazonaws.com"
    endpoint_urn: "arn:aws:s3:::my-bucket"
    auth_type: "accessKey"
    credentials:
      access_key: "my-access-key"
      secret_key: "my-secret-key"

- name: Delete existing platform service endpoint
  netapp.storagegrid.na_sg_org_endpoints:
    api_url: "https://<storagegrid-endpoint-url>"
    auth_token: "storagegrid-auth-token"
    validate_certs: false
    state: absent
    name: "My_endpoint"

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

resp

dictionary

Returns information about the StorageGRID endpoint configuration.

Returned: success

Sample: {"authType": "anonymous", "caCert": null, "credentials": null, "displayName": "My_endpoint", "endpointURI": "https://s3-aws-region.amazonaws.com", "endpointURN": "arn:aws:s3:::my-bucket", "id": "00000000-0000-0000-0000-000000000000", "insecureTLS": false}

Authors

  • NetApp Ansible Team (@vinaykus)