Overview Package Class Deprecated Help

calltrace
CallTraceFile

This object contains the single Call-Trace file present on a cflash card. This is a read-only informational object.

public class CallTraceFile

Properties
cFlashId Specifies the ID of the cflash card on the CPM board identified by the value of the object cpmSlotNum where the log file is present.

type=calltrace.CompactFlash
access=read-only
cpmSlotNumber Specifies the CPM slot where the cflash card containing the log file is present.

type=int
access=read-only
minimum=1
fileDir Specifies the absolute pathname of the directory where the log file identified by the value of the object fileName is stored on the cflash card identified by the values of the objects cpmSlotNum and cFlashId.

type=string
access=read-only
fileLastDataModified Specifies the time of the last modification to this file.

type=Date
access=read-only
fileName Specifies the basename of the log file. The basename is composed of following items: 'mac_mac_address_timestamp[_internal_id].pcap' or 'ipoe_mac_address[_trace_name>]_timestamp[_internal_id].pcap' where mac_address is a MAC address of the host in form '00-11-22-33-44-55' timestamp is a date and time of creation of the file in form 'YYMMDD_HHMM' (24 hr format) internal_id is a value used for internal purposes trace_name is a name associated with the trace by a user.

type=string
access=read-create
Mandatory on create
fileSize Specifies the size of the log file in bytes.

type=long
access=read-only
units=Bytes
jobStatus Specifies the status of the call trace job that has created this log file. The details about the call trace job can be found in CallTraceJob. The value 'running (0)' indicates the job is active and is tracing events triggered by the host and events are being recorded to the file. The value 'finished (1)' indicates the job has already finished and is not tracing events generated by the host anymore.

type=calltrace.CallTraceJobStatus
access=read-only
siteId Router ID.

type=string
access=read-only
default=0.0.0.0
maximum=64
  
Properties inherited from ManagedObject
actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed
 
Methods

retrieveCallTraceFile

Input Parameters:
siteId : string - Specifies the NE of the call-trace files(s). This is a required input parameter.
jobStatus : calltrace.CallTraceJobStatus - (Optional) Specifies the stauts of job, value could be either 'running' or 'finished'. This is an optional input parameter.
cpmSlotNumber : int - (Optional) Specifies the CPM slot where the cflash card containing the log file is present. Its value is between 1 and 128. This is an optional input parameter. Its value can only be specified if jobStatus is specified
cflashId : calltrace.CompactFlash - (Optional) Specifies the ID of the cflash card on the CPM board. Its value could be either cf1 or cf2. This is an optional input parameter. Its value can only be specified if jobStatus and cpmSlotNumber is specified.
fileName : string - (Optional) Specifies the name of the call-trace file. This is an optional input parameter.Its value can only be specified if jobStatus, cpmSlotNumber and cflashId is specified.
timeout : long - (Optional) The number of milliseconds to wait before receiving the results. If no results are 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:
calltrace.CallTraceFile.retrieveCallTraceFileException
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