Versions Compared

Old Version 5

changes.mady.by.user Ribbon Communications

Saved on

compared with

New Version Current

changes.mady.by.user Ribbon Communications

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

About this Resource

...

Available_since
Type Available Since
Release3.1.0
Excerpt

Defines a Foreign Exchange Office (FXO) Line Card Managed Object

REST API Methods for this Resource

Resource Schema

Runtime

Parameter Name Description Data Type Possible Values
rt_StatusIndicates 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_ServiceStatusThe service status of the module.EnumPossible values:
  • 0 - rmServiceStatus_Down
  • 1 - rmServiceStatus_Up
  • 2 - rmServiceStatus_NA
  • 3 - rmServiceStatus_MAX
rt_LocationThe 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
rt_CardTypeThe 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

Inventory

Parameter Name Description Data Type Possible Values
LocationThe 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
CardTypeThe 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
VendorThe vendor who provided the hardware module.string
PartNumberThe hardware module's part number.string
VersionNumberThe hardware module's version number.string
MfgWeekThe week that the hardware module was manufactured, as a two-digit string between 01 and 52.string
MfgYearThe year that the hardware module was manufactured, as a two-digit string (e.g.: 2013 is returned as "13")string
SerialNumberThe hardware module's serial number.string
LineCardLicenseTypeThe 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. This is applicable only for the SBC 1000/2000 platforms.EnumPossible values:
  • 0 - rmLineCardLicenseType_Nonlicensed
  • 1 - rmLineCardLicenseType_Licensed
LineCardNumLicensedPortsThe 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. This is applicable only for the SBC 1000/2000 platforms. int
AsmOsLicenseTypeThe 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. This is applicable only for the SBC 1000/2000 platforms.EnumPossible values:
  • 0 - aoflUnknown
  • 1 - aoflWin2008R2
  • 2 - aoflWin2012R2
StatusIndicates 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
TotalSystemMemoryIndicates the amount of RAM available in the system in MB.string