/system/ipsla_sources/{ipsla_source.name}

put

https://switch-ip/rest/v10.16/system/ipsla_sources/{ipsla_source.name}

Path Params

ipsla_source.name

string

required

Reference Resource: ipsla_source
Unique identifier of the specific IP SLA session.

Body Params

domain_name_server

string

length ≤ 256

IPv4/IPv6 address of the DNS server to be used for resolve destination hostnames. If not provided, name server for the respective VRF will be used instead. This column value can be empty.

enable

boolean

Enables IP SLA session.

frequency

integer

5 to 604800

Time gap (in seconds) between two consecutive probes of the SLA session.

history_interval

integer

10 to 7200

Period of time in seconds that IPSLA probe history in maintained. Minimum value is two times of probe-interval and Maximum is two hours.

http_sla

object

Configuration parameters for HTTP sessions.

payload_size

integer

0 to 1440

Size of the payload to add to ICMP echo and UDP echo probes. This value is zero for ICMP echo and 28 for other probes. This column value can be empty.

responder

object

IP SLA responder address. Has to be populated for all SLA types except for HTTP/s that uses URL instead.

source_interface

string

Reference Resource: Port
Helps detemining the source IPv4/IPv6 address for the probes. If interface have both IPv4 and IPv6 address, IP is chosen based on the destination IP.If source_ip is present, then source_interface configuration is overriden. If both are missing, it will default to 'VRF.effective_source_ip.ipsla'. This column value can be empty.

source_ip

string

length ≤ 256

Source IPv4/IPv6 address for outgoing IP SLA packets. If not specified, the address will either follow source_interface configuration or if it's missing as well, will default to 'VRF.effective_source_ip.ipsla'. This column value can be empty.

source_port_number

integer

1 to 65535

In case of TCP and UDP probes, allows specification of the specific source port. If not specified the port will be chosen by the system. This column value can be empty.

tos

integer

0 to 255

Type of Service (TOS) to set on the packets of UDP echo, UDP VOIP and ICMP echo probes.

type

string

enum

required

Type of IP SLA: icmp_echo: measures Round Trip Time(RTT) between source and responder using ICMP. udp_echo: measures one way or RTT latency between the source and the responder using UDP. tcp_connect: measures the time that it takes to perform TCP Connect operation between the source and the responder. udp_jitter_voip: measures packet loss, one way delay, RTT, Mean Opinion Scores (MOS), (Impairment) Calculated Planning Impairment Factor (ICPIF) between the source and the responder using VOIP traffic. http: measures HTTP response time for a web page. This includes the time taken for DNS resolution, TCP connect and fetching of the web page. 'dns': measures the time taken for DNS resolution for the given hostname and nameserver. 'dhcp': measures the time taken to perform DHCP operation on the given source interface.

Allowed:

voip_jitter_sla

object

Configuration parameters for VOIP jitter

vrf

string

required

Reference Resource: VRF
VRF to be used for sending the probes.

Responses

200

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

415

Unsupported Media Type

500

Internal Server Error

501

Not Implemented

503

Service Unavailable

Language

Response

Click Try It! to start a request and see the response here!