diff --git a/docs/appendix/zwe_server_command_reference/zwe/certificate/keyring-jcl/zwe-certificate-keyring-jcl-clean.md b/docs/appendix/zwe_server_command_reference/zwe/certificate/keyring-jcl/zwe-certificate-keyring-jcl-clean.md index 28510a658c..f22e48623a 100644 --- a/docs/appendix/zwe_server_command_reference/zwe/certificate/keyring-jcl/zwe-certificate-keyring-jcl-clean.md +++ b/docs/appendix/zwe_server_command_reference/zwe/certificate/keyring-jcl/zwe-certificate-keyring-jcl-clean.md @@ -9,6 +9,8 @@ Remove Zowe keyring. + + ### Inherited from parent command WARNING: This command is for experimental purposes and could be changed in the future releases. @@ -33,6 +35,8 @@ Full name|Alias|Type|Required|Help message --alias|-a|string|yes|Certificate alias name. --ca-alias|-ca|string|yes|Certificate authority alias name. --ignore-security-failures||boolean|no|Whether to ignore security setup job failures. + + ### Inherited from parent command Full name|Alias|Type|Required|Help message @@ -51,6 +55,8 @@ Full name|Alias|Type|Required|Help message Error code|Exit code|Error message |---|---|--- ZWEL0176E|176|Failed to clean up Zowe keyring "%s". + + ### Inherited from parent command Error code|Exit code|Error message diff --git a/docs/appendix/zwe_server_command_reference/zwe/certificate/keyring-jcl/zwe-certificate-keyring-jcl-connect.md b/docs/appendix/zwe_server_command_reference/zwe/certificate/keyring-jcl/zwe-certificate-keyring-jcl-connect.md index 4131caa32d..2161d0c3bc 100644 --- a/docs/appendix/zwe_server_command_reference/zwe/certificate/keyring-jcl/zwe-certificate-keyring-jcl-connect.md +++ b/docs/appendix/zwe_server_command_reference/zwe/certificate/keyring-jcl/zwe-certificate-keyring-jcl-connect.md @@ -9,6 +9,8 @@ Connect existing certificate to Zowe keyring. + + ### Inherited from parent command WARNING: This command is for experimental purposes and could be changed in the future releases. @@ -34,9 +36,11 @@ Full name|Alias|Type|Required|Help message --connect-user||string|yes|Certificate owner. Can be `SITE` or a user ID. --connect-label||string|yes|Certificate label to connect. --trust-zosmf||boolean|no|Whether to trust z/OSMF CA. ---zosmf-ca||string|no|Labels of z/OSMF root certificate authorities. Specify "_auto_" to let Zowe to detect automatically. This only works for RACF. +--zosmf-ca||string|no|Labels of z/OSMF root certificate authorities. Specify `_auto_` to let Zowe to detect automatically. This works for RACF and TSS. --zosmf-user||string|no|z/OSMF user name. This is used to automatically detect z/OSMF root certificate authorities. --ignore-security-failures||boolean|no|Whether to ignore security setup job failures. + + ### Inherited from parent command Full name|Alias|Type|Required|Help message @@ -55,6 +59,8 @@ Full name|Alias|Type|Required|Help message Error code|Exit code|Error message |---|---|--- ZWEL0175E|175|Failed to connect existing certificate to Zowe keyring "%s". + + ### Inherited from parent command Error code|Exit code|Error message diff --git a/docs/appendix/zwe_server_command_reference/zwe/certificate/keyring-jcl/zwe-certificate-keyring-jcl-generate.md b/docs/appendix/zwe_server_command_reference/zwe/certificate/keyring-jcl/zwe-certificate-keyring-jcl-generate.md index b8c1b529a0..fdb9ff8adc 100644 --- a/docs/appendix/zwe_server_command_reference/zwe/certificate/keyring-jcl/zwe-certificate-keyring-jcl-generate.md +++ b/docs/appendix/zwe_server_command_reference/zwe/certificate/keyring-jcl/zwe-certificate-keyring-jcl-generate.md @@ -9,6 +9,8 @@ Generate new set of certificate in Zowe keyring. + + ### Inherited from parent command WARNING: This command is for experimental purposes and could be changed in the future releases. @@ -42,9 +44,11 @@ Full name|Alias|Type|Required|Help message --validity||string|no|Validity days of certificate. --trust-cas||string|no|Labels of extra certificate authorities should be trusted, separated by comma (Maximum 2). --trust-zosmf||boolean|no|Whether to trust z/OSMF CA. ---zosmf-ca||string|no|Labels of z/OSMF root certificate authorities. Specify "_auto_" to let Zowe to detect automatically. This only works for RACF. +--zosmf-ca||string|no|Labels of z/OSMF root certificate authorities. Specify `_auto_` to let Zowe to detect automatically. This works for RACF and TSS. --zosmf-user||string|no|z/OSMF user name. This is used to automatically detect z/OSMF root certificate authorities. --ignore-security-failures||boolean|no|Whether to ignore security setup job failures. + + ### Inherited from parent command Full name|Alias|Type|Required|Help message @@ -63,6 +67,8 @@ Full name|Alias|Type|Required|Help message Error code|Exit code|Error message |---|---|--- ZWEL0174E|174|Failed to generate certificate in Zowe keyring "%s". + + ### Inherited from parent command Error code|Exit code|Error message diff --git a/docs/appendix/zwe_server_command_reference/zwe/certificate/keyring-jcl/zwe-certificate-keyring-jcl-import-ds.md b/docs/appendix/zwe_server_command_reference/zwe/certificate/keyring-jcl/zwe-certificate-keyring-jcl-import-ds.md index bd1862b76a..6a59bc1d99 100644 --- a/docs/appendix/zwe_server_command_reference/zwe/certificate/keyring-jcl/zwe-certificate-keyring-jcl-import-ds.md +++ b/docs/appendix/zwe_server_command_reference/zwe/certificate/keyring-jcl/zwe-certificate-keyring-jcl-import-ds.md @@ -9,6 +9,8 @@ Import certificate stored in MVS data set into Zowe keyring. + + ### Inherited from parent command WARNING: This command is for experimental purposes and could be changed in the future releases. @@ -33,11 +35,13 @@ Full name|Alias|Type|Required|Help message --alias|-a|string|yes|Certificate alias name. --trust-cas||string|no|Labels of extra certificate authorities should be trusted, separated by comma (Maximum 2). --trust-zosmf||boolean|no|Whether to trust z/OSMF CA. ---zosmf-ca||string|no|Labels of z/OSMF root certificate authorities. Specify "_auto_" to let Zowe to detect automatically. This only works for RACF. +--zosmf-ca||string|no|Labels of z/OSMF root certificate authorities. Specify `_auto_` to let Zowe to detect automatically. This works for RACF and TSS. --zosmf-user||string|no|z/OSMF user name. This is used to automatically detect z/OSMF root certificate authorities. --import-ds-name||string|yes|Name of the data set holds certificate to import into keyring. --import-ds-password||string|yes|Password of the data set holds certificate to import. --ignore-security-failures||boolean|no|Whether to ignore security setup job failures. + + ### Inherited from parent command Full name|Alias|Type|Required|Help message @@ -56,6 +60,8 @@ Full name|Alias|Type|Required|Help message Error code|Exit code|Error message |---|---|--- ZWEL0173E|173|Failed to import certificate to Zowe keyring "%s". + + ### Inherited from parent command Error code|Exit code|Error message diff --git a/docs/appendix/zwe_server_command_reference/zwe/certificate/keyring-jcl/zwe-certificate-keyring-jcl.md b/docs/appendix/zwe_server_command_reference/zwe/certificate/keyring-jcl/zwe-certificate-keyring-jcl.md index b02b1b8b5d..720ee07441 100644 --- a/docs/appendix/zwe_server_command_reference/zwe/certificate/keyring-jcl/zwe-certificate-keyring-jcl.md +++ b/docs/appendix/zwe_server_command_reference/zwe/certificate/keyring-jcl/zwe-certificate-keyring-jcl.md @@ -16,6 +16,8 @@ Manage z/OS Keyring with JCL. + + ### Inherited from parent command WARNING: This command is for experimental purposes and could be changed in the future releases. @@ -31,6 +33,8 @@ zwe certificate keyring-jcl connect --dataset-prefix my-dataset-prefix --jcllib ## Parameters + + ### Inherited from parent command Full name|Alias|Type|Required|Help message @@ -46,6 +50,8 @@ Full name|Alias|Type|Required|Help message ## Errors + + ### Inherited from parent command Error code|Exit code|Error message diff --git a/docs/appendix/zwe_server_command_reference/zwe/certificate/pkcs12/create/zwe-certificate-pkcs12-create-ca.md b/docs/appendix/zwe_server_command_reference/zwe/certificate/pkcs12/create/zwe-certificate-pkcs12-create-ca.md index 74dde6729a..b61d09a0f6 100644 --- a/docs/appendix/zwe_server_command_reference/zwe/certificate/pkcs12/create/zwe-certificate-pkcs12-create-ca.md +++ b/docs/appendix/zwe_server_command_reference/zwe/certificate/pkcs12/create/zwe-certificate-pkcs12-create-ca.md @@ -9,6 +9,8 @@ Create a new PKCS12 format certificate authority. + + ### Inherited from parent command WARNING: This command is for experimental purposes and could be changed in the future releases. @@ -34,6 +36,8 @@ Full name|Alias|Type|Required|Help message --state||string|no|State of certificate authority. --country||string|no|Country of certificate authority. --validity||string|no|Validity days of certificate authority. + + ### Inherited from parent command Full name|Alias|Type|Required|Help message @@ -55,6 +59,8 @@ Error code|Exit code|Error message ZWEL0300W||%s already exists. This %s will be overwritten during configuration. ZWEL0158E|158|%s already exists. ZWEL0168E|168|Failed to create certificate authority %s. + + ### Inherited from parent command Error code|Exit code|Error message diff --git a/docs/appendix/zwe_server_command_reference/zwe/certificate/pkcs12/create/zwe-certificate-pkcs12-create-cert.md b/docs/appendix/zwe_server_command_reference/zwe/certificate/pkcs12/create/zwe-certificate-pkcs12-create-cert.md index 2f489ec7c9..9a3619d3d6 100644 --- a/docs/appendix/zwe_server_command_reference/zwe/certificate/pkcs12/create/zwe-certificate-pkcs12-create-cert.md +++ b/docs/appendix/zwe_server_command_reference/zwe/certificate/pkcs12/create/zwe-certificate-pkcs12-create-cert.md @@ -9,6 +9,8 @@ Create a new PKCS12 format certificate. + + ### Inherited from parent command WARNING: This command is for experimental purposes and could be changed in the future releases. @@ -40,6 +42,8 @@ Full name|Alias|Type|Required|Help message --validity||string|no|Validity days of certificate. --key-usage||string|no|Key usage of certificate. --extended-key-usage||string|no|Extended key usage of certificate. + + ### Inherited from parent command Full name|Alias|Type|Required|Help message @@ -61,6 +65,8 @@ Error code|Exit code|Error message ZWEL0300W||%s already exists. This %s will be overwritten during configuration. ZWEL0158E|158|%s already exists. ZWEL0169E|169|Failed to create certificate "%s". + + ### Inherited from parent command Error code|Exit code|Error message diff --git a/docs/appendix/zwe_server_command_reference/zwe/certificate/pkcs12/create/zwe-certificate-pkcs12-create.md b/docs/appendix/zwe_server_command_reference/zwe/certificate/pkcs12/create/zwe-certificate-pkcs12-create.md index f9aa87e74b..72082ec264 100644 --- a/docs/appendix/zwe_server_command_reference/zwe/certificate/pkcs12/create/zwe-certificate-pkcs12-create.md +++ b/docs/appendix/zwe_server_command_reference/zwe/certificate/pkcs12/create/zwe-certificate-pkcs12-create.md @@ -9,6 +9,8 @@ * [ca](./zwe-certificate-pkcs12-create-ca.md) * [cert](./zwe-certificate-pkcs12-create-cert.md) + + ### Inherited from parent command WARNING: This command is for experimental purposes and could be changed in the future releases. @@ -27,6 +29,8 @@ zwe certificate pkcs12 create ca -d /path/to/my/keystore/dir -a ca-alias -p ca-k Full name|Alias|Type|Required|Help message |---|---|---|---|--- --keystore-dir|-d|string|yes|Keystore directory. + + ### Inherited from parent command Full name|Alias|Type|Required|Help message @@ -42,6 +46,8 @@ Full name|Alias|Type|Required|Help message ## Errors + + ### Inherited from parent command Error code|Exit code|Error message diff --git a/docs/appendix/zwe_server_command_reference/zwe/certificate/pkcs12/zwe-certificate-pkcs12-export.md b/docs/appendix/zwe_server_command_reference/zwe/certificate/pkcs12/zwe-certificate-pkcs12-export.md index 8506a3e823..c7116da49a 100644 --- a/docs/appendix/zwe_server_command_reference/zwe/certificate/pkcs12/zwe-certificate-pkcs12-export.md +++ b/docs/appendix/zwe_server_command_reference/zwe/certificate/pkcs12/zwe-certificate-pkcs12-export.md @@ -9,6 +9,8 @@ Export PKCS12 keystore as PEM files. + + ### Inherited from parent command WARNING: This command is for experimental purposes and could be changed in the future releases. @@ -27,6 +29,8 @@ Full name|Alias|Type|Required|Help message --keystore|-f|string|yes|PKCS12 keystore file name. --password|-p|string|yes|Password of the certificate keystore. --private-keys||string|no|Private keys should also be exported. + + ### Inherited from parent command Full name|Alias|Type|Required|Help message @@ -45,6 +49,8 @@ Full name|Alias|Type|Required|Help message Error code|Exit code|Error message |---|---|--- ZWEL0178E|178|Failed to export PKCS12 keystore %s. + + ### Inherited from parent command Error code|Exit code|Error message diff --git a/docs/appendix/zwe_server_command_reference/zwe/certificate/pkcs12/zwe-certificate-pkcs12-import.md b/docs/appendix/zwe_server_command_reference/zwe/certificate/pkcs12/zwe-certificate-pkcs12-import.md index f5d6a99e3d..09ae8461ce 100644 --- a/docs/appendix/zwe_server_command_reference/zwe/certificate/pkcs12/zwe-certificate-pkcs12-import.md +++ b/docs/appendix/zwe_server_command_reference/zwe/certificate/pkcs12/zwe-certificate-pkcs12-import.md @@ -9,6 +9,8 @@ Import certificate and/or certificate authorities into PKCS12 keystore. + + ### Inherited from parent command WARNING: This command is for experimental purposes and could be changed in the future releases. @@ -31,6 +33,8 @@ Full name|Alias|Type|Required|Help message --source-password|-sp|string|no|Password of the source PKCS12 keystore. --source-alias|-sa|string|no|Private keys should also be exported. --trust-cas||string|no|PEM files of extra certificate authorities should be trusted, separated by comma. + + ### Inherited from parent command Full name|Alias|Type|Required|Help message @@ -49,6 +53,8 @@ Full name|Alias|Type|Required|Help message Error code|Exit code|Error message |---|---|--- ZWEL0179E|179|Failed to import certificate (authorities) into keystore %s. + + ### Inherited from parent command Error code|Exit code|Error message diff --git a/docs/appendix/zwe_server_command_reference/zwe/certificate/pkcs12/zwe-certificate-pkcs12-lock.md b/docs/appendix/zwe_server_command_reference/zwe/certificate/pkcs12/zwe-certificate-pkcs12-lock.md index de47dd53b2..beca115498 100644 --- a/docs/appendix/zwe_server_command_reference/zwe/certificate/pkcs12/zwe-certificate-pkcs12-lock.md +++ b/docs/appendix/zwe_server_command_reference/zwe/certificate/pkcs12/zwe-certificate-pkcs12-lock.md @@ -29,6 +29,8 @@ Full name|Alias|Type|Required|Help message --user||string|yes|Owner of the keystore directory. --group||string|yes|Group of the keystore directory. --group-permission||string|no|Group permission. Can be `` for no permission, or `read`, `write`. + + ### Inherited from parent command Full name|Alias|Type|Required|Help message @@ -47,6 +49,8 @@ Full name|Alias|Type|Required|Help message Error code|Exit code|Error message |---|---|--- ZWEL0177E|177|Failed to lock keystore directory %s. + + ### Inherited from parent command Error code|Exit code|Error message @@ -85,4 +89,4 @@ ZWEL0200E||Failed to copy USS file %s to MVS data set %s. ZWEL0201E||File %s does not exist. ZWEL0202E||Unable to find samplib key for %s. ZWEL0203E||Env value in key-value pair %s has not been defined. -ZWEL0316E||Command requires zowe.useConfigmgr=true to use. +ZWEL0316E||Command requires zowe.useConfigmgr=true to use. \ No newline at end of file diff --git a/docs/appendix/zwe_server_command_reference/zwe/certificate/pkcs12/zwe-certificate-pkcs12-trust-service.md b/docs/appendix/zwe_server_command_reference/zwe/certificate/pkcs12/zwe-certificate-pkcs12-trust-service.md index 682a3f5d60..217d54fd2e 100644 --- a/docs/appendix/zwe_server_command_reference/zwe/certificate/pkcs12/zwe-certificate-pkcs12-trust-service.md +++ b/docs/appendix/zwe_server_command_reference/zwe/certificate/pkcs12/zwe-certificate-pkcs12-trust-service.md @@ -12,6 +12,8 @@ into truststore. NOTE: the service must be online and accessible. + + ### Inherited from parent command WARNING: This command is for experimental purposes and could be changed in the future releases. @@ -34,6 +36,8 @@ Full name|Alias|Type|Required|Help message --host||string|yes|Host name of the service. --port||string|yes|Port of the service. --alias|-a|string|yes|Certificate alias name for the imported the certificate. + + ### Inherited from parent command Full name|Alias|Type|Required|Help message @@ -53,6 +57,8 @@ Error code|Exit code|Error message |---|---|--- ZWEL0300W||%s already exists. This %s will be overwritten during configuration. ZWEL0170E|170|Failed to trust service "%s". + + ### Inherited from parent command Error code|Exit code|Error message diff --git a/docs/appendix/zwe_server_command_reference/zwe/certificate/pkcs12/zwe-certificate-pkcs12.md b/docs/appendix/zwe_server_command_reference/zwe/certificate/pkcs12/zwe-certificate-pkcs12.md index ba0f8705ad..fa1bca4995 100644 --- a/docs/appendix/zwe_server_command_reference/zwe/certificate/pkcs12/zwe-certificate-pkcs12.md +++ b/docs/appendix/zwe_server_command_reference/zwe/certificate/pkcs12/zwe-certificate-pkcs12.md @@ -17,6 +17,8 @@ Manage PKCS12 format keystore and truststore. + + ### Inherited from parent command WARNING: This command is for experimental purposes and could be changed in the future releases. @@ -32,6 +34,8 @@ zwe certificate pkcs12 export -f /path/to/my/keystore/file -p keystore-cert-pass ## Parameters + + ### Inherited from parent command Full name|Alias|Type|Required|Help message @@ -47,6 +51,8 @@ Full name|Alias|Type|Required|Help message ## Errors + + ### Inherited from parent command Error code|Exit code|Error message diff --git a/docs/appendix/zwe_server_command_reference/zwe/certificate/zwe-certificate-verify-service.md b/docs/appendix/zwe_server_command_reference/zwe/certificate/zwe-certificate-verify-service.md index 31d27e88bd..6d429e9447 100644 --- a/docs/appendix/zwe_server_command_reference/zwe/certificate/zwe-certificate-verify-service.md +++ b/docs/appendix/zwe_server_command_reference/zwe/certificate/zwe-certificate-verify-service.md @@ -12,6 +12,8 @@ certificate Common Name (CN) and Subject Alternate Name (SAN). NOTE: the service must be online and accessible. + + ### Inherited from parent command WARNING: This command is for experimental purposes and could be changed in the future releases. @@ -29,6 +31,8 @@ Full name|Alias|Type|Required|Help message |---|---|---|---|--- --host||string|yes|Host name of the service. --port||string|yes|Port of the service. + + ### Inherited from parent command Full name|Alias|Type|Required|Help message @@ -47,6 +51,8 @@ Full name|Alias|Type|Required|Help message Error code|Exit code|Error message |---|---|--- ZWEL0171E|171|Failed to verify certificate (CN and SAN) of service "%s". + + ### Inherited from parent command Error code|Exit code|Error message diff --git a/docs/appendix/zwe_server_command_reference/zwe/certificate/zwe-certificate.md b/docs/appendix/zwe_server_command_reference/zwe/certificate/zwe-certificate.md index c9285f68f2..59846c2a65 100644 --- a/docs/appendix/zwe_server_command_reference/zwe/certificate/zwe-certificate.md +++ b/docs/appendix/zwe_server_command_reference/zwe/certificate/zwe-certificate.md @@ -28,6 +28,8 @@ zwe certificate verify-service --host service-hostname --port service-port ## Parameters + + ### Inherited from parent command Full name|Alias|Type|Required|Help message @@ -43,6 +45,8 @@ Full name|Alias|Type|Required|Help message ## Errors + + ### Inherited from parent command Error code|Exit code|Error message diff --git a/docs/appendix/zwe_server_command_reference/zwe/components/install/zwe-components-install-extract.md b/docs/appendix/zwe_server_command_reference/zwe/components/install/zwe-components-install-extract.md index 16f4cdcfcc..659af6a4fc 100644 --- a/docs/appendix/zwe_server_command_reference/zwe/components/install/zwe-components-install-extract.md +++ b/docs/appendix/zwe_server_command_reference/zwe/components/install/zwe-components-install-extract.md @@ -25,6 +25,8 @@ Full name|Alias|Type|Required|Help message |---|---|---|---|--- --component-file,--component|-o|string|yes|Path to the component package or directory. --auto-encoding|-e|string|no|If we want to automatically tagging the module files. + + ### Inherited from parent command Full name|Alias|Type|Required|Help message @@ -45,10 +47,13 @@ Error code|Exit code|Error message ZWEL0139E|139|Failed to create directory %s. ZWEL0153E|153|Cannot install Zowe component to system root directory. ZWEL0154E|154|Temporary directory is empty. -ZWEL0155E|155|Component %s already exists in %s. +ZWEL0155E|155|Component %s already exists in %s. If you meant to upgrade this component, run the command 'zwe components upgrade' instead. ZWEL0167E|167|Cannot find component name from %s package manifest. ZWEL0204E|204|Symlink creation failure, error=%s -ZWEL0313E|313|Cannot file component file %s.### Inherited from parent command +ZWEL0313E|313|Cannot file component file %s. + + +### Inherited from parent command Error code|Exit code|Error message |---|---|--- diff --git a/docs/appendix/zwe_server_command_reference/zwe/components/install/zwe-components-install-process-hook.md b/docs/appendix/zwe_server_command_reference/zwe/components/install/zwe-components-install-process-hook.md index 42844a67ac..f6583656ed 100644 --- a/docs/appendix/zwe_server_command_reference/zwe/components/install/zwe-components-install-process-hook.md +++ b/docs/appendix/zwe_server_command_reference/zwe/components/install/zwe-components-install-process-hook.md @@ -24,6 +24,8 @@ zwe components install process-hook -c /path/to/zowe.yaml -n component-name Full name|Alias|Type|Required|Help message |---|---|---|---|--- --component-name|-n|string|yes|Component name. + + ### Inherited from parent command Full name|Alias|Type|Required|Help message @@ -39,6 +41,8 @@ Full name|Alias|Type|Required|Help message ## Errors + + ### Inherited from parent command Error code|Exit code|Error message diff --git a/docs/appendix/zwe_server_command_reference/zwe/components/install/zwe-components-install.md b/docs/appendix/zwe_server_command_reference/zwe/components/install/zwe-components-install.md index 7e43c125b6..ba1186d4c2 100644 --- a/docs/appendix/zwe_server_command_reference/zwe/components/install/zwe-components-install.md +++ b/docs/appendix/zwe_server_command_reference/zwe/components/install/zwe-components-install.md @@ -47,6 +47,8 @@ Full name|Alias|Type|Required|Help message ## Parameters + + ### Inherited from parent command Full name|Alias|Type|Required|Help message @@ -69,7 +71,9 @@ ZWEL0180E|180|Zowe extension directory (zowe.extensionDirectory) is not defined ZWEL0304E|304|Handler install failure, cannot continue. ZWEL0305E|305|Could not find one of the components' directories. ZWEL0314E|314|Cannot install with component=all. This option only exists for upgrade. -ZWEL0315E|315|Handler (-handler or zowe.extensionRegistry.defaultHandler) required but not specified.### Inherited from parent command +ZWEL0315E|315|Handler (-handler or zowe.extensionRegistry.defaultHandler) required but not specified. + +### Inherited from parent command Error code|Exit code|Error message |---|---|--- diff --git a/docs/appendix/zwe_server_command_reference/zwe/components/zwe-components-disable.md b/docs/appendix/zwe_server_command_reference/zwe/components/zwe-components-disable.md index fe237b9dab..82b4cc0983 100644 --- a/docs/appendix/zwe_server_command_reference/zwe/components/zwe-components-disable.md +++ b/docs/appendix/zwe_server_command_reference/zwe/components/zwe-components-disable.md @@ -26,6 +26,8 @@ Full name|Alias|Type|Required|Help message |---|---|---|---|--- --component-name,--component|-o|string|yes|Component name to be disabled. --ha-instance|-i|string|no|Zowe high availability instance ID from zowe.yaml. + + ### Inherited from parent command Full name|Alias|Type|Required|Help message @@ -44,6 +46,8 @@ Full name|Alias|Type|Required|Help message Error code|Exit code|Error message |---|---|--- ZWEL0152E|152|Cannot find component %s. + + ### Inherited from parent command Error code|Exit code|Error message diff --git a/docs/appendix/zwe_server_command_reference/zwe/components/zwe-components-enable.md b/docs/appendix/zwe_server_command_reference/zwe/components/zwe-components-enable.md index f7f7c8508d..e46d91e55a 100644 --- a/docs/appendix/zwe_server_command_reference/zwe/components/zwe-components-enable.md +++ b/docs/appendix/zwe_server_command_reference/zwe/components/zwe-components-enable.md @@ -26,6 +26,8 @@ Full name|Alias|Type|Required|Help message |---|---|---|---|--- --component-name,--component|-o|string|yes|Component name to be enabled. --ha-instance|-i|string|no|Zowe high availability instance ID from zowe.yaml. + + ### Inherited from parent command Full name|Alias|Type|Required|Help message @@ -44,6 +46,8 @@ Full name|Alias|Type|Required|Help message Error code|Exit code|Error message |---|---|--- ZWEL0152E|152|Cannot find component %s. + + ### Inherited from parent command Error code|Exit code|Error message diff --git a/docs/appendix/zwe_server_command_reference/zwe/components/zwe-components-search.md b/docs/appendix/zwe_server_command_reference/zwe/components/zwe-components-search.md index 30ba7ba9e3..64d6c96b69 100644 --- a/docs/appendix/zwe_server_command_reference/zwe/components/zwe-components-search.md +++ b/docs/appendix/zwe_server_command_reference/zwe/components/zwe-components-search.md @@ -34,6 +34,8 @@ Full name|Alias|Type|Required|Help message --registry|-r|string|no|Specifies the registry to search within instead of the default. The registry must be compatible with the manager used. --handler||string|no|Specifies the registry handler name used with the package registry, instead of the default. The handler must be compatible with the registry used. + + ### Inherited from parent command Full name|Alias|Type|Required|Help message @@ -52,7 +54,9 @@ Full name|Alias|Type|Required|Help message Error code|Exit code|Error message |---|---|--- ZWEL0310E|310|Component name (-name|-n) or id (-id,-d) required but not specified. -ZWEL0311E|311|Handler (-handler,-h or zowe.extensionRegistry.defaultHandler) required but not specified.### Inherited from parent command +ZWEL0311E|311|Handler (-handler,-h or zowe.extensionRegistry.defaultHandler) required but not specified. + +### Inherited from parent command Error code|Exit code|Error message |---|---|--- diff --git a/docs/appendix/zwe_server_command_reference/zwe/components/zwe-components-uninstall.md b/docs/appendix/zwe_server_command_reference/zwe/components/zwe-components-uninstall.md index 12a8ae30b0..d4e90c89cc 100644 --- a/docs/appendix/zwe_server_command_reference/zwe/components/zwe-components-uninstall.md +++ b/docs/appendix/zwe_server_command_reference/zwe/components/zwe-components-uninstall.md @@ -25,7 +25,7 @@ Full name|Alias|Type|Required|Help message --component-name,--component|-o|string|yes|The name of an installed component. --registry|-r|string|no|Specifies the registry to search within instead of the default. The registry must be compatible with the manager used. --handler||string|no|Specifies the registry handler name used with the package registry, instead of the default. The handler must be compatible with the registry used. ---dry-run|-d|boolean|no|Whether or not to perform the upgrade versus just checking if an upgrade is available. +--dry-run|-d|boolean|no|Whether or not to perform the upgrade versus just checking if an upgrade is available ### Inherited from parent command @@ -49,7 +49,9 @@ ZWEL0307E|307|Component %s cannot be uninstalled, because it is a core component ZWEL0308W|308|Component directory %s could not be removed, rc=%s. ZWEL0309W|309|Skipping removal of component %s because it is a core component. ZWEL0312W|312|Component %s marked for removal but is not installed. -ZWEL????E|???|Command requires zowe.useConfigmgr=true to use.### Inherited from parent command +ZWEL????E|???|Command requires zowe.useConfigmgr=true to use. + +### Inherited from parent command Error code|Exit code|Error message |---|---|--- diff --git a/docs/appendix/zwe_server_command_reference/zwe/components/zwe-components-upgrade.md b/docs/appendix/zwe_server_command_reference/zwe/components/zwe-components-upgrade.md index 870abffc57..0439ba806d 100644 --- a/docs/appendix/zwe_server_command_reference/zwe/components/zwe-components-upgrade.md +++ b/docs/appendix/zwe_server_command_reference/zwe/components/zwe-components-upgrade.md @@ -26,7 +26,7 @@ Full name|Alias|Type|Required|Help message --component-file,--component|-o|string|yes|Either a path or component name. The path must be to a component package or directory. If a name is specified instead, install checks the zowe package registry. --registry|-r|string|no|Specifies the registry to search within instead of the default. The registry must be compatible with the manager used. --handler||string|no|Specifies the registry handler name used with the package registry, instead of the default. The handler must be compatible with the registry used. ---dry-run|-d|boolean|no|Whether or not to perform the upgrade versus just checking if an upgrade is available. +--dry-run|-d|boolean|no|Whether or not to perform the upgrade versus just checking if an upgrade is available ### Inherited from parent command @@ -49,6 +49,8 @@ ZWEL0156E|156|Component name is not initialized after extract step. ZWEL0180E|180|Zowe extension directory (zowe.extensionDirectory) is not defined in Zowe YAML configuration file. ZWEL0304E|304|Handler install failure, cannot continue. ZWEL0305E|305|Could not find one of the components' directories. + + ### Inherited from parent command Error code|Exit code|Error message diff --git a/docs/appendix/zwe_server_command_reference/zwe/components/zwe-components.md b/docs/appendix/zwe_server_command_reference/zwe/components/zwe-components.md index c26a743f7f..f851142179 100644 --- a/docs/appendix/zwe_server_command_reference/zwe/components/zwe-components.md +++ b/docs/appendix/zwe_server_command_reference/zwe/components/zwe-components.md @@ -22,6 +22,8 @@ zwe components install -c /path/to/zowe.yaml -o /path/to/component/package ## Parameters + + ### Inherited from parent command Full name|Alias|Type|Required|Help message @@ -37,6 +39,8 @@ Full name|Alias|Type|Required|Help message ## Errors + + ### Inherited from parent command Error code|Exit code|Error message diff --git a/docs/appendix/zwe_server_command_reference/zwe/config/zwe-config-get.md b/docs/appendix/zwe_server_command_reference/zwe/config/zwe-config-get.md index 32d999d2a2..bfaece746d 100644 --- a/docs/appendix/zwe_server_command_reference/zwe/config/zwe-config-get.md +++ b/docs/appendix/zwe_server_command_reference/zwe/config/zwe-config-get.md @@ -26,6 +26,8 @@ Full name|Alias|Type|Required|Help message |---|---|---|---|--- --ha-instance|-i|string|no|Zowe high availability instance ID. --path|-p|string|yes|Path of the configuration. For example, `components.gateway.port`. + + ### Inherited from parent command Full name|Alias|Type|Required|Help message @@ -43,7 +45,9 @@ Full name|Alias|Type|Required|Help message Error code|Exit code|Error message |---|---|--- -ZWEL0303E|303|Invalid config path syntax for %s. Get only supports single period delimiters between values.### Inherited from parent command +ZWEL0303E|303|Invalid config path syntax for %s. Get only supports single period delimiters between values. + +### Inherited from parent command Error code|Exit code|Error message |---|---|--- diff --git a/docs/appendix/zwe_server_command_reference/zwe/config/zwe-config-validate.md b/docs/appendix/zwe_server_command_reference/zwe/config/zwe-config-validate.md index 04e9d9d667..d987212930 100644 --- a/docs/appendix/zwe_server_command_reference/zwe/config/zwe-config-validate.md +++ b/docs/appendix/zwe_server_command_reference/zwe/config/zwe-config-validate.md @@ -18,6 +18,7 @@ This command can optionally validate enabled components or all components, but o zwe config validate -c /path/to/zowe.yaml zwe config validate -c FILE(/customizations/zowe.yaml):FILE(/defaults/zowe.yaml) --all zwe config validate -c 'FILE(/path/to/zowe.yaml):PARMLIB(ZOWE.PARMLIB(YAML))' + ``` ## Parameters @@ -25,7 +26,9 @@ zwe config validate -c 'FILE(/path/to/zowe.yaml):PARMLIB(ZOWE.PARMLIB(YAML))' Full name|Alias|Type|Required|Help message |---|---|---|---|--- --components||boolean|no|Turns on validation for enabled components. ---all||boolean|no|Turns on validation for all components, even disabled ones.### Inherited from parent command +--all||boolean|no|Turns on validation for all components, even disabled ones. + +### Inherited from parent command Full name|Alias|Type|Required|Help message |---|---|---|---|--- @@ -40,6 +43,8 @@ Full name|Alias|Type|Required|Help message ## Errors + + ### Inherited from parent command Error code|Exit code|Error message @@ -78,4 +83,4 @@ ZWEL0200E||Failed to copy USS file %s to MVS data set %s. ZWEL0201E||File %s does not exist. ZWEL0202E||Unable to find samplib key for %s. ZWEL0203E||Env value in key-value pair %s has not been defined. -ZWEL0316E||Command requires zowe.useConfigmgr=true to use. +ZWEL0316E||Command requires zowe.useConfigmgr=true to use. \ No newline at end of file diff --git a/docs/appendix/zwe_server_command_reference/zwe/config/zwe-config.md b/docs/appendix/zwe_server_command_reference/zwe/config/zwe-config.md index f42935dd9c..1a9803fdef 100644 --- a/docs/appendix/zwe_server_command_reference/zwe/config/zwe-config.md +++ b/docs/appendix/zwe_server_command_reference/zwe/config/zwe-config.md @@ -11,6 +11,8 @@ ## Parameters + + ### Inherited from parent command Full name|Alias|Type|Required|Help message @@ -26,6 +28,8 @@ Full name|Alias|Type|Required|Help message ## Errors + + ### Inherited from parent command Error code|Exit code|Error message diff --git a/docs/appendix/zwe_server_command_reference/zwe/init/zwe-init-apfauth.md b/docs/appendix/zwe_server_command_reference/zwe/init/zwe-init-apfauth.md index e00962df57..8fd082e854 100644 --- a/docs/appendix/zwe_server_command_reference/zwe/init/zwe-init-apfauth.md +++ b/docs/appendix/zwe_server_command_reference/zwe/init/zwe-init-apfauth.md @@ -42,6 +42,8 @@ Full name|Alias|Type|Required|Help message |---|---|---|---|--- --security-dry-run||boolean|no|Whether to dry run security related setup. --ignore-security-failures||boolean|no|Whether to ignore security setup job failures. + + ### Inherited from parent command Full name|Alias|Type|Required|Help message @@ -65,6 +67,8 @@ Full name|Alias|Type|Required|Help message Error code|Exit code|Error message |---|---|--- ZWEL0157E|157|%s (%s) is not defined in Zowe YAML configuration file. + + ### Inherited from parent command Error code|Exit code|Error message diff --git a/docs/appendix/zwe_server_command_reference/zwe/init/zwe-init-certificate.md b/docs/appendix/zwe_server_command_reference/zwe/init/zwe-init-certificate.md index 24c62bcb84..8676c7ce6a 100644 --- a/docs/appendix/zwe_server_command_reference/zwe/init/zwe-init-certificate.md +++ b/docs/appendix/zwe_server_command_reference/zwe/init/zwe-init-certificate.md @@ -79,7 +79,8 @@ zOSMF: ``` - `zowe.setup.certificate.type` is the type of certificate. Valid values are - "PKCS12" (USS keystore) or "JCERACFKS" (z/OS keyring). + "PKCS12" (USS keystore) or "JCEKS", "JCECCAKS", "JCERACFKS", "JCECCARACFKS", + and "JCEHYBRIDRACFKS (z/OS keyring). - `zowe.setup.certificate.dname` is the distinguished name of the certificate. You can define `caCommonName`, `commonName`, `orgUnit`, `org`, `locality`, `state`, and / or `country`. These configurations are optional. @@ -87,13 +88,15 @@ zOSMF: This is optional. - `zowe.setup.certificate.san` is the `Subject Alternative Name`(s) of the certificate if they are different from `zowe.externalDomains`. Please note, - for `JCERACFKS`` type, with limitation of RACDCERT command, this should - contain exact one hostname (domain) and one IP address. + for `JCEKS`, `JCECCAKS`, `JCERACFKS`, `JCECCARACFKS`, and `JCEHYBRIDRACFKS` + type, with limitation of RACDCERT command, this should contain exact one + hostname (domain) and one IP address. - `zowe.setup.certificate.importCertificateAuthorities` is the list of - certificate authorities will be imported to Zowe PKCS12 keystore or JCERACFKS - keyring. Please note, for JCERACFKS type, only maximum 2 CAs is supported. + certificate authorities will be imported to Zowe PKCS12 keystore or + keyring. Please note, for keyring type, only maximum 2 CAs is supported. If you are using `PKCS12` certificate, this should be USS files in PEM format. - If you are using `JCERACFKS` certificate, this should be certificate labels + If you are using `JCEKS`, `JCECCAKS`, `JCERACFKS`, `JCECCARACFKS`, or + `JCEHYBRIDRACFKS` certificate, this should be certificate labels on the z/OS system. - `zOSMF.host` and `zOSMF.port` is the z/OSMF service information. This is required if you are using z/OSMF as authentication service. @@ -126,13 +129,14 @@ zOSMF: the certificate will be saved as alias specified in `zowe.setup.certificate.pkcs12.name`. -**For `JCERACFKS` certificate (z/OS keyring) users,** +**For keyring certificate users,** - `zowe.setup.certificate.keyring.owner` is the keyring owner. It's optional and default value is `zowe.setup.security.users.zowe`. If it's also not defined, the default value is `ZWESVUSR`. - `zowe.setup.certificate.keyring.name` is the keyring name will be created - on z/OS. This is required if `zowe.setup.certificate.type` is `JCERACFKS`. + on z/OS. This is required if `zowe.setup.certificate.type` is one of `JCEKS`, + `JCECCAKS`, `JCERACFKS`, `JCECCARACFKS`, or `JCEHYBRIDRACFKS`. - If you want to let Zowe to generate new certificate, * You can also customize `label` and `caLabel` under `zowe.setup.certificate.keyring` if you want to generate new certificate. @@ -177,6 +181,8 @@ Full name|Alias|Type|Required|Help message --allow-overwrite,--allow-overwritten||boolean|no|Allow overwritten existing MVS data set. --update-config||boolean|no|Whether to update YAML configuration file with initialization result. --ignore-security-failures||boolean|no|Whether to ignore security setup job failures. + + ### Inherited from parent command Full name|Alias|Type|Required|Help message @@ -201,6 +207,8 @@ Error code|Exit code|Error message |---|---|--- ZWEL0157E|157|%s (%s) is not defined in Zowe YAML configuration file. ZWEL0164E|164|Value of %s (%s) defined in Zowe YAML configuration file is invalid. Valid values are %s. + + ### Inherited from parent command Error code|Exit code|Error message diff --git a/docs/appendix/zwe_server_command_reference/zwe/init/zwe-init-mvs.md b/docs/appendix/zwe_server_command_reference/zwe/init/zwe-init-mvs.md index 3c4d5884cd..367383f0b5 100644 --- a/docs/appendix/zwe_server_command_reference/zwe/init/zwe-init-mvs.md +++ b/docs/appendix/zwe_server_command_reference/zwe/init/zwe-init-mvs.md @@ -54,6 +54,8 @@ zwe init mvs -v -c /path/to/zowe.yaml Full name|Alias|Type|Required|Help message |---|---|---|---|--- --allow-overwrite,--allow-overwritten||boolean|no|Allow overwritten existing MVS data set. + + ### Inherited from parent command Full name|Alias|Type|Required|Help message @@ -80,6 +82,8 @@ ZWEL0157E|157|%s (%s) is not defined in Zowe YAML configuration file. ZWEL0300W||%s already exists. This data set member will be overwritten during configuration. ZWEL0301W||%s already exists and will not be overwritten. For upgrades, you must use --allow-overwrite. ZWEL0158E|158|%s already exists. + + ### Inherited from parent command Error code|Exit code|Error message diff --git a/docs/appendix/zwe_server_command_reference/zwe/init/zwe-init-security.md b/docs/appendix/zwe_server_command_reference/zwe/init/zwe-init-security.md index 15f11ceb0c..ed3909e7d4 100644 --- a/docs/appendix/zwe_server_command_reference/zwe/init/zwe-init-security.md +++ b/docs/appendix/zwe_server_command_reference/zwe/init/zwe-init-security.md @@ -69,6 +69,8 @@ Full name|Alias|Type|Required|Help message |---|---|---|---|--- --security-dry-run||boolean|no|Whether to dry run security related setup. --ignore-security-failures||boolean|no|Whether to ignore security setup job failures. + + ### Inherited from parent command Full name|Alias|Type|Required|Help message @@ -100,6 +102,8 @@ ZWEL0162E|162|Failed to find job %s result. ZWEL0162W||Failed to find job %s result. ZWEL0163E|163|Job %s ends with code %s. ZWEL0163W||Job %s ends with code %s. + + ### Inherited from parent command Error code|Exit code|Error message diff --git a/docs/appendix/zwe_server_command_reference/zwe/init/zwe-init-stc.md b/docs/appendix/zwe_server_command_reference/zwe/init/zwe-init-stc.md index ff573eaf22..bff1cb7289 100644 --- a/docs/appendix/zwe_server_command_reference/zwe/init/zwe-init-stc.md +++ b/docs/appendix/zwe_server_command_reference/zwe/init/zwe-init-stc.md @@ -58,6 +58,8 @@ zwe init stc -v -c /path/to/zowe.yaml Full name|Alias|Type|Required|Help message |---|---|---|---|--- --allow-overwrite,--allow-overwritten||boolean|no|Allow overwritten existing MVS data set. + + ### Inherited from parent command Full name|Alias|Type|Required|Help message @@ -87,6 +89,8 @@ ZWEL0143E|143|Cannot find data set member %s. You may need to re-run `zwe instal ZWEL0158E|158|%s already exists. ZWEL0159E|159|Failed to modify %s. ZWEL0160E|160|Failed to write to %s. Please check if target data set is opened by others. + + ### Inherited from parent command Error code|Exit code|Error message diff --git a/docs/appendix/zwe_server_command_reference/zwe/init/zwe-init-vsam.md b/docs/appendix/zwe_server_command_reference/zwe/init/zwe-init-vsam.md index 9438c245b1..962609cca5 100644 --- a/docs/appendix/zwe_server_command_reference/zwe/init/zwe-init-vsam.md +++ b/docs/appendix/zwe_server_command_reference/zwe/init/zwe-init-vsam.md @@ -56,6 +56,8 @@ zwe init vsam -v -c /path/to/zowe.yaml Full name|Alias|Type|Required|Help message |---|---|---|---|--- --allow-overwrite,--allow-overwritten||boolean|no|Allow overwritten existing MVS data set. + + ### Inherited from parent command Full name|Alias|Type|Required|Help message @@ -88,6 +90,8 @@ ZWEL0161E|161|Failed to run JCL %s. ZWEL0162E|162|Failed to find job %s result. ZWEL0163E|163|Job %s ends with code %s. ZWEL0301W|0|Zowe Caching Service is not configured to use VSAM. Command skipped. + + ### Inherited from parent command Error code|Exit code|Error message diff --git a/docs/appendix/zwe_server_command_reference/zwe/init/zwe-init.md b/docs/appendix/zwe_server_command_reference/zwe/init/zwe-init.md index 89a72d45bf..a254041f68 100644 --- a/docs/appendix/zwe_server_command_reference/zwe/init/zwe-init.md +++ b/docs/appendix/zwe_server_command_reference/zwe/init/zwe-init.md @@ -161,7 +161,8 @@ components: This configuration is optional. Default value is `ZWESASTC`. - `zowe.setup.certificate.type` is the type of certificate. Valid values are - "PKCS12" (USS keystore) or "JCERACFKS" (z/OS keyring). + "PKCS12" (USS keystore) or "JCEKS", "JCECCAKS", "JCERACFKS", "JCECCARACFKS", + and "JCEHYBRIDRACFKS (z/OS keyring). - `zowe.setup.certificate.dname` is the distinguished name of the certificate. You can define `caCommonName`, `commonName`, `orgUnit`, `org`, `locality`, `state`, and / or `country`. These configurations are optional. @@ -169,13 +170,15 @@ components: This is optional. - `zowe.setup.certificate.san` is the `Subject Alternative Name`(s) of the certificate if they are different from `zowe.externalDomains`. Please note, - for `JCERACFKS` type, with limitation of RACDCERT command, this should - contain exact one hostname (domain) and one IP address. + for `JCEKS`, `JCECCAKS`, `JCERACFKS`, `JCECCARACFKS`, and `JCEHYBRIDRACFKS` + type, with limitation of RACDCERT command, this should contain exact one + hostname (domain) and one IP address. - `zowe.setup.certificate.importCertificateAuthorities` is the list of - certificate authorities will be imported to Zowe PKCS12 keystore or JCERACFKS - keyring. Please note, for JCERACFKS type, only maximum 2 CAs is supported. + certificate authorities will be imported to Zowe PKCS12 keystore or + keyring. Please note, for keyring type, only maximum 2 CAs is supported. If you are using `PKCS12` certificate, this should be USS files in PEM format. - If you are using `JCERACFKS` certificate, this should be certificate labels + If you are using `JCEKS`, `JCECCAKS`, `JCERACFKS`, `JCECCARACFKS`, or + `JCEHYBRIDRACFKS` certificate, this should be certificate labels on the z/OS system. **For `PKCS12` certificate users,** @@ -200,13 +203,14 @@ components: the certificate will be saved as alias specified in `zowe.setup.certificate.pkcs12.name`. -**For `JCERACFKS` certificate (z/OS keyring) users,** +**For keyring certificate users,** - `zowe.setup.certificate.keyring.owner` is the keyring owner. It's optional and default value is `zowe.setup.security.users.zowe`. If it's also not defined, the default value is `ZWESVUSR`. - `zowe.setup.certificate.keyring.name` is the keyring name will be created - on z/OS. This is required if `zowe.setup.certificate.type` is `JCERACFKS`. + on z/OS. This is required if `zowe.setup.certificate.type` is one of `JCEKS`, + `JCECCAKS`, `JCERACFKS`, `JCECCARACFKS`, or `JCEHYBRIDRACFKS`. - If you want to let Zowe to generate new certificate, * You can also customize `label` and `caLabel` under `zowe.setup.certificate.keyring` if you want to generate new certificate. @@ -277,6 +281,8 @@ Full name|Alias|Type|Required|Help message --security-dry-run||boolean|no|Whether to dry run security related setup. --ignore-security-failures||boolean|no|Whether to ignore security setup job failures. --update-config||boolean|no|Whether to update YAML configuration file with initialization result. + + ### Inherited from parent command Full name|Alias|Type|Required|Help message @@ -292,6 +298,8 @@ Full name|Alias|Type|Required|Help message ## Errors + + ### Inherited from parent command Error code|Exit code|Error message diff --git a/docs/appendix/zwe_server_command_reference/zwe/internal/config/zwe-internal-config-get.md b/docs/appendix/zwe_server_command_reference/zwe/internal/config/zwe-internal-config-get.md index a93e049384..7ac493f073 100644 --- a/docs/appendix/zwe_server_command_reference/zwe/internal/config/zwe-internal-config-get.md +++ b/docs/appendix/zwe_server_command_reference/zwe/internal/config/zwe-internal-config-get.md @@ -9,6 +9,8 @@ Return value of a configuration defined in YAML configuration. + + ### Inherited from parent command WARNING: This command is for experimental purposes and could be changed in the future releases. @@ -26,6 +28,8 @@ Full name|Alias|Type|Required|Help message |---|---|---|---|--- --ha-instance|-i|string|no|Zowe high availability instance ID. --path|-p|string|yes|Path of the configuration. For example, `components.gateway.port`. + + ### Inherited from parent command Full name|Alias|Type|Required|Help message @@ -43,7 +47,9 @@ Full name|Alias|Type|Required|Help message Error code|Exit code|Error message |---|---|--- -ZWEL0303E|303|Invalid config path syntax for %s. Get only supports single period delimiters between values.### Inherited from parent command +ZWEL0303E|303|Invalid config path syntax for %s. Get only supports single period delimiters between values. + +### Inherited from parent command Error code|Exit code|Error message |---|---|--- diff --git a/docs/appendix/zwe_server_command_reference/zwe/internal/config/zwe-internal-config-set.md b/docs/appendix/zwe_server_command_reference/zwe/internal/config/zwe-internal-config-set.md index 6fc84ccdff..64251457a3 100644 --- a/docs/appendix/zwe_server_command_reference/zwe/internal/config/zwe-internal-config-set.md +++ b/docs/appendix/zwe_server_command_reference/zwe/internal/config/zwe-internal-config-set.md @@ -9,6 +9,8 @@ Set value of a configuration and write back to the YAML configuration. + + ### Inherited from parent command WARNING: This command is for experimental purposes and could be changed in the future releases. @@ -27,7 +29,9 @@ Full name|Alias|Type|Required|Help message --ha-instance|-i|string|no|Zowe high availability instance ID. --path|-p|string|yes|Path of the configuration. For example, `components.gateway.port`. --value|-e|string|no|New value of the configuration. ---string||boolean|no|When specified, the value is treated as a string even if it looks like a number or boolean### Inherited from parent command +--string||boolean|no|When specified, the value is treated as a string even if it looks like a number or boolean + +### Inherited from parent command Full name|Alias|Type|Required|Help message |---|---|---|---|--- @@ -42,6 +46,8 @@ Full name|Alias|Type|Required|Help message ## Errors + + ### Inherited from parent command Error code|Exit code|Error message diff --git a/docs/appendix/zwe_server_command_reference/zwe/internal/config/zwe-internal-config.md b/docs/appendix/zwe_server_command_reference/zwe/internal/config/zwe-internal-config.md index 5dbb90a755..5757653aa2 100644 --- a/docs/appendix/zwe_server_command_reference/zwe/internal/config/zwe-internal-config.md +++ b/docs/appendix/zwe_server_command_reference/zwe/internal/config/zwe-internal-config.md @@ -9,6 +9,8 @@ * [get](./zwe-internal-config-get.md) * [set](./zwe-internal-config-set.md) + + ### Inherited from parent command WARNING: This command is for experimental purposes and could be changed in the future releases. @@ -24,6 +26,8 @@ zwe internal config set -p path-of-configuration -e new-value-of-configuration - ## Parameters + + ### Inherited from parent command Full name|Alias|Type|Required|Help message @@ -39,6 +43,8 @@ Full name|Alias|Type|Required|Help message ## Errors + + ### Inherited from parent command Error code|Exit code|Error message diff --git a/docs/appendix/zwe_server_command_reference/zwe/internal/container/zwe-internal-container-cleanup.md b/docs/appendix/zwe_server_command_reference/zwe/internal/container/zwe-internal-container-cleanup.md index 93f9804eb0..0321b162ff 100644 --- a/docs/appendix/zwe_server_command_reference/zwe/internal/container/zwe-internal-container-cleanup.md +++ b/docs/appendix/zwe_server_command_reference/zwe/internal/container/zwe-internal-container-cleanup.md @@ -11,12 +11,16 @@ Clean up Kubernetes runtime. Currently this command will remove all outdated static definitions. + + ### Inherited from parent command WARNING: This command is for experimental purposes and could be changed in the future releases. ## Parameters + + ### Inherited from parent command Full name|Alias|Type|Required|Help message @@ -32,6 +36,8 @@ Full name|Alias|Type|Required|Help message ## Errors + + ### Inherited from parent command Error code|Exit code|Error message diff --git a/docs/appendix/zwe_server_command_reference/zwe/internal/container/zwe-internal-container-init.md b/docs/appendix/zwe_server_command_reference/zwe/internal/container/zwe-internal-container-init.md index cd7253249a..ae11cfe39c 100644 --- a/docs/appendix/zwe_server_command_reference/zwe/internal/container/zwe-internal-container-init.md +++ b/docs/appendix/zwe_server_command_reference/zwe/internal/container/zwe-internal-container-init.md @@ -9,12 +9,16 @@ Initialize special runtime environment required by Zowe containerization. + + ### Inherited from parent command WARNING: This command is for experimental purposes and could be changed in the future releases. ## Parameters + + ### Inherited from parent command Full name|Alias|Type|Required|Help message @@ -30,6 +34,8 @@ Full name|Alias|Type|Required|Help message ## Errors + + ### Inherited from parent command Error code|Exit code|Error message diff --git a/docs/appendix/zwe_server_command_reference/zwe/internal/container/zwe-internal-container-prestop.md b/docs/appendix/zwe_server_command_reference/zwe/internal/container/zwe-internal-container-prestop.md index 7a40f95cf6..4904f70d3b 100644 --- a/docs/appendix/zwe_server_command_reference/zwe/internal/container/zwe-internal-container-prestop.md +++ b/docs/appendix/zwe_server_command_reference/zwe/internal/container/zwe-internal-container-prestop.md @@ -9,6 +9,8 @@ Actions will be executed before a service is stopped. + + ### Inherited from parent command WARNING: This command is for experimental purposes and could be changed in the future releases. @@ -18,6 +20,8 @@ WARNING: This command is for experimental purposes and could be changed in the f Full name|Alias|Type|Required|Help message |---|---|---|---|--- --ha-instance|-i|string|no|Zowe high availability instance ID. + + ### Inherited from parent command Full name|Alias|Type|Required|Help message @@ -33,6 +37,8 @@ Full name|Alias|Type|Required|Help message ## Errors + + ### Inherited from parent command Error code|Exit code|Error message diff --git a/docs/appendix/zwe_server_command_reference/zwe/internal/container/zwe-internal-container.md b/docs/appendix/zwe_server_command_reference/zwe/internal/container/zwe-internal-container.md index edc5681cd1..29d56da4fa 100644 --- a/docs/appendix/zwe_server_command_reference/zwe/internal/container/zwe-internal-container.md +++ b/docs/appendix/zwe_server_command_reference/zwe/internal/container/zwe-internal-container.md @@ -17,12 +17,16 @@ Internal commands to help manager workloads in Zowe containers. NOTE: these internal commands are only used by Zowe Containerization use scenario. + + ### Inherited from parent command WARNING: This command is for experimental purposes and could be changed in the future releases. ## Parameters + + ### Inherited from parent command Full name|Alias|Type|Required|Help message @@ -38,6 +42,8 @@ Full name|Alias|Type|Required|Help message ## Errors + + ### Inherited from parent command Error code|Exit code|Error message diff --git a/docs/appendix/zwe_server_command_reference/zwe/internal/start/zwe-internal-start-component.md b/docs/appendix/zwe_server_command_reference/zwe/internal/start/zwe-internal-start-component.md index 92d2ab0c42..0c42441af3 100644 --- a/docs/appendix/zwe_server_command_reference/zwe/internal/start/zwe-internal-start-component.md +++ b/docs/appendix/zwe_server_command_reference/zwe/internal/start/zwe-internal-start-component.md @@ -4,6 +4,8 @@ zwe internal start component [parameter [parameter]...] + + ### Inherited from parent command WARNING: This command is for experimental purposes and could be changed in the future releases. @@ -21,6 +23,8 @@ Full name|Alias|Type|Required|Help message |---|---|---|---|--- --component|-o|string|yes|Component to start. --run-in-background||boolean|no|Whether to start this component in background. + + ### Inherited from parent command Full name|Alias|Type|Required|Help message @@ -37,6 +41,8 @@ Full name|Alias|Type|Required|Help message ## Errors + + ### Inherited from parent command Error code|Exit code|Error message diff --git a/docs/appendix/zwe_server_command_reference/zwe/internal/start/zwe-internal-start-prepare.md b/docs/appendix/zwe_server_command_reference/zwe/internal/start/zwe-internal-start-prepare.md index eabdc08f7a..79fb314808 100644 --- a/docs/appendix/zwe_server_command_reference/zwe/internal/start/zwe-internal-start-prepare.md +++ b/docs/appendix/zwe_server_command_reference/zwe/internal/start/zwe-internal-start-prepare.md @@ -4,6 +4,8 @@ zwe internal start prepare [parameter [parameter]...] + + ### Inherited from parent command WARNING: This command is for experimental purposes and could be changed in the future releases. @@ -17,6 +19,8 @@ zwe internal start prepare -c /path/to/zowe.yaml ## Parameters + + ### Inherited from parent command Full name|Alias|Type|Required|Help message @@ -37,6 +41,8 @@ Error code|Exit code|Error message |---|---|--- ZWEL0141E|141|User %s does not have write permission on %s. ZWEL0302W||You are running the Zowe process under user id IZUSVR. This is not recommended and may impact your z/OS MF server negatively. +ZWEL0317E||Component %s commands.configure ended with rc=%s. + ### Inherited from parent command Error code|Exit code|Error message diff --git a/docs/appendix/zwe_server_command_reference/zwe/internal/start/zwe-internal-start.md b/docs/appendix/zwe_server_command_reference/zwe/internal/start/zwe-internal-start.md index d8a436a0ad..3b5af45437 100644 --- a/docs/appendix/zwe_server_command_reference/zwe/internal/start/zwe-internal-start.md +++ b/docs/appendix/zwe_server_command_reference/zwe/internal/start/zwe-internal-start.md @@ -9,6 +9,8 @@ * [component](./zwe-internal-start-component.md) * [prepare](./zwe-internal-start-prepare.md) + + ### Inherited from parent command WARNING: This command is for experimental purposes and could be changed in the future releases. @@ -27,6 +29,8 @@ zwe internal start component -o component-name -c /path/to/zowe.yaml Full name|Alias|Type|Required|Help message |---|---|---|---|--- --ha-instance|-i|string|no|Zowe high availability instance ID. + + ### Inherited from parent command Full name|Alias|Type|Required|Help message @@ -42,6 +46,8 @@ Full name|Alias|Type|Required|Help message ## Errors + + ### Inherited from parent command Error code|Exit code|Error message diff --git a/docs/appendix/zwe_server_command_reference/zwe/internal/zwe-internal-get-launch-components.md b/docs/appendix/zwe_server_command_reference/zwe/internal/zwe-internal-get-launch-components.md index a6d758a0dc..d3eba16331 100644 --- a/docs/appendix/zwe_server_command_reference/zwe/internal/zwe-internal-get-launch-components.md +++ b/docs/appendix/zwe_server_command_reference/zwe/internal/zwe-internal-get-launch-components.md @@ -11,6 +11,8 @@ Return component list should be started in specified HA instance. NOTE: This command only returns a list of enabled components with start command. + + ### Inherited from parent command WARNING: This command is for experimental purposes and could be changed in the future releases. @@ -27,6 +29,8 @@ zwe internal get-launch-components -c /path/to/zowe.yaml Full name|Alias|Type|Required|Help message |---|---|---|---|--- --ha-instance|-i|string|no|Zowe high availability instance ID. + + ### Inherited from parent command Full name|Alias|Type|Required|Help message @@ -42,6 +46,8 @@ Full name|Alias|Type|Required|Help message ## Errors + + ### Inherited from parent command Error code|Exit code|Error message diff --git a/docs/appendix/zwe_server_command_reference/zwe/internal/zwe-internal.md b/docs/appendix/zwe_server_command_reference/zwe/internal/zwe-internal.md index 7bde28eff0..764fd3f56c 100644 --- a/docs/appendix/zwe_server_command_reference/zwe/internal/zwe-internal.md +++ b/docs/appendix/zwe_server_command_reference/zwe/internal/zwe-internal.md @@ -29,6 +29,8 @@ zwe internal config set -p path-of-configuration -e new-value-of-configuration - ## Parameters + + ### Inherited from parent command Full name|Alias|Type|Required|Help message @@ -44,6 +46,8 @@ Full name|Alias|Type|Required|Help message ## Errors + + ### Inherited from parent command Error code|Exit code|Error message diff --git a/docs/appendix/zwe_server_command_reference/zwe/migrate/for/zwe-migrate-for-kubernetes.md b/docs/appendix/zwe_server_command_reference/zwe/migrate/for/zwe-migrate-for-kubernetes.md index 082ac98907..edcecd35cf 100644 --- a/docs/appendix/zwe_server_command_reference/zwe/migrate/for/zwe-migrate-for-kubernetes.md +++ b/docs/appendix/zwe_server_command_reference/zwe/migrate/for/zwe-migrate-for-kubernetes.md @@ -30,13 +30,13 @@ In order to make certificates working in Kubernetes, the certificate you are usi have these domains defined in certificate Subject Alt Name (SAN): - your external domains to access Zowe APIML Gateway Service running in Kubernetes cluster, -- `*..svc.` -- `*.discovery-service..svc.` -- `*.gateway-service..svc.` -- `*..pod.` +- `*.[k8s-namespace].svc.[k8s-cluster-name]` +- `*.discovery-service.[k8s-namespace].svc.[k8s-cluster-name]` +- `*.gateway-service.[k8s-namespace].svc.[k8s-cluster-name]` +- `*.[k8s-namespace].pod.[k8s-cluster-name]` -`` is the Kubernetes Namespace you installed Zowe into. And -`` is the Kubernetes cluster name, which usually should be +`[k8s-namespace]` is the Kubernetes Namespace you installed Zowe into. And +`[k8s-cluster-name]` is the Kubernetes cluster name, which usually should be `cluster.local`. Without the additional domains in SAN, you may see warnings/errors related to certificate @@ -69,6 +69,8 @@ Full name|Alias|Type|Required|Help message --k8s-cluster-name||string|no|Kubernetes cluster name. --alias|-a|string|no|Certificate alias name. --password|-p|string|no|Password of the certificate keystore. + + ### Inherited from parent command Full name|Alias|Type|Required|Help message @@ -84,6 +86,8 @@ Full name|Alias|Type|Required|Help message ## Errors + + ### Inherited from parent command Error code|Exit code|Error message diff --git a/docs/appendix/zwe_server_command_reference/zwe/migrate/for/zwe-migrate-for.md b/docs/appendix/zwe_server_command_reference/zwe/migrate/for/zwe-migrate-for.md index fc46fc1aa5..964737fbef 100644 --- a/docs/appendix/zwe_server_command_reference/zwe/migrate/for/zwe-migrate-for.md +++ b/docs/appendix/zwe_server_command_reference/zwe/migrate/for/zwe-migrate-for.md @@ -10,6 +10,8 @@ ## Parameters + + ### Inherited from parent command Full name|Alias|Type|Required|Help message @@ -25,6 +27,8 @@ Full name|Alias|Type|Required|Help message ## Errors + + ### Inherited from parent command Error code|Exit code|Error message diff --git a/docs/appendix/zwe_server_command_reference/zwe/migrate/zwe-migrate.md b/docs/appendix/zwe_server_command_reference/zwe/migrate/zwe-migrate.md index 8da46c79a3..abb17e6b09 100644 --- a/docs/appendix/zwe_server_command_reference/zwe/migrate/zwe-migrate.md +++ b/docs/appendix/zwe_server_command_reference/zwe/migrate/zwe-migrate.md @@ -10,6 +10,8 @@ ## Parameters + + ### Inherited from parent command Full name|Alias|Type|Required|Help message @@ -25,6 +27,8 @@ Full name|Alias|Type|Required|Help message ## Errors + + ### Inherited from parent command Error code|Exit code|Error message diff --git a/docs/appendix/zwe_server_command_reference/zwe/sample/sub/zwe-sample-sub-deep.md b/docs/appendix/zwe_server_command_reference/zwe/sample/sub/zwe-sample-sub-deep.md index 7a447d08e5..0ba5a1ed21 100644 --- a/docs/appendix/zwe_server_command_reference/zwe/sample/sub/zwe-sample-sub-deep.md +++ b/docs/appendix/zwe_server_command_reference/zwe/sample/sub/zwe-sample-sub-deep.md @@ -14,7 +14,9 @@ NOTE: This command is to demonstrate how `zwe` command works. There are no real meaningful functionalities defined in this command and sub-commands. -WARNING: This command is for experimental purposes and could be changed in the future releases.### Inherited from parent command +WARNING: This command is for experimental purposes and could be changed in the future releases. + +### Inherited from parent command WARNING: This command is for experimental purposes and could be changed in the future releases. @@ -30,6 +32,8 @@ zwe sample sub deep -d required-parameter Full name|Alias|Type|Required|Help message |---|---|---|---|--- --another-parameter|-p|boolean|no|Every command level can have their own parameters. + + ### Inherited from parent command Full name|Alias|Type|Required|Help message @@ -47,6 +51,8 @@ Full name|Alias|Type|Required|Help message ## Errors + + ### Inherited from parent command Error code|Exit code|Error message diff --git a/docs/appendix/zwe_server_command_reference/zwe/sample/sub/zwe-sample-sub-second.md b/docs/appendix/zwe_server_command_reference/zwe/sample/sub/zwe-sample-sub-second.md index bb2fe8b5c9..bc1251f7bc 100644 --- a/docs/appendix/zwe_server_command_reference/zwe/sample/sub/zwe-sample-sub-second.md +++ b/docs/appendix/zwe_server_command_reference/zwe/sample/sub/zwe-sample-sub-second.md @@ -12,7 +12,9 @@ NOTE: This command is to demonstrate how `zwe` command works. There are no real meaningful functionalities defined in this command and sub-commands. -WARNING: This command is for experimental purposes and could be changed in the future releases.### Inherited from parent command +WARNING: This command is for experimental purposes and could be changed in the future releases. + +### Inherited from parent command WARNING: This command is for experimental purposes and could be changed in the future releases. @@ -25,6 +27,8 @@ zwe sample sub second -d required-parameter ## Parameters + + ### Inherited from parent command Full name|Alias|Type|Required|Help message @@ -42,6 +46,8 @@ Full name|Alias|Type|Required|Help message ## Errors + + ### Inherited from parent command Error code|Exit code|Error message diff --git a/docs/appendix/zwe_server_command_reference/zwe/sample/sub/zwe-sample-sub.md b/docs/appendix/zwe_server_command_reference/zwe/sample/sub/zwe-sample-sub.md index c88c497bdf..3220310d4a 100644 --- a/docs/appendix/zwe_server_command_reference/zwe/sample/sub/zwe-sample-sub.md +++ b/docs/appendix/zwe_server_command_reference/zwe/sample/sub/zwe-sample-sub.md @@ -17,6 +17,8 @@ NOTE: This command is to demonstrate how `zwe` command works. There are no real meaningful functionalities defined in this command and sub-commands. + + ### Inherited from parent command WARNING: This command is for experimental purposes and could be changed in the future releases. @@ -34,6 +36,8 @@ Full name|Alias|Type|Required|Help message |---|---|---|---|--- --target-dir,--target|-d|string|yes|This parameter is required. --auto-encoding|-e|string|no|This parameter has default value.\nThis help message has multiple lines.\n - another line + + ### Inherited from parent command Full name|Alias|Type|Required|Help message @@ -49,6 +53,8 @@ Full name|Alias|Type|Required|Help message ## Errors + + ### Inherited from parent command Error code|Exit code|Error message diff --git a/docs/appendix/zwe_server_command_reference/zwe/sample/zwe-sample-test.md b/docs/appendix/zwe_server_command_reference/zwe/sample/zwe-sample-test.md index e25b9cf7d0..c97da07591 100644 --- a/docs/appendix/zwe_server_command_reference/zwe/sample/zwe-sample-test.md +++ b/docs/appendix/zwe_server_command_reference/zwe/sample/zwe-sample-test.md @@ -12,7 +12,9 @@ NOTE: This command is to demonstrate how `zwe` command works. There are no real meaningful functionalities defined in this command and sub-commands. -WARNING: This command is for experimental purposes and could be changed in the future releases.### Inherited from parent command +WARNING: This command is for experimental purposes and could be changed in the future releases. + +### Inherited from parent command WARNING: This command is for experimental purposes and could be changed in the future releases. @@ -25,6 +27,8 @@ zwe sample test ## Parameters + + ### Inherited from parent command Full name|Alias|Type|Required|Help message @@ -40,6 +44,8 @@ Full name|Alias|Type|Required|Help message ## Errors + + ### Inherited from parent command Error code|Exit code|Error message diff --git a/docs/appendix/zwe_server_command_reference/zwe/sample/zwe-sample.md b/docs/appendix/zwe_server_command_reference/zwe/sample/zwe-sample.md index 21f36794fe..4b38f4b7a6 100644 --- a/docs/appendix/zwe_server_command_reference/zwe/sample/zwe-sample.md +++ b/docs/appendix/zwe_server_command_reference/zwe/sample/zwe-sample.md @@ -28,6 +28,8 @@ zwe sample sub second -d required-parameter ## Parameters + + ### Inherited from parent command Full name|Alias|Type|Required|Help message @@ -43,6 +45,8 @@ Full name|Alias|Type|Required|Help message ## Errors + + ### Inherited from parent command Error code|Exit code|Error message diff --git a/docs/appendix/zwe_server_command_reference/zwe/support/zwe-support-verify-fingerprints.md b/docs/appendix/zwe_server_command_reference/zwe/support/zwe-support-verify-fingerprints.md index 04ee440981..a663ffbf4c 100644 --- a/docs/appendix/zwe_server_command_reference/zwe/support/zwe-support-verify-fingerprints.md +++ b/docs/appendix/zwe_server_command_reference/zwe/support/zwe-support-verify-fingerprints.md @@ -6,6 +6,8 @@ ## Parameters + + ### Inherited from parent command Full name|Alias|Type|Required|Help message @@ -28,6 +30,8 @@ ZWEL0113E|113|Failed to find Zowe version. Please validate your Zowe directory. ZWEL0150E|150|Failed to find file %s. Zowe runtimeDirectory is invalid. ZWEL0151E|151|Failed to create temporary file %s. Please check permission or volume free space. ZWEL0181E|181|Failed to verify Zowe file fingerprints. + + ### Inherited from parent command Error code|Exit code|Error message diff --git a/docs/appendix/zwe_server_command_reference/zwe/support/zwe-support.md b/docs/appendix/zwe_server_command_reference/zwe/support/zwe-support.md index c43d580023..a4bc1decf3 100644 --- a/docs/appendix/zwe_server_command_reference/zwe/support/zwe-support.md +++ b/docs/appendix/zwe_server_command_reference/zwe/support/zwe-support.md @@ -23,8 +23,8 @@ This command will collect these information: * Zowe configuration file * Zowe installation logs * Zowe PKCS#12 keystore if used - * Zowe temporary configuration files under `/.env` - * Zowe APIML static registration files under `/api-mediation/api-defs` + * Zowe temporary configuration files under "`zowe.workspaceDirectory`/.env" + * Zowe APIML static registration files under "`zowe.workspaceDirectory`/api-mediation/api-defs" - Zowe runtime * Active running Zowe processes * Zowe job log @@ -36,6 +36,8 @@ This command will collect these information: Full name|Alias|Type|Required|Help message |---|---|---|---|--- --target-dir||string|no|Target directory where the support package will be created.\nIf it is not specified, system temporary directory will be used. + + ### Inherited from parent command Full name|Alias|Type|Required|Help message @@ -51,6 +53,8 @@ Full name|Alias|Type|Required|Help message ## Errors + + ### Inherited from parent command Error code|Exit code|Error message diff --git a/docs/appendix/zwe_server_command_reference/zwe/zwe-diagnose.md b/docs/appendix/zwe_server_command_reference/zwe/zwe-diagnose.md new file mode 100644 index 0000000000..611229d47d --- /dev/null +++ b/docs/appendix/zwe_server_command_reference/zwe/zwe-diagnose.md @@ -0,0 +1,84 @@ +# zwe diagnose + +[zwe](././zwe) > [diagnose](./zwe-diagnose) + + zwe diagnose [parameter [parameter]...] + +## Description + +Display the message corresponding to the error code. + + +## Examples + +``` +zwe diagnose -e ZWES0014I + +``` + +## Parameters + +Full name|Alias|Type|Required|Help message +|---|---|---|---|--- +--error-code|-e|string|yes|Error Code. + + +### Inherited from parent command + +Full name|Alias|Type|Required|Help message +|---|---|---|---|--- +--help|-h|boolean|no|Display this help. +--debug,--verbose|-v|boolean|no|Enable verbose mode. +--trace|-vv|boolean|no|Enable trace level debug mode. +--silent|-s|boolean|no|Do not display messages to standard output. +--log-dir,--log|-l|string|no|Write logs to this directory. +--config|-c|string|no|Path to Zowe configuration zowe.yaml file. +--configmgr||boolean|no|Enable use of configmgr capabilities. + + +## Errors + +Error code|Exit code|Error message +|---|---|--- +ZWEL0102E|102|Invalid parameter %s. + + +### Inherited from parent command + +Error code|Exit code|Error message +|---|---|--- +||100|If the user pass `--help` or `-h` parameter, the zwe command always exits with `100` code. +ZWEL0101E|101|ZWE_zowe_runtimeDirectory is not defined. +ZWEL0102E|102|Invalid parameter %s. +ZWEL0103E|103|Invalid type of parameter %s. +ZWEL0104E|104|Invalid command %s. +ZWEL0105E|105|The Zowe YAML config file is associated to Zowe runtime "%s", which is not same as where zwe command is located. +ZWEL0106E|106|%s parameter is required. +ZWEL0107E|107|No handler defined for command %s. +ZWEL0108E|108|Zowe YAML config file is required. +ZWEL0109E|109|The Zowe YAML config file specified does not exist. +ZWEL0110E|110|Doesn't have write permission on %s directory. +ZWEL0111E|111|Command aborts with error. +ZWEL0112E|112|Zowe runtime environment must be prepared first with "zwe internal start prepare" command. +ZWEL0114E|114|Reached max retries on allocating random number. +ZWEL0120E|120|This command must run on a z/OS system. +ZWEL0121E|121|Cannot find node. Please define NODE_HOME environment variable. +ZWEL0122E|122|Cannot find java. Please define JAVA_HOME environment variable. +ZWEL0123E|123|This function is only available in Zowe Containerization deployment. +ZWEL0131E|131|Cannot find key %s defined in file %s. +ZWEL0132E|132|No manifest file found in component %s. +ZWEL0133E|133|Data set %s already exists. +ZWEL0134E|134|Failed to find SMS status of data set %s. +ZWEL0135E|135|Failed to find volume of data set %s. +ZWEL0136E|136|Failed to APF authorize data set %s. +ZWEL0137E|137|z/OSMF root certificate authority is not provided (or cannot be detected) with trusting z/OSMF option enabled. +ZWEL0138E|138|Failed to update key %s of file %s. +ZWEL0139E|139|Failed to create directory %s. +ZWEL0140E|140|Failed to translate Zowe configuration (%s). +ZWEL0142E|142|Failed to refresh APIML static registrations. +ZWEL0172E||Component %s has %s defined but the file is missing. +ZWEL0200E||Failed to copy USS file %s to MVS data set %s. +ZWEL0201E||File %s does not exist. +ZWEL0202E||Unable to find samplib key for %s. +ZWEL0203E||Env value in key-value pair %s has not been defined. +ZWEL0316E||Command requires zowe.useConfigmgr=true to use. \ No newline at end of file diff --git a/docs/appendix/zwe_server_command_reference/zwe/zwe-install.md b/docs/appendix/zwe_server_command_reference/zwe/zwe-install.md index 961f7d0080..254d90e0dd 100644 --- a/docs/appendix/zwe_server_command_reference/zwe/zwe-install.md +++ b/docs/appendix/zwe_server_command_reference/zwe/zwe-install.md @@ -42,6 +42,8 @@ Full name|Alias|Type|Required|Help message |---|---|---|---|--- --allow-overwrite,--allow-overwritten||boolean|no|Allow overwritten existing MVS data set. --dataset-prefix,--ds-prefix||string|no|Install Zowe to this dataset prefix.\nIf you specify this value, --config is not required. + + ### Inherited from parent command Full name|Alias|Type|Required|Help message @@ -63,6 +65,8 @@ ZWEL0157E|157|%s (%s) is not defined in Zowe YAML configuration file. ZWEL0300W||%s already exists. Members in this data set will be overwritten. ZWEL0301W||%s already exists and will not be overwritten. For upgrades, you must use --allow-overwrite. ZWEL0158E|158|%s already exists. + + ### Inherited from parent command Error code|Exit code|Error message diff --git a/docs/appendix/zwe_server_command_reference/zwe/zwe-start.md b/docs/appendix/zwe_server_command_reference/zwe/zwe-start.md index 4d3b4bc926..1ee5a7f063 100644 --- a/docs/appendix/zwe_server_command_reference/zwe/zwe-start.md +++ b/docs/appendix/zwe_server_command_reference/zwe/zwe-start.md @@ -16,10 +16,9 @@ zowe: security: stcs: zowe: ZWESLSTC - job: - name: ZWE1SV + jobname: ZWE1SV haInstances: - : + [ha-instance]: sysname: ZLP1 ``` @@ -27,7 +26,7 @@ haInstances: This configuration is optional. Default value is `ZWESLSTC`. - `zowe.job.name` is the optional customized job name to start Zowe. If it's empty, the start command will not pass `JOBNAME=` option to `S` command. -- `haInstances..sysname` is the SYSNAME of the target HA instance. +- `haInstances.[ha-instance].sysname` is the SYSNAME of the target HA instance. If you pass `--ha-instance` parameter, this is the SYSNAME the start command will be routed to. @@ -44,6 +43,8 @@ zwe start -c /path/to/zowe.yaml Full name|Alias|Type|Required|Help message |---|---|---|---|--- --ha-instance|-i|string|no|Zowe high availability instance ID. + + ### Inherited from parent command Full name|Alias|Type|Required|Help message @@ -62,6 +63,8 @@ Full name|Alias|Type|Required|Help message Error code|Exit code|Error message |---|---|--- ZWEL0165E|165|Failed to start job %s: %s. + + ### Inherited from parent command Error code|Exit code|Error message diff --git a/docs/appendix/zwe_server_command_reference/zwe/zwe-stop.md b/docs/appendix/zwe_server_command_reference/zwe/zwe-stop.md index 89c1cf462e..da080e7c03 100644 --- a/docs/appendix/zwe_server_command_reference/zwe/zwe-stop.md +++ b/docs/appendix/zwe_server_command_reference/zwe/zwe-stop.md @@ -16,10 +16,9 @@ zowe: security: stcs: zowe: ZWESLSTC - job: - name: ZWE1SV + jobname: ZWE1SV haInstances: - : + [ha-instance]: sysname: ZLP1 ``` @@ -28,7 +27,7 @@ haInstances: - `zowe.job.name` is the optional customized job name to start Zowe. If it's empty, the stop command will try to use value of `zowe.setup.security.stcs.zowe` as job name to stop. -- `haInstances..sysname` is the SYSNAME of the target HA instance. +- `haInstances.[ha-instance].sysname` is the SYSNAME of the target HA instance. If you pass `--ha-instance` parameter, this is the SYSNAME the start command will be routed to. @@ -45,6 +44,8 @@ zwe stop -c /path/to/zowe.yaml Full name|Alias|Type|Required|Help message |---|---|---|---|--- --ha-instance|-i|string|no|Zowe high availability instance ID. + + ### Inherited from parent command Full name|Alias|Type|Required|Help message @@ -63,6 +64,8 @@ Full name|Alias|Type|Required|Help message Error code|Exit code|Error message |---|---|--- ZWEL0166E|166|Failed to stop job %s: %s. + + ### Inherited from parent command Error code|Exit code|Error message diff --git a/docs/appendix/zwe_server_command_reference/zwe/zwe-version.md b/docs/appendix/zwe_server_command_reference/zwe/zwe-version.md index d721666b09..fa1d67130a 100644 --- a/docs/appendix/zwe_server_command_reference/zwe/zwe-version.md +++ b/docs/appendix/zwe_server_command_reference/zwe/zwe-version.md @@ -18,6 +18,8 @@ zwe version ## Parameters + + ### Inherited from parent command Full name|Alias|Type|Required|Help message @@ -36,6 +38,8 @@ Full name|Alias|Type|Required|Help message Error code|Exit code|Error message |---|---|--- ZWEL0150E|150|Failed to find file %s. Zowe runtimeDirectory is invalid. + + ### Inherited from parent command Error code|Exit code|Error message diff --git a/docs/appendix/zwe_server_command_reference/zwe/zwe.md b/docs/appendix/zwe_server_command_reference/zwe/zwe.md index 04baa59c2f..01aff48505 100644 --- a/docs/appendix/zwe_server_command_reference/zwe/zwe.md +++ b/docs/appendix/zwe_server_command_reference/zwe/zwe.md @@ -9,6 +9,7 @@ * [certificate](./certificate/zwe-certificate.md) * [components](./components/zwe-components.md) * [config](./config/zwe-config.md) +* [diagnose](./zwe-diagnose.md) * [init](./init/zwe-init.md) * [install](./zwe-install.md) * [internal](./internal/zwe-internal.md) diff --git a/docs/extend/extend-apiml/api-mediation-infinispan.md b/docs/extend/extend-apiml/api-mediation-infinispan.md index 374a5b019c..15b69b37af 100644 --- a/docs/extend/extend-apiml/api-mediation-infinispan.md +++ b/docs/extend/extend-apiml/api-mediation-infinispan.md @@ -42,18 +42,31 @@ Configure Infinispan as a storage solution through the Caching service by settin The port number used by Infinispan to synchronise data among cahing-service instances. - **Example of Caching service configuration using Infinispan:** + **Example of Caching service HA configuration using Infinispan:** ```yaml zowe - components: - caching-service: - storage: - mode: infinispan - infinispan: - initialHosts: lpar123[7099] - jgroups: - port: 7098 - persistence: - dataLocation: data01 + haInstances: + lpar1: + components: + caching-service: + storage: + mode: infinispan + infinispan: + initialHosts: lpar2[7099] + jgroups: + port: 7098 + persistence: + dataLocation: /global/zowe/workspace/caching-service/data01 + lpar2: + components: + caching-service: + storage: + mode: infinispan + infinispan: + initialHosts: lpar1[7098] + jgroups: + port: 7099 + persistence: + dataLocation: /global/zowe/workspace/caching-service/data02 ``` \ No newline at end of file diff --git a/docs/troubleshoot/cli/troubleshoot-cli-plugins.md b/docs/troubleshoot/cli/troubleshoot-cli-plugins.md index 4606487493..077843ca5c 100644 --- a/docs/troubleshoot/cli/troubleshoot-cli-plugins.md +++ b/docs/troubleshoot/cli/troubleshoot-cli-plugins.md @@ -13,8 +13,7 @@ For help with error codes from a back-end vendor, refer to the vendor’s help d 1. Is there already a GitHub issue (open or closed) that covers the problem? Check the following repositories: - [IBM CICS Plug-in issues](https://github.com/zowe/zowe-cli-cics-plugin/issues) - - [IBM Db2 Database Plug-in issues](https://github.com/zowe/zowe-cli-db2-plugin/issues). - - [IBM IMS Plug-in issues](https://github.com/zowe/zowe-cli-ims-plugin/issues) + - [IBM Db2 Database Plug-in issues](https://github.com/zowe/zowe-cli-db2-plugin/issues) - [IBM MQ Plug-in issues](https://github.com/zowe/zowe-cli-mq-plugin/issues) - [IBM z/OS FTP Plug-in issues](https://github.com/zowe/zowe-cli-ftp-plugin/issues) @@ -22,4 +21,4 @@ For help with error codes from a back-end vendor, refer to the vendor’s help d 2. Try searching for the issue using the [Zowe Docs](https://docs.zowe.org/) **Search** bar. -3. Use [the Zowe CLI Slack channel](https://openmainframeproject.slack.com/archives/CC8AALGN6) to reach the Zowe CLI community for assistance. +3. Use the [Zowe CLI Slack channel](https://openmainframeproject.slack.com/archives/CC8AALGN6) to reach the Zowe CLI community for assistance. diff --git a/docs/user-guide/cli-extending.md b/docs/user-guide/cli-extending.md index 11dc840fc4..b36b135102 100644 --- a/docs/user-guide/cli-extending.md +++ b/docs/user-guide/cli-extending.md @@ -4,14 +4,24 @@ You can install plug-ins to extend the capabilities of Zowe™ CLI. Plug-ins :::info Important -Plug-ins can gain control of your CLI application legitimately during the execution of every command. Install third-party plug-ins at your own risk. Zowe makes no warranties regarding the use of third-party plug-ins. +Plug-ins can gain control of Zowe CLI legitimately during the execution of every command. Install third-party plug-ins at your own risk. ::: -- [Install Zowe CLI plug-ins](cli-installplugins.md) +- [Installing Zowe CLI plug-ins](cli-installplugins.md) - [IBM® CICS Plug-in for Zowe CLI](cli-cicsplugin.md) - [IBM® Db2® Database Plug-in for Zowe CLI](cli-db2plugin.md) - [IBM® z/OS FTP Plug-in for Zowe CLI](cli-ftpplugin.md) -- [IBM® IMS™ Plug-in for Zowe CLI](cli-imsplugin.md) - [IBM® MQ Plug-in for Zowe CLI](cli-mqplugin.md) +- [IDF Plug-in for Zowe CLI](cli-idfplugin.md) - [Visual Studio Code (VSCode) Extension for Zowe](ze-install.md) + +- [IBM® IMS™ Plug-in for Zowe CLI](cli-imsplugin.md) + + :::warning + + As of Zowe v2.15, the **IBM IMS Plug-in** has been deprecated. + + No additional security updates, bug fixes, or enhancements for the plug-in are expected. + + ::: diff --git a/docs/user-guide/cli-idfplugin.md b/docs/user-guide/cli-idfplugin.md index c62b37ac62..87a74ce125 100644 --- a/docs/user-guide/cli-idfplugin.md +++ b/docs/user-guide/cli-idfplugin.md @@ -12,7 +12,11 @@ For a system administrator for the Zowe API Mediation Layer, the IDF Plug-in for The plug-in provides the `map` command. For details about the map command, see [Using](#using). -**Note:** The plug-in `help` command includes specific parameters of Zowe-profiles which are not used. +:::note + +The plug-in `help` command includes specific parameters of Zowe-profiles which are not used. + +::: ## Software requirements diff --git a/docs/user-guide/cli-imsplugin.md b/docs/user-guide/cli-imsplugin.md index 40d689f64c..f080089017 100644 --- a/docs/user-guide/cli-imsplugin.md +++ b/docs/user-guide/cli-imsplugin.md @@ -1,8 +1,20 @@ # IBM® IMS™ Plug-in for Zowe CLI +:::warning + +As of Zowe v2.15, the IBM **IMS Plug-in** has been deprecated. + +No additional security updates, bug fixes, or enhancements for the plug-in are expected. + +::: + The IBM IMS Plug-in for Zowe CLI lets you extend Zowe CLI such that it can interact with IMS resources (regions, programs and transactions). You can use the plug-in to start, stop, and query regions and start, stop, query, and update programs and transactions. -**Note:** For more information about IMS, see [IBM Information Management System (IMS)](https://www.ibm.com/it-infrastructure/z/ims) on the IBM Knowledge Center. +:::note + +For more information about IMS, see [IBM Information Management System (IMS)](https://www.ibm.com/it-infrastructure/z/ims) on the IBM Knowledge Center. + +::: ## Use cases @@ -52,7 +64,11 @@ Alternatively, you can create an ims profile manually by adding a section that c 2. Open the `zowe.config.json` configuration file using a text editor or IDE, such as Visual Studio Code or IntelliJ. - **NOTE:** If the file does not exist, issue the following command to create the configuration file: `zowe config init --gc` + :::note + + If the file does not exist, issue the following command to create the configuration file: `zowe config init --gc` + + ::: 3. Add code to the "profiles" section as shown in the following example: ``` @@ -114,6 +130,6 @@ The following steps describe how to create a profile using the `zowe profiles cr zowe profiles create ims-profile imsplex1 --host ims.zowe.org –-port 1443 --user zowe --password zowepass --ims-connect-host imsconnect.zowe.org --ims-connect-port 1444 ``` -2. Press Enter. The result of the command displays as a success or failure message. +2. Press `Enter`. The result of the command displays as a success or failure message. You can now use your profile when you issue commands in the ims command group. \ No newline at end of file diff --git a/docs/user-guide/cli-installplugins.md b/docs/user-guide/cli-installplugins.md index 34645d4592..d2478bc8ff 100755 --- a/docs/user-guide/cli-installplugins.md +++ b/docs/user-guide/cli-installplugins.md @@ -2,7 +2,11 @@ Use commands in the `plugins` command group to install and manage Zowe™ CLI plug-ins. -**Important!** Plug-ins can gain control of your CLI application legitimately during the execution of commands. Install third-party plug-ins at your own risk. We make no warranties regarding the use of third-party plug-ins. +:::info Important + +Plug-ins can gain control of Zowe CLI legitimately during the execution of every command. Install third-party plug-ins at your own risk. + +::: You can install the following Zowe plug-ins: - IBM® CICS® Plug-in for Zowe CLI @@ -32,18 +36,24 @@ Install Zowe CLI plug-ins on Windows, Mac, and Linux. The procedures in this art ``` zowe plugins install ``` - - **Note:** Replace `` with the installation command syntax in the following table: + + Replace `` with the installation command syntax in the following table | Plug-in | Syntax | |---------|-----------------------------| | IBM CICS Plug-in for Zowe CLI | `@zowe/cics-for-zowe-cli@zowe-v2-lts` | | IBM Db2 Plug-in for Zowe CLI| `@zowe/db2-for-zowe-cli@zowe-v2-lts` | | IBM z/OS FTP Plug-in for Zowe CLI | `@zowe/zos-ftp-for-zowe-cli@zowe-v2-lts` | - | IBM IMS Plug-in for Zowe CLI | `@zowe/ims-for-zowe-cli@zowe-v2-lts` | | IBM MQ Plug-in for Zowe CLI | `@zowe/mq-for-zowe-cli@zowe-v2-lts` | + | IBM IMS Plug-in for Zowe CLI
**DEPRECATED** | `@zowe/ims-for-zowe-cli@zowe-v2-lts` | + :::warning + + As of Zowe v2.15, the **IBM IMS Plug-in** has been deprecated. + + No additional security updates, bug fixes, or enhancements for the plug-in are expected. + ::: 3. (Optional) Issue the following command to install two or more plug-ins using one command. Separate the `` names with one space. @@ -51,9 +61,13 @@ Install Zowe CLI plug-ins on Windows, Mac, and Linux. The procedures in this art zowe plugins install <@zowe/my-plugin1> <@zowe/my-plugin2> <@zowe/my-plugin3> ... ``` - **Note:** The IBM Db2 Plug-in for Zowe CLI requires additional licensing and ODBC driver configurations. If you installed the DB2 plug-in, see [IBM Db2 Plug-in for Zowe CLI](cli-db2plugin.md). + :::note + + The IBM Db2 Plug-in for Zowe CLI requires additional licensing and ODBC driver configurations. If you installed the DB2 plug-in, see [IBM Db2 Plug-in for Zowe CLI](cli-db2plugin.md). -You installed Zowe CLI plug-ins. + ::: + + You have successfully installed Zowe CLI plug-ins. ## Installing plug-ins from a local package @@ -67,7 +81,11 @@ Install plug-ins from a local package on any computer that has limited or no acc From the Zowe [Download](https://zowe.org/download/) website, click **Download Zowe CLI** to download the Zowe CLI installation package named `zowe-cli-package-*v*.*r*.*m*.zip` to your computer. - **Note:** `v` indicates the version, `r` indicates the release number, and `m` indicates the modification number + :::note + + `v` indicates the version, `r` indicates the release number, and `m` indicates the modification number. + + ::: 3. Open a command-line window, such as Windows Command Prompt. Browse to the directory where you downloaded the Zowe CLI installation package (.zip file). Issue the following command, or use your preferred method to unzip the files: @@ -94,11 +112,18 @@ Install plug-ins from a local package on any computer that has limited or no acc | IBM CICS Plug-in for Zowe CLI | `cics-for-zowe-cli.tgz` | | IBM Db2 Plug-in for Zowe CLI | `db2-for-zowe-cli.tgz` | | IBM z/OS FTP Plug-in for Zowe CLI | `zos-ftp-for-zowe-cli.tgz` | - | IBM IMS Plug-in for Zowe CLI | `ims-for-zowe-cli.tgz` | | IBM MQ Plug-in for Zowe CLI | `mq-for-zowe-cli.tgz` | + | IBM IMS Plug-in for Zowe CLI
**DEPRECATED** | `ims-for-zowe-cli.tgz` | + :::warning + + As of Zowe v2.15, the **IBM IMS Plug-in** has been deprecated. + + No additional security updates, bug fixes, or enhancements for the plug-in are expected. + + ::: -You installed Zowe CLI plug-ins. + You have successfully installed the Zowe CLI plug-ins. ## Validating plug-ins diff --git a/docs/user-guide/cli-swreqplugins.md b/docs/user-guide/cli-swreqplugins.md index b162d86148..374b20b6e4 100644 --- a/docs/user-guide/cli-swreqplugins.md +++ b/docs/user-guide/cli-swreqplugins.md @@ -9,9 +9,9 @@ Before you use Zowe™ CLI plug-ins, complete the following steps: | [IBM CICS Plug-in for Zowe CLI](cli-cicsplugin.md) |
  • Ensure that [IBM CICS Transaction Server v5.2 or later](https://www.ibm.com/support/knowledgecenter/en/SSGMCP_5.2.0/com.ibm.cics.ts.home.doc/welcomePage/welcomePage.html) is installed and running in your mainframe environment
  • [IBM CICS Management Client Interface (CMCI)](https://www.ibm.com/support/knowledgecenter/en/SSGMCP_5.2.0/com.ibm.cics.ts.clientapi.doc/topics/clientapi_overview.html) is configured and running in your CICS region.
| | [IBM Db2 Database Plug-in for Zowe CLI](cli-db2plugin.md) |
  • [Download and prepare the ODBC driver](../user-guide/cli-db2plugin.md#downloading-the-odbc-driver) (required for only package installations) and address the licensing requirements. _Perform this task before you install the plug-in_.
  • **(MacOS)** Download and Install [Xcode](https://developer.apple.com/xcode/resources/).
| [z/OS FTP Plug-in for Zowe CLI](cli-ftpplugin.md) |
  • Ensure that z/OS FTP service is enabled and configured with `JESINTERFACELEVEL` = 2.
  • FTP over SSL is recommended.
| | [IBM z/OS FTP Plug-in for Zowe CLI](cli-ftpplugin.md) |
  • Ensure that z/OS FTP service is enabled and configured with `JESINTERFACELEVEL` = 2.
  • FTP over SSL is recommended.
| -| [IBM IMS Plug-in for Zowe CLI](cli-imsplugin.md) |
  • Ensure that [IBM® IMS™ v14.1.0](https://www.ibm.com/support/knowledgecenter/en/SSEPH2_14.1.0/com.ibm.ims14.doc/ims_product_landing_v14.html) or later is installed and running in your mainframe environment.
  • Configure [IBM® IMS™ Connect](https://www.ibm.com/support/knowledgecenter/en/SSEPH2_13.1.0/com.ibm.ims13.doc.ccg/ims_ct_intro.html).
  • Configure [IBM IMS Operations APIs](https://github.com/zowe/ims-operations-api) to enable communication between the CLI and the IMS instance.
| | [IBM MQ Plug-in for Zowe CLI](cli-mqplugin.md) |
  • Ensure that [IBM® MQ™ v9.1.0](https://www.ibm.com/support/knowledgecenter/en/SSFKSJ_9.1.0/com.ibm.mq.pro.doc/q121910_.htm) or later is installed and running in your mainframe environment. Please read this blog for more information: [Exposing the MQ REST API via the Zowe API Mediation Layer](https://developer.ibm.com/messaging/2019/05/17/exposing-the-mq-rest-api-via-the-zowe-api-mediation-layer/)
| | [Visual Studio Code Extension for Zowe](../user-guide/ze-install.md) |
  • Node.js V8.0 or later
  • Access to z/OSMF; at least one profile is configured
  • Configure TSO/E address space services, z/OS data set, file REST interface, and z/OS jobs REST interface. For more information, see [z/OS Requirements](../user-guide/systemrequirements-zosmf.md).
| +| [IBM IMS Plug-in for Zowe CLI](cli-imsplugin.md)
**DEPRECATED** |
  • **As of Zowe v2.15, the IBM IMS Plug-in has been deprecated. No additional security updates, bug fixes, or enhancements are expected.**
  • Ensure that [IBM® IMS™ v14.1.0](https://www.ibm.com/support/knowledgecenter/en/SSEPH2_14.1.0/com.ibm.ims14.doc/ims_product_landing_v14.html) or later is installed and running in your mainframe environment.
  • Configure [IBM® IMS™ Connect](https://www.ibm.com/support/knowledgecenter/en/SSEPH2_13.1.0/com.ibm.ims13.doc.ccg/ims_ct_intro.html).
  • Configure [IBM IMS Operations APIs](https://github.com/zowe/ims-operations-api) to enable communication between the CLI and the IMS instance.
| **Important!** You can perform the required configurations for the plug-ins that you want to use ***before*** or ***after*** you install the plug-ins. However, if you do not perform the required configurations, the plug-ins will not function as designed. diff --git a/docs/user-guide/systemrequirements-cli.md b/docs/user-guide/systemrequirements-cli.md index 6f2d0cf67f..81e1e071c1 100644 --- a/docs/user-guide/systemrequirements-cli.md +++ b/docs/user-guide/systemrequirements-cli.md @@ -83,7 +83,7 @@ You do not need to install the full Zowe solution to install and use Zowe CLI. M Services for plug-ins must be configured and running. -Plug-ins communicate with various mainframe services. The services must be configured and running on the mainframe before issuing plug-in commands. For example, the IMS plug-in requires an instance of IBM IMS on the mainframe with IMS Connect (REST services) running. For more information, see [Software requirements for CLI plug-ins](./cli-swreqplugins.md) +Plug-ins communicate with various mainframe services. The services must be configured and running on the mainframe before issuing plug-in commands. For example, the CICS plug-in requires an instance of IBM CICS Transaction Server on the mainframe with the CICS Management Client Interface (CMCI) API running. ### Zowe CLI on z/OS is not supported diff --git a/sidebars.js b/sidebars.js index 81325a4189..5ef4c35171 100644 --- a/sidebars.js +++ b/sidebars.js @@ -703,6 +703,7 @@ module.exports = { "extend/extend-apiml/api-mediation-infinispan", "extend/extend-apiml/api-mediation-vsam", "extend/extend-apiml/api-mediation-redis", + "extend/extend-apiml/api-mediation-infinispan", ], } ],