dellemc.powerstore.dellemc_powerstore_job (1.3.0) — module

Install collection

Install with ansible-galaxy collection install dellemc.powerstore:==1.3.0

Add to requirements.yml

  collections:
    - name: dellemc.powerstore
      version: 1.3.0

Description

Managing jobs on PowerStore Storage System includes getting details of job.

Requirements

• A Dell EMC PowerStore Storage System.
• Ansible 2.9 or 2.10

Usage examples

Scanned by Steampunk Spotter

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

- name: Get Job Details
  dellemc_powerstore_job:
    array_ip: "{{mgmt_ip}}"
    verifycert: "{{verifycert}}"
    user: "{{user}}"
    password: "{{password}}"
    job_id: "a544981c-e94a-40ab-9eae-e578e182d2bb"

Inputs

    
user:
    description:
    - The username of the PowerStore host.
    required: true
    type: str

job_id:
    description:
    - The ID of the job.
    required: true
    type: str

array_ip:
    description:
    - IP or FQDN of the PowerStore management system.
    required: true
    type: str

password:
    description:
    - The password of the PowerStore host.
    required: true
    type: str

verifycert:
    choices:
    - true
    - false
    description:
    - Boolean variable to specify whether to validate SSL certificate or not.
    - True - indicates that the SSL certificate should be verified. Set the environment
      variable REQUESTS_CA_BUNDLE to the path of the SSL certificate.
    - False - indicates that the SSL certificate should not be verified.
    required: true
    type: bool

Outputs

changed:
  description: Whether or not the resource has changed.
  returned: always
  type: bool
job_details:
  contains:
    description_l10n:
      description: Description of the job.
      type: str
    end_time:
      description: Date and time when the job execution completed.
      type: str
    estimated_completion_time:
      description: Estimated completion date and time.
      type: str
    id:
      description: Unique identifier of the job.
      type: str
    parent_id:
      description: Unique identifier of the parent job, if applicable.
      type: str
    phase:
      description: Current status of the job.
      type: str
    progress_percentage:
      description: Percent complete of the job.
      type: int
    resource_action:
      description: User-specified action to be performed on the given resource.
      type: str
    resource_id:
      description: Unique identifier of the resource on which the job is operating.
      type: str
    resource_name:
      description: Name of the resource on which the job is operating.
      type: str
    resource_type:
      description: Resource Type for the given resource.
      type: str
    response_body:
      contains:
        messages:
          contains:
            arguments:
              description: Values involved in the error.
              type: list
            code:
              description: Hexadecimal code of the error.
              type: str
            message_l10n:
              description: The description of the error.
              type: str
            severity:
              description: Type of the severity.
              type: str
          description: The details of the error response.
          type: complex
        response_type:
          description: Job error response.
          type: str
      description: Base response object.
      type: complex
    response_status:
      description: Possible HTTP status values of completed or failed jobs.
      type: str
    root_id:
      description: Unique identifier of the root job, if applicable. The root job
        is the job at the top of the parent hierarchy.
      type: str
    start_time:
      description: Date and time when the job execution started.
      type: str
    state:
      description: Current status of the job.
      type: str
    step_order:
      description: Order of a given job step with respect to its siblings within the
        job hierarchy.
      type: int
    user:
      description: Name of the user associated with the job.
      type: str
  description: The job details.
  returned: When job exists.
  type: complex