Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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

CLI Menu Structure

CLI commands are  organized in tiered menus. Shown here are the commands available on the primary and secondary tiers.


Primary Tier of CLI
Top


Secondary Tiers of CLI

authentication

certificate


collector

exit

Image RemovedImage Added

help

history

Image Modified

log

Image Modifiedtop


logout

Image Modified

lumeta

organization

role

support

system

Image Modified

user

Image Modified

zone


Image Modified






Tip
titleCLI Syntax Tips

To see what's next and display syntax tips while working in it, press ? after a partial command for possible completions plus brief descriptions of the command's purpose and syntax.

If you press ?? after a command completes, an expanded description will display. 

You can navigate down through each menu tier by pressing  after entering a single command at that tier ( e.g., system  hardware-id ) or you can include the full command, separating each tier's command with a space. Press  at the end of the line (e.g., system hardware-id ).  Enclose values that have spaces in them such as "Finance Department"  in quotation marks (e.g., admin@Organization1> zone new "Finance Department" Organization1).

Anchor
net
net
Enabling Netflow Capture

To enable NetFlow capture from the Lumeta command-line interface:

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

Anchor
retrieving
retrieving
Retrieving Your System's Hardware ID/ Identifying your UUID

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

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

Anchor
install
install
Installing and Activating a License

The certificate Lumeta command in the Lumeta 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 Lumeta browser interface.

If you have a term license that entitles you to use the system for a limited time, Lumeta will prompt you to install its key the first time you log in via the CLI. The license counter will begin at that point. You can use the CLI as much as you like; it does not decrement the license counter.  

Info

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 Lumeta 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 lumeta install alice@xenon:/home/alice/license.p12  

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

certificate lumeta install /tmp/license.p12
  1. Log in to the CLI.
  2. If you have a term license,  type certificate lumeta install <loginname@IPaddress:/directory/license_filename> at the command prompt and press Enter (e.g, certificate lumeta 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 Lumeta, send your UUID to trial_support@lumeta.com.
    2. Otherwise, send your UUID to support@lumeta.com.
      In response, Lumeta Support will send you a message containing your license key.
  5. Put the license file you receive from Lumeta in a location that can be accessed by SSH. 

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

  1. Provide the location of your license file.  In the following screen capture, admin is the username, Lumeta-command-center:Desktop/ is the location of the license file, and license.p12 is the filename of the license. For example:
    1. lumeta 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.

Anchor
edp
edp
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

Anchor
connecting
connecting
Connecting and Disconnecting Scouts

  • At the CLI command-line prompt, enter lumeta connect to connect a Command Center to a Scout
  • At the CLI command-line prompt, enter lumeta delete to delete a Scout connected to the Command Center

Anchor
upgrading
upgrading
Upgrading via CLI

To upgrade to a new version of Lumeta, 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 lumeta install <user@host:path/to/local/file>
  • At the CLI command-line prompt, enter certificate lumeta install admin@10.9.0.240:Desktop/upgrade5443.tgz
    Open the file you receive to execute the upgrade.

Anchor
identifying
identifying
Identifying Your Installed Version

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

Anchor
installing2
installing2
Installing 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 friendlyName admin@10.9.0.240:Desktop/copyCert.pem


Anchor
IP
IP
Identifying Your System ID

To retrieve the full name of a Scout such as spectre32Scout: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.

Anchor
bgp
bgp
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>

Anchor
diag
diag
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, Lumeta version, os version, interface config)

Anchor
super
super
Adding 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 ]

Anchor
SD
SD
Exporting 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>

Anchor
import
import
Importing 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>

Anchor
usc
usc
Using 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.

Anchor
interface
interface
Connecting Lumeta Components

Use the Interface parameter in the third position to indicate the Lumeta component to which you intend to connect (command-center, portal or scout). In addition, when you connect a command center and portal, you need to supply location information for CC and can optionally enter a label and icon (avatar).

ON CC:
lumeta connect portaportal_name_or_ip portal cc_lat cc_long cc_label [user@host:path/to/cc_icon/file.png ] ]
lumeta connect scout scout_name_or_ip
ON SCOUT:
lumeta connect command-center cc_name_or_ip { command-center | scout }
 (where the final parameter is the connection initiator)

Anchor
meraki
meraki
Meraki CLI

These commands will enable you to configure the Meraki integration via the Command-Line Interface.

  1. system feed list meraki
  2. system feed set meraki enabled [ true | false ] - Enable or Disable the Meraki integration
  3. system feed set meraki pollInterval posInt - Set the polling interval
  4. system feed set meraki key apiKey - Provide the API key to Meraki API
  5. system feed set meraki zone zone [ enable | disable ] - Enable integration for the indicated zone