Overview Package Class Deprecated Help

adp
Domain

Represents an instance of a Domain. Domain defines the group of related Nodes for Auto-Discovery into NSP. Each Domain contains all the necessary configuration information used for auto discovering the Nodes which will be grouped under this Domain.

public class Domain

Properties
aclIpFilterPointer Pointer to the acl IP filter policy deployed to the SAR-Hm node to filter egress traffic.

type=Pointer
access=read-only
default=
adp.CellularCarrier-Set type=Children-Set
adp.DomainSite-Set type=Children-Set
adp.DomainSubnet-Set type=Children-Set
adp.DomainSystemIpPool-Set type=Children-Set
adp.HeadNode-Set type=Children-Set
adp.SerialNumData-Set type=Children-Set
adpEnable Enables or disables the ADP process on the domain.

type=boolean
default=false
Displayed(tab/group)=Enable ADP
adpProcess Specifies whether this Domain currently is in One Step or Two Step Auto Discovery Process.

type=adp.ADPProcess
default=oneStep
Displayed(tab/group)=ADP Process
adpSystemIP Specifies how the system IP will be allocated to the node getting discovered. When the type of Domain is cellularInterface or cellularDynamic, the valid value is useXML. Otherwise this value can be either verify or learn only.

type=adp.IpAllocation
default=verify
Displayed(tab/group)=ADP System IP Address
areSystemIpPoolsExhausted When adpSystemIP is set to learnAlloc or verifyAlloc, indicates if the system IP pools are exhausted, i.e. all the IP addresses in all the pools were assigned.

type=boolean
access=read-only
default=false
asNumber Autonomous System number

type=long
access=read-create
minimum=0
maximum=4294967295
Mandatory on create
Displayed(tab/group)=Autonomous System Number (/BGP Configuration)
bgpConnectRetryTime Specifies the value (in seconds) of the BGP Connect Retry timer.

type=int
default=120
minimum=1
maximum=65535
units=seconds
Displayed(tab/group)=Connect Retry Time (/BGP Configuration)
bgpDampOscErrorInterval Specifies the time in minutes after a session reset, during which the session must be error-free in order to reset the penalty counter and return idle-hold-time to dampOscInitialWaitTime.

type=long
default=5
minimum=0
maximum=2048
units=minutes
Displayed(tab/group)=Damp Error Interval (/BGP Configuration)
bgpDampOscInitialWaitTime Specifies the time in minutes, that a session remains in the idle-state after it has been stable for a while.

type=long
default=0
minimum=0
maximum=2048
units=minutes
Displayed(tab/group)=Damp Initial Wait Time (/BGP Configuration)
bgpDampOscMaxWaitTime Specifies the maximum amount of time in minutes, that the session remains in the idle-state after it has experienced repeated instability.

type=long
default=10
minimum=1
maximum=2048
units=minutes
Displayed(tab/group)=Damp Max Wait Time (/BGP Configuration)
bgpDampOscSecondWaitTime Specifies the time in minutes, that is doubled after each repeated session failure that occurs within a relatively short span of time.

type=long
default=3
minimum=1
maximum=2048
units=minutes
Displayed(tab/group)=Damp Second Wait Time (/BGP Configuration)
bgpDampPeerOscillations Specifies whether damping peer oscillations is enabled for this BGP instance or not.

type=generic.TruthValue
default=true
bgpGroupName It indicates the name of the BGP group.

type=string
minimum=0
maximum=32
Displayed(tab/group)=BGP Group Name (/BGP Configuration)
bgpHoldTime Specifies the value (in seconds) of the BGP Hold Time."

type=int
default=90
minimum=0
maximum=65535
units=seconds
Displayed(tab/group)=Hold Time (/BGP Configuration)
bgpKeepAlive Specifies the value (in seconds) of the BGP Keep-alive timer. A keep-alive message is sent every time this timer expires. A value of 0 means the timer is off.

type=int
default=30
minimum=0
maximum=21845
units=seconds
Displayed(tab/group)=Keep-Alive (/BGP Configuration)
bgpLoopDetect Determines how the peer session should deal with loop detection in the AS Path.

type=int
default=discardRoute
Displayed(tab/group)=Loop Detect (/BGP Configuration)
enums=
    1: drop - Drop
    2: ignore - Ignore
    3: off - Off
    4: discardRoute - Discard Route
cellularCurrentPin This is NFMP only attribute used validate the current PIN configured for the domain is same as the previously entered value for New PIN configuration.

type=string
default=0000
minimum=0
maximum=8
Displayed(tab/group)=Current PIN (/PIN Security)
cellularNewPin The value of cellularNewPin specifies the PIN (Personal Identification Number) used to secure/access 7705 SR-Hm nodes.

type=string
default=
minimum=0
maximum=8
Displayed(tab/group)=New PIN (/PIN Security)
defaultAdpAdminPassword The password used to authenticate admin access for nodes that do not have a specific password configured against their serial number.

type=string
default=
minimum=0
maximum=129
Displayed(tab/group)=Default ADP-Hm admin Password
defaultSourceIp Specifies if an egress ACL is to be added to the PDN router interface.

type=boolean
default=false
Displayed(tab/group)=Default Source IP
description A user provided description for this Domain.

type=string
default=
minimum=0
maximum=255
Displayed(tab/group)=Description
discoveryRuleId Discovery rule allocated for nodes discovered from this subnet import list.

type=long
access=read-only
default=0
minimum=0
maximum=25000
domainName The name to associate with this Domain.

type=string
minimum=1
maximum=32
Displayed(tab/group)=Name
firmwareVersion Specifies expected SAR-Hm firmware version.

type=string
minimum=0
maximum=64
Displayed(tab/group)=SAR-Hm Firmware Version (/Software and Firmware)
id The ID of the Domain.

type=int
access=read-create
default=0
minimum=1
maximum=1000
Displayed(tab/group)=ID
ipVersion Specifies the IP Address type of the NEs that can be grouped under this Domain.

type=rtr.InetAddressType
access=read-create
default=ipv4
Displayed(tab/group)=IP Version
mediationPolicyId Specifies the ID of the mediation policy selected.

type=int
access=read-create
default=0
Displayed(tab/group)=Mediation Policy (/Mediation Security)
mtuSize Specifies the MTU size to be configured on the PDN interfaces of SAR-Hm NEs.

type=int
access=read-create
default=1430
minimum=512
maximum=1486
units=bytes
Displayed(tab/group)=MTU Size
ngeDomainId The ID of the NGE Domain.

type=int
default=0
minimum=0
maximum=64
pdnProfileId The ID of the PDN Profile. PDN Profile with Id greater than 2 is applicable on SAR-Hm/Hmc nodes from version TiMOS 20.7.R1 onwards.

type=long
access=read-create
default=-1
Displayed(tab/group)=PDN Profile (/PDN Profile)
postDiscoveryActionPointer The post discovery action assigned to the domain

type=Pointer
default=
Displayed(tab/group)=Post Discovery Action (/Post Discovery Action)
sarHmcFirmwareVersion Specifies expected SAR-Hmc firmware version.

type=string
minimum=0
maximum=64
Displayed(tab/group)=SAR-Hmc Firmware Version (/Software and Firmware)
sim2AclIpFilterPointer Pointer to the acl IP filter policy used for sim2 deployed to the SAR-Hm node to filter egress traffic.

type=Pointer
access=read-only
default=
simLayout Indicates the sim layout of the domain.

type=adp.SimLayoutType
access=read-create
default=singleSim
Displayed(tab/group)=Sim Layout
softwareUpgradePolicyId Specifies the softwareVersionPolicy.

type=int
access=read-create
default=0
Displayed(tab/group)=Software and Firmware Upgrade Policy (/Software and Firmware)
softwareVersion Specifies expected software version.

type=string
minimum=1
maximum=32
Displayed(tab/group)=Software Version (/Software and Firmware)
type The type of Mode supported by this Domain.

type=adp.DomainType
access=read-create
default=cellularSystem
Displayed(tab/group)=Operation Mode
vprnServiceId Specifies the ID of the VPRN Service to be associated.

type=long
access=read-create
default=0
Displayed(tab/group)=VPRN Service (VPRN)
  
Properties inherited from ManagedObject
actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed
 
Methods

addManagedNodes

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.
networkElements : Set (Pointer) -
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Exceptions:
adp.Domain.addManagedNodesException

findManagedNodes

d
Input Parameters:
instanceFullName : string - the full name of the object.
filter : FilterHolder -
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:
result : List (generic.CommonManagedEntityInformation) -
Exceptions:
adp.Domain.findManagedNodesException

findVprnService

Method used to query the VPRN Services Based on the HeadNode. Fetch the services that relates to Head nodes (i.e. the count of that service will be >1).
Input Parameters:
infoList : List (string) - List of HeadNodes from Celluar Domain.
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:
infoList : List (generic.CommonManagedEntityInformation) - VPRN Service Objects Based on the headNodes.

importFromXML

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.
importFileName : string -
requestId : string -
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Exceptions:
adp.Domain.importFromXMLException

importSerialNumbersFromXML

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.
importFileName : string -
requestId : string -
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Exceptions:
adp.Domain.importSerialNumbersFromXMLException
Supported Network Elements
7705 SAR Hm