netapp.storagegrid.na_sg_grid_proxy_settings module – NetApp StorageGRID manage proxy settings for the grid.

Note

This module is part of the netapp.storagegrid collection (version 21.15.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_grid_proxy_settings.

New in netapp.storagegrid 21.15.0

Synopsis

  • Update NetApp StorageGRID Proxy settings 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

ca_bundle

string

CA certificate bundle in concatenated PEM-encoding for TLS enabled connection; null when TLS is disabled.

enable

boolean

Enable use of the Admin Node proxy.

Choices:

  • false

  • true

host_name

string

The IP address or hostname of the Admin Node proxy.

host_port

integer

Port for the Admin Node proxy.

password

string

Password for the Admin Node proxy.

proxy

string

The address of the Storage Node proxy to use for external requests. Can be either protocol://hostname:port or protocol://ip:port, where protocol is one of http or socks5.

state

string

Proxy settings should be present.

Choices:

  • "present" ← (default)

username

string

Username for the Admin Node proxy.

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: update Proxy settings on StorageGRID
  na_sg_grid_proxy_settings:
    state: present
    enable: true
    host_name: "proxy.example.com"
    host_port: 8080
    username: "MyProxyUsername"
    password: "MyProxyPassword"
    ca_bundle: "<CA certificates in concatenated PEM-encoding>"
    proxy: "http://myproxy.example.com:8080"

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 proxy settings.

Returned: If state is ‘present’.

Sample: {"caBundle": null, "enable": true, "hostPort": 8080, "hostname": "proxy.example.com", "password": null, "proxy": "http://myproxy.example.com:8080", "username": "MyProxyUsername"}

Authors

  • NetApp Ansible Team (@aamirs)