dellemc.powerscale.synciq_global_settings (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 global settings on an PowerScale system includes retrieving details of SyncIQ global settings and modifying SyncIQ global settings.

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: Get SyncIQ global settings
  dellemc.powerscale.synciq_global_settings:
    onefs_host: "{{ onefs_host }}"
    port_no: "{{ port_no }}"
    api_user: "{{ api_user }}"
    api_password: "{{ api_password }}"
    verify_ssl: "{{ verify_ssl }}"

Scanned by Steampunk Spotter

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

- name: Update service of SyncIQ global settings
  dellemc.powerscale.synciq_global_settings:
    onefs_host: "{{ onefs_host }}"
    port_no: "{{ port_no }}"
    api_user: "{{ api_user }}"
    api_password: "{{ api_password }}"
    verify_ssl: "{{ verify_ssl }}"
    service: "on"
    encryption_required: true

Inputs

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

service:
    choices:
    - 'on'
    - 'off'
    - paused
    default: 'on'
    description:
    - Specifies if the SyncIQ service currently C(on), C(paused), or C(off).
    - If C(paused), all sync jobs will be paused. If turned C(off), all jobs will be canceled.
    type: str

api_user:
    description:
    - username of the PowerScale cluster.
    required: true
    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

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

encryption_required:
    default: false
    description:
    - If true, requires all SyncIQ policies to utilize encrypted communications.
    type: bool

Outputs

changed:
  description: A boolean indicating if the task had to make changes.
  returned: always
  sample: 'false'
  type: bool
synciq_global_settings:
  contains:
    bandwidth_reservation_reserve_absolute:
      description: The absolute bandwidth reservation for SyncIQ.
      type: int
    bandwidth_reservation_reserve_percentage:
      description: The percentage-based bandwidth reservation for SyncIQ.
      type: int
    cluster_certificate_id:
      description: The ID of the cluster certificate used for SyncIQ.
      type: str
    encryption_cipher_list:
      description: The list of encryption ciphers used for SyncIQ.
      type: str
    encryption_required:
      description: Whether encryption is required or not for SyncIQ.
      type: bool
    force_interface:
      description: Whether the force interface is enabled or not for SyncIQ.
      type: bool
    max_concurrent_jobs:
      description: The maximum number of concurrent jobs for SyncIQ.
      type: int
    ocsp_address:
      description: The address of the OCSP server used for SyncIQ certificate validation.
      type: str
    ocsp_issuer_certificate_id:
      description: The ID of the issuer certificate used for OCSP validation in SyncIQ.
      type: str
    preferred_rpo_alert:
      description: Whether the preferred RPO alert is enabled or not for SyncIQ.
      type: bool
    renegotiation_period:
      description: The renegotiation period in seconds for SyncIQ.
      type: int
    report_email:
      description: The email address to which SyncIQ reports are sent.
      type: str
    report_max_age:
      description: The maximum age in days of reports that are retained by SyncIQ.
      type: int
    report_max_count:
      description: The maximum number of reports that are retained by SyncIQ.
      type: int
    restrict_target_network:
      description: Whether to restrict the target network in SyncIQ.
      type: bool
    rpo_alerts:
      description: Whether RPO alerts are enabled or not in SyncIQ.
      type: bool
    service:
      description: Specifies whether the SyncIQ service is currently on, off, or paused.
      type: str
    service_history_max_age:
      description: The maximum age in days of service history that is retained by
        SyncIQ.
      type: int
    service_history_max_count:
      description: The maximum number of service history records that are retained
        by SyncIQ.
      type: int
    source_network:
      description: The source network used by SyncIQ.
      type: str
    tw_chkpt_interval:
      description: The interval between checkpoints in seconds in SyncIQ.
      type: int
    use_workers_per_node:
      description: Whether to use workers per node in SyncIQ or not.
      type: bool
  description: The SyncIQ global settings details.
  returned: always
  sample:
    bandwidth_reservation_reserve_absolute: null
    bandwidth_reservation_reserve_percentage: 1
    cluster_certificate_id: xxxx
    encryption_cipher_list: ''
    encryption_required: true
    force_interface: false
    max_concurrent_jobs: 16
    ocsp_address: ''
    ocsp_issuer_certificate_id: ''
    preferred_rpo_alert: 0
    renegotiation_period: 28800
    report_email: []
    report_max_age: 31536000
    report_max_count: 2000
    restrict_target_network: false
    rpo_alerts: true
    service: 'off'
    service_history_max_age: 31536000
    service_history_max_count: 2000
    source_network: null
    tw_chkpt_interval: null
    use_workers_per_node: false
  type: dict