Skip to main content

List

List all groups on a target host:

$ osapi client node group list --target web-01

HOSTNAME STATUS NAME GID MEMBERS
web-01 ok docker 999 deploy,app
web-01 ok sudo 27 deploy
web-01 ok users 100 deploy,app

1 host: 1 ok

JSON Output

Use --json to get the full API response:

$ osapi client node group list --target web-01 --json
{"results":[{"hostname":"web-01","groups":[{"name":"docker","gid":999,"members":["deploy","app"]}],"status":"ok"}],"job_id":"..."}

Flags

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