Difference between revisions of "ESXi - 6.7 esxcli hardware"

From Da Nerd Mage Wiki
Jump to navigation Jump to search
 
(10 intermediate revisions by the same user not shown)
Line 1: Line 1:
= hardware =
VMKernel hardware properties and commands for configuring hardware.<br>
Device manager commands
== bootdevice ==
== bootdevice ==
* '''list'''
* '''list'''
Line 10: Line 9:
: Disply the current hardware clock time.
: Disply the current hardware clock time.
:* <code>esxcli hardware clock get</code>
:* <code>esxcli hardware clock get</code>
* '''set'''
: '''set'''
: Set the hardware clock time. Any missing parameters will default to the current time.
:: Set the hardware clock time. Any missing parameters will default to the current time.
:* <code>esxcli hardware clock set '''TIME'''</code>
::* <code>esxcli hardware clock set '''TIME'''</code>
:: You must specify one of year, month, day, hour, minute or second
'''TIME'''
You must specify one of year, month, day, hour, minute or second


== cpu ==
== cpu ==
* '''list'''
:* '''list'''
: List all of the CPUs on this host.
:: List all of the CPUs on this host.
:* <code>esxcli hardware cpu list</code>
::* <code>esxcli hardware cpu list</code>


=== cpuid ===
=== cpuid ===
* '''get'''
:* '''get'''
: Get subset of CPUID fields for a CPU (deprecated, use: esxcli hardware cpu cpuid raw list).
:: Get subset of CPUID fields for a CPU (deprecated, use: esxcli hardware cpu cpuid raw list).
:* <code>esxcli hardware cpu cpuid get -c '''CPUID'''</code>
::* <code>esxcli hardware cpu cpuid get '''CPUID'''</code>


==== raw ====
==== raw ====
* '''list'''
:* '''list'''
: Get all CPUID fields for a CPU.
:: Get all CPUID fields for a CPU.
:* <code>esxcli hardware cpu cpuid raw list -c '''CPUID'''</code>
::* <code>esxcli hardware cpu cpuid raw list '''CPUID'''</code>


=== global ===
=== global ===
* '''get'''
:* '''get'''
: Get properties that are global to all CPUs.
:: Get properties that are global to all CPUs.
:* <code>esxcli hardware cpu global get</code>
::* <code>esxcli hardware cpu global get</code>
* '''set'''
:: '''set'''
: Set properties that are global to all CPUs.
::: Set properties that are global to all CPUs.
:* <code>esxcli hardware cpu global set -t '''HYPERTHREADING'''</code>
:::* <code>esxcli hardware cpu global set '''HYPERTHREADING'''</code>
'''CPUID'''
  -c{{!}}--cpu=<long>      The ID of the CPU to query for CPUID data. (required)
'''HYPERTHREADING'''
  -t{{!}}--hyperthreading=<bool>
                        Enable or disable hyperthreading (required)


== ipmi ==
== ipmi ==
=== bmc ===
=== bmc ===
* '''get'''
::* '''get'''
: Get IPMI Baseboard Management Controller (BMC) properties.
::: Get IPMI Baseboard Management Controller (BMC) properties.
:* <code>esxcli hardware ipmi bmc get</code>
:::* <code>esxcli hardware ipmi bmc get</code>
* '''set'''
::: '''set'''
: Set IPMI Baseboard Management Controller (BMC) properties. Changes take effect immediately.
:::: Set IPMI Baseboard Management Controller (BMC) properties. Changes take effect immediately.
:* <code>esxcli hardware ipmi bmc set</code>
::::* <code>esxcli hardware ipmi bmc set</code>


=== fru ===
=== fru ===
* '''get'''
:::* '''get'''
: Get IPMI Field Replaceable Unit (FRU) device details.
:::: Get IPMI Field Replaceable Unit (FRU) device details.
:* <code>esxcli hardware ipmi fru get</code>
::::* <code>esxcli hardware ipmi fru get</code>
* '''list'''
:::: '''list'''
: List IPMI Field Replaceable Unit (FRU) inventory.
::::: List IPMI Field Replaceable Unit (FRU) inventory.
:* <code>esxcli hardware ipmi fru list</code>
:::::* <code>esxcli hardware ipmi fru list</code>


=== sdr ===
=== sdr ===
* '''get'''
::::* '''get'''
: Get IPMI Sensor Data Repository (SDR) properties.
::::: Get IPMI Sensor Data Repository (SDR) properties.
:* <code>esxcli hardware ipmi sdr get</code>
:::::* <code>esxcli hardware ipmi sdr get</code>
* '''list'''
::::: '''list'''
: List IPMI Sensor Data Repository.
:::::: List IPMI Sensor Data Repository.
:* <code>esxcli hardware ipmi sdr list</code>
::::::* <code>esxcli hardware ipmi sdr list</code>


=== sel ===
=== sel ===
* '''clear'''
:::::* '''clear'''
: Clear IPMI System Event Log.
:::::: Clear IPMI System Event Log.
:* <code>esxcli hardware ipmi sel clear</code>
::::::* <code>esxcli hardware ipmi sel clear</code>
* '''get'''
:::::: '''get'''
: Get IPMI System Event Log (SEL) properties.
::::::: Get IPMI System Event Log (SEL) properties.
:* <code>esxcli hardware ipmi sel get</code>
:::::::* <code>esxcli hardware ipmi sel get</code>
* '''list'''
::::::: '''list'''
: List IPMI System Event Log.
:::::::: List IPMI System Event Log.
:* <code>esxcli hardware ipmi sel list</code>
::::::::* <code>esxcli hardware ipmi sel list</code>


== memory ==
== memory ==
* '''get'''
:::::::* '''get'''
: Get information about memory.
:::::::: Get information about memory.
:* <code>esxcli hardware memory get</code>
::::::::* <code>esxcli hardware memory get</code>


== pci ==
== pci ==
* '''list'''
:::::::* '''list'''
: List all of the PCI devices on this host.
:::::::: List all of the PCI devices on this host.
:* <code>esxcli hardware pci list</code>
::::::::* <code>esxcli hardware pci list</code>


== platform ==
== platform ==
* '''get'''
:::::::* '''get'''
: Get information about the platform
:::::::: Get information about the platform
:* <code>esxcli hardware platform get</code>
::::::::* <code>esxcli hardware platform get</code>


== power ==
== power ==
* '''get'''
:::::::* '''get'''
: Display the current power policy.
:::::::: Display the current power policy.
:* <code>esxcli hardware power policy get</code>
::::::::* <code>esxcli hardware power policy get</code>
* '''set'''
:::::::: '''set'''
: Set the power policy.
::::::::: Set the power policy.
:* <code>esxcli hardware power policy set</code>
:::::::::* <code>esxcli hardware power policy set '''CHOICE'''</code>
 
=== choices ===
=== choices ===
* '''list'''
::::::::* '''list'''
: List the power policies.
::::::::: List the power policies.
:* <code>esxcli hardware power policy choices list '''[CHOICE]'''</code>
:::::::::* <code>esxcli hardware power policy choices list</code>
 
  '''CHOICE'''
  '''[CHOICE]'''
   -i{{!}}--id=<long>        Power policy numeric id
   -i|--id=<long>        Power policy numeric id
   -n{{!}}--name=<str>      Power policy name
   -n|--name=<str>      Power policy name
   -s{{!}}--short-name=<str> Power policy short name
   -s|--short-name=<str> Power policy short name


== smartcard ==
== smartcard ==
=== certificate ===
=== certificate ===
* '''list'''
::::::::* '''list'''
: Certificates from inserted smart cards.
::::::::: Certificates from inserted smart cards.
:* <code>esxcli hardware smartcard certificate list</code>
:::::::::* <code>esxcli hardware smartcard certificate list</code>


=== info ===
=== info ===
* '''get'''
::::::::* '''get'''
: Information about the smart card subsystem.
::::::::: Information about the smart card subsystem.
:* <code>esxcli hardware smartcard info get</code>
:::::::::* <code>esxcli hardware smartcard info get</code>


=== slot ===
=== slot ===
* '''list'''
::::::::* '''list'''
: Information about connected smart card readers.
::::::::: Information about connected smart card readers.
:* <code>esxcli hardware smartcard slot list</code>
:::::::::* <code>esxcli hardware smartcard slot list</code>


=== token ===
=== token ===
* '''list'''
::::::::* '''list'''
: Information about inserted smart cards.
::::::::: Information about inserted smart cards.
:* <code>esxcli hardware smartcard token list</code>
:::::::::* <code>esxcli hardware smartcard token list</code>


== tpm ==
== tpm ==
=== tag ===
=== tag ===
* '''get'''
::::::::* '''get'''
: Get the TPM's tag (from index 0x40000010).
::::::::: Get the TPM's tag (from index 0x40000010).
:* <code>esxcli hardware tpm tag get</code>
:::::::::* <code>esxcli hardware tpm tag get</code>
* '''set'''
::::::::: '''set'''
: Set the TPM's tag (at index 0x40000010).
:::::::::: Set the TPM's tag (at index 0x40000010).
:* <code>esxcli hardware tpm tag set '''[DATA]'''</code>
::::::::::* <code>esxcli hardware tpm tag set '''DATA'''</code>
* '''clear'''
:::::::::: '''clear'''
: Clear the TPM's tag (at index 0x40000010).
::::::::::: Clear the TPM's tag (at index 0x40000010).
:* <code>esxcli hardware tpm tag clear</code>
:::::::::::* <code>esxcli hardware tpm tag clear</code>
 
  '''DATA'''
  '''[DATA]'''
   -d{{!}}--data=<str>      The tag data to store in the TPM (with hexadecimal byte encoding).
   -d|--data=<str>      The tag data to store in the TPM (with hexadecimal byte encoding).
                         (required)
                         (required)


== trustedboot ==
== trustedboot ==
::::::::::* '''get'''
::::::::::: Information about the status of trusted boot. (TPM, DRTM status)
:::::::::::* <code>esxcli hardware trustedboot get</code>
== usb ==
== usb ==
=== passthrough ===
==== device ====
::::::::::* '''list'''
::::::::::: List usb devices and their passthrough status
:::::::::::* <code>esxcli hardware usb passthrough device list</code>
::::::::::: '''disable'''
:::::::::::: Disable usb passthrough
::::::::::::* <code>esxcli hardware usb passthrough device disable '''DEVICE'''</code>
:::::::::::: '''enable'''
::::::::::::: Enable usb passthrough
:::::::::::::* <code>esxcli hardware usb passthrough device enable '''DEVICE'''</code>
'''DEVICE'''
  -d{{!}}--device=<str>    The device you wish to enable/disable passthrough for.
                        Please enter the information of the device in the format
                        Bus#:Dev#:vendorId:productId using hexadecimal values(as shown by the list
                        command) (required)
                        Please note that the enable command only makes the device eligible for passthrough.
                        The device can be connected to the VM only if usbarbitrator is running. See
                        /etc/init.d/usbarbitrator status  to check the status of the usbarbitrator.

Latest revision as of 20:06, 10 February 2022

VMKernel hardware properties and commands for configuring hardware.

bootdevice

  • list
List the boot device order, if available, for this host.
  • esxcli hardware bootdevice list

clock

  • get
Disply the current hardware clock time.
  • esxcli hardware clock get
set
Set the hardware clock time. Any missing parameters will default to the current time.
  • esxcli hardware clock set TIME
TIME
You must specify one of year, month, day, hour, minute or second

cpu

  • list
List all of the CPUs on this host.
  • esxcli hardware cpu list

cpuid

  • get
Get subset of CPUID fields for a CPU (deprecated, use: esxcli hardware cpu cpuid raw list).
  • esxcli hardware cpu cpuid get CPUID

raw

  • list
Get all CPUID fields for a CPU.
  • esxcli hardware cpu cpuid raw list CPUID

global

  • get
Get properties that are global to all CPUs.
  • esxcli hardware cpu global get
set
Set properties that are global to all CPUs.
  • esxcli hardware cpu global set HYPERTHREADING
CPUID
 -c|--cpu=<long>       The ID of the CPU to query for CPUID data. (required)
HYPERTHREADING
 -t|--hyperthreading=<bool>
                       Enable or disable hyperthreading (required)

ipmi

bmc

  • get
Get IPMI Baseboard Management Controller (BMC) properties.
  • esxcli hardware ipmi bmc get
set
Set IPMI Baseboard Management Controller (BMC) properties. Changes take effect immediately.
  • esxcli hardware ipmi bmc set

fru

  • get
Get IPMI Field Replaceable Unit (FRU) device details.
  • esxcli hardware ipmi fru get
list
List IPMI Field Replaceable Unit (FRU) inventory.
  • esxcli hardware ipmi fru list

sdr

  • get
Get IPMI Sensor Data Repository (SDR) properties.
  • esxcli hardware ipmi sdr get
list
List IPMI Sensor Data Repository.
  • esxcli hardware ipmi sdr list

sel

  • clear
Clear IPMI System Event Log.
  • esxcli hardware ipmi sel clear
get
Get IPMI System Event Log (SEL) properties.
  • esxcli hardware ipmi sel get
list
List IPMI System Event Log.
  • esxcli hardware ipmi sel list

memory

  • get
Get information about memory.
  • esxcli hardware memory get

pci

  • list
List all of the PCI devices on this host.
  • esxcli hardware pci list

platform

  • get
Get information about the platform
  • esxcli hardware platform get

power

  • get
Display the current power policy.
  • esxcli hardware power policy get
set
Set the power policy.
  • esxcli hardware power policy set CHOICE

choices

  • list
List the power policies.
  • esxcli hardware power policy choices list
CHOICE
 -i|--id=<long>        Power policy numeric id
 -n|--name=<str>       Power policy name
 -s|--short-name=<str> Power policy short name

smartcard

certificate

  • list
Certificates from inserted smart cards.
  • esxcli hardware smartcard certificate list

info

  • get
Information about the smart card subsystem.
  • esxcli hardware smartcard info get

slot

  • list
Information about connected smart card readers.
  • esxcli hardware smartcard slot list

token

  • list
Information about inserted smart cards.
  • esxcli hardware smartcard token list

tpm

tag

  • get
Get the TPM's tag (from index 0x40000010).
  • esxcli hardware tpm tag get
set
Set the TPM's tag (at index 0x40000010).
  • esxcli hardware tpm tag set DATA
clear
Clear the TPM's tag (at index 0x40000010).
  • esxcli hardware tpm tag clear
DATA
 -d|--data=<str>       The tag data to store in the TPM (with hexadecimal byte encoding).
                       (required)

trustedboot

  • get
Information about the status of trusted boot. (TPM, DRTM status)
  • esxcli hardware trustedboot get

usb

passthrough

device

  • list
List usb devices and their passthrough status
  • esxcli hardware usb passthrough device list
disable
Disable usb passthrough
  • esxcli hardware usb passthrough device disable DEVICE
enable
Enable usb passthrough
  • esxcli hardware usb passthrough device enable DEVICE
DEVICE
 -d|--device=<str>     The device you wish to enable/disable passthrough for.

                       Please enter the information of the device in the format
                       Bus#:Dev#:vendorId:productId using hexadecimal values(as shown by the list
                       command) (required)

                       Please note that the enable command only makes the device eligible for passthrough.
                       The device can be connected to the VM only if usbarbitrator is running. See
                       /etc/init.d/usbarbitrator status  to check the status of the usbarbitrator.