Update Ipfix Config

Update Ipfix Config

Update an existing IPFIX configuration

Request
URI
PUT
https://nsxmanager.your.domain/api/v1/ipfix/configs/{config-id}
COPY
Path Parameters
string
config-id
Required

config-id

Request Body
IpfixConfig of type(s) application/json
Optional 
{
    "_self": {
        "rel": "string"
    },
    "_system_owned": false,
    "display_name": "string",
    "description": "string",
    "tags": [
        {
            "scope": "string",
            "tag": "string"
        }
    ],
    "_revision": 0,
    "applied_tos": [
        {
            "target_display_name": "string",
            "is_valid": false,
            "target_id": "string",
            "target_type": "string"
        }
    ],
    "_schema": "string",
    "_create_time": 0,
    "_links": [
        {
            "action": "string",
            "href": "string",
            "rel": "string"
        }
    ],
    "resource_type": "string",
    "_last_modified_time": 0,
    "_last_modified_user": "string",
    "id": "string",
    "_create_user": "string"
}
SelfResourceLink
_self
Optional

_self

boolean
_system_owned
Optional

Indicates system owned resource

string
display_name
Optional

Defaults to ID if not set

string
description
Optional

description

array of Tag
tags
Optional

tags

integer As int64 As int64
_revision
Optional

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.

array of ResourceReference
applied_tos
Optional

List of objects where the IPFIX Config will be enabled.

string
_schema
Optional

_schema

integer As int64 As int64
_create_time
Optional

Timestamp of resource creation

array of ResourceLink
_links
Optional

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

string
resource_type
Required

Supported IPFIX Config Types.

integer As int64 As int64
_last_modified_time
Optional

Timestamp of last modification

string
_last_modified_user
Optional

ID of the user who last modified this resource

string
id
Optional

id

string
_create_user
Optional

ID of the user who created this resource

Authentication
This operation uses the following authentication methods.
Responses
200

Success

Returns IpfixConfig of type(s) application/json 
{
    "_self": {
        "rel": "string"
    },
    "_system_owned": false,
    "display_name": "string",
    "description": "string",
    "tags": [
        {
            "scope": "string",
            "tag": "string"
        }
    ],
    "_revision": 0,
    "applied_tos": [
        {
            "target_display_name": "string",
            "is_valid": false,
            "target_id": "string",
            "target_type": "string"
        }
    ],
    "_schema": "string",
    "_create_time": 0,
    "_links": [
        {
            "action": "string",
            "href": "string",
            "rel": "string"
        }
    ],
    "resource_type": "string",
    "_last_modified_time": 0,
    "_last_modified_user": "string",
    "id": "string",
    "_create_user": "string"
}
SelfResourceLink
_self
Optional

_self

boolean
_system_owned
Optional

Indicates system owned resource

string
display_name
Optional

Defaults to ID if not set

string
description
Optional

description

array of Tag
tags
Optional

tags

integer As int64 As int64
_revision
Optional

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.

array of ResourceReference
applied_tos
Optional

List of objects where the IPFIX Config will be enabled.

string
_schema
Optional

_schema

integer As int64 As int64
_create_time
Optional

Timestamp of resource creation

array of ResourceLink
_links
Optional

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

string
resource_type
Required

Supported IPFIX Config Types.

integer As int64 As int64
_last_modified_time
Optional

Timestamp of last modification

string
_last_modified_user
Optional

ID of the user who last modified this resource

string
id
Optional

id

string
_create_user
Optional

ID of the user who created this resource


default

Unexpected error

Returns ApiError of type(s) application/json 
{
    "module_name": "string",
    "error_message": "string",
    "error_code": 0
}
string
module_name
Optional

module_name

string
error_message
Optional

error_message

integer As int64 As int64
error_code
Optional

error_code


On This Page
Operations Operations
POST
Create Ipfix Config
DELETE
Delete Ipfix Config
GET
Get Ipfix Config
GET
List Ipfix Config
PUT
Update Ipfix Config