monitoring

Documentation

Index

• type HeatMapTransportZoneStatus
• type IpfixCollector
• type IpfixCollectorConfig
• type IpfixCollectorConfigListResult
• type IpfixConfig
• type IpfixConfigListResult
• type IpfixDfwConfig
• type IpfixDfwTemplateParameters
• type IpfixObsPointConfig
• type IpfixObsPointsListResult
• type IpfixServiceAssociationListResult
• type IpfixSwitchConfig
• type NodeLogProperties
• type NodeLogPropertiesListResult
• type PacketData
• type Traceflow
• type TraceflowListResult
• type TraceflowObservation
• type TraceflowObservationCounters
• type TraceflowObservationDelivered
• type TraceflowObservationDropped
• type TraceflowObservationDroppedLogical
• type TraceflowObservationForwarded
• type TraceflowObservationForwardedLogical
• type TraceflowObservationListResult
• type TraceflowObservationReceived
• type TraceflowObservationReceivedLogical
• type TraceflowRequest

Types

type HeatMapTransportZoneStatus

type HeatMapTransportZoneStatus struct {

	// Number of transport nodes that are degraded
	DegradedCount int32 `json:"degraded_count,omitempty"`

	// Number of transport nodes that are down
	DownCount int32 `json:"down_count,omitempty"`

	// Number of transport nodes with unknown status
	UnknownCount int32 `json:"unknown_count,omitempty"`

	// Number of transport nodes that are up
	UpCount int32 `json:"up_count,omitempty"`
}

type IpfixCollector

type IpfixCollector struct {

	// IP address for the IPFIX collector
	CollectorIpAddress string `json:"collector_ip_address"`

	// Port for the IPFIX collector
	CollectorPort int32 `json:"collector_port,omitempty"`
}

type IpfixCollectorConfig

type IpfixCollectorConfig struct {

	// The server will populate this field when returing the resource. Ignored on PUT and POST.
	Links []common.ResourceLink `json:"_links,omitempty"`

	Schema string `json:"_schema,omitempty"`

	Self *common.SelfResourceLink `json:"_self,omitempty"`

	// The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.
	Revision int64 `json:"_revision"`

	// Timestamp of resource creation
	CreateTime int64 `json:"_create_time,omitempty"`

	// ID of the user who created this resource
	CreateUser string `json:"_create_user,omitempty"`

	// Timestamp of last modification
	LastModifiedTime int64 `json:"_last_modified_time,omitempty"`

	// ID of the user who last modified this resource
	LastModifiedUser string `json:"_last_modified_user,omitempty"`

	// Indicates system owned resource
	SystemOwned bool `json:"_system_owned,omitempty"`

	// Description of this resource
	Description string `json:"description,omitempty"`

	// Defaults to ID if not set
	DisplayName string `json:"display_name,omitempty"`

	// Unique identifier of this resource
	Id string `json:"id,omitempty"`

	// The type of this resource.
	ResourceType string `json:"resource_type,omitempty"`

	// Opaque identifiers meaningful to the API user
	Tags []common.Tag `json:"tags,omitempty"`

	// IPFIX Collectors
	Collectors []IpfixCollector `json:"collectors"`
}

type IpfixCollectorConfigListResult

type IpfixCollectorConfigListResult struct {

	// The server will populate this field when returing the resource. Ignored on PUT and POST.
	Links []common.ResourceLink `json:"_links,omitempty"`

	Schema string `json:"_schema,omitempty"`

	Self *common.SelfResourceLink `json:"_self,omitempty"`

	// Opaque cursor to be used for getting next page of records (supplied by current result page)
	Cursor string `json:"cursor,omitempty"`

	// Count of results found (across all pages), set only on first page
	ResultCount int64 `json:"result_count,omitempty"`

	SortAscending bool `json:"sort_ascending,omitempty"`

	// Field by which records are sorted
	SortBy string `json:"sort_by,omitempty"`

	// IPFIX Collector Config
	Results []IpfixCollectorConfig `json:"results,omitempty"`
}

type IpfixConfig

type IpfixConfig struct {

	// The server will populate this field when returing the resource. Ignored on PUT and POST.
	Links []common.ResourceLink `json:"_links,omitempty"`

	Schema string `json:"_schema,omitempty"`

	Self *common.SelfResourceLink `json:"_self,omitempty"`

	// The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.
	Revision int64 `json:"_revision"`

	// Timestamp of resource creation
	CreateTime int64 `json:"_create_time,omitempty"`

	// ID of the user who created this resource
	CreateUser string `json:"_create_user,omitempty"`

	// Timestamp of last modification
	LastModifiedTime int64 `json:"_last_modified_time,omitempty"`

	// ID of the user who last modified this resource
	LastModifiedUser string `json:"_last_modified_user,omitempty"`

	// Indicates system owned resource
	SystemOwned bool `json:"_system_owned,omitempty"`

	// Description of this resource
	Description string `json:"description,omitempty"`

	// Defaults to ID if not set
	DisplayName string `json:"display_name,omitempty"`

	// Unique identifier of this resource
	Id string `json:"id,omitempty"`

	// Supported IPFIX Config Types.
	ResourceType string `json:"resource_type"`

	// Opaque identifiers meaningful to the API user
	Tags []common.Tag `json:"tags,omitempty"`

	// List of objects where the IPFIX Config will be enabled.
	AppliedTos []common.ResourceReference `json:"applied_tos,omitempty"`
}

type IpfixConfigListResult

type IpfixConfigListResult struct {

	// The server will populate this field when returing the resource. Ignored on PUT and POST.
	Links []common.ResourceLink `json:"_links,omitempty"`

	Schema string `json:"_schema,omitempty"`

	Self *common.SelfResourceLink `json:"_self,omitempty"`

	// Opaque cursor to be used for getting next page of records (supplied by current result page)
	Cursor string `json:"cursor,omitempty"`

	// Count of results found (across all pages), set only on first page
	ResultCount int64 `json:"result_count,omitempty"`

	SortAscending bool `json:"sort_ascending,omitempty"`

	// Field by which records are sorted
	SortBy string `json:"sort_by,omitempty"`

	// IPFIX Config
	Results []IpfixConfig `json:"results,omitempty"`
}

type IpfixDfwConfig

type IpfixDfwConfig struct {

	// The server will populate this field when returing the resource. Ignored on PUT and POST.
	Links []common.ResourceLink `json:"_links,omitempty"`

	Schema string `json:"_schema,omitempty"`

	Self *common.SelfResourceLink `json:"_self,omitempty"`

	// The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.
	Revision int64 `json:"_revision"`

	// Timestamp of resource creation
	CreateTime int64 `json:"_create_time,omitempty"`

	// ID of the user who created this resource
	CreateUser string `json:"_create_user,omitempty"`

	// Timestamp of last modification
	LastModifiedTime int64 `json:"_last_modified_time,omitempty"`

	// ID of the user who last modified this resource
	LastModifiedUser string `json:"_last_modified_user,omitempty"`

	// Indicates system owned resource
	SystemOwned bool `json:"_system_owned,omitempty"`

	// Description of this resource
	Description string `json:"description,omitempty"`

	// Defaults to ID if not set
	DisplayName string `json:"display_name,omitempty"`

	// Unique identifier of this resource
	Id string `json:"id,omitempty"`

	// Supported IPFIX Config Types.
	ResourceType string `json:"resource_type"`

	// Opaque identifiers meaningful to the API user
	Tags []common.Tag `json:"tags,omitempty"`

	// List of objects where the IPFIX Config will be enabled.
	AppliedTos []common.ResourceReference `json:"applied_tos,omitempty"`

	// For long standing active flows, IPFIX records will be sent per timeout period
	ActiveFlowExportTimeout int64 `json:"active_flow_export_timeout,omitempty"`

	// Each IPFIX DFW config can have its own collector config.
	Collector string `json:"collector"`

	// An identifier that is unique to the exporting process and used to meter the Flows.
	ObservationDomainId int64 `json:"observation_domain_id"`

	// This priority field is used to resolve conflicts in Logical Ports which are covered by more than one IPFIX profiles. The IPFIX exporter will send records to Collectors in highest priority profile (lowest number) only.
	Priority int64 `json:"priority"`

	// An object that indicates whether each corresponding template parameter is required or not.
	TemplateParameters *IpfixDfwTemplateParameters `json:"template_parameters,omitempty"`
}

type IpfixDfwTemplateParameters

type IpfixDfwTemplateParameters struct {

	// The destination IP address of a monitored network flow.
	DestinationAddress bool `json:"destination_address,omitempty"`

	// The destination transport port of a monitored network flow.
	DestinationTransportPort bool `json:"destination_transport_port,omitempty"`

	// Five valid values are allowed: 1. Flow Created. 2. Flow Deleted. 3. Flow Denied. 4. Flow Alert (not used in DropKick implementation). 5. Flow Update.
	FirewallEvent bool `json:"firewall_event,omitempty"`

	// Two valid values are allowed: 1. 0x00: igress flow to VM. 2. 0x01: egress flow from VM.
	FlowDirection bool `json:"flow_direction,omitempty"`

	// The absolute timestamp (seconds) of the last packet of this flow.
	FlowEnd bool `json:"flow_end,omitempty"`

	// The absolute timestamp (seconds) of the first packet of this flow.
	FlowStart bool `json:"flow_start,omitempty"`

	// Code of the IPv4 ICMP message.
	IcmpCode bool `json:"icmp_code,omitempty"`

	// The number of octets since the previous report (if any) in incoming packets for this flow at the observation point. The number of octets include IP header(s) and payload.
	OctetDeltaCount bool `json:"octet_delta_count,omitempty"`

	// The number of incoming packets since the previous report (if any) for this flow at the observation point.
	PacketDeltaCount bool `json:"packet_delta_count,omitempty"`

	// The value of the protocol number in the IP packet header.
	ProtocolIdentifier bool `json:"protocol_identifier,omitempty"`

	// Firewall rule Id - enterprise specific Information Element that uniquely identifies firewall rule.
	RuleId bool `json:"rule_id,omitempty"`

	// The source IP address of a monitored network flow.
	SourceAddress bool `json:"source_address,omitempty"`

	// Type of the IPv4 ICMP message.
	SourceIcmpType bool `json:"source_icmp_type,omitempty"`

	// The source transport port of a monitored network flow.
	SourceTransportPort bool `json:"source_transport_port,omitempty"`

	// VIF UUID - enterprise specific Information Element that uniquely identifies VIF.
	VifUuid bool `json:"vif_uuid,omitempty"`
}

This entity represents the flow parameters which are exported.

type IpfixObsPointConfig

type IpfixObsPointConfig struct {

	// The server will populate this field when returing the resource. Ignored on PUT and POST.
	Links []common.ResourceLink `json:"_links,omitempty"`

	Schema string `json:"_schema,omitempty"`

	Self *common.SelfResourceLink `json:"_self,omitempty"`

	// The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.
	Revision int64 `json:"_revision"`

	// Timestamp of resource creation
	CreateTime int64 `json:"_create_time,omitempty"`

	// ID of the user who created this resource
	CreateUser string `json:"_create_user,omitempty"`

	// Timestamp of last modification
	LastModifiedTime int64 `json:"_last_modified_time,omitempty"`

	// ID of the user who last modified this resource
	LastModifiedUser string `json:"_last_modified_user,omitempty"`

	// Indicates system owned resource
	SystemOwned bool `json:"_system_owned,omitempty"`

	// Description of this resource
	Description string `json:"description,omitempty"`

	// Defaults to ID if not set
	DisplayName string `json:"display_name,omitempty"`

	// Unique identifier of this resource
	Id string `json:"id,omitempty"`

	// The type of this resource.
	ResourceType string `json:"resource_type,omitempty"`

	// Opaque identifiers meaningful to the API user
	Tags []common.Tag `json:"tags,omitempty"`

	// The time in seconds after a Flow is expired even if more packets matching this Flow are received by the cache.
	ActiveTimeout int32 `json:"active_timeout,omitempty"`

	// List of IPFIX collectors
	Collectors []IpfixCollector `json:"collectors,omitempty"`

	// Enabled status of IPFIX export
	Enabled bool `json:"enabled"`

	// The time in seconds after a Flow is expired if no more packets matching this Flow are received by the cache.
	IdleTimeout int32 `json:"idle_timeout,omitempty"`

	// The maximum number of flow entries in each exporter flow cache.
	MaxFlows int64 `json:"max_flows,omitempty"`

	// An identifier that is unique to the exporting process and used to meter the Flows.
	ObservationDomainId int64 `json:"observation_domain_id,omitempty"`

	// The probability in percentage that a packet is sampled, in range 0-100. The probability is equal for every packet.
	PacketSampleProbability float32 `json:"packet_sample_probability,omitempty"`
}

type IpfixObsPointsListResult

type IpfixObsPointsListResult struct {

	// The server will populate this field when returing the resource. Ignored on PUT and POST.
	Links []common.ResourceLink `json:"_links,omitempty"`

	Schema string `json:"_schema,omitempty"`

	Self *common.SelfResourceLink `json:"_self,omitempty"`

	// Opaque cursor to be used for getting next page of records (supplied by current result page)
	Cursor string `json:"cursor,omitempty"`

	// Count of results found (across all pages), set only on first page
	ResultCount int64 `json:"result_count,omitempty"`

	SortAscending bool `json:"sort_ascending,omitempty"`

	// Field by which records are sorted
	SortBy string `json:"sort_by,omitempty"`

	// IPFIX observation points
	Results []IpfixObsPointConfig `json:"results,omitempty"`
}

type IpfixServiceAssociationListResult

type IpfixServiceAssociationListResult struct {

	// The server will populate this field when returing the resource. Ignored on PUT and POST.
	Links []common.ResourceLink `json:"_links,omitempty"`

	Schema string `json:"_schema,omitempty"`

	Self *common.SelfResourceLink `json:"_self,omitempty"`

	// Opaque cursor to be used for getting next page of records (supplied by current result page)
	Cursor string `json:"cursor,omitempty"`

	// Count of results found (across all pages), set only on first page
	ResultCount int64 `json:"result_count,omitempty"`

	SortAscending bool `json:"sort_ascending,omitempty"`

	// Field by which records are sorted
	SortBy string `json:"sort_by,omitempty"`

	ServiceType string `json:"service_type"`

	// Ipfix config list result with pagination support.
	Results []IpfixConfig `json:"results,omitempty"`
}

type IpfixSwitchConfig

type IpfixSwitchConfig struct {

	// The server will populate this field when returing the resource. Ignored on PUT and POST.
	Links []common.ResourceLink `json:"_links,omitempty"`

	Schema string `json:"_schema,omitempty"`

	Self *common.SelfResourceLink `json:"_self,omitempty"`

	// The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.
	Revision int64 `json:"_revision"`

	// Timestamp of resource creation
	CreateTime int64 `json:"_create_time,omitempty"`

	// ID of the user who created this resource
	CreateUser string `json:"_create_user,omitempty"`

	// Timestamp of last modification
	LastModifiedTime int64 `json:"_last_modified_time,omitempty"`

	// ID of the user who last modified this resource
	LastModifiedUser string `json:"_last_modified_user,omitempty"`

	// Indicates system owned resource
	SystemOwned bool `json:"_system_owned,omitempty"`

	// Description of this resource
	Description string `json:"description,omitempty"`

	// Defaults to ID if not set
	DisplayName string `json:"display_name,omitempty"`

	// Unique identifier of this resource
	Id string `json:"id,omitempty"`

	// Supported IPFIX Config Types.
	ResourceType string `json:"resource_type"`

	// Opaque identifiers meaningful to the API user
	Tags []common.Tag `json:"tags,omitempty"`

	// List of objects where the IPFIX Config will be enabled.
	AppliedTos []common.ResourceReference `json:"applied_tos,omitempty"`

	// The time in seconds after a Flow is expired even if more packets matching this Flow are received by the cache.
	ActiveTimeout int32 `json:"active_timeout,omitempty"`

	// The time in seconds after a Flow is expired if no more packets matching this Flow are received by the cache.
	IdleTimeout int32 `json:"idle_timeout,omitempty"`

	// The maximum number of flow entries in each exporter flow cache.
	MaxFlows int64 `json:"max_flows,omitempty"`

	// The probability in percentage that a packet is sampled, in range 0-100. The probability is equal for every packet.
	PacketSampleProbability float32 `json:"packet_sample_probability,omitempty"`
}

type NodeLogProperties

type NodeLogProperties struct {

	// The server will populate this field when returing the resource. Ignored on PUT and POST.
	Links []common.ResourceLink `json:"_links,omitempty"`

	Schema string `json:"_schema,omitempty"`

	Self *common.SelfResourceLink `json:"_self,omitempty"`

	// Last modified time expressed in milliseconds since epoch
	LastModifiedTime int64 `json:"last_modified_time,omitempty"`

	// Name of log file
	LogName string `json:"log_name,omitempty"`

	// Size of log file in bytes
	LogSize int64 `json:"log_size,omitempty"`
}

type NodeLogPropertiesListResult

type NodeLogPropertiesListResult struct {

	// The server will populate this field when returing the resource. Ignored on PUT and POST.
	Links []common.ResourceLink `json:"_links,omitempty"`

	Schema string `json:"_schema,omitempty"`

	Self *common.SelfResourceLink `json:"_self,omitempty"`

	// Opaque cursor to be used for getting next page of records (supplied by current result page)
	Cursor string `json:"cursor,omitempty"`

	// Count of results found (across all pages), set only on first page
	ResultCount int64 `json:"result_count,omitempty"`

	SortAscending bool `json:"sort_ascending,omitempty"`

	// Field by which records are sorted
	SortBy string `json:"sort_by,omitempty"`

	// Node log property results
	Results []NodeLogProperties `json:"results"`
}

type PacketData

type PacketData struct {

	// If the requested frame_size is too small (given the payload and traceflow metadata requirement of 16 bytes), the traceflow request will fail with an appropriate message.  The frame will be zero padded to the requested size.
	FrameSize int64 `json:"frame_size,omitempty"`

	// Packet configuration
	ResourceType string `json:"resource_type"`

	// A flag, when set true, indicates that the traceflow packet is of L3 routing.
	Routed bool `json:"routed,omitempty"`

	// transport type of the traceflow packet
	TransportType string `json:"transport_type,omitempty"`
}

type Traceflow

type Traceflow struct {

	// The server will populate this field when returing the resource. Ignored on PUT and POST.
	Links []common.ResourceLink `json:"_links,omitempty"`

	Schema string `json:"_schema,omitempty"`

	Self *common.SelfResourceLink `json:"_self,omitempty"`

	// Traceflow result analysis notes
	Analysis []string `json:"analysis,omitempty"`

	// observation counters
	Counters *TraceflowObservationCounters `json:"counters,omitempty"`

	// The id of the traceflow round
	Id string `json:"id,omitempty"`

	// counters of observations from logical components
	LogicalCounters *TraceflowObservationCounters `json:"logical_counters,omitempty"`

	// id of the source logical port used for injecting the traceflow packet
	LportId string `json:"lport_id,omitempty"`

	// Represents the traceflow operation state
	OperationState string `json:"operation_state,omitempty"`

	// A flag, when set true, indicates some observations were deleted from the result set.
	ResultOverflowed bool `json:"result_overflowed,omitempty"`

	// Maximum time (in ms) the management plane will be waiting for this traceflow round.
	Timeout int64 `json:"timeout,omitempty"`
}

type TraceflowListResult

type TraceflowListResult struct {

	// The server will populate this field when returing the resource. Ignored on PUT and POST.
	Links []common.ResourceLink `json:"_links,omitempty"`

	Schema string `json:"_schema,omitempty"`

	Self *common.SelfResourceLink `json:"_self,omitempty"`

	// Opaque cursor to be used for getting next page of records (supplied by current result page)
	Cursor string `json:"cursor,omitempty"`

	// Count of results found (across all pages), set only on first page
	ResultCount int64 `json:"result_count,omitempty"`

	SortAscending bool `json:"sort_ascending,omitempty"`

	// Field by which records are sorted
	SortBy string `json:"sort_by,omitempty"`

	// Traceflow Results
	Results []Traceflow `json:"results,omitempty"`
}

type TraceflowObservation

type TraceflowObservation struct {

	// The name of the component that issued the observation.
	ComponentName string `json:"component_name,omitempty"`

	// The type of the component that issued the observation.
	ComponentType string `json:"component_type,omitempty"`

	ResourceType string `json:"resource_type"`

	// the hop count for observations on the transport node that a traceflow packet is injected in will be 0. The hop count is incremented each time a subsequent transport node receives the traceflow packet. The sequence number of 999 indicates that the hop count could not be determined for the containing observation.
	SequenceNo int64 `json:"sequence_no,omitempty"`

	// Timestamp when the observation was created by the transport node (milliseconds epoch)
	Timestamp int64 `json:"timestamp,omitempty"`

	// Timestamp when the observation was created by the transport node (microseconds epoch)
	TimestampMicro int64 `json:"timestamp_micro,omitempty"`

	// id of the transport node that observed a traceflow packet
	TransportNodeId string `json:"transport_node_id,omitempty"`

	// name of the transport node that observed a traceflow packet
	TransportNodeName string `json:"transport_node_name,omitempty"`
}

type TraceflowObservationCounters

type TraceflowObservationCounters struct {

	// Total number of delivered observations for this traceflow round.
	DeliveredCount int64 `json:"delivered_count,omitempty"`

	// Total number of dropped observations for this round.
	DroppedCount int64 `json:"dropped_count,omitempty"`

	// Total number of forwarded observations for this traceflow round.
	ForwardedCount int64 `json:"forwarded_count,omitempty"`

	// Total number of received observations for this traceflow round.
	ReceivedCount int64 `json:"received_count,omitempty"`
}

type TraceflowObservationDelivered

type TraceflowObservationDelivered struct {

	// The name of the component that issued the observation.
	ComponentName string `json:"component_name,omitempty"`

	// The type of the component that issued the observation.
	ComponentType string `json:"component_type,omitempty"`

	ResourceType string `json:"resource_type"`

	// the hop count for observations on the transport node that a traceflow packet is injected in will be 0. The hop count is incremented each time a subsequent transport node receives the traceflow packet. The sequence number of 999 indicates that the hop count could not be determined for the containing observation.
	SequenceNo int64 `json:"sequence_no,omitempty"`

	// Timestamp when the observation was created by the transport node (milliseconds epoch)
	Timestamp int64 `json:"timestamp,omitempty"`

	// Timestamp when the observation was created by the transport node (microseconds epoch)
	TimestampMicro int64 `json:"timestamp_micro,omitempty"`

	// id of the transport node that observed a traceflow packet
	TransportNodeId string `json:"transport_node_id,omitempty"`

	// name of the transport node that observed a traceflow packet
	TransportNodeName string `json:"transport_node_name,omitempty"`

	// The id of the logical port into which the traceflow packet was delivered
	LportId string `json:"lport_id,omitempty"`

	// The name of the logical port into which the traceflow packet was delivered
	LportName string `json:"lport_name,omitempty"`

	// VLAN on bridged network
	VlanId int64 `json:"vlan_id,omitempty"`
}

type TraceflowObservationDropped

type TraceflowObservationDropped struct {

	// The name of the component that issued the observation.
	ComponentName string `json:"component_name,omitempty"`

	// The type of the component that issued the observation.
	ComponentType string `json:"component_type,omitempty"`

	ResourceType string `json:"resource_type"`

	// the hop count for observations on the transport node that a traceflow packet is injected in will be 0. The hop count is incremented each time a subsequent transport node receives the traceflow packet. The sequence number of 999 indicates that the hop count could not be determined for the containing observation.
	SequenceNo int64 `json:"sequence_no,omitempty"`

	// Timestamp when the observation was created by the transport node (milliseconds epoch)
	Timestamp int64 `json:"timestamp,omitempty"`

	// Timestamp when the observation was created by the transport node (microseconds epoch)
	TimestampMicro int64 `json:"timestamp_micro,omitempty"`

	// id of the transport node that observed a traceflow packet
	TransportNodeId string `json:"transport_node_id,omitempty"`

	// name of the transport node that observed a traceflow packet
	TransportNodeName string `json:"transport_node_name,omitempty"`

	// The id of the acl rule that was applied to drop the traceflow packet
	AclRuleId int64 `json:"acl_rule_id,omitempty"`

	// The id of the logical port at which the traceflow packet was dropped
	LportId string `json:"lport_id,omitempty"`

	// The name of the logical port at which the traceflow packet was dropped
	LportName string `json:"lport_name,omitempty"`

	// The reason traceflow packet was dropped
	Reason string `json:"reason,omitempty"`
}

type TraceflowObservationDroppedLogical

type TraceflowObservationDroppedLogical struct {

	// The name of the component that issued the observation.
	ComponentName string `json:"component_name,omitempty"`

	// The type of the component that issued the observation.
	ComponentType string `json:"component_type,omitempty"`

	ResourceType string `json:"resource_type"`

	// the hop count for observations on the transport node that a traceflow packet is injected in will be 0. The hop count is incremented each time a subsequent transport node receives the traceflow packet. The sequence number of 999 indicates that the hop count could not be determined for the containing observation.
	SequenceNo int64 `json:"sequence_no,omitempty"`

	// Timestamp when the observation was created by the transport node (milliseconds epoch)
	Timestamp int64 `json:"timestamp,omitempty"`

	// Timestamp when the observation was created by the transport node (microseconds epoch)
	TimestampMicro int64 `json:"timestamp_micro,omitempty"`

	// id of the transport node that observed a traceflow packet
	TransportNodeId string `json:"transport_node_id,omitempty"`

	// name of the transport node that observed a traceflow packet
	TransportNodeName string `json:"transport_node_name,omitempty"`

	// The id of the acl rule that was applied to drop the traceflow packet
	AclRuleId int64 `json:"acl_rule_id,omitempty"`

	// The id of the logical port at which the traceflow packet was dropped
	LportId string `json:"lport_id,omitempty"`

	// The name of the logical port at which the traceflow packet was dropped
	LportName string `json:"lport_name,omitempty"`

	// The reason traceflow packet was dropped
	Reason string `json:"reason,omitempty"`

	// The id of the component that dropped the traceflow packet.
	ComponentId string `json:"component_id,omitempty"`
}

type TraceflowObservationForwarded

type TraceflowObservationForwarded struct {

	// The name of the component that issued the observation.
	ComponentName string `json:"component_name,omitempty"`

	// The type of the component that issued the observation.
	ComponentType string `json:"component_type,omitempty"`

	ResourceType string `json:"resource_type"`

	// the hop count for observations on the transport node that a traceflow packet is injected in will be 0. The hop count is incremented each time a subsequent transport node receives the traceflow packet. The sequence number of 999 indicates that the hop count could not be determined for the containing observation.
	SequenceNo int64 `json:"sequence_no,omitempty"`

	// Timestamp when the observation was created by the transport node (milliseconds epoch)
	Timestamp int64 `json:"timestamp,omitempty"`

	// Timestamp when the observation was created by the transport node (microseconds epoch)
	TimestampMicro int64 `json:"timestamp_micro,omitempty"`

	// id of the transport node that observed a traceflow packet
	TransportNodeId string `json:"transport_node_id,omitempty"`

	// name of the transport node that observed a traceflow packet
	TransportNodeName string `json:"transport_node_name,omitempty"`

	// The 64bit tunnel context carried on the wire.
	Context int64 `json:"context,omitempty"`

	// This field will not be always available. Use remote_ip_address when this field is not set.
	DstTransportNodeId string `json:"dst_transport_node_id,omitempty"`

	// The name of the transport node to which the traceflow packet is forwarded
	DstTransportNodeName string `json:"dst_transport_node_name,omitempty"`

	// IP address of the source end of the tunnel
	LocalIpAddress string `json:"local_ip_address,omitempty"`

	// IP address of the destination end of the tunnel
	RemoteIpAddress string `json:"remote_ip_address,omitempty"`

	// The name of the uplink the traceflow packet is forwarded on
	UplinkName string `json:"uplink_name,omitempty"`

	// The virtual tunnel endpoint label
	VtepLabel int64 `json:"vtep_label,omitempty"`
}

type TraceflowObservationForwardedLogical

type TraceflowObservationForwardedLogical struct {

	// The name of the component that issued the observation.
	ComponentName string `json:"component_name,omitempty"`

	// The type of the component that issued the observation.
	ComponentType string `json:"component_type,omitempty"`

	ResourceType string `json:"resource_type"`

	// the hop count for observations on the transport node that a traceflow packet is injected in will be 0. The hop count is incremented each time a subsequent transport node receives the traceflow packet. The sequence number of 999 indicates that the hop count could not be determined for the containing observation.
	SequenceNo int64 `json:"sequence_no,omitempty"`

	// Timestamp when the observation was created by the transport node (milliseconds epoch)
	Timestamp int64 `json:"timestamp,omitempty"`

	// Timestamp when the observation was created by the transport node (microseconds epoch)
	TimestampMicro int64 `json:"timestamp_micro,omitempty"`

	// id of the transport node that observed a traceflow packet
	TransportNodeId string `json:"transport_node_id,omitempty"`

	// name of the transport node that observed a traceflow packet
	TransportNodeName string `json:"transport_node_name,omitempty"`

	// The id of the acl rule that was applied to forward the traceflow packet
	AclRuleId int64 `json:"acl_rule_id,omitempty"`

	// The id of the component that forwarded the traceflow packet.
	ComponentId string `json:"component_id,omitempty"`

	// The id of the destination component to which the traceflow packet was forwarded.
	DstComponentId string `json:"dst_component_id,omitempty"`

	// The name of the destination component to which the traceflow packet was forwarded.
	DstComponentName string `json:"dst_component_name,omitempty"`

	// The type of the destination component to which the traceflow packet was forwarded.
	DstComponentType string `json:"dst_component_type,omitempty"`

	// The id of the logical port through which the traceflow packet was forwarded.
	LportId string `json:"lport_id,omitempty"`

	// The name of the logical port through which the traceflow packet was forwarded.
	LportName string `json:"lport_name,omitempty"`

	// VNI for the logical network on which the traceflow packet was forwarded.
	Vni int32 `json:"vni,omitempty"`
}

type TraceflowObservationListResult

type TraceflowObservationListResult struct {

	// The server will populate this field when returing the resource. Ignored on PUT and POST.
	Links []common.ResourceLink `json:"_links,omitempty"`

	Schema string `json:"_schema,omitempty"`

	Self *common.SelfResourceLink `json:"_self,omitempty"`

	// Opaque cursor to be used for getting next page of records (supplied by current result page)
	Cursor string `json:"cursor,omitempty"`

	// Count of results found (across all pages), set only on first page
	ResultCount int64 `json:"result_count,omitempty"`

	SortAscending bool `json:"sort_ascending,omitempty"`

	// Field by which records are sorted
	SortBy string `json:"sort_by,omitempty"`

	// TraceflowObservation list results
	Results []TraceflowObservation `json:"results,omitempty"`
}

type TraceflowObservationReceived

type TraceflowObservationReceived struct {

	// The name of the component that issued the observation.
	ComponentName string `json:"component_name,omitempty"`

	// The type of the component that issued the observation.
	ComponentType string `json:"component_type,omitempty"`

	ResourceType string `json:"resource_type"`

	// the hop count for observations on the transport node that a traceflow packet is injected in will be 0. The hop count is incremented each time a subsequent transport node receives the traceflow packet. The sequence number of 999 indicates that the hop count could not be determined for the containing observation.
	SequenceNo int64 `json:"sequence_no,omitempty"`

	// Timestamp when the observation was created by the transport node (milliseconds epoch)
	Timestamp int64 `json:"timestamp,omitempty"`

	// Timestamp when the observation was created by the transport node (microseconds epoch)
	TimestampMicro int64 `json:"timestamp_micro,omitempty"`

	// id of the transport node that observed a traceflow packet
	TransportNodeId string `json:"transport_node_id,omitempty"`

	// name of the transport node that observed a traceflow packet
	TransportNodeName string `json:"transport_node_name,omitempty"`

	// IP address of the destination end of the tunnel
	LocalIpAddress string `json:"local_ip_address,omitempty"`

	// IP address of the source end of the tunnel
	RemoteIpAddress string `json:"remote_ip_address,omitempty"`

	// The name of the uplink the traceflow packet is received on
	UplinkName string `json:"uplink_name,omitempty"`

	// The virtual tunnel endpoint label
	VtepLabel int64 `json:"vtep_label,omitempty"`
}

type TraceflowObservationReceivedLogical

type TraceflowObservationReceivedLogical struct {

	// The name of the component that issued the observation.
	ComponentName string `json:"component_name,omitempty"`

	// The type of the component that issued the observation.
	ComponentType string `json:"component_type,omitempty"`

	ResourceType string `json:"resource_type"`

	// the hop count for observations on the transport node that a traceflow packet is injected in will be 0. The hop count is incremented each time a subsequent transport node receives the traceflow packet. The sequence number of 999 indicates that the hop count could not be determined for the containing observation.
	SequenceNo int64 `json:"sequence_no,omitempty"`

	// Timestamp when the observation was created by the transport node (milliseconds epoch)
	Timestamp int64 `json:"timestamp,omitempty"`

	// Timestamp when the observation was created by the transport node (microseconds epoch)
	TimestampMicro int64 `json:"timestamp_micro,omitempty"`

	// id of the transport node that observed a traceflow packet
	TransportNodeId string `json:"transport_node_id,omitempty"`

	// name of the transport node that observed a traceflow packet
	TransportNodeName string `json:"transport_node_name,omitempty"`

	// The id of the component that received the traceflow packet.
	ComponentId string `json:"component_id,omitempty"`

	// The id of the logical port at which the traceflow packet was received
	LportId string `json:"lport_id,omitempty"`

	// The name of the logical port at which the traceflow packet was received
	LportName string `json:"lport_name,omitempty"`

	// The id of the source component from which the traceflow packet was received.
	SrcComponentId string `json:"src_component_id,omitempty"`

	// The name of source component from which the traceflow packet was received.
	SrcComponentName string `json:"src_component_name,omitempty"`

	// The type of the source component from which the traceflow packet was received.
	SrcComponentType string `json:"src_component_type,omitempty"`

	// VNI for the logical network on which the traceflow packet was received.
	Vni int32 `json:"vni,omitempty"`
}

type TraceflowRequest

type TraceflowRequest struct {

	// id of the source logical port to inject the traceflow packet into
	LportId string `json:"lport_id"`

	// Packet configuration
	Packet *PacketData `json:"packet"`

	// Maximum time (in ms) the management plane will wait for observation result list to be sent by controller plane.
	Timeout int64 `json:"timeout,omitempty"`
}