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)
-
--help-examples
(boolean)
- Not available for top tier Zowe group
-
--help-web
| --hw
(boolean)
- Display HTML help in browser
Connect to Zowe API Mediation Layer authentication service and obtain a token,
or disconnect from the authentication service and revoke the token.
The token provides authentication to services that support the API ML SSO
(Single Sign-On) capability. When you log in, the token is stored in your
default base profile until it expires. Base profiles store connection
information shared by multiple services (e.g., z/OSMF), and are used if you do
not supply connection information in a service profile. To take advantage of
the API ML SSO capability, you should omit username and password in service
profiles so that the token in the base profile is used.
Log in to an authentication service.
Log in to Zowe API Mediation Layer authentication service and obtain or update a
token.
The token provides authentication to services that support the API ML SSO
(Single Sign-On) capability. When you log in, the token is stored in your
default base profile until it expires. Base profiles store connection
information shared by multiple services (e.g., z/OSMF), and are used if you do
not supply connection information in a service profile. To take advantage of
the API ML SSO capability, you should omit username and password in service
profiles so that the token in the base profile is used.
Usage
zowe auth login apiml [options]
Options
Base Connection Options
Profile Options
Examples
Log out of an authentication service.
Log out of the Zowe API Mediation Layer authentication service and revoke the
token so it can no longer authenticate. Also remove the token from the default
base profile, if it is stored on disk.
Usage
zowe auth logout apiml [options]
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--token-type
| --tt
(string)
-
The type of token to get and use for the API. Omit this option to use the
default token type, which is provided by 'zowe auth login'.
Allowed values: apimlAuthenticationToken, jwtToken, LtpaToken2
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--reject-unauthorized
| --ru
(boolean)
Profile Options
Examples
Interact with IBM CICS programs and transactions.
Add new resources (for example, CSD Groups to CSD Lists) to CICS through IBM
CMCI.
Add a CSD Group to a CICS CSD List.
Usage
zowe cics add-to-list csdGroup <name> <csdList> [options]
Positional Arguments
-
name
(string)
- The name of the CSD Group to add. The maximum length of the CSD Group name is
eight characters
-
csdList
(string)
- The name of the CSD List to add the group to. The maximum length of the CSD
List name is eight characters
Options
-
--region-name
(string)
- The CICS region name to which to add the CSD Group to the CSD List
-
--cics-plex
(string)
- The name of the CICSPlex to which to add the CSD Group to the CSD List
Cics Connection Options
Profile Options
Base Connection Options
Examples
Define new resources (for example, programs) to CICS through IBM CMCI.
Define a new program to CICS.
Usage
zowe cics define program <programName> <csdGroup> [options]
Positional Arguments
-
programName
(string)
- The name of the new program to define. The maximum length of the program name
is eight characters.
-
csdGroup
(string)
- The CICS system definition (CSD) Group for the new program that you want to
define. The maximum length of the group name is eight characters.
Options
-
--region-name
(string)
- The CICS region name to which to define the new program
-
--cics-plex
(string)
- The name of the CICSPlex to which to define the new program
Cics Connection Options
Profile Options
Base Connection Options
Examples
Define a new transaction to CICS.
Usage
zowe cics define transaction <transactionName> <programName> <csdGroup> [options]
Positional Arguments
-
transactionName
(string)
- The name of the new transaction to define. The maximum length of the
transaction name is four characters.
-
programName
(string)
- The name of the program that the transaction uses. The maximum length of the
program name is eight characters.
-
csdGroup
(string)
- The CICS system definition (CSD) Group for the new transaction that you want to
define. The maximum length of the group name is eight characters.
Options
-
--region-name
(string)
- The CICS region name to which to define the new transaction
-
--cics-plex
(string)
- The name of the CICSPlex to which to define the new transaction
Cics Connection Options
Profile Options
Base Connection Options
Examples
Define a new URIMAP of type client to CICS. This acts as an HTTP(S) client
Usage
zowe cics define urimap-client <urimapName> <csdGroup> [options]
Positional Arguments
-
urimapName
(string)
- The name of the URIMAP to create. The maximum length of the urimap name is
eight characters.
-
csdGroup
(string)
- The CICS system definition (CSD) Group for the new urimap that you want to
define. The maximum length of the group name is eight characters.
Required Options
Options
-
--urimap-scheme
| --us
(string)
-
--authenticate
| --auth
(string)
-
The authentication and identification scheme to be used for client URIMAPs.
Allowed values: NO, BASIC
-
--certificate
| --cert
(string)
- The label of a certificate in the keyring that is to be used as the client
certificate in SSL handshakes
-
--description
| --desc
(string)
- Description of the URIMAP resource being defined.
-
--region-name
(string)
- The CICS region name to which to define the new URIMAP.
-
--cics-plex
(string)
- The name of the CICSPlex to which to define the new URIMAP.
-
--enable
(boolean)
Cics Connection Options
Profile Options
Base Connection Options
Examples
Define a new URIMAP of type pipeline to CICS. This processes incoming HTTP(S)
requests
Usage
zowe cics define urimap-pipeline <urimapName> <csdGroup> [options]
Positional Arguments
-
urimapName
(string)
- The name of the URIMAP to create. The maximum length of the urimap name is
eight characters.
-
csdGroup
(string)
- The CICS system definition (CSD) Group for the new urimap that you want to
define. The maximum length of the group name is eight characters.
Required Options
-
--urimap-path
| --up
(string)
- The path component of the URI.
-
--urimap-host
| --uh
(string)
- The host component of the URI.
-
--pipeline-name
| --pn
(string)
- The name of the PIPELINE resource definition for the URIMAP. The maximum length
of the pipeline name is eight characters.
Options
-
--urimap-scheme
| --us
(string)
-
--description
| --desc
(string)
- Description of the URIMAP resource being defined.
-
--transaction-name
| --tn
(string)
- The name of the TRANSACTION resource definition for the URIMAP. The maximum
length of the transaction name is four characters.
-
--webservice-name
| --wn
(string)
- The name of the WEBSERVICE resource definition for the URIMAP. The maximum
length of the transaction name is 32 characters.
-
--tcpipservice
| --tcpip
(string)
- The TCPIPSERVICE to which the URIMAP definition applies.
-
--region-name
(string)
- The CICS region name to which to define the new URIMAP.
-
--cics-plex
(string)
- The name of the CICSPlex to which to define the new URIMAP.
-
--enable
(boolean)
Cics Connection Options
Profile Options
Base Connection Options
Examples
Define a new URIMAP of type server to CICS. This acts as an HTTP(S) server
Usage
zowe cics define urimap-server <urimapName> <csdGroup> [options]
Positional Arguments
-
urimapName
(string)
- The name of the URIMAP to create. The maximum length of the urimap name is
eight characters.
-
csdGroup
(string)
- The CICS system definition (CSD) Group for the new urimap that you want to
define. The maximum length of the group name is eight characters.
Required Options
-
--urimap-path
| --up
(string)
- The path component of the URI.
-
--urimap-host
| --uh
(string)
- The host component of the URI.
-
--program-name
| --pn
(string)
- The application program that makes or handles the requests.
Options
-
--urimap-scheme
| --us
(string)
-
--description
| --desc
(string)
- Description of the URIMAP resource being defined.
-
--tcpipservice
| --tcpip
(string)
- The TCPIPSERVICE to which the URIMAP definition applies.
-
--region-name
(string)
- The CICS region name to which to define the new URIMAP.
-
--cics-plex
(string)
- The name of the CICSPlex to which to define the new URIMAP.
-
--enable
(boolean)
Cics Connection Options
Profile Options
Base Connection Options
Examples
Define a new web service to CICS.
Usage
zowe cics define webservice <webserviceName> <csdGroup> [options]
Positional Arguments
-
webserviceName
(string)
- The name of the WEBSERVICE to create. The maximum length of the web service
name is eight characters.
-
csdGroup
(string)
- The CICS system definition (CSD) Group for the new web service that you want to
define. The maximum length of the group name is eight characters.
Required Options
Options
Cics Connection Options
Profile Options
Base Connection Options
Examples
Delete resources (for example, programs) from CICS through IBM CMCI.
Delete a program from CICS.
Usage
zowe cics delete program <programName> <csdGroup> [options]
Positional Arguments
-
programName
(string)
- The name of the program to delete. The maximum length of the program name is
eight characters.
-
csdGroup
(string)
- The CICS system definition (CSD) Group for the program that you want to delete.
The maximum length of the group name is eight characters.
Options
-
--region-name
(string)
- The CICS region name from which to delete the program
-
--cics-plex
(string)
- The name of the CICSPlex from which to delete the program
Cics Connection Options
Profile Options
Base Connection Options
Examples
Delete a transaction from CICS.
Usage
zowe cics delete transaction <transactionName> <csdGroup> [options]
Positional Arguments
-
transactionName
(string)
- The name of the transaction to delete. The maximum length of the transaction
name is four characters.
-
csdGroup
(string)
- The CICS system definition (CSD) Group for the transaction that you want to
delete. The maximum length of the group name is eight characters.
Options
-
--region-name
(string)
- The CICS region name from which to delete the transaction
-
--cics-plex
(string)
- The name of the CICSPlex from which to delete the transaction
Cics Connection Options
Profile Options
Base Connection Options
Examples
Delete a urimap from CICS.
Usage
zowe cics delete urimap <urimapName> <csdGroup> [options]
Positional Arguments
-
urimapName
(string)
- The name of the urimap to delete. The maximum length of the urimap name is
eight characters.
-
csdGroup
(string)
- The CICS system definition (CSD) Group for the urimap that you want to delete.
The maximum length of the group name is eight characters.
Options
-
--region-name
(string)
- The CICS region name from which to delete the urimap
Cics Connection Options
Profile Options
Base Connection Options
Examples
Delete a web service from CICS.
Usage
zowe cics delete webservice <webserviceName> <csdGroup> [options]
Positional Arguments
-
webserviceName
(string)
- The name of the web service to delete. The maximum length of the web service
name is eight characters.
-
csdGroup
(string)
- The CICS system definition (CSD) Group for the web service that you want to
delete. The maximum length of the group name is eight characters.
Options
-
--region-name
(string)
- The CICS region name from which to delete the web service
Cics Connection Options
Profile Options
Base Connection Options
Examples
Disable resources (for example, urimaps) from CICS through IBM CMCI.
Disable a urimap from CICS.
Usage
zowe cics disable urimap <urimapName> [options]
Positional Arguments
-
urimapName
(string)
- The name of the urimap to disable. The maximum length of the urimap name is
eight characters.
Options
-
--region-name
(string)
- The CICS region name in which to disable the urimap
Cics Connection Options
Profile Options
Base Connection Options
Examples
Discard resources (for example, programs) from CICS through IBM CMCI.
Discard a program from CICS.
Usage
zowe cics discard program <programName> [options]
Positional Arguments
-
programName
(string)
- The name of the program to discard. The maximum length of the program name is
eight characters.
Options
-
--region-name
(string)
- The CICS region name from which to discard the program
-
--cics-plex
(string)
- The name of the CICSPlex from which to discard the program
Cics Connection Options
Profile Options
Base Connection Options
Examples
Discard a transaction from CICS.
Usage
zowe cics discard transaction <transactionName> [options]
Positional Arguments
-
transactionName
(string)
- The name of the transaction to discard. The maximum length of the transaction
name is four characters.
Options
-
--region-name
(string)
- The CICS region name from which to discard the transaction
-
--cics-plex
(string)
- The name of the CICSPlex from which to discard the transaction
Cics Connection Options
Profile Options
Base Connection Options
Examples
Discard a urimap from CICS.
Usage
zowe cics discard urimap <urimapName> [options]
Positional Arguments
-
urimapName
(string)
- The name of the urimap to discard. The maximum length of the urimap name is
eight characters.
Options
-
--region-name
(string)
- The CICS region name from which to discard the urimap
Cics Connection Options
Profile Options
Base Connection Options
Examples
Enable resources (for example, urimaps) from CICS through IBM CMCI.
Enable a urimap from CICS.
Usage
zowe cics enable urimap <urimapName> [options]
Positional Arguments
-
urimapName
(string)
- The name of the urimap to enable. The maximum length of the urimap name is
eight characters.
Options
-
--region-name
(string)
- The CICS region name in which to enable the urimap
Cics Connection Options
Profile Options
Base Connection Options
Examples
Get resources (for example, programs or transactions) from CICS through IBM
CMCI.
Get resources (for example, programs or transactions) from CICS.
Usage
zowe cics get resource <resourceName> [options]
Positional Arguments
-
resourceName
(string)
- The name of the resource to get.
Options
-
--region-name
| --rn
(string)
- The CICS region name from which to get the resources
-
--cics-plex
| --cp
(string)
- The name of the CICSPlex from which to get the resources
-
--criteria
| -c
(string)
- The criteria by which to filter the resource
-
--parameter
| -p
(string)
- The parameter by which to refine the resource
Cics Connection Options
Profile Options
Base Connection Options
Response Format Options
-
--response-format-filter
| --rff
(array)
- Filter (include) fields in the response. Accepts an array of field/property
names to include in the output response. You can filter JSON objects properties
OR table columns/fields. In addition, you can use this option in conjunction
with '--response-format-type' to reduce the output of a command to a single
field/property or a list of a single field/property.
-
--response-format-type
| --rft
(string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is
an array of homogeneous JSON objects. Each property of the object will become a
column in the table.
list: Formats output data as a list of strings. Can be used on any data type
(JSON objects/arrays) are stringified and a new line is added after each entry
in an array.
object: Formats output data as a list of prettified objects (or single object).
Can be used in place of "table" to change from tabular output to a list of
prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header
| --rfh
(boolean)
- If "--response-format-type table" is specified, include the column headers
in the output.
Examples
-
Get program resources from the region named MYREGION:
zowe cics get resource CICSProgram --region-name MYREGION
-
Get local transaction resources from the region named
MYREGION:
zowe cics get resource CICSLocalTransaction --region-name MYREGION
-
Get local file resources from the region named MYREGION:
zowe cics get resource CICSLocalFile --region-name MYREGION
-
Get program definition resources from the CSD group named
GRP1 and the region named MYREGION:
zowe cics get resource CICSDefinitionProgram --region-name MYREGION --parameter "CSDGROUP(GRP1)"
-
Get transaction definition resources from the CSD group
named GRP1 and the region named MYREGION:
zowe cics get resource CICSDefinitionTransaction --region-name MYREGION --parameter "CSDGROUP(GRP1)"
-
Get URIMap definition resources from the CSD group named
GRP1 and the region named MYREGION:
zowe cics get resource CICSDefinitionURIMap --region-name MYREGION --parameter "CSDGROUP(GRP1)"
-
Get program resources that start with the name PRG from the
region named MYREGION:
zowe cics get resource CICSProgram --region-name MYREGION --criteria "PROGRAM=PRG*"
-
Get a local transaction resource named TRAN from the region
named MYREGION:
zowe cics get resource CICSLocalTransaction --region-name MYREGION --criteria "TRANID=TRAN"
-
Get program resources that start with the name MYPRG from
the region named MYREGION and display various fields as a table:
zowe cics get resource CICSProgram --region-name MYREGION --criteria "PROGRAM=MYPRG*" --rft table --rfh --rff program length status
Install resources (for example, programs) to CICS through IBM CMCI.
Install a program to CICS.
Usage
zowe cics install program <programName> <csdGroup> [options]
Positional Arguments
-
programName
(string)
- The name of the program to install. The maximum length of the program name is
eight characters.
-
csdGroup
(string)
- The CICS system definition (CSD) Group for the program that you want to
install. The maximum length of the group name is eight characters.
Options
-
--region-name
(string)
- The CICS region name to which to install the program
-
--cics-plex
(string)
- The name of the CICSPlex to which to install the program
Cics Connection Options
Profile Options
Base Connection Options
Examples
Install a transaction to CICS.
Usage
zowe cics install transaction <transactionName> <csdGroup> [options]
Positional Arguments
-
transactionName
(string)
- The name of the transaction to install. The maximum length of the transaction
name is four characters.
-
csdGroup
(string)
- The CICS system definition (CSD) Group for the transaction that you want to
install. The maximum length of the group name is eight characters.
Options
-
--region-name
(string)
- The CICS region name to which to install the transaction
-
--cics-plex
(string)
- The name of the CICSPlex to which to install the transaction
Cics Connection Options
Profile Options
Base Connection Options
Examples
Install a urimap to CICS.
Usage
zowe cics install urimap <urimapName> <csdGroup> [options]
Positional Arguments
-
urimapName
(string)
- The name of the urimap to install. The maximum length of the urimap name is
eight characters.
-
csdGroup
(string)
- The CICS system definition (CSD) Group for the urimap that you want to install.
The maximum length of the group name is eight characters.
Options
-
--region-name
(string)
- The CICS region name to which to install the urimap
Cics Connection Options
Profile Options
Base Connection Options
Examples
Refresh a program on CICS through IBM CMCI.
Refresh a program on CICS.
Usage
zowe cics refresh program <programName> [options]
Positional Arguments
-
programName
(string)
- The name of the program to refresh. The maximum length of the program name is
eight characters.
Options
-
--region-name
(string)
- The CICS region name on which you want to refresh the program
-
--cics-plex
(string)
- The name of the CICSPlex on which to refresh the program
Cics Connection Options
Profile Options
Base Connection Options
Examples
Remove resources (for example, CSD Groups in CSD Lists) from CICS through IBM
CMCI.
Remove a CSD Group from a CICS CSD List.
Usage
zowe cics remove-from-list csdGroup <name> <csdList> [options]
Positional Arguments
-
name
(string)
- The name of the CSD Group to remove. The maximum length of the CSD Group name
is eight characters
-
csdList
(string)
- The name of the CSD List to remove the group from. The maximum length of the
CSD List name is eight characters
Options
-
--region-name
(string)
- The CICS region name to which to remove the CSD Group from the CSD List
-
--cics-plex
(string)
- The name of the CICSPlex to which to remove the CSD Group from the CSD List
Cics Connection Options
Profile Options
Base Connection Options
Examples
Manage configuration and overrides. To see all set-able options use "list"
command.
Get a value of single setting option.
Usage
zowe config get <configName> [options]
Positional Arguments
Examples
List all configuration setting options.
Usage
zowe config list [options]
Options
-
--values
(boolean)
- Show values for every option
Examples
Reset a configuration setting to default value.
Usage
zowe config reset <configName> [options]
Positional Arguments
Examples
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)
Examples
Interact with IBM Db2 for z/OS
Call a Db2 stored procedure
Call a Db2 stored procedure. Specify the stored procedure name and optionally
provide values.
Usage
zowe db2 call procedure <routine> [options]
Positional Arguments
-
routine
(string)
- The name of a Db2 stored procedure
Options
DB2 Connection Options
-
--host
| -H
(string)
-
--port
| -P
(number)
- The Db2 server port number
-
--user
| -u
(string)
- The Db2 user ID (may be the same as the TSO login)
-
--password
| --pass
| --pw
(string)
- The Db2 password (may be the same as the TSO password)
-
--database
| --db
(string)
-
--sslFile
| --ssl
(string)
- Path to an SSL Certificate file
Profile Options
Base Connection Options
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the
default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
Examples
-
Call stored procedure DEMO.SP1:
zowe db2 call procedure "DEMO.SP1"
-
Call a stored procedure and pass values for parameter
indicators:
zowe db2 call procedure "DEMO.SP2(?, ?)" --parameters "Hello" "world!"
-
Call a stored procedure and pass values for two output
parameters. The first output requires a 2-character buffer. The second output
is a message that will be truncated to the length of the placeholder.:
zowe db2 call procedure "DEMO.SP3(NULL, ?, ?)" --parameters "00" "message_placeholder_message_placeholder"
Execute SQL queries against a Db2 region and retrieve the response. Enclose the
query in quotes and escape any symbols that have a special meaning to the
shell.
Execute one or multiple SQL statements separated by a semicolon from a command
line or from a file.
Usage
zowe db2 execute sql [options]
Options
-
--query
| -q
(string)
- The SQL statement verbatim to execute
-
--file
| -f
(string)
- A local file containing the SQL statements to execute
DB2 Connection Options
-
--host
| -H
(string)
-
--port
| -P
(number)
- The Db2 server port number
-
--user
| -u
(string)
- The Db2 user ID (may be the same as the TSO login)
-
--password
| --pass
| --pw
(string)
- The Db2 password (may be the same as the TSO password)
-
--database
| --db
(string)
-
--sslFile
| --ssl
(string)
- Path to an SSL Certificate file
Profile Options
Base Connection Options
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the
default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
Examples
-
Execute a dummy SQL query:
zowe db2 execute sql --query "SELECT 'Hello World' FROM SYSIBM.SYSDUMMY1"
-
Retrieve the employees table and total number of rows:
zowe db2 execute sql -q "SELECT * FROM SAMPLE.EMP; SELECT COUNT(*) AS TOTAL FROM SAMPLE.EMP"
-
Execute a file with SQL statements:
zowe db2 execute sql --file backup_sample_database.sql
Export data from a Db2 table
Export a Db2 table to the stdout or a file.
Usage
zowe db2 export table <table> [options]
Positional Arguments
-
table
(string)
- The name of the table to export
Options
DB2 Connection Options
-
--host
| -H
(string)
-
--port
| -P
(number)
- The Db2 server port number
-
--user
| -u
(string)
- The Db2 user ID (may be the same as the TSO login)
-
--password
| --pass
| --pw
(string)
- The Db2 password (may be the same as the TSO password)
-
--database
| --db
(string)
-
--sslFile
| --ssl
(string)
- Path to an SSL Certificate file
Profile Options
Base Connection Options
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the
default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
Examples
Interact with IBM IMS programs and transactions.
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.
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
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
Base Connection Options
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the
default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
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"
Query an IMS region.
Usage
zowe ims query region [options]
Options
-
--dc
(boolean)
-
--region
(boolean)
-
--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
Base Connection Options
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the
default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
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"
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
Base Connection Options
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the
default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
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"
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.
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
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
Base Connection Options
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the
default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
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"
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
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
Base Connection Options
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the
default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
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"
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
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
Base Connection Options
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the
default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
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"
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.",
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
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
Base Connection Options
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the
default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
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"
Stop an IMS region.
Usage
zowe ims stop region [options]
Options
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
Base Connection Options
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the
default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
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"
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
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
Base Connection Options
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the
default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
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"
Updates the setting(s) for application program or transaction. This command
submits a 'UPDATE PGM' or 'UPDATE TRAN' IMS command and returns the output.
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)
-
--dynamic
| --dopt
(string)
-
--fast-path
| --fp
(string)
-
--generated-psb
| --gpsb
(string)
-
--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)
-
--option
| -o
(string)
-
--resident
| -r
(string)
-
--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)
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
Base Connection Options
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the
default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
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"
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)
-
--current-priority
| --cpri
(number)
- Specifies a new value for the current priority of a transaction.
-
--directed-routing
| --dirroute
(string)
-
--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)
-
--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)
-
--inquiry
| --inq
(string)
-
--limit-count
| --lct
(number)
- Specifies the limit count.
-
--limit-priority
| --lpri
(number)
- Specifies the limit priority.
-
--lock
| -l
(string)
-
--log-write-ahead
| --dclwa
(string)
-
--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)
-
--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)
-
--remote
| --re
(string)
-
--response-mode
| --resp
(string)
-
--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)
-
--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)
-
--transaction-level-stat
| --transtat
(string)
-
--wait-for-input
| --wfi
(string)
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
Base Connection Options
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the
default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
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"
Interact with IBM MQ for z/OS.
MQ Utilities
MQ Utilities
Usage
zowe mq run mqsc <qmgr> <cmd> [options]
Positional Arguments
-
qmgr
(string)
- The queue manager to apply the command to
-
cmd
(string)
MQ Connection Options
Profile Options
Base Connection Options
Examples
Install and manage plug-ins.
Install plug-ins to an application.
Usage
zowe plugins install [plugin...] [options]
Positional Arguments
-
plugin...
(string)
-
A space-separated list of plug-ins to install. A plug-in can be any format
that is accepted by the `npm install` command (local directory, TAR file, git
URL, public package, private package, etc...).
To use a relative local directory, at least one '/' or '\' must exist in the
plug-in path. For example, you have a local plug-in in a folder called
'test-plugin' that you want to install. Specify the relative local directory
by issuing the following command:
zowe plugins install ./test-plugin
If you omit the './', then the install command looks for 'test-plugin' in an
npm registry.
If the plugin argument is omitted, the plugins.json file will determine which
plug-ins are installed. For more information on the plugins.json file, see
the --file option.
Options
-
--file
(local file path)
-
Specifies the location of a plugins.json file that contains the plug-ins you
want to install.
All plug-ins specified in plugins.json will be installed to the base CLI and
the contents will be placed into ~/.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
List all plug-ins installed.
Usage
zowe plugins list [options]
Uninstall plug-ins.
Usage
zowe plugins uninstall [plugin...] [options]
Positional Arguments
Examples
-
Uninstall a plug-in:
zowe plugins uninstall my-plugin
Update plug-ins.
Usage
zowe plugins update [plugin...] [options]
Positional Arguments
Options
-
--registry
(string)
-
The npm registry that is used when installing remote packages. When this value
is omitted, the value returned by `npm config get registry` is used.
For more information about npm registries, see:
https://docs.npmjs.com/misc/registry
-
--login
(boolean)
-
The flag to add a registry user account to install from secure registry. It
saves credentials to the .npmrc file using `npm 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
Validate a plug-in that has been installed.
Usage
zowe plugins validate [plugin] [options]
Positional Arguments
-
plugin
(string)
-
The name of the plug-in to validate.
Validation issues identified for this plug-in are displayed.
If the plug-in argument is omitted, all installed plug-ins are validated.
Options
Examples
-
Validate a plug-in named my-plugin:
zowe plugins validate my-plugin
-
Validate all installed plug-ins:
zowe plugins validate
-
Validate a plug-in named my-plugin, and treat warnings as
errors:
zowe plugins validate my-plugin --fail-on-warning
Create and manage configuration profiles.
Create new configuration profiles.
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)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the
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
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
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
Cics Connection Options
Examples
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)
-
--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)
-
--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.
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
Examples
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
Options
Examples
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)
-
--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
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
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)
-
--code-page
| --cp
(string)
-
--columns
| --cols
(number)
-
--logon-procedure
| -l
(string)
-
--region-size
| --rs
(number)
-
--rows
(number)
Options
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
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
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)
-
--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
Examples
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)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to
prepend the base path to all z/OSMF resources when making REST requests. Do not
specify this option if you are not using an API mediation layer.
-
--protocol
(string)
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.
-
--response-timeout
| --rto
(number)
- The maximum amount of time in seconds the z/OSMF Files TSO servlet should run
before returning a response. Any request exceeding this amount of time will be
terminated and return an error. Allowed values: 5 - 600
-
--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
Delete existing profiles.
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 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 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 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 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 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 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 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 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
List profiles of the type {{type}}.
Base profile that stores values shared by multiple service profiles
Usage
zowe profiles list base-profiles [options]
Options
Examples
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
Examples
A profile for interaction with Db2 for the z/OS region
Usage
zowe profiles list db2-profiles [options]
Options
Examples
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
Examples
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
Examples
z/OS SSH Profile
Usage
zowe profiles list ssh-profiles [options]
Options
Examples
z/OS TSO/E User Profile
Usage
zowe profiles list tso-profiles [options]
Options
Examples
Configuration profile for z/OS FTP
Usage
zowe profiles list zftp-profiles [options]
Options
Examples
z/OSMF Profile
Usage
zowe profiles list zosmf-profiles [options]
Options
Examples
Set which profiles are loaded by default.
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
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
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
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
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
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
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
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
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
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.
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
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)
-
--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
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
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.
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
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.
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
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
TLS / Secure Connection options
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)
-
--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.
-
--protocol
(string)
Options
Examples
Perform z/OSMF provisioning tasks on Published Templates in the Service Catalog
and Provisioned Instances in the Service Registry.
Deletes instance previously provisioned with z/OSMF cloud provisioning
services.
Deletes selected deprovisioned instance.
Usage
zowe provisioning delete instance <name> [options]
Positional Arguments
-
name
(string)
- Deprovisioned Instance name.
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to
prepend the base path to all z/OSMF resources when making REST requests. Do not
specify this option if you are not using an API mediation layer.
-
--protocol
(string)
Profile Options
Base Connection Options
Examples
Lists z/OSMF provisioning information such as the provisioned instances from the
registry, the provisioned instance details, the available provisioning templates
and provisioning template details.
Lists the z/OSMF service catalog published templates.
Usage
zowe provisioning list catalog-templates [options]
Options
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to
prepend the base path to all z/OSMF resources when making REST requests. Do not
specify this option if you are not using an API mediation layer.
-
--protocol
(string)
Profile Options
Base Connection Options
Examples
List details about an instance provisioned with z/OSMF.
Usage
zowe provisioning list instance-info <name> [options]
Positional Arguments
-
name
(string)
- Provisioned Instance Name
Options
-
--display
(string)
-
Level of information to display for the provisioned instance. Possible values:
summary - summary information, no actions or variables
actions - (default) summary with actions, no variables
vars - summary information with variables, no actions
extended - extended information with actions
full - all available information
Allowed values: extended, summary, vars, actions, full
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to
prepend the base path to all z/OSMF resources when making REST requests. Do not
specify this option if you are not using an API mediation layer.
-
--protocol
(string)
Profile Options
Base Connection Options
Examples
List a set of variables and their values for a given name.
Usage
zowe provisioning list instance-variables <name> [options]
Positional Arguments
-
name
(string)
- Provisioned Instance Name
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to
prepend the base path to all z/OSMF resources when making REST requests. Do not
specify this option if you are not using an API mediation layer.
-
--protocol
(string)
Profile Options
Base Connection Options
Response Format Options
-
--response-format-filter
| --rff
(array)
- Filter (include) fields in the response. Accepts an array of field/property
names to include in the output response. You can filter JSON objects properties
OR table columns/fields. In addition, you can use this option in conjunction
with '--response-format-type' to reduce the output of a command to a single
field/property or a list of a single field/property.
-
--response-format-type
| --rft
(string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is
an array of homogeneous JSON objects. Each property of the object will become a
column in the table.
list: Formats output data as a list of strings. Can be used on any data type
(JSON objects/arrays) are stringified and a new line is added after each entry
in an array.
object: Formats output data as a list of prettified objects (or single object).
Can be used in place of "table" to change from tabular output to a list of
prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header
| --rfh
(boolean)
- If "--response-format-type table" is specified, include the column headers
in the output.
Examples
List the provisioned instances from the z/OSMF software registry.
Usage
zowe provisioning list registry-instances [options]
Options
-
--all-info
| --ai
(boolean)
- Display all available information about provisioned instances (summary by
default).
-
--filter-by-type
| --fbt
(string)
- Filter the list of provisioned instances by type (e.g. DB2 or CICS).
-
--filter-by-external-name
| --fben
(string)
- Filter the list of provisioned instances by External Name.
-
--types
| -t
(boolean)
- Display a list of all types for provisioned instances (e.g. DB2 or CICS).
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to
prepend the base path to all z/OSMF resources when making REST requests. Do not
specify this option if you are not using an API mediation layer.
-
--protocol
(string)
Profile Options
Base Connection Options
Examples
List details about a template published with z/OSMF Cloud Provisioning.
Usage
zowe provisioning list template-info <name> [options]
Positional Arguments
-
name
(string)
- The name of a z/OSMF cloud provisioning template.
Options
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to
prepend the base path to all z/OSMF resources when making REST requests. Do not
specify this option if you are not using an API mediation layer.
-
--protocol
(string)
Profile Options
Base Connection Options
Examples
Perform actions against instances provisioned with z/OSMF.
Perform actions on instances previously provisioned with z/OSMF cloud
provisioning services. To view the list of provisioned instances, use the
"zowe provisioning list registry-instances" command. Once you have
obtained an instance name you can use the "zowe provisioning list
instance-info <name>" command to view the available instance actions.
Usage
zowe provisioning perform action <name> <actionname> [options]
Positional Arguments
-
name
(string)
- Provisioned Instance name.
-
actionname
(string)
- The action name. Use the "zowe provisioning list instance-info <name>"
command to view available instance actions.
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to
prepend the base path to all z/OSMF resources when making REST requests. Do not
specify this option if you are not using an API mediation layer.
-
--protocol
(string)
Profile Options
Base Connection Options
Examples
Using z/OSMF cloud provisioning services provision available templates.
Using z/OSMF cloud provisioning services, provision available templates.
You can view available templates using the zowe provisioning list
catalog-templates command.
Usage
zowe provisioning provision template <name> [options]
Positional Arguments
-
name
(string)
- The name of a z/OSMF cloud provisioning template.
Options
-
--properties
| -p
(string)
- A sequence of string enclosed "name=value" pairs of prompt variables.
e.g: "CSQ_MQ_SSID=ZCT1,CSQ_CMD_PFX=!ZCT1".
-
--properties-file
| --pf
(string)
- Path to .yml file containing properties.
-
--domain-name
| --dn
(string)
- Required if the user has consumer authorization to more than one domain with
this template name.
-
--tenant-name
| --tn
(string)
- Required if the user has consumer authorization to more than one tenant in the
same domain that contains this template name.
-
--user-data-id
| --udi
(string)
- ID for the user data specified with user-data. Passed into the software
services registry.
-
--user-data
| --ud
(string)
- User data that is passed into the software services registry. Can be specified
only if user-data-id is provided.
-
--account-info
| --ai
(string)
- Account information to use in the JCL JOB statement. The default is the account
information that is associated with the resource pool for the tenant.
-
--system-nick-names
| --snn
(string)
- Each string is the nickname of the system upon which to provision the software
service defined by the template. The field is required if the resource pool
associated with the tenant used for this operation is not set up to
automatically select a system. Only one nickname is allowed.If the field is
provided it is validated.
e.g: "SYSNAME1,SYSNAME2".
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to
prepend the base path to all z/OSMF resources when making REST requests. Do not
specify this option if you are not using an API mediation layer.
-
--protocol
(string)
Profile Options
Base Connection Options
Examples
Store credentials securely in profiles by encrypting them
Reverts all secure profiles to be stored in plain text
Usage
zowe secure-credential-store revert [options]
Required Options
Updates all plain text profiles to be securely stored
Usage
zowe secure-credential-store update [options]
Interact with z/OSMF console services. Issue z/OS console commands and collect
responses. z/OS console services establishes extended MCS (EMCS) consoles on
behalf of the user, which are used to issue the commands and collect responses.
Important! Before you use commands in the zos-console command group, ensure
that you understand the implications of issuing z/OS console commands in your
environment.
z/OSMF console services provides a command response key upon successful issue of
a console command. You can use this key to collect additional console message
responses.
The z/OSMF console REST APIs return a "solicited response key" after
successfully issuing a synchronous console command that produces solicited
responses. You can use the "solicited response key"on the "sync-responses"
command to collect any additional outstanding solicited responses from the
console the command was issued.
In general, when issuing a z/OS console command, z/OS applications route
responses to the originating console. The command response messages are
referred to as "solicited command responses" (i.e. direct responses to the
command issued). When issuing a z/OS console command using Zowe CLI, collection
of all solicited command responses is attempted by default. However, there is
no z/OS mechanism that indicates the total number of response messages that may
be produced from a given command. Therefore, the Zowe CLI console APIs return a
"solicited response key" that can be used to "follow-up" and collect any
additional solicited command responses.
Usage
zowe zos-console collect sync-responses <responsekey> [options]
Positional Arguments
-
responsekey
(string)
- The "solicited response key" provided in response to a previously issued console
command. Used by the z/OSMF console API to collect any additional outstanding
solicited responses from a previously issued console command. Must match
regular expression:
^\[a\-zA\-Z0\-9\]\+$
Options
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to
prepend the base path to all z/OSMF resources when making REST requests. Do not
specify this option if you are not using an API mediation layer.
-
--protocol
(string)
Profile Options
Base Connection Options
Examples
Issue z/OS console commands and optionally collect responses.
Issue a z/OS console command and print command responses (known as "solicited
command responses").
In general, when issuing a z/OS console command, z/OS applications route
responses to the originating console. The command response messages are
referred to as "solicited command responses" (i.e. direct responses to the
command issued). When issuing a z/OS console command using Zowe CLI, collection
of all solicited command responses is attempted by default. However, there is
no z/OS mechanism that indicates the total number of response messages that may
be produced from a given command. Therefore, the Zowe CLI console APIs return a
"solicited response key" that can be used to "follow-up" and collect any
additional solicited command responses.
Zowe CLI will issue "follow-up" API requests by default to collect any
additional outstanding solicited command responses until a request returns no
additional responses. At that time, Zowe CLI will attempt a final collection
attempt. If no messages are present, the command is complete. If additional
messages are present, the process is repeated. However, this does not guarantee
that all messages produced in direct response (i.e. solicited) have been
collected. The z/OS application may produce additional messages in direct
response to your command at some point in the future. You can manually collect
additional responses using the "command response key" OR specify additional
processing options to, for example, delay collection attempts by a specified
interval.
Usage
zowe zos-console issue command <commandtext> [options]
Positional Arguments
-
commandtext
(string)
- The z/OS console command to issue.
Options
-
--console-name
| --cn
| -c
(string)
-
The name of the z/OS extended MCS console to direct the command. You must have
the required authority to access the console specified. You may also specify an
arbitrary name, if your installation allows dynamic creation of consoles with
arbitrary names.
Allowed values: ^[a-zA-Z0-9]+$
-
--include-details
| --id
| -i
(boolean)
- Include additional details at the end of the Zowe CLI command response, such as
the "command response key" and the z/OSMF command response URL.
-
--key-only
| --ko
| -k
(boolean)
- Displays only the "command response key" returned from the z/OSMF console API.
You can collect additional messages using the command key with 'zowe
zos-console collect sync-responses <key>'. Note that when using this option,
you will not be presented with the "first set" of command response messages (if
present in the API response). However, you can view them by using the
--response-format-json option.
-
--return-first
| --rf
| -r
(boolean)
- Indicates that Zowe CLI should return immediately with the response message set
returned in the first z/OSMF API request (even if no responses are present).
Using this option may result in partial or no response, but quicker Zowe CLI
command response time. The z/OSMF console API has an implicit wait when
collecting the first set of console command responses, i.e you will normally
receive at least one set of response messages.
-
--solicited-keyword
| --sk
| -s
(string)
- For solicited responses (direct command responses) the response is considered
complete if the keyword specified is present. If the keyword is detected, the
command will immediately return, meaning the full command response may not be
provided. The key only applies to the first request issued, follow up requests
do not support searching for the keyword.
-
--sysplex-system
| --ss
| --sys
(string)
- Specifies the z/OS system (LPAR) in the current SYSPLEX (where your target
z/OSMF resides) to route the z/OS console command.
-
--wait-to-collect
| --wtc
| -w
(number)
- Indicates that Zowe CLI wait at least the specified number of seconds before
attempting to collect additional solicited response messages. If additional
messages are collected on "follow-up" requests, the timer is reset until an
attempt is made that results in no additional response messages.
-
--follow-up-attempts
| --fua
| -a
(number)
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to
prepend the base path to all z/OSMF resources when making REST requests. Do not
specify this option if you are not using an API mediation layer.
-
--protocol
(string)
Profile Options
Base Connection Options
Examples
-
Issue a z/OS console command to display the IPL information
for the system:
zowe zos-console issue command "D IPLINFO"
-
Issue a z/OS console command to display the local and
coordinated universal time and date:
zowe zos-console issue command "D T"
-
Issue a Db2 command to display information about the status
and configuration of DDF:
zowe zos-console issue command "\-DB1G DISPLAY DDF"
Manage z/OS data sets, create data sets, and more.
Copy a 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)
Options
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to
prepend the base path to all z/OSMF resources when making REST requests. Do not
specify this option if you are not using an API mediation layer.
-
--protocol
(string)
Profile Options
Base Connection Options
Examples
-
Copy the data set named 'USER.FROM.SET' to the data set
named 'USER.TO.SET':
zowe zos-files copy data-set "USER.FROM.SET" "USER.TO.SET"
-
Copy the data set member named 'USER.FROM.SET(MEM1)' to
the data set member named 'USER.TO.SET(MEM2)':
zowe zos-files copy data-set "USER.FROM.SET(mem1)" "USER.TO.SET(mem2)"
-
Copy the data set named 'USER.FROM.SET' to the data set
member named 'USER.TO.SET(MEM2)':
zowe zos-files copy data-set "USER.FROM.SET" "USER.TO.SET(mem2)"
-
Copy the data set member named 'USER.FROM.SET(MEM1)' to
the data set named 'USER.TO.SET':
zowe zos-files copy data-set "USER.FROM.SET(mem1)" "USER.TO.SET"
-
Copy the data set named 'USER.FROM.SET' to the data set
named 'USER.TO.SET' and replace like-named members:
zowe zos-files copy data-set "USER.FROM.SET" "USER.TO.SET" --replace
Create data sets.
Create data sets based on the properties of an existing data set
Usage
zowe zos-files create data-set <dataSetName> [options]
Positional Arguments
-
dataSetName
(string)
- The name of the data set that you want to create
Options
-
--block-size
| --bs
| --blksize
(number)
- The block size for the data set (for example, 6160)
-
--data-class
| --dc
(string)
- The SMS data class to use for the allocation
-
--data-set-type
| --dst
| --dsntype
(string)
- The data set type (BASIC, EXTPREF, EXTREQ, HFS, LARGE, PDS, LIBRARY, PIPE)
-
--device-type
| --dt
| --unit
(string)
- The device type, also known as 'unit'
-
--directory-blocks
| --db
| --dirblks
(number)
- The number of directory blocks (for example, 25)
-
--like
| --lk
(string)
- Name of an existing data set to base your new data set's properties on
-
--management-class
| --mc
(string)
- The SMS management class to use for the allocation
-
--primary-space
| --ps
(number)
- The primary space allocation (for example, 5)
-
--record-format
| --rf
| --recfm
(string)
- The record format for the data set (for example, FB for "Fixed Block")
-
--record-length
| --rl
| --lrecl
(number)
- The logical record length. Analogous to the length of a line (for example, 80)
-
--secondary-space
| --ss
(number)
- The secondary space allocation (for example, 1)
-
--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
| --volser
(string)
- The volume serial (VOLSER) on which you want the data set to be placed. A
VOLSER is analogous to a drive name on a PC.
-
--response-timeout
| --rto
(number)
- The maximum amount of time in seconds the z/OSMF Files TSO servlet should run
before returning a response. Any request exceeding this amount of time will be
terminated and return an error. Allowed values: 5 - 600
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to
prepend the base path to all z/OSMF resources when making REST requests. Do not
specify this option if you are not using an API mediation layer.
-
--protocol
(string)
Profile Options
Base Connection Options
Examples
-
Create a data set with default parameters and like flag:
zowe zos-files create data-set NEW.DATASET --like EXISTING.DATASET
-
Create a data set with default parameters and like flag and
lrecl flag:
zowe zos-files create data-set NEW.DATASET --like EXISTING.DATASET --lrecl 1024
-
Create a data set with type LIBRARY:
zowe zos-files create data-set NEW.DATASET --data-set-type LIBRARY
Create executable data sets
Usage
zowe zos-files create data-set-binary <dataSetName> [options]
Positional Arguments
-
dataSetName
(string)
- The name of the data set that you want to create
Options
-
--block-size
| --bs
| --blksize
(number)
-
--data-class
| --dc
(string)
- The SMS data class to use for the allocation
-
--data-set-type
| --dst
| --dsntype
(string)
- The data set type (BASIC, EXTPREF, EXTREQ, HFS, LARGE, PDS, LIBRARY, PIPE)
-
--device-type
| --dt
| --unit
(string)
- The device type, also known as 'unit'
-
--directory-blocks
| --db
| --dirblks
(number)
-
--management-class
| --mc
(string)
- The SMS management class to use for the allocation
-
--primary-space
| --ps
(number)
-
--record-format
| --rf
| --recfm
(string)
-
--record-length
| --rl
| --lrecl
(number)
-
--secondary-space
| --ss
(number)
- The secondary space allocation (for example, 1)
-
--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
| --volser
(string)
- The volume serial (VOLSER) on which you want the data set to be placed. A
VOLSER is analogous to a drive name on a PC.
-
--response-timeout
| --rto
(number)
- The maximum amount of time in seconds the z/OSMF Files TSO servlet should run
before returning a response. Any request exceeding this amount of time will be
terminated and return an error. Allowed values: 5 - 600
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to
prepend the base path to all z/OSMF resources when making REST requests. Do not
specify this option if you are not using an API mediation layer.
-
--protocol
(string)
Profile Options
Base Connection Options
Examples
Create data sets for C code programming
Usage
zowe zos-files create data-set-c <dataSetName> [options]
Positional Arguments
-
dataSetName
(string)
- The name of the data set that you want to create
Options
-
--block-size
| --bs
| --blksize
(number)
-
--data-class
| --dc
(string)
- The SMS data class to use for the allocation
-
--data-set-type
| --dst
| --dsntype
(string)
- The data set type (BASIC, EXTPREF, EXTREQ, HFS, LARGE, PDS, LIBRARY, PIPE)
-
--device-type
| --dt
| --unit
(string)
- The device type, also known as 'unit'
-
--directory-blocks
| --db
| --dirblks
(number)
-
--management-class
| --mc
(string)
- The SMS management class to use for the allocation
-
--primary-space
| --ps
(number)
-
--record-format
| --rf
| --recfm
(string)
-
--record-length
| --rl
| --lrecl
(number)
-
--secondary-space
| --ss
(number)
- The secondary space allocation (for example, 1)
-
--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
| --volser
(string)
- The volume serial (VOLSER) on which you want the data set to be placed. A
VOLSER is analogous to a drive name on a PC.
-
--response-timeout
| --rto
(number)
- The maximum amount of time in seconds the z/OSMF Files TSO servlet should run
before returning a response. Any request exceeding this amount of time will be
terminated and return an error. Allowed values: 5 - 600
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to
prepend the base path to all z/OSMF resources when making REST requests. Do not
specify this option if you are not using an API mediation layer.
-
--protocol
(string)
Profile Options
Base Connection Options
Examples
Create classic data sets (JCL, HLASM, CBL, etc...)
Usage
zowe zos-files create data-set-classic <dataSetName> [options]
Positional Arguments
-
dataSetName
(string)
- The name of the data set that you want to create
Options
-
--block-size
| --bs
| --blksize
(number)
-
--data-class
| --dc
(string)
- The SMS data class to use for the allocation
-
--data-set-type
| --dst
| --dsntype
(string)
- The data set type (BASIC, EXTPREF, EXTREQ, HFS, LARGE, PDS, LIBRARY, PIPE)
-
--device-type
| --dt
| --unit
(string)
- The device type, also known as 'unit'
-
--directory-blocks
| --db
| --dirblks
(number)
-
--management-class
| --mc
(string)
- The SMS management class to use for the allocation
-
--primary-space
| --ps
(number)
-
--record-format
| --rf
| --recfm
(string)
-
--record-length
| --rl
| --lrecl
(number)
-
--secondary-space
| --ss
(number)
- The secondary space allocation (for example, 1)
-
--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
| --volser
(string)
- The volume serial (VOLSER) on which you want the data set to be placed. A
VOLSER is analogous to a drive name on a PC.
-
--response-timeout
| --rto
(number)
- The maximum amount of time in seconds the z/OSMF Files TSO servlet should run
before returning a response. Any request exceeding this amount of time will be
terminated and return an error. Allowed values: 5 - 600
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to
prepend the base path to all z/OSMF resources when making REST requests. Do not
specify this option if you are not using an API mediation layer.
-
--protocol
(string)
Profile Options
Base Connection Options
Examples
Create partitioned data sets (PDS)
Usage
zowe zos-files create data-set-partitioned <dataSetName> [options]
Positional Arguments
-
dataSetName
(string)
- The name of the data set that you want to create
Options
-
--block-size
| --bs
| --blksize
(number)
-
--data-class
| --dc
(string)
- The SMS data class to use for the allocation
-
--data-set-type
| --dst
| --dsntype
(string)
- The data set type (BASIC, EXTPREF, EXTREQ, HFS, LARGE, PDS, LIBRARY, PIPE)
-
--device-type
| --dt
| --unit
(string)
- The device type, also known as 'unit'
-
--directory-blocks
| --db
| --dirblks
(number)
-
--management-class
| --mc
(string)
- The SMS management class to use for the allocation
-
--primary-space
| --ps
(number)
-
--record-format
| --rf
| --recfm
(string)
-
--record-length
| --rl
| --lrecl
(number)
-
--secondary-space
| --ss
(number)
- The secondary space allocation (for example, 1)
-
--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
| --volser
(string)
- The volume serial (VOLSER) on which you want the data set to be placed. A
VOLSER is analogous to a drive name on a PC.
-
--response-timeout
| --rto
(number)
- The maximum amount of time in seconds the z/OSMF Files TSO servlet should run
before returning a response. Any request exceeding this amount of time will be
terminated and return an error. Allowed values: 5 - 600
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to
prepend the base path to all z/OSMF resources when making REST requests. Do not
specify this option if you are not using an API mediation layer.
-
--protocol
(string)
Profile Options
Base Connection Options
Examples
Create physical sequential data sets (PS)
Usage
zowe zos-files create data-set-sequential <dataSetName> [options]
Positional Arguments
-
dataSetName
(string)
- The name of the data set that you want to create
Options
-
--block-size
| --bs
| --blksize
(number)
-
--data-class
| --dc
(string)
- The SMS data class to use for the allocation
-
--device-type
| --dt
| --unit
(string)
- The device type, also known as 'unit'
-
--directory-blocks
| --db
| --dirblks
(number)
- The number of directory blocks (for example, 25)
-
--management-class
| --mc
(string)
- The SMS management class to use for the allocation
-
--primary-space
| --ps
(number)
-
--record-format
| --rf
| --recfm
(string)
-
--record-length
| --rl
| --lrecl
(number)
-
--secondary-space
| --ss
(number)
- The secondary space allocation (for example, 1)
-
--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
| --volser
(string)
- The volume serial (VOLSER) on which you want the data set to be placed. A
VOLSER is analogous to a drive name on a PC.
-
--response-timeout
| --rto
(number)
- The maximum amount of time in seconds the z/OSMF Files TSO servlet should run
before returning a response. Any request exceeding this amount of time will be
terminated and return an error. Allowed values: 5 - 600
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to
prepend the base path to all z/OSMF resources when making REST requests. Do not
specify this option if you are not using an API mediation layer.
-
--protocol
(string)
Profile Options
Base Connection Options
Examples
Create a VSAM cluster
Usage
zowe zos-files create data-set-vsam <dataSetName> [options]
Positional Arguments
-
dataSetName
(string)
- The name of the 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
| --dsorg
(string)
-
The data set organization.
Default value: INDEXED
Allowed values: INDEXED, IXD, LINEAR, LIN, NONINDEXED, NIXD, NUMBERED, NUMD, ZFS
-
--management-class
| --mc
(string)
- The SMS management class to use for the allocation
-
--retain-for
| --rf
(number)
- The number of days that the VSAM cluster will be retained on the system. You
can delete the cluster at any time when neither retain-for nor retain-to is
specified.
-
--retain-to
| --rt
(string)
- The earliest date that a command without the PURGE parameter can delete an
entry. Specify the expiration date in the form yyyyddd, where yyyy is a
four-digit year (maximum value: 2155) and ddd is the three-digit day of the
year from 001 through 365 (for non-leap years) or 366 (for leap years). You
can delete the cluster at any time when neither retain-for nor retain-to is
used. You cannot specify both the 'retain-to' and 'retain-for' options.
-
--secondary-space
| --ss
(number)
- The number of items for the secondary space allocation (for example, 840). The
type of item allocated is the same as the type used for the '--size' option.
If you do not specify a secondary allocation, a value of ~10% of the primary
allocation is used.
-
--show-attributes
| --pa
(boolean)
- Show the full allocation attributes
-
--size
| --sz
(string)
-
--storage-class
| --sc
(string)
- The SMS storage class to use for the allocation
-
--volumes
| -v
(string)
- The storage volumes on which to allocate a VSAM cluster. Specify a single
volume by its volume serial (VOLSER). To specify more than one volume, enclose
the option in double-quotes and separate each VOLSER with a space. You must
specify the volumes option when your cluster is not SMS-managed.
-
--response-timeout
| --rto
(number)
- The maximum amount of time in seconds the z/OSMF Files TSO servlet should run
before returning a response. Any request exceeding this amount of time will be
terminated and return an error. Allowed values: 5 - 600
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to
prepend the base path to all z/OSMF resources when making REST requests. Do not
specify this option if you are not using an API mediation layer.
-
--protocol
(string)
Profile Options
Base Connection Options
Examples
-
Create a VSAM data set named "SOME.DATA.SET.NAME" using
default values of INDEXED, 840 KB primary storage and 84 KB secondary storage:
zowe zos-files create data-set-vsam SOME.DATA.SET.NAME
-
Create a 5 MB LINEAR VSAM data set named
"SOME.DATA.SET.NAME" with 1 MB of secondary space. Show the properties of
the data set when it is created:
zowe zos-files create data-set-vsam SOME.DATA.SET.NAME --data-set-organization LINEAR --size 5MB --secondary-space 1 --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
Create a UNIX directory.
Usage
zowe zos-files create uss-directory <ussPath> [options]
Positional Arguments
-
ussPath
(string)
- The name of the directory that you want to create.
Options
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to
prepend the base path to all z/OSMF resources when making REST requests. Do not
specify this option if you are not using an API mediation layer.
-
--protocol
(string)
Profile Options
Base Connection Options
Examples
Create a UNIX file.
Usage
zowe zos-files create uss-file <ussPath> [options]
Positional Arguments
-
ussPath
(string)
- The name of the file that you want to create.
Options
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to
prepend the base path to all z/OSMF resources when making REST requests. Do not
specify this option if you are not using an API mediation layer.
-
--protocol
(string)
Profile Options
Base Connection Options
Examples
Create a z/OS file system.
Usage
zowe zos-files create zos-file-system <fileSystemName> [options]
Positional Arguments
-
fileSystemName
(string)
- The name of the file system to create.
Options
-
--cyls-pri
| --cp
(number)
-
--cyls-sec
| --cs
(number)
-
--data-class
| --dc
(string)
- The SMS data class to use for the allocation
-
--group
| -g
(string)
- The z/OS group ID or GID for the group of the ZFS root directory.
-
--management-class
| --mc
(string)
- The SMS management class to use for the allocation
-
--owner
| -o
(string)
- The z/OS user ID or UID for the owner of the ZFS root directory.
-
--perms
| -p
(number)
-
--storage-class
| --sc
(string)
- The SMS storage class to use for the allocation
-
--timeout
| -t
(number)
-
--volumes
| -v
(array)
- The storage volumes on which to allocate the z/OS file system. Specify a single
volume by its volume serial (VOLSER). To specify more than one volume, separate
each VOLSER with a space. You must specify the volumes option when your cluster
is not SMS-managed.
-
--response-timeout
| --rto
(number)
- The maximum amount of time in seconds the z/OSMF Files TSO servlet should run
before returning a response. Any request exceeding this amount of time will be
terminated and return an error. Allowed values: 5 - 600
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to
prepend the base path to all z/OSMF resources when making REST requests. Do not
specify this option if you are not using an API mediation layer.
-
--protocol
(string)
Profile Options
Base Connection Options
Examples
-
Create a ZFS named "HLQ.MYNEW.ZFS" using default values of
755 permissions, 10 primary and 2 secondary cylinders allocated, and a timeout
of 20 seconds:
zowe zos-files create zos-file-system HLQ.MYNEW.ZFS
-
Create a ZFS with 100 primary and 10 secondary cylinders
allocated:
zowe zos-files create zos-file-system HLQ.MYNEW.ZFS --cp 100 --cs 10
-
Create a ZFS specifying the volumes that should be used:
zowe zos-files create zos-file-system HLQ.MYNEW.ZFS -v ZFS001 ZFS002
Delete a data set or Unix System Services file.
Delete a data set or data set member permanently
Usage
zowe zos-files delete data-set <dataSetName> [options]
Positional Arguments
-
dataSetName
(string)
- The name of the data set that you want to delete
Required Options
Options
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to
prepend the base path to all z/OSMF resources when making REST requests. Do not
specify this option if you are not using an API mediation layer.
-
--protocol
(string)
Profile Options
Base Connection Options
Examples
Delete a VSAM cluster permanently
Usage
zowe zos-files delete data-set-vsam <dataSetName> [options]
Positional Arguments
-
dataSetName
(string)
- The name of the VSAM cluster that you want to delete
Options
Required Options
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to
prepend the base path to all z/OSMF resources when making REST requests. Do not
specify this option if you are not using an API mediation layer.
-
--protocol
(string)
Profile Options
Base Connection Options
Examples
-
Delete the VSAM data set named 'ibmuser.cntl.vsam':
zowe zos-files delete data-set-vsam "ibmuser.cntl.vsam" -f
-
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
Delete migrated data sets.
Usage
zowe zos-files delete migrated-data-set <dataSetName> [options]
Positional Arguments
-
dataSetName
(string)
- The name of the migrated data set you want to delete.
Options
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to
prepend the base path to all z/OSMF resources when making REST requests. Do not
specify this option if you are not using an API mediation layer.
-
--protocol
(string)
Profile Options
Base Connection Options
Examples
Delete a Unix Systems Services (USS) File or directory permanently
Usage
zowe zos-files delete uss-file <fileName> [options]
Positional Arguments
-
fileName
(string)
- The name of the file or directory that you want to delete
Required Options
Options
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to
prepend the base path to all z/OSMF resources when making REST requests. Do not
specify this option if you are not using an API mediation layer.
-
--protocol
(string)
Profile Options
Base Connection Options
Examples
-
Delete the empty directory '/u/ibmuser/testcases':
zowe zos-files delete uss-file "/a/ibmuser/testcases" -f
-
Delete the file named '/a/ibmuser/my_text.txt':
zowe zos-files delete uss-file "/a/ibmuser/testcases/my_text.txt" -f
-
Recursively delete the directory named
'/u/ibmuser/testcases':
zowe zos-files delete uss-file "/a/ibmuser/testcases" -rf
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
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to
prepend the base path to all z/OSMF resources when making REST requests. Do not
specify this option if you are not using an API mediation layer.
-
--protocol
(string)
Options
Profile Options
Base Connection Options
Examples
Download content from z/OS data sets and USS files to your PC.
Download all members from a partitioned data set to a local folder
Usage
zowe zos-files download all-members <dataSetName> [options]
Positional Arguments
-
dataSetName
(string)
- The name of the data set from which you want to download members
Options
-
--binary
| -b
(boolean)
- Download the file content in binary mode, which means that no data conversion is
performed. The data transfer process returns each line as-is, without
translation. No delimiters are added between records.
-
--directory
| -d
(string)
- The directory to where you want to save the members. The command creates the
directory for you when it does not already exist. By default, the command
creates a folder structure based on the data set qualifiers. For example, the
data set ibmuser.new.cntl's members are downloaded to ibmuser/new/cntl).
-
--encoding
| --ec
(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)
-
--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)
-
--volume-serial
| --vs
(string)
- The volume serial (VOLSER) where the data set resides. You can use this option
at any time. However, the VOLSER is required only when the data set is not
cataloged on the system. A VOLSER is analogous to a drive name on a PC.
-
--response-timeout
| --rto
(number)
- The maximum amount of time in seconds the z/OSMF Files TSO servlet should run
before returning a response. Any request exceeding this amount of time will be
terminated and return an error. Allowed values: 5 - 600
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to
prepend the base path to all z/OSMF resources when making REST requests. Do not
specify this option if you are not using an API mediation layer.
-
--protocol
(string)
Profile Options
Base Connection Options
Examples
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)
-
--volume-serial
| --vs
(string)
- The volume serial (VOLSER) where the data set resides. You can use this option
at any time. However, the VOLSER is required only when the data set is not
cataloged on the system. A VOLSER is analogous to a drive name on a PC.
-
--response-timeout
| --rto
(number)
- The maximum amount of time in seconds the z/OSMF Files TSO servlet should run
before returning a response. Any request exceeding this amount of time will be
terminated and return an error. Allowed values: 5 - 600
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to
prepend the base path to all z/OSMF resources when making REST requests. Do not
specify this option if you are not using an API mediation layer.
-
--protocol
(string)
Profile Options
Base Connection Options
Examples
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
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to
prepend the base path to all z/OSMF resources when making REST requests. Do not
specify this option if you are not using an API mediation layer.
-
--protocol
(string)
Profile Options
Base Connection Options
Examples
Invoke z/OS utilities such as Access Method Services (AMS).
Submit control statements for execution by Access Method Services (IDCAMS). You
can use IDCAMS to create VSAM data sets (CSI, ZFS, etc...), delete data sets,
and more. You must format the control statements exactly as the IDCAMS utility
expects. For more information about control statements, see the IBM publication
'z/OS DFSMS Access Method Services Commands'.
Usage
zowe zos-files invoke ams-file <controlStatementsFile> [options]
Positional Arguments
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to
prepend the base path to all z/OSMF resources when making REST requests. Do not
specify this option if you are not using an API mediation layer.
-
--protocol
(string)
Options
Profile Options
Base Connection Options
Examples
Submit control statements for execution by Access Method Services (IDCAMS). You
can use IDCAMS to create VSAM data sets (CSI, ZFS, etc...), delete data sets,
and more. You must format the control statements exactly as the IDCAMS utility
expects. For more information about control statements, see the IBM publication
'z/OS DFSMS Access Method Services Commands'.
Usage
zowe zos-files invoke ams-statements <controlStatements> [options]
Positional Arguments
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to
prepend the base path to all z/OSMF resources when making REST requests. Do not
specify this option if you are not using an API mediation layer.
-
--protocol
(string)
Options
Profile Options
Base Connection Options
Examples
List data sets and data set members. Optionally, you can list their details and
attributes.
List all members of a partitioned data set. To view additional information
about each member, use the --attributes option under the Options section of
this help text.
Usage
zowe zos-files list all-members <dataSetName> [options]
Positional Arguments
-
dataSetName
(string)
- The name of the data set for which you want to list the members
Options
-
--attributes
| -a
(boolean)
- Display more information about each member. Data sets with an undefined record
format display information related to executable modules. Variable and fixed
block data sets display information about when the members were created and
modified.
-
--max-length
| --max
(number)
- The option --max-length specifies the maximum number of items to return.
Skip this parameter to return all items. If you specify an incorrect value, the
parameter returns up to 1000 items.
-
--pattern
(string)
- The option --pattern specifies the match pattern used when listing members in
a data set. The default is to match against all members, e.g. "*".
-
--response-timeout
| --rto
(number)
- The maximum amount of time in seconds the z/OSMF Files TSO servlet should run
before returning a response. Any request exceeding this amount of time will be
terminated and return an error. Allowed values: 5 - 600
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to
prepend the base path to all z/OSMF resources when making REST requests. Do not
specify this option if you are not using an API mediation layer.
-
--protocol
(string)
Profile Options
Base Connection Options
Examples
-
Show members of the data set "ibmuser.asm":
zowe zos-files list all-members "ibmuser.asm"
-
Show attributes of members of the data set "ibmuser.cntl":
zowe zos-files list all-members "ibmuser.cntl" -a
-
Show the first 5 members of the data set "ibmuser.cntl":
zowe zos-files list all-members "ibmuser.cntl" --max 5
-
Show the first 4 members of the data set "ibmuser.cntl"
matching an input pattern":
zowe zos-files list all-members "sys1.maclib" --pattern IJK* --max 4
List data sets that match a pattern in the data set name
Usage
zowe zos-files list data-set <dataSetName> [options]
Positional Arguments
-
dataSetName
(string)
- The name or pattern of the data set that you want to list
Options
-
--attributes
| -a
(boolean)
- Display more information about each member. Data sets with an undefined record
format display information related to executable modules. Variable and fixed
block data sets display information about when the members were created and
modified.
-
--max-length
| --max
(number)
- The option --max-length specifies the maximum number of items to return.
Skip this parameter to return all items. If you specify an incorrect value, the
parameter returns up to 1000 items.
-
--volume-serial
| --vs
(string)
- The volume serial (VOLSER) where the data set resides. You can use this option
at any time. However, the VOLSER is required only when the data set is not
cataloged on the system. A VOLSER is analogous to a drive name on a PC.
-
--start
| -s
(string)
- An optional search parameter that specifies the first data set name to return in
the response document.
-
--response-timeout
| --rto
(number)
- The maximum amount of time in seconds the z/OSMF Files TSO servlet should run
before returning a response. Any request exceeding this amount of time will be
terminated and return an error. Allowed values: 5 - 600
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to
prepend the base path to all z/OSMF resources when making REST requests. Do not
specify this option if you are not using an API mediation layer.
-
--protocol
(string)
Profile Options
Base Connection Options
Examples
-
Show the data set "ibmuser.asm":
zowe zos-files list data-set "ibmuser.asm"
-
Show attributes of the data set "ibmuser.cntl":
zowe zos-files list data-set "ibmuser.cntl" -a
-
Show all data sets of the user "ibmuser":
zowe zos-files list data-set "ibmuser.*"
-
Show attributes of all data sets of the user "ibmuser":
zowe zos-files list data-set "ibmuser.*" -a
-
Show the first 5 data sets of the user "ibmuser":
zowe zos-files list data-set "ibmuser.cntl" --max 5
List all mounted filesystems, or the specific filesystem mounted at a given
path, or the filesystem with a given filesystem name.
Usage
zowe zos-files list file-system [options]
Options
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to
prepend the base path to all z/OSMF resources when making REST requests. Do not
specify this option if you are not using an API mediation layer.
-
--protocol
(string)
Profile Options
Base Connection Options
Response Format Options
-
--response-format-filter
| --rff
(array)
- Filter (include) fields in the response. Accepts an array of field/property
names to include in the output response. You can filter JSON objects properties
OR table columns/fields. In addition, you can use this option in conjunction
with '--response-format-type' to reduce the output of a command to a single
field/property or a list of a single field/property.
-
--response-format-type
| --rft
(string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is
an array of homogeneous JSON objects. Each property of the object will become a
column in the table.
list: Formats output data as a list of strings. Can be used on any data type
(JSON objects/arrays) are stringified and a new line is added after each entry
in an array.
object: Formats output data as a list of prettified objects (or single object).
Can be used in place of "table" to change from tabular output to a list of
prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header
| --rfh
(boolean)
- If "--response-format-type table" is specified, include the column headers
in the output.
Examples
-
To list all mounted filesystems:
zowe zos-files list file-system
-
To list filesystems mounted to a specific path:
zowe zos-files list file-system -p /a/ibmuser
-
To list filesystems mounted with a specific name:
zowe zos-files list file-system -f MY.ZFS
List USS files and directories in a UNIX file path
Usage
zowe zos-files list uss-files <path> [options]
Positional Arguments
-
path
(string)
- The directory containing the files and directories to be listed
Options
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to
prepend the base path to all z/OSMF resources when making REST requests. Do not
specify this option if you are not using an API mediation layer.
-
--protocol
(string)
Profile Options
Base Connection Options
Response Format Options
-
--response-format-filter
| --rff
(array)
- Filter (include) fields in the response. Accepts an array of field/property
names to include in the output response. You can filter JSON objects properties
OR table columns/fields. In addition, you can use this option in conjunction
with '--response-format-type' to reduce the output of a command to a single
field/property or a list of a single field/property.
-
--response-format-type
| --rft
(string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is
an array of homogeneous JSON objects. Each property of the object will become a
column in the table.
list: Formats output data as a list of strings. Can be used on any data type
(JSON objects/arrays) are stringified and a new line is added after each entry
in an array.
object: Formats output data as a list of prettified objects (or single object).
Can be used in place of "table" to change from tabular output to a list of
prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header
| --rfh
(boolean)
- If "--response-format-type table" is specified, include the column headers
in the output.
Examples
-
Show the files and directories in path '/u/ibmuser':
zowe zos-files list uss-files "/u/ibmuser"
-
Show the files and directories in path '/u/ibmuser
displaying only the file or directory name:
zowe zos-files list uss-files "/u/ibmuser" --rff name
-
Show the files and directories in path '/u/ibmuser'
displaying the headers associated with the file detail:
zowe zos-files list uss-files "/u/ibmuser" --rfh
Migrate data sets.
Migrate a data set.
Usage
zowe zos-files migrate data-set <dataSetName> [options]
Positional Arguments
-
dataSetName
(string)
- The name of the data set you want to migrate.
Options
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to
prepend the base path to all z/OSMF resources when making REST requests. Do not
specify this option if you are not using an API mediation layer.
-
--protocol
(string)
Profile Options
Base Connection Options
Examples
Mount z/OS UNIX file systems, such as HFS, ZFS, and more. This connects you to
USS file systems.
Mount a UNIX file system on a specified directory.
Usage
zowe zos-files mount file-system <fileSystemName> <mountPoint> [options]
Positional Arguments
-
fileSystemName
(string)
- The name of the file system to mount.
-
mountPoint
(string)
- The directory to use as a mount point.
Options
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to
prepend the base path to all z/OSMF resources when making REST requests. Do not
specify this option if you are not using an API mediation layer.
-
--protocol
(string)
Profile Options
Base Connection Options
Examples
Recall migrated data sets.
Recall a migrated data set.
Usage
zowe zos-files recall data-set <dataSetName> [options]
Positional Arguments
-
dataSetName
(string)
- The name of the data set you want to recall.
Options
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to
prepend the base path to all z/OSMF resources when making REST requests. Do not
specify this option if you are not using an API mediation layer.
-
--protocol
(string)
Profile Options
Base Connection Options
Examples
Rename a data set or member.
Rename a data set.
Usage
zowe zos-files rename data-set <beforeDataSetName> <afterDataSetName> [options]
Positional Arguments
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to
prepend the base path to all z/OSMF resources when making REST requests. Do not
specify this option if you are not using an API mediation layer.
-
--protocol
(string)
Options
Profile Options
Base Connection Options
Examples
Rename a data set member.
Usage
zowe zos-files rename data-set-member <dataSetName> <beforeMemberName> <afterMemberName> [options]
Positional Arguments
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to
prepend the base path to all z/OSMF resources when making REST requests. Do not
specify this option if you are not using an API mediation layer.
-
--protocol
(string)
Options
Profile Options
Base Connection Options
Examples
Unmount file systems, such as HFS, ZFS, and more. This disconnects you from USS
file systems.
Unmount a UNIX file system.
Usage
zowe zos-files unmount file-system <fileSystemName> [options]
Positional Arguments
-
fileSystemName
(string)
- The name of the file system to unmount.
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to
prepend the base path to all z/OSMF resources when making REST requests. Do not
specify this option if you are not using an API mediation layer.
-
--protocol
(string)
Options
Profile Options
Base Connection Options
Examples
Upload the contents of a file to data sets.
Upload files from a local directory to a partitioned data set (PDS)
Usage
zowe zos-files upload dir-to-pds <inputdir> <dataSetName> [options]
Positional Arguments
-
inputdir
(string)
- The path for a local directory that you want to upload to a PDS
-
dataSetName
(string)
- The name of the partitioned data set to which you want to upload the files
Options
-
--binary
| -b
(boolean)
- Data content in binary mode, which means that no data conversion is performed.
The data transfer process returns each record as-is, without translation. No
delimiters are added between records.
-
--encoding
| --ec
(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.
-
--response-timeout
| --rto
(number)
- The maximum amount of time in seconds the z/OSMF Files TSO servlet should run
before returning a response. Any request exceeding this amount of time will be
terminated and return an error. Allowed values: 5 - 600
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to
prepend the base path to all z/OSMF resources when making REST requests. Do not
specify this option if you are not using an API mediation layer.
-
--protocol
(string)
Profile Options
Base Connection Options
Examples
Upload a local directory to a USS directory.
An optional .zosattributes file in the source directory can be used to control
file conversion and tagging.
An example .zosattributes file:
# pattern local-encoding remote-encoding
# Don't upload the node_modules directory
.* -
*.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
-
--response-timeout
| --rto
(number)
- The maximum amount of time in seconds the z/OSMF Files TSO servlet should run
before returning a response. Any request exceeding this amount of time will be
terminated and return an error. Allowed values: 5 - 600
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to
prepend the base path to all z/OSMF resources when making REST requests. Do not
specify this option if you are not using an API mediation layer.
-
--protocol
(string)
Profile Options
Base Connection Options
Examples
-
Upload all files from the "local_dir" directory to the
"/a/ibmuser/my_dir" USS directory:":
zowe zos-files upload dir-to-uss "local_dir" "/a/ibmuser/my_dir"
-
Upload all files from the "local_dir" directory and all its
sub-directories, to the "/a/ibmuser/my_dir" USS directory::
zowe zos-files upload dir-to-uss "local_dir" "/a/ibmuser/my_dir" --recursive
-
Upload all files from the "local_dir" directory to the
"/a/ibmuser/my_dir" USS directory in default ASCII mode, while specifying a
list of file names (without path) to be uploaded in binary mode::
zowe zos-files upload dir-to-uss "local_dir" "/a/ibmuser/my_dir" --binary-files "myFile1.exe,myFile2.exe,myFile3.exe"
-
Upload all files from the "local_dir" directory to the
"/a/ibmuser/my_dir" USS directory in binary mode, while specifying a list of
file names (without path) to be uploaded in ASCII mode::
zowe zos-files upload dir-to-uss "local_dir" "/a/ibmuser/my_dir" --binary --ascii-files "myFile1.txt,myFile2.txt,myFile3.txt"
-
Recursively upload all files from the "local_dir" directory
to the "/a/ibmuser/my_dir" USS directory, specifying files to ignore and file
encodings in the local file my_global_attributes::
zowe zos-files upload dir-to-uss "local_dir" "/a/ibmuser/my_dir" --recursive --attributes my_global_attributes
Upload 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.
-
--response-timeout
| --rto
(number)
- The maximum amount of time in seconds the z/OSMF Files TSO servlet should run
before returning a response. Any request exceeding this amount of time will be
terminated and return an error. Allowed values: 5 - 600
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to
prepend the base path to all z/OSMF resources when making REST requests. Do not
specify this option if you are not using an API mediation layer.
-
--protocol
(string)
Profile Options
Base Connection Options
Examples
-
Upload file contents to a sequential data set named
"ibmuser.ps":
zowe zos-files upload file-to-data-set "file.txt" "ibmuser.ps"
-
Upload file contents to a PDS member named
"ibmuser.pds(mem)":
zowe zos-files upload file-to-data-set "file.txt" "ibmuser.pds(mem)"
-
Upload file contents to a migrated data set and wait for it
to be recalled:
zowe zos-files upload file-to-data-set "file.txt" "ibmuser.ps" --mr wait
Upload content to a USS file from local file
Usage
zowe zos-files upload file-to-uss <inputfile> <USSFileName> [options]
Positional Arguments
-
inputfile
(string)
- The local file that you want to upload to a USS file
-
USSFileName
(string)
- The name of the USS file to which you want to upload the file
Options
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to
prepend the base path to all z/OSMF resources when making REST requests. Do not
specify this option if you are not using an API mediation layer.
-
--protocol
(string)
Profile Options
Base Connection Options
Examples
Upload the content of a stdin to a z/OS data set
Usage
zowe zos-files upload stdin-to-data-set <dataSetName> [options]
Positional Arguments
-
dataSetName
(string)
- The name of the data set to which you want to upload data
Options
-
--binary
| -b
(boolean)
- Data content in binary mode, which means that no data conversion is performed.
The data transfer process returns each record as-is, without translation. No
delimiters are added between records.
-
--migrated-recall
| --mr
(string)
-
The method by which migrated data set is handled. By default, a migrated data
set is recalled synchronously. You can specify the following values: wait,
nowait, error
Default value: nowait
-
--volume-serial
| --vs
(string)
- The volume serial (VOLSER) where the data set resides. You can use this option
at any time. However, the VOLSER is required only when the data set is not
cataloged on the system. A VOLSER is analogous to a drive name on a PC.
-
--response-timeout
| --rto
(number)
- The maximum amount of time in seconds the z/OSMF Files TSO servlet should run
before returning a response. Any request exceeding this amount of time will be
terminated and return an error. Allowed values: 5 - 600
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to
prepend the base path to all z/OSMF resources when making REST requests. Do not
specify this option if you are not using an API mediation layer.
-
--protocol
(string)
Profile Options
Base Connection Options
Examples
-
Stream content from stdin to a sequential data set named
"ibmuser.ps" from a Windows console:
echo "hello world" | zowe zos-files upload stdin-to-data-set "ibmuser.ps"
-
Stream content from stdin to a partition data set member
named "ibmuser.pds(mem)" from a Windows console:
echo "hello world" | zowe zos-files upload stdin-to-data-set "ibmuser.pds(mem)"
-
Stream content from stdin to a migrated data set and wait
for it to be recalled from a Windows console:
echo "hello world" | zowe zos-files upload stdin-to-data-set "ibmuser.ps" --mr wait
Data set and job functionality via FTP. This functionality uses the open source
zos-node-accessor package from IBM. Commands under this group require you to
create a zftp profile before using them.
If you find this functionality useful, please consider setting up z/OSMF on your
system to get improved stability and speed and more features (for example,
issuing TSO and console commands) by using core Zowe CLI.
Allocate a sequential or partitioned dataset
Allocate a sequential or partitioned dataset
Usage
zowe zos-ftp allocate data-set <datasetName> [options]
Positional Arguments
-
datasetName
(string)
- The dataset name you'd like to allocate.
Options
Required Options
TLS / Secure Connection options
Profile Options
Base Connection Options
Examples
Delete data sets, jobs, and USS files
Delete a data set
Usage
zowe zos-ftp delete data-set <dataSet> [options]
Positional Arguments
-
dataSet
(string)
- The data set (PDS member or physical sequential data set) which you would like
to delete.
Required Options
Options
TLS / Secure Connection options
Profile Options
Base Connection Options
Examples
Cancel a job and purge its output. Note: this command will not work to delete
TSU or STC type jobs.
Usage
zowe zos-ftp delete job <jobid> [options]
Positional Arguments
-
jobid
(string)
- The ID of the job that you would like to delete
Required Options
Options
TLS / Secure Connection options
Profile Options
Base Connection Options
Examples
Delete a USS file
Usage
zowe zos-ftp delete uss-file <ussFile> [options]
Positional Arguments
-
ussFile
(string)
- The absolute path to a USS file you would like to delete.
Required Options
Options
TLS / Secure Connection options
Profile Options
Base Connection Options
Examples
Download data set, job spool, and USS file content
Download all spool content for a job to files in a local directory by providing
the job id
Usage
zowe zos-ftp download all-spool-by-jobid <jobid> [options]
Positional Arguments
-
jobid
(string)
- The ID of the job for which you would like to list spool files
Options
-
--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)
Required Options
TLS / Secure Connection options
Profile Options
Base Connection Options
Examples
Download the contents of a z/OS data set to a local file
Usage
zowe zos-ftp download data-set <dataSet> [options]
Positional Arguments
-
dataSet
(string)
- The data set (PDS member or physical sequential data set) which you would like
to download to a local file.
Options
Required Options
TLS / Secure Connection options
Profile Options
Base Connection Options
Examples
Download the contents of a USS file to a local file
Usage
zowe zos-ftp download uss-file <ussFile> [options]
Positional Arguments
-
ussFile
(string)
- The path to the USS file you would like to download.
Options
Required Options
TLS / Secure Connection options
Profile Options
Base Connection Options
Examples
List data sets, data set members, uss files, jobs, spool files
List all data sets that match a DSLEVEL pattern (see help below).
The following values can be used with the --response-format-filter (--rff)
argument to display more data from the data sets:volume, unit, referred, ext,
used, recfm, lrecl, blksz, dsorg, and dsname.
Usage
zowe zos-ftp list data-set <pattern> [options]
Positional Arguments
-
pattern
(string)
- The pattern or patterns to match data sets against. Also known as 'DSLEVEL', it
is somewhat similar to the concept of a 'glob' (but not identical). The
following special sequences can be used in the pattern:
%: Matches any single character
*: Matches any number of characters within a data set name qualifier (e.g.
"ibmuser.j*.old" matches "ibmuser.jcl.old" but not
"ibmuser.jcl.very.old")
**: Matches any number of characters within any number of data set name
qualifiers (e.g. "ibmuser.**.old" matches both "ibmuser.jcl.old" and
"ibmuser.jcl.very.old")
However, the pattern cannot begin with any of these sequences.
Required Options
Options
TLS / Secure Connection options
Profile Options
Base Connection Options
Response Format Options
-
--response-format-filter
| --rff
(array)
- Filter (include) fields in the response. Accepts an array of field/property
names to include in the output response. You can filter JSON objects properties
OR table columns/fields. In addition, you can use this option in conjunction
with '--response-format-type' to reduce the output of a command to a single
field/property or a list of a single field/property.
-
--response-format-type
| --rft
(string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is
an array of homogeneous JSON objects. Each property of the object will become a
column in the table.
list: Formats output data as a list of strings. Can be used on any data type
(JSON objects/arrays) are stringified and a new line is added after each entry
in an array.
object: Formats output data as a list of prettified objects (or single object).
Can be used in place of "table" to change from tabular output to a list of
prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header
| --rfh
(boolean)
- If "--response-format-type table" is specified, include the column headers
in the output.
Examples
List all 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
Options
TLS / Secure Connection options
Profile Options
Base Connection Options
Response Format Options
-
--response-format-filter
| --rff
(array)
- Filter (include) fields in the response. Accepts an array of field/property
names to include in the output response. You can filter JSON objects properties
OR table columns/fields. In addition, you can use this option in conjunction
with '--response-format-type' to reduce the output of a command to a single
field/property or a list of a single field/property.
-
--response-format-type
| --rft
(string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is
an array of homogeneous JSON objects. Each property of the object will become a
column in the table.
list: Formats output data as a list of strings. Can be used on any data type
(JSON objects/arrays) are stringified and a new line is added after each entry
in an array.
object: Formats output data as a list of prettified objects (or single object).
Can be used in place of "table" to change from tabular output to a list of
prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header
| --rfh
(boolean)
- If "--response-format-type table" is specified, include the column headers
in the output.
Examples
List all data sets that match a DSLEVEL pattern (see help below).
Usage
zowe zos-ftp list jobs [options]
Options
Required Options
TLS / Secure Connection options
Profile Options
Base Connection Options
Response Format Options
-
--response-format-filter
| --rff
(array)
- Filter (include) fields in the response. Accepts an array of field/property
names to include in the output response. You can filter JSON objects properties
OR table columns/fields. In addition, you can use this option in conjunction
with '--response-format-type' to reduce the output of a command to a single
field/property or a list of a single field/property.
-
--response-format-type
| --rft
(string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is
an array of homogeneous JSON objects. Each property of the object will become a
column in the table.
list: Formats output data as a list of strings. Can be used on any data type
(JSON objects/arrays) are stringified and a new line is added after each entry
in an array.
object: Formats output data as a list of prettified objects (or single object).
Can be used in place of "table" to change from tabular output to a list of
prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header
| --rfh
(boolean)
- If "--response-format-type table" is specified, include the column headers
in the output.
Examples
Given a z/OS job JOBID, list the spool files (DDs) for a z/OS job on the
JES/spool queues. The command does not pre-validate the JOBID.
Usage
zowe zos-ftp list spool-files-by-jobid <jobid> [options]
Positional Arguments
-
jobid
(string)
- The z/OS JOBID of the job with the spool files you want to list. No
pre-validation of the JOBID is performed.
Required Options
Options
TLS / Secure Connection options
Profile Options
Base Connection Options
Response Format Options
-
--response-format-filter
| --rff
(array)
- Filter (include) fields in the response. Accepts an array of field/property
names to include in the output response. You can filter JSON objects properties
OR table columns/fields. In addition, you can use this option in conjunction
with '--response-format-type' to reduce the output of a command to a single
field/property or a list of a single field/property.
-
--response-format-type
| --rft
(string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is
an array of homogeneous JSON objects. Each property of the object will become a
column in the table.
list: Formats output data as a list of strings. Can be used on any data type
(JSON objects/arrays) are stringified and a new line is added after each entry
in an array.
object: Formats output data as a list of prettified objects (or single object).
Can be used in place of "table" to change from tabular output to a list of
prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header
| --rfh
(boolean)
- If "--response-format-type table" is specified, include the column headers
in the output.
Examples
List USS files and subdirectories in a directory. Optional file name pattern
like "prefix*", "*suffix", or "prefix*suffix" can be specified at the end of
directory. See EXAMPLES section.
The following values can be used with the --response-format-filter (--rff)
argument to display more data from the data sets: name, size, owner, group, and
permissions.
Usage
zowe zos-ftp list uss-files <directory> [options]
Positional Arguments
-
directory
(string)
- The USS directory to list files in, or the directory with file name pattern
Required Options
Options
TLS / Secure Connection options
Profile Options
Base Connection Options
Response Format Options
-
--response-format-filter
| --rff
(array)
- Filter (include) fields in the response. Accepts an array of field/property
names to include in the output response. You can filter JSON objects properties
OR table columns/fields. In addition, you can use this option in conjunction
with '--response-format-type' to reduce the output of a command to a single
field/property or a list of a single field/property.
-
--response-format-type
| --rft
(string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is
an array of homogeneous JSON objects. Each property of the object will become a
column in the table.
list: Formats output data as a list of strings. Can be used on any data type
(JSON objects/arrays) are stringified and a new line is added after each entry
in an array.
object: Formats output data as a list of prettified objects (or single object).
Can be used in place of "table" to change from tabular output to a list of
prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header
| --rfh
(boolean)
- If "--response-format-type table" is specified, include the column headers
in the output.
Examples
-
List USS files in the directory "/u/users/ibmuser/":
zowe zos-ftp list uss-files "/u/users/ibmuser"
-
List USS files with suffix of ".txt" in the directory
"/u/users/ibmuser/":
zowe zos-ftp list uss-files "/u/users/ibmuser/*.txt"
-
List USS files in the directory "/u/users/ibmuser/" and show
only the file name:
zowe zos-ftp list uss-files "/u/users/ibmuser/" --rff name
Make a USS directory
Make a Unix System Services Directory
Usage
zowe zos-ftp make uss-directory <ussDirectory> [options]
Positional Arguments
-
ussDirectory
(string)
- The USS directory you'd like to make.
Required Options
Options
TLS / Secure Connection options
Profile Options
Base Connection Options
Examples
Rename data sets and USS files or directories
Rename a cataloged data set
Usage
zowe zos-ftp rename data-set <oldDataSet> <newDataSet> [options]
Positional Arguments
-
oldDataSet
(string)
- The current name of the data set you want to rename.
-
newDataSet
(string)
- The new name for the data set.
Required Options
Options
TLS / Secure Connection options
Profile Options
Base Connection Options
Examples
-
Rename the data set ibmuser.jcl to ibmuser.cntl:
zowe zos-ftp rename data-set ibmuser.jcl ibmuser.cntl
-
Rename the data set member "ibmuser.cntl(alloc)" to
"ibmuser.cntl(alloc2)". Note: you can only rename members within the same
partitioned data set. You cannot move a member to another data set with this
command.:
zowe zos-ftp rename data-set "ibmuser.cntl(alloc)" "ibmuser.cntl(alloc2)"
Rename a USS file or directory
Usage
zowe zos-ftp rename uss-file <olduss> <newuss> [options]
Positional Arguments
-
olduss
(string)
- The current name of the USS file you want to rename.
-
newuss
(string)
- The new name for the USS file.
Required Options
Options
TLS / Secure Connection options
Profile Options
Base Connection Options
Examples
Submit jobs from local files and data sets
Submit a job from a cataloged data set containing JCL. The JCL will be
downloaded via FTP and then submitted.
Usage
zowe zos-ftp submit data-set <dataSet> [options]
Positional Arguments
-
dataSet
(string)
- The data set containing JCL that you would like to submit
Options
-
--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)
Required Options
TLS / Secure Connection options
Profile Options
Base Connection Options
Response Format Options
-
--response-format-filter
| --rff
(array)
- Filter (include) fields in the response. Accepts an array of field/property
names to include in the output response. You can filter JSON objects properties
OR table columns/fields. In addition, you can use this option in conjunction
with '--response-format-type' to reduce the output of a command to a single
field/property or a list of a single field/property.
-
--response-format-type
| --rft
(string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is
an array of homogeneous JSON objects. Each property of the object will become a
column in the table.
list: Formats output data as a list of strings. Can be used on any data type
(JSON objects/arrays) are stringified and a new line is added after each entry
in an array.
object: Formats output data as a list of prettified objects (or single object).
Can be used in place of "table" to change from tabular output to a list of
prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header
| --rfh
(boolean)
- If "--response-format-type table" is specified, include the column headers
in the output.
Examples
-
Submit a job residing in the data set
"ibmuser.cntl(iefbr14)":
zowe zos-ftp submit data-set "ibmuser.cntl(iefbr14)"
-
Submit a job from the data set "ibmuser.cntl(iefbr14)" and
print only the job ID:
zowe zos-ftp submit data-set "ibmuser.cntl(iefbr14)" --rff jobid --rft string
-
Submit a job from the data set "ibmuser.cntl(iefbr14)" and
wait for job complete.:
zowe zos-ftp submit data-set "ibmuser.cntl(iefbr14)" --wait 5,12
Submit a job from a local file containing JCL
Usage
zowe zos-ftp submit local-file <file> [options]
Positional Arguments
-
file
(local file path)
- The file you would like to submit as jcl
Options
-
--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)
Required Options
TLS / Secure Connection options
Profile Options
Base Connection Options
Response Format Options
-
--response-format-filter
| --rff
(array)
- Filter (include) fields in the response. Accepts an array of field/property
names to include in the output response. You can filter JSON objects properties
OR table columns/fields. In addition, you can use this option in conjunction
with '--response-format-type' to reduce the output of a command to a single
field/property or a list of a single field/property.
-
--response-format-type
| --rft
(string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is
an array of homogeneous JSON objects. Each property of the object will become a
column in the table.
list: Formats output data as a list of strings. Can be used on any data type
(JSON objects/arrays) are stringified and a new line is added after each entry
in an array.
object: Formats output data as a list of prettified objects (or single object).
Can be used in place of "table" to change from tabular output to a list of
prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header
| --rfh
(boolean)
- If "--response-format-type table" is specified, include the column headers
in the output.
Examples
-
Submit a job from the local file "my_build_jcl.txt":
zowe zos-ftp submit local-file "my_build_jcl.txt"
-
Submit a job from the local file "my_build_jcl.txt" and
print only the job ID:
zowe zos-ftp submit local-file "my_build_jcl.txt" --rff jobid --rft string
-
Submit a job from the local file "my_build_jcl.txt" and
wait for job complete.:
zowe zos-ftp submit local-file "my_build_jcl.txt" --wait 5,12
Submit a job from JCL written to the standard input (stdin) of this process.
Usage
zowe zos-ftp submit stdin [options]
Options
-
--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)
Required Options
TLS / Secure Connection options
Profile Options
Base Connection Options
Response Format Options
-
--response-format-filter
| --rff
(array)
- Filter (include) fields in the response. Accepts an array of field/property
names to include in the output response. You can filter JSON objects properties
OR table columns/fields. In addition, you can use this option in conjunction
with '--response-format-type' to reduce the output of a command to a single
field/property or a list of a single field/property.
-
--response-format-type
| --rft
(string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is
an array of homogeneous JSON objects. Each property of the object will become a
column in the table.
list: Formats output data as a list of strings. Can be used on any data type
(JSON objects/arrays) are stringified and a new line is added after each entry
in an array.
object: Formats output data as a list of prettified objects (or single object).
Can be used in place of "table" to change from tabular output to a list of
prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header
| --rfh
(boolean)
- If "--response-format-type table" is specified, include the column headers
in the output.
Examples
-
Submit a job from stdin, redirecting the contents of
my_jcl.txt in.:
zowe zos-ftp submit stdin < my_jcl.txt
-
Submit a job from the local file "my_build_jcl.txt" and
wait for job complete.:
zowe zos-ftp submit stdin "my_build_jcl.txt" --wait 5,12
Upload data set and USS content
Upload contents of a local file to a z/OS data set
Usage
zowe zos-ftp upload file-to-data-set <file> <dataSet> [options]
Positional Arguments
-
file
(local file path)
- Upload the contents of this file to the data set
-
dataSet
(string)
- The data set (PDS member or physical sequential data set) to which you would
like to upload content.
Options
Required Options
TLS / Secure Connection options
Profile Options
Base Connection Options
Examples
Upload contents of a local to a Unix System Services file.
Usage
zowe zos-ftp upload file-to-uss-file <file> <ussFile> [options]
Positional Arguments
-
file
(local file path)
- Upload the contents of this local file to a data set.
-
ussFile
(string)
- The USS file to which you would like to upload content.
Options
Required Options
TLS / Secure Connection options
Profile Options
Base Connection Options
Examples
Upload contents piped to stdin to a z/OS data set
Usage
zowe zos-ftp upload stdin-to-data-set <dataSet> [options]
Positional Arguments
-
dataSet
(string)
- The data set (PDS member or physical sequential data set) to which you would
like to upload content.
Options
Required Options
TLS / Secure Connection options
Profile Options
Base Connection Options
Examples
Upload from stdin to a Unix System Services File
Usage
zowe zos-ftp upload stdin-to-uss-file <ussFile> [options]
Positional Arguments
-
ussFile
(string)
- The USS file to which you would like to upload content.
Options
Required Options
TLS / Secure Connection options
Profile Options
Base Connection Options
Examples
View data sets, job output, and USS content
View all spool content for a job by providing the job id
Usage
zowe zos-ftp view all-spool-by-jobid <jobid> [options]
Positional Arguments
-
jobid
(string)
- The ID of the job for which you would like to list spool files
Required Options
Options
TLS / Secure Connection options
Profile Options
Base Connection Options
Examples
View the contents of a z/OS data set
Usage
zowe zos-ftp view data-set <dataSet> [options]
Positional Arguments
-
dataSet
(string)
- The data set (PDS member or physical sequential data set) which you would like
to view the contents of.
Options
Required Options
TLS / Secure Connection options
Profile Options
Base Connection Options
Examples
View status details of a single z/OS job on spool/JES queues. The command does
not prevalidate the JOBID.
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
Options
TLS / Secure Connection options
Profile Options
Base Connection Options
Response Format Options
-
--response-format-filter
| --rff
(array)
- Filter (include) fields in the response. Accepts an array of field/property
names to include in the output response. You can filter JSON objects properties
OR table columns/fields. In addition, you can use this option in conjunction
with '--response-format-type' to reduce the output of a command to a single
field/property or a list of a single field/property.
-
--response-format-type
| --rft
(string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is
an array of homogeneous JSON objects. Each property of the object will become a
column in the table.
list: Formats output data as a list of strings. Can be used on any data type
(JSON objects/arrays) are stringified and a new line is added after each entry
in an array.
object: Formats output data as a list of prettified objects (or single object).
Can be used in place of "table" to change from tabular output to a list of
prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header
| --rfh
(boolean)
- If "--response-format-type table" is specified, include the column headers
in the output.
Examples
View the contents of a spool file from a z/OS job on spool/JES queues. The
command does not pre-validate the JOBID or spool ID.
Usage
zowe zos-ftp view spool-file-by-id <jobid> <spoolfileid> [options]
Positional Arguments
-
jobid
(string)
- The z/OS JOBID of the job containing the spool file you want to view. No
pre-validation of the JOBID is performed.
-
spoolfileid
(number)
- The spool file ID number for the spool file to view. No pre-validation of the
ID is performed.
Required Options
Options
TLS / Secure Connection options
Profile Options
Base Connection Options
Examples
View the contents of a Unix System Services File
Usage
zowe zos-ftp view uss-file <ussFile> [options]
Positional Arguments
-
ussFile
(string)
- The USS file you'd like to view the contents of.
Options
Required Options
TLS / Secure Connection options
Profile Options
Base Connection Options
Examples
Manage z/OS jobs.
Cancel a single job by job ID. This cancels the job if it is running or on
input.
Cancel a single job by job ID
Usage
zowe zos-jobs cancel job <jobid> [options]
Positional Arguments
-
jobid
(string)
- The job ID (e.g. JOB00123) of the job. Job ID is a unique identifier for z/OS
batch jobs -- no two jobs on one system can have the same ID. Note: z/OS
allows you to abbreviate the job ID if desired. You can use, for example
"J123".
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to
prepend the base path to all z/OSMF resources when making REST requests. Do not
specify this option if you are not using an API mediation layer.
-
--protocol
(string)
Profile Options
Base Connection Options
Examples
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.
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)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to
prepend the base path to all z/OSMF resources when making REST requests. Do not
specify this option if you are not using an API mediation layer.
-
--protocol
(string)
Profile Options
Base Connection Options
Examples
Download the output of a job as separate files.
Download all job output to a local directory. Each spool DD will be downloaded
to its own file in the directory.
Usage
zowe zos-jobs download output <jobid> [options]
Positional Arguments
-
jobid
(string)
- The z/OS JOBID of the job containing the spool files you want to view. No
pre-validation of the JOBID is performed.
Options
-
--directory
| -d
| --dir
(string)
- The local directory you would like to download the output for the job to.
-
--extension
| -e
(string)
- A file extension to save the job output with. Defaults to '.txt'.
-
--omit-jobid-directory
| --ojd
(boolean)
- If specified, job output will be saved directly to the specified directory
rather than creating a subdirectory named after the ID of the job.
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to
prepend the base path to all z/OSMF resources when making REST requests. Do not
specify this option if you are not using an API mediation layer.
-
--protocol
(string)
Profile Options
Base Connection Options
Examples
List z/OS jobs and list the spool files (DDs) for a z/OS job on the JES/spool
queues.
List jobs on JES spool/queues. By default, the command lists jobs owned (owner)
by the user specified in your z/OSMF profile. The default for prefix is "*".
The command does not prevalidate your user ID. The command surfaces errors
verbatim from the z/OSMF Jobs REST endpoints.
Usage
zowe zos-jobs list jobs [options]
Options
-
--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)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to
prepend the base path to all z/OSMF resources when making REST requests. Do not
specify this option if you are not using an API mediation layer.
-
--protocol
(string)
Profile Options
Base Connection Options
Response Format Options
-
--response-format-filter
| --rff
(array)
- Filter (include) fields in the response. Accepts an array of field/property
names to include in the output response. You can filter JSON objects properties
OR table columns/fields. In addition, you can use this option in conjunction
with '--response-format-type' to reduce the output of a command to a single
field/property or a list of a single field/property.
-
--response-format-type
| --rft
(string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is
an array of homogeneous JSON objects. Each property of the object will become a
column in the table.
list: Formats output data as a list of strings. Can be used on any data type
(JSON objects/arrays) are stringified and a new line is added after each entry
in an array.
object: Formats output data as a list of prettified objects (or single object).
Can be used in place of "table" to change from tabular output to a list of
prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header
| --rfh
(boolean)
- If "--response-format-type table" is specified, include the column headers
in the output.
Examples
-
List all jobs with default settings. The command returns
jobs owned by your user ID with any job name:
zowe zos-jobs list jobs
-
List all jobs owned by user IDs starting with 'ibmu' and job
names starting with 'myjo':
zowe zos-jobs list jobs -o "ibmu*" -p "myjo*"
-
List all jobs with default owner and prefix settings,
displaying only the job ID of each job:
zowe zos-jobs list jobs --rff jobid --rft table
Given a z/OS job JOBID, list the spool files (DDs) for a z/OS job on the
JES/spool queues. The command does not pre-validate the JOBID. The command
presents errors verbatim from the z/OSMF Jobs REST endpoints.
Usage
zowe zos-jobs list spool-files-by-jobid <jobid> [options]
Positional Arguments
-
jobid
(string)
- The z/OS JOBID of the job with the spool files you want to list. No
pre-validation of the JOBID is performed.
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to
prepend the base path to all z/OSMF resources when making REST requests. Do not
specify this option if you are not using an API mediation layer.
-
--protocol
(string)
Profile Options
Base Connection Options
Response Format Options
-
--response-format-filter
| --rff
(array)
- Filter (include) fields in the response. Accepts an array of field/property
names to include in the output response. You can filter JSON objects properties
OR table columns/fields. In addition, you can use this option in conjunction
with '--response-format-type' to reduce the output of a command to a single
field/property or a list of a single field/property.
-
--response-format-type
| --rft
(string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is
an array of homogeneous JSON objects. Each property of the object will become a
column in the table.
list: Formats output data as a list of strings. Can be used on any data type
(JSON objects/arrays) are stringified and a new line is added after each entry
in an array.
object: Formats output data as a list of prettified objects (or single object).
Can be used in place of "table" to change from tabular output to a list of
prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header
| --rfh
(boolean)
- If "--response-format-type table" is specified, include the column headers
in the output.
Examples
Submit a job (JCL).
Submit a job (JCL) contained in a data set. The data set may be of type
physical sequential or a PDS member. The command does not pre-validate the
data set name. The command presents errors verbatim from the z/OSMF Jobs REST
endpoints. For more information about z/OSMF Jobs API errors, see the z/OSMF
Jobs API REST documentation.
Usage
zowe zos-jobs submit data-set <dataset> [options]
Positional Arguments
-
dataset
(string)
- The z/OS data set containing the JCL to submit. You can specify a physical
sequential data set (for example, "DATA.SET") or a partitioned data set
qualified by a member (for example, "DATA.SET(MEMBER)").
Options
-
--volume
| --vol
(string)
- The volume serial (VOLSER) where the data set resides. The option is required
only when the data set is not catalogued on the system.
-
--wait-for-active
| --wfa
(boolean)
- Wait for the job to enter ACTIVE status before completing the command.
-
--wait-for-output
| --wfo
(boolean)
- Wait for the job to enter OUTPUT status before completing the command.
-
--view-all-spool-content
| --vasc
(boolean)
- Print all spool output. If you use this option you will wait for the job to
complete.
-
--directory
| -d
(string)
- The local directory you would like to download the output of the job. Creates a
subdirectory using the jobID as the name and files are titled based on DD
names. If you use this option you will wait for the job to complete.
-
--extension
| -e
(string)
- A file extension to save the job output with. Default is '.txt'.
-
--jcl-symbols
| --js
(string)
- A string of JCL symbols to use for substitution. For symbol values with no
spaces: "symbol1=value1 symbol2=value2 ...". When a value contains spaces,
enclose the value in single quotes: "symbol1='value 1 with spaces'
symbol2='value 2 with spaces' ...". To embed a single quote in a value, use
two single quotes: "NAME=O''Brian".
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to
prepend the base path to all z/OSMF resources when making REST requests. Do not
specify this option if you are not using an API mediation layer.
-
--protocol
(string)
Profile Options
Base Connection Options
Response Format Options
-
--response-format-filter
| --rff
(array)
- Filter (include) fields in the response. Accepts an array of field/property
names to include in the output response. You can filter JSON objects properties
OR table columns/fields. In addition, you can use this option in conjunction
with '--response-format-type' to reduce the output of a command to a single
field/property or a list of a single field/property.
-
--response-format-type
| --rft
(string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is
an array of homogeneous JSON objects. Each property of the object will become a
column in the table.
list: Formats output data as a list of strings. Can be used on any data type
(JSON objects/arrays) are stringified and a new line is added after each entry
in an array.
object: Formats output data as a list of prettified objects (or single object).
Can be used in place of "table" to change from tabular output to a list of
prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header
| --rfh
(boolean)
- If "--response-format-type table" is specified, include the column headers
in the output.
Examples
-
Submit the JCL in the data set "ibmuser.cntl(deploy)":
zowe zos-jobs submit data-set "ibmuser.cntl(deploy)"
-
Submit the JCL in the data set "ibmuser.cntl(deploy)", wait
for the job to complete and print all output from the job:
zowe zos-jobs submit data-set "ibmuser.cntl(deploy)" --vasc
Submit a job (JCL) contained in a local file. The command presents errors
verbatim from the z/OSMF Jobs REST endpoints. For more information about z/OSMF
Jobs API errors, see the z/OSMF Jobs API REST documentation.
Usage
zowe zos-jobs submit local-file <localFile> [options]
Positional Arguments
-
localFile
(string)
- The local file containing the JCL to submit.
Options
-
--wait-for-active
| --wfa
(boolean)
- Wait for the job to enter ACTIVE status before completing the command.
-
--wait-for-output
| --wfo
(boolean)
- Wait for the job to enter OUTPUT status before completing the command.
-
--view-all-spool-content
| --vasc
(boolean)
- Print all spool output. If you use this option you will wait for the job to
complete.
-
--directory
| -d
(string)
- The local directory you would like to download the output of the job. Creates a
subdirectory using the jobID as the name and files are titled based on DD
names. If you use this option you will wait for the job to complete.
-
--extension
| -e
(string)
- A file extension to save the job output with. Default is '.txt'.
-
--jcl-symbols
| --js
(string)
- A string of JCL symbols to use for substitution. For symbol values with no
spaces: "symbol1=value1 symbol2=value2 ...". When a value contains spaces,
enclose the value in single quotes: "symbol1='value 1 with spaces'
symbol2='value 2 with spaces' ...". To embed a single quote in a value, use
two single quotes: "NAME=O''Brian".
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to
prepend the base path to all z/OSMF resources when making REST requests. Do not
specify this option if you are not using an API mediation layer.
-
--protocol
(string)
Profile Options
Base Connection Options
Response Format Options
-
--response-format-filter
| --rff
(array)
- Filter (include) fields in the response. Accepts an array of field/property
names to include in the output response. You can filter JSON objects properties
OR table columns/fields. In addition, you can use this option in conjunction
with '--response-format-type' to reduce the output of a command to a single
field/property or a list of a single field/property.
-
--response-format-type
| --rft
(string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is
an array of homogeneous JSON objects. Each property of the object will become a
column in the table.
list: Formats output data as a list of strings. Can be used on any data type
(JSON objects/arrays) are stringified and a new line is added after each entry
in an array.
object: Formats output data as a list of prettified objects (or single object).
Can be used in place of "table" to change from tabular output to a list of
prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header
| --rfh
(boolean)
- If "--response-format-type table" is specified, include the column headers
in the output.
Examples
Submit a job (JCL) passed to the command via the stdin stream. The command
presents errors verbatim from the z/OSMF Jobs REST endpoints. For more
information about z/OSMF Jobs API errors, see the z/OSMF Jobs API REST
documentation.
Usage
zowe zos-jobs submit stdin [options]
Options
-
--wait-for-active
| --wfa
(boolean)
- Wait for the job to enter ACTIVE status before completing the command.
-
--wait-for-output
| --wfo
(boolean)
- Wait for the job to enter OUTPUT status before completing the command.
-
--view-all-spool-content
| --vasc
(boolean)
- Print all spool output. If you use this option you will wait for the job to
complete.
-
--directory
| -d
(string)
- The local directory you would like to download the output of the job. Creates a
subdirectory using the jobID as the name and files are titled based on DD
names. If you use this option you will wait for the job to complete.
-
--extension
| -e
(string)
- A file extension to save the job output with. Default is '.txt'.
-
--jcl-symbols
| --js
(string)
- A string of JCL symbols to use for substitution. For symbol values with no
spaces: "symbol1=value1 symbol2=value2 ...". When a value contains spaces,
enclose the value in single quotes: "symbol1='value 1 with spaces'
symbol2='value 2 with spaces' ...". To embed a single quote in a value, use
two single quotes: "NAME=O''Brian".
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to
prepend the base path to all z/OSMF resources when making REST requests. Do not
specify this option if you are not using an API mediation layer.
-
--protocol
(string)
Profile Options
Base Connection Options
Response Format Options
-
--response-format-filter
| --rff
(array)
- Filter (include) fields in the response. Accepts an array of field/property
names to include in the output response. You can filter JSON objects properties
OR table columns/fields. In addition, you can use this option in conjunction
with '--response-format-type' to reduce the output of a command to a single
field/property or a list of a single field/property.
-
--response-format-type
| --rft
(string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is
an array of homogeneous JSON objects. Each property of the object will become a
column in the table.
list: Formats output data as a list of strings. Can be used on any data type
(JSON objects/arrays) are stringified and a new line is added after each entry
in an array.
object: Formats output data as a list of prettified objects (or single object).
Can be used in place of "table" to change from tabular output to a list of
prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header
| --rfh
(boolean)
- If "--response-format-type table" is specified, include the column headers
in the output.
View details of z/OS jobs on spool/JES queues.
View status details of a single z/OS job on spool/JES queues. The command does
not prevalidate the JOBID. The command presents errors verbatim from the z/OSMF
Jobs REST endpoints (expect for "no jobs found").
Usage
zowe zos-jobs view job-status-by-jobid <jobid> [options]
Positional Arguments
-
jobid
(string)
- The z/OS JOBID of the job you want to view. No prevalidation of the JOBID is
performed.
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to
prepend the base path to all z/OSMF resources when making REST requests. Do not
specify this option if you are not using an API mediation layer.
-
--protocol
(string)
Profile Options
Base Connection Options
Response Format Options
-
--response-format-filter
| --rff
(array)
- Filter (include) fields in the response. Accepts an array of field/property
names to include in the output response. You can filter JSON objects properties
OR table columns/fields. In addition, you can use this option in conjunction
with '--response-format-type' to reduce the output of a command to a single
field/property or a list of a single field/property.
-
--response-format-type
| --rft
(string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is
an array of homogeneous JSON objects. Each property of the object will become a
column in the table.
list: Formats output data as a list of strings. Can be used on any data type
(JSON objects/arrays) are stringified and a new line is added after each entry
in an array.
object: Formats output data as a list of prettified objects (or single object).
Can be used in place of "table" to change from tabular output to a list of
prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header
| --rfh
(boolean)
- If "--response-format-type table" is specified, include the column headers
in the output.
Examples
-
View status and other details of the job with the job ID
JOB00123:
zowe zos-jobs view job-status-by-jobid j123
-
Print only the status (for example, "OUTPUT" or "ACTIVE") of
the job with the job ID JOB00123:
zowe zos-jobs view job-status-by-jobid j123 --rff status --rft string
View the contents of a spool file from a z/OS job on spool/JES queues. The
command does not pre-validate the JOBID or spool ID. The command presents
errors verbatim from the z/OSMF Jobs REST endpoints.
Usage
zowe zos-jobs view spool-file-by-id <jobid> <spoolfileid> [options]
Positional Arguments
-
jobid
(string)
- The z/OS JOBID of the job containing the spool file you want to view. No
pre-validation of the JOBID is performed.
-
spoolfileid
(number)
- The spool file ID number for the spool file to view. Use the "zowe zos-jobs
list spool-files-by-jobid" command to obtain spool ID numbers.No
pre-validation of the ID is performed.
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to
prepend the base path to all z/OSMF resources when making REST requests. Do not
specify this option if you are not using an API mediation layer.
-
--protocol
(string)
Profile Options
Base Connection Options
Examples
Issue z/OS USS commands remotely using an SSH session. Output from the commands
is displayed on the local terminal.
Issue a z/OS USS command.
Issue a z/OS USS command
Usage
zowe zos-ssh issue command <command> [options]
Positional Arguments
-
command
(string)
- z/OS USS command to issue
Options
-
--cwd
(string)
- Working directory in which to execute the command
z/OS Ssh Connection Options
-
--host
| -H
(string)
- The z/OS SSH server host name.
-
--port
| -P
(number)
-
--user
| -u
(string)
- Mainframe user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe password, which can be the same as your TSO password.
-
--privateKey
| --key
| --pk
(string)
- Path to a file containing your private key, that must match a public key stored
in the server for authentication
-
--keyPassphrase
| --passphrase
| --kp
(string)
- Private key passphrase, which unlocks the private key.
-
--handshakeTimeout
| --timeout
| --to
(number)
- How long in milliseconds to wait for the SSH handshake to complete.
Profile Options
Base Connection Options
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the
default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
Examples
Issue TSO commands and interact with TSO address spaces.
Issue TSO commands.
Creates a TSO address space, issues a TSO command through the newly created
address space, waits for the READY prompt to print the response, and terminates
the TSO address space. All response data are returned to the user up to (but
not including) the TSO 'READY' prompt.
Usage
zowe zos-tso issue command <commandText> [options]
Positional Arguments
-
commandText
(string)
- The TSO command to issue.
Options
TSO ADDRESS SPACE OPTIONS
-
--account
| -a
(string)
- Your z/OS TSO/E accounting information.
-
--character-set
| --cs
(string)
-
--code-page
| --cp
(string)
-
--columns
| --cols
(number)
-
--logon-procedure
| -l
(string)
-
--region-size
| --rs
(number)
-
--rows
(number)
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to
prepend the base path to all z/OSMF resources when making REST requests. Do not
specify this option if you are not using an API mediation layer.
-
--protocol
(string)
Profile Options
-
--zosmf-profile
| --zosmf-p
(string)
- The name of a (zosmf) profile to load for this command execution.
-
--tso-profile
| --tso-p
(string)
- The name of a (tso) profile to load for this command execution.
-
--base-profile
| --base-p
(string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
Examples
Ping a TSO address space, from which you previously started and received a token
(a.k.a 'servelet-key').
Ping a TSO address space, from which you previously started and received a token
(a.k.a 'servlet-key').
Usage
zowe zos-tso ping address-space <servletKey> [options]
Positional Arguments
-
servletKey
(string)
- The servlet key from a previously started TSO address space.
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to
prepend the base path to all z/OSMF resources when making REST requests. Do not
specify this option if you are not using an API mediation layer.
-
--protocol
(string)
Profile Options
Base Connection Options
Examples
Send data to TSO and collect responses until the prompt is reached.
Send data to the TSO address space, from which you previously started and
received a token (a.k.a 'servlet-key').
Usage
zowe zos-tso send address-space <servletKey> [options]
Positional Arguments
-
servletKey
(string)
- The servlet key from a previously started TSO address space.
Required Options
-
--data
(string)
- The data to which we want to send to the TSO address space represented by the
servlet key.
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to
prepend the base path to all z/OSMF resources when making REST requests. Do not
specify this option if you are not using an API mediation layer.
-
--protocol
(string)
Profile Options
Base Connection Options
Examples
Start TSO/E address space.
Start a TSO address space, from which you will receive a token (a.k.a
'servlet-key') for further address space interaction (e.g. termination).
Usage
zowe zos-tso start address-space [options]
TSO ADDRESS SPACE OPTIONS
-
--account
| -a
(string)
- Your z/OS TSO/E accounting information.
-
--character-set
| --cs
(string)
-
--code-page
| --cp
(string)
-
--columns
| --cols
(number)
-
--logon-procedure
| -l
(string)
-
--region-size
| --rs
(number)
-
--rows
(number)
Options
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to
prepend the base path to all z/OSMF resources when making REST requests. Do not
specify this option if you are not using an API mediation layer.
-
--protocol
(string)
Profile Options
-
--zosmf-profile
| --zosmf-p
(string)
- The name of a (zosmf) profile to load for this command execution.
-
--tso-profile
| --tso-p
(string)
- The name of a (tso) profile to load for this command execution.
-
--base-profile
| --base-p
(string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
Examples
-
Start TSO/E address space:
zowe zos-tso start address-space
-
Start TSO/E address space, and receive response in JSON
format:
zowe zos-tso start address-space --rfj
-
Start TSO/E address space, and print only the servlet key:
zowe zos-tso start address-space --sko
Stop TSO/E address space.
Stop a TSO address space, from which you previously started and received a token
(a.k.a 'servlet-key').
Usage
zowe zos-tso stop address-space <servletkey> [options]
Positional Arguments
-
servletkey
(string)
- The servlet key from a previously started TSO address space.
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to
prepend the base path to all z/OSMF resources when making REST requests. Do not
specify this option if you are not using an API mediation layer.
-
--protocol
(string)
Profile Options
Base Connection Options
Examples
Create and manage z/OSMF workflows on a z/OS system.
Archive workflow instance in z/OSMF.
Archive an active workflow instance in z/OSMF.
Usage
zowe zos-workflows archive active-workflow [options]
Options
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to
prepend the base path to all z/OSMF resources when making REST requests. Do not
specify this option if you are not using an API mediation layer.
-
--protocol
(string)
Profile Options
Base Connection Options
Response Format Options
-
--response-format-filter
| --rff
(array)
- Filter (include) fields in the response. Accepts an array of field/property
names to include in the output response. You can filter JSON objects properties
OR table columns/fields. In addition, you can use this option in conjunction
with '--response-format-type' to reduce the output of a command to a single
field/property or a list of a single field/property.
-
--response-format-type
| --rft
(string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is
an array of homogeneous JSON objects. Each property of the object will become a
column in the table.
list: Formats output data as a list of strings. Can be used on any data type
(JSON objects/arrays) are stringified and a new line is added after each entry
in an array.
object: Formats output data as a list of prettified objects (or single object).
Can be used in place of "table" to change from tabular output to a list of
prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header
| --rfh
(boolean)
- If "--response-format-type table" is specified, include the column headers
in the output.
Examples
-
Archive a workflow with workflow name "testworkflow":
zowe zos-workflows archive active-workflow --wn "testworkflow"
-
Archive multiple workflows with workflow names starting with
"test":
zowe zos-workflows archive active-workflow --wn "test.*"
-
Archive a workflow with workflow key "123-456-abv-xyz":
zowe zos-workflows archive active-workflow --wk "123-456-abv-xyz"
Create a z/OSMF workflow on a z/OS system.
Create a z/OSMF workflow on a z/OS system using a Data set
Usage
zowe zos-workflows create workflow-from-data-set <workflowName> [options]
Positional Arguments
Required Options
Options
-
--variables-input-file
| --vif
(string)
- Specifies an optional properties file that you can use to pre-specify values
for one or more of the variables that are defined in the workflow definition
file.
-
--variables
| --vs
(string)
- Includes a list of variables for the workflow. The variables that you specify
here take precedence over the variables that are specified in the workflow
variable input file. Make sure the value meets all regular expression
requirements set for the corresponding variable.
-
--assign-to-owner
| --ato
(boolean)
- Indicates whether the workflow steps are assigned to the workflow owner.
-
--access-type
| --at
(string)
-
Specifies the access type for the workflow. Public, Restricted or Private.
Allowed values: Public, Restricted, Private
-
--delete-completed
| --dc
(boolean)
- Whether the successfully completed jobs to be deleted from the JES spool.
-
--overwrite
| --ov
(boolean)
- Replaces an existing workflow with a new workflow.
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to
prepend the base path to all z/OSMF resources when making REST requests. Do not
specify this option if you are not using an API mediation layer.
-
--protocol
(string)
Profile Options
Base Connection Options
Response Format Options
-
--response-format-filter
| --rff
(array)
- Filter (include) fields in the response. Accepts an array of field/property
names to include in the output response. You can filter JSON objects properties
OR table columns/fields. In addition, you can use this option in conjunction
with '--response-format-type' to reduce the output of a command to a single
field/property or a list of a single field/property.
-
--response-format-type
| --rft
(string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is
an array of homogeneous JSON objects. Each property of the object will become a
column in the table.
list: Formats output data as a list of strings. Can be used on any data type
(JSON objects/arrays) are stringified and a new line is added after each entry
in an array.
object: Formats output data as a list of prettified objects (or single object).
Can be used in place of "table" to change from tabular output to a list of
prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header
| --rfh
(boolean)
- If "--response-format-type table" is specified, include the column headers
in the output.
Examples
-
Create a workflow with name "testworkflow" using the data
set "TESTID.WKFLOW" that contains the workflow definition xml on the system
"TESTM1" with owner "OTHERID" and delete workflow with the same name if it
already 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
Create a z/OSMF workflow on a z/OS system using a Local file
Usage
zowe zos-workflows create workflow-from-local-file <workflowName> [options]
Positional Arguments
Required Options
Options
-
--variables-input-file
| --vif
(string)
- Specifies an optional properties file that you can use to pre-specify values
for one or more of the variables that are defined in the workflow definition
file.
-
--variables
| --vs
(string)
- Includes a list of variables for the workflow. The variables that you specify
here take precedence over the variables that are specified in the workflow
variable input file. Make sure the value meets all regular expression
requirements set for the corresponding variable.
-
--assign-to-owner
| --ato
(boolean)
- Indicates whether the workflow steps are assigned to the workflow owner.
-
--access-type
| --at
(string)
-
Specifies the access type for the workflow. Public, Restricted or Private.
Allowed values: Public, Restricted, Private
-
--delete-completed
| --dc
(boolean)
- Whether the successfully completed jobs to be deleted from the JES spool.
-
--overwrite
| --ov
(boolean)
- Replaces an existing workflow with a new workflow.
-
--remote-directory
| --rd
(string)
- The remote uss directory where the files are to be uploaded. The directory has
to exist
-
--keep-files
| --kf
(boolean)
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to
prepend the base path to all z/OSMF resources when making REST requests. Do not
specify this option if you are not using an API mediation layer.
-
--protocol
(string)
Profile Options
Base Connection Options
Response Format Options
-
--response-format-filter
| --rff
(array)
- Filter (include) fields in the response. Accepts an array of field/property
names to include in the output response. You can filter JSON objects properties
OR table columns/fields. In addition, you can use this option in conjunction
with '--response-format-type' to reduce the output of a command to a single
field/property or a list of a single field/property.
-
--response-format-type
| --rft
(string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is
an array of homogeneous JSON objects. Each property of the object will become a
column in the table.
list: Formats output data as a list of strings. Can be used on any data type
(JSON objects/arrays) are stringified and a new line is added after each entry
in an array.
object: Formats output data as a list of prettified objects (or single object).
Can be used in place of "table" to change from tabular output to a list of
prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header
| --rfh
(boolean)
- If "--response-format-type table" is specified, include the column headers
in the output.
Examples
Create a workflow instance in z/OSMF using a USS file
Usage
zowe zos-workflows create workflow-from-uss-file <workflowName> [options]
Positional Arguments
-
workflowName
(string)
- Name of the workflow instance to create
Required Options
Options
-
--variables-input-file
| --vif
(string)
- Specifies an optional properties file that you can use to pre-specify values
for one or more of the variables that are defined in the workflow definition
file.
-
--variables
| --vs
(string)
- Includes a list of variables for the workflow. The variables that you specify
here take precedence over the variables that are specified in the workflow
variable input file. Make sure the value meets all regular expression
requirements set for the corresponding variable.
-
--assign-to-owner
| --ato
(boolean)
- Indicates whether the workflow steps are assigned to the workflow owner.
-
--access-type
| --at
(string)
-
Specifies the access type for the workflow. Public, Restricted or Private.
Allowed values: Public, Restricted, Private
-
--delete-completed
| --dc
(boolean)
- Whether the successfully completed jobs to be deleted from the JES spool.
-
--overwrite
| --ov
(boolean)
- Replaces an existing workflow with a new workflow.
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to
prepend the base path to all z/OSMF resources when making REST requests. Do not
specify this option if you are not using an API mediation layer.
-
--protocol
(string)
Profile Options
Base Connection Options
Response Format Options
-
--response-format-filter
| --rff
(array)
- Filter (include) fields in the response. Accepts an array of field/property
names to include in the output response. You can filter JSON objects properties
OR table columns/fields. In addition, you can use this option in conjunction
with '--response-format-type' to reduce the output of a command to a single
field/property or a list of a single field/property.
-
--response-format-type
| --rft
(string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is
an array of homogeneous JSON objects. Each property of the object will become a
column in the table.
list: Formats output data as a list of strings. Can be used on any data type
(JSON objects/arrays) are stringified and a new line is added after each entry
in an array.
object: Formats output data as a list of prettified objects (or single object).
Can be used in place of "table" to change from tabular output to a list of
prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header
| --rfh
(boolean)
- If "--response-format-type table" is specified, include the column headers
in the output.
Examples
-
Create a workflow with name "testworkflow" using uss file
"/path/workflow.xml" containing workflow definition, on system "TESTM1" with
owner "OTHERID" and delete workflow with the same name if it already 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
Delete an active workflow or an archived workflow from z/OSMF.
Delete an active workflow instance in z/OSMF
Usage
zowe zos-workflows delete active-workflow [options]
Options
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to
prepend the base path to all z/OSMF resources when making REST requests. Do not
specify this option if you are not using an API mediation layer.
-
--protocol
(string)
Profile Options
Base Connection Options
Examples
-
To delete a workflow instance in z/OSMF with workflow key
"d043b5f1-adab-48e7-b7c3-d41cd95fa4b0":
zowe zos-workflows delete active-workflow --workflow-key "d043b5f1-adab-48e7-b7c3-d41cd95fa4b0"
-
To delete a workflow instance in z/OSMF with workflow name
"testWorkflow":
zowe zos-workflows delete active-workflow --workflow-name "testWorkflow"
-
To delete multiple workflow instances in z/OSMF with names
starting with "test":
zowe zos-workflows delete active-workflow --workflow-name "test.*"
Delete an archived workflow from z/OSMF
Usage
zowe zos-workflows delete archived-workflow [options]
Options
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to
prepend the base path to all z/OSMF resources when making REST requests. Do not
specify this option if you are not using an API mediation layer.
-
--protocol
(string)
Profile Options
Base Connection Options
Examples
-
To delete an archived workflow from z/OSMF with workflow key
"d043b5f1-adab-48e7-b7c3-d41cd95fa4b0":
zowe zos-workflows delete archived-workflow --workflow-key "d043b5f1-adab-48e7-b7c3-d41cd95fa4b0"
-
To delete an archived workflow from z/OSMF with workflow
name "testWorkflow":
zowe zos-workflows delete archived-workflow --workflow-name "testWorkflow"
-
To delete multiple archived workflows from z/OSMF with names
beginnig with "test":
zowe zos-workflows delete archived-workflow --workflow-name "test.*"
List the z/OSMF workflows for a system or a sysplex with filter options.
Get the details of an active z/OSMF workflow
Usage
zowe zos-workflows list active-workflow-details [options]
Options
-
--workflow-name
| --wn
(string)
- List active workflow details by specified workflow name.
-
--workflow-key
| --wk
(string)
- List active workflow details by specified workflow key.
-
--list-steps
| --ls
(boolean)
- Optional parameter for listing steps and their properties.
-
--steps-summary-only
| --sso
(boolean)
- Optional parameter that lists steps summary only.
-
--list-variables
| --lv
(boolean)
- Optional parameter for listing variables and their properties.
-
--skip-workflow-summary
| --sws
(boolean)
- Optional parameter that skips the default workflow summary.
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to
prepend the base path to all z/OSMF resources when making REST requests. Do not
specify this option if you are not using an API mediation layer.
-
--protocol
(string)
Profile Options
Base Connection Options
Examples
-
To list the details of an active workflow with key
"7c62c790-0340-86b2-61ce618d8f8c" including its steps and variables:
zowe zos-workflows list active-workflow-details --workflow-key "7c62c790-0340-86b2-61ce618d8f8c" --list-steps --list-variables
-
To list the details of an active workflow with name
"testWorkflow" including its steps and variables:
zowe zos-workflows list active-workflow-details --workflow-name "testWorkflow" --list-steps --list-variables
List active workflow instance(s) in z/OSMF.
Multiple filters can be used together.
Omitting all options will list all workflows on the sysplex
Usage
zowe zos-workflows list active-workflows [options]
Options
-
--workflow-name
| --wn
(string)
- Filter by workflow name. For wildcard use .*
-
--category
| --cat
(string)
- Filter by the category of the workflows, which is either general or
configuration.
-
--system
| --sys
(string)
- Filter by the nickname of the system on which the workflows is/are active.
-
--owner
| --ow
(string)
- Filter by owner of the workflow(s) (a valid z/OS user ID).
-
--vendor
| --vd
(string)
- Filter by the name of the vendor that provided the workflow(s) definition file.
-
--status-name
| --sn
(string)
-
Filter by the status of the workflow(s).
Allowed values: in-progress, complete, automation-in-progress, canceled
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to
prepend the base path to all z/OSMF resources when making REST requests. Do not
specify this option if you are not using an API mediation layer.
-
--protocol
(string)
Profile Options
Base Connection Options
Response Format Options
-
--response-format-filter
| --rff
(array)
- Filter (include) fields in the response. Accepts an array of field/property
names to include in the output response. You can filter JSON objects properties
OR table columns/fields. In addition, you can use this option in conjunction
with '--response-format-type' to reduce the output of a command to a single
field/property or a list of a single field/property.
-
--response-format-type
| --rft
(string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is
an array of homogeneous JSON objects. Each property of the object will become a
column in the table.
list: Formats output data as a list of strings. Can be used on any data type
(JSON objects/arrays) are stringified and a new line is added after each entry
in an array.
object: Formats output data as a list of prettified objects (or single object).
Can be used in place of "table" to change from tabular output to a list of
prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header
| --rfh
(boolean)
- If "--response-format-type table" is specified, include the column headers
in the output.
Examples
-
List the workflow with name "testworkflow":
zowe zos-workflows list active-workflows --wn "testworkflow"
-
List multiple active workflows on the entire syspex with
names containing"workflow":
zowe zos-workflows list active-workflows --wn ".*workflow.*"
-
List multiple active workflows on system "IBMSYS" with names
beginnig with "testW" that are in status "complete":
zowe zos-workflows list active-workflows --wn "test.*" --sys "IBMSYS" --sn "complete"
List the archived z/OSMF workflows for a system or sysplex.
Usage
zowe zos-workflows list archived-workflows [options]
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to
prepend the base path to all z/OSMF resources when making REST requests. Do not
specify this option if you are not using an API mediation layer.
-
--protocol
(string)
Profile Options
Base Connection Options
Response Format Options
-
--response-format-filter
| --rff
(array)
- Filter (include) fields in the response. Accepts an array of field/property
names to include in the output response. You can filter JSON objects properties
OR table columns/fields. In addition, you can use this option in conjunction
with '--response-format-type' to reduce the output of a command to a single
field/property or a list of a single field/property.
-
--response-format-type
| --rft
(string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is
an array of homogeneous JSON objects. Each property of the object will become a
column in the table.
list: Formats output data as a list of strings. Can be used on any data type
(JSON objects/arrays) are stringified and a new line is added after each entry
in an array.
object: Formats output data as a list of prettified objects (or single object).
Can be used in place of "table" to change from tabular output to a list of
prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header
| --rfh
(boolean)
- If "--response-format-type table" is specified, include the column headers
in the output.
Retrieve the contents of a z/OSMF workflow definition from a z/OS system.
Usage
zowe zos-workflows list definition-file-details <definitionFilePath> [options]
Positional Arguments
Options
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to
prepend the base path to all z/OSMF resources when making REST requests. Do not
specify this option if you are not using an API mediation layer.
-
--protocol
(string)
Profile Options
Base Connection Options
Examples
-
To list the contents of a workflow definition stored in the
UNIX file "/user/dir/workflow.xml" including its steps and variables:
zowe zos-workflows list definition-file-details "/user/dir/workflow.xml" --list-steps --list-variables
-
To list the contents of a workflow definition stored in the
z/OS data set "USER.DATA.SET.XML" including its steps and variables:
zowe zos-workflows list definition-file-details --workflow-name "testWorkflow" --list-steps --list-variables
Start a z/OSMF workflow on a z/OS system.
Will run workflow from the beginning to the end or to the first manual step.
Usage
zowe zos-workflows start workflow-full [options]
Options
-
--workflow-key
| --wk
(string)
- Workflow key of workflow instance to be started
-
--workflow-name
| --wn
(string)
- Workflow name of workflow instance to be started
-
--resolve-conflict-by
| --rcb
(string)
-
How variable conflicts should be handled.
Options:
outputFileValue: Allow the output file values to override the existing values.
existingValue: Use the existing variables values instead of the output file
values.
leaveConflict: Automation is stopped. The user must resolve the conflict
manually.
Default value: outputFileValue
Allowed values: outputFileValue, existingValue, leaveConflict
-
--wait
| -w
(boolean)
- Identifies whether to wait for workflow instance to finish.
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to
prepend the base path to all z/OSMF resources when making REST requests. Do not
specify this option if you are not using an API mediation layer.
-
--protocol
(string)
Profile Options
Base Connection Options
Examples
-
To start a workflow instance in z/OSMF with workflow key
"d043b5f1-adab-48e7-b7c3-d41cd95fa4b0":
zowe zos-workflows start workflow-full --workflow-key "d043b5f1-adab-48e7-b7c3-d41cd95fa4b0"
-
To start a workflow instance in z/OSMF with workflow key
"d043b5f1-adab-48e7-b7c3-d41cd95fa4b0" and wait 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"
Will run given step of workflow instance plus following steps if specified by
--perform-following-steps option.
Usage
zowe zos-workflows start workflow-step <stepName> [options]
Positional Arguments
-
stepName
(string)
- Specifies the step name that will be run.
Options
-
--workflow-key
| --wk
(string)
- Workflow key of workflow instance to be started
-
--workflow-name
| --wn
(string)
- Workflow name of workflow instance to be started
-
--resolve-conflict-by
| --rcb
(string)
-
How variable conflicts should be handled.
Options:
outputFileValue: Allow the output file values to override the existing values.
existingValue: Use the existing variables values instead of the output file
values.
leaveConflict: Automation is stopped. The user must resolve the conflict
manually.
Default value: outputFileValue
Allowed values: outputFileValue, existingValue, leaveConflict
-
--perform-following-steps
| --pfs
(boolean)
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to
prepend the base path to all z/OSMF resources when making REST requests. Do not
specify this option if you are not using an API mediation layer.
-
--protocol
(string)
Profile Options
Base Connection Options
Examples
-
To start step "Step1" only in a workflow instance in z/OSMF
with workflow key "d043b5f1-adab-48e7-b7c3-d41cd95fa4b0":
zowe zos-workflows start workflow-step "Step1" --workflow-key "d043b5f1-adab-48e7-b7c3-d41cd95fa4b0"
-
To start a workflow instance in z/OSMF from step "Step1"
with workflow key "d043b5f1-adab-48e7-b7c3-d41cd95fa4b0":
zowe zos-workflows start workflow-step "Step1" --workflow-key "d043b5f1-adab-48e7-b7c3-d41cd95fa4b0" --perform-following-steps
-
To start step "Step1" only in a workflow instance in z/OSMF
with workflow key "d043b5f1-adab-48e7-b7c3-d41cd95fa4b0"and if there is a
conflict in variable's value use the value that is in output file:
zowe zos-workflows start workflow-step "Step1" --workflow-key "d043b5f1-adab-48e7-b7c3-d41cd95fa4b0" --resolve-conflict-by "outputFileValue"
-
To start step "Step1" only in a workflow instance in z/OSMF
with workflow name "testWorkflow":
zowe zos-workflows start workflow-step "Step1" --workflow-name "testWorkflow"
Retrieve and show the properties of a z/OSMF web server.
Confirm that z/OSMF is running on a specified system and gather information
about the z/OSMF server for diagnostic purposes.
Confirm that z/OSMF is running on a system specified in your profile and gather
information about the z/OSMF server for diagnostic purposes. The command
outputs properties of the z/OSMF server such as version, hostname, and installed
plug-ins.
Usage
zowe zosmf check status [options]
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to
prepend the base path to all z/OSMF resources when making REST requests. Do not
specify this option if you are not using an API mediation layer.
-
--protocol
(string)
Profile Options
Base Connection Options
Examples
-
Report the status of the z/OSMF server that you specified in
your default z/OSMF profile:
zowe zosmf check status
-
Report the status of the z/OSMF server that you specified in
a supplied z/OSMF profile:
zowe zosmf check status --zosmf-profile SomeZosmfProfileName
-
Report the status of the z/OSMF server that you specified
manually via command line:
zowe zosmf check status --host myhost --port 443 --user myuser --password mypass
Obtain a list of systems that are defined to a z/OSMF instance.
Obtain a list of systems that are defined to a z/OSMF instance.
Usage
zowe zosmf list systems [options]
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to
prepend the base path to all z/OSMF resources when making REST requests. Do not
specify this option if you are not using an API mediation layer.
-
--protocol
(string)
Profile Options
Base Connection Options
Examples
-
Obtain a list of systems defined to a z/OSMF instance with
your default z/OSMF profile:
zowe zosmf list systems
-
Obtain a list of systems defined to a z/OSMF instance for
the specified z/OSMF profile:
zowe zosmf list systems --zosmf-profile SomeZosmfProfileName
-
Obtain a list of the systems defined to a z/OSMF instance
that you specified in the command line:
zowe zosmf list systems --host myhost --port 443 --user myuser --password mypass