External agent deployment configuration

Edit online

Configure deployments for an external agent on the system.

Request

Edit online

Security

Edit online
Table 1. Roles capable of executing the External agent deployment configuration API method
Any Super User System Admin Security Admin Operator
  superUser systemAdmin    

HTTP method

Edit online

POST /manager/api/{apiResponseType}/1.0/editSystemExternalAgentDeploymentConfiguration.adm HTTP/1.1 Host: {manager.dsnet} id={long} global={enable|disable|remove} regionMap[string]={enable|disable|remove} [regionMap[string]={enable|disable|remove}] siteMap[string]={enable|disable|remove} [siteMap[string]={enable|disable|remove}] deviceMap[string]={enable|disable|remove} [deviceMap[string]={enable|disable|remove}]

Curl method

Edit online
curl -u {admin}:{password}   
     -k 'https://{manager.dsnet}/manager/api/{apiResponseType}/1.0/editSystemExternalAgentDeploymentConfiguration.adm'
     -d 'id={long}&global={enable|disable|remove}
         &regionMap[string]={enable|disable|remove}[&regionMap[string]={enable|disable|remove}]
         &siteMap[string]={enable|disable|remove}[&siteMap[string]={enable|disable|remove}]
         &deviceMap[string]={enable|disable|remove}[&deviceMap[string]={enable|disable|remove}]'

Request parameters

Edit online
Table 2. Request Parameters for External agent deployment configuration (editSystemExternalAgentDeploymentConfiguration) API method
Parameter Type Usage Default Description
id Long Required  

The ID of the external agent
global String  Optional  

Indicates the specified configuration should be deployed globally. If not already deployed globally, selecting enable or disable will deploy the agent globally as enabled or disabled.
regionMap Map Optional  

Map of region IDs to action, to either enable, disable, or remove. If the region is not deployed, selecting enable or disable will deploy the region as enabled or disabled.
siteMap Map Optional  

Map of site IDs to action, to either enable, disable, or remove. If the site is not deployed, selecting enable or disable will deploy the site as enabled or disabled.
deviceMap Map Optional  

Map of device IDs to action, to either enable, disable, or remove. If the device is not deployed, selecting enable or disable will deploy the device as enabled or disabled.