IXpect Configuration Schema

Type: object
No Additional Properties

root probes
Type: object

The probe configurations.

 No Additional Properties

root probes print
Type: object
No Additional Properties

root probes print enable
Type: boolean Default: false

Enables this probe.

root probes arp_neighbor
Type: object

The arp_neighbor probe checks the ARP resolution from IP to MAC addresses.

 No Additional Properties

root probes arp_neighbor enable
Type: boolean Default: false

Enables this probe.

root probes arp_neighbor static_resolutions
Type: array

Static map of ARP resolutions.

 No Additional Items

Each item of this array must be:

root probes arp_neighbor static_resolutions ArpNeighborResolutionConfig
Type: object
No Additional Properties

root probes arp_neighbor static_resolutions static_resolutions items mac
Type: string
Must match regular expression: ^([0-9A-Fa-f]{2}[:]){5}([0-9A-Fa-f]{2})$

root probes arp_neighbor dynamic_enable
Type: boolean Default: false

Enable dynamic learning from observed ARP resolutions.

root probes bum_rate
Type: object

The bum_rate probe monitors the packet rates of BUM traffic.

 No Additional Properties

root probes bum_rate enable
Type: boolean Default: false

Enables this probe.

root probes bum_rate window
Type: object

The aggregation window in which the BUM thresholds are periodically checked.

root probes bum_rate window secs
Type: integerFormat: uint64

Value must be greater or equal to 0

root probes bum_rate window nanos
Type: integerFormat: uint32

Value must be greater or equal to 0

root probes bum_rate thresholds
Type: object

The thresholds for different BUM traffic patterns.

 No Additional Properties

root probes bum_rate thresholds broadcast
Type: integer or nullFormat: uint64

root probes bum_rate thresholds unicast
Type: integer or nullFormat: uint64

root probes bum_rate thresholds multicast
Type: integer or nullFormat: uint64

root probes ether_type
Type: object

The ether_type probe inspects the EtherType of packets.

 No Additional Properties

root probes ether_type enable
Type: boolean Default: false

Enables this probe.

root probes ether_type allowed_ether_types
Type: array of integer Default: []

The list of allowed ether types.

All items must be unique

No Additional Items

Each item of this array must be:

root probes ether_type allowed_ether_types allowed_ether_types items
Type: integerFormat: uint16

Value must be greater or equal to 0 and lesser or equal to 65535

root probes stp
Type: object
No Additional Properties

root probes stp enable
Type: boolean Default: false

Enables this probe.

root probes arp_bogon
Type: object

The arp_bogon probe checks IP addresses in ARP resolutions against a prefix whitelist.

 No Additional Properties

root probes arp_bogon enable
Type: boolean Default: false

Enables this probe.

root probes arp_bogon prefixes
Type: array of string Default: []

A whitelist of connected prefixes.

 No Additional Items

Each item of this array must be:

root probes arp_bogon prefixes prefixes items
Type: string

root probes ipv6_bogon
Type: object

The ipv6_bogon probe checks IP addresses in IPv6 neighbor discoveries against a prefix whitelist.

 No Additional Properties

root probes ipv6_bogon enable
Type: boolean Default: false

Enables this probe.

root probes ipv6_bogon prefixes
Type: array of string Default: []

A whitelist of connected prefixes.

 No Additional Items

Each item of this array must be:

root probes ipv6_bogon prefixes prefixes items
Type: string

root probes ipv6_router
Type: object
No Additional Properties

root probes ipv6_router enable
Type: boolean Default: false

Enables this probe.

root probes ipv6_neighbor
Type: object

The ipv6_neighbor probe checks the IPv6 neighbor discovery from IP addresses to MAC addresses.

 No Additional Properties

root probes ipv6_neighbor enable
Type: boolean Default: false

Enables this probe.

root probes ipv6_neighbor static_resolutions
Type: array

Static map of IPv6 neighbor discoveries.

 No Additional Items

Each item of this array must be:

root probes ipv6_neighbor static_resolutions Ipv6NeighborResolutionConfig
Type: object
No Additional Properties

root probes ipv6_neighbor static_resolutions static_resolutions items mac
Type: string
Must match regular expression: ^([0-9A-Fa-f]{2}[:]){5}([0-9A-Fa-f]{2})$

root probes ipv6_neighbor dynamic_enable
Type: boolean Default: false

Enable dynamic learning from observed IPv6 neighbor discoveries.

root event
Type: object

The configuration of event notifications.

 No Additional Properties

root event collection_window
Type: string Default: "5m"

The time window, in which IXpect will collect and aggregate events.
Example: 1hour 12min 5s

The duration string is a concatenation of time spans. Where each time
span is an integer number and a suffix. Supported suffixes:

  • nsec, ns -- nanoseconds
  • usec, us, µs -- microseconds
  • msec, ms -- milliseconds
  • seconds, second, sec, s
  • minutes, minute, min, m
  • hours, hour, hr, hrs, h
  • days, day, d
  • weeks, week, wk, wks, w
  • months, month, M -- defined as 30.44 days
  • years, year, yr, yrs, y -- defined as 365.25 days

root event notifiers
Type: object

The notifiers configurations.

 No Additional Properties

root event notifiers log
Type: object

The log notifier will print the list of received events to stdout.

 No Additional Properties

root event notifiers log enable
Type: boolean Default: false

Enables this notifier.

root event notifiers log events
Type: array

A whitelist of events processed by this notifier. An empty list accepts any events.

All items must be unique

No Additional Items

Each item of this array must be:

root event notifiers log events EventName
Type: object

root event notifiers log events events items oneOf item 0
Type: const

the target IP address is not covered by prefixes

Specific value: "ARP_BOGON_TARGET"
root event notifiers log events events items oneOf item 1
Type: const

the source IP address is not covered by prefixes

Specific value: "ARP_BOGON_SOURCE"
root event notifiers log events events items oneOf item 2
Type: const

an observed resolution conflicts with a static configured one

Specific value: "ARP_NEIGHBOR_SPOOFED_STATIC"
root event notifiers log events events items oneOf item 3
Type: const

an observed resolution conflicts with a dynamic learned one

Specific value: "ARP_NEIGHBOR_SPOOFED_DYNAMIC"
root event notifiers log events events items oneOf item 4
Type: const

dynamic_enable is true and a resolution is learned

Specific value: "ARP_NEIGHBOR_NEW_DYNAMIC"
root event notifiers log events events items oneOf item 5
Type: const

dynamic_enable is false and a resolution is unknown

Specific value: "ARP_NEIGHBOR_UNKNOWN"
root event notifiers log events events items oneOf item 6
Type: const

a packet with a non-whitelisted EtherType has been observed

Specific value: "ETHER_TYPE_VIOLATION"
root event notifiers log events events items oneOf item 7
Type: const

the number of broadcast packets have exceeded the threshold

Specific value: "BUM_RATE_BROADCAST_EXCEEDED"
root event notifiers log events events items oneOf item 8
Type: const

the number of multicast packets have exceeded the threshold

Specific value: "BUM_RATE_UNICAST_EXCEEDED"
root event notifiers log events events items oneOf item 9
Type: const

the number of (unknown) unicast packets have exceeded the threshold

Specific value: "BUM_RATE_MULTICAST_EXCEEDED"
root event notifiers log events events items oneOf item 10
Type: const

a STP related packet has been observed

Specific value: "STP_PACKET_FOUND"
root event notifiers log events events items oneOf item 11
Type: const

the target IPv6 address is not covered by prefixes

Specific value: "IPV6_BOGON_TARGET"
root event notifiers log events events items oneOf item 12
Type: const

the source IPv6 address is not covered by prefixes

Specific value: "IPV6_BOGON_SOURCE"
root event notifiers log events events items oneOf item 13
Type: const

router advertisement has been detected

Specific value: "IPV6_ROUTER_ADVERTISEMENT"
root event notifiers log events events items oneOf item 14
Type: const

router solicitation has been detected

Specific value: "IPV6_ROUTER_SOLICITATION"
root event notifiers log events events items oneOf item 15
Type: const

an observed resolution conflicts with a static configured one

Specific value: "IPV6_NEIGHBOR_SPOOFED_STATIC"
root event notifiers log events events items oneOf item 16
Type: const

an observed resolution conflicts with a dynamic learned one

Specific value: "IPV6_NEIGHBOR_SPOOFED_DYNAMIC"
root event notifiers log events events items oneOf item 17
Type: const

dynamic_enable is true and a resolution is learned

Specific value: "IPV6_NEIGHBOR_NEW_DYNAMIC"
root event notifiers log events events items oneOf item 18
Type: const

dynamic_enable is false and a resolution is unknown

Specific value: "IPV6_NEIGHBOR_UNKNOWN"
root event notifiers log events events items oneOf item 19
Type: const

the packet does not match the expected format

Specific value: "IXPECT_BAD_PACKET"
root event notifiers log events events items oneOf item 20
Type: const

a test event, triggered when a signal USR1 is received

Specific value: "IXPECT_TEST"

root event notifiers email
Type: object

The email notifier allows IXpect to send emails via SMTP.

 No Additional Properties

root event notifiers email enable
Type: boolean Default: false

Enables this notifier.

root event notifiers email smtp
Type: object

The SMTP configuration of the mail server that should be used for submitting emails.

 No Additional Properties

root event notifiers email smtp host
Type: string

The mail server host.

root event notifiers email smtp port
Type: integerFormat: uint16 Default: 25

The SMTP port of the mail server.

Value must be greater or equal to 0 and lesser or equal to 65535

root event notifiers email smtp encryption
Type: enum (of string)

The transport encryption to be used.

Must be one of:

  • "NONE"
  • "START_TLS"
  • "TLS"

root event notifiers email smtp auth
Type: object

The authentication mode to be used.

root event notifiers email smtp auth oneOf item 0
Type: object
No Additional Properties

root event notifiers email smtp auth oneOf item 0 mechanism
Type: const
Specific value: "NONE"
root event notifiers email smtp auth oneOf item 1
Type: object
No Additional Properties

root event notifiers email smtp auth oneOf item 1 pass
Type: object

root event notifiers email smtp auth oneOf item 1 pass anyOf item 0
Type: string

An inlined password
root event notifiers email smtp auth oneOf item 1 pass anyOf item 1
Type: object

The path to a file containing the password.

root event notifiers email smtp auth oneOf item 1 mechanism
Type: const
Specific value: "PLAIN"
root event notifiers email smtp auth oneOf item 2
Type: object
No Additional Properties

root event notifiers email smtp auth oneOf item 2 pass
Type: object

root event notifiers email smtp auth oneOf item 2 pass anyOf item 0
Type: string

An inlined password
root event notifiers email smtp auth oneOf item 2 pass anyOf item 1
Type: object

The path to a file containing the password.

root event notifiers email smtp auth oneOf item 2 mechanism
Type: const
Specific value: "LOGIN"

root event notifiers email from
Type: string

The email sender address which should be used.

root event notifiers email template
Type: string Default: "email.html.j2"

The file name of the MiniJinja template in the templates folder that should be used to format the message.

root event notifiers email channels
Type: array

The list of channels.

 No Additional Items

Each item of this array must be:

root event notifiers email channels ChannelEMailEventNotifierConfig
Type: object
No Additional Properties

root event notifiers email channels channels items events
Type: array

A whitelist of events processed by this notifier. An empty list accepts any events.

All items must be unique

No Additional Items

Each item of this array must be:

root event notifiers email channels channels items events EventName
Type: object

root event notifiers email channels channels items events events items oneOf item 0
Type: const

the target IP address is not covered by prefixes

Specific value: "ARP_BOGON_TARGET"
root event notifiers email channels channels items events events items oneOf item 1
Type: const

the source IP address is not covered by prefixes

Specific value: "ARP_BOGON_SOURCE"
root event notifiers email channels channels items events events items oneOf item 2
Type: const

an observed resolution conflicts with a static configured one

Specific value: "ARP_NEIGHBOR_SPOOFED_STATIC"
root event notifiers email channels channels items events events items oneOf item 3
Type: const

an observed resolution conflicts with a dynamic learned one

Specific value: "ARP_NEIGHBOR_SPOOFED_DYNAMIC"
root event notifiers email channels channels items events events items oneOf item 4
Type: const

dynamic_enable is true and a resolution is learned

Specific value: "ARP_NEIGHBOR_NEW_DYNAMIC"
root event notifiers email channels channels items events events items oneOf item 5
Type: const

dynamic_enable is false and a resolution is unknown

Specific value: "ARP_NEIGHBOR_UNKNOWN"
root event notifiers email channels channels items events events items oneOf item 6
Type: const

a packet with a non-whitelisted EtherType has been observed

Specific value: "ETHER_TYPE_VIOLATION"
root event notifiers email channels channels items events events items oneOf item 7
Type: const

the number of broadcast packets have exceeded the threshold

Specific value: "BUM_RATE_BROADCAST_EXCEEDED"
root event notifiers email channels channels items events events items oneOf item 8
Type: const

the number of multicast packets have exceeded the threshold

Specific value: "BUM_RATE_UNICAST_EXCEEDED"
root event notifiers email channels channels items events events items oneOf item 9
Type: const

the number of (unknown) unicast packets have exceeded the threshold

Specific value: "BUM_RATE_MULTICAST_EXCEEDED"
root event notifiers email channels channels items events events items oneOf item 10
Type: const

a STP related packet has been observed

Specific value: "STP_PACKET_FOUND"
root event notifiers email channels channels items events events items oneOf item 11
Type: const

the target IPv6 address is not covered by prefixes

Specific value: "IPV6_BOGON_TARGET"
root event notifiers email channels channels items events events items oneOf item 12
Type: const

the source IPv6 address is not covered by prefixes

Specific value: "IPV6_BOGON_SOURCE"
root event notifiers email channels channels items events events items oneOf item 13
Type: const

router advertisement has been detected

Specific value: "IPV6_ROUTER_ADVERTISEMENT"
root event notifiers email channels channels items events events items oneOf item 14
Type: const

router solicitation has been detected

Specific value: "IPV6_ROUTER_SOLICITATION"
root event notifiers email channels channels items events events items oneOf item 15
Type: const

an observed resolution conflicts with a static configured one

Specific value: "IPV6_NEIGHBOR_SPOOFED_STATIC"
root event notifiers email channels channels items events events items oneOf item 16
Type: const

an observed resolution conflicts with a dynamic learned one

Specific value: "IPV6_NEIGHBOR_SPOOFED_DYNAMIC"
root event notifiers email channels channels items events events items oneOf item 17
Type: const

dynamic_enable is true and a resolution is learned

Specific value: "IPV6_NEIGHBOR_NEW_DYNAMIC"
root event notifiers email channels channels items events events items oneOf item 18
Type: const

dynamic_enable is false and a resolution is unknown

Specific value: "IPV6_NEIGHBOR_UNKNOWN"
root event notifiers email channels channels items events events items oneOf item 19
Type: const

the packet does not match the expected format

Specific value: "IXPECT_BAD_PACKET"
root event notifiers email channels channels items events events items oneOf item 20
Type: const

a test event, triggered when a signal USR1 is received

Specific value: "IXPECT_TEST"

root event notifiers email channels channels items to
Type: array of string

The list of recipient email addresses.

 No Additional Items

Each item of this array must be:

root event notifiers email channels channels items to to items
Type: string

root event notifiers matrix
Type: object

The matrix notifier allows IXpect to send unencrypted messages into Matrix chat rooms.

 No Additional Properties

root event notifiers matrix enable
Type: boolean Default: false

Enables this notifier.

root event notifiers matrix channels
Type: array

The list of channels.

 No Additional Items

Each item of this array must be:

root event notifiers matrix channels ChannelMatrixEventNotifierConfig
Type: object
No Additional Properties

root event notifiers matrix channels channels items server
Type: stringFormat: uri

The URL of the matrix server (i.e. https://matrix.example.net).

root event notifiers matrix channels channels items internal_room_id
Type: string

The internal room inclung your servers host (i.e. room_id:matrix.example.net).

root event notifiers matrix channels channels items access_token
Type: object

The access token for this account.

root event notifiers matrix channels channels items access_token anyOf item 0
Type: string

An inlined password
root event notifiers matrix channels channels items access_token anyOf item 1
Type: object

The path to a file containing the password.

root event notifiers matrix channels channels items template
Type: string Default: "matrix.html.j2"

The file name of the MiniJinja template in the templates folder that should be used to format the message.

root event notifiers matrix channels channels items events
Type: array

A whitelist of events processed by this notifier. An empty list accepts any events.

All items must be unique

No Additional Items

Each item of this array must be:

root event notifiers matrix channels channels items events EventName
Type: object

root event notifiers matrix channels channels items events events items oneOf item 0
Type: const

the target IP address is not covered by prefixes

Specific value: "ARP_BOGON_TARGET"
root event notifiers matrix channels channels items events events items oneOf item 1
Type: const

the source IP address is not covered by prefixes

Specific value: "ARP_BOGON_SOURCE"
root event notifiers matrix channels channels items events events items oneOf item 2
Type: const

an observed resolution conflicts with a static configured one

Specific value: "ARP_NEIGHBOR_SPOOFED_STATIC"
root event notifiers matrix channels channels items events events items oneOf item 3
Type: const

an observed resolution conflicts with a dynamic learned one

Specific value: "ARP_NEIGHBOR_SPOOFED_DYNAMIC"
root event notifiers matrix channels channels items events events items oneOf item 4
Type: const

dynamic_enable is true and a resolution is learned

Specific value: "ARP_NEIGHBOR_NEW_DYNAMIC"
root event notifiers matrix channels channels items events events items oneOf item 5
Type: const

dynamic_enable is false and a resolution is unknown

Specific value: "ARP_NEIGHBOR_UNKNOWN"
root event notifiers matrix channels channels items events events items oneOf item 6
Type: const

a packet with a non-whitelisted EtherType has been observed

Specific value: "ETHER_TYPE_VIOLATION"
root event notifiers matrix channels channels items events events items oneOf item 7
Type: const

the number of broadcast packets have exceeded the threshold

Specific value: "BUM_RATE_BROADCAST_EXCEEDED"
root event notifiers matrix channels channels items events events items oneOf item 8
Type: const

the number of multicast packets have exceeded the threshold

Specific value: "BUM_RATE_UNICAST_EXCEEDED"
root event notifiers matrix channels channels items events events items oneOf item 9
Type: const

the number of (unknown) unicast packets have exceeded the threshold

Specific value: "BUM_RATE_MULTICAST_EXCEEDED"
root event notifiers matrix channels channels items events events items oneOf item 10
Type: const

a STP related packet has been observed

Specific value: "STP_PACKET_FOUND"
root event notifiers matrix channels channels items events events items oneOf item 11
Type: const

the target IPv6 address is not covered by prefixes

Specific value: "IPV6_BOGON_TARGET"
root event notifiers matrix channels channels items events events items oneOf item 12
Type: const

the source IPv6 address is not covered by prefixes

Specific value: "IPV6_BOGON_SOURCE"
root event notifiers matrix channels channels items events events items oneOf item 13
Type: const

router advertisement has been detected

Specific value: "IPV6_ROUTER_ADVERTISEMENT"
root event notifiers matrix channels channels items events events items oneOf item 14
Type: const

router solicitation has been detected

Specific value: "IPV6_ROUTER_SOLICITATION"
root event notifiers matrix channels channels items events events items oneOf item 15
Type: const

an observed resolution conflicts with a static configured one

Specific value: "IPV6_NEIGHBOR_SPOOFED_STATIC"
root event notifiers matrix channels channels items events events items oneOf item 16
Type: const

an observed resolution conflicts with a dynamic learned one

Specific value: "IPV6_NEIGHBOR_SPOOFED_DYNAMIC"
root event notifiers matrix channels channels items events events items oneOf item 17
Type: const

dynamic_enable is true and a resolution is learned

Specific value: "IPV6_NEIGHBOR_NEW_DYNAMIC"
root event notifiers matrix channels channels items events events items oneOf item 18
Type: const

dynamic_enable is false and a resolution is unknown

Specific value: "IPV6_NEIGHBOR_UNKNOWN"
root event notifiers matrix channels channels items events events items oneOf item 19
Type: const

the packet does not match the expected format

Specific value: "IXPECT_BAD_PACKET"
root event notifiers matrix channels channels items events events items oneOf item 20
Type: const

a test event, triggered when a signal USR1 is received

Specific value: "IXPECT_TEST"

root event notifiers slack
Type: object

The slack notifier allows IXpect to send messages into Slack channels.

 No Additional Properties

root event notifiers slack enable
Type: boolean Default: false

Enables this notifier.

root event notifiers slack channels
Type: array

The list of channels.

 No Additional Items

Each item of this array must be:

root event notifiers slack channels ChannelSlackEventNotifierConfig
Type: object
No Additional Properties

root event notifiers slack channels channels items webhook
Type: object

The Slack webhook containing the access token and the Slack channel ID.

root event notifiers slack channels channels items webhook anyOf item 0
Type: string

An inlined password
root event notifiers slack channels channels items webhook anyOf item 1
Type: object

The path to a file containing the password.

root event notifiers slack channels channels items template
Type: string Default: "slack.json.j2"

The file name of the MiniJinja template in the templates folder that should be used to format the message.

root event notifiers slack channels channels items events
Type: array

A whitelist of events processed by this notifier. An empty list accepts any events.

All items must be unique

No Additional Items

Each item of this array must be:

root event notifiers slack channels channels items events EventName
Type: object

root event notifiers slack channels channels items events events items oneOf item 0
Type: const

the target IP address is not covered by prefixes

Specific value: "ARP_BOGON_TARGET"
root event notifiers slack channels channels items events events items oneOf item 1
Type: const

the source IP address is not covered by prefixes

Specific value: "ARP_BOGON_SOURCE"
root event notifiers slack channels channels items events events items oneOf item 2
Type: const

an observed resolution conflicts with a static configured one

Specific value: "ARP_NEIGHBOR_SPOOFED_STATIC"
root event notifiers slack channels channels items events events items oneOf item 3
Type: const

an observed resolution conflicts with a dynamic learned one

Specific value: "ARP_NEIGHBOR_SPOOFED_DYNAMIC"
root event notifiers slack channels channels items events events items oneOf item 4
Type: const

dynamic_enable is true and a resolution is learned

Specific value: "ARP_NEIGHBOR_NEW_DYNAMIC"
root event notifiers slack channels channels items events events items oneOf item 5
Type: const

dynamic_enable is false and a resolution is unknown

Specific value: "ARP_NEIGHBOR_UNKNOWN"
root event notifiers slack channels channels items events events items oneOf item 6
Type: const

a packet with a non-whitelisted EtherType has been observed

Specific value: "ETHER_TYPE_VIOLATION"
root event notifiers slack channels channels items events events items oneOf item 7
Type: const

the number of broadcast packets have exceeded the threshold

Specific value: "BUM_RATE_BROADCAST_EXCEEDED"
root event notifiers slack channels channels items events events items oneOf item 8
Type: const

the number of multicast packets have exceeded the threshold

Specific value: "BUM_RATE_UNICAST_EXCEEDED"
root event notifiers slack channels channels items events events items oneOf item 9
Type: const

the number of (unknown) unicast packets have exceeded the threshold

Specific value: "BUM_RATE_MULTICAST_EXCEEDED"
root event notifiers slack channels channels items events events items oneOf item 10
Type: const

a STP related packet has been observed

Specific value: "STP_PACKET_FOUND"
root event notifiers slack channels channels items events events items oneOf item 11
Type: const

the target IPv6 address is not covered by prefixes

Specific value: "IPV6_BOGON_TARGET"
root event notifiers slack channels channels items events events items oneOf item 12
Type: const

the source IPv6 address is not covered by prefixes

Specific value: "IPV6_BOGON_SOURCE"
root event notifiers slack channels channels items events events items oneOf item 13
Type: const

router advertisement has been detected

Specific value: "IPV6_ROUTER_ADVERTISEMENT"
root event notifiers slack channels channels items events events items oneOf item 14
Type: const

router solicitation has been detected

Specific value: "IPV6_ROUTER_SOLICITATION"
root event notifiers slack channels channels items events events items oneOf item 15
Type: const

an observed resolution conflicts with a static configured one

Specific value: "IPV6_NEIGHBOR_SPOOFED_STATIC"
root event notifiers slack channels channels items events events items oneOf item 16
Type: const

an observed resolution conflicts with a dynamic learned one

Specific value: "IPV6_NEIGHBOR_SPOOFED_DYNAMIC"
root event notifiers slack channels channels items events events items oneOf item 17
Type: const

dynamic_enable is true and a resolution is learned

Specific value: "IPV6_NEIGHBOR_NEW_DYNAMIC"
root event notifiers slack channels channels items events events items oneOf item 18
Type: const

dynamic_enable is false and a resolution is unknown

Specific value: "IPV6_NEIGHBOR_UNKNOWN"
root event notifiers slack channels channels items events events items oneOf item 19
Type: const

the packet does not match the expected format

Specific value: "IXPECT_BAD_PACKET"
root event notifiers slack channels channels items events events items oneOf item 20
Type: const

a test event, triggered when a signal USR1 is received

Specific value: "IXPECT_TEST"

root event notifiers http
Type: object

The HTTP notifier can be used to send a customizable payload to a HTTP-based API.

 No Additional Properties

root event notifiers http enable
Type: boolean Default: false

Enables this notifier.

root event notifiers http channels
Type: array

The list of channels.

 No Additional Items

Each item of this array must be:

root event notifiers http channels ChannelHttpEventNotifierConfig
Type: object
No Additional Properties

root event notifiers http channels channels items url
Type: stringFormat: uri

The URL of the remote HTTP endpoint (i.e. https://api.example.net/api/notify).

root event notifiers http channels channels items method
Type: string Default: "POST"

The HTTP method.

root event notifiers http channels channels items content_type
Type: string

The content type of the HTTP body (i.e. application/json).

root event notifiers http channels channels items template
Type: string

The file name of the MiniJinja template in the templates folder that should be used to format the message.

root event notifiers http channels channels items events
Type: array

A whitelist of events processed by this notifier. An empty list accepts any events.

All items must be unique

No Additional Items

Each item of this array must be:

root event notifiers http channels channels items events EventName
Type: object

root event notifiers http channels channels items events events items oneOf item 0
Type: const

the target IP address is not covered by prefixes

Specific value: "ARP_BOGON_TARGET"
root event notifiers http channels channels items events events items oneOf item 1
Type: const

the source IP address is not covered by prefixes

Specific value: "ARP_BOGON_SOURCE"
root event notifiers http channels channels items events events items oneOf item 2
Type: const

an observed resolution conflicts with a static configured one

Specific value: "ARP_NEIGHBOR_SPOOFED_STATIC"
root event notifiers http channels channels items events events items oneOf item 3
Type: const

an observed resolution conflicts with a dynamic learned one

Specific value: "ARP_NEIGHBOR_SPOOFED_DYNAMIC"
root event notifiers http channels channels items events events items oneOf item 4
Type: const

dynamic_enable is true and a resolution is learned

Specific value: "ARP_NEIGHBOR_NEW_DYNAMIC"
root event notifiers http channels channels items events events items oneOf item 5
Type: const

dynamic_enable is false and a resolution is unknown

Specific value: "ARP_NEIGHBOR_UNKNOWN"
root event notifiers http channels channels items events events items oneOf item 6
Type: const

a packet with a non-whitelisted EtherType has been observed

Specific value: "ETHER_TYPE_VIOLATION"
root event notifiers http channels channels items events events items oneOf item 7
Type: const

the number of broadcast packets have exceeded the threshold

Specific value: "BUM_RATE_BROADCAST_EXCEEDED"
root event notifiers http channels channels items events events items oneOf item 8
Type: const

the number of multicast packets have exceeded the threshold

Specific value: "BUM_RATE_UNICAST_EXCEEDED"
root event notifiers http channels channels items events events items oneOf item 9
Type: const

the number of (unknown) unicast packets have exceeded the threshold

Specific value: "BUM_RATE_MULTICAST_EXCEEDED"
root event notifiers http channels channels items events events items oneOf item 10
Type: const

a STP related packet has been observed

Specific value: "STP_PACKET_FOUND"
root event notifiers http channels channels items events events items oneOf item 11
Type: const

the target IPv6 address is not covered by prefixes

Specific value: "IPV6_BOGON_TARGET"
root event notifiers http channels channels items events events items oneOf item 12
Type: const

the source IPv6 address is not covered by prefixes

Specific value: "IPV6_BOGON_SOURCE"
root event notifiers http channels channels items events events items oneOf item 13
Type: const

router advertisement has been detected

Specific value: "IPV6_ROUTER_ADVERTISEMENT"
root event notifiers http channels channels items events events items oneOf item 14
Type: const

router solicitation has been detected

Specific value: "IPV6_ROUTER_SOLICITATION"
root event notifiers http channels channels items events events items oneOf item 15
Type: const

an observed resolution conflicts with a static configured one

Specific value: "IPV6_NEIGHBOR_SPOOFED_STATIC"
root event notifiers http channels channels items events events items oneOf item 16
Type: const

an observed resolution conflicts with a dynamic learned one

Specific value: "IPV6_NEIGHBOR_SPOOFED_DYNAMIC"
root event notifiers http channels channels items events events items oneOf item 17
Type: const

dynamic_enable is true and a resolution is learned

Specific value: "IPV6_NEIGHBOR_NEW_DYNAMIC"
root event notifiers http channels channels items events events items oneOf item 18
Type: const

dynamic_enable is false and a resolution is unknown

Specific value: "IPV6_NEIGHBOR_UNKNOWN"
root event notifiers http channels channels items events events items oneOf item 19
Type: const

the packet does not match the expected format

Specific value: "IXPECT_BAD_PACKET"
root event notifiers http channels channels items events events items oneOf item 20
Type: const

a test event, triggered when a signal USR1 is received

Specific value: "IXPECT_TEST"