NSX-T Data Center REST API
IpfixDfwConfig (schema)
IPFIX Config for the DFW Module
It defines IPFIX DFW Configuration.
Name | Description | Type | Notes |
---|---|---|---|
_create_time | Timestamp of resource creation | EpochMsTimestamp | Readonly Sortable |
_create_user | ID of the user who created this resource | string | Readonly |
_last_modified_time | Timestamp of last modification | EpochMsTimestamp | Readonly Sortable |
_last_modified_user | ID of the user who last modified this resource | string | Readonly |
_links | References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST. |
array of ResourceLink | Readonly |
_protection | Indicates protection status of this resource 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. |
string | Readonly |
_revision | Generation of this resource config 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. |
int | |
_schema | Schema for this resource | string | Readonly |
_self | Link to this resource | SelfResourceLink | Readonly |
_system_owned | Indicates system owned resource | boolean | Readonly |
active_flow_export_timeout | Active flow export timeout (minutes) For long standing active flows, IPFIX records will be sent per timeout period |
integer | Minimum: 1 Maximum: 60 Default: "1" |
applied_tos | AppliedTo List List of objects where the IPFIX Config will be enabled. |
array of ResourceReference | Maximum items: 128 |
collector | UUID of IPFIX DFW Collector Config Each IPFIX DFW config can have its own collector config. |
string | Required |
description | Description of this resource | string | Maximum length: 1024 Sortable |
display_name | Identifier to use when displaying entity in logs or GUI Defaults to ID if not set |
string | Maximum length: 255 Sortable |
id | Unique identifier of this resource | string | Sortable |
observation_domain_id | Observation domain ID An identifier that is unique to the exporting process and used to meter the Flows. |
integer | Required Minimum: 0 Maximum: 4294967295 |
priority | Config Priority 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. |
integer | Required Minimum: 0 Maximum: 65536 Default: "0" |
resource_type | Must be set to the value IpfixDfwConfig | IpfixConfigType | Required |
tags | Opaque identifiers meaningful to the API user | array of Tag | Maximum items: 30 |
template_parameters | Template Parameters An object that indicates whether each corresponding template parameter is required or not. |
IpfixDfwTemplateParameters |