service.SitePingDefinition (NSP Network Functions Manager

service
SitePingDefinition

Test definition. Determines the existence and state of a service site on another node. There are options to force the ping to use the local and remote SDP tunnels. Note that this test is a one-shot test. That is, the number of packets sent is always 1.

Inheritance Hierarchy
- ManagedObject
  - sas.AbstractTest
    - sas.TestDefinition
      - sas.PingDefinition
        
        service. SitePingDefinition

Parent Hierarchy
- sas.TestManager
  - sas.TestPolicy
    - service.SitePingDefinition [[sas]:[test-policy-${*id}]:[def-][svc-ping-][${*id}]]

Children Hierarchy
- service.SitePingDefinition
  - sas.ThresholdEventDefinition
    - sas.FallingThresholdDefinition
    - sas.RisingThresholdDefinition

Relationships
- many service.SitePingDefinitions may be direct children of one sas.TestPolicy (child-parent relationship)

public class SitePingDefinition

Relative Name=[[def-][svc-ping-][${*id}]]
Displayed Name=Service Site Ping Definition

Properties
useLocalTunnel	When the value of testLocalTunnel is 'true', the ping test determines an egress tunnel ID that is bound to the service that has the far-end IP address specified in targetIpAddress assigned to it. The far-end address of the specified tunnel ID is the expected responder-id within the OAM Echo reply message. The encapsulation of the local tunnel is used to reach the far-end. This can be IP/GRE or MPLS. On the originator egress, the service ID must have an associated VC-Label to reach the far-end address of the tunnel and the tunnel must be operational for the message to be sent. type=boolean default=false Displayed(tab/group)=Use Local Tunnel (Test Parameters/Test Packet)
useRemoteTunnel	When the value of useRemoteTunnel is 'false', the far-end node must use the generic IP/GRE OAM encapsulation as the return path. type=boolean default=false Displayed(tab/group)=Use Remote Tunnel (Test Parameters/Test Packet)

Properties

useLocalTunnel

When the value of testLocalTunnel is 'true', the ping test determines an egress tunnel ID that is bound to the service that has the far-end IP address specified in targetIpAddress assigned to it. The far-end address of the specified tunnel ID is the expected responder-id within the OAM Echo reply message. The encapsulation of the local tunnel is used to reach the far-end. This can be IP/GRE or MPLS. On the originator egress, the service ID must have an associated VC-Label to reach the far-end address of the tunnel and the tunnel must be operational for the message to be sent.

type=boolean
default=false
Displayed(tab/group)=Use Local Tunnel (Test Parameters/Test Packet)

useRemoteTunnel

When the value of useRemoteTunnel is 'false', the far-end node must use the generic IP/GRE OAM encapsulation as the return path.

type=boolean
default=false
Displayed(tab/group)=Use Remote Tunnel (Test Parameters/Test Packet)

Overridden Properties
packetInterval	Service Site ping does not use this field. default=0 minimum=0 maximum=0
packetSize	Service Site ping does not use this field. default=0 minimum=0 maximum=0
packetTimeout	Service Site ping does not use this field. default=0 minimum=0 maximum=0
packetsToSend	Service Site ping does not use this field. maximum=1

Properties inherited from sas.PingDefinition
assurance, maxHistoryRows, packetFailureThreshold, packetInterval, packetSize, packetTimeout, packetsToSend, testFailureThreshold, trapGenerationPolicy

Properties inherited from sas.TestDefinition
executionOrder, nePersistent, neSchedulable, probeHistory, publishTopic, sas.ThresholdEventDefinition-Set, testDefinitionmodified

Properties inherited from sas.AbstractTest
administrativeState, description, displayedName, failures, globalId, id, lastRunResult, runs, weight

Properties inherited from ManagedObject
actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed

Methods inherited from sas.AbstractTest
execute, stop

service SitePingDefinition

service
SitePingDefinition