dellemc.powerstore.job (3.2.0) — module

Install collection

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

Add to requirements.yml

  collections:
    - name: dellemc.powerstore
      version: 3.2.0

Description

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

Requirements

• A Dell PowerStore storage system version 3.0.0.0 or later.
• Ansible-core 2.14 or later.
• PyPowerStore 3.1.0.
• 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 Job Details
  dellemc.powerstore.job:
    array_ip: "{{mgmt_ip}}"
    validate_certs: "{{validate_certs}}"
    user: "{{user}}"
    password: "{{password}}"
    job_id: "a544981c-e94a-40ab-9eae-e578e182d2bb"

Inputs

    
port:
    description:
    - Port number for the PowerStore array.
    - If not passed, it will take 443 as default.
    type: int

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

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

timeout:
    default: 120
    description:
    - Time after which the connection will get terminated.
    - It is to be mentioned in seconds.
    type: int

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

validate_certs:
    aliases:
    - verifycert
    default: true
    description:
    - Boolean variable to specify whether to validate SSL certificate or not.
    - C(true) - indicates that the SSL certificate should be verified. Set the environment
      variable REQUESTS_CA_BUNDLE to the path of the SSL certificate.
    - C(false) - indicates that the SSL certificate should not be verified.
    type: bool

Outputs

changed:
  description: Whether or not the resource has changed.
  returned: always
  sample: 'false'
  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.
  sample:
    description_l10n: Modify network parameters.
    end_time: '2022-01-06T07:39:05.846+00:00'
    estimated_completion_time: null
    id: be0d099c-a6cf-44e8-88d7-9be80ccae369
    parent_id: null
    phase: Completed
    phase_l10n: Completed
    progress_percentage: 100
    resource_action: modify
    resource_action_l10n: modify
    resource_id: nw6
    resource_name: null
    resource_type: network
    resource_type_l10n: network
    response_body: null
    response_status: null
    response_status_l10n: null
    root_id: be0d099c-a6cf-44e8-88d7-9be80ccae369
    start_time: '2022-01-06T07:39:05.47+00:00'
    state: COMPLETED
    state_l10n: Completed
    step_order: 23792565
    user: admin
  type: complex