ESXi - 6.7 software

Manage the ESXi software image and packages

acceptance

• get

Gets the host acceptance level. This controls what VIBs will be allowed on a host.

• esxcli software acceptance get

• set

Sets the host acceptance level. This controls what VIBs will be allowed on a host.

• esxcli software acceptance set OPTIONS

OPTIONS
 --level=<str>         Specifies the acceptance level to set. Should be one of
                       VMwareCertified / VMwareAccepted / PartnerSupported /
                       CommunitySupported. (required)

profile

• get

Display the installed image profile.

• esxcli software profile get

• 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. The common vibs between host and image profile will be skipped. To preserve installed VIBs, use profile update instead. WARNING: If your installation requires a reboot, you need to disable HA first.

• esxcli software profile install OPTIONS

OPTIONS
 -d|--depot=[ <str> ... ]
                       Specifies full remote URLs of the depot index.xml or
                       server file path pointing to an offline bundle .zip file.
                       (required)
 --dry-run             Performs a dry-run only. Report the VIB-level operations
                       that would be performed, but do not change anything in the
                       system.
 -f|--force            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.  Use this option only when instructed
                       to do so by VMware Technical Support.
 --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-hardware-warning Allows the transaction to proceed when hardware precheck
                       returns a warning. A hardware error will continue to be
                       shown with this option. Use of this option may result in
                       device not functioning normally.
 --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.
 -p|--profile=<str>    Specifies the name of the image profile to install.
                       (required)
 --proxy=<str>         Specifies a proxy server to use for HTTP, FTP, and HTTPS
                       connections. The format is proxy-url:port.

• 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.

• esxcli software profile update OPTIONS

OPTIONS
 --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.
 -d|--depot=[ <str> ... ]
                       Specifies full remote URLs of the depot index.xml or
                       server file path pointing to an offline bundle .zip file.
                       (required)
 --dry-run             Performs a dry-run only. Report the VIB-level operations
                       that would be performed, but do not change anything in the
                       system.
 -f|--force            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.  Use this option only when instructed
                       to do so by VMware Technical Support.
 --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-hardware-warning Allows the transaction to proceed when hardware precheck
                       returns a warning. A hardware error will continue to be
                       shown with this option. Use of this option may result in
                       device not functioning normally.
 --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.
 -p|--profile=<str>    Specifies the name of the image profile to update the host
                       with. (required)
 --proxy=<str>         Specifies a proxy server to use for HTTP, FTP, and HTTPS
                       connections. The format is proxy-url:port.

• validate

Validates the current image profile on the host against an image profile in a depot.

• esxcli software profile validate OPTIONS

OPTIONS
 -d|--depot=[ <str> ... ]
                       Specifies full remote URLs of the depot index.xml or
                       server file path pointing to an offline bundle .zip file.
                       (required)
 -p|--profile=<str>    Specifies the name of the image profile to validate the
                       host with. (required)
 --proxy=<str>         Specifies a proxy server to use for HTTP, FTP, and HTTPS
                       connections. The format is proxy-url:port.

sources

profile

• get

Display details about an image profile from the depot.

• esxcli software sources profile get OPTIONS

OPTIONS
 -d|--depot=[ <str> ... ]
                       Specifies full remote URLs of the depot index.xml or
                       server file path pointing to an offline bundle .zip file.
                       (required)
 -p|--profile=<str>    Specifies the name of the image profile to display.
                       (required)
 --proxy=<str>         Specifies a proxy server to use for HTTP, FTP, and HTTPS
                       connections. The format is proxy-url:port.

• list

List all the image profiles in a depot.

• esxcli software sources profile list OPTIONS

OPTIONS
 -d|--depot=[ <str> ... ]
                       Specifies full remote URLs of the depot index.xml or
                       server file path pointing to an offline bundle .zip file.
                       (required)
 --proxy=<str>         Specifies a proxy server to use for HTTP, FTP, and HTTPS
                       connections. The format is proxy-url:port.

vib

• get

Displays detailed information about one or more VIB packages in the depot

• esxcli software sources vib get OPTIONS

OPTIONS
 -d|--depot=[ <str> ... ]
                       Specifies full remote URLs of the depot index.xml or
                       server file path pointing to an offline bundle .zip
                       file.
 --proxy=<str>         Specifies a proxy server to use for HTTP, FTP, and
                       HTTPS connections. The format is proxy-url:port.
 -n|--vibname=[ <str> ... ]
                       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.
 -v|--viburl=[ <str> ... ]
                       Specifies one or more URLs to VIB packages to display
                       information about. http:, https:, ftp:, and file: are
                       all supported.

• list

List all the VIBs from depots.

• esxcli software sources vib list OPTIONS

OPTIONS
 -d|--depot=[ <str> ... ]
                       Specifies full remote URLs of the depot index.xml or
                       server file path pointing to an offline bundle .zip file.
                       (required)
 --proxy=<str>         Specifies a proxy server to use for HTTP, FTP, and HTTPS
                       connections. The format is proxy-url:port.

vib

• list

Lists the installed VIB packages

• esxcli software vib list [OPTIONS]

OPTIONS
 -d|--depot=[ <str> ... ]
                       Specifies full remote URLs of the depot index.xml or
                       server file path pointing to an offline bundle .zip
                       file. (required)
 --proxy=<str>         Specifies a proxy server to use for HTTP, FTP, and
                       HTTPS connections. The format is proxy-url:port.

• get

Displays detailed information about one or more installed VIBs

• esxcli software vib get [OPTIONS]

OPTIONS
 --rebooting-image     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.
 -n|--vibname=[ <str> ... ]
                       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.

• 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.

• esxcli software vib install OPTIONS

OPTIONS
 -d|--depot=[ <str> ... ]
                       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.
 -f|--force            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.  Use this option only when
                       instructed to do so by VMware Technical Support.
 --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=<str>         Specifies a proxy server to use for HTTP, FTP, and
                       HTTPS connections. The format is proxy-url:port.
 -n|--vibname=[ <str> ... ]
                       Specifies VIBs from a depot, using one of the
                       following forms: name, name:version, vendor:name, or
                       vendor:name:version.
 -v|--viburl=[ <str> ... ]
                       Specifies one or more URLs to VIB packages to install.
                       http:, https:, ftp:, and file: are all supported.

• remove

Removes VIB packages from the host. WARNING: If your installation requires a reboot, you need to disable HA first.

• esxcli software vib remove OPTIONS

OPTIONS
 --dry-run             Performs a dry-run only. Report the VIB-level operations
                       that would be performed, but do not change anything in the
                       system.
 -f|--force            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.  Use this option only when instructed
                       to do so by VMware Technical Support.
 --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.
 -n|--vibname=[ <str> ... ]
                       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. (required)

• 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.

• esxcli software vib update OPTIONS

OPTIONS
 -d|--depot=[ <str> ... ]
                       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.
 -f|--force            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.  Use this option only
                       when instructed to do so by VMware Technical Support.
 --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=<str>         Specifies a proxy server to use for HTTP, FTP, and
                       HTTPS connections. The format is proxy-url:port.
 -n|--vibname=[ <str> ... ]
                       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.
 -v|--viburl=[ <str> ... ]
                       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.

signature

• verify

Verifies the signatures of installed VIB packages and displays the name, version, vendor, acceptance level and the result of signature verification for each of them

• esxcli software vib signature verify