Rancher 1.6 Docs

Agent

Resource Fields

Writeable Fields

Field Type Create Update Default Notes
description string Optional Yes -  
name string Optional Yes -  

Read Only Fields

Field Type Notes
data map[json]  
id int The unique identifier for the agent
managedConfig boolean  
uri string  


Please read more about the common resource fields. These fields are read only and applicable to almost every resource. We have segregated them from the list above.

Actions

activate POST: /v1/projects/${PROJECT_ID}/agents/${ID}?action=activate

Input:This action has no inputs 
curl -u "${RANCHER_ACCESS_KEY}:${RANCHER_SECRET_KEY}" \
-X POST \
'http://${RANCHER_URL}:8080/v1/projects/${PROJECT_ID}/agents/${ID}?action=activate'

Output: An updated copy of the agent resource
deactivate POST: /v1/projects/${PROJECT_ID}/agents/${ID}?action=deactivate

Input:This action has no inputs 
curl -u "${RANCHER_ACCESS_KEY}:${RANCHER_SECRET_KEY}" \
-X POST \
'http://${RANCHER_URL}:8080/v1/projects/${PROJECT_ID}/agents/${ID}?action=deactivate'

Output: An updated copy of the agent resource
disconnect POST: /v1/projects/${PROJECT_ID}/agents/${ID}?action=disconnect

Input:This action has no inputs 
curl -u "${RANCHER_ACCESS_KEY}:${RANCHER_SECRET_KEY}" \
-X POST \
'http://${RANCHER_URL}:8080/v1/projects/${PROJECT_ID}/agents/${ID}?action=disconnect'

Output: An updated copy of the agent resource
reconnect POST: /v1/projects/${PROJECT_ID}/agents/${ID}?action=reconnect

Input:This action has no inputs 
curl -u "${RANCHER_ACCESS_KEY}:${RANCHER_SECRET_KEY}" \
-X POST \
'http://${RANCHER_URL}:8080/v1/projects/${PROJECT_ID}/agents/${ID}?action=reconnect'

Output: An updated copy of the agent resource
Edit this page