zowe-profiles.md

Profiles

base

Property	Description	Allowed
host	Host name of service on the mainframe.	string
port	Port number of service on the mainframe.	number
user	User name to authenticate to service on the mainframe.	string
password	Password to authenticate to service on the mainframe.	string
rejectUnauthorized	Reject self-signed certificates. Default: true	boolean: true false
tokenType	The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.	string
tokenValue	The value of the token to pass to the API.	string
certFile	The file path to a certificate file to use for authentication. Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.	string
certKeyFile	The file path to a certificate key file to use for authentication	string

ca7

Property	Description	Allowed
host	Host name of the CA7 API service that is running on the mainframe system.	string
port	Port for the CA7 API service that is running on the mainframe system.	number
user	User name for authenticating connections to the CA7 API service that is running on the mainframe system.	string
password	Password for authenticating connections to the CA7 API service that is running on the mainframe system.	string
basePath	The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.	string
protocol	Specifies protocol to use for CA7 connection (http or https).	string: http https
rejectUnauthorized	Reject self-signed certificates. Default: true	boolean: true false

cics

Property	Description	Allowed
host	The CMCI server host name	string
port	The CMCI server port Default: 1490	number
user	Your username to connect to CICS	string
password	Your password to connect to CICS	string
regionName	The name of the CICS region name to interact with	string
cicsPlex	The name of the CICSPlex to interact with	string
rejectUnauthorized	Reject self-signed certificates. Default: true	boolean: true false
protocol	Specifies CMCI protocol (http or https). Default: https	string: http https

db2

Property	Description	Allowed
host	The Db2 server host name	string
port	The Db2 server port number	number
user	The Db2 user ID (may be the same as the TSO login)	string
password	The Db2 password (may be the same as the TSO password)	string
database	The name of the database	string
sslFile	Path to the root CA Certificate file	string

dbm-db2

Property	Description	Allowed
host	Specifies the DBM Data Service REST API server host name or TCP/IP address to use.	string
port	Specifies the DBM Data Service REST API server TCP/IP port number. Default: 7300	number
user	Specifies the mainframe user name that you want to use to connect to the mainframe systems during execution of the Zowe CLI commands. This user name can be the same as your TSO login ID.	string
password	Specifies the mainframe password for the user name that is used to connect to the mainframe systems during execution of the CLI commands. This password can be the same as your TSO password.	string
protocol	Specifies the communication protocol between zowe dbm-db2 client and DBM Data Service. Default: https	string: http https
rejectUnauthorized	Determines whether the dbm-db2 command is accepted or rejected when a self-signed certificate is returned by the DBM Data Service. Default: true	boolean: true false
environmentList	Specifies a string of one or more entries consisting of a Db2 subsystem ID and a DBM Data Service REST API server host name or TCP/IP address. Use a comma to separate entries. The same Db2 subsystem can be used in multiple DBM Data Service environments. For more information about configuring the DBM Data Service, see the Database Management Solutions for Db2 for z/OS documentation at https://techdocs.broadcom.com/db2mgmt Default: {     "ssid1": "env1@host1:port1",     "ssid2": "env2@host2:port2" }	object
jobCards	Specifies a string array of z/OS JCL JOB statements. Default: //DB2DVOPS JOB CLASS=A, //     MSGCLASS=X	array
workDatasetPrefix	Specifies the prefix (high-level qualifier) in z/OS work data set names. Default: ${user}.dbmdb2	string
deleteWorkDatasets	Specifies whether to delete work data sets on a mainframe after the request is fulfilled. Default: true	boolean: true false
overwriteOutputFiles	Specifies whether to overwrite output files if they exist. Default: false	boolean: true false
authid	Specifies the primary Db2 authorization ID that is used to establish a connection between Db2 and a process. Default: ${user}	string
sqlid	Specifies the authorization ID that is used in generated SET CURRENT SQLID statements. Default: ${user}	string
terminationCharacter	Specifies the SQL termination character to use in DDL generation when the default termination character conflicts with the SQL statements that are used in triggers, XML indexes, and routines (external SQL functions and native SQL stored procedures). The default termination character is a semi-colon (;). You cannot specify a comma, double quote, single quote, left or right parentheses, or an underscore. Default: #	string
basePath	The base path for your API mediation layer instance. Specify this option to prepend the base path to all DBM DS resources when making REST requests. Do not specify this option if you are not using an API mediation layer.	string

dbm-db2-options

Property	Description	Allowed
authid	Specifies the primary Db2 authorization ID that is used to establish a connection between Db2 and a process.	string
changeSet	Specifies the creator and name of an existing RC/Migrator global change set that changes Db2 objects during a command execution. Format: <change-set-creator.change-set-name> For more information about global change services, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig Note: If change-set and change-set-file are both specified, specifications in change-set-file take precedence.	string
changeSetValues	Specifies the global change specifications that modify Db2 object attributes during a command execution. Format: <object-attribute> <from-value> <to-value>    The <object-attribute> consists of four characters. The first two characters identify the object type. The last two characters identify the specific attribute. Wildcard characters are supported in <from-value> and <to-value>. If the same <object-attribute> is specified multiple times, the first occurrence takes precedence.   For a full list of attributes, see Global Change Set Attributes in the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig Example: The following example demonstrates changes to the table schema (creator) and tablespace names:    TBCR TEST% PROD% TBTS TESTTS% PRODTS% Note: - If change-set and change-set-file are both specified, specifications in change-set-file take precedence. - The changeSetValues options-profile option has the same behavior as the change-set-file command option. Default: -- DDL changes for a table with dependent objects. -- Note: Replace CHANGEME with your database name. ALDB * CHANGEME ALCR * ${user} TBTC * ${user} IXTC * ${user} VWTC * ${user} VWFS * ${user} SYTC * ${user} ASTC * ${user} TGSC * ${user} TGOW * ${user} TGTC * ${user} TGTO * ${user} TGQU * ${user} TGFS * ${user} TGQS * ${user} SQSC * ${user} RTSC * ${user} RTPO * ${user} RTQU * ${user}	array
deleteWorkDatasets	Specifies whether to delete work data sets on a mainframe after the request is fulfilled.	boolean: true false
description	Specifies a 1- to 25-character description for the RC/Migrator compare strategy.	string
id	Specifies the 1- to 8-character name of the RC/Migrator compare strategy that is created on the target Db2 subsystem during a command execution. Format: The name must begin with a non-numeric character and contain the following characters only: uppercase letters from A to Z, numbers from 0 to 9, and special characters $, #, and @.	string
jobCards	Specifies a string array of z/OS JCL JOB statements.	array
matchSet	Specifies the creator and name of an existing RC/Migrator automapping mask set. Matching is used to pair objects in a DDL file to objects that are defined on a Db2 subsystem. Matching determines whether the 'change-set' or 'rule-set' options are applied. Format: <match-set-creator.match-set-name> For more information about mask services, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig Note: If --match-set and --match-set-file are both specified, specifications in match-set-file take precedence.	string
matchSetValues	Specifies the mapping mask specifications. Matching is used to pair objects in a DDL file to objects that are defined on a Db2 subsystem. For example, a mask specification can account for different schema naming patterns across environments. Matching determines whether the 'change-set' or 'rule-set' options are applied. Format: <object-type> <source-name-mask> <target-name-mask>; STOGROUP <name> <name> DATABASE <name> <name> TABLESPACE <database.name> <database.name> TABLE <schema.name> <schema.name> INDEX <schema.name> <schema.name> VIEW <schema.name> <schema.name> SYNONYM <schema.name> <schema.name> ALIAS <schema.name> <schema.name> TRIGGER <schema.name> <schema.name> SEQUENCE <schema.name> <schema.name> FUNCTION <schema.name[.version]> <schema.name[.version]> PROCEDURE <schema.name[.version]> <schema.name[.version]> Note: - <name> must be between 1 and 128 characters. For DATABASE and TABLESPACE, <name> must be between 1 and 8 characters. - <schema> must be between 1 and 128 characters. - <version> must be between 1 and 64 characters.            A mask specification can include the following wildcard characters:            Percent sign (%) indicates that zero or more characters can occupy that position and all remaining positions to the end of the name, or to the next character. The percent sign can be used anywhere in the name. However, the source and target characters must match exactly. Hyphen or dash (-) indicates that any character can occupy that position, but a character must exist at that position, and the source and target character must match exactly. The hyphen can be repeated in several places in the name. Asterisk (*) indicates matching values. An asterisk cannot be used with other characters.            Use a semicolon to separate mask specifications. Multiple mask specifications for the same object type are supported. Example: The following example demonstrates different ways of matching the table MYNAME.MYTABLE to the table YOURNAME.YOURTABLE: TABLE MY%.%TABLE YOUR%.%TABLE; TABLE MYN-M-.MYT% YOURN-M-.YOURT%; TABLE MYNAME.MYTABLE YOURNAME.YOURTABLE; TABLE *.MYTABLE *.YOURTABLE; For a list of mask specifications, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig Note: - If --match-set and --match-set-file are both specified, specifications in match-set-file take precedence. - The matchSetValues options-profile option has the same behavior as the match-set-file command option.	array
modification	Specifies a named set of server-managed default parameter values that control the execution behavior of the zowe dbm-db2 commands. For example, you can use a modification to identify a set of default values that differ from the current set of default values.   For more information about using the modification option, see the DBM Data Service documentation at https://techdocs.broadcom.com/db2mgmt	string
overwriteOutputFiles	Specifies whether to overwrite output files if they exist.	boolean: true false
ruleSet	Specifies the creator and name of an existing RC/Migrator rule set that overrides Db2 object attributes in the target Db2 subsystem with the corresponding values from the input DDL file. The changes only apply to existing objects, as determined by match-set processing. Format: <rule-set-creator.rule-set-name>      For more information about rule database services, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig	string
sqlid	Specifies the authorization ID that is used in generated SET CURRENT SQLID statements.	string
sourceDb2	Specifies the source Db2 subsystem or data sharing group where the objects that you want to use in a command are located. Note: If you specify the data sharing group, the first active Db2 subsystem in the group is used.	string
targetDb2	Specifies the target Db2 subsystem or data sharing group where you want to use a command. Note: If you specify the data sharing group, the first active Db2 subsystem in the group is used.	string
terminationCharacter	Specifies the SQL termination character to use in DDL generation when the default termination character conflicts with the SQL statements that are used in triggers, XML indexes, and routines (external SQL functions and native SQL stored procedures). The default termination character is a semi-colon (;). You cannot specify a comma, double quote, single quote, left or right parentheses, or an underscore.	string
type	Specifies the type of DDL statements that you want to generate. You can generate CREATE or DROP statements.	string: drop create
verify	Specifies whether to verify that the objects to be created do not exist on the Db2 subsystem and that the related objects that are required for successful creation of the objects exist on the Db2 subsystem or in the input DDL. Default: no	string: yes no
workDatasetPrefix	Specifies the prefix (high-level qualifier) in z/OS work data set names.	string

endevor

Property	Description	Allowed
host	The hostname of the endevor session	string
port	The port number of the endevor session	number
user	The username of the endevor session	string
password	The password of the user	string
protocol	The protocol used for connecting to Endevor Rest API Default: https	string: http https
basePath	The base path used for connecting to Endevor Rest API Default: EndevorService/api/v2	string
rejectUnauthorized	If set, the server certificate is verified against the list of supplied CAs	boolean: true false
reportDir	The default path where any reports will be written to, either absolute or relative to current directory Default: .	string

endevor-location

Property	Description	Allowed
instance	The STC/datasource of the session Default: ``````	string
environment	The Endevor environment where your project resides Default: DEV	string
system	The Endevor system where the element resides	string
subsystem	The Endevor subsystem where your element resides	string
type	Name of the Endevor element's type	string
stageNumber	The Endevor stage where your project resides	string: 1 2
comment	The Endevor comment you want to use when performing an action	string
ccid	The Endevor CCID you want to use when performing an action	string
maxrc	The return code of Endevor that defines a failed action Default: 8	number
override-signout	Always override element signout, without having to specify the override signout option on each command Default: false	boolean: true false
file-extension	The strategy for deciding what file extension to use during a bulk retrieve or workspace synchronization. Must be one of the following: none: File name is equal to element name, no extension is added. file-ext: The file extension defined in the Type definition is used; If not defined, no extension is added. type-name: The type name is used as the file extension. mixed: The file extension defined in Type definition is used; If not defined, the type name is used instead. Default: mixed	string: none type-name file-ext mixed

jclcheck

Property	Description	Allowed
host	Host name of the JCLCheck API service that is running on the mainframe system.	string
port	Port for the JCLCheck API service that is running on the mainframe system. Default: 12697	number
user	User name for authenticating connections to the JCLCheck API service that is running on the mainframe system.	string
password	Password for authenticating connections to the JCLCheck API service that is running on the mainframe system.	string
basePath	The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer. Default: cajclcheck/api/v1	string
rejectUnauthorized	Reject self-signed certificates. Default: true	boolean: true false
protocol	Specifies protocol to use for JCLCheck connection (http or https). Default: https	string: http https
jclcheckOptions	The desired set of JCLCheck runtime options. Specify the options exactly as you would on the PARM= or OPTIONS DD on a batch run of JCLCheck. See the JCLCheck runtime options documentation for details on available runtime options. If you specify options that change the format of the JCLCheck reports, you should request '--raw-output'. Changing the format of the report will affect the ability to produce a structured API response.	string

mat

Property	Description	Allowed
protocol	Specifies the protocol defined for the MAT REST API server (http or https). Default: https	string: http https
hostname	Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost).	string
port	Specifies the server port (e.g. 8080).	number
user	Your mainframe username.	string
password	Your mainframe password.	string
basePath	The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.	string
rejectUnauthorized	Reject self-signed certificates. Default: true	boolean: true false
listingDir	Specifies the directory where you want to store the registered program listings (e.g. 'c:\listings') for your immediate source code inspection. You can use the advantage of automated listing registration with MAT and listing retrieval through Endevor® footprints for Cobol, C/C++, and Assembler programs. When a source program listing is registered with MAT, you can enhance the histogram analysis data with the program listing details that pertain to the specific CSECT and program statement. The listing is transfered to the specified directory, which enables you to navigate directly to the line of the source code in you VS Code IDE and inspect the program statement. To use the listing retrieval option through Endevor® footprints, you need to have the Endevor® Web Services installed and configured and specify the Endevor® web server details in the MAT database configuration.	string

mq

Property	Description	Allowed
host	The host name used to access the IBM MQ REST API. This might be the host name of the IBM MQ mqweb server, or the Zowe API Mediation Layer..	string
port	The port number used to access the IBM MQ REST API. This might be the port number of the IBM MQ mqweb server, or the Zowe API Mediation Layer.	number
user	The mainframe (MQ) user name, which can be the same as your TSO login.	string
password	The mainframe (MQ) password, which can be the same as your TSO password.	string
rejectUnauthorized	Reject self-signed certificates. Default: false	boolean: true false
protocol	Specifies the MQ protocol (http or https). Default: https	string: http https

omspool

Property	Description	Allowed
account	z/OS TSO/E accounting information.	string
spoolhlq	High level qualifier of OM Spool installation.	string
subsys	OM Spool subsystem name. Default: ESF	string
outds	The SYSTSPRT data set allocated by CAI.CBQ4JCL(BQ4JZOWE). It must be unique for each Zowe CLI user interacting with OM Spool.	string
clist	The data set containing ESFZOWE REXX exec.	string

omview

Property	Description	Allowed
protocol	Protocol of the target OM Web Viewer instance. Default: https	string: http https
host	Hostname or ip address of the target OM Web Viewer instance.	string
port	Port of the target OM Web Viewer instance. Default: 443	number
basePath	Context name of the target OM Web Viewer instance. Default: web-viewer	string
user	User name used to authenticate against the target OM Web Viewer instance.	string
password	Password used to authenticate against the target OM Web Viewer instance.	string

ops

Property	Description	Allowed
host	The hostname of the server where OPS/MVS Web Services / REST API is running.	string
port	The port number for OPS/MVS Web Services / REST API.	number
user	Your z/OS user name that is used to authenticate to OPS/MVS Web Services / REST API.	string
password	Your z/OS password that is used to authenticate to OPS/MVS Web Services / REST API.	string
protocol	The protocol that is used for connecting to OPS/MVS Web Services / REST API. Default: https	string: http https
rejectUnauthorized	If set to true, the server certificate is verified against the list of supplied CAs. If set to false, certificate verification is not performed. Default: true	boolean: true false
subsystem	Specifies the subsystem ID of the OPS/MVS instance to which commands will be directed. This parameter is ignored by the 'show status' and 'show subsystem' commands. Default: OPSS	string
restApi	If set to true, the plug-in executes the command against the OPS/MVS REST API. If set to false, the plug-in executes against the OPS/MVS Web Services. Default: false	boolean: true false
basePath	NOTE: This parameter can only be used with the REST API server. Specifies the base path for your Zowe API Mediation Layer instance. Specify this option to prepend the base path to all resources when making REST requests. Only specify this option if you are using an Zowe API Mediation Layer.	string

pma

Property	Description	Allowed
job_acct	Specifies z/OS TSO/E accounting information. Values: numeric characters (0-9)	string
job_class	Your z/OS class information. Values: alphanumeric characters (A-Z, 0-9)	string
job_mclass	Specifies the MSGCLASS parameter value and assigns the job log to the specified output class. The specified MSGCLASS value is used in all JCLs that PMA runs while you execute the commands. If you do not provide the job_mclass parameter, the default MSGCLASS value is used. Values: alphanumeric characters (A-Z, 0-9) Default: A	string
job_load	Specifies the PMA loadlib data set name that you defined during the PMA customization (&HLQ.CEETLOAD)	string
job_pmahlq	Specifies your PMA HLQ to access the KSDSALT, KSDSJOB, and KSDSEXC VSAM files that ensure the collection of the necessary data	string

rse

Property	Description	Allowed
host	The z/OS host name running the Zowe REST API.	string
port	The server port used by the REST API. Default: 6800	number
user	The user name for the Zowe REST API operations.	string
password	The password of the user for the Zowe REST API operations.	string
rejectUnauthorized	Reject self-signed certificates. Default: true	boolean: true false
basePath	The base path of the API for the REST API operations. Default: rseapi	string
protocol	Only HTTPS supported for a TLS handshake to access REST API. Default: https	string: https
encoding	The encoding for download and upload of z/OS data set and USS files. The encoding should be specified in the form of "IBM-1047".	string
tokenType	JWT type assigned to profile when "zowe rse auth login" is used for authentication.	string
tokenValue	JWT value assigned to profile when "zowe rse auth login" is used for authentication.	string
tokenExpiration	JWT expiration assigned to profile when "zowe rse auth login" is used for authentication.	string

ssh

Property	Description	Allowed
host	The z/OS SSH server host name.	string
port	The z/OS SSH server port. Default: 22	number
user	Mainframe user name, which can be the same as your TSO login.	string
password	Mainframe password, which can be the same as your TSO password.	string
privateKey	Path to a file containing your private key, that must match a public key stored in the server for authentication	string
keyPassphrase	Private key passphrase, which unlocks the private key.	string
handshakeTimeout	How long in milliseconds to wait for the SSH handshake to complete.	number

sysview

Property	Description	Allowed
host	The hostname of the SYSVIEW REST API	string
port	The port number of the SYSVIEW REST API	number
user	Your z/OS username used to authenticate to the SYSVIEW REST API	string
password	Your z/OS password used to authenticate to the SYSVIEW REST API	string
rejectUnauthorized	If set, the server certificate is verified against the list of supplied CAs	boolean: true false
ssid	SSID of the SYSVIEW instance. Default: GSVX	string
basePath	The base path for your API mediation layer instance. Do not specify this option if you are not using an API mediation layer. Default: /api/v1	string

sysview-format

Property	Description	Allowed
contextFields	Context fields to display. Defaults to hiding all context	array
overview	Display the overview section	boolean: true false
info	Display the information area, if any	boolean: true false
pretty	Display formatted data	boolean: true false
blankIfZero	Show a blank space instead of '0' values	boolean: true false
truncate	Truncate displays that are too wide for the console Default: false	boolean: true false

tso

Property	Description	Allowed
account	Your z/OS TSO/E accounting information.	string
characterSet	Character set for address space to convert messages and responses from UTF-8 to EBCDIC. Default: 697	string
codePage	Codepage value for TSO/E address space to convert messages and responses from UTF-8 to EBCDIC. Default: 1047	string
columns	The number of columns on a screen. Default: 80	number
logonProcedure	The logon procedure to use when creating TSO procedures on your behalf. Default: IZUFPROC	string
regionSize	Region size for the TSO/E address space. Default: 4096	number
rows	The number of rows on a screen. Default: 24	number

zftp

Property	Description	Allowed
host	The hostname or IP address of the z/OS server to connect to.	string
port	The port of the z/OS FTP server. Default: 21	number
user	Username for authentication on z/OS	string
password	Password to authenticate to FTP.	string
secureFtp	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: true	boolean,null
rejectUnauthorized	Reject self-signed certificates. Only specify this if you are connecting to a secure FTP instance.	boolean,null
servername	Server name for the SNI (Server Name Indication) TLS extension. Only specify if you are connecting securely	string,null
connectionTimeout	How long (in milliseconds) to wait for the control connection to be established. Default: 10000	number
encoding	The encoding for download and upload of z/OS data set.	string

zosmf

Property	Description	Allowed
host	The z/OSMF server host name.	string
port	The z/OSMF server port. Default: 443	number
user	Mainframe (z/OSMF) user name, which can be the same as your TSO login.	string
password	Mainframe (z/OSMF) password, which can be the same as your TSO password.	string
rejectUnauthorized	Reject self-signed certificates. Default: true	boolean: true false
certFile	The file path to a certificate file to use for authentication	string
certKeyFile	The file path to a certificate key file to use for authentication	string
basePath	The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.	string
protocol	The protocol used (HTTP or HTTPS) Default: https	string: http https
encoding	The encoding for download and upload of z/OS data set and USS files. The default encoding if not specified is IBM-1047.	string
responseTimeout	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	number