broadcom.ca7.commands_addrq (2.0.7) — module

Adds temporary user or predecessor job requirements

| "added in version" 1.0.0 of broadcom.ca7"

Authors: Daniel Remta <daniel.remta@broadcom.com> (@broadcom)

| supported by Broadcom

This plugin has a corresponding action plugin.

Install collection

Install with ansible-galaxy collection install broadcom.ca7:==2.0.7


Add to requirements.yml

  collections:
    - name: broadcom.ca7
      version: 2.0.7

Description

Manually adds temporary, one-time, preexecution user or predecessor job requirements.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Adds the job requirement ca7 number, 0016 from CA 7
  broadcom.ca7.commands_addrq:
    ca7num: 0016

Inputs

    
usr:
    description:
    - 'Example: USER WILL CALL TO RELEASE'
    - ''
    - Defines the description of a temporary, one-time user requirement.
    - This requirement must be manually satisfied before the job identified by JOB is
      eligible for submission.
    - If any commas are included as part of the text, enclose the entire requirements
      text in parentheses.
    - This requirement is satisfied automatically when the predecessor job completes.
    - Only in unusual situations would this requirement must be satisfied manually.
    - That is, any time that a normal completion did not occur.
    - 'Required: USR is required unless DEPJOB is used, in which case, omit USR.'
    - ''
    - 'Limits: 1 to 36 alphanumeric characters.'
    required: false
    type: str

host:
    description:
    - Host name of the CA7 API service that is running on the mainframe system.
    required: true
    type: str

port:
    description:
    - Port for the CA7 API service that is running on the mainframe system.
    required: true
    type: int

user:
    description:
    - User name for authenticating connections to the CA7 API service that is running
      on the mainframe system.
    required: true
    type: str

ca7num:
    description:
    - Ca7num=0016
    - ''
    - Defines the job to which you want to add the job requirement.
    - The job must be in the request queue.
    - Defines the CA 7 job number to which you want to add the requirement for this run
      of the job.
    - 'Limits: 1 to 4 numeric characters.'
    required: true
    type: str

depjob:
    description:
    - 'Example: PAYJOB'
    - ''
    - Defines a temporary one-time job dependency requirement.
    - The DEPJOB value specifies the job name that must complete execution
    - or must be manually posted complete before the job identified by JOB is eligible
      for submission.
    - ''
    - DEPJOB is required unless USR is used, in which case, omit DEPJOB.
    - This requirement is satisfied automatically when the predecessor job completes.
    - Only in unusual situations would this requirement must be satisfied manually.
    - That is, any time that a normal completion did not occur.
    - ''
    - 'Required: Yes, unless USR is used.'
    - ''
    - 'Limits: 1 to 8 alphanumeric characters.'
    required: false
    type: str

rmtjob:
    description:
    - 'Example: RMT_JOB'
    - ''
    - Names the job in the remote scheduler that is required by the job specified in the
      JOB field.
    - 'Limits: RMTJOB should accept up to 64 characters'
    - valid characters are a-z, A-Z, 0-9, period (.), underscore (_), hyphen (-),
    - colon (:), and pound (#); do not include embedded spaces or tabs.
    - .
    required: false
    type: str

rmtschd:
    description:
    - 'Example: AP1'
    - ''
    - Names the remote scheduler where the predecessor job runs.
    - Before adding this requirement, the remote scheduler must be defined.
    - The remote scheduler defined as type LOCAL cannot be specified.
    - 'Limits: 1 to 3 alphanumeric characters; generic specification not supported.'
    required: false
    type: str

password:
    description:
    - Password for authenticating connections to the CA7 API service that is running on
      the mainframe system.
    required: true
    type: str

protocol:
    choices:
    - http
    - https
    description:
    - Specifies protocol to use for CA7 connection (http or https).
    required: true
    type: str

base_path:
    description:
    - The base path for your Zowe API Mediation Layer instance. Specify this option to
      prepend the base path to all resources when making REST requests. Do not specify
      this option if you are not using an Zowe API Mediation Layer.
    required: false
    type: str

cert_file:
    description:
    - The file path to a certificate file to use for authentication.
    - ''
    - 'Note: The CLI does not support certificate files that require a password. For more
      information, search Troubleshooting PEM Certificates in Zowe Docs.'
    required: false
    type: path

cert_key_file:
    description:
    - The file path to a certificate key file to use for authentication.
    required: false
    type: path

reject_unauthorized:
    default: true
    description:
    - Reject self-signed certificates.
    required: false
    type: bool

Outputs

data:
  description: Data from the module execution (a data structure). The items of this
    dict are set as individual return values on the top level as well.
  elements: dict
  returned: when returned data is a dictionary
  type: list
error:
  contains:
    additional_details:
      description: Detailed message about the failure.
      type: str
    msg:
      description: Short description of the result or failure.
      type: str
    request:
      description: HTTP method used to invoke API service request.
      returned: API request failed
      type: str
    resource:
      description: URI of the resource of the API service request.
      returned: API request failed
      type: str
  description: More details about why the action has failed. If the failure is when
    calling an API service, the response contains the connection parameters.
  returned: error
  type: complex
failed:
  description: A boolean that indicates if the task was failed or not.
  returned: always
  type: bool
list:
  description: Data from the module execution (a list of data structures).
  elements: dict
  returned: when returned data is a list
  type: list
msg:
  description: Short description of the result or failure.
  returned: sometimes
  type: str
rc:
  description: Exit code of the module, successful exit code is 0, failure is typically
    1 or higher.
  returned: always
  type: int
stderr:
  description: Details of the error.
  returned: error
  type: str
stdout:
  description: Summary of the result.
  returned: success
  type: str