rmtadmin Command Line Utility

Resource Monitoring Tool includes a command line interface, rmtadmin.cmd, located in the installation folder. The default installation folder is:

  • RMT Server %PROGRAMFILES%\Tableau\Tableau Resource Monitoring Tool\Master
  • Agent: %PROGRAMFILES%\Tableau\Tableau Resource Monitoring Tool\agent

Note: You must run the command prompt as an Administrator for these commands to run successfully.

rmtadmin is included in both the RMT Server and Agent installations. Some commands may vary based on whether you are using the RMT Server or Agent rmtadmin command line utility. E.g. the users command only works from the RMT Server. The ziplogs command is available everywhere but only includes the log files from the application the command is run on.

Here are the commands that can be used with the rmtadmin command line:

Note: The rmtadmin commands use both positional parameters and options.
The positional parameters should be specified using only the values. You don't need to specify the actual keyword. The option keyword and the value should be specified using an equals sign.
Example:
rmtadmin <command> <positional parameter value> --<option keyword>=<value>

In an effort to align with our company values of Equality, we have changed non-inclusive terminology where possible. Because changing terms in certain places can cause a breaking change, we maintain the existing terminology. So, you may continue to see the terms in CLI commands and options, installation folders, configuration files and other instances. For more information, see About Tableau Help.

rmtadmin agents

Note: Added in version 2021.2

Lists all the registered Agents on Tableau Server nodes for all environments.

This is useful to see where the Resource Monitoring Tool Agent is installed on Tableau Server.

This command only works on the RMT Server.

Synopsis

rmtadmin agents [options][global option]

Options

--env

Optional: Use this option to see the list of Agents for the specific environment.

--keys

Optional: includes the agent key in the output.

Example: rmtadmin agents --env=<myenvironment> --keys

rmtadmin bootstrap-file

Note: Added in version 2021.2

Creates and saves the bootstrap file used to register Agents on Tableau Server nodes.

Bootstrap file will be created and saved to the specified absolute path or relative path. Relative paths are resolved to the current working directory.

This command only works on the RMT Server.

Synopsis

rmtadmin bootstrap-file [options][global option]

Options

--env

Required. Name of the environment that will be monitoring this Tableau Server. The Agent on a Tableau Server node can only be registered to one environment at a time.

--filename

Optional. The absolute or relative path including the file name. The relative paths are resolved to the current working directory. If not specified, the default output filename is used.

--force

Optional. Overwrites the existing file with the same name.

Example: rmtadmin bootstrap-file --env=<myenvironment>

rmtadmin cleanup

Note: Added in version 2021.2

Deletes the log files that are older than a certain number of days. By default it deletes log files older than 31 days.

This command works on both the RMT Server and Agent.

Note: If the Resource Monitoring Tool processes are running, the active log files will not be cleaned up by the command. If you want to be sure that all files are deleted, you will need to stop RMT using the rmtadmin_stop command and then run cleanup using the following command, rmtadmin cleanup --log-files-retention=0, and then restart the processes using the rmtadmin_start command.

Synopsis

rmtadmin cleanup [option][global option]

Option

--log-fles-retention

Optional. Deletes the log files older than the specified number of days.

Example: rmtadmin cleanup --log-files-retention=<number of days>

rmtadmin create-env

Note: Added in version 2021.2

Creates a new environment.

This command only works on the RMT Server.

Synopsis

rmtadmin create-env [options][global option]

Options

Option Required? Default Description
--name Yes n/a The name of the environment.
--gateway-url

Yes

 

n/a

URL used to access the Tableau Server gateway.

--version Yes n/a Tableau Server version that this environment will be monitoring.
--non-interactive

No

Interactive prompts are enabled by default. Disables all interactive prompts.
--no-test

No

API and Repository connection testing is enabled by default. Disables testing API and repository connections.
--id No System generated based on the name of the environment. Identifier of the environment used in web interface URLs.
--api-username No Null Username of the account used to connect to Tableau Server APIs. The user account should be a Tableau Server administrator with access to all Tableau Server sites.
--api-password

No

(If you specify the Tableau API username, you will either provide the password or specify the file path and file that has the password)

Null

Password of the Tableau Server API user account used to connect to Tableau Server APIs.

--api-password-file No Null The path to the file and the name of the file containing the password of the Tableau Server API user account.
--repository-server No

Null

This is the server name for the PostgreSQL database that is installed with Tableau Server
--repository-port No Null The port number of the Tableau Server Repository database.
--repository-username No Null

Username used to connect to PostgreSQL database installed with the Tableau Server Repository.

Resource Monitoring Tool accesses the Tableau Server Repository database directly for performance reasons. For this to work, access to the repository must be enabled, with a password set for the readonly database user. For details, see Enable access to the Tableau Server repository.

--repository-password No Null

Password for the user account used to connect to the PostgreSQL database that is installed with the Tableau Server.

Resource Monitoring Tool accesses the Tableau Server Repository database directly for performance reasons. For this to work, access to the repository must be enabled, with a password set for the readonly database user. For details, see Enable access to the Tableau Server repository.

--repository-password-file No Null The path including the file name where the password for the user account used to connect to the PostgreSQL database that is installed with Tableau Server.
--repository-ssl-mode

No

Prefer

Tableau Server Repository SSL Mode:

Prefer SSL or Require SSL to configure SSL connections to Tableau Repository.

Disable to never use SSL to make Tableau Server Repository connections.

--repository-ssl-thumbprint

No

Null You can choose to either supply the thumbprint that was generated by Tableau Server or copy the server.crt file to the Resource Monitoring Tool Server machine. If you choose to copy the certificate file, you don't have to supply the thumbprint. For more information, see Configure Postgres SSL to Allow Direct Connections from Clients.

Example: rmtadmin create-env --name=<myenvironment> --api-username=<TableauServer API user name> --api-password=<password for the Tableau Server API user account> --gateway-url <Tableau Server Gateway URL> --version <Tableau Server version>

rmtadmin delete-env

Note: Added in version 2021.2

Deletes a specific environment and all data that has been collected for that environment. It also removes the connection and topology information about the Tableau Server that the environment is monitoring and deregisters all the Resource Monitoring Tool Agents.

This command only works on the RMT Server.

Synopsis

rmtadmin delete-env [positional parameter][options] [global option]

Positional Parameter

env

Required. The name of the environment you want to delete.

Options

--confirm

Optional. Confirm that you want to delete the environment. If you do not provide this option, you will be prompted to confirm.

--skip-agent-disconnect

Optional. Skips disconnecting the Agent and continues with deregistering the Agent. Use this option if you think the Agent is inaccessible – for example, if the Tableau Server node has been removed or if the Agent has been uninstalled on that node.

Example: rmtadmin delete-env <myenvironment>

rmtadmin delete-env-data

Permanently deletes all Tableau Server-related data collected for a specific environment. Environment configuration, Tableau Server information and Agent registration will not be removed.

This is useful for clearing all the existing data in an environment without removing the environment itself. After deleting the existing data, new data sent by the Agents will continue to be processed.

This command only works on the RMT Server.

Synopsis

rmtadmin delete-env-data [positional parameter][option][global option]

Positional Parameter

env

The name of the environment for which the data should be deleted.

Option

--confirm

Optional. Confirm that you want to delete the environment data. If you do not provide this option, you will be prompted to confirm.

Example: rmtadmin delete-env-data <myenvironment>

rmtadmin delete-server

Note: Added in version 2021.2

Deletes the configuration information of the Tableau Server node from the environment, deregisters the Agent on that node and deletes all monitoring data collected specific to that node.

This command only works on the RMT Server.

Synopsis

rmtadmin delete-server [options][global option]

Options

--env

Required. The name of the environment that the Tableau Server node is connected to.

--hostname

Required to delete information about one or more connected to the environment and if --all is not specified.

This is the machine name of the Tableau Server node. Use commas to separate multiple values if specifying more than one host name.

--all

Optional, but required if --hostname is not specified.

Deletes the information for all the Tableau Server nodes connected to the environment.

--skip-agent-disconnect

Optional. Skips disconnecting the Agent and continues with registering the Agent. Use this option if the Agent is inaccessible – for example, if the node has been removed from Tableau Server or if the Agent has been uninstalled on that node.

--confirm

Confirm that you want to delete all the information about the Tableau Server node. If you do not provide this option, you will be prompted to confirm.

Example: rmtadmin delete-server --hostname=<machine name of the Tableau Server node>

rmtadmin delete-server-data

Note: Added in version 2021.2

Deletes the data collected from one or more Tableau Server nodes. Data removed only pertains to the nodes that are specified. If you specify all, then all the data collected from all the nodes will be deleted. Environment configuration, Tableau Server information and Agent registrations will not be deleted.

This command only works on the RMT Server.

 

Synopsis

rmtadmin delete-server-data [options][global option]

Options

--env

Required. The name of the environment that the Tableau Server node is connected to.

--hostname

Required to delete information about one or more connected to the environment and if --all is not specified.

This is the machine name of the Tableau Server node. Use commas to separate multiple values if specifying more than one host name.

--all

Optional, but required if --hostname is not specified.

Deletes the monitoring data for all the Tableau Server nodes connected to the environment.

--confirm

Confirm that you want to delete all the monitoring data from the Tableau Server nodes. If you do not provide this option, you will be prompted to confirm.

Example: rmtadmin delete-server-data --all

rmtadmin deregister-agent

Note: Added in version 2021.2

Deregisters the Agent from the environment. Monitoring data from this node will no longer be collected. Existing data will remain and not be deleted.

This command only works on the RMT Server.

 

Synopsis

rmtadmin deregister-agent [options][global option]

Options

--env

Required if --key is not specified.

This is the name of the environment where the Agent is currently registered.

--key

Optional if --env is specified.

This is the Agent key. Use commas to separate multiple values. You can get the key values by running the rmtadmin agents command.

--hostname

Optional. Machine name of the Tableau Server node where the Agent is installed. Use commas to separate multiple values.

--all

Optional. Use this option to deregister Agents on all the nodes.

--ignore-agent-errors

Optional. Ignores any errors that occur if unable to connect with the Agents during this process.

--skip-agent-disconnect

Optional. Skips disconnecting the Agent and continues with deregistering the Agent. Use this option if you think the Agent is inaccessible – for example, if the node has been removed from Tableau Server or if the Agent has been uninstalled on that node.

--confirm

Optional. Confirm that you want to deregister the Agents. If you do not provide this option, you will be prompted to confirm.

Example: rmtadmin deregister-agent --env=<myenvironment> --all

rmtadmin environments

Note: Added in version 2021.2

Lists all the environments on the Resource Monitoring Tool Server.

This command only works on the RMT Server.

 

Synopsis

rmtadmin environments [global option]

rmtadmin get

Gets the value of a specified configuration key.

This command can be used both on the RMT Server and Agent.

Synopsis

rmtadmin get <config.key> [global option]

Positional Parameter

key

Name of the configuration key.

Example: rmtadmin get db:database

Supported configuration keys

Key Data Type Applies To DEFAULT Description
db:database String RMT Server tabrmtdb Name of the PostgreSQL database that RMT uses.
db:readOnlyUsername String RMT Server read only Username of a PostgreSQL user account which has only read-only access to the RMT data.
db:readOnlyPassword String RMT Server Generated by the installer program. Password of the PostgreSQL read-only user.
mq:tls:certificateHostName String RMT Server and Agent n/a Host name in the certificate to use when connecting to RabbitMQ via TLS.
mq:tls:enabled Boolean operator RMT Server and Agent FALSE Enable/disable TLS connection to RabbitMQ.
mq:port Integer RMT Server and Agent 5672 RabbitMQ host port number.
mq:virtualHost String RMT Server and Agent tabrmt Connection to the RMT Server or Agent. For Agent, you can modify this setting by registering the Agent with a bootstrap file. For the RMT Server, the value is managed by the installer.
server.web.run Boolean operator Agent TRUE Enable or disable the Agent's web interface.

Use the set command to change the current configuration value.

rmtadmin help

Shows general help about the command line interface and the available commands.

This command can be used both on the RMT Server and Agent.

Synopsis

rmtadmin help

Show help and usage information for a specific command:

This command can be used both on the RMT Server and Agent.

rmtadmin help [command]

rmtadmin master-setup

Configures the RMT Server with specified options. Used both during install and post installation configurations.

Synopsis

rmtadmin master-setup [options][global option]

The configuration options are listed below:

Option Required? Default Description
--admin-password

Yes (Required for initial installation only)

Password can be supplied in the command line or provide a file with the password to use. If neither is provided, you will be prompted for the password.

n/a The password for the administrator user.
--admin-password-file

Yes (Required for initial installation only)

Password can be supplied in the command line or provide a file with the password to use. If neither is provided, you will be prompted for the password.

n/a The password for the administrator user.
--admin-username No admin The username for the administrator user.
--skip-admin-creation

No

This option must be and only used when you making configuration updates post installation.

False

Skip creating the administrator user and password.

If this option is not used during post installation configuration updates, the command will fail and no updates will be made.

--http-port No 80  
--require-https No False Redirect http traffic to HTTPS.
--https-certificate-mode No

'Default'

Available options:

  • Default
  • Store (Windows only)
  • Local

The type of certificate search to perform for the HTTPS certificate.

Default: This mode uses the default self-signed certificate supplied by the installer.

Store: This allows you to enter the thumbprint of a certificate in the Windows certificate store.

Local: Allows you to specify a file-based certificate in the config folder.

--https-certificate-store-thumbprint No Null The HTTPS certificate hash/thumbprint to search for in 'store' certificate mode.
--https-certificate-local-name No

Null

Note: If not specified, the Resource Monitoring Tool is installed with a self-signed certificate and will use that certificate for HTTPS communications.

The name of the HTTPS certificate file.
--https-certificate-local-password No Null The password to use for the HTTPS certificate.
--https-certificate-local-password-file No Null The path to the file containing the password to use for the HTTPS certificate.
--confirm No Prompt for confirmation. Confirms the restart of the RMT Server.
--host

No

Note: We don't recommended changing this value.

Current configuration value or machine name. The preferred URL for accessing the Resource Monitoring Tool server. The server will listen to all the IPs regardless of the host name.
--db-server No Current configuration value or installer default. This is the server name for the PostgreSQL database that is installed with the Resource Monitoring Tool.
--db-port No Current configuration value or installer default. Port number for the database server.
--db-username No Current configuration value or installer default.

Username used to connect to PostgreSQL database installed with the Resource Monitoring Tool.

Resource Monitoring Tool accesses the repository database directly for performance reasons. For this to work, access to the repository must be enabled, with a password set for the readonly database user. For details, see Enable access to the Tableau Server repository.

--db-password No Current configuration value or installer default.

Password for the user account used to connect to the PostgreSQL database that is installed with the Resource Monitoring Tool.

Resource Monitoring Tool accesses the repository database directly for performance reasons. For this to work, access to the repository must be enabled, with a password set for the readonly database user. For details, see Enable access to the Tableau Server repository.

--mq-server No Current configuration value or installer default. The name of the message queue server.
--mq-port No Current configuration value or installer default. The message queue port.
--mq-vhost No Current configuration value or installer default. The message queue virtual host.
--mq-username No Current configuration value or installer default. The username used to connect to the message queue.
--mq-password No Current configuration value or installer default. The password for the user account used to connect to the message queue.
--mq-enable-tls No Current configuration value or false. Requires TLS connection to connect to the message queue.
--mq-tls-certificate-host No Current configuration value or null. The canonical name of the message queue server. This must match the name on the certificate.
--password-salt No Random

A global salt to use to hash the password.

This applies to the local user accounts created in the Resource Monitoring Tool.

--password-min-length No Current configuration value or 10.

The minimum length for the password.

This applies to the local user accounts created in the Resource Monitoring Tool.

--password-min-numeric No Current configuration value or 1.

The minimum required numeric characters in the password.

This applies to the local user accounts created in the Resource Monitoring Tool.

--password-min-special No Current configuration value or 1.

The minimum required special characters in the password.

This applies to the local user accounts created in the Resource Monitoring Tool.

--password-min-latin No Current configuration value or 5.

The minimum required latin characters in the password.

This applies to the local user accounts created in the Resource Monitoring Tool.

--password-require-mixed-case No Current configuration value or true.

Requires mixed case characters in passwords.

This applies to the local user accounts created in the Resource Monitoring Tool.

--auth-timeout-minutes No Current configuration value or 240. The number of minutes before the user authentication expires for the session.
--auth-sliding-expiration No Current configuration or true. Whether or not to reset the authentication timeout period with user activity.

Examples:

To specify the admin password: rmtadmin master-setup --admin-password=<password>

To update the port post install: rmtadmin master-setup --http-port=8000 --skip-admin-creation

rmtadmin passwd

Resets the password for a specific Resource Monitoring Tool user account.

This command works only on the RMT Server.

Synopsis

rmtadmin passwd [positional parameter][global option]

Positional Parameter

username

Name of the user that you want to change the password for.

Example: rmtadmin passwd <username>

rmtadmin query

Executes a raw SQL query against the Resource Monitoring Tool database and saves the results to an output file.

This command works only on the RMT Server.

Synopsis

rmtadmin query [positional parameter][options] [global option]

Positional Parameter

sql

SQL command text to run. You can provide multiple SQL commands. To use a file with the SQL commands, use @ as a prefix to the name of the file.

Options

--outfile=VALUE

Name of the zip file you want to output the query results. Default is queryresults.zip

--force

Overwrites the existing file.

--timeout=VALUE

timeout for the query. Specify this in seconds

--commit

Commits any changes made by the SQL command to the database. By default, the SQL command is run as a transaction, but is rolled back on completion.

Example: rmtadmin query <SQLCommand> --outfile=<path and the output file name>

rmtadmin register

Note: Added in version 2020.2

Registers the Agent using a bootstrap file. The bootstrap file can be downloaded using the rmtadmin bootstrap-file command.

This command is can only be used on the Agent and should be run on the machine where you want to install the Agent.

Synopsis

rmtadmin register [options][positional parameter] [global option]

Positional Parameter

bootstrap

The file path including the name of the bootstrap file.

Options

--username

Required. Name of the admin user created during the RMT Server installation.

--password

Required. Password for the user account.

--password-file

Path including the file name that contains the password information. Password can be supplied in the command line or a file that contains the password. If neither is provided, you will be prompted for the password.

--server-name

Name of the node where Agent is being installed. It defaults to the machine name if no name is specified.

--server-description

Custom description for the Server.

Example: rmtadmin register <bootstrap file name and path> --server-name=<server name>

rmtadmin restart

Restarts the Resource Monitoring Tool applications. When run from the machine where RMT Server is installed, it restarts the RMT Server application. When run on a node where the Agent is installed, it restarts just the Agent application on that particular node.

This command can be run from both the RMT Server and Agent.

Synopsis

rmtadmin restart [options] [global option]

Options

At least one option must be specified:

RMT Server:

--all

Restarts all services.

--master

Restarts the RMT Server.

--mq

Restarts the message queue service.

--db

Restarts the database service.

Agent:

--agent

Restarts the Agent service running on the machine.

Example: rmtadmin restart --db

 

rmtadmin servers

Note: Added in version 2021.2

Lists all the Tableau Server nodes across all environments or a specific environment.

This command only works on the RMT Server.

 

Synopsis

rmtadmin servers [positional parameter][global option]

Positional Parameter

env

Optional. Specify the name of the environment to get a list of Tableau Server nodes registered in that environment.

rmtadmin set

Sets the value of a specified configuration key.

This command works both on the RMT Server and Agent.

Synopsis

rmtadmin set [positional parameter] [global option]

Positional Parameters

key

The configuration key you want to change the value for.

value

The new value you want to use.

Example: rmtadmin set mq:port <port number> where mq:port is the key and the <port number> is the value.

Supported configuration keys

Key Data Type Applies To DEFAULT Description
mq:tls:certificateHostName String RMT Server and Agent n/a Host name in the certificate to use when connecting to RabbitMQ via TLS
mq:tls:enabled Boolean operator RMT Server and Agent FALSE Enable/disable TLS connection to RabbitMQ
mq:port Integer RMT Server and Agent 5672 RabbitMQ host port number.
server.web.run Boolean operator Agent TRUE Enable or disable the Agent’s web interface.

Options

--backup

Creates a backup of the configuration file before making changes.

Use the get command to view the current configuration value.

rmtadmin start

Starts the Resource Monitoring Tool services. When this is run on the RMT Server, it will start the RMT Server only. When run on an Agent, it will start the Agent on the machine you are running the command from.

This command works both on the RMT Server and Agent

Synopsis

rmtadmin start [options] [global option]

Options

At least one option must be specified:

RMT Server:

--all

Starts all services.

--master

Starts the RMT Server.

--mq

Starts the message queue service.

--db

Starts the database service.

Agent:

--agent

Starts the Agent service running on the machine.

Example: rmtadmin start --all

rmtadmin status

Checks the status of the application and running services on the machine you are running this command on. For RMT Server, the status report confirms that the RMT Server is connected to the database and message queue. For Agents, the status report confirms that the agent is connected to the RMT Server.

This command can be run both on the RMT Server and the Agent.

This command returns the following:

  • Application status (running or not)
  • Licence status
  • MQ connection
  • Queue details
  • Memory used
  • Disk space used
  • Tableau server version on machine
  • Process topology of Tableau Server that is stored in Agent config file.

Synopsis

rmtadmin status [global option]

rmtadmin stop

Stops the Resource Monitoring Tool services. When this command is run on the RMT Server, it will only stop the RMT Server. When run on a machine where Agent is installed, it will only stop the Agent on that machine.

This command can be run both on the RMT Server and the Agent.

Synopsis

rmtadmin stop [options] [global option]

Options

At least one option must be specified:

RMT Server:

--all

Stops all services.

--master

Stops the RMT Server.

--mq

Stops the message queue service.

--db

Stops the database service.

Agent:

--agent

Stops the Agent service running on the machine.

Example: rmtadmin stop --db

rmtadmin test-env

Note: Added in version 2021.2

Tests the various connection points between Resource Monitoring Tool and Tableau Server. This includes testing Tableau Server Repository connection, Tableau Server API connections and Server Management Add-on licensing.

This command only works on the RMT Server.

 

Synopsis

rmtadmin test-env [positional parameter][global option]

Positional Parameter

env

Required. The name of the environment that you want to run the test on.

rmtadmin update-env

Note: Added in version 2021.2

Updates the environment settings.

This command only works on the RMT Server.

Synopsis

rmtadmin update-env [options][global option]

Options

Option Required? Description
--non-interactive

No

Disables all interactive prompts.
--no-test

No

Disables testing API and repository connections.
--name Yes The name of the environment.
--id No Identifier of the environment used in web interface URLs.
--gateway-url

No

 

URL used to access the Tableau Server gateway.

--version No Tableau Server version that this environment will be monitoring.
--api-username No Username of the account used to connect to Tableau Server APIs. The user account should be a Tableau Server administrator with access to all Tableau Server sites.
--api-password No

Password of the Tableau Server API user account used to connect to Tableau Server APIs.

--api-password-file No The path to the file containing the password of the Tableau Server API user account.
--repository-server No This is the server name for the PostgreSQL database that is installed with the Resource Monitoring Tool.
--repository-port No The port number of the Tableau Server Repository database.
--repository-username No

Username used to connect to PostgreSQL database installed with the Tableau Server Repository.

Resource Monitoring Tool accesses the Tableau Server Repository database directly for performance reasons. For this to work, access to the repository must be enabled, with a password set for the readonly database user. For details, see Enable access to the Tableau Server repository.

--repository-password No

Password for the user account used to connect to the PostgreSQL database that is installed with the Tableau Server.

Resource Monitoring Tool accesses the Tableau Server Repository database directly for performance reasons. For this to work, access to the repository must be enabled, with a password set for the readonly database user. For details, see Enable access to the Tableau Server repository.

--repository-password No The path including the file name where the password for the user account used to connect to the PostgreSQL database that is installed with Tableau Server.
--repository-ssl-mode

No

Tableau Server Repository SSL Mode:

Prefer SSL or Require SSL to configure SSL connections to Tableau Repository.

Disable to never use SSL to make Tableau Server Repository connections.

--repository-ssl-thumbprint

No

You can choose to either supply the thumbprint that was generated by Tableau Server or copy the server.crt file to the Resource Monitoring Tool Server machine. If you choose to copy the certificate file, you don't have to supply the thumbprint. For more information, see Configure Postgres SSL to Allow Direct Connections from Clients.

Example: rmtadmin update-env --name=<new name>

rmtadmin users

Shows a list of the Resource Monitoring Tool user accounts.

This command works only on the RMT Server.

Synopsis

rmtadmin users

rmtadmin version

Shows the current version information for the RMT Server when run on the RMT Sever machine. It shows the current version information of the Agent installed on the machine that you are running the command from.

This command can be run both on the RMT Server and the Agent.

Synopsis

rmtadmin version

rmtadmin ziplogs

Creates a ZIP archive file containing the Resource Monitoring Tool log files.

This command works both on the RMT Server and Agent but only includes the log files from the application the command is run on.

Synopsis

rmtadmin ziplogs [positional parameter] [option] [global option]

Positional Parameter

filename

Name of the output zip file. Defaults to log.zip if no name is provided.

Option

--force

Overwrites the existing file.

Example: rmtadmin ziplogs <zip file name> --force

Global Option

--help

Shows the help for the command.

Thanks for your feedback!