The table below lists and defines PHSETUP control parameters.
Parameter
Definition
@path&filename
Create a text file the includes a series of PHSETUP commands. Use this parameter with a call to PHSETUP to run the text file (command line script) (referred to here as filename), and process the PHSETUP commands listed in the text file exactly as if you were to call them directly from PHSETUP.
If you include lines in the text file that begin with a semicolon (;), they are treated as comment lines and are ignored.
importjson:path&filename
Import a JSON-formatted file of Host settings, such as one created with the mode:exportjson option. This option can be combined on the command line with other options to fully configure the Host.
/p
Specify the protocol or a “protocol|port” pair to use when connecting to a Host computer for the purpose of configuring it. For peer-to-peer connections to a Host computer for the purpose of configuration, the protocol you specify connects your local computer to the Host computer. The entire phrase is in double quotes. You can use this command to specify the protocol and port (other than defaults).
The following examples assign the standard port in each case:
/pTCP for TCP/IP protocol. No quotes required.
/pUDP for UDP/IP protocol. No quotes required.
/pSSL for SSL protocol. No quotes required.
/pWSS for WSSprotocol. No quotes required.
Use the following syntax to specify the port:
/p"Protocol_name|Port_number"
Example:
/p"TCP|5001"
Notice that the vertical bar is required as a separator for the protocol/port number pair, and this then requires the string to be quoted.
/s (peer-to-peer)
Specify the station when connecting directly to a Host computer for the purpose of configuring it. This value is in quotes, and is the string value for the station name, DNS name, or network address specifier for peer-to-peer connections. The peer-to-peer syntax depends on your protocol specification.
The following are some protocol-specific examples:
/pUDP /S192.168.160.138
/pTCP /Sjackson
/pTCP /Sjackson.acme.com
/g /s (connections through a PROXY Pro Gateway)
Specify the PROXY Pro Gateway and Host computer when connecting to a Host computer through a PROXY Pro Gateway for the purpose of Host computer configuration. Specify these values in double quotes. Note that when you specify the PROXY Pro Gateway and protocol (using /p), the protocol applies to the connection between your local computer and the PROXY Pro Gateway. The /g value is the string value for the Gateway name, and the /s value is the string value for the type of host (logged-in user or workstation) and the Host key for remote connections through a PROXY Pro Gateway.
The Gateway syntax for /s values depends on your host specification. Use u for a logged-in user and w (with curly braces) for a workstation:
•“u=host_key"
•“w={host_key}"
NOTE: The u that you use for the Gateway syntax of /S is independent of the /U command.
To find the workstation Host key, navigate to the "About tab" of PROXY Pro Host. Click System Information, and select the text listed next to PROXY Pro Host Workstation Id.
The following rows have host format-specific examples.
When configuring a Host computer, specify a user account name to use when connecting to the Host computer (either peer-to-peer, or through a PROXY Pro Gateway). You need only specify the user account name when your logged in credentials are not sufficient for configuring the Host computer (either directly, or through a PROXY Pro Gateway).
Example: /U“ACME\george"
/x
When configuring a Host computer, specify a password for the user account you use when connecting to the Host computer (either peer-to-peer, or through a PROXY Pro Gateway). You need only specify the password when your logged in credentials are not sufficient for configuring the Host computer (either directly, or through a PROXY Pro Gateway). The value to specify is a string value for the password in quotes. The syntax is as follows: /X“password"
Example: /X“foo"
mode
There are several mode commands you can issue at the beginning of a PHSETUP command:
•mode:interactive, to allow for error messages to appear during the command executions.
•mode:lockdown, to lock one or more PROXY Pro Host features.
•mode:terminalservices, to cause the command line to affect the Terminal Services template copy of the settings, not the root Host settings. Note that this is mutually exclusive with mode:lockdown,which is not applicable to TS template.
•mode:exportjson, to export the settings into JSON format at the end of execution; this allows settings changes to be made using other keywords on the command line. The exported settings are placed in a file name <machinename>_HostSettings.json on the desktop.
•mode:reset, to reset all settings associated with the current mode (e.g. mode:lockdown, or mode:terminalservices, or default mode) to their installation defaults
If none of these options is specified, then the default mode is non-interactive. PHSETUP does not display error messages even if an error occurs (this avoids interrupting a batch file or login script processing.
NOTE: When you use the mode:lockdown parameter to lock down PROXY Pro Host, you cannot use the /p, /g, /s, /x, or /u parameters. See “Lock Host settings” for more information on this control.
