Entity - ManagementGroups - handles management groups

Page version: 33, last updated:

Minimum API version 3.3 



VerbRequestNotesPermissions required
POST/Consumer/ManagementGroups/InitiateSlaSync

Initiate synchronization of Management Groups with SLA.

Requires Tachyon Management Group support mode to be set to 'External'.

Payload
{
   'Repository':'Default Inventory'
}

Change 'Default Inventory' into the name of the SLA repository against which you are synchronizing. It needs to match the repository that is configured in the Coordinator, otherwise you will get back an error.

Requires 'Synchronize' permission on Management Groups

GET/Consumer/ManagementGroups

Returns all Management Groups.

By default, only non-system Management Groups are returned. In order to get system groups as well, use includeSystemGroups query string parameter and set it to true i.e. https://your.tachyon.server.address/Consumer/ManagementGroups?includeSystemGroups=true

Return payload
[
	{
	    "Id": "1",
	    "Name": "Management Group A",
	    "Description": "",
	    "Expression": "",
	    "Count": "12",
	    "UsableId": "0E9514B6-FD77-4077-9B54-A2AAA0C1953C",
    	"HashOfMembers": "5c9f347457272d5edfeb5dd5c0f6fe4e38311b6126908f2612a1e58d8fb5b754"
	},{
	    "Id": "2",
	    "Name": "Management Group B",
	    "Description": "",
	    "Expression": "",
	    "Count": "7",
	    "UsableId": "AD9514B6-FD77-4077-9B54-A2AAA0C1953C",
    	"HashOfMembers": "ddff347457272d5edfeb5dd5c0f6fe4e38311b6126908f2612a1e58d8fb5bbcc"
	}
]

Requires one of following:

  • Any permission on any of the Instruction Sets
  • 'Read' permission on Management Groups
GET/Consumer/ManagementGroups/Id/{id}

Returns a single Management Group by its Id.

Return payload
{
    "Id": "1",
    "Name": "Management Group A",
    "Description": "",
    "Expression": "",
    "Count": "12",
    "UsableId": "0E9514B6-FD77-4077-9B54-A2AAA0C1953C",
    "HashOfMembers": "5c9f347457272d5edfeb5dd5c0f6fe4e38311b6126908f2612a1e58d8fb5b3ea"
}

Requires one of following:

  • Any permission on any of the Instruction Sets
  • 'Read' permission on Management Groups
GET/Consumer/ManagementGroups/Name/{name}

Returns a single Management Group by its Name.

Name needs to be supplied as Base64Encoded string.

Return payload as above.

Requires one of following:

  • Any permission on any of the Instruction Sets
  • 'Read' permission on Management Groups
GET/Consumer/ManagementGroups/UsableId/{usableId}

Returns a single Management Group by its UsableId.

Return payload as above.

Requires one of following:

  • Any permission on any of the Instruction Sets
  • 'Read' permission on Management Groups
GET/Consumer/ManagementGroups/Search/{base64SearchString}

Returns a collection of Management Groups whose names are at least a partial match to the search string.

System Management Groups are not returned.

Search string must be Base64 encoded.

Return payload will be as in GET /Consumer/ManagementGroups.

Requires one of following:

  • Any permission on any of the Instruction Sets
  • 'Read' permission on Management Groups
POST/Consumer/ManagementGroups/Search

Returns Management Groups that match search parameters passed in the request body:

  • filter - filter expression.To learn about how to define filter check Using scope and filter expressions page.
  • sort - sort expression. To learn about how to define sort criteria check Sort Definition page.
  • start - starting index to support pagination. It begins from 1.
  • pagesize - number of results to fetch

Allowed filter columns:

  • Name
  • CreatedTime
  • ModifiedTime
  • Description
  • UsableId

Allowed sort columns:

  • Name
  • CreatedTime
  • ModifiedTime

Example

POST payload
{
	"Filter": {
   		"Operator": "and",
   		"Operands":[
        		{  
         		   "Attribute":"Name",
         		   "Operator":"like",
         		   "Value":"Group%"
       		 },
       		 {  
         		   "Attribute":"UsableId",
         		   "Operator":"like",
         		   "Value":"%2"
      		 }
   		 ]
		},
	"Start": 100,
	"PageSize": 100,
	"Sort": [{Column: "CreatedTime", Direction: "DESC"}]
}


Requires one of following:

  • Any permission on any of the Instruction Sets
  • 'Read' permission on Management Groups
POST/Consumer/ManagementGroups

Creates a new Management Group.

ManagementGroup object is required and it must have a Name, which must be unique.

UsableId is ignored as it will be generated internally.

Count and HashOfMembers are calculated internally and will be ignored if passed in the API call.

Devices collection is optional and if provided should contain device FQDNs.

Requires Tachyon Management Group support mode to be set to 'Internal'.

POST payload
{
	"ManagementGroup": {
    	"Name": "Management Group A",
	    "Description": "",
    	"Expression": ""
	},
	"Devices": ["machinename01.somedomain.com", "machinename02.somedomain.com"]
}
Requires 'Write' permission on Management Groups
PUT/Consumer/ManagementGroups

Updates an existing Management Group.

Id must be a valid Id.

You cannot change UsableId, Count or HashOfMembers

Requires Tachyon Management Group support mode to be set to 'Internal'.

PUT Payload
{
	"Id": 1,
    "Name": "Management Group A renamed",
    "Description": "",
    "Expression": ""
}
Requires 'Write' permission on Management Groups
DELETE/Consumer/ManagementGroups/Id/{id}

Deletes a Management Group by its Id.

Requires Tachyon Management Group support mode to be set to 'Internal'.

Requires 'Write' permission on Management Groups
DELETE/Consumer/ManagementGroups/Name/{name}

Deletes a Management Group by its Name.

Name needs to be supplied as Base64Encoded string.

Requires Tachyon Management Group support mode to be set to 'Internal'.

Requires 'Write' permission on Management Groups
DELETE/Consumer/ManagementGroups/ UsableId/{usableId}

Deletes a Management Group by its UsableId.

Requires Tachyon Management Group support mode to be set to 'Internal'.

Requires 'Write' permission on Management Groups
GET/Consumer/ManagementGroups/Contents/Id/{id}Returns all devices that belong to given Management Group using Management Group's Id.Requires 'Read' permission on Management Groups
GET/Consumer/ManagementGroups/Contents/Name/{Name}

Returns all devices that belong to given Management Group using Management Group's Name.

Name needs to be supplied as Base64Encoded string.

Requires 'Read' permission on Management Groups
GET/Consumer/ManagementGroups/Contents/UsableId/{usableId}Returns all devices that belong to given Management Group using Management Group's UsableId.Requires 'Read' permission on Management Groups
POST/Consumer/ManagementGroups/Contents

Adds device(s) to a Management Group.

Payload for this request is an object representing a one-to-many relationship using Ids of objects.

Owner has the Id of the Management Group, Elements is an array of Ids of Devices.

POST payload
{
	"ManagementGroupId": 12,
	"DeviceFqdns": ["machinename01.somedomain.com", "machinename02.somedomain.com", "machinename03.somedomain.com", "machinename04.somedomain.com"]
}

After devices have been added to the group Count and HashOfMembers for that group will be recalculated.

Return payload will contain the Management Group in question and all devices that belong to it

Sample Response payload
{
	"ManagementGroup": {
		"Id": "12",
	    "Name": "Management Group A",
    	"Description": "",
	    "Expression": "",
	    "Count": "12",
    	"UsableId": "0E9514B6-FD77-4077-9B54-A2AAA0C1953C",
	    "HashOfMembers": "5c9f347457272d5edfeb5dd5c0f6fe4e38311b6126908f2612a1e58d8fb5b3ea"
	},
	"Devices": [
		{
	    "Id":1,
    	"Name":"machinename01",
	    "Fqdn":"machinename01.somedomain.com",
	    "Status":1,
	    "OsType":"Windows",
	    "OsVerNum":2814750438195200,
	    "OsVerTxt":"Microsoft Windows 10 Enterprise",
	    "AgentVersion":281483566841860,
	    "Manufacturer":"Dell Inc.",
	    "ChassisType":7,
	    "DeviceType":"Desktop",
	    "CpuType":"Intel(R) Xeon(R) CPU E5-2630 0 @ 2.30GHz",
	    "CpuArchitecture":"x64",
	    "OsArchitecture":"x64",
	    "RamMB":32693,
	    "SMBiosGuid":"4c4c4544-0051-5a10-8058-b7c04f47354a",
	    "OsGuid":"4c4c4544-0051-5a10-8058-b7c04f47354a",
	    "TachyonGuid":"4c4c4544-0051-5a10-8058-b7c04f47354a",
	    "BiosVersion":"n/a",
	    "LastBootUTC":1454408472,
	    "LastConnUtc":1454604670,
	    "CreatedUtc":"2016-02-03T17:20:55.003",
	    "VrPlatform":"",
	    "TimeZone":0,
	    "CertType":null,
	    "CertExpiryUtc":null,
	    "PushToken":null,
	    "Model":"Precision T5600",
	    "Domain":"somedomain"
		},
		{ ... },
		{ ... }
	]
}

Requires Tachyon Management Group support mode to be set to 'Internal'.

Requires 'Write' permission on Management Groups
PUT/Consumer/ManagementGroups/Contents

Replaces all the devices in a Management Group. All existing devices are deleted, and the devices supplied with this request are stored in their place.

After devices have been updated, the group Count and HashOfMembers for that group will be recalculated.

The incoming payload and the return payload are exactly the same as specified above for a POST request.

Requires 'Write' permission on Management Groups
DELETE/Consumer/ManagementGroups/Contents

Removes device(s) from a Management Group.

Payload for this request is an object representing a one-to-many relationship using Ids of objects.

Owner has the Id of the Management Group, Elements is an array of Ids of Devices.

DELETE payload
{
	"ManagementGroupId": 12,
	"DeviceFqdns": ["machinename01.somedomain.com", "machinename02.somedomain.com"]
}

After devices have been removed from the group Count and HashOfMembers for that group will be recalculated.

Return payload will contain the Management Group in question and all devices that belong to it.

Sample Response payload
{
	"ManagementGroup": {
		"Id": "1",
	    "Name": "Management Group A",
    	"Description": "",
	    "Expression": "",
	    "Count": "12",
    	"UsableId": "0E9514B6-FD77-4077-9B54-A2AAA0C1953C",
	    "HashOfMembers": "5c9f347457272d5edfeb5dd5c0f6fe4e38311b6126908f2612a1e58d8fb5b3ea"
	},
	"Devices": [
		{
	    "Id":1,
    	"Name":"machinename03",
	    "Fqdn":"machinename03.somedomain.com",
	    "Status":1,
	    "OsType":"Windows",
	    "OsVerNum":2814750438195200,
	    "OsVerTxt":"Microsoft Windows 10 Enterprise",
	    "AgentVersion":281483566841860,
	    "Manufacturer":"Dell Inc.",
	    "ChassisType":7,
	    "DeviceType":"Desktop",
	    "CpuType":"Intel(R) Xeon(R) CPU E5-2630 0 @ 2.30GHz",
	    "CpuArchitecture":"x64",
	    "OsArchitecture":"x64",
	    "RamMB":32693,
	    "SMBiosGuid":"4c4c4544-0051-5a10-8058-b7c04f47354a",
	    "OsGuid":"4c4c4544-0051-5a10-8058-b7c04f47354a",
	    "TachyonGuid":"4c4c4544-0051-5a10-8058-b7c04f47354a",
	    "BiosVersion":"n/a",
	    "LastBootUTC":1454408472,
	    "LastConnUtc":1454604670,
	    "CreatedUtc":"2016-02-03T17:20:55.003",
	    "VrPlatform":"",
	    "TimeZone":0,
	    "CertType":null,
	    "CertExpiryUtc":null,
	    "PushToken":null,
	    "Model":"Precision T5600",
	    "Domain":"somedomain"
		},
		{ ... },
		{ ... }
	]
}

Requires Tachyon Management Group support mode to be set to 'Internal'.

Requires 'Write' permission on Management Groups
POST/Consumer/ManagementGroups/Clear/Id/{id}

Removes all Devices from a Management Group by the group's Id.

Requires Tachyon Management Group support mode to be set to 'Internal'.

Requires 'Write' permission on Management Groups
POST/Consumer/ManagementGroups/Clear/Name/{name}

Removes all Devices from a Management Group by the group's Name.

Name needs to be supplied as Base64Encoded string.

Requires Tachyon Management Group support mode to be set to 'Internal'.

Requires 'Write' permission on Management Groups
POST/Consumer/ManagementGroups/Clear/UsableId/{usableId}

Removes all Devices from a Management Group by the group's UsableId.

Requires Tachyon Management Group support mode to be set to 'Internal'.

Requires 'Write' permission on Management Groups