Overview Package Class Deprecated Help

mediation
ManagementPingDestination

This class represents a management ping destination to be checked based on its Ping Policy. A destination can be one of the following:

  1. System IP address, called an in-band management interface,
  2. Management IP address on the management port, called an out-of-band management interface, or
  3. IP address of the standby control card, also called CPM.
public class ManagementPingDestination

Properties
ipAddress Specifies the address to be checked using ping.

type=InetAddress
access=read-create
Mandatory on create
Displayed(tab/group)=IP Address
ipAddressType

type=rtr.InetAddressType
access=read-create
default=ipv4
lastPingAttempt Specifies the time when ping was last attempted to this destination.

type=Date
access=read-only
default=0
Displayed(tab/group)=Time (/Last Ping)
lastPingStatus Specifies the status of the last ping operation to this destination.

type=mediation.PingStatus
access=read-only
default=0
Displayed(tab/group)=Status (/Last Ping)
siteId Specifies the system address of the network element.

type=string
access=read-create
maximum=64
Mandatory on create
Displayed(tab/group)=Site ID (/Site)
siteIdAddrType

DEPRECATED: 8.0 Attribute mediation.ManagementPingDestination.siteId is now a string, which may or may not be an IP address, rendering this field irrelevant.
type=rtr.InetAddressType
access=read-create
default=ipv4
siteName Specifies the name of the network element.

type=string
access=read-create
maximum=252
Mandatory on create
Displayed(tab/group)=Site Name (/Site)
type Specifies the type of this address (whether it is an an in-band, out-of-band or standby CPM address)

type=mediation.ManagementPingDestinationType
access=read-create
Mandatory on create
Displayed(tab/group)=Type
  
Properties inherited from ManagedObject
actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed
 
Methods

ping

Input Parameters:
deployer : Deployer - the deployment state
synchronousDeploy : boolean - (Optional) Specify whether to block until the changes have been fully deployed to the network. A value of "true" means to block. A value of "false" means to return immediately. Default: false (asynchronous)
clearOnDeployFailure : boolean - (Optional) Specify whether to clear any failed deployers. A value of "true" means to clear. A value of "false" means to leave the failed deployer. Default: false
deployRetries : int - (Optional) The number of times to attempt re-deployment during synchronous deployment. This parameter is meaningless in the asynchronous case. Default: 0
deployRetryInterval : long - (Optional) The number of milliseconds to wait between deployment retries. This parameter is meaningless in the asynchronous case. Default: 0
taskDescription : string - (Optional) A user friendly description of what the operation does. This information will be used by the task manager.
instanceFullName : string - the full name of the object.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false

pingAndGetResult

Execute network element reachability test and return the ping status enum mediation.PingStatus. It waits for the result and then returns so there may be delay due to network or timeout.
Input Parameters:
instanceFullName : string - the full name of the object.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Output Parameters:
pingStatus : int -