Overview Package Class Deprecated Help

netw
TopologyDiscoveryRule

public class TopologyDiscoveryRule

Properties
administrativeState

type=int
default=up
Displayed(tab/group)=Administrative State
enums=
    1: up - Up
    2: down - Down
backupPolicyPointer

type=Pointer
default=network:backup-policy-1
Displayed(tab/group)=Backup Policy (Backup Policy)
dcInterconnectPointer

type=Pointer
default=
defaultExternalEms It is used to specify the Installation Path for the External Application to be launched. The path is compatible to Windows,Linux,Solaris Path formats where the client is installed. The installation path must be located where the client is installed

type=string
default=
maximum=80
Displayed(tab/group)=Default External EMS
description

type=string
default=
minimum=0
maximum=80
Displayed(tab/group)=Description
discoveryProtocol

type=netw.DiscoveryProtocol
access=read-create
default=snmp
Displayed(tab/group)=Discovery Protocol
dualReadMediationPolicyId

type=int
access=read-create
default=0
Displayed(tab/group)=Dual Read Policy ID (LI Mediation Security/Dual Read Access Mediation Policy)
dualReadMediationPolicyName

type=string
access=read-only
default=Undefined Policy
maximum=80
Displayed(tab/group)=Dual Read Policy Name (LI Mediation Security/Dual Read Access Mediation Policy)
dualTrapMediationPolicyId

type=int
access=read-create
default=0
Displayed(tab/group)=Dual Trap Policy ID (LI Mediation Security/Dual Trap Access Mediation Policy)
dualTrapMediationPolicyName

type=string
access=read-only
default=Undefined Policy
maximum=80
Displayed(tab/group)=Dual Trap Policy Name (LI Mediation Security/Dual Trap Access Mediation Policy)
dualWriteMediationPolicyId

type=int
access=read-create
default=0
Displayed(tab/group)=Dual Write Policy ID (LI Mediation Security/Dual Write Access Mediation Policy)
dualWriteMediationPolicyName

type=string
access=read-only
default=Undefined Policy
maximum=80
Displayed(tab/group)=Dual Write Policy Name (LI Mediation Security/Dual Write Access Mediation Policy)
hip.EMSystem-Set type=Children-Set
id

type=long
access=read-create
minimum=1
maximum=25000
Mandatory on create
Displayed(tab/group)=ID
inBandPingPolicyId

type=int
access=read-create
default=1
Displayed(tab/group)=In Band Ping Policy ID (Ping/In Band Management Interface Ping)
inBandPingPolicyName

type=string
access=read-only
default=Default Policy
maximum=80
Displayed(tab/group)=In Band Ping Policy Name (Ping/In Band Management Interface Ping)
ipAddressType

type=rtr.InetAddressType
access=read-create
default=ipv4
Displayed(tab/group)=Management Protocol
lastActiveTime

type=Date
access=read-only
default=0
Displayed(tab/group)=Last Active Time
neSelfConfigurationPolicies The list of NE self config policies one per network element type that is used to self configure network elements discovered using this discovery rule.

type=List (Pointer)
netw.AutoDiscoveryRuleElementACL-Set type=Children-Set
netw.DiscoveredNode-Set type=Children-Set
netw.TopologyDiscoveryRuleElement-Set type=Children-Set
netw.TopologyDiscoveryRuleSpan-Set type=Children-Set
numberOfNodes

type=int
access=read-only
default=0
olcState

type=generic.OLCStates
default=inService
Displayed(tab/group)=OLC State
operationalState

type=int
access=read-only
default=idle
Displayed(tab/group)=Operational State
enums=
    1: idle - Idle
    2: active - Active
    3: down - Down
outOfBandPingPolicyId

type=int
access=read-create
default=1
Displayed(tab/group)=Out Of Band Ping Policy ID (Ping/Out Of Band Management Interface Ping)
outOfBandPingPolicyName

type=string
access=read-only
default=Default Policy
maximum=80
Displayed(tab/group)=Out Of Band Ping Policy Name (Ping/Out Of Band Management Interface Ping)
postDiscoveryActionName The name of the post discovery action assigned

type=string
access=read-only
default=
Displayed(tab/group)=Post Discovery Action (Post Discovery Action)
postDiscoveryActionPointer The post discovery action assigned

type=Pointer
default=
Displayed(tab/group)=Post Discovery Action (Post Discovery Action)
readMediationPolicyId

type=int
access=read-create
default=1
Displayed(tab/group)=Read Policy ID (Mediation Security/Read Access Mediation Policy)
readMediationPolicyName

type=string
access=read-only
default=Default Policy
maximum=80
Displayed(tab/group)=Read Policy Name (Mediation Security/Read Access Mediation Policy)
revertOlcState Revert the OLC state once a full discovery is complete

type=boolean
default=false
Displayed(tab/group)=Revert OLC State when discovery completes
scanInterval How often to scan the IP ranges of this discovery rule. By default, global Discovery Rule Scan Interval value is used.

type=netw.ScanInterval
default=global
Displayed(tab/group)=Scan Interval
securityMediationPolicyId

type=int
access=read-create
default=1
Displayed(tab/group)=Security Policy ID (Mediation Security/Security Access Mediation Policy)
securityMediationPolicyName

type=string
access=read-only
default=Default Policy
maximum=80
Displayed(tab/group)=Security Policy Name (Mediation Security/Security Access Mediation Policy)
standbyCpmPingPolicyId

type=int
access=read-create
default=1
Displayed(tab/group)=Standby CPM Ping Policy ID (Ping/Standby CPM Ping)
standbyCpmPingPolicyName

type=string
access=read-only
default=Default Policy
maximum=80
Displayed(tab/group)=Standby CPM Ping Policy Name (Ping/Standby CPM Ping)
statsPollingPolicyId

type=int
access=read-create
default=1
Displayed(tab/group)=MIB Statistics Policy ID (MIB Statistics Policy)
statsPollingPolicyName

type=string
access=read-only
default=Default Stats Policy
maximum=80
Displayed(tab/group)=MIB Statistics Policy Name (MIB Statistics Policy)
topologyGroupPointer

type=Pointer
default=topologyGroup:Network-DiscoveredNes
Displayed(tab/group)=Discovery Group
trapMediationPolicyId

type=int
access=read-create
default=1
Displayed(tab/group)=Trap Policy ID (Mediation Security/Trap Access Mediation Policy)
trapMediationPolicyName

type=string
access=read-only
default=Default Policy
maximum=80
Displayed(tab/group)=Trap Policy Name (Mediation Security/Trap Access Mediation Policy)
writeMediationPolicyId

type=int
access=read-create
default=1
Displayed(tab/group)=Write Policy ID (Mediation Security/Write Access Mediation Policy)
writeMediationPolicyName

type=string
access=read-only
default=Default Policy
maximum=80
Displayed(tab/group)=Write Policy Name (Mediation Security/Write Access Mediation Policy)
  
Properties inherited from ManagedObject
actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed
 
Methods

assignNodes

Assigns this discovery rule to the specified node discovery controls.
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.
ndcIds : Set (Pointer) -
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Exceptions:
netw.TopologyDiscoveryRule.assignNodesException

configureRuleElement

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.
ruleElementConfigInfo : config(netw.TopologyDiscoveryRuleElement) -
resultFilter : ResultFilter - (Optional) Filter for narrowing down the information returned per object
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Output Parameters:
ruleElement : summary(netw.TopologyDiscoveryRuleElement) -
Exceptions:
netw.TopologyDiscoveryRule.configureRuleElementException

findDiscoveredNodes

Finds nodes within this discovery rule that have been discovered.
Input Parameters:
instanceFullName : string - the full name of the object.
resultFilter : ResultFilter - (Optional) Filter for narrowing down the information returned per object
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Output Parameters:
discoveredNodes : Set (summary(netw.NetworkElement)) -
Exceptions:
netw.TopologyDiscoveryRule.findDiscoveredNodesException

findUnDiscoveredNodes

Finds nodes within this discovery rule that have not been discovered.
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:
undiscoveredNodes : Set (string) - List of Mgmt IP addresses corresponding to the nodes in the specified discovery rule instance that have not been discovered.
Exceptions:
netw.TopologyDiscoveryRule.findUnDiscoveredNodesException

force

Forces the scanning of the IP ranges defined by this discovery rule.
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
Exceptions:
netw.TopologyDiscoveryRule.forceException