Skip to main content

Get

Get a specific user account by name:

$ osapi client node user get --target web-01 --name deploy

HOSTNAME STATUS NAME UID HOME SHELL GROUPS
web-01 ok deploy 1001 /home/deploy /bin/bash sudo,docker

1 host: 1 ok

JSON Output

$ osapi client node user get --target web-01 --name deploy --json
{"results":[{"hostname":"web-01","users":[{"name":"deploy","uid":1001,"gid":1001,"home":"/home/deploy","shell":"/bin/bash","groups":["sudo","docker"],"locked":false}],"status":"ok"}],"job_id":"..."}

Flags

FlagDescriptionDefault
-T, --targetTarget: _any, _all, hostname, or label (group:web)_all
--nameUsername to look up (required)
-j, --jsonOutput raw JSON response