Managed Object - HostKernelModuleSystem(vim.host.KernelModuleSystem)

Property of: HostConfigManager
See also: KernelModuleInfo
Since: VI API 2.5u2

Managed Object Description

The KernelModuleSystem managed object controls the configuration of kernel modules on the host.

Properties

Name	Type	Description
None

Methods

Methods defined in this Managed Object
QueryConfiguredModuleOptionString, QueryModules, UpdateModuleOptionString

QueryConfiguredModuleOptionString(queryConfiguredModuleOptionString)

Query the options configured to be passed to the kernel module when loaded. Note that this is not necessarily the option string currently in use by the kernel module.

Required Privileges: Host.Config.Settings

Parameters

Name

Type

Description

_this

ManagedObjectReference

A reference to the HostKernelModuleSystem used to make the method call.

name P

xsd:string

Module name.

Since VI API 2.5u2

P Required privilege: name

Return Value

Type	Description
xsd:string	Option string to be passed to the kernel module at load time.

Faults

Type	Description
NotFound	Thrown if the kernel module does not exist on the host.
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="QueryConfiguredModuleOptionString" type="vim25:QueryConfiguredModuleOptionStringRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="QueryConfiguredModuleOptionStringResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="xsd:string"/>
                     </sequence>
                  </complexType>
               </element>

QueryModules(queryModules)

Query the set of modules on the host.

Required Privileges: Host.Config.Settings
Since: vSphere API 4.0

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the HostKernelModuleSystem used to make the method call.

Return Value

Type	Description
KernelModuleInfo[]

Faults

Type	Description
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="QueryModules" type="vim25:QueryModulesRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="QueryModulesResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="vim25:KernelModuleInfo" minOccurs="0" maxOccurs="unbounded"/>
                     </sequence>
                  </complexType>
               </element>

UpdateModuleOptionString(updateModuleOptionString)

Specifies the options to be passed to the kernel module when loaded.

Required Privileges: Host.Config.Settings

Parameters

Name

Type

Description

_this

ManagedObjectReference

A reference to the HostKernelModuleSystem used to make the method call.

name P

xsd:string

Module name.

Since VI API 2.5u2

options P

xsd:string

Option string to be passed to the kernel module at load time.

Since VI API 2.5u2

PRequired privilege - see tooltip for details

Return Value

Type	Description
None

Faults

Type	Description
NotFound	Thrown if the kernel module does not exist on the host.
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="UpdateModuleOptionString" type="vim25:UpdateModuleOptionStringRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="UpdateModuleOptionStringResponse">
                  <complexType/>
               </element>