Update Troubleshooting Metrics Data Collection

• Metrics Data Collection

Update troubleshooting metrics data collection resource IDs by category

Updates the list of resource IDs that have troubleshooting metrics data collection enabled for the specified category. Troubleshooting data collection enables enhanced metrics gathering for security monitoring and diagnostics. This operation replaces the existing configuration with the provided resource IDs.

The request body must include the resource_ids array. The array can be empty to clear all configured resources for the category, or contain up to a maximum of 10 resource IDs. Each resource ID must be an intent path (the 'path' field on the NSX API output). For example, '/infra/sites/default/enforcement-points/default/host-transport-nodes/TN1'.

Request

URI

PUT

https://{api_host}/security-monitoring/sites/{site-id}/troubleshooting-metrics/{category}

COPY

Path Parameters

string

site-id

Required  

Site id in the query

string

category

Required  

The metrics data collection category for which to retrieve or update configured resource IDs. Only one category can be specified per request. Supported values include DISTRIBUTED_IDPS_HOST_TROUBLESHOOTING, DISTRIBUTED_IDPS_VM_TROUBLESHOOTING, and DISTRIBUTED_TLS_VM_STATS_COLLECTION. For DISTRIBUTED_IDPS_HOST_TROUBLESHOOTING and DISTRIBUTED_IDPS_VM_TROUBLESHOOTING, resource_ids must be of HostTransportNode resource type.

Enumeration: DISTRIBUTED_IDPS_HOST_TROUBLESHOOTING, DISTRIBUTED_IDPS_VM_TROUBLESHOOTING, DISTRIBUTED_TLS_VM_STATS_COLLECTION

---

Request Body

MetricsTroubleshootingDataCollectionConfig of type(s) application/json

Required  

This request body class requires all of the following: ManagedResource , InlineMetricsTroubleshootingDataCollectionConfig1

{
    "_create_user": "string",
    "_create_time": 0,
    "_last_modified_user": "string",
    "_last_modified_time": 0,
    "_revision": 0,
    "_resource_type": "string",
    "_system_owned": false,
    "id": "string",
    "display_name": "string",
    "description": "string",
    "site_ids": [
        "string"
    ],
    "resource_ids": [
        "string"
    ]
}

Authentication

This operation uses the following authentication methods.

enterprise_admin

security_engineer

security_op

Responses

200

Hide Details

Successfully updated the list of resource IDs that have troubleshooting metrics data collection enabled for the specified category.

Returns MetricsTroubleshootingDataCollectionConfig of type(s) application/json

This response body class contains all of the following: ManagedResource , InlineMetricsTroubleshootingDataCollectionConfig1

{
    "_create_user": "string",
    "_create_time": 0,
    "_last_modified_user": "string",
    "_last_modified_time": 0,
    "_revision": 0,
    "_resource_type": "string",
    "_system_owned": false,
    "id": "string",
    "display_name": "string",
    "description": "string",
    "site_ids": [
        "string"
    ],
    "resource_ids": [
        "string"
    ]
}

400

Hide Details

Bad request. The request body is invalid, missing required parameters, or contains invalid values. A maximum of 10 resource IDs are supported.

Returns Error of type(s) application/json

{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}

integer

error_code

Required  

HTTP Status or Application error code.

string

module_name

Optional

Module where the error happened.

string

error_message

Required  

Message describing the error.

401

Hide Details

Unauthorized

Returns Unauthorized of type(s) application/json

{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}

integer

error_code

Required  

HTTP Status or Application error code.

string

module_name

Optional

Module where the error happened.

string

error_message

Required  

Message describing the error.

403

Hide Details

Forbidden

Returns Forbidden of type(s) application/json

{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}

integer

error_code

Required  

HTTP Status or Application error code.

string

module_name

Optional

Module where the error happened.

string

error_message

Required  

Message describing the error.

404

Hide Details

Not found. The site or category was not found.

Returns Error of type(s) application/json

{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}

integer

error_code

Required  

HTTP Status or Application error code.

string

module_name

Optional

Module where the error happened.

string

error_message

Required  

Message describing the error.

412

Hide Details

Precondition Failed

Returns PreconditionFailed of type(s) application/json

{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}

integer

error_code

Required  

HTTP Status or Application error code.

string

module_name

Optional

Module where the error happened.

string

error_message

Required  

Message describing the error.

428

Hide Details

Precondition Required

Returns PreconditionRequired of type(s) application/json

{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}

integer

error_code

Required  

HTTP Status or Application error code.

string

module_name

Optional

Module where the error happened.

string

error_message

Required  

Message describing the error.

429

Hide Details

Too Many Requests

Returns TooManyRequests of type(s) application/json

{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}

integer

error_code

Required  

HTTP Status or Application error code.

string

module_name

Optional

Module where the error happened.

string

error_message

Required  

Message describing the error.

default

Hide Details

An unexpected error occurred while processing the request.

Returns Error of type(s) application/json

"Error Object"

integer

error_code

Required  

HTTP Status or Application error code.

string

module_name

Optional

Module where the error happened.

string

error_message

Required  

Message describing the error.

Code Samples

COPY

                    curl -X PUT -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"resource_ids":["string"]}' https://{api_host}/security-monitoring/sites/{site-id}/troubleshooting-metrics/{category}
                

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body

Errors

Metrics Data Collection Operations

GET

Get Troubleshooting Metrics Data Collection

PUT

Update Troubleshooting Metrics Data Collection