Overview Package Class Deprecated Help

vrrp
VrrpVirtualRouter

VRRP Virtual Router is a logical NFM-P object that acts as a default router for host on a shared LAN. It is defined by its VRID and the subnet it is providing redundancy on.

public class VrrpVirtualRouter

Properties
aggrOperationalState

type=vrrp.VrrpOperState
access=read-only
default=up
Displayed(tab/group)=Aggregated Operational State (/Status)
backUpAddress

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

type=UInt128
access=read-only
backUpAddressMin

type=UInt128
access=read-only
backupAddressType

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

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

type=string
minimum=0
maximum=32
Displayed(tab/group)=Name
id

type=long
access=read-create
default=0
minimum=1
maximum=1000000999999
numberOfInstances

type=int
access=read-only
default=0
Displayed(tab/group)=Number Of VRRP Instances (/Status)
operationalFlags Specifies all the conditions that could affect the operation of the VR.

type=vrrp.VROperFlags
access=read-only
Displayed(tab/group)=State Cause (/Status)
servicePointer Only Used for vrrpType VPRN

type=Pointer
access=read-create
default=
Mandatory on create
Displayed(tab/group)=Service (/Service)
subnetMask

type=int
access=read-create
default=24
minimum=0
maximum=128
Displayed(tab/group)=Subnet Mask
vrId

type=long
access=read-create
default=0
minimum=1
maximum=255
Displayed(tab/group)=Virtual Router ID
vrrp.VRInstance-Set type=Children-Set
vrrpType

type=vrrp.VrrpType
access=read-create
default=network
Displayed(tab/group)=VRRP Type
  
Properties inherited from ManagedObject
actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed
 
Methods

addVrrpInstances

adds instance(s) to this VRRP Virtual Router
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.
aInFdns : Set (Pointer) -
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false

createVrrpInstance

creates a vrrp Instance and adds a VRInstance to this Virtual Router Backup address is automatically configured for this Instance.
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.
aInL3InterfaceFullName : string -
aInVrrpInstance : config(vrrp.AbstractInstance) -
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Output Parameters:
aInFullName : string -

findInstances

finds vrrp Instances that have same vrId and that parent L3Interface has a Subnet which the backupAddress falls in
Input Parameters:
aInBackUpAddress : string -
aInBackupAddressType : int -
aInVrId : long -
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:
infoList : List (generic.CommonManagedEntityInformation) -

findL3Interfaces

finds L3Interface has a Subnet which the backupAddress falls in and does have a vrrp instance already created with passed in Vrid
Input Parameters:
aInBackUpAddress : string -
aInBackupAddressType : int -
aInVrId : long -
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:
infoList : List (generic.CommonManagedEntityInformation) -

removeInstances

removes vrrp instance(s) from this VRRP virtual Router
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.
aInFdns : Set (Pointer) -
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false