Network
- Connect
Declaration
<AMNETWORK CONNECTION="text (options)" ENTRY="text" NUMBER="number" USERNAME="text" PASSWORD="text (encrypted)" REDIAL="number" REDIALTIME="number" WAITTYPE="text (options)" />
Description
Establishes a connection to another network using a Virtual Private Network (VPN) or Dial-Up Network (DUN) connection.
Practical usage
Used to connect to the Internet with a modem or other network device if needed before executing Internet actions.
Parameters
Predefined Connection
| Property | Type | Required | Default | Markup | Description |
|---|---|---|---|---|---|
| Connection | Text (options) | Yes | Predefined | CONNECTION="manual" | Specifies
whether the connection derives from an existing phone book entry
created during Dial-Up Networking (DUN) or Virtual Private Network
(VPN) configuration or that it will be manually entered in the
properties of this activity. The available options are:
|
| Connections | Text | Yes, if connection is set to Predefined | (Empty) | ENTRY="myConnection" | The name of an existing Dial-Up Networking (DUN) or Virtual Private Network (VPN) connection. To select an existing entry, click the Down arrow and select from the drop-down list of available named connections or manually enter the name of the connection in the provided text box. This parameter is active only if the Connection parameter is set to Predefined. |
| Phone number | Number | Yes, if connection is set to Manual | (Empty) |
|
The phone number that should be used to establish a DUN or VPN connection. This parameter is active only if the Connection parameter is set to Manual. |
| Username | Text | Yes, if connection is set to Manual | (Empty) | USERNAME="joe" | The username to authenticate with when establishing a remote connection. This parameter is active only if the Connection parameter is set to Manual. |
| Password | Text | Yes, if connection is set to Manual | (Empty) | PASSWORD="encrypted" | The password to authenticate with when establishing a remote connection. This parameter is active only if the Connection parameter is set to Manual. |
Advanced
| Property | Type | Required | Default | Markup | Description |
|---|---|---|---|---|---|
| Attempt redial | --- | --- | --- | --- | If
enabled, allows redial settings to take place as specified by way of
the Redial Attempts and
Time Between Attempts
parameters. NOTE: This parameter does not contain markup and is only displayed in visual mode for task construction and configuration purposes. |
| Redial attempts | Number | No | (Empty) | REDIAL="3" | Specifies the amount of times that the connection should be re-dialed before an error is generated. This option is valid only if the Action parameter is set to Establish a connection. |
| Time between attempts | Text | No | 0 | REDIALTIME="30" | Specifies the amount of time to wait before attempting to redial the connection. The Wait Type parameter specifies whether this value is referring to seconds or minutes. This option is valid only if the Action parameter is set to Establish a connection. |
| Wait measure | Text (options) | No | minutes | WAITTYPE="minutes" |
Specifies whether the number entered in the Time between attempts parameter is in seconds or minutes. The available options are:
|
Example
NOTE:
- Copy and paste the sample AML code below directly into the Task Builder Steps Panel.
- To successfully run the sample code, update parameters containing user credentials, files, file paths, or other information specific to the task to match your environment.
Description
This sample task establishes a connection to a network.
Copy
<AMNETWORK CONNECTION="manual" NUMBER="555-867-3734" USERNAME="theUserName" PASSWORD="AM3V7hFgOHqLgo=aME" REDIAL="3" REDIALTIME="10" />