Plugins
Commands to administer plugins in a TrueSight Pulse account.
plugin-add
API Documentation
(http://premium-documentation.boundary.com/v1/put/plugins/private/:plugin/:org/:repo)[http://premium-documentation.boundary.com/v1/put/plugins/private/:plugin/:org/:repo]
Usage
usage: plugin-add [-h] [-l {debug,info,warning,error,critical}] [-a api_host]
[-e e_mail] [-t api_token] -n plugin_name -o
organization_name -r respository_name
Imports a meter plugin from a github repository into a TrueSight Pulse account
optional arguments:
-h, --help show this help message and exit
-l {debug,info,warning,error,critical}, --log-level {debug,info,warning,error,critical}
Sets logging level to one of
debug,info,warning,error,critical.Default is logging
is disabled
-a api_host, --api-host api_host
TrueSight Pulse API host endpoint
-e e_mail, --email e_mail
e-mail that has access to the TrueSight Pulse account
-t api_token, --api-token api_token
API token for given e-mail that has access to the
TrueSight Pulse account
-n plugin_name, --plugin-name plugin_name
Plugin name
-o organization_name, --organization-name organization_name
Name of the github user or organization
-r respository_name, --repository-name respository_name
Name of the github repository
Examples
Adds a plugin from a github repository jdgwartney/boundary-plugin-disk-summary
with the name diskuse-summary
into
a TrueSight Pulse account
$ plugin-add -n diskuse-summary -o jdgwartney -r boundary-plugin-diskuse-summary
{
"result": {
"success": true
}
}
plugin-get
API Documentation
http://premium-documentation.boundary.com/v1/get/plugins/:plugin
Usage
usage: plugin-get [-h] [-l {debug,info,warning,error,critical}] [-a api_host]
[-e e_mail] [-t api_token] -n plugin_name
Get the details of a plugin in a TrueSight Pulse account
optional arguments:
-h, --help show this help message and exit
-l {debug,info,warning,error,critical}, --log-level {debug,info,warning,error,critical}
Sets logging level to one of
debug,info,warning,error,critical.Default is logging
is disabled
-a api_host, --api-host api_host
TrueSight Pulse API host endpoint
-e e_mail, --email e_mail
e-mail that has access to the TrueSight Pulse account
-t api_token, --api-token api_token
API token for given e-mail that has access to the
TrueSight Pulse account
-n plugin_name, --plugin-Name plugin_name
Plugin name
Examples
plugin-get-components
API Documentation
http://premium-documentation.boundary.com/v1/get/plugins/:plugin/components
Usage
usage: plugin-get-components [-h] [-l {debug,info,warning,error,critical}]
[-a api_host] [-e e_mail] [-t api_token] -n
plugin_name
Get the components of a plugin in a TrueSight Pulse account
optional arguments:
-h, --help show this help message and exit
-l {debug,info,warning,error,critical}, --log-level {debug,info,warning,error,critical}
Sets logging level to one of
debug,info,warning,error,critical.Default is logging
is disabled
-a api_host, --api-host api_host
TrueSight Pulse API host endpoint
-e e_mail, --email e_mail
e-mail that has access to the TrueSight Pulse account
-t api_token, --api-token api_token
API token for given e-mail that has access to the
TrueSight Pulse account
-n plugin_name, --plugin-Name plugin_name
Plugin name
Examples
Displays runtime and metadata about a plugin diskuse-summary
$ plugin-get-components -n diskuse-summary
{
"result": {
"projectId": 7053,
"pluginName": "diskuse-summary",
"metrics": [
"DISKUSE_SUMMARY"
],
"dashboards": [],
"relays": []
}
}
plugin-install
API Documentation
http://premium-documentation.boundary.com/v1/put/plugins/installed/:plugin
Usage
usage: plugin-install [-h] [-l {debug,info,warning,error,critical}]
[-a api_host] [-e e_mail] [-t api_token] -n plugin_name
Installs a plugin into a TrueSight Pulse account
optional arguments:
-h, --help show this help message and exit
-l {debug,info,warning,error,critical}, --log-level {debug,info,warning,error,critical}
Sets logging level to one of
debug,info,warning,error,critical.Default is logging
is disabled
-a api_host, --api-host api_host
TrueSight Pulse API host endpoint
-e e_mail, --email e_mail
e-mail that has access to the TrueSight Pulse account
-t api_token, --api-token api_token
API token for given e-mail that has access to the
TrueSight Pulse account
-n plugin_name, --plugin-name plugin_name
Plugin name
Examples
Installs a plugin diskuse-summary
into a TrueSight Pulse account so the plugin can be deployed to a meter
$ plugin-install -n diskuse-summary
{
"result": {}
}
plugin-installed
API Documentation
http://premium-documentation.boundary.com/v1/get/plugins/installed
Usage
usage: plugin-installed [-h] [-l {debug,info,warning,error,critical}]
[-a api_host] [-e e_mail] [-t api_token]
Gets the plugins installed into a TrueSight Pulse account
optional arguments:
-h, --help show this help message and exit
-l {debug,info,warning,error,critical}, --log-level {debug,info,warning,error,critical}
Sets logging level to one of
debug,info,warning,error,critical.Default is logging
is disabled
-a api_host, --api-host api_host
TrueSight Pulse API host endpoint
-e e_mail, --email e_mail
e-mail that has access to the TrueSight Pulse account
-t api_token, --api-token api_token
API token for given e-mail that has access to the
TrueSight Pulse account
plugin-list
API Documentation
http://premium-documentation.boundary.com/v1/get/plugins
Usage
usage: plugin-list [-h] [-l {debug,info,warning,error,critical}] [-a api_host]
[-e e_mail] [-t api_token]
Lists the plugins in a TrueSight Pulse account
optional arguments:
-h, --help show this help message and exit
-l {debug,info,warning,error,critical}, --log-level {debug,info,warning,error,critical}
Sets logging level to one of
debug,info,warning,error,critical.Default is logging
is disabled
-a api_host, --api-host api_host
TrueSight Pulse API host endpoint
-e e_mail, --email e_mail
e-mail that has access to the TrueSight Pulse account
-t api_token, --api-token api_token
API token for given e-mail that has access to the
TrueSight Pulse account
Examples
List all of the plugins in a TrueSight Pulse account
$ plugin-list
{
"result": {
"aerospike": {
"download": "https://github.com/boundary/boundary-plugin-aerospike-server/archive/e6a08431789523419714d14fda725b4578e5e41a.zip",
"repoUrl": "https://github.com/boundary/boundary-plugin-aerospike-server/tree/e6a08431789523419714d14fda725b4578e5e41a",
"name": "aerospike",
"description": "Aerospike Server",
"postExtract": "npm install",
"command": "node . --interval $(pollInterval)",
"ignore": "node_modules",
...
plugin-remove
API Documentation
http://premium-documentation.boundary.com/v1/delete/plugins/private/:plugin
Usage
usage: plugin-remove [-h] [-l {debug,info,warning,error,critical}]
[-a api_host] [-e e_mail] [-t api_token] -n plugin_name
Remove a staged pre-release meter plugin from a TrueSight Pulse account
optional arguments:
-h, --help show this help message and exit
-l {debug,info,warning,error,critical}, --log-level {debug,info,warning,error,critical}
Sets logging level to one of
debug,info,warning,error,critical.Default is logging
is disabled
-a api_host, --api-host api_host
TrueSight Pulse API host endpoint
-e e_mail, --email e_mail
e-mail that has access to the TrueSight Pulse account
-t api_token, --api-token api_token
API token for given e-mail that has access to the
TrueSight Pulse account
-n plugin_name, --plugin-name plugin_name
Plugin name
Examples
Remove a plugin named diskuse-summary
from an account
$ plugin-remove -n diskuse-summary
{
"result": {
"success": true
}
}
plugin-uninstall
API Documentation
http://premium-documentation.boundary.com/v1/delete/plugins/installed/:plugin
Usage
usage: plugin-uninstall [-h] [-l {debug,info,warning,error,critical}]
[-a api_host] [-e e_mail] [-t api_token] -n
plugin_name [-d] [-r]
Uninstalls a plugin from a TrueSight Pulse account
optional arguments:
-h, --help show this help message and exit
-l {debug,info,warning,error,critical}, --log-level {debug,info,warning,error,critical}
Sets logging level to one of
debug,info,warning,error,critical.Default is logging
is disabled
-a api_host, --api-host api_host
TrueSight Pulse API host endpoint
-e e_mail, --email e_mail
e-mail that has access to the TrueSight Pulse account
-t api_token, --api-token api_token
API token for given e-mail that has access to the
TrueSight Pulse account
-n plugin_name, --plugin-name plugin_name
Plugin name
-d, --remove-Dashes Remove dashboards associated with the plugin
-r, --remove-Metrics Remove metrics associated with the plugin
Examples
Uninstall a plugin from all meters in an account
$ plugin-uninstall -n diskuse-summary
{
"result": {
"success": true
}
}