NAME

vicfg-module - enable configuration of VMkernel module options


SYNOPSIS

 vicfg-module [<connection_options>]
    [--get-options <module_name> |
     --help |
     --list |
     --set-options "<option> <value>" <module_name> |
     --vihost <esx_host> ]


DESCRIPTION

The vicfg-module command supports setting and retrieving VMkernel module options. This command is a vSphere CLI implementation of the esxcfg-module service console command, but it supports only some of the options esxcfg-module supports. The command is commonly used when VMware Technical Support, a Knowledge Base article, or VMware documentation instruct you to do so.


OPTIONS

connection_options

Specifies the target server and authentication information if required. Run vicfg-module --help for a list of all connection options.

--get-options | -g <module_name>

Returns the option string configured to be passed to the module when it is loaded. This string is not necessarily the option string currently in use by the module.

--help

Prints a help message for each command-specific and each connection option. Calling the script with no arguments or with --help has the same effect.

--list | -l

Lists the set of modules on the host (valid for vSphere 4.0 and later).

--set-options | -s "<option>=<value>" <module_name>

Specifies the option string to be passed to the module when the module is loaded.

--vihost | -h

When you run a vSphere CLI command with the --server option pointing to a vCenter Server system, use --vihost to specify the ESX/ESXi host to run the command against.


EXAMPLES

The following examples assume you are specifying connection options, either explicitly or, for example, by specifying the server, user name, and password. Use vicfg-module --help for a list of common options including connection options.

Configure a supported NIC to use NetQueue:

 vicfg-module <conn_options> -s "intr_type=2 rx_ring_num=8" s2io

Verify that NetQueue has been configured:

 vicfg-module <conn_options> -g s2io

List the set of modules on the host:

 vicfg-module <conn_options> -l