Developer Documentation
Get IPFIX Collection Instance
API will return details of IPFIX switch collection. If instance does
not exist, it will return 404.
This API is deprecated. Please use the following API:
https://
Request
URLURL
https://nsxmanager.your.domain/policy/api/v1/infra/tier-1s/{tier-1-id}/ipfix-switch-collection-instances/{ipfix-switch-collection-instance-id}
Path Parameters
Path Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | Tier-1 ID |
| required |
|
string | IPFIX switch collection id |
Response
Response
Response BodyResponse Body
200 OK returns
IPFIXSwitchCollectionInstance
{
"_create_time": 0,
"_create_user": "string",
"_last_modified_time": 0,
"_last_modified_user": "string",
"_links": [
{
"action": "string",
"href": "string",
"rel": "string"
}
],
"_protection": "string",
"_revision": 0,
"_schema": "string",
"_self": {
"action": "string",
"href": "string",
"rel": "string"
},
"_system_owned": false,
"active_timeout": 0,
"children": [
{
"_create_time": 0,
"_create_user": "string",
"_last_modified_time": 0,
"_last_modified_user": "string",
"_links": [
{
"action": "string",
"href": "string",
"rel": "string"
}
],
"_protection": "string",
"_revision": 0,
"_schema": "string",
"_self": {
"action": "string",
"href": "string",
"rel": "string"
},
"_system_owned": false,
"description": "string",
"display_name": "string",
"id": "string",
"marked_for_delete": false,
"resource_type": "string",
"tags": [
{
"scope": "string",
"tag": "string"
}
]
}
],
"description": "string",
"display_name": "string",
"id": "string",
"idle_timeout": 0,
"ipfix_collector_profile_paths": [
"string"
],
"marked_for_delete": false,
"max_flows": 0,
"observation_domain_id": 0,
"packet_sample_probability": 0,
"parent_path": "string",
"path": "string",
"relative_path": "string",
"resource_type": "string",
"source_logical_segment_paths": [
"string"
],
"tags": [
{
"scope": "string",
"tag": "string"
}
]
}| Property Name | Type | Description |
|---|---|---|
| _create_time | integer |
Timestamp of resource creation |
| _create_user | string |
ID of the user who created this resource |
| _last_modified_time | integer |
Timestamp of last modification |
| _last_modified_user | string |
ID of the user who last modified this resource |
| _links | array of ResourceLink |
The server will populate this field when returing the resource. Ignored on PUT and POST. |
| _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. |
| _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. |
| _schema | string |
Schema for this resource |
| _self | SelfResourceLink |
Link to this resource |
| _system_owned | boolean |
Indicates system owned resource |
| active_timeout | integer |
The time in seconds after a flow is expired even if more packets matching this flow are received by the cache. |
| children | array of ChildPolicyConfigResource |
subtree for this type within policy tree containing nested elements. |
| description | string |
Description of this resource |
| display_name | string |
Defaults to ID if not set |
| id | string |
Unique identifier of this resource |
| idle_timeout | integer |
The time in seconds after a Flow is expired if no more packets matching this Flow are received by the cache. |
| ipfix_collector_profile_paths | array of string |
Policy path for IPFIX collector profiles. IPFIX data from these logical segments will be sent to all specified IPFIX collectors. |
| 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. |
| max_flows | integer |
The maximum number of flow entries in each exporter flow cache. |
| observation_domain_id | integer |
An identifier that is unique to the exporting process and used to meter the Flows. |
| packet_sample_probability | number |
The probability in percentage that a packet is sampled, in range 0-100. The probability is equal for every packet. |
| parent_path | string |
Path of its parent |
| path | string |
Absolute path of this object |
| relative_path | string |
Path relative from its parent |
| resource_type | string |
The type of this resource. |
| source_logical_segment_paths | array of string |
Policy path for source tier-1 segment. IPFIX data from these logical segments will be sent IPFIX collector. |
| tags | array of Tag |
Opaque identifiers meaningful to the API user |
Errors
| Code | Returns | Description |
|---|---|---|
| 412 | PreconditionFailed | Not available |
| 500 | InternalServerError | The server encountered an unexpected condition which prevented it from fulfilling the request. |
| 503 | ServiceUnavailable | The server is currently unavailable (because it is overloaded or down for maintenance). |
| 400 | BadRequest | The request cannot be fulfilled due to bad syntax. |
| 403 | Forbidden | The server understood the request, but is refusing to fulfill it. |
| 404 | Nothing | Not Found |
