Appendix A: AppViewX Operational Commands

For operational assistance in the Command Line Interface, use the following commands in the scripts directory: for example, /appviewx/appviewx.
Command Purpose
appviewx - - status all Check the status of all plugins
appviewx - - start all Start all plugins
appviewx - - stop all Stop all plugins
appviewx - - start <plugin_ name> Start Database, Web, or Gateway, Scheduler, Queue
appviewx - - stop <plugin_ name> Stop Database, Web, or Gateway, Scheduler, Queue
appviewx - - start plugins <plugin_ name> Start a particular plugin
appviewx - - stop plugins <plugin_ name> Stop a particular plugin
appviewx - - start plugins Start all plugins
appviewx - - stop plugins Stop all plugins
appviewx - - start <plugin_name> $(hostname -i) Start all plugin in the particular host machine
appviewx - - stop <plugin_name> $(hostname -i) Stop all plugin in the particular host machine
appviewx - - start plugins <plugin_ name> $(hostname -i) Start a particular plugin in the particular host machine
appviewx - - stop plugins <plugin_ name> $(hostname -i) Stop a particular plugin in the particular host machine
appviewx - - start plugins $(hostname -i) Start all plugins in the particular host machine
appviewx - - stop plugins $(hostname -i) Stop all plugins in the particular host machine
appviewx - - conf-sync Sync the configuration file from one host to another host
appviewx - - initialize all Initialize all plugins after a specific configuration update
appviewx - - prerequisite Check the prerequisite of all hosts
appviewx - - prerequisite $(hostname -i) Check the prerequisite of a particular host
appviewx - - restart <plugin_name> Restart a particular plugin
appviewx - - restart plugins <plugin_name> Restart a particular plugin
appviewx - - restart all Restart all plugins
appviewx - - enable-https <all> or <gateway> or <web> or <plugin> Enable SSL on the plugins
appviewx - - disable-https <all> or <gateway> or <web> or <plugins> Disable SSL on the plugins
appviewx - - databasebackup <Backup path> Trigger a backup
appviewx - - databaserestore <Path of the backup archive> Restore an already available backup archive
appviewx - - databaseimport fresh Insert dbscripts for fresh installation
appviewx - - databaseimport upgrade <version> Insert dbscripts for an upgrade from an older version
appviewx --change-db-password Functionality to change the DB password
appviewx --update-node-password Functionality to update the encrypted node password in the conf file
appviewx --db-execution Functionality to execute a .js file
appviewx --sync-files Functionality to sync directories/files across nodes
appviewx --plugin-heapinfo <IP> Fetch the maximum and the minimum heap sizes of all the available plugins from a specific node
appviewx --plugin-heapinfo Fetch the maximum and the minimum heap sizes of all the available plugins across all the cluster node setup
appviewx --plugin-heapinfo <plugin_name> Fetch the maximum and the minimum heap sizes of a particular plugin across all the cluster node setup
appviewx --gw-api-form Execute the gateway API
appviewx --update-plugin-heapsize Add and update the heap size for each plugin across all the nodes
appviewx --update-plugin-loglevel Update the log level for each plugin across all the nodes
--license host-fetch Fetch the hostname on which the license needs to be generated
--license host-update Update the hostname for the new license
--db-shell <username> Provision to access and query the database
appviewx --start avx_platform_elastic Start the elastic search component across all the cluster nodes
appviewx --start avx_platform_elastic <IP> Start the elastic search component for a single node
appviewx --stop avx_platform_elastic Stop the elastic search component across all the cluster nodes
appviewx --stop avx_platform_elastic <IP> Stop the elastic search component for a single node
appviewx --restart avx_platform_elastic Restart the elastic search component across all the cluster nodes
appviewx --restart avx_platform_elastic <IP> Restart the elastic search component for a single node
appviewx --status avx_platform_elastic Check the status of the elastic search component across all the cluster nodes
appviewx --status avx_platform_elastic <IP> Check the status of the elastic search component for a single node
appviewx --elastic -passwd-update Change the password of elastic search component for the admin user
appviewx --version View the version of all the components used in the application
appviewx --view_logs <Transaction ID> View the logs associated with a specific transaction ID
appviewx --gwrefresh mask View the status of gateway components
appviewx --buildinfo <component> View the build information of AppViewX components
appviewx --start avx_platform_vault Start the vault component across all the nodes
appviewx --start avx_platform_vault <IP> Start the vault component for a specific node
appviewx --start avx_platform_consul server Start the avx_platform_consul server across all the nodes
appviewx --start avx_platform_consul client Start the avx_platform_consul client across all the nodes