dellemc.powerscale.synciqcertificate (3.0.0) — module

Install collection

Install with ansible-galaxy collection install dellemc.powerscale:==3.0.0

Add to requirements.yml

  collections:
    - name: dellemc.powerscale
      version: 3.0.0

Description

Managing SyncIQ target cluster certificate on an PowerScale system includes getting, importing, modifying and deleting target cluster certificates.

Requirements

• A Dell PowerScale Storage system.
• Ansible-core 2.14 or later.
• Python 3.9, 3.10 or 3.11.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Import SyncIQ certificate
  dellemc.powerscale.synciqcertificate:
    onefs_host: "{{ onefs_host }}"
    verify_ssl: "{{ verify_ssl }}"
    api_user: "{{ api_user }}"
    api_password: "{{ api_password }}"
    certificate_file: "/ifs/server.crt"
    description: "From python"
    alias_name: "Test_1"
    state: 'present'

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Get SyncIQ certificate details
  dellemc.powerscale.synciqcertificate:
    onefs_host: "{{ onefs_host }}"
    api_user: "{{ api_user }}"
    api_password: "{{ api_password }}"
    verify_ssl: "{{ verify_ssl }}"
    certificate_id: "a851d9f3d7b16985be6fcb0402"
    state: "present"

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Modify SyncIQ certificate details
  dellemc.powerscale.synciqcertificate:
    onefs_host: "{{ onefs_host }}"
    api_user: "{{ api_user }}"
    api_password: "{{ api_password }}"
    verify_ssl: "{{ verify_ssl }}"
    certificate_id: "a851d9f3d7b16985be6fcb0402"
    description: "test description"
    alias_name: "Modify_alias_name"
    state: "present"

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Delete SyncIQ certificate details
  dellemc.powerscale.synciqcertificate:
    onefs_host: "{{ onefs_host }}"
    api_user: "{{ api_user }}"
    api_password: "{{ api_password }}"
    verify_ssl: "{{ verify_ssl }}"
    certificate_id: "a851d9f3d7b16985be6fcb0402"
    state: "absent"

Inputs

    
state:
    choices:
    - absent
    - present
    default: present
    description:
    - The state option is used to mention the existence of SyncIQ certificate.
    type: str

port_no:
    default: '8080'
    description:
    - Port number of the PowerScale cluster.It defaults to 8080 if not specified.
    required: false
    type: str

api_user:
    description:
    - username of the PowerScale cluster.
    required: true
    type: str

alias_name:
    description:
    - Alias name for the certificate.
    type: str

onefs_host:
    description:
    - IP address or FQDN of the PowerScale cluster.
    required: true
    type: str

verify_ssl:
    choices:
    - true
    - false
    description:
    - boolean variable to specify whether to validate SSL certificate or not.
    - C(true) - indicates that the SSL certificate should be verified.
    - C(false) - indicates that the SSL certificate should not be verified.
    required: true
    type: bool

description:
    description:
    - Description of the certificate.
    - Map users to a specific user and/or group ID after a failed auth attempt.
    type: str

api_password:
    description:
    - the password of the PowerScale cluster.
    required: true
    type: str

certificate_id:
    description:
    - ID assigned by the system to certificate.
    - This parameter does not affect server behavior, but is included to accommodate legacy
      client requirements.
    type: str

new_alias_name:
    description:
    - Alias name for the certificate in case of modify operation.
    type: str

certificate_file:
    description:
    - Certificate file path.
    type: str

Outputs

changed:
  description: A boolean indicating if the task had to make changes.
  returned: always
  sample: 'false'
  type: bool
synciq_certificate_details:
  contains:
    description:
      description: Description of the certificate.
      type: str
    fingerprints:
      description: Fingerprint details of the certificate.
      type: list
    id:
      description: System assigned certificate id.
      type: str
    issuer:
      description: Name of the certificate issuer.
      type: str
    name:
      description: Name for the certificate.
      type: str
    not_after:
      description: Specifies the preferred size for directory read operations. This
        value is used to advise the client of optimal settings for the server, but
        is not enforced.
      type: str
    not_before:
      description: Validity date of the certificate.
      type: str
    status:
      description: Specifies the validity of the certificate.
      type: str
    subject:
      description: Validity date of the certificate.
      type: str
  description: The synciq certificate details.
  returned: always
  sample:
    description: SyncIQ Certificate details
    fingerprints:
    - type: SHA1
      value: xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:5e:xx:xx:xx:xx:xx:xx:xx:xx
    - type: SHA256
      value: 'xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:5e:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:'
    id: 479891a2b14eb6204b1b9975573fda0fea92cfa851d9f3d7b16985be6fcb0402
    issuer: C=AU, ST=Some-State, O=Internet Widgits Pty Ltd
    name: Test_1_modify
    not_after: 1753465054
    not_before: 1690393054
    status: valid
    subject: C=AU, ST=Some-State, O=Internet Widgits Pty Ltd
  type: dict