From 838cc3ceb2cda6254427b843fdfdaae4968d3d5b Mon Sep 17 00:00:00 2001 From: anaxceron <ana.ceron@broadcom.com> Date: Tue, 5 Nov 2024 16:05:32 -0500 Subject: [PATCH 1/4] proxy env variable doc Signed-off-by: anaxceron <ana.ceron@broadcom.com> --- docs/user-guide/cli-configuringcli-ev.md | 10 ++++++++++ .../cli-using-formatting-environment-variables.md | 1 - .../cli-using-using-environment-variables.md | 2 +- 3 files changed, 11 insertions(+), 2 deletions(-) diff --git a/docs/user-guide/cli-configuringcli-ev.md b/docs/user-guide/cli-configuringcli-ev.md index f9a627604d..79a988e2bd 100644 --- a/docs/user-guide/cli-configuringcli-ev.md +++ b/docs/user-guide/cli-configuringcli-ev.md @@ -74,3 +74,13 @@ Use the `--show-inputs-only` option in a Zowe CLI command to view the property v | Environment variable | Description | Values | Default | | ---------------------- | ----------- |------- | ------- | | `ZOWE_SHOW_SECURE_ARGS` | Displays secure property values used by a Zowe CLI command | `TRUE`, `FALSE` | `FALSE` | + +## Using Zowe CLI with a proxy + +If your network configuration requires communication with the mainframe to be performed through a proxy server, set environment variables to route Zowe CLI traffic through an HTTP/HTTPS proxy. + +| Environment Variable | Description | +| ---------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `HTTPS_PROXY`, `https_proxy` | Use the `https` proxy to route communication to the mainframe when your proxy server supports `https`. | +| `HTTP_PROXY`, `http_proxy` | Use the `http` proxy to route communication to the mainframe. | +| `NO_PROXY` | Set a list of host addresses (separated by commas) to connect to the specified hosts without going through a proxy.| diff --git a/docs/user-guide/cli-using-formatting-environment-variables.md b/docs/user-guide/cli-using-formatting-environment-variables.md index 523a3aa80c..102ea11d61 100644 --- a/docs/user-guide/cli-using-formatting-environment-variables.md +++ b/docs/user-guide/cli-using-formatting-environment-variables.md @@ -19,4 +19,3 @@ The following table provides examples of CLI options and the corresponding envir | `--user` | `ZOWE_OPT_USER` | Define your mainframe username to an environment variable to avoid specifying it on all commands or profiles. | | `--reject-unauthorized` | `ZOWE_OPT_REJECT_UNAUTHORIZED` | Define a value of `true` to the `--reject-unauthorized` flag when you always require the flag and do not want to specify it on all commands or profiles. | | `--editor` | `ZOWE_OPT_EDITOR` | Define an editor that Zowe CLI uses to open files. The value can be either the editor's executable file location or the name of a program (for example, *notepad* on Windows or *nano* on Linux).| - diff --git a/docs/user-guide/cli-using-using-environment-variables.md b/docs/user-guide/cli-using-using-environment-variables.md index 51d9c889e1..91fa1a17c1 100644 --- a/docs/user-guide/cli-using-using-environment-variables.md +++ b/docs/user-guide/cli-using-using-environment-variables.md @@ -53,4 +53,4 @@ pipeline { } ``` -For more information on Jenkins credential storage, see [Using credentials](https://www.jenkins.io/doc/book/using/using-credentials/) and Using a [Jenkinsfile](https://www.jenkins.io/doc/book/pipeline/jenkinsfile/#for-secret-text-usernames-and-passwords-and-secret-files). \ No newline at end of file +For more information on Jenkins credential storage, see [Using credentials](https://www.jenkins.io/doc/book/using/using-credentials/) and Using a [Jenkinsfile](https://www.jenkins.io/doc/book/pipeline/jenkinsfile/#for-secret-text-usernames-and-passwords-and-secret-files). From bb89af1121691f79f96de5b936432361376f4228 Mon Sep 17 00:00:00 2001 From: anaxceron <ana.ceron@broadcom.com> Date: Fri, 8 Nov 2024 15:13:58 -0500 Subject: [PATCH 2/4] minor update Signed-off-by: anaxceron <ana.ceron@broadcom.com> --- docs/user-guide/cli-configuringcli-ev.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/user-guide/cli-configuringcli-ev.md b/docs/user-guide/cli-configuringcli-ev.md index 79a988e2bd..c9cdeebd03 100644 --- a/docs/user-guide/cli-configuringcli-ev.md +++ b/docs/user-guide/cli-configuringcli-ev.md @@ -79,8 +79,8 @@ Use the `--show-inputs-only` option in a Zowe CLI command to view the property v If your network configuration requires communication with the mainframe to be performed through a proxy server, set environment variables to route Zowe CLI traffic through an HTTP/HTTPS proxy. -| Environment Variable | Description | -| ---------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `HTTPS_PROXY`, `https_proxy` | Use the `https` proxy to route communication to the mainframe when your proxy server supports `https`. | -| `HTTP_PROXY`, `http_proxy` | Use the `http` proxy to route communication to the mainframe. | -| `NO_PROXY` | Set a list of host addresses (separated by commas) to connect to the specified hosts without going through a proxy.| +| Environment Variable | Description | Example Value | +| - | - | - | +| `HTTPS_PROXY`, `https_proxy` | Use an `https` proxy to route communication to the mainframe when your proxy server supports `https`. | If authentication required: </br> `https://[user]:[password]@[address]:[port]` </br> If authentication not required: `https://[address]:[port]` | +| `HTTP_PROXY`, `http_proxy` | Use an `http` proxy to route communication to the mainframe when your proxy server does not support `https`. | If authentication required: </br> `http://[user]:[password]@[address]:[port]` </br> If authentication not required: `http://[address]:[port]`| +| `NO_PROXY` | Set a list of host addresses (separated by commas) to connect to the specified hosts without going through a proxy.| `https://[address_1],https://[address_2]`, `http://[address_1],http://[address_2]`, `*.address_1,*.address_2` | From 6d2f91292b79f13c571fba639fe5a9fd78233849 Mon Sep 17 00:00:00 2001 From: anaxceron <ana.ceron@broadcom.com> Date: Mon, 11 Nov 2024 11:14:03 -0500 Subject: [PATCH 3/4] fixing syntax Signed-off-by: anaxceron <ana.ceron@broadcom.com> --- docs/user-guide/cli-configuringcli-ev.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/user-guide/cli-configuringcli-ev.md b/docs/user-guide/cli-configuringcli-ev.md index c9cdeebd03..79149f6a8e 100644 --- a/docs/user-guide/cli-configuringcli-ev.md +++ b/docs/user-guide/cli-configuringcli-ev.md @@ -81,6 +81,6 @@ If your network configuration requires communication with the mainframe to be pe | Environment Variable | Description | Example Value | | - | - | - | -| `HTTPS_PROXY`, `https_proxy` | Use an `https` proxy to route communication to the mainframe when your proxy server supports `https`. | If authentication required: </br> `https://[user]:[password]@[address]:[port]` </br> If authentication not required: `https://[address]:[port]` | -| `HTTP_PROXY`, `http_proxy` | Use an `http` proxy to route communication to the mainframe when your proxy server does not support `https`. | If authentication required: </br> `http://[user]:[password]@[address]:[port]` </br> If authentication not required: `http://[address]:[port]`| +| `HTTPS_PROXY`, `https_proxy` | Use an `https` proxy to route communication to the mainframe when your proxy server supports `https`. | If authentication required: <br /> `https://[user]:[password]@[address]:[port]` <br /> If authentication not required: `https://[address]:[port]` | +| `HTTP_PROXY`, `http_proxy` | Use an `http` proxy to route communication to the mainframe when your proxy server does not support `https`. | If authentication required: <br /> `http://[user]:[password]@[address]:[port]` <br /> If authentication not required: `http://[address]:[port]`| | `NO_PROXY` | Set a list of host addresses (separated by commas) to connect to the specified hosts without going through a proxy.| `https://[address_1],https://[address_2]`, `http://[address_1],http://[address_2]`, `*.address_1,*.address_2` | From c00f08ef7d842a479050857cf8fe9143e546cf8b Mon Sep 17 00:00:00 2001 From: anaxceron <ana.ceron@broadcom.com> Date: Mon, 11 Nov 2024 12:17:13 -0500 Subject: [PATCH 4/4] updating syntax Signed-off-by: anaxceron <ana.ceron@broadcom.com> --- docs/user-guide/cli-configuringcli-ev.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/user-guide/cli-configuringcli-ev.md b/docs/user-guide/cli-configuringcli-ev.md index 79149f6a8e..9761370094 100644 --- a/docs/user-guide/cli-configuringcli-ev.md +++ b/docs/user-guide/cli-configuringcli-ev.md @@ -81,6 +81,6 @@ If your network configuration requires communication with the mainframe to be pe | Environment Variable | Description | Example Value | | - | - | - | -| `HTTPS_PROXY`, `https_proxy` | Use an `https` proxy to route communication to the mainframe when your proxy server supports `https`. | If authentication required: <br /> `https://[user]:[password]@[address]:[port]` <br /> If authentication not required: `https://[address]:[port]` | -| `HTTP_PROXY`, `http_proxy` | Use an `http` proxy to route communication to the mainframe when your proxy server does not support `https`. | If authentication required: <br /> `http://[user]:[password]@[address]:[port]` <br /> If authentication not required: `http://[address]:[port]`| +| `HTTPS_PROXY`, `https_proxy` | Use an `https` proxy to route communication to the mainframe when your proxy server supports `https`. | If authentication required: <br/> `https://[user]:[password]@[address]:[port]` <br/> If authentication not required:<br/> `https://[address]:[port]` | +| `HTTP_PROXY`, `http_proxy` | Use an `http` proxy to route communication to the mainframe when your proxy server does not support `https`. | If authentication required: <br/>`http://[user]:[password]@[address]:[port]` <br/> If authentication not required:<br/> `http://[address]:[port]`| | `NO_PROXY` | Set a list of host addresses (separated by commas) to connect to the specified hosts without going through a proxy.| `https://[address_1],https://[address_2]`, `http://[address_1],http://[address_2]`, `*.address_1,*.address_2` |