netapp_eseries.santricity.na_santricity_client_certificate – NetApp E-Series manage remote server certificates.
Note
This plugin is part of the netapp_eseries.santricity collection (version 1.2.13).
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.
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 | Choices/Defaults | Comments |
|---|---|---|
| api_password
string / required
|
The password to authenticate with the SANtricity Web Services Proxy or Embedded Web Services API.
|
|
| api_url
string / required
|
The url to the SANtricity Web Services Proxy or Embedded Web Services API.
Example https://prod-1.wahoo.acme.com:8443/devmgr/v2
|
|
| api_username
string / required
|
The username to authenticate with the SANtricity Web Services Proxy or Embedded Web Services API.
|
|
| certificates
list / elements=string
|
List of certificate files
Each item must include the path to the file
|
|
| reload_certificates
boolean
|
|
Whether to reload certificates when certificates have been added or removed.
Certificates will not be available or removed until the servers have been reloaded.
|
| remove_unspecified_user_certificates
boolean
|
|
Whether to remove user install client certificates that are not specified in certificates.
|
| ssid
string
|
Default:
1
|
The ID of the array to manage. This value must be unique for each array.
|
| validate_certs
boolean
|
|
Should https certificates be validated?
|
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.
- M(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 | Returned | Description |
|---|---|---|
| add_certificates
list / elements=string
|
always |
Any SSL certificates that were added.
Sample:
['added_cerificiate.crt']
|
| changed
boolean
|
always |
Whether changes have been made.
Sample:
True
|
| removed_certificates
list / elements=string
|
always |
Any SSL certificates that were removed.
Sample:
['removed_cerificiate.crt']
|
Authors
- Nathan Swartz (@ndswartz)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/netapp_eseries/santricity/na_santricity_client_certificate_module.html