Table Of Contents
Provisioning API Overview
com.cisco.provisioning.cpe Package
Batch Interface
BatchStatus Interface
CommandStatus Interface
CSRCAPI Interface
CSRCAPIStatus Interface
PACEConnection Interface
ActivationMode Class
APINames Class
ConfirmationMode Class
PACEConnectionFactory Class
Exceptions
com.cisco.provisioning.cpe.api Package
Configuration Interface
DeviceSearch Interface
DSTB Interface
Provisioning Interface
xGCP Interface
com.cisco.provisioning.cpe.constants Package
BatchStatusCodes Interface
CNRServersKeys Interface
CommandStatusCodes Interface
DeviceDetailsKeys Interface
DeviceTypeValues Interface
DVBProvisioningKeys Interface
LicenseDataKeys Interface
SNMPPropertyKeys Interface
VOIPServiceDetailsKeys Interface
XGCPCommandStatusCodes Interface
XGCPProvisioningKeys Interface
Provisioning API Overview
The CSRC DPR provisioning API makes it possible for you to easily integrate your OSS/Mediator and other applications with CSRC. Using the provisioning API, you can externally control all aspects of the CSRC DPR provisioning system. The CSRC DPR system serves as a client to your applications.
The provisioning API consists of packages of programming interfaces and classes that contain the commands required to interact with CSRC. The API packages are the following:
•com.cisco.provisioning.cpe—Contains the interfaces, classes, and methods used to connect to the provisioning API command engine (PACE) and to manage batch operations.
•com.cisco.provisioning.cpe.api—Contains the interfaces and methods used to provision and manage customer premises equipment (CPE), such as high-speed data (HSD) devices, digital set-top box (DSTB) devices, voice capable (xGCP) devices, and computers.
•com.cisco.provisioning.cpe.constants—Contains the interfaces and constants that interpret status information and retrieve values associated with the device types that CSRC provisions.
The sections that follow introduce each of the CSRC provisioning API packages.
Note You can access the complete provisioning API through the JavaDoc packaged with the CSRC DPR product.
com.cisco.provisioning.cpe Package
The com.cisco.provisioning.cpe package contains the interfaces, classes, and methods used to connect to the provisioning API command engine (PACE) and to manage batch operations.
Table 2-1 summarizes the com.cisco.provisioning.cpe package interfaces.
Table 2-1 The com.cisco.provisioning.cpe Package Interfaces Summary
Interface
|
Description
|
Batch |
Provides access to the provisioning API commands to be executed. |
BatchStatus |
Provides the return type for a batch operation. |
CommandStatus |
Provides a standard return type for the individual commands submitted from a batch operation. |
PACEConnection |
Contains the commands used to create and manage communication with the provisioning API command engine (PACE). |
CSRCAPI |
Is a marker interface that all CSRC API interfaces implement. |
CSRCAPIStatus |
Is a status interface that all CSRC API interfaces implement. It describes messages returned from PACE to the client program. |
Table 2-2 summarizes the classes in the com.cisco.provisioning.cpe package.
Table 2-2 The com.cisco.provisioning.cpe Package Classes Summary
Class
|
Description
|
ActivationMode |
Provides an enumeration of batch activation request states. |
APINames |
Provides an enumeration of the CSRC named API interfaces and is used in conjunction with the Batch.getAPI() command. |
ConfirmationMode |
Not used. |
PACEConnectionFactory |
Returns a singleton instance of the PACE connection using LDAP server connection parameters. |
Table 2-3 summarizes the exceptions in the com.cisco.provisioning.cpe package.
Table 2-3 The com.cisco.provisioning.cpe Package Exceptions Summary
Exception
|
Description
|
AlreadyPostedException |
Used to indicate that this batch has already been posted. |
APINotFoundException |
Used to signal an attempt to retrieve an API instance S that is not one of the APIs enumerated by APINames class. |
PACEConnectionException |
Used to indicate an error in getting an instance of PACEConnection through the PACEConnectionFactory. |
ProvisioningException |
Used to signal that PACE could not process the posted batch. |
The following sections provide a summary of the com.cisco.provisioning.cpe interfaces, classes, and exceptions. For more detailed information about usage, returns, and examples for this package, see Chapter 5, "Package com.cisco.provisioning.cpe Reference."
Batch Interface
The Batch interface gives access to all the provisioning API methods in CSRC DPR. Each batch of commands has a unique identifier; therefore, you can post a batch only once. If you try to add calls to a batch that has already been posted or to repost a batch, CSRC generates a runtime exception.
Table 2-4 provides a summary of the Batch interface methods.
Table 2-4 Batch Interface Methods Summary
Method
|
Description
|
addAPICall() |
Adds an API Call object to the list of method calls in a batch. Note This method is for CSRC DPR internal use only. CSRC DPR API clients should not call this method. |
getActivationMode() |
Obtains the Activation mode associated with this batch. |
getAPI() |
Returns the requested API, or generates a runtime exception if your customer license does not provide access to this API. |
getAPICall() |
Returns an API call from the list of methods in a batch. Note This method is for CSRC DPR internal use only. CSRC DPR API clients should not call this method. |
getAPICallCount() |
Obtains the count of API calls stored in the batch. |
getBatchID() |
Gets the batch identifier associated with the batch. |
getConfirmationMode() |
Obtains the Confirmation mode associated with this batch. The returned value is an enumerated type from the Confirmation mode class. |
post() |
Posts this batch of commands for execution. |
wasPosted() |
Indicates whether the batch was ever posted. |
BatchStatus Interface
The Batch Status interface provides the standard return type for a batch operation. Table 2-5 provides a summary of the methods for this interface.
Table 2-5 BatchStatus Interface Methods Summary
Method
|
Description
|
getBatchID() |
Returns the associated batch identifier for this status request. |
getCommandCount() |
Gets the number of commands in a batch that were processed. |
getCommandStatus() |
Returns the command status for the specified command or returns null if there is no corresponding command. |
getFailedCommandIndex() |
Gets the index for the specified command that failed. Returns a value of -1 if no command failed. |
getFailedCommandStatus() |
Gets the command status return for the failed command or returns null value if no command failed. |
CommandStatus Interface
The Command Status interface provides the standard return type for the individual operations submitted in a batch, including command error status. For methods that return data to the caller, this interface also provides the data type code and the data itself.
The CommandStatus.getDataTypeCode() function returns status values to indicate that a command returned the following types of data:
•Byte array data
•List data
•Map of key/value data
•Null
•String data
•Void (the command did not return any data)
Table 2-6 provides a summary of the Command Status interface methods.
Table 2-6 CommandStatus Interface Methods Summary
Method
|
Description
|
commandReturnsData() |
Indicates whether a command returns data. |
getData() |
Returns the requested data for this command status. |
getDataTypeCode() |
Returns the data type code for this command status. |
CSRCAPI Interface
The CSRC API interface is a marker interface that all the com.cisco.provising.cpe.api interfaces implement. Its subinterfaces are:
•Configuration
•Device search
•DSTB
•Provisioning
•xGCP
CSRCAPIStatus Interface
The CSRC API Status interface is implemented by all interfaces that describe messages returned from PACE to the client program. This interface provides the following information about status:
•Status type of the batch operation
•Status type of the command
•Unknown status type
•Provisioning exception type
Table 2-7 provides a summary of the CSRC API Status interface methods.
Table 2-7 CSRCAPI Status Interface Methods Summary
Method
|
Description
|
getBatchID() |
Returns the batch identifier. |
getErrorMessage() |
Obtains an error message that describes a problem encountered in processing. |
getStatusCode() |
Obtains the status code for the results of processing. |
getStatusType() |
Returns the type of interface that the implementing object represents. |
isError() |
Determines whether a status code is an error message. |
isSystemError() |
Determines whether a status code is a system error message. |
PACEConnection Interface
The PACE Connection interface contains the commands used to create and manage communication with the provisioning API command engine (PACE).
Table 2-8 provides a summary of the PACE Connection interface methods.
Table 2-8 PACEConnection Interface Methods Summary
Method
|
Description
|
getHost() |
Returns the hostname of the LDAP directory server to which you are connecting. |
getPort() |
Returns the port number of the LDAP directory server to which you are connecting. |
isActive() |
Returns the status of the connection. |
newBatch() |
Gets a new batch with a guaranteed globally-unique batch identifier. |
postBatch() |
Posts a batch of commands for execution. |
realseConnection() |
Signifies that the connection is no longer needed. |
ActivationMode Class
Use the Activation mode class for an enumeration of batch activation request states. This class has two values:
•NO_ACTIVATION—The database is updated with device information, but PACE does not activate the device or devices. Use this mode to preprovision devices.
•AUTOMATIC—The database is updated with device information, and PACE determines the necessary activations for the particular device.
The Activation mode class implements two methods, as described in Table 2-9.
Table 2-9 ActivationMode Class Methods Summary
Method
|
Description
|
getNamed() |
Returns the ActivationMode object with the selected name, or it returns null if the name does not exist. |
getValued() |
Returns the ActivationMode object with the selected value, or it returns null if the value does not exist. |
APINames Class
Use this class, in conjunction with the Batch.getAPI() method, for an enumeration of the CSRC DPR named API interfaces.
The API names class implements the following fields:
•Configuration—References the com.cisco.provisioning.cpe.api.Configuration interface.
•Provisioning—References the com.cisco.provisioning.cpe.api.Provisioning interface.
•DeviceSearch—References the com.cisco.provisioning.cpe.api.DeviceSearch interface.
•DSTB— References the com.cisco.provisioning.cpe.api.DSTB interface.
•xGCP—References the com.cisco.provisioning.cpe.api.xGCP interface.
The API names class implements the methods described in Table 2-10.
Table 2-10 APINames Class Methods Summary
Method
|
Description
|
getNamed() |
Returns the APIName object with the selected name, or it returns null value if the name does not exist. |
getValued() |
Returns the APIName object with the selected value, or it returns null value if the value does not exist. |
ConfirmationMode Class
Use the Confirmation mode class for an enumeration of batch confirmation request states. This class has the following value:
•NO_CONFIRMATION— A confirmation is not required before returning from batch execution.
Note CSRC DPR does not use this class. It is included in the com.cisco.provisioning.cpe package to ensure forward compatibility with subsequent releases of CSRC.
The Confirmation mode class implements the methods described in Table 2-11.
Table 2-11 ConfirmationMode Class Methods Summary
Method
|
Description
|
getNamed() |
Returns the APIName object with the selected name, or it returns null value if the name does not exist. |
getValued() |
Returns the APIName object with the selected value, or it returns null value if the value does not exist. |
PACEConnectionFactory Class
Use the PACE connection factory class to return singleton instances using LDAP server connection parameters. This class implements the methods described in Table 2-12.
Table 2-12 PACEConnectionFactory Class Methods Summary
Method
|
Description
|
getInstance() |
Gets the singleton instance of the PACEConnection for the given parameters. |
Exceptions
The CSRC DPR provisioning API implements the following four exceptions to handle processing errors and other abnormal conditions:
•AlreadyPostedException—This exception is thrown when an attempt is made to repost an already posted batch. The caller must get a new batch instance.
•APINotFoundException—This exception is thrown when an attempt is made to retrieve an API Instance object that is not one of the APIs enumerated by APINames. This exception does not occur with pure Java code, but may occur in a badly formed XML batch.
•PACEConnectionException— This exception could occur when getting an instance of PACEConnection through the PACEConnectionFactory.
•ProvisioningException—This exception may be thrown as a result of calling Batch.post(), and signals that PACE could not process the posted batch due to catastrophic failure.
com.cisco.provisioning.cpe.api Package
The com.cisco.provisioning.cpe.api package contains the interfaces and commands used to manage the following types of devices:
•High-speed data (HSD) devices
•Digital set-top box (DSTB) devices
•Voice capable Gateway Control Protocol (xGCP) devices
Table 2-13 summarizes the com.cisco.provisioning.cpe.api package interfaces.
Table 2-13 com.cisco.provisioning.cpe.api Package Interfaces Summary
Interface
|
Description
|
Configuration |
Provides methods to get and set default configuration properties for CPE devices in the CSRC system. |
DeviceSearch |
Provides the methods that search for multiple CPE devices and retrieve a list of matching device identifiers. |
DSTB |
Contains methods to configure digital set-top box interfaces in CSRC and to retrieve digital set-top box interface information from CSRC. |
Provisioning |
Contains methods used to manipulate provisioned CPE devices in the CSRC system. |
xGCP |
Contains methods to configure batch operations associated with xGCP devices. |
The following sections discuss the com.cisco.provisioning.cpe.api interfaces.
Configuration Interface
Use the Configuration interface to get and set default configuration parameters for CPE devices. In the CSRC DPR, API methods are defined with arguments and properties. Arguments indicate the most commonly used fields that an API call must specify. In many cases, you can set arguments to null. You must specify properties in the form of a map containing key/value pairs.
The Configuration interface provides commonly used configuration methods. Table 2-14 lists the methods for this interface.
Table 2-14 Configuration Interface Methods Summary
Method
|
Description
|
changeSystemDefaults() |
Changes the default system properties. |
getSystemDefaults() |
Gets the system default properties. |
DeviceSearch Interface
Use the Device Search interface to search for multiple CPE devices and to retrieve a list of matching device identifiers. Table 2-15 lists the methods for this interface.
Table 2-15 DeviceSearch Interface Methods Summary
Method
|
Description
|
getIPDevicesByFQDN() |
Searches for IP devices by fully qualified domain name (FQDN). |
getIPDevicesByMACAddress() |
Searches for IP devices by MAC address. |
DSTB Interface
Use the DSTB interface to configure digital set-top box components for CSRC and to retrieve information about the components from CSRC. Table 2-16 lists the methods for this interface.
Table 2-16 DSTB Interface Methods Summary
Method
|
Description
|
addDSTB() |
Adds a DSTB. |
addDSTBByIPAddress() |
Adds a DSTB identified by its IP address. |
changeDSTBClientClass() |
Changes the client class of a DSTB. |
changeDSTBFQDN() |
Changes the FQDN of a DSTB. |
changeDSTBOwnerID() |
Changes the owner identifier of a DSTB. |
changeDSTBProperties() |
Changes the properties of a DSTB. |
changeDSTBRelatedDOCSISModemID() |
Changes the modem identifier of a DSTB's related DOCSIS modem. |
changeDSTBRelatedDVBModemID() |
Changes the modem identifier of a DSTB's related DVB modem. |
deleteDSTB() |
Deletes a DSTB and optionally deletes related DOCSIS or DVB modems related to the DSTB. |
getDetailsForDSTB() |
Gets the device details for a given DSTB. |
getDetailsForDSTBByIPAddress() |
Gets the device details for a given DSTB, identified by IP address. |
Provisioning Interface
Use the Provisioning interface to manipulate provisioned customer premises equipment (CPE) in the CSRC system. Table 2-17 lists the methods for this interface.
Table 2-17 Provisioning Interface Methods Summary
Method
|
Description
|
addComputer() |
Adds a computer. |
addComputerByIPAddress() |
Adds a computer identified by its IP address. |
addDOCSISModem() |
Adds a DOCSIS modem. |
addDOCSISModemByIPAddress() |
Adds a DOCSIS modem identified by its IP address. |
addDVBModem() |
Adds a DVB modem. |
addDVBModemByIPAddress() |
Adds a DVB modem identified by its IP address. |
changeComputerClientClass() |
Changes a computer's client class. |
changeComputerFQDN() |
Changes the FQDN of a computer. |
changeComputerOwnerID() |
Changes a computer's owner identifier (ownership). |
changeComputerProperties() |
Changes a computer's properties. |
changeDOCSISModemClassOfService() |
Changes a DOCSIS modem's class of service. |
changeDOCSISModemClientClass() |
Changes a DOCSIS modem's client class. |
changeDOCSISModemCPESelectionTags() |
Changes a DOCSIS modem's CPE selection tags. |
changeDOCSISModemFQDN() |
Changes a DOCSIS modem's FQDN. |
changeDOCSISModemOwnerID() |
Changes a DOCSIS modem's owner identifier. |
changeDOCSISModemProperties() |
Changes a DOCSIS modem's properties. |
changeDVBModemClassOfService() |
Changes a DVB modem's class of service. |
changeDVBModemClientClass() |
Changes a DVB modem's client class. |
changeDVBModemCPESelectionTags() |
Changes a DVB modem's CPE selection tags. |
changeDVBModemFQDN() |
Changes a DVB modem's FQDN. |
changeDVBModemOwnerID() |
Changes a DVB modem's owner identifier. |
changeDVBModemProperties() |
Changes a DVB modem's properties. |
deleteComputer() |
Deletes a computer. |
deleteDOCSISModem() |
Deletes a DOCSIS modem. |
deleteDVBModem() |
Deletes a DVB modem. |
deleteIPDevice() |
Deletes an IP device regardless of type. |
getDetailsForComputer() |
Gets the device details for a given computer. |
getDetailsForComputerByIPAddress() |
Gets the device details for a given computer, identified by IP address. |
getDetailsForDOCSISModem() |
Gets the device details for a given DOCSIS modem. |
getDetailsForDOCSISModemByIPAddress() |
Gets the device details for a given DOCSIS modem, identified by IP address. |
getDetailsForDVBModem() |
Gets the device details for a given DVB modem. |
getDetailsForDVBModemByIPAddress() |
Gets the device details for a given DVB modem, identified by IP address. |
getDetailsForIPDevice() |
Gets the device details for a given IP device instance. |
getDetailsForIPDeviceByIPAddress() |
Gets the IP device details for a given IP address. |
getIPDeviceDetailsList() |
Gets a list of IP device details maps for the list of macAddress strings supplied. |
getIPDeviceForIPAddress() |
Looks up the IP device for the specified IP address. |
getIPDevicesByOwnerID() |
Gets the list of IP devices for a specified owner identifier. |
resetIPDevice() |
Resets (reboots) an IP device. |
xGCP Interface
Use the xGCP interface to manage batch operations associated with xGCP devices. This interface contains the methods used to configure xGCP information for CSRC DPR and to retrieve xGCP information from CSRC. Table 2-18 lists the methods for this interface.
Table 2-18 xGCP Interface Methods Summary
Method
|
Description
|
addXGCPModemMTA() |
Adds an xGCP modem/MTA (a DOCSIS modem/media terminal adapter). |
addXGCPModemMTAByIPAddress() |
Adds an xGCP modem/MTA (DOCSIS modem/MTA) by IP address. |
addXGCPService() |
Assigns an xGCP service to a specified port on an MTA. |
changeXGCPModemMTAClientClass() |
Changes the client class for an xGCP modem/MTA. |
changeXGCPModemMTACPESelectionTags() |
Changes the CPE selection tags for an xGCP modem/MTA. |
changeXGCPModemMTADeviceClassOfService() |
Changes the device level class of service for an xGCP modem/MTA. |
changeXGCPModemMTAFQDN() |
Changes the FQDN for an xGCP modem/MTA. |
changeXGCPModemMTAModemClassOfService() |
Changes the DOCSIS modem class of service for an xGCP modem/MTA. |
changeXGCPModemMTAOwnerID() |
Changes the owner identifier for an xGCP modem/MTA. |
changeXGCPModemMTAProperties() |
Changes properties associated with an xGCP modem/MTA. |
changeXGCPServiceCmsFQDN() |
Modifies the FQDN of the call management server (CMS) associated with an xGCP service. |
changeXGCPServiceCmsPortNumber() |
Modifies the CMS port number associated with an xGCP service. |
changeXGCPServiceCmsQualifier() |
Modifies the CMS Qualifier associated with an xGCP service. |
changeXGCPServiceProperties() |
Modifies properties associated with an xGCP service. |
changeXGCPServiceTelephoneNumber() |
Modifies the telephone number associated with an xGCP service. |
deleteXGCPModemMTA() |
Deletes an xGCP Modem/MTA (DOCSIS modem/MTA). |
deleteXGCPService() |
Deletes the service from the specified port on an xGCP MTA. |
getDetailsForXGCPModemMTA() |
Gets details for the specified xGCP modem/MTA. |
getDetailsForXGCPModemMTAByIPAddress() |
Gets details for the specified xGCP modem/MTA, identified by IP address. |
getXGCPServiceDetails() |
Retrieves the xGCP port information in a map. |
com.cisco.provisioning.cpe.constants Package
The com.cisco.provisioning.cpe.constants package contains the interfaces and constants that interpret status information and retrieve values associated with the device types that CSRC provisions. Table 2-19 summarizes the com.cisco.provisioning.cpe.constants package.
Table 2-19 com.cisco.provisioning.cpe.constants Package Summary
Interface
|
Description
|
BatchStatusCodes |
Specifies constants that are used to interpret returned status information for a batch operation of commands. |
CNRServerKeys |
Specifies constant strings that are used as system default keys for a CSRC DPR configuration of Network Registrar. |
CommandStatusCodes |
Specifies constants that are used to interpret the returned command status. |
DeviceDetailsKeys |
Specifies character strings that are used as keys to retrieve values associated with IP devices, for example an IP address or a MAC address. |
DeviceTypeValues |
Specifies the allowed values for a device type. |
DVBProvisioningKeys |
Specifies character strings that are used as keys to retrieve values associated with DVB modems, for example, a channel number or a demodulator number. |
LicenseDataKeys |
Specifies constant strings that are used as keys in map objects returned by the query method for license key data. |
SNMPPropertyKeys |
Specifies character strings that are used as keys to store and retrieve values associated with devices that respond to simple network management protocol (SNMP) requests, for example their read and write community strings. |
VOIPServiceDetailsKeys |
Specifies character strings that are used as keys to retrieve values associated with xGCP devices, for example, an FQDN, a port number, or a telephone number. |
XGCPCommandStatusCodes |
Specifies constants that are used to interpret returned xGCP command and query status information. |
XGCPProvisioningKeys |
Specifies the constants that are used to interpret and set the values associated with xGCP devices, for example, the SGCP version string. |
The following sections provide a summary of the interfaces in this package.
BatchStatusCodes Interface
Use the Batch Status Codes interface to obtain status information about a batch operation. The BatchStatus.getStatusCode() function returns values described in Table 2-20.
Table 2-20 BatchStatusCodes Interface Values Summary
Value
|
Description
|
BATCH_COMPLETED |
Indicates that a batch has completed processing. |
BATCH_ERROR |
Indicates that processing of a batch resulted in an error. |
BATCH_FAILED_AUTOMATIC_ACTIVATION |
Indicates that automatic activation failed during the processing of a batch. |
BATCH_FAILED_QUERY |
Indicates that processing of a batch failed during the query phase. |
BATCH_FAILED_VALIDATION |
Indicates that a batch has failed validation. |
BATCH_FAILED_WRITE |
Indicates that processing of a batch failed during the write phase. |
BATCH_ILLEGAL_MULTIPLE_ACTIVATIONS |
Indicates that a batch contains multiple change the activation state of multiple devices. |
BATCH_SYSTEM_ERROR |
Return value from BatchStatus.getStatusCode(), representing a batch whose processing has resulted in a system error. |
CNRServersKeys Interface
Use the CNR Servers Keys interface to specify the constants that are used as system default keys during CSRC DPR configuration. Table 2-21 describes the CNRServersKeys constants.
Table 2-21 CNRServersKeys Values Summary
Value
|
Description
|
CNR_SERVERS_LIST |
Returns a list of Network Registrar servers to query. |
CNR_CLIENT_PORT |
The listening port of the API when communicating with the Network Registrar servers. |
CNR_NUMBER_RETRIES |
The number of retries when communicating with the Network Registrar servers. |
CNR_TIMEOUT |
The time in milliseconds between retries when communicating with the Network Registrar servers. |
USE_CLIENT_ID |
If true, uses the client ID instead of the MAC address. |
CommandStatusCodes Interface
The Command Status Codes interface specifies a number of constants that are used to interpret the return status of HSD commands. The CommandStatus.getStatusCode() function returns values to indicate that HSD command processing succeeded or that a command processing error occurred. Table 2-22 summarizes these values.
Table 2-22 CommandStatusCodes Interface Values Summary
Value
|
Description
|
CMD_ERROR |
Indicates that an error occurred in processing a command. |
CMD_ERROR_DB_UNREACHABLE |
Indicates that a command failed while attempting to access the database. |
CMD_ERROR_DEVICE_ID_UNKNOWN |
Indicates that a command is trying to modify or delete a device with an unknown identifier (MAC address or FQDN). |
CMD_ERROR_DEVICE_MAC_EXISTS |
Represents a command that is trying to add a device using an already existing MAC address. |
CMD_ERROR_ILLEGAL_PARAM_VALUE |
Indicates a command failed because it has a parameter with an illegal value. |
CMD_ERROR_INTERNAL |
Indicates a command encountered an unexpected internal error during processing. |
CMD_ERROR_INVALID_DEVICE_TECHNOLOGY |
Represents a command in a batch where the device technology did not match the command's technology. |
CMD_ERROR_IPADDR_UNKNOWN |
Indicates that a command used an IP address that is unknown to the system. |
CMD_ERROR_TOO_MANY_IN_LIST |
Indicates that the specified search limit on a search for a device has been exceeded. |
CMD_OK |
Represents a command that completed successfully. |
DeviceDetailsKeys Interface
The Device Details Keys interface specifies the character strings that are used as keys to retrieve values associated with IP devices. This interface defines keys that provide detailed information about IP devices that you are querying. This interface also defines keys that provide information related to a specific technology. Table 2-23 summarizes the keys.
Table 2-23 DeviceDetailsKeys Interface Summary
Key
|
Description
|
CLASS_OF_SERVICE_DATA |
Retrieves class of service data. |
CLIENT_CLASS |
Gets the client class of a device. |
CLIENT_ID |
Retrieves the client identifier of a device. |
CLIENT_REQUESTED_HOST_NAME |
Retrieves the host name that a client requested. |
CPE_SELECTION_TAGS |
Indicates the scopes that Network Registrar should use to select IP addresses for CPEs in Promiscuous mode. |
CUSTOM_COS |
Gets custom class of service data about a device. |
DEVICE_TYPE |
Retrieves the device type. |
DOCSIS_COS |
Gets the DOCSIS class of service of a device. |
DOCSIS_TECHNOLOGY |
Retrieves data specific to DOCSIS technology. |
DOCSIS_VERSION |
Obtains the DOCSIS version of a device. |
DSTB_RELATED_DOCSIS_MODEM_ID |
Gets the related DOCSIS modem identifier of a DSTB device. |
DSTB_RELATED_DVB_MODEM_ID |
Gets the related DVB modem identifier of a DSTB device. |
DSTB_TECHNOLOGY |
Retrieves data specific to DSTB technology. |
DVB_COS |
Gets the DVB class of service of a device. |
DVB_TECHNOLOGY |
Retrieves data specific to DVB technology. |
FQDN |
Retrieves the FQDN of a device. |
IP_ADDRESS |
Retrieves the IP address of a device. |
IS_PROVISIONED |
Obtains the provisioned state of a device. |
MAC_ADDRESS |
Retrieves the MAC address of a device. |
NETWORK_DATA |
Obtains network data. |
OWNER_ID |
Retrieves the owner identifier of a device. |
PROPERTIES |
Retrieves the properties of a device. |
PROVISIONING_DATA |
Retrieves provisioning data. |
RELAY_AGENT_CIRCUIT_ID |
Retrieves the relay agent circuit identifier of a device. |
RELAY_AGENT_REMOTE_ID |
Obtains the relay agent remote identifier of a device. |
TECHNOLOGY_DATA |
Retrieves data specific to the device type technology. |
XGCP_MTA |
Gets data specific to the xGCP MTA portion of an xGCP device. |
XGCP_MTA_PORTS_IN_SERVICE_LIST |
Gets the list of ports in service for an xGCP device. |
XGCP_TECHNOLOGY |
Retrieves data specific to xGCP technology. |
DeviceTypeValues Interface
The Device Type Values interface specifies the allowed values for a device type. These are returned as the values for the DeviceDetailsKeys.DEVICE_TYPE key. The allowed values are as follows:
•Computer
•DOCSIS modem
•DSTB
•DVB modem
•xGCP modem MTA
DVBProvisioningKeys Interface
The DVB Provisioning Keys interface specifies character strings that are used as keys to retrieve and set values associated with DVB modems. Table 2-24 summarizes the keys.
Table 2-24 DVBProvisioningKeys Interface Summary
Key
|
Description
|
DVB_CHANNEL_NUMBER |
Retrieves and sets the channel number of a DVB modem. |
DVB_DEMODULATOR_NUMBER |
Retrieves and sets the demodulator number of a DVB modem. |
DVB_ FLAGS |
Retrieves and sets the DVB flags. |
DVB_QOS_INDEX |
Retrieves and sets the QoS index for a DVB modem. |
LicenseDataKeys Interface
The LicenseDataKeys interface specifies constant strings that are used as keys in Map objects returned by the query method for license key data. Table 2-25 summarizes the keys.
Table 2-25 LicenseDataKeys Interface Summary
Key
|
Description
|
DATE_EXPIRES |
Expiration date of this license. |
DATE_INSTALLED |
Installation date for this license. |
ENCRYPTED_KEY |
Encrypted key for this license. |
IS_PERMANENT |
Indicates whether this license is permanent. |
NUMBER_OF_EXTENSIONS |
Number of extensions for this license. |
NUMBER_OF_SUBSCRIBERS |
Number of subscribers for this license. |
SNMPPropertyKeys Interface
The SNMP Property Keys interface specifies character strings that are used as keys to store and retrieve values associated with devices that respond to SNMP requests. Table 2-26 summarizes the keys.
Table 2-26 SNMPPropertyKeys Interface Summary
Key
|
Description
|
SNMP_DATA |
Retrieves SNMP data. |
READ_COMMUNITY_STRING |
Gets the SNMP read community string. |
WRITE_COMMUNITY_STRING |
Gets the SNMP write community string. |
VOIPServiceDetailsKeys Interface
The VoIP Service Details Keys interface specifies character strings that are used as keys to retrieve values associated with xGCP services. This interface contains fields that provide detailed information about xGCP devices. Table 2-27 summarizes the keys.
Table 2-27 VOIPServiceDetailsKeys Interface Summary
Key
|
Description
|
CMS_FQDN |
Obtains the FQDN of a CMS. |
CMS_PORT_NUMBER |
Gets the CMS port number of a service. |
CMS_QUALIFIER |
Retrieves the CMS qualifier of a service. |
PROPERTIES |
Gets the properties of a service. |
TELEPHONE_NUMBER |
Gets the telephone number of a service. |
XGCPCommandStatusCodes Interface
The XGCP Command Status Codes interface specifies constants that are used to interpret returned xGCP command and query status information. The CommandStatus.getStatusCode() command returns values to indicate that an xGCP command processing error occurred. Command failure occurs as a result of the following causes:
•The xGCP service already exists
•The command is trying to operate on an unknown xGCP service.
XGCPProvisioningKeys Interface
The XGCP Provisioning Keys interface specifies the constants that are used to interpret and set the values associated with xGCP devices, for example, the SGCP version string (SGCP_VERSION).