Install Agent

Install Agent
Install agent on resource


Install app monitoring agent on specified resource.
vCenters mapping should be present for this API to work.

Correct configuration for vCenters mapping -
vCenter is mapped to individual CP or CP part of non HA collector group.
vCenter is mapped to HA enabled collector group.

vCenters mapping APIs -
Create vCenters mappings API POST /api/applications/vccpmappings.
Delete vCenters mapping API DELETE /api/applications/vccpmappings.

Request
URI
POST
https://{api_host}/suite-api/api/applications/agents
COPY
Request Body

Credentials of resources required to install the agent

resource-credentials of type(s) application/json
Required

Show optional properties

{
    "resourceCredentials": [
        {
            "password": "string",
            "resourceId": "string",
            "username": "string"
        }
    ]
}
"{\n  \"resourceCredentials\" : [ {\n    \"resourceId\" : \"05f5cb2b-eecf-41fd-a07a-715108781ccc\",\n    \"username\" : \"vm_username1\",\n    \"password\" : \"vm_password1\",\n    \"addRuntimeUser\" : true\n  }, {\n    \"resourceId\" : \"851793b1-4818-4db0-89d6-c3ab7284391e\",\n    \"username\" : \"vm_username2\",\n    \"password\" : \"vm_password2\",\n    \"addRuntimeUser\" : true\n  } ],\n  \"retainTelegrafConf\" : true\n}"
array of object
resourceCredentials
Required

List of resource credentials

boolean
retainTelegrafConf
Optional

Flag that indicates to retain telegraf to preserve configuration, default value is true

Authentication
This operation uses the following authentication methods.
Responses
200

The result of task status

Returns agent-task-statuses of type(s) application/json 
"{\n  \"taskStatuses\" : [ {\n    \"taskID\" : \"task_id_1\",\n    \"resources\" : [ \"vm_id_1\", \"vm_id_2\" ]\n  }, {\n    \"taskID\" : \"task_id_2\",\n    \"resources\" : [ \"vm_id_3\", \"vm_id_4\" ]\n  } ]\n}"
array of object
taskStatuses
Required

Collection of agent task statuses


Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"resourceCredentials":["object"]}' https://{api_host}/suite-api/api/applications/agents
On This Page
Applications Operations
GET
Get Configuration Details
DELETE
Uninstall Agent
POST
Install Agent
POST
Renew Clients Certificate
POST
Get Renew Clients Certificate Status
POST
Activate Services
GET
Get Service Operation Status
PUT
Start Agent
PUT
Stop Agent
PUT
Upgrade Agent
POST
Renew Client Certificate
GET
Get Renew Client Certificate Status
DELETE
Remove Services Configurations
GET
Get Services Configurations
POST
Save Services Configurations
PUT
Update Services Configurations
GET
Get Service Configurations
GET
Get Agent Operation Status
POST
Sign Client Certificate
GET
Download Client Certificate
GET
Get Application Resources
GET
Get Service Configuration Template
PUT
Subscribe
PUT
Unsubscribe
DELETE
Delete V Center Mapping
POST
Create V Center Mapping
POST
Query V Center Mappings Info
PUT
Add Vcenter To Configuration
Deprecated
PUT
Remove Vcenter From Configuration
Deprecated