Merge pull request #3451 from zowe/auto-update-zwe-reference

Update zwe server command reference
zowe · Feb 21, 2024 · a1f09a5 · a1f09a5
2 parents 3b76c0b + c290b7a
commit a1f09a5
Show file tree

Hide file tree

Showing 62 changed files with 436 additions and 51 deletions.
diff --git a/...mand_reference/zwe/certificate/keyring-jcl/zwe-certificate-keyring-jcl-clean.md b/...mand_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/...nd_reference/zwe/certificate/keyring-jcl/zwe-certificate-keyring-jcl-connect.md b/...nd_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/...d_reference/zwe/certificate/keyring-jcl/zwe-certificate-keyring-jcl-generate.md b/...d_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/..._reference/zwe/certificate/keyring-jcl/zwe-certificate-keyring-jcl-import-ds.md b/..._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/...er_command_reference/zwe/certificate/keyring-jcl/zwe-certificate-keyring-jcl.md b/...er_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/...and_reference/zwe/certificate/pkcs12/create/zwe-certificate-pkcs12-create-ca.md b/...and_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/...d_reference/zwe/certificate/pkcs12/create/zwe-certificate-pkcs12-create-cert.md b/...d_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/...ommand_reference/zwe/certificate/pkcs12/create/zwe-certificate-pkcs12-create.md b/...ommand_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/...erver_command_reference/zwe/certificate/pkcs12/zwe-certificate-pkcs12-export.md b/...erver_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/...erver_command_reference/zwe/certificate/pkcs12/zwe-certificate-pkcs12-import.md b/...erver_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/..._server_command_reference/zwe/certificate/pkcs12/zwe-certificate-pkcs12-lock.md b/..._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 `<empty>` 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.
diff --git a/...ommand_reference/zwe/certificate/pkcs12/zwe-certificate-pkcs12-trust-service.md b/...ommand_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/...x/zwe_server_command_reference/zwe/certificate/pkcs12/zwe-certificate-pkcs12.md b/...x/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/.../zwe_server_command_reference/zwe/certificate/zwe-certificate-verify-service.md b/.../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