.. _commands_submit_1_module:


commands_submit_1 -- Issue SUBMIT command for DEFAULT\_INSTANCE
===============================================================

.. contents::
   :local:
   :depth: 1


Synopsis
--------

The SUBMIT top line command modifies and expedites the process of job submission for jobs already residing in the queues.

This processing can be accomplished in two ways:



All outstanding input requirements for the specified jobs can be posted as satisfied.

Optionally, by specifying EXPRESS=YES, a priority can be set for a specific job.

This priority ensures that the job is submitted ahead of other jobs also ready for submission.

Note:

EXPRESS=YES has no effect when workload balancing is being used.







Parameters
----------

  key (type: str)
    The command transaction key.



  ca7# (type: str)
    Specifies the CA 7 job number of the job whose requirements you want to post as satisfied.Limits:

    1 to 4 alphanumeric characters.



  express (type: str)
    (Optional) Indicates to place the job ahead of all other jobs (those jobs without EXPRESS=YES) for submission.

    The value must be coded as shown. Not valid if workload balancing is being used.

    Use of EXPRESS=YES does not establish an increased execution priority for a job.

    Rather, it ensures that nonexpress jobs are not submitted ahead of a job that is flagged as an express job.



  host (*required*, type: str)
    Host name of the CA7 API service that is running on the mainframe system.



  port (*required*, type: int)
    Port for the CA7 API service that is running on the mainframe system.



  user (*required*, type: str)
    User name for authenticating connections to the CA7 API service that is running on the mainframe system.



  password (*required*, type: str)
    Password for authenticating connections to the CA7 API service that is running on the mainframe system.



  base_path (type: str)
    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.



  protocol (*required*, type: str)
    Specifies protocol to use for CA7 connection (http or https).


    Choices:
      * ``http`` 
      * ``https`` 

  reject_unauthorized (type: bool, default: ``True``)
    Reject self\-signed certificates.



  cert_file (type: path)
    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.



  cert_key_file (type: path)
    The file path to a certificate key file to use for authentication.










Examples
--------

.. code-block:: yaml+jinja

    
    - name: Submits the job with ca7 number 0123 on default instance
      broadcom.ca7.commands_submit_1:
        ca7#: 0123




Return Values
-------------

data (type: list, *when returned data is a dictionary*)
  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.


error (type: complex, *error*)
  More details about why the action has failed. If the failure is when calling an API service, the response contains the connection parameters.


  additional_details (type: str)
    Detailed message about the failure.


  msg (type: str)
    Short description of the result or failure.


  request (type: str, *API request failed*)
    HTTP method used to invoke API service request.


  resource (type: str, *API request failed*)
    URI of the resource of the API service request.



failed (type: bool, *always*)
  A boolean that indicates if the task was failed or not.


list (type: list, *when returned data is a list*)
  Data from the module execution (a list of data structures).


msg (type: str, *sometimes*)
  Short description of the result or failure.


rc (type: int, *always*)
  Exit code of the module, successful exit code is 0, failure is typically 1 or higher.


stderr (type: str, *error*)
  Details of the error.


stdout (type: str, *success*)
  Summary of the result.





Status
------




- This module is maintained by Broadcom.