Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

proxy env variable doc #3983

Merged
merged 7 commits into from
Nov 11, 2024
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions docs/user-guide/cli-configuringcli-ev.md
Original file line number Diff line number Diff line change
Expand Up @@ -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: `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` |
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).|

2 changes: 1 addition & 1 deletion docs/user-guide/cli-using-using-environment-variables.md
Original file line number Diff 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).
Loading