hitachivantara.vspone_object.oneobject_node.hv_certificates module – Manage certificates in Hitachi VSP One Object

Note

This module is part of the hitachivantara.vspone_object collection (version 1.0.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 hitachivantara.vspone_object. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: hitachivantara.vspone_object.oneobject_node.hv_certificates.

New in hitachivantara.vspone_object 1.0.0

Synopsis

  • This module manages certificates in Hitachi VSP One Object.

Requirements

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

  • python >= 3.7

Parameters

Parameter

Comments

connection_info

dictionary / required

Information required to establish a connection to the system.

cluster_name

string / required

Cluster name of the system.

http_request_retry_interval_seconds

integer / required

Interval between retries of an HTTP request.

http_request_retry_times

integer / required

Number of times to retry an HTTP request.

http_request_timeout

integer / required

Timeout for HTTP requests.

oneobject_node_client_id

string / required

Id for authentication.

oneobject_node_client_secret

string

Secret for authentication.

oneobject_node_username

string / required

Username for authentication.

oneobject_node_userpass

string / required

Password for authentication.

region

string / required

Region of the system.

ssl

dictionary

SSL configuration.

ca_certs

string

Path to the CA certificates file.

Default: ""

ca_path

string

Path to the CA certificate file.

Default: ""

check_hostname

boolean

Whether to check the hostname.

Choices:

  • false ← (default)

  • true

client_cert

string

Path to the client certificate file.

Default: ""

client_key

string

Path to the client key file.

Default: ""

ssl_cipher

string

SSL cipher to use.

Default: ""

ssl_version

string

SSL version to use.

Default: ""

validate_certs

boolean / required

Whether to validate SSL certificates.

Choices:

  • false

  • true

spec

dictionary / required

Request parameters for managing certificates.

cert_file_path

string

Path to the certificate file.

If provided, the module will add the certificate from this file.

delete_cert_dn

string

The Subject Distinguished Name of the certificate.

If provided, the module will delete the certificate with this DN.

state

string

Desired state of the certificate.

Choices:

  • "present"

  • "absent"

Attributes

Attribute

Support

Description

check_mode

Support: none

Determines if the module should run in check mode.

Examples

- name: Add Certificate to VSP One Object
  hitachivantara.vspone_object.oneobject_node.hv_certificates:
    connection_info:
      http_request_timeout: 300
      http_request_retry_times: 3
      http_request_retry_interval_seconds: 5
      cluster_name: "your_cluster_name"
      region: "your_region"
      oneobject_node_username: "your_username"
      oneobject_node_userpass: "your_password"
      oneobject_node_client_id: "vsp-object-external-client"
    spec:
      cert_file_path: "/path/to/certificate.pem"

- name: Delete a certificate from VSP One Object
  hitachivantara.vspone_object.oneobject_node.hv_certificates:
    connection_info:
      http_request_timeout: 300
      http_request_retry_times: 3
      http_request_retry_interval_seconds: 5
      cluster_name: "your_cluster_name"
      region: "your_region"
      oneobject_node_username: "your_username"
      oneobject_node_userpass: "your_password"
      oneobject_node_client_id: "vsp-object-external-client"
    spec:
      subject_dn: "[email protected], CN=*.example.com, OU=SampleOU, O=SampleOrg, L=New York, ST=New York, C=US"

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

certificate

dictionary

Certificate and its attributes.

Returned: success

issuer_dn

string

The Issuer Distinguished Name of the certificate.

Returned: success

Sample: "CN=XXXXX, OU=XXXXX, O=XXXXX, L=XXXXX, ST=XXXXX, C=XXXXX"

not_after

string

The expiration date of the certificate.

Returned: success

Sample: "9/6/2029 6:11PM"

not_before

string

The start date of the certificate.

Returned: success

Sample: "9/6/2024 6:11PM"

pem_encoded

string

The status of the Privacy-Enhanced Mail (PEM) encoding of the certificate.

Returned: success

Sample: "-----BEGIN CERTIFICATE----- SAMPLE DATA-----END CERTIFICATE-----"

subject_dn

string

The Subject Distinguished Name of the certificate.

Returned: success

Sample: "CN=XXXXX, OU=XXXXX, O=XXXXX, L=XXXXX, ST=XXXXX, C=XXXXX"

Authors

  • Hitachi Vantara, LTD. (@hitachi-vantara)