Auto-Generated Documentation

This set of documentation is automatically generated from source, and will help ensure any change to functionality will always be documented and available on release.

Observer

Observer is defined as a special network, security, or application device used to detect, observe, or create network, sercurity, or application event metrics

Field	Type	Description	Required	Default
egress	Egress	Holds information like interface number, name, vlan, and zone to classify ingress traffic	Optional	None
hostname	Keyword	Hostname of the observer	Optional	None
ingress	Ingress	Holds information like interface number, name, vlan, and zone to classify ingress traffic	Optional	None
interface	Interface	Interface being observed	Optional	None
ip	List [IP]	None	Yes	[]
mac	List [Keyword]	None	Yes	[]
name	Keyword	Custom name of the observer	Optional	None
product	Keyword	Product name of the observer	Optional	None
serial_number	Keyword	Observer serial number	Optional	None
type	Keyword	Type of the observer the data is coming from	Optional	None
vendor	Keyword	Vendor name of the observer	Optional	None
version	Keyword	Observer version	Optional	None