The following topics describe how to access and use the Tools menu.
System requirements
Make sure the following requirements are met.
Model numbers and system image versions:
Malware Analysis Version 8.0.0 or later is running on one of the following appliance models: AX 5500, AX 5550.
Central Management System Version 8.1.0 or later is running on one of the following appliance models: CM 4500, CM 7500, CM 9500.
Email Security — Server Version 8.0.0 or later is running on one of the following appliance models: EX 3500, EX 5500, EX 8500.
File Protect Version 8.0.0 or later is running on the FX 6500 model.
Endpoint Security (HX) Version 4.0.0 or later is running on one of the following appliance models: HX 4000, HX 4400, HX 4402.
Network Security Version 8.0.0 or later is running on one of the following appliance models: NX 1500, NX 2500, NX 2550, NX 3500, NX 4500, NX 5500, NX 7500, NX 10450, NX 10550.
Intelligent Virtual Execution - Server Version 8.0.0 or later is running on one of the following appliance models: VX 5500, VX 12500.
You have access to the physical or serial console (see Accessing the physical or serial console ).
The minimum system image version cited above is installed on both boot partitions on the appliance. If the appliance was not originally manufactured with that system image version, you must perform the Upgrade steps to meet this requirement.
You obtained the appliance-specific preset Tools menu password from Trellix Technical Support, or you configured another password as described in Setting or disabling the Tools menu password .
Limitations
The Manufacture Appliance and Wipe Appliance Media and Manufacture Appliance options require that the appliance was originally manufactured with a system image that supports the Tools menu.
All logging goes to the serial console. If you use the physical console to access the Tools menu, you will be unable to monitor the progress on the VGA monitor.
Upgrade steps
The minimum system image version must be installed on both boot partitions before you can access the Tools menu. Perform the steps in this section if you are upgrading from an earlier version.
Note
These steps are not required if your appliance was originally manufactured with the minimum system image version. The minimum versions are listed in System Requirement.
Fetch and install a supported system image:
hostname (config) # fenet image check hostname (config) # show fenet image status hostname (config) # fenet image fetch hostname (config) # show fenet image status hostname (config) # image install <image>
This installs the system image in one of the boot partitions.
Verify the boot partition for the new system image:
hostname (config) # show images
For example, on a Network Security appliance:
hostname (config) # show images Installed images: Partition 1: wmps wMPS (wMPS) 8.0.0 ... Partition 2: wmps wMPS (wMPS) 7.9.4 ... Last boot partition: 2 Next boot partition: 2
If necessary, change the
Next boot partitionso the appliance boots from the partition with the new system image when it reloads:hostname (config) # image boot next hostname (config) # write memory
Reload the appliance:
hostname (config) # reload
Install the new system image again to put it on the other boot partition:
hostname (config) # image install <image>
Change the next boot partition:
hostname (config) # image boot next hostname (config) # write memory
Reload the appliance:
hostname (config) # reload
If you do not want to use the default Tools menu password, you can now configure one as described in Setting the tools Menu password . Users who know the password can access the Tools menu on any subsequent appliance reload, as described in Accessing the Tools menu .
Setting the Tools menu password
The Tools menu requires a password. There are two options:
Default Password. A unique password that is derived from the appliance ID is preset on the appliance and must be obtained from Trellix Technical Support.
Configured Password. You can instead set another password in plain text or as a hashed string. A plain-text password is hashed before it is stored.
Admin access
Setting the Tools menu password in plain text using the CLI
Use the commands in this section to set the Tools menu password in plain text.
Log into the appliance CLI.
Go to CLI configuration mode:
hostname > enable hostame # configure terminal
Set the password:
hostname (config) # boot bootmgr tools password <password>
Save your change:
hostname (config) # write memory
Note
Alternatively, you can use the
boot bootmgr tools password 0 <password>command to set the password in plain text, or use theboot bootmgr tools passwordcommand and enter the plain-text password at the prompt.
Example
The following example sets "fyd4k8q2" as the password for the Tools menu.
hostname (config) # boot bootmgr tools password fyd4k8q2
Setting the Tools menu password with encryption using the CLI
Use the commands in this section to set the Tools menu password with a hashed string.
Log into the appliance CLI.
Go to CLI configuration mode:
hostname > enable hostame # configure terminal
Set the password:
hostname (config) # boot bootmgr tools password 7 <password>
Save your change:
hostname (config) # write memory
Example
The following example sets an encrypted password for the Tools menu.
hostname (config) # boot bootmgr tools password 7 $6$xuQN2G3r$ufK5k8dUDdpp0hPETrtjBIDZ3f3PhCxGYagp2k0gvgv/YrD88GNIkUsaKRVDMsPAyQlcGuzhRXaBpCCVPeQd1
Restoring the default Tools menu password using the CLI
Use the commands in this section to restore the default Tools menu password. You must obtain this password from Trellix Technical Support.
Log into the appliance CLI.
Go to CLI configuration mode:
hostname > enable hostname # configure terminal
Restore the password:
hostname (config) # no boot bootmgr tools password
Save your change:
hostname (config) # write memory
Accessing the Tools menu
Use the procedure in this section to access the Tools menu.
Connect to the physical or serial console as described in Accessing the physical or serial console .
Note
If you use the physical console to access the Tools menu, you will be unable to monitor the progress on the VGA monitor.
Log into the console using admin credentials.
Go to CLI configuration mode:
hostname > enable hostname # configure terminal
Reload the appliance:
hostname (config) # reload
Pay close attention to the console as it reloads so you do not miss the
boot:prompt.When you see the
boot:prompt, press Enter.Pay close attention to the console so you do not miss a series of five periods (
.) displayed one second apart.Before the console moves past the fifth period, press any key twice. An image boot menu such as the following on a Network Security appliance is displayed.
Boot Menu --------------------------------------------------------------- 0: wmps wMPS (wMPS) 8.0.0... 1: wmps wMPS (wMPS) 8.0.0... 2: Tools Menu ---------------------------------------------------------------
Press the down arrow on your keyboard to select the 2. Tools Menu option.
Press Enter.
When prompted, enter the Tools menu password provided by your administrator.
The Tools menu (labeled "Boot Menu") is displayed.
Boot Menu --------------------------------------------------------------- 0: Reset admin Password 1: Wipe Appliance Media 2: Manufacture Appliance 3: Wipe Appliance Media and Manufacture Appliance 4: Return to Image Boot Menu ---------------------------------------------------------------
Select an option (described in Boot manager utilities ).
Note
If you select option 4, pay attention to the console so you do not miss a series of five periods displayed one second apart, and then press any key twice to access the image boot menu.
Example
The following example from a Network Security appliance accesses the Tools menu.
nx-03 (config) # reload Configuration changed: save changes? Configuration changes saved. Rebooting... ... boot: Booting from local disk... PXE-MOF: Exiting Intel Boot Agent. Booting default image in 3 seconds. ... This terminal is not active or input for output while booting. Booting default image in 1 seconds. Boot Menu --------------------------------------------------------------- 0: wmps wMPS (wMPS) 8.0.0... 1: wmps wMPS (wMPS) 8.0.0... 2: Tools Menu --------------------------------------------------------------- Use the ^ and v keys to select which entry is highlighted. Press enter to boot the selected image or 'p' to enter a password to unlock the next set of features. Highlighted entry is 2: Booting: 'Tools Menu' Password: ******** ....... Boot Menu --------------------------------------------------------------- 0: Reset admin Password 1: Wipe Appliance Media 2: Manufacture Appliance 3: Wipe Appliance Media and Manufacture Appliance 4: Return to Image Boot Menu --------------------------------------------------------------- Use the ^ and v keys to select which entry is highlighted. Press enter to boot the selected image or 'p' to enter a password to unlock the next set of features. Highlighted entry is 0:
Note
The
'p'option cited in the console instructions is not available.
Disabling the Tools menu
To prevent users from accessing the Tools menu, disable the Tools menu password.
Admin access
Disabling the Tools menu using the CLI
Use the commands in this section to disable the Tools menu password, which prevents users from accessing the Tools menu.
Go to CLI configuration mode:
hostname > enable hostname # configure terminal
Disable the password:
hostname (config) # boot bootmgr tools disable password
Save your change:
hostname (config) # write memory
Viewing Tools menu availability
You can view whether the Tools menu is available on the appliance.
Monitor, Operator, or Admin access
Viewing Tools menu availability using the CLI
Use either of the following commands to view whether users can access the Tools menu.
show bootvar
show images
If a Tools menu password is set (either the default password or a configured password), users can access the Tools menu. If the Tools menu password is disabled, users cannot access the Tools menu.
Examples
The following example from a Network Security appliance shows that the Tools menu password is set, so users can access the Tools menu.
nx-05 > show bootvar Installed images: Partition 1: wmps wMPS (wMPS) 7.4.0 xxx Partition 2: wmps wMPS (wMPS) 8.0.0 xxx Last boot partition: 1 Next boot partition: 1 Boot manager admin password: undisclosed password set Boot manager tools menu password: undisclosed password set ...
The following example shows that the Tools menu password is disabled, so users cannot access the Tools menu.
nx-01 > show images Installed images:
Partition 1: wmps wMPS (wMPS) 7.4.0 ... Partition 2: wmps wMPS (wMPS) 8.0.0 ... No image files are available to be installed. No image install currently in progress. Boot manager admin password: undisclosed password set Boot manager tools menu password: password disabled