23.48. vmware - VMWare Support

The following documentation is for VMWare Support (vmware) content package at version v4.6.0-beta01.47+gfb4d9d119b24c3ffbb0ec412c8495528d8f92159.

23.48.1. VMware vSphere Tools

A collection of tools for managing VMware vSphere ESXi nodes via Digital Rebar Provision (DRP) workflows and content. This plugin provides content and pieces for managing ESXi infrastrcuture. In addition to standard VMware release BootEnvs for various ESXi versions, custom vendor BootEnvs are also included.

VMware vSphere ESXi installs can be highly customized via the use of DRPs templating constructs to create a complex Kickstart that is capable of doing deep configuration of the ESXi node.

23.48.1.1. Overview of Usage

Starting in the VMware plugin version 2.9.0 and newer, there is a much simplified Workflow use pattern. Previously, there were several Workflows and Stages that were each used for a specific version of the VMware ISO to be installed. This created a sprawling mess.

Starting with v2.9.0 plugin - you now have only one example Workflow and stage that uses a set of Params to define what to deploy to your machines. In addition, you can let the system select a default version based on the the Classification Vendor/Model information of your machines, by use of a Map.

Note

WARNING: Moving to the v2.9.0 version plugin will require some manual upgrade steps. Please see the UPGRADE notes below.

23.48.1.1.1. Basic Usage

For basic usage, and to obtain the latest VMware generic ISO BootEnv installation, simply use the esxi-install workflow.

Note

The ‘esxi-install’ workflow must be run in the Sledgehammer (Discovery) image environment to transition the Machine to the appropriate ESXi bootenv installation.

Note

The first stage of the workflow is ‘prep-install’ which WILL WIPE the disks in preparation of the installation.

This workflow uses the following Params:

  • vmware/esxi-version: set to select-vendor, or to a precise BootEnv that exists on the system (eg esxi_670u2-13006603_vmware), this is an enum type of curated an supported BootEnvs by RackN
  • vmware/esxi-version-override: if the curated list of BootEnvs does not support your needs (you’ve installed custom BootEnvs), then setting this value will override the enum list in vmware/esxi-version - the specified BootEnv must exist, be valid, and the ISO contents exploded and available somewhere
  • vmware/esxi-version-vendor-map: this is a mapping of which BootEnv to use by default when a machine Vendor and Model has been automatically Classified - it allows for single workflows to address heterogeneous pools of hardware - see the Param documentation below for more details
  • esxi/patch-map: allows the operator to specify additional patches to install after the BootEnv is installed via the ISO contents - this is useful for VMware Cloud Foundation (vCF) HCL compliance installations that require additional patch levels be installed in preparation for vCF cluster builds.

Please review below documentation for additional details on the above pieces.

23.48.1.1.2. Advanced Usage

Setting the vmware/esxi-version Param to select-vendor will enable automatic selection of the ISO based on the Vendor and Model (if appropriate) of the hardware, dynamically. This pattern allows operators to have a pool of heterogenous hardware, and map VMware ESXi ISO versions to the vendors, allowing for appropriate custom vendor ISOs to be used for each hardware type.

This map is maintained in the vmware/esxi-version-vendor-map, which carries a default set defined by RackN. Should you want to specify precise versions to use, you can set this Param to a map structure of your choosing. Set this directly on the Machine as a Param, or via Profiles that are added to the machine (including global, if appropriate).

23.48.1.1.3. Patching ESXi Systems at Install Time

The RackN VMware plugin also supports applying a patch version to the base install ISO at installation time. The patching system relies on two separate sets of maps to specify where to find the Patches and related information (the esxi/patch-map, and the actual patch to install (via the vmware/esxi-version-vendor-map param).

The Patch Map defines the patch name based on the VMware “Build Number”, which also serves as the index for the URL location, hash to validate the patch, and an optional custom location for finding the patch. Please see the individual esxi/patch-* named Params for more details.

VMware maintains their patch download URLs behind a CGI gateway that does not expose a direct download URL link. RackN can not provide a direct download link in the individual Patch download locations. Please follow the below steps to acquire patches:

  • go to: https://my.vmware.com/group/vmware/patch#search
  • login with your VMware account
  • select “ESXi (Embedded and Installable)”
  • select the version of ESXi that the patch applies to
  • then in the “Enter Build Number” - put the build number ID which can be referenced in the esxi/patch-map Param
  • hit search
  • you’ll get a table of results - cross reference the correct Build ID - and click on the “Download” button they provide
  • send a gentle note to VMware to modernize their download process

23.48.1.1.4. Adding Custom BootEnvs (VMware ESXi versions)

At RackN, we try to keep up with the latest set of VMware ESXi versions, but the reality is … we won’t succeed. As such, you may need to inject new BootEnvs in to the system, which support your specific Vendor and/or VMware ESXi version needs. This content pack supports adding in new BootEnvs (VMware ESXi versions), and using the above set of Params and Workflow control to deploy them to your machines.

Additionally, custom created vSphere ESXi ISOs can be converted to Digital Rebar content packs with this process.

There is a script that is distributed with the vmware plugin named make-esxi.sh. This script combines the previous two scripts capabilities in to a single tool. The previous scripts were make-esxi-bootenvs.sh and make-esxi-content-pack.sh.

Note

See the ref:vmware_esxi_v430_upgrade notes for details on dealing with this transition

The script is designed to allow you to specify what ISO images to create either a standalone mini content pack from, or to just generate appropriate bootenvs and a boot.cfg template to match it. The mini content pack approach is designed to work in conjunction with the vmware plugin, not to replace it. In content pack mode, appropriate workflows and stages will also be generated in addtion to the bootenvs and boot.cfg templates.

RackN uses this same script to generate the vmware plugin_provider content pieces (bootenvs and boot.cfg templates).

Part of the process includes generating appropriate meta data information about the bootenv and ISO version information. Unfortunately, because the ISO file names and internal ISO meta data information is wildly inconsistent, it’s impossible to dynamically generate structured and useful data.

As a consequence, there is an internal array map (named ISO_MAP[]) which contains all generated bootenv meta data details. This is a curated list that is amended as RackN adds more ISOs to the support list for the vmware plugin_provider.

If you are just testing one-off or a small handful of ISOs for installation, it may not be necessary to worry about this. Just use the ‘-g’ (Generated) mode of the script, and minimal meta data will be built. If you wish to maintain a more comprehensive content pack for longer term use with curated bootenvs, we highly recommend you generate an appropriate ISO_MAP set of values. The ISO_MAP can be contained in a separate reference file independent of the script.

There are two Usage related flags to the script for additional information and details on how to use it. Please see those output details for more usage, notes, and examples.

# the two usage flags to the make-esxi.sh script
cd /var/lib/dr-provision/tftpboot/files/plugin_providers/vmware
./make-esxi -u         # switch argument Usage
./make-esxi -x         # eXtended usage output, includes notes and examples

Note

IF YOU NEED ISO VERSIONS WE HAVE NOT ADDED … please contact RackN, we would like to keep the vmware plugin as up to date as possible for our customer requirements. We will continue to add new versions as we can. You will receive the benefit of this content being “off-the-shelf” and not requiring additional custom content to support ESXi environments.

23.48.1.2. Managing Your ESXi Passwords

There are a few options you have for setting/defining the password(s) that are set on your installed ESXi instance.

During the ESXi installer process (kickstart/weasel), the shell (Alt-F1) is the stock/standard ESXi set (user “root”, no password).

If you take no actions, the default password will follow all standard bootenv passwords see Knowledge Base Article: kb-00009 for details.

To set custom passwords, you have the following options, the items listed first, will take precedence over subsequent items:

  1. Set the provisioner-default-password-hash to a SHA512 sum value.
  2. Use the esxi/insecure-password Param set on a machine (directly or via a Profile), with a clear text password. This will be converted to a SHA512 hash and fed to weasel for the installed ESXi password.
  3. You can have the system dynamically generate a random VMware formatted valid password for every single ESXi instance installed. To use this, set the param esxi/generate-random-password to true. This can only be run as a preparatory stage in Sledgehammer.

The generate random use case is designed to allow your infrastructure to have secure per-machine passwords. The expectation is that you will move these in to a centrally managed secrets system (eg vault or password keeper) for consumption by other automated systems.

Please see the per-Param documentation below for more details on the above methods.

23.48.1.3. NOTES ON UPGRADING TO v4.4.0 Plugin

In the v4.4.0 plugin_provider the rackn agent known as drpy is now provided as a VMware Partner Supported package which requires building a custom ISO to include the packages needed. RackN provides a build script to produce the ISO, but it must be run from Windows and depends on PowerCLI from VMware. To make this process easier for our customers we include a link to a pre-built ISO for many common releases.

23.48.1.4. NOTES ON UPGRADING To v4.3.0 Plugin

In the v4.3.0 plugin_provider the previous two (or three!) scripts:

  • make-esxi-bootenv.sh
  • make-esxi-bootenvs.sh
  • make-esxi-content-pack.sh

Have been consolidated in to a single script named make-esxi.sh. The Plugin Provider update process does not remove these scripts on update. We highly recommend that you remove the old versions of the above listed scripts to prevent future confusion.

You will need to manually remove the old versions of the scripts. Log in to the shell of your DRP Endpoint, and perform the following tasks.

# remove old script versions - assume "default production" install location
cd /var/lib/dr-provision/tftpboot       # adjust to your 'tftpboot' directory location
FILES="files/plugin_providers/vmware/scripts/make-esxi-bootenvs.sh
       files/plugin_providers/vmware/scripts/make-esxi-content-pack.sh
       make-esxi-bootenv.sh make-esxi-bootenvs.sh make-esxi-content-pack.sh"

for F in $FILES; do [[ -r "$F" ]] && rm -i $F || echo "Skipping - '$F' file found"; done

Additionally, you may wish to symbolically link the new replacement script to a system PATH location, as follows:

ln -s /var/lib/dr-provision/tftpboot/files/plugin_providers/vmware/scripts/make-esxi.sh /usr/local/bin/

23.48.1.5. NOTES ON UPGRADING To v2.9.0 Plugin

The new version selector features are being released in the plugin version v2.9.0. If you have used the previous v2.8.0 or older versions, you will need to perform some basic maintenance to install this version, as there are incompatible changes. Below are some notes related to the upgrade. If you run in to issues, please contact RackN as quickly as possible, don’t waste your time trying to sort it out.

  1. Remove all vmware/esxi-version Params from your Machines or profiles. The naming structure of the BootEnvs has changed to be more structured and predictable. This causes the Param enum structure from the OLD versions to NOT BE COMPATIBLE with the new.
  2. Your “exploded” BootEnvs on disk or in your esxi/http-mirror location needs to change. If you are not using the http mirror method, you can simply delete the tftpboot/esxi-* directories relating to your existing ISOs, then restart the DRP service.
  3. Insure your original ISOs still exist in the tftpboot/isos/ directory, for them to be re-exploded to the new BootEnv names.
  4. Remove the existing VMware plugin, then add the new one - do not perform an upgrade/install of it.

Generally speaking we try to avoid, impacting upgrades like this with content, but sometimes there are compelling reasons to make breaking changes. In this case we move to a much cleaner and easier to support method for deploying ESXi, gain incredibly powerful auto-magic deployments based on hardware vendor, and simplify and standardize the naming structure of the BootEnvs.

23.48.1.5.1. DEPRECATED BOOTENVS

To support a successful upgrade from the v2.8.0 to v2.9.0 vmware plugin, the old BootEnv names must be mainatined. If they are referenced via Workflow or as configuration on Machine Objects, or other places in the system, you will not be able to successfully update to the v2.9.0 plugin version.

The following list of BootEnvs are considered deprecated, and will be removed in a future release. Probably very very soon (v2.10.0 plugin versions). You must change any references to the following BootEnvs in your DRP endpoint, prior to your next upgrade:

  • esxi-550u3b
  • esxi-6.7.0-update1-10302608-custom-hitachi_0200_Blade_HA8000
  • esxi-6.7.0-update1-10302608-custom-hitachi_1200_HA8000VGen10
  • esxi-6.7.1-10302608-nec-6.702
  • esxi-6.7.1-10302608-nec-gen-6.7
  • esxi-600u2
  • esxi-600u3a
  • esxi-650a
  • esxi-650u2
  • esxi-670
  • esxi-670u1
  • esxi-670u2
  • esxi-dellemc-esxi-6.5u2-10719125a07
  • esxi-dellemc-esxi-6.7u1-10764712-a04
  • esxi-fujitsu-vmvisor-installer-6.7-10
  • esxi-hpe-esxi-6.7.0-update1-iso-gen9p
  • esxi-lenovo_esxi6.7u1-10302608_201810
  • esxi-vmware-esxi-6.7.0-10302608-custom-cisco

The new bootenv naming scheme is designed to be more machine parsable, and no longer uses the vendor ISO meta information as it is wildly inconsistent and sucks.

The replacement BootEnv names are below, and you should be able to determine the mappings between the names.

  • esxi_550u3b-3248547_vmware
  • esxi_600u2-3620759_vmware
  • esxi_600u3a-5572656_vmware
  • esxi_650a-4887370_vmware
  • esxi_650u1-7388607_hpe
  • esxi_650u2-10719125-A07_dell
  • esxi_650u2-8294253-A00_dell
  • esxi_650u2-8294253_vmware
  • esxi_670-8169922_vmware
  • esxi_670u1-10302608_cisco
  • esxi_670u1-10302608_fujitsu
  • esxi_670u1-10302608_hitachi_blade-ha8000
  • esxi_670u1-10302608_hitachi_ha8000v-gen10
  • esxi_670u1-10302608_lenovo
  • esxi_670u1-10302608_nec
  • esxi_670u1-10302608_vmware
  • esxi_670u1-10764712-A04_dell
  • esxi_670u1-11675023_hpe_gen9plus
  • esxi_670u2-13006603_cisco
  • esxi_670u2-13006603_hitachi
  • esxi_670u2-13006603_hpe
  • esxi_670u2-13006603_vmware
  • esxi_670u2-13473784_fujitsu
  • esxi_670u2-13644319_nec_r120h-t120h-r110j
  • esxi_670u2-13644319_nec_standard
  • esxi_670u2-13981272-A02_dell
  • esxi_670u2-13981272_lenovo

Note

There may be many more bootenv names than listed above, if support for newer vendor ISOs and/or VMware versions are released.

Note

It is advisable to use the ‘esxi-install’ Workflow and the ‘esxi/select-version-map’ Param to control your ESXi bootenv installation.

23.48.1.6. ESXi Agent/Runner Information

VMware ESXi environments are for the most part “closed appliances”, and compiling third party tools for these environments is not an easy process. Consequently, the Golang based compiled Agent/Runner (drpcli) can not be cross compiled to run in the ESXi operating environment. RackN does build and maintain a Python3 capable Agent/Runner to support Workflow operations in the ESXi install environment (Weasel kickstart) and as a post-installed Agent for executing Workflow in installed systems.

There are two primary components that must be installed to support Workflow in the ESXi environment:

  • DRPY (“derpy”) Agent - an ESXi VIB module - installs the Python3 based tools to support Workflow/Stage execution
  • Firewall-VIB - an ESXi VIB module - enables persistent firewall port access from the installed ESXi environment to the DRP API port

If you are using the Workflow system to mark machines as “complete” for install tracking purposes, you must also set the esxi/skip-notify Param value to true.

To install the ESXi Agent/Runner, you must also install the Firewall-VIB module, or arrange to disable the ESXi built-in firewall system.

23.48.1.6.1. Adding Custom Kickstart Sections

Digital Rebar Provision provides on-the-fly customization of the built Kickstart through the use of injecting Templates in to the core Kickstart file, and also providing dynamic information available on the DRP endpoint, in to the Templates.

Note

It is HIGHLY RECOMMENDED to use the RackN Workflow and Stages to add customizations to the install process, and to NOT INJECT custom kickstart templates. Please see the “ESXI Agent/Runner Information” section.

ESXi kickstarts support three additional sections (or phases) that extra actions can be taken during the installation process:

Pre Stage (%pre)
Specifies a script to run before the kickstart configuration is evaluated. For example, you can use it to generate files for the kickstart file to include.
ESXi Installation Stage
Uses Kickstart for automating the installation; see Vmware Kickstart Documentation for more details.
Post Stage (%post)
Runs the specified script after package installation is complete. If you specify multiple %post sections, they run in the order that they appear in the installation script.
Firstboot Stage (%firstboot)
Creates an init script that runs only during the first boot. The script has no effect on subsequent boots. If multiple %firstboot sections are specified, they run in the order that they appear in the kickstart file.

DRP’s “vmware” content allows you to inject custom %pre, %post, and %firstboot scripts in to your installation kickstart. It is up to the operator to understand the ordering and proper usage of these scripts.

To do so, simply create Templates with your Kickstart snippets defined as you desire. Then use the esxi/ks-custom-sections Param structure to include the appropriate scripts in your kickstart. NOTE: the %pre %post and %firstboot separators will be injected into the Kickstart file for you (do NOT include them in the template).

Example Param definition:

##############
# YAML example
# see WARNING note about kickstart below

- "pre-busybox"
  - "my-pre-busybox-chunk1.ks.tmpl"
  - "my-pre-busybox-chunk2.ks.tmpl"
- "post-python"
  - "my-post-python3-chunk2.ks.tmpl"
- "firstboot-busybox"
  - "my-fistboot-busybox-chunk1.ks.tmpl"


##############
# JSON example
# see WARNING note about kickstart below

{
  "firstboot-busybox": [
    "my-fistboot-busybox-chunk1.ks.tmpl"
  ],
  "post-python": [
    "my-post-python3-chunk2.ks.tmpl"
  ],
  "pre-busybox": [
    "my-pre-busybox-chunk1.ks.tmpl",
    "my-pre-busybox-chunk2.ks.tmpl"
  ]
}

Note

None of the above reference templates exist in this plugin. You must create them as appropriate for your use cases.

You may also create templates that carry kickstart command directives, to customize the main body of the kickstart. Use the esxi/ks-custom-kickstart param to specify the additional templates with kickstart directives to inject. These will be placed after the esxi-network-ks.tmpl, but before any of the %pre, %post, and/or %firstboot ections are injected.

Example:

esxi/ks-custom-kickstart:
  - my-kickstart-chunk1.ks.tmpl

The above examples will generate a kickstart that looks similar to below:

# DRP provided kickstart opening statements
<template default statements go here>

# DRP provided network configuration template
<esxi-network-ks.tmpl>

# example "kickstart" customization template
<my-kickstart-chunk1.ks.tmpl>

# DRP provided kickstart template pre/post/firstboot "stock" sections
<esxi-notify-drp-py3.tmpl>
<esxi-preserve-logs.tmpl>
<esxi-enable-shells.tmpl>

# example custom sections to add
# firstboot-busybox
%pre --interpreter=busybox
<my-firstboot-busybox-chunk1.ks.tmpl>

# post-python
%pre --interpreter=python
<my-post-python3-chunk2.ks.tmpl>

# pre-busybox
%pre --interpreter=busybox
<my-pre-busybox-chunk1.ks.tmpl>
<my-pre-busybox-chunk2.ks.tmpl>

23.48.1.7. Network Configuration Options

The VMware plugin from RackN supports managing relatively complex network scenarious around your VMware ESXi infrastructure. There are three places within the provisioning stages that network configuration changes can be made to support different operational models.

The three primary configuration points for network settings are explained below. In all cases, we assume that the PXE start process is assigned an IP address from your DHCP infrastructure - either from Digital Rebar Provision itself, or other external DHCP services.

  1. Initial kernel network configuration. Initial DHCP/PXE services may be on an isolated network from the provisioning networks. These settings are controlled by passing values to the kernel at initial load time, via use of the kernel-options parameter.

    An example:

    ip=10.10.10.10 netmask=255.255.255.0 gateway=10.10.10.1 vlan=10

  2. Once the initial kernel has booted, the kickstart environment can be plumbed with a set of network configuration options. See the esxi/network-kickstart-type Param documentation for details on configuring the network at this stage.

  3. Once a machine has finished installing, and subsequently boots in to it’s installed operating system; it is possible to again specify different network configurations.

    This may be necessary in the case of a Provisioning network transition to a Production network configuration post-install.

    To customize the network configuration post-install, please see the esxi/network-firstboot-type parameter for options.

Some sample scenarios and how you need to configure for those use cases are listed below.

23.48.1.7.1. Simple DHCP Only Setup

If you are trying to simply obtain a DHCP configuration at boot time, and preserve that IP through the install and frist boot of the installed OS, you do not need to do anything. The default behavior will be to obtain DHCP and preserve it through the install.

23.48.1.7.2. DHCP on PXE; Configure Manual IP (kickstart and installed OS)

If you intend to acquire an IP address during initial PXE boot of the Machine, but then transition to a Static (manually) configured network configurutation during the Kickstart installation and as the final installed network config, use the following steps:

  1. Do not set any values for kernel-options
  2. Set the esxi/network-kickstart-type appropriately
  3. Follow the documentation for that Param.

23.48.1.7.3. DHCP ON PXE; Retain for Kickstart; Installed OS Different

If your provisioning network is defined by the PXE DHCP network configuration, but you wish to transfer the installed OS (on first boot), to a new network configuration, use the following setps:

  1. Do not set any values for kernel-options
  2. Set the esxi/network-firstboot-type appropriately
  3. Follow the documentation for that Param.

23.48.1.7.4. VLAN Tagged Interfaces

VLAN tagged frames can be set at any of the three primary stages of the provisioning process outlined above. Set the appropriate options for either of the following stages:

Kernel boot/kickstart VLAN tagged
Set the kernel-options param to include the vlan=N setting, where N is the VLAN ID from 1 to 4096.
Kickstart Network and/or Firstboot Network VLAN tagged
Set the Param esxi/network-*-vlan Param for the appropriate stage.

23.48.1.7.5. Packet MTU Size

Custom MTU (maximum transmission unit) frame sizes for packets can be set. This is for the Management Network (eg “vmnic0”/”vmk0”) MTU setting. To set the MTU size, set the following Param to your specified value:

  • esxi/network-firstboot-mtu

Note

The MTU size setting change currently is only supported for the “firstboot” (final installed) stage of the configuraiont; it is not supported during the kickstart/weasel install process.

23.48.1.7.6. DNS, Search Domains, NTP Settings

To customize network configurations for DNS and NTP settings, please see the drp-community-content Params:

  • dns-servers
  • ntp-servers
  • dns-search-domains

Additionally, a custom NTP configuration template can be provided to completely override the (relatively simplistic) default NTP settings supported by this content. To override the template follow the below steps:

  1. Create a new Template with your NTP configuration.
  2. (optional) You can use the existing ntp-servers Param similarly to the RackN supplied content, by reviewing the following example.
restrict default kod nomodify notrap noquerynopeer
restrict 127.0.0.1
{{range $key, $ntp := .Param "ntp-servers" -}}
server {{ $ntp }} iburst
{{end -}}
  1. Set the esxi-ntp-conf Param with the name of your NTP template you created above.

23.48.1.8. Licensing ESXI During Install

Use the esxi/license Parameter to set a License to be used during installation to enable licensed use of ESXi.

The following documentation defines the various components of the vmware content and how to use them.

23.48.1.9. Various Error Messages You May See

If you are regularly installing ESXi systems and observing the installation from the systems console (keyboard, video, mouse, etc.), you may observe a few error messages that the Weasel installer kicks out. These are considered “normal” and are documented here just in case you go looking for them.

23.48.1.9.1. Deleting vmk0 Management Interface

Error Message:

Deleting vmk0 Management Interface, so setting advIface to NULL

Explanation:

This is generally a non fatal issue, and due to forcing override on the default gateway during the Weasel installation configuration stages. You should be able to safely ignore this error.

23.48.1.9.2. Validation Disabled

Error Message:

Attempting to install an image profile with validation disabled.  This may result
in an image with unsatisfied dependencies, file or package conflicts, and potential
security violations.

Explanation:

VMware VIBs (software installer bundles) have four levels of “trusted” levels. Currently, the RackN Firewall and DRPY Agent VIB are set at CommunitySupported level. This means that if the ESXi system is installed to accept software any higher level, then this message will be displayed.

RackN is a Partner with VMware, however, we do not have certifications for these packages yet. Until then, you’ll have to live with this error message.

For more details on VMware Acceptance Levels, please see:

23.48.1.9.3. Scratch Partition Location

Error Message:

Logs are stored on a non-persistent storage.  Consult product documentation to configure a
syslog server or a scratch partition.

Explanation:

This is an expected message due to the installer (Weasel) architecture. The installation is performed from a memory backed filesystem, and any installer logs are written to this location. When you reboot, the installer logs are nuked.

To preserve the logs, RackN copies them to /vmfs/volumes/datastore1/install-logs/ for post-install review if there are any questions on the installer actions, or errors in the installation.

At some future point, these logs may be forwarded to the Endpoint and accessible within the Job Logs subsystem.

For more details on Scratch partition, please see:

Note

Unfortunately, the scratch partition can’t be located within the Weasel installer, so this error message will always be present.

23.48.1.10. Error Opening tools.t00

Error Message:

Error (see log for more info):
cannot open file
[Errno 2] No such file or directory: '/tardisks/tools/t00'

Explanation

VMware vSphere 7.x ISO disks now require all modules specified in the manifest to be loaded. This means if the esxi/skip-tools is set to true, that module (tools.t00) will not be served to the Weasel install environment.

You must set:

esxi/skip-tools: false

To insure that tools.t00 modules is properly loaded. You can no longer skip loading this module.

Starting in v4.4 of the VMWare plugin many of the ISO files now provide a -no-tools ISO file and matching bootenv you can use.

23.48.1.11. Building ESXi ISOs With RackN Agent Embedded

As mentioned above in the upgrading to v4.4 notes a Windows machine will be required to build the ISO. On the Windows machine you need to have powershell, and powercli from VMware. Its fine to use your normal user. Admin privs were not needed in testing. The powercli script to build the iso is part of the vmware plugin.

PS C:\Users\errr> Set-PowerCLIConfiguration -Scope User -ParticipateInCEIP $false # only needed the first time you use powercli
PS C:\Users\errr> mkdir rackn
PS C:\Users\errr> cd rackn
PS C:\Users\errr\rackn> Invoke-Webrequest -Uri http://RS_ENDPOINT:8091/files/plugin_providers/vmware/scripts/build_iso.ps1 -Outfile build_iso.ps1
PS C:\Users\errr\rackn> build-iso.ps1 -exportpath C:\temp\isos\7-0\ -rackNolbDir C:\temp\olbs\rkn-7-0\ -esxiOlbDir C:\temp\olbs\7-0\

Once that is done a command prompt should be returned, but sometimes it doesnt so after 30-60 seconds if you dont have a prompt hit enter and it should show up if its done if not just wait a bit more. The process takes under 1 min in most cases. This process will build an ISO & OLB for every profile listed in the ESXi OLB.

23.48.2. Object Specific Documentation

23.48.2.1. stages

The content package provides the following stages.

23.48.2.1.1. vmware-esxi-hcl-install

This stage will install all prerequisites for the VMware HCL compatibility checker, and the python3 tool itself (compchecker.py).

23.48.2.1.2. esxi-install-welcome

Update the welcome banner

23.48.2.1.3. esxi-preserve-logs

Backup logs to persist reboot and change of environments.

23.48.2.1.4. in-subnet-check-validate

Validates that the ESXi firstboot IP, Def GW, and Netmask are in the same subnet to prevent failures of ESXi firstboot network configuration.

Requires that the following Params are accessible to the validate script:

  • esxi/network-firstboot-ipaddr
  • esxi/network-firstboot-gateway
  • esxi/network-firstboot-netmask

This stage will also run the Task in-subnet-check-render to make the python script (in-subnet-check.py) available for use.

23.48.2.1.5. vcf-builder-settings

This Stage will set the JSON structures needed for an ESXi node to be included in the vCloud Foundation Builder built cluster. It must be run on Sledgehammer, prior to ESXi being installed.

The following Optional Params will be injected in to the JSON esxiHostSpec stanzas if set. If not specified, the default values will be used.

Param Default
vcf-builder/association digitalrebar-sddc-01
vcf-builder/esxiCredentials-username root
vcf-builder/esxiCredentials-password RocketSkates
vcf-builder/vSwitch vswitch0
vcf-builder/serverId Machine.UUID

23.48.2.1.6. vmware-build-isos

Build ISOs for RackN with DRPY embedded in the iso

23.48.2.1.7. in-subnet-check-render

This stage will render the template named in-subnet-check.py.tmpl to the local ESXi filesystem as /tmp/in-subnet-check.py for use by the system. The task will also set the rendered python file executable.

To call and use the python file, ensure python3 is found by env, and simply call it as /tmp/in-subnet-check.py <OPTIONS>.

See the Task in-subnet-check-validate to use it.

23.48.2.1.8. vcf-builder-deploy

This Stage will set the JSON structures needed for an ESXi node.

Requires ovftool - which can be acquired from the docker container sygibson/vmtools - which also contains a DRP Runner for running arbitrary workflow.

Param Default
vcf-builder/association digitalrebar-sddc-01
vcf-builder/esxiCredentials-username root
vcf-builder/esxiCredentials-password RocketSkates
vcf-builder/vSwitch vswitch0
vcf-builder/serverId Machine.UUID

23.48.2.1.9. vmware-esxi-install

This stage will install VMware vSphere ESXi on the machine of the ESXi and VSAN compatibility checks have succeeded (both set to True).

Future implementations of this should allow for a force-install option to allow installation even if the compatibility checks have failed.

23.48.2.1.10. esxi-acceptance-level

This task will set ESXi node software VIB install acceptanceLevel. NOTE that as per VMware defined policies and behavior, you may NOT set the acceptanceLevel to a level any higher than the lowest level install software VIB package.

Currently, the RackN DRP-Agent and DRP-Firewall-Ruleset VIBs require that the acceptanceLevel be set at CommunitySupported. If these components are installed (as they are by default) you will not be able to raise the level.

The default value is CommunitySupported. The supported values are (from highest to lowest):

  • VMwareCertified
  • VMwareAccepted
  • PartnerSupported
  • CommunitySupported

For more details, please see the VMware knoweldge base article:

23.48.2.1.11. esxi-activate-nested

Using parameters, this stage enables ESXi nesting.

23.48.2.1.12. esxi-join-local

Used to join an ESXi host to the DRP endpoint using the esxi-join-up.py script.

23.48.2.1.13. esxi-remove-vmware-bootorder

This task will remove VMware ESXi from the machine’s bootorder in UEFI mode.

23.48.2.1.14. esxi-rename-datastore

This stage will rename the defautl datastore on the ESXi node to the value defined in the esxi/rename-datastore param.

This must be run in the firstboot or post-install booted environment of an ESXi host. It can not run during the kickstart stage of the install.

23.48.2.1.15. esxi-activate-network

Using parameters, this stage sets up the ESXi networking.

23.48.2.1.16. esxi-activate-password-policy

Using parameters, set the password security policy.

23.48.2.1.17. esxi-install-certificate

Install SSL Certificate

23.48.2.1.18. vmware-esxi-hcl-validate

This task will run the VMware ESXi HCL compatibility checker and determine if the Machine meets the HCL compatibility for ESXi.

23.48.2.1.19. esxi-activate-shells

Using parameters, this stage activate shells for ESXi.

23.48.2.1.20. esxi-install-patches

This stage installs the patches contained in the esxi/patch-list array. The list is created by the esxi-set-patch-list stage. It is possible that other programmatic methods can be used to generate the esxi/patch-list, in which case, the esxi-set-patch-list stage is not necessary.

The patches specified in esxi/patch-list must be represented in the esxi/patch-map, which is used to reference the actual patch file, and it’s checksum.

23.48.2.1.21. esxi-set-network-protocol

Sets the supported IP protocol suites supported on the ESXi system. Supported values are:

  • both - (default) Support both IPv4 and IPv6 protocols
  • ipv4 - support ONLY the IPv4 protocol, and disable IPv6 support completely
  • ipv6 - enable IPv6 protocol if not currently on (IPv4 can not be disabled in ESXi)

Warning

Changing IPv4 or IPv6 requires an ESXi reboot - and may disconnect the ESXI node from the network. This Task does not validate desired protocol state connectivity after changes are made. Ensure you have appropriate IP addressing in place for continued network connectivity.

If the esxi/set-network-protocol-skip-reboot Param is set to true, the operator is responsible to reboot the ESXi node to implement any protocol changes.

23.48.2.1.22. vmware-esxi-set-password

This task allows the operator to set an insecure cleartext password value, which will be converted to a SHA512 hash for the machine admin password to be set to.

Alternatively, a unique randomly generated password can be created using the ‘esxi/generate-random-password’ param set to ‘true’.

23.48.2.2. tasks

The content package provides the following tasks.

23.48.2.2.1. esxi-enable-maint-mode

Set maintenanceMode on an ESXi system. In addition to setting it on the system, also record the state on DRP in the Param esxi/maintenance-mode.

Subsequently, when maintenance mode is disabled, BOTH the system state must be in maintenance (Enabled), and the DRP Param set to Enabled. This is a safety check to insure that DRP set the maintenance mode, and to not disable it unless we’ve set it.

Uses the esxi-params.py.tmpl python code to set/manage Params on the system.

23.48.2.2.2. esxi-install-certificate

Install an SSL certificate and restart services.

23.48.2.2.3. vmware-get-bundles

A task to get VMWare ISO bundles

23.48.2.2.4. esxi-acceptance-level

This task will set ESXi node software VIB install acceptanceLevel. NOTE that as per VMware defined policies and behavior, you may NOT set the acceptanceLevel to a level any higher than the lowest level install software VIB package.

Currently, the RackN DRP-Agent and DRP-Firewall-Ruleset VIBs require that the acceptanceLevel be set at CommunitySupported. If these components are installed (as they are by default) you will not be able to raise the level.

The default value is CommunitySupported. The supported values are (from highest to lowest):

  • VMwareCertified
  • VMwareAccepted
  • PartnerSupported
  • CommunitySupported

For more details, please see the VMware knoweldge base article:

23.48.2.2.5. esxi-activate-nesting

This task activates ESXi nested in other hypervisors (eg ESXi).

23.48.2.2.6. esxi-activate-shells

This task activates the shells for ESXI if parameters allow it.

23.48.2.2.7. esxi-set-network-image-deploy

For an ESXi Image Deploy path; configure the ESXi network based on the various param values defined with names esxi/network-*.

23.48.2.2.8. vmware-esxi-hcl-install

This task will install all prerequisites for the VMware HCL compatibility checker, and the tool itself.

23.48.2.2.9. esxi-exit-maint-mode

Remove maintenanceMode on an ESXi system, but only when the system is in maintenanceMode, and the DRP param esxi/maintenance-mode is set to Enabled. This is a safety check to insure that DRP set the maintenance mode, and to not disable it unless we’ve set it.

Uses the esxi-params.py.tmpl python code to set/manage Params on the system.

23.48.2.2.10. esxi-preserve-logs

Preserve the logs to a datastore area.

23.48.2.2.11. validation-machine-name-dns-to-ip

Validates that the machines IP address exists in DNS records.

23.48.2.2.12. esxi-install-welcome

This task updates the Welcome Banner with additional info.

23.48.2.2.13. esxi-patch-install

Iterates through the list of patches and applies them. Rebooting as necessary.

Uses the esxi-params.py.tmpl python code to set/manage Params on the system.

23.48.2.2.14. esxi-set-ntp

Set the NTP system in ESXi based the following params, evaulated in the order:

  • ntp-servers

This task will also appropriately modify the ESXi Firewall rulesets to allow access to the NTP servers based on the ntpClient ruleset.

Full customization of the ntp.conf file can override the generated config files from this task by using the esxi/ntp-conf param.

23.48.2.2.15. vcf-builder-settings

This task will set the JSON structures needed for an ESXi node to be included in the vCloud Foundation Builder built cluster. It must be run on Sledgehammer, prior to ESXi being installed.

23.48.2.2.16. vmware-esxi-install

If the given Machine has passed both ESXi and VSAN HCL compatibility checks, then install the VMware vSphere ESXi version specified.

Uses the vmware/esxi-version Param (enum type) to define which supported version to install.

23.48.2.2.17. vmware-esxi-set-password

This task allows the operator to set an insecure cleartext password value, which will be converted to a SHA512 hash for the machine admin password to be set to.

Alternatively, a unique randomly generated password can be created using the esxi/generate-random-password param set to true.

Note

This is considered HIGHLY INSECURE as the cleartext password value is recorded on the Machine object in the esxi/insecure-password param.

23.48.2.2.18. vmware-powershell-install

A task to install the VMWare PowerShell client

23.48.2.2.19. vmware-selector

Deprecated in favor of the new vmware-esxi-selector tooling.

23.48.2.2.20. vmware-esxi-selector

This tasks calls the vmware-esxi-selector.tmpl which implements the automatic ESXi install based on the hardware vendor of the machine (if vmware/esxi-version is set to select-vendor), and the map of Param values (vmware/esxi-version-vendor-map).

23.48.2.2.21. vmware-iso-build

A task to build RackN ISOs

23.48.2.2.22. esxi-patch-start

Set maintenanceMode on an ESXi system. In addition to setting it on the system, also record the state on DRP in the Param esxi/maintenance-mode.

Subsequently, when maintenance mode is disabled, BOTH the system state must be in maintenance (Enabled), and the DRP Param set to Enabled. This is a safety check to insure that DRP set the maintenance mode, and to not disable it unless we’ve set it.

Uses the esxi-params.py.tmpl python code to set/manage Params on the system.

23.48.2.2.23. esxi-remove-vmware-bootorder

This task will attempt to remove “VMWare ESXi” from the bootorder if it is present and the system is in UEFU boot mode.

This will return to the pre-install bootorder.

This may be skipped by setting esxi/skip-remove-bootorder parameter to true.

23.48.2.2.24. esxi-set-network-protocol

Sets the supported IP protocol suites supported on the ESXi system. Supported values are:

  • both - (default) Support both IPv4 and IPv6 protocols
  • ipv4 - support ONLY the IPv4 protocol, and disable IPv6 support completely
  • ipv6 - enable IPv6 protocol if not currently on (IPv4 can not be disabled in ESXi)

Warning

Changing IPv4 or IPv6 requires a node restart - and may disconnect the ESXI node from the network. This Task does not validate desired protocol state connectivity after changes are made. Ensure you have appropriate IP addressing in place for continued network connectivity.

If the esxi/set-network-protocol-skip-reboot Param is set to true, the operator is responsible to reboot the ESXi node to implement any protocol changes.

23.48.2.2.25. in-subnet-check-render

Renders a Python and Shell version of the in-subnet-check tool to the local ESXi instance. The file permissions are then set as executable for subsequent use of the scripts.

23.48.2.2.26. no-op

Task that is used by the esxi-join-local stage that does nothing.

23.48.2.2.27. vmware-esxi-hcl-validate

This task will run the VMware ESXi HCL compatibility checker and determine if the Machine meets the HCL compatibility for ESXi.

23.48.2.2.28. esxi-rename-datastore

This task and template renames the default datastore (datastore1) to a new value defined by the esxi/rename-datastore Param.

23.48.2.2.29. esxi-set-dns

Setup DNS components in ESXi, using the params:

  • dns-servers
  • dns-domain
  • dns-search-domains

23.48.2.2.30. esxi-set-hostname

Set hostname in ESXi based on the values of the params, evaluated in the following order:

  • esxi/network-firstboot-hostname
  • hostname
  • currently defined .Machine.Name

23.48.2.2.31. esxi-set-network

Configure the ESXi network based on the various param values defined with names esxi/network-*.

23.48.2.2.32. in-subnet-check-validate

Validates that the defined ESXi network parameters for the IP Address, Gateway, and Netmask are all in the same subnet.

Requires the in-subnet-check-render task to have been run prior to this task execution.

23.48.2.2.33. esxi-password-security-policy

Using the esxi/password-policy parameter, set the /etc/pam.d/passwd file to enforce password policy.

This will update the /etc/pam.d/passwd file.

The ESXi GUI may not reflect this change.

23.48.2.2.34. esxi-patch-complete

Remove maintenanceMode on an ESXi system, but only when the system is in maintenanceMode, and the DRP param esxi/maintenance-mode is set to Enabled. This is a safety check to insure that DRP set the maintenance mode, and to not disable it unless we’ve set it.

Uses the esxi-params.py.tmpl python code to set/manage Params on the system.

23.48.2.2.35. vcf-builder-deploy

This task will use ovftool to deploy a vCloud Foundation builder appliance to a specified ESXi node.

23.48.2.2.36. vmware-esxi-clear-patch-index

A task to reset the patch index so that patches can be applied. This is useful to ensure that the sledgehammer pre-phase of ESXi install makes sure that patches can be applied in the install phase.

23.48.2.3. workflows

The content package provides the following workflows.

23.48.2.3.1. esxi-build-isos

Build isos for RackN

23.48.2.3.2. esxi-install

This workflow implements the automatic ESXi install based on the hardware vendor of the machine (if vmware/esxi-version set to select-vendor), and the map Param values from vmware/esxi-version-vendor-map. If select-vendor is not set, then the latest “generic” BootEnv will be used. Please examine the default Param values defined in the vmware/esxi-version-vendor-map param for details.

You must initiate and run this workflow when the machine is in the Sledgehammer (also referred to as “discovery”) environment.

..note:: WARNING: The first stage ‘prep-install’ will erase the disks in preparatioon for the installation.

Please see the full documentation regarding use of the VMware plugin at:

If you have qny questions on customnization of the installation process.

23.48.2.3.3. esxi-join-local

This workflow provides a minimal set of stages and tasks to get an ESXi host added to the DRP endpoint using the esxi-join-up.py script. Upon completion the host will be set to boot locally.

23.48.2.4. bootenvs

The content package provides the following bootenvs.

23.48.2.4.1. esxi_600u2-3620759_vmware-install

Provides VMware BootEnv for ESXi 600u2-3620759 for vmware For more details, and to download ISO see:

NOTE: The ISO filename and sha256sum must match this BootEnv exactly.

23.48.2.4.2. esxi_650u3-13932383-v431_fujitsu-install

Provides VMware BootEnv for ESXi 650u3-13932383-v431 for fujitsu For more details, and to download ISO see:

NOTE: The ISO filename and sha256sum must match this BootEnv exactly.

23.48.2.4.3. esxi_670u2-13981272_lenovo-install

Provides VMware BootEnv for ESXi 670u2-13981272 for lenovo For more details, and to download ISO see:

NOTE: The ISO filename and sha256sum must match this BootEnv exactly.

23.48.2.4.4. esxi_670u3-14320388_fujitsu-install

Provides VMware BootEnv for ESXi 670u3-14320388 for fujitsu For more details, and to download ISO see:

NOTE: The ISO filename and sha256sum must match this BootEnv exactly.

23.48.2.4.5. esxi_670u3-14320388_nec-install

Provides VMware BootEnv for ESXi 670u3-14320388 for nec For more details, and to download ISO see:

NOTE: The ISO filename and sha256sum must match this BootEnv exactly.

23.48.2.4.6. esxi_670u2-13644319_nec_r120h-t120h-r110j-install

Provides VMware BootEnv for ESXi 670u2-13644319 for nec (r120h-t120h-r110j) For more details, and to download ISO see:

NOTE: The ISO filename and sha256sum must match this BootEnv exactly.

23.48.2.4.7. esxi_670u3-14320388_hpe-install

Provides VMware BootEnv for ESXi 670u3-14320388 for hpe For more details, and to download ISO see:

NOTE: The ISO filename and sha256sum must match this BootEnv exactly.

23.48.2.4.8. esxi_670u3-14320388_lenovo-install

Provides VMware BootEnv for ESXi 670u3-14320388 for lenovo For more details, and to download ISO see:

NOTE: The ISO filename and sha256sum must match this BootEnv exactly.

23.48.2.4.9. esxi_650a-4887370_vmware-install

Provides VMware BootEnv for ESXi 650a-4887370 for vmware For more details, and to download ISO see:

NOTE: The ISO filename and sha256sum must match this BootEnv exactly.

23.48.2.4.10. esxi_650u2-8294253_vmware-install

Provides VMware BootEnv for ESXi 650u2-8294253 for vmware For more details, and to download ISO see:

NOTE: The ISO filename and sha256sum must match this BootEnv exactly.

23.48.2.4.11. esxi_670u1-10302608_vmware-install

Provides VMware BootEnv for ESXi 670u1-10302608 for vmware For more details, and to download ISO see:

NOTE: The ISO filename and sha256sum must match this BootEnv exactly.

23.48.2.4.12. esxi_670u2-13006603_hitachi-install

Provides VMware BootEnv for ESXi 670u2-13006603 for hitachi For more details, and to download ISO see:

NOTE: The ISO filename and sha256sum must match this BootEnv exactly.

23.48.2.4.13. esxi_670u2-13006603_rkn_hpe-install

Provides VMware BootEnv for ESXi 670u2-13006603 for rkn_hpe For more details, and to download ISO see:

NOTE: The ISO filename and sha256sum must match this BootEnv exactly.

23.48.2.4.14. esxi_670u3-14320388_nec_r120h-t120h-r110j-install

Provides VMware BootEnv for ESXi 670u3-14320388 for nec (r120h-t120h-r110j) For more details, and to download ISO see:

NOTE: The ISO filename and sha256sum must match this BootEnv exactly.

23.48.2.4.15. esxi_670u3-xs20190801001_rkn_vmware-install

Provides VMware BootEnv for ESXi 670u3-xs20190801001 for rkn_vmware For more details, and to download ISO see:

NOTE: The ISO filename and sha256sum must match this BootEnv exactly.

23.48.2.4.16. esxi_672u3-13644319_rkn_nec-install

Provides VMware BootEnv for ESXi 672u3-13644319 for rkn_nec For more details, and to download ISO see:

NOTE: The ISO filename and sha256sum must match this BootEnv exactly.

23.48.2.4.17. esxi_701-16412512_vmware-install

Provides VMware BootEnv for ESXi 701-16412512 for vmware For more details, and to download ISO see:

NOTE: The ISO filename and sha256sum must match this BootEnv exactly.

23.48.2.4.18. esxi_650u3-13932383_nec_standard-install

Provides VMware BootEnv for ESXi 650u3-13932383 for nec (standard) For more details, and to download ISO see:

NOTE: The ISO filename and sha256sum must match this BootEnv exactly.

23.48.2.4.19. esxi_650u3-13932383_rkn_hpe-install

Provides VMware BootEnv for ESXi 650u3-13932383 for rkn_hpe For more details, and to download ISO see:

NOTE: The ISO filename and sha256sum must match this BootEnv exactly.

23.48.2.4.20. esxi_670u3-15160138-A04_dell-install

Provides VMware BootEnv for ESXi 670u3-15160138-A04 for dell For more details, and to download ISO see:

NOTE: The ISO filename and sha256sum must match this BootEnv exactly.

23.48.2.4.21. esxi_670u3-x20190801001_rkn_vmware-install

Provides VMware BootEnv for ESXi 670u3-x20190801001 for rkn_vmware For more details, and to download ISO see:

NOTE: The ISO filename and sha256sum must match this BootEnv exactly.

23.48.2.4.22. esxi_700-16324942_rkn_dell-install

Provides VMware BootEnv for ESXi 700-16324942 for rkn_dell For more details, and to download ISO see:

NOTE: The ISO filename and sha256sum must match this BootEnv exactly.

23.48.2.4.23. esxi_670u3-13981272-A03_dell-install

Provides VMware BootEnv for ESXi 670u3-13981272-A03 for dell For more details, and to download ISO see:

NOTE: The ISO filename and sha256sum must match this BootEnv exactly.

23.48.2.4.24. esxi_670u3-20190801001_rkn_vmware-install

Provides VMware BootEnv for ESXi 670u3-20190801001 for rkn_vmware For more details, and to download ISO see:

NOTE: The ISO filename and sha256sum must match this BootEnv exactly.

23.48.2.4.25. esxi_700-15843807_rkn_dell-install

Provides VMware BootEnv for ESXi 700-15843807 for rkn_dell For more details, and to download ISO see:

NOTE: The ISO filename and sha256sum must match this BootEnv exactly.

23.48.2.4.26. esxi_600u3a-5572656_vmware-install

Provides VMware BootEnv for ESXi 600u3a-5572656 for vmware For more details, and to download ISO see:

NOTE: The ISO filename and sha256sum must match this BootEnv exactly.

23.48.2.4.27. esxi_650u1-7388607_hpe-install

Provides VMware BootEnv for ESXi 650u1-7388607 for hpe For more details, and to download ISO see:

NOTE: The ISO filename and sha256sum must match this BootEnv exactly.

23.48.2.4.28. esxi_650u2-8294253-A00_dell-install

Provides VMware BootEnv for ESXi 650u2-8294253-A00 for dell For more details, and to download ISO see:

NOTE: The ISO filename and sha256sum must match this BootEnv exactly.

23.48.2.4.29. esxi_670-xs20190401001_rkn_vmware-install

Provides VMware BootEnv for ESXi 670-xs20190401001 for rkn_vmware For more details, and to download ISO see:

NOTE: The ISO filename and sha256sum must match this BootEnv exactly.

23.48.2.4.30. esxi_670u2-13006603_hitachi_blade-ha8000-install

Provides VMware BootEnv for ESXi 670u2-13006603 for hitachi (blade-ha8000) For more details, and to download ISO see:

NOTE: The ISO filename and sha256sum must match this BootEnv exactly.

23.48.2.4.31. esxi_700u1-16850804_rkn_hpe-install

Provides VMware BootEnv for ESXi 700u1-16850804 for rkn_hpe For more details, and to download ISO see:

NOTE: The ISO filename and sha256sum must match this BootEnv exactly.

23.48.2.4.32. esxi_550u3b-3248547_vmware-install

Provides VMware BootEnv for ESXi 550u3b-3248547 for vmware For more details, and to download ISO see:

NOTE: The ISO filename and sha256sum must match this BootEnv exactly.

23.48.2.4.33. esxi_670u1-11675023_hpe-install

Provides VMware BootEnv for ESXi 670u1-11675023 for hpe For more details, and to download ISO see:

NOTE: The ISO filename and sha256sum must match this BootEnv exactly.

23.48.2.4.34. esxi_670u2-13473784_rkn_fujitsu-install

Provides VMware BootEnv for ESXi 670u2-13473784 for rkn_fujitsu For more details, and to download ISO see:

NOTE: The ISO filename and sha256sum must match this BootEnv exactly.

23.48.2.4.35. esxi_700-15843807_rkn_vmware-install

Provides VMware BootEnv for ESXi 700-15843807 for rkn_vmware For more details, and to download ISO see:

NOTE: The ISO filename and sha256sum must match this BootEnv exactly.

23.48.2.4.36. esxi_700-16324942_rkn_cisco-install

Provides VMware BootEnv for ESXi 700-16324942 for rkn_cisco For more details, and to download ISO see:

NOTE: The ISO filename and sha256sum must match this BootEnv exactly.

23.48.2.4.37. esxi_700-15843807_vmware-install

Provides VMware BootEnv for ESXi 700-15843807 for vmware For more details, and to download ISO see:

NOTE: The ISO filename and sha256sum must match this BootEnv exactly.

23.48.2.4.38. esxi_700-x15843807_rkn_vmware-install

Provides VMware BootEnv for ESXi 700-x15843807 for rkn_vmware For more details, and to download ISO see:

NOTE: The ISO filename and sha256sum must match this BootEnv exactly.

23.48.2.4.39. esxi_650u3-x13932383_rkn_vmware-install

Provides VMware BootEnv for ESXi 650u3-x13932383 for rkn_vmware For more details, and to download ISO see:

NOTE: The ISO filename and sha256sum must match this BootEnv exactly.

23.48.2.4.40. esxi_670u2-13006603_hpe-install

Provides VMware BootEnv for ESXi 670u2-13006603 for hpe For more details, and to download ISO see:

NOTE: The ISO filename and sha256sum must match this BootEnv exactly.

23.48.2.4.41. esxi_670u2-13006603_rkn_hitachi-install

Provides VMware BootEnv for ESXi 670u2-13006603 for rkn_hitachi For more details, and to download ISO see:

NOTE: The ISO filename and sha256sum must match this BootEnv exactly.

23.48.2.4.42. esxi_670u3-14320388_cisco-install

Provides VMware BootEnv for ESXi 670u3-14320388 for cisco For more details, and to download ISO see:

NOTE: The ISO filename and sha256sum must match this BootEnv exactly.

23.48.2.4.43. esxi_670u3b-15160138_vmware-install

Provides VMware BootEnv for ESXi 670u3b-15160138 for vmware For more details, and to download ISO see:

NOTE: The ISO filename and sha256sum must match this BootEnv exactly.

23.48.2.4.44. esxi_670-s20190401001_rkn_vmware-install

Provides VMware BootEnv for ESXi 670-s20190401001 for rkn_vmware For more details, and to download ISO see:

NOTE: The ISO filename and sha256sum must match this BootEnv exactly.

23.48.2.4.45. esxi_670u1-10302608_hitachi_blade-ha8000-install

Provides VMware BootEnv for ESXi 670u1-10302608 for hitachi (blade-ha8000) For more details, and to download ISO see:

NOTE: The ISO filename and sha256sum must match this BootEnv exactly.

23.48.2.4.46. esxi_670u2-13006603_vmware-install

Provides VMware BootEnv for ESXi 670u2-13006603 for vmware For more details, and to download ISO see:

NOTE: The ISO filename and sha256sum must match this BootEnv exactly.

23.48.2.4.47. esxi_700u1-16850804_rkn_dell-install

Provides VMware BootEnv for ESXi 700u1-16850804 for rkn_dell For more details, and to download ISO see:

NOTE: The ISO filename and sha256sum must match this BootEnv exactly.

23.48.2.4.48. esxi_700u1-x16850804_rkn_vmware-install

Provides VMware BootEnv for ESXi 700u1-x16850804 for rkn_vmware For more details, and to download ISO see:

NOTE: The ISO filename and sha256sum must match this BootEnv exactly.

23.48.2.4.49. esxi_670u1-10764712-A04_dell-install

Provides VMware BootEnv for ESXi 670u1-10764712-A04 for dell For more details, and to download ISO see:

NOTE: The ISO filename and sha256sum must match this BootEnv exactly.

23.48.2.4.50. esxi_670u2-13473784_fujitsu-install

Provides VMware BootEnv for ESXi 670u2-13473784 for fujitsu For more details, and to download ISO see:

NOTE: The ISO filename and sha256sum must match this BootEnv exactly.

23.48.2.4.51. esxi_670u3-15160138_hpe-install

Provides VMware BootEnv for ESXi 670u3-15160138 for hpe For more details, and to download ISO see:

NOTE: The ISO filename and sha256sum must match this BootEnv exactly.

23.48.2.4.52. esxi_650u3-105610_rkn_hpe-install

Provides VMware BootEnv for ESXi 650u3-105610 for rkn_hpe For more details, and to download ISO see:

NOTE: The ISO filename and sha256sum must match this BootEnv exactly.

23.48.2.4.53. esxi_650u3-13932383_hitachi_blade-ha8000-install

Provides VMware BootEnv for ESXi 650u3-13932383 for hitachi (blade-ha8000) For more details, and to download ISO see:

NOTE: The ISO filename and sha256sum must match this BootEnv exactly.

23.48.2.4.54. esxi_670u1-10302608_cisco-install

Provides VMware BootEnv for ESXi 670u1-10302608 for cisco For more details, and to download ISO see:

NOTE: The ISO filename and sha256sum must match this BootEnv exactly.

23.48.2.4.55. esxi_670u1-10302608_nec-install

Provides VMware BootEnv for ESXi 670u1-10302608 for nec For more details, and to download ISO see:

NOTE: The ISO filename and sha256sum must match this BootEnv exactly.

23.48.2.4.56. esxi_670u1-10302608_nec_r120h-t120h-r110j-install

Provides VMware BootEnv for ESXi 670u1-10302608 for nec (r120h-t120h-r110j) For more details, and to download ISO see:

NOTE: The ISO filename and sha256sum must match this BootEnv exactly.

23.48.2.4.57. esxi_670u3-15160138_lenovo-install

Provides VMware BootEnv for ESXi 670u3-15160138 for lenovo For more details, and to download ISO see:

NOTE: The ISO filename and sha256sum must match this BootEnv exactly.

23.48.2.4.58. esxi_650u3-105610_hpe-install

Provides VMware BootEnv for ESXi 650u3-105610 for hpe For more details, and to download ISO see:

NOTE: The ISO filename and sha256sum must match this BootEnv exactly.

23.48.2.4.59. esxi_650u3-13932383_hitachi_ha8000v-gen10-install

Provides VMware BootEnv for ESXi 650u3-13932383 for hitachi (ha8000v-gen10) For more details, and to download ISO see:

NOTE: The ISO filename and sha256sum must match this BootEnv exactly.

23.48.2.4.60. esxi_670u1-11675023_hitachi_ha8000v-gen10-install

Provides VMware BootEnv for ESXi 670u1-11675023 for hitachi (ha8000v-gen10) For more details, and to download ISO see:

NOTE: The ISO filename and sha256sum must match this BootEnv exactly.

23.48.2.4.61. esxi_700-15843807_rkn_hpe-install

Provides VMware BootEnv for ESXi 700-15843807 for rkn_hpe For more details, and to download ISO see:

NOTE: The ISO filename and sha256sum must match this BootEnv exactly.

23.48.2.4.62. esxi_700u1-16850804_rkn_lenovo-install

Provides VMware BootEnv for ESXi 700u1-16850804 for rkn_lenovo For more details, and to download ISO see:

NOTE: The ISO filename and sha256sum must match this BootEnv exactly.

23.48.2.4.63. esxi_700u1-16850804_rkn_vmware-install

Provides VMware BootEnv for ESXi 700u1-16850804 for rkn_vmware For more details, and to download ISO see:

NOTE: The ISO filename and sha256sum must match this BootEnv exactly.

23.48.2.4.64. esxi_70b-16324942_vmware-install

Provides VMware BootEnv for ESXi 70b-16324942 for vmware For more details, and to download ISO see:

NOTE: The ISO filename and sha256sum must match this BootEnv exactly.

23.48.2.4.65. esxi_650u3-13932383-A01_dell-install

Provides VMware BootEnv for ESXi 650u3-13932383-A01 for dell For more details, and to download ISO see:

NOTE: The ISO filename and sha256sum must match this BootEnv exactly.

23.48.2.4.66. esxi_670-13006603_rkn_cisco-install

Provides VMware BootEnv for ESXi 670-13006603 for rkn_cisco For more details, and to download ISO see:

NOTE: The ISO filename and sha256sum must match this BootEnv exactly.

23.48.2.4.67. esxi_670u2-13006603_cisco-install

Provides VMware BootEnv for ESXi 670u2-13006603 for cisco For more details, and to download ISO see:

NOTE: The ISO filename and sha256sum must match this BootEnv exactly.

23.48.2.4.68. esxi_700-15843807_fujitsu-install

Provides VMware BootEnv for ESXi 700-15843807 for fujitsu For more details, and to download ISO see:

NOTE: The ISO filename and sha256sum must match this BootEnv exactly.

23.48.2.4.69. esxi_700-16324942-A02_dell-install

Provides VMware BootEnv for ESXi 700-16324942-A02 for dell For more details, and to download ISO see:

NOTE: The ISO filename and sha256sum must match this BootEnv exactly.

23.48.2.4.70. esxi_650u2-10719125-A07_dell-install

Provides VMware BootEnv for ESXi 650u2-10719125-A07 for dell For more details, and to download ISO see:

NOTE: The ISO filename and sha256sum must match this BootEnv exactly.

23.48.2.4.71. esxi_670-x20190402001_rkn_vmware-install

Provides VMware BootEnv for ESXi 670-x20190402001 for rkn_vmware For more details, and to download ISO see:

NOTE: The ISO filename and sha256sum must match this BootEnv exactly.

23.48.2.4.72. esxi_670u3-14320388_vmware-install

Provides VMware BootEnv for ESXi 670u3-14320388 for vmware For more details, and to download ISO see:

NOTE: The ISO filename and sha256sum must match this BootEnv exactly.

23.48.2.4.73. esxi_670u3-15160138-20200407_lenovo-install

Provides VMware BootEnv for ESXi 670u3-15160138-20200407 for lenovo For more details, and to download ISO see:

NOTE: The ISO filename and sha256sum must match this BootEnv exactly.

23.48.2.4.74. esxi_67u2-13981272_rkn_dell-install

Provides VMware BootEnv for ESXi 67u2-13981272 for rkn_dell For more details, and to download ISO see:

NOTE: The ISO filename and sha256sum must match this BootEnv exactly.

23.48.2.4.75. esxi_650u3-15177306_lenovo-install

Provides VMware BootEnv for ESXi 650u3-15177306 for lenovo For more details, and to download ISO see:

NOTE: The ISO filename and sha256sum must match this BootEnv exactly.

23.48.2.4.76. esxi_670-11675023_fujitsu-install

Provides VMware BootEnv for ESXi 670-11675023 for fujitsu For more details, and to download ISO see:

NOTE: The ISO filename and sha256sum must match this BootEnv exactly.

23.48.2.4.77. esxi_670-20190402001_rkn_vmware-install

Provides VMware BootEnv for ESXi 670-20190402001 for rkn_vmware For more details, and to download ISO see:

NOTE: The ISO filename and sha256sum must match this BootEnv exactly.

23.48.2.4.78. esxi_670u3-14320388_nec_standard-install

Provides VMware BootEnv for ESXi 670u3-14320388 for nec (standard) For more details, and to download ISO see:

NOTE: The ISO filename and sha256sum must match this BootEnv exactly.

23.48.2.4.79. esxi_700-15843807_hpe-install

Provides VMware BootEnv for ESXi 700-15843807 for hpe For more details, and to download ISO see:

NOTE: The ISO filename and sha256sum must match this BootEnv exactly.

23.48.2.4.80. esxi_650u3-13932383_vmware-install

Provides VMware BootEnv for ESXi 650u3-13932383 for vmware For more details, and to download ISO see:

NOTE: The ISO filename and sha256sum must match this BootEnv exactly.

23.48.2.4.81. esxi_650u3-14320405-A03_dell-install

Provides VMware BootEnv for ESXi 650u3-14320405-A03 for dell For more details, and to download ISO see:

NOTE: The ISO filename and sha256sum must match this BootEnv exactly.

23.48.2.4.82. esxi_650u3-14320405_lenovo-install

Provides VMware BootEnv for ESXi 650u3-14320405 for lenovo For more details, and to download ISO see:

NOTE: The ISO filename and sha256sum must match this BootEnv exactly.

23.48.2.4.83. esxi_650u3-15256549_lenovo-install

Provides VMware BootEnv for ESXi 650u3-15256549 for lenovo For more details, and to download ISO see:

NOTE: The ISO filename and sha256sum must match this BootEnv exactly.

23.48.2.4.84. esxi_670u2-13644319_nec_standard-install

Provides VMware BootEnv for ESXi 670u2-13644319 for nec (standard) For more details, and to download ISO see:

NOTE: The ISO filename and sha256sum must match this BootEnv exactly.

23.48.2.4.85. esxi_670u3-s20190801001_rkn_vmware-install

Provides VMware BootEnv for ESXi 670u3-s20190801001 for rkn_vmware For more details, and to download ISO see:

NOTE: The ISO filename and sha256sum must match this BootEnv exactly.

23.48.2.4.86. esxi_700-16324942_hpe-install

Provides VMware BootEnv for ESXi 700-16324942 for hpe For more details, and to download ISO see:

NOTE: The ISO filename and sha256sum must match this BootEnv exactly.

23.48.2.4.87. esxi_700u1-16850804_rkn_cisco-install

Provides VMware BootEnv for ESXi 700u1-16850804 for rkn_cisco For more details, and to download ISO see:

NOTE: The ISO filename and sha256sum must match this BootEnv exactly.

23.48.2.4.88. esxi_650u3-13932383-v430_fujitsu-install

Provides VMware BootEnv for ESXi 650u3-13932383-v430 for fujitsu For more details, and to download ISO see:

NOTE: The ISO filename and sha256sum must match this BootEnv exactly.

23.48.2.4.89. esxi_650u3-13932383_cisco-install

Provides VMware BootEnv for ESXi 650u3-13932383 for cisco For more details, and to download ISO see:

NOTE: The ISO filename and sha256sum must match this BootEnv exactly.

23.48.2.4.90. esxi_650u3-13932383_hpe_pregen9-install

Provides VMware BootEnv for ESXi 650u3-13932383 for hpe (pregen9) For more details, and to download ISO see:

NOTE: The ISO filename and sha256sum must match this BootEnv exactly.

23.48.2.4.91. esxi_670-8169922_vmware-install

Provides VMware BootEnv for ESXi 670-8169922 for vmware For more details, and to download ISO see:

NOTE: The ISO filename and sha256sum must match this BootEnv exactly.

23.48.2.4.92. esxi_670u3-16316930-20200407_lenovo-install

Provides VMware BootEnv for ESXi 670u3-16316930-20200407 for lenovo For more details, and to download ISO see:

NOTE: The ISO filename and sha256sum must match this BootEnv exactly.

23.48.2.4.93. esxi_700-15843807_cisco-install

Provides VMware BootEnv for ESXi 700-15843807 for cisco For more details, and to download ISO see:

NOTE: The ISO filename and sha256sum must match this BootEnv exactly.

23.48.2.4.94. esxi_650u3-13932383_rkn_vmware-install

Provides VMware BootEnv for ESXi 650u3-13932383 for rkn_vmware For more details, and to download ISO see:

NOTE: The ISO filename and sha256sum must match this BootEnv exactly.

23.48.2.4.95. esxi_650u3-14293459_vmware_rollup-install

Provides VMware BootEnv for ESXi 650u3-14293459 for vmware (rollup) For more details, and to download ISO see:

NOTE: The ISO filename and sha256sum must match this BootEnv exactly.

23.48.2.4.96. esxi_650u3-14320405_hpe-install

Provides VMware BootEnv for ESXi 650u3-14320405 for hpe For more details, and to download ISO see:

NOTE: The ISO filename and sha256sum must match this BootEnv exactly.

23.48.2.4.97. esxi_670u2-13981272-A02_dell-install

Provides VMware BootEnv for ESXi 670u2-13981272-A02 for dell For more details, and to download ISO see:

NOTE: The ISO filename and sha256sum must match this BootEnv exactly.

23.48.2.4.98. esxi_670u2-13981272_rkn_lenovo-install

Provides VMware BootEnv for ESXi 670u2-13981272 for rkn_lenovo For more details, and to download ISO see:

NOTE: The ISO filename and sha256sum must match this BootEnv exactly.

23.48.2.4.99. esxi_700-15843807_dell-install

Provides VMware BootEnv for ESXi 700-15843807 for dell For more details, and to download ISO see:

NOTE: The ISO filename and sha256sum must match this BootEnv exactly.

23.48.2.4.100. esxi_650u3-14990892_hpe-install

Provides VMware BootEnv for ESXi 650u3-14990892 for hpe For more details, and to download ISO see:

NOTE: The ISO filename and sha256sum must match this BootEnv exactly.

23.48.2.4.101. esxi_670u1-10302608_fujitsu-install

Provides VMware BootEnv for ESXi 670u1-10302608 for fujitsu For more details, and to download ISO see:

NOTE: The ISO filename and sha256sum must match this BootEnv exactly.

23.48.2.4.102. esxi_670u1-110302608_lenovo-install

Provides VMware BootEnv for ESXi 670u1-110302608 for lenovo For more details, and to download ISO see:

NOTE: The ISO filename and sha256sum must match this BootEnv exactly.

23.48.2.4.103. esxi_670u1-11675023_lenovo-install

Provides VMware BootEnv for ESXi 670u1-11675023 for lenovo For more details, and to download ISO see:

NOTE: The ISO filename and sha256sum must match this BootEnv exactly.

23.48.2.4.104. esxi_700-15083681_vmware-install

Provides VMware BootEnv for ESXi 700-15083681 for vmware For more details, and to download ISO see:

NOTE: The ISO filename and sha256sum must match this BootEnv exactly.

23.48.2.5. params

The content package provides the following params.

23.48.2.5.1. esxi/generate-random-password

If specified, the ‘esxi-insecure-password.sh.tmpl’ template will dynamically generate a random password. This will be recorded in the insecure param ‘esxi/insecure-password’, then converted to a SHA512 hash value used to set the root/admin password.

Future iterations of this may include the ability to store the generated password on a remote password keeper, secrets vault, or whatever.

The default operation is to not generate a random password, but to use the value set in the ‘esxi/insecure-password’ param.

23.48.2.5.2. esxi/patch-list-override

Defines the VMware patches that will be applied to the system. This value will override all construction methods replacing the vmware/esxi-version-vendor-map.

Generally speaking, the vendor map should be used to select the patches to apply to the system. However, this override exists to allow an operator a method to specify precise patches to apply if your vendor map doesn’t support a patch list.

In both cases, the esxi/patch-map must contain a map for the specified patches to be applied with appropriate values.

Pathces are applied in order. For each patch that specifies a reboot-required: true, the system will be rebooted before applying the next patch set. If not set to true, then patches will be applied until the next required reboot is specified.

23.48.2.5.3. esxi/rename-datastore

Rename the default VMware ESXi datastore (datastore1) to something else. This Param is implemented by the esxi-rename-datastore Task and Stage.

If this Param is set, and if the esxi-rename-datastore task is run, then the datastore will be renamed to this value.

23.48.2.5.4. esxi/welcome-customize

By default Digital Rebar Provision VMware plugin will customize the /etc/vmware/welcome screen with DRP, RackN, and other additional information.

To disable this behavior and fall back to the product default, set this Param value to false.

23.48.2.5.5. esxi/network-firstboot-dns

Use this param with esxi/network-firstboot-type set to manual to specify the ESXi nodes network configuration post-kickstart. NOTE, you must verify that the IP addressing and Layer 2 characteristics are correct for proper network connectivity post-reboot.

Up to two DNS nameservers may be specified by separating them with a comma (,) without any spaces (eg. 1.1.1.1,1.0.0.1

The two nameserver and format limitation is a VMware defined limit.

23.48.2.5.6. esxi/network-firstboot-vlan

Sets the VLAN tag ID (VLANID) for the installed ESXi instance on first boot.

Note that there are three possible places you may want/need to set a VLANID:

  1. At PXE boot time for the kernel - use kernel-options and vlanid=N syntax
  2. During the installation phase in the kickstart process - use the Param esxi/network-kickstart-vlan
  3. After final reboot, to transition to a “production” or similar network, use the Param esxi/network-firstboot-vlan

In many cases, the provisioning network may or may not be a VLAN tagged network, which may very likely be different from the final installed ESXi production use case network configuration. On firstboot, you can specify values separately from the installation phases to support network transitions from install to production use.

If you set a different value for the firstboot stage VLANID, you must also ensure the network settings are correctly reflected for the new VLAN. Your options are to use DHCP or Manual modes in this case (see esxi/network-type Param). Convert would not be correct in this case as the provisioning network is likely to not be the same IP address space as a production network when changing VLANIDs.

Valid values as defined by VMware for this field are from 1 to 4095.

23.48.2.5.7. esxi/network-kickstart-type

This Param specifies how the ESXi node should be configured for it’s network interface during kickstart installation. The supported mode types are:

type notes
dhcp (default) requests IP info via DHCP service
convert converts the existing DHCP lease to a static assignment
manual operator provides values via additonal params

If set to manual use the following Params to configure the network

param notes
esxi/network-ipaddr sets the IP Address
esxi/network-netmask sets the subnet Netmask
esxi/network-gateway sets the Default Gateway
esxi/network-dns sets DNS server(s) (comma, no spaces separated)
esxi/network-hostname defines nodes Hostname

All values must be specified for “manual” type.

WARNING

Currently, changing the network type from DHCP will not cause any interaction with your DRP Endpoint. This means that if you use convert to static IP assignment, the DRP endpoint will not be aware of this. You will need to create a Reservation manually to ensure your IP assignment isn’t stomped on.

Similarly, if you use manual, it is your responsibility to ensure you do not map a manual IP assignment to any DHCP ranges, unless you also arrange to have that IP assignment converted to a Reservation (when using DRP as the DHCP service).

Future versions of this plugin should correct this issue.

23.48.2.5.8. esxi/network-kickstart-vlan

Sets the VLAN tag ID (VLANID) for the kickstart installation network settings.

Note that there are three possible places you may want/need to set a VLANID:

  1. At PXE boot time for the kernel - use kernel-options and vlanid=N syntax
  2. During the installation phase in the kickstart process - use the Param esxi/network-kickstart-vlan
  3. After final reboot, to transition to a “production” or similar network, use the Param esxi/network-firstboot-vlan

In many cases, the provisioning network may or may not be a VLAN tagged network, which may very likely be different from the final installed ESXi production use case network configuration. On firstboot, you can specify values separately from the installation phases to support network transitions from install to production use.

If you set a different value for the firstboot stage VLANID, you must also ensure the network settings are correctly reflected for the new VLAN. Your options are to use DHCP or Manual modes in this case (see esxi/network-type Param). Convert would not be correct in this case as the provisioning network is likely to not be the same IP address space as a production network when changing VLANIDs.

Valid values as defined by VMware for this field are from 1 to 4095.

23.48.2.5.9. esxi/add-drpy-agent

Dynamically add the Digital Rebar Python Agent (runner) to the ESXi install modules list in the boot.cfg template.

Setting this value will define the install location used during the vSphere ESXi installation. It must be a valid path that resolves relative to prefix as defined in the boot.cfg template, or a fully qualified HTTP path.

Examples:

  • ../../files/vmware/drpy.v00
  • http://10.10.10.10:8091/files/vmware/drpy.v00

23.48.2.5.10. esxi/boot-cfg-extra-options

If specified, sets additional key=value pairs to be injected in to the ESXi boot.cfg file. The boot configuration file used by ESXi sets simple text based keys and associated values to control the installation options from the ISO contents.

It may be necessary to add additional boot key and value pairs in the boot.cfg template for a system to successfully install on a given platform. This Param can be used to add in extra options to the file.

To use it, simply set the Param string value to appropriate key and value pairs, separate by newlines, like:

key1=value1
key2=value2

IT IS IMPORTANT that you insert a newline between key=value pairs.

23.48.2.5.11. esxi/insecure-password

If specified, defines a HIGHLY INSECURE cleartext password to be converted to a SHA512 hash for the ‘root’ account on an ESXi instance.

Typically, the workflow will get a desired password from a remote infrastructure system (password manager, vault, etc.) as an API call, and then convert to a SHA512 for the ‘root’ account.

23.48.2.5.12. esxi/ks-custom-kickstart

This Param allows an operator to create a list of additional “kickstart” directives to apply to generated kickstart file. These directives will be placed after the network template, but before any other %pre, %post, and/or %firstboot sections.

If you wish to add additional templates for %pre, %post, and/or %firstboot sections, use the esxi/ks-custom-sections param.

Multiple additional templates can be called with kickstart commands in them. Below is an example:

# YAML example
esxi/ks-custom-kickstart:
  - "my-kickstart-1.ks.tmpl"
  - "my-kickstart-2.ks.tmpl"

# JSON example
{
  [
    "my-kickstart-1.ks.tmpl",
    "my-kickstart-2.ks.tmpl"
  ]
}

23.48.2.5.13. vcf-builder/association

Defines the grouping for the vCloud Foundation Builder association between elements.

Example:
digitalrebar-sddc-01

23.48.2.5.14. vmware/esxi-hcl-location

The python3 path location to the installed ESXi Compatibility Checker. This should be correctly setup by the vmware-esxi-hcl-install Stage.

Note that the Compatibility Checker tool currently requires access to a vCenter server and ESXi already installed on a host to gather the compatibility report information for. Additionaly, you must have internet access to the VMware API Gateway located at:

23.48.2.5.15. esxi/password-policy

In ESXI 6 and beyond, the password security policy is controlled through the /etc/pam.d/passwd file.

The default file is specified as the default. This can be replaced by updating this parameter and running the esxi-password-security-policy task.

Password strength is specified on the pam_passwdqc.so line.

  • password requisite /lib/security/$ISA/pam_passwdqc.so retry=N min=N0,N1,N2,N3,N4

Example:

  • password   requisite    /lib/security/$ISA/pam_passwdqc.so retry=3 min=8,8,8,7,6

The parts are:

  • retry is the number of times a user is prompted for a new password if the password candidate is not sufficiently strong.
  • N0 is the number of characters required for a password that uses characters from only one character class. For example, the password contains only lowercase letters.
  • N1 is the number of characters required for a password that uses characters from two character classes.
  • N2 is used for passphrases. ESXi requires three words for a passphrase. Each word in the passphrase must be 8-40 characters long.
  • N3 is the number of characters required for a password that uses characters from three character classes.
  • N4 is the number of characters required for a password that uses characters from all four character classes.

For the N(0-3) fields, disabled may be specified to ignore that class type.

The Password history can also be modify by the following line:

  • password   requisite    /lib/security/$ISA/pam_pwhistory.so use_authtok enforce_for_root retry=2 remember=0

Adding this line will enforce a number of retries before failure and how often password can be reused.

23.48.2.5.16. esxi/patches-enabled

If set to true, then apply all specified patches in the vmware/esxi-version-vendor-map or the esxi/patch-list-override for the selected bootenv.

By default, if the patches data structure in the vendor map exists and contains patch references, then they patches will be installed. This value allows an operator to override the default behavior and disable the patching system even if the pathces have been specified in the vendor map.

23.48.2.5.17. esxi/python-sleep

Sets a number of seconds to sleep in python code, after making a Firewall transition change. On some hardware (eg. HPE Moonshot cartridges), there may be a timing issue that requires a temporary sleep to allow the firewall changes to “settle”.

The default value is 0 seconds (no sleep) if not otherwise specified, and can range from 0 to a maximum of 300 seconds. Partial second values are allowed (eg .300 for 300 microseconds).

23.48.2.5.18. esxi/skip-update-address

This Param lets the operator skip the update of the Machine’s Address prior to setting up the network in esxi.

It uses the esxi/network-firstboot-ipaddr parameter to fill in the Machine’s Address field.

23.48.2.5.19. vmware/esxi-hcl-completed

Set to true if the Compatibility Checker has already been run for the given host.

23.48.2.5.20. vmware/esxi-version-override

If the data structure vmware/esxi-version does not support your ESXi BootEnv (eg a custom bootenv you inject), then you can use this param to specify a BootEnv to load.

The value of this Param MUST MATCH the BootEnv name exactly, without the trailing -install component.

Example 1: esxi_700-15843807_vmware

Example 2: esxi_670u1-10302608_hitachi_ha8000v-gen10

23.48.2.5.21. esxi/disk-install-override

Some hardware (namely HPE with “Smart” Array controllers do not iterate the disks smartly. This causes the ESXi install strategy to fail when the RAID controller is specified as a RAID 1 device with passthrough mode for the remainder of the devices. ESXi does not build an appropriate device type for us to handle with the –disk=mpx.vmhb0:… strategy.

This Param will override the ESXi Kickstart install … directive and select a given supported strategy for finding the disk to install to.

The currently supported install directives are defined below:

directive notes
first_disk Sets the install disk target to the default value of ‘–firstdisk’. Primarily useful only for testing the code path of this content, since this is the default behavior if nothing else is specified.
find_first_naa Selects the first device that is iterated in the /vmfs/devices/disks directory, with the name beginning with ‘naa.*’
find_first_dellboss_vd Sets disk to first JBOSS Virtual Disk on Dell systems.
find_disk_name Sets disk to the first pattern matched by the first argument to the function. The input string is surrounded by *.

find_disk_name MUST be called with an additional argument that is a pattern. An example value is:

find_disk_name 'disk.v1'

Using the above listed strategies will set the Kickstart install command as follows:

install --disk=<FOUND_DEVICE>

If other install options need to be specified (eg –overwritevmfs), you must also set those as the Param esxi/disk-install-override-options and they will be appended to the above example install command. Here is an example:

# with 'esxi/disk-install-override-options' set to '--overwritevmfs'
# the 'install' command will be built up as follows:

install --disk=/vmfs/devices/disks/naa.60... --overwritevmfs

Note that custom functions can be injected in to the template to support strategies that are not directly released with this content. This allows for custom in-the-field templates to be built, and injected in to the DRP endpoint to support new “strategies” as needed.

If new strategies are developed/used, please contact RackN to help ensure these are added in to standard product so field customizations are not necessary.

The Param type definition does not include an enum: … list as custom strategies may be injected via the esxi/disk-install-override-custom Param.

23.48.2.5.22. esxi/drp-port-disable

For installation of ESXi to succeed, the Machine being installed must be able to reach the DRP API service port. This allows for some Python hackery to notify DRP to set the Machine to boot local disk, and other actions.

Once the Machine has been installed, it is possible to disable the outbound open port access in the firstboot section. Doing so will disable the ESXi instance from being able to communicate with the dr-provision API service unless the port is opened again.

You can manually enable/disable the API service port access with the following esxcli (or equivalent localcli) command:

esxcli network firewall ruleset set --ruleset-id=dr-provision --enabled=true

Set the true state to false to disable the port access.

23.48.2.5.23. esxi/set-network-protocol-skip

Setting this Param value to true will cause the esxi-set-network-protocol task to skip running. By default the system will run the task (defaul false for this Param).

23.48.2.5.24. esxi/set-norts

If set to true, then the template boot.cfg file will add the norts=1 option to the boot flags.

This is required for some hardware platforms, typically due to processor differences. For example, some Lenovo systems with Skylake processors. The flag disables the UEFI runtime support. Note that other hardware systems may also require this value. Some errors you may see in the middle of the ESXi Weasel Kickstart installer on the systems console:

  • Shutting down firmware services...
  • Using 'simple offset' UEFI RTS mapping policy

By default, the value will not be added to the boot.cfg tempalte.

23.48.2.5.25. esxi/rackn-bundles-7

Defines the 7.X RackN Bundles list.

This can be relative to the files directory on DRP or a URL.

23.48.2.5.26. vcf-builder/serverId

The ESXi server ID string in the cluster. By default the DRP Machine UUID will be used as the serverId.

If you choose to set a different value than this default behavior, then you will have to apply it as an individual Param (or as a different Profile from the vcf-builder-cluster-profile defined profile) on the given Machine.

23.48.2.5.27. vmware/esxi-hcl-validated

Once the VMware ESXi Compatibility Checker has been completed, this Param will contain the results of the check. If the machine is marked compatible by the VMware tools, then the value will be set to True otherwise, it’s False

If True then it is implied the machine is compliant with the HCL.

Note that both this Param and vmware/esxi-hcl-completed should be set to True to ensure that the tooling ran, and the machine passed validation.

However, in DevTest situations, you may set the value to True to allow for subsequent installers to complete successfully, regardless of the actual HCL compatibility check results.

23.48.2.5.28. esxi/boot-cfg-extra-modules

Dynamically add additional modules in to the ESXi installed list of modules. This is an Array of modules. The boot.cfg supports a relative path to the module from the boot.cfg specified location defined by the prefix. For Digital Rebar, this means a path of ../../files/ would refer to the standard Files served artifacts.

A full HTTP path may be specified to the location of the modules.

# YAML example
- "https://files.example.com/path/module.v00"
- "../../files/modules/driver.v00"

# JSON example
[
  "https://files.example.com/path/module.v00",
  "../../files/modules/driver.v00"
]

Note

If the module does not exists or can’t be found, the ESXi install will fail.

23.48.2.5.29. esxi/enable-legacy-install

If set to true, the RackN agent and firewall rule will be injected into esxi during the firstboot portion of the install rather than being baked into the iso.

By default, this option is false.

23.48.2.5.30. esxi/license

If specified, sets the license ID to assign to the installed ESXi VMware vSphere hypervisor.

If not specified, then the hypervisor will be installed in evaluation mode.

23.48.2.5.31. esxi/network-kickstart-hostname

Use this param with esxi/network-kickstart-type set to manual to specify the ESXi nodes network configuration post-kickstart. NOTE, you must verify that the IP addressing and Layer 2 characteristics are correct for proper network connectivity post-reboot.

23.48.2.5.32. esxi/add-drpy-firewall

Dynamically add the Digital Rebar Firewall VIG to the ESXi install modules list in the boot.cfg template.

Setting this value will define the install location used during the vSphere ESXi installation. It must be a valid path that resolves relative to prefix as defined in the boot.cfg template, or a fully qualified HTTP path.

Examples:

  • ../../files/vmware/drpfw.v00
  • http://10.10.10.10:8091/files/vmware/drpfw.v00

23.48.2.5.33. esxi/network-kickstart-dns

Use this param with esxi/network-kickstart-type set to manual to specify the ESXi nodes network configuration post-kickstart. NOTE, you must verify that the IP addressing and Layer 2 characteristics are correct for proper network connectivity post-reboot.

Up to two DNS nameservers may be specified by separating them with a comma (,) without any spaces (eg. 1.1.1.1,1.0.0.1

The two nameserver and format limitation is a VMware defined limit.

23.48.2.5.34. esxi/drpy-log-level

Changes the log level for the DRPY Agent in ESXi

Can be one of CRITICAL, ERROR, WARNING, INFO, DEBUG, and NOTSET. Default if not set is INFO

23.48.2.5.35. esxi/shell-remote

If set to True, enable the remote ESXi shell (SSH access) during the installation of the VMware vSphere ESXi hypervisor.

By default, the remote shell will not be enabled.

23.48.2.5.36. esxi/skip-version

This Param lets the operator skip the version call back to the DRP endpoint during kickstart installation. It is used to get the DRP version info and inject it in to the DCUI screen for identify verification purposes on a built DRP endpoint.

This option is primarily intended for debugging kickstart components that are rendered to the machine via DRP’s templating system.

23.48.2.5.37. esxi/vmnic-device

Use this param to specify the device to plumb the network configuration up with post install. By default we assume “vmnic0”, however, this may not be correct. This param allows the operator to override the defined NIC for the installed OS.

It is possible the Classify content can be used to identify the machine devices to set the Param on the machine for the correct NIC name.

23.48.2.5.38. esxi/disk-install-override-options

Sets addtional options to add to the esxi/disk-install-override strategy that is defined. See that param for more documentation.

Defaults to setting –overwritevmfs for the Kickstart install command.

23.48.2.5.39. esxi/is-nested

If set to true, set the VHV value duing install to flag that we’re running in a nested setup environment (ESXi on a hypervisor).

By default, this option is false.

23.48.2.5.40. esxi/maintenance-mode

The state of ESXi maintenanceMode, as recorded by DRP. This is a second check to insure that DRP set the maintenance mode on, and that should be safe to toggle off.

The only allowed values are Enabled or Disabled, with the default set to disabled.

23.48.2.5.41. esxi/set-network-protocol

This param controls what IP protocol suite is enabled on the ESXi node. By default, both IPv4 and IPv6 are enabled on ESXi.

This Param can be set to:

  • both (the default)
  • ipv4
  • ipv6

If the Param is set to ipv4, the IPv6 protocol will be disabled.

Note

Setting the value to ipv6 will not actually disable the IPv4 protocol suite. VMware has NOT implemented this mode. Please contact VMware for any questions around this policy.

In the future, should the IPv4 protocol suite be allowed to be disabled, this Task will be updated to reflect that capability. In the meantime, IPv4 will always be enabled.

23.48.2.5.42. esxi/acceptance-level

Setting this param and running the task esxi-acceptance-level will set the ESXi node software VIB install acceptance level. NOTE that as per VMware defined policies and behavior, you may NOT set the acceptance level to a level any higher than the lowest level install software VIB package.

Currently, the RackN DRP-Agent and DRP-Firewall-Ruleset VIBs require that the acceptance level be set at CommunitySupported. If these components are installed (as they are by default) you will not be able to raise the level.

The default value is CommunitySupported. The supported values are (from highest to lowest):

  • VMwareCertified
  • VMwareAccepted
  • PartnerSupported
  • CommunitySupported

For more details, please see the VMware knoweldge base article:

23.48.2.5.43. esxi/disk-install-options

This Param lets the operator define any customizations to the install ... directive in the kickstart. If not specified, the default behavior is to set the directive as follows:

install --firstdisk --overwritevmfs

Setting this value will override the --firstdisk --overwritevmfs values with whatever the operator specifies. For options and details, see the VMware documentation:

23.48.2.5.44. esxi/network-firstboot-hostname

Use this param with esxi/network-firstboot-type set to manual to specify the ESXi nodes network configuration post-kickstart. NOTE, you must verify that the IP addressing and Layer 2 characteristics are correct for proper network connectivity post-reboot.

23.48.2.5.45. esxi/network-firstboot-type

This Param specifies how the ESXi node should be configured for it’s network interface post-kickstart. The supported mode types are:

type notes
dhcp (default) requests IP info via DHCP service
manual operator provides values via additonal params

If set to manual use the following Params are required to configure the network:

param notes
esxi/network-firstboot-ipaddr sets the IP Address
esxi/network-firstboot-netmask sets the subnet Netmask
esxi/network-firstboot-gateway sets the Default Gateway
WARNING

Currently, changing the network type from DHCP will not cause any interaction with your DRP Endpoint. This means that if you use convert to static IP assignment, the DRP endpoint will not be aware of this. You will need to create a Reservation manually to ensure your IP assignment isn’t stomped on.

Similarly, if you use manual, it is your responsibility to ensure you do not map a manual IP assignment to any DHCP ranges, unless you also arrange to have that IP assignment converted to a Reservation (when using DRP as the DHCP service).

Future versions of this plugin should correct this issue.

23.48.2.5.46. vcf-builder/cluster-profile

This parameter is used to identify the Profile name to record the vCloud Foundation Builder build information.

23.48.2.5.47. vcf-builder/esxiCredentials-password

Defines the ESXi password for vCF Builder to be able to access and manage the nodes.

23.48.2.5.48. vmware/esxi-version

This Param can be used to specify which supported version of VMware vSphere to install on a given Machine. Note that the version must be a supported BootEnv (the version matches the BootEnv, minus the -install trailer) type on the DRP Endpoint. See the documentation for “select-vendor” special BootEnv behavior selection below.

Supported versions are:
  • select-vendor
  • esxi_550u3b-3248547_vmware
  • esxi_600u2-3620759_vmware
  • esxi_600u3a-5572656_vmware
  • esxi_650a-4887370_vmware
  • esxi_650u1-7388607_hpe
  • esxi_650u2-10719125-A07_dell
  • esxi_650u2-8294253-A00_dell
  • esxi_650u2-8294253_vmware
  • esxi_670-8169922_vmware
  • esxi_670u1-10302608_cisco
  • esxi_670u1-10302608_fujitsu
  • esxi_670u1-10302608_hitachi_blade_ha8000
  • esxi_670u1-10302608_hitachi_ha8000v-gen10
  • esxi_670u1-10302608_lenovo
  • esxi_670u1-10302608_nec
  • esxi_670u1-10302608_vmware
  • esxi_670u1-10764712-A04_dell
  • esxi_670u1-11675023_hpe_gen9plus
  • esxi_670u2-13006603_vmware
  • esxi_670u2-13006603_cisco
  • esxi_670u2-13006603_hitachi
  • esxi_670u2-13006603_hpe
  • esxi_670u2-13473784_fujitsu
  • esxi_670u2-13644319_nec_r120h-t120h-r110j
  • esxi_670u2-13644319_nec_standard
  • esxi_670u2-13981272-A02_dell
  • esxi_670u2-13981272_lenovo
  • esxi_670u3-13981272-A03_dell
  • esxi_670u3-14320388_cisco
  • esxi_670u3-14320388_fujitsu
  • esxi_670u3-14320388_hpe
  • esxi_670u3-14320388_lenovo
  • esxi_670u3-14320388_nec_r120h-t120h-r110j
  • esxi_670u3-14320388_nec_standard
  • esxi_670u3-14320388_vmware
  • esxi_670u3-15160138_lenovo
  • esxi_670u3b-15160138_vmware
  • esxi_700-15843807_dell
  • esxi_700-15843807_hpe
  • esxi_700-15843807_vmware
  • esxi_700u1-16850804_vmware
  • esxi_700u1-x16850804_vmware
  • esxi_700u1-16850804_cisco
  • esxi_700u1-16850804_dell
  • esxi_700u1-16850804_hpe
  • esxi_700u1-16850804_lenovo

NOTICE: The following BootEnvs have been removed from the vmware plugin and are no longer supported:

  • (*) esxi-550u3b
  • (*) esxi-6.7.0-update1-10302608-custom-hitachi_0200_Blade_HA8000
  • (*) esxi-6.7.0-update1-10302608-custom-hitachi_1200_HA8000VGen10
  • (*) esxi-6.7.1-10302608-nec-6.702
  • (*) esxi-6.7.1-10302608-nec-gen-6.7
  • (*) esxi-600u2
  • (*) esxi-600u3a
  • (*) esxi-650a
  • (*) esxi-650u2
  • (*) esxi-670
  • (*) esxi-670u1
  • (*) esxi-670u2
  • (*) esxi-dellemc-esxi-6.5u2-10719125a07
  • (*) esxi-dellemc-esxi-6.7u1-10764712-a04
  • (*) esxi-fujitsu-vmvisor-installer-6.7-10
  • (*) esxi-hpe-esxi-6.7.0-update1-iso-gen9p
  • (*) esxi-lenovo_esxi6.7u1-10302608_201810
  • (*) esxi-vmware-esxi-6.7.0-10302608-custom-cisco

If nothing is specified, the default value will be selected in the default field of the Param.

If the operator specifies select-vendor then the latest Vendor specific BootEnv / ISO combo will be used according to the Param map vmware/esxi-version-vendor-map. The vendor version requires gohai-inventory to match DMI->System->Manufacturer appropriately.

23.48.2.5.49. esxi/bundles-6

Defines the 6.X ESXi Bundles list.

This can be relative to the files directory on DRP or a URL.

23.48.2.5.50. esxi/iso-catalog

Array of esxi iso defintions

This is used to build isos and bootenv/profiles for the content pack.

This can be overridden to build custom isos.

23.48.2.5.51. esxi/network-firstboot-ipaddr

Use this param with esxi/network-firstboot-type set to manual to specify the ESXi nodes network configuration post-kickstart. NOTE, you must verify that the IP addressing and Layer 2 characteristics are correct for proper network connectivity post-reboot.

23.48.2.5.52. esxi/ntp-conf

This is a simple string type that defines the name of a user created template file that contains your NTP configuration settings. The current /etc/ntp.conf template is somewhat rigid and only allows injecting the NTP servers to use. If you need more advanced customizations, use this to create an ntp.conf file for your needs.

You may still use the ntp-servers array if desired in your own template. See the Kickstart template on how to use the Param to inject in your own template (esxi-install-py3.ks.tmpl).

The template you specify should be a valid ntp.conf format.

23.48.2.5.53. vmware/esxi-generic

Set to true if the generic ESXi image should be used for the given host.

23.48.2.5.54. esxi/network-firstboot-vlan-vm-network

Sets the VLAN tag ID (VLANID) for the installed ESXi instance on first boot for the VM Network portgroup.

You may set either a VLAN number (1-4096), or the value management; in which case the VM Network portgroup will be set to the same value as defined for esxi/network-firstboot-vlan (the Management Network portgroup).

23.48.2.5.55. esxi/ssl-key

A SSL Key to put in place for the SSL services.

23.48.2.5.56. vcf-builder/esxiCredentials-username

Used to connect to the ESXi instance for vCloud Builder to manage the nodes.

23.48.2.5.57. vcf-builder/vSwitch

Sets the management vSwitch information to use for managing the ESXi instance via vCF Builder bringup.

Defaults to:
vSwitch0

23.48.2.5.58. vmware/esxi-version-vendor-map

This Param is used by setting the control Param vmware/esxi-version to select-vendor. The template vmware-esxi-selector.tmpl will then use this map to determine the best Vendor specific BootEnv/ISO to install on the system.

The operator can also choose to override this map Param with a set of values specific to use requirements. However, the structure must remain the same, and vendor Manufacturer information must be supported in the vmware-esxi-selector.tmpl template.

To create a unique Param mapping to override these values, set this Param on a Machine object (either via profile or directly), using the following examples:

{
  "generic": {
    "bootenv": "esxi_670u2-13006603_vmware",
    "mfg": "generic"
  },
  "cisco": {
    "bootenv": "esxi_670u1-10302608_cisco",
    "mfg": "cisco"
  }
}

The equivalent YAML format would look like:

generic:
  bootenv: esxi_670u2-13006603_vmware
  mfg: generic
cisco:
  bootenv: esxi_670u1-10302608_cisco
  mfg: cisco

An example of applying this map to a specific Machine as a Param, would be:

# assumes target machine is named just "esxi"
# assumes your map data is in the file named "map.yaml"
drpcli machines set Name:esxi param vmware/esxi-version-vendor-map to map.yaml

23.48.2.5.59. esxi/insecure-password-override

This overrides the ‘esxi/insecure-password’ in all cases and forces it to this value.

If specified, defines a HIGHLY INSECURE cleartext password to be converted to a SHA512 hash for the ‘root’ account on an ESXi instance.

23.48.2.5.60. esxi/network-kickstart-ipaddr

Use this param with esxi/network-kickstart-type set to manual to specify the ESXi nodes network configuration post-kickstart. NOTE, you must verify that the IP addressing and Layer 2 characteristics are correct for proper network connectivity post-reboot.

23.48.2.5.61. esxi/patch-index

This string variable is used to track the index of the patch to apply. This allows machine to track position across reboots.

The parameter is a string because we don’t have great tools for the esxi environment yet and should be cast to an integer when being used.

The default value is -1 to indicate uninitialized.

23.48.2.5.62. esxi/skip-tools

If set to True, the tools.t00 module will be removed from the modules list at install time of the ESXi node. Since this module is over 155 MB in size, this increases the speed of the install and reduces the bandwidth needed to for pulling down the modules.

This is typically used in a dev/test environment where rapid (re)build of ESXi hypervisors is occuring, or in environments where the Guest tools are staged in an alternate location, or injected in to prebuilt images.

23.48.2.5.63. esxi/bundles-7

Defines the 7.X ESXi Bundles list.

This can be relative to the files directory on DRP or a URL.

23.48.2.5.64. esxi/network-kickstart-netmask

Use this param with esxi/network-kickstart-type set to manual to specify the ESXi nodes network configuration post-kickstart. NOTE, you must verify that the IP addressing and Layer 2 characteristics are correct for proper network connectivity post-reboot.

23.48.2.5.65. esxi/skip-reboot

This Param lets the operator skip the reboot in to the installed ESXi node. Typically used for debugging purposes to examine the installed node, prior to it rebooting.

23.48.2.5.66. esxi/set-network-protocol-skip-reboot

Setting this Param value to true will force the Task esxi-set-network-protocol to NOT reboot as required to implement the change. Presumably the operator intends to reboot the ESXi node at a later date/time.

Warning

IP protocol suite changes require a system reboot to implement; the services.sh or down/up of interfaces does NOT implement the IP protocol suite changes.

Skipping the reboot (value set to true) will not implement the protocol state change until the system is rebooted by some OTHER task or method.

23.48.2.5.67. esxi/dcui-message

If set to false, disable the installed ESXi instance DCUI vendor message.

By default the message will be displayed.

23.48.2.5.68. esxi/ks-custom-sections

This Param allows an operator to create a list of additional Templates to include during the ESXi kickstart installation phase. Kicstarts support three additional installation phases supported by this Param:

  • %pre
  • %post
  • %firstboot

Each phase can use busybox (shell) or python interpreter to implement customizations. This results in the “phase” types that you can set as follows:

  • pre-busybox
  • pre-python
  • post-busybox
  • post-python
  • fistboot-busybox
  • fistboot-python

To inject custom kickstart directives, see the esxi/ks-custom-kickstart param.

Each “phase” has a an array of various templates that can be injected in that given phase to build up the Kickstart file. Below is an example:

# YAML example
esxi/ks-custom-sections:
  pre-busybox:
    - "my-pre-busybox-chunk1.ks.tmpl"
    - "my-pre-busybox-chunk2.ks.tmpl"
  post-python:
    - "my-post-python3-chunk2.ks.tmpl"
  firstboot-busybox:
    - "my-fistboot-busybox-chunk1.ks.tmpl"

# JSON example
{
  "firstboot-busybox": [
    "my-fistboot-busybox-chunk1.ks.tmpl"
  ],
  "post-python": [
    "my-post-python3-chunk2.ks.tmpl"
  ],
  "pre-busybox": [
    "my-pre-busybox-chunk1.ks.tmpl",
    "my-pre-busybox-chunk2.ks.tmpl"
  ]
}

23.48.2.5.69. esxi/patch-map

This Param allows an operator to create a list of VMware ESXi patches by Build Number mapped to the locations of the patch. An operator specifies which patch to apply to a system with the esxi/patches-to-apply Param which is a Build Number reference in to this data structure.

NOTES:

  • “build-number” - referes to the VMware build number assigned to the patch release
  • “filename” - used if the “location” is not set, then esxi/patch-mirror plus this value is used
  • “reboot-required” - specify if this patch requires a reboot of the system
  • “checksum” - specify the checksump type (md5, sha1, or sha254), and value of the checksum type
  • “location” - if this patch not located at esxi/patch-mirror location, specify alternate location (filename will be appended)
  • “reference-url” - reference documentation and/or download url to get more inforamtion about the patch
The VMware website to search for patches is located at:

Most patches download URLs will be found via the Patch Search link above. Do to how VMware stages patch updates for download on their website, it is not possible to provide a direct download reference link.

23.48.2.5.70. esxi/rackn-bundles-6

Defines the 6.X RackN Bundles list.

This can be relative to the files directory on DRP or a URL.

23.48.2.5.71. esxi/selected-vendor

This param should not be manipulated directly the Vendor Map system uses it to set the selected vendor for the ESXi bootenv. This is subsequently used by the Patch system - if patches need to be applied - to insure the correct patch set is referenced in the vmware/esxi-version-vendor-map

23.48.2.5.72. esxi/shell-local

If set to True, enable the local ESXi shell during the installation of the VMware vSphere ESXi host.

By default, the shell will not be enabled.

23.48.2.5.73. esxi/ssl-certificate

A SSL Certificate to put in place for the SSL services.

23.48.2.5.74. passgen-settings

This string sets values that are used to control the format random generated strings by the passgen.py.tmpl template. This is usually used to generate a random password string with a given set of rules.

Some notes about the rules:

  • chars can not be less than the sum of upper + lower + special_chars + req_nums)
  • The padding value type will “fill out” (i.e. pad) the password with characters of the specified type, if not enough chars are generated to fill the full length
  • Allowed values for padding are: + lowers + uppers + nums
  • Default set of special characters is set to VMware “safe” values of: + [!%@$^]
  • You can override the special_char_list - however, you must be aware of the processing pipeline, as some special characters will cause Workflow errors when trying to marshal from JSON to YAML, etc.
  • You only need to override a given value to make a change to it, all remaning values not specified will use the below defaults

The default settings are as follows:

length=10, chars=7, req_nums=2, special_chars=1,
special_char_list=None, upper=2, lower=5, padding=None

It is necessary that the leading and trailing character is a lowercase letter, due to internal processing. By default the passgen-settings processing will select a random character as leading and a random trailing value. You can alter this behavior and specify the exact leading and/or trailing character by setting:

  • leading_char="z"
  • trailing_char="a"

Note that the double quotes are required.

EXAMPLES:

To set custom values for passgen.py.tmpl`; create a Param named "passgen-settings", add it to a Machine Object (via ``global profile, a custom profile applied to the given Machine, or a Param directly applied to the Machine), with the values set as below.

If a value is not specified, then the listed default (above) will be used.

Setting the length to 14 chars, all other values to default:

length=14

Set length to 12, and the list of special characters that can be used:

length=12, special_char_list='!%@$^;,_'

To change the special characters to always generate 3 special characters, instead of the default of only 1, do:

special_chars=2

..note :: You must put commas between multiple settings values.

23.48.2.5.75. esxi/drpy-agent-enable

If set to true, enable the DRPY Agent on startup of ESXi.

By default, DRPY Agent will start up if installed.

23.48.2.5.76. esxi/network-firstboot-gateway

Use this param with esxi/network-firstboot-type set to manual to specify the ESXi nodes network configuration post-kickstart. NOTE, you must verify that the IP addressing and Layer 2 characteristics are correct for proper network connectivity post-reboot.

23.48.2.5.77. esxi/network-firstboot-netmask

Use this param with esxi/network-firstboot-type set to manual to specify the ESXi nodes network configuration post-kickstart. NOTE, you must verify that the IP addressing and Layer 2 characteristics are correct for proper network connectivity post-reboot.

23.48.2.5.78. esxi/network-kickstart-gateway

Use this param with esxi/network-kickstart-type set to manual to specify the ESXi nodes network configuration post-kickstart. NOTE, you must verify that the IP addressing and Layer 2 characteristics are correct for proper network connectivity post-reboot.

23.48.2.5.79. esxi/skip-render-network-data

This Param lets the operator skip the use of the network-data structure from being converted in to the esxi/network-firstboot-* values. If this value is set to true, then the appropriate network configuration values must be set via another mechanism.

If this value is false (the default), then any existing “bare Params” on the Machine object will be overwritten with the values found in the network-data structure.

23.48.2.5.80. esxi/vib-drpy-agent

The ESXi RackN Agent (runner) is “DRPY” is a VIB file. This Param defines where this VIB will be written to on the local system.

Setting this value will completely override the default location which is:

  • Determined during install time by locating the VMFS or VFFS and using /vmfs/volumes/UUID/rackn/drpy.vib

This is not defined with a default value and should normally not be used.

23.48.2.5.81. esxi/disk-install-override-custom

Use this Param to specify additional custom templates to include in to the esxi-disk-install-override.tmpl tool for setting custom strategies for the ESXi disk selection for install location.

This is intended to inject ESXi BASH “name() { … }” function stanzas in the existing ‘esxi-disk-install-override.tmpl’ template to extend the functionality to include on-the-fly strategy types discovered in the field.

# YAML example
- "my-esxi-disk-override-1.tmpl"
- "my-esxi-disk-override-2.tmpl"

# JSON example
[
  "my-esxi-disk-override-1.tmpl",
  "my-esxi-disk-override-2.tmpl"
]
WARNING - The executing environment is ESXi kickstart installer (Weasel). You
must ensure that the Function you inject operates correctly in this environment. For reference, see the Functions in the existing Template “esxi-disk-install-override.tmpl”.

Any functions MUST set the shell global variable named ‘SET_DISK’ to a correct value for defining which disk to install to. The values are documented in the ESXi documentation, for example:

Valid examples include:

  • –firstboot
  • –disk=mpx.vmhba1:C0:T0:L0

23.48.2.5.82. esxi/install-datastore

This location defines the ESXi datastore that will be used for storing install logs, RackN related status files and information, and the scratch partition that will be used.

By default that location will be on the first found (install) disk and default to:

  • /vmfs/volumes/SOME_UUID

It’s important to note that this location will contain all copies of the Weasel kickstart install logs, artifacts that RackN needs for installation/reference, and the scratch partition.

This param is no longer used and only left in place for compatibility purposes with legacy profiles, and will be removed in a future release.

23.48.2.5.83. esxi/network-firstboot-mtu

Sets the MTU frame size (“jumbo” frames) for the installed ESXi instance on first boot for the Management Network vSwitch (typically vSwitch0).

Valid values as defined by VMware for this field are from 1000 to 9999.

Typically the system default is 1500 bytes. This value may be set larger in environments using large frames (aka “jumbo”), which typically are a value close to 9000 bytes. In some virtualized environments where additional layers of overhead for encapsulation are needed, the packet may be larger than 9000 bytes.

23.48.2.5.84. esxi/patch-mirror

The HTTP mirror location to find the ESXi patches at. Note that the Param esxi/patch-map can override this value on an indivual patch basis.

The default value is to find patches on the Provisioner URL files/patches/esxi location. (eg http://127.0.0.1:8091/files/patches/esxi )

The special syntax of {{.ProvisionerURL}}/some/path can be used to reference the local server’s files.

This parameter should use the .ParamExpand function.

23.48.2.5.85. esxi/network-firstboot-vmk

Use this param to specify the device to plumb the network configuration up with post install. By default we assume “vmk0”, however, this may not be correct. This param allows the operator to override the Management NIC for the installed OS.

23.48.2.5.86. esxi/serial-console

Sets the serial console for the ESXi host. By default this is not enabled.

For Packet environment, ensure to set com port to com2 like:

gdbPort=none logPort=none tty2Port=com2

23.48.2.5.87. esxi/skip-remove-bootorder

This Param lets the operator skip the removal of VMWare ESXi from the machine’s boot order.

23.48.2.6. profiles

The content package provides the following profiles.

23.48.2.6.1. esxi-profile

Sets some basic Param values that are useful for dev/test deployments of VMware vSphere ESXi hypervisors. Generally speaking these aren’t good to set for production systems.

This profile is intended to be cloned and applied to a Machine(s) for subsequent use. You can then remove/modify the values appropriate to your use case, after you nave cloned it.

23.48.2.6.2. esxi-vcf38-example

Currently patches system only supports a single patch, but going forward, they may support an array of pathces.

The patches value is a VMware Build Number index for the release of the patch. This is used as an index in to the esxi/patch-map structure to find all of the necessary data for the patch.

23.48.2.6.3. vcf-builder-cluster-profile-example

Sets some basic Param values that are used for building the vCloud Foundating Builder bringup JSON.

param notes
vcf-builder/cluster-profile defines name of Profile to use
vcf-builder/association sets the cluster resources association
vcf-builder/esxiCredentials-username username for ESXi machines in cluster
vcf-builder/esxiCredentials-password password for ESXi machines in cluster
vcf-builder/vSwitch the vSwitch for the cluster members

This profile is intended to be cloned and applied to a Machine(s) for subsequent use. You can then remove/modify the values appropriate to your use case.

If you clone this to vcf-builder-cluster-profile the default values may work fine for testing purposes.

23.48.2.6.4. vmware-devtest

Typically clone this profile and remove/modify the Params according to your DevTest needs. This is intended as a helper profile for use when doing development testing of the various bits of the VMware content bundle.

23.48.2.6.5. vmware-iso-builder

Profile to use with image-builder to build a vm to build isos.

This assumes that you have a windows image.