The UpGuard agent is used to collect scan data for the UpGuard website to analyze. Scans take from as little as 30 seconds to complete. Install one-liners exists for most linux/unix distributions.

Download and Installing

  1. The recommended and easiest way to install the UpGuard unix agent is using the provided one-liner install scripts from the Add Nodes wizard. Install one-liners exist for most unix/linux distributions including OS X, Ubuntu, Debian, Cent OS, RHEL and AIX. Navigate to Discover and Add Nodes to open the Add Nodes wizard.

    w500

  2. Locate the type of operating system or device you want to install the agent on. You can also use the search bar to narrow down the list.

    w600

  3. Click the operating system of the new node and then select Use Agent.

    w600

  4. Copy and paste the one-liner into a terminal window logged into the node you want to install the agent on.

    w500

    The one-liner should:

    1. Download and install the agent
    2. Register the node with the website
    3. Start the agent in daemon mode
  5. After the agent has successfully registered and reported in, the Wait for connection section should show a node as being registered. You can then proceed to scan the node for the first time by clicking Scan Node.

Updating

You can update the UpGuard agent by visiting the downloads page and downloading a copy of the latest installer.

Uninstalling

The UpGuard agent can be uninstalled by running the appropriate OS uninstall one-liner. Uninstallation can be verified by running ps -ef | grep guardrail.

OS X

sudo /Library/Application\ Support/ScriptRock/GuardrailAgent/uninstall.sh

RedHat / CentOS

yum remove scriptrock-guardrail-agent

Ubuntu / Debian

apt-get remove scriptrock-guardrail-agent

Restarting

The agent can be restarted by stopping and starting its service.

sudo guardrail_agent service stop
sudo guardrail_agent service start

Kicking off a Node Scan

Ordinarily, the guradrail_agent process will poll for node scan tasks to run from the UpGuard website. Alternatively, the guardrail_agent can also kick off a node scan on its own.

  1. grep for the process id of guardrail_agent:

    ps -ef | grep guardrail_agent
    
  2. Send the process a USR1 signal:

    kill -s USR1 <guardrail_agent_pid>
    

A node scan will then be kicked off and can be viewed running under Report -> Job History.