Firepower Management Center Command Line Reference

This reference explains the command line interface (CLI) for the Firepower Management Center.


Note
For Classic devices (7000 and 8000 Series, ASA FirePOWER, NGIPSv), see Classic Device Command Line Reference.

Note
For Firepower Threat Defense, see the Cisco Firepower Threat Defense Command Reference.

About the Firepower Management Center CLI

The Firepower Management Center CLI is available only when a user with the admin user role has enabled it:

  • By default the CLI is not enabled, and users who log into the Firepower Management Center using CLI/shell accounts have direct access to the Linux shell.

  • When the CLI is enabled, users who log in the Firepower Management Center using shell/CLI accounts have access to the CLI and must use the expert command to access the Linux shell.


Caution

We strongly recommend that you do not access the Linux shell unless directed by Cisco TAC or explicit instructions in the Firepower user documentation.


Caution

Users with Linux shell access can obtain root privileges, which can present a security risk. For system security reasons, we strongly recommend:

  • If you establish external authentication, make sure that you restrict the list of users with Linux shell access appropriately.

  • Do not establish Linux shell users in addition to the pre-defined admin user.

When the CLI is enabled, you can use the commands described in this appendix to view and troubleshoot your Firepower Management Center, as well as perform limited configuration operations.

Firepower Management Center CLI Modes

The CLI encompasses four modes. The default mode, CLI Management, includes commands for navigating within the CLI itself. The remaining modes contain commands addressing three different areas of Firepower Management Center functionality; the commands within these modes begin with the mode name: system, show, or configure.

When you enter a mode, the CLI prompt changes to reflect the current mode. For example, to display version information about system components, you can enter the full command at the standard CLI prompt:

> show version

If you have previously entered show mode, you can enter the command without the show keyword at the show mode CLI prompt:

show> version

Enabling the Firepower Management Center CLI

Smart License

Classic License

Supported Devices

Supported Domains

Access

N/A

Any

FMC

Any

admin

Once the Firepower Management Center CLI is enabled, the initial access to the appliance for users logging in to the management interface will be via the CLI; the Linux shell will be accessible only via the expert command.


Note

If the administrator has disabled access to the device shell with the system lockdown command, the Enable CLI Access checkbox is checked and grayed out.

Procedure

Step 1

Choose System > Configuration.

Step 2

Click Console Configuration.

Step 3

To enable or disable the Firepower Management Center CLI check or uncheck the Enable CLI Access checkbox.

Step 4

Click Save.

Firepower Management Center CLI Management Commands

The CLI management commands provide the ability to interact with the CLI. These commands do not affect the operation of the device.

exit

Moves the CLI context up to the next highest CLI context level. Issuing this command from the default mode logs the user out of the current CLI session.

Syntax


exit

Example


system> exit
>

expert

Invokes the Linux shell.

Syntax


expert

Example


> expert

? (question mark)

Displays context-sensitive help for CLI commands and parameters. Use the question mark (?) command as follows:

  • To display help for the commands that are available within the current CLI context, enter a question mark (?) at the command prompt.

  • To display a list of the available commands that start with a particular character set, enter the abbreviated command immediately followed by a question mark (?).

  • To display help for a command’s legal arguments, enter a question mark (?) in place of an argument at the command prompt.

Note that the question mark (?) is not echoed back to the console.

Syntax


?
abbreviated_command ?
command [arguments] ?

Example


> ?

Firepower Management Center CLI Show Commands

Show commands provide information about the state of the appliance. These commands do not change the operational mode of the appliance and running them has minimal impact on system operation.

version

Syntax

Displays the product version and build. 


show version

Example


> show version

Firepower Management Center CLI Configuration Commands

The configuration commands enable the user to configure and manage the system. These commands affect system operation.

password

Syntax

Allows the current CLI/shell user to change their password.


Caution

For system security reasons, we strongly recommend that you do not establish Linux shell users in addition to the pre-defined admin on any appliance.


Note

The password command is not supported in export mode. To reset password of an admin user on a secure firewall system, see Learn more. If you use password command in expert mode to reset admin password, we recommend you to reconfigure the password using configure user admin password command. After you reconfigure the password, switch to expert mode and ensure that the password hash for admin user is same in /opt/cisco/config/db/sam.config and /etc/shadow files.

After issuing the command, the CLI prompts the user for their current (or old) password, then prompts the user to enter the new password twice. 


configure password

Example


> configure password
Changing password for admin.
(current) UNIX password: 
New UNIX password:
Retype new UNIX password:
passwd: password updated successfully

Firepower Management Center CLI System Commands

The system commands enable the user to manage system-wide files and access control settings.

generate-troubleshoot

Generates troubleshooting data for analysis by Cisco.

Syntax


system generate-troubleshoot option1 optionN

Where options are one or more of the following, space-separated:

  • ALL: Run all of the following options.

  • SNT: Snort Performance and Configuration

  • PER: Hardware Performance and Logs

  • SYS: System Configuration, Policy, and Logs

  • DES: Detection Configuration, Policy, and Logs

  • NET: Interface and Network Related Data

  • VDB: Discover, Awareness, VDB Data, and Logs

  • UPG: Upgrade Data and Logs

  • DBO: All Database Data

  • LOG: All Log Data

  • NMP: Network Map Information

Example


> system generate-troubleshoot VDB NMP
starting /usr/local/sf/bin/sf_troubleshoot.pl…
Please, be patient. This may take several minutes.
The troubleshoot options codes specified are VDB,NMP.
Getting filenames from [usr/local/sf/etc/db_updates/index]
Getting filenames from [usr/local/sf/etc/db_updates/base-6.2.3]
Troubleshooting information successfully created at /var/common/results-06-14-2018—222027.tar.gz

lockdown

Syntax

Removes the expert command and access to the Linux shell on the device.


Caution

This command is irreversible without a hotfix from Support. Use with care.

 

system lockdown

Example


> system lockdown

reboot

Reboots the appliance.

Syntax


system reboot

Example


> system reboot

restart

Restarts the appliance application.

Syntax


system restart

Example


> system restart

shutdown

Shuts down the appliance.

Syntax


system shutdown

Example


> system shutdown

History for the Firepower Management Center CLI

Feature

Version

Details

Ability to enable and disable CLI access for the FMC

6.3

New/Modified screens:

New check box available to administrators in FMC web interface: Enable CLI Access on the System > Configuration > Console Configuration page.

  • Checked: Logging into the FMC using SSH accesses the CLI.

  • Unchecked: Logging into FMC using SSH accesses the Linux shell. This is the default state for fresh Version 6.3 installations as well as upgrades to Version 6.3 from a previous release.

Supported platforms: FMC

FMC CLI

6.3

Feature introduced.

Initally supports the following commands:

  • exit

  • expert

  • ?

  • show version

  • configure password

  • system generate-troubleshoot

  • system lockdown

  • system reboot

  • system restart

  • system shutdown

Supported platforms: FMC