| _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_timeout |
Active timeout
The time in seconds after a flow is expired even if
more packets matching this flow are received by the cache.
|
int |
Minimum: 60
Maximum: 3600
Default: "300" |
| children |
subtree for this type within policy tree
subtree for this type within policy tree containing nested elements.
|
array of ChildPolicyConfigResource
Children are not allowed for this type |
|
| 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 |
| export_overlay_flow |
Export overlay Flow
This property controls whether overlay flow info is included in the
sample result.
|
boolean |
Default: "True" |
| id |
Unique identifier of this resource |
string |
Sortable |
| idle_timeout |
Idle timeout
The time in seconds after a flow is expired if
no more packets matching this flow are received by the cache.
|
int |
Minimum: 60
Maximum: 3600
Default: "300" |
| ipfix_collector_profile_path |
IPFIX collector Path
Policy path for IPFIX collector profile. User can specify only one IPFIX collector.
|
string |
Required |
| marked_for_delete |
Indicates whether the intent object is marked for deletion
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.
|
boolean |
Readonly
Default: "False" |
| max_flows |
Max flows
The maximum number of flow entries in
each exporter flow cache.
|
integer |
Minimum: 0
Maximum: 4294967295
Default: "16384" |
| observation_domain_id |
Observation domain ID
An identifier that is unique to the exporting process and used to
meter the flows.
|
integer |
Minimum: 0
Maximum: 4294967295
Default: "0" |
| overridden |
Indicates whether this object is the overridden intent object
Global intent objects cannot be modified by the user.
However, certain global intent objects can be overridden locally by use
of this property. In such cases, the overridden local values take
precedence over the globally defined values for the properties.
|
boolean |
Readonly
Default: "False" |
| packet_sample_probability |
Packet sample probability
The probability in percentage that a packet is sampled,
in range 0-100. The probability is equal for every packet.
|
number |
Required
Minimum: 0
Maximum: 100
Default: "0.1" |
| parent_path |
Path of its parent
Path of its parent |
string |
Readonly |
| path |
Absolute path of this object
Absolute path of this object |
string |
Readonly |
| priority |
Config Priority
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.
|
int |
Minimum: 0
Maximum: 32000
Default: "0" |
| realization_id |
A unique identifier assigned by the system for realizing intent
This is a UUID generated by the system for realizing the entity object.
In most cases this should be same as 'unique_id' of the entity. However,
in some cases this can be different because of entities have migrated thier
unique identifier to NSX Policy intent objects later in the timeline and did
not use unique_id for realization. Realization id is helpful for users to
debug data path to correlate the configuration with corresponding intent.
|
string |
Readonly |
| relative_path |
Relative path of this object
Path relative from its parent |
string |
Readonly |
| resource_type |
Must be set to the value IPFIXL2Profile |
string |
|
| tags |
Opaque identifiers meaningful to the API user |
array of Tag |
Maximum items: 30 |
| unique_id |
A unique identifier assigned by the system
This is a UUID generated by the GM/LM to uniquely identify
entites in a federated environment. For entities that are
stretched across multiple sites, the same ID will be used
on all the stretched sites.
|
string |
Readonly |