zowe
-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
- - -Global Options
--
-
---response-format-json|--rfj(boolean)-
-
- Produce JSON formatted data from a command -
-
---help|-h(boolean)-
-
- Display help text -
-
---help-examples(boolean)-
-
- Not available for top tier Zowe group -
-
---help-web|--hw(boolean)-
-
- Display HTML help in browser -
-
Table of Contents
-- auth
- login | li
- apiml -
-
- logout | lo
- apiml -
-
- - login | li
- cics -
- config
- get | ge -
- set | se -
- - db2 -
- ims -
- mq -
- plugins
- install -
- list -
- update -
- validate -
- - profiles -
- provisioning | pv -
- secure-credential-store | scs -
- zos-console | console -
- zos-files | files -
- zos-ftp | zftp -
- zos-jobs | jobs
- cancel | can
- job -
-
- delete | del
- job -
-
- - cancel | can
- zos-tso | tso -
- zos-uss | uss -
- zos-workflows | wf -
- zosmf -
-
zowe › auth
-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.
-zowe › auth › login
-Log in to an authentication service.
-zowe › auth › login › apiml
-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
--
-
---show-token|--st(boolean)-
-
- Show the token when login is successful. If specified, does not save the token -to a profile. -
-
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)-
-
Reject self-signed certificates.
-Default value: true
-
-
-
Profile Options
--
-
---base-profile|--base-p(string)-
-
- The name of a (base) profile to load for this command execution. -
-
Examples
--
-
Log in to an API ML instance to obtain or update the token -stored in your base profile:
--
-
zowe auth login apiml
-
-Log in to an API ML instance to obtain a token without -storing it in a profile:
--
-
zowe auth login apiml --show-token
-
-
zowe › auth › logout
-Log out of an authentication service.
-zowe › auth › logout › apiml
-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)-
-
Reject self-signed certificates.
-Default value: true
-
-
-
Profile Options
--
-
---base-profile|--base-p(string)-
-
- The name of a (base) profile to load for this command execution. -
-
Examples
--
-
Log out of an API ML instance to revoke the token that was -in use and remove it from your base profile:
--
-
zowe auth logout apiml
-
-Log out of an API ML instance to revoke a token that was not -stored in a profile:
--
-
zowe auth logout apiml --token-value <token>
-
-
-
zowe › cics
-Interact with IBM CICS programs and transactions.
-zowe › cics › add-to-list
-Add new resources (for example, CSD Groups to CSD Lists) to CICS through IBM -CMCI.
-zowe › cics › add-to-list › csdGroup
-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
--
-
---host|-H(string)-
-
- The CICS server host name. -
-
---port|-P(number)-
-
The CICS server port.
-Default value: 443
-
-
-
---user|-u(string)-
-
- Mainframe (CICS) user name, which can be the same as your TSO login. -
-
---password|--pw(string)-
-
- Mainframe (CICS) password, which can be the same as your TSO password. -
-
---reject-unauthorized|--ru(boolean)-
-
Reject self-signed certificates.
-Default value: true
-
-
-
---protocol|-o(string)-
-
Specifies CMCI protocol (http or https).
-Default value: https
-Allowed values: http, https
-
-
-
Profile Options
--
-
---cics-profile|--cics-p(string)-
-
- The name of a (cics) 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. -
-
Examples
--
-
Add the CSD Group MYGRP to the CSD List MYLIST in the region -named MYREG:
--
-
zowe cics add-to-list csdGroup MYGRP MYLIST --region-name MYREG
-
-
zowe › cics › define
-Define new resources (for example, programs) to CICS through IBM CMCI.
-zowe › cics › define › program
-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
--
-
---host|-H(string)-
-
- The CICS server host name. -
-
---port|-P(number)-
-
The CICS server port.
-Default value: 443
-
-
-
---user|-u(string)-
-
- Mainframe (CICS) user name, which can be the same as your TSO login. -
-
---password|--pw(string)-
-
- Mainframe (CICS) password, which can be the same as your TSO password. -
-
---reject-unauthorized|--ru(boolean)-
-
Reject self-signed certificates.
-Default value: true
-
-
-
---protocol|-o(string)-
-
Specifies CMCI protocol (http or https).
-Default value: https
-Allowed values: http, https
-
-
-
Profile Options
--
-
---cics-profile|--cics-p(string)-
-
- The name of a (cics) 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. -
-
Examples
--
-
Define a program named PGM123 to the region name MYREGION in -the CSD group MYGRP:
--
-
zowe cics define program PGM123 MYGRP --region-name MYREGION
-
-
zowe › cics › define › transaction
-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
--
-
---host|-H(string)-
-
- The CICS server host name. -
-
---port|-P(number)-
-
The CICS server port.
-Default value: 443
-
-
-
---user|-u(string)-
-
- Mainframe (CICS) user name, which can be the same as your TSO login. -
-
---password|--pw(string)-
-
- Mainframe (CICS) password, which can be the same as your TSO password. -
-
---reject-unauthorized|--ru(boolean)-
-
Reject self-signed certificates.
-Default value: true
-
-
-
---protocol|-o(string)-
-
Specifies CMCI protocol (http or https).
-Default value: https
-Allowed values: http, https
-
-
-
Profile Options
--
-
---cics-profile|--cics-p(string)-
-
- The name of a (cics) 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. -
-
Examples
--
-
Define a transaction named TRN1 for the program named PGM123 -to the region named MYREGION in the CSD group MYGRP:
--
-
zowe cics define transaction TRN1 PGM123 MYGRP --region-name MYREGION
-
-
zowe › cics › define › urimap-client
-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
--
-
---urimap-path|--up(string)-
-
- The path component of the URI. -
-
---urimap-host|--uh(string)-
-
- The host component of the URI. -
-
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)-
-
Whether or not the URIMAP is to be enabled on install by default.
-Default value: true
-
-
-
Cics Connection Options
--
-
---host|-H(string)-
-
- The CICS server host name. -
-
---port|-P(number)-
-
The CICS server port.
-Default value: 443
-
-
-
---user|-u(string)-
-
- Mainframe (CICS) user name, which can be the same as your TSO login. -
-
---password|--pw(string)-
-
- Mainframe (CICS) password, which can be the same as your TSO password. -
-
---reject-unauthorized|--ru(boolean)-
-
Reject self-signed certificates.
-Default value: true
-
-
-
---protocol|-o(string)-
-
Specifies CMCI protocol (http or https).
-Default value: https
-Allowed values: http, https
-
-
-
Profile Options
--
-
---cics-profile|--cics-p(string)-
-
- The name of a (cics) 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. -
-
Examples
--
-
Define a URIMAP named URIMAPA to the region named MYREGION -in the CSD group MYGRP where the host is www.example.com and the path is -/example/index.html:
--
-
zowe cics define urimap-client URIMAPA MYGRP --urimap-path /example/index.html --urimap-host www.example.com --region-name MYREGION
-
-
zowe › cics › define › urimap-pipeline
-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)-
-
Whether or not the URIMAP is to be enabled on install by default.
-Default value: true
-
-
-
Cics Connection Options
--
-
---host|-H(string)-
-
- The CICS server host name. -
-
---port|-P(number)-
-
The CICS server port.
-Default value: 443
-
-
-
---user|-u(string)-
-
- Mainframe (CICS) user name, which can be the same as your TSO login. -
-
---password|--pw(string)-
-
- Mainframe (CICS) password, which can be the same as your TSO password. -
-
---reject-unauthorized|--ru(boolean)-
-
Reject self-signed certificates.
-Default value: true
-
-
-
---protocol|-o(string)-
-
Specifies CMCI protocol (http or https).
-Default value: https
-Allowed values: http, https
-
-
-
Profile Options
--
-
---cics-profile|--cics-p(string)-
-
- The name of a (cics) 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. -
-
Examples
--
-
Define a URIMAP named URIMAPA for the pipeline named PIPE123 -to the region named MYREGION in the CSD group MYGRP where the host is -www.example.com and the path is /example/index.html:
--
-
zowe cics define urimap-pipeline URIMAPA MYGRP --urimap-path /example/index.html --urimap-host www.example.com --pipeline-name PIPE123 --region-name MYREGION
-
-
zowe › cics › define › urimap-server
-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)-
-
Whether or not the URIMAP is to be enabled on install by default.
-Default value: true
-
-
-
Cics Connection Options
--
-
---host|-H(string)-
-
- The CICS server host name. -
-
---port|-P(number)-
-
The CICS server port.
-Default value: 443
-
-
-
---user|-u(string)-
-
- Mainframe (CICS) user name, which can be the same as your TSO login. -
-
---password|--pw(string)-
-
- Mainframe (CICS) password, which can be the same as your TSO password. -
-
---reject-unauthorized|--ru(boolean)-
-
Reject self-signed certificates.
-Default value: true
-
-
-
---protocol|-o(string)-
-
Specifies CMCI protocol (http or https).
-Default value: https
-Allowed values: http, https
-
-
-
Profile Options
--
-
---cics-profile|--cics-p(string)-
-
- The name of a (cics) 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. -
-
Examples
--
-
Define a URIMAP named URIMAPA for the program named PGM123 -to the region named MYREGION in the CSD group MYGRP where the host is -www.example.com and the path is /example/index.html:
--
-
zowe cics define urimap-server URIMAPA MYGRP --urimap-path /example/index.html --urimap-host www.example.com --program-name PGM123 --region-name MYREGION
-
-
zowe › cics › define › webservice
-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
--
-
---pipeline-name|--pn(string)-
-
- The name of the PIPELINE resource definition for the web service. The maximum -length of the pipeline name is eight characters -
-
---wsbind(string)-
-
- The file name of the web service binding file on HFS. -
-
Options
--
-
---description|--desc(string)-
-
- Description of the web service resource being defined. -
-
---validation(boolean)-
-
Specifies whether full validation of SOAP messages against the corresponding -schema in the web service description should be performed at run time.
-Default value: false
-
-
-
---wsdlfile|--wsdl(string)-
-
- The file name of the web service description (WSDL) file on HFS. -
-
---region-name(string)-
-
- The CICS region name to which to define the new web service. -
-
---cics-plex(string)-
-
- The name of the CICSPlex to which to define the new web service. -
-
Cics Connection Options
--
-
---host|-H(string)-
-
- The CICS server host name. -
-
---port|-P(number)-
-
The CICS server port.
-Default value: 443
-
-
-
---user|-u(string)-
-
- Mainframe (CICS) user name, which can be the same as your TSO login. -
-
---password|--pw(string)-
-
- Mainframe (CICS) password, which can be the same as your TSO password. -
-
---reject-unauthorized|--ru(boolean)-
-
Reject self-signed certificates.
-Default value: true
-
-
-
---protocol|-o(string)-
-
Specifies CMCI protocol (http or https).
-Default value: https
-Allowed values: http, https
-
-
-
Profile Options
--
-
---cics-profile|--cics-p(string)-
-
- The name of a (cics) 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. -
-
Examples
--
-
Define a webservice named WEBSVCA for the pipeline named -PIPE123 to the region named MYREGION in the CSD group MYGRP where the binding -file is /u/exampleapp/wsbind/example.log:
--
-
zowe cics define webservice WEBSVCA MYGRP --pipeline-name PIPELINE --wsbind /u/exampleapp/wsbind/example.log --region-name MYREGION
-
-
zowe › cics › delete
-Delete resources (for example, programs) from CICS through IBM CMCI.
-zowe › cics › delete › program
-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
--
-
---host|-H(string)-
-
- The CICS server host name. -
-
---port|-P(number)-
-
The CICS server port.
-Default value: 443
-
-
-
---user|-u(string)-
-
- Mainframe (CICS) user name, which can be the same as your TSO login. -
-
---password|--pw(string)-
-
- Mainframe (CICS) password, which can be the same as your TSO password. -
-
---reject-unauthorized|--ru(boolean)-
-
Reject self-signed certificates.
-Default value: true
-
-
-
---protocol|-o(string)-
-
Specifies CMCI protocol (http or https).
-Default value: https
-Allowed values: http, https
-
-
-
Profile Options
--
-
---cics-profile|--cics-p(string)-
-
- The name of a (cics) 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. -
-
Examples
--
-
Delete a program named PGM123 from the region named -MYREGION:
--
-
zowe cics delete program PGM123 --region-name MYREGION
-
-
zowe › cics › delete › transaction
-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
--
-
---host|-H(string)-
-
- The CICS server host name. -
-
---port|-P(number)-
-
The CICS server port.
-Default value: 443
-
-
-
---user|-u(string)-
-
- Mainframe (CICS) user name, which can be the same as your TSO login. -
-
---password|--pw(string)-
-
- Mainframe (CICS) password, which can be the same as your TSO password. -
-
---reject-unauthorized|--ru(boolean)-
-
Reject self-signed certificates.
-Default value: true
-
-
-
---protocol|-o(string)-
-
Specifies CMCI protocol (http or https).
-Default value: https
-Allowed values: http, https
-
-
-
Profile Options
--
-
---cics-profile|--cics-p(string)-
-
- The name of a (cics) 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. -
-
Examples
--
-
Delete a transaction named TRN1 from the region named -MYREGION:
--
-
zowe cics delete transaction TRN1 MYGRP --region-name MYREGION
-
-
zowe › cics › delete › urimap
-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
--
-
---host|-H(string)-
-
- The CICS server host name. -
-
---port|-P(number)-
-
The CICS server port.
-Default value: 443
-
-
-
---user|-u(string)-
-
- Mainframe (CICS) user name, which can be the same as your TSO login. -
-
---password|--pw(string)-
-
- Mainframe (CICS) password, which can be the same as your TSO password. -
-
---reject-unauthorized|--ru(boolean)-
-
Reject self-signed certificates.
-Default value: true
-
-
-
---protocol|-o(string)-
-
Specifies CMCI protocol (http or https).
-Default value: https
-Allowed values: http, https
-
-
-
Profile Options
--
-
---cics-profile|--cics-p(string)-
-
- The name of a (cics) 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. -
-
Examples
--
-
Delete a urimap named URIMAPA from the region named MYREGION -belonging to the csdgroup MYGRP:
--
-
zowe cics delete urimap URIMAPA MYGRP --region-name MYREGION
-
-
zowe › cics › delete › webservice
-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
--
-
---host|-H(string)-
-
- The CICS server host name. -
-
---port|-P(number)-
-
The CICS server port.
-Default value: 443
-
-
-
---user|-u(string)-
-
- Mainframe (CICS) user name, which can be the same as your TSO login. -
-
---password|--pw(string)-
-
- Mainframe (CICS) password, which can be the same as your TSO password. -
-
---reject-unauthorized|--ru(boolean)-
-
Reject self-signed certificates.
-Default value: true
-
-
-
---protocol|-o(string)-
-
Specifies CMCI protocol (http or https).
-Default value: https
-Allowed values: http, https
-
-
-
Profile Options
--
-
---cics-profile|--cics-p(string)-
-
- The name of a (cics) 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. -
-
Examples
--
-
Delete a web service named WEBSVCA from the region named -MYREGION belonging to the csdgroup MYGRP:
--
-
zowe cics delete webservice WEBSVCA MYGRP --region-name MYREGION
-
-
zowe › cics › disable
-Disable resources (for example, urimaps) from CICS through IBM CMCI.
-zowe › cics › disable › urimap
-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
--
-
---host|-H(string)-
-
- The CICS server host name. -
-
---port|-P(number)-
-
The CICS server port.
-Default value: 443
-
-
-
---user|-u(string)-
-
- Mainframe (CICS) user name, which can be the same as your TSO login. -
-
---password|--pw(string)-
-
- Mainframe (CICS) password, which can be the same as your TSO password. -
-
---reject-unauthorized|--ru(boolean)-
-
Reject self-signed certificates.
-Default value: true
-
-
-
---protocol|-o(string)-
-
Specifies CMCI protocol (http or https).
-Default value: https
-Allowed values: http, https
-
-
-
Profile Options
--
-
---cics-profile|--cics-p(string)-
-
- The name of a (cics) 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. -
-
Examples
--
-
Disable a urimap named URIMAPA from the region named -MYREGION:
--
-
zowe cics disable urimap URIMAPA --region-name MYREGION
-
-
zowe › cics › discard
-Discard resources (for example, programs) from CICS through IBM CMCI.
-zowe › cics › discard › program
-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
--
-
---host|-H(string)-
-
- The CICS server host name. -
-
---port|-P(number)-
-
The CICS server port.
-Default value: 443
-
-
-
---user|-u(string)-
-
- Mainframe (CICS) user name, which can be the same as your TSO login. -
-
---password|--pw(string)-
-
- Mainframe (CICS) password, which can be the same as your TSO password. -
-
---reject-unauthorized|--ru(boolean)-
-
Reject self-signed certificates.
-Default value: true
-
-
-
---protocol|-o(string)-
-
Specifies CMCI protocol (http or https).
-Default value: https
-Allowed values: http, https
-
-
-
Profile Options
--
-
---cics-profile|--cics-p(string)-
-
- The name of a (cics) 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. -
-
Examples
--
-
Discard a program named PGM123 from the region named -MYREGION:
--
-
zowe cics discard program PGM123 --region-name MYREGION
-
-
zowe › cics › discard › transaction
-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
--
-
---host|-H(string)-
-
- The CICS server host name. -
-
---port|-P(number)-
-
The CICS server port.
-Default value: 443
-
-
-
---user|-u(string)-
-
- Mainframe (CICS) user name, which can be the same as your TSO login. -
-
---password|--pw(string)-
-
- Mainframe (CICS) password, which can be the same as your TSO password. -
-
---reject-unauthorized|--ru(boolean)-
-
Reject self-signed certificates.
-Default value: true
-
-
-
---protocol|-o(string)-
-
Specifies CMCI protocol (http or https).
-Default value: https
-Allowed values: http, https
-
-
-
Profile Options
--
-
---cics-profile|--cics-p(string)-
-
- The name of a (cics) 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. -
-
Examples
--
-
Discard a transaction named TRN1 from the region named -MYREGION:
--
-
zowe cics discard transaction TRN1 --region-name MYREGION
-
-
zowe › cics › discard › urimap
-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
--
-
---host|-H(string)-
-
- The CICS server host name. -
-
---port|-P(number)-
-
The CICS server port.
-Default value: 443
-
-
-
---user|-u(string)-
-
- Mainframe (CICS) user name, which can be the same as your TSO login. -
-
---password|--pw(string)-
-
- Mainframe (CICS) password, which can be the same as your TSO password. -
-
---reject-unauthorized|--ru(boolean)-
-
Reject self-signed certificates.
-Default value: true
-
-
-
---protocol|-o(string)-
-
Specifies CMCI protocol (http or https).
-Default value: https
-Allowed values: http, https
-
-
-
Profile Options
--
-
---cics-profile|--cics-p(string)-
-
- The name of a (cics) 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. -
-
Examples
--
-
Discard a urimap named URIMAPA from the region named -MYREGION:
--
-
zowe cics discard urimap URIMAPA --region-name MYREGION
-
-
zowe › cics › enable
-Enable resources (for example, urimaps) from CICS through IBM CMCI.
-zowe › cics › enable › urimap
-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
--
-
---host|-H(string)-
-
- The CICS server host name. -
-
---port|-P(number)-
-
The CICS server port.
-Default value: 443
-
-
-
---user|-u(string)-
-
- Mainframe (CICS) user name, which can be the same as your TSO login. -
-
---password|--pw(string)-
-
- Mainframe (CICS) password, which can be the same as your TSO password. -
-
---reject-unauthorized|--ru(boolean)-
-
Reject self-signed certificates.
-Default value: true
-
-
-
---protocol|-o(string)-
-
Specifies CMCI protocol (http or https).
-Default value: https
-Allowed values: http, https
-
-
-
Profile Options
--
-
---cics-profile|--cics-p(string)-
-
- The name of a (cics) 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. -
-
Examples
--
-
Enable a urimap named URIMAPA from the region named -MYREGION:
--
-
zowe cics enable urimap URIMAPA --region-name MYREGION
-
-
zowe › cics › get
-Get resources (for example, programs or transactions) from CICS through IBM -CMCI.
-zowe › cics › get › resource
-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
--
-
---host|-H(string)-
-
- The CICS server host name. -
-
---port|-P(number)-
-
The CICS server port.
-Default value: 443
-
-
-
---user|-u(string)-
-
- Mainframe (CICS) user name, which can be the same as your TSO login. -
-
---password|--pw(string)-
-
- Mainframe (CICS) password, which can be the same as your TSO password. -
-
---reject-unauthorized|--ru(boolean)-
-
Reject self-signed certificates.
-Default value: true
-
-
-
---protocol|-o(string)-
-
Specifies CMCI protocol (http or https).
-Default value: https
-Allowed values: http, https
-
-
-
Profile Options
--
-
---cics-profile|--cics-p(string)-
-
- The name of a (cics) 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. -
-
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
-
-
zowe › cics › install
-Install resources (for example, programs) to CICS through IBM CMCI.
-zowe › cics › install › program
-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
--
-
---host|-H(string)-
-
- The CICS server host name. -
-
---port|-P(number)-
-
The CICS server port.
-Default value: 443
-
-
-
---user|-u(string)-
-
- Mainframe (CICS) user name, which can be the same as your TSO login. -
-
---password|--pw(string)-
-
- Mainframe (CICS) password, which can be the same as your TSO password. -
-
---reject-unauthorized|--ru(boolean)-
-
Reject self-signed certificates.
-Default value: true
-
-
-
---protocol|-o(string)-
-
Specifies CMCI protocol (http or https).
-Default value: https
-Allowed values: http, https
-
-
-
Profile Options
--
-
---cics-profile|--cics-p(string)-
-
- The name of a (cics) 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. -
-
Examples
--
-
Install a program named PGM123 to the region named MYREGION -in the CSD group MYGRP:
--
-
zowe cics install program PGM123 MYGRP --region-name MYREGION
-
-
zowe › cics › install › transaction
-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
--
-
---host|-H(string)-
-
- The CICS server host name. -
-
---port|-P(number)-
-
The CICS server port.
-Default value: 443
-
-
-
---user|-u(string)-
-
- Mainframe (CICS) user name, which can be the same as your TSO login. -
-
---password|--pw(string)-
-
- Mainframe (CICS) password, which can be the same as your TSO password. -
-
---reject-unauthorized|--ru(boolean)-
-
Reject self-signed certificates.
-Default value: true
-
-
-
---protocol|-o(string)-
-
Specifies CMCI protocol (http or https).
-Default value: https
-Allowed values: http, https
-
-
-
Profile Options
--
-
---cics-profile|--cics-p(string)-
-
- The name of a (cics) 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. -
-
Examples
--
-
Install a transaction named TRN1 to the region named -MYREGION in the CSD group MYGRP:
--
-
zowe cics install transaction TRN1 MYGRP --region-name MYREGION
-
-
zowe › cics › install › urimap
-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
--
-
---host|-H(string)-
-
- The CICS server host name. -
-
---port|-P(number)-
-
The CICS server port.
-Default value: 443
-
-
-
---user|-u(string)-
-
- Mainframe (CICS) user name, which can be the same as your TSO login. -
-
---password|--pw(string)-
-
- Mainframe (CICS) password, which can be the same as your TSO password. -
-
---reject-unauthorized|--ru(boolean)-
-
Reject self-signed certificates.
-Default value: true
-
-
-
---protocol|-o(string)-
-
Specifies CMCI protocol (http or https).
-Default value: https
-Allowed values: http, https
-
-
-
Profile Options
--
-
---cics-profile|--cics-p(string)-
-
- The name of a (cics) 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. -
-
Examples
--
-
Install a urimap named URIMAPA to the region named MYREGION -belonging to the csdgroup MYGRP:
--
-
zowe cics install urimap URIMAPA CSDGROUP --region-name MYREGION
-
-
zowe › cics › refresh
-Refresh a program on CICS through IBM CMCI.
-zowe › cics › refresh › program
-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
--
-
---host|-H(string)-
-
- The CICS server host name. -
-
---port|-P(number)-
-
The CICS server port.
-Default value: 443
-
-
-
---user|-u(string)-
-
- Mainframe (CICS) user name, which can be the same as your TSO login. -
-
---password|--pw(string)-
-
- Mainframe (CICS) password, which can be the same as your TSO password. -
-
---reject-unauthorized|--ru(boolean)-
-
Reject self-signed certificates.
-Default value: true
-
-
-
---protocol|-o(string)-
-
Specifies CMCI protocol (http or https).
-Default value: https
-Allowed values: http, https
-
-
-
Profile Options
--
-
---cics-profile|--cics-p(string)-
-
- The name of a (cics) 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. -
-
Examples
--
-
Refresh a program named PGM123 from the region named -MYREGION:
--
-
zowe cics refresh program PGM123 --region-name MYREGION
-
-
zowe › cics › remove-from-list
-Remove resources (for example, CSD Groups in CSD Lists) from CICS through IBM -CMCI.
-zowe › cics › remove-from-list › csdGroup
-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
--
-
---host|-H(string)-
-
- The CICS server host name. -
-
---port|-P(number)-
-
The CICS server port.
-Default value: 443
-
-
-
---user|-u(string)-
-
- Mainframe (CICS) user name, which can be the same as your TSO login. -
-
---password|--pw(string)-
-
- Mainframe (CICS) password, which can be the same as your TSO password. -
-
---reject-unauthorized|--ru(boolean)-
-
Reject self-signed certificates.
-Default value: true
-
-
-
---protocol|-o(string)-
-
Specifies CMCI protocol (http or https).
-Default value: https
-Allowed values: http, https
-
-
-
Profile Options
--
-
---cics-profile|--cics-p(string)-
-
- The name of a (cics) 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. -
-
Examples
--
-
Remove the CSD Group MYGRP from the CSD List MYLIST in the -region named MYREG:
--
-
zowe cics remove-from-list csdGroup MYGRP MYLIST --region-name MYREG
-
-
-
zowe › config
-Manage configuration and overrides. To see all set-able options use "list" -command.
-zowe › config › get
-Get a value of single setting option.
-Usage
-zowe config get <configName> [options]
-Positional Arguments
--
-
-configName(string)-
-
- Setting name -
-
Examples
--
-
Get a value of CredentialManager setting:
--
-
zowe config get CredentialManager
-
-
zowe › config › list
-List all configuration setting options.
-Usage
-zowe config list [options]
-Options
--
-
---values(boolean)-
-
- Show values for every option -
-
Examples
--
-
List all configuration setting options:
--
-
zowe config list
-
-List all configuration setting options with values:
--
-
zowe config list --values
-
-
zowe › config › reset
-Reset a configuration setting to default value.
-Usage
-zowe config reset <configName> [options]
-Positional Arguments
--
-
-configName(string)-
-
- Setting name to reset -
-
Examples
--
-
Reset the credential manager to default value:
--
-
zowe config reset CredentialManager
-
-
zowe › config › set
-Set a configuration setting.
-Usage
-zowe config set <configName> <configValue> [options]
-Positional Arguments
--
-
-configName(string)-
-
- Setting name. Possible values: -CredentialManager - The package name of a plugin that will override the default -credential manager to allow for different credential storage methods. -
-
-configValue(string)-
-
- Value to set -
-
Examples
--
-
Set the default credential manager to my-credential-manager:
--
-
zowe config set CredentialManager my-credential-manager
-
-
-
zowe › db2
-Interact with IBM Db2 for z/OS
-zowe › db2 › call
-Call a Db2 stored procedure
-zowe › db2 › call › 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
--
-
---parameters|-p(array)-
-
- Values to bind to the stored procedure parameters -
-
DB2 Connection Options
--
-
---host|-H(string)-
-
- The Db2 server host name -
-
---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)-
-
- The name of the database -
-
---sslFile|--ssl(string)-
-
- Path to an SSL Certificate file -
-
Profile Options
--
-
---db2-profile|--db2-p(string)-
-
- The name of a (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. -
-
Base Connection Options
--
-
---reject-unauthorized|--ru(boolean)-
-
Reject self-signed certificates.
-Default value: true
-
-
-
---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. -
-
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!"
-
-
zowe › db2 › execute
-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.
-zowe › db2 › execute › sql
-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)-
-
- The Db2 server host name -
-
---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)-
-
- The name of the database -
-
---sslFile|--ssl(string)-
-
- Path to an SSL Certificate file -
-
Profile Options
--
-
---db2-profile|--db2-p(string)-
-
- The name of a (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. -
-
Base Connection Options
--
-
---reject-unauthorized|--ru(boolean)-
-
Reject self-signed certificates.
-Default value: true
-
-
-
---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. -
-
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
-
-
zowe › db2 › export
-Export data from a Db2 table
-zowe › db2 › export › 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
--
-
---outfile|-o(string)-
-
- The path to the output file -
-
DB2 Connection Options
--
-
---host|-H(string)-
-
- The Db2 server host name -
-
---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)-
-
- The name of the database -
-
---sslFile|--ssl(string)-
-
- Path to an SSL Certificate file -
-
Profile Options
--
-
---db2-profile|--db2-p(string)-
-
- The name of a (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. -
-
Base Connection Options
--
-
---reject-unauthorized|--ru(boolean)-
-
Reject self-signed certificates.
-Default value: true
-
-
-
---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. -
-
Examples
--
-
Export employees data from the table SAMPLE.EMP and save it -to the file 'employees.sql':
--
-
zowe db2 export table SAMPLE.EMP --outfile employees.sql
-
-
-
zowe › ims
-Interact with IBM IMS programs and transactions.
-zowe › ims › query
-Query application programs, regions or transactions across an IMSplex.The query -returns information about application programs, regions and transactions. This -command submits a 'QUERY PGM', 'DIS ACT' or 'QUERY TRAN' IMS command and returns -the output.
-zowe › ims › query › program
-Query an IMS application program.
-Usage
-zowe ims query program [name...] [options]
-Positional Arguments
--
-
-name...(string)-
-
- Specifies the name of the program(s) to query. -
-
Options
--
-
---attributes|--att(array)-
-
Specifies the application program output fields to return.
-Default value: ALL
-Allowed values: ALL, BMPTYPE, DEFN, DEFNTYPE, DOPT, FP, GLOBAL, IMSID, GPSB, -LANG, LOCAL, MODEL, RESIDENT, SCHDTYPE, STATUS, TIMESTAMP, TRANSTAT, -EXPORTNEEDED, DB, RTC, TRAN, WORK
-
-
-
---status|--st(array)-
-
Selects programs for display that possess at least one of the specified program -statuses.
-Allowed values: DB-NOTAVL, IOPREV, LOCK, NOTINIT, STOSCHD, TRACE
-
-
-
---route|--rt(array)-
-
- Specifies the routes to return. -
-
IMS Connection Options
--
-
---host|-H(string)-
-
- The IMS Operations API server host name. -
-
---port|-P(number)-
-
- The IMS Operations API server port. -
-
---ims-connect-host|--ich(string)-
-
- The hostname of your instance of IMS Connect. This is typically the hostname of -the mainframe LPAR where IMS Connect is running. -
-
---ims-connect-port|--icp(number)-
-
- The port of your instance of IMS Connect. This port can be found in your IMS -Connect configuration file on the mainframe. -
-
---plex|-x(string)-
-
- The name of the IMS plex. -
-
---user|-u(string)-
-
- The web server user name where the IMS Operations API resides. -
-
---password|--pass(string)-
-
- The web server user password where the IMS Operations API resides. -
-
---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. -
-
Profile Options
--
-
---ims-profile|--ims-p(string)-
-
- The name of a (ims) 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)-
-
Reject self-signed certificates.
-Default value: true
-
-
-
---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. -
-
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
--
-
Query information for an application program named PGM123:
--
-
zowe ims query program "PGM123"
-
-Query information for application programs named ABC and -XYZ:
--
-
zowe ims query program "ABC XYZ"
-
-Query information for application programs starting with -PROG using the wild card character '*':
--
-
zowe ims query program "PROG*"
-
-Query information for all application programs (default is -all):
--
-
zowe ims query program
-
-Query information for all application programs specifying -optional parameters:
--
-
zowe ims query program --attributes "BMPTYPE TIMESTAMP" --status "NOTINIT" --route "IMS1 IMS2"
-
-Query information for all application programs specifying -optional connection parameters:
--
-
zowe ims query program --user "username" --pass "pass1234" --host "localhost" --port 8080 --ich "zos1" --icp 9999 --plex "PLEX1"
-
-
zowe › ims › query › region
-Query an IMS region.
-Usage
-zowe ims query region [options]
-Options
--
-
---dc(boolean)-
-
Displays only the DC subset of the output
-Default value: true
-
-
-
---region(boolean)-
-
Displays only the REGION subset of the output. The display consists of active -regions
-Default value: true
-
-
-
---route|--rt(array)-
-
- Specifies the routes to return. -
-
IMS Connection Options
--
-
---host|-H(string)-
-
- The IMS Operations API server host name. -
-
---port|-P(number)-
-
- The IMS Operations API server port. -
-
---ims-connect-host|--ich(string)-
-
- The hostname of your instance of IMS Connect. This is typically the hostname of -the mainframe LPAR where IMS Connect is running. -
-
---ims-connect-port|--icp(number)-
-
- The port of your instance of IMS Connect. This port can be found in your IMS -Connect configuration file on the mainframe. -
-
---plex|-x(string)-
-
- The name of the IMS plex. -
-
---user|-u(string)-
-
- The web server user name where the IMS Operations API resides. -
-
---password|--pass(string)-
-
- The web server user password where the IMS Operations API resides. -
-
---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. -
-
Profile Options
--
-
---ims-profile|--ims-p(string)-
-
- The name of a (ims) 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)-
-
Reject self-signed certificates.
-Default value: true
-
-
-
---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. -
-
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
--
-
Query information for regions on route IMS1:
--
-
zowe ims query region "IMS1"
-
-Query information for regions on routes IMS1 and IMS2:
--
-
zowe ims query region "IMS1 IMS2"
-
-Query DC and region information for regions on routes IMS1 -and IMS2:
--
-
zowe ims query region "IMS1 IMS2" --dc true --region true
-
-Query information for regions specifying optional connection -parameters:
--
-
zowe ims query region --user "username" --pass "pass1234" --host "localhost" --port 8080 --ich "zos1" --icp 9999 --plex "PLEX1"
-
-
zowe › ims › query › transaction
-Query an IMS transaction.
-Usage
-zowe ims query transaction [name...] [options]
-Positional Arguments
--
-
-name...(string)-
-
- Specifies the name of transaction(s) to query. You can use an * character as a -wildcard to select multiple transactions. -
-
Options
--
-
---attributes|--att(array)-
-
Specifies the transaction output fields to return.
-Allowed values: ALL, BMPTYPE, DEFN, DEFNTYPE, DOPT, FP, GLOBAL, IMSID, GPSB, -LANG, LOCAL, MODEL, RESIDENT, SCHDTYPE, STATUS, TIMESTAMP, TRANSTAT, -EXPORTNEEDED, DB, RTC, TRAN, WORK
-
-
-
---status|--st(array)-
-
Selects transactions that possess at least one of the specified transaction -statuses.
-Allowed values: AFFIN, BAL, CONV, CPIC, DYN, IOPREV, LCK, NOTINIT, QERR, QSTP, -SUSPEND, STOQ, STOSCHD, TRACE, USTO
-
-
-
---route|--rt(array)-
-
- Specifies the routes to return. -
-
---class|--cl(array)-
-
- Selects transactions by the classes you specify. -
-
---queue-count-operator|--qco(array)-
-
- The compare operator used to select transactions based on queue count. Valid -values: LT, LE, GT, GE, EQ or NE. -
-
---queue-count-value|--qcv(number)-
-
- The numeric value used with 'queue_count_operator' to select transactions -based on queue count. -
-
---conversation-attributes|--ca(string)-
-
- Selects transactions by the conversational attributes you specify. -
-
---fast-path-options|--fpo(string)-
-
- Selects transactions by the Fast Path options you specify. -
-
---remote-option-specified|--ros(string)-
-
- Selects transactions by the remote option you specify. -
-
---response-mode-option-specified|--rmos(string)-
-
- Selects transactions by the response mode option you specify. -
-
IMS Connection Options
--
-
---host|-H(string)-
-
- The IMS Operations API server host name. -
-
---port|-P(number)-
-
- The IMS Operations API server port. -
-
---ims-connect-host|--ich(string)-
-
- The hostname of your instance of IMS Connect. This is typically the hostname of -the mainframe LPAR where IMS Connect is running. -
-
---ims-connect-port|--icp(number)-
-
- The port of your instance of IMS Connect. This port can be found in your IMS -Connect configuration file on the mainframe. -
-
---plex|-x(string)-
-
- The name of the IMS plex. -
-
---user|-u(string)-
-
- The web server user name where the IMS Operations API resides. -
-
---password|--pass(string)-
-
- The web server user password where the IMS Operations API resides. -
-
---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. -
-
Profile Options
--
-
---ims-profile|--ims-p(string)-
-
- The name of a (ims) 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)-
-
Reject self-signed certificates.
-Default value: true
-
-
-
---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. -
-
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
--
-
Query transaction information for transaction named TRN12:
--
-
zowe ims query transaction "TRN12"
-
-Query transaction information for transactions named TRAN1 -and TRAN2:
--
-
zowe ims query transaction "TRAN1 TRAN2"
-
-Query transaction information for transactions starting with -TRAN using the wild card character '*':
--
-
zowe ims query transaction "TRAN*"
-
-Query transaction information for all transactions (default -is all):
--
-
zowe ims query transaction
-
-Query transaction information for all transactions -specifying optional parameters:
--
-
zowe ims query transaction --attributes "AFFIN TIMESTAMP" --status "NOTINIT" --route "IMS1 IMS2"
-
-Query transaction information for all transactions -specifying optional connection parameters:
--
-
zowe ims query transaction --user "username" --pass "pass1234" --host "localhost" --port 8080 --ich "zos1" --icp 9999 --plex "PLEX1"
-
-
zowe › ims › start
-Starts a region, application program, or transaction and makes IMS resources -available for reference and use. This command submits a '/START REGION', -'UPDATE PGM' or 'UPDATE TRAN' IMS command and returns the output.
-zowe › ims › start › program
-Start an IMS application program.
-Usage
-zowe ims start program [name...] [options]
-Positional Arguments
--
-
-name...(string)-
-
- The name of the application program(s) to start. The maximum length of a -program name is eight characters. -
-
Options
--
-
---attributes|--att(array)-
-
The attributes that are to be started
-Default value: SCHD
-Allowed values: SCHD, TRACE, REFRESH
-
-
-
---route|--rte(array)-
-
- The region(s) to route the command to -
-
IMS Connection Options
--
-
---host|-H(string)-
-
- The IMS Operations API server host name. -
-
---port|-P(number)-
-
- The IMS Operations API server port. -
-
---ims-connect-host|--ich(string)-
-
- The hostname of your instance of IMS Connect. This is typically the hostname of -the mainframe LPAR where IMS Connect is running. -
-
---ims-connect-port|--icp(number)-
-
- The port of your instance of IMS Connect. This port can be found in your IMS -Connect configuration file on the mainframe. -
-
---plex|-x(string)-
-
- The name of the IMS plex. -
-
---user|-u(string)-
-
- The web server user name where the IMS Operations API resides. -
-
---password|--pass(string)-
-
- The web server user password where the IMS Operations API resides. -
-
---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. -
-
Profile Options
--
-
---ims-profile|--ims-p(string)-
-
- The name of a (ims) 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)-
-
Reject self-signed certificates.
-Default value: true
-
-
-
---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. -
-
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
--
-
Start an application program named PGM123:
--
-
zowe ims start program "PGM123"
-
-Start all application programs beginning with ACC*:
--
-
zowe ims start program "ACC*"
-
-Start an application program named PGM234 and start tracing:
--
-
zowe ims start program "PGM234" --attributes "SCHD TRACE"
-
-Start an application program named PGM890 routing to control -regions IMS1 and IMS2:
--
-
zowe ims start program "PGM890" --route "IMS1 IMS2"
-
-Start an application programs named XYZ1 specifying optional -connection parameters:
--
-
zowe ims start program "XYZ1" --user "username" --pass "pass1234" --host "localhost" --port 8080 --ich "zos1" --icp 9999 --plex "PLEX1"
-
-
zowe › ims › start › region
-Start an IMS region.
-Usage
-zowe ims start region [memberName] [options]
-Positional Arguments
--
-
-memberName(string)-
-
- The name of the member that contains JCL for the region to start. The maximum -length of the member name is eight characters. If no member name is specified, -the default member name is used -
-
Options
--
-
---route|--rte(array)-
-
- The region(s) to route the command to -
-
---local|-l(boolean)-
-
- If you specify the --local option, IMS overrides the symbolic IMSID parameter -in the JCL of the default or specified member. --local is the default if you -specify the --job-name option. -
-
---job-name|--jn(string)-
-
- Use this option to override the job name on the JOB statement of the default or -specified JCL member for a dependent region. -
-
IMS Connection Options
--
-
---host|-H(string)-
-
- The IMS Operations API server host name. -
-
---port|-P(number)-
-
- The IMS Operations API server port. -
-
---ims-connect-host|--ich(string)-
-
- The hostname of your instance of IMS Connect. This is typically the hostname of -the mainframe LPAR where IMS Connect is running. -
-
---ims-connect-port|--icp(number)-
-
- The port of your instance of IMS Connect. This port can be found in your IMS -Connect configuration file on the mainframe. -
-
---plex|-x(string)-
-
- The name of the IMS plex. -
-
---user|-u(string)-
-
- The web server user name where the IMS Operations API resides. -
-
---password|--pass(string)-
-
- The web server user password where the IMS Operations API resides. -
-
---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. -
-
Profile Options
--
-
---ims-profile|--ims-p(string)-
-
- The name of a (ims) 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)-
-
Reject self-signed certificates.
-Default value: true
-
-
-
---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. -
-
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
--
-
Start a region stored in a member named MEM1:
--
-
zowe ims start region "MEM1"
-
-Start a region stored in a member named MEM2 specifying the -region to route the command:
--
-
zowe ims start region "MEM2" --route "IMS1"
-
-Start a region stored in a member named MEM3 and override -the job name:
--
-
zowe ims start region "MEM3" --job-name "JOB9"
-
-Start a region stored in a member named MEM4 routing to -control regions IMS1 and IMS2:
--
-
zowe ims start region "MEM4" --route "IMS1 IMS2"
-
-Start a region stored in a member named MEM5 specifying -optional connection parameters:
--
-
zowe ims start region "MEM5" --user "username" --pass "pass1234" --host "localhost" --port 8080 --ich "zos1" --icp 9999 --plex "PLEX1"
-
-
zowe › ims › start › transaction
-Start an IMS transaction.
-Usage
-zowe ims start transaction [name...] [options]
-Positional Arguments
--
-
-name...(string)-
-
- The name of the transaction(s) to start. The maximum length of a transaction -name is eight characters. -
-
Options
--
-
---attributes|--att(array)-
-
The attributes that are to be started
-Default value: SCHD
-Allowed values: Q, SCHD, SUSPEND, TRACE
-
-
-
---route|--rte(array)-
-
- The region(s) to route the command to -
-
IMS Connection Options
--
-
---host|-H(string)-
-
- The IMS Operations API server host name. -
-
---port|-P(number)-
-
- The IMS Operations API server port. -
-
---ims-connect-host|--ich(string)-
-
- The hostname of your instance of IMS Connect. This is typically the hostname of -the mainframe LPAR where IMS Connect is running. -
-
---ims-connect-port|--icp(number)-
-
- The port of your instance of IMS Connect. This port can be found in your IMS -Connect configuration file on the mainframe. -
-
---plex|-x(string)-
-
- The name of the IMS plex. -
-
---user|-u(string)-
-
- The web server user name where the IMS Operations API resides. -
-
---password|--pass(string)-
-
- The web server user password where the IMS Operations API resides. -
-
---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. -
-
Profile Options
--
-
---ims-profile|--ims-p(string)-
-
- The name of a (ims) 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)-
-
Reject self-signed certificates.
-Default value: true
-
-
-
---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. -
-
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
--
-
Start a transaction named TRN1:
--
-
zowe ims start transaction "TRN1"
-
-Start all transactions beginning with TRN*:
--
-
zowe ims start transaction "TRN*"
-
-Start a transaction named TRN2 and start tracing:
--
-
zowe ims start transaction "TRN2" --attributes "SCHD TRACE"
-
-Start a transaction named TRN3 routing to control regions -IMS1 and IMS2:
--
-
zowe ims start transaction "TRN3" --route "IMS1 IMS2"
-
-Start a transaction named TRN4 specifying optional -connection parameters:
--
-
zowe ims start transaction "TRN4" --user "username" --pass "pass1234" --host "localhost" --port 8080 --ich "zos1" --icp 9999 --plex "PLEX1"
-
-
zowe › ims › stop
-Stops a running region, application program or transaction. This command -submits a '/STOP REGION', 'UPDATE PGM' or 'UPDATE TRAN' IMS command and returns -the output.",
-zowe › ims › stop › program
-Stop an IMS application program.
-Usage
-zowe ims stop program [name...] [options]
-Positional Arguments
--
-
-name...(string)-
-
- The name( of the program(s) to stop. The maximum length of a program name is -eight characters. -
-
Options
--
-
---attributes|--att(array)-
-
The attributes that are to be stopped
-Default value: SCHD
-Allowed values: SCHD, TRACE
-
-
-
---route|--rte(array)-
-
- The region(s) to route the command -
-
IMS Connection Options
--
-
---host|-H(string)-
-
- The IMS Operations API server host name. -
-
---port|-P(number)-
-
- The IMS Operations API server port. -
-
---ims-connect-host|--ich(string)-
-
- The hostname of your instance of IMS Connect. This is typically the hostname of -the mainframe LPAR where IMS Connect is running. -
-
---ims-connect-port|--icp(number)-
-
- The port of your instance of IMS Connect. This port can be found in your IMS -Connect configuration file on the mainframe. -
-
---plex|-x(string)-
-
- The name of the IMS plex. -
-
---user|-u(string)-
-
- The web server user name where the IMS Operations API resides. -
-
---password|--pass(string)-
-
- The web server user password where the IMS Operations API resides. -
-
---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. -
-
Profile Options
--
-
---ims-profile|--ims-p(string)-
-
- The name of a (ims) 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)-
-
Reject self-signed certificates.
-Default value: true
-
-
-
---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. -
-
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
--
-
Stop an application program named PGM123:
--
-
zowe ims stop program "PGM123"
-
-Stop all application programs beginning with ACC*:
--
-
zowe ims stop program "ACC*"
-
-Stop tracing an application program named PGM234:
--
-
zowe ims stop program "PGM234" --attributes "TRACE"
-
-Stop an application program named PGM890 routing to control -regions IMS1 and IMS2:
--
-
zowe ims stop program "PGM890" --route "IMS1 IMS2"
-
-Stop an application programs named XYZ1 specifying optional -connection parameters:
--
-
zowe ims stop program "XYZ1" --user "username" --pass "pass1234" --host "localhost" --port 8080 --ich "zos1" --icp 9999 --plex "PLEX1"
-
-
zowe › ims › stop › region
-Stop an IMS region.
-Usage
-zowe ims stop region [options]
-Options
--
-
---region-ids|--ri(array)-
-
- Region identifier numbers for the regions you want to stop. You must specify -either this option or --job-name. -
-
---job-name|--jn(string)-
-
- The name of the job for the IMS region you want to stop. You must specify -either this option or --region-ids. -
-
---route|--rte(array)-
-
- The region(s) to route the command to -
-
---abdump(string)-
-
- Specify this option to cause abnormal termination (ABEND) of an application -program. If the transaction indicated by this argument is currently running in -the specified region, an error message is received at the master terminal, -indicating an application program ABEND. The region will remain active, but the -transaction will be stopped. The command is ignored if the transaction is not -currently scheduled in the region. -
-
---cancel(boolean)-
-
- Use this option if the region cannot be stopped with a stop region --abdump -command. To use this option, you must have already submitted a stop region -command using the --abdump option. -
-
---transaction(string)-
-
- Specify a transaction in wait-for-input mode to stop its message processing -within the specified region. -
-
IMS Connection Options
--
-
---host|-H(string)-
-
- The IMS Operations API server host name. -
-
---port|-P(number)-
-
- The IMS Operations API server port. -
-
---ims-connect-host|--ich(string)-
-
- The hostname of your instance of IMS Connect. This is typically the hostname of -the mainframe LPAR where IMS Connect is running. -
-
---ims-connect-port|--icp(number)-
-
- The port of your instance of IMS Connect. This port can be found in your IMS -Connect configuration file on the mainframe. -
-
---plex|-x(string)-
-
- The name of the IMS plex. -
-
---user|-u(string)-
-
- The web server user name where the IMS Operations API resides. -
-
---password|--pass(string)-
-
- The web server user password where the IMS Operations API resides. -
-
---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. -
-
Profile Options
--
-
---ims-profile|--ims-p(string)-
-
- The name of a (ims) 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)-
-
Reject self-signed certificates.
-Default value: true
-
-
-
---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. -
-
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
--
-
Stop a region with job name JOBNM1:
--
-
zowe ims stop region --job-name "JOBNM1"
-
-Stop multiple regions with region identifiers:
--
-
zowe ims stop region --region-ids 4 5
-
-Stop a region with region identifier and cause the abnormal -termination (ABEND) of the application program:
--
-
zowe ims stop region --region-ids 4 --abdump "TRAN1"
-
-Stop a region with region identifier and specify 'cancel' -because the 'abdump' option failed to stop the region:
--
-
zowe ims stop region --region-ids 4 --cancel true
-
-Stop a region with job name JOBNM4 specifying optional -connection parameters:
--
-
zowe ims stop region --job-name "JOBNM4" --user "username" --pass "pass1234" --host "localhost" --port 8080--ich "zos1" --icp 9999 --plex "PLEX1"
-
-
zowe › ims › stop › transaction
-Stop an IMS transaction.
-Usage
-zowe ims stop transaction <name...> [options]
-Positional Arguments
--
-
-name...(string)-
-
- The name of the transaction(s) to stop. The maximum length of a transaction -name is eight characters. -
-
Options
--
-
---attributes|--att(array)-
-
The attributes that are to be stopped
-Default value: SCHD
-Allowed values: Q, SCHD, TRACE
-
-
-
---route|--rte(array)-
-
- The region(s) to route the command -
-
IMS Connection Options
--
-
---host|-H(string)-
-
- The IMS Operations API server host name. -
-
---port|-P(number)-
-
- The IMS Operations API server port. -
-
---ims-connect-host|--ich(string)-
-
- The hostname of your instance of IMS Connect. This is typically the hostname of -the mainframe LPAR where IMS Connect is running. -
-
---ims-connect-port|--icp(number)-
-
- The port of your instance of IMS Connect. This port can be found in your IMS -Connect configuration file on the mainframe. -
-
---plex|-x(string)-
-
- The name of the IMS plex. -
-
---user|-u(string)-
-
- The web server user name where the IMS Operations API resides. -
-
---password|--pass(string)-
-
- The web server user password where the IMS Operations API resides. -
-
---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. -
-
Profile Options
--
-
---ims-profile|--ims-p(string)-
-
- The name of a (ims) 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)-
-
Reject self-signed certificates.
-Default value: true
-
-
-
---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. -
-
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
--
-
Stop a transaction named TRN1:
--
-
zowe ims stop transaction "TRN1"
-
-Stop all transactions beginning with TRN*:
--
-
zowe ims stop transaction "TRN*"
-
-Stop tracing a transaction named TRN2:
--
-
zowe ims stop transaction "TRN2" --attributes "TRACE"
-
-Stop a transaction named TRN3 routing to control regions -IMS1 and IMS2:
--
-
zowe ims stop transaction "TRN3" --route "IMS1 IMS2"
-
-Stop a transaction named TRN4 specifying optional connection -parameters:
--
-
zowe ims stop transaction "TRN4" --user "username" --pass "pass1234" --host "localhost" --port 8080 --ich "zos1" --icp 9999 --plex "PLEX1"
-
-
zowe › ims › update
-Updates the setting(s) for application program or transaction. This command -submits a 'UPDATE PGM' or 'UPDATE TRAN' IMS command and returns the output.
-zowe › ims › update › program
-Update an IMS application program.
-Usage
-zowe ims update program [name...] [options]
-Positional Arguments
--
-
-name...(string)-
-
- The name of the application program(s) to update. The maximum length of a -program name is eight characters. -
-
Options
--
-
---bmp-type|--bmptype(string)-
-
Specifies whether the program runs in a BMP type region or not. (N or Y).
-Allowed values: N, Y
-
-
-
---dynamic|--dopt(string)-
-
Specifies the dynamic option (N or Y).
-Allowed values: N, Y
-
-
-
---fast-path|--fp(string)-
-
Specifies the Fast Path option (E or N).
-Allowed values: E, N
-
-
-
---generated-psb|--gpsb(string)-
-
Specifies the generated PSB option (N or Y).
-Allowed values: N, Y
-
-
-
---language|--lang(string)-
-
Specifies the language interface of the program or a GPSB or defined a DOPT(Y) -program as using the JAVA language (ASSEM, COBOL, JAVA, PASCAL, PLI).
-Allowed values: ASSEM, COBOL, JAVA, PASCAL, PLI
-
-
-
---lock|-l(string)-
-
Specifies the LOCK status is to be set (ON or OFF).
-Allowed values: ON, OFF
-
-
-
---option|-o(string)-
-
Specifies to return response lines for all resources that are processed. It is -only valid with --name * (ALLRSP).
-Allowed values: ALLRSP
-
-
-
---resident|-r(string)-
-
Specifies the resident option (N or Y).
-Allowed values: N, Y
-
-
-
---route|--rte(array)-
-
- Specifies the region(s) to route the command. -
-
---schedule-type|--schdtype(string)-
-
Specifies whether this application program can be scheduled into more than one -message region or batch message region simultaneously (PARALLEL or SERIAL).
-Allowed values: PARALLEL, SERIAL
-
-
-
---transaction-level-stat|--transtat(string)-
-
Specifies whether transaction level statistics should be logged (N or Y).
-Allowed values: N, Y
-
-
-
IMS Connection Options
--
-
---host|-H(string)-
-
- The IMS Operations API server host name. -
-
---port|-P(number)-
-
- The IMS Operations API server port. -
-
---ims-connect-host|--ich(string)-
-
- The hostname of your instance of IMS Connect. This is typically the hostname of -the mainframe LPAR where IMS Connect is running. -
-
---ims-connect-port|--icp(number)-
-
- The port of your instance of IMS Connect. This port can be found in your IMS -Connect configuration file on the mainframe. -
-
---plex|-x(string)-
-
- The name of the IMS plex. -
-
---user|-u(string)-
-
- The web server user name where the IMS Operations API resides. -
-
---password|--pass(string)-
-
- The web server user password where the IMS Operations API resides. -
-
---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. -
-
Profile Options
--
-
---ims-profile|--ims-p(string)-
-
- The name of a (ims) 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)-
-
Reject self-signed certificates.
-Default value: true
-
-
-
---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. -
-
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
--
-
Update an application program named PGM123 to execute -exclusively as Fast Path:
--
-
zowe ims update program "PGM123" --fp "E"
-
-Update all application programs beginning with ACC* to not -run in a BMP type region:
--
-
zowe ims update program "ACC*" --bmptype "N"
-
-Unlock all programs beginning with PGM* to allow scheduling:
--
-
zowe ims update program "PGM*" --lock "OFF"
-
-Update an application program named PGM890 to execute as -Fast Path routing to control regions IMS1 and IMS2:
--
-
zowe ims update program "PGM890" --fp "E" --route "IMS1 IMS2"
-
-Unlock an application programs named XYZ1 to allow -scheduling specifying optional connection parameters:
--
-
zowe ims update program "XYZ1" --lock "OFF" --user "username" --pass "pass1234" --host "localhost" --port 8080 --ich "zos1" --icp 9999 --plex "PLEX1"
-
-
zowe › ims › update › transaction
-Update an IMS transaction.
-Usage
-zowe ims update transaction [name...] [options]
-Positional Arguments
--
-
-name...(string)-
-
- The name of the transaction(s) to update. The maximum length of a transaction -name is eight characters. -
-
Options
--
-
---aoi-cmd|--aocmd(string)-
-
Specifies the AOI option that you want to change (N, CMD, TRAN, Y).
-Allowed values: N, CMD, TRAN, Y
-
-
-
---class|-c(array)-
-
- Selects the transactions associated with the specified class or classes to be -updated. -
-
---commit-mode|--cmtmode(string)-
-
Specifies when database updates and non-express output messages are committed -(SNGL, MULT).
-Allowed values: SINGLE, MODE
-
-
-
---conversation|--conv(string)-
-
Specifies the conversation option (N or Y).
-Allowed values: N, Y
-
-
-
---current-priority|--cpri(number)-
-
- Specifies a new value for the current priority of a transaction. -
-
---directed-routing|--dirroute(string)-
-
Specifies the MSC directed routing option (N or Y).
-Allowed values: N, Y
-
-
-
---edit-routine|--editrtn(string)-
-
- Specifies the 1- to 8-character name of your transaction input edit routine -that edits messages before the program receives the message. -
-
---edit-uppercase|--edituc(string)-
-
Specifies the edit to uppercase option (N or Y).
-Allowed values: N, Y
-
-
-
---emh-buffer-size|--emhbsz(number)-
-
- Specifies the EMH buffer size required to run the Fast Path transaction. -
-
---expiration-time|--exprtime(number)-
-
- Specifies the elapsed time in seconds that IMS can use to cancel the input -transaction. -
-
---fast-path|--fp(string)-
-
Specifies the Fast Path option (E, N, P).
-Allowed values: E, N, P
-
-
-
---inquiry|--inq(string)-
-
Specifies the inquiry option (N or Y).
-Allowed values: N, Y
-
-
-
---limit-count|--lct(number)-
-
- Specifies the limit count. -
-
---limit-priority|--lpri(number)-
-
- Specifies the limit priority. -
-
---lock|-l(string)-
-
Specifies that the LOCK status is to be set on or off. Cannot be specified with -any other SET attribute(ON or OFF).
-Allowed values: ON, OFF
-
-
-
---log-write-ahead|--dclwa(string)-
-
Specifies the log write-ahead option (N or Y).
-Allowed values: N, Y
-
-
-
---maximum-regions|--maxrgn(number)-
-
- Specifies a new value for the maximum number of regions that can be -simultaneously scheduled for a given transaction. -
-
---message-type|--msgtype(string)-
-
Specifies the message type (single segment or multiple segment) (MULTSEG or -SNGLSEG).
-Allowed values: MULTSEG, SNGLSEG
-
-
-
---msname|--mn(string)-
-
- Specifies the one- to eight-character name of the logical link path in a -multiple IMS system configuration (MSC). -
-
---normal-scheduling-priority|--npri(number)-
-
- Specifies the normal scheduling priority. -
-
---option|-o(string)-
-
Specifies functions to be performed along with the command (AFFIN or ALLRSP).
-Allowed values: ALLRSP
-
-
-
---parallel-processing-limit|--parlim(number)-
-
- Specifies the parallel processing limit count. -
-
---program|--pgm(string)-
-
- Specifies the name of the application program associated with the transaction. -
-
---processing-limit-count|--plct(number)-
-
- Specifies the processing limit count. -
-
---processing-limit-count-time|--plcttime(number)-
-
- Specifies the processing limit count time. -
-
---recover|-r(string)-
-
Specifies the recovery option (N or Y).
-Allowed values: N, Y
-
-
-
---remote|--re(string)-
-
Specifies the remote option (N or Y).
-Allowed values: N, Y
-
-
-
---response-mode|--resp(string)-
-
Specifies the response mode option (N or Y).
-Allowed values: N, Y
-
-
-
---route|--rte(array)-
-
- Specifies the region(s) to route the command. -
-
---segment-number|--segno(number)-
-
- Specifies the segment number. -
-
---segment-size|--segsz(number)-
-
- Specifies the segment size. -
-
---serial|--sr(string)-
-
Specifies the serial option (N or Y).
-Allowed values: N, Y
-
-
-
---set-class|--sc(number)-
-
- Specifies the transaction class, which is an attribute used to select a -transaction for scheduling. -
-
---system-identification-local|--sidl(number)-
-
- Specifies the system identification (SYSID) of the local system in a -multiple-IMS system (MSC) configuration. -
-
---system-identification-remote|--sidr(number)-
-
- Specifies the system identification (SYSID) of the remote system in a -multiple-IMS system (MSC) configuration. -
-
---scratchpad-area-size|--spasz(number)-
-
- Specifies the scratchpad area (SPA) size, in bytes, for a conversational -transaction. The value can be a number from 16 and 32767. -
-
---scratchpad-area-truncation|--spatrunc(string)-
-
Specifies the scratchpad area (SPA) truncation option of a conversational -transaction (S or R).
-Allowed values: S, R
-
-
-
---transaction-level-stat|--transtat(string)-
-
Specifies whether transaction level statistics should be logged for message -driven programs (N or Y).
-Allowed values: N, Y
-
-
-
---wait-for-input|--wfi(string)-
-
Specifies the wait-for input option (N or Y).
-Allowed values: N, Y
-
-
-
IMS Connection Options
--
-
---host|-H(string)-
-
- The IMS Operations API server host name. -
-
---port|-P(number)-
-
- The IMS Operations API server port. -
-
---ims-connect-host|--ich(string)-
-
- The hostname of your instance of IMS Connect. This is typically the hostname of -the mainframe LPAR where IMS Connect is running. -
-
---ims-connect-port|--icp(number)-
-
- The port of your instance of IMS Connect. This port can be found in your IMS -Connect configuration file on the mainframe. -
-
---plex|-x(string)-
-
- The name of the IMS plex. -
-
---user|-u(string)-
-
- The web server user name where the IMS Operations API resides. -
-
---password|--pass(string)-
-
- The web server user password where the IMS Operations API resides. -
-
---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. -
-
Profile Options
--
-
---ims-profile|--ims-p(string)-
-
- The name of a (ims) 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)-
-
Reject self-signed certificates.
-Default value: true
-
-
-
---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. -
-
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
--
-
Update a transaction named TRN1 to process exclusively as -Fast Path:
--
-
zowe ims update transaction "TRN1" --fp "E"
-
-Unlock to allow scheduling all transactions beginning with -TRN* and associated with class CLASSA:
--
-
zowe ims update transaction "TRN*" --class "CLASSA" --lock "OFF"
-
-Set response mode on for transaction named TRN2 and -associated with classes CLASS1 and CLASS2:
--
-
zowe ims update transaction "TRN2" --class "CLASS1 CLASS2" --resp "Y"
-
-Update a transaction named TRN3 to process exclusively as -Fast Path routing to control regions IMS1 and IMS2:
--
-
zowe ims update transaction "TRN3" -fp "E" --route "IMS1 IMS2"
-
-Associate PGM1 with transaction named TRN4 specifying -optional connection parameters:
--
-
zowe ims update transaction "TRN4" --pgm "PGM1" --user "username" --pass "pass1234" --host "localhost" --port 8080 --ich "zos1" --icp 9999 --plex "PLEX1"
-
-
-
zowe › mq
-Interact with IBM MQ for z/OS.
-zowe › mq › run
-MQ Utilities
-zowe › mq › run › mqsc
-MQ Utilities
-Usage
-zowe mq run mqsc <qmgr> <cmd> [options]
-Positional Arguments
--
-
-qmgr(string)-
-
- The queue manager to apply the command to -
-
-cmd(string)-
-
- The MQSC command -
-
MQ Connection Options
--
-
---host|-H(string)-
-
- The host name used to access the IBM MQ REST API. This might be the host name -of the IBM MQ mqweb server, or the Zowe API Mediation Layer.. -
-
---port|-P(number)-
-
- The port number used to access the IBM MQ REST API. This might be the port -number of the IBM MQ mqweb server, or the Zowe API Mediation Layer. -
-
---user|-u(string)-
-
- The mainframe (MQ) user name, which can be the same as your TSO login. -
-
---password|--pass|--pw(string)-
-
- The mainframe (MQ) password, which can be the same as your TSO password. -
-
---reject-unauthorized|--ru(boolean)-
-
Reject self-signed certificates.
-Default value: false
-
-
-
---protocol|-o(string)-
-
Specifies the MQ protocol (http or https).
-Default value: http
-Allowed values: http, https
-
-
-
Profile Options
--
-
---mq-profile|--mq-p(string)-
-
- The name of a (mq) 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. -
-
Examples
--
-
The following sequence shows how to query a -server-connection channel that is called NEWSVRCONN on an MQ queue manager - our -example queue manager is called MQ99:
--
-
zowe mq run mqsc MQ99 "DISPLAY CHANNEL(NEWSVRCONN)"
-
-
-
zowe › plugins
-Install and manage plug-ins
-zowe › plugins › install
-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 ~/.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 (~/.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 adduser`. 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/adduser
-
-
-
Examples
--
-
Install plug-ins saved in -~/.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
-
-
zowe › plugins › list
-List all plug-ins installed.
-Usage
-zowe plugins list [options]
-zowe › plugins › uninstall
-Uninstall plug-ins.
-Usage
-zowe plugins uninstall [plugin...] [options]
-Positional Arguments
--
-
-plugin...(string)-
-
The name of the plug-in to uninstall.
-If the plug-in argument is omitted, no action is taken.
-
-
-
Examples
--
-
Uninstall a plug-in:
--
-
zowe plugins uninstall my-plugin
-
-
zowe › plugins › update
-Update plug-ins.
-Usage
-zowe plugins update [plugin...] [options]
-Positional Arguments
--
-
-plugin...(string)-
-
The name of the plug-in to update.
-If the plug-in argument is omitted, no action is taken.
-
-
-
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 adduser`. 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/adduser
-
-
-
Examples
--
-
Update a plug-in:
--
-
zowe plugins update my-plugin
-
-Update 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 update my-plugin --registry https://registry.npmjs.org/ --login
-
-
zowe › plugins › validate
-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.
-
-
-
Examples
--
-
Validate a plug-in named my-plugin:
--
-
zowe plugins validate my-plugin
-
-Validate all installed plug-ins:
--
-
zowe plugins validate
-
-
-
zowe › profiles
-Create and manage configuration profiles
-zowe › profiles › create
-Create new configuration profiles.
-zowe › profiles › create › base-profile
-Base profile that stores values shared by multiple service profiles
-Usage
-zowe profiles create base-profile <profileName> [options]
-Positional Arguments
--
-
-profileName(string)-
-
- Specifies the name of the new base profile. You can load this profile by using -the name on commands that support the "--base-profile" option. -
-
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)-
-
Reject self-signed certificates.
-Default value: true
-
-
-
---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. -
-
Options
--
-
---overwrite|--ow(boolean)-
-
- Overwrite the base profile when a profile of the same name exists. -
-
---disable-defaults|--dd(boolean)-
-
- Disable populating profile values of undefined properties with default values. -
-
Examples
--
-
Create a profile called 'base1' to connect to host -example.com and port 443:
--
-
zowe profiles create base-profile base1 --host example.com --port 443 --user admin --password 123456
-
-Create a profile called 'base2' to connect to host -example.com (default port - 443) and allow self-signed certificates:
--
-
zowe profiles create base-profile base2 --host example.com --user admin --password 123456 --reject-unauthorized false
-
-Create a profile called 'base3' to connect to host -example.com and port 1443, not specifying a username or password so they are not -stored on disk; these will need to be specified on every command:
--
-
zowe profiles create base-profile base3 --host example.com --port 1443
-
-Create a zosmf profile called 'base4' to connect to default -port 443 and allow self-signed certificates, not specifying a username, -password, or host so they are not stored on disk; these will need to be -specified on every command:
--
-
zowe profiles create base-profile base4 --reject-unauthorized false
-
-
zowe › profiles › create › cics-profile
-A cics profile is required to issue commands in the cics command group that -interact with CICS regions. The cics profile contains your host, port, user -name, and password for the IBM CICS management client interface (CMCI) server of -your choice.
-Usage
-zowe profiles create cics-profile <profileName> [options]
-Positional Arguments
--
-
-profileName(string)-
-
- Specifies the name of the new cics profile. You can load this profile by using -the name on commands that support the "--cics-profile" option. -
-
Required Options
--
-
---host|-H(string)-
-
- The CMCI server host name -
-
---user|-u(string)-
-
- Your username to connect to CICS -
-
---password|-p(string)-
-
- Your password to connect to CICS -
-
Options
--
-
---port|-P(number)-
-
The CMCI server port
-Default value: 1490
-
-
-
---region-name(string)-
-
- The name of the CICS region name to interact with -
-
---cics-plex(string)-
-
- The name of the CICSPlex to interact with -
-
---overwrite|--ow(boolean)-
-
- Overwrite the cics profile when a profile of the same name exists. -
-
---disable-defaults|--dd(boolean)-
-
- Disable populating profile values of undefined properties with default values. -
-
Cics Connection Options
--
-
---reject-unauthorized|--ru(boolean)-
-
Reject self-signed certificates.
-Default value: true
-
-
-
---protocol|-o(string)-
-
Specifies CMCI protocol (http or https).
-Default value: https
-Allowed values: http, https
-
-
-
Examples
--
-
Create a cics profile named 'cics123' to connect to CICS at -host zos123 and port 1490:
--
-
zowe profiles create cics-profile cics123 --host zos123 --port 1490 --user ibmuser --password myp4ss
-
-
zowe › profiles › create › db2-profile
-A profile for interaction with Db2 for the z/OS region
-Usage
-zowe profiles create db2-profile <profileName> [options]
-Positional Arguments
--
-
-profileName(string)-
-
- Specifies the name of the new db2 profile. You can load this profile by using -the name on commands that support the "--db2-profile" option. -
-
Options
--
-
---host|-H(string)-
-
- The Db2 server host name -
-
---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|-d(string)-
-
- The name of the database -
-
---ssl-file|-s(string)-
-
- Path to an SSL Certificate file -
-
---overwrite|--ow(boolean)-
-
- Overwrite the db2 profile when a profile of the same name exists. -
-
---disable-defaults|--dd(boolean)-
-
- Disable populating profile values of undefined properties with default values. -
-
zowe › profiles › create › ims-profile
-An ims profile is used to issue commands in the ims command group that interact -with IMS regions. The ims profile contains your IMS Operations API web server -host, port, user name and password, IMS Connect host and port and IMS plex -name.
-Usage
-zowe profiles create ims-profile <profileName> [options]
-Positional Arguments
--
-
-profileName(string)-
-
- Specifies the name of the new ims profile. You can load this profile by using -the name on commands that support the "--ims-profile" option. -
-
IMS Connection Options
--
-
---host|-H(string)-
-
- The IMS Operations API server host name. -
-
---port|-P(number)-
-
- The IMS Operations API server port. -
-
---ims-connect-host|--ich(string)-
-
- The hostname of your instance of IMS Connect. This is typically the hostname of -the mainframe LPAR where IMS Connect is running. -
-
---ims-connect-port|--icp(number)-
-
- The port of your instance of IMS Connect. This port can be found in your IMS -Connect configuration file on the mainframe. -
-
---plex|-x(string)-
-
- The name of the IMS plex. -
-
---user|-u(string)-
-
- The web server user name where the IMS Operations API resides. -
-
---password|--pass(string)-
-
- The web server user password where the IMS Operations API resides. -
-
---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. -
-
Options
--
-
---overwrite|--ow(boolean)-
-
- Overwrite the ims profile when a profile of the same name exists. -
-
---disable-defaults|--dd(boolean)-
-
- Disable populating profile values of undefined properties with default values. -
-
Examples
--
-
Create a ims profile named 'ims123' to connect to IMS APIs -at host zos123 and port 1490. The name of the IMS plex in this example is -'PLEX1' and the IMS region we want to communicate with has a host of zos124 and -a port of 1491:
--
-
zowe profiles create ims-profile ims123 --host zos123 --port 1490 --user ibmuser --pass myp4ss --plex PLEX1 --ich zos124 --icp 1491
-
-
zowe › profiles › create › mq-profile
-An MQREST profile is required to issue commands in the MQ command group that -interacts with MQSC. The mq profile contains your host, port, user name, and -password for the IBM MQ System Console interface
-Usage
-zowe profiles create mq-profile <profileName> [options]
-Positional Arguments
--
-
-profileName(string)-
-
- Specifies the name of the new mq profile. You can load this profile by using -the name on commands that support the "--mq-profile" option. -
-
Required Options
--
-
---host|-H(string)-
-
- The MQ Rest server host name -
-
---port|-P(number)-
-
- Port number of your MQ REST API server -
-
---user|-u(string)-
-
- User name to authenticate to your MQ REST API server -
-
---password|-p(string)-
-
- Password to authenticate to your MQ REST API server -
-
MQ Connection Options
--
-
---reject-unauthorized|--ru(boolean)-
-
Reject self-signed certificates.
-Default value: false
-
-
-
---protocol|-o(string)-
-
Specifies the MQ protocol (http or https).
-Default value: http
-Allowed values: http, https
-
-
-
Options
--
-
---overwrite|--ow(boolean)-
-
- Overwrite the mq profile when a profile of the same name exists. -
-
---disable-defaults|--dd(boolean)-
-
- Disable populating profile values of undefined properties with default values. -
-
Examples
--
-
Create an MQ profile named 'mqprofile' to connect to MQ at -host zos123 and port 1234:
--
-
zowe profiles create mq-profile mq --host mq123 --port 1234 --user ibmuser --password myp4ss
-
-
zowe › profiles › create › ssh-profile
-z/OS SSH Profile
-Usage
-zowe profiles create ssh-profile <profileName> [options]
-Positional Arguments
--
-
-profileName(string)-
-
- Specifies the name of the new ssh profile. You can load this profile by using -the name on commands that support the "--ssh-profile" option. -
-
z/OS Ssh Connection Options
--
-
---host|-H(string)-
-
- The z/OS SSH server host name. -
-
---port|-P(number)-
-
The z/OS SSH server port.
-Default value: 22
-
-
-
---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. -
-
Options
--
-
---overwrite|--ow(boolean)-
-
- Overwrite the ssh profile when a profile of the same name exists. -
-
---disable-defaults|--dd(boolean)-
-
- Disable populating profile values of undefined properties with default values. -
-
Examples
--
-
Create a ssh profile called 'ssh111' to connect to z/OS SSH -server at host 'zos123' and default port 22:
--
-
zowe profiles create ssh-profile ssh111 --host sshhost --user ibmuser --password myp4ss
-
-Create a ssh profile called 'ssh222' to connect to z/OS SSH -server at host 'zos123' and port 13022:
--
-
zowe profiles create ssh-profile ssh222 --host sshhost --port 13022 --user ibmuser --password myp4ss
-
-Create a ssh profile called 'ssh333' to connect to z/OS SSH -server at host 'zos123' using a privatekey '/path/to/privatekey' and its -decryption passphrase 'privateKeyPassphrase' for privatekey authentication:
--
-
zowe profiles create ssh-profile ssh333 --host sshhost --user ibmuser --privateKey /path/to/privatekey --keyPassphrase privateKeyPassphrase
-
-Create a ssh profile called 'ssh444' to connect to z/OS SSH -server on default port 22, without specifying username, host, or password, -preventing those values from being stored on disk:
--
-
zowe profiles create ssh-profile ssh444 --privateKey /path/to/privatekey
-
-
zowe › profiles › create › tso-profile
-z/OS TSO/E User Profile
-Usage
-zowe profiles create tso-profile <profileName> [options]
-Positional Arguments
--
-
-profileName(string)-
-
- Specifies the name of the new tso profile. You can load this profile by using -the name on commands that support the "--tso-profile" option. -
-
TSO ADDRESS SPACE OPTIONS
--
-
---account|-a(string)-
-
- Your z/OS TSO/E accounting information. -
-
---character-set|--cs(string)-
-
Character set for address space to convert messages and responses from UTF-8 to -EBCDIC.
-Default value: 697
-
-
-
---code-page|--cp(string)-
-
Codepage value for TSO/E address space to convert messages and responses from -UTF-8 to EBCDIC.
-Default value: 1047
-
-
-
---columns|--cols(number)-
-
The number of columns on a screen.
-Default value: 80
-
-
-
---logon-procedure|-l(string)-
-
The logon procedure to use when creating TSO procedures on your behalf.
-Default value: IZUFPROC
-
-
-
---region-size|--rs(number)-
-
Region size for the TSO/E address space.
-Default value: 4096
-
-
-
---rows(number)-
-
The number of rows on a screen.
-Default value: 24
-
-
-
Options
--
-
---overwrite|--ow(boolean)-
-
- Overwrite the tso profile when a profile of the same name exists. -
-
---disable-defaults|--dd(boolean)-
-
- Disable populating profile values of undefined properties with default values. -
-
Examples
--
-
Create a tso profile called 'myprof' with default settings -and JES accounting information of 'IZUACCT':
--
-
zowe profiles create tso-profile myprof -a IZUACCT
-
-Create a tso profile called 'largeregion' with a region size -of 8192, a logon procedure of MYPROC, and JES accounting information of '1234':
--
-
zowe profiles create tso-profile largeregion -a 1234 --rs 8192
-
-Create a tso profile called 'myprof2' with default settings -and region size of 8192, without storing the user account on disk:
--
-
zowe profiles create tso-profile myprof2 --rs 8192
-
-
zowe › profiles › create › zftp-profile
-Configuration profile for z/OS FTP
-Usage
-zowe profiles create zftp-profile <profileName> [options]
-Positional Arguments
--
-
-profileName(string)-
-
- Specifies the name of the new zftp profile. You can load this profile by using -the name on commands that support the "--zftp-profile" option. -
-
Required Options
--
-
---host|-H(string)-
-
- The hostname or IP address of the z/OS server to connect to. -
-
---port|-P(number)-
-
The port of the z/OS FTP server.
-Default value: 21
-
-
-
---user|-u(string)-
-
- Username for authentication on z/OS -
-
---password|-p|--pass|--pw(string)-
-
- Password to authenticate to FTP. -
-
Options
--
-
---secure-ftp(boolean)-
-
Set to true for both control and data connection encryption, 'control' for -control connection encryption only, or 'implicit' for implicitly encrypted -control connection (this mode is deprecated in modern times, but usually uses -port 990). Note: Unfortunately, this plugin's functionality only works with FTP -and FTPS, not 'SFTP' which is FTP over SSH.
-Default value: true
-
-
-
---connection-timeout|--ct(number)-
-
How long (in milliseconds) to wait for the control connection to be -established.
-Default value: 10000
-
-
-
---overwrite|--ow(boolean)-
-
- Overwrite the zftp profile when a profile of the same name exists. -
-
---disable-defaults|--dd(boolean)-
-
- Disable populating profile values of undefined properties with default values. -
-
TLS / Secure Connection options
--
-
---reject-unauthorized|--ru(boolean)-
-
- Reject self-signed certificates. Only specify this if you are connecting to a -secure FTP instance. -
-
---server-name|--sn(string)-
-
- Server name for the SNI (Server Name Indication) TLS extension. Only specify if -you are connecting securely -
-
Examples
--
-
Create a zftp profile called 'myprofile' with default -settings (port, timeout, etc.) to connect with the host system 123.:
--
-
zowe profiles create zftp-profile myprofile -u ibmuser -p ibmp4ss -H sys123
-
-
zowe › profiles › create › zosmf-profile
-z/OSMF Profile
-Usage
-zowe profiles create zosmf-profile <profileName> [options]
-Positional Arguments
--
-
-profileName(string)-
-
- Specifies the name of the new zosmf profile. You can load this profile by using -the name on commands that support the "--zosmf-profile" option. -
-
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)-
-
Reject self-signed certificates.
-Default value: true
-
-
-
---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. -
-
Options
--
-
---encoding|--ec(number)-
-
- The encoding for download and upload of z/OS data set and USS files. The -default encoding if not specified is 1047. -
-
---responseTimeout|--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 -
-
---overwrite|--ow(boolean)-
-
- Overwrite the zosmf profile when a profile of the same name exists. -
-
---disable-defaults|--dd(boolean)-
-
- Disable populating profile values of undefined properties with default values. -
-
Examples
--
-
Create a zosmf profile called 'zos123' to connect to z/OSMF -at host zos123 and port 1443:
--
-
zowe profiles create zosmf-profile zos123 --host zos123 --port 1443 --user ibmuser --password myp4ss
-
-Create a zosmf profile called 'zos124' to connect to z/OSMF -at the host zos124 (default port - 443) and allow self-signed certificates:
--
-
zowe profiles create zosmf-profile zos124 --host zos124 --user ibmuser --password myp4ss --reject-unauthorized false
-
-Create a zosmf profile called 'zos125' to connect to z/OSMF -at the host zos125 and port 1443, not specifying a username or password so they -are not stored on disk; these will need to be specified on every command:
--
-
zowe profiles create zosmf-profile zos125 --host zos125 --port 1443
-
-Create a zosmf profile called 'zos126' to connect to z/OSMF -on the default port 443 and allow self-signed certificates, not specifying a -username, password, or host so they are not stored on disk; these will need to -be specified on every command:
--
-
zowe profiles create zosmf-profile zos126 --reject-unauthorized false
-
-Create a zosmf profile called 'zos124' to connect to z/OSMF -at the host zos124 (default port - 443) and allow self-signed certificates:
--
-
zowe profiles create zosmf-profile zosAPIML --host zosAPIML --port 2020 --user ibmuser --password myp4ss --reject-unauthorized false --base-path basePath
-
-
zowe › profiles › delete
-Delete existing profiles.
-zowe › profiles › delete › base-profile
-Delete a base profile. You must specify a profile name to be deleted. To find -a list of available profiles for deletion, issue the profiles list command. By -default, you will be prompted to confirm the profile removal.
-Usage
-zowe profiles delete base-profile <profileName> [options]
-Positional Arguments
--
-
-profileName(string)-
-
- Specifies the name of the base profile to be deleted. You can also load this -profile by using the name on commands that support the "--base-profile" -option. -
-
Options
--
-
---force(boolean)-
-
- Force deletion of profile, and dependent profiles if specified. No prompt will -be displayed before deletion occurs. -
-
Examples
--
-
Delete a base profile named profilename:
--
-
zowe profiles delete base-profile profilename
-
-
zowe › profiles › delete › cics-profile
-Delete a cics profile. You must specify a profile name to be deleted. To find -a list of available profiles for deletion, issue the profiles list command. By -default, you will be prompted to confirm the profile removal.
-Usage
-zowe profiles delete cics-profile <profileName> [options]
-Positional Arguments
--
-
-profileName(string)-
-
- Specifies the name of the cics profile to be deleted. You can also load this -profile by using the name on commands that support the "--cics-profile" -option. -
-
Options
--
-
---force(boolean)-
-
- Force deletion of profile, and dependent profiles if specified. No prompt will -be displayed before deletion occurs. -
-
Examples
--
-
Delete a cics profile named profilename:
--
-
zowe profiles delete cics-profile profilename
-
-
zowe › profiles › delete › db2-profile
-Delete a db2 profile. You must specify a profile name to be deleted. To find a -list of available profiles for deletion, issue the profiles list command. By -default, you will be prompted to confirm the profile removal.
-Usage
-zowe profiles delete db2-profile <profileName> [options]
-Positional Arguments
--
-
-profileName(string)-
-
- Specifies the name of the db2 profile to be deleted. You can also load this -profile by using the name on commands that support the "--db2-profile" -option. -
-
Options
--
-
---force(boolean)-
-
- Force deletion of profile, and dependent profiles if specified. No prompt will -be displayed before deletion occurs. -
-
Examples
--
-
Delete a db2 profile named profilename:
--
-
zowe profiles delete db2-profile profilename
-
-
zowe › profiles › delete › ims-profile
-Delete a ims profile. You must specify a profile name to be deleted. To find a -list of available profiles for deletion, issue the profiles list command. By -default, you will be prompted to confirm the profile removal.
-Usage
-zowe profiles delete ims-profile <profileName> [options]
-Positional Arguments
--
-
-profileName(string)-
-
- Specifies the name of the ims profile to be deleted. You can also load this -profile by using the name on commands that support the "--ims-profile" -option. -
-
Options
--
-
---force(boolean)-
-
- Force deletion of profile, and dependent profiles if specified. No prompt will -be displayed before deletion occurs. -
-
Examples
--
-
Delete a ims profile named profilename:
--
-
zowe profiles delete ims-profile profilename
-
-
zowe › profiles › delete › mq-profile
-Delete a mq profile. You must specify a profile name to be deleted. To find a -list of available profiles for deletion, issue the profiles list command. By -default, you will be prompted to confirm the profile removal.
-Usage
-zowe profiles delete mq-profile <profileName> [options]
-Positional Arguments
--
-
-profileName(string)-
-
- Specifies the name of the mq profile to be deleted. You can also load this -profile by using the name on commands that support the "--mq-profile" -option. -
-
Options
--
-
---force(boolean)-
-
- Force deletion of profile, and dependent profiles if specified. No prompt will -be displayed before deletion occurs. -
-
Examples
--
-
Delete a mq profile named profilename:
--
-
zowe profiles delete mq-profile profilename
-
-
zowe › profiles › delete › ssh-profile
-Delete a ssh profile. You must specify a profile name to be deleted. To find a -list of available profiles for deletion, issue the profiles list command. By -default, you will be prompted to confirm the profile removal.
-Usage
-zowe profiles delete ssh-profile <profileName> [options]
-Positional Arguments
--
-
-profileName(string)-
-
- Specifies the name of the ssh profile to be deleted. You can also load this -profile by using the name on commands that support the "--ssh-profile" -option. -
-
Options
--
-
---force(boolean)-
-
- Force deletion of profile, and dependent profiles if specified. No prompt will -be displayed before deletion occurs. -
-
Examples
--
-
Delete a ssh profile named profilename:
--
-
zowe profiles delete ssh-profile profilename
-
-
zowe › profiles › delete › tso-profile
-Delete a tso profile. You must specify a profile name to be deleted. To find a -list of available profiles for deletion, issue the profiles list command. By -default, you will be prompted to confirm the profile removal.
-Usage
-zowe profiles delete tso-profile <profileName> [options]
-Positional Arguments
--
-
-profileName(string)-
-
- Specifies the name of the tso profile to be deleted. You can also load this -profile by using the name on commands that support the "--tso-profile" -option. -
-
Options
--
-
---force(boolean)-
-
- Force deletion of profile, and dependent profiles if specified. No prompt will -be displayed before deletion occurs. -
-
Examples
--
-
Delete a tso profile named profilename:
--
-
zowe profiles delete tso-profile profilename
-
-
zowe › profiles › delete › zftp-profile
-Delete a zftp profile. You must specify a profile name to be deleted. To find -a list of available profiles for deletion, issue the profiles list command. By -default, you will be prompted to confirm the profile removal.
-Usage
-zowe profiles delete zftp-profile <profileName> [options]
-Positional Arguments
--
-
-profileName(string)-
-
- Specifies the name of the zftp profile to be deleted. You can also load this -profile by using the name on commands that support the "--zftp-profile" -option. -
-
Options
--
-
---force(boolean)-
-
- Force deletion of profile, and dependent profiles if specified. No prompt will -be displayed before deletion occurs. -
-
Examples
--
-
Delete a zftp profile named profilename:
--
-
zowe profiles delete zftp-profile profilename
-
-
zowe › profiles › delete › zosmf-profile
-Delete a zosmf profile. You must specify a profile name to be deleted. To find -a list of available profiles for deletion, issue the profiles list command. By -default, you will be prompted to confirm the profile removal.
-Usage
-zowe profiles delete zosmf-profile <profileName> [options]
-Positional Arguments
--
-
-profileName(string)-
-
- Specifies the name of the zosmf profile to be deleted. You can also load this -profile by using the name on commands that support the "--zosmf-profile" -option. -
-
Options
--
-
---force(boolean)-
-
- Force deletion of profile, and dependent profiles if specified. No prompt will -be displayed before deletion occurs. -
-
Examples
--
-
Delete a zosmf profile named profilename:
--
-
zowe profiles delete zosmf-profile profilename
-
-
zowe › profiles › list
-List profiles of the type {{type}}
-zowe › profiles › list › base-profiles
-Base profile that stores values shared by multiple service profiles
-Usage
-zowe profiles list base-profiles [options]
-Options
--
-
---show-contents|--sc(boolean)-
-
- List base profiles and their contents. All profile details will be printed as -part of command output. -
-
Examples
--
-
List profiles of type base:
--
-
zowe profiles list base-profiles
-
-List profiles of type base and display their contents:
--
-
zowe profiles list base-profiles --sc
-
-
zowe › profiles › list › cics-profiles
-A cics profile is required to issue commands in the cics command group that -interact with CICS regions. The cics profile contains your host, port, user -name, and password for the IBM CICS management client interface (CMCI) server of -your choice.
-Usage
-zowe profiles list cics-profiles [options]
-Options
--
-
---show-contents|--sc(boolean)-
-
- List cics profiles and their contents. All profile details will be printed as -part of command output. -
-
Examples
--
-
List profiles of type cics:
--
-
zowe profiles list cics-profiles
-
-List profiles of type cics and display their contents:
--
-
zowe profiles list cics-profiles --sc
-
-
zowe › profiles › list › db2-profiles
-A profile for interaction with Db2 for the z/OS region
-Usage
-zowe profiles list db2-profiles [options]
-Options
--
-
---show-contents|--sc(boolean)-
-
- List db2 profiles and their contents. All profile details will be printed as -part of command output. -
-
Examples
--
-
List profiles of type db2:
--
-
zowe profiles list db2-profiles
-
-List profiles of type db2 and display their contents:
--
-
zowe profiles list db2-profiles --sc
-
-
zowe › profiles › list › ims-profiles
-An ims profile is used to issue commands in the ims command group that interact -with IMS regions. The ims profile contains your IMS Operations API web server -host, port, user name and password, IMS Connect host and port and IMS plex -name.
-Usage
-zowe profiles list ims-profiles [options]
-Options
--
-
---show-contents|--sc(boolean)-
-
- List ims profiles and their contents. All profile details will be printed as -part of command output. -
-
Examples
--
-
List profiles of type ims:
--
-
zowe profiles list ims-profiles
-
-List profiles of type ims and display their contents:
--
-
zowe profiles list ims-profiles --sc
-
-
zowe › profiles › list › mq-profiles
-An MQREST profile is required to issue commands in the MQ command group that -interacts with MQSC. The mq profile contains your host, port, user name, and -password for the IBM MQ System Console interface
-Usage
-zowe profiles list mq-profiles [options]
-Options
--
-
---show-contents|--sc(boolean)-
-
- List mq profiles and their contents. All profile details will be printed as -part of command output. -
-
Examples
--
-
List profiles of type mq:
--
-
zowe profiles list mq-profiles
-
-List profiles of type mq and display their contents:
--
-
zowe profiles list mq-profiles --sc
-
-
zowe › profiles › list › ssh-profiles
-z/OS SSH Profile
-Usage
-zowe profiles list ssh-profiles [options]
-Options
--
-
---show-contents|--sc(boolean)-
-
- List ssh profiles and their contents. All profile details will be printed as -part of command output. -
-
Examples
--
-
List profiles of type ssh:
--
-
zowe profiles list ssh-profiles
-
-List profiles of type ssh and display their contents:
--
-
zowe profiles list ssh-profiles --sc
-
-
zowe › profiles › list › tso-profiles
-z/OS TSO/E User Profile
-Usage
-zowe profiles list tso-profiles [options]
-Options
--
-
---show-contents|--sc(boolean)-
-
- List tso profiles and their contents. All profile details will be printed as -part of command output. -
-
Examples
--
-
List profiles of type tso:
--
-
zowe profiles list tso-profiles
-
-List profiles of type tso and display their contents:
--
-
zowe profiles list tso-profiles --sc
-
-
zowe › profiles › list › zftp-profiles
-Configuration profile for z/OS FTP
-Usage
-zowe profiles list zftp-profiles [options]
-Options
--
-
---show-contents|--sc(boolean)-
-
- List zftp profiles and their contents. All profile details will be printed as -part of command output. -
-
Examples
--
-
List profiles of type zftp:
--
-
zowe profiles list zftp-profiles
-
-List profiles of type zftp and display their contents:
--
-
zowe profiles list zftp-profiles --sc
-
-
zowe › profiles › list › zosmf-profiles
-z/OSMF Profile
-Usage
-zowe profiles list zosmf-profiles [options]
-Options
--
-
---show-contents|--sc(boolean)-
-
- List zosmf profiles and their contents. All profile details will be printed as -part of command output. -
-
Examples
--
-
List profiles of type zosmf:
--
-
zowe profiles list zosmf-profiles
-
-List profiles of type zosmf and display their contents:
--
-
zowe profiles list zosmf-profiles --sc
-
-
zowe › profiles › set-default
-Set which profiles are loaded by default.
-zowe › profiles › set-default › base-profile
-The base set default-profiles command allows you to set the default profiles -for this command group. When a base command is issued and no profile override -options are specified, the default profiles for the command group are -automatically loaded for the command based on the commands profile -requirements.
-Usage
-zowe profiles set-default base-profile <profileName> [options]
-Positional Arguments
--
-
-profileName(string)-
-
- Specify a -profile for default usage within the base group. When you issue commands within -the base group without a profile specified as part of the command, the default -will be loaded instead. -
-
Examples
--
-
Set the default profile for type base to the profile named -'profilename':
--
-
zowe profiles set-default base-profile profilename
-
-
zowe › profiles › set-default › cics-profile
-The cics set default-profiles command allows you to set the default profiles -for this command group. When a cics command is issued and no profile override -options are specified, the default profiles for the command group are -automatically loaded for the command based on the commands profile -requirements.
-Usage
-zowe profiles set-default cics-profile <profileName> [options]
-Positional Arguments
--
-
-profileName(string)-
-
- Specify a -profile for default usage within the cics group. When you issue commands within -the cics group without a profile specified as part of the command, the default -will be loaded instead. -
-
Examples
--
-
Set the default profile for type cics to the profile named -'profilename':
--
-
zowe profiles set-default cics-profile profilename
-
-
zowe › profiles › set-default › db2-profile
-The db2 set default-profiles command allows you to set the default profiles for -this command group. When a db2 command is issued and no profile override -options are specified, the default profiles for the command group are -automatically loaded for the command based on the commands profile -requirements.
-Usage
-zowe profiles set-default db2-profile <profileName> [options]
-Positional Arguments
--
-
-profileName(string)-
-
- Specify a -profile for default usage within the db2 group. When you issue commands within -the db2 group without a profile specified as part of the command, the default -will be loaded instead. -
-
Examples
--
-
Set the default profile for type db2 to the profile named -'profilename':
--
-
zowe profiles set-default db2-profile profilename
-
-
zowe › profiles › set-default › ims-profile
-The ims set default-profiles command allows you to set the default profiles for -this command group. When a ims command is issued and no profile override -options are specified, the default profiles for the command group are -automatically loaded for the command based on the commands profile -requirements.
-Usage
-zowe profiles set-default ims-profile <profileName> [options]
-Positional Arguments
--
-
-profileName(string)-
-
- Specify a -profile for default usage within the ims group. When you issue commands within -the ims group without a profile specified as part of the command, the default -will be loaded instead. -
-
Examples
--
-
Set the default profile for type ims to the profile named -'profilename':
--
-
zowe profiles set-default ims-profile profilename
-
-
zowe › profiles › set-default › mq-profile
-The mq set default-profiles command allows you to set the default profiles for -this command group. When a mq command is issued and no profile override options -are specified, the default profiles for the command group are automatically -loaded for the command based on the commands profile requirements.
-Usage
-zowe profiles set-default mq-profile <profileName> [options]
-Positional Arguments
--
-
-profileName(string)-
-
- Specify a -profile for default usage within the mq group. When you issue commands within -the mq group without a profile specified as part of the command, the default -will be loaded instead. -
-
Examples
--
-
Set the default profile for type mq to the profile named -'profilename':
--
-
zowe profiles set-default mq-profile profilename
-
-
zowe › profiles › set-default › ssh-profile
-The ssh set default-profiles command allows you to set the default profiles for -this command group. When a ssh command is issued and no profile override -options are specified, the default profiles for the command group are -automatically loaded for the command based on the commands profile -requirements.
-Usage
-zowe profiles set-default ssh-profile <profileName> [options]
-Positional Arguments
--
-
-profileName(string)-
-
- Specify a -profile for default usage within the ssh group. When you issue commands within -the ssh group without a profile specified as part of the command, the default -will be loaded instead. -
-
Examples
--
-
Set the default profile for type ssh to the profile named -'profilename':
--
-
zowe profiles set-default ssh-profile profilename
-
-
zowe › profiles › set-default › tso-profile
-The tso set default-profiles command allows you to set the default profiles for -this command group. When a tso command is issued and no profile override -options are specified, the default profiles for the command group are -automatically loaded for the command based on the commands profile -requirements.
-Usage
-zowe profiles set-default tso-profile <profileName> [options]
-Positional Arguments
--
-
-profileName(string)-
-
- Specify a -profile for default usage within the tso group. When you issue commands within -the tso group without a profile specified as part of the command, the default -will be loaded instead. -
-
Examples
--
-
Set the default profile for type tso to the profile named -'profilename':
--
-
zowe profiles set-default tso-profile profilename
-
-
zowe › profiles › set-default › zftp-profile
-The zftp set default-profiles command allows you to set the default profiles -for this command group. When a zftp command is issued and no profile override -options are specified, the default profiles for the command group are -automatically loaded for the command based on the commands profile -requirements.
-Usage
-zowe profiles set-default zftp-profile <profileName> [options]
-Positional Arguments
--
-
-profileName(string)-
-
- Specify a -profile for default usage within the zftp group. When you issue commands within -the zftp group without a profile specified as part of the command, the default -will be loaded instead. -
-
Examples
--
-
Set the default profile for type zftp to the profile named -'profilename':
--
-
zowe profiles set-default zftp-profile profilename
-
-
zowe › profiles › set-default › zosmf-profile
-The zosmf set default-profiles command allows you to set the default profiles -for this command group. When a zosmf command is issued and no profile override -options are specified, the default profiles for the command group are -automatically loaded for the command based on the commands profile -requirements.
-Usage
-zowe profiles set-default zosmf-profile <profileName> [options]
-Positional Arguments
--
-
-profileName(string)-
-
- Specify a -profile for default usage within the zosmf group. When you issue commands -within the zosmf group without a profile specified as part of the command, the -default will be loaded instead. -
-
Examples
--
-
Set the default profile for type zosmf to the profile named -'profilename':
--
-
zowe profiles set-default zosmf-profile profilename
-
-
zowe › profiles › update
-Update a {{type}} profile. You can update any property present within the -profile configuration. The updated profile will be printed so that you can -review the result of the updates.
-zowe › profiles › update › base-profile
-Base profile that stores values shared by multiple service profiles
-Usage
-zowe profiles update base-profile <profileName> [options]
-Positional Arguments
--
-
-profileName(string)-
-
- Specifies the name of the new base profile. You can load this profile by using -the name on commands that support the "--base-profile" option. -
-
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)-
-
- Reject self-signed certificates. -
-
---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. -
-
Examples
--
-
Update a base profile named 'base1' with a new username and -password:
--
-
zowe profiles update base-profile base1 --user newuser --password newp4ss
-
-
zowe › profiles › update › cics-profile
-A cics profile is required to issue commands in the cics command group that -interact with CICS regions. The cics profile contains your host, port, user -name, and password for the IBM CICS management client interface (CMCI) server of -your choice.
-Usage
-zowe profiles update cics-profile <profileName> [options]
-Positional Arguments
--
-
-profileName(string)-
-
- Specifies the name of the new cics profile. You can load this profile by using -the name on commands that support the "--cics-profile" option. -
-
Options
--
-
---host|-H(string)-
-
- The CMCI server host name -
-
---port|-P(number)-
-
- The CMCI server port -
-
---user|-u(string)-
-
- Your username to connect to CICS -
-
---password|-p(string)-
-
- Your password to connect to CICS -
-
---region-name(string)-
-
- The name of the CICS region name to interact with -
-
---cics-plex(string)-
-
- The name of the CICSPlex to interact with -
-
Cics Connection Options
--
-
---reject-unauthorized|--ru(boolean)-
-
- Reject self-signed certificates. -
-
---protocol|-o(string)-
-
Specifies CMCI protocol (http or https).
-Allowed values: http, https
-
-
-
zowe › profiles › update › db2-profile
-A profile for interaction with Db2 for the z/OS region
-Usage
-zowe profiles update db2-profile <profileName> [options]
-Positional Arguments
--
-
-profileName(string)-
-
- Specifies the name of the new db2 profile. You can load this profile by using -the name on commands that support the "--db2-profile" option. -
-
Options
--
-
---host|-H(string)-
-
- The Db2 server host name -
-
---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|-d(string)-
-
- The name of the database -
-
---ssl-file|-s(string)-
-
- Path to an SSL Certificate file -
-
zowe › profiles › update › ims-profile
-An ims profile is used to issue commands in the ims command group that interact -with IMS regions. The ims profile contains your IMS Operations API web server -host, port, user name and password, IMS Connect host and port and IMS plex -name.
-Usage
-zowe profiles update ims-profile <profileName> [options]
-Positional Arguments
--
-
-profileName(string)-
-
- Specifies the name of the new ims profile. You can load this profile by using -the name on commands that support the "--ims-profile" option. -
-
IMS Connection Options
--
-
---host|-H(string)-
-
- The IMS Operations API server host name. -
-
---port|-P(number)-
-
- The IMS Operations API server port. -
-
---ims-connect-host|--ich(string)-
-
- The hostname of your instance of IMS Connect. This is typically the hostname of -the mainframe LPAR where IMS Connect is running. -
-
---ims-connect-port|--icp(number)-
-
- The port of your instance of IMS Connect. This port can be found in your IMS -Connect configuration file on the mainframe. -
-
---plex|-x(string)-
-
- The name of the IMS plex. -
-
---user|-u(string)-
-
- The web server user name where the IMS Operations API resides. -
-
---password|--pass(string)-
-
- The web server user password where the IMS Operations API resides. -
-
---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. -
-
zowe › profiles › update › mq-profile
-An MQREST profile is required to issue commands in the MQ command group that -interacts with MQSC. The mq profile contains your host, port, user name, and -password for the IBM MQ System Console interface
-Usage
-zowe profiles update mq-profile <profileName> [options]
-Positional Arguments
--
-
-profileName(string)-
-
- Specifies the name of the new mq profile. You can load this profile by using -the name on commands that support the "--mq-profile" option. -
-
Options
--
-
---host|-H(string)-
-
- The MQ Rest server host name -
-
---port|-P(number)-
-
- Port number of your MQ REST API server -
-
---user|-u(string)-
-
- User name to authenticate to your MQ REST API server -
-
---password|-p(string)-
-
- Password to authenticate to your MQ REST API server -
-
MQ Connection Options
--
-
---reject-unauthorized|--ru(boolean)-
-
- Reject self-signed certificates. -
-
---protocol|-o(string)-
-
Specifies the MQ protocol (http or https).
-Allowed values: http, https
-
-
-
zowe › profiles › update › ssh-profile
-z/OS SSH Profile
-Usage
-zowe profiles update ssh-profile <profileName> [options]
-Positional Arguments
--
-
-profileName(string)-
-
- Specifies the name of the new ssh profile. You can load this profile by using -the name on commands that support the "--ssh-profile" option. -
-
z/OS Ssh Connection Options
--
-
---host|-H(string)-
-
- The z/OS SSH server host name. -
-
---port|-P(number)-
-
- The z/OS SSH server port. -
-
---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. -
-
zowe › profiles › update › tso-profile
-z/OS TSO/E User Profile
-Usage
-zowe profiles update tso-profile <profileName> [options]
-Positional Arguments
--
-
-profileName(string)-
-
- Specifies the name of the new tso profile. You can load this profile by using -the name on commands that support the "--tso-profile" option. -
-
TSO ADDRESS SPACE OPTIONS
--
-
---account|-a(string)-
-
- Your z/OS TSO/E accounting information. -
-
---character-set|--cs(string)-
-
- Character set for address space to convert messages and responses from UTF-8 to -EBCDIC. -
-
---code-page|--cp(string)-
-
- Codepage value for TSO/E address space to convert messages and responses from -UTF-8 to EBCDIC. -
-
---columns|--cols(number)-
-
- The number of columns on a screen. -
-
---logon-procedure|-l(string)-
-
- The logon procedure to use when creating TSO procedures on your behalf. -
-
---region-size|--rs(number)-
-
- Region size for the TSO/E address space. -
-
---rows(number)-
-
- The number of rows on a screen. -
-
Examples
--
-
Update a tso profile called myprof with new JES accounting -information:
--
-
zowe profiles update tso-profile myprof -a NEWACCT
-
-
zowe › profiles › update › zftp-profile
-Configuration profile for z/OS FTP
-Usage
-zowe profiles update zftp-profile <profileName> [options]
-Positional Arguments
--
-
-profileName(string)-
-
- Specifies the name of the new zftp profile. You can load this profile by using -the name on commands that support the "--zftp-profile" option. -
-
Options
--
-
---host|-H(string)-
-
- The hostname or IP address of the z/OS server to connect to. -
-
---port|-P(number)-
-
- The port of the z/OS FTP server. -
-
---user|-u(string)-
-
- Username for authentication on z/OS -
-
---password|-p|--pass|--pw(string)-
-
- Password to authenticate to FTP. -
-
---secure-ftp(boolean)-
-
- Set to true for both control and data connection encryption, 'control' for -control connection encryption only, or 'implicit' for implicitly encrypted -control connection (this mode is deprecated in modern times, but usually uses -port 990). Note: Unfortunately, this plugin's functionality only works with FTP -and FTPS, not 'SFTP' which is FTP over SSH. -
-
---connection-timeout|--ct(number)-
-
- How long (in milliseconds) to wait for the control connection to be -established. -
-
TLS / Secure Connection options
--
-
---reject-unauthorized|--ru(boolean)-
-
- Reject self-signed certificates. Only specify this if you are connecting to a -secure FTP instance. -
-
---server-name|--sn(string)-
-
- Server name for the SNI (Server Name Indication) TLS extension. Only specify if -you are connecting securely -
-
zowe › profiles › update › zosmf-profile
-z/OSMF Profile
-Usage
-zowe profiles update zosmf-profile <profileName> [options]
-Positional Arguments
--
-
-profileName(string)-
-
- Specifies the name of the new zosmf profile. You can load this profile by using -the name on commands that support the "--zosmf-profile" option. -
-
Zosmf Connection Options
--
-
---host|-H(string)-
-
- The z/OSMF server host name. -
-
---port|-P(number)-
-
- The z/OSMF server port. -
-
---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)-
-
- Reject self-signed certificates. -
-
---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. -
-
Options
--
-
---encoding|--ec(number)-
-
- The encoding for download and upload of z/OS data set and USS files. The -default encoding if not specified is 1047. -
-
---responseTimeout|--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 -
-
Examples
--
-
Update a zosmf profile named 'zos123' with a new username -and password:
--
-
zowe profiles update zosmf-profile zos123 --user newuser --password newp4ss
-
-
-
zowe › provisioning
-Perform z/OSMF provisioning tasks on Published Templates in the Service Catalog -and Provisioned Instances in the Service Registry.
-zowe › provisioning › delete
-Deletes instance previously provisioned with z/OSMF cloud provisioning -services.
-zowe › provisioning › delete › instance
-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)-
-
Reject self-signed certificates.
-Default value: true
-
-
-
---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. -
-
Profile Options
--
-
---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
--
-
---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. -
-
Examples
--
-
Delete deprovisioned instance "instance1":
--
-
zowe provisioning delete instance instance1
-
-
zowe › provisioning › list
-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.
-zowe › provisioning › list › catalog-templates
-Lists the z/OSMF service catalog published templates.
-Usage
-zowe provisioning list catalog-templates [options]
-Options
--
-
---all-info|--ai(boolean)-
-
- Display information about published z/OSMF service catalog templates (summary -information is printed by default). -
-
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)-
-
Reject self-signed certificates.
-Default value: true
-
-
-
---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. -
-
Profile Options
--
-
---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
--
-
---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. -
-
Examples
--
-
List all published templates in the z/OSMF service catalog -(with full detail):
--
-
zowe provisioning list catalog-templates --all-info
-
-
zowe › provisioning › list › instance-info
-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, fullZosmf 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)-
-
Reject self-signed certificates.
-Default value: true
-
-
-
---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. -
-
Profile Options
--
-
---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
--
-
---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. -
-
Examples
--
-
List summary information with a list of actions for an -instance with the name "instance1":
--
-
zowe provisioning list instance-info instance1
-
-Show extended general information with actions for a -provisioned instance with the name "instance1":
--
-
zowe provisioning list instance-info instance1 --display extended
-
-
zowe › provisioning › list › instance-variables
-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)-
-
Reject self-signed certificates.
-Default value: true
-
-
-
---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. -
-
Profile Options
--
-
---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
--
-
---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. -
-
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 instance variables of "instance1":
--
-
zowe provisioning list instance-variables instance1
-
-
zowe › provisioning › list › registry-instances
-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)-
-
Reject self-signed certificates.
-Default value: true
-
-
-
---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. -
-
Profile Options
--
-
---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
--
-
---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. -
-
Examples
--
-
List all provisioned instances (with full detail):
--
-
zowe provisioning list registry-instances --all-info
-
-
zowe › provisioning › list › template-info
-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
--
-
---all-info|--ai(boolean)-
-
- Display detailed information about published z/OSMF service catalog template -(summary information is printed by default). -
-
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)-
-
Reject self-signed certificates.
-Default value: true
-
-
-
---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. -
-
Profile Options
--
-
---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
--
-
---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. -
-
Examples
--
-
List summary information for template "template1":
--
-
zowe provisioning list template-info template1
-
-
zowe › provisioning › perform
-Perform actions against instances provisioned with z/OSMF.
-zowe › provisioning › perform › action
-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)-
-
Reject self-signed certificates.
-Default value: true
-
-
-
---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. -
-
Profile Options
--
-
---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
--
-
---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. -
-
Examples
--
-
Perform the "start" action on the provisioned instance -"instance1":
--
-
zowe provisioning perform action instance1 start
-
-
zowe › provisioning › provision
-Using z/OSMF cloud provisioning services provision available templates.
-zowe › provisioning › provision › template
-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)-
-
Reject self-signed certificates.
-Default value: true
-
-
-
---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. -
-
Profile Options
--
-
---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
--
-
---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. -
-
Examples
--
-
Provision a published software service template.:
--
-
zowe provisioning provision template template1
-
-
-
zowe › secure-credential-store
-Store credentials securely in profiles by encrypting them
-zowe › secure-credential-store › revert
-Reverts all secure profiles to be stored in plain text
-Usage
-zowe secure-credential-store revert [options]
-Required Options
--
-
---for-sure|-f(boolean)-
-
- Specify this option to confirm that you want to revert all credentials to be -stored insecurely. -
-
zowe › secure-credential-store › update
-Updates all plain text profiles to be securely stored
-Usage
-zowe secure-credential-store update [options]
--
zowe › zos-console
-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.
-zowe › zos-console › collect
-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.
-zowe › zos-console › collect › sync-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\]\+$
-
-- 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:
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]+$
-
-
-
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)-
-
Reject self-signed certificates.
-Default value: true
-
-
-
---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. -
-
Profile Options
--
-
---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
--
-
---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. -
-
Examples
--
-
Collect any outstanding additional solicited response -messages:
--
-
zowe zos-console collect sync-responses C4866969
-
-
zowe › zos-console › issue
-Issue z/OS console commands and optionally collect responses.
-zowe › zos-console › issue › command
-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)-
-
Number of request attempts if no response returned
-Default value: 1
-
-
-
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)-
-
Reject self-signed certificates.
-Default value: true
-
-
-
---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. -
-
Profile Options
--
-
---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
--
-
---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. -
-
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"
-
-
-
zowe › zos-files
-Manage z/OS data sets, create data sets, and more
-zowe › zos-files › copy
-Copy a data set
-zowe › zos-files › copy › data-set
-Copy a data set to another 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 (data set must be -preallocated) -
-
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)-
-
Reject self-signed certificates.
-Default value: true
-
-
-
---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. -
-
Options
--
-
---responseTimeout|--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 -
-
Profile Options
--
-
---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
--
-
---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. -
-
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"
-
-
zowe › zos-files › create
-Create data sets
-zowe › zos-files › create › data-set-binary
-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
--
-
---block-size|--bs(number)-
-
The block size for the data set (for example, 6160)
-Default value: 27998
-
-
-
---data-class|--dc(string)-
-
- The SMS data class to use for the allocation -
-
---data-set-type|--dst(string)-
-
- The data set type -
-
---device-type|--dt(string)-
-
- The device type, also known as 'unit' -
-
---directory-blocks|--db(number)-
-
The number of directory blocks (for example, 25)
-Default value: 25
-
-
-
---management-class|--mc(string)-
-
- The SMS management class to use for the allocation -
-
---primary-space|--ps(number)-
-
The primary space allocation (for example, 5)
-Default value: 10
-
-
-
---record-format|--rf(string)-
-
The record format for the data set (for example, FB for "Fixed Block")
-Default value: U
-
-
-
---record-length|--rl(number)-
-
The logical record length. Analogous to the length of a line (for example, 80)
-Default value: 27998
-
-
-
---secondary-space|--ss(number)-
-
- The secondary space allocation (for example, 1) -
-
---show-attributes|--pa(boolean)-
-
- Show the full allocation attributes -
-
---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(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. -
-
---responseTimeout|--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)-
-
Reject self-signed certificates.
-Default value: true
-
-
-
---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. -
-
Profile Options
--
-
---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
--
-
---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. -
-
Examples
--
-
Create an empty binary partitioned data set (PDS) with -default parameters:
--
-
zowe zos-files create data-set-binary NEW.BINARY.DATASET
-
-
zowe › zos-files › create › data-set-c
-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
--
-
---block-size|--bs(number)-
-
The block size for the data set (for example, 6160)
-Default value: 32760
-
-
-
---data-class|--dc(string)-
-
- The SMS data class to use for the allocation -
-
---data-set-type|--dst(string)-
-
- The data set type -
-
---device-type|--dt(string)-
-
- The device type, also known as 'unit' -
-
---directory-blocks|--db(number)-
-
The number of directory blocks (for example, 25)
-Default value: 25
-
-
-
---management-class|--mc(string)-
-
- The SMS management class to use for the allocation -
-
---primary-space|--ps(number)-
-
The primary space allocation (for example, 5)
-Default value: 1
-
-
-
---record-format|--rf(string)-
-
The record format for the data set (for example, FB for "Fixed Block")
-Default value: VB
-
-
-
---record-length|--rl(number)-
-
The logical record length. Analogous to the length of a line (for example, 80)
-Default value: 260
-
-
-
---secondary-space|--ss(number)-
-
- The secondary space allocation (for example, 1) -
-
---show-attributes|--pa(boolean)-
-
- Show the full allocation attributes -
-
---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(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. -
-
---responseTimeout|--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)-
-
Reject self-signed certificates.
-Default value: true
-
-
-
---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. -
-
Profile Options
--
-
---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
--
-
---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. -
-
Examples
--
-
Create an empty C code PDS with default parameters:
--
-
zowe zos-files create data-set-c NEW.CCODE.DATASET
-
-
zowe › zos-files › create › data-set-classic
-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
--
-
---block-size|--bs(number)-
-
The block size for the data set (for example, 6160)
-Default value: 6160
-
-
-
---data-class|--dc(string)-
-
- The SMS data class to use for the allocation -
-
---data-set-type|--dst(string)-
-
- The data set type -
-
---device-type|--dt(string)-
-
- The device type, also known as 'unit' -
-
---directory-blocks|--db(number)-
-
The number of directory blocks (for example, 25)
-Default value: 25
-
-
-
---management-class|--mc(string)-
-
- The SMS management class to use for the allocation -
-
---primary-space|--ps(number)-
-
The primary space allocation (for example, 5)
-Default value: 1
-
-
-
---record-format|--rf(string)-
-
The record format for the data set (for example, FB for "Fixed Block")
-Default value: FB
-
-
-
---record-length|--rl(number)-
-
The logical record length. Analogous to the length of a line (for example, 80)
-Default value: 80
-
-
-
---secondary-space|--ss(number)-
-
- The secondary space allocation (for example, 1) -
-
---show-attributes|--pa(boolean)-
-
- Show the full allocation attributes -
-
---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(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. -
-
---responseTimeout|--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)-
-
Reject self-signed certificates.
-Default value: true
-
-
-
---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. -
-
Profile Options
--
-
---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
--
-
---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. -
-
Examples
--
-
Create an empty z/OS 'classic' PDS with default parameters:
--
-
zowe zos-files create data-set-classic NEW.CLASSIC.DATASET
-
-
zowe › zos-files › create › data-set-partitioned
-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
--
-
---block-size|--bs(number)-
-
The block size for the data set (for example, 6160)
-Default value: 6160
-
-
-
---data-class|--dc(string)-
-
- The SMS data class to use for the allocation -
-
---data-set-type|--dst(string)-
-
- The data set type -
-
---device-type|--dt(string)-
-
- The device type, also known as 'unit' -
-
---directory-blocks|--db(number)-
-
The number of directory blocks (for example, 25)
-Default value: 5
-
-
-
---management-class|--mc(string)-
-
- The SMS management class to use for the allocation -
-
---primary-space|--ps(number)-
-
The primary space allocation (for example, 5)
-Default value: 1
-
-
-
---record-format|--rf(string)-
-
The record format for the data set (for example, FB for "Fixed Block")
-Default value: FB
-
-
-
---record-length|--rl(number)-
-
The logical record length. Analogous to the length of a line (for example, 80)
-Default value: 80
-
-
-
---secondary-space|--ss(number)-
-
- The secondary space allocation (for example, 1) -
-
---show-attributes|--pa(boolean)-
-
- Show the full allocation attributes -
-
---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(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. -
-
---responseTimeout|--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)-
-
Reject self-signed certificates.
-Default value: true
-
-
-
---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. -
-
Profile Options
--
-
---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
--
-
---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. -
-
Examples
--
-
Create an empty PDS with default parameters:
--
-
zowe zos-files create data-set-partitioned NEW.PDS.DATASET
-
-
zowe › zos-files › create › data-set-sequential
-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
--
-
---block-size|--bs(number)-
-
The block size for the data set (for example, 6160)
-Default value: 6160
-
-
-
---data-class|--dc(string)-
-
- The SMS data class to use for the allocation -
-
---device-type|--dt(string)-
-
- The device type, also known as 'unit' -
-
---directory-blocks|--db(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)-
-
The primary space allocation (for example, 5)
-Default value: 1
-
-
-
---record-format|--rf(string)-
-
The record format for the data set (for example, FB for "Fixed Block")
-Default value: FB
-
-
-
---record-length|--rl(number)-
-
The logical record length. Analogous to the length of a line (for example, 80)
-Default value: 80
-
-
-
---secondary-space|--ss(number)-
-
- The secondary space allocation (for example, 1) -
-
---show-attributes|--pa(boolean)-
-
- Show the full allocation attributes -
-
---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(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. -
-
---responseTimeout|--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)-
-
Reject self-signed certificates.
-Default value: true
-
-
-
---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. -
-
Profile Options
--
-
---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
--
-
---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. -
-
Examples
--
-
Create an empty physical sequential data set with default -parameters:
--
-
zowe zos-files create data-set-sequential NEW.PS.DATASET
-
-
zowe › zos-files › create › data-set-vsam
-Create a VSAM cluster
-Usage
-zowe zos-files create data-set-vsam <dataSetName> [options]
-Positional Arguments
--
-
-dataSetName(string)-
-
- The name of the dataset in which to create a VSAM cluster -
-
Options
--
-
---data-class|--dc(string)-
-
- The SMS data class to use for the allocation -
-
---data-set-organization|--dso(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. -
-
---show-attributes|--pa(boolean)-
-
- Show the full allocation attributes -
-
---size|--sz(string)-
-
The primary size to allocate for the VSAM cluster. Specify size as the number -of items to allocate (nItems). You specify the type of item by keyword.
-Default value: 840KB
-
-
-
---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. -
-
---responseTimeout|--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)-
-
Reject self-signed certificates.
-Default value: true
-
-
-
---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. -
-
Profile Options
--
-
---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
--
-
---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. -
-
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 1MB --show-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
-
-
zowe › zos-files › create › uss-directory
-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
--
-
---mode|-m(string)-
-
- Specifies the file permission bits to use when creating the directory. -
-
---responseTimeout|--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)-
-
Reject self-signed certificates.
-Default value: true
-
-
-
---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. -
-
Profile Options
--
-
---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
--
-
---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. -
-
Examples
--
-
Create a USS directory named "testDir" :
--
-
zowe zos-files create uss-directory testDir
-
-Create a USS directory named "testDir" with mode "rwxrwxrwx" -:
--
-
zowe zos-files create uss-directory testDir -m rwxrwxrwx
-
-
zowe › zos-files › create › uss-file
-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
--
-
---mode|-m(string)-
-
- Specifies the file permission bits to use when creating the file. -
-
---responseTimeout|--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)-
-
Reject self-signed certificates.
-Default value: true
-
-
-
---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. -
-
Profile Options
--
-
---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
--
-
---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. -
-
Examples
--
-
Create a USS file named "test.ext" :
--
-
zowe zos-files create uss-file text.txt
-
-Create a USS file named "text.txt" with mode "rwxrwxrwx" :
--
-
zowe zos-files create uss-file text.txt -m rwxrwxrwx
-
-
zowe › zos-files › create › zos-file-system
-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)-
-
The number of primary cylinders to allocate for the ZFS.
-Default value: 10
-
-
-
---cyls-sec|--cs(number)-
-
The number of secondary cylinders to allocate for the ZFS.
-Default value: 2
-
-
-
---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)-
-
The permissions code for the ZFS root directory.
-Default value: 755
-
-
-
---storage-class|--sc(string)-
-
- The SMS storage class to use for the allocation -
-
---timeout|-t(number)-
-
The number of seconds to wait for the underlying "zfsadm format" command to -complete. If this command times out, the ZFS may have been created but not -formatted correctly.
-Default value: 20
-
-
-
---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. -
-
---responseTimeout|--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)-
-
Reject self-signed certificates.
-Default value: true
-
-
-
---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. -
-
Profile Options
--
-
---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
--
-
---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. -
-
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
-
-
zowe › zos-files › delete
-Delete a data set or Unix System Services file
-zowe › zos-files › delete › data-set
-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
--
-
---for-sure|-f(boolean)-
-
- Specify this option to confirm that you want to delete the data set -permanently. -
-
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. -
-
---responseTimeout|--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)-
-
Reject self-signed certificates.
-Default value: true
-
-
-
---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. -
-
Profile Options
--
-
---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
--
-
---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. -
-
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
-
-
zowe › zos-files › delete › data-set-vsam
-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
--
-
---erase|-e(boolean)-
-
Specify this option to overwrite the data component for the cluster with binary -zeros. This option is ignored if the NOERASE attribute was specified when the -cluster was defined or altered.
-Default value: false
-
-
-
---purge|-p(boolean)-
-
Specify this option to delete the VSAM cluster regardless of its retention -period or date.
-Default value: false
-
-
-
---responseTimeout|--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 -
-
Required Options
--
-
---for-sure|-f(boolean)-
-
- Specify this option to confirm that you want to delete the VSAM cluster -permanently. -
-
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)-
-
Reject self-signed certificates.
-Default value: true
-
-
-
---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. -
-
Profile Options
--
-
---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
--
-
---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. -
-
Examples
--
-
Delete the VSAM data set named 'ibmuser.cntl.vsam':
--
-
zowe zos-files delete data-set-vsam "ibmuser.cntl.vsam" -f
-
-Delete all expired VSAM data sets that match -'ibmuser.AAA.**.FFF':
--
-
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
-
-
zowe › zos-files › delete › migrated-data-set
-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
--
-
---wait|-w(boolean)-
-
If true then the function waits for completion of the request. If false -(default) the request is queued.
-Default value: false
-
-
-
---purge|-p(boolean)-
-
If true then the function uses the PURGE=YES on ARCHDEL request. If false -(default) the function uses the PURGE=NO on ARCHDEL request.
-Default value: false
-
-
-
---responseTimeout|--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)-
-
Reject self-signed certificates.
-Default value: true
-
-
-
---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. -
-
Profile Options
--
-
---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
--
-
---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. -
-
Examples
--
-
Delete a migrated data set using default options:
--
-
zowe zos-files delete migrated-data-set "USER.DATA.SET"
-
-
zowe › zos-files › delete › uss-file
-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
--
-
---for-sure|-f(boolean)-
-
- Specify this option to confirm that you want to delete the file or directory -permanently. -
-
Options
--
-
---recursive|-r(boolean)-
-
- Delete directories recursively. -
-
---responseTimeout|--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)-
-
Reject self-signed certificates.
-Default value: true
-
-
-
---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. -
-
Profile Options
--
-
---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
--
-
---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. -
-
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
-
-
zowe › zos-files › delete › zos-file-system
-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
--
-
---for-sure|-f(boolean)-
-
- Specify this option to confirm that you want to delete the ZFS permanently. -
-
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)-
-
Reject self-signed certificates.
-Default value: true
-
-
-
---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. -
-
Options
--
-
---responseTimeout|--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 -
-
Profile Options
--
-
---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
--
-
---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. -
-
Examples
--
-
Delete the z/OS file system 'HLQ.MYNEW.ZFS':
--
-
zowe zos-files delete zos-file-system "HLQ.MYNEW.ZFS" -f
-
-
zowe › zos-files › download
-Download content from z/OS data sets and USS files to your PC
-zowe › zos-files › download › all-members
-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(number)-
-
- 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)-
-
Set this option to false to continue downloading dataset members if one or more -fail.
-Default value: true
-
-
-
---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)-
-
Specifies if the automatically generated directories and files use the original -letter case
-Default value: false
-
-
-
---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. -
-
---responseTimeout|--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)-
-
Reject self-signed certificates.
-Default value: true
-
-
-
---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. -
-
Profile Options
--
-
---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
--
-
---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. -
-
Examples
--
-
Download the members of the data set "ibmuser.loadlib" in -binary mode to the directory "loadlib/":
--
-
zowe zos-files download all-members "ibmuser.loadlib" -b -d loadlib
-
-Download the members of the data set "ibmuser.cntl" in text -mode to the directory "jcl/":
--
-
zowe zos-files download all-members "ibmuser.cntl" -d jcl
-
-
zowe › zos-files › download › data-set
-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(number)-
-
- 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)-
-
Specifies if the automatically generated directories and files use the original -letter case
-Default value: false
-
-
-
---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. -
-
---responseTimeout|--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)-
-
Reject self-signed certificates.
-Default value: true
-
-
-
---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. -
-
Profile Options
--
-
---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
--
-
---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. -
-
Examples
--
-
Download the data set "ibmuser.loadlib(main)" in binary mode -to the local file "main.obj":
--
-
zowe zos-files download data-set "ibmuser.loadlib(main)" -b -f main.obj
-
-
zowe › zos-files › download › uss-file
-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
--
-
---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(number)-
-
- 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. -
-
---responseTimeout|--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)-
-
Reject self-signed certificates.
-Default value: true
-
-
-
---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. -
-
Profile Options
--
-
---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
--
-
---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. -
-
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"
-
-
zowe › zos-files › invoke
-Invoke z/OS utilities such as Access Method Services (AMS)
-zowe › zos-files › invoke › ams-file
-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
--
-
-controlStatementsFile(string)-
-
- The path to a file that contains IDCAMS control statements. Ensure that your -file does not contain statements that are longer than 255 characters (maximum -allowed length). -
-
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)-
-
Reject self-signed certificates.
-Default value: true
-
-
-
---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. -
-
Options
--
-
---responseTimeout|--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 -
-
Profile Options
--
-
---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
--
-
---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. -
-
Examples
--
-
Reads the specified file and submits the controls -statements:
--
-
zowe zos-files invoke ams-file "./path/to/file/MyControlStatements.idcams"
-
-
zowe › zos-files › invoke › ams-statements
-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
--
-
-controlStatements(string)-
-
- The IDCAMS control statement that you want to submit. Zowe CLI attempts to -split the inline control statement at 255 characters. -
-
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)-
-
Reject self-signed certificates.
-Default value: true
-
-
-
---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. -
-
Options
--
-
---responseTimeout|--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 -
-
Profile Options
--
-
---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
--
-
---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. -
-
Examples
--
-
Defines a cluster named 'DUMMY.VSAM.CLUSTER':
--
-
zowe zos-files invoke ams-statements "DEFINE CLUSTER ( NAME (DUMMY.VSAM.CLUSTER) CYL(1 1))"
-
-Deletes a cluster named 'DUMMY.VSAM.CLUSTER':
--
-
zowe zos-files invoke ams-statements "DELETE DUMMY.VSAM.CLUSTER CLUSTER"
-
-
zowe › zos-files › list
-List data sets and data set members. Optionally, you can list their details and -attributes.
-zowe › zos-files › list › all-members
-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. -
-
---responseTimeout|--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)-
-
Reject self-signed certificates.
-Default value: true
-
-
-
---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. -
-
Profile Options
--
-
---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
--
-
---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. -
-
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
-
-
zowe › zos-files › list › data-set
-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. -
-
---responseTimeout|--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)-
-
Reject self-signed certificates.
-Default value: true
-
-
-
---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. -
-
Profile Options
--
-
---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
--
-
---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. -
-
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
-
-
zowe › zos-files › list › file-system
-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
--
-
---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. -
-
---fsname|-f(string)-
-
- Specifies the name of the mounted file system. This option and --path are -mutually exclusive. -
-
---path|-p(string)-
-
- Specifies the path where the file system is mounted. This option and --fsname -are mutually exclusive. -
-
---responseTimeout|--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)-
-
Reject self-signed certificates.
-Default value: true
-
-
-
---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. -
-
Profile Options
--
-
---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
--
-
---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. -
-
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
-
-
zowe › zos-files › list › uss-files
-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
--
-
---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. -
-
---responseTimeout|--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)-
-
Reject self-signed certificates.
-Default value: true
-
-
-
---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. -
-
Profile Options
--
-
---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
--
-
---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. -
-
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
-
-
zowe › zos-files › migrate
-Migrate data sets.
-zowe › zos-files › migrate › data-set
-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
--
-
---wait|-w(boolean)-
-
If true then the function waits for completion of the request. If false -(default) the request is queued.
-Default value: false
-
-
-
---responseTimeout|--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)-
-
Reject self-signed certificates.
-Default value: true
-
-
-
---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. -
-
Profile Options
--
-
---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
--
-
---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. -
-
Examples
--
-
Migrate a data set using default options:
--
-
zowe zos-files migrate data-set "USER.DATA.SET"
-
-
zowe › zos-files › mount
-Mount z/OS UNIX file systems, such as HFS, ZFS, and more. This connects you to -USS file systems.
-zowe › zos-files › mount › file-system
-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
--
-
---fs-type|--ft(string)-
-
Specify the file system type that you are going to mount. The name must match -the TYPE operand on a FILESYSTYPE statement in the BPXPRMxx parmlib member for -the file system.
-Default value: ZFS
-
-
-
---mode|-m(string)-
-
Specify the mode for mounting the file system (rdonly - read-only, rdwr - -read/write).
-Default value: rdonly
-Allowed values: rdonly, rdwr
-
-
-
---responseTimeout|--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)-
-
Reject self-signed certificates.
-Default value: true
-
-
-
---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. -
-
Profile Options
--
-
---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
--
-
---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. -
-
Examples
--
-
Mount a z/OS file system using default options:
--
-
zowe zos-files mount file-system MY.ZFS /a/ibmuser/mountdir
-
-Mount a hierarchical file system with write access:
--
-
zowe zos-files mount file-system MY.HFS /a/ibmuser/mountdir --ft HFS -m rdwr
-
-
zowe › zos-files › recall
-Recall migrated data sets.
-zowe › zos-files › recall › data-set
-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
--
-
---wait|-w(boolean)-
-
If true then the function waits for completion of the request. If false -(default) the request is queued.
-Default value: false
-
-
-
---responseTimeout|--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)-
-
Reject self-signed certificates.
-Default value: true
-
-
-
---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. -
-
Profile Options
--
-
---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
--
-
---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. -
-
Examples
--
-
Recall a data set using default options:
--
-
zowe zos-files recall data-set "USER.DATA.SET"
-
-
zowe › zos-files › rename
-Rename a data set or member.
-zowe › zos-files › rename › data-set
-Rename a data set.
-Usage
-zowe zos-files rename data-set <beforeDataSetName> <afterDataSetName> [options]
-Positional Arguments
--
-
-beforeDataSetName(string)-
-
- The name of the data set that you want to rename. -
-
-afterDataSetName(string)-
-
- The name you want to rename the data set to. -
-
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)-
-
Reject self-signed certificates.
-Default value: true
-
-
-
---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. -
-
Options
--
-
---responseTimeout|--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 -
-
Profile Options
--
-
---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
--
-
---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. -
-
Examples
--
-
Rename the data set named 'USER.BEFORE.SET' to -'USER.AFTER.SET.':
--
-
zowe zos-files rename data-set "USER.BEFORE.SET" "USER.AFTER.SET"
-
-
zowe › zos-files › rename › data-set-member
-Rename a data set member.
-Usage
-zowe zos-files rename data-set-member <dataSetName> <beforeMemberName> <afterMemberName> [options]
-Positional Arguments
--
-
-dataSetName(string)-
-
- The name of the data set the member belongs to. -
-
-beforeMemberName(string)-
-
- The name of the data set member that you want to rename. -
-
-afterMemberName(string)-
-
- The name you want to rename the data set member to. -
-
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)-
-
Reject self-signed certificates.
-Default value: true
-
-
-
---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. -
-
Options
--
-
---responseTimeout|--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 -
-
Profile Options
--
-
---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
--
-
---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. -
-
Examples
--
-
In the data set 'USER.DATA.SET', rename the member named -'MEM1' to 'MEM2'.:
--
-
zowe zos-files rename data-set-member "USER.DATA.SET" "MEM1" "MEM2
-
-
zowe › zos-files › unmount
-Unmount file systems, such as HFS, ZFS, and more. This disconnects you from USS -file systems.
-zowe › zos-files › unmount › file-system
-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)-
-
Reject self-signed certificates.
-Default value: true
-
-
-
---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. -
-
Options
--
-
---responseTimeout|--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 -
-
Profile Options
--
-
---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
--
-
---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. -
-
Examples
--
-
Unmount a mounted file system:
--
-
zowe zos-files unmount file-system MY.FS
-
-
zowe › zos-files › upload
-Upload the contents of a file to z/OS data sets
-zowe › zos-files › upload › dir-to-pds
-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(number)-
-
- 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
-
-
-
---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. -
-
---responseTimeout|--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)-
-
Reject self-signed certificates.
-Default value: true
-
-
-
---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. -
-
Profile Options
--
-
---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
--
-
---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. -
-
Examples
--
-
Upload a directory named "src" to a PDS named "ibmuser.src":
--
-
zowe zos-files upload dir-to-pds "src" "ibmuser.src"
-
-Upload a directory named "src" to a migrated PDS named -"ibmuser.src" and wait for it to be recalled:
--
-
zowe zos-files upload dir-to-pds "src" "ibmuser.src" --mr wait
-
-
zowe › zos-files › upload › dir-to-uss
-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
.* -
*.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. -
Due to a z/OSMF limitation, files that are transferred in text mode are -converted to the default EBCDIC code page on the z/OS system. Therefore the -only EBCDIC code page to specify as the remote encoding is the default code page -for your system.
-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
-
-
-
---responseTimeout|--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)-
-
Reject self-signed certificates.
-Default value: true
-
-
-
---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. -
-
Profile Options
--
-
---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
--
-
---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. -
-
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
-
-
zowe › zos-files › upload › file-to-data-set
-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(number)-
-
- 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
-
-
-
---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. -
-
---responseTimeout|--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)-
-
Reject self-signed certificates.
-Default value: true
-
-
-
---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. -
-
Profile Options
--
-
---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
--
-
---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. -
-
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
-
-
zowe › zos-files › upload › file-to-uss
-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(number)-
-
- Data content in encoding mode, which means that data conversion is performed -according to the encoding specified. -
-
---responseTimeout|--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)-
-
Reject self-signed certificates.
-Default value: true
-
-
-
---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. -
-
Profile Options
--
-
---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
--
-
---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. -
-
Examples
--
-
Upload to the USS file "/a/ibmuser/my_text.txt" from the -file "file.txt":
--
-
zowe zos-files upload file-to-uss "file.txt" "/a/ibmuser/my_text.txt"
-
-
zowe › zos-files › upload › stdin-to-data-set
-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
-
-
-
---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. -
-
---responseTimeout|--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)-
-
Reject self-signed certificates.
-Default value: true
-
-
-
---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. -
-
Profile Options
--
-
---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
--
-
---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. -
-
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
-
-
-
zowe › zos-ftp
-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.
-zowe › zos-ftp › delete
-Delete data sets, jobs, and USS files
-zowe › zos-ftp › delete › data-set
-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
--
-
---for-sure|-f(boolean)-
-
- Specify this option to confirm that you want to delete the data set -permanently. -
-
---host|-H(string)-
-
- The hostname or IP address of the z/OS server to connect to. -
-
---port|-P(number)-
-
The port of the z/OS FTP server.
-Default value: 21
-
-
-
---user|-u(string)-
-
- Username for authentication on z/OS -
-
---password|-p|--pass|--pw(string)-
-
- Password to authenticate to FTP. -
-
Options
--
-
---secure-ftp(boolean)-
-
Set to true for both control and data connection encryption, 'control' for -control connection encryption only, or 'implicit' for implicitly encrypted -control connection (this mode is deprecated in modern times, but usually uses -port 990). Note: Unfortunately, this plugin's functionality only works with FTP -and FTPS, not 'SFTP' which is FTP over SSH.
-Default value: true
-
-
-
---connection-timeout|--ct(number)-
-
How long (in milliseconds) to wait for the control connection to be -established.
-Default value: 10000
-
-
-
TLS / Secure Connection options
--
-
---reject-unauthorized|--ru(boolean)-
-
- Reject self-signed certificates. Only specify this if you are connecting to a -secure FTP instance. -
-
---server-name|--sn(string)-
-
- Server name for the SNI (Server Name Indication) TLS extension. Only specify if -you are connecting securely -
-
Profile Options
--
-
---zftp-profile|--zftp-p(string)-
-
- The name of a (zftp) 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. -
-
Examples
--
-
Delete the data set "ibmuser.cntl":
--
-
zowe zos-ftp delete data-set "ibmuser.cntl" -f
-
-
zowe › zos-ftp › delete › job
-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 -
-
Required Options
--
-
---host|-H(string)-
-
- The hostname or IP address of the z/OS server to connect to. -
-
---port|-P(number)-
-
The port of the z/OS FTP server.
-Default value: 21
-
-
-
---user|-u(string)-
-
- Username for authentication on z/OS -
-
---password|-p|--pass|--pw(string)-
-
- Password to authenticate to FTP. -
-
Options
--
-
---secure-ftp(boolean)-
-
Set to true for both control and data connection encryption, 'control' for -control connection encryption only, or 'implicit' for implicitly encrypted -control connection (this mode is deprecated in modern times, but usually uses -port 990). Note: Unfortunately, this plugin's functionality only works with FTP -and FTPS, not 'SFTP' which is FTP over SSH.
-Default value: true
-
-
-
---connection-timeout|--ct(number)-
-
How long (in milliseconds) to wait for the control connection to be -established.
-Default value: 10000
-
-
-
TLS / Secure Connection options
--
-
---reject-unauthorized|--ru(boolean)-
-
- Reject self-signed certificates. Only specify this if you are connecting to a -secure FTP instance. -
-
---server-name|--sn(string)-
-
- Server name for the SNI (Server Name Indication) TLS extension. Only specify if -you are connecting securely -
-
Profile Options
--
-
---zftp-profile|--zftp-p(string)-
-
- The name of a (zftp) 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. -
-
Examples
--
-
Cancel the job "JOB00123" and purge its output, optionally -abbreviating the job ID:
--
-
zowe zos-ftp delete job j123
-
-
zowe › zos-ftp › delete › uss-file
-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
--
-
---for-sure|-f(boolean)-
-
- Specify this option to confirm that you want to delete the data set -permanently. -
-
---host|-H(string)-
-
- The hostname or IP address of the z/OS server to connect to. -
-
---port|-P(number)-
-
The port of the z/OS FTP server.
-Default value: 21
-
-
-
---user|-u(string)-
-
- Username for authentication on z/OS -
-
---password|-p|--pass|--pw(string)-
-
- Password to authenticate to FTP. -
-
Options
--
-
---recursive(boolean)-
-
- Delete the directory and all files/directories under it. -
-
---secure-ftp(boolean)-
-
Set to true for both control and data connection encryption, 'control' for -control connection encryption only, or 'implicit' for implicitly encrypted -control connection (this mode is deprecated in modern times, but usually uses -port 990). Note: Unfortunately, this plugin's functionality only works with FTP -and FTPS, not 'SFTP' which is FTP over SSH.
-Default value: true
-
-
-
---connection-timeout|--ct(number)-
-
How long (in milliseconds) to wait for the control connection to be -established.
-Default value: 10000
-
-
-
TLS / Secure Connection options
--
-
---reject-unauthorized|--ru(boolean)-
-
- Reject self-signed certificates. Only specify this if you are connecting to a -secure FTP instance. -
-
---server-name|--sn(string)-
-
- Server name for the SNI (Server Name Indication) TLS extension. Only specify if -you are connecting securely -
-
Profile Options
--
-
---zftp-profile|--zftp-p(string)-
-
- The name of a (zftp) 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. -
-
Examples
--
-
Delete the USS file "/u/ibmuser/myfile.txt":
--
-
zowe zos-ftp delete uss-file "/u/ibmuser/myfile.txt" -f
-
-
zowe › zos-ftp › download
-Download data set, job spool, and USS file content
-zowe › zos-ftp › download › all-spool-by-jobid
-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
--
-
---directory|-d(string)-
-
- The local directory to save the spool content to. By default, it will be saved -to "./output". -
-
---omit-jobid-directory|--ojd(boolean)-
-
- If you specify this, the job output will be saved directly to the specified (or -default) directory. For example, if you omit this, the output would be saved to -./output/JOB00123. If you specify --ojd, the JOB00123 directory would not be -included in the output path and the content would be saved to ./output. -
-
---secure-ftp(boolean)-
-
Set to true for both control and data connection encryption, 'control' for -control connection encryption only, or 'implicit' for implicitly encrypted -control connection (this mode is deprecated in modern times, but usually uses -port 990). Note: Unfortunately, this plugin's functionality only works with FTP -and FTPS, not 'SFTP' which is FTP over SSH.
-Default value: true
-
-
-
---connection-timeout|--ct(number)-
-
How long (in milliseconds) to wait for the control connection to be -established.
-Default value: 10000
-
-
-
Required Options
--
-
---host|-H(string)-
-
- The hostname or IP address of the z/OS server to connect to. -
-
---port|-P(number)-
-
The port of the z/OS FTP server.
-Default value: 21
-
-
-
---user|-u(string)-
-
- Username for authentication on z/OS -
-
---password|-p|--pass|--pw(string)-
-
- Password to authenticate to FTP. -
-
TLS / Secure Connection options
--
-
---reject-unauthorized|--ru(boolean)-
-
- Reject self-signed certificates. Only specify this if you are connecting to a -secure FTP instance. -
-
---server-name|--sn(string)-
-
- Server name for the SNI (Server Name Indication) TLS extension. Only specify if -you are connecting securely -
-
Profile Options
--
-
---zftp-profile|--zftp-p(string)-
-
- The name of a (zftp) 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. -
-
Examples
--
-
Download all spool for the job with the ID JOB00123 to the -default subdirectory in the current directory:
--
-
zowe zos-ftp download all-spool-by-jobid j123
-
-Download all spool for the job with the ID JOB00123 to the -directory build/job_output:
--
-
zowe zos-ftp download all-spool-by-jobid j123 -d build/job_output/
-
-
zowe › zos-ftp › download › data-set
-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
--
-
---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. -
-
---secure-ftp(boolean)-
-
Set to true for both control and data connection encryption, 'control' for -control connection encryption only, or 'implicit' for implicitly encrypted -control connection (this mode is deprecated in modern times, but usually uses -port 990). Note: Unfortunately, this plugin's functionality only works with FTP -and FTPS, not 'SFTP' which is FTP over SSH.
-Default value: true
-
-
-
---connection-timeout|--ct(number)-
-
How long (in milliseconds) to wait for the control connection to be -established.
-Default value: 10000
-
-
-
Required Options
--
-
---host|-H(string)-
-
- The hostname or IP address of the z/OS server to connect to. -
-
---port|-P(number)-
-
The port of the z/OS FTP server.
-Default value: 21
-
-
-
---user|-u(string)-
-
- Username for authentication on z/OS -
-
---password|-p|--pass|--pw(string)-
-
- Password to authenticate to FTP. -
-
TLS / Secure Connection options
--
-
---reject-unauthorized|--ru(boolean)-
-
- Reject self-signed certificates. Only specify this if you are connecting to a -secure FTP instance. -
-
---server-name|--sn(string)-
-
- Server name for the SNI (Server Name Indication) TLS extension. Only specify if -you are connecting securely -
-
Profile Options
--
-
---zftp-profile|--zftp-p(string)-
-
- The name of a (zftp) 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. -
-
Examples
--
-
Download the data set "ibmuser.loadlib(main)" in binary mode -to the local file "main.obj":
--
-
zowe zos-ftp download data-set "ibmuser.loadlib(main)" -b -f main.obj
-
-
zowe › zos-ftp › download › uss-file
-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. -
-
---secure-ftp(boolean)-
-
Set to true for both control and data connection encryption, 'control' for -control connection encryption only, or 'implicit' for implicitly encrypted -control connection (this mode is deprecated in modern times, but usually uses -port 990). Note: Unfortunately, this plugin's functionality only works with FTP -and FTPS, not 'SFTP' which is FTP over SSH.
-Default value: true
-
-
-
---connection-timeout|--ct(number)-
-
How long (in milliseconds) to wait for the control connection to be -established.
-Default value: 10000
-
-
-
Required Options
--
-
---host|-H(string)-
-
- The hostname or IP address of the z/OS server to connect to. -
-
---port|-P(number)-
-
The port of the z/OS FTP server.
-Default value: 21
-
-
-
---user|-u(string)-
-
- Username for authentication on z/OS -
-
---password|-p|--pass|--pw(string)-
-
- Password to authenticate to FTP. -
-
TLS / Secure Connection options
--
-
---reject-unauthorized|--ru(boolean)-
-
- Reject self-signed certificates. Only specify this if you are connecting to a -secure FTP instance. -
-
---server-name|--sn(string)-
-
- Server name for the SNI (Server Name Indication) TLS extension. Only specify if -you are connecting securely -
-
Profile Options
--
-
---zftp-profile|--zftp-p(string)-
-
- The name of a (zftp) 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. -
-
Examples
--
-
Download the USS file "/u/users/ibmuser/main.obj" in binary -mode to the local file "main.obj":
--
-
zowe zos-ftp download uss-file "/u/users/ibmuser/main.obj" -b -f main.obj
-
-
zowe › zos-ftp › list
-List data sets, data set members, uss files, jobs, spool files
-zowe › zos-ftp › list › data-set
-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. -
-
Required Options
--
-
---host|-H(string)-
-
- The hostname or IP address of the z/OS server to connect to. -
-
---port|-P(number)-
-
The port of the z/OS FTP server.
-Default value: 21
-
-
-
---user|-u(string)-
-
- Username for authentication on z/OS -
-
---password|-p|--pass|--pw(string)-
-
- Password to authenticate to FTP. -
-
Options
--
-
---secure-ftp(boolean)-
-
Set to true for both control and data connection encryption, 'control' for -control connection encryption only, or 'implicit' for implicitly encrypted -control connection (this mode is deprecated in modern times, but usually uses -port 990). Note: Unfortunately, this plugin's functionality only works with FTP -and FTPS, not 'SFTP' which is FTP over SSH.
-Default value: true
-
-
-
---connection-timeout|--ct(number)-
-
How long (in milliseconds) to wait for the control connection to be -established.
-Default value: 10000
-
-
-
TLS / Secure Connection options
--
-
---reject-unauthorized|--ru(boolean)-
-
- Reject self-signed certificates. Only specify this if you are connecting to a -secure FTP instance. -
-
---server-name|--sn(string)-
-
- Server name for the SNI (Server Name Indication) TLS extension. Only specify if -you are connecting securely -
-
Profile Options
--
-
---zftp-profile|--zftp-p(string)-
-
- The name of a (zftp) 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. -
-
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 beginning with "ibmuser" and ending in -"cntl":
--
-
zowe zos-ftp list data-set "ibmuser.**.cntl"
-
-
zowe › zos-ftp › list › data-set-members
-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. -
-
Required Options
--
-
---host|-H(string)-
-
- The hostname or IP address of the z/OS server to connect to. -
-
---port|-P(number)-
-
The port of the z/OS FTP server.
-Default value: 21
-
-
-
---user|-u(string)-
-
- Username for authentication on z/OS -
-
---password|-p|--pass|--pw(string)-
-
- Password to authenticate to FTP. -
-
Options
--
-
---secure-ftp(boolean)-
-
Set to true for both control and data connection encryption, 'control' for -control connection encryption only, or 'implicit' for implicitly encrypted -control connection (this mode is deprecated in modern times, but usually uses -port 990). Note: Unfortunately, this plugin's functionality only works with FTP -and FTPS, not 'SFTP' which is FTP over SSH.
-Default value: true
-
-
-
---connection-timeout|--ct(number)-
-
How long (in milliseconds) to wait for the control connection to be -established.
-Default value: 10000
-
-
-
TLS / Secure Connection options
--
-
---reject-unauthorized|--ru(boolean)-
-
- Reject self-signed certificates. Only specify this if you are connecting to a -secure FTP instance. -
-
---server-name|--sn(string)-
-
- Server name for the SNI (Server Name Indication) TLS extension. Only specify if -you are connecting securely -
-
Profile Options
--
-
---zftp-profile|--zftp-p(string)-
-
- The name of a (zftp) 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. -
-
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 in data set "ibmuser.test.cntl":
--
-
zowe zos-ftp list data-set-members "ibmuser.test.cntl"
-
-
zowe › zos-ftp › list › jobs
-List all data sets that match a DSLEVEL pattern (see help below).
-Usage
-zowe zos-ftp list jobs [options]
-Required 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*". -
-
---host|-H(string)-
-
- The hostname or IP address of the z/OS server to connect to. -
-
---port|-P(number)-
-
The port of the z/OS FTP server.
-Default value: 21
-
-
-
---user|-u(string)-
-
- Username for authentication on z/OS -
-
---password|-p|--pass|--pw(string)-
-
- Password to authenticate to FTP. -
-
Options
--
-
---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. -
-
---secure-ftp(boolean)-
-
Set to true for both control and data connection encryption, 'control' for -control connection encryption only, or 'implicit' for implicitly encrypted -control connection (this mode is deprecated in modern times, but usually uses -port 990). Note: Unfortunately, this plugin's functionality only works with FTP -and FTPS, not 'SFTP' which is FTP over SSH.
-Default value: true
-
-
-
---connection-timeout|--ct(number)-
-
How long (in milliseconds) to wait for the control connection to be -established.
-Default value: 10000
-
-
-
TLS / Secure Connection options
--
-
---reject-unauthorized|--ru(boolean)-
-
- Reject self-signed certificates. Only specify this if you are connecting to a -secure FTP instance. -
-
---server-name|--sn(string)-
-
- Server name for the SNI (Server Name Indication) TLS extension. Only specify if -you are connecting securely -
-
Profile Options
--
-
---zftp-profile|--zftp-p(string)-
-
- The name of a (zftp) 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. -
-
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 names beginning beginning with "ibmu":
--
-
zowe zos-ftp list jobs --prefix "ibmu*"
-
-List Alice's jobs with names beginning beginning with -"ibmu":
--
-
zowe zos-ftp list jobs --prefix "ibmu*" --owner "alice"
-
-
zowe › zos-ftp › list › spool-files-by-jobid
-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-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. -
-
Required Options
--
-
---host|-H(string)-
-
- The hostname or IP address of the z/OS server to connect to. -
-
---port|-P(number)-
-
The port of the z/OS FTP server.
-Default value: 21
-
-
-
---user|-u(string)-
-
- Username for authentication on z/OS -
-
---password|-p|--pass|--pw(string)-
-
- Password to authenticate to FTP. -
-
Options
--
-
---secure-ftp(boolean)-
-
Set to true for both control and data connection encryption, 'control' for -control connection encryption only, or 'implicit' for implicitly encrypted -control connection (this mode is deprecated in modern times, but usually uses -port 990). Note: Unfortunately, this plugin's functionality only works with FTP -and FTPS, not 'SFTP' which is FTP over SSH.
-Default value: true
-
-
-
---connection-timeout|--ct(number)-
-
How long (in milliseconds) to wait for the control connection to be -established.
-Default value: 10000
-
-
-
TLS / Secure Connection options
--
-
---reject-unauthorized|--ru(boolean)-
-
- Reject self-signed certificates. Only specify this if you are connecting to a -secure FTP instance. -
-
---server-name|--sn(string)-
-
- Server name for the SNI (Server Name Indication) TLS extension. Only specify if -you are connecting securely -
-
Profile Options
--
-
---zftp-profile|--zftp-p(string)-
-
- The name of a (zftp) 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. -
-
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 spool files of the job with JOBID JOB00123:
--
-
zowe zos-ftp list spool-files-by-jobid job00123
-
-
zowe › zos-ftp › list › uss-files
-List USS files and subdirectories in a directory. -The following values can be used with the --response-format-filter (--rff) -argument todisplay 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 -
-
Required Options
--
-
---host|-H(string)-
-
- The hostname or IP address of the z/OS server to connect to. -
-
---port|-P(number)-
-
The port of the z/OS FTP server.
-Default value: 21
-
-
-
---user|-u(string)-
-
- Username for authentication on z/OS -
-
---password|-p|--pass|--pw(string)-
-
- Password to authenticate to FTP. -
-
Options
--
-
---secure-ftp(boolean)-
-
Set to true for both control and data connection encryption, 'control' for -control connection encryption only, or 'implicit' for implicitly encrypted -control connection (this mode is deprecated in modern times, but usually uses -port 990). Note: Unfortunately, this plugin's functionality only works with FTP -and FTPS, not 'SFTP' which is FTP over SSH.
-Default value: true
-
-
-
---connection-timeout|--ct(number)-
-
How long (in milliseconds) to wait for the control connection to be -established.
-Default value: 10000
-
-
-
TLS / Secure Connection options
--
-
---reject-unauthorized|--ru(boolean)-
-
- Reject self-signed certificates. Only specify this if you are connecting to a -secure FTP instance. -
-
---server-name|--sn(string)-
-
- Server name for the SNI (Server Name Indication) TLS extension. Only specify if -you are connecting securely -
-
Profile Options
--
-
---zftp-profile|--zftp-p(string)-
-
- The name of a (zftp) 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. -
-
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 in the directory "/u/users/ibmuser/" and show -only the file name:
--
-
zowe zos-ftp list uss-files "/u/users/ibmuser/" --rff name
-
-
zowe › zos-ftp › make
-Make a USS directory
-zowe › zos-ftp › make › 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. -
-
Required Options
--
-
---host|-H(string)-
-
- The hostname or IP address of the z/OS server to connect to. -
-
---port|-P(number)-
-
The port of the z/OS FTP server.
-Default value: 21
-
-
-
---user|-u(string)-
-
- Username for authentication on z/OS -
-
---password|-p|--pass|--pw(string)-
-
- Password to authenticate to FTP. -
-
Options
--
-
---secure-ftp(boolean)-
-
Set to true for both control and data connection encryption, 'control' for -control connection encryption only, or 'implicit' for implicitly encrypted -control connection (this mode is deprecated in modern times, but usually uses -port 990). Note: Unfortunately, this plugin's functionality only works with FTP -and FTPS, not 'SFTP' which is FTP over SSH.
-Default value: true
-
-
-
---connection-timeout|--ct(number)-
-
How long (in milliseconds) to wait for the control connection to be -established.
-Default value: 10000
-
-
-
TLS / Secure Connection options
--
-
---reject-unauthorized|--ru(boolean)-
-
- Reject self-signed certificates. Only specify this if you are connecting to a -secure FTP instance. -
-
---server-name|--sn(string)-
-
- Server name for the SNI (Server Name Indication) TLS extension. Only specify if -you are connecting securely -
-
Profile Options
--
-
---zftp-profile|--zftp-p(string)-
-
- The name of a (zftp) 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. -
-
Examples
--
-
Make a USS directory "/u/users/ibmuser/mydir":
--
-
zowe zos-ftp make uss-directory "/u/users/ibmuser/mydir"
-
-
zowe › zos-ftp › rename
-Rename data sets and USS files or directories
-zowe › zos-ftp › rename › data-set
-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. -
-
Required Options
--
-
---host|-H(string)-
-
- The hostname or IP address of the z/OS server to connect to. -
-
---port|-P(number)-
-
The port of the z/OS FTP server.
-Default value: 21
-
-
-
---user|-u(string)-
-
- Username for authentication on z/OS -
-
---password|-p|--pass|--pw(string)-
-
- Password to authenticate to FTP. -
-
Options
--
-
---secure-ftp(boolean)-
-
Set to true for both control and data connection encryption, 'control' for -control connection encryption only, or 'implicit' for implicitly encrypted -control connection (this mode is deprecated in modern times, but usually uses -port 990). Note: Unfortunately, this plugin's functionality only works with FTP -and FTPS, not 'SFTP' which is FTP over SSH.
-Default value: true
-
-
-
---connection-timeout|--ct(number)-
-
How long (in milliseconds) to wait for the control connection to be -established.
-Default value: 10000
-
-
-
TLS / Secure Connection options
--
-
---reject-unauthorized|--ru(boolean)-
-
- Reject self-signed certificates. Only specify this if you are connecting to a -secure FTP instance. -
-
---server-name|--sn(string)-
-
- Server name for the SNI (Server Name Indication) TLS extension. Only specify if -you are connecting securely -
-
Profile Options
--
-
---zftp-profile|--zftp-p(string)-
-
- The name of a (zftp) 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. -
-
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)"
-
-
zowe › zos-ftp › rename › uss-file
-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. -
-
Required Options
--
-
---host|-H(string)-
-
- The hostname or IP address of the z/OS server to connect to. -
-
---port|-P(number)-
-
The port of the z/OS FTP server.
-Default value: 21
-
-
-
---user|-u(string)-
-
- Username for authentication on z/OS -
-
---password|-p|--pass|--pw(string)-
-
- Password to authenticate to FTP. -
-
Options
--
-
---secure-ftp(boolean)-
-
Set to true for both control and data connection encryption, 'control' for -control connection encryption only, or 'implicit' for implicitly encrypted -control connection (this mode is deprecated in modern times, but usually uses -port 990). Note: Unfortunately, this plugin's functionality only works with FTP -and FTPS, not 'SFTP' which is FTP over SSH.
-Default value: true
-
-
-
---connection-timeout|--ct(number)-
-
How long (in milliseconds) to wait for the control connection to be -established.
-Default value: 10000
-
-
-
TLS / Secure Connection options
--
-
---reject-unauthorized|--ru(boolean)-
-
- Reject self-signed certificates. Only specify this if you are connecting to a -secure FTP instance. -
-
---server-name|--sn(string)-
-
- Server name for the SNI (Server Name Indication) TLS extension. Only specify if -you are connecting securely -
-
Profile Options
--
-
---zftp-profile|--zftp-p(string)-
-
- The name of a (zftp) 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. -
-
Examples
--
-
Rename the file /u/users/ibmuser/hello.txt to -/u/users/ibmuser/hello2.txt:
--
-
zowe zos-ftp rename uss-file "/u/users/ibmuser/hello.txt" "/u/users/ibmuser/hello2.txt"
-
-
zowe › zos-ftp › submit
-Submit jobs from local files and data sets
-zowe › zos-ftp › submit › data-set
-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
--
-
---wait|-w(string)-
-
- Specify job query interval and max times of querying job status. The format of -this option is comma-separated numeric values. For example, '5,12' means -queries job status every 5 seconds for 12 times at most. -
-
---wait-for-output|--wfo(boolean)-
-
- Wait for the job to enter OUTPUT status before completing the command. -
-
---wait-for-active|--wfa(boolean)-
-
- Wait for the job to enter ACTIVE status before completing the command. -
-
---secure-ftp(boolean)-
-
Set to true for both control and data connection encryption, 'control' for -control connection encryption only, or 'implicit' for implicitly encrypted -control connection (this mode is deprecated in modern times, but usually uses -port 990). Note: Unfortunately, this plugin's functionality only works with FTP -and FTPS, not 'SFTP' which is FTP over SSH.
-Default value: true
-
-
-
---connection-timeout|--ct(number)-
-
How long (in milliseconds) to wait for the control connection to be -established.
-Default value: 10000
-
-
-
Required Options
--
-
---host|-H(string)-
-
- The hostname or IP address of the z/OS server to connect to. -
-
---port|-P(number)-
-
The port of the z/OS FTP server.
-Default value: 21
-
-
-
---user|-u(string)-
-
- Username for authentication on z/OS -
-
---password|-p|--pass|--pw(string)-
-
- Password to authenticate to FTP. -
-
TLS / Secure Connection options
--
-
---reject-unauthorized|--ru(boolean)-
-
- Reject self-signed certificates. Only specify this if you are connecting to a -secure FTP instance. -
-
---server-name|--sn(string)-
-
- Server name for the SNI (Server Name Indication) TLS extension. Only specify if -you are connecting securely -
-
Profile Options
--
-
---zftp-profile|--zftp-p(string)-
-
- The name of a (zftp) 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. -
-
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
-
-
zowe › zos-ftp › submit › local-file
-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
--
-
---wait|-w(string)-
-
- Specify job query interval and max times of querying job status. The format of -this option is comma-separated numeric values. For example, '5,12' means -queries job status every 5 seconds for 12 times at most. -
-
---wait-for-output|--wfo(boolean)-
-
- Wait for the job to enter OUTPUT status before completing the command. -
-
---wait-for-active|--wfa(boolean)-
-
- Wait for the job to enter ACTIVE status before completing the command. -
-
---secure-ftp(boolean)-
-
Set to true for both control and data connection encryption, 'control' for -control connection encryption only, or 'implicit' for implicitly encrypted -control connection (this mode is deprecated in modern times, but usually uses -port 990). Note: Unfortunately, this plugin's functionality only works with FTP -and FTPS, not 'SFTP' which is FTP over SSH.
-Default value: true
-
-
-
---connection-timeout|--ct(number)-
-
How long (in milliseconds) to wait for the control connection to be -established.
-Default value: 10000
-
-
-
Required Options
--
-
---host|-H(string)-
-
- The hostname or IP address of the z/OS server to connect to. -
-
---port|-P(number)-
-
The port of the z/OS FTP server.
-Default value: 21
-
-
-
---user|-u(string)-
-
- Username for authentication on z/OS -
-
---password|-p|--pass|--pw(string)-
-
- Password to authenticate to FTP. -
-
TLS / Secure Connection options
--
-
---reject-unauthorized|--ru(boolean)-
-
- Reject self-signed certificates. Only specify this if you are connecting to a -secure FTP instance. -
-
---server-name|--sn(string)-
-
- Server name for the SNI (Server Name Indication) TLS extension. Only specify if -you are connecting securely -
-
Profile Options
--
-
---zftp-profile|--zftp-p(string)-
-
- The name of a (zftp) 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. -
-
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
-
-
zowe › zos-ftp › submit › stdin
-Submit a job from JCL written to the standard input (stdin) of this process.
-Usage
-zowe zos-ftp submit stdin [options]
-Options
--
-
---wait|-w(string)-
-
- Specify job query interval and max times of querying job status. The format of -this option is comma-separated numeric values. For example, '5,12' means -queries job status every 5 seconds for 12 times at most. -
-
---wait-for-output|--wfo(boolean)-
-
- Wait for the job to enter OUTPUT status before completing the command. -
-
---wait-for-active|--wfa(boolean)-
-
- Wait for the job to enter ACTIVE status before completing the command. -
-
---secure-ftp(boolean)-
-
Set to true for both control and data connection encryption, 'control' for -control connection encryption only, or 'implicit' for implicitly encrypted -control connection (this mode is deprecated in modern times, but usually uses -port 990). Note: Unfortunately, this plugin's functionality only works with FTP -and FTPS, not 'SFTP' which is FTP over SSH.
-Default value: true
-
-
-
---connection-timeout|--ct(number)-
-
How long (in milliseconds) to wait for the control connection to be -established.
-Default value: 10000
-
-
-
Required Options
--
-
---host|-H(string)-
-
- The hostname or IP address of the z/OS server to connect to. -
-
---port|-P(number)-
-
The port of the z/OS FTP server.
-Default value: 21
-
-
-
---user|-u(string)-
-
- Username for authentication on z/OS -
-
---password|-p|--pass|--pw(string)-
-
- Password to authenticate to FTP. -
-
TLS / Secure Connection options
--
-
---reject-unauthorized|--ru(boolean)-
-
- Reject self-signed certificates. Only specify this if you are connecting to a -secure FTP instance. -
-
---server-name|--sn(string)-
-
- Server name for the SNI (Server Name Indication) TLS extension. Only specify if -you are connecting securely -
-
Profile Options
--
-
---zftp-profile|--zftp-p(string)-
-
- The name of a (zftp) 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. -
-
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
-
-
zowe › zos-ftp › upload
-Upload data set and USS content
-zowe › zos-ftp › upload › file-to-data-set
-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
--
-
---binary|-b(boolean)-
-
- Upload content in binary mode. -
-
---dcb(string)-
-
- DCB parameters for dataset allocation if not existing. It's space separated -like RECFM=FB LRECL=326 BLKSIZE=23472 -
-
---secure-ftp(boolean)-
-
Set to true for both control and data connection encryption, 'control' for -control connection encryption only, or 'implicit' for implicitly encrypted -control connection (this mode is deprecated in modern times, but usually uses -port 990). Note: Unfortunately, this plugin's functionality only works with FTP -and FTPS, not 'SFTP' which is FTP over SSH.
-Default value: true
-
-
-
---connection-timeout|--ct(number)-
-
How long (in milliseconds) to wait for the control connection to be -established.
-Default value: 10000
-
-
-
Required Options
--
-
---host|-H(string)-
-
- The hostname or IP address of the z/OS server to connect to. -
-
---port|-P(number)-
-
The port of the z/OS FTP server.
-Default value: 21
-
-
-
---user|-u(string)-
-
- Username for authentication on z/OS -
-
---password|-p|--pass|--pw(string)-
-
- Password to authenticate to FTP. -
-
TLS / Secure Connection options
--
-
---reject-unauthorized|--ru(boolean)-
-
- Reject self-signed certificates. Only specify this if you are connecting to a -secure FTP instance. -
-
---server-name|--sn(string)-
-
- Server name for the SNI (Server Name Indication) TLS extension. Only specify if -you are connecting securely -
-
Profile Options
--
-
---zftp-profile|--zftp-p(string)-
-
- The name of a (zftp) 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. -
-
Examples
--
-
Upload to "ibmuser.cntl(iefbr14)" from the file iefbr14.txt:
--
-
zowe zos-ftp upload file-to-data-set iefbr14.txt "ibmuser.cntl(iefbr14)"
-
-Upload to "ibmuser.cntl(iefbr14)" from the file iefbr14.txt -with the DCB parameters:
--
-
zowe zos-ftp upload file-to-data-set iefbr14.txt "ibmuser.cntl(iefbr14)" --dcb "RECFM=FB LRECL=326 BLKSIZE=23472"
-
-
zowe › zos-ftp › upload › file-to-uss-file
-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. -
-
---secure-ftp(boolean)-
-
Set to true for both control and data connection encryption, 'control' for -control connection encryption only, or 'implicit' for implicitly encrypted -control connection (this mode is deprecated in modern times, but usually uses -port 990). Note: Unfortunately, this plugin's functionality only works with FTP -and FTPS, not 'SFTP' which is FTP over SSH.
-Default value: true
-
-
-
---connection-timeout|--ct(number)-
-
How long (in milliseconds) to wait for the control connection to be -established.
-Default value: 10000
-
-
-
Required Options
--
-
---host|-H(string)-
-
- The hostname or IP address of the z/OS server to connect to. -
-
---port|-P(number)-
-
The port of the z/OS FTP server.
-Default value: 21
-
-
-
---user|-u(string)-
-
- Username for authentication on z/OS -
-
---password|-p|--pass|--pw(string)-
-
- Password to authenticate to FTP. -
-
TLS / Secure Connection options
--
-
---reject-unauthorized|--ru(boolean)-
-
- Reject self-signed certificates. Only specify this if you are connecting to a -secure FTP instance. -
-
---server-name|--sn(string)-
-
- Server name for the SNI (Server Name Indication) TLS extension. Only specify if -you are connecting securely -
-
Profile Options
--
-
---zftp-profile|--zftp-p(string)-
-
- The name of a (zftp) 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. -
-
Examples
--
-
Upload to "/u/users/ibmuser/iefbr14.txt" from the file -iefbr14.txt:
--
-
zowe zos-ftp upload file-to-uss-file iefbr14.txt "/u/users/ibmuser/iefbr14.txt"
-
-
zowe › zos-ftp › upload › stdin-to-data-set
-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
--
-
---binary|-b(boolean)-
-
- Upload content in binary mode. -
-
---secure-ftp(boolean)-
-
Set to true for both control and data connection encryption, 'control' for -control connection encryption only, or 'implicit' for implicitly encrypted -control connection (this mode is deprecated in modern times, but usually uses -port 990). Note: Unfortunately, this plugin's functionality only works with FTP -and FTPS, not 'SFTP' which is FTP over SSH.
-Default value: true
-
-
-
---connection-timeout|--ct(number)-
-
How long (in milliseconds) to wait for the control connection to be -established.
-Default value: 10000
-
-
-
Required Options
--
-
---host|-H(string)-
-
- The hostname or IP address of the z/OS server to connect to. -
-
---port|-P(number)-
-
The port of the z/OS FTP server.
-Default value: 21
-
-
-
---user|-u(string)-
-
- Username for authentication on z/OS -
-
---password|-p|--pass|--pw(string)-
-
- Password to authenticate to FTP. -
-
TLS / Secure Connection options
--
-
---reject-unauthorized|--ru(boolean)-
-
- Reject self-signed certificates. Only specify this if you are connecting to a -secure FTP instance. -
-
---server-name|--sn(string)-
-
- Server name for the SNI (Server Name Indication) TLS extension. Only specify if -you are connecting securely -
-
Profile Options
--
-
---zftp-profile|--zftp-p(string)-
-
- The name of a (zftp) 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. -
-
Examples
--
-
Upload to "ibmuser.cntl(iefbr14)" from standard input (you -can pipe into this command):
--
-
zowe zos-ftp upload stdin-to-data-set "ibmuser.cntl(iefbr14)"
-
-
zowe › zos-ftp › upload › stdin-to-uss-file
-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. -
-
---secure-ftp(boolean)-
-
Set to true for both control and data connection encryption, 'control' for -control connection encryption only, or 'implicit' for implicitly encrypted -control connection (this mode is deprecated in modern times, but usually uses -port 990). Note: Unfortunately, this plugin's functionality only works with FTP -and FTPS, not 'SFTP' which is FTP over SSH.
-Default value: true
-
-
-
---connection-timeout|--ct(number)-
-
How long (in milliseconds) to wait for the control connection to be -established.
-Default value: 10000
-
-
-
Required Options
--
-
---host|-H(string)-
-
- The hostname or IP address of the z/OS server to connect to. -
-
---port|-P(number)-
-
The port of the z/OS FTP server.
-Default value: 21
-
-
-
---user|-u(string)-
-
- Username for authentication on z/OS -
-
---password|-p|--pass|--pw(string)-
-
- Password to authenticate to FTP. -
-
TLS / Secure Connection options
--
-
---reject-unauthorized|--ru(boolean)-
-
- Reject self-signed certificates. Only specify this if you are connecting to a -secure FTP instance. -
-
---server-name|--sn(string)-
-
- Server name for the SNI (Server Name Indication) TLS extension. Only specify if -you are connecting securely -
-
Profile Options
--
-
---zftp-profile|--zftp-p(string)-
-
- The name of a (zftp) 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. -
-
Examples
--
-
Upload to "/u/users/ibmuser/iefbr14.txt" from standard input -(you can pipe into this command):
--
-
zowe zos-ftp upload stdin-to-uss-file "/u/users/ibmuser/iefbr14.txt"
-
-
zowe › zos-ftp › view
-View data sets, job output, and USS content
-zowe › zos-ftp › view › all-spool-by-jobid
-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 -
-
Required Options
--
-
---host|-H(string)-
-
- The hostname or IP address of the z/OS server to connect to. -
-
---port|-P(number)-
-
The port of the z/OS FTP server.
-Default value: 21
-
-
-
---user|-u(string)-
-
- Username for authentication on z/OS -
-
---password|-p|--pass|--pw(string)-
-
- Password to authenticate to FTP. -
-
Options
--
-
---secure-ftp(boolean)-
-
Set to true for both control and data connection encryption, 'control' for -control connection encryption only, or 'implicit' for implicitly encrypted -control connection (this mode is deprecated in modern times, but usually uses -port 990). Note: Unfortunately, this plugin's functionality only works with FTP -and FTPS, not 'SFTP' which is FTP over SSH.
-Default value: true
-
-
-
---connection-timeout|--ct(number)-
-
How long (in milliseconds) to wait for the control connection to be -established.
-Default value: 10000
-
-
-
TLS / Secure Connection options
--
-
---reject-unauthorized|--ru(boolean)-
-
- Reject self-signed certificates. Only specify this if you are connecting to a -secure FTP instance. -
-
---server-name|--sn(string)-
-
- Server name for the SNI (Server Name Indication) TLS extension. Only specify if -you are connecting securely -
-
Profile Options
--
-
---zftp-profile|--zftp-p(string)-
-
- The name of a (zftp) 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. -
-
Examples
--
-
View all spool content for the job with ID JOB00123 -(optionally abbreviating the job ID):
--
-
zowe zos-ftp view all-spool-by-jobid j123
-
-
zowe › zos-ftp › view › data-set
-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
--
-
---binary|-b(boolean)-
-
- View content in binary form without converting to ASCII text -
-
---secure-ftp(boolean)-
-
Set to true for both control and data connection encryption, 'control' for -control connection encryption only, or 'implicit' for implicitly encrypted -control connection (this mode is deprecated in modern times, but usually uses -port 990). Note: Unfortunately, this plugin's functionality only works with FTP -and FTPS, not 'SFTP' which is FTP over SSH.
-Default value: true
-
-
-
---connection-timeout|--ct(number)-
-
How long (in milliseconds) to wait for the control connection to be -established.
-Default value: 10000
-
-
-
Required Options
--
-
---host|-H(string)-
-
- The hostname or IP address of the z/OS server to connect to. -
-
---port|-P(number)-
-
The port of the z/OS FTP server.
-Default value: 21
-
-
-
---user|-u(string)-
-
- Username for authentication on z/OS -
-
---password|-p|--pass|--pw(string)-
-
- Password to authenticate to FTP. -
-
TLS / Secure Connection options
--
-
---reject-unauthorized|--ru(boolean)-
-
- Reject self-signed certificates. Only specify this if you are connecting to a -secure FTP instance. -
-
---server-name|--sn(string)-
-
- Server name for the SNI (Server Name Indication) TLS extension. Only specify if -you are connecting securely -
-
Profile Options
--
-
---zftp-profile|--zftp-p(string)-
-
- The name of a (zftp) 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. -
-
Examples
--
-
View the content of the data set "ibmuser.cntl(iefbr14)":
--
-
zowe zos-ftp view data-set "ibmuser.cntl(iefbr14)"
-
-View the content of the data set "ibmuser.loadlib(main)" and -pipe it into the hex viewer program xxd:
--
-
zowe zos-ftp view data-set "ibmuser.loadlib(main)" -b | xxd
-
-
zowe › zos-ftp › view › job-status-by-jobid
-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-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 -
-
Required Options
--
-
---host|-H(string)-
-
- The hostname or IP address of the z/OS server to connect to. -
-
---port|-P(number)-
-
The port of the z/OS FTP server.
-Default value: 21
-
-
-
---user|-u(string)-
-
- Username for authentication on z/OS -
-
---password|-p|--pass|--pw(string)-
-
- Password to authenticate to FTP. -
-
Options
--
-
---secure-ftp(boolean)-
-
Set to true for both control and data connection encryption, 'control' for -control connection encryption only, or 'implicit' for implicitly encrypted -control connection (this mode is deprecated in modern times, but usually uses -port 990). Note: Unfortunately, this plugin's functionality only works with FTP -and FTPS, not 'SFTP' which is FTP over SSH.
-Default value: true
-
-
-
---connection-timeout|--ct(number)-
-
How long (in milliseconds) to wait for the control connection to be -established.
-Default value: 10000
-
-
-
TLS / Secure Connection options
--
-
---reject-unauthorized|--ru(boolean)-
-
- Reject self-signed certificates. Only specify this if you are connecting to a -secure FTP instance. -
-
---server-name|--sn(string)-
-
- Server name for the SNI (Server Name Indication) TLS extension. Only specify if -you are connecting securely -
-
Profile Options
--
-
---zftp-profile|--zftp-p(string)-
-
- The name of a (zftp) 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. -
-
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 status for the job with ID "JOB00123" (optionally -abbreviating the ID):
--
-
zowe zos-ftp view job-status-by-jobid j123
-
-
zowe › zos-ftp › view › spool-file-by-id
-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-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. Use the "imperative -zos-jobs list spool-files-by-jobid" command to obtain spool ID numbers.No -pre-validation of the ID is performed. -
-
Required Options
--
-
---host|-H(string)-
-
- The hostname or IP address of the z/OS server to connect to. -
-
---port|-P(number)-
-
The port of the z/OS FTP server.
-Default value: 21
-
-
-
---user|-u(string)-
-
- Username for authentication on z/OS -
-
---password|-p|--pass|--pw(string)-
-
- Password to authenticate to FTP. -
-
Options
--
-
---secure-ftp(boolean)-
-
Set to true for both control and data connection encryption, 'control' for -control connection encryption only, or 'implicit' for implicitly encrypted -control connection (this mode is deprecated in modern times, but usually uses -port 990). Note: Unfortunately, this plugin's functionality only works with FTP -and FTPS, not 'SFTP' which is FTP over SSH.
-Default value: true
-
-
-
---connection-timeout|--ct(number)-
-
How long (in milliseconds) to wait for the control connection to be -established.
-Default value: 10000
-
-
-
TLS / Secure Connection options
--
-
---reject-unauthorized|--ru(boolean)-
-
- Reject self-signed certificates. Only specify this if you are connecting to a -secure FTP instance. -
-
---server-name|--sn(string)-
-
- Server name for the SNI (Server Name Indication) TLS extension. Only specify if -you are connecting securely -
-
Profile Options
--
-
---zftp-profile|--zftp-p(string)-
-
- The name of a (zftp) 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. -
-
Examples
--
-
View the spool file with ID 4 for the job with job ID -JOB00123:
--
-
zowe zos-ftp view spool-file-by-id JOB00123 4
-
-
zowe › zos-ftp › view › uss-file
-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 -
-
---secure-ftp(boolean)-
-
Set to true for both control and data connection encryption, 'control' for -control connection encryption only, or 'implicit' for implicitly encrypted -control connection (this mode is deprecated in modern times, but usually uses -port 990). Note: Unfortunately, this plugin's functionality only works with FTP -and FTPS, not 'SFTP' which is FTP over SSH.
-Default value: true
-
-
-
---connection-timeout|--ct(number)-
-
How long (in milliseconds) to wait for the control connection to be -established.
-Default value: 10000
-
-
-
Required Options
--
-
---host|-H(string)-
-
- The hostname or IP address of the z/OS server to connect to. -
-
---port|-P(number)-
-
The port of the z/OS FTP server.
-Default value: 21
-
-
-
---user|-u(string)-
-
- Username for authentication on z/OS -
-
---password|-p|--pass|--pw(string)-
-
- Password to authenticate to FTP. -
-
TLS / Secure Connection options
--
-
---reject-unauthorized|--ru(boolean)-
-
- Reject self-signed certificates. Only specify this if you are connecting to a -secure FTP instance. -
-
---server-name|--sn(string)-
-
- Server name for the SNI (Server Name Indication) TLS extension. Only specify if -you are connecting securely -
-
Profile Options
--
-
---zftp-profile|--zftp-p(string)-
-
- The name of a (zftp) 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. -
-
Examples
--
-
View the content of the USS file -"/u/users/ibmuser/myfile.txt":
--
-
zowe zos-ftp view uss-file "/u/users/ibmuser/myfile.txt"
-
-View the content of the USS file -"/u/users/ibmuser/myjava.jar" in binary mode and pipe it into the hex viewer -command xxd:
--
-
zowe zos-ftp view uss-file "/u/users/ibmuser/myjava.jar" -b | xxd
-
-
-
zowe › zos-jobs
-Manage z/OS jobs.
-zowe › zos-jobs › cancel
-Cancel a single job by job ID. This cancels the job if it is running or on -input.
-zowe › zos-jobs › cancel › job
-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". -
-
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)-
-
Reject self-signed certificates.
-Default value: true
-
-
-
---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. -
-
Profile Options
--
-
---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
--
-
---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. -
-
Examples
--
-
Cancel job with job ID JOB03456:
--
-
zowe zos-jobs cancel job JOB03456
-
-
zowe › zos-jobs › delete
-Delete a single job by job ID in OUTPUT status. This cancels the job if it is -running and purges its output from the system
-zowe › zos-jobs › delete › job
-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". -
-
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)-
-
Reject self-signed certificates.
-Default value: true
-
-
-
---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. -
-
Profile Options
--
-
---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
--
-
---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. -
-
Examples
--
-
Delete job with job ID JOB03456.:
--
-
zowe zos-jobs delete job JOB03456
-
-
zowe › zos-jobs › download
-Download the output of a job as separate files.
-zowe › zos-jobs › download › output
-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. -
-
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)-
-
Reject self-signed certificates.
-Default value: true
-
-
-
---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. -
-
Profile Options
--
-
---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
--
-
---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. -
-
Examples
--
-
Download all the output of the job with job ID JOB00234 to -an automatically generated directory.:
--
-
zowe zos-jobs download output JOB00234
-
-
zowe › zos-jobs › list
-List z/OS jobs and list the spool files (DDs) for a z/OS job on the JES/spool -queues.
-zowe › zos-jobs › list › jobs
-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
--
-
---owner|-o(string)-
-
- Specify the owner 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. The -command does not prevalidate the owner. You can specify a wildcard according to -the z/OSMF Jobs REST endpoint documentation, which is usually in the form -"USER*". -
-
---prefix|-p(string)-
-
- Specify the job name prefix of the jobs you want to list. The command does not -prevalidate the owner. You can specify a wildcard according to the z/OSMF Jobs -REST endpoint documentation, which is usually in the form "JOB*". -
-
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)-
-
Reject self-signed certificates.
-Default value: true
-
-
-
---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. -
-
Profile Options
--
-
---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
--
-
---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. -
-
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
-
-
zowe › zos-jobs › list › spool-files-by-jobid
-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)-
-
Reject self-signed certificates.
-Default value: true
-
-
-
---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. -
-
Profile Options
--
-
---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
--
-
---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. -
-
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 spool files of the job with JOBID JOB00123:
--
-
zowe zos-jobs list spool-files-by-jobid job00123
-
-
zowe › zos-jobs › submit
-Submit jobs (JCL) contained in data sets.
-zowe › zos-jobs › submit › data-set
-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-output|--wfo(boolean)-
-
- Wait for the job to enter OUTPUT status before completing the command. -
-
---wait-for-active|--wfa(boolean)-
-
- Wait for the job to enter ACTIVE status before completing the command. -
-
---view-all-spool-content|--vasc(boolean)-
-
- Print all spool output. If you use this option you will wait 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 the job to complete. -
-
---extension|-e(string)-
-
- A file extension to save the job output with. Default is '.txt'. -
-
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)-
-
Reject self-signed certificates.
-Default value: true
-
-
-
---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. -
-
Profile Options
--
-
---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
--
-
---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. -
-
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
-
-
zowe › zos-jobs › submit › local-file
-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
--
-
---view-all-spool-content|--vasc(boolean)-
-
- Print all spool output. If you use this option you will wait the job to -complete. -
-
---wait-for-output|--wfo(boolean)-
-
- Wait for the job to enter OUTPUT status before completing the command. -
-
---wait-for-active|--wfa(boolean)-
-
- Wait for the job to enter ACTIVE status before completing the command. -
-
---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 the job to complete. -
-
---extension|-e(string)-
-
- A file extension to save the job output with. Default is '.txt'. -
-
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)-
-
Reject self-signed certificates.
-Default value: true
-
-
-
---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. -
-
Profile Options
--
-
---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
--
-
---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. -
-
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 file "iefbr14.txt":
--
-
zowe zos-jobs submit local-file "iefbr14.txt"
-
-
zowe › zos-jobs › submit › stdin
-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
--
-
---view-all-spool-content|--vasc(boolean)-
-
- Print all spool output. If you use this option you will wait the job to -complete. -
-
---wait-for-output|--wfo(boolean)-
-
- Wait for the job to enter OUTPUT status before completing the command. -
-
---wait-for-active|--wfa(boolean)-
-
- Wait for the job to enter ACTIVE status before completing the command. -
-
---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 the job to complete. -
-
---extension|-e(string)-
-
- A file extension to save the job output with. Default is '.txt'. -
-
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)-
-
Reject self-signed certificates.
-Default value: true
-
-
-
---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. -
-
Profile Options
--
-
---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
--
-
---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. -
-
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. -
-
zowe › zos-jobs › view
-View details of z/OS jobs on spool/JES queues.
-zowe › zos-jobs › view › job-status-by-jobid
-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)-
-
Reject self-signed certificates.
-Default value: true
-
-
-
---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. -
-
Profile Options
--
-
---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
--
-
---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. -
-
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
-
-
zowe › zos-jobs › view › spool-file-by-id
-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. -
-
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)-
-
Reject self-signed certificates.
-Default value: true
-
-
-
---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. -
-
Profile Options
--
-
---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
--
-
---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. -
-
Examples
--
-
View the spool file with ID 4 for the job with job ID -JOB00123:
--
-
zowe zos-jobs view spool-file-by-id JOB00123 4
-
-
-
zowe › zos-tso
-Issue TSO commands and interact with TSO address spaces
-zowe › zos-tso › issue
-Issue TSO commands
-zowe › zos-tso › issue › command
-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
--
-
---suppress-startup-messages|--ssm(boolean)-
-
- Suppress console messages from start of address space. -
-
TSO ADDRESS SPACE OPTIONS
--
-
---account|-a(string)-
-
- Your z/OS TSO/E accounting information. -
-
---character-set|--cs(string)-
-
Character set for address space to convert messages and responses from UTF-8 to -EBCDIC.
-Default value: 697
-
-
-
---code-page|--cp(string)-
-
Codepage value for TSO/E address space to convert messages and responses from -UTF-8 to EBCDIC.
-Default value: 1047
-
-
-
---columns|--cols(number)-
-
The number of columns on a screen.
-Default value: 80
-
-
-
---logon-procedure|-l(string)-
-
The logon procedure to use when creating TSO procedures on your behalf.
-Default value: IZUFPROC
-
-
-
---region-size|--rs(number)-
-
Region size for the TSO/E address space.
-Default value: 4096
-
-
-
---rows(number)-
-
The number of rows on a screen.
-Default value: 24
-
-
-
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)-
-
Reject self-signed certificates.
-Default value: true
-
-
-
---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. -
-
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
--
-
---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. -
-
Examples
--
-
Issue the TSO command "status" to display information about -jobs for your user ID.:
--
-
zowe zos-tso issue command "status"
-
-
zowe › zos-tso › ping
-Ping a TSO address space, from which you previously started and received a token -(a.k.a 'servelet-key').
-zowe › zos-tso › ping › address-space
-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)-
-
Reject self-signed certificates.
-Default value: true
-
-
-
---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. -
-
Profile Options
--
-
---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
--
-
---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. -
-
Examples
--
-
Ping the TSO address space identified by -IBMUSER-329-aafkaaoc:
--
-
zowe zos-tso ping address-space IBMUSER-329-aafkaaoc
-
-
zowe › zos-tso › send
-Send data to TSO and collect responses until the prompt is reached
-zowe › zos-tso › send › address-space
-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)-
-
Reject self-signed certificates.
-Default value: true
-
-
-
---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. -
-
Profile Options
--
-
---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
--
-
---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. -
-
Examples
--
-
"Send the TIME TSO command to the TSO address space -identified by IBMUSER-329-aafkaaoc":
--
-
zowe zos-tso send address-space IBMUSER-329-aafkaaoc --data "TIME"
-
-
zowe › zos-tso › start
-Start TSO/E address space
-zowe › zos-tso › start › 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)-
-
Character set for address space to convert messages and responses from UTF-8 to -EBCDIC.
-Default value: 697
-
-
-
---code-page|--cp(string)-
-
Codepage value for TSO/E address space to convert messages and responses from -UTF-8 to EBCDIC.
-Default value: 1047
-
-
-
---columns|--cols(number)-
-
The number of columns on a screen.
-Default value: 80
-
-
-
---logon-procedure|-l(string)-
-
The logon procedure to use when creating TSO procedures on your behalf.
-Default value: IZUFPROC
-
-
-
---region-size|--rs(number)-
-
Region size for the TSO/E address space.
-Default value: 4096
-
-
-
---rows(number)-
-
The number of rows on a screen.
-Default value: 24
-
-
-
Options
--
-
---servlet-key-only|--sko(boolean)-
-
- Specify this option to print only 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)-
-
Reject self-signed certificates.
-Default value: true
-
-
-
---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. -
-
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
--
-
---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. -
-
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
-
-
zowe › zos-tso › stop
-Stop TSO/E address space
-zowe › zos-tso › stop › 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)-
-
Reject self-signed certificates.
-Default value: true
-
-
-
---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. -
-
Profile Options
--
-
---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
--
-
---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. -
-
Examples
--
-
Stop the TSO address space identified by -IBMUSER-329-aafkaaoc:
--
-
zowe zos-tso stop address-space IBMUSER-329-aafkaaoc
-
-
-
zowe › zos-uss
-Issue z/OS USS commands remotely using an SSH session. Output from the commands -is displayed on the local terminal.
-zowe › zos-uss › issue
-Issue a z/OS USS command
-zowe › zos-uss › issue › ssh
-Issue a z/OS USS command
-Usage
-zowe zos-uss issue ssh <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)-
-
The z/OS SSH server port.
-Default value: 22
-
-
-
---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
--
-
---ssh-profile|--ssh-p(string)-
-
- The name of a (ssh) 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)-
-
Reject self-signed certificates.
-Default value: true
-
-
-
---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. -
-
Examples
--
-
Issue a simple command, giving the working directory:
--
-
zowe zos-uss issue ssh "npm install express" --cwd /u/cicprov/mnt/CICPY01I/bundles/myapp
-
-
-
zowe › zos-workflows
-Create and manage z/OSMF workflows on a z/OS system
-zowe › zos-workflows › archive
-Archive workflow instance in z/OSMF
-zowe › zos-workflows › archive › active-workflow
-Archive an active workflow instance in z/OSMF.
-Usage
-zowe zos-workflows archive active-workflow [options]
-Options
--
-
---workflow-name|--wn(string)-
-
- The name of the workflow to be archived. -
-
---workflow-key|--wk(string)-
-
- The workflow key of the workflow to be archived. -
-
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)-
-
Reject self-signed certificates.
-Default value: true
-
-
-
---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. -
-
Profile Options
--
-
---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
--
-
---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. -
-
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"
-
-
zowe › zos-workflows › create
-Create a z/OSMF workflow on a z/OS system.
-zowe › zos-workflows › create › workflow-from-data-set
-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
--
-
-workflowName(string)-
-
- Name of the workflow -
-
Required Options
--
-
---data-set|--ds(string)-
-
- Data set that contains a workflow definiton. -
-
---system-name|--sn(string)-
-
- z/OS system to execute the workflow. -
-
---owner|--ow(string)-
-
- User ID of the workflow owner. This user can perform the workflow steps or -delegate the steps to other users. -
-
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)-
-
Reject self-signed certificates.
-Default value: true
-
-
-
---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. -
-
Profile Options
--
-
---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
--
-
---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. -
-
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 exist 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 succesfully 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
-
-
zowe › zos-workflows › create › workflow-from-local-file
-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
--
-
-workflowName(string)-
-
- Name of the workflow -
-
Required Options
--
-
---local-file|--lf(string)-
-
- Local file that contains workflow definiton. -
-
---system-name|--sn(string)-
-
- z/OS system to execute the workflow. -
-
---owner|--ow(string)-
-
- User ID of the workflow owner. This user can perform the workflow steps or -delegate the steps to other users. -
-
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)-
-
Avoid deletion the uploaded files in /tmp or another specified directory after -successful execution.
-Default value: false
-
-
-
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)-
-
Reject self-signed certificates.
-Default value: true
-
-
-
---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. -
-
Profile Options
--
-
---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
--
-
---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. -
-
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 local -file "TESTID_WKFLOW.xml" that contains the workflow definition xml on the system -"TESTM1" with owner "OTHERID" and delete workflow with the same name if it -already exist in z/OSMF:
--
-
zowe zos-workflows create workflow-from-local-file "testworkflow" --local-file "TESTID_WKFLOW.xml" --system-name "TESTM1" --owner "OTHERID" --overwrite
-
-
zowe › zos-workflows › create › workflow-from-uss-file
-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
--
-
---uss-file|--uf(string)-
-
- Uss file that contains workflow definiton. -
-
---system-name|--sn(string)-
-
- z/OS system to execute the workflow. -
-
---owner|--ow(string)-
-
- User ID of the workflow owner. This user can perform the workflow steps or -delegate the steps to other users. -
-
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)-
-
Reject self-signed certificates.
-Default value: true
-
-
-
---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. -
-
Profile Options
--
-
---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
--
-
---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. -
-
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 exist 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
-
-
zowe › zos-workflows › delete
-Delete an active workflow or an archived workflow from z/OSMF.
-zowe › zos-workflows › delete › active-workflow
-Delete an active workflow instance in z/OSMF
-Usage
-zowe zos-workflows delete active-workflow [options]
-Options
--
-
---workflow-key|--wk(string)-
-
- Delete active workflow by specified workflow key -
-
---workflow-name|--wn(string)-
-
- Delete active workflow by specified workflow 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)-
-
Reject self-signed certificates.
-Default value: true
-
-
-
---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. -
-
Profile Options
--
-
---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
--
-
---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. -
-
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.*"
-
-
zowe › zos-workflows › delete › archived-workflow
-Delete an archived workflow from z/OSMF
-Usage
-zowe zos-workflows delete archived-workflow [options]
-Options
--
-
---workflow-key|--wk(string)-
-
- Delete an archived workflow by specified workflow key -
-
---workflow-name|--wn(string)-
-
- Delete an archived workflow by specified workflow 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)-
-
Reject self-signed certificates.
-Default value: true
-
-
-
---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. -
-
Profile Options
--
-
---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
--
-
---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. -
-
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.*"
-
-
zowe › zos-workflows › list
-List the z/OSMF workflows for a system or a sysplex with filter options.
-zowe › zos-workflows › list › active-workflow-details
-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)-
-
Reject self-signed certificates.
-Default value: true
-
-
-
---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. -
-
Profile Options
--
-
---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
--
-
---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. -
-
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
-
-
zowe › zos-workflows › list › active-workflows
-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)-
-
Reject self-signed certificates.
-Default value: true
-
-
-
---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. -
-
Profile Options
--
-
---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
--
-
---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. -
-
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"
-
-
zowe › zos-workflows › list › archived-workflows
-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)-
-
Reject self-signed certificates.
-Default value: true
-
-
-
---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. -
-
Profile Options
--
-
---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
--
-
---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. -
-
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. -
-
zowe › zos-workflows › list › definition-file-details
-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
--
-
-definitionFilePath(string)-
-
- Specifies the location of the workflow definition file, which is either a UNIX -path name or a fully qualified z/OS data set name. -
-
Options
--
-
---list-steps|--ls(boolean)-
-
- Optional parameter for listing steps and their properties. -
-
---list-variables|--lv(boolean)-
-
- Optional parameter for listing variables and their properties. -
-
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)-
-
Reject self-signed certificates.
-Default value: true
-
-
-
---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. -
-
Profile Options
--
-
---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
--
-
---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. -
-
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 --workflow-name "testWorkflow" --list-steps --list-variables
-
-
zowe › zos-workflows › start
-Start a z/OSMF workflow on a z/OS system.
-zowe › zos-workflows › start › workflow-full
-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)-
-
Reject self-signed certificates.
-Default value: true
-
-
-
---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. -
-
Profile Options
--
-
---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
--
-
---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. -
-
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 forit 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"
-
-
zowe › zos-workflows › start › workflow-step
-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)-
-
Identifies whether to perform also following steps in the workflow instance.
-Default value: false
-
-
-
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)-
-
Reject self-signed certificates.
-Default value: true
-
-
-
---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. -
-
Profile Options
--
-
---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
--
-
---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. -
-
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"
-
-
-
zowe › zosmf
-Retrieve and show the properties of a z/OSMF web server
-zowe › zosmf › check
-Confirm that z/OSMF is running on a specified system and gather information -about the z/OSMF server for diagnostic purposes.
-zowe › zosmf › check › status
-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)-
-
Reject self-signed certificates.
-Default value: true
-
-
-
---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. -
-
Profile Options
--
-
---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
--
-
---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. -
-
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
-
-
zowe › zosmf › list
-Obtain a list of systems that are defined to a z/OSMF instance.
-zowe › zosmf › list › systems
-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)-
-
Reject self-signed certificates.
-Default value: true
-
-
-
---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. -
-
Profile Options
--
-
---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
--
-
---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. -
-
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
-
-
-