Developer Documentation


IPFIX data from source logical segment, port, group will be forwarded to IPFIX collector.


Required Property Name Type Description
optional _create_time integer

Timestamp of resource creation

optional _create_user string

ID of the user who created this resource

optional _last_modified_time integer

Timestamp of last modification

optional _last_modified_user string

ID of the user who last modified this resource

optional _links array of ResourceLink

The server will populate this field when returing the resource. Ignored on PUT and POST.

optional _protection string

Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.

optional _revision integer

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.

optional _schema string

Schema for this resource

optional _self SelfResourceLink

Link to this resource

optional _system_owned boolean

Indicates system owned resource

optional active_timeout integer

The time in seconds after a flow is expired even if more packets matching this flow are received by the cache.

optional children array of ChildPolicyConfigResource

subtree for this type within policy tree containing nested elements.

optional description string

Description of this resource

optional display_name string

Defaults to ID if not set

optional export_overlay_flow boolean

This property controls whether overlay flow info is included in the sample result.

optional id string

Unique identifier of this resource

optional idle_timeout integer

The time in seconds after a flow is expired if no more packets matching this flow are received by the cache.

optional ipfix_collector_profile_path string

Policy path for IPFIX collector profile. User can specify only one IPFIX collector.

optional marked_for_delete boolean

Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.

optional max_flows integer

The maximum number of flow entries in each exporter flow cache.

optional observation_domain_id integer

An identifier that is unique to the exporting process and used to meter the flows.

optional packet_sample_probability number

The probability in percentage that a packet is sampled, in range 0-100. The probability is equal for every packet.

optional parent_path string

Path of its parent

optional path string

Absolute path of this object

optional priority integer

This priority field is used to resolve conflicts in Segment 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.

optional relative_path string

Path relative from its parent

optional resource_type string

The type of this resource.

optional tags array of Tag

Opaque identifiers meaningful to the API user


Was this page helpful?