rtr
Peer

Abstract class representing a peer. Defines all the common peer related attributes and behavior.



public abstract class Peer

Properties
description

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

groupName

type=string
access=read-only
default=
maximum=32

peerAddress

type=InetAddress
access=read-create
default=0.0.0.0
Displayed(tab/group)=Peer Address

peerAddressType

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

routingInstance

type=long
access=read-only
default=0
Displayed(tab/group)=Routing Instance ID (/Routing Instance)

routingInstanceName

type=string
access=read-only
default=
maximum=252
Displayed(tab/group)=Routing Instance Name (/Routing Instance)

serviceId

type=long
access=read-only
default=0

serviceType

type=service.ServiceType
access=read-only
default=unknown

siteId

type=string
access=read-only
default=
maximum=50
Displayed(tab/group)=Site ID (/Site)

siteName

type=string
access=read-only
default=
maximum=252
Displayed(tab/group)=Site Name (/Site)

subscriberId

type=long
access=read-only
default=1

  
Properties inherited from netw.Connection
administrativeState, application, connectionId, operationalState
 
Properties inherited from ManagedObject
actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed
 
Methods

remove

DEPRECATED - 8.0.R1
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:
rtr.Peer.removeException

shutDown

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

turnUp

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
Supported Network Elements
7450 ESS
7210 SAS M
7210 SAS X
7210 SAS E
7210 SAS D
7210 SAS K
7210 SAS T
7210 SAS Mxp
7210 SAS Dxp
7210 SAS S/Sx
7210 SAS R
7250 IXR
7750 SR
7705 SAR Gen 2
7705 SAR Hm
7705 SAR
7705 SAR H
7701 CPAA
Generic NE 1.0.0
OS9700E/9800E
DC VSC
DC 7850
DC 210
DC VSA8
7950 XRS