Commands

help

Prints out a manual page in the console

Example

dbw -h

ping

Checks if a dbWatch server accepts a login.

-l -login            Username used to authenticate.
-p -password         Password used to authenticate.
-url                 The address of a dbWatch server
                         In the form of <server>:<port> or rmi://<server>:<port>
-s -server           Namespace of the target server.
                         The server connection parameters are prefixed with this value

dbw ping -url example.dbwatch.com:7099 -login myuser -password mypassword
dbw ping -server myserver

run

Runs a named task on selected instance.

-l -login            Username used to authenticate.
-p -password         Password used authenticate.
-url                 The address of a dbWatch server
                         In the form of <server>:<port> or rmi://<server>:<port>
-s -server           Namespace of the target server.
                         The server connection parameters are prefixed with this value
-f -format           The format definition.
                         The provided formats are csv and xml.
                         The user can define additional formats by placing format definitions in <user>/.dbwatch/formats.
-i -instance         Name of the selected instance
-t -task             The task.

dbw run -url example.dbwatch.com:7099 -login myuser -password mypassword -task "my task"
dbw run -server myserver  -task "my task"

dbwql

Executes a dbwql query. The query result is formatted according to the selected format.

-l -login            Username used to authenticate.
-p -password         Password used authenticate.
-url                 The address of a dbWatch server
                         In the form of <server>:<port> or rmi://<server>:<port>
-s -server           Namespace of the target server.
                         The server connection parameters are prefixed with this value
-q -query            The query to execute.
-set                 Define additional environment variables to be used in  this command.
                         The format is -set <name>=<value>
-f -format           The format definition.
                         The provided formats are csv and xml.
                         The user can define additional formats by placing formatted definitions in <user>/.dbwatch/formats.

dbw dbwql -url example.dbwatch.com:7099 -login myuser -password mypassword -query instance/name -format csv
dbw dbwql -server nyserver -query instance/name -format myformat

status

Checks the status of tasks on a given instance. Will check all tasks if no task is specified.

-l -login            Username used to authenticate.
-p -password         Password used to authenticate.
-url                 The address of a dbWatch server
                         In the form of <server>:<port> or rmi://<server>:<port>
-s -server           Namespace of the target server.
                         The server connection parameters are prefixed with this value
-f -format           The format definition.
                         The provided formats are csv and xml.
                         The user can define additional formats by placing formatted definitions in <user>/.dbwatch/formats.
-i -instance         Name of the selected instance
-t -task             The task.

dbw status -url example.dbwatch.com:7099 -login myuser -password mypassword -task "my task"
dbw status -url example.dbwatch.com:7099 -login myuser -password mypassword
dbw status -server myserver -task "my task"
dbw status -server myserver

delete

Deletes an instance (not the same as uninstall)

-l -login            Username used to authenticate.
-p -password         Password used to authenticate.
-url                 The address of a dbWatch server
                         In the form of <server>:<port> or rmi://<server>:<port>
-s -server           Namespace of the target server.
                         The server connection parameters are prefixed with this value
-i -instance         Name of the selected instance

dbw delete -url example.dbwatch.com:7099 -login myuser -password mypassword -instance MyInstanceName
dbw delete -server myserver -i MyInstanceName

map

Maps an instance to a service grouping

-l -login            Username used to authenticate.
-p -password         Password used to authenticate.
-url                 The address of a dbWatch server
                         In the form of <server>:<port> or rmi://<server>:<port>
-s -server           Namespace of the target server.
                         The server connection parameters are prefixed with this value
-i -instance         Name of the selected instance
-sg -servicegrouping Name of the selected service grouping

dbw map -url example.dbwatch.com:7099 -login myuser -password mypassword -i MyInstance -sg MyServiceGrouping

get

Gets the configuration of the selected instance or servicegrouping.

-l -login            Username used to authenticate.
-p -password         Password used to authenticate.
-url                 The address of a dbWatch server
                         In the form of <server>:<port> or rmi://<server>:<port>
-s -server           Namespace of the target server.
                         The server connection parameters are prefixed with this value
-i -instance         Name of the selected instance
-sg -servicegrouping Name of the selected service grouping

dbw get -url example.dbwatch.com:7099 -login myuser -password mypassword -instance MyInstance
dbw get -server myserver -sg clusterName

register

Registers an instance or service grouping

-l -login            Username used to authenticate.
-p -password         Password used to authenticate.
-url                 The address of a dbWatch server
                         In the form of <server>:<port> or rmi://<server>:<port>
-s -server           Namespace of the target server.
                         The server connection parameters are prefixed with this value
-cf -configfile      File containing the configuration

dbw register -url example.dbwatch.com:7099 -login myuser -password mypassword -configfile myconfig.xml
dbw register -server myserver -configfile myconfig.xml

The format of the config file argument is the same as the format returned by the get command.

File example for servicegrouping

installinstance

Installs an instance

-b -blocking         Block until call is completed (timeout after x seconds).
-l -login            Username used to authenticate.
-p -password         Password used to authenticate.
-url                 The address of a dbWatch server
                         In the form of <server>:<port> or rmi://<server>:<port>
-s -server           Namespace of the target server.
                         The server connection parameters are prefixed with this value
-cf -configfile      File containing the configuration

dbw installinstance -url example.dbwatch.com:7099 -login myuser -password mypassword -configfile myconfig.xml
dbw installinstance -server myserver -configfile myconfig.xml

For config file examples look here

update

Update property for instance. Currently only connected=true/false supported

-l -login            Username used to authenticate.
-p -password         Password used to authenticate.
-url                 The address of a dbWatch server
                         In the form of <server>:<port> or rmi://<server>:<port>
-s -server           Namespace of the target server.
                         The server connection parameters are prefixed with this value
-set                 Define additional environment variables to be used in  this command.
                         The format is -set <name>=<value>
-i -instance         Name of the selected instance

dbw update -url example.dbwatch.com:7099 -login myuser -password -i instancename -set connected=true
dbw update -server myserver -i instancename -set connected=true

installtask

Installs a task. If the task is already installed and a higher version is available, it is upgraded. If no task is specified all tasks that are marked as ‘express install’ are installed.

-b -blocking         Block until call is completed (timeout after x seconds).
-l -login            Username used to authenticate.
-p -password         Password used to authenticate.
-url                 The address of a dbWatch server
                         In the form of <server>:<port> or rmi://<server>:<port>
-s -server           Namespace of the target server.
                         The server connection parameters are prefixed with this value
-i -instance         Name of the selected instance
-t -task             The task.

dbw installtask -url example.dbwatch.com:7099 -login myuser -password mypassword -instance myInstanceName -blocking 10 -task "DBMS Uptime"
dbw installtask -server myserver -login myuser -password mypassword -instance myInstanceName -blocking 10 -task "DBMS Uptime"
dbw installtask -server myserver -login myuser -password mypassword -instance myInstanceName -blocking 10

uninstalltask

Uninstalls a task.

-b -blocking         Block until call is completed (timeout after x seconds).
-l -login            Username used to authenticate.
-p -password         Password used to authenticate.
-url                 The address of a dbWatch server
                         In the form of <server>:<port> or rmi://<server>:<port>
-s -server           Namespace of the target server.
                         The server connection parameters are prefixed with this value
-i -instance         Name of the selected instance
-t -task             The task.

dbw uninstalltask -url example.dbwatch.com:7099 -login myuser -password mypassword -instance myInstanceName -blocking 10 -task "DBMS Uptime"
dbw uninstalltask -server myserver -login myuser -password mypassword -instance myInstanceName -blocking 10 -task "DBMS Uptime"

upgradetask

Upgrades a task. If no task is specified, all upgradeable tasks for the instance are upgraded. If no instance is specified, all upgradeable tasks for all instances are upgraded.

-b -blocking         Block until call is completed (timeout after x seconds).
-l -login            Username used to authenticate.
-p -password         Password used to authenticate.
-url                 The address of a dbWatch server
                         In the form of <server>:<port> or rmi://<server>:<port>
-s -server           Namespace of the target server.
                         The server connection parameters are prefixed with this value
-i -instance         Name of the selected instance
-t -task             The task.

dbw upgradetask -url example.dbwatch.com:7099 -login myuser -password mypassword -instance myInstanceName -blocking 10 -task "DBMS Uptime"
dbw upgradetask -server myserver -login myuser -password mypassword -instance myInstanceName -blocking 10
dbw upgradetask -server myserver -login myuser -password mypassword -blocking 10

← Command Line / Install instance format →

Copyright © 2024 dbWatch AS