MachineDriver

Resource Fields

Writeable Fields

Field Type Create Update Default Notes
activateOnCreate boolean Optional - -  
builtin boolean Optional - -  
checksum string Optional Yes -  
description string Optional Yes -  
externalId string Optional Yes -  
uiUrl string Optional Yes -  
url string Yes Yes -  

Read Only Fields

Field Type Notes
data map[json]  
defaultActive boolean  
id int The unique identifier for the machineDriver
name 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.

Operations

CreatePOST: /v2-beta/projects/${PROJECT_ID}/machineDrivers

curl -u "${RANCHER_ACCESS_KEY}:${RANCHER_SECRET_KEY}" \
-X POST \
-H 'Content-Type: application/json' \
-d '{
	"activateOnCreate": false,
	"builtin": false,
	"checksum": "string",
	"description": "string",
	"externalId": "string",
	"uiUrl": "string",
	"url": "string"
}' 'http://${RANCHER_URL}:8080/v2-beta/projects/${PROJECT_ID}/machineDrivers'

DeleteDELETE: /v2-beta/projects/${PROJECT_ID}/machineDrivers/${ID}

curl -u "${RANCHER_ACCESS_KEY}:${RANCHER_SECRET_KEY}" \
-X DELETE \
'http://${RANCHER_URL}:8080/v2-beta/projects/${PROJECT_ID}/machineDrivers/${ID}'

UpdatePUT: /v2-beta/projects/${PROJECT_ID}/machineDrivers/${ID}

curl -u "${RANCHER_ACCESS_KEY}:${RANCHER_SECRET_KEY}" \
-X PUT \
-H 'Content-Type: application/json' \
-d '{
	"checksum": "string",
	"description": "string",
	"externalId": "string",
	"uiUrl": "string",
	"url": "string"
}' 'http://${RANCHER_URL}:8080/v2-beta/projects/${PROJECT_ID}/machineDrivers/${ID}'

Actions

activate POST: /v2-beta/projects/${PROJECT_ID}/machineDrivers/${ID}?action=activate


Input:This action has no inputs


curl -u "${RANCHER_ACCESS_KEY}:${RANCHER_SECRET_KEY}" \
-X POST \
'http://${RANCHER_URL}:8080/v2-beta/projects/${PROJECT_ID}/machineDrivers/${ID}?action=activate'


Output: An updated copy of the machineDriver resource

deactivate POST: /v2-beta/projects/${PROJECT_ID}/machineDrivers/${ID}?action=deactivate


Input:This action has no inputs


curl -u "${RANCHER_ACCESS_KEY}:${RANCHER_SECRET_KEY}" \
-X POST \
'http://${RANCHER_URL}:8080/v2-beta/projects/${PROJECT_ID}/machineDrivers/${ID}?action=deactivate'


Output: An updated copy of the machineDriver resource

reactivate POST: /v2-beta/projects/${PROJECT_ID}/machineDrivers/${ID}?action=reactivate


Input:This action has no inputs


curl -u "${RANCHER_ACCESS_KEY}:${RANCHER_SECRET_KEY}" \
-X POST \
'http://${RANCHER_URL}:8080/v2-beta/projects/${PROJECT_ID}/machineDrivers/${ID}?action=reactivate'


Output: An updated copy of the machineDriver resource

Edit this page