Overview Package Class Deprecated Help

mirror
PcapSession

public class PcapSession

Stats:
mirror.PcapSessionStats

Properties
capture

type=mirror.SessionCapture
default=stop
Displayed(tab/group)=Session Capture (MirrorPCAP session/Pcap Session Details)
captureCount

type=int
default=250
minimum=1
maximum=250
Displayed(tab/group)=Capture Count (MirrorPCAP session/Pcap Session Details)
creationOrigin

type=svt.L2RouteOriginType
access=read-create
default=manual
fileUrl

type=string
default=
minimum=0
maximum=180
Displayed(tab/group)=File URL (MirrorPCAP session/Pcap Session Details)
mirrorApplicationName

type=string
access=read-create
default=
Mandatory on create
mirrorApplicationType

type=int
access=read-create
default=mirror_dest
Displayed(tab/group)=Application Type (MirrorPCAP session/Pcap Session Details)
enums=
    1: mirror_dest - mirror-destination
mirrorSessionName

type=string
access=read-create
default=
maximum=32
Mandatory on create
Displayed(tab/group)=Session Name (MirrorPCAP session/Pcap Session Details)
serviceId

type=long
access=read-only
default=0
Displayed(tab/group)=Service ID (MirrorPCAP session)
serviceName

type=string
access=read-only
default=
minimum=0
maximum=32
siteId

type=string
access=read-only
default=
maximum=60
Displayed(tab/group)=Site ID (MirrorPCAP session)
siteName

type=string
access=read-only
default=
maximum=252
state

type=mirror.SessionState
access=read-only
default=stopped
Displayed(tab/group)=Session State (MirrorPCAP session/Pcap Session Details)
svcComponentId

type=long
access=read-only
default=0
templateVersionPointer Pointer to the template if this object was created from a template.

type=Pointer
default=
Displayed(tab/group)=Associated Template (Template/Associated Template)
  
Properties inherited from ManagedObject
actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed
 
Methods

shutDown

To administratively stop the pcap session
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

To administratively start the pcap session .
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
7705 SAR Supported from 20.4.R1
7705 SAR H Supported from 20.4.R1