esxcli software Commands

Command Description Options Help
software acceptance get Gets the host acceptance level. This controls what VIBs will be allowed on a host.
--help | -h
Show the help message.
software acceptance set Sets the host acceptance level. This controls what VIBs will be allowed on a host.
--help | -h
Show the help message.
--level
Specifies the acceptance level to set. Should be one of certified / accepted / partner / community.
software profile get Display the installed image profile and host acceptance level.
--help | -h
Show the help message.
--pending
Displays information for the ESXi image which becomes active after a reboot, or nothing if the pending-reboot image has not been created yet. If not specified, information from the current ESXi image in memory will be returned.
software profile install Installs or applies an image profile from a depot to this host. This command completely replaces the installed image with the image defined by the new image profile, and may result in the loss of installed VIBs. To preserve installed VIBs, use profile update instead. WARNING: If your installation requires a reboot, you need to disable HA first.
--depot | -d
Specifies full remote URLs of the depot index.xml or server file path pointing to an offline bundle .zip file.
--dry-run
Performs a dry-run only. Report the VIB-level operations that would be performed, but do not change anything in the system.
--force | -f
Bypasses checks for package dependencies, conflicts, obsolescence, and acceptance levels. Really not recommended unless you know what you are doing. Use of this option will result in a warning being displayed in the vSphere Client.
--help | -h
Show the help message.
--maintenance-mode
Pretends that maintenance mode is in effect. Otherwise, installation will stop for live installs that require maintenance mode. This flag has no effect for reboot required remediations.
--no-live-install
Forces an install to /altbootbank even if the VIBs are eligible for live installation or removal. Will cause installation to be skipped on PXE-booted hosts.
--no-sig-check
Bypasses acceptance level verification, including signing. Use of this option poses a large security risk and will result in a SECURITY ALERT warning being displayed in the vSphere Client.
--ok-to-remove
Allows the removal of installed VIBs as part of applying the image profile. If not specified, esxcli will error out if applying the image profile results in the removal of installed VIBs.
--profile | -p
Specifies the name of the image profile to install.
--proxy
Specifies a proxy server to use for HTTP, FTP, and HTTPS connections. The format is proxy-url:port.
software profile update Updates the host with VIBs from an image profile in a depot. Installed VIBs may be upgraded (or downgraded if --allow-downgrades is specified), but they will not be removed. Any VIBs in the image profile which are not related to any installed VIBs will be added to the host. WARNING: If your installation requires a reboot, you need to disable HA first.
--allow-downgrades
If this option is specified, then the VIBs from the image profile which update, downgrade, or are new to the host will be installed. If the option is not specified, then the VIBs which update or are new to the host will be installed.
--depot | -d
Specifies full remote URLs of the depot index.xml or server file path pointing to an offline bundle .zip file.
--dry-run
Performs a dry-run only. Report the VIB-level operations that would be performed, but do not change anything in the system.
--force | -f
Bypasses checks for package dependencies, conflicts, obsolescence, and acceptance levels. Really not recommended unless you know what you are doing. Use of this option will result in a warning being displayed in the vSphere Client.
--help | -h
Show the help message.
--maintenance-mode
Pretends that maintenance mode is in effect. Otherwise, installation will stop for live installs that require maintenance mode. This flag has no effect for reboot required remediations.
--no-live-install
Forces an install to /altbootbank even if the VIBs are eligible for live installation or removal. Will cause installation to be skipped on PXE-booted hosts.
--no-sig-check
Bypasses acceptance level verification, including signing. Use of this option poses a large security risk and will result in a SECURITY ALERT warning being displayed in the vSphere Client.
--profile | -p
Specifies the name of the image profile to update the host with.
--proxy
Specifies a proxy server to use for HTTP, FTP, and HTTPS connections. The format is proxy-url:port.
software profile validate Validates the current image profile on the host against an image profile in a depot.
--depot | -d
Specifies full remote URLs of the depot index.xml or server file path pointing to an offline bundle .zip file.
--help | -h
Show the help message.
--profile | -p
Specifies the name of the image profile to validate the host with.
--proxy
Specifies a proxy server to use for HTTP, FTP, and HTTPS connections. The format is proxy-url:port.
software sources profile get Display details about an image profile from the depot.
--depot | -d
Specifies full remote URLs of the depot index.xml or server file path pointing to an offline bundle .zip file.
--help | -h
Show the help message.
--profile | -p
Specifies the name of the image profile to display.
--proxy
Specifies a proxy server to use for HTTP, FTP, and HTTPS connections. The format is proxy-url:port.
software sources profile list List all the image profiles in a depot.
--depot | -d
Specifies full remote URLs of the depot index.xml or server file path pointing to an offline bundle .zip file.
--help | -h
Show the help message.
--proxy
Specifies a proxy server to use for HTTP, FTP, and HTTPS connections. The format is proxy-url:port.
software sources vib get Displays detailed information about one or more VIB packages in the depot
--depot | -d
Specifies full remote URLs of the depot index.xml or server file path pointing to an offline bundle .zip file.
--help | -h
Show the help message.
--proxy
Specifies a proxy server to use for HTTP, FTP, and HTTPS connections. The format is proxy-url:port.
--vibname | -n
Specifies one or more VIBs in the depot to display more information about. If this option is not specified, then all of the VIB packages from the depot will be displayed. Must be one of the following forms: name, name:version, vendor:name, or vendor:name:version.
--viburl | -v
Specifies one or more URLs to VIB packages to display information about. http:, https:, ftp:, and file: are all supported.
software sources vib list List all the VIBs from depots.
--depot | -d
Specifies full remote URLs of the depot index.xml or server file path pointing to an offline bundle .zip file.
--help | -h
Show the help message.
--proxy
Specifies a proxy server to use for HTTP, FTP, and HTTPS connections. The format is proxy-url:port.
software vib get Displays detailed information about one or more installed VIBs
--help | -h
Show the help message.
--pending
Displays information for the ESXi image which becomes active after a reboot, or nothing if the pending-reboot image has not been created yet. If not specified, information from the current ESXi image in memory will be returned.
--vibname | -n
Specifies one or more installed VIBs to display more information about. If this option is not specified, then all of the installed VIBs will be displayed. Must be one of the following forms: name, name:version, vendor:name, or vendor:name:version.
software vib install Installs VIB packages from a URL or depot. VIBs may be installed, upgraded, or downgraded. WARNING: If your installation requires a reboot, you need to disable HA first.
--depot | -d
Specifies full remote URLs of the depot index.xml or server file path pointing to an offline bundle .zip file.
--dry-run
Performs a dry-run only. Report the VIB-level operations that would be performed, but do not change anything in the system.
--force | -f
Bypasses checks for package dependencies, conflicts, obsolescence, and acceptance levels. Really not recommended unless you know what you are doing. Use of this option will result in a warning being displayed in the vSphere Client.
--help | -h
Show the help message.
--maintenance-mode
Pretends that maintenance mode is in effect. Otherwise, installation will stop for live installs that require maintenance mode. This flag has no effect for reboot required remediations.
--no-live-install
Forces an install to /altbootbank even if the VIBs are eligible for live installation or removal. Will cause installation to be skipped on PXE-booted hosts.
--no-sig-check
Bypasses acceptance level verification, including signing. Use of this option poses a large security risk and will result in a SECURITY ALERT warning being displayed in the vSphere Client.
--proxy
Specifies a proxy server to use for HTTP, FTP, and HTTPS connections. The format is proxy-url:port.
--vibname | -n
Specifies VIBs from a depot, using one of the following forms: name, name:version, vendor:name, or vendor:name:version.
--viburl | -v
Specifies one or more URLs to VIB packages to install. http:, https:, ftp:, and file: are all supported.
software vib list Lists the installed VIB packages
--help | -h
Show the help message.
--pending
Displays information for the ESXi image which becomes active after a reboot, or nothing if the pending-reboot image has not been created yet. If not specified, information from the current ESXi image in memory will be returned.
software vib remove Removes VIB packages from the host. WARNING: If your installation requires a reboot, you need to disable HA first.
--dry-run
Performs a dry-run only. Report the VIB-level operations that would be performed, but do not change anything in the system.
--force | -f
Bypasses checks for package dependencies, conflicts, obsolescence, and acceptance levels. Really not recommended unless you know what you are doing. Use of this option will result in a warning being displayed in the vSphere Client.
--help | -h
Show the help message.
--maintenance-mode
Pretends that maintenance mode is in effect. Otherwise, remove will stop for live removes that require maintenance mode. This flag has no effect for reboot required remediations.
--no-live-install
Forces an remove to /altbootbank even if the VIBs are eligible for live removal. Will cause installation to be skipped on PXE-booted hosts.
--vibname | -n
Specifies one or more VIBs on the host to remove. Must be one of the following forms: name, name:version, vendor:name, vendor:name:version.
software vib update Update installed VIBs to newer VIB packages. No new VIBs will be installed, only updates. WARNING: If your installation requires a reboot, you need to disable HA first.
--depot | -d
Specifies full remote URLs of the depot index.xml or server file path pointing to an offline bundle .zip file.
--dry-run
Performs a dry-run only. Report the VIB-level operations that would be performed, but do not change anything in the system.
--force | -f
Bypasses checks for package dependencies, conflicts, obsolescence, and acceptance levels. Really not recommended unless you know what you are doing. Use of this option will result in a warning being displayed in the vSphere Client.
--help | -h
Show the help message.
--maintenance-mode
Pretends that maintenance mode is in effect. Otherwise, installation will stop for live installs that require maintenance mode. This flag has no effect for reboot required remediations.
--no-live-install
Forces an install to /altbootbank even if the VIBs are eligible for live installation or removal. Will cause installation to be skipped on PXE-booted hosts.
--no-sig-check
Bypasses acceptance level verification, including signing. Use of this option poses a large security risk and will result in a SECURITY ALERT warning being displayed in the vSphere Client.
--proxy
Specifies a proxy server to use for HTTP, FTP, and HTTPS connections. The format is proxy-url:port.
--vibname | -n
Specifies VIBs from a depot, using one of the following forms: name, name:version, vendor:name, or vendor:name:version. VIB packages which are not updates will be skipped.
--viburl | -v
Specifies one or more URLs to VIB packages to update to. http:, https:, ftp:, and file: are all supported. VIB packages which are not updates will be skipped.