Undeploy

Remove a deployed file from disk on the target node. The object store entry is preserved so the file can be redeployed at any time.

$ osapi client node file undeploy \
    --target server1 \
    --path /etc/app/app.conf

  Hostname: server1
  Status:   ok
  Changed:  true

If the file does not exist on disk, the operation is a no-op and Changed: false is returned.

Undeploy from all hosts in a label group:

$ osapi client node file undeploy \
    --path /etc/nginx/nginx.conf \
    --target group:web

JSON Output

Use --json to get the full API response:

$ osapi client node file undeploy \
    --target server1 \
    --path /etc/app/app.conf \
    --json
{"results":[{"hostname":"server1","changed":true}],"job_id":"550e8400-e29b-41d4-a716-446655440000"}

Flags

Flag	Description	Default
--path	Path of the file to remove on the target (required)
-T, --target	Target: _any, _all, hostname, or label (group:web)	_any
-j, --json	Output raw JSON response

note

The object store entry is not deleted. Use osapi client file delete to remove the object from the store once it is no longer needed.