Index

Index
A
B
C
D
E
F
G
H
I
J
K
L
M
N
O
P
Q
R
S
T
U
V
W
X

Index

A

ActivationMode class 1-9

methods summary A-11

role in provisioning API A-11

Activation modes

defined 1-8

in batch operations 1-9

obtaining A-7

addAPICall() method A-7

addBatchListener() method A-52

addClassOfService() method A-21

addComputer() method A-16

addComputerByIPAddress() method A-16

addCOSListener() method A-52

addCustomCPE() method A-18

addCustomCPEByIPAddress() method A-18

addCustomCPEType() method A-18

addCustomPropertyDefinition() method A-17

addDeviceListener() method A-52

addDHCPCriteria() method A-21

addDHCPCriteriaListener() method A-52

addDOCSISModem() method A-19

addDOCSISModemByIPAddress() method A-19

addDSTB() method A-20

addDSTBByIPAddress() method A-20

added() method A-61

addExternalFile() method A-17

addExternalFileListener() method A-52

Adding methods to get device details 1-13

addLicenseKey() method A-17

addMessagingListener() method A-52

addProvGroupListener() method A-52

addSystemConfigListener() method A-52

addUser() method A-17

addXGCPService() method A-22

AlreadyPostedException A-15

APINames class

fields A-12

method summary A-12

role in provisioning A-12

APINotFoundException A-15

APIs and the Batch interface A-7

AUTOMATIC flag 1-9

AUTOMATIC mode 1-9, A-11

B

batch

asynchronous 1-7

atomic 1-7

code to call newBatch() method 1-11

failure 1-7

flags 1-7

getting new A-10

logging completion 2-27

logging completions 2-27

posting 1-13, A-7, A-8

reliable batches 1-7

returning status A-51

status codes A-25

status flags 1-7

synchronous 1-7

XML batches 1-7

BATCH_WARNING status code 1-9, A-12

BatchEvent A-49

BatchEvent interface A-51

methods summary A-51

batch identifier

getting A-8

must be unique 1-9

returning A-9

Batch interface

methods summary A-7

role in provisioning API A-7

BatchListener interface A-51

methods summary A-51

batch operations

code for 1-10

cycle 1-9

batch status

code for getting 1-13

examining 1-14

BatchStatusCodes interface

defined A-22

role in provisioning A-25

values summary A-25, A-28

BatchStatus interface

methods summary A-8, A-13, A-26, A-34, A-43, A-45, A-47, A-48, A-54, A-55, A-56, A-57, A-58, A-59, A-60, A-61, A-62, A-63, A-64

role in provisioning API A-8

ByFQDN key A-44

ByMACAndFQDN key A-44

ByMAC key A-44

C

cable modems

replacing in Standard mode 2-14

change

change in system configuration A-63

changeClassOfServiceProperties() method A-21

changeComputerClassOfService() method A-16

changeComputerDefaults() method A-16

changeComputerDHCPCriteria() method A-16

changeComputerFQDN() method A-16

changeComputerMACAddress() method A-16

changeComputerOwnerID() method A-16

changeComputerProperties() method A-16

changeCustomCPEClassOfService() method A-18

changeCustomCPEDefaults() method A-18

changeCustomCPEDHCPCriteria() method A-18

changeCustomCPEFQDN() method A-18

changeCustomCPEMACAddress() method A-18

changeCustomCPEOwnerID() method A-18

changeCustomCPEProperties() method A-18

changeCustomCPETypeProperties() method A-18

changedCoS() method A-54

changeDHCPCriteriaExcludeSelectionTags() method A-21

changeDHCPCriteriaIncludeSelectionTags() method A-21

changeDHCPCriteriaProperties() method A-21

changedIP() method A-54, A-59

changeDOCSISDefaults() method A-19

changeDOCSISModemClassOfService() method A-19

changeDOCSISModemCPEDHCPCriteria() method A-19

changeDOCSISModemDHCPCriteria() method A-19

changeDOCSISModemFQDN() method A-19

changeDOCSISModemMACAddress() method A-19

changeDOCSISModemOwnerID() method A-19

changeDOCSISModemProperties() method A-20

changeDPEDefaults() method A-17

changeDSTBClassOfService() method A-20

changeDSTBDefaults() method A-20

changeDSTBDHCPCriteria() method A-20

changeDSTBFQDN() method A-20

changeDSTBMACAddress() method A-20

changeDSTBOwnerID() method A-20

changeDSTBProperties() method A-20

changeDSTBRelatedDOCSISModemID() method A-20

changeExtensionPointSettings() method A-17

changeRDUDefaults() method A-17

changeSystemDefaults() method A-17

changeUser() method A-17

changeXGCPServiceCmsFQDN() method A-22

changeXGCPServiceCmsPortNumber() method A-22

changeXGCPServiceCmsQualifier() method A-22

changeXGCPServiceProperties() method A-22

changeXGCPServiceTelephoneNumber() method A-22

classes

ActivationMode 1-9, A-11

AlreadyPostedException A-2, A-6

APINames A-12

APINotFoundException A-2, A-6, A-15

BatchAdapter A-58

com.cisco.provisioning.cpe A-6

com.cisco.provisioning.cpe.events A-49

ConfirmationMode 1-9, A-13

DataType A-13

DeviceAdapter A-59

ExternalFileAdapter A-61

MessagingAdapter A-62

MessagingQualifier A-62

PACEConnectionFactory A-14

ProvGroupAdapter A-62

ServerConfigEventType A-64

SNMPVersion A-14

SystemConfigAdapter A-63

class of service

add or delete 1-5

changing for a computer A-16

configuration options 1-16

event marking new class A-54

new class of service event A-59

types supported A-26

ClassOfServiceKeys interface

role in provisioning A-26

ClassOfServiceType interface

role in provisioning A-26

clearAll() method A-58, A-59, A-60, A-61, A-62, A-64

CLIENT_CLASS key A-33

CLIENT_ID key A-33

CLIENT_REQUESTED_HOST_NAME key A-33

CMS

changing the FQDN A-22

modifying a port number A-22

service information A-22

CMS_FQDN key A-48

CMS_PORT_NUMBER key A-48

CMS_QUALIFIER key A-48

CMTS_MIC_ENABLED key A-41

CMTS_MIC_SHARED_SECRET key A-41

CNR_ATTRIBUTES_TO_READ_FROM_ENVIRONMENT_DICTIONARY key A-27

CNR_ATTRIBUTES_TO_READ_FROM_REQUEST_DICTIONARY key A-27

CNR_BATCHES key A-27

CNR_CLIENT_PORT key A-28

CNR_HEALTH key A-27

CNR_HOST_ID key A-27

CNR_NUMBER_RETRIES key A-28

CNR_PROPERTIES key A-27

CNR_PROV_GROUP_ID key A-27

CNR_SERVERS_LIST key A-28

CNR_STATE key A-27

CNR_TIMEOUT key A-28

CNR_UPTIME key A-27

CNR_VERSION key A-27

CNRDetailsKeys interface

role in provisioning A-27

CNRExtensionSettingKeys interface

role in provisioning A-27

CNRServersKeys interface

defined A-22

role in provisioning A-28

code

for batch operations 1-10

com.cisco.provisioning.cpe

classes summary A-6

exceptions summary A-6

interfaces summary A-5

role in provisioning API A-1

com.cisco.provisioning.cpe.api

interfaces summary A-15

role in provisioning API A-1

com.cisco.provisioning.cpe.constants

role in provisioning A-22

role in provisioning API A-1

summary A-22

com.cisco.provisioning.cpe.events

classes summary A-50

exceptions summary A-51

interfaces summary A-49

role in provisioning API A-1

commandReturnsData() method A-9

commands

for failed command A-8

getting number of A-8

status for failed command A-8

command status codes A-28

CommandStatusCodes interface

defined A-23, A-24

role in provisioning A-28

values summary A-28

CommandStatus interface

methods summary A-9, A-12

role in provisioning A-8

completion() method A-51, A-58

COMPUTER_DEFAULT_CLASS_OF_SERVICE key A-46

COMPUTER_DEFAULT_DHCP_CRITERIA key A-46

COMPUTER_DISRUPTION_EXTENSION_POINT key A-46

COMPUTER_EXTENSION_POINT key A-46

computer interface

in provisioning API 1-5

computers

adding A-16

add in NAT mode 2-17

add in Promiscuous mode 2-15

getting details A-16

keys A-46

new computer in Standard mode (fixed) 2-5

self-provisioning in Standard mode (roaming) 2-7

configuration file

ExternalFile events A-61

configuration generation

use case 2-23

Configuration interface

defined A-15

in provisioning API 1-5

methods summary A-16

role in provisioning A-16

configuration parameters, getting and setting A-16

ConfirmationMode class 1-9

role in provisioning A-12

Confirmation modes

defined 1-8

connections

monitoring 2-26

connectionStarted() method A-56, A-62

connectionStopped() method A-56, A-62

containsInstance() method A-14

COS_DOCSIS_FILE key A-26

createdByClient() method A-7

CSRCAPI interface

role in provisioning API A-9

subinterfaces A-9

CSRC DPR

deprecated methods 1-6

CUSTOM_CONFIRMATION flag A-12

CUSTOM_COS key A-33

CUSTOM_CPE_DEFAULT_CLASS_OF_SERVICE key A-47

CUSTOM_CPE_DEFAULT_DHCP_CRITERIA key A-47

CUSTOM_CPE_DISRUPTION_EXTENSION_POINT key A-47

CUSTOM_CPE_EXTENSION_POINT key A-47

CUSTOM_CPE_FIRMWARE_VERSION key A-43

custom CPE

keys A-47

custom properties

methods for managing A-17

specifying A-13

custom property definition 1-5

D

data queries 1-14, 2-27

defaults

change in server defaults A-57, A-63

change in system defaults A-63

changing computer defaults A-16

changing system defaults A-17

getting for a computer A-16

getting system defaults A-18

notification of system default change A-57

system default keys A-22

deleteClassOfService() method A-21

deleteCNR() method A-17

deleteComputer() method A-16

deleteCustomCPE() method A-18

deleteCustomCPEType() method A-18

deleted() method A-61

deletedCOS() method A-53

deletedDevice() method A-54, A-59

deletedDHCPCriteria() method A-55

deleteDHCPCriteria() method A-21

deleteDOCSISModem() method A-20

deleteDPE() method A-17

deleteDSTB() method A-20

deletedVoiceService() method A-54

deletedVoiceService) method A-59

deleteExternalFile() method A-17

deleteIPDevice() method A-21

deleteUser() method A-17

deleteXGCPService() method A-22

demonstration interface 1-4

demonstration user interface 1-4

deprecated methods 1-6, B-1

device

activation 1-8

device modified event notification A-54

event marking deletion A-54

event marking new provisioned device A-54

event marking new unprovisioned device A-54

event marking relocation of a device A-54

event on deletion of device A-59

event on detection of unprovisioned device A-59

event on relocation A-59

event when provisioned A-59

methods for management A-15

registration 1-19

reset 1-5

roaming A-54

DEVICE_TYPE key A-33

DeviceDetailsKeys interface

defined A-23, A-24

role in provisioning A-33

summary A-33

device searches

in provisioning API 1-5

DeviceSearch interface

defined A-15

methods summary A-19

role in provisioning A-19

DeviceTypeValues interface

defined A-23, A-24

role in provisioning A-34

DHCP criteria

use case 2-24

digital set-top box

See DSTB devices

DOCSIS_COS key A-33

DOCSIS_DEFAULT_CLASS_OF_SERVICE key A-47

DOCSIS_DEFAULT_DHCP_CRITERIA key A-47

DOCSIS_DISRUPTION_EXTENSION_POINT key A-47

DOCSIS_EXTENSION_POINT key A-47

DOCSIS_MODEM_FIRMWARE_VERSION key A-43

DOCSIS_VERSION key A-33

DOCSIS interface

in provisioning API 1-5

DOCSIS modem

adding A-19

getting details A-20

keys A-47

modifying A-19

DPE

methods for managing A-17

DPE_AGENT_HOST_ID key A-42

DPE_CONFIG_POPULATION_BACKOFF key A-45

DPE_CONFIG_POPULATION_DELAY key A-45

DPE_CONFIG_REQUEST_BUFFERS key A-45

DPE_CONFIG_REQUEST_THREADS key A-45

DPE_CONFIG_SYNCHRONIZATION_BACKOFF key A-45

DPE_CONFIG_TIMEOUT key A-45

DPE_CONFIGS key A-42

DPE_FILE_POPULATION_BACKOFF key A-45

DPE_FILE_POPULATION_DELAY key A-45

DPE_FILE_REQUEST_BUFFERS key A-45

DPE_FILE_REQUEST_THREADS key A-45

DPE_FILE_SYNCHRONIZATION_BACKOFF key A-45

DPE_FILE_TIMEOUT key A-45

DPE_FILES key A-42

DPE_HEALTH key A-42

DPE_HITS key A-42

DPE_HOST_ID key A-42

DPE_MISSES key A-42

DPE_MIXING_IP_ADDRESS_ENABLE_KEY key A-45

DPE_PRIMARY_PROV_GROUP_LIST key A-42

DPE_PROPERTIES key A-42

DPE_REQ key A-42

DPE_SECONDARY_PROV_GROUP_LIST key A-42

DPE_SENT key A-42

DPE_STATE key A-42

DPE_SYNCHRONIZATION_DELAY key A-45

DPE_SYNCHRONIZATION_TIMEOUT key A-45

DPE_TIMESERVER_ENABLE_KEY key A-45

DPE_UPTIME key A-42

DPE_VERSION key A-42

DSTB_DEFAULT_CLASS_OF_SERVICE key A-47

DSTB_DEFAULT_DHCP_CRITERIA key A-47

DSTB_DISRUPTION_EXTENSION_POINT key A-47

DSTB_EXTENSION_POINT key A-47

DSTB devices

adding A-20

changing class of service 2-18

configuring A-20

getting details A-20

keys A-47

modifying 2-18

operations on 1-5

preprovisioning 1-12, 2-17

removing 2-20

replacing 2-19

use cases 2-17, 2-20

DSTB interface

defined A-16

in provisioning API 1-5

methods summary A-20

role in provisioning A-20

E

error messages

getting A-9

error processing A-15

events

adding A-52

adding listeners A-52

batch A-51

change in system configuration A-63

change in system defaults A-63

connection started or stopped A-62

creating a listener 2-25

DeviceMod event notification A-54

ExternalFile event notification A-55

firing A-52

in a provisioning group A-56

listening for A-52

managing A-52

MessagingEvent notification A-56

notifications A-52

package A-49

registering for events 2-26

removing A-52

server defaults change A-63

server properties change A-63

use cases 2-25

exceptions A-15

com.cisco.provisioning.cpe A-6, A-15

com.cisco.provisioning.cpe.events A-50

external file event notifications A-55

external files

methods for managing A-17

F

fireBatchEvent() method A-52

fireCOSEvent() method A-52

fireDeviceEvent() method A-52

fireDHCPCriteriaEvent() method A-52

fireExternalFileEvent() method A-52

fireMessagingEvent() method A-52

fireProvGroupEvent() method A-52

fireSystemConfigEvent() method A-52

firmware

version keys A-43

forceBatchReliable A-7

FQDN 1-16

Fully Qualified Domain Name

See FQDN

G

Gateway Control Protocols

See xGCP protocols

generateConfiguration() method A-21

getActivationMode() method A-7

getAddedAndChangedSettings() method A-57

getAddress() method A-56

getAllAPIs() method A-7

getAllClassesOfService() method A-21

getAllCNRs() method A-17

getAllComputers() method A-16

getAllCustomCPEs() method A-18

getAllCustomPropertyDefinitions() method A-17

getAllDHCPCriterias() method A-21

getAllDOCSISModems() method A-20

getAllDPEs() method A-17

getAllDSTBs() method A-20

getAllProvGroups() method A-17

getAllRDUs() method A-17

getAllSystemPropertyDefinitions() method A-17

getAllUsers() method A-17

getAPI() method A-7

getAPICall() method A-7

getAPICallCount() method A-7

getBatchID() method A-7, A-8, A-9

getBatchStatus() method A-51

getClassOfServiceProperties() method A-21

getClientClass() method A-55

getCNRDefaults() method A-17

getCNRDetails() method A-17

getCNRsByProvGroup() method A-17

getCommandCount() method A-8

getCommandStatus() method A-8

getComputerDefaults() method A-16

getConfirmationMode() method A-7

getCustomCPEDefaults() method A-18

getCustomCPETypeDetails() method A-18

getData() method A-9

getDataTypeCode() method A-9

getDetailsForComputer() method A-16

getDetailsForComputerByIPAddress() method A-16

getDetailsForCustomCPE() method A-19

getDetailsForCustomCPEByIPAddress() method A-19

getDetailsForDOCSISModem() method A-20

getDetailsForDOCSISModemByIPAddress() method A-20

getDetailsForDSTB() method A-20

getDetailsForDSTBByIPAddress() method A-20

getDetailsForIPDevice() method A-21

getDetailsForIPDeviceByIPAddress() method A-21

getDeviceFQDN() method A-54

getDeviceID() method A-54

getDeviceIP() method A-54

getDOCSISDefaults() method A-20

getDPEDefaults() method A-17

getDPEDetails() method A-17

getDPEsByProvGroup() method A-17

getDSTBDefaults() method A-20

getErrorMessage() method A-9

getExcludeSelectionTags() method A-55

getExtensionPointSettings() method A-17

getExternalFile() method A-17

getFailedCommandIndex() method A-8

getFailedCommandStatus() method A-8

getFilename() method A-55

getHost() method A-10

getID() method A-51

getIncludeSelectionTags() method A-55

getInstance() A-14

getInstance() method A-14

getIPDeviceDetailsList() method A-21

getIPDeviceDetailsListByIPAddress() method A-21

getIPDeviceForIPAddress() method A-21

getIPDevicesBehindModem() method A-21

getIPDevicesByClassOfService() method A-19

getIPDevicesByFQDN() method A-19

getIPDevicesByIPAddress() method A-19

getIPDevicesByMACAddress() method A-19

getIPDevicesByOwnerID() method A-21

getLicenseKeyData() method A-17

getMatchingExternalFilenames() method A-18

getName() method A-53, A-55

getNamed() method A-11, A-12, A-13, A-14, A-64

getNewData() method A-54

getOldData() method A-54

getOneShot() method A-52, A-58, A-59, A-61, A-62, A-63

getPersistence() method A-56

getPort() method A-10, A-56

getProperties() method A-53, A-55

getProvGroupID() method A-56

getProvisioningGroup() method A-56

getRDUDefaults() method A-18

getRDUDetails() method A-18

getRemovedSettings() method A-57

getReturnString() method A-10

getServerHostID() method A-57

getSource() method A-51

getStatusCode() method A-9

getStatusType() method A-9

getSystemDefaults() method A-18

getting device information 2-27

getType() method A-53, A-57

getUserDetails() method A-18

getValued() method A-11, A-12, A-13, A-14, A-64

getXGCPServiceDetails() method A-22

H

hostnames, getting A-10

I

interfaces

Batch A-7

BatchEvent A-51

BatchListener A-51

BatchStatus A-8

BatchStatusCodes A-25

ClassOfServiceKeys A-26

CNRDetailsKeys A-27

CNRExtensionSettingKeys A-27

CNRServersKeys A-28

com.cisco.provisioning.cpe A-5

com.cisco.provisioning.cpe.api A-15

CommandStatus A-8, A-12

CommandStatusCodes A-28

Computer A-16

Configuration A-16

CSRCAPI A-9

CSRC DPR vs. CSRC BPR B-1

CustomCPE A-18

DeviceDetailsKeys A-33

DeviceEvent A-54

DeviceListener A-54

DeviceSearch A-19

DeviceTypeValues A-34

DHCPCriteriaKeys A-34

DHCPOptionKeys A-35

DOCSIS A-19

DocsisDefaultKeys A-41

DPEDetailsKeys A-42

DSTB A-20

ExternalFileEvent A-55

IPDeviceKeys A-43

MessagingEvent A-56

MessagingListener A-56

ModemKeys A-43

PACEConnection A-10

ProvAPIEvent A-51

ProvAPIEventListener A-52

ProvAPIEventManager A-52

ProvAPIStatus A-9

ProvGroupEvent A-56

ProvGroupListener A-56

Provisioning IP A-21

Qualifier A-57

RDUDetailsKeys A-43

SearchType A-44

ServerDefaultsKeys A-45

SNMPPropertyKeys A-46

SystemConfigEvent A-57

SystemConfigListener A-57

TechnologyDefaultsKeys A-46

UserDetailsKeys A-47

VOIPServiceDetailsKeys A-48

XGCP A-22

XGCPCommandStatusCodes A-48

XGCPProvisioningKeys A-48

IP address

event marking new address A-54

new address event A-59

isAlive() method A-10

isError() method A-9

isSystemError() method A-9

J

Java

JavaDoc 1-5, A-1

joinBatch method A-10

K

keys

ByFQDN A-44

ByMAC A-44

ByMACAndFQDN A-44

CLIENT_CLASS A-33

CLIENT_ID A-33

CLIENT_REQUESTED_HOST_NAME A-33

CMS_FQDN A-48

CMS_PORT_NUMBER A-48

CMS_QUALIFIER A-48

CMTS_MIC_ENABLED A-41

CMTS_MIC_SHARED_SECRET A-41

CNR_ATTRIBUTES_TO_READ_FROM_ENVIRONMENT_DICTIONARY A-27

CNR_ATTRIBUTES_TO_READ_FROM_REQUEST_DICTIONARY A-27

CNR_BATCHES A-27

CNR_CLIENT_PORT A-28

CNR_HEALTH A-27

CNR_HOST_ID A-27

CNR_NUMBER_RETRIES A-28

CNR_PROPERTIES A-27

CNR_PROV_GROUP_ID A-27

CNR_SERVERS_LIST A-28

CNR_STATE A-27

CNR_TIMEOUT A-28

CNR_UPTIME A-27

CNR_VERSION A-27

COMPUTER_DEFAULT_CLASS_OF_SERVICE A-4 6

COMPUTER_DEFAULT_DHCP_CRITERIA A-46

COMPUTER_DISRUPTION_EXTENSION_POINT

COMPUTER_EXTENSION_POINT A-46

COS_DOCSIS_FILE A-26

CUSTOM_COS A-33

CUSTOM_CPE_DEFAULT_CLASS_OF_SERVICE

CUSTOM_CPE_DEFAULT_DHCP_CRITERIA A-47

CUSTOM_CPE_DISRUPTION_EXTENSION_POINT A-47

CUSTOM_CPE_EXTENSION_POINT A-47

CUSTOM_CPE_FIRMWARE_VERSION A-43

DEVICE_TYPE A-33

DOCSIS_COS A-33

DOCSIS_DEFAULT_CLASS_OF_SERVICE A-47

DOCSIS_DEFAULT_DHCP_CRITERIA A-47

DOCSIS_DISRUPTION_EXTENSION_POINT A-47

DOCSIS_EXTENSION_POINT A-47

DOCSIS_MODEM_FIRMWARE_VERSION A-43

DOCSIS_VERSION A-33

DPE_AGENT_HOST_ID A-42

DPE_CONFIG_POPULATION_BACKOFF A-45

DPE_CONFIG_POPULATION_DELAY A-45

DPE_CONFIG_REQUEST_BUFFERS A-45

DPE_CONFIG_REQUEST_THREADS A-45

DPE_CONFIG_SYNCHRONIZATION_BACKOFF A -45

DPE_CONFIG_TIMEOUT A-45

DPE_CONFIGS A-42

DPE_FILE_POPULATION_BACKOFF A-45

DPE_FILE_POPULATION_DELAY A-45

DPE_FILE_REQUEST_BUFFERS A-45

DPE_FILE_REQUEST_THREADS A-45

DPE_FILE_SYNCHRONIZATION_BACKOFF A-45

DPE_FILE_TIMEOUT A-45

DPE_FILES A-42

DPE_HEALTH A-42

DPE_HITS A-42

DPE_HOST_ID A-42

DPE_MISSES A-42

DPE_MIXING_IP_ADDRESS_ENABLE_KEY A-45

DPE_PRIMARY_PROV_GROUP_LIST A-42

DPE_PROPERTIES A-42

DPE_REQ A-42

DPE_SECONDARY_PROV_GROUP_LIST A-42

DPE_SENT A-42

DPE_STATE A-42

DPE_SYNCHRONIZATION_DELAY A-45

DPE_SYNCHRONIZATION_TIMEOUT A-45

DPE_TIMESERVER_ENABLE_KEY A-45

DPE_UPTIME A-42

DPE_VERSION A-42

DSTB_DEFAULT_CLASS_OF_SERVICE A-47

DSTB_DEFAULT_DHCP_CRITERIA A-47

DSTB_DISRUPTION_EXTENSION_POINT A-47

DSTB_EXTENSION_POINT A-47

MUST_BE_BEHIND_DEVICE A-43

MUST_BE_IN_PROV_GROUP A-43

PROMISCUOUS_MODE_ENABLED A-43

PROPERTIES A-48

RDU_AGENT_HOST_ID A-43

RDU_CONFIGURATION_EXTENSION_POINT A-4 5

RDU_DEVICE_DETECTION_EXTENSION_POINT A-45

RDU_HEALTH A-43

RDU_HOST_ID A-44

RDU_HOST_PORT A-44

RDU_MAX_GET_SYNC_REV_NUMBERS_FOR_IP_DEVICES A-45

RDU_PROPERTIES A-44

RDU_STATE A-44

RDU_UPTIME A-44

RDU_VERSION A-44

READ_COMMUNITY_STRING A-46

RELAY_AGENT_CIRCUIT_ID A-34

RELAY_AGENT_REMOTE_ID A-34

SERVER_CONNECTION_DELAY A-46

SERVER_REGISTRATION_DELAY A-46

SERVER_REGISTRATION_TIMEOUT A-46

TELEPHONE_NUMBER A-48

TFTP_MODEM_ADDRESS_OPTION_ENABLED A -41

TFTP_TIMESTAMP_OPTION_ENABLED A-41

UNCOMMITED_CONFIG_TIME_TO_LIVE A-43

USE_CLIENT_ID A-28

USER_DESCRIPTION A-47

USER_ID A-47

USER_ISADMIN A-47

USER_PASSWORD A-47

WRITE_COMMUNITY_STRING A-46

XGCP_SIGNALING_TYPE A-47, A-48

XGCP_USE_OLD_STYLE A-47, A-48

XGCP_VERSION_NUMBER A-47, A-48

L

lease

promiscuous mode 1-20

LicenseDataKeys interface

defined A-23, A-24

license keys

methods for managing A-17

licensing 1-5

listeners

adding A-52

creating 2-25

removing A-52

logging 1-7

logging batch completions 2-27

logging device deletions 2-25

M

MAC address 1-15

changing for a computer A-16

machine address

See MAC address

merit-dump string key A-47

methods

addAPICall() method A-7

addBatchListener() A-52

addClassOfService() A-21

addComputer() A-16

addComputerByIPAddress() A-16

addCOSListener() A-52

addCustomCPE() A-18

addCustomCPEByIPAddress() A-18

addCustomCPEType() A-18

addCustomPropertyDefinition() A-17

addDeviceListener() A-52

addDHCPCriteria() A-21

addDHCPCriteriaListener() A-52

addDOCSISModem() A-19

addDOCSISModemByIPAddress() A-19

addDSTB() A-20

addDSTBByIPAddress() A-20

added() A-61

addExternalFile() A-17

addExternalFileListener() A-52

addLicenseKey() A-17

addMessagingListener() A-52

addProvGroupListener() A-52

addSystemConfigListener() A-52

addUser() A-17

addXGCPService() A-22

changeClassOfServiceProperties() A-21

changeComputerClassOfService() A-16

changeComputerDefaults() A-16

changeComputerDHCPCriteria() A-16

changeComputerFQDN() A-16

changeComputerMACAddress() A-16

changeComputerOwnerID() A-16

changeComputerProperties() A-16

changeCustomCPEClassOfService() A-18

changeCustomCPEDefaults() A-18

changeCustomCPEDHCPCriteria() A-18

changeCustomCPEFQDN() A-18

changeCustomCPEMACAddress() A-18

changeCustomCPEOwnerID() A-18

changeCustomCPEProperties() A-18

changeCustomCPETypeProperties() A-18

changedCoS() A-54

changeDHCPCriteriaExcludeSelectionTags() A-21

changeDHCPCriteriaIncludeSelectionTags() A-21

changeDHCPCriteriaProperties() A-21

changedIP() A-54, A-59

changeDOCSISDefaults() A-19

changeDOCSISModemClassOfService() A-19

changeDOCSISModemCPEDHCPCriteria() A-19

changeDOCSISModemDHCPCriteria() A-19

changeDOCSISModemFQDN() A-19

changeDOCSISModemMACAddress() A-19

changeDOCSISModemOwnerID() A-19

changeDOCSISModemProperties() A-20

changeDPEDefaults() A-17

changeDSTBClassOfService() A-20

changeDSTBDefaults() A-20

changeDSTBDHCPCriteria() A-20

changeDSTBFQDN() A-20

changeDSTBMACAddress() A-20

changeDSTBOwnerID() A-20

changeDSTBProperties() A-20

changeDSTBRelatedDOCSISModemID() A-20

changeExtensionPointSettings() A-17

changeRDUDefaults() A-17

changeSystemDefaults() A-17

changeUser() A-17

changeXGCPServiceCmsFQDN() A-22

changeXGCPServiceCmsPortNumber() A-22

changeXGCPServiceCmsQualifier() A-22

changeXGCPServiceProperties() A-22

changeXGCPServiceTelephoneNumber() A-22

clearAll() A-58, A-59, A-60, A-61, A-62, A-64

code to access interfaces 1-11

commandReturnsData() A-9

completion() A-51, A-58

connectionStarted() A-56, A-62

connectionStopped() A-56, A-62

containsInstance() A-14

createdByClient() A-7

deleteClassOfService() A-21

deleteCNR() A-17

deleteComputer() A-16

deleteCustomCPE() A-18

deleteCustomCPEType() A-18

deleted() A-61

deletedCOS() A-53

deletedDevice() A-54, A-59

deletedDHCPCriteria() A-55

deleteDHCPCriteria() A-21

deleteDOCSISModem() A-20

deleteDPE() A-17

deleteDSTB() A-20

deletedVoiceService() A-54, A-59

deleteExternalFile() A-17

deleteIPDevice() A-21

deleteUser() A-17

deleteXGCPService() A-22

deprecated methods B-1

fireBatchEvent() A-52

fireCOSEvent() A-52

fireDeviceEvent() A-52

fireDHCPCriteriaEvent() A-52

fireExternalFileEvent() A-52

fireMessagingEvent() A-52

fireProvGroupEvent() A-52

fireSystemConfigEvent() A-52

forceBatchReliable A-7

generateConfiguration() A-21

getActivationMode() A-7

getAddedAndChangedSettings() A-57

getAddress() A-56

getAllAPI()s A-7

getAllClassesOfService() A-21

getAllCNRs() A-17

getAllComputers() A-16

getAllCustomCPEs() A-18

getAllCustomPropertyDefinitions() A-17

getAllDHCPCriterias() A-21

getAllDOCSISModems() A-20

getAllDPEs() A-17

getAllDSTBs() A-20

getAllProvGroups() A-17

getAllRDUs() A-17

getAllSystemPropertyDefinitions() A-17

getAllUsers() A-17

getAPI() A-7

getAPICall() A-7

getAPICallCount() A-7

getBatchID() A-8, A-9

getBatchStatus() A-51

getClassOfServiceProperties() A-21

getClientClass() A-55

getCNRDefaults() A-17

getCNRDetails() A-17

getCNRsByProvGroup() A-17

getCommandCount() A-8

getComputerDefaults() A-16

getConfirmationMode() A-7

getCustomCPEDefaults() A-18

getCustomCPETypeDetails() A-18

getData() A-9

getDataTypeCode() A-9

getDetailsForComputer() A-16

getDetailsForComputerByIPAddress() A-16

getDetailsForCustomCPE() A-19

getDetailsForCustomCPEByIPAddress() A-19

getDetailsForDOCSISModem() A-20

getDetailsForDOCSISModemByIPAddress() A-20

getDetailsForDSTB() A-20

getDetailsForDSTBByIPAddress() A-20

getDetailsForIPDevice() A-21

getDetailsForIPDeviceByIPAddress() A-21

getDeviceFQDN() A-54

getDeviceID() A-54

getDeviceIP() A-54

getDOCSISDefaults() A-20

getDPEDefaults() A-17

getDPEDetails() A-17

getDPEsByProvGroup() A-17

getDSTBDefaults() A-20

getErrorMessage() A-9

getExcludeSelectionTags() A-55

getExtensionPointSettings() A-17

getExternalFile() A-17

getFailedCommandIndex() A-8

getFailedCommandStatus() A-8

getFilename() A-55

getHost() A-10

getID() A-51

getIncludeSelectionTags() A-55

getIPDeviceDetailsList() A-21

getIPDeviceDetailsListByIPAddress() A-21

getIPDeviceForIPAddress() A-21

getIPDevicesBehindModem() A-21

getIPDevicesByClassOfService() A-19

getIPDevicesByFQDN() A-19

getIPDevicesByIPAddress() A-19

getIPDevicesByMACAddress() A-19

getIPDevicesByOwnerID() A-21

getLicenseKeyData() A-17

getMatchingExternalFilenames() A-18

getName() A-53, A-55

getNamed() A-11, A-12, A-13, A-14, A-64

getNewData() A-54

getOldData() A-54

getOneShot() A-52, A-58, A-59, A-61, A-62, A-63

getPersistence() A-56

getPort() A-10, A-56

getProperties() A-53, A-55

getProvAPI() A-7

getProvGroupID() A-56

getProvisioningGroup() A-56

getPublishingMode() A-7

getRDUDefaults() A-18

getRDUDetails() A-18

getRemovedSettings() A-57

getReturnString() A-10

getServerHostID() A-57

getSource() A-51

getStatusCode() A-9

getStatusType() A-9

getSystemDefaults() A-18

getType() A-53, A-57

getUserDetails() A-18

getValued() A-11, A-12, A-13, A-14, A-64

getXGCPServiceDetails() A-22

in batch operations 1-9

isAlive() A-10

isBatchReliable() A-7

isError() A-9

isSystemError() A-9

isWarning() A-8

joinBatch A-10

modified() A-56, A-63

newBatch() A-10, A-11

newCOS() A-53

newCoS() A-59

newDHCPCriteria() A-55

newProvDevice() A-54, A-59

newUnprovDevice() A-54, A-59

newVoiceService() A-54, A-59

openConnection() A-11

post() A-7, A-8

postBatch() A-11

postBatchNoStatus() A-11

postNoConfirmation() A-8

postWithConfirmation() A-8

qualifies() A-57, A-58, A-62, A-63

qualifies(ProvAPIEvent event) A-59, A-60, A-61, A-64

releaseConnection() A-11

removeBatchListener() A-52

removeCOSListener() A-53

removeCustomPropertyDefinition() A-18

removeDeviceListener() A-53

removeDHCPCriteriaListener A-53

removeExternalFileListener() A-53

removeProvGroupListener() A-53

removeSystemConfigListener() A-53

replaced() A-61

replaceExternalFile() A-18

resetIPDevice() A-21

roaming() A-54, A-59

serverDefaultsChanged() A-57, A-63

serverPropertiesChanged() A-63

serverPropertiesChanges() A-57

setAllConnectionsDown() A-62

setAllPersistentConnectionsDown() A-62

setBatchID() A-58

setChangedCOS() A-59

setChangedIP() A-59

setDeletedCOS() A-58

setDeletedDevice() A-59

setDeletedDHCPCriteria() A-60

setDeletedExternalFile() A-61

setDeletedVoiceService() A-60

setDeviceID(java.lang.String deviceMac) A-60

setID() A-51

setNewCOS() A-58

setNewDevice() A-60

setNewDHCPCriteria() A-60

setNewExternalFile() A-61

setNewProvDevice() A-60

setNewUnprovDevice() A-60

setNewVoiceService() A-60

setOneShot() A-52, A-58, A-59, A-61, A-62, A-63

setReplaceExternalFile() A-61

setRoamingDevice() A-60

setServerDefaultsChange() A-64

setServerPropertiesChange() A-64

setSource() A-51

setSystemConfigChange() A-64

setSystemDefaultsChange() A-64

systemConfigChanged() A-57, A-63

systemDefaultsChanged() A-57, A-63

toString() A-51

wasBatchReliable A-8

wasPosted() A-8

modem and computer

self-provisioning in Standard mode (fixed) 2-2

modems

activate in NAT mode 2-15

bulk provisioning in Promiscuous mode 2-11

preprovisioning an xGCP capable DOCSIS modem 2-20, 2-22, 2-23

replace in Promiscuous mode 2-14

self-provisioning in Standard mode (roaming) 2-8

modes

AUTOMATIC A-11

for registering devices 1-19

Network Address Translation 1-20

NO_ACTIVATION A-11

Promiscuous 1-20

Standard 1-19

modified() method A-56, A-63

modifying

a DOCSIS modem A-19

monitor broken connections 2-26

MUST_BE_BEHIND_DEVICE key A-43

MUST_BE_IN_PROV_GROUP key A-43

N

NAT mode

activate a modem 2-15

add a computer 2-17

defined 1-20

use cases 2-15, 2-17

Network Address Translation mode

See NAT mode

newBatch() method A-10

newCOS() method A-53

newCoS() method A-59

newDHCPCriteria() method A-55

newProvDevice() method A-54, A-59

newUnprovDevice() method A-54, A-59

newVoiceService() method A-54

newVoiceService) method A-59

NO_ACTIVATION flag 1-9

NO_ACTIVATION mode 1-9, A-11

NO_CONFIRMATION flag 1-9, A-12

O

oneShot mode A-58, A-59, A-61

ownerID 1-16

owner identifier

See ownerID

P

PACE

code to call getInstance() 1-10, 1-11

connection methods A-5

opening connection to 1-10

posting batch 1-13

PACEConnectionException exception A-15

PACEConnectionFactory class

methods summary A-14

role in provisioning A-14

PACEConnection interface

communication with PACE A-10

methods summary A-10

role in provisioning API A-10

packages

com.cisco.provisioning.cpe.constants A-22

com.cisco.provisioning.cpe.events A-49

packages in provisioning API A-1

port information

for xGCP service A-22

port number

getting A-10

postBatch() method A-11

posting batch 1-13

preprovisioning

DSTB 2-17

first time activation in Promiscuous mode 2-13

xGCP capable DOCSIS modem 2-20, 2-22, 2-23

xGCP devices 2-20

preprovisioning a DSTB

queuing method calls 1-12

programming examples, for batch operations 1-10

PROMISCUOUS_MODE_ENABLED key A-43

Promiscuous mode

activation 2-9, 2-13

add a modem 2-15

bulk provisioning modems 2-11

defined 1-20

enabled key A-43

replace a modem 2-14

use cases 2-9, 2-11, 2-13, 2-14, 2-15

properties

changing for a computer A-16

changing for a DOCSIS modem A-20

changing for a DSTB A-20

changing for an xGCP service A-22

changing system properties A-17

data types in custom property definitions A-6

getting system properties A-18

methods for managing A-17

notification when server properties change A-57

returning new or changed properties A-57

returning removed properties A-57

server A-63

PROPERTIES key A-48

proprietary equipment

CustomCPE interface A-18

ProvAPIEvent interface A-51

ProvAPIEventListener interface A-52

methods A-52

ProvAPIEventManager interface A-52

methods summary A-52

ProvAPI interface

methods summary A-51

ProvAPIListener nterface

methods summary A-52

ProvAPIStatus interface

methods summary A-9

role in provisioning API A-9

provisioning

interface in provisioning API 1-5

provisioning API

deprecated methods 1-6

packages listed A-1

provisioning client

monitoring multiple instances 2-25

ProvisioningException() A-15

provisioning groups

events A-56

managing A-17

Provisioning interface

defined A-16

methods summary A-16, A-21

role in provisioning A-19

pseudocode, definition of 2-1

Q

qualifies() method A-57, A-58, A-62, A-63

qualifies(ProvAPIEvent event) method A-59, A-60, A-61, A-64

querying

data 1-14, 2-27

for vendor prefix 2-28

R

RDU

keys A-43

methods for managing A-17

monitoring connections 2-26

RDU_AGENT_HOST_ID key A-43

RDU_CONFIGURATION_EXTENSION_POINT key A-45

RDU_DEVICE_DETECTION_EXTENSION_POINT key A-45

RDU_HEALTH key A-43

RDU_HOST_ID key A-44

RDU_HOST_PORT key A-44

RDU_MAX_GET_SYNC_REV_NUMBERS_FOR_IP_DEVICES key A-45

RDU_PROPERTIES key A-44

RDU_STATE key A-44

RDU_UPTIME key A-44

RDU_VERSION key A-44

READ_COMMUNITY_STRING key A-46

Registering devices 1-19

S

searching for devices 2-27, A-19

search types

enumerated A-44

self-provisioning

activation in Promiscuous mode 2-9

modem and computer in Standard mode (fixed) 2-2

modify a modem in Standard mode (roaming) 2-8

new computer in Standard mode (roaming) 2-7

server

changes in defaults A-57

changes in properties A-63

defaults A-63

notification when properties change A-57

SERVER_CONNECTION_DELAY key A-46

SERVER_REGISTRATION_DELAY key A-46

SERVER_REGISTRATION_TIMEOUT key A-46

serverDefaultsChanged() method A-57, A-63

serverPropertiesChanged() method A-57, A-63

setAllConnectionsDown() method A-62

setAllPersistentConnectionsDown() method A-62

setBatchID() method A-58

setChangedCOS() method A-59

setChangedIP() method A-59

setDeletedCOS() method A-58

setDeletedDevice() method A-59

setDeletedDHCPCriteria() method A-60

setDeletedExternalFile() method A-61

setDeletedVoiceService method A-60

setDeviceID(java.lang.String deviceMac) method A-60

setID() method A-51

setNewCOS() method A-58

setNewDevice() method A-60

setNewDHCPCriteria() method A-60

setNewExternalFile() method A-61

setNewProvDevice() method A-60

setNewUnprovDevice() method A-60

setNewVoiceService() method A-60

setOneShot() method A-52, A-58, A-59, A-61, A-62, A-63

setReplaceExternalFile() method A-61

setRoamingDevice() method A-60

setServerDefaultsChange() method A-64

setServerPropertiesChange() method A-64

setSource() method A-51

setSystemConfigChange() method A-64

setSystemDefaultsChange() method A-64

SGCP version string A-48

signaling type key A-47

Simple Gateway Control Protocol

See xGCP protocols

SNMP

OID 1-8

version A-14

SNMPPropertyKeys interface

defined A-23, A-24

role in provisioning A-46

summary A-46

Standard mode 1-19

Standard mode (fixed)

disable a subscriber 2-6

use cases 2-2, 2-5, 2-6

Standard mode (roaming)

delete devices 2-8

use cases 2-7, 2-8

status

getting A-22

of batch 1-13

status codes

BATCH_WARNING 1-9, A-12

commands A-28

for batches A-25

status codes, for results of processing A-9

subscribers

delete devices in Standard mode (roaming) 2-8

disable in Standard mode (fixed) 2-6

systemConfigChanged() method A-57, A-63

system configuration A-63

system defaults A-63

changing A-17

getting A-18

keys A-22

notification when changed A-57

returning new or changed defaults A-57

returning removed defaults A-57

use case for changing 2-25

systemDefaultsChanged() method A-57, A-63

T

TELEPHONE_NUMBER key A-48

telephone line

activating 2-22

TFTP_MODEM_ADDRESS_OPTION_ENABLED key A-41

TFTP_TIMESTAMP_OPTION_ENABLED key A-41

toString() method A-51

type

class of service A-26

U

UNCOMMITED_CONFIG_TIME_TO_LIVE key A-43

USE_CLIENT_ID key A-28

use cases

add DHCP criteria 2-24

changing system defaults 2-25

configuration generation 2-23

events 2-25

for DSTB devices 2-17, 2-20

for events 2-25

for NAT mode 2-15, 2-17

for Promiscuous mode 2-9, 2-11, 2-13, 2-14, 2-15

for Standard mode (fixed) 2-2, 2-5, 2-6

for Standard mode (roaming) 2-7, 2-8

for xGCP capable DOCSIS modem 2-20, 2-22, 2-23

monitoring a connection to the RDU 2-26

USER_DESCRIPTION key A-47

USER_ID key A-47

USER_ISADMIN key A-47

USER_PASSWORD key A-47

users

methods for managing A-17

V

vendor prefix search 2-28

version

number key for xGCP device A-47

SGCP version strings A-48

voice capable devices

See xGCP devices

voice service

adding and deleting listeners A-54

VOIPServiceDetailsKeys interface

defined A-23, A-24

role in provisioning A-48

W

wasPosted() method A-8

WRITE_COMMUNITY_STRING key A-46

X

XGCP_SIGNALING_TYPE key A-47, A-48

XGCP_USE_OLD_STYLE key A-47, A-48

XGCP_VERSION_NUMBER key A-47, A-48

xGCP capable DOCSIS modem

use cases 2-20, 2-22, 2-23

XGCPCommandStatusCodes interface

defined A-25

role in provisioning A-48

xGCP devices

configuring A-22

merit-dump string format key A-47

operations on 1-5

preprovisioning 2-20

signaling type key A-47

version number key A-47

xGCP interface

defined A-16

in provisioning API 1-5

methods summary A-22

role in provisioning A-22

xGCP modem/MTA

assigning a service A-22

getting details A-22

getting port information A-22

xGCP protocols

Simple Gateway Control Protocol 1-5

XGCPProvisioningKeys interface

defined A-25

XML batch submission 1-7

Table of Contents

Index

A

B

C

D

E

F

G

H

I

J

K

L

M

N

O

P

Q

R

S

T

U

V

W

X