About this Resource
Defines the Link Monitor Managed ObjectREST API Methods for this Resource
- GET linkmonitor
- GET linkmonitor id
- POST linkmonitor id
- PUT linkmonitor id
- DELETE linkmonitor id
- POST linkmonitor - action resetlinkmonitorcounters
Resource Schema
Configuration
| Parameter Name | Required | Service Affecting | Data Type | Default Value | Possible Values | Description |
|---|---|---|---|---|---|---|
| GWDescription | No | No | string | none | 64 - Max Length | Assign an operator-friendly gateway description text configured by the operator for future reference. |
| HostType | Yes | No | Enum | 0 | Possible values:
| Specifies whether the peer is a Host or Gateway that is being monitored. |
| HostIpAddress | Yes | No | string | none | 255 - Max Length | Specifies the IP address or FQDN of the destination to be monitored. If HostType is eHost, this value could be an IP Address or an FQDN. If HostType is eGateway, this value is an IP Address of the gateway. If this host/gateway is reachable, it indicates that the WAN link is healthy. |
| TimeProbePeriod | Yes | No | int | 10 | Possible values:
| Specifies the poll frequency time in seconds, for testing the link status. The host or the nexthop gateway specified by HostIpAddress is probed for every TimeProbePeriod specified. |
| PollToDownState | Yes | No | int | 3 | Possible values:
| Specifies the number of failure attempts, to the probe in reaching the gateway, after which the gateway is declared to be in DOWN state. When the gateway is declared DOWN, the sequence of actions ("DownAction_x") are executed. Probes are continued to detect if the gateway becomes reachable again. |
| PollToServiceReadyState | Yes | No | int | 3 | Possible values:
| Specifies the number of success polls, from REACHABLE state for which the system must stay in the REACHABLE state, before being declared to be ready for service (i.e. for calls, data etc). |
| IdIPsec_1 | No | Yes | int | 0 | Specifies the IPsec tunnel ID to be activated when this gateway is in use. The tunnel is terminated when this gateway is not in use. | |
| IdIPsec_2 | No | Yes | int | 0 | Specifies the IPsec tunnel ID to be activated when this gateway is in use. The tunnel is terminated when this gateway is not is use. | |
| IdIPsec_3 | No | Yes | int | 0 | Specifies the IPsec tunnel ID to be activated when this gateway is in use. The tunnel is terminated when this gateway is not in use. | |
| IdIPsec_4 | No | Yes | int | 0 | Specifies the IPsec tunnel ID to be activated when this gateway is in use. The tunnel is terminated when this gateway is not in use. | |
| CACProfileID | No | No | int | 0 | Specifies the CAC profile ID associated with this gateway. For Host the CACProfileID is 0. |
Runtime
| Parameter Name | Description | Data Type | Possible Values |
|---|---|---|---|
| rt_HostIpAddress | Specifies the IP address of the host or gateway . | string | |
| rt_ServiceState | Indicates the state of the link monitoring the host or gateway. | Enum | Possible values:
|
| rt_InUse | Indicates if the current gateway is used as the default gateway. | Enum | Possible values:
|
Overview
Content Tools