HomeGuidesAPI Reference
API Reference

Save HPE SSE IPSLA rule destination configuration

Saves or updates the IP SLA rule destination settings for HPE SSE integration. The destination field is required and will be trimmed of whitespace. Changes trigger re-orchestration and are logged as system actions.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

IPSLA rule destination configuration object containing probe settings, thresholds, and monitoring parameters.

HPE SSE IPSLA rule destination configuration. Extends base IpslaRuleDestination with sourceInterface field specific to Axis/HPE SSE integration.

string

WAN interface label to use as source for IPSLA probes. Must match a configured interface label. Empty string uses system default.

string
enum
Defaults to http-monitor

IPSLA monitor type. 'http-monitor' sends HTTP requests to destination URL; 'ip-monitor' sends ICMP probes to destination IP.

Allowed:
string
required

Target destination for IPSLA probes. Required field that cannot be empty. For http-monitor use full URL; for ip-monitor use IP address. Multiple destinations can be comma-separated.

string

HTTP proxy server hostname or IP for http-monitor probes. Leave empty for direct connection without proxy.

integer
0 to 65535
Defaults to 0

HTTP proxy server port number. Only used when proxyAddress is configured.

string

Custom User-Agent header for HTTP monitor requests. Leave empty for default User-Agent.

integer
≥ 1
Defaults to 2

Timeout in seconds for HTTP monitor requests before marking probe as failed.

integer
≥ 1
Defaults to 2

Interval in seconds between consecutive probe packets for health monitoring.

integer
≥ 1
Defaults to 5

Number of consecutive successful probes required to mark path as UP after being DOWN.

integer
≥ 1
Defaults to 5

Number of consecutive failed probes required to mark path as DOWN after being UP.

integer
≥ 1
Defaults to 30

IPSLA rule evaluation interval in seconds for calculating path health metrics.

integer
≥ 1
Defaults to 60

Rolling average window in seconds for calculating loss and latency metrics.

integer
0 to 100
Defaults to 0

Maximum packet loss percentage threshold for path to remain UP. Set 0 to disable loss-based monitoring.

integer
0 to 100
Defaults to 0

Packet loss percentage threshold at which path is marked DOWN. Set 0 to disable loss-based monitoring.

integer
≥ 0
Defaults to 0

Maximum latency in milliseconds for path to remain UP. Set 0 to disable latency-based monitoring.

integer
≥ 0
Defaults to 0

Latency threshold in milliseconds at which path is marked DOWN. Set 0 to disable latency-based monitoring.

string
enum
Defaults to metric-or

Logical operator for combining loss and latency thresholds. 'metric-or' triggers state change when either condition is met; 'metric-and' requires both conditions.

Allowed:
integer
≥ 0
Defaults to 0

Route label ID to associate with this IPSLA rule for traffic steering. Use 0 for default route label.

Responses
204

IPSLA rule destination configuration saved successfully. Configuration change is logged and triggers re-orchestration on associated appliances.

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json