event-notification kafka server

Set remote kafka server ip address

server Specification

   
Type Configuration Resource
Element Name server
Element URI /axapi/v3/event-notification/kafka/server
Element Attributes server_attributes
Statistics Data URI /axapi/v3/event-notification/kafka/server/stats
Operational Data URI /axapi/v3/event-notification/kafka/server/oper
Schema server schema

Operations Allowed:

OperationMethodURIPayload

Create Object

POST

/axapi/v3/event-notification/kafka/server

server attributes

Get Object

GET

/axapi/v3/event-notification/kafka/server

server attributes

Modify Object

POST

/axapi/v3/event-notification/kafka/server

server attributes

Replace Object

PUT

/axapi/v3/event-notification/kafka/server

server attributes

Delete Object

DELETE

/axapi/v3/event-notification/kafka/server

server attributes

server attributes

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

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, vcpe-events-device-status, vcpe-messagestream-device-dhcp-stream, vcpe-events-tunnel-status, vcpe-events-device-report, cfg-sent-to-cm, kafka-broker-down, kafka-queue-full-err, cfg-sent-to-cm-enqueue-err, vcpe-messagestream-dhcp-stream-enqueue-err, vcpe-events-tunnel-status-enqueue-err, vcpe-events-device-status-enqueue-err, vcpe-events-device-report-enqueue-err, cfg-sent-to-cm-dequeue-err, vcpe-messagestream-dhcp-stream-dequeue-err, vcpe-events-tunnel-status-dequeue-err, vcpe-events-device-status-dequeue-err, vcpe-events-device-report-dequeue-err, kafka-unknown-topic-dequeue-err, pr-acos-appcito-topic, pr-acos-appcito-topic-enqueue-err, pr-acos-appcito-topic-dequeue-err, host-acos-appcito-topic, host-acos-appcito-topic-enqueue-err, host-acos-appcito-topic-dequeue-err, server-acos-appcito-topic, server-acos-appcito-topic-enqueue-err, server-acos-appcito-topic-dequeue-err, service-acos-appcito-topic, service-acos-appcito-topic-enqueue-err, service-acos-appcito-topic-dequeue-err, flow-acos-appcito-topic, flow-acos-appcito-topic-enqueue-err, flow-acos-appcito-topic-dequeue-err

stats data

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

operational data

  Counter Size Description
       
  kafka-broker-state enum Output contains one of the following values: - Up, Down