Add Collector To Collector Group

Add Collector To Collector Group

Add a Collector to the specified Collector Group

Request
URI
PUT
https://{api_host}/suite-api/api/collectorgroups/{id}/collector/{collectorId}
COPY
Path Parameters
string
id
Required

Identifier of the Collector Group

integer
collectorId
Required

Identifier (an integer) of the Collector

Query Parameters
boolean
checkCollectorMembers
Optional
Constraints: default: false

Check if collector group members are valid, before proceeding with collector group update

Authentication
This operation uses the following authentication methods.
Responses
200

The added Collector Group

Returns collector-group of type(s) application/json 
"{\n  \"id\" : \"42912d30-598c-4eee-b841-27edab7c8a9b\",\n  \"name\" : \"collector_group_1\",\n  \"description\" : \"collector_group_1 description\",\n  \"collectorId\" : [ 3, 4 ],\n  \"systemDefined\" : false,\n  \"haEnabled\" : true,\n  \"lbEnabled\" : false,\n  \"virtualIP\" : \"1.2.3.4\"\n}"
string As uuid As uuid
id
Required

Identifier of the Collector Group.
This is system generated during the creation time.

string
name
Required

Name of the Collector Group. This uniquely identifier a Collector Group in the system but is user specified and mutable.

string
description
Optional

Description of the Collector Group

array of integer
collectorId
Optional

Set of Collector IDs that belong to a Collector Group

boolean
systemDefined
Optional

Is the Collector group system defined? This is a Read Only attribute and is set by the system.

array of object
links
Optional

Represents a HTTP 'link' element.
It is implicit that all the link tags support http 'GET' method.

boolean
haEnabled
Optional

is the collector group ha enabled or not

boolean
lbEnabled
Optional

is the collector group LB enabled or not

string
virtualIP
Optional

virtual IP value of collector group


500

In case of any error adding the Collector to the Collector Group

Operation doesn't return any data structure

Code Samples
COPY
                    curl -X PUT -H 'Authorization: <value>' https://{api_host}/suite-api/api/collectorgroups/{id}/collector/{collectorId}
On This Page
Collector Groups Operations
GET
Get Collector Groups
PUT
Update Collector Group
POST
Create Collector Group
PUT
Add Collector To Collector Group
DELETE
Remove Collector From Collector Group
GET
Get Collector Group
DELETE
Delete Collector Group