REST API Method: PUT /rest/linkmonitor/{identifier}

Creates a Link Monitor Configuration entry given a specific ID.

URL:

https://192.168.0.111/rest/linkmonitor/{identifier}

HTTP Method

PUT

Requires Authentication:

true

linkmonitor - REST API Methods

Parameters

Parameter Name Required Service Affecting Data Type Default Value Possible Values Description
GWDescriptionNoNostringnone64 - Max Length Assign an operator-friendly gateway description text configured by the operator for future reference.
HostTypeYesNoEnum0Possible values:
  • 0 - eHost
  • 1 - eGateway
Specifies whether the peer is a Host or Gateway that is being monitored.
MonitorTypeYesNoEnum1Possible values:
  • 0 - eIPSEC_CAC
  • 1 - eBackupRoute
Specifies whether this entry supports IPSEC and/or CAC or backup default route.
HostIpAddressYesNostringnone255 - 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.
TimeProbePeriodYesNoint10Possible values:
  • 5 - Minimum
  • 60 - Maximum
 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 YesNoint3Possible values:
  • 2 - Minimum
  • 10 - Maximum
 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 performed. Probes are continued to detect if the gateway becomes reachable again.
PollToServiceReadyStateYesNoint3Possible values:
  • 2 - Minimum
  • 10 - Maximum
 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_1NoYesint0 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_2NoYesint0 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_3NoYesint0 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_4NoYesint0 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.
CACProfileIDNoNoint0 Specifies the CAC profile ID associated with this gateway. For Host the CACProfileID is 0.

  • No labels