diff --git a/docs/user-guide/cli-install-configure-zosmf-security.md b/docs/user-guide/cli-install-configure-zosmf-security.md index 22c8cecdb4..57d82001a7 100644 --- a/docs/user-guide/cli-install-configure-zosmf-security.md +++ b/docs/user-guide/cli-install-configure-zosmf-security.md @@ -21,8 +21,8 @@ The following table details the required z/OSMF REST services and examples of th | ----------- | ----------- | ---------- | ------------- | | Cloud provisioning services | Endpoints that begin with: `/zosmf/provisioning/` | Cloud provisioning for development environments. | | | TSO/E address space services | Endpoints that begin with: `/zosmf/tsoApp` | TSO commands (`zowe zos-tso issue`). | | -| z/OS console services | Endpoints that begin with: `/zosmf/restconsoles/`
Example: `/zosmf/restconsoles/defcn` | Console commands (`zowe zos-console issue`). Any MVS console command such as MODIFY and DISPLAY. | | -| z/OS data set and file REST interface | Endpoints that begin with: `/zosmf/restfiles/` Example: `/zosmf/restfiles/ds/` | Create data sets (`zowe zos-files create`), delete data sets (`zowe zos-files delete`), read (download) data sets (`zowe zos-files download`), and write (upload) data sets (`zowe zos-files upload`).
Access to access method services (IDCAMS) (`zowe zos-files invoke access-method-services`). | | +| z/OS console services | Endpoints that begin with: `/zosmf/restconsoles/`
Example: `/zosmf/restconsoles/defcn` | Console commands (`zowe zos-console issue`). Any MVS console command such as MODIFY and DISPLAY. | | +| z/OS data set and file REST interface | Endpoints that begin with: `/zosmf/restfiles/` Example: `/zosmf/restfiles/ds/` | Create data sets (`zowe zos-files create`), delete data sets (`zowe zos-files delete`), read (download) data sets (`zowe zos-files download`), and write (upload) data sets (`zowe zos-files upload`).
Access to access method services (IDCAMS) (`zowe zos-files invoke access-method-services`). | | | z/OS jobs REST interface | Endpoints that begin with: `/zosmf/restjobs/` Example: `/zosmf/restjobs/jobs//` | Submit jobs (`zowe zos-jobs submit`), purge jobs, and read job output.
List jobs (`zowe zos-jobs list`). |
  • [z/OS jobs REST interface](https://www.ibm.com/docs/en/zos/2.5.0?topic=services-zos-jobs-rest-interface)
  • [Resource authorizations for the z/OS jobs REST interface](https://www.ibm.com/docs/en/zos/2.5.0?topic=guide-security-structures-zosmf#DefaultSecuritySetupForZosmf__ResourceAuthorizationsForRESTapi__title__1)
| | z/OSMF workflow services | Endpoints that begin with: `/zosmf/workflow/` | Cloud provisioning for development environments. |
  • [z/OSMF workflow services](https://www.ibm.com/docs/en/zos/2.5.0?topic=services-zosmf-workflow)
| diff --git a/docs/user-guide/cli-install-verify-your-installation.md b/docs/user-guide/cli-install-verify-your-installation.md index 9dcb067568..38bbef04af 100644 --- a/docs/user-guide/cli-install-verify-your-installation.md +++ b/docs/user-guide/cli-install-verify-your-installation.md @@ -2,7 +2,7 @@ Verify that Zowe CLI has been installed successfully by checking your connection to z/OSMF and accessing the in-product help. -:::info**Required roles:** systems administrator, devops architect +:::info Required roles: systems administrator, devops architect ::: :::note diff --git a/docs/user-guide/cli-updatingcli.md b/docs/user-guide/cli-updatingcli.md index e5f7c336d8..ebeb31c21b 100644 --- a/docs/user-guide/cli-updatingcli.md +++ b/docs/user-guide/cli-updatingcli.md @@ -23,7 +23,7 @@ zowe plugins list ## Updating to the Zowe CLI V3 Long-term Support (v3-lts) version -If you are running Zowe CLI version v2.0.0 to v2.15.x, you can update to `@zowe-v3-lts` (LTS version) to leverage the latest Zowe CLI and Zowe CLI plug-ins functionality. +If you are running the Zowe CLI version included with Zowe release v2.0.0 to v2.15.x, you can update to `@zowe-v3-lts` (LTS version) to leverage the latest Zowe CLI and Zowe CLI plug-ins functionality. ### Updating from an npm online registry diff --git a/docs/user-guide/cli-using-initializing-team-configuration.md b/docs/user-guide/cli-using-initializing-team-configuration.md index c37be8da91..d7938ff5b5 100644 --- a/docs/user-guide/cli-using-initializing-team-configuration.md +++ b/docs/user-guide/cli-using-initializing-team-configuration.md @@ -104,7 +104,9 @@ To create a team plug-in profile: ## Connecting profiles to API Mediation Layer -If you are using the API Mediation Layer, set up the `zowe.config.json` file to automatically access the services that are registered to the API ML and support Single Sign-On. +You can use profiles to connect to the API Mediation Layer. This more efficient way to connect to the mainframe allows you to specify a host and port only once on a base profile instead of multiple host-and-port combinations across several service profiles. + +To set up the `zowe.config.json` file to automatically access the services that are registered to the API ML and support Single Sign-On: 1. Open a command line window and issue the following command: @@ -112,26 +114,25 @@ If you are using the API Mediation Layer, set up the `zowe.config.json` file to zowe config auto-init --global-config ``` + :::note + + To add a profile to a configuration file in the current working directory, enter the base command without the `--global-config` option: `zowe config auto-init`. + + ::: + 2. Respond to subsequent CLI prompts with the following information: - The host name and port to your API ML instance. - Your username and password. - A default profile is added to the configuration file in the `.zowe` home directory. + A default base profile is added to the configuration file in the `.zowe` home directory. -:::note - -To add a profile to a configuration file in the current working directory, enter the base command without the `--global-config` option: `zowe config init`. - -::: + :::note -## Using Certificates + To use certificates instead of basic authentication (such as user ID and password), you can specify the options `--cert-file` and `--cert-key-file` on the base command (`zowe config auto-init`). For more information on how to log in with certificates, see [Integrating with API Mediation Layer](../user-guide/cli-using-integrating-apiml). + + ::: -**[what does this apply to? api ml? everything in this article?]** -If using certificates to authenticate, specify the details for the certificates by modifying the following example command with your information: -``` -zowe auth login apiml --cert-file "/path/to/cert/file" --cert-key-file "/path/to/cert/key/file" -``` diff --git a/docs/user-guide/cli-using-using-daemon-mode.md b/docs/user-guide/cli-using-using-daemon-mode.md index 5d3872cb7e..646e8a7739 100644 --- a/docs/user-guide/cli-using-using-daemon-mode.md +++ b/docs/user-guide/cli-using-using-daemon-mode.md @@ -13,7 +13,7 @@ Review the following installation notes before you configure Zowe CLI to run in - Daemon mode does not function on z/OS UNIX System Services (USS) systems. - When you want Zowe CLI to run in daemon mode on z/Linux operating systems, you must build the daemon mode binary on the z/Linux systems. For information about how to build the binary, see [Configuring daemon mode on z/Linux operating systems](../user-guide/cli-configure-daemon-on-zlinux-os.md). The sections [Enabling daemon mode](#enabling-daemon-mode) and [Disabling daemon mode](#disabling-daemon-mode) (in this article) **do not apply** to running Zowe CLI in daemon mode on z/Linux operating systems. -- We do not recommend using daemon mode in an environment where multiple users use the same system. For example, a shared Linux server. **[can we explain why we don't recommend this?]** +- We do not recommend using daemon mode in an environment where multiple users use the same system. For example, a shared Linux server. This could result in increased consumption of system resources. - When you are running Zowe on a Windows operating system in a virtual environment (for example, Windows Sandbox), you might receive an error message that indicates that a library named `VCRUNTIME140.dll` is missing. To correct the error, install Visual C++ Redistributable for Visual Studio 2015. For more information, see [Download Visual C++ Redistributable for Visual Studio 2015](https://www.microsoft.com/en-us/download/details.aspx?id=48145) in the Microsoft Download Center. ## Enabling daemon mode @@ -58,7 +58,7 @@ The following example illustrates running Zowe CLI commands with daemon mode ena ``` :::note -When you are running Zowe CLI in daemon mode using a Git Bash terminal on a Windows operating system, special characters might display using the wrong code page. For example, the default code page 437 renders a form-feed character (\f) as an emoji (♀️) **[<--is this really an emoji? do we need a better example?]**. +When you are running Zowe CLI in daemon mode using a Git Bash terminal on a Windows operating system, special characters might display using the wrong code page. For example, the default code page 437 renders a form-feed character (\f) as a unicode symbol (♀️). To correct this, issue the command `chcp.com 65001` to change the code page to UTF-8. If you want the change to be persistent, add the command to your `.bashrc` file in the `//Users//.bashrc` directory.