Go to Cmd
All Collections
Product Documentation
Product Documentation
Learn how to set up and use Cmd.
104 articles in this collection
Written by
Ben Ironside
Setup
Initial setup
How to configure a new Cmd environment
Written by
Ben Ironside
Updated over a week ago
Global security settings
A glossary of the 'Security' settings menu
Written by
Ben Ironside
Updated over a week ago
Global integration permissions
How to globally enable or disable integrations on your Cmd platform
Written by
Ben Ironside
Updated over a week ago
IPs and domains to allowlist
Include these IP addresses or domain names on your allowlist
Written by
Ben Ironside
Updated over a week ago
How to automatically scrub sensitive data
Use RE2 regular expressions to define custom scrubbers
Written by
Ben Ironside
Updated over a week ago
How to modify your email settings
Select what information Cmd alerts you about via email
Written by
Ben Ironside
Updated over a week ago
Timed session termination
The Timed Session Termination feature allows you to specify a maximum session duration, and a maximum inactive session duration
Written by
Ben Ironside
Updated over a week ago
Agent installation guides
How to install an agent via Apt or Yum
Learn to download and install the Cmd Audit or Cmd Control agent using standard package managers
Written by
Ben Ironside
Updated over a week ago
Deployment guide — Cmd Audit on EKS, AKS, GKE, or OpenShift (DaemonSet)
How to deploy the Cmd Audit agent to your cloud as a DaemonSet
Written by
Ben Ironside
Updated over a week ago
Deployment guide — Container Optimized Linux Distributions
How to deploy the Cmd Audit agent on Red Hat CoreOS, Fedora CoreOS, or Flatcar OS
Written by
Ben Ironside
Updated over a week ago
Single-server deployment guide (Bash script)
Quickly install either Cmd agent on a single server
Written by
Ben Ironside
Updated over a week ago
Deployment guide — Cmd Audit / Cmd Free agent
Deploy the Cmd Audit agent to a fleet of servers
Written by
Ben Ironside
Updated over a week ago
Deployment guide — Cmd Control agent
How to automate deployment to a fleet of servers
Written by
Ben Ironside
Updated over a week ago
Container deployment guide — Cmd Control
Use Cmd's launcher method to hook containerized applications
Written by
Ben Ironside
Updated over a week ago
Terraform deployment example
How to deploy Cmd agents with Terraform
Written by
Ben Ironside
Updated over a week ago
Ansible install playbook example
An example of how to deploy the Cmd agent with Ansible
Written by
Ben Ironside
Updated over a week ago
Supervisord deployment guide
Install the Cmd Control agent in containers running Supervisord
Written by
Ben Ironside
Updated over a week ago
Chef install recipe example
An example Chef recipe that deploys Cmd
Written by
Ben Ironside
Updated over a week ago
Puppet install manifest example
An example of how to install Cmd using Puppet
Written by
Ben Ironside
Updated over a week ago
AWS SSM deployment guide
Enable the Cmd agent on servers managed by AWS Systems Manager (SSM)
Written by
Ben Ironside
Updated over a week ago
AWS EC2 deployment guide
Deploy the Cmd agent on AWS EC2 instances via a user data script
Written by
Ben Ironside
Updated over a week ago
User accounts
Types of User Accounts
A glossary of Cmd accounts & their permissions
Written by
Ben Ironside
Updated over a week ago
Teammates settings
Add new Cmd users, modify user accounts, and group users into 'roles'
Written by
Ben Ironside
Updated over a week ago
How to set up your user account
A configuration guide for new Cmd users
Written by
Ben Ironside
Updated over a week ago
2-factor authentication setup guide
How to set up 2FA methods for your Cmd account
Written by
Ben Ironside
Updated over a week ago
How to view your account settings and activity
Find your account information, web app activity, and server login history.
Written by
Ben Ironside
Updated over a week ago
How to update your timezone
Select a timezone to use throughout the web app
Written by
Ben Ironside
Updated over a week ago
How to change your password
Update the password for your Cmd account
Written by
Ben Ironside
Updated over a week ago
How to log in or out
A guide to logging in with any supported method
Written by
Ben Ironside
Updated over a week ago
Reports
Reports overview
An introduction to Cmd's built-in reporting tool
Written by
Ben Ironside
Updated over a week ago
Tutorial: how to make new reports
A step-by-step guide to adding widgets, charts, and filters
Written by
Ben Ironside
Updated over a week ago
How to share reports
Make a report public or download it as a PDF to share it with your team
Written by
Ben Ironside
Updated over a week ago
How to edit and delete reports
Modify or remove existing Cmd reports
Written by
Ben Ironside
Updated over a week ago
How to copy reports
Add a report to another project, create a private or modified version of a public report
Written by
Ben Ironside
Updated over a week ago
Projects
Projects overview
Conceptual background and further reading related to Cmd projects
Written by
Ben Ironside
Updated over a week ago
Project settings glossary
A detailed overview of the 'Project settings' menu, including teammates, servers, web app, agent, and integration settings.
Written by
Ben Ironside
Updated over a week ago
Add a third-party integration to a project
A guide to connecting with third-party apps
Written by
Ben Ironside
Updated over a week ago
How to review project history
A guide to tracking user-initiated changes to Cmd projects
Written by
Ben Ironside
Updated over a week ago
How to add users to Cmd projects
Invite your team to sign up, and define their permissions
Written by
Ben Ironside
Updated over a week ago
How to add new projects
A step-by-step guide to creating new Cmd projects
Written by
Ben Ironside
Updated over a week ago
How to switch between projects
Select a project to view its servers, triggers, reports, and data
Written by
Ben Ironside
Updated over a week ago
How to rename & delete projects
Instructions for changing a project's name or removing it
Written by
Ben Ironside
Updated over a week ago
Data Export
Data export schema
Learn how Cmd structures data for storage and export
Written by
Ben Ironside
Updated over a week ago
How to export Cmd data to S3
Send Cmd session and event data to AWS for long-term storage
Written by
Ben Ironside
Updated over a week ago
How to export Cmd data to GCP
A guide to sending Cmd data to a Google Cloud Platform bucket
Written by
Ben Ironside
Updated over a week ago
How to access exported data using AWS Redshift
Written by
Ben Ironside
Updated over a week ago
Use AWS Athena to analyze Cmd data
Learn how to use Athena to query Cmd data that's stored long-term in S3
Written by
Ben Ironside
Updated over a week ago
How to download and examine objects with jq
Written by
Ben Ironside
Updated over a week ago
Legacy data export schema
Learn about the legacy format for JSON data exported from Cmd
Written by
Ben Ironside
Updated over a week ago
Access exported Cmd data using AWS Redshift Spectrum
How to query your Cmd data within an S3 bucket
Written by
Ben Ironside
Updated over a week ago
Access exported Cmd data using AWS S3 Select
How to analyze a single S3 object exported from Cmd
Written by
Ben Ironside
Updated over a week ago
Integrations
PagerDuty integration guide
How to send alerts from a Cmd project directly to PagerDuty
Written by
Ben Ironside
Updated over a week ago
Third-party integrations overview
Learn about integrating 3rd-party apps with Cmd
Written by
Ben Ironside
Updated over a week ago
Glossary of third-party integrations
Learn which 3rd-party integrations are available, and how to use them
Written by
Ben Ironside
Updated over a week ago
Jira Integration — Setup Guide
How to use Cmd to create Jira tickets
Written by
Ben Ironside
Updated over a week ago
Duo Integration — Setup Guide
How to implement Duo 2FA on Cmd-enabled servers
Written by
Ben Ironside
Updated over a week ago
Okta SCIM & SSO — Setup Guide
Use Okta to provision Cmd users via SCIM, and for SSO via SAML
Written by
Ben Ironside
Updated over a week ago
Azure AD SSO via SAML — Setup Guide
How to configure Cmd to use Azure AD for SSO via SAML
Written by
Ben Ironside
Updated over a week ago
Azure SCIM — Setup guide
How to set up SCIM via Microsoft Azure
Written by
Ben Ironside
Updated over a week ago
Slack Integration — Setup Guide
How to set up a native Slack integration
Written by
Ben Ironside
Updated over a week ago
Elastic webhook — setup guide
Send data to the Elastic stack with a webhook
Written by
Ben Ironside
Updated over a week ago
Opsgenie Webhook — Setup Guide
Send Cmd event data to Opsgenie with a webhook
Written by
Ben Ironside
Updated over a week ago
Splunk webhook — setup guide
Send Cmd event data to Splunk with a webhook
Written by
Ben Ironside
Updated over a week ago
Custom Webhooks — Setup Overview
Learn about Cmd's custom webhook integrations with 3rd-party apps
Written by
Ben Ironside
Updated over a week ago
xMatters Webhook — Setup Guide
How to send Cmd alerts and data to xMatters
Written by
Ben Ironside
Updated over a week ago
Slack Webhook — Setup Guide
How to implement a custom webhook to send Cmd data to Slack
Written by
Ben Ironside
Updated over a week ago
Sumo Logic Webhook — Setup Guide
Create a webhook integration to send Cmd data to Sumo Logic
Written by
Ben Ironside
Updated over a week ago
Microsoft Teams webhook — Setup Guide
How to integrate Cmd with MS Teams
Written by
Ben Ironside
Updated over a week ago
Triggers and alerts
CQL character matching — syntax guide
Improve your triggers by learning how to match characters in Cmd CQL
Written by
Ben Ironside
Updated over a week ago
Triggers overview
Learn about Cmd's flexible tools for defining rules and alert conditions on your hosts
Written by
Ben Ironside
Updated over a week ago
Trigger best practices and examples
Unlock the flexibility and power of Cmd triggers by following these design principles
Written by
Ben Ironside
Updated over a week ago
How to add new triggers
Step-by-step instructions for setting up triggers
Written by
Ben Ironside
Updated over a week ago
How to copy a trigger between projects
Copy an existing trigger from one project to another
Written by
Ben Ironside
Updated over a week ago
How to troubleshoot triggers
A guide to resolving common problems with triggers
Written by
Ben Ironside
Updated over a week ago
Trigger actions overview
Learn about the actions Cmd can take when trigger conditions are met
Written by
Ben Ironside
Updated over a week ago
2FA on session connect — setup guide
Follow this guide to enforce two-factor authentication when users sign onto your hosts
Written by
Ben Ironside
Updated over a week ago
Simple 2FA prompts — setup guide
How to streamline authentication and reduce 2FA-fatigue on Cmd Control
Written by
Ben Ironside
Updated over a week ago
How to limit when triggers fire for authenticated users
Reduce alert fatigue by following these trigger design principles
Written by
Ben Ironside
Updated over a week ago
How to rename and delete trigger groups
A step-by-step guide to managing trigger groups
Written by
Ben Ironside
Updated over a week ago
How to add new trigger groups
A step-by-step guide to creating trigger groups
Written by
Ben Ironside
Updated over a week ago
Agent self-protection triggers
Written by
Ben Ironside
Updated over a week ago
The Web App
The Cmd Web App Terminal
Learn about the terminal that displays your data in the Cmd web app
Written by
Ben Ironside
Updated over a week ago
The 'Home' page
An overview of the homepage dashboard, and how to customize it
Written by
Ben Ironside
Updated over a week ago
The 'Servers' page
View and manage Cmd-enabled servers; update, uninstall, or disable an agent; and edit server groups
Written by
Ben Ironside
Updated over a week ago
The 'Alerts' page
An overview of the 'Alerts' page, where you can view and resolve alerts
Written by
Ben Ironside
Updated over a week ago
The 'Sessions' page
An overview of 'sessions', where you can view Cmd data and live sessions
Written by
Ben Ironside
Updated over a week ago
The Cmd agent
Cmd Audit agent troubleshooting guide
Learn to resolve the most common issues with setting up the Cmd Audit / Cmd Free agent to capture data
Written by
Ben Ironside
Updated over a week ago
Monitor environment variables
How to capture local env vars at session inception with the Cmd Audit or Cmd Control agent
Written by
Ben Ironside
Updated over a week ago
The agent status API
How to check an agent’s state via a UDS diagnostic endpoint
Written by
Ben Ironside
Updated over a week ago
The agent download endpoint
Learn how to download specific versions of either agent from a URL maintained by Cmd
Written by
Ben Ironside
Updated over a week ago
How to disable or uninstall the Cmd agent
Written by
Ben Ironside
Updated over a week ago
How to manage server groups
Instructions for how to add and delete server groups, and for how to add servers to groups
Written by
Ben Ironside
Updated over a week ago
Cmd Control agent troubleshooting guide
How to resolve issues with deploying the Cmd Control agent on servers to log data and enforce policies
Written by
Ben Ironside
Updated over a week ago
Appendix
Cmd Audit Open Source Software BSD Copyright Attributions
Licensing and copyright information for the open source packages used in the Cmd Audit agent
Written by
Ben Ironside
Updated over a week ago
Cmd Control Open Source Software BSD Copyright Attributions
Licensing and copyright information for the open source packages used in the Cmd Control agent
Written by
Ben Ironside
Updated over a week ago
Enable or disable access for Cmd support
Control whether Cmd support can log in to your environment
Written by
Ben Ironside
Updated over a week ago
Agent diagnostic reports — Overview
Information about agent diagnostic and error reports
Written by
Ben Ironside
Updated over a week ago
Cmd CQL
Information about the operators and properties that you can use to build queries throughout the Cmd web app
Written by
Ben Ironside
Updated over a week ago
Glossary of Cmd-generated server terminal messages
Explanations of the messages which Cmd can show to users logged in to Cmd-enabled servers
Written by
Ben Ironside
Updated over a week ago
Cmd webhook CQL properties glossary
A glossary of the CQL properties you can include with webhook-based alerts
Written by
Ben Ironside
Updated over a week ago
Example POST body
An example of the data Cmd sends to third-party webhook integrations
Written by
Ben Ironside
Updated over a week ago
Known Issues
'man' / 'mandb' crashes on Ubuntu
Easily fix this known issue
Written by
Ben Ironside
Updated over a week ago
Upstart — known issue with SSH daemon
Avoid an issue that can stop triggers from firing as expected on CentOS 6 and Amazon Linux 1
Written by
Ben Ironside
Updated over a week ago
Why do GCP VM SSH sessions appear as two sessions in Cmd?
An explanation of how GCP VMs show up in the Cmd web app
Written by
Ben Ironside
Updated over a week ago