Proxy Administration |
Sun xVM Ops Center 1.1 Home Man Pages |
Name
proxyadm - Manipulates proxy services
Synopsis
/opt/SUNWxvmoc/bin/proxyadm -V
/opt/SUNWxvmoc/bin/proxyadm -h|--help
/opt/SUNWxvmoc/bin/proxyadm subcommand [ options ]
Description
The proxyadm command helps to start, stop, configure and unconfigure the xVM Ops Center proxy services.
Options
The proxyadm command supports the following options:
-h | --help: Displays the usage synopsis for proxyadm.
-V: Displays the version of Sun xVM Ops Center.
Subcommands
The proxyadm command includes the following subcommands:
start
Starts the proxy services running on the host.
stop
Stops the proxy services running on the host.
status
Displays the online or offline status of the proxy services to the standard output, and sets the exit status to reflect the proxy service state.
configure
Performs configuration tasks for the proxy services.
You can set the following classes of configuration information:
- Registering the proxy with the xVM Ops Center satellite server.
- Configuring the type of DHCP server that the proxy will be running along with the parameters for that DHCP server.
unconfigure
Performs the inverse operation of configuring the proxy.
Subcommand options
The following common options are supported for all the subcommands:
-h | --help: Displays the usage synopsis for that subcommand.
-v | --verbose: Displays verbose error and informational messages.
start
/opt/SUNWxvmoc/bin/proxyadm start [ -h | --help ] [ -v | --verbose ] [ -w | --wait ] [ -l | --logfile <logfile> ]
-w | --wait: proxyadm does not exit until all the services are started.
-l | --logfile <logfile>: Captures any output from proxyadm in the logfile.
stop
/opt/SUNWxvmoc/bin/proxyadm stop [ -h | --help ] [ -v | --verbose ] [ -w | --wait ] [ -l | --logfile <logfile> ]
-w | --wait: proxyadm does not exit until all the services are stopped.
-l | --logfile <logfile>: Captures any output from proxyadm in the logfile.
status
/opt/SUNWxvmoc/bin/proxyadm status [ -h |--help ]
configure
/opt/SUNWxvmoc/bin/proxyadm configure [ -h | --help ] [ -v | --verbose ] [ -s | --satellite <hostname> ] [ -u | --user <username> ] [ -p | --passwordfile <passwordfile> ] [ -X | --proxy <hostname>[:<port>] ] [ -U | --proxy-user <proxyusername> ] [ -P | --proxy-passwordfile <passwordfile> ] [ -D | --dhcp-server <hostname> ] [ -I | --provisioning-interface <interfacename> ] [ -L | --low-ip <ip-addr> ] [ -H | --high-ip <ip-addr> ]
-s | --satellite <hostname>: Specifies the hostname of the satellite to register the proxy.
-u | --user <username>: Specifies the Sun Online Account (SOA) username used for registration.
-p | --passwordfile <passwordfile>: Specifies a filename containing the password for the SOA user.
The following options are optional for registering the proxy server with the satellite:
-X | --proxy <hostname>[:<port> ]: If an HTTPS proxy server is required to reach the satellite, specify the <hostname> for that proxy. Specifying the IP port is optional.
-U | --proxy-user <proxyusername>: If a proxy requires a username for authentication, use <proxyusername>.
-P | --proxy-passwordfile <password file>: Uses the password in <proxypasswordfile> for proxy authentication.
The following options are supported for configuring the DHCP server:
-D | --dhcp-server <hostname>: Specify the type of DHCP server (ISC or Solaris).
-I | --provisioning-interface <interfacename>: Specify the network interface name on which the DHCP server will provide the DHCP services.
-L | --low-ip <ip-addr>: Restricts the DHCP server to answer requests for IP addresses with addresses beginning with <ip-addr> on <interfacename>.
-H | --high-ip <ip-addr>: Restricts the DHCP server to answer requests for IP addresses with addresses ending with <ip-addr> on <interfacename>.
| Be Careful The password file should be secured to prevent unauthorized users from examining the file. The file permission should be set to 400. |
unconfigure
/opt/SUNWxvmoc/bin/proxyadm unconfigure [ -h | --help ] [ -s | --satellite ] [ -D | --DHCP ]
Use the following option to unconfigure the DHCP server:
-D | --DHCP: Unconfigures and disables the DHCP server on the proxy.
Use the following option is used to unconfigure the satellite registration:
-s | --satellite: De-registers and unconfigures the connection between the proxy and the satellite with which it was associated.
Exit status
The exit status displays the status of the proxy services. The states currently displays either offline or online on the standard output.
The exit status displays the following status code:
Exit Code Status
0 Online
2 Offline
1 Error occurred during processing

