scyld-reportsΒΆ
NAME
scyld-reports -- Manage and generate cluster reports.
USAGE
scyld-reports
[-h]
[-v]
[-q]
[[-c | --config] CONFIG]
[--base-url URL]
[[-u | --user] USER[:PASSWD]]
[--human | --json | --csv | --table]
[--pretty | --no-pretty]
{setup, usage, unknown} ...
DESCRIPTION
This tool manages and generates cluster reports.
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.
ARGUMENTS TO OVERRIDE BASIC CONFIGURATION DETAILS
- --base-url URL
Specify the base URL of the ClusterWare REST API.
- -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.
ACTIONS
- setup [--accountant [ACCOUNTANT]]
Specify the accountant URL with credentials. Contact Penguin Computing Support or Professional Services for assistance.
- usage [--start START] [--end END] [--users USERS] [--queues QUEUES]
Display cluster usage. This requires a prior scyld-reports setup` of the accountant connection.
- --start START
Specify a starting date. Defaults to first of current month.
- --end END
Specify a duration in days or an end date. Defaults to days until the end of the month.
- --users USERS
Filter the results using comma-separated list of users.
- --queues QUEUES
Filter the results using the comma-separated list of queues.
- unknown [--newer-than SECS] [--columns COLS] [--sort COLS] [--lookup]
[--as-creates [POOL]] [--flush]
Display MAC addresses of unknown nodes that have attempted to boot.
- --newer-than SECS
Only show MACs with contact within the last SECS seconds.
- --columns COLS
Display the columns in the desired comma-separated name order. Default is display all columns.
- --sort COLS
Sort entries based on the provided column names.
- --lookup
Attempt to identify MAC OUIs.
- --as-creates [POOL]
Print a specific
scyld-nodectl create
command for each unknown MAC, optionally associating a new node with a specific POOL.
- --flush
Flush the current unknown node list.
EXAMPLES
scyld-reports unknown
Display the full list of unknown nodes that have attempted to boot.
scyld-reports unknown --newer-than 1200 --columns mac,seen
Display only nodes which have made contact in the last 1200 seconds (20 minutes), showing each node's MAC address and last seen timestamp.
scyld-reports unknown --newer-than 600 --as-creates
Display only nodes which have made contact in the last 600 seconds (10 minutes), and for each show the
scyld-nodectl create mac=<MACADDR>
command that would add that node as a compute node.
RETURN VALUES
Upon successful completion, scyld-reports returns 0.
On failure, an error message is printed to stderr
and
scyld-reports returns 1.