infinidat.infinibox.infini_certificate module – Create (present state) or clear (absent state) SSL certificates on Infinibox

Note

This module is part of the infinidat.infinibox collection (version 1.6.3).

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 infinidat.infinibox. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: infinidat.infinibox.infini_certificate.

New in infinidat.infinibox 2.16.0

Synopsis

  • This module uploads (present state) or clears (absent state) SSL certificates on Infinibox

Requirements

The below requirements are needed on the host that executes this module.

Parameters

Parameter

Comments

certificate_file_name

string

Name with full path of a certificate file.

password

string / required

Infinibox User password.

state

string

Creates/Modifies the systems SSL certificate by uploading one from a file, when using state present.

For state absent, the current certificate is removed and a new self-signed certificate is automatically generated by the IBOX.

State stat shows the existing certificate’s details.

Choices:

  • "stat"

  • "present" ← (default)

  • "absent"

stay_logged_in

boolean

If True, persist API session to disk.

Load the session on subsequent module calls.

Persisted sessions are only usable for stay_logged_in_minutes.

Choices:

  • false ← (default)

  • true

stay_logged_in_minutes

integer

Number of minutes for which a persisted session may be reused.

After this time, the session data will be deleted.

The time should be shorter than the IBOX session timeout time.

Default: 5

system

string / required

Infinibox Hostname or IPv4 Address.

user

string / required

Infinibox User username with sufficient priveledges ( see notes ).

Notes

Note

  • This module requires infinisdk python library

  • You must set INFINIBOX_USER and INFINIBOX_PASSWORD environment variables if user and password arguments are not passed to the module directly

  • Ansible uses the infinisdk configuration file ~/.infinidat/infinisdk.ini if no credentials are provided. See http://infinisdk.readthedocs.io/en/latest/getting_started.html

  • All Infinidat modules support check mode (--check). However, a dryrun that creates resources may fail if the resource dependencies are not met for a task. For example, consider a task that creates a volume in a pool. If the pool does not exist, the volume creation task will fail. It will fail even if there was a previous task in the playbook that would have created the pool but did not because the pool creation was also part of the dry run.

Examples

- name: Upload SSL certificate from file
  infini_certificate:
    certificate_file_name: cert.crt
    state: present
    user: admin
    password: secret
    system: ibox001

- name: State SSL certificate
  infini_certificate:
    state: stat
    user: admin
    password: secret
    system: ibox001

- name: Clear SSL certificate
  infini_certificate:
    state: absent
    user: admin
    password: secret
    system: ibox001

Authors

  • David Ohlemacher (@ohlemacher)