Endpoint: /sites/{siteId}/ram/agents

Note: Available as of EFT 8.1.0

Returns a list of remote agents from a specified site.

  • GET

Method & URL

GET https://[server URL]:[port]/admin/v2/sites/{siteId}/ram/agents

GET Body Sample

Copy 
### GET Remote Agents
GET  https://{{host}}/admin/v2/sites/{{Siteid}}/ram/agents HTTP/1.1
Authorization: EFTAdminAuthToken {{AuthToken}}
##

GET Response Body Sample

Copy 
{ "data": [ { "id": "4dfd3f28-6ba9-4e19-ae7b-4d3b0b4314f6", "type": "remote-agent", "attributes": { 
"name": "ag_IV-2019A", "clid": "00000000-0000-0000-0000-000000000000", "state": "PendingJoin", 
"pausing": false, "resuming": false, "netBios": "IV-2019A", "domain": "", "winOEM": "x64 (AMD or Intel)", 
"ips": [ "fe80::904:aa5a:7256:ca57 (Ethernet)", "10.91.160.123 (Ethernet)", "ff01::1 (Ethernet)", 
"ff02::1 (Ethernet)", "ff02::c (Ethernet)", "ff02::fb (Ethernet)", "ff02::1:3 (Ethernet)", 
"ff02::1:ff56:ca57 (Ethernet)", "224.0.0.1 (Ethernet)", "224.0.0.251 (Ethernet)", "224.0.0.252 (Ethernet)", 
"239.255.255.250 (Ethernet)", "::1 (Loopback Pseudo-Interface 1)", "127.0.0.1 (Loopback Pseudo-Interface 1)", 
"ff02::c (Loopback Pseudo-Interface 1)", "239.255.255.250 (Loopback Pseudo-Interface 1)" ], 
"macAddresses": [ "0-15-5d-64-e-2c" ], "lastUpdate": 0, "version": "8.1.0.6", 
"lastKnownIP": "10.91.160.123", "nextUpdate": 0, "approvedTime": 0, 
"secret": "7102da9c0219696b82679072b9c2f", "peakVersion": "8.1.0.6" }, "links": { "self": 
"/admin/v2/sites/4ebb829f-f84c-4355-8d55-d43a2852ca12/ram/agents/4dfd3f28-6ba9-4e19-ae7b-4d3b0b4314f6" } }, 
{ "id": "6ad61dcb-fabe-4627-aebe-065cfe4eadd0", "type": "remote-agent", "attributes": { "name": "ag_IV-2019C", 
"clid": "00000000-0000-0000-0000-000000000000", "state": "PendingJoin", "pausing": false, "resuming": false, 
"netBios": "IV-2019C", "domain": "", "winOEM": "x64 (AMD or Intel)", "ips": [ 

"fe80::2d7d:3dd6:4ff0:9bba (Ethernet)", "10.91.160.130 (Ethernet)", "ff01::1 (Ethernet)", 
"ff02::1 (Ethernet)", "ff02::c (Ethernet)", "ff02::fb (Ethernet)", "ff02::1:3 (Ethernet)", 
"ff02::1:fff0:9bba (Ethernet)", "224.0.0.1 (Ethernet)", "224.0.0.251 (Ethernet)", "224.0.0.252 (Ethernet)", 
"239.255.255.250 (Ethernet)", "::1 (Loopback Pseudo-Interface 1)", "127.0.0.1 (Loopback Pseudo-Interface 1)", 
"ff02::c (Loopback Pseudo-Interface 1)", "239.255.255.250 (Loopback Pseudo-Interface 1)" ], 
"macAddresses": [ "0-15-5d-64-e-2e" ], "lastUpdate": 0, "version": "8.1.0.6", "lastKnownIP": "10.91.160.130", 
"nextUpdate": 0, "approvedTime": 0, "secret": "0a8e8c89ed87352f0a979c73cb9e686ff3fe700a614546d28cbd96864e0de9fd",
"peakVersion": "8.1.0.6" }, "links": { "self": "/admin/v2/sites/4ebb829f-f84c-4355-8d55-d43a2852ca12/ram/agents/
6ad61dcb-fabe-4627-aebe-065cfe4eadd0" } } ], "links": { "self": "/admin/v2/sites/
4ebb829f-f84c-4355-8d55-d43a2852ca12/ram/agents" } }

GET PowerShell Sample

Copy 
# Get sites
$siteList = Invoke-RestMethod -Uri "$baseURL/v2/sites" -Method 'GET' -Headers $authHeader
$siteID = $siteList.data[0].id

###GET Remote Agents
Write-Output "Remote Agents"
Write-Output "----"
$ramAgentList = Invoke-RestMethod -Uri "$baseURL/v2/sites/$siteID/ram/agents" 
-Method 'GET' -Headers $authHeader
Write-Output $ramAgentList | ConvertTo-Json
foreach ($ramAgentList in $ramAgentList.data)
{
    Write-Output ("Remote Agent  $($ramAgentList.id): $($ramAgentList.attributes.name)")
}