VIC Configuration Utility

This chapter includes the following sections:

Understanding the VIC Configuration Utility

The Cisco UCS P81E Virtual Interface Card (VIC) can be configured by a KVM connection to the card through the EFI as an alternative to using the CIMC CLI or GUI. The processor on the VIC hosts the VIC Configuration Utility, a CLI providing many commands that are the same or similar to those of the CIMC, as well as a few unique commands.

Shared Commands

Most commands in the adapter command mode (/chassis/adapter) are available in the VIC Configuration Utility. In addition, the following common navigation and general commands are available:

  • commit
  • connect
  • discard
  • exit
  • scope
  • set
  • show
  • top

Substitute Commands

For some functions, the VIC Configuration Utility provides a new or modified command as a substitute for a CIMC command. The following table lists these CIMC commands and their corresponding VIC Configuration Utility substitute commands. The substitute commands are described in this chapter.

CIMC Command VIC Configuration Utility Command
activate-adapter-fw pci-slot image activate image
adapter-reset-defaults pci-slot reset-defaults
export-vnic tftp-address path/name export-vnic path/name
import-vnic tftp-address path/name import-vnic path/name
scope adapter pci-slot scope adapter
update ip-address path/name update path/name

Unique Commands

The following commands are unique to the VIC Configuration Utility and are described in this chapter:

  • scope firmware (adapter)
  • show firmware (adapter)
  • techsupport

Connecting to the VIC Configuration Utility

Before You Begin

For information on using the KVM connection to reach the Extensible Firmware Interface (EFI), see the following documents:

  • Cisco UCS C[xxx] Server installation and Service Guide
  • Cisco UCS C-Series Servers Integrated Management Controller GUI Configuration Guide

Note

If you plan to import or export files in the VIC Configuration Utility, you must mount a flash drive as virtual media in the KVM before launching the VIC Configuration Utility.

    Step 1   Connect to the server management console either by a local KVM connection or by the virtual KVM in the CIMC GUI.
    Step 2   Perform a hard reset of the server, either by pressing and releasing the server Power button or through the CIMC GUI.
    Step 3   In the KVM console, observe the booting process and press F6 when prompted to enter the BIOS Boot Manager.
    Note   

    After you press F6, other screens appear briefly before the boot device selection screen appears. Do not press any keys during this time.

    Step 4   From the table of boot device options, select Internal EFI Shell and press Enter to launch the EFI shell.
    Step 5   When the EFI shell prompt appears, type vic-config to launch the VIC Configuration Utility.

    Example:

    Shell> vic-config

    Step 6   In the initial screen of the VIC Configuration Utility, choose an adapter from the table by typing the displayed adapter number.

    Example:

    Select Adapter to Configure [type 'e' to exit] : 1

    Step 7   At the VIC Configuration Utility prompt, type scope adapter to enter the adapter command mode.

    Example: 
    VIC-P81E-slot-1# scope adapter
VIC-P81E-slot-1 /adapter #
    What to Do Next

    Navigate and operate the VIC Configuration Utility CLI using the same methods as the CIMC CLI.

    VIC Configuration Utility Commands

    activate (VIC)

    To activate an adapter firmware image in the VIC Configuration Utility, use the activate command.

    activate image-index

    Syntax Description

    image-index

    The number of the firmware image to be activated. This can be a number from 0 to 3.

    Command Default

    None

    Command Modes

    VIC firmware (/adapter/firmware)

    Command History

    Release Modification

    1.2(1)

    This command was introduced.

    Usage Guidelines

    Use this command to select an adapter firmware image to be activated upon the next reboot of the server. Use the show firmware (VIC) command to view the status and version information of the installed firmware images.


    Note

    This command is available only in the VIC Configuration Utility, which is accessible through the EFI.

    Examples

    This example shows how to activate adapter firmware image 0 in the VIC Configuration Utility:

    VIC-P81E-slot-1# scope adapter
VIC-P81E-slot-1 /adapter # show firmware
Image index Image type            Image version  Image status
----------- --------------------- -------------- ----------------
0           APPLICATION_FIRMWARE  1.4(0.290)
1           APPLICATION_FIRMWARE  1.2(0.33)      STARTUP, RUNNING
2           BOOT_FIRMWARE         1.4(0.290)
3           DIAGS_FIRMWARE        2.2.0.2

VIC-P81E-slot-1 /adapter # scope firmware
VIC-P81E-slot-1 /adapter/firmware # activate 0 
Activated adapter firmware image will boot upon the next server reset
VIC-P81E-slot-1 /adapter/firmware #

    Related Commands

    Command

    Description

    show firmware (VIC)

     

    export-vnic (VIC)

    To export the adapter configuration in the VIC Configuration Utility, use the export-vnic command.

    export-vnic path/file

    Syntax Description

    path/file

    Specifies the path to the file on the EFI file system.

    Command Default

    None

    Command Modes

    VIC adapter (/adapter)

    Command History

    Release Modification

    1.2(1)

    This command was introduced.

    Usage Guidelines

    Use this command to export the adapter configuration to a file on the EFI file system. The storage medium must be a virtually mounted USB drive, mounted in the vKVM before launching the VIC Configuration Utility.


    Note

    This command is available only in the VIC Configuration Utility, which is accessible through the EFI.

    Examples

    This example shows how to store the adapter configuration to a file on the EFI file system in the VIC Configuration Utility:

    VIC-P81E-slot-1# scope adapter
VIC-P81E-slot-1 /adapter # export-vnic /backup/P81E.xml
VIC-P81E-slot-1 /adapter #

    Related Commands

    Command

    Description

    import-vnic (VIC)

     

    import-vnic (VIC)

    To import the adapter configuration in the VIC Configuration Utility, use the import-vnic command.

    import-vnic path/file

    Syntax Description

    path/file

    Specifies the path to the file on the EFI file system.

    Command Default

    None

    Command Modes

    VIC adapter (/adapter)

    Command History

    Release Modification

    1.2(1)

    This command was introduced.

    Usage Guidelines

    Use this command to import the adapter configuration from a file on the EFI file system. The storage medium must be a virtually mounted USB drive, mounted in the vKVM before launching the VIC Configuration Utility. The imported configuration is applied upon the next server reboot.


    Note

    This command is available only in the VIC Configuration Utility, which is accessible through the EFI.

    Examples

    This example shows how to import the adapter configuration from a file on the EFI file system in the VIC Configuration Utility:

    VIC-P81E-slot-1# scope adapter
VIC-P81E-slot-1 /adapter # import-vnic /backup/P81E.xml
VIC-P81E-slot-1 /adapter #

    Related Commands

    Command

    Description

    export-vnic (VIC)

     

    reset-defaults (VIC)

    To restore the adapter to the factory default configuration in the VIC Configuration Utility, use the reset-defaults command.

    reset-defaults

    This command has no arguments or keywords.

    Command Default

    None

    Command Modes

    VIC adapter (/adapter)

    Command History

    Release Modification

    1.2(1)

    This command was introduced.

    Usage Guidelines

    Use this command to restore the adapter to the factory default configuration in the VIC Configuration Utility. The default settings are restored upon the next reboot of the server.


    Note

    This command is available only in the VIC Configuration Utility, which is accessible through the EFI.

    Examples

    This example shows how to reset the factory default configuration in the VIC Configuration Utility:

    VIC-P81E-slot-1# scope adapter
VIC-P81E-slot-1 /adapter # reset-defaults
Reset the adapter's VNIC configuration to defaults
Do you want to continue [Y/N]: Y

********************************************************
   VNIC configuration reset to defaults

   A server reset is required for the default VNIC
   configuration to take effect

********************************************************
VIC-P81E-slot-1 /adapter #

    scope adapter (VIC)

    To enter adapter command mode in the VIC Configuration Utility, use the scope adapter command.

    scope adapter

    This command has no arguments or keywords.

    Command Default

    None

    Command Modes

    VIC EXEC (/)

    Command History

    Release Modification

    1.2(1)

    This command was introduced.

    Usage Guidelines

    Use this command to enter adapter command mode in the VIC Configuration Utility.


    Note

    This command is available only in the VIC Configuration Utility, which is accessible through the EFI.

    Examples

    This example shows enter adapter command mode in the VIC Configuration Utility:

    VIC-P81E-slot-1# scope adapter
VIC-P81E-slot-1 /adapter #

    scope firmware (VIC)

    To enter firmware command mode in the VIC Configuration Utility, use the scope firmware command.

    scope firmware

    This command has no arguments or keywords.

    Command Default

    None

    Command Modes

    VIC adapter (/adapter)

    Command History

    Release Modification

    1.2(1)

    This command was introduced.

    Usage Guidelines

    This command is available only in the VIC Configuration Utility, which is accessible through the EFI.

    Examples

    This example shows enter firmware command mode in the VIC Configuration Utility:

    VIC-P81E-slot-1# scope adapter
VIC-P81E-slot-1 /adapter # scope firmware
VIC-P81E-slot-1 /adapter/firmware #

    show firmware (VIC)

    To display information about adapter firmware images in the VIC Configuration Utility, use the show firmware command.

    show firmware [ detail ]

    Syntax Description

    detail

    (Optional) Displays detailed information about adapter firmware images in list format.

    Command Default

    None

    Command Modes

    VIC adapter (/adapter)

    Command History

    Release Modification

    1.2(1)

    This command was introduced.

    Usage Guidelines

    Use this command to display adapter firmware image information in the VIC Configuration Utility, including image types, image versions, and image status.


    Note

    This command is available only in the VIC Configuration Utility, which is accessible through the EFI.

    Examples

    This example shows adapter firmware images in the VIC Configuration Utility:

    VIC-P81E-slot-1# scope adapter
VIC-P81E-slot-1 /adapter # show firmware
Image index Image type            Image version  Image status
----------- --------------------- -------------- ----------------
0           APPLICATION_FIRMWARE  1.4(0.290)
1           APPLICATION_FIRMWARE  1.2(0.33)      STARTUP, RUNNING
2           BOOT_FIRMWARE         1.4(0.290)
3           DIAGS_FIRMWARE        2.2.0.2

VIC-P81E-slot-1 /adapter #

    techsupport (VIC)

    To export adapter technical support information in the VIC Configuration Utility, use the techsupport command.

    techsupport path/file

    Syntax Description

    path/file

    Specifies the path to the file on the EFI file system.

    Command Default

    None

    Command Modes

    VIC adapter (/adapter)

    Command History

    Release Modification

    1.2(1)

    This command was introduced.

    Usage Guidelines

    Use this command to export the adapter technical support information to a file on the EFI file system. The storage medium must be a virtually mounted USB drive, mounted in the vKVM before launching the VIC Configuration Utility.


    Note

    This command is available only in the VIC Configuration Utility, which is accessible through the EFI.

    Examples

    This example shows how to store the adapter technical support information to a file on the EFI file system in the VIC Configuration Utility:

    VIC-P81E-slot-1# scope adapter
VIC-P81E-slot-1 /adapter # export-vnic /support/P81E.xml
VIC-P81E-slot-1 /adapter #

    update (VIC)

    To download an adapter firmware image in the VIC Configuration Utility, use the update command.

    update path/file

    Syntax Description

    path/file

    Specifies the path to the file on the EFI file system.

    Command Default

    None

    Command Modes

    VIC adapter (/adapter)

    Command History

    Release Modification

    1.2(1)

    This command was introduced.

    Usage Guidelines

    Use this command to download an adapter firmware image file from the EFI file system. The storage medium must be a virtually mounted USB drive, mounted in the vKVM before launching the VIC Configuration Utility. The downloaded image is stored as a backup image until activated by the activate command.


    Note

    This command is available only in the VIC Configuration Utility, which is accessible through the EFI.

    Examples

    This example shows how to download an adapter firmware image file from the EFI file system in the VIC Configuration Utility:

    VIC-P81E-slot-1# scope adapter
VIC-P81E-slot-1 /adapter # update /images/P81E
VIC-P81E-slot-1 /adapter #

    Related Commands

    Command

    Description

    activate (VIC)