Broadcom Manageability Configuration and Control Utility
========================================================
Version 1.00
June 28, 2008
Background:
----------
This utility provides command-line based control and configuration of
Broadcom's TruManage standards-based (e.g. ASF, DASH, PMCI) management
controllers embedded in enterprise-class NetXtreme Gigabit Ethernet
network controllers (e.g. BCM5761).
This utility replaces the functionality of Broadcom's ASFSilentConfig
(ASFSCfg) for Soledad (BCM5761) class devices. This utility may be enhanced
to support legacy device (i.e. ASF-only) manageability configuration and
control later, but currently the support is limited to Soledad devices.
Platforms:
---------
Currently only Windows (i386 and x64) operating systems are supported.
Dependencies:
------------
This utility requires:
* BMAPI.DLL (or BMAPIa.DLL for Win-x64) v7.12.0 or later and
* NDIS5 driver (e.g. b57xp32.sys) v10.83 or later or
* NDIS6 driver (i.e. b57nd60x.sys) v10.97 or later
Usage summary
=============
usage: bmcc <cmd> [[-option] [-option] [...]] [cfgfilename]
control commands:
enable enable the management controller
disable disable the management controller
status query management controller status
sync synchronize OS/network/driver information and settings
ping determine if the management controller is alive
reset reset the management controller
shutdown shutdown the management controller
recycle recycle BrcmMgmtAgent (if running)
information commands:
version display program version details
view-asf display ASF System Description Table from system memory
configuration commands:
create create a new configuration record set with default values
create=[length] -record=<type> to create a record [of specified length]
verify verify headers and data of configuration record set
view display one or more configuration records
view-asfcfg display ASF System Description Table configuration records
dump display one or more configuration records (in hex/ASCII)
clear clear the data of one or more configuration records
remove remove one or more configuration records
delete delete (do not remove) one or more configuration records
encrypt encrypt one or more configuration records
decrypt decrypt one or more configuration records
edit modify existing configuration records
compress remove unused records and data from configuration image
merge combine NULL records in configuration image
import=<file> import a configuration set/record from specified filename
export=<file> export a configuration set/record to specified filename
asf import ASF System Description Table from system memory
smbios import SMBIOS structure tables from system memory
smbios=<file> import SMBIOS structure tables from specified filename
web=<path> import Web files (e.g. HTML, images) from specified path
opaque management data commands:
ostatus display status of one or all OMData instances
ocreate=[args] create OMData storage and instance records
args=<number of OMData instances>,<total storage bytes>
oalloc=[args] allocate an OMData instance with the specified properties
args=<length>,<owner account>,<data format>,<element name>
oread display contents of one or all OMData instances
owrite write to one OMData instance
oclear clear contents of one or all OMData instances
ofree free one or all OMData instances
configuration options:
-record=<type> specify record type [e.g. in hex] (default type is "any")
-attr=<value> specify record attributes (default value is "none")
-instance=<num> specify record instance (default instance is "any")
-noverify disable automatic configuration record set verification
-truncate truncate output file to minimum bytes required
general options:
-quiet suppress console output
-verbose verbose output and display version details
Usage notes:
-----------
* Only one command may be specified per invocation of this utility
* Multiple options may be specified per invocation of this utility
* A configuration file (e.g. dashfw.cfg) is optional for most commands
* Optional arguments are shown in square brackets ([ and ])
* Required arguments are shown in angle brackets (< and >)
* Run "bmcc" from a command prompt to display a list of currently supported
commands and options for the version of bmcc that you have
Basic commands
==============
"bmcc"
------
Display the version number and usage syntax summary (a.k.a. "help").
"bmcc version"
--------------
Display detailed version information about bmcc and its associated libraries.
"bmcc enable"
-------------
Enable the management controller if it has not already been enabled, and
start the management controller firmware if it has not already been started.
The enable state is persistent across system power-loss. This command is the
equivalent of the b57diag "setman -e" command followed-by a conditional
"apectl -R" command.
"bmcc disable"
--------------
Disable the management controller if it has not already been disabled,
and stop the management controller firmware if it is currently running.
The disable state is persistent across system power-loss. This command is the
equivalent of the b57diag "setman -d" command followed-by a conditional
"apectl -r" command.
"bmcc status"
-------------
Display the current persistent (e.g. Enabled State) and dynamic status of the
management controller.
When used with the "-verbose" option, the entire APE shared memory segment
will be dumped in 32-bit hexadecimal values.
This command is similar to the b57diag "apeinfo -m" command.
"bmcc ping"
-----------
Query the management controller firmware to test if it is capable of
responding to "events".
"bmcc edit"
-----------
View and (optionally) modify the management controller configuration values
using a text-based interactive menu system.
If a [cfgfilename] is specified on the command-line (e.g. dashfw.cfg), then
configuration records will be read-from and written-to that file. If no
[cfgfilename] is specified on the command-line, then a management-capable
NetXtreme network controller must be discovered in the system and the
configuration records will be read-from and written-to its NVRAM.
This command is the equivalent of the b57diag "mancfg" command.
"bmcc view"
-----------
View the information (headers) for configuration records contained in the
management configuration record set.
When used with the "-verbose" option, details about the contents of the
record will be displayed, when available.
This command is similar to the b57diag "mancfg -v" command.
"bmcc verify"
-------------
Check the validity of the configuration record set. This command performs
additional sanity-checks that are not performed by the automatic verification
(which may be disabled with the '-noverify' option).
Advanced commands
=================
"bmcc sync"
-----------
Synchronizes the configuration file (if specified) or management controller's
NVRAM configuration settings with the current host operating system and
network stack settings.
This command provides functionality similar to that of the BrcmMgmtAgent.
"bmcc reset"
------------
Requests a graceful reset of the management controller and if that fails,
performs a hard reset.
This command is the equivalent of the b57diag "apectl -r" command.
"bmcc shutdown"
---------------
Requests a graceful shutdown of the management controller. This command does
not change the persistent Enabled State.
This command is the equivalent of the b57diag "apectl -h" command.
"bmcc recycle"
--------------
If the BrcmMgmtAgent service has been installed and started, this command will
force the service to re-load the management configuration record set and
synchronize with the system's SMBIOS and ASF tables, host operating system,
and network stack.
"bmcc create"
-------------
Creates a default configuration set in the [cfgfilename] if specified or
the management controller's NVRAM. All existing configuration records will
be over-written by this command.
This command is the equivalent of the b57diag "mancfg -c" command with the
exception that the APE_CFG NVRAM directory entry must already exist.
If the "create=<size>" syntax is used to create a default configuration file,
the size (in kilobytes) may be used to specify the *minimum* size of the file
to be created. i.e. "bmcc create=64 default.cfg" will create a default.cfg
file with the default configuration record set and padded with terminator
records (if necessary) to generate at least 65536 bytes in length.
If the "-record=<type>" option is specified, this command will create a single
configuration record of the specified type. The "attribute" value of the new
configuration record will be 0x00 unless a different value was specified with
the "-attr=<value>" option. The record length will be the "default" length
for the specified record type, unless the length was specified with
"bmcc create=<length>".
"bmcc dump"
-----------
View the contents (in hexadecimal and ASCII) of configuration records
contained in the management configuration reset set.
"bmcc clear -record=<type>"
---------------------------
Clear the data of one or more configuration records of the specified record
type from the management configuration record set.
The "-record=<type>" option must be specified.
If the instance number is not specified with the "-instance" option, all
instances of the specified record type will be cleared.
"bmcc remove -record=<type>"
----------------------------
Remove one or more configuration records of the specified record type from
the management configuration record set.
The "-record=<type>" option must be specified.
If the instance number is not specified with the "-instance" option, all
instances of the specified record type will be removed.
"bmcc delete -record=<type>"
----------------------------
Nulify one or more configuration records of the specified record type from
the management configuration record set. The record header and data will be
cleared (zereod) out, but not removed from the configuration set, so the
space may be used by a newly added or re-sized configuration record.
The "-record=<type>" option must be specified.
If the instance number is not specified with the "-instance" option, all
instances of the specified record type will be deleted.
"bmcc encrypt"
--------------
Encrypt one or more configuration records in the management configuration
record set. This command cannot not be used to encrypt records in a
configuration file.
If the instance number is not specified with the "-instance" option, all
instances of the specified record type will be encrypted.
"bmcc decrypt"
--------------
Decrypt one or more configuration records in the management configuration
record set. This command cannot not be used to encrypt records in a
configuration file.
If the instance number is not specified with the "-instance" option, all
instances of the specified record type will be decrypted.
"bmcc compress"
---------------
Reduces configuration record lengths to the miminum length required to
store the current record data and removes configuration records with no data.
"bmcc merge"
------------
If there are adjacent deleted/null records (record type == 00) in the
configuration record set, each set of such records will be merged into a
single deleted/null record.
"bmcc import=<file>"
--------------------
If the "-record=<type>" option is specified, this command will import raw
data from the specified filename into the specified record (and instance
number, if specified) of the management configuration record set.
If the "-attr=<value>" option is specified, the newly created configuration
record will use that attribute value instead of the default (0x00 - "none").
Example: "bmcc import=private.key -record=50"
If the "-record=<type>" option is not specified, this command will import
all of the configuration records from the specified configuration filename.
Any existing records in the management configuration record set will be
deleted/over-written.
Example: "bmcc import=dashfw.cfg"
"bmcc export=<file>"
--------------------
If the "-record=<type>" option is specified, this command will export the
specified configuration record from the management configuration record set
to the specified filename.
Example: "bmcc export=private.key -record=50"
If the "-record=<type>" option is not specified, this command will export
all of the configuration records from the management configuration record set
to specified configuration filename.
Example: "bmcc export=dashfw.cfg"
"bmcc view-asf"
---------------
View the system's ASF System Description Table (ADT, a.k.a. "ASF! Table").
"bmcc view-asfcfg"
-----------------
View the stored ASF System Description Table configuration records.
"bmcc asf"
----------
Import the system's ASF System Description Table into the management
configuration record set.
"bmcc smbios"
-------------
Import the system's SMBIOS Structure Table into the management configuration
record set.
"bmcc smbios=<file>"
--------------------
Import an SMBIOS Structure Table from the specified filename into the
management configuration record set.
"bmcc web=<path>"
-----------------
Import a web file or directory tree of web files (content) for the web/HTML
user interface. This command deletes any existing WEBFILE or WEBDATA
configuration records before importing the specified web content.
Examples:
"bmcc web=index.html"
"bmcc web=c:\webpages\*"
"bmcc ostatus"
--------------
Display the status of the Opaque Management Data configuration records.
"bmcc ocreate=<number of OMData instances>,<total storage bytes>"
-----------------------------------------------------------------
Create the Opaque Management Data (OMData) configuration records to support
the specified number of OMData instances and total storage bytes.
If the <total storage bytes> value is not evenly divisible by 4, it will
be rounded up to the nearest value evenly divisible by 4.
"bmcc oalloc=<length>,[owner account],[data format],[element name]"
-------------------------------------------------------------------
Allocate the next available Opaque Management Data (OMData) instance based
on the specified data length. The owner account, data format, and element
name values are optional.
"bmcc oread"
------------
Read data contained in one or all OMData instances.
"bmcc owrite"
-------------
Write data (from stdin) into the specified OMData instance.
"bmcc oclear"
-------------
Clear (zero-out) data associated with one or all OMData instances and set
the data length value(s) to 0.
"bmcc ofree"
------------
Release one or more OMData instances to the pool of available OMData instances
that may be allocated (e.g. with "bmcc oalloc") from.
Advanced options
================
"-quiet"
--------
Display nothing on the standard output stream (stdout). Error messages will
still be sent to the standard error stream (stderr).
This option applies to all commands.
"-record=<type>"
----------------
If the "-record=<type>" option is specified, only records matching the
specified record type will be displayed. The record type may be the
hexadecimal value of the record type or one of the following record type
specifiers:
Record Type Multi Description
----------- ----- -----------
null Yes Null/Deleted record
ver No Version information
mgmt No Manageability configuration
ipv4 No IPv4 configuration
ipv6 No IPv6 configuration
rsp No RMCP Security Protocol-extensions
pet No Platform Event Trap configuration
smbus Yes System Management Bus configuration
smbios No System Management BIOS structure table
asf_info No ASF System Description Table ASF_INFO record
asf_alrt No ASF System Description Table ASF_ALRT record
asf_rctl No ASF System Description Table ASF_RCTL record
asf_rmcp No ASF System Description Table ASF_RMCP record
asf_addr No ASF System Description Table ASF_ADDR record
account Yes CIM_Account instance
role Yes CIM_Role instance
webfile Yes Web/HTML user interface file
webdata No Web file data (for all web files)
"-instance=<num>"
-----------------
If this option is specified (with a 0-based decimal instance number), only the
specified instance of the specified record type will be operated on
(e.g. displayed or modified). Otherwise, all instances of the specified record
type will be operated on.
This option applies to the following commands:
view, dump, remove, encrypt, decrypt, import, export,
oread, owrite, oclear, ofree
"-attr=<value>"
---------------
This option is used to specify the attribute value used when creating a new
configuration record. The value may be specific in hexadecimal, or the value
strings "none" or "prop" (for property stream records) may be specified.
This option applies to the following commands:
create, import, ocreate
"-noverify"
-----------
This option is used to disable the automatic configuration record set
validity checking that is performed when the configuration record data is
read (from NVRAM or file) and before it is written (to NVRAM or file).
"-truncate"
-----------
This option may be used when creating or modifying a .cfg file to force the
output file size to the minimum number of bytes required to store the
configuration record set (by excluding terminator records).
/* End of file */
Download Driver Pack
After your driver has been downloaded, follow these simple steps to install it.
Expand the archive file (if the download file is in zip or rar format).
If the expanded file has an .exe extension, double click it and follow the installation instructions.
Otherwise, open Device Manager by right-clicking the Start menu and selecting Device Manager.
Find the device and model you want to update in the device list.
Double-click on it to open the Properties dialog box.
From the Properties dialog box, select the Driver tab.
Click the Update Driver button, then follow the instructions.
Very important: You must reboot your system to ensure that any driver updates have taken effect.
For more help, visit our Driver Support section for step-by-step videos on how to install drivers for every file type.