Difference between revisions of "Cloudpulseclient"
(Created page with "<big><big><big><big>CloudPulseClient - Command Line Client for Cloudpulse </big></big></big></big> === Introduction ===") |
|||
(2 intermediate revisions by the same user not shown) | |||
Line 1: | Line 1: | ||
<big><big><big><big>CloudPulseClient - Command Line Client for Cloudpulse </big></big></big></big> | <big><big><big><big>CloudPulseClient - Command Line Client for Cloudpulse </big></big></big></big> | ||
=== Introduction === | === Introduction === | ||
+ | The Cloudpulseclient is the command-line interface (CLI) for the OpenStack cloudpulse service. | ||
+ | |||
+ | === Cloudpulseclient usage === | ||
+ | |||
+ | To get help on any subcommand enter: | ||
+ | <div class="highlight-console"><div class="highlight"><pre>$ cloudpulse help SUBCOMMAND</pre></div></div> | ||
+ | |||
+ | ==== cloudpulseclient usage ==== | ||
+ | cloudpulse client usage | ||
+ | |||
+ | <div class="highlight-console"><div class="highlight"><pre> | ||
+ | usage: cloudpulse [--version] [--debug] [--os-cache] | ||
+ | [--os-region-name <region-name>] | ||
+ | [--os-tenant-id <auth-tenant-id>] | ||
+ | [--service-type <service-type>] | ||
+ | [--endpoint-type <endpoint-type>] | ||
+ | [--cloudpulse-api-version <cloudpulse-api-ver>] | ||
+ | [--os-cacert <ca-certificate>] [--insecure] | ||
+ | [--bypass-url <bypass-url>] [--os-auth-system <auth-system>] | ||
+ | [--os-username <username>] [--os-password <password>] | ||
+ | [--os-tenant-name <tenant-name>] [--os-token <token>] | ||
+ | [--os-auth-url <auth-url>] | ||
+ | <subcommand> ... | ||
+ | </pre></div></div> | ||
+ | |||
+ | ==== Subcommands ==== | ||
+ | Subcommands: | ||
+ | |||
+ | * '''result''' - List all the tests results | ||
+ | * '''run''' - Run new test | ||
+ | * '''show''' - Show the detailed results of the test | ||
+ | * '''delete''' - Delete a test | ||
+ | * '''help''' - Display help about this program or one of its subcommands | ||
+ | * '''bash-completion''' - Prints all of the commands and options to stdout so that the cloudpulse.bash_completion script doesn’t have to hard code them. | ||
+ | |||
+ | ==== Optional Arguments ==== | ||
+ | --version show program's version number and exit | ||
+ | --debug Print debugging output. | ||
+ | --os-cache Use the auth token cache. Defaults to False if | ||
+ | env[OS_CACHE] is not set. | ||
+ | --os-region-name <region-name> | ||
+ | Region name. Default=env[OS_REGION_NAME]. | ||
+ | --os-tenant-id <auth-tenant-id> | ||
+ | Defaults to env[OS_TENANT_ID]. | ||
+ | --service-type <service-type> | ||
+ | Defaults to container for all actions. | ||
+ | --endpoint-type <endpoint-type> | ||
+ | Defaults to env[CLOUDPULSE_ENDPOINT_TYPE] or publicURL. | ||
+ | --cloudpulse-api-version <cloudpulse-api-ver> | ||
+ | Accepts "api", defaults to | ||
+ | env[CLOUDPULSE_API_VERSION]. | ||
+ | --os-cacert <ca-certificate> | ||
+ | Specify a CA bundle file to use in verifying a TLS | ||
+ | (https) server certificate. Defaults to | ||
+ | env[OS_CACERT]. | ||
+ | --insecure Insecure connection to cloudpulse url. | ||
+ | --bypass-url <bypass-url> | ||
+ | Use this API endpoint instead of the Service Catalog. | ||
+ | |||
+ | |||
+ | ==== ''cloudpulse result'' ==== | ||
+ | <div class="highlight-console"><div class="highlight"><pre> | ||
+ | usage: cloudpulse result [--failed] [--period <period>] | ||
+ | </pre></div></div> | ||
+ | List all the tests | ||
+ | |||
+ | Optional arguments: | ||
+ | <p> --failed Display only failed tests.</p> | ||
+ | <p> --period <period> List all tests in the last x minutes.</p> | ||
+ | |||
+ | ==== ''cloudpulse run'' ==== | ||
+ | <div class="highlight-console"><div class="highlight"><pre> | ||
+ | usage: cloudpulse run <name> | ||
+ | </pre></div></div> | ||
+ | |||
+ | Run new test | ||
+ | |||
+ | Positional arguments: | ||
+ | <p> <name> Name of the healthcheck to run</p> | ||
+ | |||
+ | ==== ''cloudpulse show'' ==== | ||
+ | <div class="highlight-console"><div class="highlight"><pre> | ||
+ | usage: cloudpulse show <cpulse> [<cpulse> ...] | ||
+ | </pre></div></div> | ||
+ | |||
+ | Show the results of the test | ||
+ | |||
+ | Positional arguments: | ||
+ | <p> <cpulse> ID or name of the (cpulse)s to show.</p> | ||
+ | |||
+ | ==== ''cloudpulse delete'' ==== | ||
+ | <div class="highlight-console"><div class="highlight"><pre> | ||
+ | usage: cloudpulse delete <cpulse> [<cpulse> ...] | ||
+ | </pre></div></div> | ||
+ | |||
+ | Delete the test | ||
+ | |||
+ | Positional arguments: | ||
+ | <p> <cpulse> ID or name of the (cpulse)s to delete.</p> |
Latest revision as of 20:34, 28 March 2016
CloudPulseClient - Command Line Client for Cloudpulse
Contents
Introduction
The Cloudpulseclient is the command-line interface (CLI) for the OpenStack cloudpulse service.
Cloudpulseclient usage
To get help on any subcommand enter:
$ cloudpulse help SUBCOMMAND
cloudpulseclient usage
cloudpulse client usage
usage: cloudpulse [--version] [--debug] [--os-cache]
[--os-region-name <region-name>]
[--os-tenant-id <auth-tenant-id>]
[--service-type <service-type>]
[--endpoint-type <endpoint-type>]
[--cloudpulse-api-version <cloudpulse-api-ver>]
[--os-cacert <ca-certificate>] [--insecure]
[--bypass-url <bypass-url>] [--os-auth-system <auth-system>]
[--os-username <username>] [--os-password <password>]
[--os-tenant-name <tenant-name>] [--os-token <token>]
[--os-auth-url <auth-url>]
<subcommand> ...
Subcommands
Subcommands:
- result - List all the tests results
- run - Run new test
- show - Show the detailed results of the test
- delete - Delete a test
- help - Display help about this program or one of its subcommands
- bash-completion - Prints all of the commands and options to stdout so that the cloudpulse.bash_completion script doesn’t have to hard code them.
Optional Arguments
--version show program's version number and exit --debug Print debugging output. --os-cache Use the auth token cache. Defaults to False if env[OS_CACHE] is not set. --os-region-name <region-name> Region name. Default=env[OS_REGION_NAME]. --os-tenant-id <auth-tenant-id> Defaults to env[OS_TENANT_ID]. --service-type <service-type> Defaults to container for all actions. --endpoint-type <endpoint-type> Defaults to env[CLOUDPULSE_ENDPOINT_TYPE] or publicURL. --cloudpulse-api-version <cloudpulse-api-ver> Accepts "api", defaults to env[CLOUDPULSE_API_VERSION]. --os-cacert <ca-certificate> Specify a CA bundle file to use in verifying a TLS (https) server certificate. Defaults to env[OS_CACERT]. --insecure Insecure connection to cloudpulse url. --bypass-url <bypass-url> Use this API endpoint instead of the Service Catalog.
cloudpulse result
usage: cloudpulse result [--failed] [--period <period>]
List all the tests
Optional arguments:
--failed Display only failed tests.
--period <period> List all tests in the last x minutes.
cloudpulse run
usage: cloudpulse run <name>
Run new test
Positional arguments:
<name> Name of the healthcheck to run
cloudpulse show
usage: cloudpulse show <cpulse> [<cpulse> ...]
Show the results of the test
Positional arguments:
<cpulse> ID or name of the (cpulse)s to show.
cloudpulse delete
usage: cloudpulse delete <cpulse> [<cpulse> ...]
Delete the test
Positional arguments:
<cpulse> ID or name of the (cpulse)s to delete.