netapp_eseries.santricity.na_santricity_client_certificate module – NetApp E-Series manage remote server certificates.
Note
This module is part of the netapp_eseries.santricity collection (version 1.4.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_eseries.santricity
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: netapp_eseries.santricity.na_santricity_client_certificate
.
Synopsis
Manage NetApp E-Series storage array’s remote server certificates.
Requirements
The below requirements are needed on the host that executes this module.
cryptography
Parameters
Parameter |
Comments |
---|---|
The password to authenticate with the SANtricity Web Services Proxy or Embedded Web Services API. |
|
The url to the SANtricity Web Services Proxy or Embedded Web Services API. |
|
The username to authenticate with the SANtricity Web Services Proxy or Embedded Web Services API. |
|
List of certificate files Each item must include the path to the file |
|
Whether to reload certificates when certificates have been added or removed. Certificates will not be available or removed until the servers have been reloaded. Choices:
|
|
Whether to remove user install client certificates that are not specified in certificates. Choices:
|
|
The ID of the array to manage. This value must be unique for each array. Default: |
|
Should https certificates be validated? Choices:
|
Notes
Note
Set ssid==”0” or ssid==”proxy” to specifically reference SANtricity Web Services Proxy.
The E-Series Ansible modules require either an instance of the Web Services Proxy (WSP), to be available to manage the storage-system, or an E-Series storage-system that supports the Embedded Web Services API.
Embedded Web Services is currently available on the E2800, E5700, EF570, and newer hardware models.
netapp_eseries.santricity.netapp_e_storage_system may be utilized for configuring the systems managed by a WSP instance.
Examples
- name: Upload certificates
na_santricity_client_certificate:
ssid: 1
api_url: https://192.168.1.100:8443/devmgr/v2
api_username: admin
api_password: adminpass
certificates: ["/path/to/certificates.crt", "/path/to/another_certificate.crt"]
- name: Remove all certificates
na_santricity_client_certificate:
ssid: 1
api_url: https://192.168.1.100:8443/devmgr/v2
api_username: admin
api_password: adminpass
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Any SSL certificates that were added. Returned: always Sample: |
|
Whether changes have been made. Returned: always Sample: |
|
Any SSL certificates that were removed. Returned: always Sample: |