Command line interface to Boundary REST APIs
Project description
bash $ metric-list
Installation
bash $ pip install boundary_cli
Configuration
The Boundary CLI uses environment variables for configuration information (user, password, etc) to execute against the Boundary REST APIs, and optionally this information can be overridden via the command line
Environment Variables
Environment Variable |
Description |
|---|---|
BOUNDARY_API_HOST |
Boundary API host |
BOUNDARY_EMAIL |
Boundary email |
BOUNDARY_API_TOKEN |
Boundary API token |
Examples
Usage of the Boundary CLI
metric-create
$ metric-create FOO "foo bar" "foo" "it's the foo" sum number
{
"result": {
"success": true
}
}Add a Metric Value
$ metric-add myhost LOAD_1_MINUTE 30
{
"result": {
"success": true
}
}metric-list
$ metric-list
{
"result": [{
{
"id": 6028,
"name": "LOAD_1_MINUTE",
"displayName": "CPU Load 1 Minute",
"description": "CPU load for the last minute",
"drillFromMetricName": null,
"unit": "number",
"catalogId": 2110,
"displayNameShort": "Load 1 Minute",
"defaultAggregate": "avg",
"isDisabled": 0,
"isDeleted": 0,
"isBuiltin": 0
},
...Command Reference
Metric
Commands to administer metrics in Boundary
metric-add
Creates a new measurement value in Boundary
`bash usage: metric-add source metric measure
metric-delete
Creates/updates a Boundary Premium metric definition
usage: metric-create <name> <display-name> <display-name_short> <description> <aggregate> <unit> <defaultResolutionMS>
where:
name - Name of the metric
display-name - Name displayed in the Web UI
display-name-short - Shorter display name
description - Description of the metric (also used as tooltip)
aggregate - Type of aggregate (sum, avg, max, or min)
unit - Type of measurement (percent, number, bytecount, or duration )
defaultResolutionMS -metric-delete
usage: metric-delete <name>metric-list
Lists the metric definitions in your Boundary instance.
usage: metric-listPlugins
plugin-add
plugin-delete
plugin-get
plugin-get-components
plugin-install
plugin-installed
plugin-list
plugin-remove
plugin-uninstall`
Sources
source-delete
$ source-delete <source> <metric id>
source-list
Lists all sources in your Boundary instance
$ source-list
User
user-get
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
