Overview Package Class Deprecated Help

netw
NodeDiscoveryControl

A NodeDiscoveryControl (NDC) object tracks a netw.NetworkElement once it is discovered. NDC objects may exist without a netw.NetworkElement if the NE is unmanaged. Each object contains properties that are first assigned during NE discovery.

public class NodeDiscoveryControl

Properties
activeManagementIp This property is used to remember the last active management address for the network element such as if the node gets un-managed and then remanaged it will always attempt to use this address to re-discover the node unless the useOriginalIpAddress flag is set.

type=string
access=read-only
maximum=50
Displayed(tab/group)=Last Active Management IP
additionalContext An optional additional context for specific domain usage.

type=string
access=read-only
default=
maximum=512
autoConfigScriptInstancePointer The control script instance that will be executed on the NE after it has been successfully discovered.

type=Pointer
access=read-only
default=
Displayed(tab/group)=Auto-Config Script (Post Discovery/Auto-Config Script)
autoConfigScriptResultPointer The script execution result file

type=Pointer
access=read-only
default=
autoConfigScriptStatus The control script instance execution status. If the script could not be run because NE discovery failed, the status is "Not Executed".

type=netw.AutoConfigScriptStatus
access=read-create
default=0
Displayed(tab/group)=Script Execution Status (Post Discovery/Auto-Config Script)
autoDiscovered Indicates whether the node is managed through auto discovery process.

type=boolean
access=read-only
default=false
backupPolicyPointer Node backup policy used by network elements part of this discovery rule.

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

type=equipment.ShelfType
access=read-create
default=unknownShelf
displayedName Discovery Rule name.

type=string
access=read-create
maximum=80
Mandatory on create
Displayed(tab/group)=Name
displayedProduct

type=string
access=read-create
default=
minimum=0
maximum=80
Mandatory on create
Displayed(tab/group)=Product
displayedVersion

type=string
access=read-create
default=
minimum=0
maximum=40
Mandatory on create
Displayed(tab/group)=Descriptor Version
dualReadMediationPolicyId Mediation policy defining read access if network element supports LI management

type=int
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 Mediation policy for receiving traps if network element supports LI management

type=int
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 Mediation policy defining write access if network element supports LI management

type=int
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)
genericNeDriverPointer A pointer to the Generic NE Driver if it is associated with the Generic NE Profile. Only applicable if this is a Generic NE.

type=Pointer
access=read-only
default=
Displayed(tab/group)=Driver (/Generic NE)
genericNeProfilePointer This is the pointer to the Generic NE Profile. Only applicable if this is a Generic NE.

type=Pointer
access=read-only
default=
Displayed(tab/group)=Product Definition (/Generic NE)
inBandPingPolicyId If the Network element does not support this type of ping policy the default value of this property will become 0 and its value cannot be changed.

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)
mgmtIpAddress

type=InetAddress
access=read-create
Mandatory on create
Displayed(tab/group)=Original Management IP
mgmtIpAddressType

type=rtr.InetAddressType
access=read-create
default=ipv4
mgmtIpProtocol This represents the IP protocol of the management IP address. The user will be allowed to flip the protocol of the management IP address.

type=rtr.InetAddressType
default=ipv4
Displayed(tab/group)=Active Management IP Protocol
mgmtProtocol This represents the management protocol.

type=netw.DiscoveryProtocol
access=read-create
default=snmp
oneFullResyncDone It indicates whether the network element has under gone at least one full resync after a network element upgrade or after a NFM-P upgrade or first time after network element is managed.

type=boolean
access=read-only
default=false
Displayed(tab/group)=First Full Resync Done
originDiscoveryRuleId When the value is 0 then the original discovery rule is deleted

type=long
access=read-create
minimum=0
maximum=25000
Mandatory on create
Displayed(tab/group)=Discovery Rule ID
outOfBandPingPolicyId If the Network element does not support this type of ping policy the default value of this property will become 0 and its value cannot be changed.

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)
postDiscoveryActionPointer The post discovery action assigned

type=Pointer
access=read-create
default=
Mandatory on create
Displayed(tab/group)=Post Discovery Action (Post Discovery)
productType

type=int
access=read-create
default=0
values
readMediationPolicyId Mediation policy defining read access to network element

type=int
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)
routerId This is actually the System ID.

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

DEPRECATED: 8.0.R5 Attribute netw.NodeDiscoveryControl.routerId 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
securityMediationPolicyId Mediation policy for receiving traps from network element

type=int
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)
snmpEngineID

type=string
access=read-only
default=
maximum=252
standbyCpmIpAddress

type=string
access=read-only
default=0.0.0.0
maximum=50
standbyCpmIpV6Address

type=string
access=read-only
default=0:0:0:0:0:0:0:0
maximum=50
standbyCpmPingPolicyId If the Network element does not support this type of ping policy the default value of this property will become 0 and its value cannot be changed.

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)
state Network element discovery state. In suspend state network element configuration and update from network will be blocked.

type=netw.ManagedState
Displayed(tab/group)=Site State
statsPollingPolicyId Stats policy used by network elements part of this discovery rule.

type=int
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)
trapMediationPolicyId Mediation policy for receiving traps from network element

type=int
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)
upgradeState Indicates whether the NDC detected a version change request for the network element

type=netw.UpgradeState
default=unknown
useOriginalDiscoveryIp In case of an un-manage and re-manage setting this flag allows to re-discover the NE using the original address used to discover the node. If this flag is not set the activeManagementIp address is used to re-manage the node.

type=boolean
default=false
Displayed(tab/group)=Use Original Management IP
versionType

type=int
access=read-create
default=0
writeMediationPolicyId Mediation policy defining write access to network element

type=int
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

ping

Execute network element reachability test asynchronously based on the network element management connection type. Use generic.GenericObject.findInstance() to retrieve the Ping result.
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.
mgmtConnectionType : mediation.ManagementPingDestinationType -
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Exceptions:
netw.NodeDiscoveryControl.pingException

pingAndGetResult

Execute network element reachability test based on network element management connection type 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.
mgmtConnectionType : mediation.ManagementPingDestinationType -
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Output Parameters:
pingStatus : int -
Exceptions:
netw.NodeDiscoveryControl.pingAndGetResultException

remove

DEPRECATED - 8.0.R3
Use generic.GenericObject.deleteInstance() instead.
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.NodeDiscoveryControl.removeException