nstsetproxy

Name

nstsetproxy — Used to manage proxy server configuration for NST.

Synopsis

Description

The nstsetproxy is used by the root user to manage (set/query) the proxy server configuration for a NST probe. It can:

Configure the proxy server settings for shell environments, , elinks, dnf as well as other NST scripts with a single invocation.
Show the last proxy settings.
Remove the proxy settings.

The default operation (when invoked without arguments) is to display the current proxy server settings found in /etc/nst.proxy.conf. In order to change proxy server settings, you MUST include either the -i HOST or --http-host HOST (they are equivalent) on the command line.

Note

In order to change the system proxy configurations, this script must be run as root.

Warning

One should avoid using the --user USER and --password PASSWORD options if the NST probe is public access is given to the NST probe. Both of these values will be stored as plain text values in files which are readable by anyone having access to the system.

Options

The following command line options are available:

[-i HOSTNAME|IPv4ADDR] | [--http-host HOSTNAME|IPv4ADDR]: If this option is omitted, we we report the current proxy information. To actually set the proxy, you MUST specify a host IPv4 Address or Host Name. For example --host 192.168.1.1.
[-p PORT] | [--http-port PORT]: This option allows one to specify the port number of the HTTP proxy. If omitted, it defaults to port 3128 as this is typical of a squid based proxy.
[-r [true]|false] | [--remove [true]|false]: If you supply this option, we will remove any (and all) proxy information that is managed by nstsetproxy.
[-u TEXT] | [--user TEXT]: Some proxy servers require authentication prior to use. This argument allows one to specify the user name to use when logging into the proxy server. NOTE: This will appear as clear text in the files that are updated by nstsetproxy. The default value, if omitted, is: NOT_REQUIRED indicating that authentication is not required.
[--password TEXT]: Some proxy servers require authentication prior to use. This argument allows one to specify the password to use when logging into the proxy server. NOTE: This will appear as clear text in the files that are updated by nstsetproxy. The default value, if omitted, is: NOT_REQUIRED indicating that authentication is not required.
[-s HOSTNAME|IPv4ADDR] | [--https-host HOSTNAME|IPv4ADDR]: You only need to specify this if FTP connections require a different proxy server than HTTP connections.
[--https-port PORT]: You only need to specify this if HTTPS connections require a different proxy server than HTTP connections.
[-f HOSTNAME|IPv4ADDR] | [--ftp-host HOSTNAME|IPv4ADDR]: You only need to specify this if FTP connections require a different proxy server than HTTP connections.
[--ftp-port PORT]: You only need to specify this if FTP connections require a different proxy server than HTTP connections.
[-t TEXT] | [--targets TEXT]: You can limit which system configuration files this script modifies with this option. You may specify a comma separated list containing any of the following keywords: elinks, nst, wget, dnf, sh, and csh.
[-h [true]|false] | [--help [true]|false]: When this option is specified, nstsetproxy will display a short one line description of nstsetproxy, followed by a short description of each of the supported command line options. After displaying this information nstsetproxy will terminate.
[-H [true]|false] | [--help-long [true]|false]: This option will attempt to pull up additional nstsetproxy documentation within a text based web browser. You can force which browser we use setting the environment variable TEXTBROWSER, otherwise, we will search for some common ones.
[-v [true]|false] | [--verbose [true]|false]: When you set this option to true, nstsetproxy will produce additional output. This is typically used for diagnostic purposes to help track down when things go wrong.
[--version [true]|false]: If this option is specified, the version number of the script is displayed.

Files

/etc/nst.proxy.conf: The NST proxy configuration created the last time this script was used to configure the proxy server(s). This corresponds to the nst target.
/etc/wgetrc: The configuration for wget which is modified/created when this script is used to configure the proxy server(s). This corresponds to the wget target.
/etc/elinks.conf: The configuration for elinks which is modified/created when this script is used to configure the proxy server(s). This corresponds to the elinks target.
/etc/dnf/dnf.conf: The configuration for yum which is modified/created when this script is used to configure the proxy server(s). This corresponds to the yum target.
/etc/profile.d/nstsetproxy.sh: The configuration for user shell environments (like: bash) which is modified/created when this script is used to configure the proxy server(s). This corresponds to the sh target.
/etc/profile.d/nstsetproxy.csh: The configuration for user C shell environments (like: csh and tcsh) which is modified/created when this script is used to configure the proxy server(s). This corresponds to the csh target.

Environment

TEXTBROWSER: This controls what text based browser is used to display help information about the script. If not set, we will search your system for available text-based browsers (Ex: elinks, lynx ...).