VMware vSphere

Sections

To discover host instances running on your VMware vSphere account, including host attributes, add your VMware vSphere source. In addition to this, add your host credentials and Puppet Discovery discovers each host instance's attributes, the system services, the users and groups belonging to each instance, along with packages, tags, and containers.

What resources can I discover?

Depending on the level of credentials you enter, this table lists the depth of resources that you can discover.

CredentialsDiscovered resources
  • VMware vSphere source.

  • Hosts, including host attributes.

  • VMware vSphere source.

  • SSH or WinRM host credentials.

  • Hosts, including host attributes.

  • Services

  • Users

  • Groups

  • Tags

  • Packages, including package attributes.

  • Container images, including container attributes.

This table lists the pages where you can view the discovered resources.

UI pageDescription
VMware host pageDisplays summary information about host instances running in your VMware vSphere account.
Host details pageLists the host instance's attributes, the system services, the users and groups belonging to each instance, along with packages, tags, and containers.
Packages summary page.Accessed by selecting the packages dashboard card, view a list of packages in use across your infrastructure.
Package details page.Lists various types of information about a package instance; its attributes, along with a list of hosts and containers it's installed on.
Containers summary page.Accessed by selecting the containers dashboard card, view a list of container instances running on your infrastructure.
Container details page.Lists various types of information about a container image; it's attributes, packages in use, and it's label information.

Hosts

Puppet Discovery considers each host as a network accessible resource, whether it's physical or virtual, and discovers attributes that define the host's state and properties.

Important: To discover resources running on an Unknown host, you must enter the host credentials.

Attributes

Puppet Discovery groups attributes into a number of different facets to give you even more insights into each host. A facet represents a set of related attributes, each one independently maintained, that describe a certain aspect of a discovered resource.

Note: Listed below are the fields that you can show or hide on the VMware hosts summary page. Additional attributes are also displayed on the Host details page.
FieldFacet::attributeDescription
Annotation vmware_computeInstance::Config_Annotation Description for the virtual machine.
Disk vmware_computeInstance::Disk Guest information about disks; used space and total space available.
Fault tolerance state vmware_computeInstance::Runtime_FaultToleranceState Defines a set of states for a fault tolerant virtual machine:
  • disabled

  • enabled

  • needSecondary

  • notConfigured

  • running

  • starting

Guest full name vmware_computeInstance::GuestFullName The full name of the guest operating system for the virtual machine.
Guest hostname vmware_computeInstance::HostName The FDQN of the guest host.
Guest heartbeat status vmware_computeInstance::QuickStats The current status of the guest operating system:
  • gray - VMware tools not installed or running.

  • red - No heartbeat.

  • yellow - Intermittent heartbeat.

  • green - Guest operating system responding normally.

Guest state vmware_computeInstance::GuestState Operation mode of the guest operating system:
  • running

  • shuttingdown

  • resetting

  • standby

  • notrunning

  • unknown

ID vmware_computeInstance::ID The guest operating system identifier.
IP address host::privateIPv4 The private IP version 4 address.
IP stack vmware_computeInstance::IpStack Guest information about the IP networking stack:
  • DomainName

  • IpAddress

Last scanThe last scan of the host represented by the data platform timestamp in UTC.
Max memory usage (MB) vmware_computeInstance::Runtime_MaxMemoryUsage The maximum memory usage based on the memory configuration of the virtual machine, as well as limits configured on the virtual machine, or any parent resource pool.
Memory size (MB) vmware_computeInstance::Config_MemorySizeMB The memory size of the virtual machine, in megabytes.
Name host::name The name of the host.
Net vmware_computeInstance::Net Guest information about network adapters:
  • Network

  • MacAddress

  • IpAddress

Number of CPU's vmware_computeInstance::Config_NumCpu The number of processors in the virtual machine.
Number of virtual disks vmware_computeInstance::Config _NumVirtualDisks The number of virtual disks attached to the virtual machine.
Operating system computeHost::os The operating system running on the host.
OS version computeHost::osVersion The version of the operating system running on the host.
Overall status vmware_computeInstance::OverallStatus The overall alarm status on this host.
Power state vmware_computeInstance::Runtime_PowerState Defines a set of states for a virtual machine:
  • poweredOff

  • poweredOn

  • suspended

Tools running status vmware_computeInstance::ToolsRunningStatus The current running status of VMware tools in the guest operating system.
Tools version vmware_computeInstance::ToolsVersion The VMware tools version.
Uptime computeHost::uptime The uptime for the instance, in seconds.

Services

Discover services on the host, and their state:
  • Service - the name of the service, derived from the name attribute.

  • State - the current state of the service derived from the state attribute: running, stopped, or failed.

Important: To stop or start a system service, run the manage services task on your Linux or Windows hosts. For more information, see running tasks on target hosts.

To find a specific service, filter the list by the service name.

Users

Discover users associated with the host, and their home directory:
  • User - the name of the user, derived from the name attribute.

  • Home - the home directory of the user, derived from the home attribute.

To find a specific user, filter the list by the user name.

Groups

Discover user groups associated with the host. The Group name is derived from the name attribute.

To find a specific group, filter the list by the group name.

Tags

Discover tags relating to the host:
  • Name - the tag name, derived from the name attribute.

  • Value - the tag value, derived from the value attribute.

To find a specific tag, filter the list by the tag name.

Packages

Discover various types of information about a package instance, its attributes, along with a list of hosts and containers it's installed on.

Attributes

Discover attributes that describe the characteristics of the package. The UI queries the data platform to discover the name, version, and packageManager attributes.

AttributeDescription
name The package name.
version The package version.
packageManager The name of the package manager:
  • apk

  • Chocolatey

  • dpkg

  • rpm

  • msi

Important: To manage packages, run the manage package task on your Linux or Windows hosts. For more information, see running tasks on target hosts.

Container images

Discover various types of information about a container image; it's attributes, packages in use, and it's label information.

Attributes

Discover attributes that describe the characteristics of the container. The UI queries the data platform for the discovered container facet.

AttributeDescription
name The container name for processes running inside the container.
dockerAPIVersion The version of the Docker Engine API.
dockerMinAPIVersion The minimum version of the Docker Engine API.
dockerVersion The version of Docker.
id The Docker container ID for processes running inside the container.
imageName The Docker image name for processes running inside the container.
Important: To discover containers, your Linux credentials must be for the root account or an account that is a member of the Docker group. For more information, see managing Docker.

Labels

Discover the container label names and values:
  • Label - the label name, derived from the name attribute.

  • Value - the label value, derived from the value attribute.

How helpful was this page?
Puppet sites use proprietary and third-party cookies. By using our sites, you agree to our cookie policy.