Node attributes
Node attributes represent the data associated with a node. You can use node attributes in Node Management to filter, group, sort, or search for nodes.
Attribute namespaces
Attributes of a node are associated with a namespace to indicate the source of the attribute.
The following namespaces are reserved by Chef 360 Platform:
Namespace | Reserved by |
---|---|
agent | Attributes added by Node Management agent |
tags | User applied tags |
gohai | Attributed added by Chef Gohai skill |
aws | AWS attributes (also added by Gohai skill) |
azure | Azure attributes (also added by Gohai skill) |
Get details of one node
You can get the details of a node including its attributes and attribute namespaces using the node ID:
chef-node-management-cli management node find-one-node --nodeId <NODE_ID>
Which returns a response similar to the following:
{
"item":{
"attributes":[
{
"name":"architecture",
"namespace":"agent",
"value":"x86_64"
},
{
"name":"hostname",
"namespace":"agent",
"value":"ip-192-168-10-10.us-east-2.compute.internal"
},
{
"name":"kernel_name",
"namespace":"agent",
"value":"Linux"
},
{
"name":"kernel_version",
"namespace":"agent",
"value":"6.1.94-99.176.amzn2023.x86_64"
},
{
"name":"netmask",
"namespace":"agent",
"value":"255.255.255.0"
},
{
"name":"os_name",
"namespace":"agent",
"value":"Amazon Linux"
},
{
"name":"os_version",
"namespace":"agent",
"value":"2023"
},
{
"name":"primary_ip",
"namespace":"agent",
"value":"192.168.10.10"
},
{
"name":"time_zone",
"namespace":"agent",
"value":"UTC+0000"
},
{
"name":"account-id",
"namespace":"aws",
"value":"834902008322"
},
{
"name":"ami-id",
"namespace":"aws",
"value":"ami-07d7e3e669718ab45"
},
{
"name":"architecture",
"namespace":"aws",
"value":"x86_64"
},
{
"name":"availability-zone",
"namespace":"aws",
"value":"us-east-2a"
},
{
"name":"hostname",
"namespace":"aws",
"value":"ip-192-168-10-10.us-east-2.compute.internal"
},
{
"name":"instance-id",
"namespace":"aws",
"value":"i-037c82e36bb617da9"
},
{
"name":"instance-type",
"namespace":"aws",
"value":"t3.micro"
},
{
"name":"local-hostname",
"namespace":"aws",
"value":"ip-192-168-10-10.us-east-2.compute.internal"
},
{
"name":"local-ipv4",
"namespace":"aws",
"value":"192.168.10.10"
},
{
"name":"mac",
"namespace":"aws",
"value":"02:ff:1b:8b:bf:b7"
},
{
"name":"private-ip",
"namespace":"aws",
"value":"192.168.10.10"
},
{
"name":"region",
"namespace":"aws",
"value":"us-east-2"
},
{
"name":"fqdn",
"namespace":"enroll",
"value":"192.168.10.10"
},
{
"name":"cpu_cores",
"namespace":"gohai",
"value":"1"
},
{
"name":"cpu_family",
"namespace":"gohai",
"value":"6"
},
{
"name":"cpu_logical_processors",
"namespace":"gohai",
"value":"2"
},
{
"name":"cpu_mhz",
"namespace":"gohai",
"value":"2499.998"
},
{
"name":"cpu_model",
"namespace":"gohai",
"value":"85"
},
{
"name":"cpu_modelname",
"namespace":"gohai",
"value":"Intel(R) Xeon(R) Platinum 8175M CPU @ 2.50GHz"
},
{
"name":"cpu_stepping",
"namespace":"gohai",
"value":"4"
},
{
"name":"hostname",
"namespace":"gohai",
"value":"ip-192-168-10-10.us-east-2.compute.internal"
},
{
"name":"instance_type",
"namespace":"gohai",
"value":"aws"
},
{
"name":"ipaddress",
"namespace":"gohai",
"value":"192.168.10.10"
},
{
"name":"ipaddress_v6",
"namespace":"gohai",
"value":"fe80::ff:1bff:fe8b:bfb7"
},
{
"name":"kernel_name",
"namespace":"gohai",
"value":"Linux"
},
{
"name":"kernel_release_date",
"namespace":"gohai",
"value":"#1 SMP PREEMPT_DYNAMIC Tue Jun 18 14:57:56 UTC 2024"
},
{
"name":"kernel_version",
"namespace":"gohai",
"value":"6.1.94-99.176.amzn2023.x86_64"
},
{
"name":"macaddress",
"namespace":"gohai",
"value":"02:ff:1b:8b:bf:b7"
},
{
"name":"machine_architecture",
"namespace":"gohai",
"value":"x86_64"
},
{
"name":"os",
"namespace":"gohai",
"value":"GNU/Linux"
},
{
"name":"processor_type",
"namespace":"gohai",
"value":"x86_64"
},
{
"name":"total_memory_inbytes",
"namespace":"gohai",
"value":"948973568"
},
{
"name":"total_swapmemory",
"namespace":"gohai",
"value":"0kB"
},
{
"name":"vendor_id",
"namespace":"gohai",
"value":"GenuineIntel"
},
{
"name":"testtagkey",
"namespace":"tags",
"value":"somevalue"
},
{
"name":"testtagkey1",
"namespace":"tags",
"value":"somevalue1"
}
],
"checkedinAt":"2024-07-01T06:34:53.983239Z",
"cohortId":"04ca4cd0-44e1-4b40-a940-ed77d516974d",
"enrollmentLevel":"enrolled",
"healthStatus":"online",
"id":"8c113d54-c3ae-49a8-9fb1-cf68506cd522",
"installedSkills":[
{
"canister":{
"channel":"",
"release":"20240626105357",
"version":"0.3.1"
},
"name":"chef-client-interpreter",
"native":null
},
{
"canister":{
"channel":"",
"release":"20240625161904",
"version":"0.3.1"
},
"name":"chef-gohai",
"native":null
},
{
"canister":{
"channel":"",
"release":"20240626104028",
"version":"1.3.1"
},
"name":"courier-runner",
"native":null
},
{
"canister":{
"channel":"",
"release":"20240626104214",
"version":"0.3.1"
},
"name":"inspec-interpreter",
"native":null
},
{
"canister":{
"channel":"",
"release":"20240626140712",
"version":"0.7.0"
},
"name":"node-management-agent",
"native":null
},
{
"canister":{
"channel":"",
"release":"20240626104148",
"version":"0.3.1"
},
"name":"restart-interpreter",
"native":null
},
{
"canister":{
"channel":"",
"release":"20240626104105",
"version":"0.3.1"
},
"name":"shell-interpreter",
"native":null
}
],
"requiredSkills":[
{
"canister":{
"channel":"",
"release":"20240626105357",
"version":"0.3.1"
},
"name":"chef-client-interpreter",
"native":null
},
{
"canister":{
"channel":"",
"release":"20240625161904",
"version":"0.3.1"
},
"name":"chef-gohai",
"native":null
},
{
"canister":{
"channel":"",
"release":"20240626104028",
"version":"1.3.1"
},
"name":"courier-runner",
"native":null
},
{
"canister":{
"channel":"",
"release":"20240626104214",
"version":"0.3.1"
},
"name":"inspec-interpreter",
"native":null
},
{
"canister":{
"channel":"",
"release":"20240626140712",
"version":"0.7.0"
},
"name":"node-management-agent",
"native":null
},
{
"canister":{
"channel":"",
"release":"20240626104148",
"version":"0.3.1"
},
"name":"restart-interpreter",
"native":null
},
{
"canister":{
"channel":"",
"release":"20240626104105",
"version":"0.3.1"
},
"name":"shell-interpreter",
"native":null
}
]
}
}
Get details of all nodes
You can view the details of all nodes:
chef-node-management-cli management node find-all-nodes
Node health status
The healthStatus
attribute indicates the health status of nodes enrolled with Chef 360 Platform.
Nodes have the following health statuses:
health status | available | performs push actions |
---|---|---|
online | yes | yes |
reachable | no | yes |
waiting | yes | no |
offline | no | no |
ready | yes | hasn’t attempted |
unknown | no | hasn’t attempted |
Note
A node is available if it checks according to the defined Node Management check-in interval and unavailable if it hasn’t checked-in within six times the check-in interval.