Merge pull request #3983 from zowe/anax-v3.0-proxydoc-cli

proxy env variable doc
zowe · Nov 11, 2024 · 87f7495 · 87f7495
2 parents 8110cb6 + d13ff5c
commit 87f7495
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 2 deletions.
diff --git 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   |   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:<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` |
diff --git 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
@@ -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).
+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).
Original file line number	Diff line number	Diff line change
Expand Up		@@ -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).\|
-Original file line number
+Diff line change
@@ Expand Up / @@ -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).
+    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).