vcenter

VMware vCenter puppet module

Project URL RSS Feed Report issues

Module Stats

14,984 downloads

7,937 latest version

2.0 quality score

Version information

released Sep 15th 2016

This module has been deprecated by its author since Apr 1st 2023.

Start using this module

Installation method

Add this module to your Puppetfile:

mod 'vmware-vcenter', '0.10.0'

Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add vmware-vcenter

Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install vmware-vcenter --version 0.10.0

Tags: vmware, vcenter

Documentation

vmware/vcenter — version 0.10.0 Sep 15th 2016

VMware vCenter module

This module manages resources in VMware vCenter such as folders, datacenter, ESX host and clusters.

Description

VMware vCenter can be deployed either via an virtual appliance (vmware-vcsa module) or installed on a windows server. This module manages vCenter 5.1 resources via the vSphere API using rbvmomi gem:

+------------+         +---------+         +-----+
|            | vsphere | vCSA    |         | ESX |
|   Puppet   | +-----> +---------+ +-----> +-----+
| Management |   |                   |
|    Host    |   |     +---------+   |     +-----+
|            |    ---> | vCenter |    ---> | ESX |
+------------+         +---------+         +-----+

vCenter resources in this module are NOT compatible with PuppetLabs-vCenter module.
ESX resources operate on hosts once they are attached to vCenter.

Installation

$ puppet module install vmware/vcenter

Usage

Puppet management host (see diagram above) should install type/provider gem dependencies:

include vcenter::package

Warning: nokogiri gem is an implicit requirement:

Nokogiri package is shipped with Puppet Enterprise, but typically not installed by default on the agent. The platform appropriate PE nokogiri gem should be installed on the management host (rather than building the gem).
Open source puppet will automatically attempt to build nokogiri gem, but additional packages may be required for successful compilation (see tests/package.pp example and nokogiri installation documentation).
This module ships with a custom version of rbvmomi gem for Ruby 1.8.7 compatibility.

Transport resource specifies rbvmomi connectivity info (see VIM.connect method for additional options):

# The name of the transport is referenced by other resource:
transport { 'lab':
  username => 'root',
  password => 'vmware',
  server   => 'vcsa.lab',
  options  => { 'insecure' => true },
}

All vCenter resources use the transport metaparameter to specify the connectivity used to manage the resource:

vc_datacenter { 'dc1':
  path      => '/dc1',
  ensure    => present,
  transport => Transport['lab'],
}

vc_folder { '/dc1/folder1':
  ensure    => absent,
  transport => Transport['lab'],
}

An ESX host can be attached and managed indirectly via vSphere API:

vcenter::host { $esx1['hostname']:
  path      => '/dc1',
  username  => 'root',
  password  => 'password',
  dateTimeConfig => {
    'ntpConfig' => {
      'server' => 'us.pool.ntp.org',
    },
    'timeZone' => {
      'key' => 'UTC',
    },
  },
  transport => Transport['lab'],
}

See tests folder for additional examples.

ESXi resource types

esx_advanced_options

Parameters

transport: A resource reference to a transport type declared elsewhere. Eg: Transport['vcenter']
options: A hash containing a list of options:

options => {
"Vpx.Vpxa.config.log.level"  => "verbose",   # ChoiceOption  default "verbose"
"Config.HostAgent.log.level" => "verbose",   # ChoiceOption  default "verbose"
"Annotations.WelcomeMessage" => "",          # StringOption  default ""
"BufferCache.SoftMaxDirty"   => 15,          # LongOption    default 15
"CBRC.Enable"                => false,       # BoolOption    default false
"Config.GlobalSettings.guest.commands.sharedPolicyRefCount" => 0   # IntOption     default 0

esx_debug

Parameters

debug: true, false
transport: A resource reference to a transport type declared elsewhere. Eg: Transport['vcenter']

esx_firewall_ruleset

Parameters

ensure: enabled, disabled
name: Name of the firewall ruleset (namevar)
host: ESX host to configure (namevar)
path: Path to the datacenter where the host resides
allowed_hosts: Accepts a string value of "all" or an array of IP addresses and IP networks with prefixes
transport: A resource reference to a transport type declared elsewhere. Eg: Transport['vcenter']

Title pattern

Both name and host are namevars, by default the title will be used for name, but both may be specified in the title as host:name

esx_dnsconfig

Parameters

address: ['array','of','dns','values']
host_name: Hostname of ESXi server.
domain_name: Domain name of ESXi server.
search_domain: Search domain of ESXi server.
dhcp: true, false
transport: A resource reference to a transport type declared elsewhere. Eg: Transport['vcenter']

Further Documentation

VMware Docs

esx_ntpconfig

Parameters

server: ['array','of','ntp','servers']
transport: A resource reference to a transport type declared elsewhere. Eg: Transport['vcenter']

esx_powerpolicy

Parameters

current_policy: 'static','dynamic','low' static = High performance dynamic = Balanced low = Low Power
transport: A resource reference to a transport type declared elsewhere. Eg: Transport['vcenter']

esx_service

The service name should be in the form of: ESXi_hostname:<service name. Eg esx.example.com:ntpd

Parameters

running: true, false
policy: 'on','off','automatic'
transport: A resource reference to a transport type declared elsewhere. Eg: Transport['vcenter']

esx_syslog

Parameters

default_rotate: The maximum number of log files to keep locally on the ESXi host in the configured logDir. Does not affect remote syslog server retention. Defaults to 8
default_size: The maximum size, in kilobytes, of each local log file before it is rotated. Does not affect remote syslog server retention. Defaults to 1024 KB.
log_dir: A location on a local or remote datastore and path where logs are saved to. Has the format [DatastoreName] DirectoryName/Filename, which maps to /vmfs/volumes/DatastoreName/DirectoryName/Filename. The [DatastoreName] is case sensitive and if the specified DirectoryName does not exist, it will be created. If the datastore path field is blank, the logs are only placed in their default location. If /scratch is defined, the default is []/scratch/log.
log_host:A remote server where logs are sent using the syslog protocol. If the logHost field is blank, no logs are forwarded. Include the protocol and port, similar to tcp://hostname:514
log_dir_unique: A boolean option which controls whether a host-specific directory is created within the configured logDir. The directory name is the hostname of the ESXi host. A unique directory is useful if the same shared directory is used by multiple ESXi hosts. Defaults to false.
transport: A resource reference to a transport type declared elsewhere. Eg: Transport['vcenter']

esx_system_resource

Parameters

This resource allows the configuration of system resources of a host that are viewed und er the 'System Resource Allocation' section of the vSphere client

host:
system_resource:
cpu_limit: Can be set to a numerical value representing MHz, or "unlimited"
cpu_reservation:
cpu_expandable_reservation:
memory_limit: Can be set to a numerical value representing MB, or "unlimited"
memory_reservation:
memory_expandable_reservation:
transport: A resource reference to a transport type declared elsewhere. Eg: Transport['vcenter']

esx_timezone

Parameters

key: 3 letter time zone. Eg: 'GMT'
transport: A resource reference to a transport type declared elsewhere. Eg: Transport['vcenter']

esx_datastore

Manage vCenter esx hosts' datastore. The datastore name should be in the form of: ESXi_hostname:<datastore name>.

Parameters

ensure: present
type: vmfs, cifs, nfs
lun: LUN number of storage volume. Specify only for block storage.
remote_host: IP or DNS name of remote host.
remote_path: Path to directory/folder or remote host.
transport: A resource reference to a transport type declared elsewhere. Eg: Transport['vcenter']

esx_vmknic_type

Manages ESXi vmknic types - management, vmotion, faultToleranceLogging, or vSphereReplication The vmknic type should be in the form of: ESXi_hostname:<name of vmknic>.

Parameters

nic_type: 'faultToleranceLogging', 'management', 'vmotion', 'vSphereReplication'
transport: A resource reference to a transport type declared elsewhere. Eg: Transport['vcenter']

esx_license

Parameters

license_key: Namevar variable for puppet. Adds licenses to Vcenter pool. Does not assign them to managed entities (esxi, vcenter). Use esx_license_assignment to assign licenses to entities.

Usage

esx_license { 'XXXXX-XXXXX-XXXXX-XXXXX-XXXXX'
  ensure    => present,
  transport => Transport['vcenter']
}

esx_license { 'mylicense':
  license_key => 'XXXXX-XXXXX-XXXXX-XXXXX-XXXXX',
  ensure      => present,
  transport   => Transport['vcenter']
}

esx_license_assignment

Manage vsphere license assignment. entity_id should be the name of an esx host or vcenter. Licenses can only be assigned to one entity at a time.

Parameters

entity_id: Name of ESX or Virtual Center node associated with the license key
license_key: vSphere License Key

vCenter resource types

vc_role

Parameters

transport: A resource reference to a transport type declared elsewhere. Eg: Transport['vcenter']
name: The desired name for the role.
privileges: An array of privilege IDs to be assigned to the role. A list of privileges of privileges can be gathered via the Managed Object Browser (MOB). Simply navigate to https:///mob/?moid=AuthorizationManager&doPath=privilegeList. Use the privId value to add the privilege to the role.
force_delete: By default, a role will not be deleted if user or group permissions are associated with it. If force_delete is set to true, then the role will be deleted even if there are associated permissions

vc_role { 'Role Admin':
  ensure     => present,
  privileges => [ 'Authorization.ModifyRoles', 'Authorization.ReassignRolePermissions', 'Authorization.ModifyPermissions' ],
  transport  => Transport['vcenter']
}

vc_role { 'Role Admin':
  ensure       => absent,
  force_delete => true,
  transport    => Transport['vcenter']
}

Types in this module release

vm_tools_config

Parameters
datacenter	Set by namevar. Format datacenter:vmname
name	The datacenter and vm name split by a colon (:). Format dc1:vm1
provider
vm_name	Set by namevar. Format datacenter:vmname

Properties
after_power_on	Flag to specify whether or not scripts should run after the virtual machine powers on.
after_resume	Flag to specify whether or not scripts should run after the virtual machine resumes.
before_guest_reboot	Flag to specify whether or not scripts should run before the virtual machine reboots.
before_guest_shutdown	Flag to specify whether or not scripts should run before the virtual machine powers off.
before_guest_standby	Flag to specify whether or not scripts should run before the virtual machine suspends.
sync_time_with_host	Indicates whether or not the tools program will sync time with the host time.
tools_upgrade_policy	Tools upgrade policy setting for the virtual machine.

Providers
vm_tools_config

esx_syslog

Manage vCenter esx hosts syslog config.

Parameters
host	ESX hostname or ip address.
provider

Properties
default_rotate	The maximum number of log files to keep locally on the ESXi host in the configured logDir. Does not affect remote syslog server retention. Defaults to 8.
default_size	The maximum size, in kilobytes, of each local log file before it is rotated. Does not affect remote syslog server retention. Defaults to 1024 KB.
log_dir	A location on a local or remote datastore and path where logs are saved to. Has the format [DatastoreName] DirectoryName/Filename, which maps to /vmfs/volumes/DatastoreName/DirectoryName/Filename. The [DatastoreName] is case sensitive and if the specified DirectoryName does not exist, it will be created. If the datastore path field is blank, the logs are only placed in their default location. If /scratch is defined, the default is []/scratch/log.
log_dir_unique	A boolean option which controls whether a host-specific directory is created within the configured logDir. The directory name is the hostname of the ESXi host. A unique directory is useful if the same shared directory is used by multiple ESXi hosts. Defaults to false.
log_host	A remote server where logs are sent using the syslog protocol. If the logHost field is blank, no logs are forwarded. Include the protocol and port, similar to tcp://hostname:514

Providers
esx_syslog

vc_dvswitch_pool

Manages vCenter Distributed Virtual Switch Network Resource Pool Management

Parameters
dvswitch_name
dvswitch_path	The path to the dvportgroup.
ensure
key	pool identifier
name	{path to dvswitch}:{network resource pool key}
provider

Properties
description	A string describing the network resource pool
level	Share level ('custom', 'high', 'low', 'normal')
limit	Maximum allowed usage for network clients belonging to this resource pool per host. To set to Unlimited set this to -1
priority_tag	QOS priority tag
shares	network shares

Providers
vc_dvswitch_pool

vc_cluster_drs

Manages vCenter cluster's settings for DRS (Distributed Resource Scheduler).

Parameters
path	The path to the cluster.
provider

Properties
default_vm_behavior	Cluster-wide default for DRS management of VMs: fullyAutomated, partiallyAutomated, or manual
enable_vm_behavior_overrides	Is VM-specific override of cluster-wide DRS behavior enabled? true or false
enabled	Is DRS enabled? true or false
vmotion_rate	Aggressiveness of DRS actions or recommendations for vMotion: 1 (aggressive) through 5 (conservative)

Providers
vc_cluster_drs

esx_advanced_options

Properties
options	a hash with options and values

Providers
esx_advanced_options

esx_firewall_ruleset

This type manages ESX firewall rulesets on a host. This title has two namevars host and name, the name may be specified in the title, or both the name and the host delimited with a comma, eg;

esx_firewall_ruleset { 'ntp rule': ensure => enabled, name => 'ntpClient', host => 'esxi1.localdomain', transport => Transport['vcenter'], }

esx_firewall_ruleset { 'ntpClient': ensure => enabled, host => 'esxi1.localdomain', transport => Transport['vcenter'], }

esx_firewall_ruleset { 'esxi1.localdomain:ntpClient': ensure => enabled, transport => Transport['vcenter'], }

Parameters
ensure	Valid ensure values are "enabled" and "disabled" (present and absent will also map to their respective values)
host	ESX host to configure
name	The name of the firewall rulset, eg: ntpClient
path	Datacenter path where host resides
provider

Properties

Properties
allowed_hosts	A list of allowed IP ranges `This attribute can take a single string value of "all" indicating that all IP addresses are allowed for this ruleset, alternatively an array of IP addresses, or IP address ranges with prefixes may be given. Allow all hosts allowed_hosts => 'all' Allow multiple hosts allowed_hosts => [ '192.168.10.2', '192.168.200.0/24', '10.72.99.0/24' ]`

allowed_hosts

A list of allowed IP ranges

  This attribute can take a single string value of "all" indicating that
  all IP addresses are allowed for this ruleset, alternatively an array
  of IP addresses, or IP address ranges with prefixes may be given.

  Allow all hosts
  allowed_hosts => 'all'

  Allow multiple hosts
  allowed_hosts => [
    '192.168.10.2',
    '192.168.200.0/24',
    '10.72.99.0/24'
  ]

Providers
default

esx_license

Adds licenses to Vcenter pool. Does not assign them to managed entities (esxi, vcenter). Use esx_license_assignment to assign licenses to entities.

Parameters
ensure
license_key	License key
provider

Providers
esx_license

esx_datastore

Manage vCenter esx hosts' datastore.

Parameters
access_mode	Enum - HostMountMode: Defines the access mode of the datastore.
datastore	The name of the datastore.
ensure
host	The ESX host the datastore is attached to.
local_path
lun	LUN number of storage volume. Specify only for block storage.
name	ESX host:datastore name.
password
provider
uid
user_name

Properties
remote_host	Name or IP of remote storage host. Specify only for file based storage.
remote_path	Path to volume on remote storage host. Specify only for file based storage.
type	The datastore type.

Providers
esx_datastore

vc_extension

Providers
vc_extension

vc_datacenter

Providers
vc_datacenter

vc_cluster_ha

Providers
vc_cluster_ha

esx_service

Parameters
host
name	ESX host:service name.
provider
service

Properties
policy
running

Providers
esx_service

esx_license_assignment

Manage vsphere license assignment. entity_id should be the name of an esx host or vcenter. Licenses can only be assigned to one entity at a time.

Parameters
entity_id	Name of ESX or Virtual Center node associated with the license key
provider

Properties
license_key	vSphere License Key

Providers
esx_license_assignment

vc_dvswitch_migrate

Manages Distributed Virtual Switch migration on an ESXi hostby moving vmknics and vmnics from standard to distributed switch

Parameters
dvswitch	Path of the destination distributed virtual switch
host	Name of ESXi host, as known to vCenter
name	{name of host}:{path of dvswitch}[:{optional tag}
provider

Properties
vmk0	For kernel port vmk0, name of the destination dvportgroup
vmk1	For kernel port vmk1, name of the destination dvportgroup
vmk2	For kernel port vmk2, name of the destination dvportgroup
vmk3	For kernel port vmk3, name of the destination dvportgroup
vmnic0	For uplink port vmnic0, name of the destination dvportgroup
vmnic1	For uplink port vmnic1, name of the destination dvportgroup
vmnic2	For uplink port vmnic2, name of the destination dvportgroup
vmnic3	For uplink port vmnic3, name of the destination dvportgroup

Providers
vc_dvswitch_migrate

vc_ip_pool

Manage vCenter IpPools. http://pubs.vmware.com/vsphere-55/index.jsp#com.vmware.wssdk.apiref.doc/vim.vApp.IpPool.html

Parameters
datacenter	The datacenter target for the IpPool
ensure
force_destroy	If true, the pool will be destroyed even if it is in use
label	Pool name. The pool name must be unique within the datacenter.
provider

Providers
vc_ip_pool

esx_shells

Manage vCenter esx hosts config for shells (ESXi Shell and SSH)

Parameters
host	ESX hostname or ip address.
provider

Properties
esxi_shell_interactive_time_out
esxi_shell_time_out
suppress_shell_warning

Providers
esx_shells

esx_vmknic_type

Manages Virtual Adapters

Parameters
esxi_host	Name of the ESXi host containing the vmknic.
name	{ESX Host}:{name of vmknic}
nicname	Name of the vmknic on the ESXi host.
provider

Properties
nic_type	List (array) of names of types for nic: zero or more of vmotion, faultToleranceLogging, management, or vSphereReplication

Providers
esx_vmknic_type

esx_system_resource

This resource allows the configuration of system resources of a host that are viewed und er the 'System Resource Allocation' section of the vSphere client

Parameters
host	ESX hostname or ip address.
name	A unique name that will allow for setting the same resource on multiple hosts or multiple resources on the same host through multiple resource calls within your puppet manifest.
provider
system_resource	The system resource to be managed

Properties
cpu_expandable_reservation	Enable expandable reservation
cpu_limit	Sets the CPU limit. Acceptable values are a numeric value (in Mhz) or the string "unlimited"
cpu_reservation	System resource CPU reservation in MHz
memory_expandable_reservation	Enable expandable reservation
memory_limit	Sets the memory limit. Acceptable values are a numeric value (in MB) or the string "unlimited"
memory_reservation	System resource memory reservation in MB

Providers
esx_system_resource

vc_cluster

vc_folder

esx_iscsi

vm_hardware

Manage a vCenter VM's virtual hardware settings. See http://pubs.vmware.com/vsphere-55/index.jsp#com.vmware.wssdk.apiref.doc/vim.vm.VirtualHardware.html for class details

Parameters
datacenter	The name of the datacenter hosting the target VM
provider
vm_name	The name of the target VM

Providers
vm_hardware

vc_host

Manage vCenter hosts.

Parameters
ensure
name	ESX hostname or ip address.
password	ESX password.
provider
secure	Add host require sslthumprint verification.
sslthumbprint	ESX host ssl thumbprint.
username	ESX username.

Properties
path	The path to the host.

Providers
vc_host

esx_iscsi_targets

esx_dnsconfig

This resource allows disabling dhcp for DNS, and setting DNS client parameters

Parameters
host	ESX hostname or ip address.
provider

Properties
address	dns server address
dhcp	boolean for dns config from dhcp
domain_name	dns suffix
host_name	server hostname
search_domain	dns search domain

Providers
esx_dnsconfig

vc_affinity

Manage vCenter Cluster affinity rules.

Parameters
ensure
name	Name of the cluster rule
path	The path to the Cluster.
provider
rule_type	Type of rule: affinity or anti_affinity
vm	Array of virtual machines

Providers
vc_affinity

vc_dvswitch_nioc

Manages vCenter Distributed Virtual Switch Network Resource Management (NIOC)

Parameters
name	{path to dvswitch}{:optional tag to make resource name unique}
path	The path to the dvswitch.
provider

Properties
network_resource_management_enabled	Enable or disable NIOC (network resource management); true/false

Providers
vc_dvswitch_nioc

vc_vpxsettings

Manage vCenter vpxsettings ( event.maxAge, mail.smtp.server, etc )

Parameters
name	The vm name
provider

Properties

vpx_settings

hash of vpxsetting for a given vcenter, this must match the api parameters exactly ( including case ) inside of setting[], that is shown from the below:

       1. browse to https://<vcenter>/mob/?moid=ServiceInstance&method=retrieveContent
       2. click on Invoke Method,
       3. select VpxSettings

      example: setting['event.maxAge'] and setting['event.maxAgeEnabled'] would be

             vpx_settings => { 'event.maxAge' => 14, 'event.maxAgeEnabled' => true, }

Providers
vc_vpxsettings

vc_dvswitch

vc_vm

Manage vCenter VMs. Warning, this type / provider is currently experimental

Parameters
cpucount
datacenter_name
datastore
ensure
graceful_shutdown	Perform a graceful shutdown if possible. This parameter has no effect unless :power_state is set to :poweredOff
guestid
memory
name	The vm name
provider

Properties
power_state	set the powerstate for the vm to either poweredOn/poweredOff, for poweredOff, if tools is running a shutdownGuest will be issued, otherwise powerOffVM_TASK

Providers
vc_vm

Copyright (C) 2013 VMware, Inc.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

Parameters
ensure
esx_host	Name of ESXi host
iscsi_hba_device	HBA on host system
name	ESX host:target address
provider
type	The iSCSI target type.

Modules

Discover

Contribute

Puppet

Premium features

Downloads

Resources

About Forge

Getting Started

vcenter

Version information

This module has been deprecated by its author since Apr 1st 2023.

Start using this module

Documentation

VMware vCenter module

Description

Installation

Usage

ESXi resource types

esx_advanced_options

Parameters

esx_debug

Parameters

esx_firewall_ruleset

Parameters

Title pattern

esx_dnsconfig

Parameters

Further Documentation

esx_ntpconfig

Parameters

esx_powerpolicy

Parameters

esx_service

Parameters

esx_syslog

Parameters

esx_system_resource

Parameters

esx_timezone

Parameters

esx_datastore

Parameters

esx_vmknic_type

Parameters

esx_license

Parameters

Usage

esx_license_assignment

Parameters

vCenter resource types

vc_role

Parameters

Types in this module release

vm_tools_config

esx_syslog

vc_dvswitch_pool

vc_cluster_drs

esx_advanced_options

esx_firewall_ruleset

esx_license

esx_datastore

vc_extension

vc_datacenter

vc_cluster_ha

esx_service

esx_license_assignment

vc_dvswitch_migrate

vc_ip_pool

esx_shells

esx_vmknic_type

esx_system_resource

vc_cluster

vc_folder

esx_iscsi

vm_hardware

vc_host

esx_iscsi_targets

esx_dnsconfig

vc_affinity