Search Results

TIBCO® Cloud - Command Line Interface Reference

You can interact with TIBCO Cloud Integration by using the TIBCO Cloud - Command Line Interface (CLI). The executable is downloaded to your machine and will have the name tibcli (for Linux and Mac OS X) or tibcli.exe (for Windows). The TIBCO Cloud CLI does not contain a shell-like interface. Instead, the TIBCO Cloud CLI commands are invoked by calling the executable with a different set of arguments.

All commands assume the tibcli executable is in the current path. For more information, see Installing the TIBCO® Cloud - Command Line Interface.

TIBCO Cloud CLI Usage

tibcli [global options...] command [command options] [arguments...]

Global Options

Option Description
--debug, -d Enable debug logging
--help, -h Display Help
--version, -v Display the app version

Commands

login

Log in the user to the TIBCO® Cloud Integration server. A successful login will store cookies at files $HOME/.tibcli/session and $HOME/.tibcli/token. The files are accessible only by the user and obfuscated to be consumed only by the TIBCO Cloud CLI. All other TIBCO Cloud CLI commands will depend on a successful login.

Usage

tibcli login [command options]

Options

Argument Description
-p password The password. If the password is not specified as part of the -p option then you will be prompted to type it in. The -p argument is optional, but if you specify it, the password argument is mandatory.

Example

Log in:

tibcli login 

logout

Log out the user from the Cloud Integration server. This erases the stored cookie files cookie files session and token in the $HOME/.ticli/ folder.

Usage

tibcli logout

Example

Log out the current user:

tibcli logout

app

Manage app-related operations for the current user. This includes operations such as push and move.

Note that in Cloud Integration 1.3, syntax for commands was changed with the addition of the app command.

TIBCO Cloud CLI 1.2.0 usage:

tibcli push [command options] [<desired instances count>] [<appName>] [property=overrideValue] ... (one or more pairs of app property values)

TIBCO Cloud CLI 1.3.0 and later usage:

tibcli app push [command options] [<desired instances count>] [<appName>] [property=overrideValue] ... (one or more pairs of app property values)

Commands

app push

Push the app in the current directory to the Cloud Integration server.

This command must be executed from a directory containing the app binary file and a manifest.json file. The binary file type depends on the app type. For example, in the case of BusinessWorks, it is an EAR file. For Node.js, it is a ZIP archive.

When an app doesn’t exist in Cloud Integration, this command will create the app for the first time. When an app already exists, it will upgrade the app.

If an app is re-pushed, any existing property overrides are removed along with any existing properties. Properties defined in the new manifest become the new set of properties and any overrides specified on the re-push become the new set of override values. If no overrides are supplied then all properties assume their default value.

Note: The bash shell interprets $, ` (back tick), \, !, and # on the command line even when enclosed in double quotes. You need to use single quotes to prevent this, or use a properties file.

Usage

tibcli app push [command options] [<instanceCount>] [<appName>] [property=value] ... (one or more pairs of app property values)

Arguments

Argument Description
instanceCount The desired number of instances of the app. If not specified, instancecount defaults to 1 or the most recent instance count for a re-push.
property=value One or more properties to override (optional). The property is specified with the syntax name=value. If values contain spaces, the value must be contained in quotes.
appName The name of the app to push (optional). This overrides the app name in the manifest.

Options

Option Description
--sandbox, -s <sandbox> The name of the sandbox where the app will be pushed. By default it is the user default sandbox.
--quiet, -q Do not produce any output, and immediately return without status updates. The action will be completed on the server side.
--propfile, -p Applies property overrides defined in a specified file. The name of the property file can be any valid filename. See the configure command options for details on file format.

Examples

Push one instance of the app in the current directory:

tibcli app push 1

Push one instance of the app in the current directory. Override prop1 and prop2 with the values "newval" and "newval2":

tibcli app push 1 prop1="newval" prop1="newval2"

app list

List the apps associated with the current user.

Usage

tibcli app list [command options]

Options

Option Description
--sandbox, -s <sandbox> The name of the sandbox from which to list apps. By default it is the user default sandbox.
--all, -a List apps in all sandboxes for the current user.

Example

List the apps for the current user:

tibcli app list

app scaleup

Increase the number of instances of the specified app.

Usage

tibcli app scaleup [command options] <numberOfInstances> <appName>

Arguments

Argument Description
numberOfInstances The number of instances to add.
appName The name of the app to scale up.

Options

Option Description
--sandbox, -s <sandbox> The name of the sandbox containing the app to scale. By default it is the user default sandbox.
--quiet, -q Do not produce any output, and immediately return without status updates. The action will be completed on the server side.

Example

Scale up the app myApp1 by adding three instances:

tibcli app scaleup 3 myApp1 

app scaledown

Decrease the number of instances of the specified app.

Usage

tibcli app scaledown [command options] <numberOfInstances> <appName>

Arguments

Argument Description
numberOfInstances The number of instances to delete.
appName The name of the app to scale down.

Options

Option Description
--sandbox, -s <sandbox> The name of the sandbox containing the app to scale. By default it is the user default sandbox.
--quiet, -q Do not produce any output, and immediately return without status updates. The action will be completed on the server side.

Example

Scale down the app myApp1 by one instance:

tibcli app scaledown 1 myApp1 

app scaleto

Set the final instance count of the specified app.

Usage

tibcli app scaleto [command options] <numberOfInstances> <appName>

Arguments

Argument Description
numberOfInstances The number of instances to set.
appName The name of the app to scale.

Options

Option Description
--sandbox, -s <sandbox> The name of the sandbox containing the app to scale. By default it is the user default sandbox.
--quiet, -q Do not produce any output, and immediately return without status updates. The action will be completed on the server side.

Example

Scale the app myApp1 to three instances:

tibcli app scaleto 3 myApp1 

app configure

Configure an integration or Node.js app by specifying one or more property and value pairs to override default property values that were specified in the manifest.json file. The app will be restarted after configuration. You can also use this command to view the configuration of the specified app.

You can use the -p option to get values from an optional property file. The property file format corresponds to the Java property file definition, as specified in https://docs.oracle.com/javase/6/docs/api/java/util/Properties.html#load(java.io.Reader).

Property overrides added with the TIBCO Cloud CLI are additive. After the tibcli configure command completes, property updates are merged into the existing set, either changing an existing override, adding a new override or reverting an override to its default value by providing an override consisting of the default value.

Property overrides only support the datatypes of string, boolean, password, integer and datetime. In particular, the datetime string must take the UTC format, such as 2016-04-12T19:51:39-04:00.

You can set password properties by using the BusinessWorks obfuscated format. For password properties, values are not shown when viewing app properties. Values will be displayed as ******.

The -l option will only list the current configuration, without making changes.

You will be prompted to verify if the app will be reconfigured. If you confirm, the overrides will be applied and the app will be restarted. The verification can be skipped with the -f option.

Note: the bash shell interprets $, ` (back tick), \, !, and # on the command line even when enclosed in double quotes. You need to use single quotes to prevent this, or use a properties file.

Usage

tibcli app configure [command options] <appName> [property=value] ... (one or more pairs of app property values)

Arguments

Argument Description
appName The name of the app to configure.
property=value One or more properties to override. The property is specified with the syntax name=value.

Options

Option Description
--force, -f Force the configuration without confirmation.
--list, -l Show the current configuration of an app, including default and overridden properties.
--profile, -p Applies property overrides defined in a specified file. The name of the property file can be any valid filename.
--quiet, -q Do not produce any output, and immediately return without status updates. The action will be completed on the server side.

Examples

View the configuration for the app myApp1:

tibcli app configure -l myApp1

Change the configuration for the app myApp1 by overriding prop1 and prop2 with the values "newval" and "newval2" and restart the app:

tibcli app configure myApp1 prop1="newval" prop2="newval2" 

Change the configuration for the app myApp1 by overriding prop1 and prop2 with the values "newval" and "newval2" as specified in a file.properties file and restart the app:

tibcli app configure -p file.properties myApp1

Where file.properties is the following:

prop1="newval"
prop2="newval2"

app delete

Delete the specified app.

*Usage

tibcli app delete [command options] <appName>

Arguments

Argument Description
appName The name of the app to delete.

Options

Option Description
--sandbox, -s <sandbox> The name of the sandbox containing the app to delete. By default it is the user default sandbox.
--force, -f Force delete the app.
--quiet, -q Do not produce any output, and immediately return without status updates. The action will be completed on the server side.

Example

Delete the app myApp1:

tibcli app delete myApp1	

app move

Move an app from one sandbox to another.

After an app is moved to a different sandbox, the app endpoint does not change. The number of instances remain unchanged.

Usage

tibcli app move <sandboxName> <appName> <targetSandboxName>

Arguments

Argument Description
sandboxName The sandbox where the app to be moved is currently deployed.
appName The name of the app to move.
targetSandboxName The destination sandbox for the app to be moved.

Example

Move the app myApp1 from myTestBox to myDevBox:

tibcli app move myTestBox myApp1 myDevBox

app status

Show the status of any operations in progress for specified app. This outputs the same status information normally shown during an app operation such as push which was hidden with the --quiet option.

Arguments

Argument Description
appName The name of the app.

Options

Option Description
--sandbox, -s <sandbox> The name of the sandbox from which to list apps. By default it is the user default sandbox.
--all, -a List apps in all sandboxes for the current user.

Example

Show the status of the app myApp1:

tibcli app status myApp1 

sandbox

Manage sandbox-related operations for the current user.

Commands

sandbox create

Create a new sandbox working environment.

Note: sandbox names must start with a letter or underscore and can include letters, digits, periods, underscores, and dashes.

Usage

tibcli sandbox create [command options] <sandboxName>

Arguments

Argument Description
sandboxName The name of the sandbox.

Options

Option Description
--desc, -ds The description for the sandbox.
--disp, -dp The display name for the sandbox.

Example

Create a sandbox named myTest with a description and display name:

sandbox create --desc "My test sandbox" --disp "Joe test sandbox" myTest

sandbox list

List information for one or more sandboxes for the current user.

Usage

tibcli sandbox list [<sandboxName>]

Arguments

Argument Description
sandboxName The name of the sandbox. In the absence of specific sandbox name as input, information about all sandboxes will be displayed.

Example

List information for the sandbox named myTest:

tibcli sandbox list myTest

sandbox update

Update one or more attributes of the sandbox for the current user.

Usage

tibcli sandbox update [command options] <sandboxName>

Arguments

Argument Description
sandboxName The name of the sandbox.

Options

Option Description
--newName, -nm The new name for the sandbox.
--newDesc, -ds The new description for the sandbox.
--newDisp, -dp The new display name for the sandbox.

Example

Change the name, description, and display name of sandbox myTest:

sandbox update --newName myTest2 --newDesc "My second test sandbox" --newDisp "Joe test sandbox 2" myTest

sandbox delete

Delete the sandbox only when there are no apps in the sandbox.

Usage

tibcli sandbox delete [command options] <sandboxName>

Arguments

Argument Description
sandboxName The name of the sandbox.

Options

Option Description
--force, -f Force delete the sandbox only when there are no apps in the sandbox.
--quiet, -q Delete the sandbox without monitoring the status progress.

Examples

Delete the empty sandbox myTest2:

tibcli sandbox delete myTest2

monitor

Manage monitoring aspects of operations.

Commands

*monitor applog

monitor applog

Shows or downloads app logs.

In the absence of any option flags, only the last hour of app logs will be available.

Usage

tibcli monitor applog [command options] <appName> 

Arguments

Argument Description
appName The name of the app whose logs are being requested.

Options

Option Description
--beginTime, -b <date/time> The start of the time slot within which the logs are to be collected in the date/time formats (described below)
--endTime, -e <date/time> The end of the time slot within which the logs are to be collected in the date/time formats (described below)
--interval, -n <interval> Choose from one of the predefined time slot intervals: [1m, 5m, 30m, 1h, 12h, 1d, 7d, 30d, 1y]
--stream, -s Display the last five minutes of app logs, then retrieve app logs continuously in real-time similar to tail -f

Note: In the absence of any optional flags, the last hour of app logs (or last five minutes for streaming) will be available.

Valid Date/Time Formats

Format Description
yyyy-mm-ddTHH:MM RFC3339 Compliant format.
yyyy-mm-dd Date-Only format, 12:00AM will assumed as the time component for complete time stamp.
HH:MM Time-Only format, current date will be assumed as the date component for complete time stamp.

Examples

View the last hour of app logs for myApp1:

tibcli monitor applog myApp1

Download the last hour of app logs for myApp1:

tibcli monitor applog myApp1 > myApp1.log

View the logs for myApp1 for the last twelve hours:

tibcli monitor applog --interval 12h myApp1

View the logs for myApp1 from midnight, January 20th to midnight, January 30th:

tibcli monitor applog --beginTime 2016-01-20 --endTime 2016-01-30 myApp1

Stream the logs continually for myApp1:

tibcli monitor applog --stream myApp1

eula

Displays the Cloud Integration End User License Agreement.

Usage

tibcli eula

Example

Output the EULA and save to a file named eula.txt:

tibcli eula > eula.txt