event-notification kafka

Set parameters for kafka server

kafka Specification

   
Type Intermediate Resource
Element Name kafka
Element URI /axapi/v3/event-notification/kafka
Element Attributes kafka_attributes
Schema kafka schema

Operations Allowed:

OperationMethodURIPayload

Get Object

GET

/axapi/v3/event-notification/kafka

kafka_attributes

kafka attributes

server

Description: server is a JSON Block. Please see below for server

Type: Object

Refernce Object: /axapi/v3/event-notification/kafka/server

server

Specification  
Type object

host-ipv4

Description Set kafka Broker ip address or hostname

Type: string

Format: host

port

Description Set remote kafka port number (Remote kafka port number 1-32767, default is 9092)

Type: number

Range: 1-32767

Default: 9092

sampling-enable

Type: List

use-mgmt-port

Description Use management port for connections

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

server_sampling-enable

Specification  
Type list
Block object keys  

counters1

Description ‘all’: all; ‘vcpe-events-device-status’: vCPE_Events topic device status counter; ‘vcpe-messagestream-device-dhcp-stream’: vCPE_MessageStream topic device dhcp stream counter; ‘vcpe-events-tunnel-status’: vCPE_Events topic tunnel status counter; ‘vcpe-events-device-report’: vCPE_Events topic device report counter; ‘cfg-sent-to-cm’: Configuration sent to CM from Backend counter; ‘kafka-broker-down’: Notification not sent because kafka broker is down; ‘kafka-queue-full-err’: Notification drop because kafka Queue is full; ‘cfg-sent-to-cm-enqueue-err’: Configuration sent to CM enqueue error; ‘vcpe-messagestream-dhcp-stream-enqueue-err’: vCPE_MessageStream topic device dhcp stream counter enqueue error; ‘vcpe-events-tunnel-status-enqueue-err’: vCPE_Events topic tunnel status counter enqueue error; ‘vcpe-events-device-status-enqueue-err’: vCPE_Events topic device status counter enqueue error; ‘vcpe-events-device-report-enqueue-err’: vCPE_Events topic device report counter enqueue error; ‘cfg-sent-to-cm-dequeue-err’: Configuration sent to CM dequeue error; ‘vcpe-messagestream-dhcp-stream-dequeue-err’: vCPE_MessageStream topic device dhcp stream counter dequeue error; ‘vcpe-events-tunnel-status-dequeue-err’: vCPE_Events topic tunnel status counter dequeue error; ‘vcpe-events-device-status-dequeue-err’: vCPE_Events topic device status counter dequeue error; ‘vcpe-events-device-report-dequeue-err’: vCPE_Events topic device report counter dequeue error; ‘kafka-unknown-topic-dequeue-err’: Kafka Unknown topic error; ‘pr-acos-appcito-topic’: PR topic counter from acos to appcito; ‘pr-acos-appcito-topic-enqueue-err’: PR topic to appcito enqueue error; ‘pr-acos-appcito-topic-dequeue-err’: PR topic to appcito dequeue error; ‘host-acos-appcito-topic’: HOST topic counter from acos to appcito; ‘host-acos-appcito-topic-enqueue-err’: HOST topic to appcito enqueue error; ‘host-acos-appcito-topic-dequeue-err’: HOST topic to appcito dequeue error; ‘server-acos-appcito-topic’: SERVER topic counter from acos to appcito; ‘server-acos-appcito-topic-enqueue-err’: SERVER topic to appcito enqueue error; ‘server-acos-appcito-topic-dequeue-err’: SERVER topic to appcito dequeue error; ‘service-acos-appcito-topic’: SERVICE topic counter from acos to appcito; ‘service-acos-appcito-topic-enqueue-err’: SERVICE topic to appcito enqueue error; ‘service-acos-appcito-topic-dequeue-err’: SERVICE topic to appcito dequeue error; ‘flow-acos-appcito-topic’: FLOW topic counter from acos to appcito; ‘flow-acos-appcito-topic-enqueue-err’: FLOW topic to appcito enqueue error; ‘flow-acos-appcito-topic-dequeue-err’: FLOW topic to appcito dequeue error;

Type: string

Supported Values: all, pr-acos-harmony-topic, avro-device-status-topic, avro-partition-metrics-topic, avro-generic-sent, pr-acos-harmony-topic-enqueue-err, pr-acos-harmony-topic-dequeue-err, avro-generic-failed-encoding, avro-generic-failed-sending, avro-device-status-topic-enqueue-err, avro-device-status-topic-dequeue-err, avro-partition-metrics-topic-enqueue-err, avro-partition-metrics-topic-dequeue-err, kafka-unknown-topic-dequeue-err, kafka-broker-down, kafka-queue-full-err, pr-throttle-drop, pr-not-allowed-drop, pr-be-ttfb-anomaly, pr-be-ttlb-anomaly, pr-in-latency-threshold-exceed, pr-out-latency-threshold-exceed, pr-out-latency-anomaly, pr-in-latency-anomaly, kafka-topic-error, pc-encoding-failed, pc-acos-harmony-topic, pc-acos-harmony-topic-dequeue-err, cgn-pc-acos-harmony-topic, cgn-pc-acos-harmony-topic-dequeue-err, cgn-pe-acos-harmony-topic, cgn-pe-acos-harmony-topic-dequeue-err, fw-pc-acos-harmony-topic, fw-pc-acos-harmony-topic-dequeue-err, fw-deny-pc-acos-harmony-topic, fw-deny-pc-acos-harmony-topic-dequeue-err, fw-rst-pc-acos-harmony-topic, fw-rst-pc-acos-harmony-topic-dequeue-err, cgn-summary-error-acos-harmony-topic, cgn-summary-error-acos-harmony-topic-dequeue-err, rule-set-application-metrics-topic, rule-set-application-metrics-topic-dequeue-err, slb-ssl-stats-metrics-topic, slb-ssl-stats-metrics-topic-dequeue-err, slb-client-ssl-counters-metrics-topic, slb-client-ssl-counters-metrics-topic-dequeue-err, slb-server-ssl-counters-metrics-topic, slb-server-ssl-counters-metrics-topic-dequeue-err, pc-throttle-drop, metrics-dropped-pt-missing, ssli-pc-acos-harmony-topic, ssli-pc-acos-harmony-topic-dequeue-err, ssli-pe-acos-harmony-topic, ssli-pe-acos-harmony-topic-dequeue-err, analytics-bus-restart, waf-learn-pr-topic, waf-learn-pr-topic-dequeue-err, waf-events-topic, waf-events-topic-dequeue-err, visibility-topn-harmony-topic, visibility-topn-harmony-topic-dequeue-err, hc-logs-sent-to-master, hc-logs-received-from-blade, hc-oper-sent-to-master, hc-oper-received-from-blade, hc-counters-sent-to-master, hc-counters-received-from-blade, hc-counters-dropped-from-blade, pe-acos-harmony-topic, pe-acos-harmony-topic-enqueue-err, pe-acos-harmony-topic-dequeue-err, vpn-ipsec-sa-metrics-topic, vpn-ipsec-sa-metrics-topic-dequeue-err, vpn-ike-gateway-metrics-topic, vpn-ike-gateway-metrics-topic-dequeue-err, vpn-stats-metrics-topic, vpn-stats-metrics-topic-dequeue-err, cgn-port-usage-hstgrm-acos-harmony-topic, cgn-port-usage-hstgrm-acos-harmony-topic-dequeue-err, avro-system-env-topic, avro-system-env-dequeue-err, cert-pinning-list-topic, cert-pinning-list-topic-dequeue-err