About this Resource

Modified: for 1.3.0

Defines the License resource containing information about the feature licenses on the SBC and their availability.

REST API Methods for this Resource

Resource Schema

Inventory

Parameter Name Description Data Type Possible Values
LicenseType Shows the type of license.
  • 0 - No license installed.
  • 1 - Node license is installed.
  • 2 - Base license is installed.
EnumPossible values:
  • 0 - ltNone
  • 1 - ltLicense
  • 2 - ltBaseLiecnse
ExpirationDate Shows when the license is due to expire. This attribute is only applicable to the SBC 1000 and 2000. string
SBA Displays the license status of the Survivable Branch Appliance (SBA) functionality on the SBC.
  • 0 - SBA feature is not licensed.
  • 1 - SBA feature is licensed.
 EnumPossible values:
  • 0 - btFalse
  • 1 - btTrue
RBA Displays the license status of the Remote Branch Appliance (RBA) functionality on the SBC.
  • 0 - RBA feature is not licensed.
  • 1 - RBA feature is licensed.
 EnumPossible values:
  • 0 - btFalse
  • 1 - btTrue
Transcoding Displays the license status for media transcoding on the SBC.
  • 0 - Transcoding feature is not licensed.
  • 1 - Transcoding feature is licensed.
 EnumPossible values:
  • 0 - btFalse
  • 1 - btTrue
TrncExpirationDate Epoch seconds, from January 1, 1970 00:00:00 UTC, when the feature is due to expire. This is only valid for the SWe Edge platform. long
AD Displays the license status for Active Directory on the SBC. Deprecated on SWe Edge since AD feature is now free.
  • 0 - AD feature is not licensed.
  • 1 - AD feature is licensed.
 EnumPossible values:
  • 0 - btFalse
  • 1 - btTrue
ADExpirationDate Epoch seconds, from January 1, 1970 00:00:00 UTC, when the feature is due to expire. This is only valid for the SWe Edge platform. Deprecated on SWe Edge since AD feature is now free. long
Encryption Displays the license status for Active Directory on the SBC.
  • 0 - AD feature is not licensed.
  • 1 - AD feature is licensed.
 EnumPossible values:
  • 0 - btFalse
  • 1 - btTrue
EncrExpirationDate Epoch seconds, from January 1, 1970 00:00:00 UTC, when the feature is due to expire. This is only valid for the SWe Edge platform. long
Forking Displays the license status call forking on the SBC. Deprecated on SWe Edge since Forking feature is now free.
  • 0 - Forking feature is not licensed.
  • 1 - Forking feature is licensed.
 EnumPossible values:
  • 0 - btFalse
  • 1 - btTrue
ForkExpirationDate Epoch seconds, from January 1, 1970 00:00:00 UTC, when the feature is due to expire. This is only valid for the SWe Edge platform. Deprecated on SWe Edge since Forking feature is now free. long
Rest Displays the license status for Rest on the SBC. Deprecated on SWe Edge since Rest feature is now free.
  • 0 - Rest feature is not licensed.
  • 1 - Rest feature is licensed.
 EnumPossible values:
  • 0 - btFalse
  • 1 - btTrue
SIPChannels Displays the total number of SIP channel licenses purchased for the system. int
AvailableSIPCh Displays the total number of SIP Channel licenses currently available for use on the system. int
SipcExpirationDate Epoch seconds, from January 1, 1970 00:00:00 UTC, when the feature is due to expire. This is only valid for the SWe Edge platform. long
SIPRegistrations Displays the total number of SIP registration licenses purchased for the system. Deprecated on SWe Edge since SIP registration feature is now free. int
AvailableSIPReg Displays the total number of SIP registration licenses currently available for use on the system. Deprecated on SWe Edge since SIP registration feature is now free. int
SiprExpirationDate Epoch seconds, from January 1, 1970 00:00:00 UTC, when the feature is due to expire. This is only valid for the SWe Edge platform. Deprecated on SWe Edge since SIP registration feature is now free. long
DS1Ports Displays the number of DS1 port licenses purchased for the system. int
BRIPorts Displays the number of BRI port licenses purchased for the system. int
FXSPorts Displays the number of FXS port licenses purchased for the system. int
FXOPorts Displays the number of FXO port licenses purchased for the system. int
DSPChannels Displays the total number of DSP channel licenses purchased for the system. This license name is deprecated. Existing licenses will be active through EnhancedMediaSessionswithTranscoding, and the new licenses can be purchased using the license name EnhancedMediaSessionswithTranscoding. int
AvailableDSPCh Displays the total number of DSP channel licenses currently available for use on the system. This license name is deprecated. Existing licenses will be active through EnhancedMediaSessionswithTranscoding, and the new licenses can be purchased using the license name EnhancedMediaSessionswithTranscoding. int
DSPExpirationDate Epoch seconds, from January 1, 1970 00:00:00 UTC, when the feature is due to expire. This license name is deprecated. Existing licenses will be active through EnhancedMediaSessionswithTranscoding, and the new licenses can be purchased using the license name EnhancedMediaSessionswithTranscoding. long
EnhancedMediaSessionswithTranscodingChannels Displays the total number of DSP channel licenses purchased for the system. int
AvailableEnhancedMediaSessionswithTranscodingCh Displays the total number of DSP channel licenses currently available for use on the system. int
EnhancedMediaSessionswithTranscodingExpirationDate Epoch seconds, from January 1, 1970 00:00:00 UTC, when the feature is due to expire. This is only valid for the SWe Edge platform. long
CAS Displays the license status for Channel Associated Signaling on the SBC.
  • 0 - CAS feature is not licensed.
  • 1 - CAS feature is licensed.
 EnumPossible values:
  • 0 - btFalse
  • 1 - btTrue
CDR Displays the license status for Call Detail Record on the SBC.
  • 0 - CDR feature is not licensed.
  • 1 - CDR feature is licensed.
 EnumPossible values:
  • 0 - btFalse
  • 1 - btTrue
IPsec Displays the license status for VPN IPsec on the UX system.
  • 0 - IPsec feature is not licensed.
  • 1 - IPsec feature is licensed.
 EnumPossible values:
  • 0 - btFalse
  • 1 - btTrue
QOER Displays the license status for QoE reporting on the SBC.
  • 0 - QoE reporting feature is not licensed.
  • 1 - QoE reporting feature is licensed.
 EnumPossible values:
  • 0 - btFalse
  • 1 - btTrue
BRSF Displays the license status for Broadsoft Remote Survivability on the SBC. Deprecated on SWe Edge since Broadsoft Remote Survivability feature is now free.
  • 0 - Broadsoft Remote Survivability feature is not licensed.
  • 1 - Broadsoft Remote Survivability feature is licensed.
 EnumPossible values:
  • 0 - btFalse
  • 1 - btTrue
VideoPassthru Displays the license status for Video Passthrough on the SBC. Deprecated on SWe Edge since Video Passthrough feature is now free.
  • 0 - Video Passthrough feature is not licensed.
  • 1 - Video Passthrough is licensed.
 EnumPossible values:
  • 0 - btFalse
  • 1 - btTrue
VidpExpirationDate Epoch seconds, from January 1, 1970 00:00:00 UTC, when the feature is due to expire. This is only valid for the SWe Edge platform. Deprecated on SWe Edge since Video Passthrough feature is now free. long
RIPR Displays the license status for Dynamic Routing on the SBC.
  • 0 - RIP protocol feature is not licensed.
  • 1 - RIP protocol feature is licensed.
 EnumPossible values:
  • 0 - btFalse
  • 1 - btTrue
OSPF Displays the license status for Dynamic Routing on the SBC.
  • 0 - OSPF protocol feature is not licensed.
  • 1 - OSPF protocol feature is licensed.
 EnumPossible values:
  • 0 - btFalse
  • 1 - btTrue
CarrierCPE Displays the license status for deployment as Carrier CPE.
  • 0 - Node is licensed as a standard SBC Edge Portfolio, not as Carrier CPE.
  • 1 - Node is licensed as Carrier CPE, with access controls restricting management to the Ethernet 1 Interface.
EnumPossible values:
  • 0 - btFalse
  • 1 - btTrue
AMRW Displays the license status for AMR-WB codec on the SBC.
  • 0 - AMR-WB codec feature is not licensed.
  • 1 - AMR-WB codec feature is licensed.
EnumPossible values:
  • 0 - btFalse
  • 1 - btTrue
AmrwExpirationDate Epoch seconds, from January 1, 1970 00:00:00 UTC, when the feature is due to expire. This is only valid for the SWe Edge platform. long
BrsfExpirationDate Epoch seconds, from January 1, 1970 00:00:00 UTC, when the feature is due to expire. This is only valid for the SWe Edge platform. Deprecated on SWe Edge since Video Passthrough feature is now free. long
WinSer2008R2 Displays the status of the additional license for Windows Server 2008R2 Operating System on the SBC.
  • 0 - Additional WS 2008R2 OS is not licensed.
  • 1 - Additional WS 2008R2 OS is licensed.
 EnumPossible values:
  • 0 - btFalse
  • 1 - btTrue
WinSer2012R2 Displays the status of the additional license for Windows Server 2012R2 Operating System on the SBC.
  • 0 - Additional WS 2012R2 OS is not licensed.
  • 1 - Additional WS 2012R2 OS is licensed.
 EnumPossible values:
  • 0 - btFalse
  • 1 - btTrue
OEMCode Displays the OEM branding code int
CVQR Displays the license status for Call Voice Quality Reporting (CVQR) on the SBC.
  • 0 - CVQR feature is not licensed.
  • 1 - CVQR feature is licensed.
 EnumPossible values:
  • 0 - btFalse
  • 1 - btTrue
UGBR Displays the license status for BRI TopUp (UGBR) on the SBC.
  • 0 - UGBR feature is not licensed.
  • 1 - UGBR feature is licensed.
 EnumPossible values:
  • 0 - btFalse
  • 1 - btTrue
UGPR Displays the license status for PRI TopUp (UGPR) on the SBC.
  • 0 - UGPR feature is not licensed.
  • 1 - UGPR feature is licensed.
 EnumPossible values:
  • 0 - btFalse
  • 1 - btTrue
SWON Displays the license status for Swoftware Enabled (SWON) on the SBC.
  • 0 - SWON feature is not licensed.
  • 1 - SWON feature is licensed.
 EnumPossible values:
  • 0 - btFalse
  • 1 - btTrue
UGFS Displays the license status for FXS TopUp (UGFS) on the SBC.
  • 0 - UGFS feature is not licensed.
  • 1 - UGFS feature is licensed.
 EnumPossible values:
  • 0 - btFalse
  • 1 - btTrue
ProxyLocalSrtp Displays the total number of Proxy local SRTP licenses purchased for the system. This license name is deprecated. Existing licenses will be active through EnhancedMediaSessionswithoutTranscoding, and the new licenses can be purchased using the license name EnhancedMediaSessionswithoutTranscoding. int
AvailableProxyLocalSrtp Displays the total number of Proxy local SRTP licenses currently available for use on the system.This license name is deprecated. Existing licenses will be active through EnhancedMediaSessionswithoutTranscoding, and the new licenses can be purchased using the license name EnhancedMediaSessionswithoutTranscoding. int
ProxyLocalSrtpExpirationDate Epoch seconds, from January 1, 1970 00:00:00 UTC, when the feature is due to expire. This license name is deprecated. Existing licenses will be active through EnhancedMediaSessionswithoutTranscoding, and the new licenses can be purchased using the license name EnhancedMediaSessionswithoutTranscoding. long
EnhancedMediaSessionswithoutTranscoding Displays the total number of Proxy local SRTP licenses purchased for the system. int
AvailableEnhancedMediaSessionswithoutTranscoding Displays the total number of Proxy local SRTP licenses currently available for use on the system. int
EnhancedMediaSessionswithoutTranscodingExpirationDate Epoch seconds, from January 1, 1970 00:00:00 UTC, when the feature is due to expire. This is only valid for the SWe Edge platform. long
RtpProxy Displays the total number of RTP Proxy licenses purchased for the system. int
AvailableRtpProxy Displays the total number of RTP Proxy licenses currently available for use on the system. int
RtpProxyExpirationDate Epoch seconds, from January 1, 1970 00:00:00 UTC, when the feature is due to expire. This is only valid for the SWe Edge platform. long
Video Displays the total number of Video licenses purchased for the system. Deprecated on SWe Edge since Video Passthrough feature is now free. int
AvailableVideo Displays the total number of Video licenses currently available for use on the system. Deprecated on SWe Edge since Video Passthrough feature is now free. int
VideoExpirationDate Epoch seconds, from January 1, 1970 00:00:00 UTC, when the feature is due to expire. This is only valid for the SWe Edge platform. Deprecated on SWe Edge since Video Passthrough feature is now free. long
UGHC Displays the license status for High Capacity Enabled feature on the SBC.
  • 0 - High Capacity Enabled feature is not licensed.
  • 1 - High Capacity Enabled featureis is licensed.
 EnumPossible values:
  • 0 - btFalse
  • 1 - btTrue
UGHCExpirationDate Epoch seconds, from January 1, 1970 00:00:00 UTC, when the feature is due to expire. This is only valid for the SWe Edge platform. long
SILKChannels Displays the total number of SILK licenses purchased for the system. Deprecated on SWe Edge since Video Passthrough feature is now free. int
AvailableSILKCh Displays the total number of SILK licenses currently available for use on the system. Deprecated on SWe Edge since Video Passthrough feature is now free. int
SILKExpirationDate Epoch seconds, from January 1, 1970 00:00:00 UTC, when the feature is due to expire. This is only valid for the SWe Edge platform. Deprecated on SWe Edge since Video Passthrough feature is now free. long
SIPREC Displays the total number of SIPREC licenses purchased for the system. int
AvailableSIPRecrding Displays the total number of SIPREC licenses currently available for use on the system. int
SIPRECExpirationDate Epoch seconds, from January 1, 1970 00:00:00 UTC, when the feature is due to expire. This is only valid for the SWe Edge platform. long
DirectRoutingSBA Displays the license status of the Direct Routing Survivable Branch Appliance (SBA) functionality on the SBC. This is only applicable to the SBC 1000, SBC 2000 and SWe Edge.
  • 0 - SBA feature is not licensed.
  • 1 - SBA feature is licensed.
 EnumPossible values:
  • 0 - btFalse
  • 1 - btTrue
LicenseClass Indicates the version of license format.
  • 0 - This is a v1 or legacy SBC 1000/2000 license.
  • 1 - This is a v2 or legacy SWe Edge license.
  • 2 - This is a v3 or new SWe Edge license.
 EnumPossible values:
  • 0 - lt1k2kLegacy
  • 1 - ltLegacy
  • 2 - ltRibbon
AZURE Displays the license status for AZURE license on the SBC Edge system. This is only applicable for the SWe Edge platform. Deprecated on SWe Edge since Video Passthrough feature is now free.
  • 0 - AZURE instance is not licensed.
  • 1 - AZURE instance is licensed.
 EnumPossible values:
  • 0 - btFalse
  • 1 - btTrue
AZUREExpirationDate Epoch seconds, from January 1, 1970 00:00:00 UTC, when the feature is due to expire. This is only applicable for the SWe Edge platform. Deprecated on SWe Edge since Video Passthrough feature is now free. long
DirectRoutingSBAExpirationDate Epoch seconds, from January 1, 1970 00:00:00 UTC, when the feature is due to expire. This is only applicable for the SWe Edge platform. long
WinSer2019 Displays the status of the additional license for Windows Server 2019 Operating System on the SBC.
  • 0 - Additional WS 2019 OS is not licensed.
  • 1 - Additional WS 2019 OS is licensed.
 EnumPossible values:
  • 0 - btFalse
  • 1 - btTrue