scyld-adminctl¶

NAME

scyld-adminctl -- Query and modify administrators for the cluster.

USAGE

scyld-adminctl: [-h] [-v] [-q] [[-c | --config] CONFIG] [--base-url URL] [[-u | --user] USER[:PASSWD]] [--human | --json | --csv | --table] [--pretty | --no-pretty] [--fields FIELDS] [--show-uids] [[-i | --ids] ADMINS | -a | --all] {list,ls, create,mk, clone,cp, update,up, replace,re, delete,rm}

DESCRIPTION

This tool does not control the details of authentication. For that, please consult Securing the Cluster in the Administrator's Guide.

OPTIONAL ARGUMENTS

-h, --help: Print usage message and exit. Ignore trailing args, parse and ignore preceding args.
-v, --verbose: Increase verbosity.
-q, --quiet: Decrease verbosity.
-c, --config CONFIG: Specify a client configuration file CONFIG.
--show-uids: Do not try to make the output more human readable.
-a, --all: Interact with all administrators (default for list).
-i, --ids ADMINS: A comma-separated list of administrators to query or modify.

ARGUMENTS TO OVERRIDE BASIC CONFIGURATION DETAILS

-u, --user USER[:PASSWD]: Masquerade as user USER with optional colon-separated password PASSWD.

FORMATTING ARGUMENTS

--human: Format the output for readability (default).
--json: Format the output as JSON.
--csv: Format the output as CSV.
--table: Format the output as a table.
--pretty: Indent JSON or XML output, and substitute human readable output for other formats.
--no-pretty: Opposite of --pretty.
--fields FIELDS: Select individual fields in the result or error.

ACTIONS ON SPECIFIED ADMINISTRATOR(S)

list (ls): List information about administrator(s).
create (mk) name=NAME: Add an administrator NAME.
clone (cp) name=NAME: Copy administrator to new identifier NAME.
update (up): Modify administrator fields.
replace (re): Replace all administrator fields. Deprecated in favor of "update".
delete (rm): Delete administrators(s).

EXAMPLES

scyld-adminctl create name=hsolo

Add new administrator "hsolo".

scyld-adminctl -i hsolo clone name=cbaca

Copy the administrator properties for "hsolo" to a new administrator "cbaca".

RETURN VALUES

Upon successful completion, scyld-adminctl returns 0. On failure, an error message is printed to stderr and scyld-adminctl returns 1.