Nodes
List managed nodes
Get information about the nodes managed by the target server
get/nodes
Query parameters
includestring comma-separated list
Example:minimal
Level of information to include from the node inventory. Some base levels are defined (minimal, default, full). You can add fields you want to a base level by adding them to the list, possible values are keys from json answer. If you don't provide a base level, they will be added to default level, so if you only want os details, use minimal,os as the value for this parameter.
- minimal includes: id, hostname and status
- default includes minimal plus architectureDescription, description, ipAddresses, lastRunDate, lastInventoryDate, machine, os, managementTechnology, policyServerId, properties (be careful! Only node own properties, if you also need inherited properties, look at the dedicated /nodes/{id}/inheritedProperties endpoint), policyMode , ram and timezone
- full includes: default plus accounts, bios, controllers, environmentVariables, fileSystems, instanceId, managementTechnologyDetails, memories, networkInterfaces, ports, processes, processors, slots, software, softwareUpdate, sound, storage, videos and virtualMachines
The criterion you want to find for your nodes. Replaces the where, composition and select parameters in a single parameter.
The criterion you want to find for your nodes
composition'and' | 'or'
Example:and
Boolean operator to use between each where criteria.
selectstring
What kind of data we want to include. Here we can get policy servers/relay by setting nodeAndPolicyServer. Only used if where is defined.
Response
Nodes
Example response
{
"data": {
"nodes": [
{
"id": "9a1773c9-0889-40b6-be89-f6504443ac1b",
"hostname": "node1.example.com",
"status": "accepted",
"architectureDescription": "x86_64",
"ipAddresses": [
"192.168.23.45"
],
"lastRunDate": "2020-02-29T14:48:28Z",
"acceptanceDate": "2020-02-29T10:11:32Z",
"lastInventoryDate": "2020-02-29T10:11:32Z",
"machine": {
"type": "Virtual",
"provider": "vbox",
"manufacturer": "innotek GmbH",
"serialNumber": "ece12459-2b90-49c9-ab1e-72e38f797421"
},
"os": {
"type": "Linux",
"name": "Centos",
"version": "7.6.1810",
"fullName": "CentOS Linux release 7.6.1810 (Core)",
"servicePack": "3",
"kernelVersion": "3.10.0-957.1.3.el7.x86_64"
},
"managementTechnology": [
{
"name": "Rudder",
"version": "6.0.3.release-1.EL.7",
"capabilities": [
"xml"
],
"nodeKind": "node",
"rootComponents": [
"rudder-db"
]
}
],
"policyServerId": "root",
"properties": [
{
"name": "datacenter",
"value": "AMS2"
}
],
"policyMode": "audit",
"ram": 8589934592,
"timezone": {
"name": "UTC",
"offset": "+0000"
},
"accounts": [
"root"
],
"bios": {
"name": "VirtualBox",
"version": "1.2.3",
"editor": "innotek GmbH",
"quantity": 1,
"releaseDate": "2006-12-01T00:00:00Z",
"description": "FIXME"
},
"controllers": [
{
"quantity": 1
}
],
"environmentVariables": [
{
"name": "LANG",
"value": "en_US.UTF-8"
}
],
"fileSystems": [
{
"name": "ext4",
"mountPoint": "/srv",
"fileCount": 1456,
"freeSpace": 1048576,
"totalSpace": 2097152
}
],
"managementTechnologyDetails": {
"cfengineKeys": [
"-----BEGIN CERTIFICATE-----\\nMIIFqDCC[...]3tALNn\\n-----END CERTIFICATE-----"
],
"cfengineUser": "root",
"scheduleOverride": {
"runInterval": "20 min",
"firstRun": "00:11",
"splayTime": "7 min"
}
},
"memories": [
{
"speed": 1066,
"quantity": 1,
"capacity": 1073741824,
"slotNumber": 3
}
],
"networkInterfaces": [
{
"name": "eth0",
"mask": [
"255.255.255.0"
],
"type": "ethernet",
"speed": "1000",
"status": "Up",
"dhcpServer": "192.168.34.5",
"macAddress": "08:00:27:6f:5c:14",
"ipAddresses": [
"192.168.76.4"
]
}
],
"ports": [
{
"quantity": 1
}
],
"processes": [
{
"pid": 3576,
"tty": "?",
"name": "/usr/sbin/httpd -DFOREGROUND",
"user": "apache",
"started": "2020-02-29 00:24",
"memory": 0.4000000059604645,
"virtualMemory": 4380,
"cpuUsage": 1
}
],
"processors": [
{
"name": "Intel(R) Core(TM) i7-7700HQ CPU @ 2.80GHz",
"arch": "i386",
"model": 158,
"core": 1,
"speed": 2800,
"thread": 1,
"stepping": 9,
"manufacturer": "Intel",
"quantity": 1
}
],
"software": [
{
"name": "libcurl",
"version": "7.29.0-54.el7_7.2",
"editor": "CentOS",
"description": "A library for getting files from web servers"
}
],
"sound": [
{
"quantity": 1
}
],
"storage": [
{
"name": "sda",
"type": "disk",
"size": 10737418240,
"model": "VBOXHARDDISK",
"firmware": "10",
"quantity": 1,
"serialNumber": "000a1954"
}
],
"videos": [
{
"quantity": 1
}
]
}
]
}
}