/system/nae_scripts/{NAE_Script.name}/nae_agents

post

https://switch-ip/rest/v10.16/system/nae_scripts/{NAE_Script.name}/nae_agents

Path Params

NAE_Script.name

string

required

Reference Resource: NAE_Script
Name of a NAE Script. This has to be a valid canonical name (CNAME) (i.e com.arubanetworks.bgp_monitor).

Body Params

disabled

boolean

Disables the Agent, so it won't react to any alarms actions, etc.

encrypted_parameters_values

object

Reference Resource: NAE_Parameter
Particular agent values for the nae script parameters that are encrypted.

nae_script

string

required

Reference Resource: NAE_Agent
NAE Script that corresponds to this agent.

name

string

required

length between 3 and 80

Reference Resource: NAE_Agent
Name of a NAE Agent. This has to be a CNAME starting with NAE Script name followed by its own name (i.e com.arubanetworks.bgp_monitor.agent1).

origin

string

enum

Defines the origin of the agent. Set to system if the agent is inbuilt in the system. Set to generated if the agent is generated using user input. Set to user if the agent is uploaded by the user.

Allowed:

parameters_values

object

Reference Resource: NAE_Parameter
Particular agent values for the nae script parameters.

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

Response

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