Install Agent

Install Agent


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": [
        {
            "resourceId": "string",
            "username": "string",
            "password": "string"
        }
    ]
}
"{\n  \"resourceCredentials\" : [ {\n    \"resourceId\" : \"1a333fd1-f831-4fc6-a271-bf1098a77ad0\",\n    \"username\" : \"vm_username1\",\n    \"password\" : \"vm_password1\",\n    \"addRuntimeUser\" : true\n  }, {\n    \"resourceId\" : \"95222343-c028-412d-98ab-554743f0306f\",\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