Welcome to Zowe CLI!
Zowe CLI is a command line interface (CLI) that provides a simple and streamlined way to interact with IBM z/OS.
For additional Zowe CLI documentation, visit https://docs.zowe.org
For Zowe CLI support, visit https://www.zowe.org
Options
Global Options
Connect to Zowe API Mediation Layer authentication service and obtain a token, or disconnect from the authentication service and revoke the token.
The token provides authentication to services that support the API ML SSO (Single Sign-On) capability. When you log in, the token is stored in your default base profile until it expires. Base profiles store connection information shared by multiple services (e.g., z/OSMF), and are used if you do not supply connection information in a service profile. To take advantage of the API ML SSO capability, you should omit username and password in service profiles so that the token in the base profile is used.
Log in to an authentication service.
Log in to Zowe API Mediation Layer authentication service and obtain or update a token.
The token provides authentication to services that support the API ML SSO (Single Sign-On) capability. When you log in, the token is stored in your default base profile until it expires. Base profiles store connection information shared by multiple services (e.g., z/OSMF), and are used if you do not supply connection information in a service profile. To take advantage of the API ML SSO capability, you should omit username and password in service profiles so that the token in the base profile is used.
Usage
zowe auth login apiml [options]
Options
Base Connection Options
-
--host | -H (string)
- Host name of service on the mainframe.
-
--port | -P (number)
- Port number of service on the mainframe.
-
--user | -u (string)
- User name to authenticate to service on the mainframe.
-
--password | --pass | --pw (string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized | --ru (boolean)
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Examples
Log out of an authentication service.
Log out of the Zowe API Mediation Layer authentication service and revoke the token so it can no longer authenticate. Also remove the token from the default base profile, if it is stored on disk.
Usage
zowe auth logout apiml [options]
Base Connection Options
-
--host | -H (string)
- Host name of service on the mainframe.
-
--port | -P (number)
- Port number of service on the mainframe.
-
--token-type | --tt (string)
-
The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
Allowed values: apimlAuthenticationToken.*, jwtToken, LtpaToken2
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--reject-unauthorized | --ru (boolean)
Profile Options
Examples
Interact with IBM CICS programs and transactions.
Add new resources (for example, CSD Groups to CSD Lists) to CICS through IBM CMCI.
Add a CSD Group to a CICS CSD List.
Usage
zowe cics add-to-list csdGroup <name> <csdList> [options]
Positional Arguments
-
name (string)
- The name of the CSD Group to add. The maximum length of the CSD Group name is eight characters
-
csdList (string)
- The name of the CSD List to add the group to. The maximum length of the CSD List name is eight characters
Options
-
--region-name (string)
- The CICS region name to which to add the CSD Group to the CSD List
-
--cics-plex (string)
- The name of the CICSPlex to which to add the CSD Group to the CSD List
Cics Connection Options
Profile Options
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
Define new resources (for example, programs) to CICS through IBM CMCI.
Define a new program to CICS.
Usage
zowe cics define program <programName> <csdGroup> [options]
Positional Arguments
-
programName (string)
- The name of the new program to define. The maximum length of the program name is eight characters.
-
csdGroup (string)
- The CICS system definition (CSD) Group for the new program that you want to define. The maximum length of the group name is eight characters.
Options
-
--region-name (string)
- The CICS region name to which to define the new program
-
--cics-plex (string)
- The name of the CICSPlex to which to define the new program
Cics Connection Options
Profile Options
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
Define a new transaction to CICS.
Usage
zowe cics define transaction <transactionName> <programName> <csdGroup> [options]
Positional Arguments
-
transactionName (string)
- The name of the new transaction to define. The maximum length of the transaction name is four characters.
-
programName (string)
- The name of the program that the transaction uses. The maximum length of the program name is eight characters.
-
csdGroup (string)
- The CICS system definition (CSD) Group for the new transaction that you want to define. The maximum length of the group name is eight characters.
Options
-
--region-name (string)
- The CICS region name to which to define the new transaction
-
--cics-plex (string)
- The name of the CICSPlex to which to define the new transaction
Cics Connection Options
Profile Options
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
Define a new URIMAP of type client to CICS. This acts as an HTTP(S) client
Usage
zowe cics define urimap-client <urimapName> <csdGroup> [options]
Positional Arguments
-
urimapName (string)
- The name of the URIMAP to create. The maximum length of the urimap name is eight characters.
-
csdGroup (string)
- The CICS system definition (CSD) Group for the new urimap that you want to define. The maximum length of the group name is eight characters.
Required Options
Options
-
--urimap-scheme | --us (string)
-
The scheme component to be used with the request (http or https).
Default value: https
Allowed values: http, https
-
--authenticate | --auth (string)
-
The authentication and identification scheme to be used for client URIMAPs.
Allowed values: NO, BASIC
-
--certificate | --cert (string)
- The label of a certificate in the keyring that is to be used as the client certificate in SSL handshakes
-
--description | --desc (string)
- Description of the URIMAP resource being defined.
-
--region-name (string)
- The CICS region name to which to define the new URIMAP.
-
--cics-plex (string)
- The name of the CICSPlex to which to define the new URIMAP.
-
--enable (boolean)
Cics Connection Options
Profile Options
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
Define a new URIMAP of type pipeline to CICS. This processes incoming HTTP(S) requests
Usage
zowe cics define urimap-pipeline <urimapName> <csdGroup> [options]
Positional Arguments
-
urimapName (string)
- The name of the URIMAP to create. The maximum length of the urimap name is eight characters.
-
csdGroup (string)
- The CICS system definition (CSD) Group for the new urimap that you want to define. The maximum length of the group name is eight characters.
Required Options
-
--urimap-path | --up (string)
- The path component of the URI.
-
--urimap-host | --uh (string)
- The host component of the URI.
-
--pipeline-name | --pn (string)
- The name of the PIPELINE resource definition for the URIMAP. The maximum length of the pipeline name is eight characters.
Options
-
--urimap-scheme | --us (string)
-
The scheme component to be used with the request (http or https).
Default value: https
Allowed values: http, https
-
--description | --desc (string)
- Description of the URIMAP resource being defined.
-
--transaction-name | --tn (string)
- The name of the TRANSACTION resource definition for the URIMAP. The maximum length of the transaction name is four characters.
-
--webservice-name | --wn (string)
- The name of the WEBSERVICE resource definition for the URIMAP. The maximum length of the transaction name is 32 characters.
-
--tcpipservice | --tcpip (string)
- The TCPIPSERVICE to which the URIMAP definition applies.
-
--region-name (string)
- The CICS region name to which to define the new URIMAP.
-
--cics-plex (string)
- The name of the CICSPlex to which to define the new URIMAP.
-
--enable (boolean)
Cics Connection Options
Profile Options
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
Define a new URIMAP of type server to CICS. This acts as an HTTP(S) server
Usage
zowe cics define urimap-server <urimapName> <csdGroup> [options]
Positional Arguments
-
urimapName (string)
- The name of the URIMAP to create. The maximum length of the urimap name is eight characters.
-
csdGroup (string)
- The CICS system definition (CSD) Group for the new urimap that you want to define. The maximum length of the group name is eight characters.
Required Options
-
--urimap-path | --up (string)
- The path component of the URI.
-
--urimap-host | --uh (string)
- The host component of the URI.
-
--program-name | --pn (string)
- The application program that makes or handles the requests.
Options
-
--urimap-scheme | --us (string)
-
The scheme component to be used with the request (http or https).
Default value: https
Allowed values: http, https
-
--description | --desc (string)
- Description of the URIMAP resource being defined.
-
--tcpipservice | --tcpip (string)
- The TCPIPSERVICE to which the URIMAP definition applies.
-
--region-name (string)
- The CICS region name to which to define the new URIMAP.
-
--cics-plex (string)
- The name of the CICSPlex to which to define the new URIMAP.
-
--enable (boolean)
Cics Connection Options
Profile Options
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
Define a new web service to CICS.
Usage
zowe cics define webservice <webserviceName> <csdGroup> [options]
Positional Arguments
-
webserviceName (string)
- The name of the WEBSERVICE to create. The maximum length of the web service name is eight characters.
-
csdGroup (string)
- The CICS system definition (CSD) Group for the new web service that you want to define. The maximum length of the group name is eight characters.
Required Options
Options
Cics Connection Options
Profile Options
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
Delete resources (for example, programs) from CICS through IBM CMCI.
Delete a program from CICS.
Usage
zowe cics delete program <programName> <csdGroup> [options]
Positional Arguments
-
programName (string)
- The name of the program to delete. The maximum length of the program name is eight characters.
-
csdGroup (string)
- The CICS system definition (CSD) Group for the program that you want to delete. The maximum length of the group name is eight characters.
Options
-
--region-name (string)
- The CICS region name from which to delete the program
-
--cics-plex (string)
- The name of the CICSPlex from which to delete the program
Cics Connection Options
Profile Options
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
Delete a transaction from CICS.
Usage
zowe cics delete transaction <transactionName> <csdGroup> [options]
Positional Arguments
-
transactionName (string)
- The name of the transaction to delete. The maximum length of the transaction name is four characters.
-
csdGroup (string)
- The CICS system definition (CSD) Group for the transaction that you want to delete. The maximum length of the group name is eight characters.
Options
-
--region-name (string)
- The CICS region name from which to delete the transaction
-
--cics-plex (string)
- The name of the CICSPlex from which to delete the transaction
Cics Connection Options
Profile Options
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
Delete a urimap from CICS.
Usage
zowe cics delete urimap <urimapName> <csdGroup> [options]
Positional Arguments
-
urimapName (string)
- The name of the urimap to delete. The maximum length of the urimap name is eight characters.
-
csdGroup (string)
- The CICS system definition (CSD) Group for the urimap that you want to delete. The maximum length of the group name is eight characters.
Options
-
--region-name (string)
- The CICS region name from which to delete the urimap
Cics Connection Options
Profile Options
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
Delete a web service from CICS.
Usage
zowe cics delete webservice <webserviceName> <csdGroup> [options]
Positional Arguments
-
webserviceName (string)
- The name of the web service to delete. The maximum length of the web service name is eight characters.
-
csdGroup (string)
- The CICS system definition (CSD) Group for the web service that you want to delete. The maximum length of the group name is eight characters.
Options
-
--region-name (string)
- The CICS region name from which to delete the web service
Cics Connection Options
Profile Options
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
Disable resources (for example, urimaps) from CICS through IBM CMCI.
Disable a urimap from CICS.
Usage
zowe cics disable urimap <urimapName> [options]
Positional Arguments
-
urimapName (string)
- The name of the urimap to disable. The maximum length of the urimap name is eight characters.
Options
-
--region-name (string)
- The CICS region name in which to disable the urimap
Cics Connection Options
Profile Options
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
Discard resources (for example, programs) from CICS through IBM CMCI.
Discard a program from CICS.
Usage
zowe cics discard program <programName> [options]
Positional Arguments
-
programName (string)
- The name of the program to discard. The maximum length of the program name is eight characters.
Options
-
--region-name (string)
- The CICS region name from which to discard the program
-
--cics-plex (string)
- The name of the CICSPlex from which to discard the program
Cics Connection Options
Profile Options
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
Discard a transaction from CICS.
Usage
zowe cics discard transaction <transactionName> [options]
Positional Arguments
-
transactionName (string)
- The name of the transaction to discard. The maximum length of the transaction name is four characters.
Options
-
--region-name (string)
- The CICS region name from which to discard the transaction
-
--cics-plex (string)
- The name of the CICSPlex from which to discard the transaction
Cics Connection Options
Profile Options
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
Discard a urimap from CICS.
Usage
zowe cics discard urimap <urimapName> [options]
Positional Arguments
-
urimapName (string)
- The name of the urimap to discard. The maximum length of the urimap name is eight characters.
Options
-
--region-name (string)
- The CICS region name from which to discard the urimap
Cics Connection Options
Profile Options
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
Enable resources (for example, urimaps) from CICS through IBM CMCI.
Enable a urimap from CICS.
Usage
zowe cics enable urimap <urimapName> [options]
Positional Arguments
-
urimapName (string)
- The name of the urimap to enable. The maximum length of the urimap name is eight characters.
Options
-
--region-name (string)
- The CICS region name in which to enable the urimap
Cics Connection Options
Profile Options
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
Get resources (for example, programs or transactions) from CICS through IBM CMCI.
Get resources (for example, programs or transactions) from CICS.
Usage
zowe cics get resource <resourceName> [options]
Positional Arguments
-
resourceName (string)
- The name of the resource to get.
Options
-
--region-name | --rn (string)
- The CICS region name from which to get the resources
-
--cics-plex | --cp (string)
- The name of the CICSPlex from which to get the resources
-
--criteria | -c (string)
- The criteria by which to filter the resource
-
--parameter | -p (string)
- The parameter by which to refine the resource
Cics Connection Options
Profile Options
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Response Format Options
-
--response-format-filter | --rff (array)
- Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
-
--response-format-type | --rft (string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.
list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.
object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header | --rfh (boolean)
- If "--response-format-type table" is specified, include the column headers in the output.
Examples
-
Get program resources from the region named MYREGION:
zowe cics get resource CICSProgram --region-name MYREGION
-
Get local transaction resources from the region named MYREGION:
zowe cics get resource CICSLocalTransaction --region-name MYREGION
-
Get local file resources from the region named MYREGION:
zowe cics get resource CICSLocalFile --region-name MYREGION
-
Get program definition resources from the CSD group named GRP1 and the region named MYREGION:
zowe cics get resource CICSDefinitionProgram --region-name MYREGION --parameter "CSDGROUP(GRP1)"
-
Get transaction definition resources from the CSD group named GRP1 and the region named MYREGION:
zowe cics get resource CICSDefinitionTransaction --region-name MYREGION --parameter "CSDGROUP(GRP1)"
-
Get URIMap definition resources from the CSD group named GRP1 and the region named MYREGION:
zowe cics get resource CICSDefinitionURIMap --region-name MYREGION --parameter "CSDGROUP(GRP1)"
-
Get program resources that start with the name PRG from the region named MYREGION:
zowe cics get resource CICSProgram --region-name MYREGION --criteria "PROGRAM=PRG*"
-
Get a local transaction resource named TRAN from the region named MYREGION:
zowe cics get resource CICSLocalTransaction --region-name MYREGION --criteria "TRANID=TRAN"
-
Get program resources that start with the name MYPRG from the region named MYREGION and display various fields as a table:
zowe cics get resource CICSProgram --region-name MYREGION --criteria "PROGRAM=MYPRG*" --rft table --rfh --rff program length status
Install resources (for example, programs) to CICS through IBM CMCI.
Install a program to CICS.
Usage
zowe cics install program <programName> <csdGroup> [options]
Positional Arguments
-
programName (string)
- The name of the program to install. The maximum length of the program name is eight characters.
-
csdGroup (string)
- The CICS system definition (CSD) Group for the program that you want to install. The maximum length of the group name is eight characters.
Options
-
--region-name (string)
- The CICS region name to which to install the program
-
--cics-plex (string)
- The name of the CICSPlex to which to install the program
Cics Connection Options
Profile Options
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
Install a transaction to CICS.
Usage
zowe cics install transaction <transactionName> <csdGroup> [options]
Positional Arguments
-
transactionName (string)
- The name of the transaction to install. The maximum length of the transaction name is four characters.
-
csdGroup (string)
- The CICS system definition (CSD) Group for the transaction that you want to install. The maximum length of the group name is eight characters.
Options
-
--region-name (string)
- The CICS region name to which to install the transaction
-
--cics-plex (string)
- The name of the CICSPlex to which to install the transaction
Cics Connection Options
Profile Options
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
Install a urimap to CICS.
Usage
zowe cics install urimap <urimapName> <csdGroup> [options]
Positional Arguments
-
urimapName (string)
- The name of the urimap to install. The maximum length of the urimap name is eight characters.
-
csdGroup (string)
- The CICS system definition (CSD) Group for the urimap that you want to install. The maximum length of the group name is eight characters.
Options
-
--region-name (string)
- The CICS region name to which to install the urimap
Cics Connection Options
Profile Options
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
Refresh a program on CICS through IBM CMCI.
Refresh a program on CICS.
Usage
zowe cics refresh program <programName> [options]
Positional Arguments
-
programName (string)
- The name of the program to refresh. The maximum length of the program name is eight characters.
Options
-
--region-name (string)
- The CICS region name on which you want to refresh the program
-
--cics-plex (string)
- The name of the CICSPlex on which to refresh the program
Cics Connection Options
Profile Options
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
Remove resources (for example, CSD Groups in CSD Lists) from CICS through IBM CMCI.
Remove a CSD Group from a CICS CSD List.
Usage
zowe cics remove-from-list csdGroup <name> <csdList> [options]
Positional Arguments
-
name (string)
- The name of the CSD Group to remove. The maximum length of the CSD Group name is eight characters
-
csdList (string)
- The name of the CSD List to remove the group from. The maximum length of the CSD List name is eight characters
Options
-
--region-name (string)
- The CICS region name to which to remove the CSD Group from the CSD List
-
--cics-plex (string)
- The name of the CICSPlex to which to remove the CSD Group from the CSD List
Cics Connection Options
Profile Options
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
Manage JSON project and global configuration.
Automatically generate a config from APIML.
Usage
zowe config auto-init [options]
Automatic Config Initialization Options
-
--user-config | --uc (boolean)
-
--global-config | --gc (boolean)
-
--dry-run | --dr | --dry (boolean)
- Display the outcome of the initialization without saving
-
--edit | -e (boolean)
- Open in editor after initializing the configuration
-
--overwrite | --ow (boolean)
-
--for-sure | -f (boolean)
Options
-
--editor | --ed (string)
- Editor that overrides the default editor for this file type. Set the option to the editor's executable file location or the program's name: ie "--editor notepad"
APIML Connection Options
-
--host | -H (string)
- Host name of the mainframe running the API Mediation Layer.
-
--port | -P (number)
- Port number of API Mediation Layer on the mainframe.
-
--user | -u (string)
- User name to authenticate to the API Mediation Layer on the mainframe.
-
--password | --pass | --pw (string)
- Password to authenticate to the API Mediation Layer on the mainframe.
-
--reject-unauthorized | --ru (boolean)
-
--token-type | --tt (string)
- The type of token to get and use for the API Mediation Layer. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API Mediation Layer.
-
--cert-file (local file path)
- The file path to a certificate file to use to authenticate to the API Mediation Layer
-
--cert-key-file (local file path)
- The file path to a certificate key file to use to authenticate to the API Mediation Layer
Profile Options
Convert v1 profiles to a global zowe.config.json file.
Usage
zowe config convert-profiles [options]
Options
-
--prompt (boolean)
-
--delete (boolean)
- Delete the existing profiles on disk and any securely stored secrets.
Examples
Edit an existing config file in your system's default text editor.
In a graphical environment, the application associated with JSON files will be launched. In a command-line environment, vi will be launched. To override the command-line editor used, specify it with the --editor option.
Usage
zowe config edit [options]
Options
Examples
-
Edit global config file:
zowe config edit --global-config
Import config files from another location on disk or from an Internet URL.
If the config `$schema` property points to a relative path, the schema will also be imported.
Usage
zowe config import <location> [options]
Positional Arguments
-
location (string)
- File path or URL to import from.
Options
-
--global-config | --gc (boolean)
-
--user-config | --uc (boolean)
-
--overwrite | --ow (boolean)
Connection Options
Examples
Initialize config files. Defaults to initializing "zowe.config.json" in the current working directory unless otherwise specified.
Use "--user-config" to init "zowe.config.user.json". Use "--global-config" to initialize the configuration files in your home "~/.zowe" directory.
Use "--no-prompt" to skip prompting for values in a CI environment.
Usage
zowe config init [options]
Options
-
--global-config | --gc (boolean)
-
--user-config | --uc (boolean)
-
--prompt (boolean)
-
--overwrite | --ow (boolean)
- Replace existing config files instead of merging the new changes.
-
--for-sure | --fs (boolean)
-
--dry-run | --dr | --dry (boolean)
- Display the outcome of the initialization without saving it.
-
--edit | -e (boolean)
- Open in editor after initializing the configuration.
-
--editor | --ed (string)
- Editor that overrides the default editor for this file type. Set the option to the editor's executable file location or the program's name: ie "--editor notepad".
Examples
-
Initialize configuration files in your home "~/.zowe" directory:
zowe config init --global-config
-
Do a dry run of initializing configuration files in your home "~/.zowe" directory:
zowe config init --global-config --dry-run
-
Initialize the user config files:
zowe config init --user-config
-
Initialize the user config files and do not prompt for secure values:
zowe config init --user-config --prompt false
-
Do a dry run of initializing the user config files and do not prompt for secure values:
zowe config init --user-config --prompt false --dry-run
-
Overwrite any existing global config files:
zowe config init --global-config --overwrite --for-sure
-
Overwrite any existing user config files:
zowe config init --user-config --overwrite --for-sure
List config properties.
Usage
zowe config list [property] [options]
Positional Arguments
-
property (string)
- The config property to list. Blank to list all properties.
Options
Examples
-
List property names for a specified config property:
zowe config list "defaults"
-
List only root level property names for a specified config property:
zowe config list "defaults" --name-only
-
List config properties by separating them by their respective config file locations:
zowe config list --locations
-
List only the root level configuration property names:
zowe config list --name-only
-
List only the root level configuration property names by separating them by their respective config file locations:
zowe config list --locations --name-only
Displays profile paths.
Usage
zowe config profiles [options]
Examples
-
Display profile paths:
zowe config profiles
Reports key items from your environment and identifies problem conditions.
Usage
zowe config report-env [options]
Examples
Dumps the JSON schema for the config. The schema is dynamically created based on your available plugins. Direct the output of this command to a file and include in your config with '$schema' property to get editor completion.
Usage
zowe config schema [options]
Examples
Prompt for secure configuration properties.
Usage
zowe config secure [options]
Options
-
--global-config | --gc (boolean)
-
--user-config | --uc (boolean)
-
--prune | -p (boolean)
-
--profile | --pf (string)
- Specify the profile for which you want to configure secure values.
Examples
Create or update a configuration property.
Usage
zowe config set <property> [value] [options]
Positional Arguments
-
property (string)
- The property to set. You may specify a path using dot notation (e.g. profiles.host1.profiles.service1.properties.setting).
-
value (string)
- The property value to set. The value may be JSON. Use '--json' to indicate.
Options
Examples
-
Set the property in global config:
zowe config set "profiles.host1.profiles.service1.properties.setting" "value" --global-config
-
Set the property in user config:
zowe config set "profiles.host1.profiles.service2.properties.setting" "value" --user-config
-
Set property value to JSON:
zowe config set "profiles.host1.profiles.service3.properties.setting" "{"property":"value"}" --json
-
Store the property value:
zowe config set "profiles.host1.profiles.service1.properties.setting" "value" --secure
-
Set a default zosmf profile:
zowe config set "defaults.zosmf" "zosmfProfileName"
-
Set a default tso profile:
zowe config set "defaults.tso" "tsoProfileName"
Update schema files by looking up the directory structure.
Schema files up in higher level directories will always be updated. To also update schema files down in lower level directories, specify the `--depth` flag.
Usage
zowe config update-schemas [options]
Options
Examples
Perform operations that control the daemon-mode functionality of the Zowe CLI. Daemon-mode runs the CLI command processor as a daemon to improve performance.
Disable daemon-mode operation of the Zowe CLI.
Usage
zowe daemon disable [options]
Examples
Enable daemon-mode operation of the Zowe CLI. You only need to run the enable command once after each new installation of the Zowe CLI. Afterwards, any zowe command will automatically start a daemon as needed.
Usage
zowe daemon enable [options]
Examples
Restart the Zowe CLI daemon.
Usage
zowe daemon restart [options]
Examples
Interact with IBM Db2 for z/OS
Call a Db2 stored procedure
Call a Db2 stored procedure. Specify the stored procedure name and optionally provide values.
Usage
zowe db2 call procedure <routine> [options]
Positional Arguments
-
routine (string)
- The name of a Db2 stored procedure
Options
DB2 Connection Options
-
--host | -H (string)
-
--port | -P (number)
- The Db2 server port number
-
--user | -u (string)
- The Db2 user ID (may be the same as the TSO login)
-
--password | --pass | --pw (string)
- The Db2 password (may be the same as the TSO password)
-
--database | --db (string)
-
--sslFile | --ssl (string)
- Path to an SSL Certificate file
Profile Options
Base Connection Options
-
--reject-unauthorized | --ru (boolean)
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Call stored procedure DEMO.SP1:
zowe db2 call procedure "DEMO.SP1"
-
Call a stored procedure and pass values for parameter indicators:
zowe db2 call procedure "DEMO.SP2(?, ?)" --parameters "Hello" "world!"
-
Call a stored procedure and pass values for two output parameters. The first output requires a 2-character buffer. The second output is a message that will be truncated to the length of the placeholder.:
zowe db2 call procedure "DEMO.SP3(NULL, ?, ?)" --parameters "00" "message_placeholder_message_placeholder"
Execute SQL queries against a Db2 region and retrieve the response. Enclose the query in quotes and escape any symbols that have a special meaning to the shell.
Execute one or multiple SQL statements separated by a semicolon from a command line or from a file.
Usage
zowe db2 execute sql [options]
Options
-
--query | -q (string)
- The SQL statement verbatim to execute
-
--file | -f (string)
- A local file containing the SQL statements to execute
DB2 Connection Options
-
--host | -H (string)
-
--port | -P (number)
- The Db2 server port number
-
--user | -u (string)
- The Db2 user ID (may be the same as the TSO login)
-
--password | --pass | --pw (string)
- The Db2 password (may be the same as the TSO password)
-
--database | --db (string)
-
--sslFile | --ssl (string)
- Path to an SSL Certificate file
Profile Options
Base Connection Options
-
--reject-unauthorized | --ru (boolean)
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Execute a dummy SQL query:
zowe db2 execute sql --query "SELECT 'Hello World' FROM SYSIBM.SYSDUMMY1"
-
Retrieve the employees table and total number of rows:
zowe db2 execute sql -q "SELECT * FROM SAMPLE.EMP; SELECT COUNT(*) AS TOTAL FROM SAMPLE.EMP"
-
Execute a file with SQL statements:
zowe db2 execute sql --file backup_sample_database.sql
Export data from a Db2 table
Export a Db2 table to the stdout or a file.
Usage
zowe db2 export table <table> [options]
Positional Arguments
-
table (string)
- The name of the table to export
Options
DB2 Connection Options
-
--host | -H (string)
-
--port | -P (number)
- The Db2 server port number
-
--user | -u (string)
- The Db2 user ID (may be the same as the TSO login)
-
--password | --pass | --pw (string)
- The Db2 password (may be the same as the TSO password)
-
--database | --db (string)
-
--sslFile | --ssl (string)
- Path to an SSL Certificate file
Profile Options
Base Connection Options
-
--reject-unauthorized | --ru (boolean)
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
DBM-Db2 plug-in to interact with Db2 using the Broadcom Database Management Solutions for Db2 for z/OS.
For details about command usage for automation, see DBM-Db2 samples at https://github.com/BroadcomMFD/dbm\-db2\-for\-zowe\-cli
Perform DDL syntax checking.
Validate the syntax of input DDL and optionally verify Db2 object dependencies. Use this command to ensure that the syntax of the input DDL is valid. You can also optionally verify that the objects to be created do not exist on the Db2 subsystem and that the related objects that are required for successful creation of the objects exist on the Db2 subsystem or in the input DDL. You can generate input DDL using the 'zowe dbm generate ddl' command.
For details about command usage for automation, see DBM-Db2 samples at https://github.com/BroadcomMFD/dbm\-db2\-for\-zowe\-cli
Usage
zowe dbm-db2 check ddl <local-input-ddl-filename> [options]
Positional Arguments
Required Options
Options
Profile Options
-
--dbm-db2-options-profile | --dbm-db2-options-p (string)
- The name of a (dbm-db2-options) profile to load for this command execution.
-
--dbm-db2-profile | --dbm-db2-p (string)
- The name of a (dbm-db2) profile to load for this command execution.
-
--base-profile | --base-p (string)
- The name of a (base) profile to load for this command execution.
DBM-Db2 Connection Options
-
--protocol (string)
-
Specifies the communication protocol between zowe dbm-db2 client and DBM Data Service.
Allowed values: http, https
-
--environment-list | --el (string)
- Specifies a string of one or more entries consisting of a Db2 subsystem ID and a DBM Data Service REST API server host name or TCP/IP address. Use a comma to separate entries. The same Db2 subsystem can be used in multiple DBM Data Service environments. For more information about configuring the DBM Data Service, see the Database Management Solutions for Db2 for z/OS documentation at https://techdocs.broadcom.com/db2mgmt
-
--job-cards | --jc (array)
- Specifies a string array of z/OS JCL JOB statements.
-
--work-dataset-prefix | --wdp (string)
- Specifies the prefix (high-level qualifier) in z/OS work data set names.
-
--delete-work-datasets | --dwd (boolean)
- Specifies whether to delete work data sets on a mainframe after the request is fulfilled.
-
--overwrite-output-files | --oof (boolean)
- Specifies whether to overwrite output files if they exist.
-
--authid | -a (string)
- Specifies the primary Db2 authorization ID that is used to establish a connection between Db2 and a process.
-
--sqlid | -s (string)
- Specifies the authorization ID that is used in generated SET CURRENT SQLID statements.
-
--base-path | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all DBM DS resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
Base Connection Options
-
--host | -H (string)
- Host name of service on the mainframe.
-
--port | -P (number)
- Port number of service on the mainframe.
-
--user | -u (string)
- User name to authenticate to service on the mainframe.
-
--password | --pass | --pw (string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized | --ru (boolean)
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
Compare DDL with a Db2 subsystem and produce an update script to implement changes.
Compare objects that are defined in a DDL file to objects that are defined on a Db2 subsystem and generate an update script to implement the necessary object changes. This command also generates a high-level change summary report and a parseable impact analysis report. You can execute the script that is generated from this command using the 'zowe dbm execute compare-script' command.
For details about command usage for automation, see DBM-Db2 samples at https://github.com/BroadcomMFD/dbm\-db2\-for\-zowe\-cli
Usage
zowe dbm-db2 compare ddl <local-input-ddl-filename> [options]
Positional Arguments
Required Options
Options
-
--match-set | --ms (string)
-
Specifies the creator and name of an existing RC/Migrator automapping mask set. Matching is used to pair objects in a DDL file to objects that are defined on a Db2 subsystem. Matching determines whether the 'change-set' or 'rule-set' options are applied.
Format:
<match-set-creator.match-set-name>
For more information about mask services, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig
Note: If --match-set and --match-set-file are both specified, specifications in match-set-file take precedence.
-
--match-set-file | --msf (string)
-
Specifies the name of the local input file that contains the mapping mask specifications. Matching is used to pair objects in a DDL file to objects that are defined on a Db2 subsystem. For example, a mask specification can account for different schema naming patterns across environments. Matching determines whether the 'change-set' or 'rule-set' options are applied.
Format:
<object-type> <source-name-mask> <target-name-mask>;
STOGROUP <name> <name>
DATABASE <name> <name>
TABLESPACE <database.name> <database.name>
TABLE <schema.name> <schema.name>
INDEX <schema.name> <schema.name>
VIEW <schema.name> <schema.name>
SYNONYM <schema.name> <schema.name>
ALIAS <schema.name> <schema.name>
TRIGGER <schema.name> <schema.name>
SEQUENCE <schema.name> <schema.name>
FUNCTION <schema.name[.version]> <schema.name[.version]>
PROCEDURE <schema.name[.version]> <schema.name[.version]>
Note:
- <name> must be between 1 and 128 characters. For DATABASE and TABLESPACE, <name> must be between 1 and 8 characters.
- <schema> must be between 1 and 128 characters.
- <version> must be between 1 and 64 characters.
A mask specification can include the following wildcard characters:
Percent sign (%) indicates that zero or more characters can occupy that position and all remaining positions to the end of the name, or to the next character. The percent sign can be used anywhere in the name. However, the source and target characters must match exactly.
Hyphen or dash (-) indicates that any character can occupy that position, but a character must exist at that position, and the source and target character must match exactly. The hyphen can be repeated in several places in the name.
Asterisk (*) indicates matching values. An asterisk cannot be used with other characters.
Use a semicolon to separate mask specifications. Multiple mask specifications for the same object type are supported.
Example:
The following example demonstrates different ways of matching the table MYNAME.MYTABLE to the table YOURNAME.YOURTABLE:
TABLE MY%.%TABLE YOUR%.%TABLE;
TABLE MYN-M-.MYT% YOURN-M-.YOURT%;
TABLE MYNAME.MYTABLE YOURNAME.YOURTABLE;
TABLE *.MYTABLE *.YOURTABLE;
For a list of mask specifications, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig
Note:
- If --match-set and --match-set-file are both specified, specifications in match-set-file take precedence.
- The matchSetValues options-profile option has the same behavior as the match-set-file command option.
-
--change-set | --cs (string)
-
Specifies the creator and name of an existing RC/Migrator global change set that changes Db2 objects during a command execution.
Format:
<change-set-creator.change-set-name>
For more information about global change services, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig
Note: If change-set and change-set-file are both specified, specifications in change-set-file take precedence.
-
--change-set-file | --csf (string)
-
Specifies the name of the local input file that contains the global change specifications that modify attributes of Db2 objects. Depending on the backend configuration, the changes apply to either ALL objects in the DDL or to NEW objects only as determined by match-set processing.
Format:
<object-attribute> <from-value> <to-value>
The <object-attribute> consists of four characters. The first two characters identify the object type. The last two characters identify the specific attribute. Wildcard characters are supported in <from-value> and <to-value>. If the same <object-attribute> is specified multiple times, the first occurrence takes precedence.
Example:
The following example demonstrates changes to the table schema (creator) and tablespace names:
TBCR TEST% PROD%
TBTS TESTTS% PRODTS%
For more information about global change services, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig
Note:
- If change-set and change-set-file are both specified, specifications in change-set-file take precedence.
- The changeSetValues options-profile option has the same behavior as the change-set-file command option.
-
--rule-set | --rs (string)
-
Specifies the creator and name of an existing RC/Migrator rule set that overrides Db2 object attributes in the target Db2 subsystem with the corresponding values from the input DDL file. The changes only apply to existing objects, as determined by match-set processing.
Format:
<rule-set-creator.rule-set-name>
For more information about rule database services, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig
-
--id (string)
-
Specifies the 1- to 8-character name of the RC/Migrator compare strategy that is created on the target Db2 subsystem during a command execution.
Format: The name must begin with a non-numeric character and contain the following characters only: uppercase letters from A to Z, numbers from 0 to 9, and special characters $, #, and @.
-
--description | -d (string)
- Specifies a 1- to 25-character description for the RC/Migrator compare strategy.
-
--output-compare-script | --ocs (string)
-
--output-summary-file | --osf (string)
-
Specifies the name of the local output file that contains the change summary report in text format. This report tracks changes to Db2 objects on the target Db2 subsystem, but it does not describe how changes are made.
Default value: summary.txt
-
--output-impact-file | --oif (string)
-
Specifies the name of the local output file that contains the parseable impact analysis report in JSON or YAML format. This report identifies the significant DDL operations that are performed on Db2 objects. The report provides the total number and type of DDL operations that are performed on each object type, the list of DDL operations performed on each object instance, and the state of any pending changes.
To determine the report format, supply one of the following extensions in the file name:
- .json for JSON
- .yaml or .yml for YAML
If no extension is provided, the format is set to JSON.
Default value: impact.json
For more information about the impact analysis report, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig
-
--error-file | --ef (string)
-
Specifies the local output error file in YAML format. The file contains basic execution information, connection details, dbm-db2 profile parameters, used arguments, and errors that occurred during execution of the command.
Default value: error.log
-
--modification | -m (string)
-
Specifies a named set of server-managed default parameter values that control the execution behavior of the zowe dbm-db2 commands. For example, you can use a modification to identify a set of default values that differ from the current set of default values.
For more information about using the modification option, see the DBM Data Service documentation at https://techdocs.broadcom.com/db2mgmt
Profile Options
-
--dbm-db2-options-profile | --dbm-db2-options-p (string)
- The name of a (dbm-db2-options) profile to load for this command execution.
-
--dbm-db2-profile | --dbm-db2-p (string)
- The name of a (dbm-db2) profile to load for this command execution.
-
--base-profile | --base-p (string)
- The name of a (base) profile to load for this command execution.
DBM-Db2 Connection Options
-
--protocol (string)
-
Specifies the communication protocol between zowe dbm-db2 client and DBM Data Service.
Allowed values: http, https
-
--environment-list | --el (string)
- Specifies a string of one or more entries consisting of a Db2 subsystem ID and a DBM Data Service REST API server host name or TCP/IP address. Use a comma to separate entries. The same Db2 subsystem can be used in multiple DBM Data Service environments. For more information about configuring the DBM Data Service, see the Database Management Solutions for Db2 for z/OS documentation at https://techdocs.broadcom.com/db2mgmt
-
--job-cards | --jc (array)
- Specifies a string array of z/OS JCL JOB statements.
-
--work-dataset-prefix | --wdp (string)
- Specifies the prefix (high-level qualifier) in z/OS work data set names.
-
--delete-work-datasets | --dwd (boolean)
- Specifies whether to delete work data sets on a mainframe after the request is fulfilled.
-
--overwrite-output-files | --oof (boolean)
- Specifies whether to overwrite output files if they exist.
-
--authid | -a (string)
- Specifies the primary Db2 authorization ID that is used to establish a connection between Db2 and a process.
-
--sqlid | -s (string)
- Specifies the authorization ID that is used in generated SET CURRENT SQLID statements.
-
--termination-character | --tc (string)
- Specifies the SQL termination character to use in DDL generation when the default termination character conflicts with the SQL statements that are used in triggers, XML indexes, and routines (external SQL functions and native SQL stored procedures). The default termination character is a semi-colon (;). You cannot specify a comma, double quote, single quote, left or right parentheses, or an underscore.
-
--base-path | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all DBM DS resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
Base Connection Options
-
--host | -H (string)
- Host name of service on the mainframe.
-
--port | -P (number)
- Port number of service on the mainframe.
-
--user | -u (string)
- User name to authenticate to service on the mainframe.
-
--password | --pass | --pw (string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized | --ru (boolean)
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Generate a script to update objects on the 'TEST' Db2 subsystem with DDL definitions in myddl.sql file:
zowe dbm-db2 compare ddl myddl.sql --target-db2 TEST
-
Generate a script to update objects and apply a rule set for the matched objects:
zowe dbm-db2 compare ddl myddl.sql --target-db2 TEST --rule-set USER1.RULESET
-
Generate a script to update objects and apply a rule set for the objects matched as determined by the local mask specifications in the pair.txt file:
zowe dbm-db2 compare ddl myddl.sql --target-db2 TEST --rule-set USER1.RULESET --match-set-file pair.txt
Deploy DDL statements to a Db2 subsystem.
Deploy Db2 object changes on the target Db2 subsystem using an input file that contains the DDL. For example, an application developer has made changes to DDL in a local file and is ready to test the DDL changes. Use this command to deploy the changes to the test environment.
For details about command usage for automation, see DBM-Db2 samples at https://github.com/BroadcomMFD/dbm\-db2\-for\-zowe\-cli
Usage
zowe dbm-db2 deploy ddl <local-input-ddl-filename> [options]
Positional Arguments
Required Options
Options
-
--match-set | --ms (string)
-
Specifies the creator and name of an existing RC/Migrator automapping mask set. Matching is used to pair objects in a DDL file to objects that are defined on a Db2 subsystem. Matching determines whether the 'change-set' or 'rule-set' options are applied.
Format:
<match-set-creator.match-set-name>
For more information about mask services, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig
Note: If --match-set and --match-set-file are both specified, specifications in match-set-file take precedence.
-
--match-set-file | --msf (string)
-
Specifies the name of the local input file that contains the mapping mask specifications. Matching is used to pair objects in a DDL file to objects that are defined on a Db2 subsystem. For example, a mask specification can account for different schema naming patterns across environments. Matching determines whether the 'change-set' or 'rule-set' options are applied.
Format:
<object-type> <source-name-mask> <target-name-mask>;
STOGROUP <name> <name>
DATABASE <name> <name>
TABLESPACE <database.name> <database.name>
TABLE <schema.name> <schema.name>
INDEX <schema.name> <schema.name>
VIEW <schema.name> <schema.name>
SYNONYM <schema.name> <schema.name>
ALIAS <schema.name> <schema.name>
TRIGGER <schema.name> <schema.name>
SEQUENCE <schema.name> <schema.name>
FUNCTION <schema.name[.version]> <schema.name[.version]>
PROCEDURE <schema.name[.version]> <schema.name[.version]>
Note:
- <name> must be between 1 and 128 characters. For DATABASE and TABLESPACE, <name> must be between 1 and 8 characters.
- <schema> must be between 1 and 128 characters.
- <version> must be between 1 and 64 characters.
A mask specification can include the following wildcard characters:
Percent sign (%) indicates that zero or more characters can occupy that position and all remaining positions to the end of the name, or to the next character. The percent sign can be used anywhere in the name. However, the source and target characters must match exactly.
Hyphen or dash (-) indicates that any character can occupy that position, but a character must exist at that position, and the source and target character must match exactly. The hyphen can be repeated in several places in the name.
Asterisk (*) indicates matching values. An asterisk cannot be used with other characters.
Use a semicolon to separate mask specifications. Multiple mask specifications for the same object type are supported.
Example:
The following example demonstrates different ways of matching the table MYNAME.MYTABLE to the table YOURNAME.YOURTABLE:
TABLE MY%.%TABLE YOUR%.%TABLE;
TABLE MYN-M-.MYT% YOURN-M-.YOURT%;
TABLE MYNAME.MYTABLE YOURNAME.YOURTABLE;
TABLE *.MYTABLE *.YOURTABLE;
For a list of mask specifications, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig
Note:
- If --match-set and --match-set-file are both specified, specifications in match-set-file take precedence.
- The matchSetValues options-profile option has the same behavior as the match-set-file command option.
-
--change-set | --cs (string)
-
Specifies the creator and name of an existing RC/Migrator global change set that changes Db2 objects during a command execution.
Format:
<change-set-creator.change-set-name>
For more information about global change services, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig
Note: If change-set and change-set-file are both specified, specifications in change-set-file take precedence.
-
--change-set-file | --csf (string)
-
Specifies the name of the local input file that contains the global change specifications that modify attributes of Db2 objects. Depending on the backend configuration, the changes apply to either ALL objects in the DDL or to NEW objects only as determined by match-set processing.
Format:
<object-attribute> <from-value> <to-value>
The <object-attribute> consists of four characters. The first two characters identify the object type. The last two characters identify the specific attribute. Wildcard characters are supported in <from-value> and <to-value>. If the same <object-attribute> is specified multiple times, the first occurrence takes precedence.
Example:
The following example demonstrates changes to the table schema (creator) and tablespace names:
TBCR TEST% PROD%
TBTS TESTTS% PRODTS%
For more information about global change services, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig
Note:
- If change-set and change-set-file are both specified, specifications in change-set-file take precedence.
- The changeSetValues options-profile option has the same behavior as the change-set-file command option.
-
--rule-set | --rs (string)
-
Specifies the creator and name of an existing RC/Migrator rule set that overrides Db2 object attributes in the target Db2 subsystem with the corresponding values from the input DDL file. The changes only apply to existing objects, as determined by match-set processing.
Format:
<rule-set-creator.rule-set-name>
For more information about rule database services, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig
-
--error-file | --ef (string)
-
Specifies the local output error file in YAML format. The file contains basic execution information, connection details, dbm-db2 profile parameters, used arguments, and errors that occurred during execution of the command.
Default value: error.log
-
--modification | -m (string)
-
Specifies a named set of server-managed default parameter values that control the execution behavior of the zowe dbm-db2 commands. For example, you can use a modification to identify a set of default values that differ from the current set of default values.
For more information about using the modification option, see the DBM Data Service documentation at https://techdocs.broadcom.com/db2mgmt
Profile Options
-
--dbm-db2-options-profile | --dbm-db2-options-p (string)
- The name of a (dbm-db2-options) profile to load for this command execution.
-
--dbm-db2-profile | --dbm-db2-p (string)
- The name of a (dbm-db2) profile to load for this command execution.
-
--base-profile | --base-p (string)
- The name of a (base) profile to load for this command execution.
DBM-Db2 Connection Options
-
--protocol (string)
-
Specifies the communication protocol between zowe dbm-db2 client and DBM Data Service.
Allowed values: http, https
-
--environment-list | --el (string)
- Specifies a string of one or more entries consisting of a Db2 subsystem ID and a DBM Data Service REST API server host name or TCP/IP address. Use a comma to separate entries. The same Db2 subsystem can be used in multiple DBM Data Service environments. For more information about configuring the DBM Data Service, see the Database Management Solutions for Db2 for z/OS documentation at https://techdocs.broadcom.com/db2mgmt
-
--job-cards | --jc (array)
- Specifies a string array of z/OS JCL JOB statements.
-
--work-dataset-prefix | --wdp (string)
- Specifies the prefix (high-level qualifier) in z/OS work data set names.
-
--delete-work-datasets | --dwd (boolean)
- Specifies whether to delete work data sets on a mainframe after the request is fulfilled.
-
--overwrite-output-files | --oof (boolean)
- Specifies whether to overwrite output files if they exist.
-
--authid | -a (string)
- Specifies the primary Db2 authorization ID that is used to establish a connection between Db2 and a process.
-
--sqlid | -s (string)
- Specifies the authorization ID that is used in generated SET CURRENT SQLID statements.
-
--termination-character | --tc (string)
- Specifies the SQL termination character to use in DDL generation when the default termination character conflicts with the SQL statements that are used in triggers, XML indexes, and routines (external SQL functions and native SQL stored procedures). The default termination character is a semi-colon (;). You cannot specify a comma, double quote, single quote, left or right parentheses, or an underscore.
-
--base-path | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all DBM DS resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
Base Connection Options
-
--host | -H (string)
- Host name of service on the mainframe.
-
--port | -P (number)
- Port number of service on the mainframe.
-
--user | -u (string)
- User name to authenticate to service on the mainframe.
-
--password | --pass | --pw (string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized | --ru (boolean)
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Update Db2 objects on a target Db2 subsystem according to DDL definitions in myddl.sql file:
zowe dbm-db2 deploy ddl myddl.sql --target-db2 TEST
-
Update Db2 objects according to the input DDL definitions and applied rule set for the matched objects:
zowe dbm-db2 deploy ddl myddl.sql --target-db2 TEST --rule-set USER1.RULESET
-
Update Db2 objects according to the input DDL definitions and applied rule set for the objects matched as determined by the local mask specifications in the pair.txt file:
zowe dbm-db2 deploy ddl myddl.sql --target-db2 TEST --rule-set USER1.RULESET --match-set-file pair.txt
Execute a script to implement Db2 object changes.
Execute the compare script that was generated with the 'zowe dbm compare ddl' command to implement the Db2 object changes on the Db2 subsystem specified within the script. This command also generates a recovery script to undo compare script changes.
For details about command usage for automation, see DBM-Db2 samples at https://github.com/BroadcomMFD/dbm\-db2\-for\-zowe\-cli
Usage
zowe dbm-db2 execute compare-script <local-input-compare-script-filename> [options]
Positional Arguments
Options
-
--output-recovery-script | --ors | --output-recovery-file | --orf (string)
-
Specifies the local output file name that contains the recovery script that is generated during execution of this command. Executing the recovery script using the 'zowe dbm execute script' command undoes the changes that were made by execution of the compare-script.
Default value: recovery.txt
-
--restart | -r (string)
-
Specifies the location in the script where you want to restart execution. The effects of previous successful script statement executions remain.
The following restart options are valid:
new - Restart execution of the script at the first statement.
token - Restart execution of the script at the location that is recorded in the specified token and that was returned from a previous execution failure.
-
--error-file | --ef (string)
-
Specifies the local output error file in YAML format. The file contains basic execution information, connection details, dbm-db2 profile parameters, used arguments, and errors that occurred during execution of the command.
Default value: error.log
-
--modification | -m (string)
-
Specifies a named set of server-managed default parameter values that control the execution behavior of the zowe dbm-db2 commands. For example, you can use a modification to identify a set of default values that differ from the current set of default values.
For more information about using the modification option, see the DBM Data Service documentation at https://techdocs.broadcom.com/db2mgmt
Profile Options
-
--dbm-db2-options-profile | --dbm-db2-options-p (string)
- The name of a (dbm-db2-options) profile to load for this command execution.
-
--dbm-db2-profile | --dbm-db2-p (string)
- The name of a (dbm-db2) profile to load for this command execution.
-
--base-profile | --base-p (string)
- The name of a (base) profile to load for this command execution.
DBM-Db2 Connection Options
-
--protocol (string)
-
Specifies the communication protocol between zowe dbm-db2 client and DBM Data Service.
Allowed values: http, https
-
--environment-list | --el (string)
- Specifies a string of one or more entries consisting of a Db2 subsystem ID and a DBM Data Service REST API server host name or TCP/IP address. Use a comma to separate entries. The same Db2 subsystem can be used in multiple DBM Data Service environments. For more information about configuring the DBM Data Service, see the Database Management Solutions for Db2 for z/OS documentation at https://techdocs.broadcom.com/db2mgmt
-
--job-cards | --jc (array)
- Specifies a string array of z/OS JCL JOB statements.
-
--work-dataset-prefix | --wdp (string)
- Specifies the prefix (high-level qualifier) in z/OS work data set names.
-
--delete-work-datasets | --dwd (boolean)
- Specifies whether to delete work data sets on a mainframe after the request is fulfilled.
-
--overwrite-output-files | --oof (boolean)
- Specifies whether to overwrite output files if they exist.
-
--base-path | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all DBM DS resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
Base Connection Options
-
--host | -H (string)
- Host name of service on the mainframe.
-
--port | -P (number)
- Port number of service on the mainframe.
-
--user | -u (string)
- User name to authenticate to service on the mainframe.
-
--password | --pass | --pw (string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized | --ru (boolean)
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Execute a compare script:
zowe dbm-db2 execute compare-script compare.txt
-
Restart execution of a compare script at the first statement in the script:
zowe dbm-db2 execute compare-script compare.txt --restart new
-
Restart execution of a compare script at the location in the token:
zowe dbm-db2 execute compare-script compare.txt --restart 78A724GOBLEDYGOOK6FD140F6780D6FA
Execute the migration script that was generated with the 'zowe dbm prepare migration' command to migrate Db2 objects (DDL) and table data from a source subsystem to a target subsystem. The source and target subsystem IDs are specified within the script.
For details about command usage for automation, see DBM-Db2 samples at https://github.com/BroadcomMFD/dbm\-db2\-for\-zowe\-cli
Usage
zowe dbm-db2 execute migration-script <local-input-migrate-script-filename> [options]
Positional Arguments
Options
Profile Options
-
--dbm-db2-options-profile | --dbm-db2-options-p (string)
- The name of a (dbm-db2-options) profile to load for this command execution.
-
--dbm-db2-profile | --dbm-db2-p (string)
- The name of a (dbm-db2) profile to load for this command execution.
-
--base-profile | --base-p (string)
- The name of a (base) profile to load for this command execution.
DBM-Db2 Connection Options
-
--protocol (string)
-
Specifies the communication protocol between zowe dbm-db2 client and DBM Data Service.
Allowed values: http, https
-
--environment-list | --el (string)
- Specifies a string of one or more entries consisting of a Db2 subsystem ID and a DBM Data Service REST API server host name or TCP/IP address. Use a comma to separate entries. The same Db2 subsystem can be used in multiple DBM Data Service environments. For more information about configuring the DBM Data Service, see the Database Management Solutions for Db2 for z/OS documentation at https://techdocs.broadcom.com/db2mgmt
-
--job-cards | --jc (array)
- Specifies a string array of z/OS JCL JOB statements.
-
--work-dataset-prefix | --wdp (string)
- Specifies the prefix (high-level qualifier) in z/OS work data set names.
-
--delete-work-datasets | --dwd (boolean)
- Specifies whether to delete work data sets on a mainframe after the request is fulfilled.
-
--overwrite-output-files | --oof (boolean)
- Specifies whether to overwrite output files if they exist.
-
--base-path | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all DBM DS resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
Base Connection Options
-
--host | -H (string)
- Host name of service on the mainframe.
-
--port | -P (number)
- Port number of service on the mainframe.
-
--user | -u (string)
- User name to authenticate to service on the mainframe.
-
--password | --pass | --pw (string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized | --ru (boolean)
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Execute a migration script:
zowe dbm-db2 execute migration-script migration.txt
-
Restart execution of a migration script at the first statement in the script:
zowe dbm-db2 execute migration-script migration.txt --restart new
-
Restart execution of a migration script at the location in the token. Execution begins at the last successful sync point that is recorded in the restart token up to the end of the restart token section:
zowe dbm-db2 execute migration-script migration.txt --restart target,78A724GOBLEDYGOOK6FD140F6780D6FA
Execute a Batch Processor script on a target subsystem. For example, use this command to execute a Batch Processor script or specifically to execute a recovery script to undo changes that were made by the 'zowe dbm execute compare-script' command. If execution of the script fails, you can execute it again using the 'script-section' or 'restart' options. You can edit the script and make changes before you execute or restart it.
For details about command usage for automation, see DBM-Db2 samples at https://github.com/BroadcomMFD/dbm\-db2\-for\-zowe\-cli
Usage
zowe dbm-db2 execute script <local-input-bp-script-filename> [options]
Positional Arguments
Options
-
--target-db2 | --td (string)
-
Specifies the target Db2 subsystem or data sharing group where you want to execute the script. If this option is not specified, the target subsystem is identified by the first .CONNECT statement in the script.
Note: If you specify the data sharing group, the first active Db2 subsystem in the group is used.
The target-db2 option takes precedence over any other value that is specified for the Db2 subsystem or data sharing group.
-
--script-section | --ss (string)
-
Identifies the location in the script where you want to begin execution.
The following options are valid:
name - Begin execution of the specific section and process all subsequent statements up to the next section.
A section is a '.SYSTEM <name>' statement, where <name> identifies a logical grouping of statements such as UNLOADS or SQLDDL. 'source' is an alias for UNLOADS. 'target' is an alias for SQLDDL.
number - Begin execution after the specific sync point (.SYNC <number> statement) and process all statements up to the end of the script.
name, number - Begin execution of the specific script section beginning from the sync point (.SYNC <number> statement) within the section and process all subsequent statements up to the next section.
-
--restart | -r (string)
-
Specifies the location in the script where you want to restart execution. The effects of previous successful script statement executions remain.
The following restart options are valid:
new - Restart execution of the script at the first statement.
token - Restart execution of the script at the location that is recorded in the specified token and that was returned from a previous execution failure.
name, token - Restart execution of the script at the location in the restart section that is recorded in the specified token and that was returned from a prior execution failure.
A section is a Batch Processor '.SYSTEM <name>' statement, where <name> identifies a logical grouping of statements such as UNLOADS or SQLDDL. 'source' is an alias for UNLOADS. 'target' is an alias for SQLDDL.
-
--error-file | --ef (string)
-
Specifies the local output error file in YAML format. The file contains basic execution information, connection details, dbm-db2 profile parameters, used arguments, and errors that occurred during execution of the command.
Default value: error.log
-
--modification | -m (string)
-
Specifies a named set of server-managed default parameter values that control the execution behavior of the zowe dbm-db2 commands. For example, you can use a modification to identify a set of default values that differ from the current set of default values.
For more information about using the modification option, see the DBM Data Service documentation at https://techdocs.broadcom.com/db2mgmt
Profile Options
-
--dbm-db2-options-profile | --dbm-db2-options-p (string)
- The name of a (dbm-db2-options) profile to load for this command execution.
-
--dbm-db2-profile | --dbm-db2-p (string)
- The name of a (dbm-db2) profile to load for this command execution.
-
--base-profile | --base-p (string)
- The name of a (base) profile to load for this command execution.
DBM-Db2 Connection Options
-
--protocol (string)
-
Specifies the communication protocol between zowe dbm-db2 client and DBM Data Service.
Allowed values: http, https
-
--environment-list | --el (string)
- Specifies a string of one or more entries consisting of a Db2 subsystem ID and a DBM Data Service REST API server host name or TCP/IP address. Use a comma to separate entries. The same Db2 subsystem can be used in multiple DBM Data Service environments. For more information about configuring the DBM Data Service, see the Database Management Solutions for Db2 for z/OS documentation at https://techdocs.broadcom.com/db2mgmt
-
--job-cards | --jc (array)
- Specifies a string array of z/OS JCL JOB statements.
-
--work-dataset-prefix | --wdp (string)
- Specifies the prefix (high-level qualifier) in z/OS work data set names.
-
--delete-work-datasets | --dwd (boolean)
- Specifies whether to delete work data sets on a mainframe after the request is fulfilled.
-
--overwrite-output-files | --oof (boolean)
- Specifies whether to overwrite output files if they exist.
-
--base-path | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all DBM DS resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
Base Connection Options
-
--host | -H (string)
- Host name of service on the mainframe.
-
--port | -P (number)
- Port number of service on the mainframe.
-
--user | -u (string)
- User name to authenticate to service on the mainframe.
-
--password | --pass | --pw (string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized | --ru (boolean)
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Execute a recovery script:
zowe dbm-db2 execute script recovery.txt
-
Execute a script on the 'TEST' Db2 subsystem:
zowe dbm-db2 execute script script001.txt --target-db2 TEST
-
Execute only the SQLDDL section of a script. The first .CONNECT statement in the script identifies the target subsystem where the script is executed. Execution begins at the .SYSTEM SQLDDL statement and ends at the next .SYSTEM statement in the script:
zowe dbm-db2 execute script script001.txt --script-section SQLDDL
-
Execute a script beginning from the sync point 10 (.SYNC 10 statement) to the end of the script:
zowe dbm-db2 execute script script001.txt --script-section 10
-
Execute only the target (SQLDDL) section of the script starting at sync point 20:
zowe dbm-db2 execute script script001.txt --script-section target,20
-
Restart execution of a script from the beginning:
zowe dbm-db2 execute script script001.txt --restart new
-
Restart execution of a script at the location specified in the token. The restart token is returned by a previous 'zowe dbm execute command' failure as part of the terminal output and in the error file:
zowe dbm-db2 execute script script001.txt --restart 78A724A48DA5185D06FD140F6780D6FA
-
Restart execution at the last successful sync point recorded in the restart token up to the end of the target (SQLDDL) section:
zowe dbm-db2 execute script script001.txt --restart target,78A724A48DA5185D06FD140F6780D6FA
Generate DDL statements for Db2 objects.
Generate CREATE or DROP DDL statements for specified Db2 objects into an output DDL file. For example, use this command to generate CREATE TABLE definitions that you can then edit and use to update the table definition on a Db2 subsystem with the 'zowe dbm compare ddl' command.
For details about command usage for automation, see DBM-Db2 samples at https://github.com/BroadcomMFD/dbm\-db2\-for\-zowe\-cli
Usage
zowe dbm-db2 generate ddl [options]
Required Options
Options
-
--change-set | --cs (string)
-
Specifies the creator and name of an existing RC/Migrator global change set that changes Db2 objects during a command execution.
Format:
<change-set-creator.change-set-name>
For more information about global change services, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig
Note: If change-set and change-set-file are both specified, specifications in change-set-file take precedence.
-
--change-set-file | --csf (string)
-
Specifies the name of the local input file that contains the global change specifications that modify attributes of Db2 objects.
Format:
<object-attribute> <from-value> <to-value>
The <object-attribute> consists of four characters. The first two characters identify the object type. The last two characters identify the specific attribute. Wildcard characters are supported in <from-value> and <to-value>. If the same <object-attribute> is specified multiple times, the first occurrence takes precedence.
For a full list of attributes, see Global Change Set Attributes in the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig
Example:
The following example demonstrates changes to the table schema (creator) and tablespace names:
TBCR TEST% PROD%
TBTS TESTTS% PRODTS%
Note:
- If change-set and change-set-file are both specified, specifications in change-set-file take precedence.
- The changeSetValues options-profile option has the same behavior as the change-set-file command option.
-
--type | -t (string)
-
Specifies the type of DDL statements that you want to generate. You can generate CREATE or DROP statements.
Default value: create
Allowed values: drop, create
-
--output-ddl-file | --odf (string)
-
--error-file | --ef (string)
-
Specifies the local output error file in YAML format. The file contains basic execution information, connection details, dbm-db2 profile parameters, used arguments, and errors that occurred during execution of the command.
Default value: error.log
-
--modification | -m (string)
-
Specifies a named set of server-managed default parameter values that control the execution behavior of the zowe dbm-db2 commands. For example, you can use a modification to identify a set of default values that differ from the current set of default values.
For more information about using the modification option, see the DBM Data Service documentation at https://techdocs.broadcom.com/db2mgmt
Profile Options
-
--dbm-db2-options-profile | --dbm-db2-options-p (string)
- The name of a (dbm-db2-options) profile to load for this command execution.
-
--dbm-db2-profile | --dbm-db2-p (string)
- The name of a (dbm-db2) profile to load for this command execution.
-
--base-profile | --base-p (string)
- The name of a (base) profile to load for this command execution.
DBM-Db2 Connection Options
-
--protocol (string)
-
Specifies the communication protocol between zowe dbm-db2 client and DBM Data Service.
Allowed values: http, https
-
--environment-list | --el (string)
- Specifies a string of one or more entries consisting of a Db2 subsystem ID and a DBM Data Service REST API server host name or TCP/IP address. Use a comma to separate entries. The same Db2 subsystem can be used in multiple DBM Data Service environments. For more information about configuring the DBM Data Service, see the Database Management Solutions for Db2 for z/OS documentation at https://techdocs.broadcom.com/db2mgmt
-
--job-cards | --jc (array)
- Specifies a string array of z/OS JCL JOB statements.
-
--work-dataset-prefix | --wdp (string)
- Specifies the prefix (high-level qualifier) in z/OS work data set names.
-
--delete-work-datasets | --dwd (boolean)
- Specifies whether to delete work data sets on a mainframe after the request is fulfilled.
-
--overwrite-output-files | --oof (boolean)
- Specifies whether to overwrite output files if they exist.
-
--authid | -a (string)
- Specifies the primary Db2 authorization ID that is used to establish a connection between Db2 and a process.
-
--sqlid | -s (string)
- Specifies the authorization ID that is used in generated SET CURRENT SQLID statements.
-
--termination-character | --tc (string)
- Specifies the SQL termination character to use in DDL generation when the default termination character conflicts with the SQL statements that are used in triggers, XML indexes, and routines (external SQL functions and native SQL stored procedures). The default termination character is a semi-colon (;). You cannot specify a comma, double quote, single quote, left or right parentheses, or an underscore.
-
--base-path | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all DBM DS resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
Base Connection Options
-
--host | -H (string)
- Host name of service on the mainframe.
-
--port | -P (number)
- Port number of service on the mainframe.
-
--user | -u (string)
- User name to authenticate to service on the mainframe.
-
--password | --pass | --pw (string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized | --ru (boolean)
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Generate CREATE DDL statements for a tablespace and its child table:
zowe dbm-db2 generate ddl --object "tablespace my.tbsp include(table)" --source-db2 SRC --output-ddl-file objects.sql
-
Generate CREATE DDL statements for a database and its children and apply changes as defined in the change set:
zowe dbm-db2 generate ddl --object "database my.db include(children)" --source-db2 SRC --change-set USER1.CHANGSET --output-ddl-file objects.sql
-
Generate DROP DDL statements only for the input object list:
zowe dbm-db2 generate ddl --object-file objects.txt --source-db2 SRC --type drop --output-ddl-file output.sql
Prepare DDL statements and a script to migrate Db2 objects.
Generate a script to migrate Db2 object definitions (DDL) and data from a source subsystem to a target subsystem. You can specify which objects to include and apply changes to the objects as part of the migration. To execute the script, use the 'zowe dbm execute migration-script' command.
For details about command usage for automation, see DBM-Db2 samples at https://github.com/BroadcomMFD/dbm\-db2\-for\-zowe\-cli
Usage
zowe dbm-db2 prepare migration [options]
Required Options
-
--object | -o (string)
-
Specifies the Db2 objects to be migrated. Use the optional include clause to include related Db2 objects.
Format: see the object-file description
Note: The --object and --object-file options are mutually exclusive.
-
--object-file | --of (string)
-
Specifies the name of the local input file that contains a list of Db2 objects to be migrated. Use a semicolon to separate objects. Use the optional include clause to include related Db2 objects.
Format:
<object-type> <object-name> [include(<related-object-type>,...)];
The required clause <object-type> <object-name> identifies the specific Db2 (base) object:
STOGROUP <name>
DATABASE <name>
TABLESPACE <dbname.name>
TABLE <schema.name>
INDEX <schema.name>
VIEW <schema.name>
ALIAS <schema.name>
SYNONYM <schema.name>
MQT <schema.name>
SEQUENCE <schema.name>
TRIGGER <schema.name[.version]>
FUNCTION <schema.name[.version]>
PROCEDURE <schema.name[.version]>
The optional include clause (<related-object-type>,...) identifies one or more related Db2 object types to include in the object list.
You can specify the following object types: STOGROUP, DATABASE, TABLESPACE, TABLE, INDEX, VIEW, SYNONYM, MQT-ALL, TRIGGER, ROUTINE, PARENTS, CHILDREN, and ALL.
Example:
table sysibm.systables include (tablespace, database, index);
database db1 include(children);
Note: The --object and --object-file options are mutually exclusive.
-
--source-db2 | --sd (string)
-
Specifies the source Db2 subsystem or data sharing group where the objects that you want to use in a command are located.
Note: If you specify the data sharing group, the first active Db2 subsystem in the group is used.
-
--target-db2 | --td (string)
-
Specifies the target Db2 subsystem or data sharing group where you want to use a command.
Note: If you specify the data sharing group, the first active Db2 subsystem in the group is used.
Options
-
--change-set | --cs (string)
-
Specifies the creator and name of an existing RC/Migrator global change set that changes Db2 objects during a command execution.
Format:
<change-set-creator.change-set-name>
For more information about global change services, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig
Note: If change-set and change-set-file are both specified, specifications in change-set-file take precedence.
-
--change-set-file | --csf (string)
-
Specifies the name of the local input file that contains the global change specifications that modify attributes of Db2 objects.
Format:
<object-attribute> <from-value> <to-value>
The <object-attribute> consists of four characters. The first two characters identify the object type. The last two characters identify the specific attribute. Wildcard characters are supported in <from-value> and <to-value>. If the same <object-attribute> is specified multiple times, the first occurrence takes precedence.
For a full list of attributes, see Global Change Set Attributes in the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig
Example:
The following example demonstrates changes to the table schema (creator) and tablespace names:
TBCR TEST% PROD%
TBTS TESTTS% PRODTS%
Note:
- If change-set and change-set-file are both specified, specifications in change-set-file take precedence.
- The changeSetValues options-profile option has the same behavior as the change-set-file command option.
-
--output-migrate-script | --oms (string)
-
--output-ddl-file | --odf (string)
-
--error-file | --ef (string)
-
Specifies the local output error file in YAML format. The file contains basic execution information, connection details, dbm-db2 profile parameters, used arguments, and errors that occurred during execution of the command.
Default value: error.log
-
--modification | -m (string)
-
Specifies a named set of server-managed default parameter values that control the execution behavior of the zowe dbm-db2 commands. For example, you can use a modification to identify a set of default values that differ from the current set of default values.
For more information about using the modification option, see the DBM Data Service documentation at https://techdocs.broadcom.com/db2mgmt
Profile Options
-
--dbm-db2-options-profile | --dbm-db2-options-p (string)
- The name of a (dbm-db2-options) profile to load for this command execution.
-
--dbm-db2-profile | --dbm-db2-p (string)
- The name of a (dbm-db2) profile to load for this command execution.
-
--base-profile | --base-p (string)
- The name of a (base) profile to load for this command execution.
DBM-Db2 Connection Options
-
--protocol (string)
-
Specifies the communication protocol between zowe dbm-db2 client and DBM Data Service.
Allowed values: http, https
-
--environment-list | --el (string)
- Specifies a string of one or more entries consisting of a Db2 subsystem ID and a DBM Data Service REST API server host name or TCP/IP address. Use a comma to separate entries. The same Db2 subsystem can be used in multiple DBM Data Service environments. For more information about configuring the DBM Data Service, see the Database Management Solutions for Db2 for z/OS documentation at https://techdocs.broadcom.com/db2mgmt
-
--job-cards | --jc (array)
- Specifies a string array of z/OS JCL JOB statements.
-
--work-dataset-prefix | --wdp (string)
- Specifies the prefix (high-level qualifier) in z/OS work data set names.
-
--delete-work-datasets | --dwd (boolean)
- Specifies whether to delete work data sets on a mainframe after the request is fulfilled.
-
--overwrite-output-files | --oof (boolean)
- Specifies whether to overwrite output files if they exist.
-
--authid | -a (string)
- Specifies the primary Db2 authorization ID that is used to establish a connection between Db2 and a process.
-
--sqlid | -s (string)
- Specifies the authorization ID that is used in generated SET CURRENT SQLID statements.
-
--termination-character | --tc (string)
- Specifies the SQL termination character to use in DDL generation when the default termination character conflicts with the SQL statements that are used in triggers, XML indexes, and routines (external SQL functions and native SQL stored procedures). The default termination character is a semi-colon (;). You cannot specify a comma, double quote, single quote, left or right parentheses, or an underscore.
-
--base-path | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all DBM DS resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
Base Connection Options
-
--host | -H (string)
- Host name of service on the mainframe.
-
--port | -P (number)
- Port number of service on the mainframe.
-
--user | -u (string)
- User name to authenticate to service on the mainframe.
-
--password | --pass | --pw (string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized | --ru (boolean)
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
Endevor plug-in for listing Endevor environment information, working with elements and packages located in specified Endevor instance.
Add an Element into Endevor.
The add element command lets you add an Element to an Environment entry Stage in Endevor.
Usage
zowe endevor add element <element> [options]
Positional Arguments
-
element (string)
- Name of the Endevor element.
endevor-location definition options
-
--environment | --env (string)
- The Endevor environment where your project resides.
-
--system | --sys (string)
- The Endevor system where your project resides.
-
--subsystem | --sub (string)
- The Endevor subsystem where your project resides.
-
--type | --typ (string)
- Name of the Endevor element's type.
-
--ccid | --cci (string)
- The CCID you want to use when performing an Element action.
-
--comment | --com (string)
- The comment you want to have when performing an Element action
-
--maxrc (number)
-
--instance | -i (string)
- Specifies Endevor Web Services dataSource name.
input sources options
-
--from-file | --ff (string)
- Use this input to provide source file.
-
--from-dataset | --fd (string)
- Use this input to provide source data set name.
-
--from-member | --fm (string)
- Use this input to provide source member name in the data set.
-
--from-path | --fp (string)
- Use this input to provide the path of source USS file. It must be used with from-uss-file.
-
--from-uss-file | --fuf (string)
- Use this input to provide source USS file name. It must be used with from-path
options
-
--override-signout | --os (boolean)
- Specify if you want to override the Signout of an Endevor element while performing this action.
-
--new-version | --nv (number)
- Assign a different version number to the Element.
-
--proc-group | --pg (string)
- The Endevor processor group you would like to use.
-
--generate | -g (boolean)
- Specifies if you want to Generate Element after Add/Update action.
-
--get-fingerprint | --gfg (boolean)
-
--fingerprint | --fg (string)
- Specifies the fingerprint of the element to Add or Update. Use value 'NEW' when adding a new element that shouldn't exist in the map yet.
-
--charset | --char (string)
endevor session definition options
-
--host | --hostname (string)
- Specifies the base host name.
-
--port | -p (string)
- Specifies the port number.
-
--protocol | --prot (string)
-
Specifies the protocol used for connecting to Endevor Rest API
Default value: https
Allowed values: http, https
-
--user | --username (string)
-
--password | --pass (string)
- Specifies the user's password.
-
--reject-unauthorized | --ru (boolean)
- Specify this option to have the server certificate verified against the list of supplied CAs
-
--base-path | --bp (string)
- Specifies the base path used for connecting to Endevor Rest API
output customization options
Profile Options
-
--endevor-profile | --endevor-p (string)
- The name of a (endevor) profile to load for this command execution.
-
--endevor-location-profile | --endevor-location-p (string)
- The name of a (endevor-location) profile to load for this command execution.
-
--base-profile | --base-p (string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
Approve a Package in Endevor.
The approve package command approves Package in Endevor for execution.
Usage
zowe endevor approve package [package] [options]
Positional Arguments
-
package (string)
- Name of the Endevor package.
options
endevor-location definition options
-
--maxrc (number)
-
--instance | -i (string)
- Specifies Endevor Web Services dataSource name.
asynchronous task options
endevor session definition options
-
--host | --hostname (string)
- Specifies the base host name.
-
--port | -p (string)
- Specifies the port number.
-
--protocol | --prot (string)
-
Specifies the protocol used for connecting to Endevor Rest API
Default value: https
Allowed values: http, https
-
--user | --username (string)
-
--password | --pass (string)
- Specifies the user's password.
-
--reject-unauthorized | --ru (boolean)
- Specify this option to have the server certificate verified against the list of supplied CAs
-
--base-path | --bp (string)
- Specifies the base path used for connecting to Endevor Rest API
output customization options
Profile Options
-
--endevor-profile | --endevor-p (string)
- The name of a (endevor) profile to load for this command execution.
-
--endevor-location-profile | --endevor-location-p (string)
- The name of a (endevor-location) profile to load for this command execution.
-
--base-profile | --base-p (string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
Backin a Package in Endevor.
The backin package command reverses the backout action and returns the Package to a status of Executed.
Usage
zowe endevor backin package [package] [options]
Positional Arguments
-
package (string)
- Name of the Endevor package.
options
endevor-location definition options
-
--maxrc (number)
-
--instance | -i (string)
- Specifies Endevor Web Services dataSource name.
asynchronous task options
endevor session definition options
-
--host | --hostname (string)
- Specifies the base host name.
-
--port | -p (string)
- Specifies the port number.
-
--protocol | --prot (string)
-
Specifies the protocol used for connecting to Endevor Rest API
Default value: https
Allowed values: http, https
-
--user | --username (string)
-
--password | --pass (string)
- Specifies the user's password.
-
--reject-unauthorized | --ru (boolean)
- Specify this option to have the server certificate verified against the list of supplied CAs
-
--base-path | --bp (string)
- Specifies the base path used for connecting to Endevor Rest API
output customization options
Profile Options
-
--endevor-profile | --endevor-p (string)
- The name of a (endevor) profile to load for this command execution.
-
--endevor-location-profile | --endevor-location-p (string)
- The name of a (endevor-location) profile to load for this command execution.
-
--base-profile | --base-p (string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
Backout a Package in Endevor.
The backout package command restores the executable and output modules of the Package to the status they were in before execution.
Usage
zowe endevor backout package [package] [options]
Positional Arguments
-
package (string)
- Name of the Endevor package.
options
endevor-location definition options
-
--maxrc (number)
-
--instance | -i (string)
- Specifies Endevor Web Services dataSource name.
asynchronous task options
endevor session definition options
-
--host | --hostname (string)
- Specifies the base host name.
-
--port | -p (string)
- Specifies the port number.
-
--protocol | --prot (string)
-
Specifies the protocol used for connecting to Endevor Rest API
Default value: https
Allowed values: http, https
-
--user | --username (string)
-
--password | --pass (string)
- Specifies the user's password.
-
--reject-unauthorized | --ru (boolean)
- Specify this option to have the server certificate verified against the list of supplied CAs
-
--base-path | --bp (string)
- Specifies the base path used for connecting to Endevor Rest API
output customization options
Profile Options
-
--endevor-profile | --endevor-p (string)
- The name of a (endevor) profile to load for this command execution.
-
--endevor-location-profile | --endevor-location-p (string)
- The name of a (endevor-location) profile to load for this command execution.
-
--base-profile | --base-p (string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
Cast a Package in Endevor.
The cast package command prepares the Package for review and subsequent execution. Casting a Package freezes the contents of the Package and prevents further changes to the Package.
Usage
zowe endevor cast package [package] [options]
Positional Arguments
-
package (string)
- Name of the Endevor package.
options
-
--from-date-time | --fdt (string)
- Specify the beginning of time frame within which the package can be executed. Use yyyy-mm-ddThh:mm or see ISO 8601 standard for syntax.
-
--to-date-time | --tdt (string)
- Specify the end of time frame within which the package can be executed. Use yyyy-mm-ddThh:mm or see ISO 8601 standard for syntax.
-
--validate-components | --vc (string)
-
Specify "yes" to enable component validation within the package, "no" to disable, and "warn" to generate a warning if component validation fails.
Allowed values: yes, no, warn
-
--backout (boolean)
endevor-location definition options
-
--maxrc (number)
-
--instance | -i (string)
- Specifies Endevor Web Services dataSource name.
asynchronous task options
endevor session definition options
-
--host | --hostname (string)
- Specifies the base host name.
-
--port | -p (string)
- Specifies the port number.
-
--protocol | --prot (string)
-
Specifies the protocol used for connecting to Endevor Rest API
Default value: https
Allowed values: http, https
-
--user | --username (string)
-
--password | --pass (string)
- Specifies the user's password.
-
--reject-unauthorized | --ru (boolean)
- Specify this option to have the server certificate verified against the list of supplied CAs
-
--base-path | --bp (string)
- Specifies the base path used for connecting to Endevor Rest API
output customization options
Profile Options
-
--endevor-profile | --endevor-p (string)
- The name of a (endevor) profile to load for this command execution.
-
--endevor-location-profile | --endevor-location-p (string)
- The name of a (endevor-location) profile to load for this command execution.
-
--base-profile | --base-p (string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
Endevor Web Services Health Check.
The check instance command triggers the web services health check for a given instance.
Usage
zowe endevor check instance [instance] [options]
Positional Arguments
-
instance (string)
- Specifies Endevor Web Services dataSource name.
endevor session definition options
-
--host | --hostname (string)
- Specifies the base host name.
-
--port | -p (string)
- Specifies the port number.
-
--protocol | --prot (string)
-
Specifies the protocol used for connecting to Endevor Rest API
Default value: https
Allowed values: http, https
-
--user | --username (string)
-
--password | --pass (string)
- Specifies the user's password.
-
--reject-unauthorized | --ru (boolean)
- Specify this option to have the server certificate verified against the list of supplied CAs
-
--base-path | --bp (string)
- Specifies the base path used for connecting to Endevor Rest API
endevor-location definition options
-
--instance | -i (string)
- Specifies Endevor Web Services dataSource name.
output customization options
Profile Options
-
--endevor-profile | --endevor-p (string)
- The name of a (endevor) profile to load for this command execution.
-
--endevor-location-profile | --endevor-location-p (string)
- The name of a (endevor-location) profile to load for this command execution.
-
--base-profile | --base-p (string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
Commit a Package in Endevor.
The commit package command commits a Package, which removes all backout/backin data while retaining Package event information.
Usage
zowe endevor commit package [package] [options]
Positional Arguments
-
package (string)
- Name of the Endevor package.
options
endevor-location definition options
-
--maxrc (number)
-
--instance | -i (string)
- Specifies Endevor Web Services dataSource name.
asynchronous task options
endevor session definition options
-
--host | --hostname (string)
- Specifies the base host name.
-
--port | -p (string)
- Specifies the port number.
-
--protocol | --prot (string)
-
Specifies the protocol used for connecting to Endevor Rest API
Default value: https
Allowed values: http, https
-
--user | --username (string)
-
--password | --pass (string)
- Specifies the user's password.
-
--reject-unauthorized | --ru (boolean)
- Specify this option to have the server certificate verified against the list of supplied CAs
-
--base-path | --bp (string)
- Specifies the base path used for connecting to Endevor Rest API
output customization options
Profile Options
-
--endevor-profile | --endevor-p (string)
- The name of a (endevor) profile to load for this command execution.
-
--endevor-location-profile | --endevor-location-p (string)
- The name of a (endevor-location) profile to load for this command execution.
-
--base-profile | --base-p (string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
Confirm a manual conflict resolution inside an Endevor workspace file is complete.
Confirm a manual conflict resolution inside an Endevor workspace file is complete.
Usage
zowe endevor confirm resolution [workspace-file] [options]
Positional Arguments
-
workspace-file (string)
- An Endevor workspace file (full or relative path).
Profile Options
-
--endevor-profile | --endevor-p (string)
- The name of a (endevor) profile to load for this command execution.
-
--endevor-location-profile | --endevor-location-p (string)
- The name of a (endevor-location) profile to load for this command execution.
-
--base-profile | --base-p (string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
-
--host | -H (string)
- Host name of service on the mainframe.
-
--port | -P (number)
- Port number of service on the mainframe.
-
--user | -u (string)
- User name to authenticate to service on the mainframe.
-
--password | --pass | --pw (string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized | --ru (boolean)
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
Create a Package in Endevor.
The create package command lets you create a package in Endevor.
Usage
zowe endevor create package [package] [options]
Positional Arguments
-
package (string)
- Name of the Endevor package.
input sources options
-
--from-file | --ff (string)
- Use this input to provide source file.
-
--from-dataset | --fd (string)
- Use this input to provide source data set name.
-
--from-member | --fm (string)
- Use this input to provide source member name in the data set.
-
--from-package | --fp (string)
- Directs the Create/Update action to copy the SCL from the package you specify into the package you are creating or updating.
-
--from-text | --ft (string)
- Provides a string to use as input SCL.
options
-
--description | -d (string)
- Allows you to associate a 50-character description when creating or updating package.
-
--from-date-time | --fdt (string)
- Specify the beginning of time frame within which the package can be executed. Use yyyy-mm-ddThh:mm or see ISO 8601 standard for syntax.
-
--to-date-time | --tdt (string)
- Specify the end of time frame within which the package can be executed. Use yyyy-mm-ddThh:mm or see ISO 8601 standard for syntax.
-
--backout (boolean)
-
--notes | -n (string)
-
--notes-from-file | --nff (string)
- Local file of notes for package.
-
--emergency-package | --ep (boolean)
- Specify if the package should be an emergency package. When not specified, the package is a standard package.
-
--sharable | --sh (boolean)
- Specify this option if the package can be edited by more than one person when in In-edit status.
-
--promotion | --pr (boolean)
- Specify this option to define the package as a promotion package.
-
--validate-scl | --vs (boolean)
endevor-location definition options
-
--maxrc (number)
-
--instance | -i (string)
- Specifies Endevor Web Services dataSource name.
endevor session definition options
-
--host | --hostname (string)
- Specifies the base host name.
-
--port | -p (string)
- Specifies the port number.
-
--protocol | --prot (string)
-
Specifies the protocol used for connecting to Endevor Rest API
Default value: https
Allowed values: http, https
-
--user | --username (string)
-
--password | --pass (string)
- Specifies the user's password.
-
--reject-unauthorized | --ru (boolean)
- Specify this option to have the server certificate verified against the list of supplied CAs
-
--base-path | --bp (string)
- Specifies the base path used for connecting to Endevor Rest API
output customization options
Profile Options
-
--endevor-profile | --endevor-p (string)
- The name of a (endevor) profile to load for this command execution.
-
--endevor-location-profile | --endevor-location-p (string)
- The name of a (endevor-location) profile to load for this command execution.
-
--base-profile | --base-p (string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
Delete an Element or a Package in Endevor.
The delete element command deletes an Element from the specified inventory location in Endevor.
Usage
zowe endevor delete element <element> [options]
Positional Arguments
-
element (string)
- Name of the Endevor element.
endevor-location definition options
-
--environment | --env (string)
- The Endevor environment where your project resides.
-
--system | --sys (string)
- The Endevor system where your project resides.
-
--subsystem | --sub (string)
- The Endevor subsystem where your project resides.
-
--type | --typ (string)
- Name of the Endevor element's type.
-
--stage-number | --sn (string)
-
--ccid | --cci (string)
- The CCID you want to use when performing an Element action.
-
--comment | --com (string)
- The comment you want to have when performing an Element action
-
--maxrc (number)
-
--instance | -i (string)
- Specifies Endevor Web Services dataSource name.
options
-
--proc-group | --pg (string)
- The Endevor processor group you would like to use.
-
--override-signout | --os (boolean)
- Specify if you want to override the Signout of an Endevor element while performing this action.
-
--only-components | --oc (boolean)
- Applicable for Endevor ACM users only. Indicates whether you want to delete both the Element component list and the Element, or the Element component list only. "No" is the default option
-
--where-ccid-all | --wca (string)
- Instructs Endevor to search both the Master Control File and the SOURCE DELTA levels for a specified CCIDs.
Accepts up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
-
--where-ccid-current | --wcc (string)
- Instructs Endevor to search through the CCID fields in the Master Control File to find a specified CCIDs.
Accept up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
-
--where-ccid-retrieve | --wcr (string)
- Instructs Endevor to use the CCID in the Master Control File RETRIEVE CCID field.
Accepts up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
-
--where-proc-group | --wpg (string)
- Lets you select Elements according to a specified Processor group. You can use a wildcard when specifying the Processor group name.
Accepts up to 8 Processor group names separated by ", ".
asynchronous task options
endevor session definition options
-
--host | --hostname (string)
- Specifies the base host name.
-
--port | -p (string)
- Specifies the port number.
-
--protocol | --prot (string)
-
Specifies the protocol used for connecting to Endevor Rest API
Default value: https
Allowed values: http, https
-
--user | --username (string)
-
--password | --pass (string)
- Specifies the user's password.
-
--reject-unauthorized | --ru (boolean)
- Specify this option to have the server certificate verified against the list of supplied CAs
-
--base-path | --bp (string)
- Specifies the base path used for connecting to Endevor Rest API
output customization options
Profile Options
-
--endevor-profile | --endevor-p (string)
- The name of a (endevor) profile to load for this command execution.
-
--endevor-location-profile | --endevor-location-p (string)
- The name of a (endevor-location) profile to load for this command execution.
-
--base-profile | --base-p (string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
The delete package command lets you delete Packages of any status type in Endevor.
Usage
zowe endevor delete package [package] [options]
Positional Arguments
-
package (string)
- Name of the Endevor package.
options
endevor-location definition options
-
--maxrc (number)
-
--instance | -i (string)
- Specifies Endevor Web Services dataSource name.
asynchronous task options
endevor session definition options
-
--host | --hostname (string)
- Specifies the base host name.
-
--port | -p (string)
- Specifies the port number.
-
--protocol | --prot (string)
-
Specifies the protocol used for connecting to Endevor Rest API
Default value: https
Allowed values: http, https
-
--user | --username (string)
-
--password | --pass (string)
- Specifies the user's password.
-
--reject-unauthorized | --ru (boolean)
- Specify this option to have the server certificate verified against the list of supplied CAs
-
--base-path | --bp (string)
- Specifies the base path used for connecting to Endevor Rest API
output customization options
Profile Options
-
--endevor-profile | --endevor-p (string)
- The name of a (endevor) profile to load for this command execution.
-
--endevor-location-profile | --endevor-location-p (string)
- The name of a (endevor-location) profile to load for this command execution.
-
--base-profile | --base-p (string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
Deny a Package in Endevor.
The deny package command changes the status of a Package to Denied.
Usage
zowe endevor deny package [package] [options]
Positional Arguments
-
package (string)
- Name of the Endevor package.
options
endevor-location definition options
-
--maxrc (number)
-
--instance | -i (string)
- Specifies Endevor Web Services dataSource name.
asynchronous task options
endevor session definition options
-
--host | --hostname (string)
- Specifies the base host name.
-
--port | -p (string)
- Specifies the port number.
-
--protocol | --prot (string)
-
Specifies the protocol used for connecting to Endevor Rest API
Default value: https
Allowed values: http, https
-
--user | --username (string)
-
--password | --pass (string)
- Specifies the user's password.
-
--reject-unauthorized | --ru (boolean)
- Specify this option to have the server certificate verified against the list of supplied CAs
-
--base-path | --bp (string)
- Specifies the base path used for connecting to Endevor Rest API
output customization options
Profile Options
-
--endevor-profile | --endevor-p (string)
- The name of a (endevor) profile to load for this command execution.
-
--endevor-location-profile | --endevor-location-p (string)
- The name of a (endevor-location) profile to load for this command execution.
-
--base-profile | --base-p (string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
Execute a Package in Endevor.
The execute package command executes a Package that have a status of Approved or Execfailed.
Usage
zowe endevor execute package [package] [options]
Positional Arguments
-
package (string)
- Name of the Endevor package.
options
endevor-location definition options
-
--maxrc (number)
-
--instance | -i (string)
- Specifies Endevor Web Services dataSource name.
asynchronous task options
endevor session definition options
-
--host | --hostname (string)
- Specifies the base host name.
-
--port | -p (string)
- Specifies the port number.
-
--protocol | --prot (string)
-
Specifies the protocol used for connecting to Endevor Rest API
Default value: https
Allowed values: http, https
-
--user | --username (string)
-
--password | --pass (string)
- Specifies the user's password.
-
--reject-unauthorized | --ru (boolean)
- Specify this option to have the server certificate verified against the list of supplied CAs
-
--base-path | --bp (string)
- Specifies the base path used for connecting to Endevor Rest API
output customization options
Profile Options
-
--endevor-profile | --endevor-p (string)
- The name of a (endevor) profile to load for this command execution.
-
--endevor-location-profile | --endevor-location-p (string)
- The name of a (endevor-location) profile to load for this command execution.
-
--base-profile | --base-p (string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
Generate an Element in Endevor.
The generate element command executes the generate Processor for the current level of the Element.
Usage
zowe endevor generate element <element> [options]
Positional Arguments
-
element (string)
- Name of the Endevor element.
endevor-location definition options
-
--environment | --env (string)
- The Endevor environment where your project resides.
-
--system | --sys (string)
- The Endevor system where your project resides.
-
--subsystem | --sub (string)
- The Endevor subsystem where your project resides.
-
--type | --typ (string)
- Name of the Endevor element's type.
-
--stage-number | --sn (string)
-
--ccid | --cci (string)
- The CCID you want to use when performing an Element action.
-
--comment | --com (string)
- The comment you want to have when performing an Element action
-
--maxrc (number)
-
--instance | -i (string)
- Specifies Endevor Web Services dataSource name.
options
-
--proc-group | --pg (string)
- The Endevor processor group you would like to use.
-
--search | --sea (boolean)
- Enables the search through the Endevor map.
-
--copy-back | --cb (boolean)
- Specify if you want to copy the current level of the Element back to the FROM Stage, then perform this action. Do not use with --nosource option.
-
--override-signout | --os (boolean)
- Specify if you want to override the Signout of an Endevor element while performing this action.
-
--nosource | --ns (boolean)
- Specify if you want to have source-less Element. Do not use with --copy-back option.
-
--where-ccid-all | --wca (string)
- Instructs Endevor to search both the Master Control File and the SOURCE DELTA levels for a specified CCIDs.
Accepts up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
-
--where-ccid-current | --wcc (string)
- Instructs Endevor to search through the CCID fields in the Master Control File to find a specified CCIDs.
Accept up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
-
--where-ccid-retrieve | --wcr (string)
- Instructs Endevor to use the CCID in the Master Control File RETRIEVE CCID field.
Accepts up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
-
--where-proc-group | --wpg (string)
- Lets you select Elements according to a specified Processor group. You can use a wildcard when specifying the Processor group name.
Accepts up to 8 Processor group names separated by ", ".
asynchronous task options
endevor session definition options
-
--host | --hostname (string)
- Specifies the base host name.
-
--port | -p (string)
- Specifies the port number.
-
--protocol | --prot (string)
-
Specifies the protocol used for connecting to Endevor Rest API
Default value: https
Allowed values: http, https
-
--user | --username (string)
-
--password | --pass (string)
- Specifies the user's password.
-
--reject-unauthorized | --ru (boolean)
- Specify this option to have the server certificate verified against the list of supplied CAs
-
--base-path | --bp (string)
- Specifies the base path used for connecting to Endevor Rest API
output customization options
Profile Options
-
--endevor-profile | --endevor-p (string)
- The name of a (endevor) profile to load for this command execution.
-
--endevor-location-profile | --endevor-location-p (string)
- The name of a (endevor-location) profile to load for this command execution.
-
--base-profile | --base-p (string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
Initialize a directory as an Endevor workspace.
Initialize current directory as an Endevor workspace.
Usage
zowe endevor initialize workspace [workspace-dir] [options]
Positional Arguments
-
workspace-dir (string)
- The Endevor workspace directory, if different from current working directory.
Profile Options
-
--endevor-profile | --endevor-p (string)
- The name of a (endevor) profile to load for this command execution.
-
--endevor-location-profile | --endevor-location-p (string)
- The name of a (endevor-location) profile to load for this command execution.
-
--base-profile | --base-p (string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
-
--host | -H (string)
- Host name of service on the mainframe.
-
--port | -P (number)
- Port number of service on the mainframe.
-
--user | -u (string)
- User name to authenticate to service on the mainframe.
-
--password | --pass | --pw (string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized | --ru (boolean)
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
List instances, elements, types, packages and inventory locations in Endevor.
The list code-page-config command lists the EBCDIC code page mapping rules used by Endevor Web Services
Usage
zowe endevor list code-page-config [options]
endevor session definition options
-
--host | --hostname (string)
- Specifies the base host name.
-
--port | -p (string)
- Specifies the port number.
-
--protocol | --prot (string)
-
Specifies the protocol used for connecting to Endevor Rest API
Default value: https
Allowed values: http, https
-
--reject-unauthorized | --ru (boolean)
- Specify this option to have the server certificate verified against the list of supplied CAs
-
--base-path | --bp (string)
- Specifies the base path used for connecting to Endevor Rest API
-
--host | --hostname (string)
- Specifies the base host name.
-
--port | -p (string)
- Specifies the port number.
-
--protocol | --prot (string)
-
Specifies the protocol used for connecting to Endevor Rest API
Default value: https
Allowed values: http, https
-
--user | --username (string)
-
--password | --pass (string)
- Specifies the user's password.
-
--reject-unauthorized | --ru (boolean)
- Specify this option to have the server certificate verified against the list of supplied CAs
-
--base-path | --bp (string)
- Specifies the base path used for connecting to Endevor Rest API
endevor-location definition options
-
--instance | -i (string)
- Specifies Endevor Web Services dataSource name.
output customization options
-
--suppress-messages | --sm (boolean)
- Suppress all [INFO]/[WARN] messages from terminal output.
-
--report-file | --file-name (string)
- File name for saving reports from Endevor SCM locally.
-
--report-dir (string)
- Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
-
--write-report (boolean)
- Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
-
--full-output | --fo (boolean)
- Specify this option if you want a full output of list action.
asynchronous task options
Profile Options
-
--endevor-profile | --endevor-p (string)
- The name of a (endevor) profile to load for this command execution.
-
--endevor-location-profile | --endevor-location-p (string)
- The name of a (endevor-location) profile to load for this command execution.
-
--base-profile | --base-p (string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Response Format Options
-
--response-format-filter | --rff (array)
- Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
-
--response-format-type | --rft (string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.
list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.
object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header | --rfh (boolean)
- If "--response-format-type table" is specified, include the column headers in the output.
Examples
List the contents of the main Endevor configuration table (C1DEFLTS)
Usage
zowe endevor list defaults [options]
endevor session definition options
-
--host | --hostname (string)
- Specifies the base host name.
-
--port | -p (string)
- Specifies the port number.
-
--protocol | --prot (string)
-
Specifies the protocol used for connecting to Endevor Rest API
Default value: https
Allowed values: http, https
-
--reject-unauthorized | --ru (boolean)
- Specify this option to have the server certificate verified against the list of supplied CAs
-
--base-path | --bp (string)
- Specifies the base path used for connecting to Endevor Rest API
-
--host | --hostname (string)
- Specifies the base host name.
-
--port | -p (string)
- Specifies the port number.
-
--protocol | --prot (string)
-
Specifies the protocol used for connecting to Endevor Rest API
Default value: https
Allowed values: http, https
-
--user | --username (string)
-
--password | --pass (string)
- Specifies the user's password.
-
--reject-unauthorized | --ru (boolean)
- Specify this option to have the server certificate verified against the list of supplied CAs
-
--base-path | --bp (string)
- Specifies the base path used for connecting to Endevor Rest API
endevor-location definition options
-
--instance | -i (string)
- Specifies Endevor Web Services dataSource name.
output customization options
-
--suppress-messages | --sm (boolean)
- Suppress all [INFO]/[WARN] messages from terminal output.
-
--report-file | --file-name (string)
- File name for saving reports from Endevor SCM locally.
-
--report-dir (string)
- Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
-
--write-report (boolean)
- Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
-
--full-output | --fo (boolean)
- Specify this option if you want a full output of list action.
asynchronous task options
Profile Options
-
--endevor-profile | --endevor-p (string)
- The name of a (endevor) profile to load for this command execution.
-
--endevor-location-profile | --endevor-location-p (string)
- The name of a (endevor-location) profile to load for this command execution.
-
--base-profile | --base-p (string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Response Format Options
-
--response-format-filter | --rff (array)
- Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
-
--response-format-type | --rft (string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.
list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.
object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header | --rfh (boolean)
- If "--response-format-type table" is specified, include the column headers in the output.
Examples
List the contents of the Endevor ISPF dialog defaults table (ENDIECFG)
Usage
zowe endevor list dialog [options]
endevor session definition options
-
--host | --hostname (string)
- Specifies the base host name.
-
--port | -p (string)
- Specifies the port number.
-
--protocol | --prot (string)
-
Specifies the protocol used for connecting to Endevor Rest API
Default value: https
Allowed values: http, https
-
--reject-unauthorized | --ru (boolean)
- Specify this option to have the server certificate verified against the list of supplied CAs
-
--base-path | --bp (string)
- Specifies the base path used for connecting to Endevor Rest API
-
--host | --hostname (string)
- Specifies the base host name.
-
--port | -p (string)
- Specifies the port number.
-
--protocol | --prot (string)
-
Specifies the protocol used for connecting to Endevor Rest API
Default value: https
Allowed values: http, https
-
--user | --username (string)
-
--password | --pass (string)
- Specifies the user's password.
-
--reject-unauthorized | --ru (boolean)
- Specify this option to have the server certificate verified against the list of supplied CAs
-
--base-path | --bp (string)
- Specifies the base path used for connecting to Endevor Rest API
endevor-location definition options
-
--instance | -i (string)
- Specifies Endevor Web Services dataSource name.
output customization options
-
--suppress-messages | --sm (boolean)
- Suppress all [INFO]/[WARN] messages from terminal output.
-
--report-file | --file-name (string)
- File name for saving reports from Endevor SCM locally.
-
--report-dir (string)
- Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
-
--write-report (boolean)
- Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
-
--full-output | --fo (boolean)
- Specify this option if you want a full output of list action.
asynchronous task options
Profile Options
-
--endevor-profile | --endevor-p (string)
- The name of a (endevor) profile to load for this command execution.
-
--endevor-location-profile | --endevor-location-p (string)
- The name of a (endevor-location) profile to load for this command execution.
-
--base-profile | --base-p (string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Response Format Options
-
--response-format-filter | --rff (array)
- Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
-
--response-format-type | --rft (string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.
list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.
object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header | --rfh (boolean)
- If "--response-format-type table" is specified, include the column headers in the output.
Examples
The list elements command lists element information in Endevor
Usage
zowe endevor list elements [element] [options]
Positional Arguments
-
element (string)
- Name of the Endevor element
endevor-location definition options
-
--environment | --env (string)
- The Endevor environment where your project resides.
-
--system | --sys (string)
- The Endevor system where your project resides.
-
--subsystem | --sub (string)
- The Endevor subsystem where your project resides.
-
--type | --typ (string)
- Name of the Endevor element's type.
-
--stage-number | --sn (string)
-
The Endevor stage number where your project resides.
Allowed values: \*, \%, 1, 2
-
--maxrc (number)
-
--instance | -i (string)
- Specifies Endevor Web Services dataSource name.
options
-
--path | --pa (string)
-
--return | --ret (string)
-
--search | --sea (boolean)
- Enables the search through the Endevor map.
-
--data | --dat (string)
-
Allows to select the type of summary data returned in the element list:
ALL - Full element information
BAS - Basic element information
ELE - Element change level summary
COMP - Component change level summary
When data=ALL --fo (full-output) always takes place unless there is a --rff (response-format-filter).
In all other cases default set of columns will be shown.
Allowed values: all, bas, ele, comp
-
--where-ccid-current | --wcc (string)
- Instructs Endevor to search through the CCID fields in the Master Control File to find a specified CCIDs.
Accept up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
-
--where-ccid-generate | --wcg (string)
- Instructs Endevor to search using the generate CCID associated with an Element.
Accepts up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
-
--where-ccid-lastact | --wcla (string)
- Instructs Endevor to search using the last action CCID associated with an Element.
Accepts up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
-
--where-ccid-lastlvl | --wcll (string)
- Instructs Endevor to search using the last level CCID associated with an Element.
Accepts up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
-
--where-ccid-change | --wcchg (string)
- This option is only valid when the data option is ele or comp. Instructs Endevor to filter the results of the list data summary function that is based on the specified ccids.
Accepts up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
-
--where-ccid-retrieve | --wcr (string)
- Instructs Endevor to use the CCID in the Master Control File RETRIEVE CCID field.
Accepts up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
-
--where-proc-type | --wpt (string)
-
Lets you select Elements according to a specified Processor type.
Allowed values: GEN, GENERATE, MOV, MOVE, DEL, DELETE
-
--where-proc-group | --wpg (string)
- Lets you select Elements according to a specified Processor group. You can use a wildcard when specifying the Processor group name.
Accepts up to 8 Processor group names separated by ", ".
-
--limit | --lim (number)
- Maximum number of results to return, where 0 is NOLIMIT.
endevor search text options
-
--search-text | --stext (string)
- Search string(s) separated with AND or OR. E.g.: string_1 AND string_2 AND string_3 OR string_4.
For complex search strings with quotation marks use search-text-file parameter.
-
--search-text-file | --stf (string)
- File which contains search string(s) separated with AND or OR. Recommended for complex search strings with quotation marks.
-
--search-in | --si (string)
-
2 letters describing where search should be performed:
es - Element Source
eh - Element History
ec - Element Changes
eu - Element Summary
cs - Components Source
ch - Components History
cc - Components Changes
cu - Components Summary.
Allowed values: es, eh, ec, eu, cs, ch, cc, cu
-
--search-from | --sf (number)
- Beginning interval of the column range for the search-text.
-
--search-to | --st (number)
- Ending interval of the column range for the search-text.
-
--search-ignore-case | --ic (boolean)
-
--search-in-binary | --bin (boolean)
- Should the text search be performed in binary elements.
-
--search-limit | --sl (number)
- Maximum search limit where 0 is NOLIMIT.
scl generation options
endevor session definition options
-
--host | --hostname (string)
- Specifies the base host name.
-
--port | -p (string)
- Specifies the port number.
-
--protocol | --prot (string)
-
Specifies the protocol used for connecting to Endevor Rest API
Default value: https
Allowed values: http, https
-
--user | --username (string)
-
--password | --pass (string)
- Specifies the user's password.
-
--reject-unauthorized | --ru (boolean)
- Specify this option to have the server certificate verified against the list of supplied CAs
-
--base-path | --bp (string)
- Specifies the base path used for connecting to Endevor Rest API
output customization options
-
--suppress-messages | --sm (boolean)
- Suppress all [INFO]/[WARN] messages from terminal output.
-
--report-file | --file-name (string)
- File name for saving reports from Endevor SCM locally.
-
--report-dir (string)
- Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
-
--write-report (boolean)
- Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
-
--full-output | --fo (boolean)
- Specify this option if you want a full output of list action.
asynchronous task options
Profile Options
-
--endevor-profile | --endevor-p (string)
- The name of a (endevor) profile to load for this command execution.
-
--endevor-location-profile | --endevor-location-p (string)
- The name of a (endevor-location) profile to load for this command execution.
-
--base-profile | --base-p (string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Response Format Options
-
--response-format-filter | --rff (array)
- Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
-
--response-format-type | --rft (string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.
list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.
object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header | --rfh (boolean)
- If "--response-format-type table" is specified, include the column headers in the output.
Examples
The list environments command lists environments in Endevor
Usage
zowe endevor list environments [environment] [options]
Positional Arguments
-
environment (string)
- Name of the Endevor environment.
endevor-location definition options
-
--maxrc (number)
-
--instance | -i (string)
- Specifies Endevor Web Services dataSource name.
options
endevor session definition options
-
--host | --hostname (string)
- Specifies the base host name.
-
--port | -p (string)
- Specifies the port number.
-
--protocol | --prot (string)
-
Specifies the protocol used for connecting to Endevor Rest API
Default value: https
Allowed values: http, https
-
--user | --username (string)
-
--password | --pass (string)
- Specifies the user's password.
-
--reject-unauthorized | --ru (boolean)
- Specify this option to have the server certificate verified against the list of supplied CAs
-
--base-path | --bp (string)
- Specifies the base path used for connecting to Endevor Rest API
output customization options
-
--suppress-messages | --sm (boolean)
- Suppress all [INFO]/[WARN] messages from terminal output.
-
--report-file | --file-name (string)
- File name for saving reports from Endevor SCM locally.
-
--report-dir (string)
- Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
-
--write-report (boolean)
- Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
-
--full-output | --fo (boolean)
- Specify this option if you want a full output of list action.
asynchronous task options
Profile Options
-
--endevor-profile | --endevor-p (string)
- The name of a (endevor) profile to load for this command execution.
-
--endevor-location-profile | --endevor-location-p (string)
- The name of a (endevor-location) profile to load for this command execution.
-
--base-profile | --base-p (string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Response Format Options
-
--response-format-filter | --rff (array)
- Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
-
--response-format-type | --rft (string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.
list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.
object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header | --rfh (boolean)
- If "--response-format-type table" is specified, include the column headers in the output.
Examples
List the contents of the Endevor optional features table (ENCOPTBL)
Usage
zowe endevor list features [options]
endevor session definition options
-
--host | --hostname (string)
- Specifies the base host name.
-
--port | -p (string)
- Specifies the port number.
-
--protocol | --prot (string)
-
Specifies the protocol used for connecting to Endevor Rest API
Default value: https
Allowed values: http, https
-
--reject-unauthorized | --ru (boolean)
- Specify this option to have the server certificate verified against the list of supplied CAs
-
--base-path | --bp (string)
- Specifies the base path used for connecting to Endevor Rest API
-
--host | --hostname (string)
- Specifies the base host name.
-
--port | -p (string)
- Specifies the port number.
-
--protocol | --prot (string)
-
Specifies the protocol used for connecting to Endevor Rest API
Default value: https
Allowed values: http, https
-
--user | --username (string)
-
--password | --pass (string)
- Specifies the user's password.
-
--reject-unauthorized | --ru (boolean)
- Specify this option to have the server certificate verified against the list of supplied CAs
-
--base-path | --bp (string)
- Specifies the base path used for connecting to Endevor Rest API
endevor-location definition options
-
--instance | -i (string)
- Specifies Endevor Web Services dataSource name.
output customization options
-
--suppress-messages | --sm (boolean)
- Suppress all [INFO]/[WARN] messages from terminal output.
-
--report-file | --file-name (string)
- File name for saving reports from Endevor SCM locally.
-
--report-dir (string)
- Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
-
--write-report (boolean)
- Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
-
--full-output | --fo (boolean)
- Specify this option if you want a full output of list action.
asynchronous task options
Profile Options
-
--endevor-profile | --endevor-p (string)
- The name of a (endevor) profile to load for this command execution.
-
--endevor-location-profile | --endevor-location-p (string)
- The name of a (endevor-location) profile to load for this command execution.
-
--base-profile | --base-p (string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Response Format Options
-
--response-format-filter | --rff (array)
- Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
-
--response-format-type | --rft (string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.
list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.
object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header | --rfh (boolean)
- If "--response-format-type table" is specified, include the column headers in the output.
Examples
The list instances command lists instances used by Endevor Web Services
Usage
zowe endevor list instances [options]
endevor session definition options
-
--host | --hostname (string)
- Specifies the base host name.
-
--port | -p (string)
- Specifies the port number.
-
--protocol | --prot (string)
-
Specifies the protocol used for connecting to Endevor Rest API
Default value: https
Allowed values: http, https
-
--reject-unauthorized | --ru (boolean)
- Specify this option to have the server certificate verified against the list of supplied CAs
-
--base-path | --bp (string)
- Specifies the base path used for connecting to Endevor Rest API
output customization options
Profile Options
Base Connection Options
-
--user | -u (string)
- User name to authenticate to service on the mainframe.
-
--password | --pass | --pw (string)
- Password to authenticate to service on the mainframe.
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Response Format Options
-
--response-format-filter | --rff (array)
- Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
-
--response-format-type | --rft (string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.
list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.
object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header | --rfh (boolean)
- If "--response-format-type table" is specified, include the column headers in the output.
Examples
The list packages command lists package information in Endevor
Usage
zowe endevor list packages [package] [options]
Positional Arguments
-
package (string)
- Name of the Endevor package.
options
-
--status | --st (string)
-
Specify the status of the packages. Valid values are [APPROVED, EXECFAILED] for execute action, and additional values [INEDIT, INAPPROVAL, INEXECUTION, EXECUTED, COMMITTED, DENIED] for list action, additional value [ALLSTATE] for delete action.
It is possible to specify multiple status separated by "," during list and delete package.
Allowed values: ALLSTATE, INEDIT, INAPPROVAL, APPROVED, INEXECUTION, EXECUTED, COMMITTED, DENIED, EXECFAILED
-
--emergency-package | --ep (boolean)
- Specify if the package should be an emergency package. When not specified, the package is a standard package.
-
--enterprise | --ent (string)
-
--promotion-status | --ps (string)
-
--prom-target-env | --pte (string)
- Promotion target environment. Specifies the promotion package target environment. This field only applies to promotion packages and can only be specified when the promotion package type is A or P.
-
--prom-target-stgID | --pts (string)
- Promotion target stage ID. Specifies the promotion package target stage ID. This field only applies to promotion packages and can only be specified when the promotion package type is A or P.
-
--approver | --apr (string)
- Specifies a one to eight character approver ID. Only one approver ID can be specified and name masking is not supported.
-
--limit | --lim (number)
- Maximum number of results to return, where 0 is NOLIMIT.
endevor-location definition options
-
--maxrc (number)
-
--instance | -i (string)
- Specifies Endevor Web Services dataSource name.
endevor session definition options
-
--host | --hostname (string)
- Specifies the base host name.
-
--port | -p (string)
- Specifies the port number.
-
--protocol | --prot (string)
-
Specifies the protocol used for connecting to Endevor Rest API
Default value: https
Allowed values: http, https
-
--user | --username (string)
-
--password | --pass (string)
- Specifies the user's password.
-
--reject-unauthorized | --ru (boolean)
- Specify this option to have the server certificate verified against the list of supplied CAs
-
--base-path | --bp (string)
- Specifies the base path used for connecting to Endevor Rest API
output customization options
-
--suppress-messages | --sm (boolean)
- Suppress all [INFO]/[WARN] messages from terminal output.
-
--report-file | --file-name (string)
- File name for saving reports from Endevor SCM locally.
-
--report-dir (string)
- Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
-
--write-report (boolean)
- Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
-
--full-output | --fo (boolean)
- Specify this option if you want a full output of list action.
asynchronous task options
Profile Options
-
--endevor-profile | --endevor-p (string)
- The name of a (endevor) profile to load for this command execution.
-
--endevor-location-profile | --endevor-location-p (string)
- The name of a (endevor-location) profile to load for this command execution.
-
--base-profile | --base-p (string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Response Format Options
-
--response-format-filter | --rff (array)
- Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
-
--response-format-type | --rft (string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.
list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.
object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header | --rfh (boolean)
- If "--response-format-type table" is specified, include the column headers in the output.
Examples
The list processor-groups command lists processor group information in Endevor
Usage
zowe endevor list processor-groups [proc-group] [options]
Positional Arguments
-
proc-group (string)
- Name of the Endevor processor group
endevor-location definition options
-
--environment | --env (string)
- The Endevor environment where your project resides.
-
--system | --sys (string)
- The Endevor system where your project resides.
-
--stage-number | --sn (string)
-
The Endevor stage number where your project resides.
Allowed values: \*, \%, 1, 2
-
--type | --typ (string)
- Name of the Endevor element's type.
-
--maxrc (number)
-
--instance | -i (string)
- Specifies Endevor Web Services dataSource name.
options
endevor session definition options
-
--host | --hostname (string)
- Specifies the base host name.
-
--port | -p (string)
- Specifies the port number.
-
--protocol | --prot (string)
-
Specifies the protocol used for connecting to Endevor Rest API
Default value: https
Allowed values: http, https
-
--user | --username (string)
-
--password | --pass (string)
- Specifies the user's password.
-
--reject-unauthorized | --ru (boolean)
- Specify this option to have the server certificate verified against the list of supplied CAs
-
--base-path | --bp (string)
- Specifies the base path used for connecting to Endevor Rest API
output customization options
-
--suppress-messages | --sm (boolean)
- Suppress all [INFO]/[WARN] messages from terminal output.
-
--report-file | --file-name (string)
- File name for saving reports from Endevor SCM locally.
-
--report-dir (string)
- Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
-
--write-report (boolean)
- Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
-
--full-output | --fo (boolean)
- Specify this option if you want a full output of list action.
asynchronous task options
Profile Options
-
--endevor-profile | --endevor-p (string)
- The name of a (endevor) profile to load for this command execution.
-
--endevor-location-profile | --endevor-location-p (string)
- The name of a (endevor-location) profile to load for this command execution.
-
--base-profile | --base-p (string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Response Format Options
-
--response-format-filter | --rff (array)
- Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
-
--response-format-type | --rft (string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.
list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.
object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header | --rfh (boolean)
- If "--response-format-type table" is specified, include the column headers in the output.
Examples
The list processor-symbols command lists processor group symbol overrides information in Endevor
Usage
zowe endevor list processor-symbols [proc-group] [options]
Positional Arguments
-
proc-group (string)
- Name of the Endevor processor group
endevor-location definition options
-
--environment | --env (string)
- The Endevor environment where your project resides.
-
--system | --sys (string)
- The Endevor system where your project resides.
-
--stage-number | --sn (string)
-
The Endevor stage number where your project resides.
Allowed values: \*, \%, 1, 2
-
--type | --typ (string)
- Name of the Endevor element's type.
-
--maxrc (number)
-
--instance | -i (string)
- Specifies Endevor Web Services dataSource name.
options
endevor session definition options
-
--host | --hostname (string)
- Specifies the base host name.
-
--port | -p (string)
- Specifies the port number.
-
--protocol | --prot (string)
-
Specifies the protocol used for connecting to Endevor Rest API
Default value: https
Allowed values: http, https
-
--user | --username (string)
-
--password | --pass (string)
- Specifies the user's password.
-
--reject-unauthorized | --ru (boolean)
- Specify this option to have the server certificate verified against the list of supplied CAs
-
--base-path | --bp (string)
- Specifies the base path used for connecting to Endevor Rest API
output customization options
-
--suppress-messages | --sm (boolean)
- Suppress all [INFO]/[WARN] messages from terminal output.
-
--report-file | --file-name (string)
- File name for saving reports from Endevor SCM locally.
-
--report-dir (string)
- Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
-
--write-report (boolean)
- Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
-
--full-output | --fo (boolean)
- Specify this option if you want a full output of list action.
asynchronous task options
Profile Options
-
--endevor-profile | --endevor-p (string)
- The name of a (endevor) profile to load for this command execution.
-
--endevor-location-profile | --endevor-location-p (string)
- The name of a (endevor-location) profile to load for this command execution.
-
--base-profile | --base-p (string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Response Format Options
-
--response-format-filter | --rff (array)
- Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
-
--response-format-type | --rft (string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.
list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.
object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header | --rfh (boolean)
- If "--response-format-type table" is specified, include the column headers in the output.
Examples
The list stages command lists stages in Endevor
Usage
zowe endevor list stages [stage] [options]
Positional Arguments
-
stage (string)
- Name of the Endevor stage
endevor-location definition options
options
endevor session definition options
-
--host | --hostname (string)
- Specifies the base host name.
-
--port | -p (string)
- Specifies the port number.
-
--protocol | --prot (string)
-
Specifies the protocol used for connecting to Endevor Rest API
Default value: https
Allowed values: http, https
-
--user | --username (string)
-
--password | --pass (string)
- Specifies the user's password.
-
--reject-unauthorized | --ru (boolean)
- Specify this option to have the server certificate verified against the list of supplied CAs
-
--base-path | --bp (string)
- Specifies the base path used for connecting to Endevor Rest API
output customization options
-
--suppress-messages | --sm (boolean)
- Suppress all [INFO]/[WARN] messages from terminal output.
-
--report-file | --file-name (string)
- File name for saving reports from Endevor SCM locally.
-
--report-dir (string)
- Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
-
--write-report (boolean)
- Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
-
--full-output | --fo (boolean)
- Specify this option if you want a full output of list action.
asynchronous task options
Profile Options
-
--endevor-profile | --endevor-p (string)
- The name of a (endevor) profile to load for this command execution.
-
--endevor-location-profile | --endevor-location-p (string)
- The name of a (endevor-location) profile to load for this command execution.
-
--base-profile | --base-p (string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Response Format Options
-
--response-format-filter | --rff (array)
- Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
-
--response-format-type | --rft (string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.
list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.
object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header | --rfh (boolean)
- If "--response-format-type table" is specified, include the column headers in the output.
Examples
The list subsystems command lists subsystem information in Endevor
Usage
zowe endevor list subsystems [subsystem] [options]
Positional Arguments
-
subsystem (string)
- Name of the Endevor subsystem
endevor-location definition options
-
--environment | --env (string)
- The Endevor environment where your project resides.
-
--system | --sys (string)
- The Endevor system where your project resides.
-
--stage-number | --sn (string)
-
The Endevor stage number where your project resides.
Allowed values: \*, \%, 1, 2
-
--maxrc (number)
-
--instance | -i (string)
- Specifies Endevor Web Services dataSource name.
options
endevor session definition options
-
--host | --hostname (string)
- Specifies the base host name.
-
--port | -p (string)
- Specifies the port number.
-
--protocol | --prot (string)
-
Specifies the protocol used for connecting to Endevor Rest API
Default value: https
Allowed values: http, https
-
--user | --username (string)
-
--password | --pass (string)
- Specifies the user's password.
-
--reject-unauthorized | --ru (boolean)
- Specify this option to have the server certificate verified against the list of supplied CAs
-
--base-path | --bp (string)
- Specifies the base path used for connecting to Endevor Rest API
output customization options
-
--suppress-messages | --sm (boolean)
- Suppress all [INFO]/[WARN] messages from terminal output.
-
--report-file | --file-name (string)
- File name for saving reports from Endevor SCM locally.
-
--report-dir (string)
- Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
-
--write-report (boolean)
- Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
-
--full-output | --fo (boolean)
- Specify this option if you want a full output of list action.
asynchronous task options
Profile Options
-
--endevor-profile | --endevor-p (string)
- The name of a (endevor) profile to load for this command execution.
-
--endevor-location-profile | --endevor-location-p (string)
- The name of a (endevor-location) profile to load for this command execution.
-
--base-profile | --base-p (string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Response Format Options
-
--response-format-filter | --rff (array)
- Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
-
--response-format-type | --rft (string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.
list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.
object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header | --rfh (boolean)
- If "--response-format-type table" is specified, include the column headers in the output.
Examples
List the Endevor site symbols
Usage
zowe endevor list symbols [options]
endevor session definition options
-
--host | --hostname (string)
- Specifies the base host name.
-
--port | -p (string)
- Specifies the port number.
-
--protocol | --prot (string)
-
Specifies the protocol used for connecting to Endevor Rest API
Default value: https
Allowed values: http, https
-
--reject-unauthorized | --ru (boolean)
- Specify this option to have the server certificate verified against the list of supplied CAs
-
--base-path | --bp (string)
- Specifies the base path used for connecting to Endevor Rest API
-
--host | --hostname (string)
- Specifies the base host name.
-
--port | -p (string)
- Specifies the port number.
-
--protocol | --prot (string)
-
Specifies the protocol used for connecting to Endevor Rest API
Default value: https
Allowed values: http, https
-
--user | --username (string)
-
--password | --pass (string)
- Specifies the user's password.
-
--reject-unauthorized | --ru (boolean)
- Specify this option to have the server certificate verified against the list of supplied CAs
-
--base-path | --bp (string)
- Specifies the base path used for connecting to Endevor Rest API
endevor-location definition options
-
--instance | -i (string)
- Specifies Endevor Web Services dataSource name.
output customization options
-
--suppress-messages | --sm (boolean)
- Suppress all [INFO]/[WARN] messages from terminal output.
-
--report-file | --file-name (string)
- File name for saving reports from Endevor SCM locally.
-
--report-dir (string)
- Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
-
--write-report (boolean)
- Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
-
--full-output | --fo (boolean)
- Specify this option if you want a full output of list action.
asynchronous task options
Profile Options
-
--endevor-profile | --endevor-p (string)
- The name of a (endevor) profile to load for this command execution.
-
--endevor-location-profile | --endevor-location-p (string)
- The name of a (endevor-location) profile to load for this command execution.
-
--base-profile | --base-p (string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Response Format Options
-
--response-format-filter | --rff (array)
- Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
-
--response-format-type | --rft (string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.
list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.
object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header | --rfh (boolean)
- If "--response-format-type table" is specified, include the column headers in the output.
Examples
The list systems command lists system information in Endevor
Usage
zowe endevor list systems [system] [options]
Positional Arguments
-
system (string)
- Name of the Endevor system
endevor-location definition options
options
endevor session definition options
-
--host | --hostname (string)
- Specifies the base host name.
-
--port | -p (string)
- Specifies the port number.
-
--protocol | --prot (string)
-
Specifies the protocol used for connecting to Endevor Rest API
Default value: https
Allowed values: http, https
-
--user | --username (string)
-
--password | --pass (string)
- Specifies the user's password.
-
--reject-unauthorized | --ru (boolean)
- Specify this option to have the server certificate verified against the list of supplied CAs
-
--base-path | --bp (string)
- Specifies the base path used for connecting to Endevor Rest API
output customization options
-
--suppress-messages | --sm (boolean)
- Suppress all [INFO]/[WARN] messages from terminal output.
-
--report-file | --file-name (string)
- File name for saving reports from Endevor SCM locally.
-
--report-dir (string)
- Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
-
--write-report (boolean)
- Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
-
--full-output | --fo (boolean)
- Specify this option if you want a full output of list action.
asynchronous task options
Profile Options
-
--endevor-profile | --endevor-p (string)
- The name of a (endevor) profile to load for this command execution.
-
--endevor-location-profile | --endevor-location-p (string)
- The name of a (endevor-location) profile to load for this command execution.
-
--base-profile | --base-p (string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Response Format Options
-
--response-format-filter | --rff (array)
- Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
-
--response-format-type | --rft (string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.
list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.
object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header | --rfh (boolean)
- If "--response-format-type table" is specified, include the column headers in the output.
Examples
List asynchronous tasks submitted by this user
Usage
zowe endevor list tasks [task-id] [options]
Positional Arguments
-
task-id (string)
- The id of an asynchronous Endevor web service task.
asynchronous task options
-
--task-status (string)
-
Filter tasks by status: in-progress, finished or all.
Default value: all
Allowed values: inp, fin, all
endevor session definition options
-
--host | --hostname (string)
- Specifies the base host name.
-
--port | -p (string)
- Specifies the port number.
-
--protocol | --prot (string)
-
Specifies the protocol used for connecting to Endevor Rest API
Default value: https
Allowed values: http, https
-
--user | --username (string)
-
--password | --pass (string)
- Specifies the user's password.
-
--reject-unauthorized | --ru (boolean)
- Specify this option to have the server certificate verified against the list of supplied CAs
-
--base-path | --bp (string)
- Specifies the base path used for connecting to Endevor Rest API
endevor-location definition options
-
--instance | -i (string)
- Specifies Endevor Web Services dataSource name.
output customization options
-
--suppress-messages | --sm (boolean)
- Suppress all [INFO]/[WARN] messages from terminal output.
-
--report-file | --file-name (string)
- File name for saving reports from Endevor SCM locally.
-
--report-dir (string)
- Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
-
--write-report (boolean)
- Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
-
--full-output | --fo (boolean)
- Specify this option if you want a full output of list action.
Profile Options
-
--endevor-profile | --endevor-p (string)
- The name of a (endevor) profile to load for this command execution.
-
--endevor-location-profile | --endevor-location-p (string)
- The name of a (endevor-location) profile to load for this command execution.
-
--base-profile | --base-p (string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Response Format Options
-
--response-format-filter | --rff (array)
- Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
-
--response-format-type | --rft (string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.
list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.
object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header | --rfh (boolean)
- If "--response-format-type table" is specified, include the column headers in the output.
Examples
List the contents of the Endevor type sequence
Usage
zowe endevor list type-sequence [options]
endevor session definition options
-
--host | --hostname (string)
- Specifies the base host name.
-
--port | -p (string)
- Specifies the port number.
-
--protocol | --prot (string)
-
Specifies the protocol used for connecting to Endevor Rest API
Default value: https
Allowed values: http, https
-
--reject-unauthorized | --ru (boolean)
- Specify this option to have the server certificate verified against the list of supplied CAs
-
--base-path | --bp (string)
- Specifies the base path used for connecting to Endevor Rest API
-
--host | --hostname (string)
- Specifies the base host name.
-
--port | -p (string)
- Specifies the port number.
-
--protocol | --prot (string)
-
Specifies the protocol used for connecting to Endevor Rest API
Default value: https
Allowed values: http, https
-
--user | --username (string)
-
--password | --pass (string)
- Specifies the user's password.
-
--reject-unauthorized | --ru (boolean)
- Specify this option to have the server certificate verified against the list of supplied CAs
-
--base-path | --bp (string)
- Specifies the base path used for connecting to Endevor Rest API
endevor-location definition options
-
--instance | -i (string)
- Specifies Endevor Web Services dataSource name.
output customization options
-
--suppress-messages | --sm (boolean)
- Suppress all [INFO]/[WARN] messages from terminal output.
-
--report-file | --file-name (string)
- File name for saving reports from Endevor SCM locally.
-
--report-dir (string)
- Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
-
--write-report (boolean)
- Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
-
--full-output | --fo (boolean)
- Specify this option if you want a full output of list action.
asynchronous task options
Profile Options
-
--endevor-profile | --endevor-p (string)
- The name of a (endevor) profile to load for this command execution.
-
--endevor-location-profile | --endevor-location-p (string)
- The name of a (endevor-location) profile to load for this command execution.
-
--base-profile | --base-p (string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Response Format Options
-
--response-format-filter | --rff (array)
- Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
-
--response-format-type | --rft (string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.
list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.
object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header | --rfh (boolean)
- If "--response-format-type table" is specified, include the column headers in the output.
Examples
The list types command lists type information in Endevor
Usage
zowe endevor list types [type] [options]
Positional Arguments
endevor-location definition options
-
--environment | --env (string)
- The Endevor environment where your project resides.
-
--system | --sys (string)
- The Endevor system where your project resides.
-
--stage-number | --sn (string)
-
The Endevor stage number where your project resides.
Allowed values: \*, \%, 1, 2
-
--maxrc (number)
-
--instance | -i (string)
- Specifies Endevor Web Services dataSource name.
options
endevor session definition options
-
--host | --hostname (string)
- Specifies the base host name.
-
--port | -p (string)
- Specifies the port number.
-
--protocol | --prot (string)
-
Specifies the protocol used for connecting to Endevor Rest API
Default value: https
Allowed values: http, https
-
--user | --username (string)
-
--password | --pass (string)
- Specifies the user's password.
-
--reject-unauthorized | --ru (boolean)
- Specify this option to have the server certificate verified against the list of supplied CAs
-
--base-path | --bp (string)
- Specifies the base path used for connecting to Endevor Rest API
output customization options
-
--suppress-messages | --sm (boolean)
- Suppress all [INFO]/[WARN] messages from terminal output.
-
--report-file | --file-name (string)
- File name for saving reports from Endevor SCM locally.
-
--report-dir (string)
- Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
-
--write-report (boolean)
- Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
-
--full-output | --fo (boolean)
- Specify this option if you want a full output of list action.
asynchronous task options
Profile Options
-
--endevor-profile | --endevor-p (string)
- The name of a (endevor) profile to load for this command execution.
-
--endevor-location-profile | --endevor-location-p (string)
- The name of a (endevor-location) profile to load for this command execution.
-
--base-profile | --base-p (string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Response Format Options
-
--response-format-filter | --rff (array)
- Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
-
--response-format-type | --rft (string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.
list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.
object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header | --rfh (boolean)
- If "--response-format-type table" is specified, include the column headers in the output.
Examples
Merge Endevor elements from one Endevor location into another
Merge Endevor elements from one Endevor location into another. Requires an initialized Endevor workspace to perform conflict resolution. Use "synchronize workspace" command afterwards to push the result back into Endevor.
Usage
zowe endevor merge element [element] [options]
Positional Arguments
-
element (string)
- Name of the Endevor element
endevor-location definition options
-
--environment | --env (string)
- The Endevor environment where your project resides.
-
--system | --sys (string)
- The Endevor system where your project resides.
-
--subsystem | --sub (string)
- The Endevor subsystem where your project resides.
-
--type | --typ (string)
- Name of the Endevor element's type.
-
--stage-number | --sn (string)
-
The Endevor stage number where your project resides.
Allowed values: \*, \%, 1, 2
-
--ccid | --cci (string)
- The CCID you want to use when performing an Element action.
-
--comment | --com (string)
- The comment you want to have when performing an Element action
-
--instance | -i (string)
- Specifies Endevor Web Services dataSource name.
merge-location definition options
-
--merge-environment | --menv (string)
- Merge elements from this environment to the target environment (specified by 'environment'). Defaults to the same environment as the target.
-
--merge-stage-number | --msn (string)
- Merge elements from this stage number into the target stage number (specified by 'stage-number'). Defaults to the same stage number as the target.
-
--merge-system | --msys (string)
- Merge elements from this system into the target system (specified by 'system'). Defaults to the same system as the target.
-
--merge-subsystem | --msub (string)
- Merge elements from this subsystem into the target subsystem (specified by 'subsystem'). Defaults to the same subsystem as the target.
-
--merge-out-of-sync | --moos (boolean)
- Merge out-of-sync elements at the target location with their next version in the map, and attempt to resolve the out-of-sync during the next synchronization with Endevor.
workspace options
options
endevor session definition options
-
--host | --hostname (string)
- Specifies the base host name.
-
--port | -p (string)
- Specifies the port number.
-
--protocol | --prot (string)
-
Specifies the protocol used for connecting to Endevor Rest API
Default value: https
Allowed values: http, https
-
--user | --username (string)
-
--password | --pass (string)
- Specifies the user's password.
-
--reject-unauthorized | --ru (boolean)
- Specify this option to have the server certificate verified against the list of supplied CAs
-
--base-path | --bp (string)
- Specifies the base path used for connecting to Endevor Rest API
Profile Options
-
--endevor-profile | --endevor-p (string)
- The name of a (endevor) profile to load for this command execution.
-
--endevor-location-profile | --endevor-location-p (string)
- The name of a (endevor-location) profile to load for this command execution.
-
--base-profile | --base-p (string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Merge element ELEMENT1 of type COBPGM from subsystem SUBFROM into the same element found in subsystem SUBTO (system, stage and env taken from current location profile):
zowe endevor merge element ELEMENT1 --type COBPGM --subsystem SUBTO --merge-subsystem SUBFROM
-
Merge any elements that are currently out of sync with their next element version up the map (map location determined by current profile):
zowe endevor merge element * --merge-out-of-sync
-
Report which elements are currently out of sync with their next element version up the map, but do not merge them yet (map location determined by current profile):
zowe endevor merge element * --merge-out-of-sync --dry-run
-
Merge all elements from system SYSFROM, subsystem SUBFROM into matching elements in system SYSTO subsystem SUBTO (system, stage and env taken from current location profile):
zowe endevor merge element * --system SYSTO --subsystem SUBTO --merge-system SYSFROM --merge-subsystem SUBFROM
-
Merge element ELEMENT1 of type COBPGM from subsystem SUBFROM into SUBTO, retrieving both elements using the provided ccid & comment, with signout, and overriding signout if necessary:
zowe endevor merge element ELEMENT1 --type COBPGM --subsystem SUBTO --merge-subsystem SUBFROM --ccid MYCCID --comment 'my comment' --signout --overrride-signout
Move an Element in Endevor.
The move element command moves Elements between inventory locations along a map.
Usage
zowe endevor move element <element> [options]
Positional Arguments
-
element (string)
- Name of the Endevor element.
endevor-location definition options
-
--environment | --env (string)
- The Endevor environment where your project resides.
-
--system | --sys (string)
- The Endevor system where your project resides.
-
--subsystem | --sub (string)
- The Endevor subsystem where your project resides.
-
--type | --typ (string)
- Name of the Endevor element's type.
-
--stage-number | --sn (string)
-
--ccid | --cci (string)
- The CCID you want to use when performing an Element action.
-
--comment | --com (string)
- The comment you want to have when performing an Element action
-
--maxrc (number)
-
--instance | -i (string)
- Specifies Endevor Web Services dataSource name.
options
-
--proc-group | --pg (string)
- The Endevor processor group you would like to use.
-
--sync | -s (boolean)
- Specify if you want to synchronize source and current level of the Elements while performing this action.
-
--with-history | --wh (boolean)
- Specify if you want to preserve the change history of the Elements while performing this action.
-
--bypass-element-delete | --bed (boolean)
- Specify if you want to retain the Elements in the source Stage after successfully completing this action.
-
--retain-signout | --rs (boolean)
- Specify if you want to retain the source location signouts for all Elements at the target location while performing this action.
-
--signout-to | --st (string)
- Specify if you want to sign all Elements out to the specified user ID at the target Stage while performing this action.
-
--jump | -j (boolean)
- Specify if you want to move Elements across Environments even if those Elements exist at an intermediate Stage that is not on the map, while performing this action.
-
--where-ccid-all | --wca (string)
- Instructs Endevor to search both the Master Control File and the SOURCE DELTA levels for a specified CCIDs.
Accepts up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
-
--where-ccid-current | --wcc (string)
- Instructs Endevor to search through the CCID fields in the Master Control File to find a specified CCIDs.
Accept up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
-
--where-ccid-retrieve | --wcr (string)
- Instructs Endevor to use the CCID in the Master Control File RETRIEVE CCID field.
Accepts up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
-
--where-proc-group | --wpg (string)
- Lets you select Elements according to a specified Processor group. You can use a wildcard when specifying the Processor group name.
Accepts up to 8 Processor group names separated by ", ".
asynchronous task options
endevor session definition options
-
--host | --hostname (string)
- Specifies the base host name.
-
--port | -p (string)
- Specifies the port number.
-
--protocol | --prot (string)
-
Specifies the protocol used for connecting to Endevor Rest API
Default value: https
Allowed values: http, https
-
--user | --username (string)
-
--password | --pass (string)
- Specifies the user's password.
-
--reject-unauthorized | --ru (boolean)
- Specify this option to have the server certificate verified against the list of supplied CAs
-
--base-path | --bp (string)
- Specifies the base path used for connecting to Endevor Rest API
output customization options
Profile Options
-
--endevor-profile | --endevor-p (string)
- The name of a (endevor) profile to load for this command execution.
-
--endevor-location-profile | --endevor-location-p (string)
- The name of a (endevor-location) profile to load for this command execution.
-
--base-profile | --base-p (string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
Print an Element or a Component in Endevor.
The print component command prints selected component information about Element in Endevor.
Usage
zowe endevor print components <element> [options]
Positional Arguments
-
element (string)
- Name of the Endevor element.
endevor-location definition options
-
--environment | --env (string)
- The Endevor environment where your project resides.
-
--system | --sys (string)
- The Endevor system where your project resides.
-
--subsystem | --sub (string)
- The Endevor subsystem where your project resides.
-
--type | --typ (string)
- Name of the Endevor element's type.
-
--stage-number | --sn (string)
-
--maxrc (number)
-
--instance | -i (string)
- Specifies Endevor Web Services dataSource name.
options
-
--level | --lev (number)
- Indicates the level number of the element (use along with the version option).
-
--element-version | --ev (number)
- Indicates the version number of the element (use along with the level option).
-
--print-comp | --pc (string)
-
Specify the type of data to print out for print component command
Default value: browse
Allowed values: browse, changes, history, summary
-
--search | --sea (boolean)
- Enables the search through the Endevor map.
-
--headings (boolean)
- Specify it if you want to print a header on each page.
-
--explode | --exp | --ex (boolean)
- Specify to print component info from ACMQ.
-
--where-ccid-current | --wcc (string)
- Instructs Endevor to search through the CCID fields in the Master Control File to find a specified CCIDs.
Accept up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
-
--where-ccid-all | --wca (string)
- Instructs Endevor to search both the Master Control File and the SOURCE DELTA levels for a specified CCIDs.
Accepts up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
-
--where-ccid-retrieve | --wcr (string)
- Instructs Endevor to use the CCID in the Master Control File RETRIEVE CCID field.
Accepts up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
-
--where-proc-group | --wpg (string)
- Lets you select Elements according to a specified Processor group. You can use a wildcard when specifying the Processor group name.
Accepts up to 8 Processor group names separated by ", ".
-
--charset | --char (string)
output customization options
-
--to-file | --tf (string)
- The file name in which the data from the command output is stored
-
--suppress-messages | --sm (boolean)
- Suppress all [INFO]/[WARN] messages from terminal output.
-
--report-file | --file-name (string)
- File name for saving reports from Endevor SCM locally.
-
--report-dir (string)
- Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
-
--write-report (boolean)
- Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
endevor session definition options
-
--host | --hostname (string)
- Specifies the base host name.
-
--port | -p (string)
- Specifies the port number.
-
--protocol | --prot (string)
-
Specifies the protocol used for connecting to Endevor Rest API
Default value: https
Allowed values: http, https
-
--user | --username (string)
-
--password | --pass (string)
- Specifies the user's password.
-
--reject-unauthorized | --ru (boolean)
- Specify this option to have the server certificate verified against the list of supplied CAs
-
--base-path | --bp (string)
- Specifies the base path used for connecting to Endevor Rest API
Profile Options
-
--endevor-profile | --endevor-p (string)
- The name of a (endevor) profile to load for this command execution.
-
--endevor-location-profile | --endevor-location-p (string)
- The name of a (endevor-location) profile to load for this command execution.
-
--base-profile | --base-p (string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
The print element command prints selected information about Element in Endevor.
Usage
zowe endevor print element <element> [options]
Positional Arguments
-
element (string)
- Name of the Endevor element.
endevor-location definition options
-
--environment | --env (string)
- The Endevor environment where your project resides.
-
--system | --sys (string)
- The Endevor system where your project resides.
-
--subsystem | --sub (string)
- The Endevor subsystem where your project resides.
-
--type | --typ (string)
- Name of the Endevor element's type.
-
--stage-number | --sn (string)
-
The Endevor stage number where your project resides.
Allowed values: \*, \%, 1, 2
-
--maxrc (number)
-
--instance | -i (string)
- Specifies Endevor Web Services dataSource name.
options
-
--level | --lev (number)
- Indicates the level number of the element (use along with the version option).
-
--element-version | --ev (number)
- Indicates the version number of the element (use along with the level option).
-
--print (string)
-
Specify the type of data to print out for print element command
Default value: browse
Allowed values: browse, changes, history, summary, master, listing
-
--list-string | --ls (string)
- Specifies the one to eight character text-string used to identify the listing data set to print.
-
--search | --sea (boolean)
- Enables the search through the Endevor map.
-
--headings (boolean)
- Specify it if you want to print a header on each page.
-
--explode | --exp | --ex (boolean)
- Specify to print component info from ACMQ.
-
--expand-includes | --expand | --ei (boolean)
- Indicates that INCLUDE statements should be expanded in the course of the action.
-
--where-ccid-current | --wcc (string)
- Instructs Endevor to search through the CCID fields in the Master Control File to find a specified CCIDs.
Accept up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
-
--where-ccid-all | --wca (string)
- Instructs Endevor to search both the Master Control File and the SOURCE DELTA levels for a specified CCIDs.
Accepts up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
-
--where-ccid-retrieve | --wcr (string)
- Instructs Endevor to use the CCID in the Master Control File RETRIEVE CCID field.
Accepts up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
-
--where-proc-group | --wpg (string)
- Lets you select Elements according to a specified Processor group. You can use a wildcard when specifying the Processor group name.
Accepts up to 8 Processor group names separated by ", ".
-
--charset | --char (string)
asynchronous task options
output customization options
-
--to-file | --tf (string)
- The file name in which the data from the command output is stored
-
--suppress-messages | --sm (boolean)
- Suppress all [INFO]/[WARN] messages from terminal output.
-
--report-file | --file-name (string)
- File name for saving reports from Endevor SCM locally.
-
--report-dir (string)
- Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
-
--write-report (boolean)
- Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
endevor session definition options
-
--host | --hostname (string)
- Specifies the base host name.
-
--port | -p (string)
- Specifies the port number.
-
--protocol | --prot (string)
-
Specifies the protocol used for connecting to Endevor Rest API
Default value: https
Allowed values: http, https
-
--user | --username (string)
-
--password | --pass (string)
- Specifies the user's password.
-
--reject-unauthorized | --ru (boolean)
- Specify this option to have the server certificate verified against the list of supplied CAs
-
--base-path | --bp (string)
- Specifies the base path used for connecting to Endevor Rest API
Profile Options
-
--endevor-profile | --endevor-p (string)
- The name of a (endevor) profile to load for this command execution.
-
--endevor-location-profile | --endevor-location-p (string)
- The name of a (endevor-location) profile to load for this command execution.
-
--base-profile | --base-p (string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
The print member command prints a member from a specified dataset.
Usage
zowe endevor print member <member> [options]
Positional Arguments
input sources options
options
asynchronous task options
output customization options
-
--to-file | --tf (string)
- The file name in which the data from the command output is stored
-
--suppress-messages | --sm (boolean)
- Suppress all [INFO]/[WARN] messages from terminal output.
-
--report-file | --file-name (string)
- File name for saving reports from Endevor SCM locally.
-
--report-dir (string)
- Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
-
--write-report (boolean)
- Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
endevor session definition options
-
--host | --hostname (string)
- Specifies the base host name.
-
--port | -p (string)
- Specifies the port number.
-
--protocol | --prot (string)
-
Specifies the protocol used for connecting to Endevor Rest API
Default value: https
Allowed values: http, https
-
--user | --username (string)
-
--password | --pass (string)
- Specifies the user's password.
-
--reject-unauthorized | --ru (boolean)
- Specify this option to have the server certificate verified against the list of supplied CAs
-
--base-path | --bp (string)
- Specifies the base path used for connecting to Endevor Rest API
endevor-location definition options
-
--instance | -i (string)
- Specifies Endevor Web Services dataSource name.
Profile Options
-
--endevor-profile | --endevor-p (string)
- The name of a (endevor) profile to load for this command execution.
-
--endevor-location-profile | --endevor-location-p (string)
- The name of a (endevor-location) profile to load for this command execution.
-
--base-profile | --base-p (string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
Query Elements and information about their components in Endevor.
Query components used by a specified Element with the Endevor ACM Query facility.
Usage
zowe endevor queryacm components <element> [options]
Positional Arguments
-
element (string)
- Name of the Endevor element.
endevor-location definition options
-
--environment | --env (string)
- The Endevor environment where your project resides.
-
--system | --sys (string)
- The Endevor system where your project resides.
-
--subsystem | --sub (string)
- The Endevor subsystem where your project resides.
-
--type | --typ (string)
- Name of the Endevor element's type.
-
--stage-number | --sn (string)
-
The Endevor stage number where your project resides.
Allowed values: \*, \%, 1, 2
-
--maxrc (number)
-
--instance | -i (string)
- Specifies Endevor Web Services dataSource name.
options
-
--excCirculars | --exc (boolean)
- Filters the result to exclude components that have a circular relationship to the subject of your search.
-
--excIndirect | --exi (boolean)
- Filters the result to exclude indirectly related components.
-
--excRelated | --exr (boolean)
- Filters the result to exclude related components.
output customization options
-
--full-output | --fo (boolean)
- Specify this option if you want a full output of list action.
-
--suppress-messages | --sm (boolean)
- Suppress all [INFO]/[WARN] messages from terminal output.
-
--report-file | --file-name (string)
- File name for saving reports from Endevor SCM locally.
-
--report-dir (string)
- Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
-
--write-report (boolean)
- Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
asynchronous task options
endevor session definition options
-
--host | --hostname (string)
- Specifies the base host name.
-
--port | -p (string)
- Specifies the port number.
-
--protocol | --prot (string)
-
Specifies the protocol used for connecting to Endevor Rest API
Default value: https
Allowed values: http, https
-
--user | --username (string)
-
--password | --pass (string)
- Specifies the user's password.
-
--reject-unauthorized | --ru (boolean)
- Specify this option to have the server certificate verified against the list of supplied CAs
-
--base-path | --bp (string)
- Specifies the base path used for connecting to Endevor Rest API
Profile Options
-
--endevor-profile | --endevor-p (string)
- The name of a (endevor) profile to load for this command execution.
-
--endevor-location-profile | --endevor-location-p (string)
- The name of a (endevor-location) profile to load for this command execution.
-
--base-profile | --base-p (string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Response Format Options
-
--response-format-filter | --rff (array)
- Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
-
--response-format-type | --rft (string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.
list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.
object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header | --rfh (boolean)
- If "--response-format-type table" is specified, include the column headers in the output.
Examples
Reset a Package in Endevor.
The reset package command lets you set the status of a Package back to In-edit so you can modify it.
Usage
zowe endevor reset package [package] [options]
Positional Arguments
-
package (string)
- Name of the Endevor package.
endevor-location definition options
-
--maxrc (number)
-
--instance | -i (string)
- Specifies Endevor Web Services dataSource name.
asynchronous task options
endevor session definition options
-
--host | --hostname (string)
- Specifies the base host name.
-
--port | -p (string)
- Specifies the port number.
-
--protocol | --prot (string)
-
Specifies the protocol used for connecting to Endevor Rest API
Default value: https
Allowed values: http, https
-
--user | --username (string)
-
--password | --pass (string)
- Specifies the user's password.
-
--reject-unauthorized | --ru (boolean)
- Specify this option to have the server certificate verified against the list of supplied CAs
-
--base-path | --bp (string)
- Specifies the base path used for connecting to Endevor Rest API
output customization options
Profile Options
-
--endevor-profile | --endevor-p (string)
- The name of a (endevor) profile to load for this command execution.
-
--endevor-location-profile | --endevor-location-p (string)
- The name of a (endevor-location) profile to load for this command execution.
-
--base-profile | --base-p (string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
Retrieve an Element in Endevor.
The retrieve element command retrieves an existing element in Endevor.
Usage
zowe endevor retrieve element <element> [options]
Positional Arguments
-
element (string)
- Name of the Endevor element.
endevor-location definition options
-
--environment | --env (string)
- The Endevor environment where your project resides.
-
--system | --sys (string)
- The Endevor system where your project resides.
-
--subsystem | --sub (string)
- The Endevor subsystem where your project resides.
-
--type | --typ (string)
- Name of the Endevor element's type.
-
--stage-number | --sn (string)
-
The Endevor stage number where your project resides.
Allowed values: \*, \%, 1, 2
-
--ccid | --cci (string)
- The CCID you want to use when performing an Element action.
-
--comment | --com (string)
- The comment you want to have when performing an Element action
-
--maxrc (number)
-
--instance | -i (string)
- Specifies Endevor Web Services dataSource name.
options
-
--element-version | --ev (number)
- Indicates the version number of the element (use along with the level option).
-
--level | --lev (number)
- Indicates the level number of the element (use along with the version option).
-
--override-signout | --os (boolean)
- Specify if you want to override the Signout of an Endevor element while performing this action.
-
--signout (boolean)
- Specify if you want to perform the action with signing the element out.
-
--replace-member | --replace | --rm (boolean)
- Specify if you want to replace the member currently in the library with the new element contents
-
--expand-includes | --expand | --ei (boolean)
- Indicates that INCLUDE statements should be expanded in the course of the action.
-
--search | --sea (boolean)
- Enables the search through the Endevor map.
-
--get-fingerprint | --gfg (boolean)
-
--where-ccid-all | --wca (string)
- Instructs Endevor to search both the Master Control File and the SOURCE DELTA levels for a specified CCIDs.
Accepts up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
-
--where-ccid-current | --wcc (string)
- Instructs Endevor to search through the CCID fields in the Master Control File to find a specified CCIDs.
Accept up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
-
--where-ccid-retrieve | --wcr (string)
- Instructs Endevor to use the CCID in the Master Control File RETRIEVE CCID field.
Accepts up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
-
--where-proc-group | --wpg (string)
- Lets you select Elements according to a specified Processor group. You can use a wildcard when specifying the Processor group name.
Accepts up to 8 Processor group names separated by ", ".
-
--charset | --char (string)
output location options
-
--to-path | --tp (string)
- Provide a USS path to a destination location.
-
--to-uss-file | --tuf (string)
- Provide a USS file as a destination file.
-
--to-dataset | --td (string)
- Provide a destination data set name.
-
--to-member | --tm (string)
- Provide a destination member name inside the data set.
output customization options
-
--to-file | --tf (string)
- The file name in which the data from the command output is stored
-
--suppress-messages | --sm (boolean)
- Suppress all [INFO]/[WARN] messages from terminal output.
-
--report-file | --file-name (string)
- File name for saving reports from Endevor SCM locally.
-
--report-dir (string)
- Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
-
--write-report (boolean)
- Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
bulk action options
-
--to-dir | --tdir (string)
- Directory name in which the command output will be stored.
-
--flat (boolean)
- Store the output of the bulk action within one folder. When you use this option, ensure that the results do not contain duplicate names. (Duplicate names occur when two or more Elements have the same name and type.)
-
--with-dependencies | --wd (boolean)
- Retrieve Elements, including their Endevor-managed input components.
-
--where-ccid-generate | --wcg (string)
- Instructs Endevor to search using the generate CCID associated with an Element.
Accepts up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
-
--where-ccid-lastact | --wcla (string)
- Instructs Endevor to search using the last action CCID associated with an Element.
Accepts up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
-
--where-ccid-lastlvl | --wcll (string)
- Instructs Endevor to search using the last level CCID associated with an Element.
Accepts up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
-
--where-ccid-change | --wcchg (string)
- This option is only valid when the data option is ele or comp. Instructs Endevor to filter the results of the list data summary function that is based on the specified ccids.
Accepts up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
-
--file-extension | --ext (string)
-
The strategy for deciding what file extension to use during a bulk retrieve or workspace synchronization. Must be one of the following:
none: File name is equal to element name, no extension is added.
file\-ext: The file extension defined in the Type definition is used; If not defined, no extension is added.
type\-name: The type name is used as the file extension.
mixed: The file extension defined in Type definition is used; If not defined, the type name is used instead.
Default value: mixed
Allowed values: none, file-ext, type-name, mixed
endevor session definition options
-
--host | --hostname (string)
- Specifies the base host name.
-
--port | -p (string)
- Specifies the port number.
-
--protocol | --prot (string)
-
Specifies the protocol used for connecting to Endevor Rest API
Default value: https
Allowed values: http, https
-
--user | --username (string)
-
--password | --pass (string)
- Specifies the user's password.
-
--reject-unauthorized | --ru (boolean)
- Specify this option to have the server certificate verified against the list of supplied CAs
-
--base-path | --bp (string)
- Specifies the base path used for connecting to Endevor Rest API
Profile Options
-
--endevor-profile | --endevor-p (string)
- The name of a (endevor) profile to load for this command execution.
-
--endevor-location-profile | --endevor-location-p (string)
- The name of a (endevor-location) profile to load for this command execution.
-
--base-profile | --base-p (string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Response Format Options
-
--response-format-filter | --rff (array)
- Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
-
--response-format-type | --rft (string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.
list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.
object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header | --rfh (boolean)
- If "--response-format-type table" is specified, include the column headers in the output.
Examples
-
Retrieve element from specified inventory location to local file with endevor profile set up:
zowe endevor retrieve element elementName --env ENVNAME --sn 1 --sys SYSNAME --sub SUBNAME --typ TYPENAME --tf localfile.txt -i ENDEVOR
-
Bulk Retrieve elements with wildcarded element name and type, to local directory with endevor profile set up:
zowe endevor retrieve element "*" --env ENVNAME --sn 1 --sys SYSNAME --sub SUBNAME --typ "*" --to-dir /user/localdir -i ENDEVOR
Retrieve the result of an asynchronous task
Usage
zowe endevor retrieve result [task-id] [options]
Positional Arguments
-
task-id (string)
- The id of an asynchronous Endevor web service task.
endevor session definition options
-
--host | --hostname (string)
- Specifies the base host name.
-
--port | -p (string)
- Specifies the port number.
-
--protocol | --prot (string)
-
Specifies the protocol used for connecting to Endevor Rest API
Default value: https
Allowed values: http, https
-
--user | --username (string)
-
--password | --pass (string)
- Specifies the user's password.
-
--reject-unauthorized | --ru (boolean)
- Specify this option to have the server certificate verified against the list of supplied CAs
-
--base-path | --bp (string)
- Specifies the base path used for connecting to Endevor Rest API
endevor-location definition options
-
--instance | -i (string)
- Specifies Endevor Web Services dataSource name.
output customization options
Profile Options
-
--endevor-profile | --endevor-p (string)
- The name of a (endevor) profile to load for this command execution.
-
--endevor-location-profile | --endevor-location-p (string)
- The name of a (endevor-location) profile to load for this command execution.
-
--base-profile | --base-p (string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Response Format Options
-
--response-format-filter | --rff (array)
- Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
-
--response-format-type | --rft (string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.
list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.
object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header | --rfh (boolean)
- If "--response-format-type table" is specified, include the column headers in the output.
Examples
Signin an Element in Endevor.
The signin element command signs in an existing element in Endevor.
Usage
zowe endevor signin element <element> [options]
Positional Arguments
-
element (string)
- Name of the Endevor element.
endevor-location definition options
-
--environment | --env (string)
- The Endevor environment where your project resides.
-
--system | --sys (string)
- The Endevor system where your project resides.
-
--subsystem | --sub (string)
- The Endevor subsystem where your project resides.
-
--type | --typ (string)
- Name of the Endevor element's type.
-
--stage-number | --sn (string)
-
--ccid | --cci (string)
- The CCID you want to use when performing an Element action.
-
--comment | --com (string)
- The comment you want to have when performing an Element action
-
--maxrc (number)
-
--instance | -i (string)
- Specifies Endevor Web Services dataSource name.
options
-
--proc-group | --pg (string)
- The Endevor processor group you would like to use.
-
--search | --sea (boolean)
- Enables the search through the Endevor map.
-
--override-signout | --os (boolean)
- Specify if you want to override the Signout of an Endevor element while performing this action.
-
--signout-to | --st (string)
- Specify if you want to sign all Elements out to the specified user ID at the target Stage while performing this action.
-
--where-ccid-all | --wca (string)
- Instructs Endevor to search both the Master Control File and the SOURCE DELTA levels for a specified CCIDs.
Accepts up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
-
--where-ccid-current | --wcc (string)
- Instructs Endevor to search through the CCID fields in the Master Control File to find a specified CCIDs.
Accept up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
-
--where-ccid-retrieve | --wcr (string)
- Instructs Endevor to use the CCID in the Master Control File RETRIEVE CCID field.
Accepts up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
-
--where-proc-group | --wpg (string)
- Lets you select Elements according to a specified Processor group. You can use a wildcard when specifying the Processor group name.
Accepts up to 8 Processor group names separated by ", ".
asynchronous task options
endevor session definition options
-
--host | --hostname (string)
- Specifies the base host name.
-
--port | -p (string)
- Specifies the port number.
-
--protocol | --prot (string)
-
Specifies the protocol used for connecting to Endevor Rest API
Default value: https
Allowed values: http, https
-
--user | --username (string)
-
--password | --pass (string)
- Specifies the user's password.
-
--reject-unauthorized | --ru (boolean)
- Specify this option to have the server certificate verified against the list of supplied CAs
-
--base-path | --bp (string)
- Specifies the base path used for connecting to Endevor Rest API
output customization options
Profile Options
-
--endevor-profile | --endevor-p (string)
- The name of a (endevor) profile to load for this command execution.
-
--endevor-location-profile | --endevor-location-p (string)
- The name of a (endevor-location) profile to load for this command execution.
-
--base-profile | --base-p (string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
Submit a Package or a SCL file in Endevor.
The submit package command submits a JCL job stream to execute one or more Packages.
Usage
zowe endevor submit package [package] [options]
Positional Arguments
-
package (string)
- Name of the Endevor package.
input sources options
-
--from-file | --ff (string)
- Use this input to provide source file.
-
--from-dataset | --fd (string)
- Use this input to provide source data set name.
-
--from-member | --fm (string)
- Use this input to provide source member name in the data set.
output location options
options
-
--status | --st (string)
-
Specify the status of the packages. Valid values are [APPROVED, EXECFAILED] for execute action, and additional values [INEDIT, INAPPROVAL, INEXECUTION, EXECUTED, COMMITTED, DENIED] for list action, additional value [ALLSTATE] for delete action.
It is possible to specify multiple status separated by "," during list and delete package.
Allowed values: ALLSTATE, INEDIT, INAPPROVAL, APPROVED, INEXECUTION, EXECUTED, COMMITTED, DENIED, EXECFAILED
-
--multiple-streams | --ms (boolean)
- Specify to submit a separate, unique job for each package. If you do not specify this, a single job with a unique job step for each package is submitted.
-
--increment-jobname | --ij (boolean)
- Specify to increases the last character in the jobcard you provide.
-
--jcl-procedure | --jp (string)
- This option lets you to identify the name of the JCL procedure that you want to invoke. ENDEVOR is used by default if any processor is specified.
-
--CA7-dependent-job | --7dj (string)
- Specifies a single predecessor job which must complete while demanded job is waiting in the CA 7 scheduler.
endevor-location definition options
-
--maxrc (number)
-
--instance | -i (string)
- Specifies Endevor Web Services dataSource name.
asynchronous task options
endevor session definition options
-
--host | --hostname (string)
- Specifies the base host name.
-
--port | -p (string)
- Specifies the port number.
-
--protocol | --prot (string)
-
Specifies the protocol used for connecting to Endevor Rest API
Default value: https
Allowed values: http, https
-
--user | --username (string)
-
--password | --pass (string)
- Specifies the user's password.
-
--reject-unauthorized | --ru (boolean)
- Specify this option to have the server certificate verified against the list of supplied CAs
-
--base-path | --bp (string)
- Specifies the base path used for connecting to Endevor Rest API
output customization options
Profile Options
-
--endevor-profile | --endevor-p (string)
- The name of a (endevor) profile to load for this command execution.
-
--endevor-location-profile | --endevor-location-p (string)
- The name of a (endevor-location) profile to load for this command execution.
-
--base-profile | --base-p (string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
The submit scl commands submits a SCL file to be executed.
Usage
zowe endevor submit scl [options]
options
input sources options
endevor-location definition options
-
--maxrc (number)
-
--instance | -i (string)
- Specifies Endevor Web Services dataSource name.
asynchronous task options
endevor session definition options
-
--host | --hostname (string)
- Specifies the base host name.
-
--port | -p (string)
- Specifies the port number.
-
--protocol | --prot (string)
-
Specifies the protocol used for connecting to Endevor Rest API
Default value: https
Allowed values: http, https
-
--user | --username (string)
-
--password | --pass (string)
- Specifies the user's password.
-
--reject-unauthorized | --ru (boolean)
- Specify this option to have the server certificate verified against the list of supplied CAs
-
--base-path | --bp (string)
- Specifies the base path used for connecting to Endevor Rest API
output customization options
Profile Options
-
--endevor-profile | --endevor-p (string)
- The name of a (endevor) profile to load for this command execution.
-
--endevor-location-profile | --endevor-location-p (string)
- The name of a (endevor-location) profile to load for this command execution.
-
--base-profile | --base-p (string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
Synchronize remote Endevor inventory with the local Endevor workspace.
Synchronize a selected subset of remote Endevor inventory with a local Endevor workspace
Usage
zowe endevor synchronize workspace [workspace-dir] [options]
Positional Arguments
-
workspace-dir (string)
- The Endevor workspace directory, if different from current working directory.
endevor-location definition options
-
--environment | --env (string)
- The Endevor environment where your project resides.
-
--system | --sys (string)
- The Endevor system where your project resides.
-
--subsystem | --sub (string)
- The Endevor subsystem where your project resides.
-
--type | --typ (string)
- Name of the Endevor element's type.
-
--stage-number | --sn (string)
-
The Endevor stage number where your project resides.
Allowed values: \*, \%, 1, 2
-
--ccid | --cci (string)
- The CCID you want to use when performing an Element action.
-
--comment | --com (string)
- The comment you want to have when performing an Element action
-
--instance | -i (string)
- Specifies Endevor Web Services dataSource name.
options
workspace options
-
--element | --ele | --elem (string)
-
--dry-run | --dr (boolean)
- List all actions the synchronization would perform, without executing them.
-
--reset | --rst (boolean)
- Revert any local changes, resetting the local workspace to match the current state of the remote Endevor inventory.
-
--limit | --lim (number)
-
--one-way (boolean)
- Do not update Endevor elements with local changes, only retrieve remote changes from Endevor and resolve any conflicts.
-
--allow-deletes | --del (boolean)
- Allow workspace synchronization to delete unchanged Endevor elements when it detects the corresponding local files have been deleted. Default is off to maintain backward compatibility.
-
--file-extension | --ext (string)
-
The strategy for deciding what file extension to use during a bulk retrieve or workspace synchronization. Must be one of the following:
none: File name is equal to element name, no extension is added.
file\-ext: The file extension defined in the Type definition is used; If not defined, no extension is added.
type\-name: The type name is used as the file extension.
mixed: The file extension defined in Type definition is used; If not defined, the type name is used instead.
Default value: mixed
Allowed values: none, file-ext, type-name, mixed
endevor session definition options
-
--host | --hostname (string)
- Specifies the base host name.
-
--port | -p (string)
- Specifies the port number.
-
--protocol | --prot (string)
-
Specifies the protocol used for connecting to Endevor Rest API
Default value: https
Allowed values: http, https
-
--user | --username (string)
-
--password | --pass (string)
- Specifies the user's password.
-
--reject-unauthorized | --ru (boolean)
- Specify this option to have the server certificate verified against the list of supplied CAs
-
--base-path | --bp (string)
- Specifies the base path used for connecting to Endevor Rest API
Profile Options
-
--endevor-profile | --endevor-p (string)
- The name of a (endevor) profile to load for this command execution.
-
--endevor-location-profile | --endevor-location-p (string)
- The name of a (endevor-location) profile to load for this command execution.
-
--base-profile | --base-p (string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Synchronize all elements in the map location defined by the currently active endevor-location profile with current directory:
zowe endevor synchronize workspace
-
Synchronize all elements in the map location defined by the currently active endevor-location profile with workspace directory 'C:/projects/myWorkspace':
zowe endevor synchronize workspace 'C:/projects/myWorkspace'
-
Synchronize all elements in system SYSTEM1 subsystem SUBSYS1 from environment DEV stage 1, whose type begins with 'ASM', with current directory:
zowe endevor synchronize workspace --environment DEV --stage_number 1 --system SYSTEM1 --subsystem SUBSYS1 --type ASM* --ccid myccid --comment 'my changes'
-
Synchronize all elements in the map location defined by the currently active endevor-location profile, whose name is 'PRFX' followed by any 2 characters and ending with '11', with workspace directory 'C:/projects/myWorkspace':
zowe endevor synchronize workspace 'C:/projects/myWorkspace' --ccid myccid --comment 'my changes' --element PRFX%%11
-
Display all actions needed to synchronize all elements in the map location defined by endevor-location profile 'mysandbox' with current directory, without performing them:
zowe endevor synchronize workspace --dry-run --endevor-location-profile mysandbox
-
Revert all local changes in the map location defined by the currently active endevor-location profile, resetting your workspace to match Endevor:
zowe endevor synchronize workspace --reset
Transfer an Element in Endevor.
The Transfer element command transfers Elements from one Endevor location to another.
Usage
zowe endevor transfer element <element> [options]
Positional Arguments
-
element (string)
- Name of the Endevor element.
endevor-location definition options
-
--environment | --env (string)
- The Endevor environment where your project resides.
-
--system | --sys (string)
- The Endevor system where your project resides.
-
--subsystem | --sub (string)
- The Endevor subsystem where your project resides.
-
--type | --typ (string)
- Name of the Endevor element's type.
-
--stage-number | --sn (string)
-
--ccid | --cci (string)
- The CCID you want to use when performing an Element action.
-
--comment | --com (string)
- The comment you want to have when performing an Element action
-
--maxrc (number)
-
--instance | -i (string)
- Specifies Endevor Web Services dataSource name.
output location options
-
--to-environment | --toenv (string)
- The target Endevor environment.
-
--to-system | --tosys (string)
- The target Endevor system.
-
--to-subsystem | --tosub (string)
- The target Endevor subsystem.
-
--to-element | --toele (string)
- The target Endevor element name.
-
--to-type | --totyp (string)
- The target Endevor element type.
-
--to-stage-number | --tosn (string)
- The target Endevor stage Id/number.
options
-
--proc-group | --pg (string)
- The Endevor processor group you would like to use.
-
--element-version | --ev (number)
- Indicates the version number of the element (use along with the level option).
-
--level | --lev (number)
- Indicates the level number of the element (use along with the version option).
-
--new-version | --nv (number)
- Assign a different version number to the Element.
-
--sync | -s (boolean)
- Specify if you want to synchronize source and current level of the Elements while performing this action.
-
--with-history | --wh (boolean)
- Specify if you want to preserve the change history of the Elements while performing this action.
-
--ignore-generate-failed | --igf (boolean)
- Process the transfer request regardless of whether the FAILED flag is set for the element or if the element was generated or moved successfully.
-
--bypass-element-delete | --bed (boolean)
- Specify if you want to retain the Elements in the source Stage after successfully completing this action.
-
--bypass-delete-proc | --bdp (boolean)
- Specity to bypasses the execution of the delete processor.
-
--bypass-generate-proc | --bgp (boolean)
- Specify to bypasses the execution of the generate or move processor (whichever may be chosen) upon element transfer.
-
--retain-signout | --rs (boolean)
- Specify if you want to retain the source location signouts for all Elements at the target location while performing this action.
-
--signout-to | --st (string)
- Specify if you want to sign all Elements out to the specified user ID at the target Stage while performing this action.
-
--override-signout | --os (boolean)
- Specify if you want to override the Signout of an Endevor element while performing this action.
-
--where-proc-group | --wpg (string)
- Lets you select Elements according to a specified Processor group. You can use a wildcard when specifying the Processor group name.
Accepts up to 8 Processor group names separated by ", ".
-
--where-ccid-all | --wca (string)
- Instructs Endevor to search both the Master Control File and the SOURCE DELTA levels for a specified CCIDs.
Accepts up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
-
--where-ccid-current | --wcc (string)
- Instructs Endevor to search through the CCID fields in the Master Control File to find a specified CCIDs.
Accept up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
-
--where-ccid-retrieve | --wcr (string)
- Instructs Endevor to use the CCID in the Master Control File RETRIEVE CCID field.
Accepts up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
asynchronous task options
endevor session definition options
-
--host | --hostname (string)
- Specifies the base host name.
-
--port | -p (string)
- Specifies the port number.
-
--protocol | --prot (string)
-
Specifies the protocol used for connecting to Endevor Rest API
Default value: https
Allowed values: http, https
-
--user | --username (string)
-
--password | --pass (string)
- Specifies the user's password.
-
--reject-unauthorized | --ru (boolean)
- Specify this option to have the server certificate verified against the list of supplied CAs
-
--base-path | --bp (string)
- Specifies the base path used for connecting to Endevor Rest API
output customization options
Profile Options
-
--endevor-profile | --endevor-p (string)
- The name of a (endevor) profile to load for this command execution.
-
--endevor-location-profile | --endevor-location-p (string)
- The name of a (endevor-location) profile to load for this command execution.
-
--base-profile | --base-p (string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
Remove a synchronized Endevor inventory from a local Endevor workspace and delete any related metadata.
Remove a selected subset of remote Endevor inventory from a local Endevor workspace
Usage
zowe endevor unsynchronize workspace [workspace-dir] [options]
Positional Arguments
-
workspace-dir (string)
- The Endevor workspace directory, if different from current working directory.
endevor-location definition options
-
--environment | --env (string)
- The Endevor environment where your project resides.
-
--system | --sys (string)
- The Endevor system where your project resides.
-
--subsystem | --sub (string)
- The Endevor subsystem where your project resides.
-
--type | --typ (string)
- Name of the Endevor element's type.
-
--stage-number | --sn (string)
-
The Endevor stage number where your project resides.
Allowed values: \*, \%, 1, 2
-
--instance | -i (string)
- Specifies Endevor Web Services dataSource name.
workspace options
endevor session definition options
-
--host | --hostname (string)
- Specifies the base host name.
-
--port | -p (string)
- Specifies the port number.
-
--protocol | --prot (string)
-
Specifies the protocol used for connecting to Endevor Rest API
Default value: https
Allowed values: http, https
-
--user | --username (string)
-
--password | --pass (string)
- Specifies the user's password.
-
--reject-unauthorized | --ru (boolean)
- Specify this option to have the server certificate verified against the list of supplied CAs
-
--base-path | --bp (string)
- Specifies the base path used for connecting to Endevor Rest API
Profile Options
-
--endevor-profile | --endevor-p (string)
- The name of a (endevor) profile to load for this command execution.
-
--endevor-location-profile | --endevor-location-p (string)
- The name of a (endevor-location) profile to load for this command execution.
-
--base-profile | --base-p (string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Remove all elements in the map location defined by the currently active endevor-location profile from current directory:
zowe endevor unsynchronize workspace
-
Remove all elements in the map location defined by the currently active endevor-location profile from current directory, throwing away any local changes not saved in Endevor:
zowe endevor unsynchronize workspace --force
-
Remove all elements in the map location defined by the currently active endevor-location profile from workspace directory 'C:/projects/myWorkspace':
zowe endevor unsynchronize workspace 'C:/projects/myWorkspace'
-
Remove all elements in system SYSTEM1 subsystem SUBSYS1 environment DEV stage 1, whose type begins with 'ASM', from current directory:
zowe endevor unsynchronize workspace --environment DEV --stage_number 1 --system SYSTEM1 --subsystem SUBSYS1 --type ASM* --ccid myccid --comment 'my changes'
Update an Element or a Package in Endevor.
The update element command updates an Element in the entry Stage, thereby creating a new level for the Element in the entry Stage.
Usage
zowe endevor update element <element> [options]
Positional Arguments
-
element (string)
- Name of the Endevor element.
input sources options
-
--from-file | --ff (string)
- Use this input to provide source file.
-
--from-dataset | --fd (string)
- Use this input to provide source data set name.
-
--from-member | --fm (string)
- Use this input to provide source member name in the data set.
-
--from-path | --fp (string)
- Use this input to provide the path of source USS file. It must be used with from-uss-file.
-
--from-uss-file | --fuf (string)
- Use this input to provide source USS file name. It must be used with from-path
endevor-location definition options
-
--environment | --env (string)
- The Endevor environment where your project resides.
-
--system | --sys (string)
- The Endevor system where your project resides.
-
--subsystem | --sub (string)
- The Endevor subsystem where your project resides.
-
--type | --typ (string)
- Name of the Endevor element's type.
-
--ccid | --cci (string)
- The CCID you want to use when performing an Element action.
-
--comment | --com (string)
- The comment you want to have when performing an Element action
-
--maxrc (number)
-
--instance | -i (string)
- Specifies Endevor Web Services dataSource name.
options
-
--override-signout | --os (boolean)
- Specify if you want to override the Signout of an Endevor element while performing this action.
-
--proc-group | --pg (string)
- The Endevor processor group you would like to use.
-
--generate | -g (boolean)
- Specifies if you want to Generate Element after Add/Update action.
-
--get-fingerprint | --gfg (boolean)
-
--fingerprint | --fg (string)
- Specifies the fingerprint of the element to Add or Update. Use value 'NEW' when adding a new element that shouldn't exist in the map yet.
-
--charset | --char (string)
-
--sync | -s (boolean)
- Specify if you want to synchronize source and current level of the Elements while performing this action.
-
--sync-with-history | --swh (boolean)
- Specify if you want to preserve the change history of the Elements while performing the synchronization during element update.
-
--sync-fingerprint | --sfg (string)
- Specifies the fingerprint of the element directly up the map that the updated element should be synchronized with. Prevents the sync if the element up the map doesn't match the fingerprint.
endevor session definition options
-
--host | --hostname (string)
- Specifies the base host name.
-
--port | -p (string)
- Specifies the port number.
-
--protocol | --prot (string)
-
Specifies the protocol used for connecting to Endevor Rest API
Default value: https
Allowed values: http, https
-
--user | --username (string)
-
--password | --pass (string)
- Specifies the user's password.
-
--reject-unauthorized | --ru (boolean)
- Specify this option to have the server certificate verified against the list of supplied CAs
-
--base-path | --bp (string)
- Specifies the base path used for connecting to Endevor Rest API
output customization options
Profile Options
-
--endevor-profile | --endevor-p (string)
- The name of a (endevor) profile to load for this command execution.
-
--endevor-location-profile | --endevor-location-p (string)
- The name of a (endevor-location) profile to load for this command execution.
-
--base-profile | --base-p (string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
The update package command lets you update a package in Endevor.
Usage
zowe endevor update package [package] [options]
Positional Arguments
-
package (string)
- Name of the Endevor package.
input sources options
-
--from-file | --ff (string)
- Use this input to provide source file.
-
--from-dataset | --fd (string)
- Use this input to provide source data set name.
-
--from-member | --fm (string)
- Use this input to provide source member name in the data set.
-
--from-package | --fp (string)
- Directs the Create/Update action to copy the SCL from the package you specify into the package you are creating or updating.
-
--from-text | --ft (string)
- Provides a string to use as input SCL.
options
-
--description | -d (string)
- Allows you to associate a 50-character description when creating or updating package.
-
--from-date-time | --fdt (string)
- Specify the beginning of time frame within which the package can be executed. Use yyyy-mm-ddThh:mm or see ISO 8601 standard for syntax.
-
--to-date-time | --tdt (string)
- Specify the end of time frame within which the package can be executed. Use yyyy-mm-ddThh:mm or see ISO 8601 standard for syntax.
-
--backout (boolean)
-
--notes | -n (string)
-
--notes-from-file | --nff (string)
- Local file of notes for package.
-
--emergency-package | --ep (boolean)
- Specify if the package should be an emergency package. When not specified, the package is a standard package.
-
--sharable | --sh (boolean)
- Specify this option if the package can be edited by more than one person when in In-edit status.
-
--promotion | --pr (boolean)
- Specify this option to define the package as a promotion package.
-
--validate-scl | --vs (boolean)
-
--append | -a (boolean)
- Specify this option to append the SCL you are adding to the existing package SCL. Otherwise it would be replaced.
endevor-location definition options
-
--maxrc (number)
-
--instance | -i (string)
- Specifies Endevor Web Services dataSource name.
endevor session definition options
-
--host | --hostname (string)
- Specifies the base host name.
-
--port | -p (string)
- Specifies the port number.
-
--protocol | --prot (string)
-
Specifies the protocol used for connecting to Endevor Rest API
Default value: https
Allowed values: http, https
-
--user | --username (string)
-
--password | --pass (string)
- Specifies the user's password.
-
--reject-unauthorized | --ru (boolean)
- Specify this option to have the server certificate verified against the list of supplied CAs
-
--base-path | --bp (string)
- Specifies the base path used for connecting to Endevor Rest API
output customization options
Profile Options
-
--endevor-profile | --endevor-p (string)
- The name of a (endevor) profile to load for this command execution.
-
--endevor-location-profile | --endevor-location-p (string)
- The name of a (endevor-location) profile to load for this command execution.
-
--base-profile | --base-p (string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
View an Element or a Package SCL in Endevor.
The view element command views an existing element in Endevor.
Usage
zowe endevor view element <element> [options]
Positional Arguments
-
element (string)
- Name of the Endevor element.
endevor-location definition options
-
--environment | --env (string)
- The Endevor environment where your project resides.
-
--system | --sys (string)
- The Endevor system where your project resides.
-
--subsystem | --sub (string)
- The Endevor subsystem where your project resides.
-
--type | --typ (string)
- Name of the Endevor element's type.
-
--stage-number | --sn (string)
-
--ccid | --cci (string)
- The CCID you want to use when performing an Element action.
-
--comment | --com (string)
- The comment you want to have when performing an Element action
-
--maxrc (number)
-
--instance | -i (string)
- Specifies Endevor Web Services dataSource name.
options
-
--element-version | --ev (number)
- Indicates the version number of the element (use along with the level option).
-
--level | --lev (number)
- Indicates the level number of the element (use along with the version option).
-
--search | --sea (boolean)
- Enables the search through the Endevor map.
-
--where-ccid-all | --wca (string)
- Instructs Endevor to search both the Master Control File and the SOURCE DELTA levels for a specified CCIDs.
Accepts up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
-
--where-ccid-current | --wcc (string)
- Instructs Endevor to search through the CCID fields in the Master Control File to find a specified CCIDs.
Accept up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
-
--where-ccid-retrieve | --wcr (string)
- Instructs Endevor to use the CCID in the Master Control File RETRIEVE CCID field.
Accepts up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
-
--where-proc-group | --wpg (string)
- Lets you select Elements according to a specified Processor group. You can use a wildcard when specifying the Processor group name.
Accepts up to 8 Processor group names separated by ", ".
-
--charset | --char (string)
output customization options
-
--to-file | --tf (string)
- The file name in which the data from the command output is stored
-
--suppress-messages | --sm (boolean)
- Suppress all [INFO]/[WARN] messages from terminal output.
-
--report-file | --file-name (string)
- File name for saving reports from Endevor SCM locally.
-
--report-dir (string)
- Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
-
--write-report (boolean)
- Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
asynchronous task options
endevor session definition options
-
--host | --hostname (string)
- Specifies the base host name.
-
--port | -p (string)
- Specifies the port number.
-
--protocol | --prot (string)
-
Specifies the protocol used for connecting to Endevor Rest API
Default value: https
Allowed values: http, https
-
--user | --username (string)
-
--password | --pass (string)
- Specifies the user's password.
-
--reject-unauthorized | --ru (boolean)
- Specify this option to have the server certificate verified against the list of supplied CAs
-
--base-path | --bp (string)
- Specifies the base path used for connecting to Endevor Rest API
Profile Options
-
--endevor-profile | --endevor-p (string)
- The name of a (endevor) profile to load for this command execution.
-
--endevor-location-profile | --endevor-location-p (string)
- The name of a (endevor-location) profile to load for this command execution.
-
--base-profile | --base-p (string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
The view pkgscl command views the SCL of an existing package in Endevor.
Usage
zowe endevor view pkgscl [package] [options]
Positional Arguments
-
package (string)
- Name of the Endevor package.
endevor-location definition options
-
--maxrc (number)
-
--instance | -i (string)
- Specifies Endevor Web Services dataSource name.
output customization options
-
--to-file | --tf (string)
- The file name in which the data from the command output is stored
-
--suppress-messages | --sm (boolean)
- Suppress all [INFO]/[WARN] messages from terminal output.
-
--report-file | --file-name (string)
- File name for saving reports from Endevor SCM locally.
-
--report-dir (string)
- Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
-
--write-report (boolean)
- Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
endevor session definition options
-
--host | --hostname (string)
- Specifies the base host name.
-
--port | -p (string)
- Specifies the port number.
-
--protocol | --prot (string)
-
Specifies the protocol used for connecting to Endevor Rest API
Default value: https
Allowed values: http, https
-
--user | --username (string)
-
--password | --pass (string)
- Specifies the user's password.
-
--reject-unauthorized | --ru (boolean)
- Specify this option to have the server certificate verified against the list of supplied CAs
-
--base-path | --bp (string)
- Specifies the base path used for connecting to Endevor Rest API
Profile Options
-
--endevor-profile | --endevor-p (string)
- The name of a (endevor) profile to load for this command execution.
-
--endevor-location-profile | --endevor-location-p (string)
- The name of a (endevor-location) profile to load for this command execution.
-
--base-profile | --base-p (string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
Validates the accuracy of job control language (JCL) and also helps identify execution-time errors, such as security violations and missing data sets that could cause jobs to fail.
Perform a check on JCL that is contained in an MVS data set or a local file.
Reads the specified input data set and invokes the JCLCheck service with the data set contents.
Usage
zowe jclcheck check data-set <dataSet> [options]
Positional Arguments
-
dataSet (string)
- The MVS data set containing the JCL contents. The data set can be a physical sequential (PS) or partitioned data set (PDS) member. The data set attributes must be recfm fixed-block (FB) and lrecl 80. The data set must be catalogued.
Options
JCLCheck Connection Options
-
--host | -H (string)
- Host name of the JCLCheck API service that is running on the mainframe system.
-
--port | -P (number)
-
--user | -u (string)
- User name for authenticating connections to the JCLCheck API service that is running on the mainframe system.
-
--password | --pass | --pw (string)
- Password for authenticating connections to the JCLCheck API service that is running on the mainframe system.
-
--base-path | --bp (string)
-
The base path for your 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 API mediation layer.
Default value: cajclcheck/api/v1
-
--reject-unauthorized | --ru (boolean)
-
--protocol | -o (string)
-
Specifies protocol to use for JCLCheck connection (http or https).
Default value: https
Allowed values: http, https
-
--jclcheck-options | --jo (string)
- The desired set of JCLCheck runtime options. Specify the options exactly as you would on the PARM= or OPTIONS DD on a batch run of JCLCheck. See the JCLCheck runtime options documentation for details on available runtime options. If you specify options that change the format of the JCLCheck reports, you should request '--raw-output'. Changing the format of the report will affect the ability to produce a structured API response.
Profile Options
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
Reads the contents of the local file specified and invokes the JCLCheck service with the JCL contents.
Usage
zowe jclcheck check local-file <localFile> [options]
Positional Arguments
-
localFile (string)
- The local file containing the JCL to check. The local JCL file can contain a single job or multiple jobs (specified one after another without blank lines or line breaks). The JCL lines in the file must not exceed 80 characters.
Options
JCLCheck Connection Options
-
--host | -H (string)
- Host name of the JCLCheck API service that is running on the mainframe system.
-
--port | -P (number)
-
--user | -u (string)
- User name for authenticating connections to the JCLCheck API service that is running on the mainframe system.
-
--password | --pass | --pw (string)
- Password for authenticating connections to the JCLCheck API service that is running on the mainframe system.
-
--base-path | --bp (string)
-
The base path for your 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 API mediation layer.
Default value: cajclcheck/api/v1
-
--reject-unauthorized | --ru (boolean)
-
--protocol | -o (string)
-
Specifies protocol to use for JCLCheck connection (http or https).
Default value: https
Allowed values: http, https
-
--jclcheck-options | --jo (string)
- The desired set of JCLCheck runtime options. Specify the options exactly as you would on the PARM= or OPTIONS DD on a batch run of JCLCheck. See the JCLCheck runtime options documentation for details on available runtime options. If you specify options that change the format of the JCLCheck reports, you should request '--raw-output'. Changing the format of the report will affect the ability to produce a structured API response.
Profile Options
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
The MAT Analyze plug-in for ZOWE CLI enables you to manage monitor profiles and get the measurement analysis data using Mainframe Application Tuner (MAT)
Get monitor history and measurement analysis data from MAT.
Get the CodeView measurement details.
Get the CodeView CallerID details for the specific CSECT and module.
Usage
zowe mat monitor codeview callerid [options]
Options
-
--profile (string)
- Specifies the name of the profile that you want to analyze. When you specify the profile name, you get the data for the latest measurement within the specified profile.
-
--mon_num (number)
- Specifies the unique monitor number of the measurement.
-
--module (string)
- Specifies the module name that you request the CallerID details for. You get the module value from the 'codeview csect' command response. The module name can be empty (e.g., --module "IGZCPAC" or --module '""').
-
--csect (string)
- Specifies the CSECT name that you request the CallerID details for. You get the csect value from the 'codeview csect' command response. The CSECT name can be empty (e.g., --csect "TUNCOB01" or --csect '""').
MAT Profile Options
-
--protocol | -o (string)
-
Specifies the protocol defined for the MAT REST API server (http or https).
Default value: https
Allowed values: http, https
-
--host | -H (string)
- Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost).
-
--port | -P (number)
- Specifies the server port (e.g. 8080).
-
--user | -u (string)
-
--password | --pw (string)
-
--base-path | --bp (string)
- The base path for your 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 API mediation layer.
-
--reject-unauthorized | --ru (boolean)
-
--listingDir | --ldir (string)
- Specifies the directory where you want to store the registered program listings (e.g. 'c:\listings') for your immediate source code inspection. You can use the advantage of automated listing registration with MAT and listing retrieval through Endevor® footprints for Cobol, C/C++, and Assembler programs. When a source program listing is registered with MAT, you can enhance the histogram analysis data with the program listing details that pertain to the specific CSECT and program statement. The listing is transfered to the specified directory, which enables you to navigate directly to the line of the source code in you VS Code IDE and inspect the program statement. To use the listing retrieval option through Endevor® footprints, you need to have the Endevor® Web Services installed and configured and specify the Endevor® web server details in the MAT database configuration.
Profile Options
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Get the CallerID details for monitor number 5, CSECT name TUNCOB01, and module name RUNCOB:
zowe mat monitor codeview callerid --mon_num 5 --csect "TUNCOB01" --module "RUNCOB"
-
Get the CallerID details for the latest monitor in the TESTPROF profile for CSECT name TUNCOB01 and empty module name:
zowe mat monitor codeview callerid --profile TESTPROF --csect "TUNCOB01" --module '""'
-
Get the CallerID details for monitor number 5, CSECT name TUNCOB01, and module name RUNCOB, with the specific MAT profile details defined:
zowe mat monitor codeview callerid --mon_num 5 --csect "TUNCOB01" --module "RUNCOB" --host "example.com" --port 12345 --user johndoe --password qwerty
Get the CodeView measurement details in Csect mode.
Usage
zowe mat monitor codeview csect [options]
Options
-
--profile (string)
- Specifies the name of the profile that you want to analyze. When you specify the profile name, you get the data for the latest measurement within the specified profile.
-
--mon_num (number)
- Specifies the unique monitor number of the measurement.
MAT Profile Options
-
--protocol | -o (string)
-
Specifies the protocol defined for the MAT REST API server (http or https).
Default value: https
Allowed values: http, https
-
--host | -H (string)
- Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost).
-
--port | -P (number)
- Specifies the server port (e.g. 8080).
-
--user | -u (string)
-
--password | --pw (string)
-
--base-path | --bp (string)
- The base path for your 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 API mediation layer.
-
--reject-unauthorized | --ru (boolean)
-
--listingDir | --ldir (string)
- Specifies the directory where you want to store the registered program listings (e.g. 'c:\listings') for your immediate source code inspection. You can use the advantage of automated listing registration with MAT and listing retrieval through Endevor® footprints for Cobol, C/C++, and Assembler programs. When a source program listing is registered with MAT, you can enhance the histogram analysis data with the program listing details that pertain to the specific CSECT and program statement. The listing is transfered to the specified directory, which enables you to navigate directly to the line of the source code in you VS Code IDE and inspect the program statement. To use the listing retrieval option through Endevor® footprints, you need to have the Endevor® Web Services installed and configured and specify the Endevor® web server details in the MAT database configuration.
Profile Options
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Get the CodeView measurement details in Csect mode for monitor number 5:
zowe mat monitor codeview csect --mon_num 5
-
Get the CodeView measurement details in Csect mode for the latest monitor in the TESTPROF profile:
zowe mat monitor codeview csect --profile TESTPROF
-
Get the CodeView measurement details in Csect mode for monitor number 5, with the specific MAT profile details defined:
zowe mat monitor codeview csect --mon_num 5 --host "example.com" --port 12345 --user johndoe --password qwerty
Get the Histogram details for the measurement.
Usage
zowe mat monitor codeview histogram [options]
Options
-
--profile (string)
- Specifies the name of the profile that you want to analyze. When you specify the profile name, you get the data for the latest measurement within the specified profile.
-
--mon_num (number)
- Specifies the unique monitor number of the measurement.
-
--module (string)
- Specifies the module name that you request the Histogram data for. You get the module value from the 'codeview csect' command response. The module name can be empty (e.g., --module "IGZCPAC" or --module '""').
-
--csect (string)
- Specifies the CSECT name that you request the Histogram data for. You get the csect value from the 'codeview csect' command response. The CSECT name can be empty (e.g., --csect "TUNCOB01" or --csect '""').
-
--group (string)
- Specifies the histogram group size parameter that defines the resolution of the histogram (e.g., --group 32). If you do not specify the group parameter, the group size value defaults to 4 bytes. If the source program listing is registered with MAT, the group size parameter is ignored. The --group parameter is optional. Lower values of the --group parameter result in more granular representation of the histogram data. Values: numbers between 2 and 999999.
-
--top (number)
- Specifies the maximum number of the top consuming CSECT activity locations that you want to obtain in the response (e.g., --top 5). If you specify --top 0, you get the list of all CSECT activity locations that MAT has detected during the measurement.The --top parameter is optional. Values: numbers between 0 and 300.
-
--listing (boolean)
- Enables you to retrieve program listing details that pertain to the specific CSECT and statement. To use the listing retrieval option, you must install and configure the Endevor® Web Services and have the program listing for the specific measurement registered with MAT. The source code listing is retrieved through Endevor® footprints for Cobol, C/C++, and Assembler programs. The program listing file is downloaded to your local directory that you specified with the 'listingDir' parameter in your MAT configuration profile. When you request the histogram details with the '--listing' option, the 'histogram' command returns the additional 'listing' column that contains a reference to the program listing with the specific CSECT name, program type, line and column number that pertain to the requested CSECT and statement, for example, c:listingsSA420LE.asm:382:51. If you use Visual Studio Code (VS Code) IDE, you can click on the reference in the command responce in your VS Code terminal to navigate directly to the indicated source program location.The --listing parameter is optional.
MAT Profile Options
-
--protocol | -o (string)
-
Specifies the protocol defined for the MAT REST API server (http or https).
Default value: https
Allowed values: http, https
-
--host | -H (string)
- Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost).
-
--port | -P (number)
- Specifies the server port (e.g. 8080).
-
--user | -u (string)
-
--password | --pw (string)
-
--base-path | --bp (string)
- The base path for your 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 API mediation layer.
-
--reject-unauthorized | --ru (boolean)
-
--listingDir | --ldir (string)
- Specifies the directory where you want to store the registered program listings (e.g. 'c:\listings') for your immediate source code inspection. You can use the advantage of automated listing registration with MAT and listing retrieval through Endevor® footprints for Cobol, C/C++, and Assembler programs. When a source program listing is registered with MAT, you can enhance the histogram analysis data with the program listing details that pertain to the specific CSECT and program statement. The listing is transfered to the specified directory, which enables you to navigate directly to the line of the source code in you VS Code IDE and inspect the program statement. To use the listing retrieval option through Endevor® footprints, you need to have the Endevor® Web Services installed and configured and specify the Endevor® web server details in the MAT database configuration.
Profile Options
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Get the Histogram details for monitor number 5, CSECT name TUNCOB01, and module name RUNCOB:
zowe mat monitor codeview histogram --mon_num 5 --csect "TUNCOB01" --module "RUNCOB"
-
Get the Histogram details for the latest monitor in the TESTPROF profile for CSECT name TUNCOB01, empty module name, limiting the group size to 32 bytes and the number of returned records to 5 top consumers:
zowe mat monitor codeview histogram --profile TESTPROF --csect "TUNCOB01" --module '""' --top 5 --group 32
-
Get the Histogram details for monitor number 5, CSECT name TUNCOB01, and module name RUNCOB, limit the number of returned records to 5 top consumers, and request the listing details:
zowe mat monitor codeview histogram --mon_num 5 --csect "TUNCOB01" --module "RUNCOB" --top 5 --listing
-
Get the Histogram details for monitor number 5, CSECT name TUNCOB01, and module name RUNCOB, with the specific MAT profile details defined:
zowe mat monitor codeview histogram --mon_num 5 --csect "TUNCOB01" --module "RUNCOB" --host "example.com" --port 12345 --user johndoe --password qwerty
Get the CodeView measurement details in Module mode.
Usage
zowe mat monitor codeview module [options]
Options
-
--profile (string)
- Specifies the name of the profile that you want to analyze. When you specify the profile name, you get the data for the latest measurement within the specified profile.
-
--mon_num (number)
- Specifies the unique monitor number of the measurement.
MAT Profile Options
-
--protocol | -o (string)
-
Specifies the protocol defined for the MAT REST API server (http or https).
Default value: https
Allowed values: http, https
-
--host | -H (string)
- Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost).
-
--port | -P (number)
- Specifies the server port (e.g. 8080).
-
--user | -u (string)
-
--password | --pw (string)
-
--base-path | --bp (string)
- The base path for your 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 API mediation layer.
-
--reject-unauthorized | --ru (boolean)
-
--listingDir | --ldir (string)
- Specifies the directory where you want to store the registered program listings (e.g. 'c:\listings') for your immediate source code inspection. You can use the advantage of automated listing registration with MAT and listing retrieval through Endevor® footprints for Cobol, C/C++, and Assembler programs. When a source program listing is registered with MAT, you can enhance the histogram analysis data with the program listing details that pertain to the specific CSECT and program statement. The listing is transfered to the specified directory, which enables you to navigate directly to the line of the source code in you VS Code IDE and inspect the program statement. To use the listing retrieval option through Endevor® footprints, you need to have the Endevor® Web Services installed and configured and specify the Endevor® web server details in the MAT database configuration.
Profile Options
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Get the CodeView measurement details in Module mode for monitor number 5:
zowe mat monitor codeview module --mon_num 5
-
Get the CodeView measurement details in Module mode for the latest monitor in the TESTPROF profile:
zowe mat monitor codeview module --profile TESTPROF
-
Get the CodeView measurement details in Module mode for monitor number 5, with the specific MAT profile details defined:
zowe mat monitor codeview module --mon_num 5 --host "example.com" --port 12345 --user johndoe --password qwerty
Get the DB2 measurement details.
Get the DB2View details for the measurement.
Usage
zowe mat monitor db2 db2view [options]
Options
-
--profile (string)
- Specifies the name of the profile that you want to analyze. When you specify the profile name, you get the data for the latest measurement within the specified profile.
-
--mon_num (number)
- Specifies the unique monitor number of the measurement.
-
--top (number)
- Specifies the maximum number of the top consuming DB2 statements that you want to obtain in the response (e.g., --top 5). If you specify --top 0, you get the list of all DB2 statements that MAT has detected during the measurement.The --top parameter is optional. Values: numbers between 0 and 300.
MAT Profile Options
-
--protocol | -o (string)
-
Specifies the protocol defined for the MAT REST API server (http or https).
Default value: https
Allowed values: http, https
-
--host | -H (string)
- Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost).
-
--port | -P (number)
- Specifies the server port (e.g. 8080).
-
--user | -u (string)
-
--password | --pw (string)
-
--base-path | --bp (string)
- The base path for your 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 API mediation layer.
-
--reject-unauthorized | --ru (boolean)
-
--listingDir | --ldir (string)
- Specifies the directory where you want to store the registered program listings (e.g. 'c:\listings') for your immediate source code inspection. You can use the advantage of automated listing registration with MAT and listing retrieval through Endevor® footprints for Cobol, C/C++, and Assembler programs. When a source program listing is registered with MAT, you can enhance the histogram analysis data with the program listing details that pertain to the specific CSECT and program statement. The listing is transfered to the specified directory, which enables you to navigate directly to the line of the source code in you VS Code IDE and inspect the program statement. To use the listing retrieval option through Endevor® footprints, you need to have the Endevor® Web Services installed and configured and specify the Endevor® web server details in the MAT database configuration.
Profile Options
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Get the DB2View details for monitor number 5:
zowe mat monitor db2 db2view --mon_num 5
-
Get the DB2View details for the latest monitor in the TESTPROF profile, with the top consumer limitation set to 5 top consumers:
zowe mat monitor db2 db2view --profile TESTPROF --top 5
-
Get the DB2View details for monitor number 5, with the specific MAT profile details defined:
zowe mat monitor db2 db2view --mon_num 5 --host "example.com" --port 12345 --user johndoe --password qwerty
Get SQL details for the DB2 statement.
Usage
zowe mat monitor db2 sqlstmt [options]
Options
-
--profile (string)
- Specifies the name of the profile that you want to analyze. When you specify the profile name, you get the data for the latest measurement within the specified profile.
-
--mon_num (number)
- Specifies the unique monitor number of the measurement.
-
--dbrm (string)
- Specifies the DBRM/Package name that the requested DB2 statement belongs to (e.g., --dbrm CUPBTSDY). You get the dbrm value from the 'db2 db2view ' command response.
-
--stmtnum (number)
- Specifies the statement number that you request the SQL details for (e.g., --stmtnum 464). You get the stmtnum value from the 'db2 db2view ' command response.
-
--totalsamps (number)
- Specifies the total number of samples taken for the requested statement (e.g., --totalsamps 1). You get the totalsamps value from the 'db2 db2view ' command response.
MAT Profile Options
-
--protocol | -o (string)
-
Specifies the protocol defined for the MAT REST API server (http or https).
Default value: https
Allowed values: http, https
-
--host | -H (string)
- Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost).
-
--port | -P (number)
- Specifies the server port (e.g. 8080).
-
--user | -u (string)
-
--password | --pw (string)
-
--base-path | --bp (string)
- The base path for your 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 API mediation layer.
-
--reject-unauthorized | --ru (boolean)
-
--listingDir | --ldir (string)
- Specifies the directory where you want to store the registered program listings (e.g. 'c:\listings') for your immediate source code inspection. You can use the advantage of automated listing registration with MAT and listing retrieval through Endevor® footprints for Cobol, C/C++, and Assembler programs. When a source program listing is registered with MAT, you can enhance the histogram analysis data with the program listing details that pertain to the specific CSECT and program statement. The listing is transfered to the specified directory, which enables you to navigate directly to the line of the source code in you VS Code IDE and inspect the program statement. To use the listing retrieval option through Endevor® footprints, you need to have the Endevor® Web Services installed and configured and specify the Endevor® web server details in the MAT database configuration.
Profile Options
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Get the DB2 SQL statement details for monitor number 5 for DBRM CUPBTSDY, statement number 464, with total number of taken samples 1:
zowe mat monitor db2 sqlstmt --mon_num 5 --dbrm CUPBTSDY --stmtnum 464 --totalsamps 1
-
Get the DB2 SQL statement details for the latest monitor in the TESTPROF profile, for DBRM CUPBTSDY, statement number 464, with total number of taken samples 1:
zowe mat monitor db2 sqlstmt --profile TESTPROF --dbrm CUPBTSDY --stmtnum 464 --totalsamps 1
-
Get the DB2 SQL statement details for monitor number 5 for DBRM CUPBTSDY, statement number 464, with total number of taken samples 1, and with the specific MAT profile details defined:
zowe mat monitor db2 sqlstmt --mon_num 5 --dbrm CUPBTSDY --stmtnum 464 --totalsamps 1 --host "example.com" --port 12345 --user johndoe --password qwerty
Get the DelayView measurement details.
Get the delay address details for the measurement.
Usage
zowe mat monitor delayview address [options]
Options
-
--profile (string)
- Specifies the name of the profile that you want to analyze. When you specify the profile name, you get the data for the latest measurement within the specified profile.
-
--mon_num (number)
- Specifies the unique monitor number of the measurement.
-
--majorcategory (string)
- Specifies the major delay category name identified for the analysis item (e.g., --majorcategory "PC routine delay"). You get the majorcategory value from the 'delayview delay' command response.
-
--minorcategory (string)
- Specifies the minor delay category name identified for the analysis item (e.g., --minorcategory "PC CALL"). You get the minorcategory value from the 'delayview delay' command response.
MAT Profile Options
-
--protocol | -o (string)
-
Specifies the protocol defined for the MAT REST API server (http or https).
Default value: https
Allowed values: http, https
-
--host | -H (string)
- Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost).
-
--port | -P (number)
- Specifies the server port (e.g. 8080).
-
--user | -u (string)
-
--password | --pw (string)
-
--base-path | --bp (string)
- The base path for your 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 API mediation layer.
-
--reject-unauthorized | --ru (boolean)
-
--listingDir | --ldir (string)
- Specifies the directory where you want to store the registered program listings (e.g. 'c:\listings') for your immediate source code inspection. You can use the advantage of automated listing registration with MAT and listing retrieval through Endevor® footprints for Cobol, C/C++, and Assembler programs. When a source program listing is registered with MAT, you can enhance the histogram analysis data with the program listing details that pertain to the specific CSECT and program statement. The listing is transfered to the specified directory, which enables you to navigate directly to the line of the source code in you VS Code IDE and inspect the program statement. To use the listing retrieval option through Endevor® footprints, you need to have the Endevor® Web Services installed and configured and specify the Endevor® web server details in the MAT database configuration.
Profile Options
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Get the delay address details for majorcategory "PC routine delay" and minorcategory "PC CALL" for monitor number 5:
zowe mat monitor delayview address --mon_num 5 –-majorcategory "PC routine delay" –-minorcategory "PC CALL"
-
Get the delay address details for majorcategory "PC routine delay" and minorcategory "PC CALL" for the latest monitor in the TESTPROF profile:
zowe mat monitor delayview address --profile TESTPROF –-majorcategory "PC routine delay" –-minorcategory "PC CALL"
-
Get the delay address details for majorcategory "PC routine delay" and minorcategory "PC CALL" for monitor number 5, with the specific MAT profile details defined:
zowe mat monitor delayview address --mon_num 5 –-majorcategory "PC routine delay" –-minorcategory "PC CALL" --host "example.com" --port 12345 --user johndoe --password qwerty
Get the delay details for the measurement.
Usage
zowe mat monitor delayview delay [options]
Options
-
--profile (string)
- Specifies the name of the profile that you want to analyze. When you specify the profile name, you get the data for the latest measurement within the specified profile.
-
--mon_num (number)
- Specifies the unique monitor number of the measurement.
MAT Profile Options
-
--protocol | -o (string)
-
Specifies the protocol defined for the MAT REST API server (http or https).
Default value: https
Allowed values: http, https
-
--host | -H (string)
- Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost).
-
--port | -P (number)
- Specifies the server port (e.g. 8080).
-
--user | -u (string)
-
--password | --pw (string)
-
--base-path | --bp (string)
- The base path for your 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 API mediation layer.
-
--reject-unauthorized | --ru (boolean)
-
--listingDir | --ldir (string)
- Specifies the directory where you want to store the registered program listings (e.g. 'c:\listings') for your immediate source code inspection. You can use the advantage of automated listing registration with MAT and listing retrieval through Endevor® footprints for Cobol, C/C++, and Assembler programs. When a source program listing is registered with MAT, you can enhance the histogram analysis data with the program listing details that pertain to the specific CSECT and program statement. The listing is transfered to the specified directory, which enables you to navigate directly to the line of the source code in you VS Code IDE and inspect the program statement. To use the listing retrieval option through Endevor® footprints, you need to have the Endevor® Web Services installed and configured and specify the Endevor® web server details in the MAT database configuration.
Profile Options
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Get the DelayView measurement details for monitor number 5:
zowe mat monitor delayview delay --mon_num 5
-
Get the DelayView measurement details for the latest monitor in the TESTPROF profile:
zowe mat monitor delayview delay --profile TESTPROF
-
Get the DelayView measurement details for monitor number 5, with the specific MAT profile details defined:
zowe mat monitor delayview delay --mon_num 5 --host "example.com" --port 12345 --user johndoe --password qwerty
Get list of all available measurements that are stored in the history of the specific monitor profile.
Usage
zowe mat monitor history [options]
Options
-
--profile (string)
- Specifies the name of the profile.
MAT Profile Options
-
--protocol | -o (string)
-
Specifies the protocol defined for the MAT REST API server (http or https).
Default value: https
Allowed values: http, https
-
--host | -H (string)
- Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost).
-
--port | -P (number)
- Specifies the server port (e.g. 8080).
-
--user | -u (string)
-
--password | --pw (string)
-
--base-path | --bp (string)
- The base path for your 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 API mediation layer.
-
--reject-unauthorized | --ru (boolean)
-
--listingDir | --ldir (string)
- Specifies the directory where you want to store the registered program listings (e.g. 'c:\listings') for your immediate source code inspection. You can use the advantage of automated listing registration with MAT and listing retrieval through Endevor® footprints for Cobol, C/C++, and Assembler programs. When a source program listing is registered with MAT, you can enhance the histogram analysis data with the program listing details that pertain to the specific CSECT and program statement. The listing is transfered to the specified directory, which enables you to navigate directly to the line of the source code in you VS Code IDE and inspect the program statement. To use the listing retrieval option through Endevor® footprints, you need to have the Endevor® Web Services installed and configured and specify the Endevor® web server details in the MAT database configuration.
Profile Options
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Get the list of all available measurements that are stored in the history of the monitor profile TESTPROF:
zowe mat monitor history --profile TESTPROF
-
Get the list of all available measurements that are stored in the history of the monitor profile TESTPROF, with the specific MAT profile details defined:
zowe mat monitor history --profile TESTPROF --host "example.com" --port 12345 --user johndoe --password qwerty
Get the IDMS measurement details.
Get the IDMS measurement details in DML mode.
Usage
zowe mat monitor idms dml [options]
Options
-
--profile (string)
- Specifies the name of the profile that you want to analyze. When you specify the profile name, you get the data for the latest measurement within the specified profile.
-
--mon_num (number)
- Specifies the unique monitor number of the measurement.
MAT Profile Options
-
--protocol | -o (string)
-
Specifies the protocol defined for the MAT REST API server (http or https).
Default value: https
Allowed values: http, https
-
--host | -H (string)
- Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost).
-
--port | -P (number)
- Specifies the server port (e.g. 8080).
-
--user | -u (string)
-
--password | --pw (string)
-
--base-path | --bp (string)
- The base path for your 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 API mediation layer.
-
--reject-unauthorized | --ru (boolean)
-
--listingDir | --ldir (string)
- Specifies the directory where you want to store the registered program listings (e.g. 'c:\listings') for your immediate source code inspection. You can use the advantage of automated listing registration with MAT and listing retrieval through Endevor® footprints for Cobol, C/C++, and Assembler programs. When a source program listing is registered with MAT, you can enhance the histogram analysis data with the program listing details that pertain to the specific CSECT and program statement. The listing is transfered to the specified directory, which enables you to navigate directly to the line of the source code in you VS Code IDE and inspect the program statement. To use the listing retrieval option through Endevor® footprints, you need to have the Endevor® Web Services installed and configured and specify the Endevor® web server details in the MAT database configuration.
Profile Options
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Get the CodeView measurement details in Module mode for monitor number 5:
zowe mat monitor idms dml --mon_num 5
-
Get the CodeView measurement details in Module mode for the latest monitor in the TESTPROF profile:
zowe mat monitor idms dml --profile TESTPROF
-
Get the dml details of the measurement for monitor number 5:
zowe mat monitor idms dml dml --mon_num 5
Get the IDMS measurement details.
Usage
zowe mat monitor idms module [options]
Options
-
--profile (string)
- Specifies the name of the profile that you want to analyze. When you specify the profile name, you get the data for the latest measurement within the specified profile.
-
--mon_num (number)
- Specifies the unique monitor number of the measurement.
-
--module (string)
- Specifies the module of the measurement.
-
--taskid (number)
- Specifies the taskid number.
-
--ruid (number)
- Specifies the ruid number.
-
--linecmd (string)
- Specifies the line command to be used for the row data
MAT Profile Options
-
--protocol | -o (string)
-
Specifies the protocol defined for the MAT REST API server (http or https).
Default value: https
Allowed values: http, https
-
--host | -H (string)
- Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost).
-
--port | -P (number)
- Specifies the server port (e.g. 8080).
-
--user | -u (string)
-
--password | --pw (string)
-
--base-path | --bp (string)
- The base path for your 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 API mediation layer.
-
--reject-unauthorized | --ru (boolean)
-
--listingDir | --ldir (string)
- Specifies the directory where you want to store the registered program listings (e.g. 'c:\listings') for your immediate source code inspection. You can use the advantage of automated listing registration with MAT and listing retrieval through Endevor® footprints for Cobol, C/C++, and Assembler programs. When a source program listing is registered with MAT, you can enhance the histogram analysis data with the program listing details that pertain to the specific CSECT and program statement. The listing is transfered to the specified directory, which enables you to navigate directly to the line of the source code in you VS Code IDE and inspect the program statement. To use the listing retrieval option through Endevor® footprints, you need to have the Endevor® Web Services installed and configured and specify the Endevor® web server details in the MAT database configuration.
Profile Options
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Get the idms details of the measurement for monitor number 5:
zowe mat monitor idms module --mon_num 5
-
Get the idms details of the measurement for the latest monitor in the TESTPROF profile:
zowe mat monitor idms module --profile TESTPROF
-
Get the module details of the measurement for monitor number 5:
zowe mat monitor idms module module --mon_num 5
-
Specify the module | taskid | ruid | linecmd option of the measurement for the module mode:
zowe mat monitor idms module --module SQLA01D | --taskid 1 | --ruid 19333 | --linecmd dispatch
Get the IDMS measurement details in Task mode.
Usage
zowe mat monitor idms task [options]
Options
-
--profile (string)
- Specifies the name of the profile that you want to analyze. When you specify the profile name, you get the data for the latest measurement within the specified profile.
-
--mon_num (number)
- Specifies the unique monitor number of the measurement.
MAT Profile Options
-
--protocol | -o (string)
-
Specifies the protocol defined for the MAT REST API server (http or https).
Default value: https
Allowed values: http, https
-
--host | -H (string)
- Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost).
-
--port | -P (number)
- Specifies the server port (e.g. 8080).
-
--user | -u (string)
-
--password | --pw (string)
-
--base-path | --bp (string)
- The base path for your 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 API mediation layer.
-
--reject-unauthorized | --ru (boolean)
-
--listingDir | --ldir (string)
- Specifies the directory where you want to store the registered program listings (e.g. 'c:\listings') for your immediate source code inspection. You can use the advantage of automated listing registration with MAT and listing retrieval through Endevor® footprints for Cobol, C/C++, and Assembler programs. When a source program listing is registered with MAT, you can enhance the histogram analysis data with the program listing details that pertain to the specific CSECT and program statement. The listing is transfered to the specified directory, which enables you to navigate directly to the line of the source code in you VS Code IDE and inspect the program statement. To use the listing retrieval option through Endevor® footprints, you need to have the Endevor® Web Services installed and configured and specify the Endevor® web server details in the MAT database configuration.
Profile Options
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Get the CodeView measurement details in Module mode for monitor number 5:
zowe mat monitor idms task --mon_num 5
-
Get the CodeView measurement details in Module mode for the latest monitor in the TESTPROF profile:
zowe mat monitor idms task --profile TESTPROF
-
Get the task details of the measurement for monitor number 5:
zowe mat monitor idms task task --mon_num 5
Get the IMS measurement details.
Get the IMS View DBDName details for the measurement.
Usage
zowe mat monitor imsview dbdname [options]
Options
-
--profile (string)
- Specifies the name of the profile that you want to analyze. When you specify the profile name, you get the data for the latest measurement within the specified profile.
-
--mon_num (number)
- Specifies the unique monitor number of the measurement.
MAT Profile Options
-
--protocol | -o (string)
-
Specifies the protocol defined for the MAT REST API server (http or https).
Default value: https
Allowed values: http, https
-
--host | -H (string)
- Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost).
-
--port | -P (number)
- Specifies the server port (e.g. 8080).
-
--user | -u (string)
-
--password | --pw (string)
-
--base-path | --bp (string)
- The base path for your 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 API mediation layer.
-
--reject-unauthorized | --ru (boolean)
-
--listingDir | --ldir (string)
- Specifies the directory where you want to store the registered program listings (e.g. 'c:\listings') for your immediate source code inspection. You can use the advantage of automated listing registration with MAT and listing retrieval through Endevor® footprints for Cobol, C/C++, and Assembler programs. When a source program listing is registered with MAT, you can enhance the histogram analysis data with the program listing details that pertain to the specific CSECT and program statement. The listing is transfered to the specified directory, which enables you to navigate directly to the line of the source code in you VS Code IDE and inspect the program statement. To use the listing retrieval option through Endevor® footprints, you need to have the Endevor® Web Services installed and configured and specify the Endevor® web server details in the MAT database configuration.
Profile Options
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Get the IMS View DBDName details for monitor number 5:
zowe mat monitor imsview dbdname --mon_num 5
-
Get the IMS View DBDName details for the latest monitor in the TESTPROF profile, :
zowe mat monitor imsview dbdname --profile TESTPROF
Get the IMS View details for the measurement.
Usage
zowe mat monitor imsview imsview [options]
Options
-
--mon_num (number)
- Specifies the unique monitor number of the measurement.
-
--profile (string)
- Specifies the name of the profile that you want to analyze. When you specify the profile name, you get the data for the latest measurement within the specified profile.
MAT Profile Options
-
--protocol | -o (string)
-
Specifies the protocol defined for the MAT REST API server (http or https).
Default value: https
Allowed values: http, https
-
--host | -H (string)
- Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost).
-
--port | -P (number)
- Specifies the server port (e.g. 8080).
-
--user | -u (string)
-
--password | --pw (string)
-
--base-path | --bp (string)
- The base path for your 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 API mediation layer.
-
--reject-unauthorized | --ru (boolean)
-
--listingDir | --ldir (string)
- Specifies the directory where you want to store the registered program listings (e.g. 'c:\listings') for your immediate source code inspection. You can use the advantage of automated listing registration with MAT and listing retrieval through Endevor® footprints for Cobol, C/C++, and Assembler programs. When a source program listing is registered with MAT, you can enhance the histogram analysis data with the program listing details that pertain to the specific CSECT and program statement. The listing is transfered to the specified directory, which enables you to navigate directly to the line of the source code in you VS Code IDE and inspect the program statement. To use the listing retrieval option through Endevor® footprints, you need to have the Endevor® Web Services installed and configured and specify the Endevor® web server details in the MAT database configuration.
Profile Options
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Get the IMS View details for monitor number 5:
zowe mat monitor imsview imsview --mon_num 5
-
Get the IMS View details for the latest monitor in the TESTPROF profile, :
zowe mat monitor imsview imsview --profile TESTPROF
Get the IMS View PSBName details for the measurement.
Usage
zowe mat monitor imsview psbname [options]
Options
-
--profile (string)
- Specifies the name of the profile that you want to analyze. When you specify the profile name, you get the data for the latest measurement within the specified profile.
-
--mon_num (number)
- Specifies the unique monitor number of the measurement.
MAT Profile Options
-
--protocol | -o (string)
-
Specifies the protocol defined for the MAT REST API server (http or https).
Default value: https
Allowed values: http, https
-
--host | -H (string)
- Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost).
-
--port | -P (number)
- Specifies the server port (e.g. 8080).
-
--user | -u (string)
-
--password | --pw (string)
-
--base-path | --bp (string)
- The base path for your 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 API mediation layer.
-
--reject-unauthorized | --ru (boolean)
-
--listingDir | --ldir (string)
- Specifies the directory where you want to store the registered program listings (e.g. 'c:\listings') for your immediate source code inspection. You can use the advantage of automated listing registration with MAT and listing retrieval through Endevor® footprints for Cobol, C/C++, and Assembler programs. When a source program listing is registered with MAT, you can enhance the histogram analysis data with the program listing details that pertain to the specific CSECT and program statement. The listing is transfered to the specified directory, which enables you to navigate directly to the line of the source code in you VS Code IDE and inspect the program statement. To use the listing retrieval option through Endevor® footprints, you need to have the Endevor® Web Services installed and configured and specify the Endevor® web server details in the MAT database configuration.
Profile Options
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Get the IMS View PSBName details for monitor number 5:
zowe mat monitor imsview psbname --mon_num 5
-
Get the IMS View PSBName details for the latest monitor in the TESTPROF profile, :
zowe mat monitor imsview psbname --profile TESTPROF
Get the IMS View Region details for the measurement.
Usage
zowe mat monitor imsview region [options]
Options
-
--profile (string)
- Specifies the name of the profile that you want to analyze. When you specify the profile name, you get the data for the latest measurement within the specified profile.
-
--mon_num (number)
- Specifies the unique monitor number of the measurement.
MAT Profile Options
-
--protocol | -o (string)
-
Specifies the protocol defined for the MAT REST API server (http or https).
Default value: https
Allowed values: http, https
-
--host | -H (string)
- Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost).
-
--port | -P (number)
- Specifies the server port (e.g. 8080).
-
--user | -u (string)
-
--password | --pw (string)
-
--base-path | --bp (string)
- The base path for your 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 API mediation layer.
-
--reject-unauthorized | --ru (boolean)
-
--listingDir | --ldir (string)
- Specifies the directory where you want to store the registered program listings (e.g. 'c:\listings') for your immediate source code inspection. You can use the advantage of automated listing registration with MAT and listing retrieval through Endevor® footprints for Cobol, C/C++, and Assembler programs. When a source program listing is registered with MAT, you can enhance the histogram analysis data with the program listing details that pertain to the specific CSECT and program statement. The listing is transfered to the specified directory, which enables you to navigate directly to the line of the source code in you VS Code IDE and inspect the program statement. To use the listing retrieval option through Endevor® footprints, you need to have the Endevor® Web Services installed and configured and specify the Endevor® web server details in the MAT database configuration.
Profile Options
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Get the IMS View Region details for monitor number 5:
zowe mat monitor imsview region --mon_num 5
-
Get the IMS View Region details for the latest monitor in the TESTPROF profile, :
zowe mat monitor imsview region --profile TESTPROF
Get the IMS View SSA details for the measurement.
Usage
zowe mat monitor imsview ssa [options]
Options
-
--profile (string)
- Specifies the name of the profile that you want to analyze. When you specify the profile name, you get the data for the latest measurement within the specified profile.
-
--mon_num (number)
- Specifies the unique monitor number of the measurement.
-
--call (string)
- Specifies the call details for the specified monitor number or profile name.
-
--dbdname (string)
- Specifies the dbdname details for the specified monitor number or profile name.
-
--psbname (string)
- Specifies the psbname details for the specified monitor number or profile name.
MAT Profile Options
-
--protocol | -o (string)
-
Specifies the protocol defined for the MAT REST API server (http or https).
Default value: https
Allowed values: http, https
-
--host | -H (string)
- Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost).
-
--port | -P (number)
- Specifies the server port (e.g. 8080).
-
--user | -u (string)
-
--password | --pw (string)
-
--base-path | --bp (string)
- The base path for your 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 API mediation layer.
-
--reject-unauthorized | --ru (boolean)
-
--listingDir | --ldir (string)
- Specifies the directory where you want to store the registered program listings (e.g. 'c:\listings') for your immediate source code inspection. You can use the advantage of automated listing registration with MAT and listing retrieval through Endevor® footprints for Cobol, C/C++, and Assembler programs. When a source program listing is registered with MAT, you can enhance the histogram analysis data with the program listing details that pertain to the specific CSECT and program statement. The listing is transfered to the specified directory, which enables you to navigate directly to the line of the source code in you VS Code IDE and inspect the program statement. To use the listing retrieval option through Endevor® footprints, you need to have the Endevor® Web Services installed and configured and specify the Endevor® web server details in the MAT database configuration.
Profile Options
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Get the IMS details for monitor number 5, with the specific MAT profile details defined:
zowe mat monitor imsview ssa --mon_num 5 --call TESTCALL --dbdname TESTDBDNAME --psbname TESTPSBNAME
-
Get the IMS View SSA details for the latest monitor in the TESTPROF profile,with the specific MAT profile details defined :
zowe mat monitor imsview ssa --profile TESTPROF --call TESTCALL --dbdname TESTDBDNAME --psbname TESTPSBNAME
-
Get the IMS View SSA details for monitor number 5, with the specific MAT profile details defined:
zowe mat monitor imsview ssa --mon_num 5 --call TESTCALL --dbdname TESTDBDNAME --psbname TESTPSBNAME
Get the IMS View Statement details for the measurement.
Usage
zowe mat monitor imsview statement [options]
Options
-
--profile (string)
- Specifies the name of the profile that you want to analyze. When you specify the profile name, you get the data for the latest measurement within the specified profile.
-
--mon_num (number)
- Specifies the unique monitor number of the measurement.
-
--trancode (string)
- Specifies the trancode for specified monitor number or profile name
MAT Profile Options
-
--protocol | -o (string)
-
Specifies the protocol defined for the MAT REST API server (http or https).
Default value: https
Allowed values: http, https
-
--host | -H (string)
- Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost).
-
--port | -P (number)
- Specifies the server port (e.g. 8080).
-
--user | -u (string)
-
--password | --pw (string)
-
--base-path | --bp (string)
- The base path for your 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 API mediation layer.
-
--reject-unauthorized | --ru (boolean)
-
--listingDir | --ldir (string)
- Specifies the directory where you want to store the registered program listings (e.g. 'c:\listings') for your immediate source code inspection. You can use the advantage of automated listing registration with MAT and listing retrieval through Endevor® footprints for Cobol, C/C++, and Assembler programs. When a source program listing is registered with MAT, you can enhance the histogram analysis data with the program listing details that pertain to the specific CSECT and program statement. The listing is transfered to the specified directory, which enables you to navigate directly to the line of the source code in you VS Code IDE and inspect the program statement. To use the listing retrieval option through Endevor® footprints, you need to have the Endevor® Web Services installed and configured and specify the Endevor® web server details in the MAT database configuration.
Profile Options
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Get the IMS View Statement details for monitor number 5with trancode TESTTRANCODE:
zowe mat monitor imsview statement --mon_num 5 --trancode TESTTRANCODE
-
Get the IMS View Statement details for the latest monitor in the TESTPROF profile, with trancode TESTTRANCODE:
zowe mat monitor imsview statement --profile TESTPROF --trancode TESTTRANCODE
Get the overview details of the measurement.
Usage
zowe mat monitor overview [options]
Options
-
--profile (string)
- Specifies the name of the profile that you want to analyze. When you specify the profile name, you get the data for the latest measurement within the specified profile.
-
--mon_num (number)
- Specifies the unique monitor number of the measurement.
MAT Profile Options
-
--protocol | -o (string)
-
Specifies the protocol defined for the MAT REST API server (http or https).
Default value: https
Allowed values: http, https
-
--host | -H (string)
- Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost).
-
--port | -P (number)
- Specifies the server port (e.g. 8080).
-
--user | -u (string)
-
--password | --pw (string)
-
--base-path | --bp (string)
- The base path for your 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 API mediation layer.
-
--reject-unauthorized | --ru (boolean)
-
--listingDir | --ldir (string)
- Specifies the directory where you want to store the registered program listings (e.g. 'c:\listings') for your immediate source code inspection. You can use the advantage of automated listing registration with MAT and listing retrieval through Endevor® footprints for Cobol, C/C++, and Assembler programs. When a source program listing is registered with MAT, you can enhance the histogram analysis data with the program listing details that pertain to the specific CSECT and program statement. The listing is transfered to the specified directory, which enables you to navigate directly to the line of the source code in you VS Code IDE and inspect the program statement. To use the listing retrieval option through Endevor® footprints, you need to have the Endevor® Web Services installed and configured and specify the Endevor® web server details in the MAT database configuration.
Profile Options
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Get the overview details of the measurement for monitor number 5:
zowe mat monitor overview --mon_num 5
-
Get the overview details of the measurement for the latest monitor in the TESTPROF profile:
zowe mat monitor overview --profile TESTPROF
-
Get the measurement overview details for monitor number 5, with the specific MAT profile details defined:
zowe mat monitor overview --mon_num 5 --host "example.com" --port 12345 --user johndoe --password qwerty
Get the TranView measurement details.
Get the CodeView measurement details in Module mode.
Usage
zowe mat monitor tranview all [options]
Options
-
--profile (string)
- Specifies the name of the profile that you want to analyze. When you specify the profile name, you get the data for the latest measurement within the specified profile.
-
--mon_num (number)
- Specifies the unique monitor number of the measurement.
-
--tran (string)
- Specifies the histogram group size parameter that defines the resolution of the histogram (e.g., --group 32). If you do not specify the group parameter, the group size value defaults to 4 bytes. If the source program listing is registered with MAT, the group size parameter is ignored. The --group parameter is optional. Lower values of the --group parameter result in more granular representation of the histogram data. Values: numbers between 2 and 999999.
-
--type (string)
- Specifies the histogram group size parameter that defines the resolution of the histogram (e.g., --group 32). If you do not specify the group parameter, the group size value defaults to 4 bytes. If the source program listing is registered with MAT, the group size parameter is ignored. The --group parameter is optional. Lower values of the --group parameter result in more granular representation of the histogram data. Values: numbers between 2 and 999999.
MAT Profile Options
-
--protocol | -o (string)
-
Specifies the protocol defined for the MAT REST API server (http or https).
Default value: https
Allowed values: http, https
-
--host | -H (string)
- Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost).
-
--port | -P (number)
- Specifies the server port (e.g. 8080).
-
--user | -u (string)
-
--password | --pw (string)
-
--base-path | --bp (string)
- The base path for your 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 API mediation layer.
-
--reject-unauthorized | --ru (boolean)
-
--listingDir | --ldir (string)
- Specifies the directory where you want to store the registered program listings (e.g. 'c:\listings') for your immediate source code inspection. You can use the advantage of automated listing registration with MAT and listing retrieval through Endevor® footprints for Cobol, C/C++, and Assembler programs. When a source program listing is registered with MAT, you can enhance the histogram analysis data with the program listing details that pertain to the specific CSECT and program statement. The listing is transfered to the specified directory, which enables you to navigate directly to the line of the source code in you VS Code IDE and inspect the program statement. To use the listing retrieval option through Endevor® footprints, you need to have the Endevor® Web Services installed and configured and specify the Endevor® web server details in the MAT database configuration.
Profile Options
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
Get the CodeView measurement details in Module mode.
Usage
zowe mat monitor tranview callerid [options]
Options
-
--profile (string)
- Specifies the name of the profile that you want to analyze. When you specify the profile name, you get the data for the latest measurement within the specified profile.
-
--mon_num (number)
- Specifies the unique monitor number of the measurement.
-
--tran (string)
- Specifies the histogram group size parameter that defines the resolution of the histogram (e.g., --group 32). If you do not specify the group parameter, the group size value defaults to 4 bytes. If the source program listing is registered with MAT, the group size parameter is ignored. The --group parameter is optional. Lower values of the --group parameter result in more granular representation of the histogram data. Values: numbers between 2 and 999999.
MAT Profile Options
-
--protocol | -o (string)
-
Specifies the protocol defined for the MAT REST API server (http or https).
Default value: https
Allowed values: http, https
-
--host | -H (string)
- Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost).
-
--port | -P (number)
- Specifies the server port (e.g. 8080).
-
--user | -u (string)
-
--password | --pw (string)
-
--base-path | --bp (string)
- The base path for your 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 API mediation layer.
-
--reject-unauthorized | --ru (boolean)
-
--listingDir | --ldir (string)
- Specifies the directory where you want to store the registered program listings (e.g. 'c:\listings') for your immediate source code inspection. You can use the advantage of automated listing registration with MAT and listing retrieval through Endevor® footprints for Cobol, C/C++, and Assembler programs. When a source program listing is registered with MAT, you can enhance the histogram analysis data with the program listing details that pertain to the specific CSECT and program statement. The listing is transfered to the specified directory, which enables you to navigate directly to the line of the source code in you VS Code IDE and inspect the program statement. To use the listing retrieval option through Endevor® footprints, you need to have the Endevor® Web Services installed and configured and specify the Endevor® web server details in the MAT database configuration.
Profile Options
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
Get the CodeView measurement details in Module mode.
Usage
zowe mat monitor tranview callstack [options]
Options
-
--profile (string)
- Specifies the name of the profile that you want to analyze. When you specify the profile name, you get the data for the latest measurement within the specified profile.
-
--mon_num (number)
- Specifies the unique monitor number of the measurement.
-
--tran (string)
- Specifies the histogram group size parameter that defines the resolution of the histogram (e.g., --group 32). If you do not specify the group parameter, the group size value defaults to 4 bytes. If the source program listing is registered with MAT, the group size parameter is ignored. The --group parameter is optional. Lower values of the --group parameter result in more granular representation of the histogram data. Values: numbers between 2 and 999999.
MAT Profile Options
-
--protocol | -o (string)
-
Specifies the protocol defined for the MAT REST API server (http or https).
Default value: https
Allowed values: http, https
-
--host | -H (string)
- Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost).
-
--port | -P (number)
- Specifies the server port (e.g. 8080).
-
--user | -u (string)
-
--password | --pw (string)
-
--base-path | --bp (string)
- The base path for your 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 API mediation layer.
-
--reject-unauthorized | --ru (boolean)
-
--listingDir | --ldir (string)
- Specifies the directory where you want to store the registered program listings (e.g. 'c:\listings') for your immediate source code inspection. You can use the advantage of automated listing registration with MAT and listing retrieval through Endevor® footprints for Cobol, C/C++, and Assembler programs. When a source program listing is registered with MAT, you can enhance the histogram analysis data with the program listing details that pertain to the specific CSECT and program statement. The listing is transfered to the specified directory, which enables you to navigate directly to the line of the source code in you VS Code IDE and inspect the program statement. To use the listing retrieval option through Endevor® footprints, you need to have the Endevor® Web Services installed and configured and specify the Endevor® web server details in the MAT database configuration.
Profile Options
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
Get the CodeView measurement details in Csect mode.
Usage
zowe mat monitor tranview csect [options]
Options
-
--profile (string)
- Specifies the name of the profile that you want to analyze. When you specify the profile name, you get the data for the latest measurement within the specified profile.
-
--mon_num (number)
- Specifies the unique monitor number of the measurement.
-
--tran (string)
- Specifies the unique monitor number of the measurement.
MAT Profile Options
-
--protocol | -o (string)
-
Specifies the protocol defined for the MAT REST API server (http or https).
Default value: https
Allowed values: http, https
-
--host | -H (string)
- Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost).
-
--port | -P (number)
- Specifies the server port (e.g. 8080).
-
--user | -u (string)
-
--password | --pw (string)
-
--base-path | --bp (string)
- The base path for your 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 API mediation layer.
-
--reject-unauthorized | --ru (boolean)
-
--listingDir | --ldir (string)
- Specifies the directory where you want to store the registered program listings (e.g. 'c:\listings') for your immediate source code inspection. You can use the advantage of automated listing registration with MAT and listing retrieval through Endevor® footprints for Cobol, C/C++, and Assembler programs. When a source program listing is registered with MAT, you can enhance the histogram analysis data with the program listing details that pertain to the specific CSECT and program statement. The listing is transfered to the specified directory, which enables you to navigate directly to the line of the source code in you VS Code IDE and inspect the program statement. To use the listing retrieval option through Endevor® footprints, you need to have the Endevor® Web Services installed and configured and specify the Endevor® web server details in the MAT database configuration.
Profile Options
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Get the CodeView measurement details in Csect mode for monitor number 5:
zowe mat monitor tranview csect --mon_num 5
-
Get the CodeView measurement details in Csect mode for the latest monitor in the TESTPROF profile:
zowe mat monitor tranview csect --profile TESTPROF
-
Get the CodeView measurement details in Csect mode for monitor number 5, with the specific MAT profile details defined:
zowe mat monitor tranview csect --mon_num 5 --host "example.com" --port 12345 --user johndoe --password qwerty
Get the delay details for the measurement.
Usage
zowe mat monitor tranview delay [options]
Options
-
--profile (string)
- Specifies the name of the profile that you want to analyze. When you specify the profile name, you get the data for the latest measurement within the specified profile.
-
--mon_num (number)
- Specifies the unique monitor number of the measurement.
-
--tran (string)
- Specifies the unique monitor number of the measurement.
MAT Profile Options
-
--protocol | -o (string)
-
Specifies the protocol defined for the MAT REST API server (http or https).
Default value: https
Allowed values: http, https
-
--host | -H (string)
- Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost).
-
--port | -P (number)
- Specifies the server port (e.g. 8080).
-
--user | -u (string)
-
--password | --pw (string)
-
--base-path | --bp (string)
- The base path for your 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 API mediation layer.
-
--reject-unauthorized | --ru (boolean)
-
--listingDir | --ldir (string)
- Specifies the directory where you want to store the registered program listings (e.g. 'c:\listings') for your immediate source code inspection. You can use the advantage of automated listing registration with MAT and listing retrieval through Endevor® footprints for Cobol, C/C++, and Assembler programs. When a source program listing is registered with MAT, you can enhance the histogram analysis data with the program listing details that pertain to the specific CSECT and program statement. The listing is transfered to the specified directory, which enables you to navigate directly to the line of the source code in you VS Code IDE and inspect the program statement. To use the listing retrieval option through Endevor® footprints, you need to have the Endevor® Web Services installed and configured and specify the Endevor® web server details in the MAT database configuration.
Profile Options
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Get the DelayView measurement details for monitor number 5:
zowe mat monitor tranview delay --mon_num 5
-
Get the DelayView measurement details for the latest monitor in the TESTPROF profile:
zowe mat monitor tranview delay --profile TESTPROF
-
Get the DelayView measurement details for monitor number 5, with the specific MAT profile details defined:
zowe mat monitor tranview delay --mon_num 5 --host "example.com" --port 12345 --user johndoe --password qwerty
Get the CodeView measurement details in Module mode.
Usage
zowe mat monitor tranview module [options]
Options
-
--profile (string)
- Specifies the name of the profile that you want to analyze. When you specify the profile name, you get the data for the latest measurement within the specified profile.
-
--mon_num (number)
- Specifies the unique monitor number of the measurement.
-
--tran (string)
- Specifies the transaction of the measurement.
MAT Profile Options
-
--protocol | -o (string)
-
Specifies the protocol defined for the MAT REST API server (http or https).
Default value: https
Allowed values: http, https
-
--host | -H (string)
- Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost).
-
--port | -P (number)
- Specifies the server port (e.g. 8080).
-
--user | -u (string)
-
--password | --pw (string)
-
--base-path | --bp (string)
- The base path for your 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 API mediation layer.
-
--reject-unauthorized | --ru (boolean)
-
--listingDir | --ldir (string)
- Specifies the directory where you want to store the registered program listings (e.g. 'c:\listings') for your immediate source code inspection. You can use the advantage of automated listing registration with MAT and listing retrieval through Endevor® footprints for Cobol, C/C++, and Assembler programs. When a source program listing is registered with MAT, you can enhance the histogram analysis data with the program listing details that pertain to the specific CSECT and program statement. The listing is transfered to the specified directory, which enables you to navigate directly to the line of the source code in you VS Code IDE and inspect the program statement. To use the listing retrieval option through Endevor® footprints, you need to have the Endevor® Web Services installed and configured and specify the Endevor® web server details in the MAT database configuration.
Profile Options
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Get the Tranview measurement details in Module mode for monitor number 5:
zowe mat monitor tranview module --mon_num 5
-
Get the Tranview measurement details in Module mode for the latest monitor in the TESTPROF profile:
zowe mat monitor tranview module --profile TESTPROF
-
Get the Tranview measurement details in Module mode for transaction number MVGT, with the specific MAT profile details defined:
zowe mat monitor tranview module --tran MVGT
Get the CodeView measurement details in Module mode.
Usage
zowe mat monitor tranview stat [options]
Options
-
--profile (string)
- Specifies the name of the profile that you want to analyze. When you specify the profile name, you get the data for the latest measurement within the specified profile.
-
--mon_num (number)
- Specifies the unique monitor number of the measurement.
-
--tran (string)
- Specifies the histogram group size parameter that defines the resolution of the histogram (e.g., --group 32). If you do not specify the group parameter, the group size value defaults to 4 bytes. If the source program listing is registered with MAT, the group size parameter is ignored. The --group parameter is optional. Lower values of the --group parameter result in more granular representation of the histogram data. Values: numbers between 2 and 999999.
-
--type (string)
- Specifies the histogram group size parameter that defines the resolution of the histogram (e.g., --group 32). If you do not specify the group parameter, the group size value defaults to 4 bytes. If the source program listing is registered with MAT, the group size parameter is ignored. The --group parameter is optional. Lower values of the --group parameter result in more granular representation of the histogram data. Values: numbers between 2 and 999999.
MAT Profile Options
-
--protocol | -o (string)
-
Specifies the protocol defined for the MAT REST API server (http or https).
Default value: https
Allowed values: http, https
-
--host | -H (string)
- Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost).
-
--port | -P (number)
- Specifies the server port (e.g. 8080).
-
--user | -u (string)
-
--password | --pw (string)
-
--base-path | --bp (string)
- The base path for your 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 API mediation layer.
-
--reject-unauthorized | --ru (boolean)
-
--listingDir | --ldir (string)
- Specifies the directory where you want to store the registered program listings (e.g. 'c:\listings') for your immediate source code inspection. You can use the advantage of automated listing registration with MAT and listing retrieval through Endevor® footprints for Cobol, C/C++, and Assembler programs. When a source program listing is registered with MAT, you can enhance the histogram analysis data with the program listing details that pertain to the specific CSECT and program statement. The listing is transfered to the specified directory, which enables you to navigate directly to the line of the source code in you VS Code IDE and inspect the program statement. To use the listing retrieval option through Endevor® footprints, you need to have the Endevor® Web Services installed and configured and specify the Endevor® web server details in the MAT database configuration.
Profile Options
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
Create, invoke, and list MAT monitor profiles.
Create a MAT monitor profile.
Usage
zowe mat profile create [options]
Required Options
-
--profile (string)
- Specifies the name of the profile that you create in MAT (e.g. PROFILE1). Values: 1 to 8 characters, a combination of alphanumeric and national characters (A-Z, 0-9, and @), the first character must be an alphabetic or @. The profile name must not contain characters # and $.
-
--jobname (string)
- Specifies the name of the job that you want to measure (e.g. JOB1). Values: 1 to 8 characters, alphanumeric (A-Z capitals only and 0-9), national (#, $, @), and wildcards (* or %).
-
--targsys (string)
- Specifies the target system in SYSPLEX. Values: a comma separated list of up to 4 values is allowed, 1-8 characters each, a combination of alphanumeric (A-Z and 0-9) and national (@,#,$), the first character must be an alphabetic (A-Z) or a national (@, #, $), e.g. AA31,AA32).
Options
-
--batchreports (string)
-
Specifies the setting for the Batch report option upon monitor completion.
Default value: no
Allowed values: yes, no
-
--description (string)
- Provide the monitor description (maximum 24 characters).
-
--mondsn (string)
- Specifies the monitor data set name where MAT saves the measurement (e.g. DEMO.MAT.MONITOR). Values: data set name pattern, maximum 46 characters. If not specified, your default MAT monitor DSN pattern is applied.
-
--stepname (string)
- Specifies the name of the job step to monitor. Values: maximum 8 characters, alphanumeric (A-Z capitals only and 0-9), national (#, $, @), and wildcards (* or %).
-
--mstep (string)
-
Indicates whether the multi-step monitoring option is enabled.
Default value: no
Allowed values: yes, no
-
--procstep (string)
- Specifies the name of the procedure step. Values: maximum 8 characters, alphanumeric (A-Z capitals only and 0-9), national (#, $, @), and wildcards (* or %).
-
--program (string)
- Specifies the name of the program to monitor. Values: maximum 8 characters, alphanumeric (A-Z capitals only and 0-9), national (#, $, @), and wildcards (* or %).
-
--elapstime (string)
-
--smon (string)
-
--tasklib (string)
- Specifies an additional DD name for load modules. Values: maximum 8 characters, alphanumeric (A-Z capitals only and 0-9), national (#, $, @), and wildcards (* or %).
-
--samplecnt (string)
-
--succnt (string)
-
--reccnt (string)
-
--sampdelay (string)
-
--userexit1 (string)
- Specifies the name for the call user written Data Base. Values: maximum 8 characters, alphanumeric (A-Z capitals only and 0-9), national (#, $, @), and wildcards (* or %) (e.g. DBEXIT1).
-
--userexit2 (string)
- Specifies the name 1 for the call user written 4GL exit programs for this monitor . Values: maximum 8 characters, alphanumeric (A-Z capitals only and 0-9), national (#, $, @), and wildcards (* or %) (e.g. UEXIT1).
-
--userexit3 (string)
- Specifies the name 2 for the call user written 4GL exit programs for this monitor . Values: maximum 8 characters, alphanumeric (A-Z capitals only and 0-9), national (#, $, @), and wildcards (* or %) (e.g. UEXIT2).
-
--inctask (string)
- Specifies the task name to define the tasks that you want to sample in a multitasking environment and restrict monitoring to the specific subtask within the address space. Values: a comma separated list of up to 4 values is allowed, maximum 8 characters each, alphanumeric (A-Z capitals only and 0-9), national (#, $, @), and wildcards (* or %) (e.g. INC31,INC32).
-
--exctask (string)
- Specifies the task name to omit from sampling in a multitasking environment Values: a comma separated list of up to 4 values is allowed, max. 8 characters each, alphanumeric (A-Z capitals only and 0-9), national (#, $, @), and wildcards (* or %) (e.g. EXC31,EXC32).
-
--tran (string)
- Specifies the CICS transaction code name to monitor .Values: a comma separated list of up to 4 values is allowed, maximum 8 characters each, alphanumeric (A-Z capitals only and 0-9), national (#, $, @), and wildcards (* or +) (e.g. TRAN1,TRAN2).
-
--term (string)
- Specifies the CICS terminal IDs to monitor. Values: a comma separated list of up to 4 values is allowed, maximum 8 characters each, alphanumeric (A-Z capitals only and 0-9), national (#, $, @), and wildcards (* or +) (e.g. TERM1,TERM2).
-
--userid (string)
- Specifies the CICS user IDs to monitor. Values: Values: a comma separated list of up to 4 values is allowed, maximum 8 characters each, alphanumeric (A-Z capitals only and 0-9), national (#, $, @), and wildcards (* or +) (e.g. USER1,USER2).
-
--db2expl (string)
-
Indicates whether the Explain SQL option is enabled for DB2 SQL statements.
Default value: no
Allowed values: yes, no
-
--db2ctsql (string)
-
Indicates whether the Collect SQL from Catalog option is enabled for DB2 SQL statements.If you specify db2expl=yes, then db2ctsql must be also set to yes.
Default value: no
Allowed values: yes, no
-
--db2hvloc (string)
-
Indicates whether the Requestor Location option is enabled for DB2 measurements.
Default value: no
Allowed values: yes, no
-
--db2hvcor (string)
-
Indicates whether the Correlation ID option for SQL statements is enabled for DB2 measurements.
Default value: no
Allowed values: yes, no
-
--db2hviid (string)
-
Indicates whether the Operator ID option for SQL statements is enabled for DB2 measurements.
Default value: no
Allowed values: yes, no
-
--db2hvthd (string)
-
Indicates whether the Thread Address option for SQL statements is enabled for DB2 measurements.
Default value: no
Allowed values: yes, no
-
--wasexprt (string)
-
Indicates whether the Expert Mode is enabled for Java measurement.
Default value: no
Allowed values: yes, no
-
--urlfilt (string)
- A filtering string to restrict monitoring to the specific application URL, transaction, or stored procedure for Java measurements. Values: a comma separated list of up to 4 values is allowed, max. 64 characters (e.g. mypage1.html,mypage2.html).
-
--sysfilt (string)
- A filtering string to include the specified system class for Java measurements. If you specify a value for sysfilt, the measurement includes only the classes that match the filtering string pattern. Values: a comma separated list of up to 3 values is allowed, max. 64 characters (e.g. user1.class,user2.class).
-
--schedule (string)
- Specifies the name of the schedule that you want to apply to the monitor profile (maximum 8 characters).
MAT Profile Options
-
--protocol | -o (string)
-
Specifies the protocol defined for the MAT REST API server (http or https).
Default value: https
Allowed values: http, https
-
--host | -H (string)
- Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost).
-
--port | -P (number)
- Specifies the server port (e.g. 8080).
-
--user | -u (string)
-
--password | --pw (string)
-
--base-path | --bp (string)
- The base path for your 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 API mediation layer.
-
--reject-unauthorized | --ru (boolean)
-
--listingDir | --ldir (string)
- Specifies the directory where you want to store the registered program listings (e.g. 'c:\listings') for your immediate source code inspection. You can use the advantage of automated listing registration with MAT and listing retrieval through Endevor® footprints for Cobol, C/C++, and Assembler programs. When a source program listing is registered with MAT, you can enhance the histogram analysis data with the program listing details that pertain to the specific CSECT and program statement. The listing is transfered to the specified directory, which enables you to navigate directly to the line of the source code in you VS Code IDE and inspect the program statement. To use the listing retrieval option through Endevor® footprints, you need to have the Endevor® Web Services installed and configured and specify the Endevor® web server details in the MAT database configuration.
Profile Options
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Create the PROFILE1 monitor profile to measure job JOB1 that runs on the AA31 system:
zowe mat profile create --profile PROFILE1 --jobname JOB1 --targsys AA31
-
Create the PROFILE1 monitor profile to measure for 90 seconds job JOB1 that runs on the AA31 and AA32 systems:
zowe mat profile create --profile PROFILE1 --jobname JOB1 --targsys AA31,AA32 --elapstime 90s
-
Create the PROFILE1 monitor profile to measure job JOB1 that runs on the AA31 system, with the specific MAT profile details defined:
zowe mat profile create --profile PROFILE1 --jobname JOB1 --targsys AA31 --host "example.com" --port 12345 --user johndoe --password qwerty
Invoke a MAT monitor profile to start measurement.
Usage
zowe mat profile invoke [options]
Required Options
-
--profile (string)
- Specifies the name of the profile in MAT that you invoke (e.g. PROFILE1). Values: 1 to 8 characters, a combination of alphanumeric and national characters (A-Z, 0-9, and @), the first character must be an alphabetic or @. The profile name must not contain characters # and $.
-
--jobname (string)
- Specifies the name of the job to be measured (e.g. JOB1). Values: 1 to 8 characters, alphanumeric (A-Z capitals only and 0-9), national (#, $, @), and wildcards (* or %).
-
--targsys (string)
- Specifies the target system in SYSPLEX. Values: a comma separated list of up to 4 values is allowed, maximum 8 characters each, a combination of alphanumeric (A-Z and 0-9) and national (@,#,$), the first character must be an alphabetic (A-Z) or a national (@, #, $) (e.g. AA31,AA32).
Options
-
--mondsn (string)
- Specifies the monitor data set name where MAT saves the measurement (e.g. DEMO.MAT.MONITOR). Values: data set name pattern, maximum 46 characters. If not specified, your default MAT monitor DSN pattern is applied.
-
--moiuuid (string)
- Specifies the MOI UUID. Values: maximum 61 characters, alphanumeric (A-Z and 0-9). If you use this parameter for command execution, the value cannot be blank.
-
--moitimestamp (string)
- Specifies the MOI timestamp. Values: maximum 12 characters, numbers only (0-9). If you use this parameter for command execution, the value cannot be blank.
-
--listing (boolean)
- Activates automated registration of Cobol, C/C++, and Assembler program listings through Endevor® footprints. After completion of the measurement that you invoke with the --listing parameter, the MAT Analyze plug-in for Zowe CLI automatically retrieves the program listing that is associated with the monitored job and registers the listing with MAT. A registered program listing enhances the analysis possibilities of the 'codeview histogram' command the 'codeview histogram' command and enables you to inspect the source code statements that are associated with specific modules and CSECTs.
MAT Profile Options
-
--protocol | -o (string)
-
Specifies the protocol defined for the MAT REST API server (http or https).
Default value: https
Allowed values: http, https
-
--host | -H (string)
- Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost).
-
--port | -P (number)
- Specifies the server port (e.g. 8080).
-
--user | -u (string)
-
--password | --pw (string)
-
--base-path | --bp (string)
- The base path for your 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 API mediation layer.
-
--reject-unauthorized | --ru (boolean)
-
--listingDir | --ldir (string)
- Specifies the directory where you want to store the registered program listings (e.g. 'c:\listings') for your immediate source code inspection. You can use the advantage of automated listing registration with MAT and listing retrieval through Endevor® footprints for Cobol, C/C++, and Assembler programs. When a source program listing is registered with MAT, you can enhance the histogram analysis data with the program listing details that pertain to the specific CSECT and program statement. The listing is transfered to the specified directory, which enables you to navigate directly to the line of the source code in you VS Code IDE and inspect the program statement. To use the listing retrieval option through Endevor® footprints, you need to have the Endevor® Web Services installed and configured and specify the Endevor® web server details in the MAT database configuration.
Profile Options
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Invoke the PROFILE1 monitor profile to measure job JOB1 that runs on the AA31 system :
zowe mat profile invoke --profile PROFILE1 --jobname JOB1 --targsys AA31
-
Invoke the PROFILE1 monitor profile to measure job JOB1 that runs on the AA31 system and save the measurement result in the DEMO.MAT.MONITOR.PROFILE1 data set:
zowe mat profile invoke --profile PROFILE1 --jobname JOB1 --targsys AA31 --mondsn DEMO.MAT.MONITOR.PROFILE1
-
Invoke the PROFILE1 monitor profile to measure job JOB1 that runs on the AA31 system and register the program listing:
zowe mat profile invoke --profile PROFILE1 --jobname JOB1 --targsys AA31 --listing
-
Invoke the PROFILE1 monitor profile to measure job JOB1 that runs on the AA31 system with the specific MAT profile details defined:
zowe mat profile invoke --profile PROFILE1 --jobname JOB1 --targsys AA31 --host "example.com" --port 12345 --user johndoe --password qwerty
Get the list of available monitor profiles.
Usage
zowe mat profile list [options]
MAT Profile Options
-
--protocol | -o (string)
-
Specifies the protocol defined for the MAT REST API server (http or https).
Default value: https
Allowed values: http, https
-
--host | -H (string)
- Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost).
-
--port | -P (number)
- Specifies the server port (e.g. 8080).
-
--user | -u (string)
-
--password | --pw (string)
-
--base-path | --bp (string)
- The base path for your 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 API mediation layer.
-
--reject-unauthorized | --ru (boolean)
-
--listingDir | --ldir (string)
- Specifies the directory where you want to store the registered program listings (e.g. 'c:\listings') for your immediate source code inspection. You can use the advantage of automated listing registration with MAT and listing retrieval through Endevor® footprints for Cobol, C/C++, and Assembler programs. When a source program listing is registered with MAT, you can enhance the histogram analysis data with the program listing details that pertain to the specific CSECT and program statement. The listing is transfered to the specified directory, which enables you to navigate directly to the line of the source code in you VS Code IDE and inspect the program statement. To use the listing retrieval option through Endevor® footprints, you need to have the Endevor® Web Services installed and configured and specify the Endevor® web server details in the MAT database configuration.
Profile Options
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
The MAT Detect plug-in for Zowe CLI enables you to detect performance issues and access performance data supplied by the Performance Management Assistant component (PMA) of Mainframe Application Tuner.
Get performance information using PMA utilities. You can get the current performance data of your jobs and check for the daily performance alerts.
Check for alerts created in PMA and detect whether any of your jobs exceeds the average daily performance. If the threshold is exceeded, a PMA alert is triggered. We recommend that you include this command in your end-of-day build to trace all jobs that might cause performance degradation by code changes during the day.
Usage
zowe mat-pma-util get alert [options]
PMA Connection Options
-
--job_acct | --ja (string)
- Specifies z/OS TSO/E accounting information. Values: numeric characters (0-9)
-
--job_class | --jc (string)
- Your z/OS class information. Values: alphanumeric characters (A-Z, 0-9)
-
--job_mclass | --jmc (string)
-
Specifies the MSGCLASS parameter value and assigns the job log to the specified output class. The specified MSGCLASS value is used in all JCLs that PMA runs while you execute the commands. If you do not provide the job_mclass parameter, the default MSGCLASS value is used. Values: alphanumeric characters (A-Z, 0-9)
Default value: A
-
--job_load | --jl (string)
- Specifies the PMA loadlib data set name that you defined during the PMA customization (&HLQ.CEETLOAD)
-
--job_pmahlq | --jph (string)
- Specifies your PMA HLQ to access the KSDSALT, KSDSJOB, and KSDSEXC VSAM files that ensure the collection of the necessary data
Profile Options
-
--zosmf-profile | --zosmf-p (string)
- The name of a (zosmf) profile to load for this command execution.
-
--pma-profile | --pma-p (string)
- The name of a (pma) profile to load for this command execution.
-
--base-profile | --base-p (string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
-
--host | -H (string)
- Host name of service on the mainframe.
-
--port | -P (number)
- Port number of service on the mainframe.
-
--user | -u (string)
- User name to authenticate to service on the mainframe.
-
--password | --pass | --pw (string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized | --ru (boolean)
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
Check whether the specified job exceeds the average daily performance. No record returned indicates that no performance degradation was detected for this job.
Usage
zowe mat-pma-util get alert-by-job <jobname> [options]
Positional Arguments
-
jobname (string)
- Specifies the name of the job that is being tested (e.g. TESTPMA8).
PMA Connection Options
-
--job_acct | --ja (string)
- Specifies z/OS TSO/E accounting information. Values: numeric characters (0-9)
-
--job_class | --jc (string)
- Your z/OS class information. Values: alphanumeric characters (A-Z, 0-9)
-
--job_mclass | --jmc (string)
-
Specifies the MSGCLASS parameter value and assigns the job log to the specified output class. The specified MSGCLASS value is used in all JCLs that PMA runs while you execute the commands. If you do not provide the job_mclass parameter, the default MSGCLASS value is used. Values: alphanumeric characters (A-Z, 0-9)
Default value: A
-
--job_load | --jl (string)
- Specifies the PMA loadlib data set name that you defined during the PMA customization (&HLQ.CEETLOAD)
-
--job_pmahlq | --jph (string)
- Specifies your PMA HLQ to access the KSDSALT, KSDSJOB, and KSDSEXC VSAM files that ensure the collection of the necessary data
Profile Options
-
--zosmf-profile | --zosmf-p (string)
- The name of a (zosmf) profile to load for this command execution.
-
--pma-profile | --pma-p (string)
- The name of a (pma) profile to load for this command execution.
-
--base-profile | --base-p (string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
-
--host | -H (string)
- Host name of service on the mainframe.
-
--port | -P (number)
- Port number of service on the mainframe.
-
--user | -u (string)
- User name to authenticate to service on the mainframe.
-
--password | --pass | --pw (string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized | --ru (boolean)
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Check whether your job TESTPMA8 exceeds the average daily performance using the default profile:
zowe mat-pma-util get alert-by-job TESTPMA8
-
Check whether your job TESTPMA8 exceeds the average daily performance using specific PMA profile details:
zowe mat-pma-util get alert-by-job TESTPMA8 --ja 123456789 --jc A --jmc A --jl HLQ.CEETLOAD --jph PMAHLQ
Get the current performance data of a specific job using PMA. If the current measurement results for any of the measured parameters are higher than average values, an alert message is displayed.
Usage
zowe mat-pma-util get perf <jobname> [options]
Positional Arguments
-
jobname (string)
- Specifies the name of the job that is being tested (e.g. TESTPMA8).
PMA Connection Options
-
--job_acct | --ja (string)
- Specifies z/OS TSO/E accounting information. Values: numeric characters (0-9)
-
--job_class | --jc (string)
- Your z/OS class information. Values: alphanumeric characters (A-Z, 0-9)
-
--job_mclass | --jmc (string)
-
Specifies the MSGCLASS parameter value and assigns the job log to the specified output class. The specified MSGCLASS value is used in all JCLs that PMA runs while you execute the commands. If you do not provide the job_mclass parameter, the default MSGCLASS value is used. Values: alphanumeric characters (A-Z, 0-9)
Default value: A
-
--job_load | --jl (string)
- Specifies the PMA loadlib data set name that you defined during the PMA customization (&HLQ.CEETLOAD)
-
--job_pmahlq | --jph (string)
- Specifies your PMA HLQ to access the KSDSALT, KSDSJOB, and KSDSEXC VSAM files that ensure the collection of the necessary data
Profile Options
-
--zosmf-profile | --zosmf-p (string)
- The name of a (zosmf) profile to load for this command execution.
-
--pma-profile | --pma-p (string)
- The name of a (pma) profile to load for this command execution.
-
--base-profile | --base-p (string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
-
--host | -H (string)
- Host name of service on the mainframe.
-
--port | -P (number)
- Port number of service on the mainframe.
-
--user | -u (string)
- User name to authenticate to service on the mainframe.
-
--password | --pass | --pw (string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized | --ru (boolean)
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
Get and define the PMA scope information. You can create and update the list of jobs that you want to include, or the list of programs to be excluded from the PMA scope of work.
Delete a job from the list of inclusions in the PMA scope.
Usage
zowe mat-pma-util scope del-job <jobname> [options]
Positional Arguments
-
jobname (string)
- Specifies the name of the job that you want to delete from the list of inclusions in the PMA scope (e.g. TESTPMA8).
Options
PMA Connection Options
-
--job_acct | --ja (string)
- Specifies z/OS TSO/E accounting information. Values: numeric characters (0-9)
-
--job_class | --jc (string)
- Your z/OS class information. Values: alphanumeric characters (A-Z, 0-9)
-
--job_mclass | --jmc (string)
-
Specifies the MSGCLASS parameter value and assigns the job log to the specified output class. The specified MSGCLASS value is used in all JCLs that PMA runs while you execute the commands. If you do not provide the job_mclass parameter, the default MSGCLASS value is used. Values: alphanumeric characters (A-Z, 0-9)
Default value: A
-
--job_load | --jl (string)
- Specifies the PMA loadlib data set name that you defined during the PMA customization (&HLQ.CEETLOAD)
-
--job_pmahlq | --jph (string)
- Specifies your PMA HLQ to access the KSDSALT, KSDSJOB, and KSDSEXC VSAM files that ensure the collection of the necessary data
Profile Options
-
--zosmf-profile | --zosmf-p (string)
- The name of a (zosmf) profile to load for this command execution.
-
--pma-profile | --pma-p (string)
- The name of a (pma) profile to load for this command execution.
-
--base-profile | --base-p (string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
-
--host | -H (string)
- Host name of service on the mainframe.
-
--port | -P (number)
- Port number of service on the mainframe.
-
--user | -u (string)
- User name to authenticate to service on the mainframe.
-
--password | --pass | --pw (string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized | --ru (boolean)
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Delete the TESTPMA8 job from the list of inclusions in the PMA scope:
zowe mat-pma-util scope del-job TESTPMA8
-
Delete the specific procname and step name of the TESTPMA8 job from the list of inclusions in the PMA scope:
zowe mat-pma-util scope del-job TESTPMA8 --ps TESTCALL --st TESTDO
-
Delete the specific procname and step name of the TESTPMA8 job from the list of inclusions in the PMA scope using specific PMA profile details:
zowe mat-pma-util scope del-job TESTPMA8 --ps TESTCALL --st TESTDO --ja 123456789 --jc A --jmc A --jl HLQ.CEETLOAD --jph PMAHLQ
Delete a program from the list of exclusions from the PMA scope.
Usage
zowe mat-pma-util scope del-pgm <pgmname> [options]
Positional Arguments
-
pgmname (string)
- Specifies the name of the program that you want to delete from the list of exclusions from the PMA scope (e.g. TESTPMA8).
PMA Connection Options
-
--job_acct | --ja (string)
- Specifies z/OS TSO/E accounting information. Values: numeric characters (0-9)
-
--job_class | --jc (string)
- Your z/OS class information. Values: alphanumeric characters (A-Z, 0-9)
-
--job_mclass | --jmc (string)
-
Specifies the MSGCLASS parameter value and assigns the job log to the specified output class. The specified MSGCLASS value is used in all JCLs that PMA runs while you execute the commands. If you do not provide the job_mclass parameter, the default MSGCLASS value is used. Values: alphanumeric characters (A-Z, 0-9)
Default value: A
-
--job_load | --jl (string)
- Specifies the PMA loadlib data set name that you defined during the PMA customization (&HLQ.CEETLOAD)
-
--job_pmahlq | --jph (string)
- Specifies your PMA HLQ to access the KSDSALT, KSDSJOB, and KSDSEXC VSAM files that ensure the collection of the necessary data
Profile Options
-
--zosmf-profile | --zosmf-p (string)
- The name of a (zosmf) profile to load for this command execution.
-
--pma-profile | --pma-p (string)
- The name of a (pma) profile to load for this command execution.
-
--base-profile | --base-p (string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
-
--host | -H (string)
- Host name of service on the mainframe.
-
--port | -P (number)
- Port number of service on the mainframe.
-
--user | -u (string)
- User name to authenticate to service on the mainframe.
-
--password | --pass | --pw (string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized | --ru (boolean)
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
Exclude a program from the PMA scope of work.
Usage
zowe mat-pma-util scope exl-pgm <pgmname> [options]
Positional Arguments
-
pgmname (string)
- Specifies the name of the program that you want to add to the list of exclusions from the PMA scope (e.g. TESTPMA8).
Options
PMA Connection Options
-
--job_acct | --ja (string)
- Specifies z/OS TSO/E accounting information. Values: numeric characters (0-9)
-
--job_class | --jc (string)
- Your z/OS class information. Values: alphanumeric characters (A-Z, 0-9)
-
--job_mclass | --jmc (string)
-
Specifies the MSGCLASS parameter value and assigns the job log to the specified output class. The specified MSGCLASS value is used in all JCLs that PMA runs while you execute the commands. If you do not provide the job_mclass parameter, the default MSGCLASS value is used. Values: alphanumeric characters (A-Z, 0-9)
Default value: A
-
--job_load | --jl (string)
- Specifies the PMA loadlib data set name that you defined during the PMA customization (&HLQ.CEETLOAD)
-
--job_pmahlq | --jph (string)
- Specifies your PMA HLQ to access the KSDSALT, KSDSJOB, and KSDSEXC VSAM files that ensure the collection of the necessary data
Profile Options
-
--zosmf-profile | --zosmf-p (string)
- The name of a (zosmf) profile to load for this command execution.
-
--pma-profile | --pma-p (string)
- The name of a (pma) profile to load for this command execution.
-
--base-profile | --base-p (string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
-
--host | -H (string)
- Host name of service on the mainframe.
-
--port | -P (number)
- Port number of service on the mainframe.
-
--user | -u (string)
- User name to authenticate to service on the mainframe.
-
--password | --pass | --pw (string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized | --ru (boolean)
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Exclude the TESTPMA8 program from the PMA scope:
zowe mat-pma-util scope exl-pgm TESTPMA8
-
Exclude the TESTPMA8 program from the PMA scope and add a description to the excluded program:
zowe mat-pma-util scope exl-pgm TESTPMA8 --dc "EXCLUDE FROM THE CURRENT SCOPE"
-
Exclude the TESTPMA8 program from the PMA scope and add a description to the excluded program using specific PMA profile details:
zowe mat-pma-util scope exl-pgm TESTPMA8 --dc "EXCLUDE FROM THE CURRENT SCOPE" --ja 123456789 --jc A --jmc A --jl HLQ.CEETLOAD --jph PMAHLQ
Get the list of jobs included in the PMA scope.
Usage
zowe mat-pma-util scope get-listj [options]
PMA Connection Options
-
--job_acct | --ja (string)
- Specifies z/OS TSO/E accounting information. Values: numeric characters (0-9)
-
--job_class | --jc (string)
- Your z/OS class information. Values: alphanumeric characters (A-Z, 0-9)
-
--job_mclass | --jmc (string)
-
Specifies the MSGCLASS parameter value and assigns the job log to the specified output class. The specified MSGCLASS value is used in all JCLs that PMA runs while you execute the commands. If you do not provide the job_mclass parameter, the default MSGCLASS value is used. Values: alphanumeric characters (A-Z, 0-9)
Default value: A
-
--job_load | --jl (string)
- Specifies the PMA loadlib data set name that you defined during the PMA customization (&HLQ.CEETLOAD)
-
--job_pmahlq | --jph (string)
- Specifies your PMA HLQ to access the KSDSALT, KSDSJOB, and KSDSEXC VSAM files that ensure the collection of the necessary data
Profile Options
-
--zosmf-profile | --zosmf-p (string)
- The name of a (zosmf) profile to load for this command execution.
-
--pma-profile | --pma-p (string)
- The name of a (pma) profile to load for this command execution.
-
--base-profile | --base-p (string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
-
--host | -H (string)
- Host name of service on the mainframe.
-
--port | -P (number)
- Port number of service on the mainframe.
-
--user | -u (string)
- User name to authenticate to service on the mainframe.
-
--password | --pass | --pw (string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized | --ru (boolean)
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
Get the list of programs excluded from the PMA scope.
Usage
zowe mat-pma-util scope get-listp [options]
PMA Connection Options
-
--job_acct | --ja (string)
- Specifies z/OS TSO/E accounting information. Values: numeric characters (0-9)
-
--job_class | --jc (string)
- Your z/OS class information. Values: alphanumeric characters (A-Z, 0-9)
-
--job_mclass | --jmc (string)
-
Specifies the MSGCLASS parameter value and assigns the job log to the specified output class. The specified MSGCLASS value is used in all JCLs that PMA runs while you execute the commands. If you do not provide the job_mclass parameter, the default MSGCLASS value is used. Values: alphanumeric characters (A-Z, 0-9)
Default value: A
-
--job_load | --jl (string)
- Specifies the PMA loadlib data set name that you defined during the PMA customization (&HLQ.CEETLOAD)
-
--job_pmahlq | --jph (string)
- Specifies your PMA HLQ to access the KSDSALT, KSDSJOB, and KSDSEXC VSAM files that ensure the collection of the necessary data
Profile Options
-
--zosmf-profile | --zosmf-p (string)
- The name of a (zosmf) profile to load for this command execution.
-
--pma-profile | --pma-p (string)
- The name of a (pma) profile to load for this command execution.
-
--base-profile | --base-p (string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
-
--host | -H (string)
- Host name of service on the mainframe.
-
--port | -P (number)
- Port number of service on the mainframe.
-
--user | -u (string)
- User name to authenticate to service on the mainframe.
-
--password | --pass | --pw (string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized | --ru (boolean)
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
Include a job in the PMA scope of work.
Usage
zowe mat-pma-util scope inc-job <jobname> [options]
Positional Arguments
-
jobname (string)
- Specifies the name of the job that you want to add to the list of inclusions in the PMA scope (e.g. TESTPMA8).
Options
-
--stepname | --st (string)
- Specifies the name of the job step that you want to include in the PMA scope.
-
--procstep | --ps (string)
- Specifies the procname of the job that you want to include in the PMA scope.
-
--description | --dc (string)
- Specifies the description of the job that you want to include in the PMA scope.
PMA Connection Options
-
--job_acct | --ja (string)
- Specifies z/OS TSO/E accounting information. Values: numeric characters (0-9)
-
--job_class | --jc (string)
- Your z/OS class information. Values: alphanumeric characters (A-Z, 0-9)
-
--job_mclass | --jmc (string)
-
Specifies the MSGCLASS parameter value and assigns the job log to the specified output class. The specified MSGCLASS value is used in all JCLs that PMA runs while you execute the commands. If you do not provide the job_mclass parameter, the default MSGCLASS value is used. Values: alphanumeric characters (A-Z, 0-9)
Default value: A
-
--job_load | --jl (string)
- Specifies the PMA loadlib data set name that you defined during the PMA customization (&HLQ.CEETLOAD)
-
--job_pmahlq | --jph (string)
- Specifies your PMA HLQ to access the KSDSALT, KSDSJOB, and KSDSEXC VSAM files that ensure the collection of the necessary data
Profile Options
-
--zosmf-profile | --zosmf-p (string)
- The name of a (zosmf) profile to load for this command execution.
-
--pma-profile | --pma-p (string)
- The name of a (pma) profile to load for this command execution.
-
--base-profile | --base-p (string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
-
--host | -H (string)
- Host name of service on the mainframe.
-
--port | -P (number)
- Port number of service on the mainframe.
-
--user | -u (string)
- User name to authenticate to service on the mainframe.
-
--password | --pass | --pw (string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized | --ru (boolean)
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Include the TESTPMA8 job in the PMA scope:
zowe mat-pma-util scope inc-job TESTPMA8
-
Include the specific procname and step name of the TESTPMA8 job in the PMA scope and add a description to the included job:
zowe mat-pma-util scope inc-job TESTPMA8 --ps TESTCALL --st TESTDO --dc "INCLUDE IN THE CURRENT SCOPE"
-
Include the specific procname and step name of the TESTPMA8 job in the PMA scope and add a description to the included job using specific PMA profile details:
zowe mat-pma-util scope inc-job TESTPMA8 --ps TESTCALL --st TESTDO --dc "INCLUDE IN THE CURRENT SCOPE" --ja 123456789 --jc A --jmc A --jl HLQ.CEETLOAD --jph PMAHLQ
Interact with IBM MQ for z/OS.
MQ Utilities
MQ Utilities
Usage
zowe mq run mqsc <qmgr> <cmd> [options]
Positional Arguments
-
qmgr (string)
- The queue manager to apply the command to
-
cmd (string)
MQ Connection Options
Profile Options
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
Interact with Output Management Spool™ for z/OS (OM Spool)
Issue OM Spool commands.
Issue commands to work with OM Spool.
Usage
zowe omspool issue command <command-text> [options]
Positional Arguments
-
command-text (string)
- The OM Spool command to issue.
OM SPOOL OPTIONS
Zosmf Connection Options
-
--host | -H (string)
- The z/OSMF server host name.
-
--port | -P (number)
-
The z/OSMF server port.
Default value: 443
-
--user | -u (string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized | --ru (boolean)
-
--base-path | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol (string)
-
--cert-file (local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Profile Options
-
--omspool-profile | --omspool-p (string)
- The name of a (omspool) profile to load for this command execution.
-
--zosmf-profile | --zosmf-p (string)
- The name of a (zosmf) profile to load for this command execution.
-
--base-profile | --base-p (string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
Examples
Access Output Management View™ for z/OS data and perform related tasks.
Download OM View report data to local folder.
Download report data.
Optionally convert text report to PDF.
Usage
zowe omview download report <repositoryId> <reportHandle> [fileTarget] [options]
Positional Arguments
-
repositoryId (number)
-
reportHandle (string)
-
fileTarget (string)
- Local file path.
If the path represents a directory location, the report will be downloaded into that directory using a default file name.
If the path does not represent a directory location, the report will be downloaded into the specified path.
If the path is not specified, the file will be saved to the current working directory using the default file name.
Any missing directories will be created. If the target file already exists, the file will be overwritten.
Options
-
--convert-to-pdf | --to-pdf (boolean)
-
--page-orientation | --orientation (string)
-
--font-size | --font (number)
-
--green-bar (boolean)
-
--pages (string)
-
Include the specified page numbers (or page ranges). Separate page numbers (or page ranges) with commas.
Separate boundaries of a page range with a dash (-). If you do not specify this option, all the pages of the report are downloaded.
Allowed values: (\d+(-\d+)?)(,(\d+(-\d+)?))*
-
--content-filter | --filter (string)
- Filter text report content using a permanent filter definition.
If the product instance does not support this feature, this option is ignored.
OM Web Viewer Connection Options
Profile Options
-
--omview-profile | --omview-p (string)
- The name of a (omview) profile to load for this command execution.
-
--caview-profile | --caview-p (string)
- The name of a (caview) profile to load for this command execution.
-
--base-profile | --base-p (string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
-
--reject-unauthorized | --ru (boolean)
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Export OM View text report file to local folder.
Export text report to spreadsheet using a predefined export rule.
Usage
zowe omview export report <repositoryId> <reportHandle> <ruleId> [fileTarget] [options]
Positional Arguments
-
repositoryId (number)
-
reportHandle (string)
-
ruleId (number)
-
fileTarget (string)
- Local file path.
If the path represents a directory location, the report will be exported into that directory using a default file name.
If the path does not represent a directory location, the report will be exported into the specified path.
If the path is not specified, the file will be saved to the current working directory using the default file name.
Any missing directories will be created. If the target file already exists, the file will be overwritten.
Options
-
--pages (string)
-
Include the specified page numbers (or page ranges). Separate page numbers (or page ranges) with commas.
Separate boundaries of a page range with a dash (-). If you do not specify this option, all the pages of the report are exported.
Allowed values: (\d+(-\d+)?)(,(\d+(-\d+)?))*
OM Web Viewer Connection Options
Profile Options
-
--omview-profile | --omview-p (string)
- The name of a (omview) profile to load for this command execution.
-
--caview-profile | --caview-p (string)
- The name of a (caview) profile to load for this command execution.
-
--base-profile | --base-p (string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
-
--reject-unauthorized | --ru (boolean)
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Get information from OM View repository.
Get user information from repository.
Get current user settings from repository.
Usage
zowe omview get user settings <repositoryId> [options]
Positional Arguments
Options
-
--output-format | --output (string)
-
Output format. This option is ignored if '--response-format-json' is specified.
Default value: tabular
Allowed values: tabular, csv, json, xml
-
--output-header | --header (boolean)
-
--output-field | -f (array)
-
Field to include in the output. Multiple fields can be specified. Fields appear in the order you specify.
Default value: Mode,DistId,ModeAccess,DistMask
Allowed values: Mode, DistId, ModeAccess, DistMask, Banner, Language, MasterAuthority, Printer, UserId
OM Web Viewer Connection Options
Profile Options
-
--omview-profile | --omview-p (string)
- The name of a (omview) profile to load for this command execution.
-
--caview-profile | --caview-p (string)
- The name of a (caview) profile to load for this command execution.
-
--base-profile | --base-p (string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
-
--reject-unauthorized | --ru (boolean)
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
List OM View repository, report, and user information.
List export rules defined for a report.
Use the returned 'Identifier' in the 'export report' command to reference that rule.
Usage
zowe omview list export-rules <reportId> [options]
Positional Arguments
Options
-
--output-format | --output (string)
-
Output format. This option is ignored if '--response-format-json' is specified.
Default value: tabular
Allowed values: tabular, csv, json, xml
-
--output-header | --header (boolean)
-
--output-field | -f (array)
-
Field to include in the output. Multiple fields can be specified. Fields appear in the order you specify.
Default value: Identifier,Name,Description
Allowed values: Identifier, Name, Description, Owner, Public
OM Web Viewer Connection Options
Profile Options
-
--omview-profile | --omview-p (string)
- The name of a (omview) profile to load for this command execution.
-
--caview-profile | --caview-p (string)
- The name of a (caview) profile to load for this command execution.
-
--base-profile | --base-p (string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
-
--reject-unauthorized | --ru (boolean)
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
List information about a specific report.
List indexes for a a specific report.
Use the returned 'IndexNameHandle' to reference a report index.
Use the returned 'IndexNameHandle' in the 'list report index-values' command to retrieve the list of associated index values for that index.
Usage
zowe omview list report index-names <repositoryId> <reportHandle> [options]
Positional Arguments
-
repositoryId (number)
-
reportHandle (string)
Options
-
--filter-names | --names (string)
-
Filter (include) based on index name. Separate multiple index names with commas. Use the asterisk (*) as a wildcard to represent any number of characters.
Default value: *,*,*,*,*,*,*,*
-
--output-format | --output (string)
-
Output format. This option is ignored if '--response-format-json' is specified.
Default value: tabular
Allowed values: tabular, csv, json, xml
-
--output-header | --header (boolean)
-
--output-field | -f (array)
-
Field to include in the output. Multiple fields can be specified. Fields appear in the order you specify.
Default value: Index,SubIndexNames,IndexNameHandle
Allowed values: Index, SubIndexNames, IndexNameHandle
OM Web Viewer Connection Options
Profile Options
-
--omview-profile | --omview-p (string)
- The name of a (omview) profile to load for this command execution.
-
--caview-profile | --caview-p (string)
- The name of a (caview) profile to load for this command execution.
-
--base-profile | --base-p (string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
-
--reject-unauthorized | --ru (boolean)
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
List index values for a report index.
Use the returned 'ReportHandle' to reference an index value in other commands.
For example, use 'ReportHandle' in the 'download report' command to download that corresponding view of the report.
Usage
zowe omview list report index-values <repositoryId> <reportHandle> <indexNameHandle> [options]
Positional Arguments
-
repositoryId (number)
-
reportHandle (string)
-
indexNameHandle (string)
Options
-
--filter-values | --values (string)
-
Filter (include) based on index values. Separate index values with commas. Use the asterisk (*) as a wildcard to represent any number of characters.
Default value: *,*,*,*,*,*,*,*
-
--output-format | --output (string)
-
Output format. This option is ignored if '--response-format-json' is specified.
Default value: tabular
Allowed values: tabular, csv, json, xml
-
--output-header | --header (boolean)
-
--output-field | -f (array)
-
Field to include in the output. Multiple fields can be specified. Fields appear in the order you specify.
Default value: Value,SubValues,ReportHandle
Allowed values: Value, SubValues, ReportHandle
OM Web Viewer Connection Options
Profile Options
-
--omview-profile | --omview-p (string)
- The name of a (omview) profile to load for this command execution.
-
--caview-profile | --caview-p (string)
- The name of a (caview) profile to load for this command execution.
-
--base-profile | --base-p (string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
-
--reject-unauthorized | --ru (boolean)
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
List logical views available for a specific report.
Use the returned 'ReportHandle' to reference a logical view in other commands.
For example, use 'ReportHandle' in the 'download report' command to download the logical view of that report.
Use the returned 'IndexNameHandle' in the 'list report index-values' command to retrieve the list of associated index values (if defined) for that index.
Usage
zowe omview list report logical-views <repositoryId> <reportHandle> [options]
Positional Arguments
-
repositoryId (number)
-
reportHandle (string)
Options
-
--output-format | --output (string)
-
Output format. This option is ignored if '--response-format-json' is specified.
Default value: tabular
Allowed values: tabular, csv, json, xml
-
--output-header | --header (boolean)
-
--output-field | -f (array)
-
Field to include in the output. Multiple fields can be specified. Fields appear in the order you specify.
Default value: Description,Index,SubIndexNames,ReportHandle,IndexNameHandle
Allowed values: Description, Index, SubIndexNames, ReportHandle, IndexNameHandle, Number, ViewId, Default
OM Web Viewer Connection Options
Profile Options
-
--omview-profile | --omview-p (string)
- The name of a (omview) profile to load for this command execution.
-
--caview-profile | --caview-p (string)
- The name of a (caview) profile to load for this command execution.
-
--base-profile | --base-p (string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
-
--reject-unauthorized | --ru (boolean)
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
List reports in a repository.
Use the returned 'ReportHandle' to reference a report in other commands.
For example, use the 'ReportHandle' in the 'download report' command to download that report.
Usage
zowe omview list reports <repositoryId> [options]
Positional Arguments
Options
-
--filter-name | -n (string)
-
--limit | -l (number)
-
--latest-versions | --latest-version | --lv (number)
-
--archival-since | --since | --archival-from | --from (string)
- Date of earliest archived reports to include based on archival date. Specify a value in the ISO-8601 format.
-
--archival-until | --until | --archival-to | --to (string)
- Date of latest archived reports to include based on archival date. Specify a value in the ISO-8601 format.
-
--output-header | --header (boolean)
-
--output-format | --output (string)
-
Output format. This option is ignored if '--response-format-json' is specified.
Default value: tabular
Allowed values: tabular, csv, json, xml
-
--output-field | -f (array)
-
Field to include in the output. Multiple fields can be specified. Fields appear in the order you specify.
Default value: ReportName,Lines,Pages,Type,ArchivalDate,Description,UserComments,ReportHandle
Allowed values: ReportName, Lines, Pages, Type, ArchivalDate, Description, UserComments, ReportHandle, TotalPages, OriginalType, Destination, JobName, Origin, Generation, SequenceNumber, SysoutClass, Status, JobID, Forms, XCode, UserID, ReadDate, PrintDate, OnDisk, OnTape, OnOptical, IndexOnDisk, Location, TapeSequence, TapePosition, TapeCount, ExtendedRetentionOptionID, RemainingDays, RemainingGenerations, RemainingCopy, RemainingDiskDays, RemainingDiskGeneration, RemainingDiskCopy, RemainingDisk2days
OM Web Viewer Connection Options
Profile Options
-
--omview-profile | --omview-p (string)
- The name of a (omview) profile to load for this command execution.
-
--caview-profile | --caview-p (string)
- The name of a (caview) profile to load for this command execution.
-
--base-profile | --base-p (string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
-
--reject-unauthorized | --ru (boolean)
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
List repositories.
Use the returned 'Identifier' to reference a repository in other commands.
For example, use the 'Identifier' in the list reports' command to list reports in that repository.
Usage
zowe omview list repositories [options]
Options
-
--filter-name | -n (string)
- Filter (include) based on repository name. Use the question mark (?) as a wildcard to represent a single character. Use the asterisk (*) as a wildcard to represent any number of characters.
-
--filter-path | -p (string)
-
--output-format | --output (string)
-
Output format. This option is ignored if '--response-format-json' is specified.
Default value: tabular
Allowed values: tabular, csv, json, xml
-
--output-header | --header (boolean)
-
--output-field | -f (array)
-
Field to include in the output. Multiple fields can be specified. Fields appear in the order you specify.
Default value: Identifier,Name,Description,Path,CharacterSet
Allowed values: Identifier, Name, Description, Path, CharacterSet, ReportAccess, CreatedBy, DateCreated, ModifiedBy, ModifiedDate
OM Web Viewer Connection Options
Profile Options
-
--omview-profile | --omview-p (string)
- The name of a (omview) profile to load for this command execution.
-
--caview-profile | --caview-p (string)
- The name of a (caview) profile to load for this command execution.
-
--base-profile | --base-p (string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
-
--reject-unauthorized | --ru (boolean)
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Search data in a OM View repository.
Search cross-report index data in a repository.
Search cross-report index names in a repository.
Use the returned 'IndexNameHandle' to reference a cross-report index name.
For example, use the 'IndexNameHandle' in the 'search index values' command to retrieve the list of index values for that cross-report index.
Usage
zowe omview search index names <repositoryId> [options]
Positional Arguments
Options
-
--filter-reports | --reports (string)
-
--filter-names | --names (string)
-
Filter (include) based on index name. Separate multiple index names with commas. Use the asterisk (*) as a wildcard to represent any number of characters.
Default value: *,*,*,*,*,*,*,*
-
--latest-versions | --latest-version | --lv (number)
-
--archival-since | --since | --archival-from | --from (string)
- Date of earliest archived reports to include based on archival date. Specify a value in the ISO-8601 format.
-
--archival-until | --until | --archival-to | --to (string)
- Date of latest archived reports to include based on archival date. Specify a value in the ISO-8601 format.
-
--online-only | --online (boolean)
-
--output-format | --output (string)
-
Output format. This option is ignored if '--response-format-json' is specified.
Default value: tabular
Allowed values: tabular, csv, json, xml
-
--output-header | --header (boolean)
-
--output-field | -f (array)
-
Field to include in the output. Multiple fields can be specified. Fields appear in the order you specify.
Default value: Index,SubIndexNames,IndexNameHandle
Allowed values: Index, SubIndexNames, IndexNameHandle
OM Web Viewer Connection Options
Profile Options
-
--omview-profile | --omview-p (string)
- The name of a (omview) profile to load for this command execution.
-
--caview-profile | --caview-p (string)
- The name of a (caview) profile to load for this command execution.
-
--base-profile | --base-p (string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
-
--reject-unauthorized | --ru (boolean)
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Search reports containing a cross-report index value in a repository.
Use the returned 'ReportHandle' to reference a view of the report.
For example, use the 'ReportHandle' in the 'download report' command to download that view of the report.
Usage
zowe omview search index reports <repositoryId> <indexNameHandle> <valueHandle> [options]
Positional Arguments
-
repositoryId (number)
-
indexNameHandle (string)
-
valueHandle (string)
Options
-
--filter-reports | --reports (string)
-
--latest-versions | --latest-version | --lv (number)
-
--archival-since | --since | --archival-from | --from (string)
- Date of earliest archived reports to include based on archival date. Specify a value in the ISO-8601 format.
-
--archival-until | --until | --archival-to | --to (string)
- Date of latest archived reports to include based on archival date. Specify a value in the ISO-8601 format.
-
--online-only | --online (boolean)
-
--output-format | --output (string)
-
Output format. This option is ignored if '--response-format-json' is specified.
Default value: tabular
Allowed values: tabular, csv, json, xml
-
--output-header | --header (boolean)
-
--output-field | -f (array)
-
Field to include in the output. Multiple fields can be specified. Fields appear in the order you specify.
Default value: ReportName,Lines,Pages,Type,ArchivalDate,Description,UserComments,ReportHandle
Allowed values: ReportName, Lines, Pages, Type, ArchivalDate, Description, UserComments, ReportHandle, TotalPages, OriginalType, Destination, JobName, Origin, Generation, SequenceNumber, SysoutClass, Status, JobID, Forms, XCode, UserID, ReadDate, PrintDate, OnDisk, OnTape, OnOptical, IndexOnDisk, Location, TapeSequence, TapePosition, TapeCount, ExtendedRetentionOptionID, RemainingDays, RemainingGenerations, RemainingCopy, RemainingDiskDays, RemainingDiskGeneration, RemainingDiskCopy, RemainingDisk2days
OM Web Viewer Connection Options
Profile Options
-
--omview-profile | --omview-p (string)
- The name of a (omview) profile to load for this command execution.
-
--caview-profile | --caview-p (string)
- The name of a (caview) profile to load for this command execution.
-
--base-profile | --base-p (string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
-
--reject-unauthorized | --ru (boolean)
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Search cross-report index values in a repository.
Use the returned 'IndexValueHandle' in the 'search index reports' command to retrieve the list of reports containing that index value.
Usage
zowe omview search index values <repositoryId> <indexNameHandle> [options]
Positional Arguments
-
repositoryId (number)
-
indexNameHandle (string)
Options
-
--filter-reports | --reports (string)
-
--filter-values | --values (string)
-
Filter (include) based on index values. Separate index values with commas. Use the asterisk (*) as a wildcard to represent any number of characters.
Default value: *,*,*,*,*,*,*,*
-
--latest-versions | --latest-version | --lv (number)
-
--archival-since | --since | --archival-from | --from (string)
- Date of earliest archived reports to include based on archival date. Specify a value in the ISO-8601 format.
-
--archival-until | --until | --archival-to | --to (string)
- Date of latest archived reports to include based on archival date. Specify a value in the ISO-8601 format.
-
--online-only | --online (boolean)
-
--output-format | --output (string)
-
Output format. This option is ignored if '--response-format-json' is specified.
Default value: tabular
Allowed values: tabular, csv, json, xml
-
--output-header | --header (boolean)
-
--output-field | -f (array)
-
Field to include in the output. Multiple fields can be specified. Fields appear in the order you specify.
Default value: Value,SubValues,IndexValueHandle
Allowed values: Value, SubValues, IndexValueHandle
OM Web Viewer Connection Options
Profile Options
-
--omview-profile | --omview-p (string)
- The name of a (omview) profile to load for this command execution.
-
--caview-profile | --caview-p (string)
- The name of a (caview) profile to load for this command execution.
-
--base-profile | --base-p (string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
-
--reject-unauthorized | --ru (boolean)
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Set information in OM View repository.
Set configuration for current user in repository.
Set distribution id for current user in repository.
Usage
zowe omview set user distribution <repositoryId> <distributionId> [options]
Positional Arguments
-
repositoryId (number)
-
distributionId (string)
Options
-
--output-format | --output (string)
-
Output format. This option is ignored if '--response-format-json' is specified.
Default value: tabular
Allowed values: tabular, csv, json, xml
-
--output-header | --header (boolean)
-
--output-field | -f (array)
-
Field to include in the output. Multiple fields can be specified. Fields appear in the order you specify.
Default value: Mode,DistId,ModeAccess,DistMask
Allowed values: Mode, DistId, ModeAccess, DistMask, Banner, Language, MasterAuthority, Printer, UserId
OM Web Viewer Connection Options
Profile Options
-
--omview-profile | --omview-p (string)
- The name of a (omview) profile to load for this command execution.
-
--caview-profile | --caview-p (string)
- The name of a (caview) profile to load for this command execution.
-
--base-profile | --base-p (string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
-
--reject-unauthorized | --ru (boolean)
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Set mode for current user in repository.
Usage
zowe omview set user mode <repositoryId> <mode> [options]
Positional Arguments
-
repositoryId (number)
-
mode (string)
- User mode.
Must match regular expression: ^(ALL|SAR|SARO|EXP|EXPO)$
Options
-
--output-format | --output (string)
-
Output format. This option is ignored if '--response-format-json' is specified.
Default value: tabular
Allowed values: tabular, csv, json, xml
-
--output-header | --header (boolean)
-
--output-field | -f (array)
-
Field to include in the output. Multiple fields can be specified. Fields appear in the order you specify.
Default value: Mode,DistId,ModeAccess,DistMask
Allowed values: Mode, DistId, ModeAccess, DistMask, Banner, Language, MasterAuthority, Printer, UserId
OM Web Viewer Connection Options
Profile Options
-
--omview-profile | --omview-p (string)
- The name of a (omview) profile to load for this command execution.
-
--caview-profile | --caview-p (string)
- The name of a (caview) profile to load for this command execution.
-
--base-profile | --base-p (string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
-
--reject-unauthorized | --ru (boolean)
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Interact with OPS/MVS® for automation administration and resource management.
Create a generic AOF event for API rules processing.
Create a generic AOF event for API rules processing
Usage
zowe ops create event <eventCode> <eventText> [options]
Positional Arguments
-
eventCode (string)
- The event code that is passed, upper-cased, to API rules in the AOF variable API.ID. This code can be up to 10 characters long.
-
eventText (string)
- The event text that is passed, unaltered, to API rules in the AOF variable API.TEXT. This text can be up to 255 characters long.
OPS/MVS Web Services / REST API connection options
-
--user (string)
- Your z/OS user name that is used to authenticate to OPS/MVS Web Services / REST API.
-
--password | --pass (string)
- Your z/OS password that is used to authenticate to OPS/MVS Web Services / REST API.
-
--host (string)
- The hostname of the server where OPS/MVS Web Services / REST API is running.
-
--port | -p (number)
- The port number for OPS/MVS Web Services / REST API.
-
--reject-unauthorized | --ru (boolean)
-
--protocol | --prot (string)
-
The protocol that is used for connecting to OPS/MVS Web Services / REST API.
Default value: https
Allowed values: http, https
-
--subsystem | --subs (string)
-
--rest-api | --ra (boolean)
-
--base-path | --bp (string)
- NOTE: This can only be used with the REST API server. 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. Only specify this option if you are using an Zowe API Mediation Layer.
Profile Options
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
Disable an Automated Operations Facility rule.
Disable the specified rule.
Usage
zowe ops disable rule <ruleset> <rule> [options]
Positional Arguments
-
ruleset (string)
- The ruleset containing the rule.
-
rule (string)
Options
-
--format | -f (string)
-
Format of the displayed output.
Default value: namevalue
Allowed values: namevalue, namevaluecolor, csv, json
OPS/MVS Web Services / REST API connection options
-
--user (string)
- Your z/OS user name that is used to authenticate to OPS/MVS Web Services / REST API.
-
--password | --pass (string)
- Your z/OS password that is used to authenticate to OPS/MVS Web Services / REST API.
-
--host (string)
- The hostname of the server where OPS/MVS Web Services / REST API is running.
-
--port | -p (number)
- The port number for OPS/MVS Web Services / REST API.
-
--reject-unauthorized | --ru (boolean)
-
--protocol | --prot (string)
-
The protocol that is used for connecting to OPS/MVS Web Services / REST API.
Default value: https
Allowed values: http, https
-
--subsystem | --subs (string)
-
--rest-api | --ra (boolean)
-
--base-path | --bp (string)
- NOTE: This can only be used with the REST API server. 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. Only specify this option if you are using an Zowe API Mediation Layer.
Profile Options
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
Enable an Automated Operations Facility rule.
Enable the specified rule.
Usage
zowe ops enable rule <ruleset> <rule> [options]
Positional Arguments
-
ruleset (string)
- The ruleset containing the rule.
-
rule (string)
OPS/MVS Web Services / REST API connection options
-
--user (string)
- Your z/OS user name that is used to authenticate to OPS/MVS Web Services / REST API.
-
--password | --pass (string)
- Your z/OS password that is used to authenticate to OPS/MVS Web Services / REST API.
-
--host (string)
- The hostname of the server where OPS/MVS Web Services / REST API is running.
-
--port | -p (number)
- The port number for OPS/MVS Web Services / REST API.
-
--reject-unauthorized | --ru (boolean)
-
--protocol | --prot (string)
-
The protocol that is used for connecting to OPS/MVS Web Services / REST API.
Default value: https
Allowed values: http, https
-
--subsystem | --subs (string)
-
--rest-api | --ra (boolean)
-
--base-path | --bp (string)
- NOTE: This can only be used with the REST API server. 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. Only specify this option if you are using an Zowe API Mediation Layer.
Profile Options
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
Execute an OPS/MVS REXX program or an operator command.
Execute the specified operator command.
Usage
zowe ops execute command <command> [options]
Positional Arguments
-
command (string)
- The text of the operator command to be issued. The length of this string cannot exceed 240 characters.
Options
-
--bmpCmdOut | --bco (string)
- If the specified command is an IMS command, this parameter controls the echoing of the command output. This keyword only applies if you are using an IMS Operations Facility (IOF) Batch Message Processing (BMP) program for issuing IMS commands. Valid values are: OPSLOG, WTO, and NONE. A value of 'OPSLOG' echoes all output that is associated with the current IMS command back to OPSLOG as trace messages. This results in a small amount of additional overhead to the command, assuming that the number of lines of output is not large. No output is sent back to any z/OS console or to the subsystem interface. A value of 'WTO' echoes all output that is associated with the current IMS command as Write To Operator messages to the z/OS console. Using this option can add a significant amount of overhead to IMS command processing and has the potential of flooding the consoles with command output messages. A value of 'NONE' sends IMS commands to the BMP and returns the responses to the issuing program (if so requested). This recommended approach results in the lowest amount of overhead. The use of this parameter does not affect how the IMS command output is returned to the command issuer. The default value for this parameter is 'NONE'.
-
--capture | --cp (string)
- This parameter captures command responses that are not internally routed back to the OPS/MVS console that issued the command. If this parameter is specified, command response messages are captured based on text segments matching the first characters (starting with column 1) of the messages. These captured response messages are in addition to the usual command response messages that are captured based on other specified parameters. You can specify up to 10 message text segments with this parameter, and each text segment can have up to 124 characters.
-
--cart | --ct (string)
- This parameter specifies a z/OS command and response token (CART). This token can be represented as either a one- to eight-character string such as MYCMDTOK, or as a one- to eight-byte hexadecimal value such as X'D6D7E2E205162738'. Messages issued in response to this command are issued using the same CART. If this parameter is not specified, OPS/MVS will generate a unique CART token and use this generated token to determine which response messages should be returned to the caller.
-
--cmdEcho | --ce (string)
- This parameter determines whether the issued command is echoed as the first line of the command response. You can specify either YES, which is the default, or NO. This parameter is ignored when the cmdLog parameter is set to NO.
-
--cmdLog | --cl (string)
- This parameter determines whether the issued command is echoed in both SYSLOG and the command response, or neither. You can specify either YES, which is the default, or NO. The NO setting overrides the setting of the cmdEcho parameter.
-
--cmdWait | --cw (string)
- This parameter specifies, in seconds, how long to wait for command output collection to complete. The number of lines that are collected are analyzed every few hundredths of a second, based on the value specified with the interval parameter. If no new output lines are forthcoming after at least two output lines have been received, the wait for more response characters is terminated before this cmdWait period expires. You can specify a value for this parameter from 1 through 600 seconds. If you specify a value of YES for the stopEnd parameter, the end line of a multi-line WTO message also stops response collection. The main difference between the cmdWait and wait parameters is that the wait parameter specifies an unconditional wait period, while the cmdWait parameter specifies a conditional wait based on a continuous, timely collection of response lines. The default value for this parameter is the value of the OCWAIT global OPS/MVS parameter. When used in IMS Type 2 message syntax, the cmdWait and wait parameters are identical and specify the maximum wait time in seconds for message completion. IBM documentation on IMSPLEX usage implies that the delay in gathering results from multiple IMS systems can be considerable and should be considered normal. The default if omitted is 120, or 2 minutes. This cmdWait parameter is mutually exclusive with the wait parameter.
-
--conName | --cn (string)
- This parameter defines the name of the console to receive the issued command. The console name that you provide can contain as many as eight characters. You can retrieve command output when the specified console is allocated to OPS/MVS. If the console is not allocated or does not exist, this request will return an error code of 190. This conName parameter is mutually exclusive with the conType parameter.
-
--conType | --cnt (string)
- This parameter specifies the appropriate type of console that should be used for the command that you are issuing. The default value for this parameter is the current value of the OCCONTYPE global OPS/MVS parameter. Valid values are: ANY, EXTCONS, SSCONS, or XTRACONS. A value of 'ANY' tells OPS/MVS to select the first available console to issue the command. In this case, OPS/MVS selects consoles in the following order: Subsystem consoles, followed by XTRACONS consoles, and finally Extended consoles. A value of 'EXTCONS' tells OPS/MVS to select the first available extended console. Extended consoles are controlled by the EXTENDEDCONSOLES global OPS/MVS parameter. A value of 'SSCONS' tells OPS/MVS to select the first available subsystem console. Subsystem consoles are controlled by the SUBSYSDEFAULT global OPS/MVS parameter. A value of 'XTRACONS' tells OPS/MVS to select the first available extra extended console. Extra extended consoles are controlled by the EXTRAEXTCONSOLES global OPS/MVS parameter. This conType parameter is mutually exclusive with the conName parameter.
-
--imsId | --id (string)
- If you use the IMS Operations Facility (IOF) at your site, you can use the /opscmd endpoint to issue IMS commands. If you are running only one copy of IMS on the system where the current instance of the OPS/MVS REST API is running, you can omit the imsId parameter. However, if several copies of IMS (such as a production version and a test version) reside on the system, use this parameter to specify the IMS control region that should receive the command. IMS IDs can contain from one to four characters. IBM ships IMS with a default IMS ID of IMSA. If you do not know the IMS ID of the IMS you want OPS/MVS to control, ask your systems management department. When used in IMS Type 2 message syntax, the command is issued to the IMSPLEX manager, and distributed from there. The imsId parameter is used to establish the eligibility of participating IMS systems to receive the command. If the imsId parameter is omitted, the first IMS system capable of responding receives the command. If the value of the imsId parameter is specified as a wildcard *, all participating IMS systems receive the command. The value of the imsId parameter can also be specified as a list, separated by spaces or commas, of specific IMS system names to receive the command. The wildcard * should not be used with the imsId parameter unless the imsPlex parameter is specified with an explicit name.
-
--imsPlex | --ip (string)
- If you use the IMS Operations Facility (IOF) at your site, you can use the /opscmd endpoint to issue IMS commands. If you are running only one copy of IMS on the system where the current instance of the OPS/MVS REST API is running, you can omit the imsId parameter. However, if several copies of IMS (such as a production version and a test version) reside on the system, use this parameter to specify the IMS control region that should receive the command. IMS IDs can contain from one to four characters. IBM ships IMS with a default IMS ID of IMSA. If you do not know the IMS ID of the IMS you want OPS/MVS to control, ask your systems management department. When used in IMS Type 2 message syntax, the command is issued to the IMSPLEX manager, and distributed from there. The imsId parameter is used to establish the eligibility of participating IMS systems to receive the command. If the imsId parameter is omitted, the first IMS system capable of responding receives the command. If the value of the imsId parameter is specified as a wildcard *, all participating IMS systems receive the command. The value of the imsId parameter can also be specified as a list, separated by spaces or commas, of specific IMS system names to receive the command. The wildcard * should not be used with the imsId parameter unless the imsPlex parameter is specified with an explicit name.
-
--imsReply | --ir (string)
- The presence of this imsPlex parameter implies you are issuing an IMS command using the IMS Type 2 message syntax. This value can be specified as a specific IMSPLEX name, in which case the imsId parameter controls the selection of participating IMS systems. The imsPlex parameter can also be specified as a wildcard *, meaning the imsId determines the IMSPLEX name. In this case, the imsId parameter cannot be specified as a wildcard *, but must contain a valid IMS system name. The imsId parameter, or the first of a list, will be used to locate the name of its associated IMSPLEX.
-
--interval | --int (string)
- This parameter specifies, in centiseconds, how frequently to test for command response lines to see if the response has ended. This interval parameter temporarily overrides the value of the OCINTERVAL global OPS/MVS parameter. The default for this interval parameter is the value of the OCINTERVAL global OPS/MVS parameter, but you can specify any number from 10 through 300, or a value of 0 to bypass interval testing.
-
--localOnly | --loc (string)
- When 'YES' is specified for this parameter, only messages from the local system are considered as potential command response candidates. This parameter should be used in conjunction with the capture and stopMsg parameters to prevent output from other systems possibly being returned as command output. You can specify either NO, which is the default, or YES.
-
--log | --lg (string)
- This parameter determines whether response lines from the issued command go into the SYSLOG and/or OPSLOG data sets. Valid options are: YES, NO, OFF, and NOWHERE. A value of 'YES' means command responses and command echo will be logged in both SYSLOG and OPSLOG. A value of 'NO' means SYSLOG will only contain the command echo, not the command responses, and OPSLOG will contain both the command echo and the command responses. A value of 'OFF' means the command echo and command responses will not be logged to SYSLOG. OPSLOG will contain the command responses, but not the command echo. A value of 'NOWHERE' means the command echo and command responses will not be logged to either the SYSLOG or the OPSLOG. Note that the logging of command response lines is also influenced by MIC and AOF rule processing. The default value for this parameter is 'YES'.
-
--maxCmdOut | --mco (string)
- This parameter defines how many command output lines to collect before terminating the command response. If the command output contains more lines than this maxCmdOut value, no more command output lines are collected. You can specify any value from 1 through 32767 for this parameter. The default value for this parameter is the value of the OCMAXMSG global OPS/MVS parameter.
-
--output | --out (string)
- This parameter determines whether you receive output from the issued command. You can specify either YES, which is the default, or NO. The NO setting is mutually exclusive with the wait parameter.
-
--stopEnd | --se (string)
- This parameter determines whether the end line of a multiline WTO message stops the collection of command output. Valid options are: YES, and NO. A value of 'YES' will cause the command response to terminate at the first end line of a multiline WTO message or at the time that is specified through the cmdWait parameter or the OCWAIT global OPS/MVS parameter. A value of 'NO' will cause the command output to continue collecting until either: the time interval that is specified by the cmdWait parameter or the OCWAIT global parameter expires; or no new command output lines are collected in the time interval that is specified by the interval parameter. The default value for this parameter is 'YES'.
-
--stopMsg | --sm (string)
- This parameter specifies a list of one to ten message text segments matching the first characters (starting with column 1) of the messages that terminate the collection of command response lines. When any of these text segments are detected, the collection of response lines stops. The message segment or segments you specify need not be directed to the console receiving the command response. Each item in the list of message text segments you specify can contain no more than 124 characters. All message text segments that are specified on this parameter will match both uppercase and lowercase text in potential matching messages (case-insensitive). This parameter does not work with IMS Type 2 commands. The stopMsg and stopResp parameters are mutually exclusive.
-
--stopResp | --sr (string)
- This parameter specifies a list of one to ten message text segments matching the first characters (starting with column 1) of the messages that terminate the collection of command response lines. The message segments that you specify must be directed to the console receiving the command response, and each item in the segment list can contain no more than 124 characters. You can use this stopResp parameter to terminate the collection of a long command response once the desired response line is found. All message text segments that are specified on this keyword will match both uppercase and lowercase text in potential matching messages (case-insensitive). The stopResp and stopMsg parameters are mutually exclusive.
-
--wait | -w (number)
- This parameter specifies a period of time (in seconds) to unconditionally wait to receive output from the issued command. Control is not returned to the caller until the full wait period elapses. In most cases, a conditional wait using the cmdWait parameter in conjunction with the interval and various stopXxxx parameters can be used to effectively collect command responses, thus eliminating the need for an unconditional wait. When used in IMS Type 2 message syntax, the wait parameter is identical to the cmdWait parameter. This wait parameter is mutually exclusive with the cmdWait parameter. If the output parameter is set to NO, you can not use this parameter (mutually exclusive).
-
--format | -f (string)
-
Format of the displayed output.
Default value: namevalue
Allowed values: namevalue, namevaluecolor, csv, json
OPS/MVS Web Services / REST API connection options
-
--user (string)
- Your z/OS user name that is used to authenticate to OPS/MVS Web Services / REST API.
-
--password | --pass (string)
- Your z/OS password that is used to authenticate to OPS/MVS Web Services / REST API.
-
--host (string)
- The hostname of the server where OPS/MVS Web Services / REST API is running.
-
--port | -p (number)
- The port number for OPS/MVS Web Services / REST API.
-
--reject-unauthorized | --ru (boolean)
-
--protocol | --prot (string)
-
The protocol that is used for connecting to OPS/MVS Web Services / REST API.
Default value: https
Allowed values: http, https
-
--subsystem | --subs (string)
-
--rest-api | --ra (boolean)
-
--base-path | --bp (string)
- NOTE: This can only be used with the REST API server. 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. Only specify this option if you are using an Zowe API Mediation Layer.
Profile Options
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
Execute the specified OPS/MVS REXX program.
Usage
zowe ops execute rexx <program> [options]
Positional Arguments
-
program (string)
- The name of the OPS/REXX source program. When enclosed in single quotes, the program name can be either a fully qualified data set name (sequential or PDS including member) or a member of a precompiled REXX data set. When not enclosed in quotes, the program name is expanded as follows: If it is in the format MYLIB, it is expanded to {USER_PREFIX}.MYLIB.REXX, where {USER_PREFIX} represents your default TSO prefix. If it is in the format MYLIB(MEMBER), it is expanded to {USER_PREFIX}.MYLIB.REXX(MEMBER). If it is in the format (MEMBER), it is expanded to {USER_PREFIX}.REXX(MEMBER).
Options
-
--argument | --arg (string)
- Specifies any characters to be passed to the OPS/REXX program. Leading blanks are stripped from the argument. Any embedded quotes will be passed on to the called OPS/REXX program unaltered and unfiltered. The length of the string cannot exceed 256 characters.
-
--maxQueue | --mq (string)
- The maximum number of output lines that this OPS/REXX program can have in its external data queue.
-
--workspace | --ws (string)
- Defines the size of the OPS/REXX program workspace, in bytes. The workspace size limits the maximum number of nested calls, symbols, and values that can be used during program execution. If your program has a large memory requirement, use this size value to specify a workspace that is larger than the default of 1.5 MB.
-
--timeout | --to (string)
- The amount of elapsed time (in minutes) the OPS/REXX program is allowed to execute. If this parameter is not specified, the default value specified in the application.yml (configuration file for the REST API server) parameter 'opsmvs.rexxExecRunTimeout' will be used. If the value specified for this parameter is zero, then no timeout limit is imposed on the OPS/REXX program.
-
--outputLimit | --ol (string)
- The maximum number of output lines the OPS/REXX program is allowed to generate before the OPS/REXX program is canceled. If this parameter is not specified, the default value specified in the application.yml (configuration file for the REST API server) parameter 'opsmvs.rexxExecOutputLimit' will be used. If the value for this parameter is zero, then no output limit is imposed on the OPS/REXX program.
-
--wait | -w (number)
-
--format | -f (string)
-
Format of the displayed output.
Default value: namevalue
Allowed values: namevalue, namevaluecolor, csv, json
OPS/MVS Web Services / REST API connection options
-
--user (string)
- Your z/OS user name that is used to authenticate to OPS/MVS Web Services / REST API.
-
--password | --pass (string)
- Your z/OS password that is used to authenticate to OPS/MVS Web Services / REST API.
-
--host (string)
- The hostname of the server where OPS/MVS Web Services / REST API is running.
-
--port | -p (number)
- The port number for OPS/MVS Web Services / REST API.
-
--reject-unauthorized | --ru (boolean)
-
--protocol | --prot (string)
-
The protocol that is used for connecting to OPS/MVS Web Services / REST API.
Default value: https
Allowed values: http, https
-
--subsystem | --subs (string)
-
--rest-api | --ra (boolean)
-
--base-path | --bp (string)
- NOTE: This can only be used with the REST API server. 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. Only specify this option if you are using an Zowe API Mediation Layer.
Profile Options
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
Display data associated with OPS/MVS automation elements, such as AOF rules and rulesets, and SSM resources, OPS log names, subsystems and RDF tables, or REST API server status.
Display a list of the OPSLOG lognames that are defined to the specified subsystem. The list also identifies the live OPSLOG. This command is only available when connected to the OPS/MVS REST API server.
Usage
zowe ops show logname [options]
Options
-
--format | -f (string)
-
Format of the displayed output.
Default value: namevalue
Allowed values: namevalue, namevaluecolor, csv, json
OPS/MVS Web Services / REST API connection options
-
--user (string)
- Your z/OS user name that is used to authenticate to OPS/MVS Web Services / REST API.
-
--password | --pass (string)
- Your z/OS password that is used to authenticate to OPS/MVS Web Services / REST API.
-
--host (string)
- The hostname of the server where OPS/MVS Web Services / REST API is running.
-
--port | -p (number)
- The port number for OPS/MVS Web Services / REST API.
-
--reject-unauthorized | --ru (boolean)
-
--protocol | --prot (string)
-
The protocol that is used for connecting to OPS/MVS Web Services / REST API.
Default value: https
Allowed values: http, https
-
--subsystem | --subs (string)
-
--rest-api | --ra (boolean)
-
--base-path | --bp (string)
- NOTE: This can only be used with the REST API server. 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. Only specify this option if you are using an Zowe API Mediation Layer.
Profile Options
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
Display data associated with the specified SSM resource. Currently, only the current and desired states of the resource are displayed.
Usage
zowe ops show resource <resourcename> [options]
Positional Arguments
-
resourcename (string)
- The name of the resource.
Options
OPS/MVS Web Services / REST API connection options
-
--user (string)
- Your z/OS user name that is used to authenticate to OPS/MVS Web Services / REST API.
-
--password | --pass (string)
- Your z/OS password that is used to authenticate to OPS/MVS Web Services / REST API.
-
--host (string)
- The hostname of the server where OPS/MVS Web Services / REST API is running.
-
--port | -p (number)
- The port number for OPS/MVS Web Services / REST API.
-
--reject-unauthorized | --ru (boolean)
-
--protocol | --prot (string)
-
The protocol that is used for connecting to OPS/MVS Web Services / REST API.
Default value: https
Allowed values: http, https
-
--subsystem | --subs (string)
-
--rest-api | --ra (boolean)
-
--base-path | --bp (string)
- NOTE: This can only be used with the REST API server. 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. Only specify this option if you are using an Zowe API Mediation Layer.
Profile Options
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Show the current and desired state of the resource "RESOURCE1" in the table "MYTABLE" for the "OPSS" subsystem:
zowe ops show resource "RESOURCE1" --table "MYTABLE" --subsystem "OPSS"
-
Show the current and desired state of all resources in the table "MYTABLE" for the "OPSS" subsystem. This command is only available when connected to the OPS/MVS REST API server:
zowe ops show resource * --table "MYTABLE" --subsystem "OPSS"
-
Show the current and desired state of all resources in all tables for the "OPSS" subsystem. This command is only available when connected to the OPS/MVS REST API server:
zowe ops show resource * --subsystem "OPSS"
Display data associated with the specified rule.
Usage
zowe ops show rule <ruleset> <rule> [options]
Positional Arguments
-
ruleset (string)
- The ruleset containing the rule.
-
rule (string)
Options
-
--format | -f (string)
-
Format of the displayed output.
Default value: namevalue
Allowed values: namevalue, namevaluecolor, csv, json
OPS/MVS Web Services / REST API connection options
-
--user (string)
- Your z/OS user name that is used to authenticate to OPS/MVS Web Services / REST API.
-
--password | --pass (string)
- Your z/OS password that is used to authenticate to OPS/MVS Web Services / REST API.
-
--host (string)
- The hostname of the server where OPS/MVS Web Services / REST API is running.
-
--port | -p (number)
- The port number for OPS/MVS Web Services / REST API.
-
--reject-unauthorized | --ru (boolean)
-
--protocol | --prot (string)
-
The protocol that is used for connecting to OPS/MVS Web Services / REST API.
Default value: https
Allowed values: http, https
-
--subsystem | --subs (string)
-
--rest-api | --ra (boolean)
-
--base-path | --bp (string)
- NOTE: This can only be used with the REST API server. 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. Only specify this option if you are using an Zowe API Mediation Layer.
Profile Options
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Show the data in csv format of the rule "MYRULE" in the ruleset "OPSRULES" for the "OPSS" subsystem:
zowe ops show rule "OPSRULES" "MYRULE" --subsystem "OPSS" -f csv
-
Show the data of all rules in ruleset "OPSRULES" for the "OPSS" subsystem. This command is only available when connected to the OPS/MVS REST API server:
zowe ops show rule "OPSRULES" "*" --subsystem "OPSS"
-
Show the data of all rules in all rulesets for the "OPSS" subsystem. This command is only available when connected to the OPS/MVS REST API server:
zowe ops show rule "*" "*" --subsystem "OPSS"
Display data associated with one or all rulesets for a specified subsystem. This command is only available when connected to the OPS/MVS REST API server.
Usage
zowe ops show ruleset [options]
Options
-
--ruleset (string)
-
--format | -f (string)
-
Format of the displayed output.
Default value: namevalue
Allowed values: namevalue, namevaluecolor, csv, json
OPS/MVS Web Services / REST API connection options
-
--user (string)
- Your z/OS user name that is used to authenticate to OPS/MVS Web Services / REST API.
-
--password | --pass (string)
- Your z/OS password that is used to authenticate to OPS/MVS Web Services / REST API.
-
--host (string)
- The hostname of the server where OPS/MVS Web Services / REST API is running.
-
--port | -p (number)
- The port number for OPS/MVS Web Services / REST API.
-
--reject-unauthorized | --ru (boolean)
-
--protocol | --prot (string)
-
The protocol that is used for connecting to OPS/MVS Web Services / REST API.
Default value: https
Allowed values: http, https
-
--subsystem | --subs (string)
-
--rest-api | --ra (boolean)
-
--base-path | --bp (string)
- NOTE: This can only be used with the REST API server. 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. Only specify this option if you are using an Zowe API Mediation Layer.
Profile Options
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Show the data for the rulesets defined for the "OPSS" subsystem:
zowe ops show ruleset --subsystem "OPSS"
-
Show the data for ruleset "CICS" for the default OPS/MVS subsystem:
zowe ops show ruleset --ruleset "CICS"
-
Show the data for ruleset IMS for the "OPSS" subsystem:
zowe ops show ruleset --ruleset "IMS" --subsystem "OPSS"
Display data associated with an OPS/MVS REST API server. This command is only available when connected to the OPS/MVS REST API server.
Usage
zowe ops show status [options]
Options
-
--format | -f (string)
-
Format of the displayed output.
Default value: namevalue
Allowed values: namevalue, namevaluecolor, csv, json
OPS/MVS Web Services / REST API connection options
-
--user (string)
- Your z/OS user name that is used to authenticate to OPS/MVS Web Services / REST API.
-
--password | --pass (string)
- Your z/OS password that is used to authenticate to OPS/MVS Web Services / REST API.
-
--host (string)
- The hostname of the server where OPS/MVS Web Services / REST API is running.
-
--port | -p (number)
- The port number for OPS/MVS Web Services / REST API.
-
--reject-unauthorized | --ru (boolean)
-
--protocol | --prot (string)
-
The protocol that is used for connecting to OPS/MVS Web Services / REST API.
Default value: https
Allowed values: http, https
-
--subsystem | --subs (string)
-
--rest-api | --ra (boolean)
-
--base-path | --bp (string)
- NOTE: This can only be used with the REST API server. 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. Only specify this option if you are using an Zowe API Mediation Layer.
Profile Options
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
Display a list of the OPS/MVS subsystems that are running on the host z/OS LPAR. This command is only available when connected to the OPS/MVS REST API server.
Usage
zowe ops show subsystem [options]
Options
-
--format | -f (string)
-
Format of the displayed output.
Default value: namevalue
Allowed values: namevalue, namevaluecolor, csv, json
OPS/MVS Web Services / REST API connection options
-
--user (string)
- Your z/OS user name that is used to authenticate to OPS/MVS Web Services / REST API.
-
--password | --pass (string)
- Your z/OS password that is used to authenticate to OPS/MVS Web Services / REST API.
-
--host (string)
- The hostname of the server where OPS/MVS Web Services / REST API is running.
-
--port | -p (number)
- The port number for OPS/MVS Web Services / REST API.
-
--reject-unauthorized | --ru (boolean)
-
--protocol | --prot (string)
-
The protocol that is used for connecting to OPS/MVS Web Services / REST API.
Default value: https
Allowed values: http, https
-
--subsystem | --subs (string)
-
--rest-api | --ra (boolean)
-
--base-path | --bp (string)
- NOTE: This can only be used with the REST API server. 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. Only specify this option if you are using an Zowe API Mediation Layer.
Profile Options
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
Display a list of the RDF tables that are defined to the specified subsystem. This command is only available when connected to the OPS/MVS REST API server.
Usage
zowe ops show table [options]
Options
OPS/MVS Web Services / REST API connection options
-
--user (string)
- Your z/OS user name that is used to authenticate to OPS/MVS Web Services / REST API.
-
--password | --pass (string)
- Your z/OS password that is used to authenticate to OPS/MVS Web Services / REST API.
-
--host (string)
- The hostname of the server where OPS/MVS Web Services / REST API is running.
-
--port | -p (number)
- The port number for OPS/MVS Web Services / REST API.
-
--reject-unauthorized | --ru (boolean)
-
--protocol | --prot (string)
-
The protocol that is used for connecting to OPS/MVS Web Services / REST API.
Default value: https
Allowed values: http, https
-
--subsystem | --subs (string)
-
--rest-api | --ra (boolean)
-
--base-path | --bp (string)
- NOTE: This can only be used with the REST API server. 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. Only specify this option if you are using an Zowe API Mediation Layer.
Profile Options
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
Start a System State Manager resource.
Start the specified resource. The desired state of the resource is set to the appropriate UP state and SSM takes action to start the resource.
Usage
zowe ops start resource <resourcename> <tablename> [options]
Positional Arguments
-
resourcename (string)
- The name of the resource.
-
tablename (string)
- The name of the table that contains the resource.
Options
-
--wait | -w (number)
- Wait for the specified number of seconds for the current state of the SSM resource to match the new desired state. If more than the specified number of seconds elapses and the current and desired states still do not match, the command fails with a timeout error.
OPS/MVS Web Services / REST API connection options
-
--user (string)
- Your z/OS user name that is used to authenticate to OPS/MVS Web Services / REST API.
-
--password | --pass (string)
- Your z/OS password that is used to authenticate to OPS/MVS Web Services / REST API.
-
--host (string)
- The hostname of the server where OPS/MVS Web Services / REST API is running.
-
--port | -p (number)
- The port number for OPS/MVS Web Services / REST API.
-
--reject-unauthorized | --ru (boolean)
-
--protocol | --prot (string)
-
The protocol that is used for connecting to OPS/MVS Web Services / REST API.
Default value: https
Allowed values: http, https
-
--subsystem | --subs (string)
-
--rest-api | --ra (boolean)
-
--base-path | --bp (string)
- NOTE: This can only be used with the REST API server. 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. Only specify this option if you are using an Zowe API Mediation Layer.
Profile Options
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Start the resource RESOURCE1 in the table "MYTABLE" for subsystem "OPSS".:
zowe ops start resource "RESOURCE1" "MYTABLE" --subsystem "OPSS"
-
Start the resource "RESOURCE1" in the table "MYTABLE" for the "OPSS" subsystem, and wait for up to 2 minutes for "RESOURCE1" to have a current state of UP.:
zowe ops start resource "RESOURCE1" "MYTABLE" --subsystem "OPSS" -w 120
Stop a System State Manager resource.
Stop the specified resource. The desired state of the resource is set to the appropriate DOWN state and SSM takes action to stop the resource.
Usage
zowe ops stop resource <resourcename> <tablename> [options]
Positional Arguments
-
resourcename (string)
- The name of the resource.
-
tablename (string)
- The name of the table that contains the resource.
Options
-
--wait | -w (number)
- Wait for the specified number of seconds for the current state of the SSM resource to match the new desired state. If more than the specified number of seconds elapses and the current and desired states still do not match, the command fails with a timeout error.
OPS/MVS Web Services / REST API connection options
-
--user (string)
- Your z/OS user name that is used to authenticate to OPS/MVS Web Services / REST API.
-
--password | --pass (string)
- Your z/OS password that is used to authenticate to OPS/MVS Web Services / REST API.
-
--host (string)
- The hostname of the server where OPS/MVS Web Services / REST API is running.
-
--port | -p (number)
- The port number for OPS/MVS Web Services / REST API.
-
--reject-unauthorized | --ru (boolean)
-
--protocol | --prot (string)
-
The protocol that is used for connecting to OPS/MVS Web Services / REST API.
Default value: https
Allowed values: http, https
-
--subsystem | --subs (string)
-
--rest-api | --ra (boolean)
-
--base-path | --bp (string)
- NOTE: This can only be used with the REST API server. 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. Only specify this option if you are using an Zowe API Mediation Layer.
Profile Options
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Stop the resource "RESOURCE1" in the table "MYTABLE" for the "OPSS" subsystem.:
zowe ops stop resource "RESOURCE1" "MYTABLE" --subsystem "OPSS"
-
Stop the "RESOURCE1" in the table "MYTABLE" for the "OPSS" subsystem, and wait for up to 2 minutes for "RESOURCE1" to have a current state of DOWN.:
zowe ops stop resource "RESOURCE1" "MYTABLE" --subsystem "OPSS" -w 120
Install and manage plug-ins.
Install plug-ins to an application.
Usage
zowe plugins install [plugin...] [options]
Positional Arguments
-
plugin... (string)
-
A space-separated list of plug-ins to install. A plug-in can be any format that is accepted by the `npm install` command (local directory, TAR file, git URL, public package, private package, etc...).
To use a relative local directory, at least one '/' or '\' must exist in the plug-in path. For example, you have a local plug-in in a folder called 'test-plugin' that you want to install. Specify the relative local directory by issuing the following command:
zowe plugins install ./test-plugin
If you omit the './', then the install command looks for 'test-plugin' in an npm registry.
If the plugin argument is omitted, the plugins.json file will determine which plug-ins are installed. For more information on the plugins.json file, see the --file option.
Options
-
--file (local file path)
-
Specifies the location of a plugins.json file that contains the plug-ins you want to install.
All plug-ins specified in plugins.json will be installed to the base CLI and the contents will be placed into /home/<user>/.zowe/plugins/plugins.json.
If you do not specify a plugins.json file and do not specify a plug-in, the default plugin.json file (/home/<user>/.zowe/plugins/plugins.json) will be used. This provides a way to install plug-ins that were lost or corrupted after reinstalling or updating Zowe CLI.
-
--registry (string)
-
The npm registry that is used when installing remote packages. When this value is omitted, the value returned by `npm config get registry` is used.
For more information about npm registries, see: https://docs.npmjs.com/misc/registry
-
--login (boolean)
-
The flag to add a registry user account to install from secure registry. It saves credentials to the .npmrc file using `npm login`. When this value is omitted, credentials from .npmrc file is used. If you used this flag once for specific registry, you don't have to use it again, it uses credentials from .npmrc file.
For more information about npm registries, see:
https://docs.npmjs.com/cli/login for NPM >= 9
https://docs.npmjs.com/cli/adduser for NPM < 9
Examples
-
Install plug-ins saved in /home/<user>/.zowe/plugins/plugins.json:
zowe plugins install
-
Install plug-ins saved in a properly formatted config file:
zowe plugins install --file /some/file/path/file_name.json
-
Install a remote plug-in:
zowe plugins install my-plugin
-
Install a remote plug-in using semver:
zowe plugins install my-plugin@"^1.2.3"
-
Install a remote plug-in from the specified registry:
zowe plugins install my-plugin --registry https://registry.npmjs.org/
-
Install a local folder, local TAR file, and a git URL:
zowe plugins install ./local-file /root/tar/some-tar.tgz git://github.com/project/repository.git#v1.0.0
-
Install a remote plug-in from the registry which requires authorization(don't need to use this flag if you have already logged in before):
zowe plugins install my-plugin --registry https://registry.npmjs.org/ --login
List all plug-ins installed.
Usage
zowe plugins list [options]
Options
-
--short | -s (boolean)
- Show output in abbreviated format
Show first steps required to set up plug-in for use.
Usage
zowe plugins show-first-steps [plugin] [options]
Positional Arguments
-
plugin (string)
-
The name of the installed plug-in to show first steps for.
If the plug-in argument is omitted, no action is taken.
Examples
Uninstall plug-ins.
Usage
zowe plugins uninstall [plugin...] [options]
Positional Arguments
Examples
-
Uninstall a plug-in:
zowe plugins uninstall my-plugin
Update plug-ins.
Usage
zowe plugins update [plugin...] [options]
Positional Arguments
Options
-
--registry (string)
-
The npm registry that is used when installing remote packages. When this value is omitted, the value returned by `npm config get registry` is used.
For more information about npm registries, see: https://docs.npmjs.com/misc/registry
-
--login (boolean)
-
The flag to add a registry user account to install from secure registry. It saves credentials to the .npmrc file using `npm login`. When this value is omitted, credentials from .npmrc file is used. If you used this flag once for specific registry, you don't have to use it again, it uses credentials from .npmrc file.
For more information about npm registries, see:
https://docs.npmjs.com/cli/login for NPM >= 9
https://docs.npmjs.com/cli/adduser for NPM < 9
Examples
Validate a plug-in that has been installed.
Usage
zowe plugins validate [plugin] [options]
Positional Arguments
-
plugin (string)
-
The name of the plug-in to validate.
Validation issues identified for this plug-in are displayed.
If the plug-in argument is omitted, all installed plug-ins are validated.
Options
Examples
-
Validate a plug-in named my-plugin:
zowe plugins validate my-plugin
-
Validate all installed plug-ins:
zowe plugins validate
-
Validate a plug-in named my-plugin, and treat warnings as errors:
zowe plugins validate my-plugin --fail-on-warning
Perform z/OSMF provisioning tasks on Published Templates in the Service Catalog and Provisioned Instances in the Service Registry.
Deletes instance previously provisioned with z/OSMF cloud provisioning services.
Deletes selected deprovisioned instance.
Usage
zowe provisioning delete instance <name> [options]
Positional Arguments
-
name (string)
- Deprovisioned Instance name.
Zosmf Connection Options
-
--host | -H (string)
- The z/OSMF server host name.
-
--port | -P (number)
-
The z/OSMF server port.
Default value: 443
-
--user | -u (string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized | --ru (boolean)
-
--base-path | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol (string)
-
--cert-file (local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Examples
Lists z/OSMF provisioning information such as the provisioned instances from the registry, the provisioned instance details, the available provisioning templates and provisioning template details.
Lists the z/OSMF service catalog published templates.
Usage
zowe provisioning list catalog-templates [options]
Options
Zosmf Connection Options
-
--host | -H (string)
- The z/OSMF server host name.
-
--port | -P (number)
-
The z/OSMF server port.
Default value: 443
-
--user | -u (string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized | --ru (boolean)
-
--base-path | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol (string)
-
--cert-file (local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Examples
List details about an instance provisioned with z/OSMF.
Usage
zowe provisioning list instance-info <name> [options]
Positional Arguments
-
name (string)
- Provisioned Instance Name
Options
-
--display (string)
-
Level of information to display for the provisioned instance. Possible values:
summary - summary information, no actions or variables
actions - (default) summary with actions, no variables
vars - summary information with variables, no actions
extended - extended information with actions
full - all available information
Allowed values: extended, summary, vars, actions, full
Zosmf Connection Options
-
--host | -H (string)
- The z/OSMF server host name.
-
--port | -P (number)
-
The z/OSMF server port.
Default value: 443
-
--user | -u (string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized | --ru (boolean)
-
--base-path | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol (string)
-
--cert-file (local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Examples
List a set of variables and their values for a given name.
Usage
zowe provisioning list instance-variables <name> [options]
Positional Arguments
-
name (string)
- Provisioned Instance Name
Zosmf Connection Options
-
--host | -H (string)
- The z/OSMF server host name.
-
--port | -P (number)
-
The z/OSMF server port.
Default value: 443
-
--user | -u (string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized | --ru (boolean)
-
--base-path | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol (string)
-
--cert-file (local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Response Format Options
-
--response-format-filter | --rff (array)
- Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
-
--response-format-type | --rft (string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.
list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.
object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header | --rfh (boolean)
- If "--response-format-type table" is specified, include the column headers in the output.
Examples
List the provisioned instances from the z/OSMF software registry.
Usage
zowe provisioning list registry-instances [options]
Options
-
--all-info | --ai (boolean)
- Display all available information about provisioned instances (summary by default).
-
--filter-by-type | --fbt (string)
- Filter the list of provisioned instances by type (e.g. DB2 or CICS).
-
--filter-by-external-name | --fben (string)
- Filter the list of provisioned instances by External Name.
-
--types | -t (boolean)
- Display a list of all types for provisioned instances (e.g. DB2 or CICS).
Zosmf Connection Options
-
--host | -H (string)
- The z/OSMF server host name.
-
--port | -P (number)
-
The z/OSMF server port.
Default value: 443
-
--user | -u (string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized | --ru (boolean)
-
--base-path | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol (string)
-
--cert-file (local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Examples
List details about a template published with z/OSMF Cloud Provisioning.
Usage
zowe provisioning list template-info <name> [options]
Positional Arguments
-
name (string)
- The name of a z/OSMF cloud provisioning template.
Options
Zosmf Connection Options
-
--host | -H (string)
- The z/OSMF server host name.
-
--port | -P (number)
-
The z/OSMF server port.
Default value: 443
-
--user | -u (string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized | --ru (boolean)
-
--base-path | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol (string)
-
--cert-file (local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Examples
Perform actions against instances provisioned with z/OSMF.
Perform actions on instances previously provisioned with z/OSMF cloud
provisioning services. To view the list of provisioned instances, use the
"zowe provisioning list registry-instances" command. Once you have
obtained an instance name you can use the "zowe provisioning list
instance-info <name>" command to view the available instance actions.
Usage
zowe provisioning perform action <name> <actionname> [options]
Positional Arguments
-
name (string)
- Provisioned Instance name.
-
actionname (string)
- The action name. Use the "zowe provisioning list instance-info <name>"
command to view available instance actions.
Zosmf Connection Options
-
--host | -H (string)
- The z/OSMF server host name.
-
--port | -P (number)
-
The z/OSMF server port.
Default value: 443
-
--user | -u (string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized | --ru (boolean)
-
--base-path | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol (string)
-
--cert-file (local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Examples
Using z/OSMF cloud provisioning services provision available templates.
Using z/OSMF cloud provisioning services, provision available templates.
You can view available templates using the zowe provisioning list catalog-templates command.
Usage
zowe provisioning provision template <name> [options]
Positional Arguments
-
name (string)
- The name of a z/OSMF cloud provisioning template.
Options
-
--properties | -p (string)
- A sequence of string enclosed "name=value" pairs of prompt variables.
e.g: "CSQ_MQ_SSID=ZCT1,CSQ_CMD_PFX=!ZCT1".
-
--properties-file | --pf (string)
- Path to .yml file containing properties.
-
--domain-name | --dn (string)
- Required if the user has consumer authorization to more than one domain with this template name.
-
--tenant-name | --tn (string)
- Required if the user has consumer authorization to more than one tenant in the same domain that contains this template name.
-
--user-data-id | --udi (string)
- ID for the user data specified with user-data. Passed into the software services registry.
-
--user-data | --ud (string)
- User data that is passed into the software services registry. Can be specified only if user-data-id is provided.
-
--account-info | --ai (string)
- Account information to use in the JCL JOB statement. The default is the account information that is associated with the resource pool for the tenant.
-
--system-nick-names | --snn (string)
- Each string is the nickname of the system upon which to provision the software service defined by the template. The field is required if the resource pool associated with the tenant used for this operation is not set up to automatically select a system. Only one nickname is allowed.If the field is provided it is validated.
e.g: "SYSNAME1,SYSNAME2".
Zosmf Connection Options
-
--host | -H (string)
- The z/OSMF server host name.
-
--port | -P (number)
-
The z/OSMF server port.
Default value: 443
-
--user | -u (string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized | --ru (boolean)
-
--base-path | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol (string)
-
--cert-file (local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Examples
Zowe CLI plugin for SYSVIEW
Display output from a primary command stored in a SYSVIEW capture data set
Usage
zowe sysview capture <capture-dsn> <capture-command> [options]
Positional Arguments
-
capture-dsn (string)
- Capture data set name from which to retrieve captured commands
-
capture-command (string)
- Captured command to retrieve
data options
-
--capture-row | --cr (number)
- Row number of command within capture data set
-
--capture-screen | --cs (string)
- Screen name, for commands which have multiple screens
-
--capture-title | --ct (string)
- The captured command screen title or a user supplied title specified on the CAPIMMED command
-
--fields | -f (array)
- Fields to be returned (by name). For example: "jobname" "cpu"
-
--all-rows | --ar (boolean)
- Return all rows of data, no matter how many. Overrides --row-start and --row-end
-
--row-start | --rs (number)
-
--row-end | --re (number)
-
--timeout | --to (number)
display options
-
--context-fields | --cf (array)
- Context fields to display. Defaults to hiding all context
-
--overview | -o (boolean)
- Display the overview section
-
--info | -i (boolean)
- Display the information area, if any
-
--pretty | -p (boolean)
-
--blank-if-zero | --biz | -b (boolean)
- Show a blank space instead of '0' values
-
--truncate | --tr (boolean)
response format options
sysview connection options
-
--host | -H (string)
- The hostname of the SYSVIEW REST API
-
--port | -P (number)
- The port number of the SYSVIEW REST API
-
--user | -u (string)
- Your z/OS username used to authenticate to the SYSVIEW REST API
-
--password | --pass | --pw (string)
- Your z/OS password used to authenticate to the SYSVIEW REST API
-
--reject-unauthorized | --ru (boolean)
- If set, the server certificate is verified against the list of supplied CAs
-
--ssid (string)
-
--base-path | --bp (string)
Profile Options
-
--sysview-profile | --sysview-p (string)
- The name of a (sysview) profile to load for this command execution.
-
--sysview-format-profile | --sysview-format-p (string)
- The name of a (sysview-format) profile to load for this command execution.
-
--base-profile | --base-p (string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Display the captured ACTIVITY command from MY.CAPTURE.DATASET.:
zowe sysview capture "MY.CAPTURE.DATASET" ACTIVITY
-
Display the Jobname, Jobid, and Status columns of the captured ACTIVITY command on row 3 from MY.CAPTURE.DATASET.:
zowe sysview capture "MY.CAPTURE.DATASET" ACTIVITY --capture-row 3 --fields Jobname Jobid Status
Submit a capture request2
Usage
zowe sysview capture-immediate <capture-file> [options]
Positional Arguments
-
capture-file (string)
- The list of SYSVIEW commands to be executed as an Event Capture.This takes the same form as a CAPLIB member.
display options
data options
sysview connection options
-
--host | -H (string)
- The hostname of the SYSVIEW REST API
-
--port | -P (number)
- The port number of the SYSVIEW REST API
-
--user | -u (string)
- Your z/OS username used to authenticate to the SYSVIEW REST API
-
--password | --pass | --pw (string)
- Your z/OS password used to authenticate to the SYSVIEW REST API
-
--reject-unauthorized | --ru (boolean)
- If set, the server certificate is verified against the list of supplied CAs
-
--ssid (string)
-
--base-path | --bp (string)
Profile Options
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
Confirm that the SYSVIEW REST server is running on a specified system.
Confirm that the SYSVIEW REST server is running on a system specified. The command outputs properties of the z/OS system and the SYSVIEW REST server.
Usage
zowe sysview check status [options]
sysview connection options
-
--host | -H (string)
- The hostname of the SYSVIEW REST API
-
--port | -P (number)
- The port number of the SYSVIEW REST API
-
--user | -u (string)
- Your z/OS username used to authenticate to the SYSVIEW REST API
-
--password | --pass | --pw (string)
- Your z/OS password used to authenticate to the SYSVIEW REST API
-
--reject-unauthorized | --ru (boolean)
- If set, the server certificate is verified against the list of supplied CAs
-
--ssid (string)
-
--base-path | --bp (string)
Profile Options
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Report the status of the SYSVIEW REST server that you specified in your default SYSVIEW REST profile:
zowe sysview check status
-
Report the status of the SYSVIEW REST server that you specified in a supplied SYSVIEW REST profile:
zowe sysview check status --sysview-profile SomeSysviewProfileName
-
Report the status of the SYSVIEW REST server that you specified manually via command line:
zowe sysview check status --host myhost --port 443 --user myuser --password mypass
Issue a SYSVIEW primary command and display output, including any messages
Usage
zowe sysview display <command-string> [options]
Positional Arguments
-
command-string (string)
- Command(s) to be issued
(If more than one command, separated by a semi-colon)
Example: "ACTIVITY;SORT CPU% D"
data options
-
--fields | -f (array)
- Fields to be returned (by name). For example: "jobname" "cpu"
-
--all-rows | --ar (boolean)
- Return all rows of data, no matter how many. Overrides --row-start and --row-end
-
--row-start | --rs (number)
-
--row-end | --re (number)
-
--timeout | --to (number)
display options
-
--context-fields | --cf (array)
- Context fields to display. Defaults to hiding all context
-
--overview | -o (boolean)
- Display the overview section
-
--info | -i (boolean)
- Display the information area, if any
-
--pretty | -p (boolean)
-
--blank-if-zero | --biz | -b (boolean)
- Show a blank space instead of '0' values
-
--truncate | --tr (boolean)
response format options
sysview connection options
-
--host | -H (string)
- The hostname of the SYSVIEW REST API
-
--port | -P (number)
- The port number of the SYSVIEW REST API
-
--user | -u (string)
- Your z/OS username used to authenticate to the SYSVIEW REST API
-
--password | --pass | --pw (string)
- Your z/OS password used to authenticate to the SYSVIEW REST API
-
--reject-unauthorized | --ru (boolean)
- If set, the server certificate is verified against the list of supplied CAs
-
--ssid (string)
-
--base-path | --bp (string)
Profile Options
-
--sysview-profile | --sysview-p (string)
- The name of a (sysview) profile to load for this command execution.
-
--sysview-format-profile | --sysview-format-p (string)
- The name of a (sysview-format) profile to load for this command execution.
-
--base-profile | --base-p (string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Issue the CSMSTAT command and show the 'message' field from the context area of the response:
zowe sysview display "CSMSTAT" --cf message
-
Issue the JOBSUM command to list jobs starting with "CS" showing only the fields Jobname, Jobid, and Status:
zowe sysview display "jobs CS&VLMC" --fields Jobname Jobid Status
Issue a SYSVIEW function command and display any messages
Usage
zowe sysview execute <command-string> [options]
Positional Arguments
-
command-string (string)
- Command(s) to be issued
(If more than one command, separated by a semi-colon)
Example: "ACTIVITY;SORT CPU% D"
display options
data options
sysview connection options
-
--host | -H (string)
- The hostname of the SYSVIEW REST API
-
--port | -P (number)
- The port number of the SYSVIEW REST API
-
--user | -u (string)
- Your z/OS username used to authenticate to the SYSVIEW REST API
-
--password | --pass | --pw (string)
- Your z/OS password used to authenticate to the SYSVIEW REST API
-
--reject-unauthorized | --ru (boolean)
- If set, the server certificate is verified against the list of supplied CAs
-
--ssid (string)
-
--base-path | --bp (string)
Profile Options
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
Interact with z/OSMF console services. Issue z/OS console commands and collect responses. z/OS console services establishes extended MCS (EMCS) consoles on behalf of the user, which are used to issue the commands and collect responses.
Important! Before you use commands in the zos-console command group, ensure that you understand the implications of issuing z/OS console commands in your environment.
z/OSMF console services provides a command response key upon successful issue of a console command. You can use this key to collect additional console message responses.
The z/OSMF console REST APIs return a "solicited response key" after successfully issuing a synchronous console command that produces solicited responses. You can use the "solicited response key"on the "sync-responses" command to collect any additional outstanding solicited responses from the console the command was issued.
In general, when issuing a z/OS console command, z/OS applications route responses to the originating console. The command response messages are referred to as "solicited command responses" (i.e. direct responses to the command issued). When issuing a z/OS console command using Zowe CLI, collection of all solicited command responses is attempted by default. However, there is no z/OS mechanism that indicates the total number of response messages that may be produced from a given command. Therefore, the Zowe CLI console APIs return a "solicited response key" that can be used to "follow-up" and collect any additional solicited command responses.
Usage
zowe zos-console collect sync-responses <responsekey> [options]
Positional Arguments
-
responsekey (string)
- The "solicited response key" provided in response to a previously issued console command. Used by the z/OSMF console API to collect any additional outstanding solicited responses from a previously issued console command. Must match regular expression:
^\[a\-zA\-Z0\-9\]\+$
Options
Zosmf Connection Options
-
--host | -H (string)
- The z/OSMF server host name.
-
--port | -P (number)
-
The z/OSMF server port.
Default value: 443
-
--user | -u (string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized | --ru (boolean)
-
--base-path | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol (string)
-
--cert-file (local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Examples
Issue z/OS console commands and optionally collect responses.
Issue a z/OS console command and print command responses (known as "solicited command responses").
In general, when issuing a z/OS console command, z/OS applications route responses to the originating console. The command response messages are referred to as "solicited command responses" (i.e. direct responses to the command issued). When issuing a z/OS console command using Zowe CLI, collection of all solicited command responses is attempted by default. However, there is no z/OS mechanism that indicates the total number of response messages that may be produced from a given command. Therefore, the Zowe CLI console APIs return a "solicited response key" that can be used to "follow-up" and collect any additional solicited command responses.
Zowe CLI will issue "follow-up" API requests by default to collect any additional outstanding solicited command responses until a request returns no additional responses. At that time, Zowe CLI will attempt a final collection attempt. If no messages are present, the command is complete. If additional messages are present, the process is repeated. However, this does not guarantee that all messages produced in direct response (i.e. solicited) have been collected. The z/OS application may produce additional messages in direct response to your command at some point in the future. You can manually collect additional responses using the "command response key" OR specify additional processing options to, for example, delay collection attempts by a specified interval.
Usage
zowe zos-console issue command <commandtext> [options]
Positional Arguments
-
commandtext (string)
- The z/OS console command to issue.
Options
-
--console-name | --cn | -c (string)
-
The name of the z/OS extended MCS console to direct the command. You must have the required authority to access the console specified. You may also specify an arbitrary name, if your installation allows dynamic creation of consoles with arbitrary names.
Allowed values: ^[a-zA-Z0-9]+$
-
--include-details | --id | -i (boolean)
- Include additional details at the end of the Zowe CLI command response, such as the "command response key" and the z/OSMF command response URL.
-
--key-only | --ko | -k (boolean)
- Displays only the "command response key" returned from the z/OSMF console API. You can collect additional messages using the command key with 'zowe zos-console collect sync-responses <key>'. Note that when using this option, you will not be presented with the "first set" of command response messages (if present in the API response). However, you can view them by using the --response-format-json option.
-
--return-first | --rf | -r (boolean)
- Indicates that Zowe CLI should return immediately with the response message set returned in the first z/OSMF API request (even if no responses are present). Using this option may result in partial or no response, but quicker Zowe CLI command response time. The z/OSMF console API has an implicit wait when collecting the first set of console command responses, i.e you will normally receive at least one set of response messages.
-
--solicited-keyword | --sk | -s (string)
- For solicited responses (direct command responses) the response is considered complete if the keyword specified is present. If the keyword is detected, the command will immediately return, meaning the full command response may not be provided. The key only applies to the first request issued, follow up requests do not support searching for the keyword.
-
--sysplex-system | --ss | --sys (string)
- Specifies the z/OS system (LPAR) in the current SYSPLEX (where your target z/OSMF resides) to route the z/OS console command.
-
--wait-to-collect | --wtc | -w (number)
- Indicates that Zowe CLI wait at least the specified number of seconds before attempting to collect additional solicited response messages. If additional messages are collected on "follow-up" requests, the timer is reset until an attempt is made that results in no additional response messages.
-
--follow-up-attempts | --fua | -a (number)
Zosmf Connection Options
-
--host | -H (string)
- The z/OSMF server host name.
-
--port | -P (number)
-
The z/OSMF server port.
Default value: 443
-
--user | -u (string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized | --ru (boolean)
-
--base-path | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol (string)
-
--cert-file (local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Examples
-
Issue a z/OS console command to display the IPL information for the system:
zowe zos-console issue command "D IPLINFO"
-
Issue a z/OS console command to display the local and coordinated universal time and date:
zowe zos-console issue command "D T"
-
Issue a Db2 command to display information about the status and configuration of DDF:
zowe zos-console issue command "\-DB1G DISPLAY DDF"
Manage z/OS data sets, create data sets, and more.
Compare the contents of z/OS data sets or USS files in your terminal (stdout).
Compare the contents of two z/OS data sets in your terminal (stdout).
Usage
zowe zos-files compare data-set <dataSetName1> <dataSetName2> [options]
Positional Arguments
-
dataSetName1 (string)
- The name of the first data set you want to compare.
-
dataSetName2 (string)
- The name of the second data set you want to compare.
Options
-
--binary | -b (boolean)
- Transfer the content of the first data set in binary mode (no EBCDIC to ASCII conversion). If binary mode is set and the binary2 flag is not set then both data sets are transferred in binary mode.
-
--binary2 | --b2 (boolean)
- Transfer the content of the second data set in binary mode.
-
--encoding | --ec (string)
- Transfer the content of the first data set with encoding mode, which means that data conversion is performed using the file encoding specified. If encoding mode is set and the encoding2 flag is not set both data sets are transferred in encoding mode.
-
--encoding2 | --ec2 (string)
- Transfer the content of the second data set with encoding mode.
-
--record | -r (boolean)
- Transfer the content for the first data set in record mode, which means that no data conversion is performed and the record length is prepended to the data. The data transfer process returns each line as-is, without translation. No delimiters are added between records. If encoding mode is set and the encoding2 flag is not set both data sets are transferred in encoding mode. This option conflicts with binary mode.
-
--record2 | --r2 (boolean)
- Transfer the content for the second data set in record mode. Conflicts with binary2.
-
--volume-serial | --vs (string)
- The volume serial (VOLSER) where the first data set resides. You can use this option at any time. However, the VOLSER is required only when the data set is not cataloged on the system. A VOLSER is analogous to a drive name on a PC.
-
--volume-serial2 | --vs2 (string)
- The volume serial (VOLSER) where the second data set resides.
-
--seqnum | --sn (boolean)
-
--context-lines | --cl (number)
- The number of context lines that display before and after detected non-matching lines. By default all matching lines display. If you want to limit the amount of data returned to only lines with differences use the context lines option to reduce the matching lines to only those before and after non-matching lines. Using the value of 0 strips all matching lines.
-
--browser-view | --bv (boolean)
- Opens the diffs between two given files in browser.
-
--response-timeout | --rto (number)
- The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
Zosmf Connection Options
-
--host | -H (string)
- The z/OSMF server host name.
-
--port | -P (number)
-
The z/OSMF server port.
Default value: 443
-
--user | -u (string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized | --ru (boolean)
-
--base-path | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol (string)
-
--cert-file (local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Examples
-
Compare the contents of the data set members "sys1.samplib(antptso)" and "sys1.samplib(antxtso)":
zowe zos-files compare data-set "sys1.samplib(antptso)" "sys1.samplib(antxtso)"
-
Compare the contents of the data set members "sys1.samplib(antptso)" and "sys1.samplib(antxtso)" without sequence numbers:
zowe zos-files compare data-set "sys1.samplib(antptso)" "sys1.samplib(antxtso)" --no-seqnum
Compare the contents of a local file and a z/OS data set in your terminal (stdout).
Usage
zowe zos-files compare local-file-data-set <localFilePath> <dataSetName> [options]
Positional Arguments
-
localFilePath (string)
- The path of the local file you want to compare.
-
dataSetName (string)
- The name of the data set you want to compare.
Options
-
--binary | -b (boolean)
- Transfer the content of the first data set in binary mode (no EBCDIC to ASCII conversion). If binary mode is set and the binary2 flag is not set then both data sets are transferred in binary mode.
-
--encoding | --ec (string)
- Transfer the content of the first data set with encoding mode, which means that data conversion is performed using the file encoding specified. If encoding mode is set and the encoding2 flag is not set both data sets are transferred in encoding mode.
-
--record | -r (boolean)
- Transfer the content for the first data set in record mode, which means that no data conversion is performed and the record length is prepended to the data. The data transfer process returns each line as-is, without translation. No delimiters are added between records. If encoding mode is set and the encoding2 flag is not set both data sets are transferred in encoding mode. This option conflicts with binary mode.
-
--volume-serial | --vs (string)
- The volume serial (VOLSER) where the first data set resides. You can use this option at any time. However, the VOLSER is required only when the data set is not cataloged on the system. A VOLSER is analogous to a drive name on a PC.
-
--seqnum | --sn (boolean)
-
--context-lines | --cl (number)
- The number of context lines that display before and after detected non-matching lines. By default all matching lines display. If you want to limit the amount of data returned to only lines with differences use the context lines option to reduce the matching lines to only those before and after non-matching lines. Using the value of 0 strips all matching lines.
-
--browser-view | --bv (boolean)
- Opens the diffs between two given files in browser.
-
--response-timeout | --rto (number)
- The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
Zosmf Connection Options
-
--host | -H (string)
- The z/OSMF server host name.
-
--port | -P (number)
-
The z/OSMF server port.
Default value: 443
-
--user | -u (string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized | --ru (boolean)
-
--base-path | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol (string)
-
--cert-file (local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Examples
-
Compare the contents of the local file and the data set member "./a.txt" and "sys1.samplib(antxtso)":
zowe zos-files compare local-file-data-set "./a.txt" "sys1.samplib(antxtso)"
-
Compare the contents of the local file and the data set member "./a.txt" and "sys1.samplib(antxtso)" without sequence numbers:
zowe zos-files compare local-file-data-set "./a.txt" "sys1.samplib(antxtso)" --no-seqnum
Compare the contents of a local file and a spool dd in your terminal (stdout).
Usage
zowe zos-files compare local-file-spool-dd <localFilePath> <spoolDescription> [options]
Positional Arguments
Options
-
--seqnum | --sn (boolean)
-
--context-lines | --cl (number)
- The number of context lines that display before and after detected non-matching lines. By default all matching lines display. If you want to limit the amount of data returned to only lines with differences use the context lines option to reduce the matching lines to only those before and after non-matching lines. Using the value of 0 strips all matching lines.
-
--browser-view | --bv (boolean)
- Opens the diffs between two given files in browser.
-
--response-timeout | --rto (number)
- The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
Zosmf Connection Options
-
--host | -H (string)
- The z/OSMF server host name.
-
--port | -P (number)
-
The z/OSMF server port.
Default value: 443
-
--user | -u (string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized | --ru (boolean)
-
--base-path | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol (string)
-
--cert-file (local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Examples
Compare the contents of a local file and a z/OS USS file in your terminal (stdout).
Usage
zowe zos-files compare local-file-uss-file <localFilePath> <ussFilePath> [options]
Positional Arguments
-
localFilePath (string)
- The path of the local file you want to compare.
-
ussFilePath (string)
- The path of the USS file set you want to compare.
Options
-
--binary | -b (boolean)
- Transfer the content of the first data set in binary mode (no EBCDIC to ASCII conversion). If binary mode is set and the binary2 flag is not set then both data sets are transferred in binary mode.
-
--encoding | --ec (string)
- Transfer the content of the first data set with encoding mode, which means that data conversion is performed using the file encoding specified. If encoding mode is set and the encoding2 flag is not set both data sets are transferred in encoding mode.
-
--seqnum | --sn (boolean)
-
--context-lines | --cl (number)
- The number of context lines that display before and after detected non-matching lines. By default all matching lines display. If you want to limit the amount of data returned to only lines with differences use the context lines option to reduce the matching lines to only those before and after non-matching lines. Using the value of 0 strips all matching lines.
-
--browser-view | --bv (boolean)
- Opens the diffs between two given files in browser.
-
--response-timeout | --rto (number)
- The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
Zosmf Connection Options
-
--host | -H (string)
- The z/OSMF server host name.
-
--port | -P (number)
-
The z/OSMF server port.
Default value: 443
-
--user | -u (string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized | --ru (boolean)
-
--base-path | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol (string)
-
--cert-file (local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Examples
-
Compare the contents of the local file and the USS file "./a.txt" and "/u/user/test.txt":
zowe zos-files compare local-file-uss-file "./a.txt" "/u/user/test.txt"
-
Compare the contents of the local file and the USS file "./a.txt" and "/u/user/test.txt" without sequence numbers:
zowe zos-files compare local-file-uss-file "./a.txt" "/u/user/test.txt" --no-seqnum
Compare the contents of two spool dds in your terminal (stdout).
Usage
zowe zos-files compare spool-dd <spoolDescription1> <spoolDescription2> [options]
Positional Arguments
Options
-
--context-lines | --cl (number)
- The number of context lines that display before and after detected non-matching lines. By default all matching lines display. If you want to limit the amount of data returned to only lines with differences use the context lines option to reduce the matching lines to only those before and after non-matching lines. Using the value of 0 strips all matching lines.
-
--browser-view | --bv (boolean)
- Opens the diffs between two given files in browser.
-
--response-timeout | --rto (number)
- The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
Zosmf Connection Options
-
--host | -H (string)
- The z/OSMF server host name.
-
--port | -P (number)
-
The z/OSMF server port.
Default value: 443
-
--user | -u (string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized | --ru (boolean)
-
--base-path | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol (string)
-
--cert-file (local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Examples
-
Compare the contents of the two spool dds "jobName1:jobId1:spoolId1" "jobName2:jobId2:spoolId2":
zowe zos-files compare spool-dd "jobName1:jobId1:spoolId1" "jobName2:jobId2:spoolId2"
-
Compare the contents of the two spool dds "jobName1:jobId1:spoolId1" "jobName2:jobId2:spoolId2" without sequence numbers:
zowe zos-files compare spool-dd "jobName1:jobId1:spoolId1" "jobName2:jobId2:spoolId2" --no-seqnum
Compare the contents of two z/OS USS files in your terminal (stdout).
Usage
zowe zos-files compare uss-files <ussFilePath1> <ussFilePath2> [options]
Positional Arguments
-
ussFilePath1 (string)
- The path of the first USS file you want to compare.
-
ussFilePath2 (string)
- The path of the second USS file you want to compare.
Options
-
--binary | -b (boolean)
- Transfer the content of the first data set in binary mode (no EBCDIC to ASCII conversion). If binary mode is set and the binary2 flag is not set then both data sets are transferred in binary mode.
-
--binary2 | --b2 (boolean)
- Transfer the content of the second data set in binary mode.
-
--encoding | --ec (string)
- Transfer the content of the first data set with encoding mode, which means that data conversion is performed using the file encoding specified. If encoding mode is set and the encoding2 flag is not set both data sets are transferred in encoding mode.
-
--encoding2 | --ec2 (string)
- Transfer the content of the second data set with encoding mode.
-
--seqnum | --sn (boolean)
-
--context-lines | --cl (number)
- The number of context lines that display before and after detected non-matching lines. By default all matching lines display. If you want to limit the amount of data returned to only lines with differences use the context lines option to reduce the matching lines to only those before and after non-matching lines. Using the value of 0 strips all matching lines.
-
--browser-view | --bv (boolean)
- Opens the diffs between two given files in browser.
-
--response-timeout | --rto (number)
- The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
Zosmf Connection Options
-
--host | -H (string)
- The z/OSMF server host name.
-
--port | -P (number)
-
The z/OSMF server port.
Default value: 443
-
--user | -u (string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized | --ru (boolean)
-
--base-path | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol (string)
-
--cert-file (local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Examples
Copy a data set.
Copy a data set/partitioned data set to another data set/partitioned data set.
Usage
zowe zos-files copy data-set <fromDataSetName> <toDataSetName> [options]
Positional Arguments
-
fromDataSetName (string)
- The name of the data set that you want to copy from
-
toDataSetName (string)
- The name of the data set that you want to copy to
Options
-
--overwrite | -o | --ow (boolean)
- Specify this option as true if you wish to replace the entire target data set with the source data set. All members, even those with no naming overlap, will be overwritten
-
--replace | --rep (boolean)
- Specify this option as true if you wish to replace members with identical names in the target data set
-
--safe-replace | --safe-rep | --sr (boolean)
- Specify this option as true if you wish to replace members with identical names or the content of the target data set. This option will prompt to confirm.
-
--response-timeout | --rto (number)
- The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
Zosmf Connection Options
-
--host | -H (string)
- The z/OSMF server host name.
-
--port | -P (number)
-
The z/OSMF server port.
Default value: 443
-
--user | -u (string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized | --ru (boolean)
-
--base-path | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol (string)
-
--cert-file (local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Examples
-
Copy the data set named 'USER.FROM.SET' to the data set named 'USER.TO.SET':
zowe zos-files copy data-set "USER.FROM.SET" "USER.TO.SET"
-
Copy the data set member named 'USER.FROM.SET(MEM1)' to the data set member named 'USER.TO.SET(MEM2)':
zowe zos-files copy data-set "USER.FROM.SET(mem1)" "USER.TO.SET(mem2)"
-
Copy the data set named 'USER.FROM.SET' to the data set member named 'USER.TO.SET(MEM2)':
zowe zos-files copy data-set "USER.FROM.SET" "USER.TO.SET(mem2)"
-
Copy the data set member named 'USER.FROM.SET(MEM1)' to the data set named 'USER.TO.SET':
zowe zos-files copy data-set "USER.FROM.SET(mem1)" "USER.TO.SET"
-
Copy the data set named 'USER.FROM.SET' to the data set named 'USER.TO.SET' and replace members with identical names:
zowe zos-files copy data-set "USER.FROM.SET" "USER.TO.SET" --replace
-
Copy the partitioned data set named 'TEST.PDS1' to the partitioned data set named 'TEST.PDS2':
zowe zos-files copy data-set "USER.FROM.SET" "USER.TO.SET" --safe-replace
-
Copy the partitioned data set named 'USER.FROM.SET' to the partitioned data set named 'USER.FROM.SET' and overwrite the original contents:
zowe zos-files copy data-set "USER.FROM.SET" "USER.TO.SET" --overwrite
Copy a data set to another data set on a specified LPAR.
Usage
zowe zos-files copy data-set-cross-lpar <fromDataSetName> <toDataSetName> [options]
Positional Arguments
-
fromDataSetName (string)
- The name of the data set that you want to copy from
-
toDataSetName (string)
- The name of the data set that you want to copy to. If the data set does not exist it will be allocated automatically
Options
-
--replace | --rep (boolean)
- Specify this option as true if you wish to replace the target data set if it already exists.
-
--target-data-class | --tdc (string)
- The SMS data class to use for the allocation of the target data set.
-
--target-host | --th (string)
- The target z/OSMF server host name.
-
--target-management-class | --tmc (string)
- The SMS management class to use for the allocation of the target data set.
-
--target-password | --tpw (string)
- The target z/OSMF password, which can be the same as your TSO password.
-
--target-port | --tp (number)
- The target z/OSMF server port.
-
--target-storage-class | --tsc (string)
- The SMS storage class to use for the allocation of the target data set.
-
--target-token-type | --ttt (string)
- The value of the token to pass to the API for the target system.
-
--target-token-value | --ttv (string)
- The type of token to get and use for the API for the target system.
-
--target-user | --tu (string)
- The target z/OSMF user name, which can be the same as your TSO login.
-
--target-volume-serial | --tvs | --target-volser (string)
- The volume serial (VOLSER) on which you want the target data set to be placed.
-
--target-zosmf-profile | --t-zosmf-p | --target-zosmf-p (string)
- The name of a z/OSMF profile to load for the target host.
-
--response-timeout | --rto (number)
- The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
Zosmf Connection Options
-
--host | -H (string)
- The z/OSMF server host name.
-
--port | -P (number)
-
The z/OSMF server port.
Default value: 443
-
--user | -u (string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized | --ru (boolean)
-
--base-path | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol (string)
-
--cert-file (local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Examples
-
Copy the data set named 'USER.FROM.SET' to the data set named 'USER.TO.SET' using the --target-zosmf-p option to specify the target host using a zosmf profile:
zowe zos-files copy data-set-cross-lpar "USER.FROM.SET" "USER.TO.SET" --target-zosmf-p SYS1
-
Copy the data set member named 'USER.FROM.SET(MEM1)' to the data set member named 'USER.TO.SET(MEM2)':
zowe zos-files copy data-set-cross-lpar "USER.FROM.SET(mem1)" "USER.TO.SET(mem2)" --target-zosmf-p SYS1
-
Copy the data set named 'USER.FROM.SET' to the data set member named 'USER.TO.SET(MEM2)':
zowe zos-files copy data-set-cross-lpar "USER.FROM.SET" "USER.TO.SET(mem2)" --target-zosmf-p SYS1
-
Copy the data set member named 'USER.FROM.SET(MEM1)' to the data set named 'USER.TO.SET' using the --target-host, --target-user, and --target-password options:
zowe zos-files copy data-set-cross-lpar "USER.FROM.SET(mem1)" "USER.TO.SET" --target-host sys1.com --target-user user1 --target-password pass1
Create data sets.
Create data sets based on the properties of an existing data set.
Usage
zowe zos-files create data-set <dataSetName> [options]
Positional Arguments
-
dataSetName (string)
- The name of the data set that you want to create
Options
-
--attributes | -a (boolean)
- Show the full allocation attributes
-
--block-size | --bs | --blksize (number)
- The block size for the data set (for example, 6160)
-
--data-class | --dc (string)
- The SMS data class to use for the allocation
-
--data-set-type | --dst | --dsntype (string)
- The data set type (BASIC, EXTPREF, EXTREQ, HFS, LARGE, PDS, LIBRARY, PIPE)
-
--device-type | --dt | --unit (string)
- The device type, also known as 'unit'
-
--directory-blocks | --db | --dirblks (number)
- The number of directory blocks (for example, 25)
-
--like | --lk (string)
- Name of an existing data set to base your new data set's properties on
-
--management-class | --mc (string)
- The SMS management class to use for the allocation
-
--primary-space | --ps (number)
- The primary space allocation (for example, 5)
-
--record-format | --rf | --recfm (string)
- The record format for the data set (for example, FB for "Fixed Block")
-
--record-length | --rl | --lrecl (number)
- The logical record length. Analogous to the length of a line (for example, 80)
-
--secondary-space | --ss (number)
- The secondary space allocation (for example, 1)
-
--size | --sz (string)
- The size of the data set (specified as nCYL or nTRK - where n is the number of cylinders or tracks). Sets the primary allocation (the secondary allocation becomes ~10% of the primary).
-
--storage-class | --sc (string)
- The SMS storage class to use for the allocation
-
--volume-serial | --vs | --volser (string)
- The volume serial (VOLSER) on which you want the data set to be placed. A VOLSER is analogous to a drive name on a PC.
-
--response-timeout | --rto (number)
- The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
Zosmf Connection Options
-
--host | -H (string)
- The z/OSMF server host name.
-
--port | -P (number)
-
The z/OSMF server port.
Default value: 443
-
--user | -u (string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized | --ru (boolean)
-
--base-path | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol (string)
-
--cert-file (local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Examples
-
Create a data set with default parameters and like flag:
zowe zos-files create data-set NEW.DATASET --like EXISTING.DATASET
-
Create a data set with default parameters and like flag and lrecl flag:
zowe zos-files create data-set NEW.DATASET --like EXISTING.DATASET --lrecl 1024
-
Create a data set with type LIBRARY:
zowe zos-files create data-set NEW.DATASET --data-set-type LIBRARY
Create executable data sets.
Usage
zowe zos-files create data-set-binary <dataSetName> [options]
Positional Arguments
-
dataSetName (string)
- The name of the data set that you want to create
Options
-
--attributes | -a (boolean)
- Show the full allocation attributes
-
--block-size | --bs | --blksize (number)
-
--data-class | --dc (string)
- The SMS data class to use for the allocation
-
--data-set-type | --dst | --dsntype (string)
- The data set type (BASIC, EXTPREF, EXTREQ, HFS, LARGE, PDS, LIBRARY, PIPE)
-
--device-type | --dt | --unit (string)
- The device type, also known as 'unit'
-
--directory-blocks | --db | --dirblks (number)
-
--management-class | --mc (string)
- The SMS management class to use for the allocation
-
--primary-space | --ps (number)
-
--record-format | --rf | --recfm (string)
-
--record-length | --rl | --lrecl (number)
-
--secondary-space | --ss (number)
- The secondary space allocation (for example, 1)
-
--size | --sz (string)
- The size of the data set (specified as nCYL or nTRK - where n is the number of cylinders or tracks). Sets the primary allocation (the secondary allocation becomes ~10% of the primary).
-
--storage-class | --sc (string)
- The SMS storage class to use for the allocation
-
--volume-serial | --vs | --volser (string)
- The volume serial (VOLSER) on which you want the data set to be placed. A VOLSER is analogous to a drive name on a PC.
-
--response-timeout | --rto (number)
- The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
Zosmf Connection Options
-
--host | -H (string)
- The z/OSMF server host name.
-
--port | -P (number)
-
The z/OSMF server port.
Default value: 443
-
--user | -u (string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized | --ru (boolean)
-
--base-path | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol (string)
-
--cert-file (local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Examples
Create data sets for C code programming.
Usage
zowe zos-files create data-set-c <dataSetName> [options]
Positional Arguments
-
dataSetName (string)
- The name of the data set that you want to create
Options
-
--attributes | -a (boolean)
- Show the full allocation attributes
-
--block-size | --bs | --blksize (number)
-
--data-class | --dc (string)
- The SMS data class to use for the allocation
-
--data-set-type | --dst | --dsntype (string)
- The data set type (BASIC, EXTPREF, EXTREQ, HFS, LARGE, PDS, LIBRARY, PIPE)
-
--device-type | --dt | --unit (string)
- The device type, also known as 'unit'
-
--directory-blocks | --db | --dirblks (number)
-
--management-class | --mc (string)
- The SMS management class to use for the allocation
-
--primary-space | --ps (number)
-
--record-format | --rf | --recfm (string)
-
--record-length | --rl | --lrecl (number)
-
--secondary-space | --ss (number)
- The secondary space allocation (for example, 1)
-
--size | --sz (string)
- The size of the data set (specified as nCYL or nTRK - where n is the number of cylinders or tracks). Sets the primary allocation (the secondary allocation becomes ~10% of the primary).
-
--storage-class | --sc (string)
- The SMS storage class to use for the allocation
-
--volume-serial | --vs | --volser (string)
- The volume serial (VOLSER) on which you want the data set to be placed. A VOLSER is analogous to a drive name on a PC.
-
--response-timeout | --rto (number)
- The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
Zosmf Connection Options
-
--host | -H (string)
- The z/OSMF server host name.
-
--port | -P (number)
-
The z/OSMF server port.
Default value: 443
-
--user | -u (string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized | --ru (boolean)
-
--base-path | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol (string)
-
--cert-file (local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Examples
Create classic data sets (JCL, HLASM, CBL, etc...).
Usage
zowe zos-files create data-set-classic <dataSetName> [options]
Positional Arguments
-
dataSetName (string)
- The name of the data set that you want to create
Options
-
--attributes | -a (boolean)
- Show the full allocation attributes
-
--block-size | --bs | --blksize (number)
-
--data-class | --dc (string)
- The SMS data class to use for the allocation
-
--data-set-type | --dst | --dsntype (string)
- The data set type (BASIC, EXTPREF, EXTREQ, HFS, LARGE, PDS, LIBRARY, PIPE)
-
--device-type | --dt | --unit (string)
- The device type, also known as 'unit'
-
--directory-blocks | --db | --dirblks (number)
-
--management-class | --mc (string)
- The SMS management class to use for the allocation
-
--primary-space | --ps (number)
-
--record-format | --rf | --recfm (string)
-
--record-length | --rl | --lrecl (number)
-
--secondary-space | --ss (number)
- The secondary space allocation (for example, 1)
-
--size | --sz (string)
- The size of the data set (specified as nCYL or nTRK - where n is the number of cylinders or tracks). Sets the primary allocation (the secondary allocation becomes ~10% of the primary).
-
--storage-class | --sc (string)
- The SMS storage class to use for the allocation
-
--volume-serial | --vs | --volser (string)
- The volume serial (VOLSER) on which you want the data set to be placed. A VOLSER is analogous to a drive name on a PC.
-
--response-timeout | --rto (number)
- The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
Zosmf Connection Options
-
--host | -H (string)
- The z/OSMF server host name.
-
--port | -P (number)
-
The z/OSMF server port.
Default value: 443
-
--user | -u (string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized | --ru (boolean)
-
--base-path | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol (string)
-
--cert-file (local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Examples
Create partitioned data sets (PDS).
Usage
zowe zos-files create data-set-partitioned <dataSetName> [options]
Positional Arguments
-
dataSetName (string)
- The name of the data set that you want to create
Options
-
--allocation-space-unit | --asu (string)
-
--attributes | -a (boolean)
- Show the full allocation attributes
-
--block-size | --bs | --blksize (number)
-
--data-class | --dc (string)
- The SMS data class to use for the allocation
-
--data-set-type | --dst | --dsntype (string)
- The data set type (BASIC, EXTPREF, EXTREQ, HFS, LARGE, PDS, LIBRARY, PIPE)
-
--device-type | --dt | --unit (string)
- The device type, also known as 'unit'
-
--directory-blocks | --db | --dirblks (number)
-
--management-class | --mc (string)
- The SMS management class to use for the allocation
-
--primary-space | --ps (number)
-
--record-format | --rf | --recfm (string)
-
--record-length | --rl | --lrecl (number)
-
--secondary-space | --ss (number)
- The secondary space allocation (for example, 1)
-
--size | --sz (string)
- The size of the data set (specified as nCYL or nTRK - where n is the number of cylinders or tracks). Sets the primary allocation (the secondary allocation becomes ~10% of the primary).
-
--storage-class | --sc (string)
- The SMS storage class to use for the allocation
-
--volume-serial | --vs | --volser (string)
- The volume serial (VOLSER) on which you want the data set to be placed. A VOLSER is analogous to a drive name on a PC.
-
--response-timeout | --rto (number)
- The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
Zosmf Connection Options
-
--host | -H (string)
- The z/OSMF server host name.
-
--port | -P (number)
-
The z/OSMF server port.
Default value: 443
-
--user | -u (string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized | --ru (boolean)
-
--base-path | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol (string)
-
--cert-file (local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Examples
Create physical sequential data sets (PS).
Usage
zowe zos-files create data-set-sequential <dataSetName> [options]
Positional Arguments
-
dataSetName (string)
- The name of the data set that you want to create
Options
-
--attributes | -a (boolean)
- Show the full allocation attributes
-
--block-size | --bs | --blksize (number)
-
--data-class | --dc (string)
- The SMS data class to use for the allocation
-
--data-set-type | --dst | --dsntype (string)
- The data set type (BASIC, EXTPREF, EXTREQ, HFS, LARGE, PDS, LIBRARY, PIPE)
-
--device-type | --dt | --unit (string)
- The device type, also known as 'unit'
-
--directory-blocks | --db | --dirblks (number)
- The number of directory blocks (for example, 25)
-
--management-class | --mc (string)
- The SMS management class to use for the allocation
-
--primary-space | --ps (number)
-
--record-format | --rf | --recfm (string)
-
--record-length | --rl | --lrecl (number)
-
--secondary-space | --ss (number)
- The secondary space allocation (for example, 1)
-
--size | --sz (string)
- The size of the data set (specified as nCYL or nTRK - where n is the number of cylinders or tracks). Sets the primary allocation (the secondary allocation becomes ~10% of the primary).
-
--storage-class | --sc (string)
- The SMS storage class to use for the allocation
-
--volume-serial | --vs | --volser (string)
- The volume serial (VOLSER) on which you want the data set to be placed. A VOLSER is analogous to a drive name on a PC.
-
--response-timeout | --rto (number)
- The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
Zosmf Connection Options
-
--host | -H (string)
- The z/OSMF server host name.
-
--port | -P (number)
-
The z/OSMF server port.
Default value: 443
-
--user | -u (string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized | --ru (boolean)
-
--base-path | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol (string)
-
--cert-file (local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Examples
Create a VSAM cluster.
Usage
zowe zos-files create data-set-vsam <dataSetName> [options]
Positional Arguments
-
dataSetName (string)
- The name of the data set in which to create a VSAM cluster
Options
-
--attributes | -a (boolean)
- Show the full allocation attributes
-
--data-class | --dc (string)
- The SMS data class to use for the allocation
-
--data-set-organization | --dso | --dsorg (string)
-
The data set organization.
Default value: INDEXED
Allowed values: INDEXED, IXD, LINEAR, LIN, NONINDEXED, NIXD, NUMBERED, NUMD, ZFS
-
--management-class | --mc (string)
- The SMS management class to use for the allocation
-
--retain-for | --rf (number)
- The number of days that the VSAM cluster will be retained on the system. You can delete the cluster at any time when neither retain-for nor retain-to is specified.
-
--retain-to | --rt (string)
- The earliest date that a command without the PURGE parameter can delete an entry. Specify the expiration date in the form yyyyddd, where yyyy is a four-digit year (maximum value: 2155) and ddd is the three-digit day of the year from 001 through 365 (for non-leap years) or 366 (for leap years). You can delete the cluster at any time when neither retain-for nor retain-to is used. You cannot specify both the 'retain-to' and 'retain-for' options.
-
--secondary-space | --ss (number)
- The number of items for the secondary space allocation (for example, 840). The type of item allocated is the same as the type used for the '--size' option. If you do not specify a secondary allocation, a value of ~10% of the primary allocation is used.
-
--size | --sz (string)
-
--storage-class | --sc (string)
- The SMS storage class to use for the allocation
-
--volumes | -v (string)
- The storage volumes on which to allocate a VSAM cluster. Specify a single volume by its volume serial (VOLSER). To specify more than one volume, enclose the option in double-quotes and separate each VOLSER with a space. You must specify the volumes option when your cluster is not SMS-managed.
-
--response-timeout | --rto (number)
- The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
Zosmf Connection Options
-
--host | -H (string)
- The z/OSMF server host name.
-
--port | -P (number)
-
The z/OSMF server port.
Default value: 443
-
--user | -u (string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized | --ru (boolean)
-
--base-path | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol (string)
-
--cert-file (local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Examples
-
Create a VSAM data set named "SOME.DATA.SET.NAME" using default values of INDEXED, 840 KB primary storage and 84 KB secondary storage:
zowe zos-files create data-set-vsam SOME.DATA.SET.NAME
-
Create a 5 MB LINEAR VSAM data set named "SOME.DATA.SET.NAME" with 1 MB of secondary space. Show the properties of the data set when it is created:
zowe zos-files create data-set-vsam SOME.DATA.SET.NAME --data-set-organization LINEAR --size 5MB --secondary-space 1 --attributes
-
Create a VSAM data set named "SOME.DATA.SET.NAME", which is retained for 100 days:
zowe zos-files create data-set-vsam SOME.DATA.SET.NAME --retain-for 100
Create a UNIX directory.
Usage
zowe zos-files create uss-directory <ussPath> [options]
Positional Arguments
-
ussPath (string)
- The name of the directory that you want to create.
Options
Zosmf Connection Options
-
--host | -H (string)
- The z/OSMF server host name.
-
--port | -P (number)
-
The z/OSMF server port.
Default value: 443
-
--user | -u (string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized | --ru (boolean)
-
--base-path | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol (string)
-
--cert-file (local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Examples
Create a UNIX file.
Usage
zowe zos-files create uss-file <ussPath> [options]
Positional Arguments
-
ussPath (string)
- The name of the file that you want to create.
Options
Zosmf Connection Options
-
--host | -H (string)
- The z/OSMF server host name.
-
--port | -P (number)
-
The z/OSMF server port.
Default value: 443
-
--user | -u (string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized | --ru (boolean)
-
--base-path | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol (string)
-
--cert-file (local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Examples
Create a z/OS file system.
Usage
zowe zos-files create zos-file-system <fileSystemName> [options]
Positional Arguments
-
fileSystemName (string)
- The name of the file system to create.
Options
-
--cyls-pri | --cp (number)
-
--cyls-sec | --cs (number)
-
--data-class | --dc (string)
- The SMS data class to use for the allocation
-
--group | -g (string)
- The z/OS group ID or GID for the group of the ZFS root directory.
-
--management-class | --mc (string)
- The SMS management class to use for the allocation
-
--owner | -o (string)
- The z/OS user ID or UID for the owner of the ZFS root directory.
-
--perms | -p (number)
-
--storage-class | --sc (string)
- The SMS storage class to use for the allocation
-
--timeout | -t (number)
-
--volumes | -v (array)
- The storage volumes on which to allocate the z/OS file system. Specify a single volume by its volume serial (VOLSER). To specify more than one volume, separate each VOLSER with a space. You must specify the volumes option when your cluster is not SMS-managed.
-
--response-timeout | --rto (number)
- The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
Zosmf Connection Options
-
--host | -H (string)
- The z/OSMF server host name.
-
--port | -P (number)
-
The z/OSMF server port.
Default value: 443
-
--user | -u (string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized | --ru (boolean)
-
--base-path | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol (string)
-
--cert-file (local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Examples
-
Create a ZFS named "HLQ.MYNEW.ZFS" using default values of 755 permissions, 10 primary and 2 secondary cylinders allocated, and a timeout of 20 seconds:
zowe zos-files create zos-file-system HLQ.MYNEW.ZFS
-
Create a ZFS with 100 primary and 10 secondary cylinders allocated:
zowe zos-files create zos-file-system HLQ.MYNEW.ZFS --cp 100 --cs 10
-
Create a ZFS specifying the volumes that should be used:
zowe zos-files create zos-file-system HLQ.MYNEW.ZFS -v ZFS001 ZFS002
Delete a data set or Unix System Services file.
Delete a data set or data set member permanently.
Usage
zowe zos-files delete data-set <dataSetName> [options]
Positional Arguments
-
dataSetName (string)
- The name of the data set that you want to delete
Required Options
Options
-
--ignore-not-found | -i | --inf (boolean)
- Suppress errors if the data set does not exist.
-
--volume | --vol (string)
- The volume serial (VOLSER) where the data set resides. The option is required only when the data set is not catalogued on the system.
-
--response-timeout | --rto (number)
- The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
Zosmf Connection Options
-
--host | -H (string)
- The z/OSMF server host name.
-
--port | -P (number)
-
The z/OSMF server port.
Default value: 443
-
--user | -u (string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized | --ru (boolean)
-
--base-path | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol (string)
-
--cert-file (local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Examples
-
Delete the data set named 'ibmuser.cntl':
zowe zos-files delete data-set "ibmuser.cntl" -f
-
Delete the data set member named 'ibmuser.cntl(mem)':
zowe zos-files delete data-set "ibmuser.cntl(mem)" -f
-
Quietly delete a data set, suppressing errors if it doesn't exist:
zowe zos-files delete data-set "ibmuser.cntl(mem)" -fi
Delete a VSAM cluster permanently.
Usage
zowe zos-files delete data-set-vsam <dataSetName> [options]
Positional Arguments
-
dataSetName (string)
- The name of the VSAM cluster that you want to delete
Options
Required Options
Zosmf Connection Options
-
--host | -H (string)
- The z/OSMF server host name.
-
--port | -P (number)
-
The z/OSMF server port.
Default value: 443
-
--user | -u (string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized | --ru (boolean)
-
--base-path | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol (string)
-
--cert-file (local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Examples
-
Delete the VSAM data set named 'ibmuser.cntl.vsam':
zowe zos-files delete data-set-vsam "ibmuser.cntl.vsam" -f
-
Quietly delete all VSAM data sets that match 'ibmuser.AAA.**.FFF' ignoring not-found errors:
zowe zos-files delete data-set-vsam "ibmuser.AAA.**.FFF" -f
-
Delete a non-expired VSAM data set named 'ibmuser.cntl.vsam':
zowe zos-files delete data-set-vsam "ibmuser.cntl.vsam" -f --purge
-
Delete an expired VSAM data set named 'ibmuser.cntl.vsam' by overwriting the components with zeros:
zowe zos-files delete data-set-vsam "ibmuser.cntl.vsam" -f --erase
-
Quietly delete all VSAM data sets that match 'ibmuser.AAA.**.FFF' ignoring not-found errors:
zowe zos-files delete data-set-vsam "ibmuser.cntl.vsam" -fi
Delete migrated data sets.
Usage
zowe zos-files delete migrated-data-set <dataSetName> [options]
Positional Arguments
-
dataSetName (string)
- The name of the migrated data set you want to delete.
Options
Zosmf Connection Options
-
--host | -H (string)
- The z/OSMF server host name.
-
--port | -P (number)
-
The z/OSMF server port.
Default value: 443
-
--user | -u (string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized | --ru (boolean)
-
--base-path | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol (string)
-
--cert-file (local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Examples
Delete a Unix Systems Services (USS) file or directory permanently.
Usage
zowe zos-files delete uss-file <fileName> [options]
Positional Arguments
-
fileName (string)
- The name of the file or directory that you want to delete
Required Options
Options
-
--recursive | -r (boolean)
- Delete directories recursively.
-
--ignore-not-found | -i | --inf (boolean)
- Suppress errors if the file does not exist.
-
--response-timeout | --rto (number)
- The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
Zosmf Connection Options
-
--host | -H (string)
- The z/OSMF server host name.
-
--port | -P (number)
-
The z/OSMF server port.
Default value: 443
-
--user | -u (string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized | --ru (boolean)
-
--base-path | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol (string)
-
--cert-file (local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Examples
-
Delete the empty directory '/u/ibmuser/testcases':
zowe zos-files delete uss-file "/a/ibmuser/testcases" -f
-
Delete the file named '/a/ibmuser/my_text.txt':
zowe zos-files delete uss-file "/a/ibmuser/testcases/my_text.txt" -f
-
Recursively delete the directory named '/u/ibmuser/testcases':
zowe zos-files delete uss-file "/a/ibmuser/testcases" -rf
-
Quietly delete a file, suppressing errors if the file doesn't exist:
zowe zos-files delete uss-file "/a/ibmuser/testcases" -fi
Delete a z/OS file system permanently.
Usage
zowe zos-files delete zos-file-system <fileSystemName> [options]
Positional Arguments
-
fileSystemName (string)
- The name of the z/OS file system that you want to delete.
Required Options
Options
Zosmf Connection Options
-
--host | -H (string)
- The z/OSMF server host name.
-
--port | -P (number)
-
The z/OSMF server port.
Default value: 443
-
--user | -u (string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized | --ru (boolean)
-
--base-path | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol (string)
-
--cert-file (local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Examples
-
Delete the z/OS file system 'HLQ.MYNEW.ZFS':
zowe zos-files delete zos-file-system "HLQ.MYNEW.ZFS" -f
-
Quietly delete a z/OS file, suppressing errors if the file doesn't exist:
zowe zos-files delete zos-file-system "HLQ.MYNEW.ZFS" -fi
Download content from z/OS data sets and USS files to your PC.
Download all members from a partitioned data set to a local folder.
Usage
zowe zos-files download all-members <dataSetName> [options]
Positional Arguments
-
dataSetName (string)
- The name of the data set from which you want to download members
Options
-
--binary | -b (boolean)
- Download the file content in binary mode, which means that no data conversion is performed. The data transfer process returns each line as-is, without translation. No delimiters are added between records.
-
--directory | -d (string)
- The directory to where you want to save the members. The command creates the directory for you when it does not already exist. By default, the command creates a folder structure based on the data set qualifiers. For example, the data set ibmuser.new.cntl's members are downloaded to ibmuser/new/cntl).
-
--encoding | --ec (string)
- Download the file content with encoding mode, which means that data conversion is performed using the file encoding specified.
-
--extension | -e (string)
- Save the local files with a specified file extension. For example, .txt. Or "" for no extension. When no extension is specified, .txt is used as the default file extension.
-
--fail-fast | --ff (boolean)
-
--max-concurrent-requests | --mcr (number)
-
Specifies the maximum number of concurrent z/OSMF REST API requests to download members. Increasing the value results in faster downloads. However, increasing the value increases resource consumption on z/OS and can be prone to errors caused by making too many concurrent requests. If the download process encounters an error, the following message displays:
The maximum number of TSO address spaces have been created. When you specify 0, Zowe CLI attempts to download all members at once without a maximum number of concurrent requests.
Default value: 1
-
--preserve-original-letter-case | --po (boolean)
-
--record | -r (boolean)
- Download the file content in record mode, which means that no data conversion is performed and the record length is prepended to the data. The data transfer process returns each line as-is, without translation. No delimiters are added between records. Conflicts with binary.
-
--volume-serial | --vs (string)
- The volume serial (VOLSER) where the data set resides. You can use this option at any time. However, the VOLSER is required only when the data set is not cataloged on the system. A VOLSER is analogous to a drive name on a PC.
-
--response-timeout | --rto (number)
- The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
Zosmf Connection Options
-
--host | -H (string)
- The z/OSMF server host name.
-
--port | -P (number)
-
The z/OSMF server port.
Default value: 443
-
--user | -u (string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized | --ru (boolean)
-
--base-path | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol (string)
-
--cert-file (local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Examples
Download all members that match a specific pattern from a partitioned data set to a local folder.
Usage
zowe zos-files download all-members-matching <dataSetName> <pattern> [options]
Positional Arguments
-
dataSetName (string)
- The name of the data set from which you want to download members
-
pattern (string)
- The pattern or patterns to match members against. Also known as 'DSLEVEL'. The following special sequences can be used in the pattern:
%: matches any single character
*: matches any number of characters within a member
You can specify multiple patterns separated by commas, for example "Mem*, Test*"
Options
-
--binary | -b (boolean)
- Download the file content in binary mode, which means that no data conversion is performed. The data transfer process returns each line as-is, without translation. No delimiters are added between records.
-
--directory | -d (string)
- The directory to where you want to save the members. The command creates the directory for you when it does not already exist. By default, the command creates a folder structure based on the data set qualifiers. For example, the data set ibmuser.new.cntl's members are downloaded to ibmuser/new/cntl).
-
--encoding | --ec (string)
- Download the file content with encoding mode, which means that data conversion is performed using the file encoding specified.
-
--exclude-patterns | --ep (string)
- Exclude data sets that match these DSLEVEL patterns. Any data sets that match this pattern will not be downloaded.
-
--extension | -e (string)
- Save the local files with a specified file extension. For example, .txt. Or "" for no extension. When no extension is specified, .txt is used as the default file extension.
-
--fail-fast | --ff (boolean)
-
--max-concurrent-requests | --mcr (number)
-
Specifies the maximum number of concurrent z/OSMF REST API requests to download members. Increasing the value results in faster downloads. However, increasing the value increases resource consumption on z/OS and can be prone to errors caused by making too many concurrent requests. If the download process encounters an error, the following message displays:
The maximum number of TSO address spaces have been created. When you specify 0, Zowe CLI attempts to download all members at once without a maximum number of concurrent requests.
Default value: 1
-
--preserve-original-letter-case | --po (boolean)
-
--record | -r (boolean)
- Download the file content in record mode, which means that no data conversion is performed and the record length is prepended to the data. The data transfer process returns each line as-is, without translation. No delimiters are added between records. Conflicts with binary.
-
--volume-serial | --vs (string)
- The volume serial (VOLSER) where the data set resides. You can use this option at any time. However, the VOLSER is required only when the data set is not cataloged on the system. A VOLSER is analogous to a drive name on a PC.
-
--response-timeout | --rto (number)
- The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
Zosmf Connection Options
-
--host | -H (string)
- The z/OSMF server host name.
-
--port | -P (number)
-
The z/OSMF server port.
Default value: 443
-
--user | -u (string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized | --ru (boolean)
-
--base-path | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol (string)
-
--cert-file (local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Examples
-
Download the members of the data set "ibmuser.loadlib" that begin with "Test" to the directory "loadlib/":
zowe zos-files download all-members-matching "ibmuser.loadlib" "Test*" -d loadlib
-
Download the members of the data set "ibmuser.cntl" that begin with "Test" & "M" to the directory "output",
and exclude members that begin with "M2".:
zowe zos-files download all-members-matching "ibmuser.cntl" "test*,M*" --exclude-patterns "M2*" -d output
Download content from a z/OS data set to a local file.
Usage
zowe zos-files download data-set <dataSetName> [options]
Positional Arguments
-
dataSetName (string)
- The name of the data set that you want to download
Options
-
--binary | -b (boolean)
- Download the file content in binary mode, which means that no data conversion is performed. The data transfer process returns each line as-is, without translation. No delimiters are added between records.
-
--encoding | --ec (string)
- Download the file content with encoding mode, which means that data conversion is performed using the file encoding specified.
-
--extension | -e (string)
- Save the local files with a specified file extension. For example, .txt. Or "" for no extension. When no extension is specified, .txt is used as the default file extension.
-
--file | -f (string)
- The path to the local file where you want to download the content. When you omit the option, the command generates a file name automatically for you.
-
--preserve-original-letter-case | --po (boolean)
-
--record | -r (boolean)
- Download the file content in record mode, which means that no data conversion is performed and the record length is prepended to the data. The data transfer process returns each line as-is, without translation. No delimiters are added between records. Conflicts with binary.
-
--volume-serial | --vs (string)
- The volume serial (VOLSER) where the data set resides. You can use this option at any time. However, the VOLSER is required only when the data set is not cataloged on the system. A VOLSER is analogous to a drive name on a PC.
-
--response-timeout | --rto (number)
- The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
Zosmf Connection Options
-
--host | -H (string)
- The z/OSMF server host name.
-
--port | -P (number)
-
The z/OSMF server port.
Default value: 443
-
--user | -u (string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized | --ru (boolean)
-
--base-path | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol (string)
-
--cert-file (local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Examples
Download all data sets that match a DSLEVEL pattern (see help below). You can use several options to qualify which data sets will be skipped and how the downloaded files will be structured. Data sets that are neither physical sequential nor partitioned data sets (with members) will be excluded.
Usage
zowe zos-files download data-sets-matching <pattern> [options]
Positional Arguments
-
pattern (string)
- The pattern or patterns to match data sets against. Also known as 'DSLEVEL'. The following special sequences can be used in the pattern:
%: matches any single character
*: matches any number of characters within a data set name qualifier (e.g. "ibmuser.j*.old" matches "ibmuser.jcl.old" but not "ibmuser.jcl.very.old")
**: matches any number of characters within any number of data set name qualifiers (e.g. "ibmuser.**.old" matches both "ibmuser.jcl.old" and "ibmuser.jcl.very.old")
However, the pattern cannot begin with any of these sequences. You can specify multiple patterns separated by commas, for example "ibmuser.**.cntl,ibmuser.**.jcl"
Options
-
--binary | -b (boolean)
- Download the file content in binary mode, which means that no data conversion is performed. The data transfer process returns each line as-is, without translation. No delimiters are added between records.
-
--directory | -d (string)
- The directory to where you want to save the members. The command creates the directory for you when it does not already exist. By default, the command creates a folder structure based on the data set qualifiers. For example, the data set ibmuser.new.cntl's members are downloaded to ibmuser/new/cntl).
-
--encoding | --ec (string)
- Download the file content with encoding mode, which means that data conversion is performed using the file encoding specified.
-
--exclude-patterns | --ep (string)
- Exclude data sets that match these DSLEVEL patterns. Any data sets that match this pattern will not be downloaded.
-
--extension | -e (string)
- Save the local files with a specified file extension. For example, .txt. Or "" for no extension. When no extension is specified, .txt is used as the default file extension.
-
--extension-map | --em (string)
- Use this option to map data set names that match your pattern to the desired extension. A comma delimited key value pairing (e.g. "cntl=.jcl,cpgm=.c" to map the last segment of each data set (also known as the "low level qualifier" to the desired local file extension).
-
--fail-fast | --ff (boolean)
-
--max-concurrent-requests | --mcr (number)
-
Specifies the maximum number of concurrent z/OSMF REST API requests to download members. Increasing the value results in faster downloads. However, increasing the value increases resource consumption on z/OS and can be prone to errors caused by making too many concurrent requests. If the download process encounters an error, the following message displays:
The maximum number of TSO address spaces have been created. When you specify 0, Zowe CLI attempts to download all members at once without a maximum number of concurrent requests.
Default value: 1
-
--preserve-original-letter-case | --po (boolean)
-
--record | -r (boolean)
- Download the file content in record mode, which means that no data conversion is performed and the record length is prepended to the data. The data transfer process returns each line as-is, without translation. No delimiters are added between records. Conflicts with binary.
-
--volume-serial | --vs (string)
- The volume serial (VOLSER) where the data set resides. You can use this option at any time. However, the VOLSER is required only when the data set is not cataloged on the system. A VOLSER is analogous to a drive name on a PC.
-
--response-timeout | --rto (number)
- The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
Zosmf Connection Options
-
--host | -H (string)
- The z/OSMF server host name.
-
--port | -P (number)
-
The z/OSMF server port.
Default value: 443
-
--user | -u (string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized | --ru (boolean)
-
--base-path | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol (string)
-
--cert-file (local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Examples
-
Download all data sets beginning with "ibmuser" and ending with ".cntl" or ".jcl" to the local directory "jcl" to files with the extension ".jcl":
zowe zos-files download data-sets-matching "ibmuser.**.cntl, ibmuser.**.jcl" --directory jcl --extension .jcl
-
Download all data sets that begin with "ibmuser.public.project" or "ibmuser.project.private", excluding those that end in "lib" to the local directory "project", providing a custom mapping of data set low level qualifier to local file extension:
zowe zos-files download data-sets-matching "ibmuser.public.project.*, ibmuser.project.private.*" --exclude-patterns "ibmuser.public.**.*lib" --directory project --extension-map cpgm=c,asmpgm=asm,java=java,chdr=c,jcl=jcl,cntl=jcl
Download content from a USS directory to a local directory on your PC.
Usage
zowe zos-files download uss-directory <ussDirName> [options]
Positional Arguments
-
ussDirName (string)
- The name of the USS directory you want to download
Options
-
--attributes | --attrs (local file path)
- Path of an attributes file to control how files are downloaded.
-
--binary | -b (boolean)
- Download the file content in binary mode, which means that no data conversion is performed. The data transfer process returns each line as-is, without translation. No delimiters are added between records.
-
--depth (number)
- Filters content in USS based on the number of directories to traverse down.
-
--directory | -d (string)
- The directory to where you want to save the files. The command creates the directory for you when it does not already exist. By default, the command downloads the files to the current directory.
-
--encoding | --ec (string)
- Download the file content with encoding mode, which means that data conversion is performed using the file encoding specified.
-
--fail-fast | --ff (boolean)
-
--filesys (boolean)
- Filters content in USS based on the filesystem the data is on. true - all filesystems, false - same filesystem as search directory.
-
--group (string)
- Filters content in USS based on the owning group name or ID.
-
--include-hidden | --ih (boolean)
- Include hidden files and folders that have names beginning with a dot.
-
--max-concurrent-requests | --mcr (number)
-
Specifies the maximum number of concurrent z/OSMF REST API requests to download files. Increasing the value results in faster downloads. However, increasing the value increases resource consumption on z/OS and can be prone to errors caused by making too many concurrent requests. If the download process encounters an error, the following message displays:
The maximum number of TSO address spaces have been created. When you specify 0, Zowe CLI attempts to download all files at once without a maximum number of concurrent requests.
Default value: 1
-
--max-length | --max (number)
- The option --max-length specifies the maximum number of items to return. Skip this parameter to return all items. If you specify an incorrect value, the parameter returns up to 1000 items.
-
--mtime (string)
- Filters content in USS based on the last modification time. N - specify an exact number of days, +N - older than N days, -N - newer than N days
-
--name (string)
- Filters files in USS based on the name of the file or directory.
-
--overwrite | --ow (boolean)
- Overwrite files that already exist in your local environment.
-
--owner (string)
- Filters content in USS based on the owning user name or ID.
-
--perm (string)
- Filters content in USS based on the octal permissions string.
-
--size (string)
- Filters content in USS based on the size. Default units are bytes. Add a suffix of K for kilobytes, M for megabytes, or G for gigabytes. N - specify an exact file size, +N - larger than N size, -N - smaller than N size
-
--symlinks (boolean)
- Filters content in USS based on whether or not to follow symbolic links. true - report symlinks, false - follow symlinks
-
--type (string)
-
Filters content in USS based on the type of content. f - regular file, d - directory, l - symbolic link, p - FIFO named pipe, s - socket
Allowed values: f, d, l, p, s
-
--response-timeout | --rto (number)
- The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
Zosmf Connection Options
-
--host | -H (string)
- The z/OSMF server host name.
-
--port | -P (number)
-
The z/OSMF server port.
Default value: 443
-
--user | -u (string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized | --ru (boolean)
-
--base-path | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol (string)
-
--cert-file (local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Examples
-
Download the directory "/a/ibmuser" to "./" in binary mode:
zowe zos-files download uss-directory /a/ibmuser --binary
-
Download the directory "/a/ibmuser" to "./localDir":
zowe zos-files download uss-directory /a/ibmuser --directory localDir
-
Download files from the directory "/a/ibmuser" that match the name "*.log" and were modified within the last day:
zowe zos-files download uss-directory /a/ibmuser --name "*.log" --mtime -1
Download content from a USS file to a local file on your PC.
Usage
zowe zos-files download uss-file <ussFileName> [options]
Positional Arguments
-
ussFileName (string)
- The name of the USS file you want to download
Options
-
--attributes | --attrs (local file path)
- Path of an attributes file to control how files are downloaded.
-
--binary | -b (boolean)
- Download the file content in binary mode, which means that no data conversion is performed. The data transfer process returns each line as-is, without translation. No delimiters are added between records.
-
--encoding | --ec (string)
- Download the file content with encoding mode, which means that data conversion is performed using the file encoding specified.
-
--file | -f (string)
- The path to the local file where you want to download the content. When you omit the option, the command generates a file name automatically for you.
-
--response-timeout | --rto (number)
- The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
Zosmf Connection Options
-
--host | -H (string)
- The z/OSMF server host name.
-
--port | -P (number)
-
The z/OSMF server port.
Default value: 443
-
--user | -u (string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized | --ru (boolean)
-
--base-path | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol (string)
-
--cert-file (local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Examples
-
Download the file "/a/ibmuser/my_text.txt" to ./my_text.txt:
zowe zos-files download uss-file "/a/ibmuser/my_text.txt" -f ./my_text.txt
-
Download the file "/a/ibmuser/MyJava.class" to "java/MyJava.class" in binary mode:
zowe zos-files download uss-file "/a/ibmuser/MyJava.class" -b -f "java/MyJava.class"
-
Download the file "/a/ibmuser/MyJava.class" to "java/MyJava.class" using a .zosattributes file:
zowe zos-files download uss-file "/a/ibmuser/MyJava.class" --attributes /path/to/.zosattributes -f "java/MyJava.class"
Edit the contents of a data set or USS file with your terminal and default editor.
Edit content from a z/OS data set with your terminal and default editor.
Usage
zowe zos-files edit data-set <dataSetName> [options]
Positional Arguments
-
dataSetName (string)
- The name of the data set you want to edit.
Options
-
--editor | --ed (string)
- Editor that overrides the default editor for this file type. Set the option to the editor's executable file location or the program's name: ie "--editor notepad"
-
--extension | --ext (string)
- Set the file extension of the file for editing to leverage an editor's file-type-specific formatting: ie "--extension jcl"
-
--binary | -b (boolean)
- Transfer the file content in binary mode (no EBCDIC to ASCII conversion).
-
--encoding | --ec (string)
- Transfer the file content with encoding mode, which means that data conversion is performed using the file encoding specified.
-
--response-timeout | --rto (number)
- The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
Zosmf Connection Options
-
--host | -H (string)
- The z/OSMF server host name.
-
--port | -P (number)
-
The z/OSMF server port.
Default value: 443
-
--user | -u (string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized | --ru (boolean)
-
--base-path | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol (string)
-
--cert-file (local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Examples
-
Edit the contents of the data set member "ibmuser.cntl(iefbr14)":
zowe zos-files edit data-set ibmuser.cntl(iefbr14) --editor notepad
-
Edit the contents of the data set member "ibmuser.cntl(iefbr14)":
zowe zos-files edit data-set ibmuser.cntl(iefbr14) --editor C:\Windows\System32\Notepad.exe
-
Edit the contents of the data set member "ibmuser.jcl(iefbr14)" and set extension as "jcl":
zowe zos-files edit data-set ibmuser.jcl(iefbr14) --binary
Edit content from a Unix System Services (USS) file with your terminal and default editor.
Usage
zowe zos-files edit uss-file <ussFilePath> [options]
Positional Arguments
-
ussFilePath (string)
- The path of the USS file you want to edit.
Options
Zosmf Connection Options
-
--host | -H (string)
- The z/OSMF server host name.
-
--port | -P (number)
-
The z/OSMF server port.
Default value: 443
-
--user | -u (string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized | --ru (boolean)
-
--base-path | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol (string)
-
--cert-file (local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Examples
-
Edit the contents of the USS file "/a/ibmuser/my_text.txt" in notepad:
zowe zos-files edit uss-file /a/ibmuser/my_text.txt --editor notepad
-
Edit the contents of the USS file "/a/ibmuser/my_text.txt" in notepad:
zowe zos-files edit uss-file /a/ibmuser/my_text.txt --editor C:\Windows\System32\Notepad.exe
-
Edit the contents of the USS file "/a/ibmuser/my_jcl.jcl" with binary flag set:
zowe zos-files edit uss-file /a/ibmuser/my_text.txt --binary
Invoke z/OS utilities such as Access Method Services (AMS).
Submit control statements for execution by Access Method Services (IDCAMS). You can use IDCAMS to create VSAM data sets (CSI, ZFS, etc...), delete data sets, and more. You must format the control statements exactly as the IDCAMS utility expects. For more information about control statements, see the IBM publication 'z/OS DFSMS Access Method Services Commands'.
Usage
zowe zos-files invoke ams-file <controlStatementsFile> [options]
Positional Arguments
Zosmf Connection Options
-
--host | -H (string)
- The z/OSMF server host name.
-
--port | -P (number)
-
The z/OSMF server port.
Default value: 443
-
--user | -u (string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized | --ru (boolean)
-
--base-path | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol (string)
-
--cert-file (local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Options
Profile Options
Base Connection Options
Examples
Submit control statements for execution by Access Method Services (IDCAMS). You can use IDCAMS to create VSAM data sets (CSI, ZFS, etc...), delete data sets, and more. You must format the control statements exactly as the IDCAMS utility expects. For more information about control statements, see the IBM publication 'z/OS DFSMS Access Method Services Commands'.
Usage
zowe zos-files invoke ams-statements <controlStatements> [options]
Positional Arguments
Zosmf Connection Options
-
--host | -H (string)
- The z/OSMF server host name.
-
--port | -P (number)
-
The z/OSMF server port.
Default value: 443
-
--user | -u (string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized | --ru (boolean)
-
--base-path | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol (string)
-
--cert-file (local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Options
Profile Options
Base Connection Options
Examples
List data sets and data set members. Optionally, you can list their details and attributes.
List all members of a partitioned data set. To view additional information about each member, use the --attributes option under the Options section of this help text.
Usage
zowe zos-files list all-members <dataSetName> [options]
Positional Arguments
-
dataSetName (string)
- The name of the data set for which you want to list the members
Options
-
--attributes | -a (boolean)
- Display more information about each member. Data sets with an undefined record format display information related to executable modules. Variable and fixed block data sets display information about when the members were created and modified.
-
--max-length | --max (number)
- The option --max-length specifies the maximum number of items to return. Skip this parameter to return all items. If you specify an incorrect value, the parameter returns up to 1000 items.
-
--pattern (string)
- The option --pattern specifies the match pattern used when listing members in a data set. The default is to match against all members, e.g. "*".
-
--response-timeout | --rto (number)
- The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
Zosmf Connection Options
-
--host | -H (string)
- The z/OSMF server host name.
-
--port | -P (number)
-
The z/OSMF server port.
Default value: 443
-
--user | -u (string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized | --ru (boolean)
-
--base-path | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol (string)
-
--cert-file (local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Examples
-
Show members of the data set "ibmuser.asm":
zowe zos-files list all-members "ibmuser.asm"
-
Show attributes of members of the data set "ibmuser.cntl":
zowe zos-files list all-members "ibmuser.cntl" -a
-
Show the first 5 members of the data set "ibmuser.cntl":
zowe zos-files list all-members "ibmuser.cntl" --max 5
-
Show the first 4 members of the data set "ibmuser.cntl" matching an input pattern":
zowe zos-files list all-members "sys1.maclib" --pattern IJK* --max 4
List data sets that match a pattern in the data set name.
Usage
zowe zos-files list data-set <dataSetName> [options]
Positional Arguments
-
dataSetName (string)
- The name or pattern of the data set that you want to list
Options
-
--attributes | -a (boolean)
- Display more information about each member. Data sets with an undefined record format display information related to executable modules. Variable and fixed block data sets display information about when the members were created and modified.
-
--max-length | --max (number)
- The option --max-length specifies the maximum number of items to return. Skip this parameter to return all items. If you specify an incorrect value, the parameter returns up to 1000 items.
-
--volume-serial | --vs (string)
- The volume serial (VOLSER) where the data set resides. You can use this option at any time. However, the VOLSER is required only when the data set is not cataloged on the system. A VOLSER is analogous to a drive name on a PC.
-
--start | -s (string)
- An optional search parameter that specifies the first data set name to return in the response document.
-
--response-timeout | --rto (number)
- The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
Zosmf Connection Options
-
--host | -H (string)
- The z/OSMF server host name.
-
--port | -P (number)
-
The z/OSMF server port.
Default value: 443
-
--user | -u (string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized | --ru (boolean)
-
--base-path | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol (string)
-
--cert-file (local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Examples
-
Show the data set "ibmuser.asm":
zowe zos-files list data-set "ibmuser.asm"
-
Show attributes of the data set "ibmuser.cntl":
zowe zos-files list data-set "ibmuser.cntl" -a
-
Show all data sets of the user "ibmuser":
zowe zos-files list data-set "ibmuser.*"
-
Show attributes of all data sets of the user "ibmuser":
zowe zos-files list data-set "ibmuser.*" -a
-
Show the first 5 data sets of the user "ibmuser":
zowe zos-files list data-set "ibmuser.cntl" --max 5
List all mounted filesystems, or the specific filesystem mounted at a given path, or the filesystem with a given filesystem name.
Usage
zowe zos-files list file-system [options]
Options
Zosmf Connection Options
-
--host | -H (string)
- The z/OSMF server host name.
-
--port | -P (number)
-
The z/OSMF server port.
Default value: 443
-
--user | -u (string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized | --ru (boolean)
-
--base-path | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol (string)
-
--cert-file (local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Response Format Options
-
--response-format-filter | --rff (array)
- Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
-
--response-format-type | --rft (string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.
list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.
object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header | --rfh (boolean)
- If "--response-format-type table" is specified, include the column headers in the output.
Examples
-
To list all mounted filesystems:
zowe zos-files list file-system
-
To list filesystems mounted to a specific path:
zowe zos-files list file-system -p /a/ibmuser
-
To list filesystems mounted with a specific name:
zowe zos-files list file-system -f MY.ZFS
List USS files and directories in a UNIX file path.
Usage
zowe zos-files list uss-files <path> [options]
Positional Arguments
-
path (string)
- The directory containing the files and directories to be listed
Options
Zosmf Connection Options
-
--host | -H (string)
- The z/OSMF server host name.
-
--port | -P (number)
-
The z/OSMF server port.
Default value: 443
-
--user | -u (string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized | --ru (boolean)
-
--base-path | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol (string)
-
--cert-file (local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Response Format Options
-
--response-format-filter | --rff (array)
- Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
-
--response-format-type | --rft (string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.
list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.
object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header | --rfh (boolean)
- If "--response-format-type table" is specified, include the column headers in the output.
Examples
-
Show the files and directories in path '/u/ibmuser':
zowe zos-files list uss-files "/u/ibmuser"
-
Show the files and directories in path '/u/ibmuser displaying only the file or directory name:
zowe zos-files list uss-files "/u/ibmuser" --rff name
-
Show the files and directories in path '/u/ibmuser' displaying the headers associated with the file detail:
zowe zos-files list uss-files "/u/ibmuser" --rfh
Migrate data sets.
Migrate a data set.
Usage
zowe zos-files migrate data-set <dataSetName> [options]
Positional Arguments
-
dataSetName (string)
- The name of the data set you want to migrate.
Options
Zosmf Connection Options
-
--host | -H (string)
- The z/OSMF server host name.
-
--port | -P (number)
-
The z/OSMF server port.
Default value: 443
-
--user | -u (string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized | --ru (boolean)
-
--base-path | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol (string)
-
--cert-file (local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Examples
Mount z/OS UNIX file systems, such as HFS, ZFS, and more. This connects you to USS file systems.
Mount a UNIX file system on a specified directory.
Usage
zowe zos-files mount file-system <fileSystemName> <mountPoint> [options]
Positional Arguments
-
fileSystemName (string)
- The name of the file system to mount.
-
mountPoint (string)
- The directory to use as a mount point.
Options
Zosmf Connection Options
-
--host | -H (string)
- The z/OSMF server host name.
-
--port | -P (number)
-
The z/OSMF server port.
Default value: 443
-
--user | -u (string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized | --ru (boolean)
-
--base-path | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol (string)
-
--cert-file (local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Examples
Recall migrated data sets.
Recall a migrated data set.
Usage
zowe zos-files recall data-set <dataSetName> [options]
Positional Arguments
-
dataSetName (string)
- The name of the data set you want to recall.
Options
Zosmf Connection Options
-
--host | -H (string)
- The z/OSMF server host name.
-
--port | -P (number)
-
The z/OSMF server port.
Default value: 443
-
--user | -u (string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized | --ru (boolean)
-
--base-path | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol (string)
-
--cert-file (local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Examples
Rename a data set or member.
Rename a data set.
Usage
zowe zos-files rename data-set <beforeDataSetName> <afterDataSetName> [options]
Positional Arguments
Zosmf Connection Options
-
--host | -H (string)
- The z/OSMF server host name.
-
--port | -P (number)
-
The z/OSMF server port.
Default value: 443
-
--user | -u (string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized | --ru (boolean)
-
--base-path | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol (string)
-
--cert-file (local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Options
Profile Options
Base Connection Options
Examples
Rename a data set member.
Usage
zowe zos-files rename data-set-member <dataSetName> <beforeMemberName> <afterMemberName> [options]
Positional Arguments
Zosmf Connection Options
-
--host | -H (string)
- The z/OSMF server host name.
-
--port | -P (number)
-
The z/OSMF server port.
Default value: 443
-
--user | -u (string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized | --ru (boolean)
-
--base-path | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol (string)
-
--cert-file (local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Options
Profile Options
Base Connection Options
Examples
Search files for a search term.
Search all data sets and PDS members that match the data set name for a search term.
Usage
zowe zos-files search data-sets <pattern> <searchString> [options]
Positional Arguments
-
pattern (string)
- The pattern to match data sets against. Also known as 'DSLEVEL'. The following special sequences can be used in the pattern:
%: matches any single character
*: matches any number of characters within a data set name qualifier (e.g. "ibmuser.j*.old" matches "ibmuser.jcl.old" but not "ibmuser.jcl.very.old")
**: matches any number of characters within any number of data set name qualifiers (e.g. "ibmuser.**.old" matches both "ibmuser.jcl.old" and "ibmuser.jcl.very.old")
However, the pattern cannot begin with any of these sequences. You can specify multiple patterns separated by commas, for example "ibmuser.**.cntl,ibmuser.**.jcl"
-
searchString (string)
- The parameter to search for.
Options
-
--case-sensitive | --cs (boolean)
-
--encoding | --ec (string)
- Search the file content with encoding mode, which means that data conversion is performed using the file encoding specified.
-
--mainframe-search | --ms (boolean)
-
Perform a preliminary search on the mainframe, reducing network traffic. However, this option does not work with data sets that contain binary data. This option should be omitted if any data sets may be in binary format. Failure to do so may result in an incomplete set of search results.
Default value: false
-
--max-concurrent-requests | --mcr (number)
-
--timeout | --to (number)
- The number of seconds to search before timing out.
-
--regex | --re (boolean)
-
--response-timeout | --rto (number)
- The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
Zosmf Connection Options
-
--host | -H (string)
- The z/OSMF server host name.
-
--port | -P (number)
-
The z/OSMF server port.
Default value: 443
-
--user | -u (string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized | --ru (boolean)
-
--base-path | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol (string)
-
--cert-file (local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Examples
-
Search all of IBMUSER's data sets for 'ZOWE':
zowe zos-files search data-sets 'IBMUSER.*' 'ZOWE'
-
Search all of IBMUSER's data sets for 'ZOWE' in uppercase only:
zowe zos-files search data-sets 'IBMUSER.*' 'ZOWE' --case-sensitive
-
Search all of IBMUSER's data sets for 'ZOWE', and time out in 1 minute:
zowe zos-files search data-sets 'IBMUSER.*' 'ZOWE' --timeout 60
-
Search all of IBMUSER's data sets for 'ZOWE', and perform 8 parallel tasks:
zowe zos-files search data-sets 'IBMUSER.*' 'ZOWE' --max-concurrent-requests 8
-
Search all of IBMUSER's data sets using a regular expression:
zowe zos-files search data-sets 'IBMUSER.*' 'Z([A-Za-z]){3}' --regex
Unmount file systems, such as HFS, ZFS, and more. This disconnects you from USS file systems.
Unmount a UNIX file system.
Usage
zowe zos-files unmount file-system <fileSystemName> [options]
Positional Arguments
-
fileSystemName (string)
- The name of the file system to unmount.
Zosmf Connection Options
-
--host | -H (string)
- The z/OSMF server host name.
-
--port | -P (number)
-
The z/OSMF server port.
Default value: 443
-
--user | -u (string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized | --ru (boolean)
-
--base-path | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol (string)
-
--cert-file (local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Options
Profile Options
Base Connection Options
Examples
Upload the contents of a file to data sets.
Upload files from a local directory to a partitioned data set (PDS).
Usage
zowe zos-files upload dir-to-pds <inputdir> <dataSetName> [options]
Positional Arguments
-
inputdir (string)
- The path for a local directory that you want to upload to a PDS
-
dataSetName (string)
- The name of the partitioned data set to which you want to upload the files
Options
-
--binary | -b (boolean)
- Data content in binary mode, which means that no data conversion is performed. The data transfer process returns each record as-is, without translation. No delimiters are added between records.
-
--encoding | --ec (string)
- Data content in encoding mode, which means that data conversion is performed according to the encoding specified.
-
--migrated-recall | --mr (string)
-
The method by which migrated data set is handled. By default, a migrated data set is recalled synchronously. You can specify the following values: wait, nowait, error
Default value: nowait
-
--record | -r (boolean)
- Data content in record mode, which means that no data conversion is performed and the record length is prepended to the data. The data transfer process returns each line as-is, without translation. No delimiters are added between records. Conflicts with binary.
-
--volume-serial | --vs (string)
- The volume serial (VOLSER) where the data set resides. You can use this option at any time. However, the VOLSER is required only when the data set is not cataloged on the system. A VOLSER is analogous to a drive name on a PC.
-
--response-timeout | --rto (number)
- The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
Zosmf Connection Options
-
--host | -H (string)
- The z/OSMF server host name.
-
--port | -P (number)
-
The z/OSMF server port.
Default value: 443
-
--user | -u (string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized | --ru (boolean)
-
--base-path | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol (string)
-
--cert-file (local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Examples
Upload a local directory to a USS directory.
An optional .zosattributes file in the source directory can be used to control file conversion and tagging.
An example .zosattributes file:
# pattern local-encoding remote-encoding
# Don't upload the node_modules directory
node_modules -
# Don't upload files that start with periods
.* -
# Upload jpg images in binary
*.jpg binary binary
# Convert CICS Node.js profiles to EBCDIC
*.profile ISO8859-1 EBCDIC
Lines starting with the ‘#’ character are comments. Each line can specify up to three positional attributes:
- A pattern to match a set of files. Pattern-matching syntax follows the same rules as those that apply in .gitignore files (note that negated patterns that begin with ‘!’ are not supported). See https://git-scm.com/docs/gitignore#_pattern_format.
- A local-encoding to identify a file’s encoding on the local workstation. If '-' is specified for local-encoding,files that match the pattern are not transferred.
- A remote-encoding to specify the file’s desired character set on USS. This attribute must either match the local encoding or be set to EBCDIC. If set to EBCDIC, files are transferred in text mode and converted, otherwise they are transferred in binary mode. Remote files are tagged either with the remote encoding or as binary.
A .zosattributes file can either be placed in the top-level directory you want to upload, or its location can be specified by using the --attributes parameter. .zosattributes files that are placed in nested directories are ignored.
Usage
zowe zos-files upload dir-to-uss <inputDir> <USSDir> [options]
Positional Arguments
-
inputDir (string)
- The local directory path that you want to upload to a USS directory
-
USSDir (string)
- The name of the USS directory to which you want to upload the local directory
Options
-
--binary | -b (boolean)
- Data content in binary mode, which means that no data conversion is performed. The data transfer process returns each record as-is, without translation. No delimiters are added between records.
-
--recursive | -r (boolean)
- Upload all directories recursively.
-
--binary-files | --bf (string)
- Comma separated list of file names to be uploaded in binary mode. Use this option when you upload a directory in default ASCII mode, but you want to specify certain files to be uploaded in binary mode. All files matching specified file names will be uploaded in binary mode. If a .zosattributes file (or equivalent file specified via --attributes) is present, --binary-files will be ignored.
-
--ascii-files | --af (string)
- Comma separated list of file names to be uploaded in ASCII mode. Use this option when you upload a directory with --binary/-b flag, but you want to specify certain files to be uploaded in ASCII mode. All files matching specified file names will be uploaded in ASCII mode. If a .zosattributes file (or equivalent file specified via --attributes) is present, --ascii-files will be ignored.
-
--attributes | --attrs (string)
- Path of an attributes file to control how files are uploaded.
-
--max-concurrent-requests | --mcr (number)
-
Specifies the maximum number of concurrent z/OSMF REST API requests to upload files. Increasing the value results in faster uploads. However, increasing the value increases resource consumption on z/OS and can be prone to errors caused by making too many concurrent requests. If the upload process encounters an error, the following message displays:
The maximum number of TSO address spaces have been created. When you specify 0, Zowe CLI attempts to upload all members at once without a maximum number of concurrent requests.
Default value: 1
-
--include-hidden | --ih (boolean)
- Include hidden files and folders that have names beginning with a dot.
-
--encoding | --ec (string)
- Data content in encoding mode, which means that data conversion is performed according to the encoding specified.
-
--response-timeout | --rto (number)
- The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
Zosmf Connection Options
-
--host | -H (string)
- The z/OSMF server host name.
-
--port | -P (number)
-
The z/OSMF server port.
Default value: 443
-
--user | -u (string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized | --ru (boolean)
-
--base-path | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol (string)
-
--cert-file (local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Examples
-
Upload all files from the "local_dir" directory to the "/a/ibmuser/my_dir" USS directory:
zowe zos-files upload dir-to-uss "local_dir" "/a/ibmuser/my_dir"
-
Upload all files from the "local_dir" directory and all its sub-directories, to the "/a/ibmuser/my_dir" USS directory:
zowe zos-files upload dir-to-uss "local_dir" "/a/ibmuser/my_dir" --recursive
-
Upload all files from the "local_dir" directory to the "/a/ibmuser/my_dir" USS directory in default ASCII mode, while specifying a list of file names (without path) to be uploaded in binary mode:
zowe zos-files upload dir-to-uss "local_dir" "/a/ibmuser/my_dir" --binary-files "myFile1.exe,myFile2.exe,myFile3.exe"
-
Upload all files from the "local_dir" directory to the "/a/ibmuser/my_dir" USS directory in binary mode, while specifying a list of file names (without path) to be uploaded in ASCII mode:
zowe zos-files upload dir-to-uss "local_dir" "/a/ibmuser/my_dir" --binary --ascii-files "myFile1.txt,myFile2.txt,myFile3.txt"
-
Recursively upload all files from the "local_dir" directory to the "/a/ibmuser/my_dir" USS directory, specifying files to ignore and file encodings in the local file my_global_attributes:
zowe zos-files upload dir-to-uss "local_dir" "/a/ibmuser/my_dir" --recursive --attributes my_global_attributes
-
Upload all files from the "local_dir" directory to the "/a/ibmuser/my_dir" USS directory using IBM-1047 encoding:
zowe zos-files upload dir-to-uss "local_dir" "/a/ibmuser/my_dir" --encoding "IBM-1047"
Upload the contents of a file to a z/OS data set.
Usage
zowe zos-files upload file-to-data-set <inputfile> <dataSetName> [options]
Positional Arguments
-
inputfile (string)
- The local file that you want to upload to a data set
-
dataSetName (string)
- The name of the data set to which you want to upload the file
Options
-
--binary | -b (boolean)
- Data content in binary mode, which means that no data conversion is performed. The data transfer process returns each record as-is, without translation. No delimiters are added between records.
-
--encoding | --ec (string)
- Data content in encoding mode, which means that data conversion is performed according to the encoding specified.
-
--migrated-recall | --mr (string)
-
The method by which migrated data set is handled. By default, a migrated data set is recalled synchronously. You can specify the following values: wait, nowait, error
Default value: nowait
-
--record | -r (boolean)
- Data content in record mode, which means that no data conversion is performed and the record length is prepended to the data. The data transfer process returns each line as-is, without translation. No delimiters are added between records. Conflicts with binary.
-
--volume-serial | --vs (string)
- The volume serial (VOLSER) where the data set resides. You can use this option at any time. However, the VOLSER is required only when the data set is not cataloged on the system. A VOLSER is analogous to a drive name on a PC.
-
--response-timeout | --rto (number)
- The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
Zosmf Connection Options
-
--host | -H (string)
- The z/OSMF server host name.
-
--port | -P (number)
-
The z/OSMF server port.
Default value: 443
-
--user | -u (string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized | --ru (boolean)
-
--base-path | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol (string)
-
--cert-file (local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Examples
-
Upload file contents to a sequential data set named "ibmuser.ps":
zowe zos-files upload file-to-data-set "file.txt" "ibmuser.ps"
-
Upload file contents to a PDS member named "ibmuser.pds(mem)":
zowe zos-files upload file-to-data-set "file.txt" "ibmuser.pds(mem)"
-
Upload file contents to a migrated data set and wait for it to be recalled:
zowe zos-files upload file-to-data-set "file.txt" "ibmuser.ps" --mr wait
Upload content to a USS file from local file.
Usage
zowe zos-files upload file-to-uss <inputfile> <USSFileName> [options]
Positional Arguments
-
inputfile (string)
- The local file that you want to upload to a USS file
-
USSFileName (string)
- The name of the USS file to which you want to upload the file
Options
-
--binary | -b (boolean)
- Data content in binary mode, which means that no data conversion is performed. The data transfer process returns each record as-is, without translation. No delimiters are added between records.
-
--encoding | --ec (string)
- Data content in encoding mode, which means that data conversion is performed according to the encoding specified.
-
--attributes | --attrs (string)
- Path of an attributes file to control how files are uploaded.
-
--response-timeout | --rto (number)
- The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
Zosmf Connection Options
-
--host | -H (string)
- The z/OSMF server host name.
-
--port | -P (number)
-
The z/OSMF server port.
Default value: 443
-
--user | -u (string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized | --ru (boolean)
-
--base-path | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol (string)
-
--cert-file (local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Examples
Upload the content of a stdin to a z/OS data set.
Usage
zowe zos-files upload stdin-to-data-set <dataSetName> [options]
Positional Arguments
-
dataSetName (string)
- The name of the data set to which you want to upload data
Options
-
--binary | -b (boolean)
- Data content in binary mode, which means that no data conversion is performed. The data transfer process returns each record as-is, without translation. No delimiters are added between records.
-
--migrated-recall | --mr (string)
-
The method by which migrated data set is handled. By default, a migrated data set is recalled synchronously. You can specify the following values: wait, nowait, error
Default value: nowait
-
--record | -r (boolean)
- Data content in record mode, which means that no data conversion is performed and the record length is prepended to the data. The data transfer process returns each line as-is, without translation. No delimiters are added between records. Conflicts with binary.
-
--volume-serial | --vs (string)
- The volume serial (VOLSER) where the data set resides. You can use this option at any time. However, the VOLSER is required only when the data set is not cataloged on the system. A VOLSER is analogous to a drive name on a PC.
-
--response-timeout | --rto (number)
- The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
Zosmf Connection Options
-
--host | -H (string)
- The z/OSMF server host name.
-
--port | -P (number)
-
The z/OSMF server port.
Default value: 443
-
--user | -u (string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized | --ru (boolean)
-
--base-path | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol (string)
-
--cert-file (local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Examples
-
Stream content from stdin to a sequential data set named "ibmuser.ps" from a Windows console:
echo "hello world" | zowe zos-files upload stdin-to-data-set "ibmuser.ps"
-
Stream content from stdin to a partition data set member named "ibmuser.pds(mem)" from a Windows console:
echo "hello world" | zowe zos-files upload stdin-to-data-set "ibmuser.pds(mem)"
-
Stream content from stdin to a migrated data set and wait for it to be recalled from a Windows console:
echo "hello world" | zowe zos-files upload stdin-to-data-set "ibmuser.ps" --mr wait
View the contents of a data set or USS file on your terminal (stdout).
View content from a z/OS data set on your terminal (stdout).
Usage
zowe zos-files view data-set <dataSetName> [options]
Positional Arguments
-
dataSetName (string)
- The name of the data set you want to display.
Options
-
--binary | -b (boolean)
- Transfer the file content in binary mode (no EBCDIC to ASCII conversion).
-
--encoding | --ec (string)
- Transfer the file content with encoding mode, which means that data conversion is performed using the file encoding specified.
-
--record | -r (boolean)
- Transfer the file content in record mode, which means that no data conversion is performed and the record length is prepended to the data. The data transfer process returns each line as-is, without translation. No delimiters are added between records. Conflicts with binary.
-
--volume-serial | --vs (string)
- The volume serial (VOLSER) where the data set resides. You can use this option at any time. However, the VOLSER is required only when the data set is not cataloged on the system. A VOLSER is analogous to a drive name on a PC.
-
--range | -R (string)
- The range of records to return in either `SSS-EEE` or `SSS,NNN` format. SSS identifies the start record, EEE identifies the end record, and NNN identifies the number of retrieved records.
-
--response-timeout | --rto (number)
- The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
Zosmf Connection Options
-
--host | -H (string)
- The z/OSMF server host name.
-
--port | -P (number)
-
The z/OSMF server port.
Default value: 443
-
--user | -u (string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized | --ru (boolean)
-
--base-path | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol (string)
-
--cert-file (local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Examples
-
View the contents of the data set member "ibmuser.cntl(iefbr14)":
zowe zos-files view data-set "ibmuser.cntl(iefbr14)"
-
View the contents of the data set member "ibmuser.test.loadlib(main)" in binary mode:
zowe zos-files view data-set "ibmuser.test.loadlib(main)" --binary
-
View only the first two lines of content for data set member "ibmuser.cntl(iefbr14)":
zowe zos-files view data-set "ibmuser.cntl(iefbr14)" --range 0,2
-
View only lines six through eight (zero-based) in the contents of the data set member "ibmuser.cntl(iefbr14)":
zowe zos-files view data-set "ibmuser.cntl(iefbr14)" --range 5-7
View content from a Unix System Services (USS) file on your terminal (stdout).
Usage
zowe zos-files view uss-file <file> [options]
Positional Arguments
-
file (string)
- The name of the USS file you want to display.
Options
Zosmf Connection Options
-
--host | -H (string)
- The z/OSMF server host name.
-
--port | -P (number)
-
The z/OSMF server port.
Default value: 443
-
--user | -u (string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized | --ru (boolean)
-
--base-path | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol (string)
-
--cert-file (local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Examples
Data set and job functionality via FTP. This functionality uses the open source zos-node-accessor package from IBM. Commands under this group require you to create a zftp profile before using them.
If you find this functionality useful, please consider setting up z/OSMF on your system to get improved stability and speed and more features (for example, issuing TSO and console commands) by using core Zowe CLI.
Allocate a sequential or partitioned dataset
Allocate a sequential dataset or partitioned dataset with '--dcb "PDSTYPE=PDS"'
Usage
zowe zos-ftp allocate data-set <datasetName> [options]
Positional Arguments
-
datasetName (string)
- The dataset name you'd like to allocate.
Options
FTP Connection options
TLS / Secure Connection options
Profile Options
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
Delete data sets, jobs, and USS files
Delete a data set
Usage
zowe zos-ftp delete data-set <dataSet> [options]
Positional Arguments
-
dataSet (string)
- The data set (PDS member or physical sequential data set) which you would like to delete.
Required Options
FTP Connection options
TLS / Secure Connection options
Profile Options
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
Cancel a job and purge its output. Note: this command will not work to delete TSU or STC type jobs.
Usage
zowe zos-ftp delete job <jobid> [options]
Positional Arguments
-
jobid (string)
- The ID of the job that you would like to delete
FTP Connection options
TLS / Secure Connection options
Profile Options
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
Delete a USS file
Usage
zowe zos-ftp delete uss-file <ussFile> [options]
Positional Arguments
-
ussFile (string)
- The absolute path to a USS file you would like to delete.
Required Options
Options
-
--recursive (boolean)
- Delete the directory and all files/directories under it.
FTP Connection options
TLS / Secure Connection options
Profile Options
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
Download data set, job spool, and USS file content
Download all spool content for a job to files in a local directory by providing the job id
Usage
zowe zos-ftp download all-spool-by-jobid <jobid> [options]
Positional Arguments
-
jobid (string)
- The ID of the job for which you would like to list spool files
Options
FTP Connection options
TLS / Secure Connection options
Profile Options
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
Download the contents of a z/OS data set to a local file
Usage
zowe zos-ftp download data-set <dataSet> [options]
Positional Arguments
-
dataSet (string)
- The data set (PDS member or physical sequential data set) which you would like to download to a local file.
Options
FTP Connection options
TLS / Secure Connection options
Profile Options
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
Download the contents of a USS file to a local file
Usage
zowe zos-ftp download uss-file <ussFile> [options]
Positional Arguments
-
ussFile (string)
- The path to the USS file you would like to download.
Options
-
--binary | -b (boolean)
- Download the file content in binary mode, which means that no data conversion is performed. The data transfer process returns each line as-is, without translation. No delimiters are added between records.
-
--file | -f (string)
- The path to the local file where you want to download the content. When you omit the option, the command generates a file name automatically for you.
FTP Connection options
TLS / Secure Connection options
Profile Options
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
List data sets, data set members, uss files, jobs, spool files
List all data sets that match a DSLEVEL pattern (see help below).
The following values can be used with the --response-format-filter (--rff) argument to display more data from the data sets:volume, unit, referred, ext, used, recfm, lrecl, blksz, dsorg, and dsname.
Usage
zowe zos-ftp list data-set <pattern> [options]
Positional Arguments
-
pattern (string)
- The pattern or patterns to match data sets against. Also known as 'DSLEVEL', it is somewhat similar to the concept of a 'glob' (but not identical). The following special sequences can be used in the pattern:
%: Matches any single character
*: Matches any number of characters within a data set name qualifier (e.g. "ibmuser.j*.old" matches "ibmuser.jcl.old" but not "ibmuser.jcl.very.old")
**: Matches any number of characters within any number of data set name qualifiers (e.g. "ibmuser.**.old" matches both "ibmuser.jcl.old" and "ibmuser.jcl.very.old")
However, the pattern cannot begin with any of these sequences.
FTP Connection options
TLS / Secure Connection options
Profile Options
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Response Format Options
-
--response-format-filter | --rff (array)
- Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
-
--response-format-type | --rft (string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.
list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.
object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header | --rfh (boolean)
- If "--response-format-type table" is specified, include the column headers in the output.
Examples
List all members of the specified PDS or PDSE data set.
Usage
zowe zos-ftp list data-set-members <dsname> [options]
Positional Arguments
-
dsname (string)
- The PDS or PDSE data set name.
FTP Connection options
TLS / Secure Connection options
Profile Options
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Response Format Options
-
--response-format-filter | --rff (array)
- Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
-
--response-format-type | --rft (string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.
list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.
object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header | --rfh (boolean)
- If "--response-format-type table" is specified, include the column headers in the output.
Examples
List all data sets that match a DSLEVEL pattern (see help below).
Usage
zowe zos-ftp list jobs [options]
Options
-
--prefix (string)
- Specify the job name prefix of the jobs you own and want to list. You can specify a wildcard, which is usually in the form "JOB*".
If you don't specify this option all jobs under this owner will be listed by default.
-
--owner | -o (string)
- Specify the owner user ID of the jobs you want to list. The owner is the individual/user who submitted the job OR the user ID assigned to the job.
-
--status | -s (string)
- Specify the status of the jobs you want to list. The status is one of the following: INPUT, ACTIVE and OUTPUT.
FTP Connection options
TLS / Secure Connection options
Profile Options
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Response Format Options
-
--response-format-filter | --rff (array)
- Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
-
--response-format-type | --rft (string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.
list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.
object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header | --rfh (boolean)
- If "--response-format-type table" is specified, include the column headers in the output.
Examples
Given a z/OS job JOBID, list the spool files (DDs) for a z/OS job on the JES/spool queues. The command does not pre-validate the JOBID.
Usage
zowe zos-ftp list spool-files-by-jobid <jobId> [options]
Positional Arguments
-
jobId (string)
- The z/OS JOBID of the job with the spool files you want to list. No pre-validation of the JOBID is performed.
FTP Connection options
TLS / Secure Connection options
Profile Options
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Response Format Options
-
--response-format-filter | --rff (array)
- Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
-
--response-format-type | --rft (string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.
list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.
object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header | --rfh (boolean)
- If "--response-format-type table" is specified, include the column headers in the output.
Examples
List USS files and subdirectories in a directory. Optional file name pattern like "prefix*", "*suffix", or "prefix*suffix" can be specified at the end of directory. See EXAMPLES section.
The following values can be used with the --response-format-filter (--rff) argument to display more data from the data sets: name, size, owner, group, and permissions.
Usage
zowe zos-ftp list uss-files <directory> [options]
Positional Arguments
-
directory (string)
- The USS directory to list files in, or the directory with file name pattern
FTP Connection options
TLS / Secure Connection options
Profile Options
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Response Format Options
-
--response-format-filter | --rff (array)
- Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
-
--response-format-type | --rft (string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.
list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.
object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header | --rfh (boolean)
- If "--response-format-type table" is specified, include the column headers in the output.
Examples
-
List USS files in the directory "/u/users/ibmuser/":
zowe zos-ftp list uss-files "/u/users/ibmuser"
-
List USS files with suffix of ".txt" in the directory "/u/users/ibmuser/":
zowe zos-ftp list uss-files "/u/users/ibmuser/*.txt"
-
List USS files in the directory "/u/users/ibmuser/" and show only the file name:
zowe zos-ftp list uss-files "/u/users/ibmuser/" --rff name
Make a USS directory
Make a Unix System Services Directory
Usage
zowe zos-ftp make uss-directory <ussDirectory> [options]
Positional Arguments
-
ussDirectory (string)
- The USS directory you'd like to make.
FTP Connection options
TLS / Secure Connection options
Profile Options
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
Rename data sets and USS files or directories
Rename a cataloged data set
Usage
zowe zos-ftp rename data-set <oldDataSet> <newDataSet> [options]
Positional Arguments
-
oldDataSet (string)
- The current name of the data set you want to rename.
-
newDataSet (string)
- The new name for the data set.
FTP Connection options
TLS / Secure Connection options
Profile Options
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Rename the data set ibmuser.jcl to ibmuser.cntl:
zowe zos-ftp rename data-set ibmuser.jcl ibmuser.cntl
-
Rename the data set member "ibmuser.cntl(alloc)" to "ibmuser.cntl(alloc2)". Note: you can only rename members within the same partitioned data set. You cannot move a member to another data set with this command.:
zowe zos-ftp rename data-set "ibmuser.cntl(alloc)" "ibmuser.cntl(alloc2)"
Rename a USS file or directory
Usage
zowe zos-ftp rename uss-file <olduss> <newuss> [options]
Positional Arguments
-
olduss (string)
- The current name of the USS file you want to rename.
-
newuss (string)
- The new name for the USS file.
FTP Connection options
TLS / Secure Connection options
Profile Options
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
Submit jobs from local files and data sets
Submit a job from a cataloged data set containing JCL. The JCL will be downloaded via FTP and then submitted.
Usage
zowe zos-ftp submit data-set <dataSet> [options]
Positional Arguments
-
dataSet (string)
- The data set containing JCL that you would like to submit
Options
FTP Connection options
TLS / Secure Connection options
Profile Options
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Response Format Options
-
--response-format-filter | --rff (array)
- Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
-
--response-format-type | --rft (string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.
list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.
object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header | --rfh (boolean)
- If "--response-format-type table" is specified, include the column headers in the output.
Examples
-
Submit a job residing in the data set "ibmuser.cntl(iefbr14)":
zowe zos-ftp submit data-set "ibmuser.cntl(iefbr14)"
-
Submit a job from the data set "ibmuser.cntl(iefbr14)" and print only the job ID:
zowe zos-ftp submit data-set "ibmuser.cntl(iefbr14)" --rff jobid --rft string
-
Submit a job from the data set "ibmuser.cntl(iefbr14)" and wait for job complete.:
zowe zos-ftp submit data-set "ibmuser.cntl(iefbr14)" --wait 5,12
Submit a job from a local file containing JCL
Usage
zowe zos-ftp submit local-file <file> [options]
Positional Arguments
-
file (local file path)
- The file you would like to submit as jcl
Options
FTP Connection options
TLS / Secure Connection options
Profile Options
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Response Format Options
-
--response-format-filter | --rff (array)
- Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
-
--response-format-type | --rft (string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.
list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.
object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header | --rfh (boolean)
- If "--response-format-type table" is specified, include the column headers in the output.
Examples
-
Submit a job from the local file "my_build_jcl.txt":
zowe zos-ftp submit local-file "my_build_jcl.txt"
-
Submit a job from the local file "my_build_jcl.txt" and print only the job ID:
zowe zos-ftp submit local-file "my_build_jcl.txt" --rff jobid --rft string
-
Submit a job from the local file "my_build_jcl.txt" and wait for job complete.:
zowe zos-ftp submit local-file "my_build_jcl.txt" --wait 5,12
Submit a job from JCL written to the standard input (stdin) of this process.
Usage
zowe zos-ftp submit stdin [options]
Options
FTP Connection options
TLS / Secure Connection options
Profile Options
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Response Format Options
-
--response-format-filter | --rff (array)
- Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
-
--response-format-type | --rft (string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.
list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.
object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header | --rfh (boolean)
- If "--response-format-type table" is specified, include the column headers in the output.
Examples
-
Submit a job from stdin, redirecting the contents of my_jcl.txt in.:
zowe zos-ftp submit stdin < my_jcl.txt
-
Submit a job from the local file "my_build_jcl.txt" and wait for job complete.:
zowe zos-ftp submit stdin "my_build_jcl.txt" --wait 5,12
Upload data set and USS content
Upload contents of a local file to a z/OS data set
Usage
zowe zos-ftp upload file-to-data-set <file> <dataSet> [options]
Positional Arguments
-
file (local file path)
- Upload the contents of this file to the data set
-
dataSet (string)
- The data set (PDS member or physical sequential data set) to which you would like to upload content.
Options
FTP Connection options
TLS / Secure Connection options
Profile Options
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
Upload contents of a local to a Unix System Services file.
Usage
zowe zos-ftp upload file-to-uss-file <file> <ussFile> [options]
Positional Arguments
-
file (local file path)
- Upload the contents of this local file to a data set.
-
ussFile (string)
- The USS file to which you would like to upload content.
Options
-
--binary | -b (boolean)
- Upload content in binary mode.
FTP Connection options
TLS / Secure Connection options
Profile Options
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
Upload contents piped to stdin to a z/OS data set
Usage
zowe zos-ftp upload stdin-to-data-set <dataSet> [options]
Positional Arguments
-
dataSet (string)
- The data set (PDS member or physical sequential data set) to which you would like to upload content.
Options
FTP Connection options
TLS / Secure Connection options
Profile Options
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
Upload from stdin to a Unix System Services File
Usage
zowe zos-ftp upload stdin-to-uss-file <ussFile> [options]
Positional Arguments
-
ussFile (string)
- The USS file to which you would like to upload content.
Options
-
--binary | -b (boolean)
- Upload content in binary mode.
FTP Connection options
TLS / Secure Connection options
Profile Options
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
View data sets, job output, and USS content
View all spool content for a job by providing the job id
Usage
zowe zos-ftp view all-spool-by-jobid <jobid> [options]
Positional Arguments
-
jobid (string)
- The ID of the job for which you would like to list spool files
FTP Connection options
TLS / Secure Connection options
Profile Options
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
View the contents of a z/OS data set
Usage
zowe zos-ftp view data-set <dataSet> [options]
Positional Arguments
-
dataSet (string)
- The data set (PDS member or physical sequential data set) which you would like to view the contents of.
Options
FTP Connection options
TLS / Secure Connection options
Profile Options
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
View status details of a single z/OS job on spool/JES queues. The command does not prevalidate the JOBID.
Usage
zowe zos-ftp view job-status-by-jobid <jobId> [options]
Positional Arguments
-
jobId (string)
- The ID of the jobfor which you would like to list spool files
FTP Connection options
TLS / Secure Connection options
Profile Options
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Response Format Options
-
--response-format-filter | --rff (array)
- Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
-
--response-format-type | --rft (string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.
list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.
object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header | --rfh (boolean)
- If "--response-format-type table" is specified, include the column headers in the output.
Examples
View the contents of a spool file from a z/OS job on spool/JES queues. The command does not pre-validate the JOBID or spool ID.
Usage
zowe zos-ftp view spool-file-by-id <jobid> <spoolfileid> [options]
Positional Arguments
-
jobid (string)
- The z/OS JOBID of the job containing the spool file you want to view. No pre-validation of the JOBID is performed.
-
spoolfileid (number)
- The spool file ID number for the spool file to view. No pre-validation of the ID is performed.
FTP Connection options
TLS / Secure Connection options
Profile Options
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
View the contents of a Unix System Services File
Usage
zowe zos-ftp view uss-file <ussFile> [options]
Positional Arguments
-
ussFile (string)
- The USS file you'd like to view the contents of.
Options
-
--binary | -b (boolean)
- View content in binary form without converting to ASCII text
FTP Connection options
TLS / Secure Connection options
Profile Options
Base Connection Options
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
Manage z/OS jobs.
Cancel a single job by job ID. This cancels the job if it is running or on input.
Cancel a single job by job ID.
Usage
zowe zos-jobs cancel job <jobid> [options]
Positional Arguments
-
jobid (string)
- The job ID (e.g. JOB00123) of the job. Job ID is a unique identifier for z/OS batch jobs -- no two jobs on one system can have the same ID. Note: z/OS allows you to abbreviate the job ID if desired. You can use, for example "J123".
Options
Zosmf Connection Options
-
--host | -H (string)
- The z/OSMF server host name.
-
--port | -P (number)
-
The z/OSMF server port.
Default value: 443
-
--user | -u (string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized | --ru (boolean)
-
--base-path | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol (string)
-
--cert-file (local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Examples
Delete a single job by job ID or delete multiple jobs in OUTPUT status.
Delete a single job by job ID.
Usage
zowe zos-jobs delete job <jobid> [options]
Positional Arguments
-
jobid (string)
- The job ID (e.g. JOB00123) of the job. Job ID is a unique identifier for z/OS batch jobs -- no two jobs on one system can have the same ID. Note: z/OS allows you to abbreviate the job ID if desired. You can use, for example "J123".
Options
Zosmf Connection Options
-
--host | -H (string)
- The z/OSMF server host name.
-
--port | -P (number)
-
The z/OSMF server port.
Default value: 443
-
--user | -u (string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized | --ru (boolean)
-
--base-path | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol (string)
-
--cert-file (local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Examples
Delete (purge) jobs in OUTPUT status. Defaults to deleting all jobs owned by your user ID that are in output status.
Usage
zowe zos-jobs delete old-jobs [options]
Options
Zosmf Connection Options
-
--host | -H (string)
- The z/OSMF server host name.
-
--port | -P (number)
-
The z/OSMF server port.
Default value: 443
-
--user | -u (string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized | --ru (boolean)
-
--base-path | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol (string)
-
--cert-file (local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Examples
Download the output of a job as separate files.
Download all job output to a local directory. Each spool DD will be downloaded to its own file in the directory.
Usage
zowe zos-jobs download output <jobid> [options]
Positional Arguments
-
jobid (string)
- The z/OS JOBID of the job containing the spool files you want to view. No pre-validation of the JOBID is performed.
Options
-
--directory | -d | --dir (string)
- The local directory you would like to download the output for the job to.
-
--extension | -e (string)
- A file extension to save the job output with. Defaults to '.txt'.
-
--omit-jobid-directory | --ojd (boolean)
- If specified, job output will be saved directly to the specified directory rather than creating a subdirectory named after the ID of the job.
-
--binary | -b (boolean)
- If specified, job output will be downloaded in binary format instead of performing text conversion. Conflicts with record.
-
--record | -r (boolean)
- If specified, job output will be downloaded in record format instead of performing text conversion. Conflicts with binary.
-
--encoding | --ec (string)
- Download the spool file content with encoding mode, which means that data conversion is performed using the file encoding specified.
-
--wait-for-active | --wfa (boolean)
- Wait for the job to enter ACTIVE status before completing the command.
-
--wait-for-output | --wfo (boolean)
- Wait for the job to enter OUTPUT status before completing the command.
-
--record-range | --rr (string)
- Zero indexed range of records to download from a spool file. (example: 0-100)
Zosmf Connection Options
-
--host | -H (string)
- The z/OSMF server host name.
-
--port | -P (number)
-
The z/OSMF server port.
Default value: 443
-
--user | -u (string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized | --ru (boolean)
-
--base-path | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol (string)
-
--cert-file (local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Examples
List z/OS jobs and list the spool files (DDs) for a z/OS job on the JES/spool queues.
List jobs on JES spool/queues. By default, the command lists jobs owned (owner) by the user specified in your z/OSMF profile. The default for prefix is "*". The command does not prevalidate your user ID. The command surfaces errors verbatim from the z/OSMF Jobs REST endpoints.
Usage
zowe zos-jobs list jobs [options]
Options
Zosmf Connection Options
-
--host | -H (string)
- The z/OSMF server host name.
-
--port | -P (number)
-
The z/OSMF server port.
Default value: 443
-
--user | -u (string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized | --ru (boolean)
-
--base-path | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol (string)
-
--cert-file (local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Response Format Options
-
--response-format-filter | --rff (array)
- Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
-
--response-format-type | --rft (string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.
list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.
object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header | --rfh (boolean)
- If "--response-format-type table" is specified, include the column headers in the output.
Examples
-
List all jobs with default settings. The command returns jobs owned by your user ID with any job name:
zowe zos-jobs list jobs
-
List all jobs owned by user IDs starting with 'ibmu' and job names starting with 'myjo':
zowe zos-jobs list jobs -o "ibmu*" -p "myjo*"
-
List all jobs with default owner and prefix settings, displaying only the job ID of each job:
zowe zos-jobs list jobs --rff jobid --rft table
-
List all jobs and return job execution data along with the default information:
zowe zos-jobs list jobs --exec-data
-
List all jobs owned by user IDs starting with 'ibmu' and return job execution data along with the default information:
zowe zos-jobs list jobs -o "ibmu*" --exec-data
-
List all jobs owned by user IDs starting with 'ibmu' and job names starting with 'myjo' and return job execution data along with the default information:
zowe zos-jobs list jobs -o "ibmu*" -p "myjo*" --exec-data
Given a z/OS job JOBID, list the spool files (DDs) for a z/OS job on the JES/spool queues. The command does not pre-validate the JOBID. The command presents errors verbatim from the z/OSMF Jobs REST endpoints.
Usage
zowe zos-jobs list spool-files-by-jobid <jobid> [options]
Positional Arguments
-
jobid (string)
- The z/OS JOBID of the job with the spool files you want to list. No pre-validation of the JOBID is performed.
Zosmf Connection Options
-
--host | -H (string)
- The z/OSMF server host name.
-
--port | -P (number)
-
The z/OSMF server port.
Default value: 443
-
--user | -u (string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized | --ru (boolean)
-
--base-path | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol (string)
-
--cert-file (local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Response Format Options
-
--response-format-filter | --rff (array)
- Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
-
--response-format-type | --rft (string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.
list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.
object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header | --rfh (boolean)
- If "--response-format-type table" is specified, include the column headers in the output.
Examples
Modify the job class or the hold status of a job.
Modify the job class or the hold status of a job.
Usage
zowe zos-jobs modify job <jobid> [options]
Positional Arguments
-
jobid (string)
- The job ID (e.g. JOB00123) of the job. Job ID is a unique identifier for z/OS batch jobs -- no two jobs on one system can have the same ID. Note: z/OS allows you to abbreviate the job ID if desired. You can use, for example "J123".
Options
-
--jobclass (string)
- The job class (e.g. 'A', 'B', ...) assigned to the job.
-
--hold (boolean)
- Setting this flag will prevent a job from executing until entering a second command with the '--release' flag
-
--release (boolean)
- Flag that releases a held a job for execution
Zosmf Connection Options
-
--host | -H (string)
- The z/OSMF server host name.
-
--port | -P (number)
-
The z/OSMF server port.
Default value: 443
-
--user | -u (string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized | --ru (boolean)
-
--base-path | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol (string)
-
--cert-file (local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Examples
-
Modify class of job with job ID JOB0000:
zowe zos-jobs modify job JOB0000 --jobclass A
-
Hold job with job ID JOB0000:
zowe zos-jobs modify job JOB0000 --hold
-
Release job with job ID JOB0000:
zowe zos-jobs modify job JOB0000 --release
Search the spool output of a job.
Search the spool output of a job.
Usage
zowe zos-jobs search job <jobname> [options]
Positional Arguments
-
jobname (string)
- The job name to search. Wildcards are accepted for the job name. You can use, for example "USERJOB*" to search all jobs that start with USERJOB.
Options
-
--search-string | --string (string)
- The string to search for in the spool output.
-
--search-regex | --regex (string)
- The regular expression to search for in the spool output.
-
--case-insensitive | --ci (boolean)
-
--search-limit | --sl (number)
-
--file-limit | --fl (number)
Zosmf Connection Options
-
--host | -H (string)
- The z/OSMF server host name.
-
--port | -P (number)
-
The z/OSMF server port.
Default value: 443
-
--user | -u (string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized | --ru (boolean)
-
--base-path | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol (string)
-
--cert-file (local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Examples
-
Search all jobs named USERJOB for the string "RC=0000":
zowe zos-jobs search job "USERJOB" --search-string "RC=0000"
-
Search all jobs that start with USER for the string "ENDED":
zowe zos-jobs search job "USER*" --search-string "ENDED"
-
Search all jobs named USERJOB for the string "COND CODE", with the options case sensitive and a search limit of 5:
zowe zos-jobs search job "USERJOB" --search-string "COND CODE" --case-insensitive false --search-limit 5
Submit a job (JCL).
Submit a job (JCL) contained in a data set. The data set may be of type physical sequential or a PDS member. The command does not pre-validate the data set name. The command presents errors verbatim from the z/OSMF Jobs REST endpoints. For more information about z/OSMF Jobs API errors, see the z/OSMF Jobs API REST documentation.
Usage
zowe zos-jobs submit data-set <dataset> [options]
Positional Arguments
-
dataset (string)
- The z/OS data set containing the JCL to submit. You can specify a physical sequential data set (for example, "DATA.SET") or a partitioned data set qualified by a member (for example, "DATA.SET(MEMBER)").
Options
-
--volume | --vol (string)
- The volume serial (VOLSER) where the data set resides. The option is required only when the data set is not catalogued on the system.
-
--wait-for-active | --wfa (boolean)
- Wait for the job to enter ACTIVE status before completing the command.
-
--wait-for-output | --wfo (boolean)
- Wait for the job to enter OUTPUT status before completing the command.
-
--view-all-spool-content | --vasc (boolean)
- Print all spool output. If you use this option you will wait for the job to complete.
-
--directory | -d (string)
- The local directory you would like to download the output of the job. Creates a subdirectory using the jobID as the name and files are titled based on DD names. If you use this option you will wait for the job to complete.
-
--extension | -e (string)
- A file extension to save the job output with. Default is '.txt'.
-
--jcl-symbols | --js (string)
- A string of JCL symbols to use for substitution. For symbol values with no spaces: "symbol1=value1 symbol2=value2 ...". When a value contains spaces, enclose the value in single quotes: "symbol1='value 1 with spaces' symbol2='value 2 with spaces' ...". To embed a single quote in a value, use two single quotes: "NAME=O''Brian".
Zosmf Connection Options
-
--host | -H (string)
- The z/OSMF server host name.
-
--port | -P (number)
-
The z/OSMF server port.
Default value: 443
-
--user | -u (string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized | --ru (boolean)
-
--base-path | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol (string)
-
--cert-file (local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Response Format Options
-
--response-format-filter | --rff (array)
- Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
-
--response-format-type | --rft (string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.
list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.
object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header | --rfh (boolean)
- If "--response-format-type table" is specified, include the column headers in the output.
Examples
-
Submit the JCL in the data set "ibmuser.cntl(deploy)":
zowe zos-jobs submit data-set "ibmuser.cntl(deploy)"
-
Submit the JCL in the data set "ibmuser.cntl(deploy)", wait for the job to complete and print all output from the job:
zowe zos-jobs submit data-set "ibmuser.cntl(deploy)" --vasc
Submit a job (JCL) contained in a local file. The command presents errors verbatim from the z/OSMF Jobs REST endpoints. For more information about z/OSMF Jobs API errors, see the z/OSMF Jobs API REST documentation.
Usage
zowe zos-jobs submit local-file <localFile> [options]
Positional Arguments
-
localFile (string)
- The local file containing the JCL to submit.
Options
-
--wait-for-active | --wfa (boolean)
- Wait for the job to enter ACTIVE status before completing the command.
-
--wait-for-output | --wfo (boolean)
- Wait for the job to enter OUTPUT status before completing the command.
-
--view-all-spool-content | --vasc (boolean)
- Print all spool output. If you use this option you will wait for the job to complete.
-
--directory | -d (string)
- The local directory you would like to download the output of the job. Creates a subdirectory using the jobID as the name and files are titled based on DD names. If you use this option you will wait for the job to complete.
-
--extension | -e (string)
- A file extension to save the job output with. Default is '.txt'.
-
--jcl-symbols | --js (string)
- A string of JCL symbols to use for substitution. For symbol values with no spaces: "symbol1=value1 symbol2=value2 ...". When a value contains spaces, enclose the value in single quotes: "symbol1='value 1 with spaces' symbol2='value 2 with spaces' ...". To embed a single quote in a value, use two single quotes: "NAME=O''Brian".
-
--job-encoding | --je (string)
- The encoding that should be used to read the JCL into the z/OSMF JCL reader. JCL will be converted into this codepage from UTF-8 for the JES subsystem to parse.
-
--job-record-length | --jrl (number)
-
--job-record-format | --jrf (string)
-
The record format of the JCL being submitted, where V is variable, and F is fixed.
Default value: F
Allowed values: F, V
Zosmf Connection Options
-
--host | -H (string)
- The z/OSMF server host name.
-
--port | -P (number)
-
The z/OSMF server port.
Default value: 443
-
--user | -u (string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized | --ru (boolean)
-
--base-path | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol (string)
-
--cert-file (local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Response Format Options
-
--response-format-filter | --rff (array)
- Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
-
--response-format-type | --rft (string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.
list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.
object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header | --rfh (boolean)
- If "--response-format-type table" is specified, include the column headers in the output.
Examples
Submit a job (JCL) passed to the command via the stdin stream. The command presents errors verbatim from the z/OSMF Jobs REST endpoints. For more information about z/OSMF Jobs API errors, see the z/OSMF Jobs API REST documentation.
Usage
zowe zos-jobs submit stdin [options]
Options
-
--wait-for-active | --wfa (boolean)
- Wait for the job to enter ACTIVE status before completing the command.
-
--wait-for-output | --wfo (boolean)
- Wait for the job to enter OUTPUT status before completing the command.
-
--view-all-spool-content | --vasc (boolean)
- Print all spool output. If you use this option you will wait for the job to complete.
-
--directory | -d (string)
- The local directory you would like to download the output of the job. Creates a subdirectory using the jobID as the name and files are titled based on DD names. If you use this option you will wait for the job to complete.
-
--extension | -e (string)
- A file extension to save the job output with. Default is '.txt'.
-
--jcl-symbols | --js (string)
- A string of JCL symbols to use for substitution. For symbol values with no spaces: "symbol1=value1 symbol2=value2 ...". When a value contains spaces, enclose the value in single quotes: "symbol1='value 1 with spaces' symbol2='value 2 with spaces' ...". To embed a single quote in a value, use two single quotes: "NAME=O''Brian".
-
--job-encoding | --je (string)
- The encoding that should be used to read the JCL into the z/OSMF JCL reader. JCL will be converted into this codepage from UTF-8 for the JES subsystem to parse.
-
--job-record-length | --jrl (number)
-
--job-record-format | --jrf (string)
-
The record format of the JCL being submitted, where V is variable, and F is fixed.
Default value: F
Allowed values: F, V
Zosmf Connection Options
-
--host | -H (string)
- The z/OSMF server host name.
-
--port | -P (number)
-
The z/OSMF server port.
Default value: 443
-
--user | -u (string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized | --ru (boolean)
-
--base-path | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol (string)
-
--cert-file (local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Response Format Options
-
--response-format-filter | --rff (array)
- Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
-
--response-format-type | --rft (string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.
list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.
object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header | --rfh (boolean)
- If "--response-format-type table" is specified, include the column headers in the output.
Examples
Submit a job (JCL) contained in a USS file. The command does not pre-validate the USS file path. The command presents errors verbatim from the z/OSMF Jobs REST endpoints. For more information about z/OSMF Jobs API errors, see the z/OSMF Jobs API REST documentation.
Usage
zowe zos-jobs submit uss-file <file> [options]
Positional Arguments
-
file (string)
- Path to the USS file that contains the JCL to submit.
Options
-
--wait-for-active | --wfa (boolean)
- Wait for the job to enter ACTIVE status before completing the command.
-
--wait-for-output | --wfo (boolean)
- Wait for the job to enter OUTPUT status before completing the command.
-
--view-all-spool-content | --vasc (boolean)
- Print all spool output. If you use this option you will wait for the job to complete.
-
--directory | -d (string)
- The local directory you would like to download the output of the job. Creates a subdirectory using the jobID as the name and files are titled based on DD names. If you use this option you will wait for the job to complete.
-
--extension | -e (string)
- A file extension to save the job output with. Default is '.txt'.
-
--jcl-symbols | --js (string)
- A string of JCL symbols to use for substitution. For symbol values with no spaces: "symbol1=value1 symbol2=value2 ...". When a value contains spaces, enclose the value in single quotes: "symbol1='value 1 with spaces' symbol2='value 2 with spaces' ...". To embed a single quote in a value, use two single quotes: "NAME=O''Brian".
Zosmf Connection Options
-
--host | -H (string)
- The z/OSMF server host name.
-
--port | -P (number)
-
The z/OSMF server port.
Default value: 443
-
--user | -u (string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized | --ru (boolean)
-
--base-path | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol (string)
-
--cert-file (local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Response Format Options
-
--response-format-filter | --rff (array)
- Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
-
--response-format-type | --rft (string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.
list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.
object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header | --rfh (boolean)
- If "--response-format-type table" is specified, include the column headers in the output.
Examples
-
Submit the JCL in the USS file "/a/ibmuser/compile.jcl":
zowe zos-jobs submit uss-file "/a/ibmuser/compile.jcl"
-
Submit the JCL in the USS file "/a/ibmuser/compile.jcl", wait for the job to complete and print all output from the job:
zowe zos-jobs submit uss-file "/a/ibmuser/compile.jcl" --vasc
View details of z/OS jobs on spool/JES queues.
View the contents of each spool file from a z/OS job on spool/JES queues. The command does not pre-validate the JOBID. The command presents errors verbatim from the z/OSMF Jobs REST endpoints.
Usage
zowe zos-jobs view all-spool-content <jobid> [options]
Positional Arguments
-
jobid (string)
- The z/OS JOBID of the job containing the spool files you want to view. No pre-validation of the JOBID is performed.
Options
Zosmf Connection Options
-
--host | -H (string)
- The z/OSMF server host name.
-
--port | -P (number)
-
The z/OSMF server port.
Default value: 443
-
--user | -u (string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized | --ru (boolean)
-
--base-path | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol (string)
-
--cert-file (local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Examples
View status details of a single z/OS job on spool/JES queues. The command does not prevalidate the JOBID. The command presents errors verbatim from the z/OSMF Jobs REST endpoints (expect for "no jobs found").
Usage
zowe zos-jobs view job-status-by-jobid <jobid> [options]
Positional Arguments
-
jobid (string)
- The z/OS JOBID of the job you want to view. No prevalidation of the JOBID is performed.
Zosmf Connection Options
-
--host | -H (string)
- The z/OSMF server host name.
-
--port | -P (number)
-
The z/OSMF server port.
Default value: 443
-
--user | -u (string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized | --ru (boolean)
-
--base-path | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol (string)
-
--cert-file (local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Response Format Options
-
--response-format-filter | --rff (array)
- Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
-
--response-format-type | --rft (string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.
list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.
object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header | --rfh (boolean)
- If "--response-format-type table" is specified, include the column headers in the output.
Examples
-
View status and other details of the job with the job ID JOB00123:
zowe zos-jobs view job-status-by-jobid j123
-
Print only the status (for example, "OUTPUT" or "ACTIVE") of the job with the job ID JOB00123:
zowe zos-jobs view job-status-by-jobid j123 --rff status --rft string
View the contents of a spool file from a z/OS job on spool/JES queues. The command does not pre-validate the JOBID or spool ID. The command presents errors verbatim from the z/OSMF Jobs REST endpoints.
Usage
zowe zos-jobs view spool-file-by-id <jobid> <spoolfileid> [options]
Positional Arguments
-
jobid (string)
- The z/OS JOBID of the job containing the spool file you want to view. No pre-validation of the JOBID is performed.
-
spoolfileid (number)
- The spool file ID number for the spool file to view. Use the "zowe zos-jobs list spool-files-by-jobid" command to obtain spool ID numbers.No pre-validation of the ID is performed.
Options
Zosmf Connection Options
-
--host | -H (string)
- The z/OSMF server host name.
-
--port | -P (number)
-
The z/OSMF server port.
Default value: 443
-
--user | -u (string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized | --ru (boolean)
-
--base-path | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol (string)
-
--cert-file (local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Examples
Interact with z/OS logs.
List z/OS logs by invoking z/OSMF REST API.
List z/OS operlog within a time range.
Use this operation to get the z/OS operations logs. It invokes z/OSMF REST API to retrieve logs.
Executing 'zowe zos-logs list logs' will by default return logs from current time and backwards to 10 minutes before.
Note: OPERLOG needs to be configured on z/OS server.
Usage
zowe zos-logs list logs [options]
Options
Zosmf Connection Options
-
--host | -H (string)
- The z/OSMF server host name.
-
--port | -P (number)
-
The z/OSMF server port.
Default value: 443
-
--user | -u (string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized | --ru (boolean)
-
--base-path | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol (string)
-
--cert-file (local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Examples
-
List logs starting from '2021-07-26T03:38:37.098Z' and forwards to 5 minutes later:
zowe zos-logs list logs --start-time 2021-07-26T03:38:37.098Z --range 5m --direction forward
-
List logs starting from '2021-07-26T03:38:37.098Z' and forwards to 5 minutes later. Alias version of the above command:
zowe zos-logs list logs --st 2021-07-26T03:38:37.098Z -r 5m -d forward
-
List logs starting from '2021-07-26T03:38:37.098Z' and backwards to 5 minutes before:
zowe zos-logs list logs --start-time 2021-07-26T03:38:37.098Z --range 5m
Issue z/OS USS commands remotely using an SSH session. Output from the commands is displayed on the local terminal.
Issue a z/OS USS command.
Issue a z/OS USS command
Note: The common CLI 'Base Connection Options' of token-type and token-value are not applicable to the ssh command, since the ssh service is not accessible through APIML.
Usage
zowe zos-ssh issue command <command> [options]
Positional Arguments
-
command (string)
- z/OS USS command to issue.
Options
-
--cwd (string)
- Working directory in which to execute the command.
z/OS Ssh Connection Options
-
--host | -H (string)
- The z/OS SSH server host name.
-
--port | -P (number)
-
--user | -u (string)
- Mainframe user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe password, which can be the same as your TSO password.
-
--privateKey | --key | --pk (string)
- Path to a file containing your private key, that must match a public key stored in the server for authentication
-
--keyPassphrase | --passphrase | --kp (string)
- Private key passphrase, which unlocks the private key.
-
--handshakeTimeout | --timeout | --to (number)
- How long in milliseconds to wait for the SSH handshake to complete.
Profile Options
Base Connection Options
-
--reject-unauthorized | --ru (boolean)
-
--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API.
-
--cert-file (local file 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 (local file path)
- The file path to a certificate key file to use for authentication
Examples
Issue TSO commands and interact with TSO address spaces.
Issue TSO commands.
Creates a TSO address space, issues a TSO command through the newly created address space, waits for the READY prompt to print the response, and terminates the TSO address space. All response data are returned to the user up to (but not including) the TSO 'READY' prompt.
Usage
zowe zos-tso issue command <commandText> [options]
Positional Arguments
-
commandText (string)
- The TSO command to issue.
Options
TSO ADDRESS SPACE OPTIONS
-
--account | -a (string)
- Your z/OS TSO/E accounting information.
-
--character-set | --cs (string)
-
--code-page | --cp (string)
-
--columns | --cols (number)
-
--logon-procedure | -l (string)
-
--region-size | --rs (number)
-
--rows (number)
Zosmf Connection Options
-
--host | -H (string)
- The z/OSMF server host name.
-
--port | -P (number)
-
The z/OSMF server port.
Default value: 443
-
--user | -u (string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized | --ru (boolean)
-
--base-path | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol (string)
-
--cert-file (local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Profile Options
-
--zosmf-profile | --zosmf-p (string)
- The name of a (zosmf) profile to load for this command execution.
-
--tso-profile | --tso-p (string)
- The name of a (tso) profile to load for this command execution.
-
--base-profile | --base-p (string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
Examples
Ping a TSO address space, from which you previously started and received a token (a.k.a 'servelet-key').
Ping a TSO address space, from which you previously started and received a token (a.k.a 'servlet-key').
Usage
zowe zos-tso ping address-space <servletKey> [options]
Positional Arguments
-
servletKey (string)
- The servlet key from a previously started TSO address space.
Zosmf Connection Options
-
--host | -H (string)
- The z/OSMF server host name.
-
--port | -P (number)
-
The z/OSMF server port.
Default value: 443
-
--user | -u (string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized | --ru (boolean)
-
--base-path | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol (string)
-
--cert-file (local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Examples
Receive message from TSO address space app
Receive message from TSO address space app,
Usage
zowe zos-tso receive app [options]
TSO ADDRESS SPACE OPTIONS
-
--account | -a (string)
- Your z/OS TSO/E accounting information.
-
--character-set | --cs (string)
-
--code-page | --cp (string)
-
--columns | --cols (number)
-
--logon-procedure | -l (string)
-
--region-size | --rs (number)
-
--rows (number)
Required Options
Options
Zosmf Connection Options
-
--host | -H (string)
- The z/OSMF server host name.
-
--port | -P (number)
-
The z/OSMF server port.
Default value: 443
-
--user | -u (string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized | --ru (boolean)
-
--base-path | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol (string)
-
--cert-file (local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Profile Options
-
--zosmf-profile | --zosmf-p (string)
- The name of a (zosmf) profile to load for this command execution.
-
--tso-profile | --tso-p (string)
- The name of a (tso) profile to load for this command execution.
-
--base-profile | --base-p (string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
Send data to TSO and collect responses until the prompt is reached.
Send data to the TSO address space, from which you previously started and received a token (a.k.a 'servlet-key').
Usage
zowe zos-tso send address-space <servletKey> [options]
Positional Arguments
-
servletKey (string)
- The servlet key from a previously started TSO address space.
Required Options
-
--data (string)
- The data to which we want to send to the TSO address space represented by the servlet key.
Zosmf Connection Options
-
--host | -H (string)
- The z/OSMF server host name.
-
--port | -P (number)
-
The z/OSMF server port.
Default value: 443
-
--user | -u (string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized | --ru (boolean)
-
--base-path | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol (string)
-
--cert-file (local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Examples
Send message to an application at a TSO address space,
Usage
zowe zos-tso send app [options]
TSO ADDRESS SPACE OPTIONS
-
--account | -a (string)
- Your z/OS TSO/E accounting information.
-
--character-set | --cs (string)
-
--code-page | --cp (string)
-
--columns | --cols (number)
-
--logon-procedure | -l (string)
-
--region-size | --rs (number)
-
--rows (number)
Required Options
Zosmf Connection Options
-
--host | -H (string)
- The z/OSMF server host name.
-
--port | -P (number)
-
The z/OSMF server port.
Default value: 443
-
--user | -u (string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized | --ru (boolean)
-
--base-path | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol (string)
-
--cert-file (local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Profile Options
-
--zosmf-profile | --zosmf-p (string)
- The name of a (zosmf) profile to load for this command execution.
-
--tso-profile | --tso-p (string)
- The name of a (tso) profile to load for this command execution.
-
--base-profile | --base-p (string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
Start TSO/E address space.
Start a TSO address space, from which you will receive a token (a.k.a 'servlet-key') for further address space interaction (e.g. termination).
Usage
zowe zos-tso start address-space [options]
TSO ADDRESS SPACE OPTIONS
-
--account | -a (string)
- Your z/OS TSO/E accounting information.
-
--character-set | --cs (string)
-
--code-page | --cp (string)
-
--columns | --cols (number)
-
--logon-procedure | -l (string)
-
--region-size | --rs (number)
-
--rows (number)
Options
Zosmf Connection Options
-
--host | -H (string)
- The z/OSMF server host name.
-
--port | -P (number)
-
The z/OSMF server port.
Default value: 443
-
--user | -u (string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized | --ru (boolean)
-
--base-path | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol (string)
-
--cert-file (local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Profile Options
-
--zosmf-profile | --zosmf-p (string)
- The name of a (zosmf) profile to load for this command execution.
-
--tso-profile | --tso-p (string)
- The name of a (tso) profile to load for this command execution.
-
--base-profile | --base-p (string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
Examples
-
Start TSO/E address space:
zowe zos-tso start address-space
-
Start TSO/E address space, and receive response in JSON format:
zowe zos-tso start address-space --rfj
-
Start TSO/E address space, and print only the servlet key:
zowe zos-tso start address-space --sko
Start application at TSO address space,
Usage
zowe zos-tso start app [options]
TSO ADDRESS SPACE OPTIONS
-
--account | -a (string)
- Your z/OS TSO/E accounting information.
-
--character-set | --cs (string)
-
--code-page | --cp (string)
-
--columns | --cols (number)
-
--logon-procedure | -l (string)
-
--region-size | --rs (number)
-
--rows (number)
Required Options
Options
Zosmf Connection Options
-
--host | -H (string)
- The z/OSMF server host name.
-
--port | -P (number)
-
The z/OSMF server port.
Default value: 443
-
--user | -u (string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized | --ru (boolean)
-
--base-path | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol (string)
-
--cert-file (local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Profile Options
-
--zosmf-profile | --zosmf-p (string)
- The name of a (zosmf) profile to load for this command execution.
-
--tso-profile | --tso-p (string)
- The name of a (tso) profile to load for this command execution.
-
--base-profile | --base-p (string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
Stop TSO/E address space.
Stop a TSO address space, from which you previously started and received a token (a.k.a 'servlet-key').
Usage
zowe zos-tso stop address-space <servletkey> [options]
Positional Arguments
-
servletkey (string)
- The servlet key from a previously started TSO address space.
Zosmf Connection Options
-
--host | -H (string)
- The z/OSMF server host name.
-
--port | -P (number)
-
The z/OSMF server port.
Default value: 443
-
--user | -u (string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized | --ru (boolean)
-
--base-path | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol (string)
-
--cert-file (local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Examples
Create and manage z/OSMF workflows on a z/OS system.
Archive workflow instance in z/OSMF.
Archive an active workflow instance in z/OSMF.
Usage
zowe zos-workflows archive active-workflow [options]
Options
Zosmf Connection Options
-
--host | -H (string)
- The z/OSMF server host name.
-
--port | -P (number)
-
The z/OSMF server port.
Default value: 443
-
--user | -u (string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized | --ru (boolean)
-
--base-path | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol (string)
-
--cert-file (local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Response Format Options
-
--response-format-filter | --rff (array)
- Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
-
--response-format-type | --rft (string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.
list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.
object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header | --rfh (boolean)
- If "--response-format-type table" is specified, include the column headers in the output.
Examples
-
Archive a workflow with workflow name "testworkflow":
zowe zos-workflows archive active-workflow --wn "testworkflow"
-
Archive multiple workflows with workflow names starting with "test":
zowe zos-workflows archive active-workflow --wn "test.*"
-
Archive a workflow with workflow key "123-456-abv-xyz":
zowe zos-workflows archive active-workflow --wk "123-456-abv-xyz"
Create a z/OSMF workflow on a z/OS system.
Create a z/OSMF workflow on a z/OS system using a data set.
Usage
zowe zos-workflows create workflow-from-data-set <workflowName> [options]
Positional Arguments
Required Options
Options
-
--variables-input-file | --vif (string)
- Specifies an optional properties file that you can use to pre-specify values for one or more of the variables that are defined in the workflow definition file.
-
--variables | --vs (string)
- Includes a list of variables for the workflow. The variables that you specify here take precedence over the variables that are specified in the workflow variable input file. Make sure the value meets all regular expression requirements set for the corresponding variable.
-
--assign-to-owner | --ato (boolean)
- Indicates whether the workflow steps are assigned to the workflow owner.
-
--access-type | --at (string)
-
Specifies the access type for the workflow. Public, Restricted or Private.
Allowed values: Public, Restricted, Private
-
--delete-completed | --dc (boolean)
- Whether the successfully completed jobs to be deleted from the JES spool.
-
--overwrite | --ov (boolean)
- Replaces an existing workflow with a new workflow.
Zosmf Connection Options
-
--host | -H (string)
- The z/OSMF server host name.
-
--port | -P (number)
-
The z/OSMF server port.
Default value: 443
-
--user | -u (string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized | --ru (boolean)
-
--base-path | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol (string)
-
--cert-file (local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Response Format Options
-
--response-format-filter | --rff (array)
- Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
-
--response-format-type | --rft (string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.
list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.
object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header | --rfh (boolean)
- If "--response-format-type table" is specified, include the column headers in the output.
Examples
-
Create a workflow with name "testworkflow" using the data set "TESTID.WKFLOW" that contains the workflow definition xml on the system "TESTM1" with owner "OTHERID" and delete workflow with the same name if it already exists in z/OSMF:
zowe zos-workflows create workflow-from-data-set "testworkflow" --data-set "TESTID.WKFLOW" --system-name "TESTM1" --owner "OTHERID" --overwrite
-
Create a workflow with name "testworkflow" using data set "TESTID.WKFLOW" containing workflow definition xml, on system "TESTM1" with owner "MYSYSID" and delete successfully completed jobs:
zowe zos-workflows create workflow-from-data-set "testworkflow" --data-set "TESTID.WKFLOW" --system-name "TESTM1" --owner "MYSYSID" --delete-completed
-
Create a workflow with name "testworkflow" using data set "TESTID.WKFLOW" containing workflow definition xml, on system "TESTM1" with owner "MYSYSID" and with variable values in the member PROPERTIES of data set TESTID.DATA:
zowe zos-workflows create workflow-from-data-set "testworkflow" --data-set "TESTID.WKFLOW" --system-name "TESTM1" --owner "MYSYSID" --variables-input-file TESTID.DATA(PROPERTIES)
-
Create a workflow with name "testworkflow" using the data set "TESTID.WKFLOW" that contains a workflow definition xml, on a system "TESTM1" with owner "MYSYSID" and with the variable name DUMMYVAR and the value DUMMYVAL. Assign it to the owner:
zowe zos-workflows create workflow-from-data-set "testworkflow" --data-set "TESTID.WKFLOW" --system-name "TESTM1" --owner "MYSYSID" --variables DUMMYVAR=DUMMYVAL --assign-to-owner
Create a z/OSMF workflow on a z/OS system using a local file.
Usage
zowe zos-workflows create workflow-from-local-file <workflowName> [options]
Positional Arguments
Required Options
Options
-
--variables-input-file | --vif (string)
- Specifies an optional properties file that you can use to pre-specify values for one or more of the variables that are defined in the workflow definition file.
-
--variables | --vs (string)
- Includes a list of variables for the workflow. The variables that you specify here take precedence over the variables that are specified in the workflow variable input file. Make sure the value meets all regular expression requirements set for the corresponding variable.
-
--assign-to-owner | --ato (boolean)
- Indicates whether the workflow steps are assigned to the workflow owner.
-
--access-type | --at (string)
-
Specifies the access type for the workflow. Public, Restricted or Private.
Allowed values: Public, Restricted, Private
-
--delete-completed | --dc (boolean)
- Whether the successfully completed jobs to be deleted from the JES spool.
-
--overwrite | --ov (boolean)
- Replaces an existing workflow with a new workflow.
-
--remote-directory | --rd (string)
- The remote USS directory where the files are to be uploaded. The directory has to exist.
-
--keep-files | --kf (boolean)
Zosmf Connection Options
-
--host | -H (string)
- The z/OSMF server host name.
-
--port | -P (number)
-
The z/OSMF server port.
Default value: 443
-
--user | -u (string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized | --ru (boolean)
-
--base-path | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol (string)
-
--cert-file (local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Response Format Options
-
--response-format-filter | --rff (array)
- Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
-
--response-format-type | --rft (string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.
list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.
object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header | --rfh (boolean)
- If "--response-format-type table" is specified, include the column headers in the output.
Examples
Create a workflow instance in z/OSMF using a USS file.
Usage
zowe zos-workflows create workflow-from-uss-file <workflowName> [options]
Positional Arguments
-
workflowName (string)
- Name of the workflow instance to create
Required Options
Options
-
--variables-input-file | --vif (string)
- Specifies an optional properties file that you can use to pre-specify values for one or more of the variables that are defined in the workflow definition file.
-
--variables | --vs (string)
- Includes a list of variables for the workflow. The variables that you specify here take precedence over the variables that are specified in the workflow variable input file. Make sure the value meets all regular expression requirements set for the corresponding variable.
-
--assign-to-owner | --ato (boolean)
- Indicates whether the workflow steps are assigned to the workflow owner.
-
--access-type | --at (string)
-
Specifies the access type for the workflow. Public, Restricted or Private.
Allowed values: Public, Restricted, Private
-
--delete-completed | --dc (boolean)
- Whether the successfully completed jobs to be deleted from the JES spool.
-
--overwrite | --ov (boolean)
- Replaces an existing workflow with a new workflow.
Zosmf Connection Options
-
--host | -H (string)
- The z/OSMF server host name.
-
--port | -P (number)
-
The z/OSMF server port.
Default value: 443
-
--user | -u (string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized | --ru (boolean)
-
--base-path | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol (string)
-
--cert-file (local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Response Format Options
-
--response-format-filter | --rff (array)
- Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
-
--response-format-type | --rft (string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.
list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.
object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header | --rfh (boolean)
- If "--response-format-type table" is specified, include the column headers in the output.
Examples
-
Create a workflow with name "testworkflow" using uss file "/path/workflow.xml" containing workflow definition, on system "TESTM1" with owner "OTHERID" and delete workflow with the same name if it already exists in z/OSMF:
zowe zos-workflows create workflow-from-uss-file "testworkflow" --uss-file "/path/workflow.xml" --system-name "TESTM1" --owner "OTHERID" --overwrite
-
Create a workflow with name "testworkflow" using uss file "/path/workflow.xml" containing workflow definition, on system "TESTM1" with owner "MYSYSID" and delete successfully completed jobs:
zowe zos-workflows create workflow-from-uss-file "testworkflow" --uss-file "/path/workflow.xml" --system-name "TESTM1" --owner "MYSYSID" --delete-completed
-
Create a workflow with name "testworkflow" using uss file "/path/workflow.xml" containing workflow definition, on system "TESTM1" with owner "MYSYSID" and with variable values in the member PROPERTIES of data set TESTID.DATA:
zowe zos-workflows create workflow-from-uss-file "testworkflow" --uss-file "/path/workflow.xml" --system-name "TESTM1" --owner "MYSYSID" --variables-input-file TESTID.DATA(PROPERTIES)
-
Create a workflow with name "testworkflow" using uss file "/path/workflow.xml" containing workflow definition, on system "TESTM1" with owner "MYSYSID" and with variables VAR1 and VAR2 with values DUMMYVAL1 and DUMMYVAL2, and assign it to the owner:
zowe zos-workflows create workflow-from-uss-file "testworkflow" --uss-file "/path/workflow.xml" --system-name "TESTM1"--variables VAR1=DUMMYVAL1,VAR2=DUMMYVAL2 --owner "MYSYSID" --assign-to-owner
Delete an active workflow or an archived workflow from z/OSMF.
Delete an active workflow instance in z/OSMF.
Usage
zowe zos-workflows delete active-workflow [options]
Options
Zosmf Connection Options
-
--host | -H (string)
- The z/OSMF server host name.
-
--port | -P (number)
-
The z/OSMF server port.
Default value: 443
-
--user | -u (string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized | --ru (boolean)
-
--base-path | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol (string)
-
--cert-file (local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Examples
-
To delete a workflow instance in z/OSMF with workflow key "d043b5f1-adab-48e7-b7c3-d41cd95fa4b0":
zowe zos-workflows delete active-workflow --workflow-key "d043b5f1-adab-48e7-b7c3-d41cd95fa4b0"
-
To delete a workflow instance in z/OSMF with workflow name "testWorkflow":
zowe zos-workflows delete active-workflow --workflow-name "testWorkflow"
-
To delete multiple workflow instances in z/OSMF with names starting with "test":
zowe zos-workflows delete active-workflow --workflow-name "test.*"
Delete an archived workflow from z/OSMF.
Usage
zowe zos-workflows delete archived-workflow [options]
Options
Zosmf Connection Options
-
--host | -H (string)
- The z/OSMF server host name.
-
--port | -P (number)
-
The z/OSMF server port.
Default value: 443
-
--user | -u (string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized | --ru (boolean)
-
--base-path | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol (string)
-
--cert-file (local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Examples
-
To delete an archived workflow from z/OSMF with workflow key "d043b5f1-adab-48e7-b7c3-d41cd95fa4b0":
zowe zos-workflows delete archived-workflow --workflow-key "d043b5f1-adab-48e7-b7c3-d41cd95fa4b0"
-
To delete an archived workflow from z/OSMF with workflow name "testWorkflow":
zowe zos-workflows delete archived-workflow --workflow-name "testWorkflow"
-
To delete multiple archived workflows from z/OSMF with names beginnig with "test":
zowe zos-workflows delete archived-workflow --workflow-name "test.*"
List the z/OSMF workflows for a system or a sysplex with filter options.
Get the details of an active z/OSMF workflow.
Usage
zowe zos-workflows list active-workflow-details [options]
Options
-
--workflow-name | --wn (string)
- List active workflow details by specified workflow name.
-
--workflow-key | --wk (string)
- List active workflow details by specified workflow key.
-
--list-steps | --ls (boolean)
- Optional parameter for listing steps and their properties.
-
--steps-summary-only | --sso (boolean)
- Optional parameter that lists steps summary only.
-
--list-variables | --lv (boolean)
- Optional parameter for listing variables and their properties.
-
--skip-workflow-summary | --sws (boolean)
- Optional parameter that skips the default workflow summary.
Zosmf Connection Options
-
--host | -H (string)
- The z/OSMF server host name.
-
--port | -P (number)
-
The z/OSMF server port.
Default value: 443
-
--user | -u (string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized | --ru (boolean)
-
--base-path | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol (string)
-
--cert-file (local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Examples
-
To list the details of an active workflow with key "7c62c790-0340-86b2-61ce618d8f8c" including its steps and variables:
zowe zos-workflows list active-workflow-details --workflow-key "7c62c790-0340-86b2-61ce618d8f8c" --list-steps --list-variables
-
To list the details of an active workflow with name "testWorkflow" including its steps and variables:
zowe zos-workflows list active-workflow-details --workflow-name "testWorkflow" --list-steps --list-variables
List active workflow instance(s) in z/OSMF.
Multiple filters can be used together.
Omitting all options will list all workflows on the sysplex.
Usage
zowe zos-workflows list active-workflows [options]
Options
-
--workflow-name | --wn (string)
- Filter by workflow name. For wildcard use .*
-
--category | --cat (string)
- Filter by the category of the workflows, which is either general or configuration.
-
--system | --sys (string)
- Filter by the nickname of the system on which the workflows is/are active.
-
--owner | --ow (string)
- Filter by owner of the workflow(s) (a valid z/OS user ID).
-
--vendor | --vd (string)
- Filter by the name of the vendor that provided the workflow(s) definition file.
-
--status-name | --sn (string)
-
Filter by the status of the workflow(s).
Allowed values: in-progress, complete, automation-in-progress, canceled
Zosmf Connection Options
-
--host | -H (string)
- The z/OSMF server host name.
-
--port | -P (number)
-
The z/OSMF server port.
Default value: 443
-
--user | -u (string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized | --ru (boolean)
-
--base-path | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol (string)
-
--cert-file (local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Response Format Options
-
--response-format-filter | --rff (array)
- Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
-
--response-format-type | --rft (string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.
list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.
object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header | --rfh (boolean)
- If "--response-format-type table" is specified, include the column headers in the output.
Examples
-
List the workflow with name "testworkflow":
zowe zos-workflows list active-workflows --wn "testworkflow"
-
List multiple active workflows on the entire syspex with names containing"workflow":
zowe zos-workflows list active-workflows --wn ".*workflow.*"
-
List multiple active workflows on system "IBMSYS" with names beginnig with "testW" that are in status "complete":
zowe zos-workflows list active-workflows --wn "test.*" --sys "IBMSYS" --sn "complete"
List the archived z/OSMF workflows for a system or sysplex.
Usage
zowe zos-workflows list archived-workflows [options]
Zosmf Connection Options
-
--host | -H (string)
- The z/OSMF server host name.
-
--port | -P (number)
-
The z/OSMF server port.
Default value: 443
-
--user | -u (string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized | --ru (boolean)
-
--base-path | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol (string)
-
--cert-file (local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Response Format Options
-
--response-format-filter | --rff (array)
- Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
-
--response-format-type | --rft (string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.
list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.
object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header | --rfh (boolean)
- If "--response-format-type table" is specified, include the column headers in the output.
Retrieve the contents of a z/OSMF workflow definition from a z/OS system.
Usage
zowe zos-workflows list definition-file-details <definitionFilePath> [options]
Positional Arguments
Options
Zosmf Connection Options
-
--host | -H (string)
- The z/OSMF server host name.
-
--port | -P (number)
-
The z/OSMF server port.
Default value: 443
-
--user | -u (string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized | --ru (boolean)
-
--base-path | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol (string)
-
--cert-file (local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Examples
-
To list the contents of a workflow definition stored in the UNIX file "/user/dir/workflow.xml" including its steps and variables:
zowe zos-workflows list definition-file-details "/user/dir/workflow.xml" --list-steps --list-variables
-
To list the contents of a workflow definition stored in the z/OS data set "USER.DATA.SET.XML" including its steps and variables:
zowe zos-workflows list definition-file-details "USER.DATA.SET.XML" --list-steps --list-variables
Start a z/OSMF workflow on a z/OS system.
Will run workflow from the beginning to the end or to the first manual step.
Usage
zowe zos-workflows start workflow-full [options]
Options
-
--workflow-key | --wk (string)
- Workflow key of workflow instance to be started
-
--workflow-name | --wn (string)
- Workflow name of workflow instance to be started
-
--resolve-conflict-by | --rcb (string)
-
How variable conflicts should be handled.
Options:
outputFileValue: Allow the output file values to override the existing values.
existingValue: Use the existing variables values instead of the output file values.
leaveConflict: Automation is stopped. The user must resolve the conflict manually.
Default value: outputFileValue
Allowed values: outputFileValue, existingValue, leaveConflict
-
--wait | -w (boolean)
- Identifies whether to wait for workflow instance to finish.
Zosmf Connection Options
-
--host | -H (string)
- The z/OSMF server host name.
-
--port | -P (number)
-
The z/OSMF server port.
Default value: 443
-
--user | -u (string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized | --ru (boolean)
-
--base-path | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol (string)
-
--cert-file (local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Examples
-
To start a workflow instance in z/OSMF with workflow key "d043b5f1-adab-48e7-b7c3-d41cd95fa4b0":
zowe zos-workflows start workflow-full --workflow-key "d043b5f1-adab-48e7-b7c3-d41cd95fa4b0"
-
To start a workflow instance in z/OSMF with workflow key "d043b5f1-adab-48e7-b7c3-d41cd95fa4b0" and wait for it to be finished:
zowe zos-workflows start workflow-full --workflow-key "d043b5f1-adab-48e7-b7c3-d41cd95fa4b0" --wait
-
To start a workflow instance in z/OSMF with workflow key "d043b5f1-adab-48e7-b7c3-d41cd95fa4b0" and if there is a conflict in variable's value use the value that is in output file:
zowe zos-workflows start workflow-full --workflow-key "d043b5f1-adab-48e7-b7c3-d41cd95fa4b0" --resolve-conflict-by "outputFileValue"
-
To start a workflow instance in z/OSMF with workflow name "testWorkflow":
zowe zos-workflows start workflow-full --workflow-name "testWorkflow"
Will run given step of workflow instance plus following steps if specified by --perform-following-steps option.
Usage
zowe zos-workflows start workflow-step <stepName> [options]
Positional Arguments
-
stepName (string)
- Specifies the step name that will be run.
Options
-
--workflow-key | --wk (string)
- Workflow key of workflow instance to be started
-
--workflow-name | --wn (string)
- Workflow name of workflow instance to be started
-
--resolve-conflict-by | --rcb (string)
-
How variable conflicts should be handled.
Options:
outputFileValue: Allow the output file values to override the existing values.
existingValue: Use the existing variables values instead of the output file values.
leaveConflict: Automation is stopped. The user must resolve the conflict manually.
Default value: outputFileValue
Allowed values: outputFileValue, existingValue, leaveConflict
-
--perform-following-steps | --pfs (boolean)
Zosmf Connection Options
-
--host | -H (string)
- The z/OSMF server host name.
-
--port | -P (number)
-
The z/OSMF server port.
Default value: 443
-
--user | -u (string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized | --ru (boolean)
-
--base-path | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol (string)
-
--cert-file (local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Examples
-
To start step "Step1" only in a workflow instance in z/OSMF with workflow key "d043b5f1-adab-48e7-b7c3-d41cd95fa4b0":
zowe zos-workflows start workflow-step "Step1" --workflow-key "d043b5f1-adab-48e7-b7c3-d41cd95fa4b0"
-
To start a workflow instance in z/OSMF from step "Step1" with workflow key "d043b5f1-adab-48e7-b7c3-d41cd95fa4b0":
zowe zos-workflows start workflow-step "Step1" --workflow-key "d043b5f1-adab-48e7-b7c3-d41cd95fa4b0" --perform-following-steps
-
To start step "Step1" only in a workflow instance in z/OSMF with workflow key "d043b5f1-adab-48e7-b7c3-d41cd95fa4b0"and if there is a conflict in variable's value use the value that is in output file:
zowe zos-workflows start workflow-step "Step1" --workflow-key "d043b5f1-adab-48e7-b7c3-d41cd95fa4b0" --resolve-conflict-by "outputFileValue"
-
To start step "Step1" only in a workflow instance in z/OSMF with workflow name "testWorkflow":
zowe zos-workflows start workflow-step "Step1" --workflow-name "testWorkflow"
Retrieve and show the properties of a z/OSMF web server.
Confirm that z/OSMF is running on a specified system and gather information about the z/OSMF server for diagnostic purposes.
Confirm that z/OSMF is running on a system specified in your profile and gather information about the z/OSMF server for diagnostic purposes. The command outputs properties of the z/OSMF server such as version, hostname, and installed plug-ins.
Usage
zowe zosmf check status [options]
Zosmf Connection Options
-
--host | -H (string)
- The z/OSMF server host name.
-
--port | -P (number)
-
The z/OSMF server port.
Default value: 443
-
--user | -u (string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized | --ru (boolean)
-
--base-path | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol (string)
-
--cert-file (local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Examples
-
Report the status of the z/OSMF server that you specified in your default z/OSMF profile:
zowe zosmf check status
-
Report the status of the z/OSMF server that you specified in a supplied z/OSMF profile:
zowe zosmf check status --zosmf-profile SomeZosmfProfileName
-
Report the status of the z/OSMF server that you specified manually via command line:
zowe zosmf check status --host myhost --port 443 --user myuser --password mypass
Obtain a list of systems that are defined to a z/OSMF instance.
Obtain a list of systems that are defined to a z/OSMF instance.
Usage
zowe zosmf list systems [options]
Zosmf Connection Options
-
--host | -H (string)
- The z/OSMF server host name.
-
--port | -P (number)
-
The z/OSMF server port.
Default value: 443
-
--user | -u (string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized | --ru (boolean)
-
--base-path | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol (string)
-
--cert-file (local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Examples
-
Obtain a list of systems defined to a z/OSMF instance with your default z/OSMF profile:
zowe zosmf list systems
-
Obtain a list of systems defined to a z/OSMF instance for the specified z/OSMF profile:
zowe zosmf list systems --zosmf-profile SomeZosmfProfileName
-
Obtain a list of the systems defined to a z/OSMF instance that you specified in the command line:
zowe zosmf list systems --host myhost --port 443 --user myuser --password mypass