Skip to end of metadata
Go to start of metadata

About this Resource

Defines DSP Card Managed Object

Querying this resource without any filter results in obtaining inventory information which often increases CPU utilization by about 5% and should be avoided in a production system, specially with heavy traffic.

If this resource is queried from a production system, it is recommended to pass the URI parameter 'filter=runtime'.

REST API Methods for this Resource

Resource Schema

Runtime

Parameter Name Description Data Type Possible Values
rt_Available Identifies whether a DSP Module is installed in this slot. EnumPossible values:
  • 0 - btFalse
  • 1 - btTrue
rt_ServiceStatus Indicates the status of the DSP Module
  • Detected
    - The module is detected by the SBC Edge system software but is not initialized or available for signal processing tasks.
  • Available
    - The module is ready for signal processing tasks.
EnumPossible values:
  • 0 - btFalse
  • 1 - btTrue
rt_ChannelsInUse Indicates the number of channels currently in use on the DSP Module. int
rt_CPUUsage Indicates the current CPU level for this DSP. Only applicable if the DSP is available. int
rt_CardType Indicates the DSP Card Type C300 or C900 EnumPossible values:
  • 0 - rmCardType_Unknown
  • 1 - rmCardType_DS1_2SPAN_LineCard
  • 2 - rmCardType_DS1_4SPAN_LineCard
  • 3 - rmCardType_DS1_8SPAN_LineCard
  • 4 - rmCardType_EX_LineCard
  • 5 - rmCardType_MSPD_C910_DaughterBoard
  • 6 - rmCardType_MSPD_C349_DaughterBoard
  • 7 - rmCardType_TI_6486_DaughterBoard
  • 8 - rmCardType_BITS_DaughterBoard
  • 9 - rmCardType_WAN_DaughterBoard
  • 10 - rmCardType_SFP_Daughterboard
  • 11 - rmCardType_COMExpress_Module
  • 12 - rmCardType_MainBoard
  • 13 - rmCardType_Chassis
  • 14 - rmCardType_PSU
  • 15 - rmCardType_Not_Installed
  • 16 - rmCardType_Node
  • 17 - rmCardType_FXS_8PORT_LineCard
  • 18 - rmCardType_FXS_16PORT_LineCard
  • 19 - rmCardType_FXS_24PORT_LineCard
  • 20 - rmCardType_FXS_4PORT_Lower_DaughterBoard
  • 21 - rmCardType_FXS_4PORT_Upper_DaughterBoard
  • 22 - rmCardType_FXO_4PORT_Lower_DaughterBoard
  • 23 - rmCardType_FXO_4PORT_Upper_DaughterBoard
  • 24 - rmCardType_BRI_4PORT_DaughterBoard
  • 25 - rmCardType_DS1_1SPAN_DaughterBoard
  • 26 - rmCardType_DS1_2SPAN_DaughterBoard
  • 27 - rmCardType_FXS_4PORT_NR_Lower_DaughterBoard
  • 28 - rmCardType_MSPD_C346_DaughterBoard
  • 29 - rmCardType_MAX
rt_UpdatedTime Indicates the time, in 1/1/1970 epoch seconds, when this DSP reported it's CPU usage. long
rt_MohFileUploadTime Indicates the last time, in 1/1/1970 epoch seconds, when a Music on Hold file was uploaded to this DSP. long
rt_MohFileStatus Indicates the Music on Hold file upload status for this DSP. EnumPossible values:
  • 0 - mscMohStatus_Loaded
  • 1 - mscMohStatus_NotLoad
  • 2 - mscMohStatus_LoadFail
  • 3 - mscMohStatus_Loading
  • 4 - mscMohStatus_LoadAbort
rt_Status Indicates the hardware initialization state for this card. EnumPossible values:
  • 0 - rmStatus_None
  • 1 - rmStatus_Card_Idle
  • 2 - rmStatus_Card_Detected
  • 3 - rmStatus_Card_Activating
  • 4 - rmStatus_Card_Activated
  • 5 - rmStatus_Card_RemoveRequested
  • 6 - rmStatus_Card_Removing
  • 7 - rmStatus_Card_Removed
  • 8 - rmStatus_Card_Downloading
  • 9 - rmStatus_Card_Failed
  • 10 - rmStatus_Card_DisabledLongLoop
  • 11 - rmStatus_MAX
rt_Location The hardware module's location within the SBC. EnumPossible values:
  • 0 - rmLocation_Unknown
  • 1 - rmLocation_LineCard1
  • 2 - rmLocation_LineCard2
  • 3 - rmLocation_DSPCard1
  • 4 - rmLocation_DSPCard2
  • 5 - rmLocation_DSPCard3
  • 6 - rmLocation_DSPCard4
  • 7 - rmLocation_DSPCard5
  • 8 - rmLocation_DSPCard6
  • 9 - rmLocation_BITS_WAN
  • 10 - rmLocation_SFP
  • 11 - rmLocation_COMExpress
  • 12 - rmLocation_Mainboard
  • 13 - rmLocation_PSU1
  • 14 - rmLocation_PSU2
  • 15 - rmLocation_UX1000_Telco_1
  • 16 - rmLocation_UX1000_Telco_2
  • 17 - rmLocation_UX1000_Telco_3
  • 18 - rmLocation_UX1000_Telco_4
  • 19 - rmLocation_UX1000_Telco_5
  • 20 - rmLocation_UX1000_Telco_6
  • 21 - rmLocation_UX1000_DS1_Telco
  • 22 - rmLocation_UX1000_DS1_WAN
  • 23 - rmLocation_MAX

Inventory

Parameter Name Description Data Type Possible Values
Location The hardware module's location within the SBC. EnumPossible values:
  • 0 - rmLocation_Unknown
  • 1 - rmLocation_LineCard1
  • 2 - rmLocation_LineCard2
  • 3 - rmLocation_DSPCard1
  • 4 - rmLocation_DSPCard2
  • 5 - rmLocation_DSPCard3
  • 6 - rmLocation_DSPCard4
  • 7 - rmLocation_DSPCard5
  • 8 - rmLocation_DSPCard6
  • 9 - rmLocation_BITS_WAN
  • 10 - rmLocation_SFP
  • 11 - rmLocation_COMExpress
  • 12 - rmLocation_Mainboard
  • 13 - rmLocation_PSU1
  • 14 - rmLocation_PSU2
  • 15 - rmLocation_UX1000_Telco_1
  • 16 - rmLocation_UX1000_Telco_2
  • 17 - rmLocation_UX1000_Telco_3
  • 18 - rmLocation_UX1000_Telco_4
  • 19 - rmLocation_UX1000_Telco_5
  • 20 - rmLocation_UX1000_Telco_6
  • 21 - rmLocation_UX1000_DS1_Telco
  • 22 - rmLocation_UX1000_DS1_WAN
  • 23 - rmLocation_MAX
CardType The type of hardware module. EnumPossible values:
  • 0 - rmCardType_Unknown
  • 1 - rmCardType_DS1_2SPAN_LineCard
  • 2 - rmCardType_DS1_4SPAN_LineCard
  • 3 - rmCardType_DS1_8SPAN_LineCard
  • 4 - rmCardType_EX_LineCard
  • 5 - rmCardType_MSPD_C910_DaughterBoard
  • 6 - rmCardType_MSPD_C349_DaughterBoard
  • 7 - rmCardType_TI_6486_DaughterBoard
  • 8 - rmCardType_BITS_DaughterBoard
  • 9 - rmCardType_WAN_DaughterBoard
  • 10 - rmCardType_SFP_Daughterboard
  • 11 - rmCardType_COMExpress_Module
  • 12 - rmCardType_MainBoard
  • 13 - rmCardType_Chassis
  • 14 - rmCardType_PSU
  • 15 - rmCardType_Not_Installed
  • 16 - rmCardType_Node
  • 17 - rmCardType_FXS_8PORT_LineCard
  • 18 - rmCardType_FXS_16PORT_LineCard
  • 19 - rmCardType_FXS_24PORT_LineCard
  • 20 - rmCardType_FXS_4PORT_Lower_DaughterBoard
  • 21 - rmCardType_FXS_4PORT_Upper_DaughterBoard
  • 22 - rmCardType_FXO_4PORT_Lower_DaughterBoard
  • 23 - rmCardType_FXO_4PORT_Upper_DaughterBoard
  • 24 - rmCardType_BRI_4PORT_DaughterBoard
  • 25 - rmCardType_DS1_1SPAN_DaughterBoard
  • 26 - rmCardType_DS1_2SPAN_DaughterBoard
  • 27 - rmCardType_FXS_4PORT_NR_Lower_DaughterBoard
  • 28 - rmCardType_MSPD_C346_DaughterBoard
  • 29 - rmCardType_MAX
Vendor The vendor who provided the hardware module. string
PartNumber The hardware module's part number. string
VersionNumber The hardware module's version number. string
MfgWeek The week that the hardware module was manufactured, as a two-digit string between 01 and 52. string
MfgYear The year that the hardware module was manufactured, as a two-digit string (e.g.: 2013 is returned as "13") string
SerialNumber The hardware module's serial number. string
LineCardLicenseType The type of line card license - Non-Licensed card will not require TDM port licenses, Licensed card will require TDM port licenses for additional ports to be activated. EnumPossible values:
  • 0 - rmLineCardLicenseType_Nonlicensed
  • 1 - rmLineCardLicenseType_Licensed
LineCardNumLicensedPorts The number of ports licensed for the TDM line card type. This is dependent on LineCardLicenseType. If the card is Licensed, the number of ports is equal to number of licenses, otherwise it is the maximum for that card type.. int
AsmOsLicenseType The version of ASM Operating System that is licensed by the factory. Additional license can be purchased, activated and reviewed through Ribbon licensing and license resource. EnumPossible values:
  • 0 - aoflUnknown
  • 1 - aoflWin2008R2
  • 2 - aoflWin2012R2
Status Indicates the hardware initialization state for this card. EnumPossible values:
  • 0 - rmStatus_None
  • 1 - rmStatus_Card_Idle
  • 2 - rmStatus_Card_Detected
  • 3 - rmStatus_Card_Activating
  • 4 - rmStatus_Card_Activated
  • 5 - rmStatus_Card_RemoveRequested
  • 6 - rmStatus_Card_Removing
  • 7 - rmStatus_Card_Removed
  • 8 - rmStatus_Card_Downloading
  • 9 - rmStatus_Card_Failed
  • 10 - rmStatus_Card_DisabledLongLoop
  • 11 - rmStatus_MAX
TotalSystemMemory Indicates the amount of RAM available in the system in MB. string