Contents

  • appadd
  • appls
  • apprm
  • appsnap
  • appstart
  • appstop
  • appsupport
  • dbbackup
  • manage
  • upgrade

    • Use these commands to perform maintenance tasks on your managed instance. Except where noted, you'll find these in /usr/local/jive/bin.

    Note: Execute these commands as the jive user. For example, if you've got ssh access as root to your host machine, you can use the following command to switch to the jive user: 
    sudo su - jive

    appadd

    Jive Application Addition tool (appadd). Adds a new application configuration and configuration to the standard locations. Optional parameters may be overridden for hosting multiple instances on a physical host however such configurations are not recommended.

    appadd [options] name
    Short Long Description
      --version Show program's version number and exit.
     -h --help Show help message and exit.
    HTTPD Options. Configures the HTTPD integration configuration options.
    Short Long Description
      --httpd-addr HTTPD listen address [default 0.0.0.0]
      --vhost Create a virtual host for HTTPD integration as opposed to proxy directives (default is to create proxy directives only). Default: False
      --dedicated-httpd-enable Enable Dedicated HTTPD Server.
      --dedicated-httpd-port=PORT Port to use for dedicated httpd server.
    Application Options. Configures general application server options.
    Short Long Description
    -s PORT --server-port=PORT Application server management port [default 9000]
    -j OPT --java-options=OPTS Additional JRE options to use with the Java runtime. 
      --custom-option=OPTS Additional application option to use with the Java runtime.
    -c PORT --cluster-port=PORT Multicast cluster port [default 9003]
     -m ADDR --cluster-addr=ADDR Multicast cluster address [224.224.224.224]
      --cluster-jvm-route=ROUTE Cluster JVM Route setting for Apache-based load balancing.
      --cluster-local-port-enable Enable local multicast cluster port [optional].
      --cluster-local-port=PORT Local multicast cluster port [default 9005]
      --cluster-local-addr=ADDR Local multicast address [optional].
      --snmp-enable Enabled SNMP monitoring [optional]
      --snmp-port=PORT SNMP port [optional] [default 10161]
    HTTP Options. Configures application server HTTP options.
    Short Long Description
    -z --http-port Application server http port [default 9001]
      --http-addr=ADDR Application server http listen address [default 127.0.0.1]
    AJP Options. Configures application server AJP options.
    Short Long Description
    -a PORT --ajp-port=PORT Application server ajp port [default 9002]
      --ajp-addr=ADDR Application server ajp listen address [default 127.0.0.1]
    -t THREADS --ajp-threads=THREADS Maximum number of application server AJP worker threads [default 50]
    -b BYTES --ajp-buffer=BYTES Size in bytes for AJP connection buffers [default 4096]
    Application Options. Configures application options.
    Short Long Description
    -p PATH --context-path=PATH Application context [default \'/\']
      --app-cache-size=BYTES Static cache size in bytes [default 10240 (10M)]
      --app-cache-ttl=MS Static cache TTL in ms [default 10000 (10 minutes)
    General Options. General configuration not specific to any subsystem. Most should only be used for testing.
    Short Long Description
    -v --verbose Be verbose about what actions are being taken. Default: False
    -d --debug Show debug information. Default: False
      --source=SOURCE Use the given application template path and not the default in JIVE_HOME. Default: None
      --destination-DEST Output the application to the given path and not the default in JIVE_HOME. Default: None
      --overwrite Overwrite any existing application artifacts. Default: False
      --force Ignore any warnings and proceed, potentially causing conflicts with other applications. Default: False
      --no-link Use copies instead of symlinks when creating the application [default is to link]
      --auto-port Automatically determine ports to use.

    appls

    appls [options]

    Lists information about platform-managed applications.

    Short Long Description
      --version Show program's version number and exit.
     -h --help Show help message and exit.
    -f --failed Show only failed application instances. Default: False
    -r --running Show only running application instances. Default: False
    -s --stopped Show only stopped application instances. Default: False
    -q --quiet Remove unnecessary text for combination with other utilities. Default: False
    -b --brief Remove even more unnecessary text for combination with other utilities.
    -n --name-only Show only names meeting filter criteria. Default: False
    -v --verbose Be verbose about what actions are being taken. Default: False
    -d --debug Show debug information. Default: False

    apprm

    Jive application removal tool (apprm). Stops and removes a managed application given a valid application name.

    apprm [options] name
    Short Long Description
    -h --help Show help message and exit.
      --version Show program's version number and exit.
    -s --no-stop Do not stop the application before removing. Default: True
    -v --verbose Be verbose about what actions are being taken. Default: False
    -d --debug Show debug information. Default: False

    appsnap

    Jive Application Snapshot tool (appsnap). Passively gathers information about a running system and applications.

    appsnap [options] [name]
    Short Long Description
      --version Show program's version number and exit.
     -h --help Show help message and exit.
    Snapshot Options. Defines the interval and count of snapshots taken, system or application.
    Short Long Description
      --no-sys Do not gather top-level system information. Default: True
    -c COUNT --count=COUNT Sample count to take [default 1]
    -i INTERVAL --interval=INTERVAL Time between samples [default 1]
      --jstack=PATH Use the given path to the jstack binaries for sampling applications. Default: None
      --jstack-opts=OPTS Pass the given options to jstack binary for sampling detail. Default: None
      --force=FORCE Force Java thread dump. This may be fatal to the process resulting in failure if the dump is successful.
    -o OUTPUT --out=OUTPUT Append output to the given file creating if the file does not exist [default STDOUT]
    General Options. General configuration not specific to any subsystem. Most should only be used for testing.
    Short Long Description
    -v -verbose Be verbose about what actions are being taken. Default: False
    -d -debug Show debug information. Default: False

    appstart

    Jive Application Start tool (appstart). Starts a template-configured application by name. If no name is given, all configured applications are started.

    appstart [options] name
    Short Long Description
      --version Show program's version number and exit.
     -h --help Show help message and exit.
    -v --verbose Be verbose about what actions are being taken. Default: False
    -d --debug Show debug information. Default: False

    appstop

    Jive Application Stop tool (appstop). Stops a template-configured application by name. If no name is given all configured applications are stopped.

    appstop [options] name
    Short Long Description
      --version Show program's version number and exit.
     -h --help Show help message and exit.
    -r --retain Retain work directory for the application (default false)
    -v --verbose Be verbose about what actions are being taken. Default: False
    -d --debug Show debug information. Default: False

    appsupport

    Jive Application Support tool (appsupport). Passively gathers information about a running system for communicating with Jive support.)

    appsupport [options]
    Short Long Description
      --version Show program's version number and exit.
     -h --help Show help message and exit.
    System Options. Fine tune the system information captured by the support dump. By default, all data is captured.
    Short Long Description
    -m --no-mem Do not gather memory information. Default: True
    -c --no-cpu Do not gather CPU information. Default: True
    -u --no-uptime Do not gather uptime information. Default: True
    -s --no-os Do not gather operating system information. Default: True
    -z --no-limits Do not gather ulimit information. Default: True
    -x --no-sysctl Do not gather sysctl information. Default: True
    -n --no-network Do not gather network information. Default: True
    -f --no-firewall Do not gather firewall information. Default: True
    -l --no-logs Do not gather system log information. Default: True
    Jive Options. Fine tune the jive-specific information captured by the support dump. By default, all data is captured.
    Short Long Description
    -e --no-jive-config Do not gather Jive-specific configuration information.
    -a --no-jive-apps Do not gather jive application data.
    -j --no-jive-logs Do not gather jive-specific logs.
    -i --no-httpd-logs Do not gather Jive HTTPD logs.
    -p --no-db-logs Do not gather local system database logs.
    -t BYTES --limit-logs=BYTES Limit log captures to a given number of bytes [default no limit]
    General Options. General configuration not specific to any subsystem. Most should only be used for testing.
    Short Long Description
    -o OUTPUT --out=OUTPUT Append output to the given file creating if the file does not exist [default STDOUT]
      --no-time Do not add timestamps to output. Default: True
    -v --verbose Be verbose about what actions are being taken. Default: False
    -d --debug Show debug information. Default: False

    dbbackup

    Backs up the application database. To create a full backup, omit the options. For more on backups, see the Operations Cookbook.

    dbbackup [options]
    Short Long Description
    -s SEGMENT_FILE   Database segment to archive.
    -d DATA_PATH   Path to the data source.
    -p DESTINATION_PATH   Path to which the archive should be written.

    manage

    Starts, stops, or restarts the application. Also checks the status of the application.

    This command operates on the application it is installed with (app_name).

    Location: /usr/local/jive/applications/<app_name>/bin

    upgrade [start | stop | restart | status]

    upgrade

    Jive platform upgrade tool. Used to detect if an upgrade is in progress and which behaviors need to be executed, optionally executing them depending on command options. When invoked with no options, returns 0 if an upgrade is in progress, 1 otherwise.

    upgrade [options]
    Short Long Description
      --version Show program's version number and exit.
     -h --help Show help message and exit.
    Upgrade Options. Configures upgrade behaviors.
    Short Long Description
    -x --dry-run Show upgrade tasks that would be performed. Default: False
    -e --execute Perform any pending platform upgrade tasks. Default: False
    -r --reset Mark all unperformed upgrade tasks as complete and exit. Default: False
    -f PATH --database-file=PATH Use alternate upgrade database file. Default: None
    General Options. General configuration not specific to any subsystem. Most should only be used for testing.
    Short Long Description
    -v -verbose Be verbose about what actions are being taken. Default: False
    -d -debug Show debug information. Default: False