Event System Management Commands
This chapter describes the command-line interface (CLI) commands used the PCP DPE to trigger event and, monitor and manage the Prime Cable Provisioning event system.
For information on DPE Event Publisher, see Cisco Prime Cable Provisioning 6.3 User Guide.
Note Before using a DPE event command, you must enable DPE event monitor by running the DPE event monitor command.
If you run the following commands on an unlicensed DPE, the following message appears:
This DPE is not licensed. Your request cannot be serviced. Please check with your system administrator for a DPE license.
The commands described in this chapter are:
|
|
|
|
|
|
|
|
|
|
dpe event monitor |
Enable the DPE event monitor |
P |
|
P |
P |
|
|
dpe event request |
Events the DPE request service |
P |
|
P |
P |
|
|
dpe event config |
Events the DPE cache configuration |
P |
|
P |
P |
|
|
dpe event file |
Events the DPE cache file operation |
P |
|
P |
P |
|
|
dpe event log |
Events the DPE logs with log level |
P |
|
P |
P |
|
|
dpe event tftp |
Events the DPE TFTP requests |
P |
|
P |
P |
|
|
no dpe event monitor |
Disable all the DPE events |
|
P |
P |
P |
|
|
no dpe event request |
Stop Events the DPE request service |
|
P |
P |
P |
|
|
no dpe event config |
Stop Events the DPE cache configuration |
|
P |
P |
P |
|
|
no dpe event file |
Stop Events the DPE cache file operation |
|
P |
P |
P |
|
|
no dpe event log |
Stop Events the DPE logs with log level |
|
P |
P |
P |
|
|
no dpe event tftp |
Stop Events the DPE TFTP requests |
|
P |
P |
P |
|
|
dpe event kafka bootstrap-servers |
Configures Kafka bootstrap-servers producerconfig property |
P |
|
P |
P |
|
|
dpe event kafka custom-topic |
Configures custom topics for DPE events |
P |
|
P |
P |
|
|
dpe event kafka security |
Configures Kafka security-protocol producerconfig property |
P |
|
P |
P |
|
|
dpe event kafka topic |
Sets Kafka Topic for all DPE Events |
P |
|
P |
P |
|
|
dpe event
Use the dpe event command to configure event settings on the DPE. Following are the examples that you can use with this command:
Syntax Description
dpe event monitor
no dpe event monitor
Enables DPE to trigger events, which involves common interface to enable DPE events features and depends on the below event type. It triggers the DPE events.
- dpe event config — Enables dpe configuration event for DPE event.
- dpe event file — Enables dpe file event for DPE event.
- dpe event log — Enables dpe log level event for DPE event.
- dpe event request — Enables dpe request event for DPE event.
- dpe event tftp — Enables dpe tftp event for DPE event.
To disable all the DPE events, use the no form of this command.
Examples
This result occurs when you enable dpe event monitor of the DPE.
bac_dpe# dpe event monitor
This result occurs when you disable dpe event monitor of the DPE.
bac_dpe# no dpe event monitor
Defaults
Event of the DPE is by default disabled.
dpe event config
Syntax Description
dpe event config
no dpe event config
Enables configuration events to the DPE, Which involves events that occurs while configuration changes in the dpe cache. It includes,
- Received configuration for device from RDU.
- Received updated configuration for device from RDU.
- Removed configuration for device from cache.
- Completed device attributes dumping process.
To disable DPE configuration events, use the no form of this command.
Examples
This result occurs when you enable configuration event of the DPE.
bac_dpe# dpe event config
This result occurs when you disable configuration event of the DPE.
bac_dpe# no dpe event config
Defaults
Configuration event of the DPE is by default disabled.
dpe event file
Syntax Description
dpe event file
no dpe event file
Enables file events to the DPE, Which involves events that occurs while file configuration changes in the DPE cache. It includes,
- Received file from RDU.
- Received updated file from RDU.
- Removed file from cache.
To disable DPE file events, use the no form of this command.
Examples
This result occurs when you enable file event of the DPE.
This result occurs when you disable file event of the DPE.
bac_dpe# no dpe event file
Defaults
File event of the DPE is by default disabled.
dpe event request
Syntax Description
dpe event request
no dpe event request
Enables dpe request events to the DPE, Which involves events that occurs while device request, ToD request, SNMP reset request. It includes,
Device request
- Sending no cached configuration for device in provisioning group to device.
- Sending configuration for device in provisioning group to device.
ToD request
- Received UDP time of day request from device.
- ToD Success/Failure.
SNMP reset
- Processing SNMP reset for device.
- Successfully send SNMP reset for device.
To disable DPE request events, use the no form of this command.
Examples
This result occurs when you enable dpe request event of the DPE.
bac_dpe# dpe event request
This result occurs when you disable dpe request event of the DPE.
bac_dpe# no dpe event request
Defaults
Request event of the DPE is by default disabled.
dpe event tftp
Syntax Description
dpe event tftp
no dpe event tftp
Enables tftp events to the DPE, Which involves events that occurs while device request for tftp. It includes,
- Received a TFTP [read] request from device for file.
- Finished handling [read] request from device for file.
- TFTP exception.
To disable DPE tftp events, use the no form of this command.
Examples
This result occurs when you enable dpe tftp event of the DPE.
This result occurs when you disable dpe tftp event of the DPE.
bac_dpe# no dpe event tftp
Defaults
TFTP event of the DPE is by default disabled.
dpe event log
Syntax Description
dpe event log
no dpe event log
Enables log events to the DPE, Which involves events that occurs for all dpe process and send the log event depends on the log level of DPE. It includes,
- Send the DPE log as events.
- Depend on the DPE log level it send the logs as events.
To disable DPE log events, use the no form of this command.
Examples
This result occurs when you enable dpe log event of the DPE.
This result occurs when you disable dpe log event of the DPE.
bac_dpe# no dpe event log
Defaults
Log event of the DPE is by default disabled.
dpe event kafka
Use the dpe event kafka command to configure the kafka server on the DPE.
Note The kafka version used to test is Kafka 2.7.0
Syntax Description
dpe event kafka
Following are the options that you can use with this command:
- dpe event kafka bootstrap-servers—Configures kafka bootstrap-servers producerconfig property.
- dpe event kafka custom-topic—Configures custom topics for DPE events.
- dpe event kafka security—Configures kafka security-protocol producerconfig property.
- dpe event kafka topic—Sets kafka topic for all the DPE events.
Note After you use the any of the above commands, run the dpe reload command to restart the DPE.
Examples
This result occurs when you invoke the help function for dpe event kafka command.
bac_dpe# dpe event kafka ?
bootstrap-servers Configures Kafka bootstrap-servers producerconfig property.
custom-topic Configures custom topics for DPE events.
security Configures Kafka security-protocol producerconfig property.
topic Sets Kafka Topic for all DPE Events.
dpe event kafka bootstrap-servers
Syntax Description
dpe event kafka bootstrap-servers <host:port>
Configures kafka bootstrap-servers to the specified host and port, which enables the triggered DPE events to be stored in the configured server.
– host specifies the IP address of the kafka server.
– port identifies the port number, port number must be between 0 and 65535 (optional).
Note After you use the above command, run the dpe reload command to restart the DPE.
Examples
This result occurs when you configure the kafka bootstrap-server.
bac_dpe# dpe event kafka bootstrap-servers pcp-lnx-xx:9092
% OK (Requires DPE restart "> dpe reload")
dpe event kafka custom-topic
Use the dpe event kafka custom-topic command to configure kafka topics and partitions for various DPE event types (Partition configuration is optional).
Following are the options that you can use with this command:
Syntax Description
dpe event kafka custom-topic
no dpe event kafka custom-topic
- dpe event kafka custom-topic config <topic-name> partition <partition-number>-Configures Topic for Config event.
- dpe event kafka custom-topic file <topic-name> partition <partition-number>- Configures Topic for File event.
- dpe event kafka custom-topic log <topic-name> partition <partition-number>- Configures Topic for Log event.
- dpe event kafka custom-topic request <topic-name> partition <partition-number>- Configures Topic for Request event.
- dpe event kafka custom-topic tftp <topic-name> partition <partition-number>- Configures Topic for TFTP event.
– topic-name-Specifies the name of the kafka topic, which will be created as a DPE property in dpe.properties file.
– partition-number-Configures the partition (optional) for the custom-topics which will be created as a DPE property in dpe.properties file.
To disable DPE event kafka custom-topics, use the no form of this command. This disables the whole topic when executed with just topic-name, and to disable just the partition execute it with the partition.
Note If custom-topic is configured for the above DPE events, this configuration will take preference over the topic name created using the DPE event kafka topic command.
Note After you use the any of the above commands, run the dpe reload command to restart the DPE.
Examples
This result occurs when you use the above commands to configure topic file for the DPE events.
bac_dpe# dpe event kafka custom-topic config myconfig partition 1
% OK (Requires DPE restart "> dpe reload")
bac_dpe# dpe event kafka custom-topic file myfile partition 2
% OK (Requires DPE restart "> dpe reload")
bac_dpe# dpe event kafka custom-topic log mylog partition 3
% OK (Requires DPE restart "> dpe reload")
bac_dpe# dpe event kafka custom-topic request myrequest partition 4
% OK (Requires DPE restart "> dpe reload")
bac_dpe# dpe event kafka custom-topic tftp mytftp partition 5
% OK (Requires DPE restart "> dpe reload")
dpe event kafka security
Syntax Description
dpe event kafka security <security-protocol>
Configures the kafka security-protocol for the producer and this security.protocol property is created in dpeproducerconfig.property folder under /opt/CSCObac/dpe/conf.
– Security-protocol specifies the protocol, PLAINTEXT/SASL_PLAINTEXT/SSL/SASL_SSL.
Note After you use the above command, run the dpe reload command to restart the DPE.
Examples
This result occurs when you configure the kafka security protocol.
bac_dpe# dpe event kafka security SSL
% OK (Protocol other than PLAINTEXT requires additional properties to be added in dpeproducerconfig.properties. Requires DPE restart)
dpe event kafka topic
Syntax Description
dpe event kafka topic <topic-name>
no dpe event kafka topic <topic-name>
Configures the kafka topic for all the DPE events.
– topic-name specifies the name of the kafka topic.
To disable DPE event kafka topic, use the no form of this command.
Note If custom-topic is configured for the DPE events, that configuration will take preference over the topic name created using the dpe event kafka topic command.
Note After you use the above command, run the dpe reload command to restart the DPE.
Examples
This result occurs when you configure the DPE event kafka topic.
bac_dpe# dpe event kafka topic mytopic
% OK (Requires DPE restart "> dpe reload")