zowe › caspool
-Interact with CA Spool™
+Interact with Spool™
Usage
zowe caspool <group>
Where <group> is one of the following:
Groups
-
-
- issue | is - Issue CA Spool commands. +
- issue | is - Issue Spool commands.
Interact with CA Spool™
+Interact with Spool™
Issue CA Spool commands.
+Issue Spool commands.
Issue commands to work with CA Spool.
+Issue commands to work with Spool.
zowe caspool issue command <commandText> [options]
commandText (string)
--account | -a (string)
--spoolhlq | --hlq (string)
--subsys | --sub (string)
CA Spool subsystem name.
+Spool subsystem name.
Default value: ESF
--outds | --out (string)
Issue the CA Spool command 'DS' to display the status of the ESF system:
+Issue the Spool command 'DS' to display the status of the ESF system:
zowe caspool issue command "DS" Access CA View data and perform related tasks.
+Access View data and perform related tasks.
Download CA View report data to local folder.
+Download View report data to local folder.
Download report data.
Optionally convert text report to PDF.
--hostname (string)
--port | -P (number)
Port of the target View REST API instance.
+Default value: 443
+--username (string)
--password | --pass | --pw (string)
--base-path (string)
Context name of the target View REST API instance.
+Default value: web-viewer
+--protocol (string)
Protocol of the target View REST API instance.
+Default value: https
+Allowed values: http, https
--port | -P (number)
--user | -u (string)
--password | --pass | --pw (string)
--reject-unauthorized | --ru (boolean)
Export CA View text report file to local folder.
+Export View text report file to local folder.
Export text report to spreadsheet using a predefined export rule.
--hostname (string)
--port | -P (number)
Port of the target View REST API instance.
+Default value: 443
+--username (string)
--password | --pass | --pw (string)
--base-path (string)
Context name of the target View REST API instance.
+Default value: web-viewer
+--protocol (string)
Protocol of the target View REST API instance.
+Default value: https
+Allowed values: http, https
--port | -P (number)
--user | -u (string)
--password | --pass | --pw (string)
--reject-unauthorized | --ru (boolean)
Get information from CA View repository.
+Get information from View repository.
Get user information from repository.
--caview-profile | --caview-p (string)
--base-profile | --base-p (string)
--host | -H (string)
--hostname (string)
--port | -P (number)
--user | -u (string)
--password | --pass | --pw (string)
--reject-unauthorized | --ru (boolean)
Reject self-signed certificates.
-Default value: true
---token-type | --tt (string)
--token-value | --tv (string)
--cert-file (local file path)
Port of the target View REST API instance.
+Default value: 443
--cert-key-file (local file path)
List CA View repository, report, and user information.
-List export rules defined for a report.
-Use the returned 'Identifier' in the 'export report' command to reference that rule.
zowe caview list export-rules <reportId> [options]
-reportId (string)
--username (string)
--output-format | --output (string)
--password | --pass | --pw (string)
Output format. This option is ignored if '--response-format-json' is specified.
-Default value: tabular
-Allowed values: ^tabular$, ^csv$, ^json$, ^xml$
--output-header | --header (boolean)
--base-path (string)
Include header with field names in the output when you specify 'tabular' or 'csv' for the output format.
-This option is ignored when you specify any other output format.
Default value: true
+Context name of the target View REST API instance.
+Default value: web-viewer
--output-field | -f (array)
--protocol (string)
Field to include in the output. Multiple fields can be specified.
-Fields appear in the order you specify.
Allowed values: Identifier,Name,Description,Owner,Public
-Default value: Identifier,Name,Description
+Protocol of the target View REST API instance.
+Default value: https
+Allowed values: http, https
--port | -P (number)
--user | -u (string)
--password | --pass | --pw (string)
--reject-unauthorized | --ru (boolean)
List information about a specific report.
-List indexes for a a specific report.
-Use the returned 'IndexNameHandle' to reference a report index.
-Use the returned 'IndexNameHandle' in the 'list report index-values' command to retrieve the list of associated index values for that index.
List View repository, report, and user information.
+List export rules defined for a report.
+Use the returned 'Identifier' in the 'export report' command to reference that rule.
zowe caview list report index-names <repositoryId> <reportHandle> [options]
+zowe caview list export-rules <reportId> [options]
repositoryId (number)
reportHandle (string)
reportId (string)
--filter-names | --names (string)
Filter (include) based on index name. Separate multiple index names with commas. Use the asterisk (*) as a wildcard to represent any number of characters.
-Default value: *,*,*,*,*,*,*,*
---output-format | --output (string)
Field to include in the output. Multiple fields can be specified.
Fields appear in the order you specify.
Allowed values: Index,SubIndexNames,IndexNameHandle
-Default value: Index,SubIndexNames,IndexNameHandle
+Allowed values: Identifier,Name,Description,Owner,Public
+Default value: Identifier,Name,Description
+--hostname (string)
--port | -P (number)
Port of the target View REST API instance.
+Default value: 443
+--username (string)
--password | --pass | --pw (string)
--base-path (string)
Context name of the target View REST API instance.
+Default value: web-viewer
+--protocol (string)
Protocol of the target View REST API instance.
+Default value: https
+Allowed values: http, https
--user | -u (string)
--reject-unauthorized | --ru (boolean)
Reject self-signed certificates.
+Default value: true
+--token-type | --tt (string)
--token-value | --tv (string)
--cert-file (local file path)
--cert-key-file (local file path)
List information about a specific report.
+List indexes for a a specific report.
+Use the returned 'IndexNameHandle' to reference a report index.
+Use the returned 'IndexNameHandle' in the 'list report index-values' command to retrieve the list of associated index values for that index.
zowe caview list report index-names <repositoryId> <reportHandle> [options]
+repositoryId (number)
reportHandle (string)
--filter-names | --names (string)
Filter (include) based on index name. Separate multiple index names with commas. Use the asterisk (*) as a wildcard to represent any number of characters.
+Default value: *,*,*,*,*,*,*,*
+--output-format | --output (string)
Output format. This option is ignored if '--response-format-json' is specified.
+Default value: tabular
+Allowed values: ^tabular$, ^csv$, ^json$, ^xml$
--output-header | --header (boolean)
Include header with field names in the output when you specify 'tabular' or 'csv' for the output format.
+This option is ignored when you specify any other output format.
Default value: true
+--output-field | -f (array)
Field to include in the output. Multiple fields can be specified.
+Fields appear in the order you specify.
Allowed values: Index,SubIndexNames,IndexNameHandle
+Default value: Index,SubIndexNames,IndexNameHandle
+--hostname (string)
--port | -P (number)
Port of the target View REST API instance.
+Default value: 443
+--user | -u (string)
--username (string)
--password | --pass | --pw (string)
--base-path (string)
Context name of the target View REST API instance.
+Default value: web-viewer
+--protocol (string)
Protocol of the target View REST API instance.
+Default value: https
+Allowed values: http, https
--caview-profile | --caview-p (string)
--base-profile | --base-p (string)
--host | -H (string)
--user | -u (string)
--hostname (string)
--port | -P (number)
Port of the target View REST API instance.
+Default value: 443
+--username (string)
--password | --pass | --pw (string)
--base-path (string)
Context name of the target View REST API instance.
+Default value: web-viewer
+--protocol (string)
Protocol of the target View REST API instance.
+Default value: https
+Allowed values: http, https
--port | -P (number)
--user | -u (string)
--password | --pass | --pw (string)
--reject-unauthorized | --ru (boolean)
--hostname (string)
--port | -P (number)
Port of the target View REST API instance.
+Default value: 443
+--username (string)
--password | --pass | --pw (string)
--base-path (string)
Context name of the target View REST API instance.
+Default value: web-viewer
+--protocol (string)
Protocol of the target View REST API instance.
+Default value: https
+Allowed values: http, https
--port | -P (number)
--user | -u (string)
--password | --pass | --pw (string)
--reject-unauthorized | --ru (boolean)
--hostname (string)
--port | -P (number)
Port of the target View REST API instance.
+Default value: 443
+--username (string)
--password | --pass | --pw (string)
--base-path (string)
Context name of the target View REST API instance.
+Default value: web-viewer
+--protocol (string)
Protocol of the target View REST API instance.
+Default value: https
+Allowed values: http, https
--port | -P (number)
--user | -u (string)
--password | --pass | --pw (string)
--reject-unauthorized | --ru (boolean)
--hostname (string)
--port | -P (number)
Port of the target View REST API instance.
+Default value: 443
+--username (string)
--password | --pass | --pw (string)
--base-path (string)
Context name of the target View REST API instance.
+Default value: web-viewer
+--protocol (string)
Protocol of the target View REST API instance.
+Default value: https
+Allowed values: http, https
--port | -P (number)
--user | -u (string)
--password | --pass | --pw (string)
--reject-unauthorized | --ru (boolean)
Search data in a CA View repository.
+Search data in a View repository.
Search cross-report index data in a repository.
--hostname (string)
--port | -P (number)
Port of the target View REST API instance.
+Default value: 443
+--username (string)
--password | --pass | --pw (string)
--base-path (string)
Context name of the target View REST API instance.
+Default value: web-viewer
+--protocol (string)
Protocol of the target View REST API instance.
+Default value: https
+Allowed values: http, https
--port | -P (number)
--user | -u (string)
--password | --pass | --pw (string)
--reject-unauthorized | --ru (boolean)
--caview-profile | --caview-p (string)
--hostname (string)
--base-profile | --base-p (string)
--port | -P (number)
--host | -H (string)
Port of the target View REST API instance.
+Default value: 443
--port | -P (number)
--user | -u (string)
--username (string)
--password | --pass | --pw (string)
--reject-unauthorized | --ru (boolean)
--base-path (string)
Reject self-signed certificates.
-Default value: true
+Context name of the target View REST API instance.
+Default value: web-viewer
+--protocol (string)
Protocol of the target View REST API instance.
+Default value: https
+Allowed values: http, https
--caview-profile | --caview-p (string)
--base-profile | --base-p (string)
--host | -H (string)
--user | -u (string)
--reject-unauthorized | --ru (boolean)
Reject self-signed certificates.
+Default value: true
--hostname (string)
--port | -P (number)
Port of the target View REST API instance.
+Default value: 443
+--username (string)
--password | --pass | --pw (string)
--base-path (string)
Context name of the target View REST API instance.
+Default value: web-viewer
+--protocol (string)
Protocol of the target View REST API instance.
+Default value: https
+Allowed values: http, https
--port | -P (number)
--user | -u (string)
--password | --pass | --pw (string)
--reject-unauthorized | --ru (boolean)
Set information in CA View repository.
+Set information in View repository.
Set configuration for current user in repository.
--hostname (string)
--port | -P (number)
Port of the target View REST API instance.
+Default value: 443
+--username (string)
--password | --pass | --pw (string)
--base-path (string)
Context name of the target View REST API instance.
+Default value: web-viewer
+--protocol (string)
Protocol of the target View REST API instance.
+Default value: https
+Allowed values: http, https
--port | -P (number)
--user | -u (string)
--password | --pass | --pw (string)
--reject-unauthorized | --ru (boolean)
--caview-profile | --caview-p (string)
--hostname (string)
--base-profile | --base-p (string)
--port | -P (number)
--host | -H (string)
Port of the target View REST API instance.
+Default value: 443
--port | -P (number)
--user | -u (string)
--username (string)
--password | --pass | --pw (string)
--reject-unauthorized | --ru (boolean)
Reject self-signed certificates.
-Default value: true
---token-type | --tt (string)
--base-path (string)
--token-value | --tv (string)
Context name of the target View REST API instance.
+Default value: web-viewer
--cert-file (local file path)
--cert-key-file (local file path)
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.
-zowe cics add-to-list csdGroup <name> <csdList> [options]
---protocol (string)
name (string)
Protocol of the target View REST API instance.
+Default value: https
+Allowed values: http, https
csdList (string)
--region-name (string)
--caview-profile | --caview-p (string)
--cics-plex (string)
--base-profile | --base-p (string)
--host | -H (string)
--port | -P (number)
The CICS server port.
-Default value: 443
---user | -u (string)
--password | --pw (string)
--protocol | -o (string)
Specifies CMCI protocol (http or https).
-Default value: https
-Allowed values: http, https
--cics-profile | --cics-p (string)
--base-profile | --base-p (string)
--token-type | --tt (string)
Add the CSD Group MYGRP to the CSD List MYLIST in the region named MYREG:
-zowe cics add-to-list csdGroup MYGRP MYLIST --region-name MYREG Define new resources (for example, programs) to CICS through IBM CMCI.
-Define a new program to CICS.
+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.
zowe cics define program <programName> <csdGroup> [options]
+zowe cics add-to-list csdGroup <name> <csdList> [options]
programName (string)
name (string)
csdGroup (string)
csdList (string)
--region-name (string)
--cics-plex (string)
Define a program named PGM123 to the region name MYREGION in the CSD group MYGRP:
+Add the CSD Group MYGRP to the CSD List MYLIST in the region named MYREG:
zowe cics define program PGM123 MYGRP --region-name MYREGION zowe cics add-to-list csdGroup MYGRP MYLIST --region-name MYREG Define a new transaction to CICS.
+Define new resources (for example, programs) to CICS through IBM CMCI.
+Define a new program to CICS.
zowe cics define transaction <transactionName> <programName> <csdGroup> [options]
+zowe cics define program <programName> <csdGroup> [options]
transactionName (string)
programName (string)
csdGroup (string)
--region-name (string)
--cics-plex (string)
Define a transaction named TRN1 for the program named PGM123 to the region named MYREGION in the CSD group MYGRP:
+Define a program named PGM123 to the region name MYREGION in the CSD group MYGRP:
zowe cics define transaction TRN1 PGM123 MYGRP --region-name MYREGION zowe cics define program PGM123 MYGRP --region-name MYREGION Define a new URIMAP of type client to CICS. This acts as an HTTP(S) client
+Define a new transaction to CICS.
zowe cics define urimap-client <urimapName> <csdGroup> [options]
+zowe cics define transaction <transactionName> <programName> <csdGroup> [options]
urimapName (string)
csdGroup (string)
transactionName (string)
--urimap-path | --up (string)
programName (string)
--urimap-host | --uh (string)
csdGroup (string)
--urimap-scheme | --us (string)
The scheme component to be used with the request (http or https).
-Default value: https
-Allowed values: http, https
--authenticate | --auth (string)
The authentication and identification scheme to be used for client URIMAPs.
-Allowed values: NO, BASIC
---certificate | --cert (string)
--description | --desc (string)
--region-name (string)
--cics-plex (string)
--enable (boolean)
Whether or not the URIMAP is to be enabled on install by default.
-Default value: true
-Define a URIMAP named URIMAPA to the region named MYREGION in the CSD group MYGRP where the host is www.example.com and the path is /example/index.html:
+Define a transaction named TRN1 for the program named PGM123 to the region named MYREGION in the CSD group MYGRP:
zowe cics define urimap-client URIMAPA MYGRP --urimap-path /example/index.html --urimap-host www.example.com --region-name MYREGION zowe cics define transaction TRN1 PGM123 MYGRP --region-name MYREGION Define a new URIMAP of type pipeline to CICS. This processes incoming HTTP(S) requests
+Define a new URIMAP of type client to CICS. This acts as an HTTP(S) client
zowe cics define urimap-pipeline <urimapName> <csdGroup> [options]
+zowe cics define urimap-client <urimapName> <csdGroup> [options]
--pipeline-name | --pn (string)
--description | --desc (string)
--authenticate | --auth (string)
--transaction-name | --tn (string)
The authentication and identification scheme to be used for client URIMAPs.
+Allowed values: NO, BASIC
+--webservice-name | --wn (string)
--certificate | --cert (string)
--tcpipservice | --tcpip (string)
--description | --desc (string)
Define a URIMAP named URIMAPA for the pipeline named PIPE123 to the region named MYREGION in the CSD group MYGRP where the host is www.example.com and the path is /example/index.html:
+Define a URIMAP named URIMAPA to the region named MYREGION in the CSD group MYGRP where the host is www.example.com and the path is /example/index.html:
zowe cics define urimap-pipeline URIMAPA MYGRP --urimap-path /example/index.html --urimap-host www.example.com --pipeline-name PIPE123 --region-name MYREGION zowe cics define urimap-client URIMAPA MYGRP --urimap-path /example/index.html --urimap-host www.example.com --region-name MYREGION Define a new URIMAP of type server to CICS. This acts as an HTTP(S) server
+Define a new URIMAP of type pipeline to CICS. This processes incoming HTTP(S) requests
zowe cics define urimap-server <urimapName> <csdGroup> [options]
+zowe cics define urimap-pipeline <urimapName> <csdGroup> [options]
--program-name | --pn (string)
--pipeline-name | --pn (string)
--transaction-name | --tn (string)
--webservice-name | --wn (string)
--tcpipservice | --tcpip (string)
Define a URIMAP named URIMAPA for the program named PGM123 to the region named MYREGION in the CSD group MYGRP where the host is www.example.com and the path is /example/index.html:
+Define a URIMAP named URIMAPA for the pipeline named PIPE123 to the region named MYREGION in the CSD group MYGRP where the host is www.example.com and the path is /example/index.html:
zowe cics define urimap-server URIMAPA MYGRP --urimap-path /example/index.html --urimap-host www.example.com --program-name PGM123 --region-name MYREGION zowe cics define urimap-pipeline URIMAPA MYGRP --urimap-path /example/index.html --urimap-host www.example.com --pipeline-name PIPE123 --region-name MYREGION Define a new web service to CICS.
+Define a new URIMAP of type server to CICS. This acts as an HTTP(S) server
zowe cics define webservice <webserviceName> <csdGroup> [options]
+zowe cics define urimap-server <urimapName> <csdGroup> [options]
webserviceName (string)
urimapName (string)
csdGroup (string)
--pipeline-name | --pn (string)
--urimap-path | --up (string)
--wsbind (string)
--urimap-host | --uh (string)
--program-name | --pn (string)
--description | --desc (string)
--urimap-scheme | --us (string)
The scheme component to be used with the request (http or https).
+Default value: https
+Allowed values: http, https
--validation (boolean)
--description | --desc (string)
Specifies whether full validation of SOAP messages against the corresponding schema in the web service description should be performed at run time.
-Default value: false
---wsdlfile | --wsdl (string)
--tcpipservice | --tcpip (string)
--region-name (string)
--cics-plex (string)
--enable (boolean)
Whether or not the URIMAP is to be enabled on install by default.
+Default value: true
+Define a webservice named WEBSVCA for the pipeline named PIPE123 to the region named MYREGION in the CSD group MYGRP where the binding file is /u/exampleapp/wsbind/example.log:
+Define a URIMAP named URIMAPA for the program named PGM123 to the region named MYREGION in the CSD group MYGRP where the host is www.example.com and the path is /example/index.html:
zowe cics define webservice WEBSVCA MYGRP --pipeline-name PIPELINE --wsbind /u/exampleapp/wsbind/example.log --region-name MYREGION zowe cics define urimap-server URIMAPA MYGRP --urimap-path /example/index.html --urimap-host www.example.com --program-name PGM123 --region-name MYREGION Delete resources (for example, programs) from CICS through IBM CMCI.
-Delete a program from CICS.
+Define a new web service to CICS.
zowe cics delete program <programName> <csdGroup> [options]
+zowe cics define webservice <webserviceName> <csdGroup> [options]
programName (string)
webserviceName (string)
csdGroup (string)
--pipeline-name | --pn (string)
--wsbind (string)
--description | --desc (string)
--validation (boolean)
Specifies whether full validation of SOAP messages against the corresponding schema in the web service description should be performed at run time.
+Default value: false
+--wsdlfile | --wsdl (string)
--region-name (string)
--cics-plex (string)
Delete a program named PGM123 from the region named MYREGION:
+Define a webservice named WEBSVCA for the pipeline named PIPE123 to the region named MYREGION in the CSD group MYGRP where the binding file is /u/exampleapp/wsbind/example.log:
zowe cics delete program PGM123 --region-name MYREGION zowe cics define webservice WEBSVCA MYGRP --pipeline-name PIPELINE --wsbind /u/exampleapp/wsbind/example.log --region-name MYREGION Delete a transaction from CICS.
+Delete resources (for example, programs) from CICS through IBM CMCI.
+Delete a program from CICS.
zowe cics delete transaction <transactionName> <csdGroup> [options]
+zowe cics delete program <programName> <csdGroup> [options]
transactionName (string)
programName (string)
csdGroup (string)
--region-name (string)
--cics-plex (string)
Delete a transaction named TRN1 from the region named MYREGION:
+Delete a program named PGM123 from the region named MYREGION:
zowe cics delete transaction TRN1 MYGRP --region-name MYREGION zowe cics delete program PGM123 --region-name MYREGION Delete a urimap from CICS.
+Delete a transaction from CICS.
zowe cics delete urimap <urimapName> <csdGroup> [options]
+zowe cics delete transaction <transactionName> <csdGroup> [options]
urimapName (string)
transactionName (string)
csdGroup (string)
--region-name (string)
--cics-plex (string)
Delete a urimap named URIMAPA from the region named MYREGION belonging to the csdgroup MYGRP:
+Delete a transaction named TRN1 from the region named MYREGION:
zowe cics delete urimap URIMAPA MYGRP --region-name MYREGION zowe cics delete transaction TRN1 MYGRP --region-name MYREGION Delete a web service from CICS.
+Delete a urimap from CICS.
zowe cics delete webservice <webserviceName> <csdGroup> [options]
+zowe cics delete urimap <urimapName> <csdGroup> [options]
webserviceName (string)
urimapName (string)
csdGroup (string)
--region-name (string)
Delete a web service named WEBSVCA from the region named MYREGION belonging to the csdgroup MYGRP:
+Delete a urimap named URIMAPA from the region named MYREGION belonging to the csdgroup MYGRP:
zowe cics delete webservice WEBSVCA MYGRP --region-name MYREGION zowe cics delete urimap URIMAPA MYGRP --region-name MYREGION Disable resources (for example, urimaps) from CICS through IBM CMCI.
-Disable a urimap from CICS.
+Delete a web service from CICS.
zowe cics disable urimap <urimapName> [options]
+zowe cics delete webservice <webserviceName> <csdGroup> [options]
urimapName (string)
webserviceName (string)
csdGroup (string)
--region-name (string)
Disable a urimap named URIMAPA from the region named MYREGION:
+Delete a web service named WEBSVCA from the region named MYREGION belonging to the csdgroup MYGRP:
zowe cics disable urimap URIMAPA --region-name MYREGION zowe cics delete webservice WEBSVCA MYGRP --region-name MYREGION Discard resources (for example, programs) from CICS through IBM CMCI.
-Discard a program from CICS.
+Disable resources (for example, urimaps) from CICS through IBM CMCI.
+Disable a urimap from CICS.
zowe cics discard program <programName> [options]
+zowe cics disable urimap <urimapName> [options]
programName (string)
urimapName (string)
--region-name (string)
--cics-plex (string)
Discard a program named PGM123 from the region named MYREGION:
+Disable a urimap named URIMAPA from the region named MYREGION:
zowe cics discard program PGM123 --region-name MYREGION zowe cics disable urimap URIMAPA --region-name MYREGION Discard a transaction from CICS.
+Discard resources (for example, programs) from CICS through IBM CMCI.
+Discard a program from CICS.
zowe cics discard transaction <transactionName> [options]
+zowe cics discard program <programName> [options]
transactionName (string)
programName (string)
--region-name (string)
--cics-plex (string)
Discard a transaction named TRN1 from the region named MYREGION:
+Discard a program named PGM123 from the region named MYREGION:
zowe cics discard transaction TRN1 --region-name MYREGION zowe cics discard program PGM123 --region-name MYREGION Discard a urimap from CICS.
+Discard a transaction from CICS.
zowe cics discard urimap <urimapName> [options]
+zowe cics discard transaction <transactionName> [options]
urimapName (string)
transactionName (string)
--region-name (string)
--cics-plex (string)
Discard a urimap named URIMAPA from the region named MYREGION:
+Discard a transaction named TRN1 from the region named MYREGION:
zowe cics discard urimap URIMAPA --region-name MYREGION zowe cics discard transaction TRN1 --region-name MYREGION Enable resources (for example, urimaps) from CICS through IBM CMCI.
-Enable a urimap from CICS.
+Discard a urimap from CICS.
zowe cics enable urimap <urimapName> [options]
+zowe cics discard urimap <urimapName> [options]
urimapName (string)
--region-name (string)
Enable a urimap named URIMAPA from the region named MYREGION:
+Discard a urimap named URIMAPA from the region named MYREGION:
zowe cics enable urimap URIMAPA --region-name MYREGION zowe cics discard urimap URIMAPA --region-name MYREGION Get resources (for example, programs or transactions) from CICS through IBM CMCI.
-Get resources (for example, programs or transactions) from CICS.
+Enable resources (for example, urimaps) from CICS through IBM CMCI.
+Enable a urimap from CICS.
zowe cics get resource <resourceName> [options]
+zowe cics enable urimap <urimapName> [options]
resourceName (string)
urimapName (string)
--region-name | --rn (string)
--cics-plex | --cp (string)
--criteria | -c (string)
--parameter | -p (string)
--region-name (string)
--response-format-filter | --rff (array)
--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)
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:
+Enable a urimap named URIMAPA from the region named MYREGION:
zowe cics get resource CICSDefinitionURIMap --region-name MYREGION --parameter "CSDGROUP(GRP1)" zowe cics enable urimap URIMAPA --region-name MYREGION 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:
+Get resources (for example, programs or transactions) from CICS through IBM CMCI.
+Get resources (for example, programs or transactions) from CICS.
+zowe cics get resource <resourceName> [options]
+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:
+resourceName (string)
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.
-zowe cics install program <programName> <csdGroup> [options]
-programName (string)
--region-name | --rn (string)
csdGroup (string)
--cics-plex | --cp (string)
--region-name (string)
--criteria | -c (string)
--cics-plex (string)
--parameter | -p (string)
--response-format-filter | --rff (array)
--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)
Install a program named PGM123 to the region named MYREGION in the CSD group MYGRP:
+Get program resources from the region named MYREGION:
zowe cics install program PGM123 MYGRP --region-name 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 Install a transaction to CICS.
+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.
zowe cics install transaction <transactionName> <csdGroup> [options]
+zowe cics install program <programName> <csdGroup> [options]
transactionName (string)
programName (string)
csdGroup (string)
--region-name (string)
--cics-plex (string)
Install a transaction named TRN1 to the region named MYREGION in the CSD group MYGRP:
+Install a program named PGM123 to the region named MYREGION in the CSD group MYGRP:
zowe cics install transaction TRN1 MYGRP --region-name MYREGION zowe cics install program PGM123 MYGRP --region-name MYREGION Install a urimap to CICS.
+Install a transaction to CICS.
zowe cics install urimap <urimapName> <csdGroup> [options]
+zowe cics install transaction <transactionName> <csdGroup> [options]
urimapName (string)
transactionName (string)
csdGroup (string)
--region-name (string)
--cics-plex (string)
Install a urimap named URIMAPA to the region named MYREGION belonging to the csdgroup MYGRP:
+Install a transaction named TRN1 to the region named MYREGION in the CSD group MYGRP:
zowe cics install urimap URIMAPA CSDGROUP --region-name MYREGION zowe cics install transaction TRN1 MYGRP --region-name MYREGION Refresh a program on CICS through IBM CMCI.
-Refresh a program on CICS.
+Install a urimap to CICS.
zowe cics refresh program <programName> [options]
+zowe cics install urimap <urimapName> <csdGroup> [options]
programName (string)
urimapName (string)
--region-name (string)
csdGroup (string)
--cics-plex (string)
--region-name (string)
--host | -H (string)
--port | -P (number)
The CICS server port.
+Default value: 443
+--user | -u (string)
--password | --pw (string)
--reject-unauthorized | --ru (boolean)
Reject self-signed certificates.
+Default value: true
+--protocol | -o (string)
Specifies CMCI protocol (http or https).
+Default value: https
+Allowed values: http, https
--cics-profile | --cics-p (string)
--base-profile | --base-p (string)
--token-type | --tt (string)
--token-value | --tv (string)
--cert-file (local file path)
--cert-key-file (local file path)
Install a urimap named URIMAPA to the region named MYREGION belonging to the csdgroup MYGRP:
+zowe cics install urimap URIMAPA CSDGROUP --region-name MYREGION Refresh a program on CICS through IBM CMCI.
+Refresh a program on CICS.
+zowe cics refresh program <programName> [options]
+programName (string)
--region-name (string)
--cics-plex (string)
Endevor plug-in for listing Endevor environment information, working with elements and packages located in specified Endevor instance.
-Add an Element into Endevor.
-The add element command lets you add an Element to an Environment entry Stage in Endevor.
-zowe endevor add element <element> [options]
+dbm-db2 plug-in to interact with Db2 using the Broadcom Database Management Solutions for Db2 for z/OS.
+Perform DDL syntax checking.
+Validate the syntax of input DDL and optionally verify Db2 object dependencies. Use this command to ensure that the syntax of the input DDL is valid. You can also optionally verify that the objects to be created do not exist on the Db2 subsystem and that the related objects that are required for successful creation of the objects exist on the Db2 subsystem or in the input DDL. You can generate input DDL using the 'zowe dbm-db2 generate ddl' command.
+zowe dbm-db2 check ddl <local-input-ddl-filename> [options]
element (string)
local-input-ddl-filename (string)
--environment | --env (string)
--system | --sys (string)
--subsystem | --sub (string)
--type | --typ (string)
--ccid | --cci (string)
--comment | --com (string)
--maxrc (number)
--instance | -i (string)
--target-db2 | --td (string)
--from-file | --ff (string)
--from-dataset | --fd (string)
--from-member | --fm (string)
--verify | -v (string)
--from-path | --fp (string)
--from-uss-file | --fuf (string)
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 value: no
+Allowed values: yes, no
--override-signout | --os (boolean)
--new-version | --nv (number)
--modification | -m (string)
--proc-group | --pg (string)
Identifies an existing 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 set of values that are normally used.
+For more information about using the modification option, see the DBM Data Service documentation at https://techdocs.broadcom.com/db2mgmt.
--generate | -g (boolean)
--get-fingerprint | --gfg (boolean)
--error-file | --ef (string)
Return fingerprint of a retrieved, added or updated element as the first line of the response.
-Default value: false
-Specifies the local output error file that contains errors that occurred during execution of the command.
+Default value: error.log
--fingerprint | --fg (string)
--suppress-messages | --sm (boolean)
--dbm-db2-profile | --dbm-db2-p (string)
--file-name | --fn (string)
--base-profile | --base-p (string)
--host | --hostname (string)
--port | -p (string)
--host | -H (string)
--protocol | --prot (string)
--port | -P (number)
Specifies the protocol used for connecting to Endevor Rest API
-Default value: https
-Allowed values: http, https
--user | --username (string)
--user | -u (string)
--password | --pass (string)
--password | --pass | --pw (string)
--reject-unauthorized | --ru (boolean)
--base-path | --bp (string)
--endevor-profile | --endevor-p (string)
--endevor-location-profile | --endevor-location-p (string)
Reject self-signed certificates.
+Default value: true
--base-profile | --base-p (string)
--token-type | --tt (string)
--token-value | --tv (string)
--cert-file (local file path)
--cert-key-file (local file path)
Validate DDL statement syntax of the DDL statements in the sample.sql file on the 'TEST' Db2 subsystem:
+zowe dbm-db2 check ddl sample.sql --target-db2 TEST Validate DDL statement syntax and verify object dependencies:
+zowe dbm-db2 check ddl sample.sql --target-db2 TEST --verify yes Compare DDL with a Db2 subsystem and produce an update script to implement changes.
+Compare objects that are defined in a DDL file to objects that are defined on a Db2 subsystem and generate an update script to implement the necessary object changes. This command also generates a summary report that provides a high-level overview of the changes. You can execute the script that is generated from this command using the 'zowe dbm-db2 execute compare-script' command.
+zowe dbm-db2 compare ddl <local-input-ddl-filename> [options]
+local-input-ddl-filename (string)
--target-db2 | --td (string)
--match-set | --ms (string)
Specifies the creator and name of an existing RC/Migrator automapping mask set. Matching is used to pair objects in a DDL file to objects that are defined on a Db2 subsystem. Matching determines whether the 'change-set' or 'rule-set' options are applied.
+Format:
+ <match\-set\-creator\.match\-set\-name>
+
+ For more information about mask services, see the RC/Migrator documentation at https://techdocs\.broadcom\.com/db2rcmig\.
+
+ Note: If \-\-match\-set and \-\-match\-set\-file are both specified, specifications in match\-set\-file take precedence\.
+--match-set-file | --msf (string)
Specifies the name of the local input file that contains the mapping mask specifications. Matching is used to pair objects in a DDL file to objects that are defined on a Db2 subsystem. For example, a mask specification can account for different schema naming patterns across environments. Matching determines whether the 'change-set' or 'rule-set' options are applied.
+Format:
+ <object\-type> <source\-name\-mask> <target\-name\-mask>;
+
+ STOGROUP <name> <name>
+ DATABASE <name> <name>
+ TABLESPACE <database\.name> <database\.name>
+ TABLE <schema\.name> <schema\.name>
+ INDEX <schema\.name> <schema\.name>
+ VIEW <schema\.name> <schema\.name>
+ SYNONYM <schema\.name> <schema\.name>
+ ALIAS <schema\.name> <schema\.name>
+ TRIGGER <schema\.name> <schema\.name>
+ SEQUENCE <schema\.name> <schema\.name>
+ FUNCTION <schema\.name\[\.version\]> <schema\.name\[\.version\]>
+ PROCEDURE <schema\.name\[\.version\]> <schema\.name\[\.version\]>
+
+ Note: <schema> must be 8 characters or less\. <name> must be 18 characters or less\. The SEQUENCE <name> must be 8 characters or less\.
+
+ A mask specification can include the following wildcard characters:
+
+ % (percent sign) indicates that zero or more characters can occupy that position\. Other non\-wildcard characters must match\.
+
+ \- (hyphen) indicates that any character can occupy that position, but a character must exist at that position\.
+
+ \* (asterisk) indicates that like named objects on the source and target should be mapped\. No other characters can appear together with this character\.
+
+ 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\.
+--change-set | --cs (string)
Specifies the creator and name of an existing RC/Migrator global change set to be used to modify Db2 object attributes. The changes apply to new objects only as determined by match-set processing.
+Format:
+ <change\-set\-creator\.change\-set\-name>
+
+ For more information about global change services, see the RC/Migrator documentation at https://techdocs\.broadcom\.com/db2rcmig\.
+
+ Note: If change\-set and change\-set\-file are both specified, specifications in change\-set\-file take precedence\.
+--change-set-file | --csf (string)
Specifies the name of the local input file that contains the global change specifications to modify Db2 object attributes. The changes apply to new objects only as determined by match-set processing.
+Format:
+ <object\-attribute> <from\-value> <to\-value>
+
+ The <object\-attribute> consists of four characters\. The first two characters identify the object type\. The last two characters identify the specific attribute\. Wildcard characters are supported in the <from\-value> and <to\-value>\. The first occurrence in multiple specifications for the same <object\-attribute> has the highest precedence\.
+Example:
+The following example demonstrates changes to table’s schema (creator) and tablespace names:
+TBCR TEST% PROD%
+TBTS TESTTS% PRODTS%
For a list of global change set attributes, 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\.
+--rule-set | --rs (string)
Specifies the creator and name of an existing RC/Migrator rule set to be used to override Db2 object attributes in the target Db2 subsystem with the corresponding values from the input DDL file.The changes apply to the existing objects only (as determined by match-set processing).
+Format:
+ <rule\-set\-creator\.rule\-set\-name>
+
+ For more information about rule database services, see the RC/Migrator documentation at https://techdocs\.broadcom\.com/db2rcmig\.
+--id (string)
Specifies the 1- to 8-character name of the RC/Migrator compare strategy that is created on the target Db2 subsystem by the execution of this command.
+Format: The name must begin with a non-numeric character, and can consist of the characters A to Z (uppercase only), 0 to 9, $, #, and @.
+--description | -d (string)
--output-compare-script | --ocs (string)
Specifies the local output file name that contains the update script to make changes to the target Db2 subsystem.
+Default value: compare.txt
+--output-summary-file | --osf (string)
Specifies the local output file name that provides a summary of the changes to be performed to the Db2 objects on the target Db2 subsystem. The file summarizes what the changes are, but not how the changes are made.
+Default value: summary.txt
+--modification | -m (string)
Identifies 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 set of values that are normally used.
+For more information about using the modification option, see the DBM Data Service documentation at https://techdocs.broadcom.com/db2mgmt.
+--error-file | --ef (string)
Specifies the local output error file that contains errors that occurred during execution of the command.
+Default value: error.log
+--dbm-db2-profile | --dbm-db2-p (string)
--base-profile | --base-p (string)
--host | -H (string)
--port | -P (number)
--user | -u (string)
--password | --pass | --pw (string)
--reject-unauthorized | --ru (boolean)
Reject self-signed certificates.
+Default value: true
+--token-type | --tt (string)
--token-value | --tv (string)
--cert-file (local file path)
--cert-key-file (local file path)
Generate a script to update objects on the 'TEST' Db2 subsystem with DDL definitions in myddl.sql file:
+zowe dbm-db2 compare ddl myddl.sql --target-db2 TEST Generate a script to update objects and apply a rule-set for the matched objects:
+zowe dbm-db2 compare ddl myddl.sql --target-db2 TEST --rule-set USER1.RULESET Generate a script to update objects and apply a ruleset for the objects matched as determined by the local mask specifications in the pair.txt file:
+zowe dbm-db2 compare ddl myddl.sql --target-db2 TEST --rule-set USER1.RULESET --match-set-file pair.txt Deploy DDL statements to a Db2 subsystem.
+Deploy Db2 object changes on the target Db2 subsystem using an input file that contains the DDL. For example, an application developer has made changes to DDL in a local file and is ready to test the DDL changes. Use this command to deploy the changes to the test environment.
+zowe dbm-db2 deploy ddl <local-input-ddl-filename> [options]
+local-input-ddl-filename (string)
--target-db2 | --td (string)
--match-set | --ms (string)
Specifies the creator and name of an existing RC/Migrator automapping mask set. Matching is used to pair objects in a DDL file to objects that are defined on a Db2 subsystem. Matching determines whether the 'change-set' or 'rule-set' options are applied.
+Format:
+ <match\-set\-creator\.match\-set\-name>
+
+ For more information about mask services, see the RC/Migrator documentation at https://techdocs\.broadcom\.com/db2rcmig\.
+
+ Note: If \-\-match\-set and \-\-match\-set\-file are both specified, specifications in match\-set\-file take precedence\.
+--match-set-file | --msf (string)
Specifies the name of the local input file that contains the mapping mask specifications. Matching is used to pair objects in a DDL file to objects that are defined on a Db2 subsystem. For example, a mask specification can account for different schema naming patterns across environments. Matching determines whether the 'change-set' or 'rule-set' options are applied.
+Format:
+ <object\-type> <source\-name\-mask> <target\-name\-mask>;
+
+ STOGROUP <name> <name>
+ DATABASE <name> <name>
+ TABLESPACE <database\.name> <database\.name>
+ TABLE <schema\.name> <schema\.name>
+ INDEX <schema\.name> <schema\.name>
+ VIEW <schema\.name> <schema\.name>
+ SYNONYM <schema\.name> <schema\.name>
+ ALIAS <schema\.name> <schema\.name>
+ TRIGGER <schema\.name> <schema\.name>
+ SEQUENCE <schema\.name> <schema\.name>
+ FUNCTION <schema\.name\[\.version\]> <schema\.name\[\.version\]>
+ PROCEDURE <schema\.name\[\.version\]> <schema\.name\[\.version\]>
+
+ Note: <schema> must be 8 characters or less\. <name> must be 18 characters or less\. The SEQUENCE <name> must be 8 characters or less\.
+
+ A mask specification can include the following wildcard characters:
+
+ % (percent sign) indicates that zero or more characters can occupy that position\. Other non\-wildcard characters must match\.
+
+ \- (hyphen) indicates that any character can occupy that position, but a character must exist at that position\.
+
+ \* (asterisk) indicates that like named objects on the source and target should be mapped\. No other characters can appear together with this character\.
+
+ 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\.
+--change-set | --cs (string)
Specifies the creator and name of an existing RC/Migrator global change set to be used to modify Db2 object attributes. The changes apply to new objects only as determined by match-set processing.
+Format:
+ <change\-set\-creator\.change\-set\-name>
+
+ For more information about global change services, see the RC/Migrator documentation at https://techdocs\.broadcom\.com/db2rcmig\.
+
+ Note: If change\-set and change\-set\-file are both specified, specifications in change\-set\-file take precedence\.
+--change-set-file | --csf (string)
Specifies the name of the local input file that contains the global change specifications to modify Db2 object attributes. The changes apply to new objects only as determined by match-set processing.
+Format:
+ <object\-attribute> <from\-value> <to\-value>
+
+ The <object\-attribute> consists of four characters\. The first two characters identify the object type\. The last two characters identify the specific attribute\. Wildcard characters are supported in the <from\-value> and <to\-value>\. The first occurrence in multiple specifications for the same <object\-attribute> has the highest precedence\.
+Example:
+The following example demonstrates changes to table’s schema (creator) and tablespace names:
+TBCR TEST% PROD%
+TBTS TESTTS% PRODTS%
For a list of global change set attributes, 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\.
+--rule-set | --rs (string)
Specifies the creator and name of an existing RC/Migrator rule set to be used to override Db2 object attributes in the target Db2 subsystem with the corresponding values from the input DDL file.The changes apply to the existing objects only (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\.
+--modification | -m (string)
Identifies 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 set of values that are normally used.
+For more information about using the modification option, see the DBM Data Service documentation at https://techdocs.broadcom.com/db2mgmt.
+--error-file | --ef (string)
Specifies the local output error file that contains errors that occurred during execution of the command.
+Default value: error.log
+--dbm-db2-profile | --dbm-db2-p (string)
--base-profile | --base-p (string)
--host | -H (string)
--port | -P (number)
--user | -u (string)
--password | --pass | --pw (string)
--reject-unauthorized | --ru (boolean)
Reject self-signed certificates.
+Default value: true
+--token-type | --tt (string)
--token-value | --tv (string)
--cert-file (local file path)
--cert-key-file (local file path)
Update Db2 objects on a target Db2 subsystem according to DDL definitions in myddl.sql file:
+zowe dbm-db2 deploy ddl myddl.sql --target-db2 TEST Update Db2 objects according to the input DDL definitions and applied rule set for the matched objects:
+zowe dbm-db2 deploy ddl myddl.sql --target-db2 TEST --rule-set USER1.RULESET Update Db2 objects according to the input DDL definitions and applied rule set for the objects matched as determined by the local mask specifications in the pair.txt file:
+zowe dbm-db2 deploy ddl myddl.sql --target-db2 TEST --rule-set USER1.RULESET --match-set-file pair.txt Execute a script to implement Db2 object changes.
+Execute the compare script that was generated with the 'zowe dbm-db2 compare ddl' command to implement the Db2 object changes on the Db2 subsystem specified within the script. This command also generates a recovery script to undo compare script changes.
+zowe dbm-db2 execute compare-script <local-input-compare-script-filename> [options]
+local-input-compare-script-filename (string)
--output-recovery-file | --orf (string)
Specifies the local output recovery file that contains the recovery script that is generated during execution of this command. Executing the recovery script using the 'zowe dbm-db2 execute script' command undoes the changes that were made by execution of the compare-script.
+ Default value: recovery\.txt
+--restart | -r (string)
Specifies the location in the script where you want to restart execution. The effects of previous successful script statement executions remain.
+ The following restart options are valid:
+
+ new \- Restart execution of the script at the first statement\.
+
+ token \- Restart execution of the script at the location that is recorded in the specified token and that was returned from a previous execution failure\.
+--modification | -m (string)
Identifies 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 set of values that are normally used.
+For more information about using the modification option, see the DBM Data Service documentation at https://techdocs.broadcom.com/db2mgmt.
+--error-file | --ef (string)
Specifies the local output error file that contains errors that occurred during execution of the command.
+Default value: error.log
+--dbm-db2-profile | --dbm-db2-p (string)
--base-profile | --base-p (string)
--host | -H (string)
--port | -P (number)
--user | -u (string)
--password | --pass | --pw (string)
--reject-unauthorized | --ru (boolean)
Reject self-signed certificates.
+Default value: true
+--token-type | --tt (string)
--token-value | --tv (string)
--cert-file (local file path)
--cert-key-file (local file path)
Execute a compare script:
+zowe dbm-db2 execute compare-script compare.txt Restart execution of a compare script at the first statement in the script:
+zowe dbm-db2 execute compare-script compare.txt --restart new Restart execution of a compare script at the location in the token:
+zowe dbm-db2 execute compare-script compare.txt --restart 78A724GOBLEDYGOOK6FD140F6780D6FA Execute the migration script that was generated with the 'zowe dbm-db2 prepare migration' command to migrate Db2 objects (DDL) and table data from a source subsystem to a target subsystem. The source and target subsystem IDs are specified within the script.
+zowe dbm-db2 execute migration-script <local-input-migrate-script-filename> [options]
+local-input-migrate-script-filename (string)
--restart | -r (string)
Specifies the location in the script where you want to restart execution. The effects of previous successful script statement executions remain.
+ The following restart options are valid:
+
+ new \- Restart execution of the script at the first statement\.
+
+ name, token \- Restart execution of the script at the location in the restart section that is recorded in the specified token and that was returned from a prior execution failure\.
+
+ A section is a '\.SYSTEM <name>' statement, where <name> identifies a logical grouping of statements such as UNLOADS or SQLDDL\. 'source' is an alias for UNLOADS\. 'target' is an alias for SQLDDL\.
+--modification | -m (string)
Identifies 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 set of values that are normally used.
+For more information about using the modification option, see the DBM Data Service documentation at https://techdocs.broadcom.com/db2mgmt.
+--error-file | --ef (string)
Specifies the local output error file that contains errors that occurred during execution of the command.
+Default value: error.log
+--dbm-db2-profile | --dbm-db2-p (string)
--base-profile | --base-p (string)
--host | -H (string)
--port | -P (number)
--user | -u (string)
--password | --pass | --pw (string)
--reject-unauthorized | --ru (boolean)
Reject self-signed certificates.
+Default value: true
+--token-type | --tt (string)
--token-value | --tv (string)
--cert-file (local file path)
--cert-key-file (local file path)
Execute a migration script:
+zowe dbm-db2 execute migration-script migration.txt Restart execution of a migration script at the first statement in the script:
+zowe dbm-db2 execute migration-script migration.txt --restart new Restart execution of a migration script at the location in the token. Execution begins at the last successful sync point that is recorded in the restart token up to the end of the restart token section:
+zowe dbm-db2 execute migration-script migration.txt --restart target,78A724GOBLEDYGOOK6FD140F6780D6FA Execute a Batch Processor script on a target subsystem. For example, use this command to execute a Batch Processor script or specifically to execute a recovery script to undo changes that were made by the 'zowe dbm-db2 execute compare-script' command. If execution of the script fails, you can execute it again using the 'script-section' or 'restart' options. You can edit the script and make changes before you execute or restart it.
+zowe dbm-db2 execute script <local-input-bp-script-filename> [options]
+local-input-bp-script-filename (string)
--target-db2 | --td (string)
--script-section | --ss (string)
Identifies the location in the script where you want to begin execution.
+The following options are valid:
+
+name \- Begin execution of the specific section and process all subsequent statements up to the next section\.
+A section is a '\.SYSTEM <name>' statement, where <name> identifies a logical grouping of statements such as UNLOADS or SQLDDL\. 'source' is an alias for UNLOADS\. 'target' is an alias for SQLDDL\.
+
+number \- Begin execution after the specific sync point (\.SYNC <number> statement) and process all statements up to the end of the script\.
+
+name, number \- Begin execution of the specific script section beginning from the sync point (\.SYNC <number> statement) within the section and process all subsequent statements up to the next section\.
+--restart | -r (string)
Specifies the location in the script where you want to restart execution. The effects of previous successful script statement executions remain.
+ The following restart options are valid:
+
+ new \- Restart execution of the script at the first statement\.
+
+ token \- Restart execution of the script at the location that is recorded in the specified token and that was returned from a previous execution failure\.
+
+ name, token \- Restart execution of the script at the location in the restart section that is recorded in the specified token and that was returned from a prior execution failure\.
+
+ A section is a Batch Processor '\.SYSTEM <name>' statement, where <name> identifies a logical grouping of statements such as UNLOADS or SQLDDL\. 'source' is an alias for UNLOADS\. 'target' is an alias for SQLDDL\.
+--modification | -m (string)
Identifies 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 set of values that are normally used.
+For more information about using the modification option, see the DBM Data Service documentation at https://techdocs.broadcom.com/db2mgmt.
+--error-file | --ef (string)
Specifies the local output error file that contains errors that occurred during execution of the command.
+Default value: error.log
+--dbm-db2-profile | --dbm-db2-p (string)
--base-profile | --base-p (string)
--host | -H (string)
--port | -P (number)
--user | -u (string)
--password | --pass | --pw (string)
--reject-unauthorized | --ru (boolean)
Reject self-signed certificates.
+Default value: true
+--token-type | --tt (string)
--token-value | --tv (string)
--cert-file (local file path)
--cert-key-file (local file path)
Execute a recovery script:
+zowe dbm-db2 execute script recovery.txt Execute a script on the 'TEST' Db2 subsystem:
+zowe dbm-db2 execute script script001.txt --target-db2 TEST Execute only the SQLDDL section of a script. The first .CONNECT statement in the script identifies the target subsystem where the script is executed. Execution begins at the .SYSTEM SQLDDL statement and ends at the next .SYSTEM statement in the script:
+zowe dbm-db2 execute script script001.txt ––script-section SQLDDL Execute a script beginning from the sync point 10 (.SYNC 10 statement) to the end of the script:
+zowe dbm-db2 execute script script001.txt ––script-section 10 Execute only the target (SQLDDL) section of the script starting at sync point 20:
+zowe dbm-db2 execute script script001.txt ––script-section target,20 Restart execution of a script from the beginning:
+zowe dbm-db2 execute script script001.txt ––restart new Restart execution of a script at the location specified in the token. The restart token is returned by a previous 'zowe dbm-db2 execute command' failure as part of the terminal output and in the error file:
+zowe dbm-db2 execute script script001.txt ––restart 78A724A48DA5185D06FD140F6780D6FA Restart execution at the last successful sync point recorded in the restart token up to the end of the target (SQLDDL) section:
+zowe dbm-db2 execute script script001.txt ––restart target,78A724A48DA5185D06FD140F6780D6FA Generate DDL statements for Db2 objects.
+Generate CREATE or DROP DDL statements for specified Db2 objects into an output DDL file. For example, use this command to generate CREATE TABLE definitions that you can then edit and use to update the table definition on a Db2 subsystem with the 'zowe dbm-db2 compare ddl' command.
+zowe dbm-db2 generate ddl [options]
+--object | -o (string)
Specifies the Db2 objects for which you want to generate DDL statements. Use the optional include syntax to include related Db2 objects.
+Format: see object-file description.
+Note: The \-\-object and \-\-object\-file options are mutually exclusive\.
+--object-file | --of (string)
Specifies the local input file that contains a list of Db2 objects, separated by a semicolon, for which you want to generate DDL statements. Use the optional include syntax to include related Db2 objects.
+Format:
+<object\-type> <object\-name> \[include(<related\-object\-type>,\.\.\.)\];
+
+The required clause <object\-type> <object\-name> identifies the specific Db2 (base) object:
+
+ STOGROUP <name>
+ DATABASE <name>
+ TABLESPACE <dbname>\.<name>
+ TABLE <schema>\.<name>
+ INDEX <schema>\.<name>
+ VIEW <schema>\.<name>
+ ALIAS <schema>\.<name>
+ SYNONYM <schema>\.<name>
+ MQT <schema>\.<name>
+ SEQUENCE <schema>\.<name>
+ TRIGGER <schema>\.<name>
+ FUNCTION <schema>\.<name>\[\.<version>\]
+ PROCEDURE <schema>\.<name>\[\.<version>\]
+
+The optional clause include(<related\-object\-type>,\.\.\.) identifies one or more, comma separated related object types that you want to include in the generated DDL statements\. You can specify STOGROUP, DATABASE, TABLESPACE, TABLE, INDEX, VIEW, SYNONYM, MQT\-ALL, TRIGGER, ROUTINE, PARENTS, CHILDREN, and ALL\.
+
+ Example:
+
+ table sysibm\.systables include (tablespace, database, index);
+ database db1 include(children);
+
+ Note: The \-\-object and \-\-object\-file options are mutually exclusive\.
+--change-set | --cs (string)
Specifies the creator and name of an existing RC/Migrator global change set to be used to modify Db2 object attributes when generating the DDL.
+Format:
+<change\-set\-creator\.change\-set\-name>
+
+For more information about global change services, see the RC/Migrator documentation at https://techdocs\.broadcom\.com/db2rcmig\.
+
+Note: If change\-set and change\-set\-file are both specified, specifications in change\-set\-file take precedence\.
+--change-set-file | --csf (string)
Specifies the name of the local input file that contains the global change specifications to modify Db2 object attributes when generating DDL.
+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 the <from\-value> and <to\-value>\. The first occurrence in multiple specifications for the same <object\-attribute> has the highest precedence\.
+
+For a list of global change set attributes, see the RC/Migrator documentation at https://techdocs\.broadcom\.com/db2rcmig\.
+
+Example:
+
+The following example demonstrates changes to table’s 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\.
+--type | -t (string)
Specifies the type of DDL statements that you want to generate. You can generate CREATE or DROP statements.
+Default value: create
+Allowed values: drop, create
--output-ddl-file | --odf (string)
Specifies the local output file name that contains the generated DDL for the objects that are identified by the --object-file or --object option.
+ Default value: output\.sql
+--modification | -m (string)
Identifies 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 set of values that are normally used.
+For more information about using the modification option, see the DBM Data Service documentation at https://techdocs.broadcom.com/db2mgmt.
+--error-file | --ef (string)
Specifies the local output error file that contains errors that occurred during execution of the command.
+ Default value: error\.log
+--source-db2 | --sd (string)
--dbm-db2-profile | --dbm-db2-p (string)
--base-profile | --base-p (string)
--host | -H (string)
--port | -P (number)
--user | -u (string)
--password | --pass | --pw (string)
--reject-unauthorized | --ru (boolean)
Reject self-signed certificates.
+Default value: true
+--token-type | --tt (string)
--token-value | --tv (string)
--cert-file (local file path)
--cert-key-file (local file path)
Generate CREATE DDL statements for a tablespace and its child table:
+zowe dbm-db2 generate ddl --object "tablespace my.tbsp include(table)" --source-db2 SRC --output-ddl-file objects.sql Generate CREATE DDL statements for a database and its children and apply changes as defined in the change set:
+zowe dbm-db2 generate ddl --object "database my.db include(children)" --source-db2 SRC --change-set USER1.CHANGSET --output-ddl-file objects.sql Generate DROP DDL statements only for the input object list:
+zowe dbm-db2 generate ddl --object-file objects.txt --source-db2 SRC --type drop --output-ddl-file output.sql Prepare DDL statements and a script to migrate Db2 objects.
+Generate a script to migrate Db2 object definitions (DDL) and data from a source subsystem to a target subsystem. You can specify which objects to include and apply changes to the objects as part of the migration. To execute the script, use the 'zowe dbm-db2 execute migration-script' command.
+zowe dbm-db2 prepare migration [options]
+--object | -o (string)
Specifies the Db2 objects that you want to migrate. Use the optional include syntax to include related Db2 objects.
+Format: see object-file description.
+Note: The \-\-object and \-\-object\-file options are mutually exclusive\.
+--object-file | --of (string)
Specifies the local input file that contains a list of Db2 objects, separated by a semicolon, that you want to migrate. Use the optional include syntax to include related Db2 objects.
+Format:
+<object\-type> <object\-name> \[include(<related\-object\-type>,\.\.\.)\];
+
+The required clause <object\-type> <object\-name> identifies the specific Db2 (base) object:
+
+ STOGROUP <name>
+ DATABASE <name>
+ TABLESPACE <dbname>\.<name>
+ TABLE <schema>\.<name>
+ INDEX <schema>\.<name>
+ VIEW <schema>\.<name>
+ ALIAS <schema>\.<name>
+ SYNONYM <schema>\.<name>
+ MQT <schema>\.<name>
+ SEQUENCE <schema>\.<name>
+ TRIGGER <schema>\.<name>
+ FUNCTION <schema>\.<name>\[\.<version>\]
+ PROCEDURE <schema>\.<name>\[\.<version>\]
+
+The optional clause include(<related\-object\-type>,\.\.\.) identifies one or more, comma separated related object types that you want to include in the object list\. You can specify STOGROUP, DATABASE, TABLESPACE, TABLE, INDEX, VIEW, SYNONYM, MQT\-ALL, TRIGGER, ROUTINE, PARENTS, CHILDREN, and ALL\.
+
+ Example:
+
+ table sysibm\.systables include (tablespace, database, index);
+ database db1 include(children);
+
+ Note: The \-\-object and \-\-object\-file options are mutually exclusive\.
+--change-set | --cs (string)
Specifies the creator and name of an existing RC/Migrator global change set to be used to modify Db2 object attributes when preparing objects for migration.
+Format:
+<change\-set\-creator\.change\-set\-name>
+
+For more information about global change services, see the RC/Migrator documentation at https://techdocs\.broadcom\.com/db2rcmig\.
+
+Note: If change\-set and change\-set\-file are both specified, specifications in change\-set\-file take precedence\.
+--change-set-file | --csf (string)
Specifies the name of the local input file that contains the global change specifications to modify Db2 object attributes when preparing for migration.
+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 the <from\-value> and <to\-value>\. The first occurrence in multiple specifications for the same <object\-attribute> has the highest precedence\.
+
+For a list of global change set attributes, see the RC/Migrator documentation at https://techdocs\.broadcom\.com/db2rcmig\.
+
+Example:
+
+The following example demonstrates changes to table’s 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\.
+--output-migrate-script | --oms (string)
Specifies the local output file name that contains the script to make changes to the target Db2 subsystem.
+Default value: migration.txt
+--output-ddl-file | --odf (string)
Specifies the local output file name that contains the generated DDL for the input objects that are identified by the --object-file or --object option.
+Default value: output.sql
+--modification | -m (string)
Identifies 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 set of values that are normally used.
+For more information about using the modification option, see the DBM Data Service documentation at https://techdocs.broadcom.com/db2mgmt.
+--error-file | --ef (string)
Specifies the local output error file that contains errors that occurred during execution of the command.
+ Default value: error\.log
+--source-db2 | --sd (string)
--target-db2 | --td (string)
--dbm-db2-profile | --dbm-db2-p (string)
--base-profile | --base-p (string)
--host | -H (string)
--port | -P (number)
--user | -u (string)
--password | --pass | --pw (string)
--reject-unauthorized | --ru (boolean)
Reject self-signed certificates.
+Default value: true
+--token-type | --tt (string)
--token-value | --tv (string)
--cert-file (local file path)
--cert-key-file (local file path)
Generate a migration script for a tablespace and its child table:
+zowe dbm-db2 prepare migration --object "tablespace my.tbsp include(table)" --source-db2 SRC --target-db2 TRG --output-migrate-script migrate.txt Generate a migration script and apply global changes:
+zowe dbm-db2 prepare migration --object "database my.db include(children)" --source-db2 SRC --target-db2 TRG –-change-set USER1.CHANGSET –-output-migrate-script migrate.txt --output-ddl-file objects.sql Endevor plug-in for listing Endevor environment information, working with elements and packages located in specified Endevor instance.
+Add an Element into Endevor.
+The add element command lets you add an Element to an Environment entry Stage in Endevor.
+zowe endevor add element <element> [options]
+element (string)
--environment | --env (string)
--system | --sys (string)
--subsystem | --sub (string)
--type | --typ (string)
--ccid | --cci (string)
--comment | --com (string)
--maxrc (number)
--instance | -i (string)
--from-file | --ff (string)
--from-dataset | --fd (string)
--from-member | --fm (string)
--from-path | --fp (string)
--from-uss-file | --fuf (string)
--override-signout | --os (boolean)
--new-version | --nv (number)
--proc-group | --pg (string)
--generate | -g (boolean)
--get-fingerprint | --gfg (boolean)
Return fingerprint of a retrieved, added or updated element as the first line of the response.
+Default value: false
+--fingerprint | --fg (string)
--suppress-messages | --sm (boolean)
--file-name | --fn (string)
--host | --hostname (string)
--port | -p (string)
--protocol | --prot (string)
Specifies the protocol used for connecting to Endevor Rest API
+Default value: https
+Allowed values: http, https
--user | --username (string)
--password | --pass (string)
--reject-unauthorized | --ru (boolean)
--base-path | --bp (string)
--endevor-profile | --endevor-p (string)
--endevor-location-profile | --endevor-location-p (string)
--base-profile | --base-p (string)
--token-type | --tt (string)
--maxrc (number)
--instance | -i (string)
--to-file | --tf (string)
--suppress-messages | --sm (boolean)
--file-name | --fn (string)
--host | --hostname (string)
--port | -p (string)
--protocol | --prot (string)
Specifies the protocol used for connecting to Endevor Rest API
-Default value: https
-Allowed values: http, https
--user | --username (string)
--password | --pass (string)
--reject-unauthorized | --ru (boolean)
--base-path | --bp (string)
--endevor-profile | --endevor-p (string)
--endevor-location-profile | --endevor-location-p (string)
--base-profile | --base-p (string)
--token-type | --tt (string)
--token-value | --tv (string)
--cert-file (local file path)
--cert-key-file (local file path)
View SCL of package "packageName" in the console with endevor profile set up:
-zowe endevor view pkgscl packageName -i ENDEVOR Use the CA Endevor Bridge for Git plug-in to manage your Git-Endevor mappings and build your local Git changes before synchronizing them to Endevor.
-Build changes from git local repository in Endevor
-Build changes against remote git repository's CA Endevor Bridge for Git synchronized branch, using work area or build subsystem.It does not support autogen for building dependencies.
-zowe endevor-bridge-for-git build execute [options]
---endevor-instance | --endevori (string)
--work-area-id | --waid (string)
--endevor-subsystem | --endevorsub (string)
--endevor-environment | --endevorenv (string)
--endevor-system | --endevorsys (string)
--work-dir | --wd (string)
The local working directory of your Git-Endevor mapping that you are building.
-Default value: ./
---listing-dir (string)
Specify the directory where you would like to have your build outputs downloaded
-Default value: .endevor/listings
---listing-rc (number)
All the elements that have a generate result equal to or greater than "listing-rc" will have their build outputs downloaded into "listing-dir"
-Default value: 4
---force-cleanup | --fc (boolean)
Starts the build process after cleaning the build subsystem.
-Default value: false
---endevor-protocol | --endevorprot (string)
The CA Endevor SCM Rest API protocol.
-Default value: http
-Allowed values: http, https
---endevor-host | --endevorh (string)
--endevor-port | --endevorp (number)
--endevor-user | --endevoru (string)
--endevor-password | --endevorpass | --endevorpw (string)
--endevor-reject-unauthorized | --endevorru (boolean)
Reject self-signed certificates.
-Default value: true
---endevor-base-path | --endevorbp (string)
The CA Endevor SCM Rest API base path.
-Default value: EndevorService/rest
---endevor-profile | --endevor-p (string)
--base-profile | --base-p (string)
--host | -H (string)
--port | -P (number)
--user | -u (string)
--password | --pass | --pw (string)
--reject-unauthorized | --ru (boolean)
Reject self-signed certificates.
-Default value: true
---token-type | --tt (string)
--token-value | --tv (string)
--cert-file (local file path)
--cert-key-file (local file path)
--response-format-filter | --rff (array)
--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)
Compile the changed elements in the current Git working directory using the work area "WORKAREA1" and an existing Endevor profile:
-zowe endevor-bridge-for-git build execute --endevor-instance INSTANCE --work-area-id WORKAREA1 Compile the changed elements in the current Git working directory using the build subsystem "SUBNAME" and an existing Endevor profile:
-zowe endevor-bridge-for-git build execute --endevor-instance INSTANCE --endevor-subsystem SUBNAME --endevor-environment ENVNAME --endevor-system SYSNAME Get the report after executing 'build job-submit' command. This this command must be issued to finalize processing.
-zowe endevor-bridge-for-git build job-report [options]
---endevor-instance | --endevori (string)
--work-dir | --wd (string)
The local working directory of your Git-Endevor mapping that you are building.
-Default value: ./
---listing-dir (string)
Specify the directory where you would like to have your build outputs downloaded
-Default value: .endevor/listings
---listing-rc (number)
All the elements that have a generate result equal to or greater than "listing-rc" will have their build outputs downloaded into "listing-dir"
-Default value: 4
---endevor-protocol | --endevorprot (string)
The CA Endevor SCM Rest API protocol.
-Default value: http
-Allowed values: http, https
---endevor-host | --endevorh (string)
--endevor-port | --endevorp (number)
--endevor-user | --endevoru (string)
--endevor-password | --endevorpass | --endevorpw (string)
--endevor-reject-unauthorized | --endevorru (boolean)
--instance | -i (string)
Reject self-signed certificates.
-Default value: true
---endevor-base-path | --endevorbp (string)
The CA Endevor SCM Rest API base path.
-Default value: EndevorService/rest
---to-file | --tf (string)
--zosmf-host | --zosmfh (string)
--suppress-messages | --sm (boolean)
--zosmf-port | --zosmfp (number)
--file-name | --fn (string)
The z/OSMF server port.
-Default value: 443
---zosmf-user | --zosmfu (string)
--host | --hostname (string)
--zosmf-password | --zosmfpass | --zosmfpw (string)
--port | -p (string)
--zosmf-reject-unauthorized | --zosmfru (boolean)
--protocol | --prot (string)
Reject self-signed certificates.
-Default value: true
+Specifies the protocol used for connecting to Endevor Rest API
+Default value: https
+Allowed values: http, https
--zosmf-base-path | --zosmfbp (string)
--user | --username (string)
--endevor-profile | --endevor-p (string)
--password | --pass (string)
--zosmf-profile | --zosmf-p (string)
--reject-unauthorized | --ru (boolean)
--base-profile | --base-p (string)
--base-path | --bp (string)
--host | -H (string)
--endevor-profile | --endevor-p (string)
--port | -P (number)
--endevor-location-profile | --endevor-location-p (string)
--user | -u (string)
--base-profile | --base-p (string)
--password | --pass | --pw (string)
--reject-unauthorized | --ru (boolean)
Reject self-signed certificates.
-Default value: true
---token-type | --tt (string)
--response-format-filter | --rff (array)
--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)
Get the reports from the build job submitted by 'build job-submit' command from git working directory "/endevor/ebg/repository" using existing Endevor and z/OSMF profiles:
+View SCL of package "packageName" in the console with endevor profile set up:
zowe endevor-bridge-for-git build job-report --wd "C:\endevor\ebg\dir" zowe endevor view pkgscl packageName -i ENDEVOR Build changes from git local repository in Endevor by submitting a job. It supports autogen for building dependencies using with the option of selecting autogen span. After submitting, the command 'build job-report' must be issued to finalize processing.
+Use the CA Endevor Bridge for Git plug-in to manage your Git-Endevor mappings and build your local Git changes before synchronizing them to Endevor.
+Build changes from git local repository in Endevor
+Build changes against remote git repository's CA Endevor Bridge for Git synchronized branch, using work area or build subsystem.It does not support autogen for building dependencies.
zowe endevor-bridge-for-git build job-submit [options]
+zowe endevor-bridge-for-git build execute [options]
--skeleton-jcl | --sjcl (string)
--force-cleanup | --fc (boolean)
--listing-dir (string)
Starts the build process after cleaning the build subsystem.
-Default value: false
+Specify the directory where you would like to have your build outputs downloaded
+Default value: .endevor/listings
--autogen-span | --ags (string)
--listing-rc (number)
Specifies the autogen action option to automatically generate using elements.
-The allowed values which have the following meaning:
-NONE - Generates all elements that use the component being acted upon.
-ALL - Generates using elements that are found in any System and Subsystem combinations within the Environment and Stage of the component's logical map.
-SYSTEMS - Generates using elements that are found in any System, provided the element's Subsystem name matches the name of the Subsystem of the target component.
-SUBSYSTEMS - Generates using elements from all Subsystems with the same-named System of the component specified.
Default value: NONE
-Allowed values: NONE, ALL, SYSTEMS, SUBSYSTEMS
All the elements that have a generate result equal to or greater than "listing-rc" will have their build outputs downloaded into "listing-dir"
+Default value: 4
+--force-cleanup | --fc (boolean)
Starts the build process after cleaning the build subsystem.
+Default value: false
--zosmf-host | --zosmfh (string)
--zosmf-port | --zosmfp (number)
The z/OSMF server port.
-Default value: 443
---zosmf-user | --zosmfu (string)
--zosmf-password | --zosmfpass | --zosmfpw (string)
--zosmf-reject-unauthorized | --zosmfru (boolean)
Reject self-signed certificates.
-Default value: true
---zosmf-base-path | --zosmfbp (string)
--zosmf-profile | --zosmf-p (string)
--base-profile | --base-p (string)
Compile the changed elements at "/endevor/ebg/repository" using work area with ID "WORKAREA1", jcl skeleton at "/endevor/jcl/jcl.txt" and existing Endevor and z/OSMF profiles:
+Compile the changed elements in the current Git working directory using the work area "WORKAREA1" and an existing Endevor profile:
zowe endevor-bridge-for-git build job-submit --skeleton-jcl /endevor/jcl/jcl.txt --work-area-id WORKAREA1 --work-dir /endevor/ebg/repository zowe endevor-bridge-for-git build execute --endevor-instance INSTANCE --work-area-id WORKAREA1 Compile the changed elements at "/endevor/ebg/repository" using build subsystem "SUBNAME", jcl skeleton at "/endevor/jcl/jcl.txt" and existing Endevor and z/OSMF profiles:
+Compile the changed elements in the current Git working directory using the build subsystem "SUBNAME" and an existing Endevor profile:
zowe endevor-bridge-for-git build job-submit --skeleton-jcl /endevor/jcl/jcl.txt --endevor-subsystem SUBNAME --endevor-environment ENVNAME --endevor-system SYSNAME --work-dir /endevor/ebg/repository zowe endevor-bridge-for-git build execute --endevor-instance INSTANCE --endevor-subsystem SUBNAME --endevor-environment ENVNAME --endevor-system SYSNAME Manage connections to Endevor Web Services used by CA Endevor Bridge for Git.
-Create new Endevor connection for CA Endevor Bridge for Git.
+Get the report after executing 'build job-submit' command. This this command must be issued to finalize processing.
zowe endevor-bridge-for-git endevor-connection create <connection> [options]
-zowe endevor-bridge-for-git build job-report [options]
+connection (string)
--endevor-instance | --endevori (string)
--endevor-instance | --endevori (string)
--work-dir | --wd (string)
The local working directory of your Git-Endevor mapping that you are building.
+Default value: ./
+--listing-dir (string)
Specify the directory where you would like to have your build outputs downloaded
+Default value: .endevor/listings
+--listing-rc (number)
All the elements that have a generate result equal to or greater than "listing-rc" will have their build outputs downloaded into "listing-dir"
+Default value: 4
+--protocol | --prot (string)
The Endevor Bridge for Git SCM protocol.
-Default value: http
-Allowed values: http, https
---host | -H (string)
--port | -P (number)
--user | -u (string)
--token | -t (string)
--reject-unauthorized | --ru (boolean)
Reject self-signed certificates.
-Default value: false
---ebg-profile | --ebg-p (string)
--endevor-profile | --endevor-p (string)
--base-profile | --base-p (string)
--password | --pass | --pw (string)
--token-type | --tt (string)
--token-value | --tv (string)
--cert-file (local file path)
--zosmf-host | --zosmfh (string)
--cert-key-file (local file path)
--zosmf-port | --zosmfp (number)
Create the Endevor connection 'MY-CONNECTION' using the default EBG and Endevor profile:
-zowe endevor-bridge-for-git endevor-connection create MY-CONNECTION --endevor-instance INSTANCE The z/OSMF server port.
+Default value: 443
Create the Endevor connection 'MY-CONNECTION' using the default EBG profile:
-zowe endevor-bridge-for-git endevor-connection create MY-CONNECTION --endevor-protocol http --endevor-host endevor-host --endevor-port 12345 --endevor-instance INSTANCE Create the Endevor connection 'MY-CONNECTION' using the default Endevor profile:
+--zosmf-user | --zosmfu (string)
zowe endevor-bridge-for-git endevor-connection create MY-CONNECTION --protocol http --host bridge-host --port 8080 --endevor-instance INSTANCE Delete existing Endevor connection defined to CA Endevor Bridge for Git.
-zowe endevor-bridge-for-git endevor-connection delete <connection> [options]
-connection (string)
--zosmf-password | --zosmfpass | --zosmfpw (string)
--protocol | --prot (string)
--zosmf-reject-unauthorized | --zosmfru (boolean)
The Endevor Bridge for Git SCM protocol.
-Default value: http
-Allowed values: http, https
-Reject self-signed certificates.
+Default value: true
--host | -H (string)
--port | -P (number)
--zosmf-base-path | --zosmfbp (string)
--user | -u (string)
--token | -t (string)
--reject-unauthorized | --ru (boolean)
--endevor-profile | --endevor-p (string)
Reject self-signed certificates.
-Default value: false
---ebg-profile | --ebg-p (string)
--zosmf-profile | --zosmf-p (string)
--password | --pass | --pw (string)
--token-type | --tt (string)
--token-value | --tv (string)
--cert-file (local file path)
--cert-key-file (local file path)
Delete the Endevor connection using the default EBG profile:
-zowe endevor-bridge-for-git endevor-connection delete MY-CONNECTION Delete the Endevor connection without an EBG profile:
-zowe endevor-bridge-for-git endevor-connection delete MY-CONNECTION --protocol http --host my-host --port 8080 --user my-git-username --token 1234567890 List Endevor connections used by CA Endevor Bridge for Git.
-zowe endevor-bridge-for-git endevor-connection list [options]
---protocol | --prot (string)
The Endevor Bridge for Git SCM protocol.
-Default value: http
-Allowed values: http, https
---host | -H (string)
--port | -P (number)
--user | -u (string)
--token | -t (string)
--password | --pass | --pw (string)
Reject self-signed certificates.
-Default value: false
---ebg-profile | --ebg-p (string)
--base-profile | --base-p (string)
Default value: true
--password | --pass | --pw (string)
--token-type | --tt (string)
List all the Endevor connections using the default EBG profile:
-zowe endevor-bridge-for-git endevor-connection list List all the Endevor connections without an EBG profile:
+Get the reports from the build job submitted by 'build job-submit' command from git working directory "/endevor/ebg/repository" using existing Endevor and z/OSMF profiles:
zowe endevor-bridge-for-git endevor-connection list --protocol http --host my-host --port 8080 --user my-git-username --token 1234567890 zowe endevor-bridge-for-git build job-report --wd "C:\endevor\ebg\dir" Rename existing Endevor connection defined to CA Endevor Bridge for Git.
+Build changes from git local repository in Endevor by submitting a job. It supports autogen for building dependencies using with the option of selecting autogen span. After submitting, the command 'build job-report' must be issued to finalize processing.
zowe endevor-bridge-for-git endevor-connection rename <connection> <new-connection> [options]
-zowe endevor-bridge-for-git build job-submit [options]
+connection (string)
--endevor-instance | --endevori (string)
new-connection (string)
--skeleton-jcl | --sjcl (string)
--protocol | --prot (string)
--work-area-id | --waid (string)
The Endevor Bridge for Git SCM protocol.
-Default value: http
-Allowed values: http, https
---host | -H (string)
--endevor-subsystem | --endevorsub (string)
--port | -P (number)
--endevor-environment | --endevorenv (string)
--user | -u (string)
--endevor-system | --endevorsys (string)
--token | -t (string)
--work-dir | --wd (string)
The local working directory of your Git-Endevor mapping that you are building.
+Default value: ./
+--reject-unauthorized | --ru (boolean)
--force-cleanup | --fc (boolean)
Reject self-signed certificates.
+Starts the build process after cleaning the build subsystem.
Default value: false
--ebg-profile | --ebg-p (string)
--autogen-span | --ags (string)
--base-profile | --base-p (string)
Specifies the autogen action option to automatically generate using elements.
+The allowed values which have the following meaning:
+NONE - Generates all elements that use the component being acted upon.
+ALL - Generates using elements that are found in any System and Subsystem combinations within the Environment and Stage of the component's logical map.
+SYSTEMS - Generates using elements that are found in any System, provided the element's Subsystem name matches the name of the Subsystem of the target component.
+SUBSYSTEMS - Generates using elements from all Subsystems with the same-named System of the component specified.
Default value: NONE
+Allowed values: NONE, ALL, SYSTEMS, SUBSYSTEMS
--password | --pass | --pw (string)
--endevor-protocol | --endevorprot (string)
The CA Endevor SCM Rest API protocol.
+Default value: http
+Allowed values: http, https
+--token-type | --tt (string)
--endevor-host | --endevorh (string)
--token-value | --tv (string)
--endevor-port | --endevorp (number)
--cert-file (local file path)
--endevor-user | --endevoru (string)
--cert-key-file (local file path)
--endevor-password | --endevorpass | --endevorpw (string)
Rename the Endevor connection using the default EBG profile:
+--endevor-reject-unauthorized | --endevorru (boolean)
zowe endevor-bridge-for-git endevor-connection rename MY-CONNECTION NEW-NAME Reject self-signed certificates.
+Default value: true
+Rename the Endevor connection without an EBG profile:
+--endevor-base-path | --endevorbp (string)
zowe endevor-bridge-for-git endevor-connection rename MY-CONNECTION NEW-NAME --protocol http --host my-host --port 8080 --user my-git-username --token 1234567890 The CA Endevor SCM Rest API base path.
+Default value: EndevorService/rest
+Update your Endevor credentials for the Endevor connection.
-zowe endevor-bridge-for-git endevor-connection update-credentials <connection> [options]
-connection (string)
--zosmf-host | --zosmfh (string)
--endevor-user | --endevoru (string)
--zosmf-port | --zosmfp (number)
The z/OSMF server port.
+Default value: 443
+--endevor-password | --endevorpass | --endevorpw (string)
--zosmf-user | --zosmfu (string)
--protocol | --prot (string)
--zosmf-password | --zosmfpass | --zosmfpw (string)
The Endevor Bridge for Git SCM protocol.
-Default value: http
-Allowed values: http, https
---host | -H (string)
--zosmf-reject-unauthorized | --zosmfru (boolean)
Reject self-signed certificates.
+Default value: true
+--port | -P (number)
--zosmf-base-path | --zosmfbp (string)
--user | -u (string)
--endevor-profile | --endevor-p (string)
--token | -t (string)
--zosmf-profile | --zosmf-p (string)
--reject-unauthorized | --ru (boolean)
--base-profile | --base-p (string)
Reject self-signed certificates.
-Default value: false
---ebg-profile | --ebg-p (string)
--host | -H (string)
--endevor-profile | --endevor-p (string)
--port | -P (number)
--base-profile | --base-p (string)
--user | -u (string)
--password | --pass | --pw (string)
--reject-unauthorized | --ru (boolean)
Reject self-signed certificates.
+Default value: true
+--token-type | --tt (string)
--response-format-filter | --rff (array)
--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)
Update the Endevor credentials for the Endevor connection MY-CONNECTION using the default EBG and Endevor profile:
+Compile the changed elements at "/endevor/ebg/repository" using work area with ID "WORKAREA1", jcl skeleton at "/endevor/jcl/jcl.txt" and existing Endevor and z/OSMF profiles:
zowe endevor-bridge-for-git endevor-connection update-credentials MY-CONNECTION zowe endevor-bridge-for-git build job-submit --skeleton-jcl /endevor/jcl/jcl.txt --work-area-id WORKAREA1 --work-dir /endevor/ebg/repository Update the Endevor credentials for the Endevor connection MY-CONNECTION using the default EBG profile but not using an Endevor profile:
+Compile the changed elements at "/endevor/ebg/repository" using build subsystem "SUBNAME", jcl skeleton at "/endevor/jcl/jcl.txt" and existing Endevor and z/OSMF profiles:
zowe endevor-bridge-for-git endevor-connection update-credentials MY-CONNECTION --endevor-user my-user --endevor-password my-password zowe endevor-bridge-for-git build job-submit --skeleton-jcl /endevor/jcl/jcl.txt --endevor-subsystem SUBNAME --endevor-environment ENVNAME --endevor-system SYSNAME --work-dir /endevor/ebg/repository Manage your Endevor credentials stored in CA Endevor Bridge for Git. [Deprecated]
+Manage your Endevor credentials stored in CA Endevor Bridge for Git.
Update your Endevor credentials for a Git-Endevor mapping.
--element-name | --name (string)
--elementName | --name (string)
--element-type | --type (string)
--elementType | --type (string)
--connection (string)
--endevor-instance | --endevori (string)
--system-alias (string)
--subsystem-alias (string)
--endevor-environment | --endevorenv (string)
--type-filter (string)
--json-file | --json (local file path)
Create the Git-Endevor mapping 'MY-CONTEXT / MY-MAPPING' using the default EBG and Endevor profile:
-zowe endevor-bridge-for-git mapping create --remote-url https://git-server-enterprise.com/my-context/my-mapping.git --connection endevor-connection-name --endevor-environment ENVNAME --endevor-system SYSNAME --endevor-subsystem SUBNAME Create the read-only Git-Endevor mapping 'MY-CONTEXT / MY-MAPPING' using the default EBG and Endevor profile:
zowe endevor-bridge-for-git mapping create --remote-url https://git-server-enterprise.com/my-context/my-mapping.git --endevor-instance INSTANCE --endevor-environment ENVNAME --endevor-system SYSNAME --endevor-subsystem SUBNAME --read-only --endevor-stage-number 2 List all the Git-Endevor mappings using the default EBG profile:
-zowe endevor-bridge-for-git mapping list List all the Git-Endevor mappings and show their Endevor details using the default EBG profile:
-zowe endevor-bridge-for-git mapping list --view endevor List all the Git-Endevor mappings and show all their details using the default EBG profile:
-zowe endevor-bridge-for-git mapping list --view all List all the Git-Endevor mappings without an EBG profile:
-zowe endevor-bridge-for-git mapping list --protocol http --host my-host --port 8080 --user my-git-username --token 1234567890 Manage the processor groups of your mapping
-List processor groups used by a type in your mapping
-zowe endevor-bridge-for-git processor-group list [options]
---work-dir | --wd (string)
The local working directory of your Git-Endevor mapping.
-Default value: ./
---endevor-system | --endevorsys (string)
--endevor-subsystem | --endevorsub (string)
--type | --type (string)
--response-format-filter | --rff (array)
--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)
List all the processor groups used by a type in your mapping for a single system/subsystem mapping.:
-zowe endevor-bridge-for-git processor-group list --type TYPE List all the processor groups used by a type in your mapping for a multi system/subsystem mapping.:
-zowe endevor-bridge-for-git processor-group list --endevorsys SYSTEM --endevorsub SUBSYSTEM --type TYPE Update the processor group of a specific element in your local repository
-zowe endevor-bridge-for-git processor-group update <element> <processor-group> [options]
-element (string)
processor-group (string)
--work-dir | --wd (string)
The local working directory of your Git-Endevor mapping.
-Default value: ./
---endevor-system | --endevorsys (string)
--endevor-subsystem | --endevorsub (string)
--type | --type (string)
--response-format-filter | --rff (array)
--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)
Update the processor group of all changed elements of a specific type
-zowe endevor-bridge-for-git processor-group update-all <processor-group> [options]
-processor-group (string)
--work-dir | --wd (string)
The local working directory of your Git-Endevor mapping.
-Default value: ./
---endevor-system | --endevorsys (string)
--endevor-subsystem | --endevorsub (string)
--type | --type (string)
List all the Git-Endevor mappings using the default EBG profile:
zowe endevor-bridge-for-git mapping list --response-format-filter | --rff (array)
List all the Git-Endevor mappings and show their Endevor details using the default EBG profile:
zowe endevor-bridge-for-git mapping list --view endevor --response-format-type | --rft (string)
List all the Git-Endevor mappings and show all their details using the default EBG profile:
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
-zowe endevor-bridge-for-git mapping list --view all --response-format-header | --rfh (boolean)
List all the Git-Endevor mappings without an EBG profile:
zowe endevor-bridge-for-git mapping list --protocol http --host my-host --port 8080 --user my-git-username --token 1234567890 CA File Master Plus command line interface is a file management and data manipulation tool.
+
File Master Plus command line interface is a file management and data manipulation tool.
It speeds up file creation and manipulates virtual storage access method (VSAM), sequential and partitioned data sets.
It also supports symbolic access to data via layouts and data manipulation like selection of records in data sets.
Copy data from a data set and optionally filter or modify the copied data by using selection criteria.
Copy from a data set to another data set.
-If the <to> data set does not exist, CA File Master Plus automatically creates a new data set using the attributes of <from> data set.
-It supports all data set types that are supported by CA File Master Plus.
zowe file-master-plus copy data-set <from> <to> [options]
--static-selection-criteria | --ssc (string)
--dynamic-selection-criteria | --dsc (string)
--host | -H (string)
--port | -P (number)
--protocol | -o (string)
Specifies CA File Master Plus REST API protocol.
+Specifies File Master Plus REST API protocol.
Default value: https
Allowed values: http, https
--host | -H (string)
--port | -P (number)
--protocol | -o (string)
Specifies CA File Master Plus REST API protocol.
+Specifies File Master Plus REST API protocol.
Default value: https
Allowed values: http, https
--host | -H (string)
--port | -P (number)
--protocol | -o (string)
Specifies CA File Master Plus REST API protocol.
+Specifies File Master Plus REST API protocol.
Default value: https
Allowed values: http, https
--host | -H (string)
--port | -P (number)
--protocol | -o (string)
Specifies CA File Master Plus REST API protocol.
+Specifies File Master Plus REST API protocol.
Default value: https
Allowed values: http, https
--host | -H (string)
--port | -P (number)
--protocol | -o (string)
Specifies CA File Master Plus REST API protocol.
+Specifies File Master Plus REST API protocol.
Default value: https
Allowed values: http, https
--host | -H (string)
--port | -P (number)
--protocol | -o (string)
Specifies CA File Master Plus REST API protocol.
+Specifies File Master Plus REST API protocol.
Default value: https
Allowed values: http, https
--host | -H (string)
--port | -P (number)
--protocol | -o (string)
Specifies CA File Master Plus REST API protocol.
+Specifies File Master Plus REST API protocol.
Default value: https
Allowed values: http, https
--host | -H (string)
--port | -P (number)
--protocol | -o (string)
Specifies CA File Master Plus REST API protocol.
+Specifies File Master Plus REST API protocol.
Default value: https
Allowed values: http, https
--host | -H (string)
--port | -P (number)
--protocol | -o (string)
Specifies CA File Master Plus REST API protocol.
+Specifies File Master Plus REST API protocol.
Default value: https
Allowed values: http, https
--host | -H (string)
--port | -P (number)
--protocol | -o (string)
Specifies CA File Master Plus REST API protocol.
+Specifies File Master Plus REST API protocol.
Default value: https
Allowed values: http, https
--host | -H (string)
--port | -P (number)
--protocol | -o (string)
Specifies CA File Master Plus REST API protocol.
+Specifies File Master Plus REST API protocol.
Default value: https
Allowed values: http, https
Permanently deletes a data set.
Permanently deletes a data set.
-It supports all data set types that are supported by CA File Master Plus.
zowe file-master-plus delete data-set <name> [options]
--host | -H (string)
--port | -P (number)
--protocol | -o (string)
Specifies CA File Master Plus REST API protocol.
+Specifies File Master Plus REST API protocol.
Default value: https
Allowed values: http, https
Populate the specified data set with records.
-It supports all data set types that are supported by CA File Master Plus.
Populate a specific data set with records.
The layout of the records to add are described by a Cobol or PL/I copybook.
--host | -H (string)
--port | -P (number)
--protocol | -o (string)
Specifies CA File Master Plus REST API protocol.
+Specifies File Master Plus REST API protocol.
Default value: https
Allowed values: http, https
Rename the specified data set.
Rename a data set.
-It supports all data set types that are supported by CA File Master Plus.
zowe file-master-plus rename data-set <old> <new> [options]
--host | -H (string)
--port | -P (number)
--protocol | -o (string)
Specifies CA File Master Plus REST API protocol.
+Specifies File Master Plus REST API protocol.
Default value: https
Allowed values: http, https
Renaming a data set:
+Renaming a data set:
+zowe file-master-plus rename data-set fmmvs.old.dsname fmmvs.new.dsname Renaming a VSAM data set along with its components:
+zowe file-master-plus rename data-set fmmvs.oldvsam.dsname fmmvs.newvsam.dsname --vsamc y IDMS plug-in for listing real-time monitor statistics and information, viewing DC log messages, and issuing DCMT and DCUF commands
+Issues IDMS DCMT and DCUF commands
+Execute a DCMT DISPLAY command
+zowe idms issue dcmt-display [options]
+--host | -H (string)
--port | -P (number)
--user | -u (string)
--password | --pass | --pw (string)
--reject-unauthorized | --ru (boolean)
Reject self-signed certificates
+Default value: true
+--base-path | --bp (string)
--datasource | -d (string)
--args (string)
--broadcast | -b (string)
--idms-profile | --idms-p (string)
--base-profile | --base-p (string)
--token-type | --tt (string)
--token-value | --tv (string)
--cert-file (local file path)
--cert-key-file (local file path)
--response-format-filter | --rff (array)
--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)
Issues a 'dcmt display task send' command to display information associated with the SEND task:
zowe file-master-plus rename data-set fmmvs.old.dsname fmmvs.new.dsname zowe idms issue dcmt-display --args "task send" Renaming a VSAM data set along with its components:
+Issues a 'dcmt display active programs' command with an IDMS profile and data source to override the default:
zowe file-master-plus rename data-set fmmvs.oldvsam.dsname fmmvs.newvsam.dsname --vsamc y zowe idms issue dcmt-display --args "active programs" --idms-profile myprofile2 --datasource sysdemo CA IDMS plug-in for listing real-time monitor statistics and information, viewing DC log messages, and issuing DCMT and DCUF commands
-Issues IDMS DCMT and DCUF commands
-Execute a DCMT DISPLAY command
+Execute a DCMT HELP command
zowe idms issue dcmt-display [options]
+zowe idms issue dcmt-help [options]
--datasource | -d (string)
--args (string)
--broadcast | -b (string)
Issues a 'dcmt display task send' command to display information associated with the SEND task:
+Issues a 'dcmt help' command to display a summary of the syntax for DCMT commands:
zowe idms issue dcmt-display --args "task send" zowe idms issue dcmt-help Issues a 'dcmt display active programs' command with an IDMS profile and data source to override the default:
+Issues a 'dcmt help task' command with a data source to override the default:
zowe idms issue dcmt-display --args "active programs" --idms-profile myprofile2 --datasource sysdemo zowe idms issue dcmt-help --args "task" --datasource sysdemo Execute a DCMT HELP command
+Execute a DCMT QUIESCE command
zowe idms issue dcmt-help [options]
+zowe idms issue dcmt-quiesce [options]
--datasource | -d (string)
--args (string)
--broadcast | -b (string)
Issues a 'dcmt help' command to display a summary of the syntax for DCMT commands:
+Issues the command 'dcmt quiesce dbname empdemo id 1' which quiesces all areas associated with segments included in the EMPDEMO database and assigns the operation to dcmt-id 1:
zowe idms issue dcmt-help zowe idms issue dcmt-quiesce --args "dbname empdemo id 1" Issues a 'dcmt help task' command with a data source to override the default:
+Issues the command 'dcmt quiesce area emp* id 2' which quiesces all areas whose segment name begins with EMP and assigns the operation to dcmt-id 2:
zowe idms issue dcmt-help --args "task" --datasource sysdemo zowe idms issue dcmt-quiesce --args "area emp* id 2" Execute a DCMT QUIESCE command
+Execute a DCMT SHUTDOWN command
zowe idms issue dcmt-quiesce [options]
+zowe idms issue dcmt-shutdown [options]
--datasource | -d (string)
--args (string)
Issues the command 'dcmt quiesce dbname empdemo id 1' which quiesces all areas associated with segments included in the EMPDEMO database and assigns the operation to dcmt-id 1:
+Issues a 'dcmt shutdown noprompt' command to shut down the DC/UCF system while allowing all active tasks and external run units to terminate normally first:
zowe idms issue dcmt-quiesce --args "dbname empdemo id 1" zowe idms issue dcmt-shutdown --args "noprompt" Issues the command 'dcmt quiesce area emp* id 2' which quiesces all areas whose segment name begins with EMP and assigns the operation to dcmt-id 2:
+Issues a 'dcmt shutdown noprompt immediate' command to immediately shut down the DC/UCF system, abending all active tasks and external run units with code SHUT:
zowe idms issue dcmt-quiesce --args "area emp* id 2" zowe idms issue dcmt-shutdown --args "noprompt immediate" Execute a DCMT SHUTDOWN command
+Execute a DCMT STATISTICS command
zowe idms issue dcmt-shutdown [options]
+zowe idms issue dcmt-statistics [options]
--datasource | -d (string)
--args (string)
--broadcast | -b (string)
--idms-profile | --idms-p (string)
--base-profile | --base-p (string)
--token-type | --tt (string)
--token-value | --tv (string)
--cert-file (local file path)
--cert-key-file (local file path)
--response-format-filter | --rff (array)
--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)
Issues a 'dcmt write statistics roll' command to write the current system and line statistics and histograms to the log file and then reset their values to zero:
+zowe idms issue dcmt-statistics --args "roll" Execute a DCMT TEST command. Obtains diagnostic information for Broadcom technical support personnel.
+The DCMT TEST command is used for debugging and diagnostic purposes only. Use it only when told to do so by IDMS technical support personnel. It is enabled only if certain CSA test flags are turned on
+zowe idms issue dcmt-test [options]
+--host | -H (string)
--port | -P (number)
--user | -u (string)
--password | --pass | --pw (string)
--reject-unauthorized | --ru (boolean)
Reject self-signed certificates
+Default value: true
+--base-path | --bp (string)
--datasource | -d (string)
--args (string)
--broadcast | -b (string)
Issues a 'dcmt shutdown noprompt' command to shut down the DC/UCF system while allowing all active tasks and external run units to terminate normally first:
+Issues a 'dcmt test debug options' command, with 'debug options' being the options provided by IDMS technical support:
zowe idms issue dcmt-shutdown --args "noprompt" Issues a 'dcmt shutdown noprompt immediate' command to immediately shut down the DC/UCF system, abending all active tasks and external run units with code SHUT:
-zowe idms issue dcmt-shutdown --args "noprompt immediate" zowe idms issue dcmt-test --args "debug options" Execute a DCMT STATISTICS command
+Execute a DCMT VARY command
zowe idms issue dcmt-statistics [options]
+zowe idms issue dcmt-vary [options]
--datasource | -d (string)
--args (string)
--broadcast | -b (string)
Issues a 'dcmt write statistics roll' command to write the current system and line statistics and histograms to the log file and then reset their values to zero:
+Issues a 'dcmt vary task signon enabled' command to enable the SIGNON task:
zowe idms issue dcmt-statistics --args "roll" zowe idms issue dcmt-vary --args "task signon enabled" Issues a 'dcmt vary journal swap' command with an IDMS profile and data source to override the default:
+zowe idms issue dcmt-vary --args "journal swap" --idms-profile myprofile2 --datasource sysdemo Execute a DCMT TEST command. Obtains diagnostic information for Broadcom technical support personnel.
-The DCMT TEST command is used for debugging and diagnostic purposes only. Use it only when told to do so by CA IDMS technical support personnel. It is enabled only if certain CSA test flags are turned on
+Execute a DCUF HELP command
zowe idms issue dcmt-test [options]
+zowe idms issue dcuf-help [options]
--datasource | -d (string)
--args (string)
--broadcast | -b (string)
Issues a 'dcmt test debug options' command, with 'debug options' being the options provided by CA IDMS technical support:
+Issues a 'dcuf help' command to display a list of DCUF commands and parameters. Note: Only SHOW commands are supported by the CLI:
zowe idms issue dcmt-test --args "debug options" zowe idms issue dcuf-help Execute a DCMT VARY command
+Execute a DCUF SHOW command
zowe idms issue dcmt-vary [options]
+zowe idms issue dcuf-show [options]
--datasource | -d (string)
--args (string)
Issues a 'dcmt vary task signon enabled' command to enable the SIGNON task:
-zowe idms issue dcmt-vary --args "task signon enabled" Issues a 'dcmt vary journal swap' command with an IDMS profile and data source to override the default:
-zowe idms issue dcmt-vary --args "journal swap" --idms-profile myprofile2 --datasource sysdemo Execute a DCUF HELP command
-zowe idms issue dcuf-help [options]
---host | -H (string)
--port | -P (number)
--user | -u (string)
--password | --pass | --pw (string)
--reject-unauthorized | --ru (boolean)
Reject self-signed certificates
-Default value: true
---base-path | --bp (string)
--datasource | -d (string)
--idms-profile | --idms-p (string)
--base-profile | --base-p (string)
--token-type | --tt (string)
--token-value | --tv (string)
--cert-file (local file path)
--cert-key-file (local file path)
--response-format-filter | --rff (array)
--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)
Issues a 'dcuf show tables' command to display a list of the available tables:
zowe idms issue dcuf-show --args "tables" Issues a 'dcuf help' command to display a list of DCUF commands and parameters. Note: Only SHOW commands are supported by the CLI:
+Issues a 'dcuf show user <username>' command to display information about a specific user:
zowe idms issue dcuf-help zowe idms issue dcuf-show --args "user username" Execute a DCUF SHOW command
+Lists available datasources, real-time monitor statistics information, log messages, active user tasks, and transaction details
+Lists data sources defined to the IDMS REST API
zowe idms issue dcuf-show [options]
+zowe idms list datasources [options]
--datasource | -d (string)
--args (string)
--datasourcename | --dsn (string)
--broadcast | -b (string)
--all | -a (boolean)
Issues a 'dcuf show tables' command to display a list of the available tables:
+Lists all data sources defined to the IDMS Rest API:
zowe idms issue dcuf-show --args "tables" zowe idms list datasources --all Issues a 'dcuf show user <username>' command to display information about a specific user:
+Lists a single IDMS data source identified by the data source name:
zowe idms issue dcuf-show --args "user username" zowe idms list datasources --dsn SYSDEMO Lists real-time monitor statistics information, log messages, active user tasks, and transaction details
Lists log messages based on the search options provided
--datasource | -d (string)
--datasourcename | --dsn (string)
--datasourcename | --dsn (string)
The CA MAT Analyze plug-in for ZOWE CLI enables you to manage monitor profiles and get the measurement analysis data using CA Mainframe Application Tuner (CA MAT)
+The MAT Analyze plug-in for ZOWE CLI enables you to manage monitor profiles and get the measurement analysis data using Mainframe Application Tuner (MAT)
Get monitor history and measurement analysis data from CA MAT.
+Get monitor history and measurement analysis data from MAT.
Get the CodeView measurement details.
--group (string)
--top (number)
--listing (boolean)
--top (number)
Create, invoke, and list CA MAT monitor profiles.
+Create, invoke, and list MAT monitor profiles.
Create a CA MAT monitor profile.
+Create a MAT monitor profile.
zowe mat profile create [options]
--profile (string)
--jobname (string)
--mondsn (string)
--stepname (string)
--procstep (string)
--program (string)
--tasklib (string)
--samplecnt (string)
Specifies the number of observations requested. Values: maximum 6 characters, numbers between 10 and 999999.
+Specifies the number of observations requested. Values: maximum 6 characters, numbers between 10 and 999999.
Default value: 6000
--succnt (string)
Specifies the maximum number of monitors to run per job execution. Values: maximum 4 characters, numbers between 1 and 9999.
+Specifies the maximum number of monitors to run per job execution. Values: maximum 4 characters, numbers between 1 and 9999.
Default value: 1
--reccnt (string)
Specifies the number of times this job step will be monitored. Values: maximum 4 characters, numbers between 1 and 9999.
+Specifies the number of times this job step will be monitored. Values: maximum 4 characters, numbers between 1 and 9999.
Default value: 1
--sampdelay (string)
Specifies the delay monitoring time in seconds after the step start. Values: maximum 4 characters, numbers between 0 and 9999.
+Specifies the delay monitoring time in seconds after the step start. Values: maximum 4 characters, numbers between 0 and 9999.
Default value: 0
--userexit1 (string)
--userexit2 (string)
--userexit3 (string)
--inctask (string)
--exctask (string)
--tran (string)
--term (string)
--userid (string)
--db2ctsql (string)
Indicates whether the Collect SQL from Catalog option is enabled for DB2 SQL statements.If you specify db2expl=yes, then db2ctsql must be also set to yes.
+Indicates whether the Collect SQL from Catalog option is enabled for DB2 SQL statements.If you specify db2expl=yes, then db2ctsql must be also set to yes.
Default value: no
Allowed values: yes, no
--db2hvloc (string)
Indicates whether the Requestor Location option is enabled for DB2 measurements.
+Indicates whether the Requestor Location option is enabled for DB2 measurements.
Default value: no
Allowed values: yes, no
--db2hvcor (string)
Indicates whether the Correlation ID option for SQL statements is enabled for DB2 measurements.
+Indicates whether the Correlation ID option for SQL statements is enabled for DB2 measurements.
Default value: no
Allowed values: yes, no
--db2hviid (string)
Indicates whether the Operator ID option for SQL statements is enabled for DB2 measurements.
+Indicates whether the Operator ID option for SQL statements is enabled for DB2 measurements.
Default value: no
Allowed values: yes, no
--db2hvthd (string)
Indicates whether the Thread Address option for SQL statements is enabled for DB2 measurements.
+Indicates whether the Thread Address option for SQL statements is enabled for DB2 measurements.
Default value: no
Allowed values: yes, no
--schedule (string)
Invoke a CA MAT monitor profile to start measurement.
+Invoke a MAT monitor profile to start measurement.
zowe mat profile invoke [options]
--profile (string)
--mondsn (string)
--listing (boolean)
Invoke the PROFILE1 monitor profile to measure job JOB1 that runs on the AA31 system:
+Invoke the PROFILE1 monitor profile to measure job JOB1 that runs on the AA31 system :
zowe mat profile invoke --profile PROFILE1 --jobname JOB1 --targsys AA31 The CA MAT Detect plug-in for Zowe CLI enables you to detect performance issues and access performance data supplied by the Performance Management Assistant component (PMA) of CA Mainframe Application Tuner.
+The MAT Detect plug-in for Zowe CLI enables you to detect performance issues and access performance data supplied by the Performance Management Assistant component (PMA) of Mainframe Application Tuner.
Get performance information using PMA utilities. You can get the current performance data of your jobs and check for the daily performance alerts.
Configuration profile for CA Spool, where you specify information about your CA Spool instance
+Configuration profile for Spool, where you specify information about your Spool instance
zowe profiles create caspool-profile <profileName> [options]
--account | -a (string)
--spoolhlq | --hlq (string)
--subsys | --sub (string)
CA Spool subsystem name.
+Spool subsystem name.
Default value: ESF
--outds | --out (string)
Create a profile for CA Spool named 'myProfile' with TSO account information '1234567890', CA Spool installation high level qualifier of 'CASPOOL.HLQ', subsystem name 'ESF1', output response data set 'OUTPUT.RESPONSE.DS', and data set 'USER.CLIST', containing ESFZOWE REXX exec:
+Create a profile for Spool named 'myProfile' with TSO account information '1234567890', Spool installation high level qualifier of 'CASPOOL.HLQ', subsystem name 'ESF1', output response data set 'OUTPUT.RESPONSE.DS', and data set 'USER.CLIST', containing ESFZOWE REXX exec:
zowe profiles create caspool-profile myProfile --account 1234567890 --spoolhlq CASPOOL.HLQ --subsys ESF1 --outds OUTPUT.RESPONSE.DS --clist USER.CLIST Configuration profile for CA View
+Configuration profile for View
zowe profiles create caview-profile <profileName> [options]
--protocol (string)
Protocol of the target CA View REST API instance.
+Protocol of the target View REST API instance.
Default value: https
Allowed values: http, https
--port (number)
--hostname (string)
--port | -P (number)
Port of the target CA View REST API instance.
+Port of the target View REST API instance.
Default value: 443
--base-path (string)
Context name of the target CA View REST API instance.
+Context name of the target View REST API instance.
Default value: web-viewer
--overwrite | --ow (boolean)
--disable-defaults | --dd (boolean)
--username (string)
--hostname (string)
--password | --pass | --pw (string)
--username (string)
--overwrite | --ow (boolean)
--password (string)
--disable-defaults | --dd (boolean)
Create a profile for CA View® Plug-in for Zowe CLI named 'myProfile' to connect to 'mf.company.org' over HTTP on port 80 using the 'johndoe' account.:
+Create a profile for View™ Plug-in for Zowe CLI named 'myProfile' to connect to 'mf.company.org' over HTTP on port 80 using the 'johndoe' account.:
zowe profiles create caview-profile myProfile --hostname mf.company.org --protocol http --port 80 --username johndoe --password secret The dbm-db2 profile is a named set of DBM Data Service parameters that are implicitly used with the zowe dbm-db2 commands. The profile includes server connection, z/OS execution, and user-dependent details.
+zowe profiles create dbm-db2-profile <profileName> [options]
+profileName (string)
--job-cards | --jc (string)
Specifies a newline delimited string of z/OS JCL JOB statements.
+Default value: //DB2DVOPS JOB (<nnn>),'DB2 PROVISIONING',NOTIFY=&SYSUID,\n// CLASS=A,MSGCLASS=X,MSGLEVEL=(1,1),\n// REGION=0M,TIME=NOLIMIT
+--work-dataset-prefix | --wdp (string)
Specifies the prefix that is used as the high level qualifier in z/OS work data set names.
+Default value: <hlq>
+--authid | -a (string)
Specifies the primary Db2 authorization ID (user ID) that is used to establish a connection between Db2 and a process.
+Default value: <authid>
+--sqlid | -s (string)
Specifies the authorization ID that is used as the value in generated SET CURRENT SQLID statements most of the time.
+Default value: <sqlid>
+--termination-character | --tc (string)
Specifies the SQL termination character that you want to use to terminate object DDL for triggers, XML indexes, functions, and procedures that contain embedded semicolon-terminated SQL statements.
+You cannot use a comma, an underscore, a single quote, double quotes, left parentheses, or right parentheses for this value.
+--overwrite-output-files | --oof (boolean)
Specifies whether to overwrite output files when they already exist.
+Default value: false
+--host | -H (string)
Specifies the DBM Data Service REST API server host name or TCP/IP address to use.
+Default value: <host>
+--port | -P (number)
Specifies the DBM Data Service REST API server TCP/IP port number.
+Default value: 7300
+--user | -u (string)
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.
+Default value: <user>
+--password | --pass | --pw (string)
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.
+Default value: <password>
+--reject-unauthorized | --ru (boolean)
Determines whether the dbm-db2 command is accepted or rejected when a self-signed certificate is returned by the DBM Data Service.
+Default value: true
+--protocol (string)
Specifies the communication protocol to use between the zowe dbm-db2 client and the DBM Data Service.
+Default value: https
+Allowed values: http, https
--environment-list | --el (string)
Specifies a string of one or more paired values consisting of a Db2 subsystem ID and a DBM Data Service environment pair. The paired entry identifies the DBM Data Service environment to use for a subsystem that is accessible through multiple DBM Data Service environments.
+Format:
+<ssid1>:<env1>, <ssid2>:<env2>, …
+<ssid> is the subsystem ID. <env> is an entry that is configured in the DBM Data Service environments.yaml file. 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.
+Example: ssid:prod@host1.net:7300,ssid2:test@host2.net:7300
+--overwrite | --ow (boolean)
--disable-defaults | --dd (boolean)
Create a dbm-db2 profile named profile_name1 and default values for all the dbm-db2-profile options:
+zowe profiles create dbm-db2-profile profile_name1 Create a dbm-db2 profile named dbm123 that connects to the DBM Data Service at host dbm123 and port 1443 as user db2user and password myp4ss:
+zowe profiles create dbm-db2-profile dbm123 --host dbm123 --port 1443 --user db2user --password myp4ss Create a dbm-db2 profile named dbm124 that connects to the DBM Data Service at host dbm124 and the default port as user db2user and password myp4ss, and allow self-signed certificates:
+zowe profiles create dbm-db2-profile dbm124 --host dbm124 --user db2user --password myp4ss --reject-unauthorized false Create a dbm-db2 profile named dbm125 that connects to the DBM Data Service at host dbm125 and port 1443 and requires a user and password to be specified on every dbm-db2 command. DBM Data Service access to Db2 subsystems SUBA and SUBB uses prod@host1.com:322 and test@host2.com:522, respectively:
+zowe profiles create dbm-db2-profile dbm125 --host dbm125 --port 1443 --el “SUBA:prod@host1.com:322,SUBB:test@host2.net:522” An EBG profile is required to issue commands in the ebg command group. The EBG profile contains the connection details for the CA Endevor Bridge for Git server of your choice.
The CA Endevor SCM element location, where you specify your working environment, system and subsystem
+The Endevor element location, where you specify your working environment, system and subsystem
zowe profiles create endevor-location-profile <profileName> [options]
--environment | --env (string)
The CA Endevor SCM environment where your project resides
+The Endevor environment where your project resides
Default value: DEV
--system | --sys (string)
--subsystem | --sub (string)
--type | --typ (string)
--stage-number | --sn (string)
The CA Endevor SCM stage where your project resides
+The Endevor stage where your project resides
Allowed values: 1, 2
--comment | --com (string)
--ccid | --cci (string)
--maxrc (number)
The return code of CA Endevor SCM that defines a failed action
-Default value: 8
---override-signout | --os (boolean)
Always override element signout, without having to specify the override signout option on each command
-Default value: false
+The return code of Endevor that defines a failed action
+Default value: 12
Create a location profile called 'ndvrLoc' to work at CA Endevor SCM location ENV/1/SYS/SUBSYS, with elements of type COBOL, using CA Endevor SCM web services configuration ENDEVOR:
+Create a location profile called 'ndvrLoc' to work at Endevor location ENV/1/SYS/SUBSYS, with elements of type COBOL, using Endevor web services configuration ENDEVOR:
zowe profiles create endevor-location-profile ndvrLoc --env ENV --sys SYS --sub SUBSYS --typ COBOL --sn 1 -i ENDEVOR Create a location profile called 'ndvrLoc2' to work at CA Endevor SCM location ENV/1/SYS/SUBSYS, using CCID 'CCID' and comment 'sample comment':
+Create a location profile called 'ndvrLoc2' to work at Endevor location ENV/1/SYS/SUBSYS, using CCID 'CCID' and comment 'sample comment':
zowe profiles create endevor-location-profile ndvrLoc2 --env ENV --sys SYS --sub SUBSYS --sn 1 --com 'sample comment' --cci 'CCID' CA File Master Plus profile schema.
+File Master Plus profile schema.
zowe profiles create fmp-profile <profileName> [options]
--host | -H (string)
--port | -P (number)
--protocol | -o (string)
Specifies CA File Master Plus REST API protocol.
+Specifies File Master Plus REST API protocol.
Default value: https
Allowed values: http, https
--datasource | -d (string)
CA MAT Analyze CLI profile schema.
+MAT Analyze CLI profile schema.
zowe profiles create mat-profile <profileName> [options]
--protocol | --prt (string)
Specifies the protocol defined for the CA MAT REST API server (http or https).
+Specifies the protocol defined for the MAT REST API server (http or https).
Allowed values: http, https
--hostname | --hn (string)
--zowediscoverable | --zdis (boolean)
Specifies whether you want to use Zowe API Mediation Layer to process the commands for this profile. Set '--zowediscoverable true' only if you have configured the Zowe API Mediation Layer properties in your CA MAT REST API server settings.
+Specifies whether you want to use Zowe API Mediation Layer to process the commands for this profile. Set '--zowediscoverable true' only if you have configured the Zowe API Mediation Layer properties in your MAT REST API server settings.
Allowed values: false, true
--listingDir | --ldir (string)
Create a MAT profile called 'matprofile' using your CA MAT configuration and REST API details, with the CA MAT REST API server integrated with the Zowe API Mediation Layer:
+Create a MAT profile called 'matprofile' using your MAT configuration and REST API details, with the MAT REST API server integrated with the Zowe API Mediation Layer:
zowe profiles create mat-profile matprofile --prt http --hn localhost --pt 1234 --user user --pass pass --zowediscoverable true Create a MAT profile called 'matprofile' using your CA MAT configuration and the details of the CA MAT REST API server without integration with the Zowe API Mediation Layer,and define the 'c:\listings' directory to store program listings for instant analysis from your VS Code IDE:
+Create a MAT profile called 'matprofile' using your MAT configuration and the details of the MAT REST API server without integration with the Zowe API Mediation Layer,and define the 'c:\listings' directory to store program listings for instant analysis from your VS Code IDE:
zowe profiles create mat-profile matprofile --prt http --hn localhost --pt 1234 --user user --pass pass --zowediscoverable false --listingDir 'c:\listings' CA MAT Detect CLI profile schema.
+MAT Detect CLI profile schema.
zowe profiles create pma-profile <profileName> [options]
Delete a dbm-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.
+zowe profiles delete dbm-db2-profile <profileName> [options]
+profileName (string)
--force (boolean)
Delete a dbm-db2 profile named profilename:
+zowe profiles delete dbm-db2-profile profilename Delete a ebg 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.
Configuration profile for CA Spool, where you specify information about your CA Spool instance
+Configuration profile for Spool, where you specify information about your Spool instance
zowe profiles list caspool-profiles [options]
Configuration profile for CA View
+Configuration profile for View
zowe profiles list caview-profiles [options]
The dbm-db2 profile is a named set of DBM Data Service parameters that are implicitly used with the zowe dbm-db2 commands. The profile includes server connection, z/OS execution, and user-dependent details.
+zowe profiles list dbm-db2-profiles [options]
+--show-contents | --sc (boolean)
List profiles of type dbm-db2:
+zowe profiles list dbm-db2-profiles List profiles of type dbm-db2 and display their contents:
+zowe profiles list dbm-db2-profiles --sc An EBG profile is required to issue commands in the ebg command group. The EBG profile contains the connection details for the CA Endevor Bridge for Git server of your choice.
The CA Endevor SCM element location, where you specify your working environment, system and subsystem
+The Endevor element location, where you specify your working environment, system and subsystem
zowe profiles list endevor-location-profiles [options]
CA File Master Plus profile schema.
+File Master Plus profile schema.
zowe profiles list fmp-profiles [options]
CA MAT Analyze CLI profile schema.
+MAT Analyze CLI profile schema.
zowe profiles list mat-profiles [options]
CA MAT Detect CLI profile schema.
+MAT Detect CLI profile schema.
zowe profiles list pma-profiles [options]
The dbm-db2 set default-profiles command allows you to set the default profiles for this command group. When a dbm-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.
+zowe profiles set-default dbm-db2-profile <profileName> [options]
+profileName (string)
Set the default profile for type dbm-db2 to the profile named 'profilename':
+zowe profiles set-default dbm-db2-profile profilename The ebg set default-profiles command allows you to set the default profiles for this command group. When a ebg 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.
Configuration profile for CA Spool, where you specify information about your CA Spool instance
+Configuration profile for Spool, where you specify information about your Spool instance
zowe profiles update caspool-profile <profileName> [options]
--account | -a (string)
--spoolhlq | --hlq (string)
--subsys | --sub (string)
--outds | --out (string)
Update the TSO account information to '3213213210' for CA Spool profile named 'myProfile':
+Update the TSO account information to '3213213210' for Spool profile named 'myProfile':
zowe profiles update caspool-profile myProfile --account 3213213210 Update high level qualifier of the CA Spool installation to 'CASPOOL.HLQ' for CA Spool profile named 'myProfile':
+Update high level qualifier of the Spool installation to 'CASPOOL.HLQ' for Spool profile named 'myProfile':
zowe profiles update caspool-profile myProfile --spoolhlq CASPOOL.HLQ Update the CA Spool subsystem name to 'ESF2' for CA Spool profile named 'myProfile':
+Update the Spool subsystem name to 'ESF2' for Spool profile named 'myProfile':
zowe profiles update caspool-profile myProfile --subsys ESF2 Update the output response data set to 'OUTPUT.RESPONSE.DS.NEW' for CA Spool profile named 'myProfile':
+Update the output response data set to 'OUTPUT.RESPONSE.DS.NEW' for Spool profile named 'myProfile':
zowe profiles update caspool-profile myProfile --outds OUTPUT.RESPONSE.DS.NEW Update the data set containing ESFZOWE REXX exec to 'USER.CLIST' for CA Spool profile named 'myProfile':
+Update the data set containing ESFZOWE REXX exec to 'USER.CLIST' for Spool profile named 'myProfile':
zowe profiles update caspool-profile myProfile --clist USER.CLIST Configuration profile for CA View
+Configuration profile for View
zowe profiles update caview-profile <profileName> [options]
--protocol (string)
Protocol of the target CA View REST API instance.
+Protocol of the target View REST API instance.
Allowed values: http, https
--hostname (string)
--port (number)
--port | -P (number)
--base-path (string)
--username (string)
--password (string)
--password | --pass | --pw (string)
The dbm-db2 profile is a named set of DBM Data Service parameters that are implicitly used with the zowe dbm-db2 commands. The profile includes server connection, z/OS execution, and user-dependent details.
+zowe profiles update dbm-db2-profile <profileName> [options]
+profileName (string)
--job-cards | --jc (string)
--work-dataset-prefix | --wdp (string)
--authid | -a (string)
--sqlid | -s (string)
--termination-character | --tc (string)
Specifies the SQL termination character that you want to use to terminate object DDL for triggers, XML indexes, functions, and procedures that contain embedded semicolon-terminated SQL statements.
+You cannot use a comma, an underscore, a single quote, double quotes, left parentheses, or right parentheses for this value.
+--overwrite-output-files | --oof (boolean)
Specifies whether to overwrite output files when they already exist.
+Default value: false
+--host | -H (string)
--port | -P (number)
--user | -u (string)
--password | --pass | --pw (string)
--reject-unauthorized | --ru (boolean)
--protocol (string)
Specifies the communication protocol to use between the zowe dbm-db2 client and the DBM Data Service.
+Allowed values: http, https
+--environment-list | --el (string)
Specifies a string of one or more paired values consisting of a Db2 subsystem ID and a DBM Data Service environment pair. The paired entry identifies the DBM Data Service environment to use for a subsystem that is accessible through multiple DBM Data Service environments.
+Format:
+<ssid1>:<env1>, <ssid2>:<env2>, …
+<ssid> is the subsystem ID. <env> is an entry that is configured in the DBM Data Service environments.yaml file. 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.
+Example: ssid:prod@host1.net:7300,ssid2:test@host2.net:7300
+Update a dbm-db2 profile named dbm123 with a new username and password:
+zowe profiles update dbm-db2-profile dbm123 --user newuser --password newp4ss Update a dbm-db2 profile named profile_name1 with a new work data set prefix:
+zowe profiles update dbm-db2-profile profile_name1 --work-dataset-prefix NEWPREFX.DDL An EBG profile is required to issue commands in the ebg command group. The EBG profile contains the connection details for the CA Endevor Bridge for Git server of your choice.
The CA Endevor SCM element location, where you specify your working environment, system and subsystem
+The Endevor element location, where you specify your working environment, system and subsystem
zowe profiles update endevor-location-profile <profileName> [options]
--environment | --env (string)
--system | --sys (string)
--subsystem | --sub (string)
--type | --typ (string)
--stage-number | --sn (string)
The CA Endevor SCM stage where your project resides
+The Endevor stage where your project resides
Allowed values: 1, 2
--comment | --com (string)
--ccid | --cci (string)
--maxrc (number)
--override-signout | --os (boolean)
CA File Master Plus profile schema.
+File Master Plus profile schema.
zowe profiles update fmp-profile <profileName> [options]
--host | -H (string)
--port | -P (number)
--protocol | -o (string)
Specifies CA File Master Plus REST API protocol.
+Specifies File Master Plus REST API protocol.
Allowed values: http, https
--datasource | -d (string)
CA MAT Analyze CLI profile schema.
+MAT Analyze CLI profile schema.
zowe profiles update mat-profile <profileName> [options]
--protocol | --prt (string)
Specifies the protocol defined for the CA MAT REST API server (http or https).
+Specifies the protocol defined for the MAT REST API server (http or https).
Allowed values: http, https
--hostname | --hn (string)
--zowediscoverable | --zdis (boolean)
Specifies whether you want to use Zowe API Mediation Layer to process the commands for this profile. Set '--zowediscoverable true' only if you have configured the Zowe API Mediation Layer properties in your CA MAT REST API server settings.
+Specifies whether you want to use Zowe API Mediation Layer to process the commands for this profile. Set '--zowediscoverable true' only if you have configured the Zowe API Mediation Layer properties in your MAT REST API server settings.
Allowed values: false, true
--listingDir | --ldir (string)
CA MAT Detect CLI profile schema.
+MAT Detect CLI profile schema.
zowe profiles update pma-profile <profileName> [options]
Zowe CLI plugin for CA SYSVIEW
+Zowe CLI plugin for SYSVIEW
Display output from a primary command stored in a SYSVIEW capture data set
Issue a CA SYSVIEW primary command and display output, including any messages
+Issue a SYSVIEW primary command and display output, including any messages
zowe sysview display <command-string> [options]
Issue a CA SYSVIEW function command and display any messages
+Issue a SYSVIEW function command and display any messages
zowe sysview execute <command-string> [options]
An example .zosattributes file:
# pattern local-encoding remote-encoding
# Don't upload the node_modules directory
+node_modules -
+# Don't upload files that start with periods
.* -
+# Upload jpg images in binary
*.jpg binary binary
# Convert CICS Node.js profiles to EBCDIC
*.profile ISO8859-1 EBCDIC
Upload all files from the "local_dir" directory to the "/a/ibmuser/my_dir" USS directory:":
+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::
+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::
+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::
+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::
+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 Interact with CA Spool™
+Interact with Spool™
zowe caspool <group>
Where <group> is one of the following:
Issue CA Spool commands.
+Issue Spool commands.
zowe caspool issue <command>
Where <command> is one of the following:
Issue commands to work with CA Spool.
+Issue commands to work with Spool.
zowe caspool issue command <commandText> [options]
commandText (string)
--account | -a (string)
--spoolhlq | --hlq (string)
--subsys | --sub (string)
CA Spool subsystem name.
+Spool subsystem name.
Default value: ESF
--outds | --out (string)
Issue the CA Spool command 'DS' to display the status of the ESF system:
+Issue the Spool command 'DS' to display the status of the ESF system:
zowe caspool issue command "DS" Access CA View data and perform related tasks.
+Access View data and perform related tasks.
zowe caview <group>
Where <group> is one of the following:
Download CA View report data to local folder.
+Download View report data to local folder.
zowe caview download <command>
Where <command> is one of the following:
diff --git a/static/v1.28.x/web_help/docs/zowe_caview_download_report.html b/static/v1.28.x/web_help/docs/zowe_caview_download_report.html index 2d79b2bf7c..3923561bf4 100644 --- a/static/v1.28.x/web_help/docs/zowe_caview_download_report.html +++ b/static/v1.28.x/web_help/docs/zowe_caview_download_report.html @@ -93,6 +93,55 @@--hostname (string)
--port | -P (number)
Port of the target View REST API instance.
+Default value: 443
+--username (string)
--password | --pass | --pw (string)
--base-path (string)
Context name of the target View REST API instance.
+Default value: web-viewer
+--protocol (string)
Protocol of the target View REST API instance.
+Default value: https
+Allowed values: http, https
--port | -P (number)
--user | -u (string)
--password | --pass | --pw (string)
--reject-unauthorized | --ru (boolean)
Export CA View text report file to local folder.
+Export View text report file to local folder.
zowe caview export <command>
Where <command> is one of the following:
diff --git a/static/v1.28.x/web_help/docs/zowe_caview_export_report.html b/static/v1.28.x/web_help/docs/zowe_caview_export_report.html index be5aad2802..f3703ffad2 100644 --- a/static/v1.28.x/web_help/docs/zowe_caview_export_report.html +++ b/static/v1.28.x/web_help/docs/zowe_caview_export_report.html @@ -54,6 +54,55 @@--hostname (string)
--port | -P (number)
Port of the target View REST API instance.
+Default value: 443
+--username (string)
--password | --pass | --pw (string)
--base-path (string)
Context name of the target View REST API instance.
+Default value: web-viewer
+--protocol (string)
Protocol of the target View REST API instance.
+Default value: https
+Allowed values: http, https
--port | -P (number)
--user | -u (string)
--password | --pass | --pw (string)
--reject-unauthorized | --ru (boolean)
Get information from CA View repository.
+Get information from View repository.
zowe caview get <group>
Where <group> is one of the following:
diff --git a/static/v1.28.x/web_help/docs/zowe_caview_get_user_settings.html b/static/v1.28.x/web_help/docs/zowe_caview_get_user_settings.html index dbded3c08a..ce38bf4e4a 100644 --- a/static/v1.28.x/web_help/docs/zowe_caview_get_user_settings.html +++ b/static/v1.28.x/web_help/docs/zowe_caview_get_user_settings.html @@ -53,6 +53,55 @@--hostname (string)
--port | -P (number)
Port of the target View REST API instance.
+Default value: 443
+--username (string)
--password | --pass | --pw (string)
--base-path (string)
Context name of the target View REST API instance.
+Default value: web-viewer
+--protocol (string)
Protocol of the target View REST API instance.
+Default value: https
+Allowed values: http, https
--port | -P (number)
--user | -u (string)
--password | --pass | --pw (string)
--reject-unauthorized | --ru (boolean)
List CA View repository, report, and user information.
+List View repository, report, and user information.
zowe caview list <command|group>
Where <command|group> is one of the following:
diff --git a/static/v1.28.x/web_help/docs/zowe_caview_list_export-rules.html b/static/v1.28.x/web_help/docs/zowe_caview_list_export-rules.html index 5c7cb65251..713d8e9715 100644 --- a/static/v1.28.x/web_help/docs/zowe_caview_list_export-rules.html +++ b/static/v1.28.x/web_help/docs/zowe_caview_list_export-rules.html @@ -54,6 +54,55 @@--hostname (string)
--port | -P (number)
Port of the target View REST API instance.
+Default value: 443
+--username (string)
--password | --pass | --pw (string)
--base-path (string)
Context name of the target View REST API instance.
+Default value: web-viewer
+--protocol (string)
Protocol of the target View REST API instance.
+Default value: https
+Allowed values: http, https
--port | -P (number)
--user | -u (string)
--password | --pass | --pw (string)
--reject-unauthorized | --ru (boolean)
--hostname (string)
--port | -P (number)
Port of the target View REST API instance.
+Default value: 443
+--username (string)
--password | --pass | --pw (string)
--base-path (string)
Context name of the target View REST API instance.
+Default value: web-viewer
+--protocol (string)
Protocol of the target View REST API instance.
+Default value: https
+Allowed values: http, https
--port | -P (number)
--user | -u (string)
--password | --pass | --pw (string)
--reject-unauthorized | --ru (boolean)
--hostname (string)
--port | -P (number)
Port of the target View REST API instance.
+Default value: 443
+--username (string)
--password | --pass | --pw (string)
--base-path (string)
Context name of the target View REST API instance.
+Default value: web-viewer
+--protocol (string)
Protocol of the target View REST API instance.
+Default value: https
+Allowed values: http, https
--port | -P (number)
--user | -u (string)
--password | --pass | --pw (string)
--reject-unauthorized | --ru (boolean)
--hostname (string)
--port | -P (number)
Port of the target View REST API instance.
+Default value: 443
+--username (string)
--password | --pass | --pw (string)
--base-path (string)
Context name of the target View REST API instance.
+Default value: web-viewer
+--protocol (string)
Protocol of the target View REST API instance.
+Default value: https
+Allowed values: http, https
--port | -P (number)
--user | -u (string)
--password | --pass | --pw (string)
--reject-unauthorized | --ru (boolean)
--hostname (string)
--port | -P (number)
Port of the target View REST API instance.
+Default value: 443
+--username (string)
--password | --pass | --pw (string)
--base-path (string)
Context name of the target View REST API instance.
+Default value: web-viewer
+--protocol (string)
Protocol of the target View REST API instance.
+Default value: https
+Allowed values: http, https
--port | -P (number)
--user | -u (string)
--password | --pass | --pw (string)
--reject-unauthorized | --ru (boolean)
--hostname (string)
--port | -P (number)
Port of the target View REST API instance.
+Default value: 443
+--username (string)
--password | --pass | --pw (string)
--base-path (string)
Context name of the target View REST API instance.
+Default value: web-viewer
+--protocol (string)
Protocol of the target View REST API instance.
+Default value: https
+Allowed values: http, https
--port | -P (number)
--user | -u (string)
--password | --pass | --pw (string)
--reject-unauthorized | --ru (boolean)
Search data in a CA View repository.
+Search data in a View repository.
zowe caview search <group>
Where <group> is one of the following:
diff --git a/static/v1.28.x/web_help/docs/zowe_caview_search_index_names.html b/static/v1.28.x/web_help/docs/zowe_caview_search_index_names.html index 29a234c4e4..91b9f4332a 100644 --- a/static/v1.28.x/web_help/docs/zowe_caview_search_index_names.html +++ b/static/v1.28.x/web_help/docs/zowe_caview_search_index_names.html @@ -103,6 +103,55 @@--hostname (string)
--port | -P (number)
Port of the target View REST API instance.
+Default value: 443
+--username (string)
--password | --pass | --pw (string)
--base-path (string)
Context name of the target View REST API instance.
+Default value: web-viewer
+--protocol (string)
Protocol of the target View REST API instance.
+Default value: https
+Allowed values: http, https
--port | -P (number)
--user | -u (string)
--password | --pass | --pw (string)
--reject-unauthorized | --ru (boolean)
--hostname (string)
--port | -P (number)
Port of the target View REST API instance.
+Default value: 443
+--username (string)
--password | --pass | --pw (string)
--base-path (string)
Context name of the target View REST API instance.
+Default value: web-viewer
+--protocol (string)
Protocol of the target View REST API instance.
+Default value: https
+Allowed values: http, https
--port | -P (number)
--user | -u (string)
--password | --pass | --pw (string)
--reject-unauthorized | --ru (boolean)
--hostname (string)
--port | -P (number)
Port of the target View REST API instance.
+Default value: 443
+--username (string)
--password | --pass | --pw (string)
--base-path (string)
Context name of the target View REST API instance.
+Default value: web-viewer
+--protocol (string)
Protocol of the target View REST API instance.
+Default value: https
+Allowed values: http, https
--port | -P (number)
--user | -u (string)
--password | --pass | --pw (string)
--reject-unauthorized | --ru (boolean)
Set information in CA View repository.
+Set information in View repository.
zowe caview set <group>
Where <group> is one of the following:
diff --git a/static/v1.28.x/web_help/docs/zowe_caview_set_user_distribution.html b/static/v1.28.x/web_help/docs/zowe_caview_set_user_distribution.html index 5e22585325..7b006d968b 100644 --- a/static/v1.28.x/web_help/docs/zowe_caview_set_user_distribution.html +++ b/static/v1.28.x/web_help/docs/zowe_caview_set_user_distribution.html @@ -59,6 +59,55 @@--hostname (string)
--port | -P (number)
Port of the target View REST API instance.
+Default value: 443
+--username (string)
--password | --pass | --pw (string)
--base-path (string)
Context name of the target View REST API instance.
+Default value: web-viewer
+--protocol (string)
Protocol of the target View REST API instance.
+Default value: https
+Allowed values: http, https
--port | -P (number)
--user | -u (string)
--password | --pass | --pw (string)
--reject-unauthorized | --ru (boolean)
--hostname (string)
--port | -P (number)
Port of the target View REST API instance.
+Default value: 443
+--username (string)
--password | --pass | --pw (string)
--base-path (string)
Context name of the target View REST API instance.
+Default value: web-viewer
+--protocol (string)
Protocol of the target View REST API instance.
+Default value: https
+Allowed values: http, https
--port | -P (number)
--user | -u (string)
--password | --pass | --pw (string)
--reject-unauthorized | --ru (boolean)
dbm-db2 plug-in to interact with Db2 using the Broadcom Database Management Solutions for Db2 for z/OS.
+zowe dbm-db2 <group>
+Where <group> is one of the following:
+Perform DDL syntax checking.
+zowe dbm-db2 check <command>
+Where <command> is one of the following:
+Validate the syntax of input DDL and optionally verify Db2 object dependencies. Use this command to ensure that the syntax of the input DDL is valid. You can also optionally verify that the objects to be created do not exist on the Db2 subsystem and that the related objects that are required for successful creation of the objects exist on the Db2 subsystem or in the input DDL. You can generate input DDL using the 'zowe dbm-db2 generate ddl' command.
+zowe dbm-db2 check ddl <local-input-ddl-filename> [options]
+local-input-ddl-filename (string)
--target-db2 | --td (string)
--verify | -v (string)
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 value: no
+Allowed values: yes, no
+--modification | -m (string)
Identifies an existing 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 set of values that are normally used.
+For more information about using the modification option, see the DBM Data Service documentation at https://techdocs.broadcom.com/db2mgmt.
+--error-file | --ef (string)
Specifies the local output error file that contains errors that occurred during execution of the command.
+Default value: error.log
+--dbm-db2-profile | --dbm-db2-p (string)
--base-profile | --base-p (string)
--host | -H (string)
--port | -P (number)
--user | -u (string)
--password | --pass | --pw (string)
--reject-unauthorized | --ru (boolean)
Reject self-signed certificates.
+Default value: true
+--token-type | --tt (string)
--token-value | --tv (string)
--cert-file (local file path)
--cert-key-file (local file path)
Validate DDL statement syntax of the DDL statements in the sample.sql file on the 'TEST' Db2 subsystem:
+zowe dbm-db2 check ddl sample.sql --target-db2 TEST Validate DDL statement syntax and verify object dependencies:
+zowe dbm-db2 check ddl sample.sql --target-db2 TEST --verify yes Compare DDL with a Db2 subsystem and produce an update script to implement changes.
+zowe dbm-db2 compare <command>
+Where <command> is one of the following:
+Compare objects that are defined in a DDL file to objects that are defined on a Db2 subsystem and generate an update script to implement the necessary object changes. This command also generates a summary report that provides a high-level overview of the changes. You can execute the script that is generated from this command using the 'zowe dbm-db2 execute compare-script' command.
+zowe dbm-db2 compare ddl <local-input-ddl-filename> [options]
+local-input-ddl-filename (string)
--target-db2 | --td (string)
--match-set | --ms (string)
Specifies the creator and name of an existing RC/Migrator automapping mask set. Matching is used to pair objects in a DDL file to objects that are defined on a Db2 subsystem. Matching determines whether the 'change-set' or 'rule-set' options are applied.
+Format:
+ <match\-set\-creator\.match\-set\-name>
+
+ For more information about mask services, see the RC/Migrator documentation at https://techdocs\.broadcom\.com/db2rcmig\.
+
+ Note: If \-\-match\-set and \-\-match\-set\-file are both specified, specifications in match\-set\-file take precedence\.
+--match-set-file | --msf (string)
Specifies the name of the local input file that contains the mapping mask specifications. Matching is used to pair objects in a DDL file to objects that are defined on a Db2 subsystem. For example, a mask specification can account for different schema naming patterns across environments. Matching determines whether the 'change-set' or 'rule-set' options are applied.
+Format:
+ <object\-type> <source\-name\-mask> <target\-name\-mask>;
+
+ STOGROUP <name> <name>
+ DATABASE <name> <name>
+ TABLESPACE <database\.name> <database\.name>
+ TABLE <schema\.name> <schema\.name>
+ INDEX <schema\.name> <schema\.name>
+ VIEW <schema\.name> <schema\.name>
+ SYNONYM <schema\.name> <schema\.name>
+ ALIAS <schema\.name> <schema\.name>
+ TRIGGER <schema\.name> <schema\.name>
+ SEQUENCE <schema\.name> <schema\.name>
+ FUNCTION <schema\.name\[\.version\]> <schema\.name\[\.version\]>
+ PROCEDURE <schema\.name\[\.version\]> <schema\.name\[\.version\]>
+
+ Note: <schema> must be 8 characters or less\. <name> must be 18 characters or less\. The SEQUENCE <name> must be 8 characters or less\.
+
+ A mask specification can include the following wildcard characters:
+
+ % (percent sign) indicates that zero or more characters can occupy that position\. Other non\-wildcard characters must match\.
+
+ \- (hyphen) indicates that any character can occupy that position, but a character must exist at that position\.
+
+ \* (asterisk) indicates that like named objects on the source and target should be mapped\. No other characters can appear together with this character\.
+
+ 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\.
+--change-set | --cs (string)
Specifies the creator and name of an existing RC/Migrator global change set to be used to modify Db2 object attributes. The changes apply to new objects only as determined by match-set processing.
+Format:
+ <change\-set\-creator\.change\-set\-name>
+
+ For more information about global change services, see the RC/Migrator documentation at https://techdocs\.broadcom\.com/db2rcmig\.
+
+ Note: If change\-set and change\-set\-file are both specified, specifications in change\-set\-file take precedence\.
+--change-set-file | --csf (string)
Specifies the name of the local input file that contains the global change specifications to modify Db2 object attributes. The changes apply to new objects only as determined by match-set processing.
+Format:
+ <object\-attribute> <from\-value> <to\-value>
+
+ The <object\-attribute> consists of four characters\. The first two characters identify the object type\. The last two characters identify the specific attribute\. Wildcard characters are supported in the <from\-value> and <to\-value>\. The first occurrence in multiple specifications for the same <object\-attribute> has the highest precedence\.
+Example:
+The following example demonstrates changes to table’s schema (creator) and tablespace names:
+TBCR TEST% PROD%
+TBTS TESTTS% PRODTS%
For a list of global change set attributes, 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\.
+--rule-set | --rs (string)
Specifies the creator and name of an existing RC/Migrator rule set to be used to override Db2 object attributes in the target Db2 subsystem with the corresponding values from the input DDL file.The changes apply to the existing objects only (as determined by match-set processing).
+Format:
+ <rule\-set\-creator\.rule\-set\-name>
+
+ For more information about rule database services, see the RC/Migrator documentation at https://techdocs\.broadcom\.com/db2rcmig\.
+--id (string)
Specifies the 1- to 8-character name of the RC/Migrator compare strategy that is created on the target Db2 subsystem by the execution of this command.
+Format: The name must begin with a non-numeric character, and can consist of the characters A to Z (uppercase only), 0 to 9, $, #, and @.
+--description | -d (string)
--output-compare-script | --ocs (string)
Specifies the local output file name that contains the update script to make changes to the target Db2 subsystem.
+Default value: compare.txt
+--output-summary-file | --osf (string)
Specifies the local output file name that provides a summary of the changes to be performed to the Db2 objects on the target Db2 subsystem. The file summarizes what the changes are, but not how the changes are made.
+Default value: summary.txt
+--modification | -m (string)
Identifies 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 set of values that are normally used.
+For more information about using the modification option, see the DBM Data Service documentation at https://techdocs.broadcom.com/db2mgmt.
+--error-file | --ef (string)
Specifies the local output error file that contains errors that occurred during execution of the command.
+Default value: error.log
+--dbm-db2-profile | --dbm-db2-p (string)
--base-profile | --base-p (string)
--host | -H (string)
--port | -P (number)
--user | -u (string)
--password | --pass | --pw (string)
--reject-unauthorized | --ru (boolean)
Reject self-signed certificates.
+Default value: true
+--token-type | --tt (string)
--token-value | --tv (string)
--cert-file (local file path)
--cert-key-file (local file path)
Generate a script to update objects on the 'TEST' Db2 subsystem with DDL definitions in myddl.sql file:
+zowe dbm-db2 compare ddl myddl.sql --target-db2 TEST Generate a script to update objects and apply a rule-set for the matched objects:
+zowe dbm-db2 compare ddl myddl.sql --target-db2 TEST --rule-set USER1.RULESET Generate a script to update objects and apply a ruleset for the objects matched as determined by the local mask specifications in the pair.txt file:
+zowe dbm-db2 compare ddl myddl.sql --target-db2 TEST --rule-set USER1.RULESET --match-set-file pair.txt Deploy DDL statements to a Db2 subsystem.
+zowe dbm-db2 deploy <command>
+Where <command> is one of the following:
+Deploy Db2 object changes on the target Db2 subsystem using an input file that contains the DDL. For example, an application developer has made changes to DDL in a local file and is ready to test the DDL changes. Use this command to deploy the changes to the test environment.
+zowe dbm-db2 deploy ddl <local-input-ddl-filename> [options]
+local-input-ddl-filename (string)
--target-db2 | --td (string)
--match-set | --ms (string)
Specifies the creator and name of an existing RC/Migrator automapping mask set. Matching is used to pair objects in a DDL file to objects that are defined on a Db2 subsystem. Matching determines whether the 'change-set' or 'rule-set' options are applied.
+Format:
+ <match\-set\-creator\.match\-set\-name>
+
+ For more information about mask services, see the RC/Migrator documentation at https://techdocs\.broadcom\.com/db2rcmig\.
+
+ Note: If \-\-match\-set and \-\-match\-set\-file are both specified, specifications in match\-set\-file take precedence\.
+--match-set-file | --msf (string)
Specifies the name of the local input file that contains the mapping mask specifications. Matching is used to pair objects in a DDL file to objects that are defined on a Db2 subsystem. For example, a mask specification can account for different schema naming patterns across environments. Matching determines whether the 'change-set' or 'rule-set' options are applied.
+Format:
+ <object\-type> <source\-name\-mask> <target\-name\-mask>;
+
+ STOGROUP <name> <name>
+ DATABASE <name> <name>
+ TABLESPACE <database\.name> <database\.name>
+ TABLE <schema\.name> <schema\.name>
+ INDEX <schema\.name> <schema\.name>
+ VIEW <schema\.name> <schema\.name>
+ SYNONYM <schema\.name> <schema\.name>
+ ALIAS <schema\.name> <schema\.name>
+ TRIGGER <schema\.name> <schema\.name>
+ SEQUENCE <schema\.name> <schema\.name>
+ FUNCTION <schema\.name\[\.version\]> <schema\.name\[\.version\]>
+ PROCEDURE <schema\.name\[\.version\]> <schema\.name\[\.version\]>
+
+ Note: <schema> must be 8 characters or less\. <name> must be 18 characters or less\. The SEQUENCE <name> must be 8 characters or less\.
+
+ A mask specification can include the following wildcard characters:
+
+ % (percent sign) indicates that zero or more characters can occupy that position\. Other non\-wildcard characters must match\.
+
+ \- (hyphen) indicates that any character can occupy that position, but a character must exist at that position\.
+
+ \* (asterisk) indicates that like named objects on the source and target should be mapped\. No other characters can appear together with this character\.
+
+ 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\.
+--change-set | --cs (string)
Specifies the creator and name of an existing RC/Migrator global change set to be used to modify Db2 object attributes. The changes apply to new objects only as determined by match-set processing.
+Format:
+ <change\-set\-creator\.change\-set\-name>
+
+ For more information about global change services, see the RC/Migrator documentation at https://techdocs\.broadcom\.com/db2rcmig\.
+
+ Note: If change\-set and change\-set\-file are both specified, specifications in change\-set\-file take precedence\.
+--change-set-file | --csf (string)
Specifies the name of the local input file that contains the global change specifications to modify Db2 object attributes. The changes apply to new objects only as determined by match-set processing.
+Format:
+ <object\-attribute> <from\-value> <to\-value>
+
+ The <object\-attribute> consists of four characters\. The first two characters identify the object type\. The last two characters identify the specific attribute\. Wildcard characters are supported in the <from\-value> and <to\-value>\. The first occurrence in multiple specifications for the same <object\-attribute> has the highest precedence\.
+Example:
+The following example demonstrates changes to table’s schema (creator) and tablespace names:
+TBCR TEST% PROD%
+TBTS TESTTS% PRODTS%
For a list of global change set attributes, 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\.
+--rule-set | --rs (string)
Specifies the creator and name of an existing RC/Migrator rule set to be used to override Db2 object attributes in the target Db2 subsystem with the corresponding values from the input DDL file.The changes apply to the existing objects only (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\.
+--modification | -m (string)
Identifies 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 set of values that are normally used.
+For more information about using the modification option, see the DBM Data Service documentation at https://techdocs.broadcom.com/db2mgmt.
+--error-file | --ef (string)
Specifies the local output error file that contains errors that occurred during execution of the command.
+Default value: error.log
+--dbm-db2-profile | --dbm-db2-p (string)
--base-profile | --base-p (string)
--host | -H (string)
--port | -P (number)
--user | -u (string)
--password | --pass | --pw (string)
--reject-unauthorized | --ru (boolean)
Reject self-signed certificates.
+Default value: true
+--token-type | --tt (string)
--token-value | --tv (string)
--cert-file (local file path)
--cert-key-file (local file path)
Update Db2 objects on a target Db2 subsystem according to DDL definitions in myddl.sql file:
+zowe dbm-db2 deploy ddl myddl.sql --target-db2 TEST Update Db2 objects according to the input DDL definitions and applied rule set for the matched objects:
+zowe dbm-db2 deploy ddl myddl.sql --target-db2 TEST --rule-set USER1.RULESET Update Db2 objects according to the input DDL definitions and applied rule set for the objects matched as determined by the local mask specifications in the pair.txt file:
+zowe dbm-db2 deploy ddl myddl.sql --target-db2 TEST --rule-set USER1.RULESET --match-set-file pair.txt Execute a script to implement Db2 object changes.
+zowe dbm-db2 execute <command>
+Where <command> is one of the following:
+Execute the compare script that was generated with the 'zowe dbm-db2 compare ddl' command to implement the Db2 object changes on the Db2 subsystem specified within the script. This command also generates a recovery script to undo compare script changes.
+zowe dbm-db2 execute compare-script <local-input-compare-script-filename> [options]
+local-input-compare-script-filename (string)
--output-recovery-file | --orf (string)
Specifies the local output recovery file that contains the recovery script that is generated during execution of this command. Executing the recovery script using the 'zowe dbm-db2 execute script' command undoes the changes that were made by execution of the compare-script.
+ Default value: recovery\.txt
+--restart | -r (string)
Specifies the location in the script where you want to restart execution. The effects of previous successful script statement executions remain.
+ The following restart options are valid:
+
+ new \- Restart execution of the script at the first statement\.
+
+ token \- Restart execution of the script at the location that is recorded in the specified token and that was returned from a previous execution failure\.
+--modification | -m (string)
Identifies 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 set of values that are normally used.
+For more information about using the modification option, see the DBM Data Service documentation at https://techdocs.broadcom.com/db2mgmt.
+--error-file | --ef (string)
Specifies the local output error file that contains errors that occurred during execution of the command.
+Default value: error.log
+--dbm-db2-profile | --dbm-db2-p (string)
--base-profile | --base-p (string)
--host | -H (string)
--port | -P (number)
--user | -u (string)
--password | --pass | --pw (string)
--reject-unauthorized | --ru (boolean)
Reject self-signed certificates.
+Default value: true
+--token-type | --tt (string)
--token-value | --tv (string)
--cert-file (local file path)
--cert-key-file (local file path)
Execute a compare script:
+zowe dbm-db2 execute compare-script compare.txt Restart execution of a compare script at the first statement in the script:
+zowe dbm-db2 execute compare-script compare.txt --restart new Restart execution of a compare script at the location in the token:
+zowe dbm-db2 execute compare-script compare.txt --restart 78A724GOBLEDYGOOK6FD140F6780D6FA Execute the migration script that was generated with the 'zowe dbm-db2 prepare migration' command to migrate Db2 objects (DDL) and table data from a source subsystem to a target subsystem. The source and target subsystem IDs are specified within the script.
+zowe dbm-db2 execute migration-script <local-input-migrate-script-filename> [options]
+local-input-migrate-script-filename (string)
--restart | -r (string)
Specifies the location in the script where you want to restart execution. The effects of previous successful script statement executions remain.
+ The following restart options are valid:
+
+ new \- Restart execution of the script at the first statement\.
+
+ name, token \- Restart execution of the script at the location in the restart section that is recorded in the specified token and that was returned from a prior execution failure\.
+
+ A section is a '\.SYSTEM <name>' statement, where <name> identifies a logical grouping of statements such as UNLOADS or SQLDDL\. 'source' is an alias for UNLOADS\. 'target' is an alias for SQLDDL\.
+--modification | -m (string)
Identifies 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 set of values that are normally used.
+For more information about using the modification option, see the DBM Data Service documentation at https://techdocs.broadcom.com/db2mgmt.
+--error-file | --ef (string)
Specifies the local output error file that contains errors that occurred during execution of the command.
+Default value: error.log
+--dbm-db2-profile | --dbm-db2-p (string)
--base-profile | --base-p (string)
--host | -H (string)
--port | -P (number)
--user | -u (string)
--password | --pass | --pw (string)
--reject-unauthorized | --ru (boolean)
Reject self-signed certificates.
+Default value: true
+--token-type | --tt (string)
--token-value | --tv (string)
--cert-file (local file path)
--cert-key-file (local file path)
Execute a migration script:
+zowe dbm-db2 execute migration-script migration.txt Restart execution of a migration script at the first statement in the script:
+zowe dbm-db2 execute migration-script migration.txt --restart new Restart execution of a migration script at the location in the token. Execution begins at the last successful sync point that is recorded in the restart token up to the end of the restart token section:
+zowe dbm-db2 execute migration-script migration.txt --restart target,78A724GOBLEDYGOOK6FD140F6780D6FA Execute a Batch Processor script on a target subsystem. For example, use this command to execute a Batch Processor script or specifically to execute a recovery script to undo changes that were made by the 'zowe dbm-db2 execute compare-script' command. If execution of the script fails, you can execute it again using the 'script-section' or 'restart' options. You can edit the script and make changes before you execute or restart it.
+zowe dbm-db2 execute script <local-input-bp-script-filename> [options]
+local-input-bp-script-filename (string)
--target-db2 | --td (string)
--script-section | --ss (string)
Identifies the location in the script where you want to begin execution.
+The following options are valid:
+
+name \- Begin execution of the specific section and process all subsequent statements up to the next section\.
+A section is a '\.SYSTEM <name>' statement, where <name> identifies a logical grouping of statements such as UNLOADS or SQLDDL\. 'source' is an alias for UNLOADS\. 'target' is an alias for SQLDDL\.
+
+number \- Begin execution after the specific sync point (\.SYNC <number> statement) and process all statements up to the end of the script\.
+
+name, number \- Begin execution of the specific script section beginning from the sync point (\.SYNC <number> statement) within the section and process all subsequent statements up to the next section\.
+--restart | -r (string)
Specifies the location in the script where you want to restart execution. The effects of previous successful script statement executions remain.
+ The following restart options are valid:
+
+ new \- Restart execution of the script at the first statement\.
+
+ token \- Restart execution of the script at the location that is recorded in the specified token and that was returned from a previous execution failure\.
+
+ name, token \- Restart execution of the script at the location in the restart section that is recorded in the specified token and that was returned from a prior execution failure\.
+
+ A section is a Batch Processor '\.SYSTEM <name>' statement, where <name> identifies a logical grouping of statements such as UNLOADS or SQLDDL\. 'source' is an alias for UNLOADS\. 'target' is an alias for SQLDDL\.
+--modification | -m (string)
Identifies 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 set of values that are normally used.
+For more information about using the modification option, see the DBM Data Service documentation at https://techdocs.broadcom.com/db2mgmt.
+--error-file | --ef (string)
Specifies the local output error file that contains errors that occurred during execution of the command.
+Default value: error.log
+--dbm-db2-profile | --dbm-db2-p (string)
--base-profile | --base-p (string)
--host | -H (string)
--port | -P (number)
--user | -u (string)
--password | --pass | --pw (string)
--reject-unauthorized | --ru (boolean)
Reject self-signed certificates.
+Default value: true
+--token-type | --tt (string)
--token-value | --tv (string)
--cert-file (local file path)
--cert-key-file (local file path)
Execute a recovery script:
+zowe dbm-db2 execute script recovery.txt Execute a script on the 'TEST' Db2 subsystem:
+zowe dbm-db2 execute script script001.txt --target-db2 TEST Execute only the SQLDDL section of a script. The first .CONNECT statement in the script identifies the target subsystem where the script is executed. Execution begins at the .SYSTEM SQLDDL statement and ends at the next .SYSTEM statement in the script:
+zowe dbm-db2 execute script script001.txt ––script-section SQLDDL Execute a script beginning from the sync point 10 (.SYNC 10 statement) to the end of the script:
+zowe dbm-db2 execute script script001.txt ––script-section 10 Execute only the target (SQLDDL) section of the script starting at sync point 20:
+zowe dbm-db2 execute script script001.txt ––script-section target,20 Restart execution of a script from the beginning:
+zowe dbm-db2 execute script script001.txt ––restart new Restart execution of a script at the location specified in the token. The restart token is returned by a previous 'zowe dbm-db2 execute command' failure as part of the terminal output and in the error file:
+zowe dbm-db2 execute script script001.txt ––restart 78A724A48DA5185D06FD140F6780D6FA Restart execution at the last successful sync point recorded in the restart token up to the end of the target (SQLDDL) section:
+zowe dbm-db2 execute script script001.txt ––restart target,78A724A48DA5185D06FD140F6780D6FA Generate DDL statements for Db2 objects.
+zowe dbm-db2 generate <command>
+Where <command> is one of the following:
+Generate CREATE or DROP DDL statements for specified Db2 objects into an output DDL file. For example, use this command to generate CREATE TABLE definitions that you can then edit and use to update the table definition on a Db2 subsystem with the 'zowe dbm-db2 compare ddl' command.
+zowe dbm-db2 generate ddl [options]
+--object | -o (string)
Specifies the Db2 objects for which you want to generate DDL statements. Use the optional include syntax to include related Db2 objects.
+Format: see object-file description.
+Note: The \-\-object and \-\-object\-file options are mutually exclusive\.
+--object-file | --of (string)
Specifies the local input file that contains a list of Db2 objects, separated by a semicolon, for which you want to generate DDL statements. Use the optional include syntax to include related Db2 objects.
+Format:
+<object\-type> <object\-name> \[include(<related\-object\-type>,\.\.\.)\];
+
+The required clause <object\-type> <object\-name> identifies the specific Db2 (base) object:
+
+ STOGROUP <name>
+ DATABASE <name>
+ TABLESPACE <dbname>\.<name>
+ TABLE <schema>\.<name>
+ INDEX <schema>\.<name>
+ VIEW <schema>\.<name>
+ ALIAS <schema>\.<name>
+ SYNONYM <schema>\.<name>
+ MQT <schema>\.<name>
+ SEQUENCE <schema>\.<name>
+ TRIGGER <schema>\.<name>
+ FUNCTION <schema>\.<name>\[\.<version>\]
+ PROCEDURE <schema>\.<name>\[\.<version>\]
+
+The optional clause include(<related\-object\-type>,\.\.\.) identifies one or more, comma separated related object types that you want to include in the generated DDL statements\. You can specify STOGROUP, DATABASE, TABLESPACE, TABLE, INDEX, VIEW, SYNONYM, MQT\-ALL, TRIGGER, ROUTINE, PARENTS, CHILDREN, and ALL\.
+
+ Example:
+
+ table sysibm\.systables include (tablespace, database, index);
+ database db1 include(children);
+
+ Note: The \-\-object and \-\-object\-file options are mutually exclusive\.
+--change-set | --cs (string)
Specifies the creator and name of an existing RC/Migrator global change set to be used to modify Db2 object attributes when generating the DDL.
+Format:
+<change\-set\-creator\.change\-set\-name>
+
+For more information about global change services, see the RC/Migrator documentation at https://techdocs\.broadcom\.com/db2rcmig\.
+
+Note: If change\-set and change\-set\-file are both specified, specifications in change\-set\-file take precedence\.
+--change-set-file | --csf (string)
Specifies the name of the local input file that contains the global change specifications to modify Db2 object attributes when generating DDL.
+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 the <from\-value> and <to\-value>\. The first occurrence in multiple specifications for the same <object\-attribute> has the highest precedence\.
+
+For a list of global change set attributes, see the RC/Migrator documentation at https://techdocs\.broadcom\.com/db2rcmig\.
+
+Example:
+
+The following example demonstrates changes to table’s 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\.
+--type | -t (string)
Specifies the type of DDL statements that you want to generate. You can generate CREATE or DROP statements.
+Default value: create
+Allowed values: drop, create
--output-ddl-file | --odf (string)
Specifies the local output file name that contains the generated DDL for the objects that are identified by the --object-file or --object option.
+ Default value: output\.sql
+--modification | -m (string)
Identifies 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 set of values that are normally used.
+For more information about using the modification option, see the DBM Data Service documentation at https://techdocs.broadcom.com/db2mgmt.
+--error-file | --ef (string)
Specifies the local output error file that contains errors that occurred during execution of the command.
+ Default value: error\.log
+--source-db2 | --sd (string)
--dbm-db2-profile | --dbm-db2-p (string)
--base-profile | --base-p (string)
--host | -H (string)
--port | -P (number)
--user | -u (string)
--password | --pass | --pw (string)
--reject-unauthorized | --ru (boolean)
Reject self-signed certificates.
+Default value: true
+--token-type | --tt (string)
--token-value | --tv (string)
--cert-file (local file path)
--cert-key-file (local file path)
Generate CREATE DDL statements for a tablespace and its child table:
+zowe dbm-db2 generate ddl --object "tablespace my.tbsp include(table)" --source-db2 SRC --output-ddl-file objects.sql Generate CREATE DDL statements for a database and its children and apply changes as defined in the change set:
+zowe dbm-db2 generate ddl --object "database my.db include(children)" --source-db2 SRC --change-set USER1.CHANGSET --output-ddl-file objects.sql Generate DROP DDL statements only for the input object list:
+zowe dbm-db2 generate ddl --object-file objects.txt --source-db2 SRC --type drop --output-ddl-file output.sql Prepare DDL statements and a script to migrate Db2 objects.
+zowe dbm-db2 prepare <command>
+Where <command> is one of the following:
+Generate a script to migrate Db2 object definitions (DDL) and data from a source subsystem to a target subsystem. You can specify which objects to include and apply changes to the objects as part of the migration. To execute the script, use the 'zowe dbm-db2 execute migration-script' command.
+zowe dbm-db2 prepare migration [options]
+--object | -o (string)
Specifies the Db2 objects that you want to migrate. Use the optional include syntax to include related Db2 objects.
+Format: see object-file description.
+Note: The \-\-object and \-\-object\-file options are mutually exclusive\.
+--object-file | --of (string)
Specifies the local input file that contains a list of Db2 objects, separated by a semicolon, that you want to migrate. Use the optional include syntax to include related Db2 objects.
+Format:
+<object\-type> <object\-name> \[include(<related\-object\-type>,\.\.\.)\];
+
+The required clause <object\-type> <object\-name> identifies the specific Db2 (base) object:
+
+ STOGROUP <name>
+ DATABASE <name>
+ TABLESPACE <dbname>\.<name>
+ TABLE <schema>\.<name>
+ INDEX <schema>\.<name>
+ VIEW <schema>\.<name>
+ ALIAS <schema>\.<name>
+ SYNONYM <schema>\.<name>
+ MQT <schema>\.<name>
+ SEQUENCE <schema>\.<name>
+ TRIGGER <schema>\.<name>
+ FUNCTION <schema>\.<name>\[\.<version>\]
+ PROCEDURE <schema>\.<name>\[\.<version>\]
+
+The optional clause include(<related\-object\-type>,\.\.\.) identifies one or more, comma separated related object types that you want to include in the object list\. You can specify STOGROUP, DATABASE, TABLESPACE, TABLE, INDEX, VIEW, SYNONYM, MQT\-ALL, TRIGGER, ROUTINE, PARENTS, CHILDREN, and ALL\.
+
+ Example:
+
+ table sysibm\.systables include (tablespace, database, index);
+ database db1 include(children);
+
+ Note: The \-\-object and \-\-object\-file options are mutually exclusive\.
+--change-set | --cs (string)
Specifies the creator and name of an existing RC/Migrator global change set to be used to modify Db2 object attributes when preparing objects for migration.
+Format:
+<change\-set\-creator\.change\-set\-name>
+
+For more information about global change services, see the RC/Migrator documentation at https://techdocs\.broadcom\.com/db2rcmig\.
+
+Note: If change\-set and change\-set\-file are both specified, specifications in change\-set\-file take precedence\.
+--change-set-file | --csf (string)
Specifies the name of the local input file that contains the global change specifications to modify Db2 object attributes when preparing for migration.
+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 the <from\-value> and <to\-value>\. The first occurrence in multiple specifications for the same <object\-attribute> has the highest precedence\.
+
+For a list of global change set attributes, see the RC/Migrator documentation at https://techdocs\.broadcom\.com/db2rcmig\.
+
+Example:
+
+The following example demonstrates changes to table’s 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\.
+--output-migrate-script | --oms (string)
Specifies the local output file name that contains the script to make changes to the target Db2 subsystem.
+Default value: migration.txt
+--output-ddl-file | --odf (string)
Specifies the local output file name that contains the generated DDL for the input objects that are identified by the --object-file or --object option.
+Default value: output.sql
+--modification | -m (string)
Identifies 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 set of values that are normally used.
+For more information about using the modification option, see the DBM Data Service documentation at https://techdocs.broadcom.com/db2mgmt.
+--error-file | --ef (string)
Specifies the local output error file that contains errors that occurred during execution of the command.
+ Default value: error\.log
+--source-db2 | --sd (string)
--target-db2 | --td (string)
--dbm-db2-profile | --dbm-db2-p (string)
--base-profile | --base-p (string)
--host | -H (string)
--port | -P (number)
--user | -u (string)
--password | --pass | --pw (string)
--reject-unauthorized | --ru (boolean)
Reject self-signed certificates.
+Default value: true
+--token-type | --tt (string)
--token-value | --tv (string)
--cert-file (local file path)
--cert-key-file (local file path)
Generate a migration script for a tablespace and its child table:
+zowe dbm-db2 prepare migration --object "tablespace my.tbsp include(table)" --source-db2 SRC --target-db2 TRG --output-migrate-script migrate.txt Generate a migration script and apply global changes:
+zowe dbm-db2 prepare migration --object "database my.db include(children)" --source-db2 SRC --target-db2 TRG –-change-set USER1.CHANGSET –-output-migrate-script migrate.txt --output-ddl-file objects.sql Where <group> is one of the following:
Manage connections to Endevor Web Services used by CA Endevor Bridge for Git.
-zowe endevor-bridge-for-git endevor-connection <command>
-Where <command> is one of the following:
-Create new Endevor connection for CA Endevor Bridge for Git.
-zowe endevor-bridge-for-git endevor-connection create <connection> [options]
-connection (string)
--endevor-instance | --endevori (string)
--endevor-protocol | --endevorprot (string)
The CA Endevor SCM Rest API protocol.
-Default value: http
-Allowed values: http, https
---endevor-host | --endevorh (string)
--endevor-port | --endevorp (number)
--endevor-user | --endevoru (string)
--endevor-password | --endevorpass | --endevorpw (string)
--endevor-reject-unauthorized | --endevorru (boolean)
Reject self-signed certificates.
-Default value: true
---endevor-base-path | --endevorbp (string)
The CA Endevor SCM Rest API base path.
-Default value: EndevorService/rest
---protocol | --prot (string)
The Endevor Bridge for Git SCM protocol.
-Default value: http
-Allowed values: http, https
---host | -H (string)
--port | -P (number)
--user | -u (string)
--token | -t (string)
--reject-unauthorized | --ru (boolean)
Reject self-signed certificates.
-Default value: false
---ebg-profile | --ebg-p (string)
--endevor-profile | --endevor-p (string)
--base-profile | --base-p (string)
--password | --pass | --pw (string)
--token-type | --tt (string)
--token-value | --tv (string)
--cert-file (local file path)
--cert-key-file (local file path)
Create the Endevor connection 'MY-CONNECTION' using the default EBG and Endevor profile:
-zowe endevor-bridge-for-git endevor-connection create MY-CONNECTION --endevor-instance INSTANCE Create the Endevor connection 'MY-CONNECTION' using the default EBG profile:
-zowe endevor-bridge-for-git endevor-connection create MY-CONNECTION --endevor-protocol http --endevor-host endevor-host --endevor-port 12345 --endevor-instance INSTANCE Create the Endevor connection 'MY-CONNECTION' using the default Endevor profile:
-zowe endevor-bridge-for-git endevor-connection create MY-CONNECTION --protocol http --host bridge-host --port 8080 --endevor-instance INSTANCE Delete existing Endevor connection defined to CA Endevor Bridge for Git.
-zowe endevor-bridge-for-git endevor-connection delete <connection> [options]
-connection (string)
--protocol | --prot (string)
The Endevor Bridge for Git SCM protocol.
-Default value: http
-Allowed values: http, https
---host | -H (string)
--port | -P (number)
--user | -u (string)
--token | -t (string)
--reject-unauthorized | --ru (boolean)
Reject self-signed certificates.
-Default value: false
---ebg-profile | --ebg-p (string)
--base-profile | --base-p (string)
--password | --pass | --pw (string)
--token-type | --tt (string)
--token-value | --tv (string)
--cert-file (local file path)
--cert-key-file (local file path)
Delete the Endevor connection using the default EBG profile:
-zowe endevor-bridge-for-git endevor-connection delete MY-CONNECTION Delete the Endevor connection without an EBG profile:
-zowe endevor-bridge-for-git endevor-connection delete MY-CONNECTION --protocol http --host my-host --port 8080 --user my-git-username --token 1234567890 Rename existing Endevor connection defined to CA Endevor Bridge for Git.
-zowe endevor-bridge-for-git endevor-connection rename <connection> <new-connection> [options]
-connection (string)
new-connection (string)
--protocol | --prot (string)
The Endevor Bridge for Git SCM protocol.
-Default value: http
-Allowed values: http, https
---host | -H (string)
--port | -P (number)
--user | -u (string)
--token | -t (string)
--reject-unauthorized | --ru (boolean)
Reject self-signed certificates.
-Default value: false
---ebg-profile | --ebg-p (string)
--base-profile | --base-p (string)
--password | --pass | --pw (string)
--token-type | --tt (string)
--token-value | --tv (string)
--cert-file (local file path)
--cert-key-file (local file path)
Rename the Endevor connection using the default EBG profile:
-zowe endevor-bridge-for-git endevor-connection rename MY-CONNECTION NEW-NAME Rename the Endevor connection without an EBG profile:
-zowe endevor-bridge-for-git endevor-connection rename MY-CONNECTION NEW-NAME --protocol http --host my-host --port 8080 --user my-git-username --token 1234567890 Update your Endevor credentials for the Endevor connection.
-zowe endevor-bridge-for-git endevor-connection update-credentials <connection> [options]
-connection (string)
--endevor-user | --endevoru (string)
--endevor-password | --endevorpass | --endevorpw (string)
--protocol | --prot (string)
The Endevor Bridge for Git SCM protocol.
-Default value: http
-Allowed values: http, https
---host | -H (string)
--port | -P (number)
--user | -u (string)
--token | -t (string)
--reject-unauthorized | --ru (boolean)
Reject self-signed certificates.
-Default value: false
---ebg-profile | --ebg-p (string)
--endevor-profile | --endevor-p (string)
--base-profile | --base-p (string)
--password | --pass | --pw (string)
--token-type | --tt (string)
--token-value | --tv (string)
--cert-file (local file path)
--cert-key-file (local file path)
Update the Endevor credentials for the Endevor connection MY-CONNECTION using the default EBG and Endevor profile:
-zowe endevor-bridge-for-git endevor-connection update-credentials MY-CONNECTION Update the Endevor credentials for the Endevor connection MY-CONNECTION using the default EBG profile but not using an Endevor profile:
-zowe endevor-bridge-for-git endevor-connection update-credentials MY-CONNECTION --endevor-user my-user --endevor-password my-password Manage your Endevor credentials stored in CA Endevor Bridge for Git. [Deprecated]
+Manage your Endevor credentials stored in CA Endevor Bridge for Git.
zowe endevor-bridge-for-git endevor-credentials <command>
Where <command> is one of the following:
diff --git a/static/v1.28.x/web_help/docs/zowe_endevor-bridge-for-git_mapping_add-element.html b/static/v1.28.x/web_help/docs/zowe_endevor-bridge-for-git_mapping_add-element.html index 898a7d68ce..3ce57b8bcc 100644 --- a/static/v1.28.x/web_help/docs/zowe_endevor-bridge-for-git_mapping_add-element.html +++ b/static/v1.28.x/web_help/docs/zowe_endevor-bridge-for-git_mapping_add-element.html @@ -28,13 +28,13 @@--element-name | --name (string)
--elementName | --name (string)
--element-type | --type (string)
--elementType | --type (string)
--connection (string)
--endevor-instance | --endevori (string)
--system-alias (string)
--subsystem-alias (string)
--endevor-environment | --endevorenv (string)
--type-filter (string)
--json-file | --json (local file path)
Create the Git-Endevor mapping 'MY-CONTEXT / MY-MAPPING' using the default EBG and Endevor profile:
-zowe endevor-bridge-for-git mapping create --remote-url https://git-server-enterprise.com/my-context/my-mapping.git --connection endevor-connection-name --endevor-environment ENVNAME --endevor-system SYSNAME --endevor-subsystem SUBNAME Create the read-only Git-Endevor mapping 'MY-CONTEXT / MY-MAPPING' using the default EBG and Endevor profile:
zowe endevor-bridge-for-git mapping create --remote-url https://git-server-enterprise.com/my-context/my-mapping.git --endevor-instance INSTANCE --endevor-environment ENVNAME --endevor-system SYSNAME --endevor-subsystem SUBNAME --read-only --endevor-stage-number 2 Manage the processor groups of your mapping
-zowe endevor-bridge-for-git processor-group <command>
-Where <command> is one of the following:
-List processor groups used by a type in your mapping
-zowe endevor-bridge-for-git processor-group list [options]
---work-dir | --wd (string)
The local working directory of your Git-Endevor mapping.
-Default value: ./
---endevor-system | --endevorsys (string)
--endevor-subsystem | --endevorsub (string)
--type | --type (string)
--response-format-filter | --rff (array)
--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)
List all the processor groups used by a type in your mapping for a single system/subsystem mapping.:
-zowe endevor-bridge-for-git processor-group list --type TYPE List all the processor groups used by a type in your mapping for a multi system/subsystem mapping.:
-zowe endevor-bridge-for-git processor-group list --endevorsys SYSTEM --endevorsub SUBSYSTEM --type TYPE Update the processor group of all changed elements of a specific type
-zowe endevor-bridge-for-git processor-group update-all <processor-group> [options]
-processor-group (string)
--work-dir | --wd (string)
The local working directory of your Git-Endevor mapping.
-Default value: ./
---endevor-system | --endevorsys (string)
--endevor-subsystem | --endevorsub (string)
--type | --type (string)
--response-format-filter | --rff (array)
--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)
Update the processor group of a specific element in your local repository
-zowe endevor-bridge-for-git processor-group update <element> <processor-group> [options]
-element (string)
processor-group (string)
--work-dir | --wd (string)
The local working directory of your Git-Endevor mapping.
-Default value: ./
---endevor-system | --endevorsys (string)
--endevor-subsystem | --endevorsub (string)
--type | --type (string)
--response-format-filter | --rff (array)
--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)
CA File Master Plus command line interface is a file management and data manipulation tool.
+
File Master Plus command line interface is a file management and data manipulation tool.
It speeds up file creation and manipulates virtual storage access method (VSAM), sequential and partitioned data sets.
It also supports symbolic access to data via layouts and data manipulation like selection of records in data sets.
Copy from a data set to another data set.
-If the <to> data set does not exist, CA File Master Plus automatically creates a new data set using the attributes of <from> data set.
-It supports all data set types that are supported by CA File Master Plus.
zowe file-master-plus copy data-set <from> <to> [options]
--static-selection-criteria | --ssc (string)
--dynamic-selection-criteria | --dsc (string)
--host | -H (string)
--port | -P (number)
--protocol | -o (string)
Specifies CA File Master Plus REST API protocol.
+Specifies File Master Plus REST API protocol.
Default value: https
Allowed values: http, https
--host | -H (string)
--port | -P (number)
--protocol | -o (string)
Specifies CA File Master Plus REST API protocol.
+Specifies File Master Plus REST API protocol.
Default value: https
Allowed values: http, https
--host | -H (string)
--port | -P (number)
--protocol | -o (string)
Specifies CA File Master Plus REST API protocol.
+Specifies File Master Plus REST API protocol.
Default value: https
Allowed values: http, https
--host | -H (string)
--port | -P (number)
--protocol | -o (string)
Specifies CA File Master Plus REST API protocol.
+Specifies File Master Plus REST API protocol.
Default value: https
Allowed values: http, https
--host | -H (string)
--port | -P (number)
--protocol | -o (string)
Specifies CA File Master Plus REST API protocol.
+Specifies File Master Plus REST API protocol.
Default value: https
Allowed values: http, https
--host | -H (string)
--port | -P (number)
--protocol | -o (string)
Specifies CA File Master Plus REST API protocol.
+Specifies File Master Plus REST API protocol.
Default value: https
Allowed values: http, https
--host | -H (string)
--port | -P (number)
--protocol | -o (string)
Specifies CA File Master Plus REST API protocol.
+Specifies File Master Plus REST API protocol.
Default value: https
Allowed values: http, https
--host | -H (string)
--port | -P (number)
--protocol | -o (string)
Specifies CA File Master Plus REST API protocol.
+Specifies File Master Plus REST API protocol.
Default value: https
Allowed values: http, https
--host | -H (string)
--port | -P (number)
--protocol | -o (string)
Specifies CA File Master Plus REST API protocol.
+Specifies File Master Plus REST API protocol.
Default value: https
Allowed values: http, https
--host | -H (string)
--port | -P (number)
--protocol | -o (string)
Specifies CA File Master Plus REST API protocol.
+Specifies File Master Plus REST API protocol.
Default value: https
Allowed values: http, https
--host | -H (string)
--port | -P (number)
--protocol | -o (string)
Specifies CA File Master Plus REST API protocol.
+Specifies File Master Plus REST API protocol.
Default value: https
Allowed values: http, https
Permanently deletes a data set.
-It supports all data set types that are supported by CA File Master Plus.
zowe file-master-plus delete data-set <name> [options]
--host | -H (string)
--port | -P (number)
--protocol | -o (string)
Specifies CA File Master Plus REST API protocol.
+Specifies File Master Plus REST API protocol.
Default value: https
Allowed values: http, https
Populate the specified data set with records.
-It supports all data set types that are supported by CA File Master Plus.
zowe file-master-plus populate <command>
Where <command> is one of the following:
diff --git a/static/v1.28.x/web_help/docs/zowe_file-master-plus_populate_data-set.html b/static/v1.28.x/web_help/docs/zowe_file-master-plus_populate_data-set.html index d05e66a4fb..1d2871c1f9 100644 --- a/static/v1.28.x/web_help/docs/zowe_file-master-plus_populate_data-set.html +++ b/static/v1.28.x/web_help/docs/zowe_file-master-plus_populate_data-set.html @@ -60,13 +60,13 @@--host | -H (string)
--port | -P (number)
--protocol | -o (string)
Specifies CA File Master Plus REST API protocol.
+Specifies File Master Plus REST API protocol.
Default value: https
Allowed values: http, https
Rename a data set.
-It supports all data set types that are supported by CA File Master Plus.
zowe file-master-plus rename data-set <old> <new> [options]
--host | -H (string)
--port | -P (number)
--protocol | -o (string)
Specifies CA File Master Plus REST API protocol.
+Specifies File Master Plus REST API protocol.
Default value: https
Allowed values: http, https
CA IDMS plug-in for listing real-time monitor statistics and information, viewing DC log messages, and issuing DCMT and DCUF commands
+IDMS plug-in for listing real-time monitor statistics and information, viewing DC log messages, and issuing DCMT and DCUF commands
zowe idms <group>
Where <group> is one of the following:
--datasource | -d (string)
--datasource | -d (string)
--datasource | -d (string)
--datasource | -d (string)
--datasource | -d (string)
Execute a DCMT TEST command. Obtains diagnostic information for Broadcom technical support personnel.
-The DCMT TEST command is used for debugging and diagnostic purposes only. Use it only when told to do so by CA IDMS technical support personnel. It is enabled only if certain CSA test flags are turned on
+The DCMT TEST command is used for debugging and diagnostic purposes only. Use it only when told to do so by IDMS technical support personnel. It is enabled only if certain CSA test flags are turned on
zowe idms issue dcmt-test [options]
--datasource | -d (string)
Issues a 'dcmt test debug options' command, with 'debug options' being the options provided by CA IDMS technical support:
+Issues a 'dcmt test debug options' command, with 'debug options' being the options provided by IDMS technical support:
zowe idms issue dcmt-test --args "debug options" --datasource | -d (string)
--datasource | -d (string)
--datasource | -d (string)
Lists real-time monitor statistics information, log messages, active user tasks, and transaction details
+Lists available datasources, real-time monitor statistics information, log messages, active user tasks, and transaction details
zowe idms list <command>
Where <command> is one of the following:
List Endevor connections used by CA Endevor Bridge for Git.
+Lists data sources defined to the IDMS REST API
zowe endevor-bridge-for-git endevor-connection list [options]
-zowe idms list datasources [options]
+--protocol | --prot (string)
The Endevor Bridge for Git SCM protocol.
-Default value: http
-Allowed values: http, https
---host | -H (string)
--port | -P (number)
--user | -u (string)
--token | -t (string)
--password | --pass | --pw (string)
--reject-unauthorized | --ru (boolean)
Reject self-signed certificates.
-Default value: false
+Reject self-signed certificates
+Default value: true
--base-path | --bp (string)
--ebg-profile | --ebg-p (string)
--datasourcename | --dsn (string)
--base-profile | --base-p (string)
--all | -a (boolean)
--password | --pass | --pw (string)
--idms-profile | --idms-p (string)
--base-profile | --base-p (string)
--token-type | --tt (string)
List all the Endevor connections using the default EBG profile:
+Lists all data sources defined to the IDMS Rest API:
zowe endevor-bridge-for-git endevor-connection list zowe idms list datasources --all List all the Endevor connections without an EBG profile:
+Lists a single IDMS data source identified by the data source name:
zowe endevor-bridge-for-git endevor-connection list --protocol http --host my-host --port 8080 --user my-git-username --token 1234567890 zowe idms list datasources --dsn SYSDEMO --datasource | -d (string)
--datasourcename | --dsn (string)
--datasourcename | --dsn (string)
The CA MAT Detect plug-in for Zowe CLI enables you to detect performance issues and access performance data supplied by the Performance Management Assistant component (PMA) of CA Mainframe Application Tuner.
+The MAT Detect plug-in for Zowe CLI enables you to detect performance issues and access performance data supplied by the Performance Management Assistant component (PMA) of Mainframe Application Tuner.
zowe mat-pma-util <group>
Where <group> is one of the following:
diff --git a/static/v1.28.x/web_help/docs/zowe_mat.html b/static/v1.28.x/web_help/docs/zowe_mat.html index dddcd126d7..a70c076cbc 100644 --- a/static/v1.28.x/web_help/docs/zowe_mat.html +++ b/static/v1.28.x/web_help/docs/zowe_mat.html @@ -7,7 +7,7 @@The CA MAT Analyze plug-in for ZOWE CLI enables you to manage monitor profiles and get the measurement analysis data using CA Mainframe Application Tuner (CA MAT)
+The MAT Analyze plug-in for ZOWE CLI enables you to manage monitor profiles and get the measurement analysis data using Mainframe Application Tuner (MAT)
zowe mat <group>
Where <group> is one of the following:
diff --git a/static/v1.28.x/web_help/docs/zowe_mat_monitor.html b/static/v1.28.x/web_help/docs/zowe_mat_monitor.html index 9d3fc5d7f6..c889ae9fc3 100644 --- a/static/v1.28.x/web_help/docs/zowe_mat_monitor.html +++ b/static/v1.28.x/web_help/docs/zowe_mat_monitor.html @@ -7,7 +7,7 @@Get monitor history and measurement analysis data from CA MAT.
+Get monitor history and measurement analysis data from MAT.
zowe mat monitor <command|group>
Where <command|group> is one of the following:
diff --git a/static/v1.28.x/web_help/docs/zowe_mat_monitor_codeview_histogram.html b/static/v1.28.x/web_help/docs/zowe_mat_monitor_codeview_histogram.html index da4f8b80d7..b4a82bd4d4 100644 --- a/static/v1.28.x/web_help/docs/zowe_mat_monitor_codeview_histogram.html +++ b/static/v1.28.x/web_help/docs/zowe_mat_monitor_codeview_histogram.html @@ -39,19 +39,19 @@--group (string)
--top (number)
--listing (boolean)
--top (number)
Create, invoke, and list CA MAT monitor profiles.
+Create, invoke, and list MAT monitor profiles.
zowe mat profile <command>
Where <command> is one of the following:
Create a CA MAT monitor profile.
+Create a MAT monitor profile.
zowe mat profile create [options]
--profile (string)
--jobname (string)
--mondsn (string)
--stepname (string)
--procstep (string)
--program (string)
--tasklib (string)
--samplecnt (string)
Specifies the number of observations requested. Values: maximum 6 characters, numbers between 10 and 999999.
+Specifies the number of observations requested. Values: maximum 6 characters, numbers between 10 and 999999.
Default value: 6000
--succnt (string)
Specifies the maximum number of monitors to run per job execution. Values: maximum 4 characters, numbers between 1 and 9999.
+Specifies the maximum number of monitors to run per job execution. Values: maximum 4 characters, numbers between 1 and 9999.
Default value: 1
--reccnt (string)
Specifies the number of times this job step will be monitored. Values: maximum 4 characters, numbers between 1 and 9999.
+Specifies the number of times this job step will be monitored. Values: maximum 4 characters, numbers between 1 and 9999.
Default value: 1
--sampdelay (string)
Specifies the delay monitoring time in seconds after the step start. Values: maximum 4 characters, numbers between 0 and 9999.
+Specifies the delay monitoring time in seconds after the step start. Values: maximum 4 characters, numbers between 0 and 9999.
Default value: 0
--userexit1 (string)
--userexit2 (string)
--userexit3 (string)
--inctask (string)
--exctask (string)
--tran (string)
--term (string)
--userid (string)
--db2ctsql (string)
Indicates whether the Collect SQL from Catalog option is enabled for DB2 SQL statements.If you specify db2expl=yes, then db2ctsql must be also set to yes.
+Indicates whether the Collect SQL from Catalog option is enabled for DB2 SQL statements.If you specify db2expl=yes, then db2ctsql must be also set to yes.
Default value: no
Allowed values: yes, no
--db2hvloc (string)
Indicates whether the Requestor Location option is enabled for DB2 measurements.
+Indicates whether the Requestor Location option is enabled for DB2 measurements.
Default value: no
Allowed values: yes, no
--db2hvcor (string)
Indicates whether the Correlation ID option for SQL statements is enabled for DB2 measurements.
+Indicates whether the Correlation ID option for SQL statements is enabled for DB2 measurements.
Default value: no
Allowed values: yes, no
--db2hviid (string)
Indicates whether the Operator ID option for SQL statements is enabled for DB2 measurements.
+Indicates whether the Operator ID option for SQL statements is enabled for DB2 measurements.
Default value: no
Allowed values: yes, no
--db2hvthd (string)
Indicates whether the Thread Address option for SQL statements is enabled for DB2 measurements.
+Indicates whether the Thread Address option for SQL statements is enabled for DB2 measurements.
Default value: no
Allowed values: yes, no
--schedule (string)
Invoke a CA MAT monitor profile to start measurement.
+Invoke a MAT monitor profile to start measurement.
zowe mat profile invoke [options]
--profile (string)
--mondsn (string)
--listing (boolean)
Invoke the PROFILE1 monitor profile to measure job JOB1 that runs on the AA31 system:
+Invoke the PROFILE1 monitor profile to measure job JOB1 that runs on the AA31 system :
zowe mat profile invoke --profile PROFILE1 --jobname JOB1 --targsys AA31 Configuration profile for CA Spool, where you specify information about your CA Spool instance
+Configuration profile for Spool, where you specify information about your Spool instance
zowe profiles create caspool-profile <profileName> [options]
--account | -a (string)
--spoolhlq | --hlq (string)
--subsys | --sub (string)
CA Spool subsystem name.
+Spool subsystem name.
Default value: ESF
--outds | --out (string)
Create a profile for CA Spool named 'myProfile' with TSO account information '1234567890', CA Spool installation high level qualifier of 'CASPOOL.HLQ', subsystem name 'ESF1', output response data set 'OUTPUT.RESPONSE.DS', and data set 'USER.CLIST', containing ESFZOWE REXX exec:
+Create a profile for Spool named 'myProfile' with TSO account information '1234567890', Spool installation high level qualifier of 'CASPOOL.HLQ', subsystem name 'ESF1', output response data set 'OUTPUT.RESPONSE.DS', and data set 'USER.CLIST', containing ESFZOWE REXX exec:
zowe profiles create caspool-profile myProfile --account 1234567890 --spoolhlq CASPOOL.HLQ --subsys ESF1 --outds OUTPUT.RESPONSE.DS --clist USER.CLIST Configuration profile for CA View
+Configuration profile for View
zowe profiles create caview-profile <profileName> [options]
--protocol (string)
Protocol of the target CA View REST API instance.
+Protocol of the target View REST API instance.
Default value: https
Allowed values: http, https
--port (number)
--hostname (string)
--port | -P (number)
Port of the target CA View REST API instance.
+Port of the target View REST API instance.
Default value: 443
--base-path (string)
Context name of the target CA View REST API instance.
+Context name of the target View REST API instance.
Default value: web-viewer
--overwrite | --ow (boolean)
--disable-defaults | --dd (boolean)
--username (string)
--hostname (string)
--password | --pass | --pw (string)
--username (string)
--overwrite | --ow (boolean)
--password (string)
--disable-defaults | --dd (boolean)
Create a profile for CA View® Plug-in for Zowe CLI named 'myProfile' to connect to 'mf.company.org' over HTTP on port 80 using the 'johndoe' account.:
+Create a profile for View™ Plug-in for Zowe CLI named 'myProfile' to connect to 'mf.company.org' over HTTP on port 80 using the 'johndoe' account.:
zowe profiles create caview-profile myProfile --hostname mf.company.org --protocol http --port 80 --username johndoe --password secret The dbm-db2 profile is a named set of DBM Data Service parameters that are implicitly used with the zowe dbm-db2 commands. The profile includes server connection, z/OS execution, and user-dependent details.
+zowe profiles create dbm-db2-profile <profileName> [options]
+profileName (string)
--job-cards | --jc (string)
Specifies a newline delimited string of z/OS JCL JOB statements.
+Default value: //DB2DVOPS JOB (<nnn>),'DB2 PROVISIONING',NOTIFY=&SYSUID,\n// CLASS=A,MSGCLASS=X,MSGLEVEL=(1,1),\n// REGION=0M,TIME=NOLIMIT
+--work-dataset-prefix | --wdp (string)
Specifies the prefix that is used as the high level qualifier in z/OS work data set names.
+Default value: <hlq>
+--authid | -a (string)
Specifies the primary Db2 authorization ID (user ID) that is used to establish a connection between Db2 and a process.
+Default value: <authid>
+--sqlid | -s (string)
Specifies the authorization ID that is used as the value in generated SET CURRENT SQLID statements most of the time.
+Default value: <sqlid>
+--termination-character | --tc (string)
Specifies the SQL termination character that you want to use to terminate object DDL for triggers, XML indexes, functions, and procedures that contain embedded semicolon-terminated SQL statements.
+You cannot use a comma, an underscore, a single quote, double quotes, left parentheses, or right parentheses for this value.
+--overwrite-output-files | --oof (boolean)
Specifies whether to overwrite output files when they already exist.
+Default value: false
+--host | -H (string)
Specifies the DBM Data Service REST API server host name or TCP/IP address to use.
+Default value: <host>
+--port | -P (number)
Specifies the DBM Data Service REST API server TCP/IP port number.
+Default value: 7300
+--user | -u (string)
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.
+Default value: <user>
+--password | --pass | --pw (string)
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.
+Default value: <password>
+--reject-unauthorized | --ru (boolean)
Determines whether the dbm-db2 command is accepted or rejected when a self-signed certificate is returned by the DBM Data Service.
+Default value: true
+--protocol (string)
Specifies the communication protocol to use between the zowe dbm-db2 client and the DBM Data Service.
+Default value: https
+Allowed values: http, https
--environment-list | --el (string)
Specifies a string of one or more paired values consisting of a Db2 subsystem ID and a DBM Data Service environment pair. The paired entry identifies the DBM Data Service environment to use for a subsystem that is accessible through multiple DBM Data Service environments.
+Format:
+<ssid1>:<env1>, <ssid2>:<env2>, …
+<ssid> is the subsystem ID. <env> is an entry that is configured in the DBM Data Service environments.yaml file. 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.
+Example: ssid:prod@host1.net:7300,ssid2:test@host2.net:7300
+--overwrite | --ow (boolean)
--disable-defaults | --dd (boolean)
Create a dbm-db2 profile named profile_name1 and default values for all the dbm-db2-profile options:
+zowe profiles create dbm-db2-profile profile_name1 Create a dbm-db2 profile named dbm123 that connects to the DBM Data Service at host dbm123 and port 1443 as user db2user and password myp4ss:
+zowe profiles create dbm-db2-profile dbm123 --host dbm123 --port 1443 --user db2user --password myp4ss Create a dbm-db2 profile named dbm124 that connects to the DBM Data Service at host dbm124 and the default port as user db2user and password myp4ss, and allow self-signed certificates:
+zowe profiles create dbm-db2-profile dbm124 --host dbm124 --user db2user --password myp4ss --reject-unauthorized false Create a dbm-db2 profile named dbm125 that connects to the DBM Data Service at host dbm125 and port 1443 and requires a user and password to be specified on every dbm-db2 command. DBM Data Service access to Db2 subsystems SUBA and SUBB uses prod@host1.com:322 and test@host2.com:522, respectively:
+zowe profiles create dbm-db2-profile dbm125 --host dbm125 --port 1443 --el “SUBA:prod@host1.com:322,SUBB:test@host2.net:522” The CA Endevor SCM element location, where you specify your working environment, system and subsystem
+The Endevor element location, where you specify your working environment, system and subsystem
zowe profiles create endevor-location-profile <profileName> [options]
--environment | --env (string)
The CA Endevor SCM environment where your project resides
+The Endevor environment where your project resides
Default value: DEV
--system | --sys (string)
--subsystem | --sub (string)
--type | --typ (string)
--stage-number | --sn (string)
The CA Endevor SCM stage where your project resides
+The Endevor stage where your project resides
Allowed values: 1, 2
--comment | --com (string)
--ccid | --cci (string)
--maxrc (number)
The return code of CA Endevor SCM that defines a failed action
-Default value: 8
---override-signout | --os (boolean)
Always override element signout, without having to specify the override signout option on each command
-Default value: false
+The return code of Endevor that defines a failed action
+Default value: 12
Create a location profile called 'ndvrLoc' to work at CA Endevor SCM location ENV/1/SYS/SUBSYS, with elements of type COBOL, using CA Endevor SCM web services configuration ENDEVOR:
+Create a location profile called 'ndvrLoc' to work at Endevor location ENV/1/SYS/SUBSYS, with elements of type COBOL, using Endevor web services configuration ENDEVOR:
zowe profiles create endevor-location-profile ndvrLoc --env ENV --sys SYS --sub SUBSYS --typ COBOL --sn 1 -i ENDEVOR Create a location profile called 'ndvrLoc2' to work at CA Endevor SCM location ENV/1/SYS/SUBSYS, using CCID 'CCID' and comment 'sample comment':
+Create a location profile called 'ndvrLoc2' to work at Endevor location ENV/1/SYS/SUBSYS, using CCID 'CCID' and comment 'sample comment':
zowe profiles create endevor-location-profile ndvrLoc2 --env ENV --sys SYS --sub SUBSYS --sn 1 --com 'sample comment' --cci 'CCID' CA File Master Plus profile schema.
+File Master Plus profile schema.
zowe profiles create fmp-profile <profileName> [options]
--host | -H (string)
--port | -P (number)
--protocol | -o (string)
Specifies CA File Master Plus REST API protocol.
+Specifies File Master Plus REST API protocol.
Default value: https
Allowed values: http, https
--datasource | -d (string)
CA MAT Analyze CLI profile schema.
+MAT Analyze CLI profile schema.
zowe profiles create mat-profile <profileName> [options]
--protocol | --prt (string)
Specifies the protocol defined for the CA MAT REST API server (http or https).
+Specifies the protocol defined for the MAT REST API server (http or https).
Allowed values: http, https
--hostname | --hn (string)
--zowediscoverable | --zdis (boolean)
Specifies whether you want to use Zowe API Mediation Layer to process the commands for this profile. Set '--zowediscoverable true' only if you have configured the Zowe API Mediation Layer properties in your CA MAT REST API server settings.
+Specifies whether you want to use Zowe API Mediation Layer to process the commands for this profile. Set '--zowediscoverable true' only if you have configured the Zowe API Mediation Layer properties in your MAT REST API server settings.
Allowed values: false, true
--listingDir | --ldir (string)
Create a MAT profile called 'matprofile' using your CA MAT configuration and REST API details, with the CA MAT REST API server integrated with the Zowe API Mediation Layer:
+Create a MAT profile called 'matprofile' using your MAT configuration and REST API details, with the MAT REST API server integrated with the Zowe API Mediation Layer:
zowe profiles create mat-profile matprofile --prt http --hn localhost --pt 1234 --user user --pass pass --zowediscoverable true Create a MAT profile called 'matprofile' using your CA MAT configuration and the details of the CA MAT REST API server without integration with the Zowe API Mediation Layer,and define the 'c:\listings' directory to store program listings for instant analysis from your VS Code IDE:
+Create a MAT profile called 'matprofile' using your MAT configuration and the details of the MAT REST API server without integration with the Zowe API Mediation Layer,and define the 'c:\listings' directory to store program listings for instant analysis from your VS Code IDE:
zowe profiles create mat-profile matprofile --prt http --hn localhost --pt 1234 --user user --pass pass --zowediscoverable false --listingDir 'c:\listings' CA MAT Detect CLI profile schema.
+MAT Detect CLI profile schema.
zowe profiles create pma-profile <profileName> [options]
Delete a dbm-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.
+zowe profiles delete dbm-db2-profile <profileName> [options]
+profileName (string)
--force (boolean)
Delete a dbm-db2 profile named profilename:
+zowe profiles delete dbm-db2-profile profilename Configuration profile for CA Spool, where you specify information about your CA Spool instance
+Configuration profile for Spool, where you specify information about your Spool instance
zowe profiles list caspool-profiles [options]
Configuration profile for CA View
+Configuration profile for View
zowe profiles list caview-profiles [options]
The dbm-db2 profile is a named set of DBM Data Service parameters that are implicitly used with the zowe dbm-db2 commands. The profile includes server connection, z/OS execution, and user-dependent details.
+zowe profiles list dbm-db2-profiles [options]
+--show-contents | --sc (boolean)
List profiles of type dbm-db2:
+zowe profiles list dbm-db2-profiles List profiles of type dbm-db2 and display their contents:
+zowe profiles list dbm-db2-profiles --sc The CA Endevor SCM element location, where you specify your working environment, system and subsystem
+The Endevor element location, where you specify your working environment, system and subsystem
zowe profiles list endevor-location-profiles [options]
CA File Master Plus profile schema.
+File Master Plus profile schema.
zowe profiles list fmp-profiles [options]
CA MAT Analyze CLI profile schema.
+MAT Analyze CLI profile schema.
zowe profiles list mat-profiles [options]
CA MAT Detect CLI profile schema.
+MAT Detect CLI profile schema.
zowe profiles list pma-profiles [options]
The dbm-db2 set default-profiles command allows you to set the default profiles for this command group. When a dbm-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.
+zowe profiles set-default dbm-db2-profile <profileName> [options]
+profileName (string)
Set the default profile for type dbm-db2 to the profile named 'profilename':
+zowe profiles set-default dbm-db2-profile profilename Configuration profile for CA Spool, where you specify information about your CA Spool instance
+Configuration profile for Spool, where you specify information about your Spool instance
zowe profiles update caspool-profile <profileName> [options]
--account | -a (string)
--spoolhlq | --hlq (string)
--subsys | --sub (string)
--outds | --out (string)
Update the TSO account information to '3213213210' for CA Spool profile named 'myProfile':
+Update the TSO account information to '3213213210' for Spool profile named 'myProfile':
zowe profiles update caspool-profile myProfile --account 3213213210 Update high level qualifier of the CA Spool installation to 'CASPOOL.HLQ' for CA Spool profile named 'myProfile':
+Update high level qualifier of the Spool installation to 'CASPOOL.HLQ' for Spool profile named 'myProfile':
zowe profiles update caspool-profile myProfile --spoolhlq CASPOOL.HLQ Update the CA Spool subsystem name to 'ESF2' for CA Spool profile named 'myProfile':
+Update the Spool subsystem name to 'ESF2' for Spool profile named 'myProfile':
zowe profiles update caspool-profile myProfile --subsys ESF2 Update the output response data set to 'OUTPUT.RESPONSE.DS.NEW' for CA Spool profile named 'myProfile':
+Update the output response data set to 'OUTPUT.RESPONSE.DS.NEW' for Spool profile named 'myProfile':
zowe profiles update caspool-profile myProfile --outds OUTPUT.RESPONSE.DS.NEW Update the data set containing ESFZOWE REXX exec to 'USER.CLIST' for CA Spool profile named 'myProfile':
+Update the data set containing ESFZOWE REXX exec to 'USER.CLIST' for Spool profile named 'myProfile':
zowe profiles update caspool-profile myProfile --clist USER.CLIST Configuration profile for CA View
+Configuration profile for View
zowe profiles update caview-profile <profileName> [options]
--protocol (string)
Protocol of the target CA View REST API instance.
+Protocol of the target View REST API instance.
Allowed values: http, https
--hostname (string)
--port (number)
--port | -P (number)
--base-path (string)
--username (string)
--password (string)
--password | --pass | --pw (string)
The dbm-db2 profile is a named set of DBM Data Service parameters that are implicitly used with the zowe dbm-db2 commands. The profile includes server connection, z/OS execution, and user-dependent details.
+zowe profiles update dbm-db2-profile <profileName> [options]
+profileName (string)
--job-cards | --jc (string)
--work-dataset-prefix | --wdp (string)
--authid | -a (string)
--sqlid | -s (string)
--termination-character | --tc (string)
Specifies the SQL termination character that you want to use to terminate object DDL for triggers, XML indexes, functions, and procedures that contain embedded semicolon-terminated SQL statements.
+You cannot use a comma, an underscore, a single quote, double quotes, left parentheses, or right parentheses for this value.
+--overwrite-output-files | --oof (boolean)
Specifies whether to overwrite output files when they already exist.
+Default value: false
+--host | -H (string)
--port | -P (number)
--user | -u (string)
--password | --pass | --pw (string)
--reject-unauthorized | --ru (boolean)
--protocol (string)
Specifies the communication protocol to use between the zowe dbm-db2 client and the DBM Data Service.
+Allowed values: http, https
+--environment-list | --el (string)
Specifies a string of one or more paired values consisting of a Db2 subsystem ID and a DBM Data Service environment pair. The paired entry identifies the DBM Data Service environment to use for a subsystem that is accessible through multiple DBM Data Service environments.
+Format:
+<ssid1>:<env1>, <ssid2>:<env2>, …
+<ssid> is the subsystem ID. <env> is an entry that is configured in the DBM Data Service environments.yaml file. 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.
+Example: ssid:prod@host1.net:7300,ssid2:test@host2.net:7300
+Update a dbm-db2 profile named dbm123 with a new username and password:
+zowe profiles update dbm-db2-profile dbm123 --user newuser --password newp4ss Update a dbm-db2 profile named profile_name1 with a new work data set prefix:
+zowe profiles update dbm-db2-profile profile_name1 --work-dataset-prefix NEWPREFX.DDL The CA Endevor SCM element location, where you specify your working environment, system and subsystem
+The Endevor element location, where you specify your working environment, system and subsystem
zowe profiles update endevor-location-profile <profileName> [options]
--environment | --env (string)
--system | --sys (string)
--subsystem | --sub (string)
--type | --typ (string)
--stage-number | --sn (string)
The CA Endevor SCM stage where your project resides
+The Endevor stage where your project resides
Allowed values: 1, 2
--comment | --com (string)
--ccid | --cci (string)
--maxrc (number)
--override-signout | --os (boolean)
CA File Master Plus profile schema.
+File Master Plus profile schema.
zowe profiles update fmp-profile <profileName> [options]
--host | -H (string)
--port | -P (number)
--protocol | -o (string)
Specifies CA File Master Plus REST API protocol.
+Specifies File Master Plus REST API protocol.
Allowed values: http, https
--datasource | -d (string)
CA MAT Analyze CLI profile schema.
+MAT Analyze CLI profile schema.
zowe profiles update mat-profile <profileName> [options]
--protocol | --prt (string)
Specifies the protocol defined for the CA MAT REST API server (http or https).
+Specifies the protocol defined for the MAT REST API server (http or https).
Allowed values: http, https
--hostname | --hn (string)
--zowediscoverable | --zdis (boolean)
Specifies whether you want to use Zowe API Mediation Layer to process the commands for this profile. Set '--zowediscoverable true' only if you have configured the Zowe API Mediation Layer properties in your CA MAT REST API server settings.
+Specifies whether you want to use Zowe API Mediation Layer to process the commands for this profile. Set '--zowediscoverable true' only if you have configured the Zowe API Mediation Layer properties in your MAT REST API server settings.
Allowed values: false, true
--listingDir | --ldir (string)
CA MAT Detect CLI profile schema.
+MAT Detect CLI profile schema.
zowe profiles update pma-profile <profileName> [options]
Zowe CLI plugin for CA SYSVIEW
+Zowe CLI plugin for SYSVIEW
zowe sysview <command|group>
Where <command|group> is one of the following:
Issue a CA SYSVIEW primary command and display output, including any messages
+Issue a SYSVIEW primary command and display output, including any messages
zowe sysview display <command-string> [options]
Issue a CA SYSVIEW function command and display any messages
+Issue a SYSVIEW function command and display any messages
zowe sysview execute <command-string> [options]
An example .zosattributes file:
# pattern local-encoding remote-encoding
# Don't upload the node_modules directory
+node_modules -
+# Don't upload files that start with periods
.* -
+# Upload jpg images in binary
*.jpg binary binary
# Convert CICS Node.js profiles to EBCDIC
*.profile ISO8859-1 EBCDIC
Upload all files from the "local_dir" directory to the "/a/ibmuser/my_dir" USS directory:":
+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::
+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::
+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::
+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::
+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