Using the cf CLI with a Proxy Server

Page last updated:

This topic describes using the Cloud Foundry Command Line Interface (cf CLI) with a proxy server.

Overview

If you have an HTTP or SOCKS5 proxy server on your network between a host running the cf CLI and your API endpoint, you must set https_proxy with the hostname or IP address of the proxy server. The https_proxy environment variable holds the hostname or IP address of your proxy server.

https_proxy is a standard environment variable. Like any environment variable, the specific steps you use to set it depends on your operating system.

Format of https_proxy

https_proxy is set with hostname or IP address of the proxy server in URL format, as in the example below:

https_proxy=http://proxy.example.com

If the proxy server requires a username and password, you must include the credentials, as in the example below:

https_proxy=http://username:password@proxy.example.com

If the proxy server uses a port other than 80, you must include the port number, as in the example below:

https_proxy=http://username:password@proxy.example.com:8080

If the proxy server is a SOCKS5 proxy, you must specify the SOCKS5 protocol in the URL, as in the example below:

https_proxy=socks5://socks_proxy.example.com

Use SOCKS5 with cf v3-ssh

The cf v3-ssh command in cf CLI v6 supports SOCKS5 proxies.

To specify the SOCKS5 proxy server:

  1. Set the all_proxy environment variable, as in the example below:

    all_proxy=socks5://socks_proxy.example.com
    

Note: The cf ssh command for cf CLI v7 does not work through a SOCKS5 proxy.

Set https_proxy in Mac OS or Linux

To set the https_proxy environment variable in Mac OS or Linux:

  1. Use the command specific to your shell. For example, in bash, use the export command, as in the example below:

    export https_proxy=http://my.proxyserver.com:8080
    
  2. To make this change persistent, add the command to the appropriate profile file for the shell. For example, in bash, add a line like example below to your .bash_profile or .bashrc file:

    https_proxy=http://username:password@hostname:port
    export $https_proxy
    

Set https_proxy in Windows

To set the https_proxy environment variable in Windows:

  1. Open the Start menu.

  2. Right-click Computer and select Properties.

    Properties

  3. In the left pane of the System window, click Advanced system settings.

    Adv settings

  4. In the System Properties window:

    1. Select Advanced.
    2. Click Environment Variables.

    Env var

  5. Under User variables, click New.

    New

  6. For Variable name, enter https_proxy.

  7. For Variable value, enter your proxy server information.

    Proxy

  8. Click OK.