Essential CLI Procedures

Though spare in appearance, Asset Manager's command-line interface (CLI) is a powerful tool with many of the same capabilities as Asset Manager's GUI.  It also provides some functionality that is not yet available in Asset Manager's GUI. This section introduces the basic CLI syntax and provides the procedures you are most likely to use. 

Enable Netflow Capture

To enable NetFlow capture from the Asset Manager command-line interface:

  1. Log in to the CLI.
  2. At the command-line prompt, enter support service packetcapture start.
  3. Exit the CLI.

Retrieve the System UUID

The hardware-id command is useful as it displays the information you'll need to supply Asset Manager Support to generate a license.  You can also access your UUID via the
Asset Manager GUI.

  1. Log in to the CLI.
  2. At the command-line prompt, enter system hardware-id
    The hardware ID displays.

Install & Activate a License

The certificate Asset Manager command in the Asset Manager CLI enables you to activate a license or find out the activation date of your current license. Licenses, however, are more frequently activated via the Asset Manager browser interface.

If a command requires a file upload, you have two choices. You can put the file on an SSH server or you can use an SFTP tool like psftp or FileZilla to copy the file to Asset Manager first.  

If the file is on an SSH server, then you can refer to it with this syntax: userid@sshserver:/path/to/file. For example if the file is on a server called xenon and you have an account on xenon with the name alice and the file is in your home directory and called license.p12, you can use "alice@xenon:/home/alice/license.p12".

certificate Asset Manager install alice@xenon:/home/alice/license.p12  

If the file is not on an SSH server, then use SFTP and your Asset Manager credentials to copy the file to Asset Manager's /tmp directory. Then you would use this syntax:

certificate Asset Manager install /tmp/license.p12

  1. Log in to the CLI.
  2. If you have a term license,  type certificate Asset Manager install  <loginname@IPaddress:/directory/license_filename> at the command prompt and press Enter (e.g, certificate Asset Manager install junebug@10.246.246.159:/users/junebug/Downloads/license.p12.)
  3. The license installs and you are returned to the command prompt.
  4. Copy-paste the UUID to an email message and send it to one of our support teams:
    1. If you have a free-trial copy of Asset Manager, send your UUID to trial_support@Asset Manager.com.
    2. Otherwise, send your UUID to support@Asset Manager.com.
      In response, Asset Manager Support will send you a message containing your license key.
  5. Put the license file you receive from Asset Manager in a location that can be accessed by SSH. 

The following illustrates the syntax to install an Asset Manager license via the CLI. 

  1. Provide the location of your license file.  In the following screen capture, admin is the username, Asset Manager-command-center:Desktop/ is the location of the license file, and license.p12 is the filename of the license. For example:
    1. Asset Manager install admin@10.9.0.240:Desktop/license.p12
  2. Type yes when prompted to continue. 
    The license file loads and a confirmation message displays.

Enable/Disable Data Retention Policy

  • At the CLI command-line prompt, enter system device-persistence-policy for the status.
  • At the CLI command-line prompt, enter system device-persistence-policy enable to turn it on.
  • At the CLI command-line prompt, enter system device-persistence-policy disable to turn it off

Connect & Disconnect the Portal, Command Centers & Scouts

ON CC, SCOUT OR PORTAL
At the CLI command-line prompt , enter Asset Manager list to review the list of Scout and Command Center system names.

ON CC:
Asset Manager connect portal portal_name_or_ip portal cc_lat cc_long [ cc_label [user@host:path/to/cc_icon/file.png ] ]
Asset Manager connect scout scout_name_or_ip
Asset Manager deletesystem name or IP


ON SCOUT:
Asset Manager connect command-center  cc_name_or_ip { command-center | scout } (where final parameter is the connection initiator)
Asset Manager deletesystem name or IP

ON PORTAL:
When you connect a command center and portal, supply location information for the Command Center and optionally enter a label and icon (avatar).

Asset Manager connect command-centercc_name_or_ip { portal | command-center }
 (where the final parameter is the connection initiator)
Asset Manager delete system name or IP

Upgrading via CLI

To upgrade to a new version of Asset Manager, or to upgrade your Scouts, use the System Upgrade command, the syntax of which is user@host:path/to/local/file

      • At the CLI command-line prompt, enter certificate Asset Manager install <user@host:path/to/local/file>
      • At the CLI command-line prompt, enter certificate Asset Manager install admin@10.9.0.240:Desktop/upgrade5443.tgz
        Open the file you receive to execute the upgrade.

Identify the Installed Version

 The system version Asset Manager command is especially useful when working with Support to Identify your release. 

Install Self-Signed Certificates

If a company uses its own certificates, they'll need to make use of the certificate ssl install command:
certificate ssl install Asset Manager admin@10.9.0.240:Desktop/copyCert.pem


Identifying the System ID

To retrieve the full name of a Scout such as Asset Manager32Scout:eth1, which is useful if you don't remember the full name, or want to see the IP address of your system, enter . . .

  1. system interface list
  2. Press the Tab key.
    The system name and interface ID displays.

Enable/Disable BGP

  • collector bgp <collector name> enabled [ true | false ] 
  • collector bgp <collector name> peer new <ipaddr> [ enable | disable ] <password> <remote AS> 
  • collector bgp <collector name> peer delete <ipaddr>

Exporting Support Diagnostics

To run the /api/rest/management/system/diagnostic/export API, use the CLI command: support diagnostics file

This command will return a zip file containing:

  • system configuration (same as configuration export command)
  • contents of /var/log
  • system "specs" file (name, uuid, Asset Manager version, os version, interface config)

Add a Superuser

Only a superuser can add or remove another user's superuser status. Multiple superusers are allowed. The last one cannot be deleted.

user superuser <userid> [ true | false ]

Export the System Configuration

This command (system configuration export) exports all configuration data to a remote file. To export the configuration and save the file remotely, run:
system configuration export username@hostname:<path to file>

Import a System Configuration

This command (system configuration import) imports configuration data from a file you've stored locally. To import configuration from the local system, run:
system configuration import <path to file>

Use Special Characters in Names

Most symbols can be entered without any special quoting. If you want to include spaces or double quotes as part of a name, however, care must be taken. To use double quotes, enclose the entire string in double quotes and put a backslash in front of each double quote you wish to be part of the name:

  • admin@cc> collector new "before\"after" Zone1 cc:eth0
  • admin@cc> collector list
  • before"after
To use spaces, you have two choices. Either use a backslash before each space, or enclose the entire name in double quotes:
  • admin@cc> collector new with\ space Zone1 cc:eth0
  • admin@cc> collector new "two words" Zone1 cc:eth0
  • admin@cc> collector list
  • two words
  • with space
The above is true for passwords, zone names, and organization names and, with the exception of user names, anywhere you enter a free-form string. User names cannot have special characters.

Enforce Password Rules

To enforce password rules,

  1. Log in to the CLI.
  2. Run the command "system password-controls enable"
  3. Exit the CLI.

Manage a Zone-level Avoid List

"zone discoveryspaces <zonename> avoid [ + | - | = ] command-line <cidr> [ <cidr>...]"
"zone discoveryspaces <zonename> avoid [ + | - | = ] remote <user@host:path/to/file>"

+ for adding
- for deleting
= for replacing