This document highlights valuable installation and setup-related commands and other command-line interface (CLI) commands for advanced users.
Installation Script – “install”
When you first install Immediate Insight, you initiate the “install” command. This command is a collection of the scripts outlined below (along with verification and other sanity-type checks).
- “install-tools storage”
- Formats the data volume and mounts it at “/data”
- “install-tools network”
- Establishes network connectivity (IP, netmask, DNS, etc.)
- Enter “dhcp” under the IP address prompt if you would like to use DHCP (not recommended for production environments).
- Sets the timezone for the machine.
- Sets the NTP servers used by the machine.
- “install-tools application”
- Gets the latest updates for the Immediate Insight application.
- “set-ssd on”
- If you are using SSD for storage – set this to “yes” (“on”) – for some additional tuning parameters optimized for SSD storage.
- “install-tools database”
- Initializes the database. This uses the “reset-datastore” command to create a fresh, new datastore (erases all previous data).
- “install-tools joinCluster ” (if you answer “yes” to joining a cluster)
- Joins the Immediate Insight server to an existing cluster – or to another server to create a new cluster.
- “install-tools verify” or “install verify” – runs the “install” script in a more verbose fashion – outlining everything the script is doing on-screen (instead of just logging to ~/logs/update.log). This is helpful should you be troubleshooting install issues.
- “install-tools check” or “install check” – tells you the current state of the system (version running, configuration details, storage status, memory utilization, network details, disk volume outline, and agent details).
- “status” – a more compressed “install-tools check” command outlining version info, the IP address, what Immediate Insight components are running, data storage utilization, cluster status (if applicable), and memory utilization.
- “install-tools deleteServer ” – remove a system from the cluster. Be sure to do this from the system that you are keeping in the cluster.
- “diags-search indices” – check the status of the database indexes – red is bad, yellow is OK depending on the situation (may be the cluster syncing).
- “reset-settings –x” – factory reset.
- “reset-settings –d” – delete the database and start fresh.
- “reset-settings -?” – other reset options.
- “update only” – load the latest version of application code for Immediate Insight but do not activate it.
- “update search” – update the search engine to the latest version.
- “revert” roll back to the previous version of the Immediate Insight application after an update. Previous versions are stored in ~/versions.
- “stop-all” – stop both the database and the Immediate Insight application components.
- “reload server” – bounces the Immediate Insight application without restarting the database. The database is slow to restart (since it has to verify data integrity and build caches) versus the Immediate Insight application – so this can save time if you just need to restart Immediate Insight.
- “sudo reboot” – reboot the server (“stop-all” should be issued prior to a shut down or restart of the system)
- “sudo apt-get update && sudo apt-get upgrade” – update Linux with the latest OS security patches.
- “ii” – command-line search. It returns some results – so you can verify that everything is running without having to use the browser-based console.
More Helpful Commands
- “?” – show a list of all CLI commands.
- “set-ssl on” – enable SSL for the browser-based console (https). Certs are stored in the ~/app/config directory.
- “set-certs” – install newly added certs or generate a self-signed certificate.
- “set-ip” – change the IP address (/etc/network/interfaces).
- “set-api” – activate the API and set keys.
- “set-agent” – configure the agent (used for the Drag & Drop and Remotes features)
- “set-updateproxy” – enable/disable HTTPS proxy server for the “update” command to use.
- “firewall show” – show the current local port controls.
- “firewall clear” – disable the local firewall (not recommended for production use, but helpful when troubleshooting connectivity issues).
Please contact email@example.com for any other inquiries.