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 Node wizard. Install one-liners exist most unix/linux distributions including OS X, Ubuntu, Debian, Cent OS, RHEL and AIX. To access this simply login and click the Discover subnavigation button under the Discover heading.

    w500

  2. Click Linux / Unix.

    w500

  3. Choose Agent.

    w500

  4. Select your OS from the dropdown list and then copy the one line command.

    w500

  5. Run this command on your target node. The command will:

    1. Download and install the agent
    2. Register the node with the website
    3. Start the agent in daemon mode
  6. After the install script has run, return to the UpGuard website and click Continue to scan your node.

    w500

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.