Overview Package Class Deprecated Help

icmp
IcmpPingTemplate

"The IcmpPingTemplate has an entry for each ping template controlling the operational status of an IP interface. This is achieved by using ICMP."

public class IcmpPingTemplate

Properties
actionType Setting this object to 'doAction' triggers an attempt to to update all interfaces that use the specified ping-template and update all interfaces that are using previously configured values that do not match the currently active template. An SNMP GET request on this object returns 'notApplicable'.

type=icmp.ActionType
default=2
Displayed(tab/group)=Icmp Ping Interfaces (/Perform Sync)
dot1p The value of dot1p specifies the values of the Ethernet dot1p bits in the outer and any inner Ethernet header, when dot1q or qinq encapsulation is used. The field is not exposed to egress QoS policy

type=qos.Dot1pPriority
default=priority_7
Displayed(tab/group)=Dot1p (/Test Parameters)
dscpName The value of dscpName specifies the Differentiated Services Code Point (DSCP) to be copied into the IP header of each echo request packet launched for each test belonging to the specified session.

type=sas.DscpEnum
default=48
Displayed(tab/group)=DSCP (/Test Parameters)
failureThreshold The value of failureThreshold specifies a count that causes the transition of the IP interface from operationally up to operationally down because of ping-template failure.

type=int
default=3
minimum=1
maximum=10
Displayed(tab/group)=Failure Threshold (/Test Parameters)
interval The value of interval specifies the packets transmit interval used when the interface is operational.

type=int
default=60
minimum=1
maximum=60
units=seconds
Displayed(tab/group)=Interval (/Test Parameters)
reactivationFailThreshold The value of reactivationFailThreshold specifies the number of consecutive failures without previous successes, that must occur transmitting at the reactivation interval before changing to the standard interval and subsequently waiting for the first success.

type=int
default=3
minimum=0
maximum=10
Displayed(tab/group)=Reactivation Fail Threshold (/Test Parameters)
reactivationInterval The value of reactivationInterval specifies the packets transmit interval used when the IP interface is operationally down because of ping-template failure and the previous ICMP echo request successfully received a response.

type=int
default=1
minimum=1
maximum=60
units=seconds
Displayed(tab/group)=Reactivation Interval (/Test Parameters)
reactivationThreshold The value of reactivationThreshold specifies the number of consecutive successful ICMP responses that triggers the interface from operationally down to operationally up.

type=int
default=3
minimum=1
maximum=10
Displayed(tab/group)=Reactivation Threshold (/Test Parameters)
reactivationTimeoutl The value of reactivationTimeoutl specifies the wait time before declaring the packet is lost.

type=int
default=1
minimum=1
maximum=60
units=seconds
Displayed(tab/group)=Reactivation Timeout (/Test Parameters)
size The value of size specifies the number of consecutive successful ICMP responses that triggers the interface from operationally down to operationally up.

type=int
default=56
minimum=12
maximum=9786
units=bytes
Displayed(tab/group)=Size (/Test Parameters)
timeout The value of timeout specifies the time the function will wait before declaring an ICMP echo request packet is lost.

type=int
default=5
minimum=1
maximum=60
units=seconds
Displayed(tab/group)=Timeout (/Test Parameters)
ttl The value of ttl specifies the time to live setting in the ICMP ping packet

type=int
default=1
minimum=1
maximum=255
Displayed(tab/group)=Time to Live (/Test Parameters)
 
Overridden Properties
description User-provided description for this icmp template.

displayedName Uniquely identifies each icmp-template configured on the system.

access=read-create
minimum=1
maximum=64
 
Properties inherited from policy.PolicyDefinition
configurationAction, configurationMode, discoveryState, displayedName, distributionMode, isMaster, lastSyncTime, numberOfUnderlyingPolicyItems, origin, policyMode, policySyncGroupPointer, policyType
 
Properties inherited from policy.PolicyObject
description, displayedName, globalPolicy, id, isLocal, policyType, siteId, siteName, templateObject
 
Properties inherited from ManagedObject
actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed
 
Methods inherited from policy.PolicyDefinition
distribute, distributeUsingGroups, distributeV2, evaluatePolicy, findGlobal, findLocal, findReleased, getSyncTaskResult, resetToReleasedPolicy, setConfigurationModeToDraft, setConfigurationModeToReleased, setDistributionModeToLocalEditOnly, setDistributionModeToSyncWithGlobal, syncTo, syncToLocalWithResync
 
Supported Network Elements
7750 SR Supported from 20.10.R1
7950 XRS Supported from 20.10.R1
7705 SAR Hm Supported from 20.10.R1
7450 ESS Supported from 20.10.R1