Overview Package Class Deprecated Help

calltrace
CallTraceConfig

A CallTraceConfig object is created automatically for each managed NE that supports Call-Trace. It is used to configure NE wide Call-Trace parameters.

public class CallTraceConfig

Properties
availableFilesNumber Specifies the remaining number of call trace log files available for use on all compact flash cards together. The value comprises both active and finished jobs.

type=int
access=read-only
Displayed(tab/group)=Number of Log Files Available
calltrace.CallTraceFile-Set type=Children-Set
calltrace.CallTraceJob-Set type=Children-Set
calltrace.CallTraceTrace-Set type=Children-Set
clear.ClearRequest-Set type=Children-Set
maxFilesNumber Specifies the maximum number of all call trace log files stored on all compact flash cards together. The value comprises both active and finished jobs.

type=int
default=200
minimum=1
maximum=1024
Displayed(tab/group)=Maximum Number of Log Files
primaryCFlash Specifies the compact flash card to be used as the primary local storage location to save the generated call trace log files. The system will write to the specified compact flash card until the size of all generated files reaches the limit defined by the value of the object tmnxCallTraceLocationSizeLimit for the given compact flash card and the card is not disabled as the local storage location by the value of the object tmnxCallTraceLocationDisable. Once the limit is reached or the card is disabled the files will be written to the other compact flash card. The compact flash card must be available in the system in order to select it as the primary storage location. If the card is not available at the moment of SNMP SET operation, the other card is automatically selected as the primary location.

type=calltrace.CompactFlash
default=cf1
Displayed(tab/group)=Primary Compact Flash Card
siteId

type=string
access=read-only
default=0.0.0.0
maximum=64
Displayed(tab/group)=Site ID (/Site)
usedFilesNumber Specifies the number of all call trace log files stored on all compact flash cards together. The value comprises both active and finished jobs.

type=int
access=read-only
Displayed(tab/group)=Number of Log Files Used
  
Properties inherited from ManagedObject
actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed
 
Methods

addIPoECallTraceJob

Add selective call trace job based on ipoe session.
Input Parameters:
traceInfoStruct : calltrace.TraceInfoStruct -
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Output Parameters:
result : string -
Exceptions:
calltrace.CallTraceConfig.addIPoECallTraceJobException

addWlanGwUeCallTraceJob

Add selective call trace job based on WLAN GW UE.
Input Parameters:
traceInfoStruct : calltrace.WlanGwUeTraceInfoStruct -
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Output Parameters:
result : string -
Exceptions:
calltrace.CallTraceConfig.addWlanGwUeCallTraceJobException

removeIPoECallTraceJob

Remove selective call trace job based on ipoe session.
Input Parameters:
removeTraceInfoStruct : calltrace.RemoveTraceInfoStruct -
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Output Parameters:
result : string -
Exceptions:
calltrace.CallTraceConfig.removeIPoECallTraceJobException

removeWlanGwUeCallTraceJob

Remove selective call trace job based on WLAN GW UE.
Input Parameters:
removeTraceInfoStruct : calltrace.RemoveWlanGwUeTraceInfoStruct -
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Output Parameters:
result : string -
Exceptions:
calltrace.CallTraceConfig.removeWlanGwUeCallTraceJobException

requestClearCallTraceIpoeSession

Request clearing of IPoE job with specific session key with the specified parameters. The siteId, sapFdn and macAddress are required. circuitId and remoteId are optional and are mutually exclusive. 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.
clearCallTraceIpoeSessionStruct : calltrace.ClearCallTraceIpoeSessionStruct - clearCallTraceIpoeSessionStruct of IPoE job with specific session key with desired siteId, sapFdn and macAddress whose values are used for the clear command. The configuration of siteId, sapFdn and macAddress are required. circuitId and remoteId are optional and are mutually exclusive.
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:
calltrace.CallTraceConfig.requestClearCallTraceIpoeSessionException

requestClearCallTraceIpoeTrace

Request clearing of IPoE Jobs Started By Specific Trace with the specified parameters. The siteId and traceName 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.
clearCallTraceIpoeTraceStruct : calltrace.ClearCallTraceIpoeTraceStruct - ClearCallTraceIpoeTraceStruct of IPoE jobs started by specific trace with desired siteId and traceName whose values are used for the clear command. The configuration of siteId and traceName 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:
calltrace.CallTraceConfig.requestClearCallTraceIpoeTraceException
Supported Network Elements
7750 SR Supported from 14.0.R1
  • Excluded chassis types: 7750-SR1 Fixed CFM, 7750 SR-1s, 7750-SRc12, 7750-SRc4, VSR-I
7705 SAR Gen 2
7450 ESS Supported from 14.0.R1