qube(1) :: Payara Qube Documentation

Name

qube - Payara Qube Command Line.

Synopsis

qube [-hqV] [-a=<applicationName>] [--endpoint=<baseUri>] [-n=<namespaceName>] [-o=<outputFormat>] [-s=<subscriptionName>] [COMMAND]

Description

Payara Qube Command Line Interface allows remote operations over Payara Qube’s namespaces and application via command line. In order to sign in, use the command qube login interactively. This will allow the client to obtain credentials that are either stored in home directory or can be provided via environment variable QUBE_AUTH_TOKEN. See qube login --help for details.

Options

-a, --application=<applicationName>: Name of application to manage.

Not required for commands listed by -n option, as well as list-applications and upload.
--endpoint=<baseUri>: Management endpoint. Defaults to https://manage.payara.cloud. Set it to management endpoint of your Payara Qube instance if that’s your target. Also settable with environment variable QUBE_ENDPOINT
-h, --help: Show this help message and exit.
-n, --namespace=<namespaceName>: Name of namespace to manage.

Required for all commands except login, list-namespaces and create-namespace.
-o, --output=<outputFormat>: Set the output format. Allowed values: TEXT, JSON.
-q, --quiet: Enable quiet output.

Only result of operations will be displayed to stdout, or error message to stderr.
-s, --subscription=<subscriptionName>: Specify the name of the subscription to use. This is only necessary when your account has access to multiple subscriptions.
-V, --version: Print version information and exit.

Commands

login: Log in to Payara Qube instance.
list-subscriptions: Get list of subscriptions available to user.
list-namespaces: List namespaces available in a subscription.
list-applications: List applications present in a namespace.
upload: Upload an application binary (.war file) to Payara Qube.
deploy: Deploy an existing application.
start: Start an application
stop: Stop an application
create-namespace: Create new namespace
delete-namespace: Deletes a namespace.
delete-application: Delete an application.
configure: Change configuration of an application
scale: Scale an application