/system/troubleshoots

post

https://switch-ip/rest/v10.18/system/troubleshoots

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

choice

string

enum

troubleshoot choice input from user. - basic-health: only run basic health check during troubleshoot. - config: run configuration troubleshoot which checks configuration issues and potential misconfigurations. - health: runs both basic health check and configuration check during troubleshoot. - operations: runs operational troubleshoot which includes advanced feature troubleshoot. - detailed: runs advanced troubleshoot similar to operations.

Allowed:

component_name

string

length ≤ 60

Component name of troubleshoot performing feature.

int64

required

1 to 4294967295

Reference Resource: Troubleshoot
Key that represents a unique troubleshoot request instance.

feature_name

string

required

length ≤ 60

Reference Resource: Troubleshoot
Troubleshoot performing feature name.

persistence

string

enum

Persistence of troubleshoot request instance, i.e how the troubleshoot request instance is provisioned: volatile : troubleshoot request instances will not be reatined over system reboot.

Allowed:

troubleshoot_type

string

enum

Set to manual if the troubleshoot is triggered by the user. Set to proactive if the troubleshoot is auto-generated.

Allowed:

tshoot_cleanup_interval

int64

Cleanup interval in minutes.

user_input

string

Additional user input for troubleshooting in text form.

verbose_mode

boolean

Flag to enable verbose output during troubleshooting.

Responses

201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

415

Unsupported Media Type

500

Internal Server Error

501

Not Implemented

503

Service Unavailable

Language

Loading…

Response

Click Try It! to start a request and see the response here!