netapp.storagegrid.na_sg_grid_ssh_security module – Configure ssh security on StorageGRID.

Note

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

New in netapp.storagegrid 21.16.0

Synopsis

  • Configure ssh security on NetApp StorageGRID.

Parameters

Parameter

Comments

allow_external_access

boolean / required

Whether external SSH access to the grid is allowed.

Choices:

  • false

  • true

api_url

string / required

The url to the StorageGRID Admin Node REST API.

auth_token

string / required

The authorization token for the API request

state

string

The ssh security should be present.

Choices:

  • "present" ← (default)

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 ssh security setting
  netapp.storagegrid.na_sg_grid_ssh_security:
    api_url: "https://<storagegrid-endpoint-url>"
    auth_token: "storagegrid-auth-token"
    validate_certs: false
    state: present
    allow_external_access: true

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 ssh security.

Returned: If state is ‘present’.

Sample: {"allowExternalAccess": true}

Authors

  • NetApp Ansible Team (@vinaykus)