Agent
Manage the agents in the fleet: discovery, drain and PKI enrollment.
osapi controller endpoint get --name agent shows the same.
Endpoint group
| Name | agent |
| Description | Manage the agents in the fleet: discovery, drain and PKI enrollment |
Methods (5)
| NAME | VERB | PATH | PERMISSION | OPERATION ID |
|---|---|---|---|---|
| status | GET | /api/agent/status | health:read | GetAgentStatus |
| list | GET | /api/agent | agent:read | GetAgents |
| get | GET | /api/agent/{hostname} | agent:read | GetAgentDetails |
| drain | POST | /api/agent/{hostname}/drain | agent:write | DrainAgent |
| undrain | POST | /api/agent/{hostname}/undrain | agent:write | UndrainAgent |
Types (5)
| NAME | INPUT | OUTPUT |
|---|---|---|
| status | StatusInput | ComponentList { total_items, items } |
| list | ListInput | ListAgentsResponse { items, total_items } |
| get | GetInput { hostname* } | AgentInfo { hostname, machine_id, state, conditions, labels, started_at, load_average, os_info, version, fingerprint, registered_at, uptime, memory, architecture, kernel_version, cpu_count, fqdn, service_mgr, package_mgr, primary_interface, interfaces, routes, facts, timeline, key_stored, verified } |
| drain | DrainInput { hostname* } | |
| undrain | UndrainInput { hostname* } |