Merge pull request #2006 from zowe/doc/cert-no-password

doc(cert): Document limitation on cert files

packages/cli/__tests__/auth/__integration__/__snapshots__/cli.auth.apiml.integration.test.ts.snap

@@ -61,7 +61,10 @@ exports[`auth login/logout apiml help should display the login help 1`] = `
 
    --cert-file (local file path)
 
-      The file path to a certificate file to use for authentication
+      The file path to a certificate file to use for authentication.
+
+      Note: The CLI does not support certificate files that require a password. For
+      more information, search Troubleshooting PEM Certificates in Zowe Docs.
 
    --cert-key-file (local file path)
 
@@ -110,9 +113,9 @@ exports[`auth login/logout apiml help should display the login help 1`] = `
   \\"success\\": true,
   \\"exitCode\\": 0,
   \\"message\\": \\"The help was constructed for command: apiml.\\",
-  \\"stdout\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n   apiml\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n   Log in to Zowe API Mediation Layer authentication service and obtain or update a\\\\n   token.\\\\n\\\\n   The token provides authentication to services that support the API ML SSO\\\\n   (Single Sign-On) capability. When you log in, the token is stored in your\\\\n   default base profile until it expires. Base profiles store connection\\\\n   information shared by multiple services (e.g., z/OSMF), and are used if you do\\\\n   not supply connection information in a service profile. To take advantage of the\\\\n   API ML SSO capability, you should omit username and password in service profiles\\\\n   so that the token in the base profile is used.\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n   zowe auth login apiml [options]\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n   --show-token | --st (boolean)\\\\n\\\\n      Show the token when login is successful. If specified, does not save the token\\\\n      to a profile.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n   --host | -H (string)\\\\n\\\\n      Host name of service on the mainframe.\\\\n\\\\n   --port | -P (number)\\\\n\\\\n      Port number of service on the mainframe.\\\\n\\\\n   --user | -u (string)\\\\n\\\\n      User name to authenticate to service on the mainframe.\\\\n\\\\n   --password | --pass | --pw (string)\\\\n\\\\n      Password to authenticate to service on the mainframe.\\\\n\\\\n   --reject-unauthorized | --ru (boolean)\\\\n\\\\n      Reject self-signed certificates.\\\\n\\\\n      Default value: true\\\\n\\\\n   --cert-file (local file path)\\\\n\\\\n      The file path to a certificate file to use for authentication\\\\n\\\\n   --cert-key-file (local file path)\\\\n\\\\n      The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n   --base-profile | --base-p (string)\\\\n\\\\n      The name of a (base) profile to load for this command execution.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n   --show-inputs-only (boolean)\\\\n\\\\n      Show command inputs and do not run the command\\\\n\\\\n   --response-format-json | --rfj (boolean)\\\\n\\\\n      Produce JSON formatted data from a command\\\\n\\\\n   --help | -h (boolean)\\\\n\\\\n      Display help text\\\\n\\\\n   --help-web | --hw (boolean)\\\\n\\\\n      Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n   - Log in to an API ML instance to obtain or update the token\\\\n   stored in your base profile:\\\\n\\\\n      $ zowe auth login apiml\\\\n\\\\n   - Log in to an API ML instance to obtain a token without\\\\n   storing it in a profile:\\\\n\\\\n      $ zowe auth login apiml --show-token\\\\n\\\\n\\",
+  \\"stdout\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n   apiml\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n   Log in to Zowe API Mediation Layer authentication service and obtain or update a\\\\n   token.\\\\n\\\\n   The token provides authentication to services that support the API ML SSO\\\\n   (Single Sign-On) capability. When you log in, the token is stored in your\\\\n   default base profile until it expires. Base profiles store connection\\\\n   information shared by multiple services (e.g., z/OSMF), and are used if you do\\\\n   not supply connection information in a service profile. To take advantage of the\\\\n   API ML SSO capability, you should omit username and password in service profiles\\\\n   so that the token in the base profile is used.\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n   zowe auth login apiml [options]\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n   --show-token | --st (boolean)\\\\n\\\\n      Show the token when login is successful. If specified, does not save the token\\\\n      to a profile.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n   --host | -H (string)\\\\n\\\\n      Host name of service on the mainframe.\\\\n\\\\n   --port | -P (number)\\\\n\\\\n      Port number of service on the mainframe.\\\\n\\\\n   --user | -u (string)\\\\n\\\\n      User name to authenticate to service on the mainframe.\\\\n\\\\n   --password | --pass | --pw (string)\\\\n\\\\n      Password to authenticate to service on the mainframe.\\\\n\\\\n   --reject-unauthorized | --ru (boolean)\\\\n\\\\n      Reject self-signed certificates.\\\\n\\\\n      Default value: true\\\\n\\\\n   --cert-file (local file path)\\\\n\\\\n      The file path to a certificate file to use for authentication.\\\\n\\\\n      Note: The CLI does not support certificate files that require a password. For\\\\n      more information, search Troubleshooting PEM Certificates in Zowe Docs.\\\\n\\\\n   --cert-key-file (local file path)\\\\n\\\\n      The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n   --base-profile | --base-p (string)\\\\n\\\\n      The name of a (base) profile to load for this command execution.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n   --show-inputs-only (boolean)\\\\n\\\\n      Show command inputs and do not run the command\\\\n\\\\n   --response-format-json | --rfj (boolean)\\\\n\\\\n      Produce JSON formatted data from a command\\\\n\\\\n   --help | -h (boolean)\\\\n\\\\n      Display help text\\\\n\\\\n   --help-web | --hw (boolean)\\\\n\\\\n      Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n   - Log in to an API ML instance to obtain or update the token\\\\n   stored in your base profile:\\\\n\\\\n      $ zowe auth login apiml\\\\n\\\\n   - Log in to an API ML instance to obtain a token without\\\\n   storing it in a profile:\\\\n\\\\n      $ zowe auth login apiml --show-token\\\\n\\\\n\\",
   \\"stderr\\": \\"\\",
-  \\"data\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n   apiml\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n   Log in to Zowe API Mediation Layer authentication service and obtain or update a\\\\n   token.\\\\n\\\\n   The token provides authentication to services that support the API ML SSO\\\\n   (Single Sign-On) capability. When you log in, the token is stored in your\\\\n   default base profile until it expires. Base profiles store connection\\\\n   information shared by multiple services (e.g., z/OSMF), and are used if you do\\\\n   not supply connection information in a service profile. To take advantage of the\\\\n   API ML SSO capability, you should omit username and password in service profiles\\\\n   so that the token in the base profile is used.\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n   zowe auth login apiml [options]\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n   --show-token | --st (boolean)\\\\n\\\\n      Show the token when login is successful. If specified, does not save the token\\\\n      to a profile.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n   --host | -H (string)\\\\n\\\\n      Host name of service on the mainframe.\\\\n\\\\n   --port | -P (number)\\\\n\\\\n      Port number of service on the mainframe.\\\\n\\\\n   --user | -u (string)\\\\n\\\\n      User name to authenticate to service on the mainframe.\\\\n\\\\n   --password | --pass | --pw (string)\\\\n\\\\n      Password to authenticate to service on the mainframe.\\\\n\\\\n   --reject-unauthorized | --ru (boolean)\\\\n\\\\n      Reject self-signed certificates.\\\\n\\\\n      Default value: true\\\\n\\\\n   --cert-file (local file path)\\\\n\\\\n      The file path to a certificate file to use for authentication\\\\n\\\\n   --cert-key-file (local file path)\\\\n\\\\n      The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n   --base-profile | --base-p (string)\\\\n\\\\n      The name of a (base) profile to load for this command execution.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n   --show-inputs-only (boolean)\\\\n\\\\n      Show command inputs and do not run the command\\\\n\\\\n   --response-format-json | --rfj (boolean)\\\\n\\\\n      Produce JSON formatted data from a command\\\\n\\\\n   --help | -h (boolean)\\\\n\\\\n      Display help text\\\\n\\\\n   --help-web | --hw (boolean)\\\\n\\\\n      Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n   - Log in to an API ML instance to obtain or update the token\\\\n   stored in your base profile:\\\\n\\\\n      $ zowe auth login apiml\\\\n\\\\n   - Log in to an API ML instance to obtain a token without\\\\n   storing it in a profile:\\\\n\\\\n      $ zowe auth login apiml --show-token\\\\n\\\\n\\"
+  \\"data\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n   apiml\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n   Log in to Zowe API Mediation Layer authentication service and obtain or update a\\\\n   token.\\\\n\\\\n   The token provides authentication to services that support the API ML SSO\\\\n   (Single Sign-On) capability. When you log in, the token is stored in your\\\\n   default base profile until it expires. Base profiles store connection\\\\n   information shared by multiple services (e.g., z/OSMF), and are used if you do\\\\n   not supply connection information in a service profile. To take advantage of the\\\\n   API ML SSO capability, you should omit username and password in service profiles\\\\n   so that the token in the base profile is used.\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n   zowe auth login apiml [options]\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n   --show-token | --st (boolean)\\\\n\\\\n      Show the token when login is successful. If specified, does not save the token\\\\n      to a profile.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n   --host | -H (string)\\\\n\\\\n      Host name of service on the mainframe.\\\\n\\\\n   --port | -P (number)\\\\n\\\\n      Port number of service on the mainframe.\\\\n\\\\n   --user | -u (string)\\\\n\\\\n      User name to authenticate to service on the mainframe.\\\\n\\\\n   --password | --pass | --pw (string)\\\\n\\\\n      Password to authenticate to service on the mainframe.\\\\n\\\\n   --reject-unauthorized | --ru (boolean)\\\\n\\\\n      Reject self-signed certificates.\\\\n\\\\n      Default value: true\\\\n\\\\n   --cert-file (local file path)\\\\n\\\\n      The file path to a certificate file to use for authentication.\\\\n\\\\n      Note: The CLI does not support certificate files that require a password. For\\\\n      more information, search Troubleshooting PEM Certificates in Zowe Docs.\\\\n\\\\n   --cert-key-file (local file path)\\\\n\\\\n      The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n   --base-profile | --base-p (string)\\\\n\\\\n      The name of a (base) profile to load for this command execution.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n   --show-inputs-only (boolean)\\\\n\\\\n      Show command inputs and do not run the command\\\\n\\\\n   --response-format-json | --rfj (boolean)\\\\n\\\\n      Produce JSON formatted data from a command\\\\n\\\\n   --help | -h (boolean)\\\\n\\\\n      Display help text\\\\n\\\\n   --help-web | --hw (boolean)\\\\n\\\\n      Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n   - Log in to an API ML instance to obtain or update the token\\\\n   stored in your base profile:\\\\n\\\\n      $ zowe auth login apiml\\\\n\\\\n   - Log in to an API ML instance to obtain a token without\\\\n   storing it in a profile:\\\\n\\\\n      $ zowe auth login apiml --show-token\\\\n\\\\n\\"
 }"
 `;