Create Proxy
Verb: createProxy
Creates an instance of a proxy for remote communication.
Proxy is a feature that acts to establish the intermediaries between the user and the internet, with the function of receiving and passing all requests to the accessed server.
Syntax
createProxy --address(String) [--username(String)] [--password(String)] [--bypassonlocal(Boolean)] (ProxyVariant)=value
Inputs
| Script | Designer | Required | AcceptedTypes | Description |
|---|---|---|---|---|
| --address | Address | Required | Text | Address and port of a proxy server. |
| --username | User Name | Optional | Text | User to log in to an instance of a proxy. |
| --password | Password | Optional | Text | Password to log in to an instance of a proxy. |
| --bypassonlocal | Bypass Proxy for Local Address | Optional | Boolean | Bypasses the proxy to access local network addresses. |
Outputs
| Script | Designer | AcceptedTypes | Description |
|---|---|---|---|
| value | Proxy | Proxy | Returns a variable of type Proxy with the settings defined. |
Example
The command simulates a proxy creation, assigning address, username and password settings to the respective parameters.
defVar --name proxy --type ProxyVariant
defVar --name success --type Boolean
createProxy --address "ProxyAddress" --username proxyUser --password proxyPassword --bypassonlocal proxy=value
logMessage --message "Success: ${success}" --type "Info"
For this command to work properly, valid proxy information is needed. Substitute ProxyAddress for a valid IP Address for a configured proxy connection; in proxyUser and proxyPassword, enter valid username and passwords for that specific proxy connection.
Remarks
The variable returned by the Create Proxy command is used in the Proxy parameter of the HTTP Request command.