ibm.storage_virtualize.ibm_sv_manage_system_certificate module – This module manages system certificates and truststore for replication, high availability and FlashSystem grid on IBM Storage Virtualize family systems

Note

This module is part of the ibm.storage_virtualize collection (version 3.3.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 ibm.storage_virtualize.

To use it in a playbook, specify: ibm.storage_virtualize.ibm_sv_manage_system_certificate.

New in ibm.storage_virtualize 3.1.0

Synopsis
Parameters
Examples

Synopsis

Ansible interface to manage mktruststore, rmtruststore, chsystemcertstore and chsystemcert commands.
This module can be used to set up mutual TLS (mTLS) for inter-system communication which involves Policy-based Replication, Policy-based High Availability, and Flashsystem grid.
This module transfers the certificate between both local and remote system using SCP command.
This module works on SSH and uses paramiko to establish an SSH connection.
This module will only export root CA certificate for creating truststore.

Parameters

Parameter	Comments
clustername string / required	The hostname or management IP of the Storage Virtualize system.
domain string	Domain for the Storage Virtualize storage system. Valid when hostname is used for the parameter clustername.
log_path string	Path of debug log file.
password string / required	Password for the Storage Virtualize system.
primary_truststore_name string / required	Specifies the name of the truststore on the primary system.
remote_clustername string	Specifies the name of the partner remote cluster with which mTLS needs to be setup.
remote_domain string	Domain for the Storage Virtualize storage system. Valid when hostname is used for the parameter remote_clustername.
remote_password string	Password for remote cluster.
remote_truststore_name string	Specifies the name of the truststore on the remote system.
remote_username string	Username for remote cluster.
state string / required	Creates (`present`) or deletes (`absent`) a truststore. Choices: `"present"` `"absent"`
username string / required	Username for the Storage Virtualize system.

Examples

- name: Create truststore on both systems
  ibm.storage_virtualize.ibm_sv_manage_system_certificate:
    clustername: "{{ primary_clustername }}"
    username: "{{ primary_username }}"
    password: "{{ primary_password }}"
    remote_clustername: "{{ secondary_clustername }}"
    remote_username: "{{ secondary_username }}"
    remote_password: "{{ secondary_password }}"
    primary_truststore_name: "{{ primary_truststore_name }}"
    remote_truststore_name: "{{ secondary_truststore_name }}"
    state: present
    log_path: "{{ log_path | default('/tmp/playbook.debug') }}"

- name: Remove truststore on both systems
  ibm.storage_virtualize.ibm_sv_manage_system_certificate:
    clustername: "{{ primary_clustername }}"
    username: "{{ primary_username }}"
    password: "{{ primary_password }}"
    remote_clustername: "{{ secondary_clustername }}"
    remote_username: "{{ secondary_username }}"
    remote_password: "{{ secondary_password }}"
    primary_truststore_name: "{{ primary_truststore_name }}"
    remote_truststore_name: "{{ secondary_truststore_name }}"
    state: absent
    log_path: "{{ log_path | default('/tmp/playbook.debug') }}"

- name: Remove truststore on single system
  ibm.storage_virtualize.ibm_sv_manage_system_certificate:
    clustername: "{{ clustername }}"
    username: "{{ username }}"
    password: "{{ password }}"
    primary_truststore_name: "{{ truststore_name }}"
    state: absent
    log_path: "{{ log_path | default('/tmp/playbook.debug') }}"

Authors

Sandip Gulab Rajbanshi (@Sandip-Rajbanshi)

Collection links

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/ibm/storage_virtualize/ibm_sv_manage_system_certificate_module.html