esxcli system Commands

Command Description Options Help
system boot device get Get the systems boot device.
--help
Show the help message.
system coredump network check Check the status of the configured network dump server
--help
Show the help message.
system coredump network get Get the currently configured parameters for network coredump, if enabled.
--help
Show the help message.
system coredump network set Set the parameters used for network core dump
--enable | -e
Enable network dump. This option cannot be specified when setting the dump parameters below.
--interface-name | -v
An active interface to be used for the network core dump. Required option when setting dump parameters.
--server-ipv4 | -i
IP address of the core dump server. Required option when setting dump parameters.
--server-port | -o
Port on which the core dump server is listening. (Optional)
--help
Show the help message.
system coredump partition get Get one of the dump partition configured values. This command will print either the active dump partition or the configured dump partition depending on the flags passed.
--help
Show the help message.
system coredump partition list List all of the partitions on the system that have a partition type matching the VMware Core partition type. Also indicate which partition, if any, is being used as the system's dump partition and which is configured to be used at next boot.
--help
Show the help message.
system coredump partition set Set the specific VMkernel dump partition for this system. This will configure the dump partition for the next boot. This command will change the active dump partition to the partition specified.
--enable | -e
Enable or disable the VMkernel dump partition. This option cannot be specified when setting or unconfiguring the dump partition.
--partition | -p
The name of the partition to use. This should be a device name with a partition number at the end. Example: naa.xxxxx:1
--smart | -s
This flag can be used only with --enable=true. It will cause the best available partition to be selected using the smart selection algorithm.
--unconfigure | -u
Set the dump partition into an unconfigured state. This will remove the current configured dump partition for the next boot. This will result in the smart activate algorithm being used at the next boot.
--help
Show the help message.
system hostname get Get the host, domain or fully qualified name of the ESX host.
--help
Show the help message.
system hostname set This command allows the user to set the hostname, domain name or fully qualified domain name of the ESX host.
--domain | -d
The domain name to set for the ESX host. This option is mutually exclusive with the --fqdn option.
--fqdn | -f
Set the fully qualified domain name of the ESX host.
--host | -H
The host name to set for the ESX host. This name should not contain the DNS domain name of the host and can only contain letters, numbers and '-'. NOTE this is not the fully qualified name, that can be set with the --fqdn option. This option is mutually exclusive with the --fqdn option.
--help
Show the help message.
system maintenanceMode get Get the maintenance mode state of the system.
--help
Show the help message.
system maintenanceMode set Enable or disable the maintenance mode of the system.
--enable | -e
enable maintenance mode (required)
--timeout | -t
Time to perform operation in seconds (default 60 seconds)
--help
Show the help message.
system module get Show the ELF header information for the given VMkernel module.
--module | -m
The name of the VMkernel module to get the option string for. (required)
--help
Show the help message.
system module list List the VMkernel modules that the system knows about.
--enabled | -e
List the enabled / disabled VMkernel modules and device drivers.
--loaded | -l
List the loaded / not loaded VMkernel modules and device drivers.
--help
Show the help message.
system module load Load a VMkernel module with the given name if it is enabled. If the module is disabled then the use of --force is required to load the module.
--force | -f
Ignore the enabled/disabled state of this module and force it to load.
--module | -m
The name of the VMkernel module to load. (required)
--help
Show the help message.
system module parameters list List the parameters, a descriptions of each parameter supported for a given module name and the user defined value for each parameter.
--module | -m
The name of the VMkernel module to get the option string for. (required)
--help
Show the help message.
system module parameters set Set the load time parameters for the given VMkernel module.
--force | -f
Skip VMkernel module validity checks and set parameters for a module (or alias) with the given name.
--module | -m
The name of the VMkernel module to set parameters for. (required)
--parameter-string | -p
The string containing the parameters for this module. (required)
--help
Show the help message.
system module set Allow enabling and disabling of a VMkernel module.
--enabled | -e
Set to true to enable the module, set to false to disable the module. (required)
--force | -f
Skip VMkernel module validity checks and set options for a module (or alias) with the given name.
--module | -m
The name of the VMkernel module to set options for. (required)
--help
Show the help message.
system process list List the VMkernel UserWorld processes currently on the host.
--help
Show the help message.
system process stats load get System load average over the last 1, 5 and 15 minutes.
--help
Show the help message.
system process stats running get Number of currently running processes.
--help
Show the help message.
system secpolicy domain list List the enforcement level for each domain.
--help
Show the help message.
system secpolicy domain set Set the enforcement level for a domain in the system. Any option specified here is not persistent and will not survive a reboot of the system.
--all-domains | -a
All domains.
--level | -l
The enforcement level. (required)
--name | -n
The domain name.
--help
Show the help message.
system settings advanced list List the advanced options available from the VMkernel.
--delta | -d
Only display options whose values differ from their default.
--option | -o
Only get the information for a single VMkernel advanced option.
--tree | -t
Limit the list of advanced option to a specific sub tree.
--help
Show the help message.
system settings advanced set Set the value of an advanced option.
--default | -d
Reset the option to its default value.
--int-value | -i
If the option is an integer value use this option.
--option | -o
The name of the option to set the value of. Example: "/Misc/HostName" (required)
--string-value | -s
If the option is a string use this option.
--help
Show the help message.
system settings kernel list List VMkernel kernel settings.
--delta | -d
Only display options whose values differ from their default.
--option | -o
The name of the VMkernel kernel setting to get.
--help
Show the help message.
system settings kernel set Set a VMKernel setting.
--setting | -s
The name of the VMKernel setting to set. (required)
--value | -v
The value to set the setting to. (required)
--help
Show the help message.
system settings keyboard layout get Get the keyboard layout
--help
Show the help message.
system settings keyboard layout list List the keyboard layout
--help
Show the help message.
system settings keyboard layout set Set the keyboard layout
--layout | -l
The name of the layout to set
--no-persist
Only apply this layout for the current boot
--help
Show the help message.
system shutdown poweroff Power off the system. The host must be in maintenance mode.
--delay | -d
Delay interval in seconds
--reason | -r
Reason for performing the operation (required)
--help
Show the help message.
system shutdown reboot Reboot the system. The host must be in maintenance mode.
--delay | -d
Delay interval in seconds
--reason | -r
Reason for performing the operation (required)
--help
Show the help message.
system snmp get Get SNMP Agent configuration
--help
Show the help message.
system snmp hash Generate localized hash values based on this agents snmp engine id.
--auth-hash | -A
Provide filename to secret for authentication hash, use in set --users (required)
--priv-hash | -X
Provide filename to secret for privacy hash, use in set --users
--raw-secret | -r
Make -A and -X flags read raw secret from command line instead of file.
--help
Show the help message.
system snmp set This command allows the user to set up ESX SNMP agent.
--authentication | -a
Set default authentication protocol. Values: none, MD5, SHA1
--communities | -c
Set up to ten communities each no more than 64 characters. Format is: community1[,community2,...] (this overwrites previous settings)
--enable | -e
Start or stop SNMP service. Values: [yes|no, true|false, 0|1]
--engineid | -E
Set SNMPv3 engine id. Must be at least 5 to 32 hexidecimal characters.
--hwsrc | -y
Where to source hardware events from IPMI sensors or CIM Indications. One of: indications|sensors
--loglevel | -l
System Agent syslog logging level: debug|info|warning|error
--notraps | -n
Comma separated list of trap oids for traps not to be sent by agent. Use value 'reset' to clear setting
--port | -p
Set UDP port to poll snmp agent on. The default is udp/161
--privacy | -x
Set default privacy protocol. Values: none, AES128
--remote-users | -R
Set up to five inform user ids. Format is: user/auth-proto/-|auth-hash/priv-proto/-|priv-hash/engine-id[,...] Where user is 32 chars max. auth-proto is none|MD5|SHA1, priv-proto is none|AES. '-' indicates no hash. engine-id is hex string '0x0-9a-f' up to 32 chars max.
--reset | -r
Return agent configuration to factory defaults
--syscontact | -C
System contact string as presented in sysContact.0. Up to 255 characters
--syslocation | -L
System location string as presented in sysLocation.0. Up to 255 characters.
--targets | -t
Set up to three targets to send SNMPv1 traps to. Format is: ip-or-hostname[@port]/community[,...] The default port is udp/162. (this overwrites previous settings)
--users | -u
Set up to five local users. Format is: user/-|auth-hash/-|priv-hash/model[,...] Where user is 32 chars max. '-' indicates no hash. Model is one of (none|auth|priv).
--v3targets | -i
Set up to three SNMPv3 notification targets. Format is: ip-or-hostname[@port]/remote-user/security-level/trap|inform[,...].
--help
Show the help message.
system snmp test Verify ESX SNMP notifications can be delivered to target destinations.
--auth-hash | -A
Optionally test authentication secret generates matching hash for user
--priv-hash | -X
Optionally test privacy secret generates matching hash for user
--raw-secret | -r
Make -A and -X flags read raw secret from command line instead of file.
--user | -u
Validate a given SNMPv3 user name exists
--help
Show the help message.
system stats uptime get Disply the number of microseconds the system has been running.
--help
Show the help message.
system syslog config get Show the current global configuration values
--help
Show the help message.
system syslog config logger list Show the currently configured sub-loggers
--help
Show the help message.
system syslog config logger set Set configuration options for a specific sub-logger
--id
The id of the logger to configure (required)
--reset
Reset values to default
--rotate
Number of rotated logs to keep for a specific logger (requires --id)
--size
Set size of logs before rotation for a specific logger, in KiB (requires --id)
--help
Show the help message.
system syslog config set Set global log configuration options
--default-rotate
Default number of rotated local logs to keep
--default-size
Default size of local logs before rotation, in KiB
--logdir
The directory to output local logs to
--logdir-unique
Place logs in a unique subdirectory of logdir, based on hostname
--loghost
The remote host(s) to send logs to
--reset
Reset values to default
--help
Show the help message.
system syslog mark Mark all logs with the specified string
--message | -s
The message to place in the logs (required)
--help
Show the help message.
system syslog reload Reload the log daemon to apply any new configuration options
--help
Show the help message.
system time get Disply the current system time.
--help
Show the help message.
system time set Set the system clock time. Any missing parameters will default to the current time
--day | -d
Day
--hour | -H
Hour
--min | -m
Minute
--month | -M
Month
--sec | -s
Second
--year | -y
Year
--help
Show the help message.
system uuid get Get the system UUID.
--help
Show the help message.
system version get Display the product name, version and build information.
--help
Show the help message.
system visorfs get Obtain status information on the memory filesystem as a whole.
--help
Show the help message.
system visorfs ramdisk add Add a new Visorfs RAM disk to the ESXi Host and mount it.
--max-size | -M
Maximum size (max reservation in MiB) (required)
--min-size | -m
Minimum size (min reservation in MiB) (required)
--name | -n
Name for the ramdisk (required)
--permissions | -p
Permissions for the root of the ramdisk (mode) (required)
--target | -t
Mountpoint for the ramdisk (absolute path) (required)
--help
Show the help message.
system visorfs ramdisk list List the RAM disks used by the host.
--help
Show the help message.
system visorfs ramdisk remove Remove a Visorfs RAM disk from the ESXi Host.
--target | -t
Mountpoint for the ramdisk (absolute path) (required)
--help
Show the help message.
system visorfs tardisk list List the tardisks used by the host.
--help
Show the help message.
system welcomemsg get Get the Welcome Message for DCUI.
--help
Show the help message.
system welcomemsg set Set the Welcome Message for DCUI.
--message | -m
Welcome Message String. (required)
--help
Show the help message.