Overview Package Class Deprecated Help

ressubscr
SubscrSapError

This class contains information about certain errors detected by the subscriber management function. Rows are ordered by SAP identifier.>

public class SubscrSapError

Properties
innerEncapValue The inner encapsulation value of the SAP. The value of * corresponds to 4095.

type=long
default=-1
minimum=0
maximum=4095
outerEncapValue The outer encapsulation value of the SAP. The value of * corresponds to 4095.

type=long
default=0
minimum=0
maximum=4095
portId The Access Interface SNMP port ID.

type=long
portName The name of the SAP's port or empty if the error cannot be related to a SAP.

type=string
access=read-only
default=
minimum=0
maximum=32
sapEncapValue The combined encapsulation value of the SAP.

type=long
  
Properties inherited from ressubscr.AbstractSubError
additionalInfo, index, macAddress, message, reportedTimeDay, reportedTimeHours, reportedTimeMinutes, reportedTimeMonth, reportedTimeSeconds, reportedTimeYear, serviceId, siteId, siteIdAddressType
 
Properties inherited from ManagedObject
actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed
 
Methods

retrieveSubSapError

Method used to retrieve information about the error associated with the SAP detected by the subscriber from NE.
Input Parameters:
aInSiteId : string - Specifies the Network Element of the Subscriber. This is a required input parameter.
aInSapPortId : long - Specifies the ID of the access port where this SAP is defined. This is a required input parameter.
aInOuterEncapValue : long - Specifies the outer encapsulation value of the access port where this SAP is defined. The value of * corresponds to 4095. This is a required input parameter.
aInInnerEncapValue : long - (Optional) Specifies the inner encapsulation value of the access port where this SAP is defined. The value of * corresponds to 4095. This is an optional input parameter.
aInReportedTimeHours : int - (Optional) Specifies the seconds portion of the time (based on the SR Time Zone) this error was reported to the subscriber management errors subsystem. This is an optional input parameter.
aInReportedTimeMinutes : int - (Optional) Specifies the seconds portion of the time (based on the SR Time Zone) this error was reported to the subscriber management errors subsystem. This is an optional input parameter.
aInReportedTimeSeconds : int - (Optional) Specifies the seconds portion of the time (based on the SR Time Zone) this error was reported to the subscriber management errors subsystem. This is an optional input parameter.
aInReportedTimeDay : int - (Optional) Specifies the seconds portion of the time (based on the SR Time Zone) this error was reported to the subscriber management errors subsystem. This is an optional input parameter.
aInReportedTimeMonth : int - (Optional) Specifies the seconds portion of the time (based on the SR Time Zone) this error was reported to the subscriber management errors subsystem. This is an optional input parameter.
aInReportedTimeYear : int - (Optional) Specifies the seconds portion of the time (based on the SR Time Zone) this error was reported to the subscriber management errors subsystem. This is an optional input parameter.
aInSapIndex : long - (Optional) Specifies the chronological order of this error with respect to other errors associated with the same SAP that were reported in the same deci-second. This is a required input parameter.
timeout : long - (Optional) The number of milliseconds to wait before receiving the results. The method returns if no results are received in the given time. This is an optional input parameter. The default value is 5 minutes (300000).
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:
ressubscr.SubscrSapError.retrieveSubSapErrorException
Supported Network Elements
7750 SR Supported from 16.0.R4
7450 ESS Supported from 16.0.R4