Overview Package Class Deprecated Help

dynsvc
DynSvcDataTrigger

This object contains the Data Triggers created for Dynamic Services. This is a read-only informational object. -

public class DynSvcDataTrigger

Properties
acctSessionId Indicates the identifier used for accounting.

type=string
access=read-only
minimum=0
maximum=22
Displayed(tab/group)=Account Session ID
combinedEncapValue

type=long
access=read-create
Mandatory on create
innerEncapValue

type=long
access=read-only
Displayed(tab/group)=Inner Encapsulation Value
ipAddress Indicates the IP address of the incoming data packet. If this row was created by a non-IP packet, the value of ipAddressType returns 'unknown'."

type=InetAddress
access=read-only
default=0.0.0.0
Displayed(tab/group)=IP Address
ipAddressType Indicates the address type of IP Address.

type=rtr.InetAddressType
access=read-only
default=unknown
macAddress Indicates the MAC address of the incoming data packet.

type=MacAddress
access=read-only
default=00-00-00-00-00-00
Displayed(tab/group)=MAC Address
outerEncapValue

type=long
access=read-only
Displayed(tab/group)=Outer Encapsulation Value
portId

type=long
access=read-create
Mandatory on create
portIdentifyingName

type=string
access=read-only
default=
minimum=0
maximum=252
portName

type=string
access=read-only
Displayed(tab/group)=Port Name
siteId

type=string
access=read-only
default=0.0.0.0
maximum=64
state Indicates the current state of the Data Trigger.

type=dynsvc.DataTriggerStateType
access=read-only
Displayed(tab/group)=State
  
Properties inherited from ManagedObject
actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed
 
Methods

requestClearDynSvcDataTrigger

Request clearing of Dynamic Service Data-Triggers with the specified parameters. The siteId and sapId are required. When this method returns resources for the clear have been allocated but the clear has not been performed yet. To retrieve the result eventually, use the returned request handle as input param of the retrieveClearRequest method of the clear.ClearCommandManager.
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.
clearDynSvcDataTriggerConfig : dynsvc.ClearDynSvcDataTriggerStruct - clearDynSvcDataTriggerConfig of Dynamic Service Capture SAPs with desired siteId and sapId whose values are used to be cleared. The configuration of siteId and sapId are required.
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:
aOutResult : clear.RequestHandleStruct - A request handle which allows the retrieval of the request (and its result when it becomes available) through the ClearCommandManager's retrieveClearRequest method.
Exceptions:
dynsvc.DynSvcDataTrigger.requestClearDynSvcDataTriggerException

retrieveDynSvcDataTriggers

Input Parameters:
retrieveDynSvcDataTriggersStruct : dynsvc.RetrieveDynSvcDataTriggersStruct - RetrievingSessionStruct of retrieving Dynamic Service Data Triggers with desired siteId, port, and encap values. The retrievingSessionStruct must have set siteId.
timeout : long - (Optional) (Optional) The number of milliseconds to wait before receiving the results. If the results are not received in the given time, the method returns.
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:
dynsvc.DynSvcDataTrigger.retrieveDynSvcDataTriggersException
Supported Network Elements
7750 SR Supported from 14.0.R1
7705 SAR Hm
7450 ESS Supported from 14.0.R1
  • Excluded chassis types: 7450-ESS6, 7450-ESS6V
7250 IXR Supported from 19.5.R1