Overview Package Class Deprecated Help

snmp
PollerManager

public class PollerManager

Properties
administrativeState

type=snmp.AdminState
default=up
Displayed(tab/group)=Polling Admin State
basePollingInterval Specifies how often MIB elements of discovered and managed devices are polled for changes to their MIBs. When changes are detected, the NFM-P rereads the MIB element and updates the database.

type=snmp.PollingInterval
default=5minutes
ftpResyncAdminState When up NFM-P tries to resync nodes by requesting dump of NE config through FTP. The config output is parsed and populated in NFM-P. Normal resync is performed, if node does not support this functionality.

type=snmp.AdminState
default=down
Displayed(tab/group)=FTP Resync Admin State
mediation.ManagementPingPolicy-Set type=Children-Set
mirrorli.LIMediationPolicy-Set type=Children-Set
peerTargetName

type=string
default=
minimum=0
maximum=50
pollingSyncTime Specifies the polling synchronization start time from which the polling intervals are calculated based on a 24-hour clock. When the server restarts, the next appropriate collection interval is calculated and polling restarts for all enabled MIBs. The default is 00:00. Time is specified in milliseconds from 00:00 UTC.

type=Date
default=0
Displayed(tab/group)=Polling Synchronization Time
security.MediationPolicy-Set type=Children-Set
snmp.EventNotificationPolicy-Set type=Children-Set
snmp.ProductPolicy-Set type=Children-Set
snmp.SpecificStatsPollerPolicy-Set type=Children-Set
snmp.StatsPollerPolicy-Set type=Children-Set
snmpStreamingAdminState When up NFM-P tries to use SNMP Streaming instead of UDP-based SNMP.

type=snmp.AdminState
default=up
Displayed(tab/group)=SNMP Streaming Admin State
targetName

type=string
default=
minimum=0
maximum=50
topologyScanInterval How often to scan IP ranges in discovery rules.

type=snmp.PollingInterval
default=1hour_30minutes
Displayed(tab/group)=Discovery Rule Scan Interval
trapDestinationIpAddress

type=InetAddress
access=read-create
default=0.0.0.0
Displayed(tab/group)=Trap Destination IP (/SNMP Trap)
trapDestinationIpAddressSecond

type=InetAddress
access=read-create
default=0.0.0.0
trapDestinationIpAddressSecondType

type=rtr.InetAddressType
default=ipv6
trapDestinationIpAddressType

type=rtr.InetAddressType
default=ipv6
trapDestinationIpv4AddressSecondType

type=rtr.InetAddressType
access=read-create
default=ipv4

valid enums=ipv4 (Where parent is one of (ROOT))
trapDestinationIpv4AddressType

type=rtr.InetAddressType
access=read-create
default=ipv4

valid enums=ipv4 (Where parent is one of (ROOT))
trapDestinationIpv6Address

type=InetAddress
access=read-only
trapDestinationIpv6AddressSecond

type=InetAddress
access=read-only
trapDestinationPort

type=int
access=read-create
default=162
minimum=1
maximum=65535
Displayed(tab/group)=Trap Destination Port (/SNMP Trap)
trapDestinationPortSecond

type=int
access=read-create
default=162
minimum=1
maximum=65535
trapLogId

type=int
access=read-create
default=98
minimum=1
maximum=98
Displayed(tab/group)=Trap Log ID (/SNMP Trap)
trapLogIdSecond

type=int
access=read-create
default=98
minimum=1
maximum=98
  
Properties inherited from ManagedObject
actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed
 
Methods

findPolicy

finds the list of poller policies for a particular product and version
Input Parameters:
productId : int - the product ID
versionId : int - the version of the product
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:
foundPolicies : List (summary(snmp.PollerPolicy)) - list of policies
Exceptions:
snmp.PollerManager.findPolicyException

getPollerManager

retrieves the default instance of the poller manager
Input Parameters:
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:
pollerManagerInfo : summary(snmp.PollerManager) - returns the poller manager instance
Exceptions:
snmp.PollerManager.getPollerManagerException

getStatsMibEntryPolicy

retrieves stats mib entry policy associated to the object
Input Parameters:
aInFullName : string - the object full name of the object
aInStatsClassName : string - the class name of the stats policy
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:
foundPolicy : summary(snmp.PollerPolicy) - returns the stats mib entry policy
Exceptions:
snmp.PollerManager.getStatsMibEntryPolicyException

getStatsMibPolicy

retrieves stats entry policy associated to the object
Input Parameters:
aInFullName : string - the full name of the object whose policies have to be retrieved
aInStatsClassName : string - the class name of the stats policy
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:
foundPolicy : summary(snmp.AbstractStatsPollerPolicy) - list of the policies
Exceptions:
snmp.PollerManager.getStatsMibPolicyException

resync

Resyncs a Network Element. Resync requires the following Scope of Command Role permissions 'update' on netw.NetworkElement and 'execute' on snmp.PollerManager.method_resync
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.
neIdOrNameList : List (string) - list of network elements to be resynched
mibOidList : List (string) - list of the mibs to be resynched
ignoreTimestamps : boolean - ignore time stamps
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Exceptions:
snmp.PollerManager.resyncException