dellemc.powerscale.dellemc_powerscale_synciqjob (1.4.0) — module

Install collection

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

Add to requirements.yml

  collections:
    - name: dellemc.powerscale
      version: 1.4.0

Description

Managing SyncIQ jobs on PowerScale storage system includes retrieving and modifying details of a SyncIQ job.

Requirements

• A DellEMC PowerScale Storage system.
• Ansible 2.7 and above.

Usage examples

Scanned by Steampunk Spotter

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

- name: Get SyncIQ job details
  dellemc_powerscale_synciqjob:
      onefs_host: "{{onefs_host}}"
      api_user: "{{api_user}}"
      api_password: "{{api_password}}"
      verify_ssl: "{{verify_ssl}}"
      job_id: "Test_SSL"
      state: "present"

Scanned by Steampunk Spotter

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

- name: Pause a SyncIQ job when in running state
  dellemc_powerscale_synciqjob:
      onefs_host: "{{onefs_host}}"
      api_user: "{{api_user}}"
      api_password: "{{api_password}}"
      verify_ssl: "{{verify_ssl}}"
      job_id: "Test_SSL"
      job_state: "pause"
      state: "present"

Scanned by Steampunk Spotter

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

- name: Resume a SyncIQ job when in paused state
  dellemc_powerscale_synciqjob:
      onefs_host: "{{onefs_host}}"
      api_user: "{{api_user}}"
      api_password: "{{api_password}}"
      verify_ssl: "{{verify_ssl}}"
      job_id: "Test_SSL"
      job_state: "run"
      state: "present"

Scanned by Steampunk Spotter

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

- name: Cancel a SyncIQ job
  dellemc_powerscale_synciqjob:
      onefs_host: "{{onefs_host}}"
      api_user: "{{api_user}}"
      api_password: "{{api_password}}"
      verify_ssl: "{{verify_ssl}}"
      job_id: "Test_SSL"
      job_state: "cancel"
      state: "absent"

Inputs

    
state:
    choices:
    - absent
    - present
    description:
    - The state of the SyncIQ job after the task is performed.
    - present - indicates that the SyncIQ job should exist on the system.
    - absent - indicates that the SyncIQ job should not exist on the system.
    required: true
    type: str

job_id:
    description:
    - Specifies the id or name of the policy job.
    required: true
    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

job_state:
    choices:
    - run
    - pause
    - cancel
    description:
    - Specifies the state of the job.
    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.
    - True - indicates that the SSL certificate should be verified.
    - 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

Outputs

changed:
  description: Whether or not the resource has changed
  returned: always
  type: bool
job_details:
  contains:
    action:
      description: The action to be taken by this job.
      type: str
    id:
      description: A unique identifier for this object.
      type: str
    policy_id:
      description: The id of the policy from which the job is triggered.
      type: str
    policy_name:
      description: The name of the policy from which this job is triggered.
      type: str
    state:
      description: The state of the job.
      type: str
    sync_type:
      description: The type of sync being performed by this job.
      type: str
  description: The SyncIQ job details
  returned: When SyncIQ job exists
  type: complex
modified_job:
  contains:
    id:
      description: A unique identifier for this object.
      type: str
    state:
      description: The state of the job.
      type: str
  description: The modified SyncIQ job details
  returned: When SyncIQ job is modified
  type: complex