MENU
Products
Solutions
Support and Services
Company
How To Buy
Login
myBroadcom Account:
Login
Register
Forgot Username/Password?
Username
Edit My Profile
myBroadcom
Logout
Language
English
日本語
中文
Login
myBroadcom Account:
Login
Register
Forgot Username/Password?
Username
Edit My Profile
myBroadcom
Logout
English
日本語
中文
Home
VMware® Cloud Infrastructure Software
VMware vSphere
VMware vSphere SDKs and Tools 8.0
Getting Started with ESXCLI
Installing ESXCLI
VMware vSphere SDKs and Tools 8.0
Version 8.0
8.0
7.0
6.7
6.5
Open/Close Topics Navigation
Product Menu
Topics
Release Notes
vSphere Management SDK
vSphere Management SDK 8.0 Update 3 Release Notes
vSphere Management SDK 8.0 Update 2 Release Notes
vSphere Management SDK 8.0 Update 1 Release Notes
vSphere Management SDK 8.0 Release Notes
vSphere Solutions Manager, vServices, and ESX Agent Manager 8.0 Update 2 Release Notes
vSphere Solutions Manager, vServices, and ESX Agent Manager 8.0 Update 1 Release Notes
vSphere Solutions Manager, vServices, and ESX Agent Manager 8.0 Release Notes
pyVmomi SDK 8.0 Release Notes
vSphere Client SDK
vSphere Client SDK 8.0 Update 3 Release Notes
vSphere Client SDK 8.0 Update 2 Release Notes
vSphere Client SDK 8.0 Update 1 Release Notes
vSphere Client SDK 8.0 Release Notes
Virtual Disk Development Kit
Virtual Disk Development Kit 8.0 Update 3 Release Notes
Virtual Disk Development Kit 8.0 Update 2 Patch 1 Release Notes
Virtual Disk Development Kit 8.0 Update 2 Release Notes
Virtual Disk Development Kit 8.0 Update 1 Release Notes
Virtual Disk Development Kit 8.0 Release Notes
vSphere Guest SDK
Guest SDK 12.3.0 Release Notes
Guest SDK 12.1.0 Release Notes
VMware HTML Console SDK 2.2.0 Release Notes
ESXCLI 8.0 Release Notes
VMware OVF Tool
VMware OVF Tool 4.6.3 Release Notes
VMware OVF Tool 4.6.2 Release Notes
VMware OVF Tool 4.6.0 Release Notes
VMware OVF Tool 4.5.4 Release Notes
VMware OVF Tool 4.5.0 Release Notes
Using Extended XCOPY with vSphere 8.0 Update 1
An Introduction: Getting Started with vSphere APIs and SDKs
Overview of vSphere APIs and SDKs
Core vSphere APIs
vSphere Automation API
vSphere Web Services (VIM) API
vSphere Functional Extension APIs
VMware vSAN
Virtual Storage Lifecycle Management
Storage Monitoring Service
Storage Policy API
ESX Agent Manager
vCenter Server Management API
vCenter Single Sign-On
Virtual Disk API
vSphere Add-On SDKs
pyVmomi
govmomi
Getting Started with vSphere APIs and SDKs
Preliminary Resources for vSphere Programming
Authentication with vSphere APIs
Unified Management and Automation Session
Python Access to vSphere APIs
Java Access to vSphere APIs
Golang Access to vSphere APIs
REST Access to vSphere APIs
PowerCLI Access to vSphere APIs
Use Cases for vSphere APIs
Virtual Disk Development Kit
vSphere Web Services SDK Developer’s Setup Guide
What is the vSphere Web Services SDK
What you need to know for the vSphere Web Services SDK
Programming Language Support in the vSphere Web Services SDK
Types of Applications That You Can Build Using This SDK
How You Can Download the vSphere Web Services SDK
Sample Authentication with Single Sign-On Configurations
What files are in the vSphere Web Services SDK package
SDK Version Support and Limitations of the ESXi API
Set Up to Develop in Java with the vSphere Web Services SDK
Java Development Requirements for the Web Services SDK
Set Up for Java Development for the Web Services SDK
Software Downloads for the Web Services SDK
Set Up for Development Using JAX-WS with the Web Services SDK
Batch Files and Shell Scripts for Building and Running Samples in the Web Services SDK
Import Server Certificates into the Java Keystore for the Web Services SDK
Generating Stubs and Compiling Classes for the Web Services SDK
Precompiled JAX-WS Samples in the Web Services SDK
Use the Included Build Scripts in the Web Services SDK
Running the Web Services SDK SimpleClient Sample Application to Validate Setup
Run a Sample Application Using the Provided Scripts in the Web Services SDK
Endpoint Configuration for HTTP
Modifying Service Endpoint Configurations to Support HTTP
HTTP Configuration for Web Services API Endpoint
HTTP Configuration for Web Services API Endpoint on ESXi or vCenter Server for Windows
HTTP Configuration for Web Services API Endpoint on vCenter Server Appliance
HTTP Configuration for vSphere Automation API Endpoint
vSphere Web Services SDK Programming Guide
The vSphere Web Services SDK
vSphere Web Services SDK
SDK Developer Setup for the Web Services SDK
SDK Samples for the Web Services SDK
UML Diagrams Used in the Web Services SDK Programming Guide
vSphere Web Services Programming Model
vSphere Client-Server Architecture
Web Services API as a Web Service
WSDL Files and the Client-Side Proxy Interface
Network Access to the vSphere Web Service
Language-Specific Classes and Methods
Mapping XML Data Types to Java or JSON Data Types
Access to Managed Objects
Access to vSphere Server Data
Obtaining Information from a Server
Working with Data Structures
Accessing Property Values
Nested Properties and Property Paths in Composite Data Structures
xsd:anyType Arrays
Cast an xsd:anyType Array to an Event Array
Cast an xsd:anyType Array to an Array of Managed Object References
Cast an xsd:anyType Array to an Array of String
Indexed Array and Key-Based Array Properties
Unset Optional Properties
Escape Character in Name and Path Properties
Client Applications for the Web Services API
vCenter Server Connections
Establishing a Single Sign-On Session with a vCenter Server
LoginByToken to vCenter Server By Using Java
vCenter Server Single Sign-On Session Using Java
HTTP and SOAP Header Handlers in Java
Sample Code for a Java Client to the Web Services SDK
Creating the HTTP Connection in Java
Using LoginByToken in Java
Restoring the vCenter Server Session Cookie in a Java Client
Establishing a Session with Username and Password Credentials
Overview of a Java Sample Application for the Web Services SDK
Build a Simple vSphere Client Application for the Web Services SDK
Java Client Example for the Web Services SDK
Compiling the Java Test Client in the Web Services SDK
Web Server Session Token
Accessing the vSphere Web Services HTTP Endpoint with JAX-WS
Accessing the vSphere Server from a Web Services Client
Closing the Connection from a Web Services Client
Using the Java Samples as Reference
Multiple Versions of the vSphere API
Java Sample Applications in the Web Services SDK
Java Samples in the Web Services SDK
Client Applications Using the JSON Protocol
Client Requirements for the JSON Protocol
Outlining a Client for the JSON Protocol
Building JSON Request URLs
Building JSON Request Bodies
Retrieving the Service Instance with the JSON Protocol
Authenticating a JSON Client with the Session Manager
Basic Authentication for the JSON Protocol
SAML Token Authentication for a JSON Client
Mapping Methods for the JSON Protocol
Accessing Managed Object Properties with the JSON Protocol
Using Polymorphic Types with the JSON Protocol
Python Client Example for the JSON Protocol
Datacenter Inventory
Inventory Overview for the Web Services SDK
Inventory Hierarchies and ServiceInstance
Folders in the Hierarchy
ESXi Inventory Hierarchy
Accessing Inventory Objects
Creating Inventory Objects
Privileges Required for Inventory Management
Privileges
Permissions
Managed and Standalone ESXi Hosts
Property Collector
Introduction to the PropertyCollector
Data Retrieval
Inventory Traversal and Property Selection
Gathering Data with a ViewManager Object
vSphere Data Objects for Property Collection
vSphere Methods for Property Collection
Using the PropertyCollector with RetrievePropertiesEx
Retrieve a Property from a Specified Managed Object
Retrieve Properties from a Set of Managed Objects with a View
Property Collector Program in Java for Web Services SDK
Inventory Traversal
TraversalSpec Traversal
Traverse the Inventory By Using the Property Collector
Inventory Traversal Example in Java
SelectionSpec Traversal
Simple Reference SelectionSpec
Recursive Traversal
Use Recursive TraversalSpec to Traverse Nested Inventory Folders
Nested Folder Traversal in Java
Client Data Synchronization with WaitForUpdatesEx
Property Filtering
WaitForUpdatesEx
Comparing Usage of MaxWaitSeconds
UpdateSet Data Object from the Property Collector
Server Data Transmission
PropertyCollector Performance
SearchIndex
Authentication and Authorization
Objects for Authentication and Authorization Management
Authentication and Authorization for ESXi and vCenter Server
ESXi User Model
vCenter Server User Model
vSphere Security Model
Privileges
Privileges for Datastore Objects in the Web Services API
Roles
Permissions
Setting Up Users, Groups, and Permissions
Obtaining User and Group Information from UserDirectory
RetrieveUserGroups Method
Managing ESXi Users with HostLocalAccountManager
Methods Available for Local Account Management
Create a Local User Account on an ESXi System
Managing Roles and Permissions with AuthorizationManager
Using Roles to Consolidate Sets of Privileges
Description of Roles on vSphere Servers
Modifying Sample Roles to Create New Roles
Granting Privileges Through Permissions
Obtaining Information About Permissions
Setting, Changing, or Deleting Permissions
Impact of Group Membership on Permissions
Applying Permission to a Managed Entity
Authenticating Users Through SessionManager
Using VMware Single Sign On for vCenter Server Sessions
Using the Credential Store for Automated Login
Credential Store Libraries
Credential Store Methods
Credential Store Backing File
Credential Store Samples
Specifying Roles and Users with the Credential Store
Managing Licenses with LicenseManager
Hosts
Host Management Objects
Retrieving Host Information
Configuring and Reconfiguring Hosts
Managing the Host Lifecycle
Reboot and Shutdown
Using Standby Mode
Disconnecting and Reconnecting Hosts
Querying and Changing the Host Time
Querying Virtual Machine Memory Overhead
Storage
Storage Management Objects
Introduction to Storage
How Virtual Machines Access Storage
Datastores
Choosing the Storage API to Use
Managed Objects for Working with Storage
Configuring Disk Partitions
Multipath Management
Configuring iSCSI Storage
Configure the VMkernel To Support Software iSCSI
Configure iSCSI Initiators
Creating and Managing Datastores
Accessing Datastores
Creating and Modifying a VMFS Datastore
Set Up Disk Partitions
Create the VMFS Datastore
Removing and Updating Datastores
Managing VMFS Datastores with HostStorageSystem
Update and Upgrade with HostStorageSystem
Managing VMFS Volume Copies (Resignaturing)
Resignaturing Volumes with ResignatureUnresolvedVmfsVolume_Task
Managing Diagnostic Partitions
Retrieving Diagnostic Partition Information
Create a Diagnostic Partition
Sample Code for Storage
vSphere Networks
Virtual Switches
Port Groups
Virtual Machine Network Interfaces
VMkernel Network Interfaces
Physical Network Adapter (pnic)
Using a Distributed Virtual Switch
Distributed Virtual Switch Configuration
Backup, Rollback, and Query Operations
VMware Standard Virtual Switch
Configuring a Standard Virtual Switch
vNetwork Standard Switch Environment
Virtual Switches
Setting Up Networking with vSS
Retrieving Information About the Network Configuration
Adding a Standard Virtual Switch
Adding a Virtual Port Group
Adding a VMkernel Network Interface
Defining the Host Network Policies
NIC Teaming
Setting Up IPv6 Networking
Adding Networking Services
Adding an NTP Service
Setting Up the IP Route Configuration
Setting Up SNMP
Sample Code for Networks
Virtual Machine Configuration
VirtualMachine Management Objects and Methods
Creating Virtual Machines and Virtual Machine Templates
Creating a Virtual Machine Using VirtualMachineConfigSpec
Calling the CreateVM_Task Method
Specifying Virtual Machine Attributes with VirtualMachineConfigSpec
Cloning a Virtual Machine
Continuous Virtual Machine Clone
Creating Virtual Machine Templates
Converting a Template to a Virtual Machine
Accessing Information About a Virtual Machine
Checking Default Files
Checking Default Devices
Configuring a Virtual Machine
Name and Location
Hardware Version
Boot Options
Operating System
CPU and Memory Information
Configuring Virtual CPUs and Memory
CPU Processors and Memory Affinity
CPU Features
CPU and Memory Modification for Running Virtual Machines
Configuring Resource Allocation Constraints for Virtual Machines
Networks
Virtual Network Interfaces
Virtual Machine MAC Address
Fibre Channel NPIV Settings
File Locations
Adding Devices to Virtual Machines
Performing Virtual Machine Power Operations
Registering and Unregistering Virtual Machines
Customizing the Guest Operating System
Installing VMware Tools
Upgrading a Virtual Machine
Virtual Machine Management
Virtual Machine Migration
Cold Migration
Migration with vMotion
Using Storage vMotion
Snapshots
Creating a Snapshot
Reverting to a Snapshot
Deleting a Snapshot
Linked Virtual Machines
Linked Virtual Machines and Disk Backings
Limitation for HA Clusters
Creating a Linked Virtual Machine
Creating a Linked Virtual Machine From a Snapshot
Creating a Linked Virtual Machine From the Current Running Point
Instant Clone Virtual Machines
Instant Clone Terminology
Run State of the Instant Clone Source
Advantages of Cloning from the Current Running Point
Advantages of Cloning from a Frozen Virtual Machine
The Instant Clone Process from a Frozen Source
Freezing the Source Virtual Machine for an Instant Clone Operation
Instant Clone API Methods
How the Instant Clone Operation Works
Limitations of Instant Clones
Guest Customization of Instant Clone Virtual Machines
Avoiding Network Identity Collisions after Instant Clone Operations
Removing Snapshots and Deleting Linked Virtual Machines
Relocating a Virtual Machine in a Linked Virtual Machine Group
Promoting a Virtual Machine's Disk
Performing Advanced Manipulation of Delta Disks
Virtual Machine Guest Operations
Authenticating with the Guest Operating System
Running Guest OS Operations
Guest Operating System Customization
Guest Customization for Stopped Virtual Machines
Guest Customization Using cloud-init
Prepare a Virtual Machine Template for Raw Data cloud-init Customization
Prepare a cloud-init Metadata File
Prepare a cloud-init Userdata File
Initiate Raw Data cloud-init Customization with the vSphere Web Services API
Guest Network Customization for Instant Clone Virtual Machines
Installing the Guest Customization Engine
Disconnecting Virtual NICs
Customizing Guest Network Settings for Running Virtual Machines
Reconnecting Virtual NICs in a Running Virtual Machine
Restarting the Guest Network After Customization
Recovering from Guest Network Customization Errors
Application-Dependent Customization
Resetting the Network Stack in a Running Virtual Machine
Resetting the Network Stack in a Linux Virtual Machine
Resetting the Network Stack in a Windows Virtual Machine
Reset the Network Stack in a Windows Virtual Machine Using the Control Panel
Reset the Network Stack in a Windows Virtual Machine Using PowerShell
Reset the Network Stack in a Windows Virtual Machine Using netsh
Virtual Machine Security
How Virtual Machine Encryption Protects a Datacenter
What Keys are Used
What Is Encrypted
Virtual Machine Files
Virtual Disk Files
Core Dump Files
What Is Not Encrypted
Log Files
Virtual Machine Configuration Files
Virtual Disk Descriptor File
Who Can Perform Cryptographic Operations
How Can I Perform Cryptographic Operations
vSphere Virtual Machine Encryption Components
Key Management Server
vCenter Server
ESXi Hosts
Encryption Process Flow
Prerequisites and Required Privileges for Encryption Tasks
Cryptography Privileges and Roles
Host Encryption Mode
Encrypted vSphere vMotion
API Methods for vSphere Virtual Machine Encryption
vSphere API Methods for KMS Management
API Methods to Prepare an ESXi Host
vSphere API Methods for Cryptographic Operations
SPBM API Methods for Encryption
Workflows for vSphere Virtual Machine Encryption
Set Up the Key Management Server Cluster
Add Key Management Server(s) to Your Datacenter
Establish a Trusted Connection by Exchanging Certificates
Create an Encryption Storage Policy
Create an Encrypted Virtual Machine
Clone an Encrypted Virtual Machine
Encrypt an Existing Virtual Machine or Disk
Decrypt an Encrypted Virtual Machine or Disk
Encrypt with Different Keys for VM and Disk
Recrypt (Rekey) Encrypted Virtual Machines
Recrypt Only Key Encryption Keys
Recrypt Both Key and Disk Encryption Keys
Query Crypto Key In-Use Status
Encrypted vSphere vMotion
Enable Encrypted vMotion
Virtual Disk Manager
Best Practices for Virtual Machine Encryption
Configuring Advanced Options
Physical Platform Resources
Virtual Applications: the vApp
About Virtual Applications
Management Overview
Direct and Linked Children
OVF Packages
Creating a VirtualApp
Managing VirtualApp Children
Exporting a Virtual Application
VirtualApp and OvfManager Methods
VirtualApp Data Structures
OvfManager Data Structures
Example of Generating an OVF Package
Importing an OVF Package
Virtual Application Life Cycle
Powering a Virtual Application On or Off
Unregistering a Virtual Application
Suspending a Virtual Application
Destroying a Virtual Application
Resource Management
Resource Management Objects
Introduction to Resource Management
Resource Allocation
Resource Pool Hierarchies
Cluster Overview
Creating and Configuring Resource Pools
Configuring Reservation and Limit for Resource Pools
Understanding Fixed Reservations
Understanding Expandable Reservations
Expandable Reservation Example 1
Expandable Reservation Example 2
Expandable Reservation Example 3
Configuring Priority Shares for Resource Pools
Understanding Fixed Shares
Understanding Scalable Shares
Deleting Child Resource Pools
Moving Resource Pools or Virtual Machines Into a Resource Pool
Introduction to vSphere Clusters
VMware DRS
VMware HA
VMware HCI
Creating and Configuring Clusters
Creating a Cluster
Adding a Host to a Cluster
Reconfiguring a Cluster
Managing DRS Clusters
Managing HA Clusters
Primary and Secondary Hosts
Failure Detection and Host Network Isolation
Using VMware HA and DRS Together
Tasks and Scheduled Tasks
Creating Tasks
Session Persistence
Cancelling a Task
Using TaskInfo to Determine Task Status
TaskInfo Values
Monitoring TaskInfo Properties
Accessing and Manipulating Multiple Tasks
Task Monitoring Example Using the Listview Object
Create an Authenticated Session with the Server
Find Virtual Machine MOref
Get_Parent_Property
Create Clones of the Virtual Machine
Monitor Tasks with WaitForUpdatesEx
Gathering Data with a TaskManager Interface
Examining Recent Tasks with TaskManager
Understanding the ScheduledTaskManager Interface
Scheduling Tasks
Defining the Schedule and Action
Scheduling Recurring Operations
Cancelling a Scheduled Task
Using a TaskHistoryCollector
Managing the HistoryCollector
Sample Code for Tasks
Events and Alarms
Event and Alarm Management Objects
Understanding Events
Managing Events with EventManager
Event Data Objects
Formatting Event Message Content
Creating Custom Events
Creating User Log Events
Creating Extended Events
Using an EventHistoryCollector
Creating an EventHistoryCollector Filter
Managing the HistoryCollector
Using Alarms
Obtaining a List of Alarms
Creating an Alarm
Defining Alarms Using the AlarmSpec Data Object
Specifying Alarm Trigger Conditions with AlarmExpression
AlarmExpression Types
Using MetricAlarmExpression
Specifying Alarm Actions
Deleting or Disabling an Alarm
Sample Code for Events and Alarms
vSphere Performance
vSphere Performance Data Collection
PerformanceManager Objects and Methods
Retrieving vSphere Performance Data
Performance Counter Example (QueryPerf)
Mapping Performance Counters (Counter Ids and Metadata)
Retrieving Statistics
Performance Data Returned by a vSphere Server
Handling Returned Performance Data
Large-Scale Performance Data Retrieval
Using the QueryPerf Method as a Raw Data Feed
Comparison of Query Methods
Retrieving Summary Performance Data
Performance Counter Metadata
PerfCounterInfo
Performance Intervals
ESXi Server Performance Intervals
vCenter Server Performance Intervals
vSphere Performance and Data Storage
Modifying Historical Intervals
Modifying Performance Counter Collection Levels
Performance Counter Data Collection
Performance Counter Data Storage
Performance Manager Method Interaction
vSphere Client Management of Performance Statistics
Sample Code for Performance
Diagnostics and Troubleshooting
Troubleshooting Best Practices
Overview of Configuration Files and Log Files
ESXi Log File
Virtual Machine Log Files
vCenter Server Log Files
Modifying the Log Level to Obtain Detailed Information
Setting the Log Level on ESXi Systems
Generating Logs
Setting the Log Level on vCenter Server Systems
Using DiagnosticManager
Using the MOB to Explore the DiagnosticManager
Generating Diagnostic Bundles
Export Diagnostic Data By Using the vSphere Client
Managed Object Browser
Using the MOB to Explore the Object Model
Accessing the MOB
Using the MOB to Navigate the vSphere Object Model
Using the MOB to Invoke Methods
Passing Primitive Datatypes to Method
Passing Arrays of Primitives to Methods
Passing Complex Structures to Methods
Simple Content
Complex Content
Using the MOB Along With the API Reference
HTTP Access to vSphere Server Files
Introduction to HTTP Access
URL Syntax for HTTP Access
Datastore Access (/folder)
Host File Access to vSphere Server Files (/host)
Update Package Access (/tmp)
Privilege Requirements for HTTP Access
Sample Program Overview
Java Sample Programs (JAXWS Bindings)
VMware Storage Policy SDK Programming Guide
VMware Storage Policies
Storage Capabilities
Virtual Machine Storage
Storage Capability Profiles
Storage Policy Operations
Access to the Storage Policy Server
Storage Profile Queries
VMware Storage Policy SDK
VMware Storage Policy SDK Examples
Storage Policy Server Connection
About Storage Policy Server Sessions
Establish a Connection with the VMware Storage Policy Server
Server URLs for Basic Connection
Create the Storage Policy Server Connection
Establish the vCenter Session Connection for the Local Instance
vVol Based Storage Profiles
vVol Storage Policy Architecture
SPBM Calling Sequence for vVols
SPBM Data Objects
vSAN Based Storage Profiles
Create a vSAN Requirements Profile
Create an Individual Storage Requirement
Create a Storage Profile
Virtual Machine Storage Profiles
Retrieve an Existing Storage Profile from the Server
Apply the Storage Profile to a Virtual Machine
Tag-Based Storage Profiles
Creating a Tag-Based Storage Profile
Creating a Storage Profile
Retrieving Tag Metadata
Policy Rules
Create a Stand-Alone Virtual Disk with an Attached Storage Encryption Policy
Legacy Storage Profiles
VASA 1.0 Storage Capability Upgrade
vSphere Web Client User Label Conversion
vCenter Single Sign-On Client Example
vCenter Single Sign-On Token Request Overview
Using Handler Methods for SOAP Headers
Sending a Request for a Security Token
vCenter LoginByToken Example
vCenter Server Single Sign-On Session
HTTP and SOAP Header Handlers
LoginByToken Sample Code
Saving the vCenter Server Session Cookie
Using LoginByToken
Restoring the vCenter Server Session Cookie
vCenter Single Sign-On Programming Guide
Single Sign-On in the vSphere Environment
vCenter Single Sign-On Overview
vCenter Single Sign-On Client API
Acquiring a SAML Token from a vCenter Single Sign-On Server
vCenter Single Sign-On Security Policies
Connecting to a vCenter Single Sign-On Server
vCenter Single Sign-On Token Delegation
vCenter Single Sign-On Token Lifetime - Clock Tolerance
vCenter Single Sign-On Challenge (SSPI)
vCenter Single Sign-On SOAP Message Structure
vCenter Single Sign-On SDK
vCenter Single Sign-On SDK Examples
vCenter Single Sign-On API Reference
vCenter Single Sign-On Client API Methods
Issue
Renew
Validate
Challenge
vCenter Single Sign-On API Data Structures
RequestSecurityTokenType
RequestSecurityTokenResponseCollectionType
RequestSecurityTokenResponseType
LifetimeType
RenewingType
KeyTypeOpenEnum
UseKeyType
ParticipantsType
ParticipantType
EndpointReference
BinaryExchangeType
AdviceType
AttributeType
vCenter Single Sign-On Client Example (JAX-WS)
vCenter Single Sign-On Token Request Overview
Using Handler Methods for SOAP Headers in Java
Sending a Request for a Security Token in Java
LoginByToken Example (JAX-WS)
vCenter Server Single Sign-On Session
HTTP and SOAP Header Handlers in Java
LoginByToken Sample Code in Java
Steps to Connect with a vSphere Server
Import the Necessary Java Packages for LoginByToken
Get the VimPort for LoginByToken in Java
Retrieve the Service Content in Java
Invoke the loginByToken method in Java
Extract the Session Cookie in Java
Inject the Session Cookie Back Into the Request in Java
Additional Information
Using a Proxy with vSphere Virtual Serial Ports
About This Book
Remote Serial Port Access with a Virtual Serial Port Proxy
Virtual Serial Port Proxy Capabilities
Proxy as a Virtual Serial Port Concentrator
Network Serial Ports
Backing Options and Backing Information for Network Serial Ports
Network Connections Between a Virtual Machine, a Proxy, and a Remote System
Determining Backing Options
Create a Virtual Machine with a Network Serial Port
VMware Telnet Session
VMware Telnet Commands
Establish a VMware Telnet Extension Session
Proxy Failure Detection (TCP keepalive)
vMotion and Persistent Serial Port Connections
VMware Telnet Extension Commands for Proxy Communication
Command Syntax
VMware Telnet Extension Option
Option Subnegotiation
Unknown Command Response
Proxy Operation
vMotion Notification
Virtual Machine Identification
Developing and Deploying vSphere Solutions, vServices, and ESX Agents
How to develop vSphere solution
Download the vSphere ESX Agent Manager SDK
What is in the vSphere Extension APIs
How to use the vCenter Server Extensions
Standard Tabs in the vCenter Server Extensions
What are the vSphere ESX agents and agencies
vSphere ESX Agent Manager
What are vServices
vService Manager
vCenter Extension vService
How do I create vSphere solutions
Contents and structure of an extension
Key objects in the vSphere API for extension and solution development
How do I register an extension with vCenter Server
Create the program that manages the extension
Connect the extension to vCenter Server
Set the extension key
Set the extension product information
Set the extension name and localization resources
Identify the virtual machines or vApps that an extension manages
What are the operations that trigger warnings from extensions
Set the types of the virtual machines or vApps that the extension manages
Set the description for a type of virtual machine or vApp that a solution manages
Unregister the extension from vCenter Server
What are the SDK objects for integration with vCenter Server Extensions
Properties of the Extension data object that relate to the vCenter Server Extensions
vCenter Server Extensions data objects
How do I integrate a solution with vCenter Server Extensions
Add a solution to vCenter Server Extensions
Set the icon for a type of virtual machine or vApp that an extension manages
Add tabs to a solution
Set up health monitoring for a solution
Solution health XML schema
How do I integrate solutions with vSphere ESX Agent Manager
Benefits of integrating solutions with ESX Agent Manager
vSphere ESX Agent Manager architecture
Configuration components of ESX agencies
ESX agency scope
ESX agency goal state
ESX agency status
Status of ESX agency scope changes
Requirements for itegrating a solution with ESX Agent Manager
How do I authenticate against ESX Agent Manager
How do I configure the availability of ESX agent virtual machines
Monitoring and resolving ESX agent issues
How does the ESX Agent Manager remediate issues
How do I integrate a solution with ESX Agent Manager
Connect a solution to ESX Agent Manager
Configure an ESX agency and ESX agents
Create an ESX agency
Update the Agency scope of a solution
Change the goal state of an agency
Delete an ESX agency
Resolve ESX agent issues
How do I integrate an extension with the vCenter Extension vService
Integrate a virtual machine with the vCenter Extension vService
Configure the OVF descriptor file
Provide a script in the Extension virtual machine to register as a vCenter Extension
Deploy an extension in the vSphere Client by using the vCenter Extension vService
vCenter Extension vService XML schema
VMware vSphere Automation REST API Programming Guide
Introduction to the vSphere Automation REST API
Components of the vSphere Automation Virtualization Layer
Components and Services of the vSphere Environment
About vSphere
About ESXi
vCenter Server Management Overview
Understanding thevSphere Automation API
vSphere Automation API Base Path
vSphere Automation API Requests
vSphere Automation API Responses
Supplementing the vSphere Automation APIs
Authentication Mechanisms
Authentication Terminolgy
Authenticate to vCenter Server with vCenter Single Sign-On Credentials
Identity Provider Federation for vCenter Server
AD FS Federation Workflows
Federate vCenter Server to Microsoft Active Directory Federation Services (AD FS)
Authenticate by Using the Password Grant Type
Authenticate by Using the Authorization Code Grant Type
VMware Identity Broker - vCenter Server Workflows
Federate Apps or Scripts to an External Identity Provider by Using Your VMware Identity Broker - vCenter Server Configuration
Obtain JWT Tokens by Using the Password Grant Type
Obtain JWT Tokens by Using the Authorization Code Grant Type
Obtain JWT Token by Using the Client Credentials Grant Type
Exchange JWT Tokens for a SAML Token and Obtain a Session Identifier
ESXi Hosts
How to Retrieve Information About ESXi Hosts
How to Add a Standalone ESXi Host to vCenter Server
How to Disconnect and Reconnect ESXi Hosts
How to ConfigureESXi Entropy
Managing the Life Cycle of Hosts and Clusters
vSphere Lifecycle Manager Terms
vSphere Lifecycle Manager Overview
Options for Managing theESXi Life Cycle
Required Privileges for Using vSphere Lifecycle Manager and
vSphere Lifecycle Manager Privileges For Using Images
Required Privileges for Using
Software Depots
Types of Software Depots
Working with Online Depots
Working with UMDS Depots
Synchronizing Software Depots
Working with Offline Depots
Managing Depot Overrides
Inspecting Depot Contents
Enabling a Cluster to Use a Software Specification
Creating a Cluster with Enabled vSphere Lifecycle Manager
Enabling an Existing Cluster to Use vSphere Lifecycle Manager
Enabling a Standalone Host to Use a Software Specification
Working with Draft Software Specifications
Creating a Draft Software Specification
Editing a Draft Software Specification
Validating the Draft Software Specification
Committing the Draft Software Specification
Working with Desired Software States
Exporting and Importing a Desired State
Checking the Compliance Against the Desired State
Hardware Compatibility Data
Checking the Hardware Compatibility of an ESXi Host
Configuring Remediation Settings
Remediating an ESXi Cluster and a Standalone Host
Integrate Third-Party Solutions with vSphere Lifecycle Manager
Virtual Machine Configuration and Management
Creating Virtual Machines
Creating a Virtual Machine Without a Clone or Template
Configuring Virtual Machines
Managing Virtual Machines
Managing Data Sets
Data Set Operations
HTTP Requests for Data Set Operations
Using Content Libraries
What Is a Content Library
Content Library Types
Content Library Items
Content Library Storage
Querying Content Libraries
Working with Content Libraries
Working with Library Items
Content Library Support for OVF and OVA Packages
Working with OVF and OVA Packages in a Content Library
Upload an OVF or an OVA Package from a URL to a Library Item
Upload an OVF or OVA Package from a Local File System to a Library Item
Creating Virtual Machines and vApps from Templates in a Content Library
Create a VM Template in a Content Library from a Virtual Machine
Create an OVF Template in a Content Library from a Virtual Machine or vApp
Deploy a Virtual Machine from a VM Template in a Content Library
Deploy a Virtual Machine or vApp from an OVF Template in a Content Library
vSphere Tag Service
Creating vSphere Tags
Creating a Tag Category
Creating a Tag
Creating Tag Associations
Assign the Tag to a Content Library
Assign a Tag to a Cluster
Updating a Tag
Using Tags to Create and Manage Compute Policies
Create a Compute Policy
Using HTTP Requests to Manage the Compute Policy Workflow
Manage Compute Policy Capabilities
Create Tags and Associations
Create, List, and Use Policies
vSphere Security
Managing Certificates
Certificate Management Operations
Add a Root Certificate to vCenter Server
Delete a Root Certificate from vCenter Server
Change the Machine SSL Certificate of vCenter Server
Refresh the vCenter Server STS Signing Certificate with a VMCA-Issued Certificate
Set a Custom STS Signing Certificate to vCenter Server
Managing vSphere Native Key Provider
Retrieve vSphere Native Key Providers
Manage vSphere Native Key Providers
Export and Import vSphere Native Key Provider Configuration
Retrieve vSphere Native Key Providers on a Host
vSphere Trust Authority
Configure a vSphere Trust Authority Cluster
Configure Key Providers
Establish Trust Between Key Provider and Key Server
Configure Trusted TPMs of Attested ESXi Hosts on a Cluster Level
Configure Trusted ESXi Builds on a Cluster Level
Retrieve vSphere Trust Authority Components Information
Configure vSphere Trust Authority Components
Configure vSphere Trust Authority Components for Trusted Clusters
Establish Trust Between Hosts in a vSphere Trust Authority Cluster and a Workload vCenter Server
Check Trusted Cluster Health
Remediate a Trusted Cluster
Managing Host Hardware Security
Retrieve Host Hardware TPM Information
Manage Host Hardware TPM Endorsement Keys
Register an SGX Host
vSphere Supervisor Configuration and Management
vSphere Supervisor Terminology
vSphere Supervisor Components and Services
How to Configure and Manage a Supervisor
Persistent Storage in vSphere Supervisor
Creating Storage Policies for vSphere Supervisor
Enabling ReadWriteMany Support
Supervisor Networking
Configuring NSX for vSphere Supervisor
Configuring the vSphere Networking Stack for vSphere Supervisor
Installing and Configuring the HAProxy Load Balancer
Using the NSX Advanced Load Balancer with vSphere Networking
EnablevSphere Supervisor on a Cluster withNSX as the Networking Stack
EnablevSphere Supervisor on a Cluster with the vSphere Networking Stack
Upgrading a Supervisor
Monitoring the Enable and Upgrade Supervisor Operations
Reconfiguring a Supervisor
Deactivating a Supervisor
Content Libraries in vSphere Supervisor
Creating, Securing, and Synchronizing Content Libraries for TKG Releases
Creating and Managing Content Libraries for VM Provisioning in vSphere Supervisor
Associating a Content Library with a Namespace
Managing Namespaces on a Supervisor
Create a vSphere Namespace
Updating the Namespace Configuration
Configuring the Access to a Namespace
Self-Service Namespace Management
Virtual Machines in vSphere Supervisor
Create a VM Class in vSphere Supervisor
Editing or Removing a VM Class from Your Environment
Associating a VM Class with a vSphere Namespace
vCenter Server Management
Authorization Model for Administration of vCenter Server
Authorization Model Mapping to the vCenter Single Sign-On Domain
Using the Operator Role
Using the Admin Role
Using the SuperAdmin Role
Performing Privilege Checks Operations
vCenter Server Installation and Setup
Install Stage 2
Setting Up a Newly Installed vCenter Server Instance
Workflows for Install Stage 2
HTTP Requests for Install Stage 2
Use HTTP Requests to Set Up a Newly Deployed vCenter Server Instance
File-Based Backup and Restore of vCenter Server
Backing up vCenter Server
Backup and Restore Protocols for vCenter Server
Calculate the Size Needed To Store the Backup File
Back up a vCenter Server Instance by Using the API
Schedule a Backup Job
Restoring vCenter Server
Authentication When Restoring a vCenter Server Instance
Availability of Services While Restoring a vCenter Server Instance
Restore a vCenter Server Instance by Using the API
Reconcile a vCenter Server Instance with Nodes in Embedded Linked Mode
Troubleshooting for vCenter Server Installation or Deployment
Managing System Logs
Configuring Syslog Forwarding
HTTP Requests for Configuring Syslog Forwarding
Managing Support Bundles
HTTP Requests for Support Bundle Management Operations
vCenter Server Upgrade
Upgrade Stage 2
Upgrading a vCenter Server Instance
Workflows for Upgrade Stage 2
HTTP Requests for Upgrade Stage 2
Historical Data Transfer
Deferred Import
Historical Data Import Errors
vCenter Server Configuration
Health Monitoring of vCenter Server
Check Overall System Health of vCenter Server
Capacity Monitoring ofvCenter Server
Check Database Usage in vCenter Server
List Storage Consumption By Data Type in vCenter Server
Managing the Global FIPS Compliance
Performing Infrastructure Profile Management Operations
Patching and Updating vCenter Server Deployments
Planning vCenter Server Updates
Performing Discovery and Planning Operations
List Available Products and Manage Associated Products
List Available Updates
Retrieve a Report
Updating vCenter Server
ApplyingvCenter Server Software Updates
vCenter Server Software Update Workflow
VMware vSphere Automation SDKs Programming Guide
Introduction to the vSphere Automation SDKs
What Are the Components and Services of the vSphere Environment
Retrieving Service Endpoints
Filtering for Predefined Service Endpoints
Filter Parameters for Predefined Service Endpoints
Connect to the Lookup Service and Retrieve the Service Registration Object
Java Example of Connecting to the Lookup Service and Retrieving the Service Registration Object
Python Example of Connecting to the Lookup Service and Retrieving a Service Registration Object
Retrieve Service Endpoints on vCenter Server Instances
Java Example of Retrieving a Service Endpoint on a vCenter Server Instance
Python Example of Retrieving a Service Endpoint on a vCenter Server Instance
Retrieve a vCenter Server ID by Using the Lookup Service
Java Example of Retrieving a vCenter Server ID by Using the Lookup Service
Python Example of Retrieving a vCenter Server ID by Using the Lookup Service
Retrieve a vSphere Automation API Endpoint on a vCenter Server Instance
Java Example of Retrieving a vSphere Automation Endpoint on a vCenter Server Instance
Python Example of Retrieving a vSphere Automation Endpoint on a vCenter Server Instance
Authentication Mechanisms
Authentication Terminolgy
Create a vSphere Automation Session with User Credentials
Java Example of Creating a vSphere Automation API Session with User Credentials
Python Example of Creating a vSphere Automation Session with Username and Password
Retrieve a SAML Token
Java Example of Retrieving a SAML Token
Python Example of Retrieving a SAML Token
Create a vSphere Automation Session with a SAML Token
Java Example of Creating a vSphere Automation API Session with a SAML Token
Python Example of Creating a vSphere Automation API Session with a SAML Token
Create a Web Services Session
Java Example of Creating a vSphere Web Services Session
Python Example of Creating a Web Services Session
Identity Provider Federation for vCenter Server
AD FS Federation Workflows
Federate vCenter Server to Microsoft Active Directory Federation Services (AD FS)
Authenticate by Using the Password Grant Type
Java Example of Creating a vSphere Automation API Session with User Credentials
Python Example of Creating a vSphere Automation Session with Username and Password
Authenticate by Using the Authorization Code Grant Type
VMware Identity Broker - vCenter Server Workflows
Federate Apps or Scripts to an External Identity Provider by Using Your VMware Identity Broker - vCenter Server Configuration
Obtain JWT Tokens by Using the Password Grant Type
Obtain JWT Tokens by Using the Authorization Code Grant Type
Obtain JWT Token by Using the Client Credentials Grant Type
Exchange JWT Tokens for a SAML Token and Obtain a Session Identifier
Accessing vSphere Automation Services
Access a vSphere Automation Service
ESXi Hosts
How to Retrieve Information About ESXi Hosts
How to Add a Standalone ESXi Host to vCenter Server
How to Disconnect and Reconnect ESXi Hosts
How to ConfigureESXi Entropy
Managing the Life Cycle of Hosts and Clusters
vSphere Lifecycle Manager Terms
vSphere Lifecycle Manager Overview
Options for Managing theESXi Life Cycle
Required Privileges for Using vSphere Lifecycle Manager and
vSphere Lifecycle Manager Privileges For Using Images
Required Privileges for Using
Software Depots
Types of Software Depots
Working with Online Depots
Working with UMDS Depots
Synchronizing Software Depots
Working with Offline Depots
Managing Depot Overrides
Inspecting Depot Contents
Enabling a Cluster to Use a Software Specification
Creating a Cluster with Enabled vSphere Lifecycle Manager
Enabling an Existing Cluster to Use vSphere Lifecycle Manager
Enabling a Standalone Host to Use a Software Specification
Working with Draft Software Specifications
Creating a Draft Software Specification
Editing a Draft Software Specification
Validating the Draft Software Specification
Committing the Draft Software Specification
Working with Desired Software States
Exporting and Importing a Desired State
Checking the Compliance Against the Desired State
Hardware Compatibility Data
Checking the Hardware Compatibility of an ESXi Host
Configuring Remediation Settings
Remediating an ESXi Cluster and a Standalone Host
Integrate Third-Party Solutions with vSphere Lifecycle Manager
Virtual Machine Configuration and Management
Creating Virtual Machines
Creating a Virtual Machine Without a Clone or Template
Java Example of Creating a Basic Virtual Machine
Python Example of Creating a Basic Virtual Machine
Configuring Virtual Machines
Name and Location
Java Example of Configuring the Name and Placement of a Virtual Machine
Python Example of Configuring the Placement of a Virtual Machine
Hardware Version
Boot Options
Java Example of Configuring the Boot Options of a Virtual Machine
Python Example of Configuring the Boot Options
Guest Operating System
CPU and Memory
Java Example of Configuring the CPU and Memory of a Virtual Machine
Python Example of Configuring the CPU and Memory of a Virtual Machine
Networks
Java Example of Configuring the Virtual Machine Network
Python Example of Configuring the Virtual Machine Network
Managing Virtual Machines
Filtering Virtual Machines
Java Example of Filtering Virtual Machines
Python Example of Filtering Virtual Machines
Installing VMware Tools
Performing Virtual Machine Power Operations
Java Example of Powering On a Virtual Machine
Python Example of Powering On a Virtual Machine
Registering and Unregistering Virtual Machines
Virtual Machine Guest Operations
Upload and Run a Script on a Guest Operating System
Python Example of Uploading and Running a Script on a Guest Operating System
Managing Data Sets
Data Set Operations
Using Content Libraries
What Is a Content Library
Content Library Types
Content Library Items
Content Library Storage
How to Query Content Libraries
Listing All Content Libraries
Listing Content Libraries of a Specific Type
Listing Content Libraries by Using Specific Search Criteria
How to Use Content Libraries
Create a Local Content Library
Publish an Existing Content Library
Publish a Library at the Time of Creation
Subscribe to a Content Library
Synchronize a Subscribed Content Library
Editing the Settings of a Content Library
Removing the Content of a Subscribed Library
Delete a Content Library
How To Use Library Items
Create an Empty Library Item
Querying Library Items
List Library Items
List Library Items That Match Specific Criteria
Edit the Settings of a Library Item
Upload a File from a Local System to a Library Item
Upload a File from a URL to a Library Item
Download Files to a Local System from a Library Item
Synchronizing a Library Item in a Subscribed Content Library
Removing the Content of a Library Item
Deleting a Library Item
Content Library Support for OVF and OVA Packages
Working with OVF and OVA Packages in a Content Library
Upload an OVF or an OVA Package from a URL to a Library Item
Python Example of Uploading an OVF Package from a URL to a Library Item
Upload an OVF or OVA Package from a Local File System to a Library Item
Python Example of Uploading an OVA Package to a Library Item
Creating Virtual Machines and vApps from Templates in a Content Library
Create a VM Template in a Content Library from a Virtual Machine
Python Example of Creating a VM Template in a Content Library from a Virtual Machine
Create an OVF Template in a Content Library from a Virtual Machine or vApp
Java Example of Creating an OVF Template in a Content Library from a Virtual Machine
Python Example of Creating an OVF Template in a Content Library from a Virtual Machine
Deploy a Virtual Machine from a VM Template in a Content Library
Python Example of Deploying a VM from a VM Template Library Item
Deploy a Virtual Machine or vApp from an OVF Template in a Content Library
Java Example of Deploying a Virtual Machine from a Library Item in a Resource Pool
Python Example of Deploying a Virtual Machine from a Library Item on a Resource Pool
vSphere Tag Service
Creating vSphere Tags
Creating a Tag Category
Creating a Tag
Creating Tag Associations
Assign a Tag to a Content Library
Assign a Tag to a Cluster
Updating a Tag
Using Tags to Create and Manage Compute Policies
Create a Compute Policy
vSphere Supervisor Configuration and Management
vSphere Supervisor Terminology
vSphere Supervisor Components and Services
How to Configure and Manage a Supervisor
Persistent Storage in vSphere Supervisor
Creating Storage Policies for vSphere Supervisor
Enabling ReadWriteMany Support
Supervisor Networking
Configuring NSX for vSphere Supervisor
Configuring the vSphere Networking Stack for vSphere Supervisor
Installing and Configuring the HAProxy Load Balancer
Using the NSX Advanced Load Balancer with vSphere Networking
EnablevSphere Supervisor on a Cluster withNSX as the Networking Stack
EnablevSphere Supervisor on a Cluster with the vSphere Networking Stack
Upgrading a Supervisor
Monitoring the Enable and Upgrade Supervisor Operations
Reconfiguring a Supervisor
Deactivating a Supervisor
Content Libraries in vSphere Supervisor
Creating, Securing, and Synchronizing Content Libraries for TKG Releases
Creating and Managing Content Libraries for VM Provisioning in vSphere Supervisor
Associating a Content Library with a Namespace
Managing Namespaces on a Supervisor
Create a vSphere Namespace
Updating the Namespace Configuration
Configuring the Access to a Namespace
Self-Service Namespace Management
Virtual Machines in vSphere Supervisor
Create a VM Class in vSphere Supervisor
Editing or Removing a VM Class from Your Environment
Associating a VM Class with a vSphere Namespace
vSphere Security
Managing Certificates
Certificate Management Operations
Add a Root Certificate to vCenter Server
Delete a Root Certificate from vCenter Server
Change the Machine SSL Certificate of vCenter Server
Refresh the vCenter Server STS Signing Certificate with a VMCA-Issued Certificate
Set a Custom STS Signing Certificate to vCenter Server
Managing vSphere Native Key Provider
Retrieve vSphere Native Key Providers
Manage vSphere Native Key Providers
Export and Import vSphere Native Key Provider Configuration
Retrieve vSphere Native Key Providers on a Host
vSphere Trust Authority
Configure a vSphere Trust Authority Cluster
Configure Key Providers
Establish Trust Between Key Provider and Key Server
Configure Trusted TPMs of Attested ESXi Hosts on a Cluster Level
Configure Trusted ESXi Builds on a Cluster Level
Retrieve vSphere Trust Authority Components Information
Configure vSphere Trust Authority Components
Configure vSphere Trust Authority Components for Trusted Clusters
Establish Trust Between Hosts in a vSphere Trust Authority Cluster and a Workload vCenter Server
Check Trusted Cluster Health
Remediate a Trusted Cluster
Managing Host Hardware Security
Retrieve Host Hardware TPM Information
Manage Host Hardware TPM Endorsement Keys
Register an SGX Host
vCenter Server Management
Authorization Model for Administration of vCenter Server
Authorization Model Mapping to the vCenter Single Sign-On Domain
Using the Operator Role
Using the Admin Role
Using the SuperAdmin Role
Performing Privilege Checks Operations
vCenter Server Installation and Setup
Install Stage 2
Setting Up a Newly Installed vCenter Server Instance
Workflows for Install Stage 2
File-Based Backup and Restore of vCenter Server
Backing up vCenter Server
Backup and Restore Protocols for vCenter Server
Calculate the Size Needed To Store the Backup File
Back up a vCenter Server Instance by Using the API
Schedule a Backup Job
Restoring vCenter Server
Authentication When Restoring a vCenter Server Instance
Availability of Services While Restoring a vCenter Server Instance
Restore a vCenter Server Instance by Using the API
Reconcile a vCenter Server Instance with Nodes in Embedded Linked Mode
Troubleshooting for vCenter Server Installation or Deployment
Managing System Logs
Configuring Syslog Forwarding
Managing Support Bundles
vCenter Server Upgrade
Upgrade Stage 2
Upgrading a vCenter Server Instance
Workflows for Upgrade Stage 2
Historical Data Transfer
Deferred Import
Historical Data Import Errors
Class Diagrams for Deferred Import
Use the Deferred Import Sample
vCenter Server Configuration
Health Monitoring of vCenter Server
Check Overall System Health of vCenter Server
Capacity Monitoring ofvCenter Server
Check Database Usage in vCenter Server
List Storage Consumption By Data Type in vCenter Server
Managing the Global FIPS Compliance
Performing Infrastructure Profile Management Operations
Patching and Updating vCenter Server Deployments
Planning vCenter Server Updates
Performing Discovery and Planning Operations
List Available Products and Manage Associated Products
List Available Updates
Retrieve a Report
Updating vCenter Server
ApplyingvCenter Server Software Updates
vCenter Server Software Update Workflow
Developing Remote Plug-ins with the vSphere Client SDK
Revision History
Using the vSphere Client Remote Plug-in Samples
Try the Remote Plug-in Sample Starter
Remote Plug-in Sample UI and Server
Components in the Remote Plug-in Sample
Build the vSphere Client Remote Plug-in Sample
Find the SSL Thumbprint and GUID of vCenter Server
Start the Remote Plug-in Server
Get Thumbprint or Certificate of Remote Plug-in Server
Register the vSphere Client Remote Plug-in Sample
Viewing the vSphere Client Remote Plug-in Sample
Remote Plug-in Sample Directory Structure
Remote Plug-in Architecture in the vSphere Client
Components of the vSphere Client Architecture
vCenter Server Configurations
Communication Paths in Remote Plug-in Architecture
Communications Among UI Components in the vSphere Client
Client-Server Communications with Remote Plug-ins
Security Concepts for Remote Plug-ins
Creating a Remote Plug-in for the vSphere Client
Code Components for a vSphere Client Remote Plug-in
Deployment Requirements for a vSphere Client Remote Plug-in
Using Auxiliary Plug-in Servers
vSphere Client Plug-in Registration Tool
Sample Manifest File for a Remote Plug-in
Deploying Remote Plug-ins for the vSphere Client
Remote Plug-in Life Cycle
Remote Plug-in Deployment
Plug-In Caching
Remote Plugin Uninstallation
Redeploying Plug-ins During Development
Specifying Remote Plug-in Compatibility
Remote Plug-in Topologies
Remote Plug-in Terminology
Visibility of Remote Plug-in Views
Remote Plug-in Multi-Instance Support
Differentiating Plug-in Instances
Custom Topologies
Deploying Auxiliary Plug-in Servers
Remote Plug-in Deployment Example with Simultaneous Users
Remote Plug-in Multi-Version Support
Remote Plug-in Multi-Manifest Support
Choosing Extension Points for vSphere Client Plug-ins
Types of Extension Points in the vSphere Client
Remote Plug-in Manifest Example
Dynamic Extensions for Remote Plug-ins
Dynamic Extension Use Cases
How the vSphere Client Displays Dynamic Extensions
Caching Dynamic Extension Visibility
Configure Dynamic Extensions
Dynamic Extensions Filter Query
Example Code for Filtering Dynamic Extensions
vSphere Client Plug-in User Interface Modules
Bootstrapping the JavaScript API
vSphere Client JavaScript API: htmlClientSdk Interface
vSphere Client JavaScript API: Modal Interface
vSphere Client JavaScript API: Application Interface
vSphere Client JavaScript API: Event Interface
Example Using the modal API
Using Themes with vSphere Client Plug-ins
Using Style Variables in Plug-In CSS
Building Output Style Sheets for vSphere Client Plug-Ins
Configuring and Loading Theme Style Sheets in vSphere Client Remote Plug-Ins
Configuring Theme-Dependent Icons for vSphere Client Remote Plug-ins
Integrated Solution Installer for the vSphere Client
Conceptual Overview of the Preparation Process
Preparing a Solution OVF to Use the Integrated Solution Installer
Deployment with the Integrated Solution Installer
Integrated Installer Solution Metadata
Advanced Considerations for Remote Plug-in Servers
Registering Auxiliary Plug-in Servers
Auxiliary Server Data Paths
Communication Paths for Authentication in the Remote Plug-in Server
How to Delegate Session Authority to the Plug-in Server
Response Codes to session/clone-ticket Request
Best Practices for vSphere Client Remote Plug-ins
Best Practices for Implementing Plug-in Workflows
Best Practices for Localization
Best Practices for Deploying and Testing Remote Plug-ins
Additional Resources
Troubleshooting Remote Plug–ins for the vSphere Client
Plug-in Does Not Appear in vSphere Client
Wrong Plug-in URL
Troubleshooting: Plug-in Thumbprint Incorrect
Manifest Cannot Be Parsed
Wrong Plug-in Type
Plug-in Marked As Incompatible
Plug-in Registered with Incompatible Version
Plug-in View is missing in the vSphere Client
Missing Entry in the Instance Selector
Unable to Change Plug-in Manifest File
Troubleshooting: Problems with Registration Script in SDK
Plug-in Already Registered
Unable To Unregister Plug-in
Developing Local Plug-ins with the vSphere Client SDK
About This Book
Deprecation of Local Plug-in Architecture
Revision History
About the vSphere Web Client and the vSphere Client
Understanding the vSphere Client Architecture
Overview of the User Interface Layer Components
Understanding Extensibility in the vSphere Client
Extending the User Interface Layer
Concepts for Extending the User Interface Layer in the vSphere Client
Extending the Java Service Layer
About the vSphere Client
Knowledge Requirements for Using the vSphere Client SDK
SDK Versions and Compatibility
vSphere Client SDK Contents
vSphere Client SDK Setup
Software Requirements
Development Environment Requirements Overview
Setting Up for HTML-Based Plug-In Development
Set Up for Java Development
Automate the Plug-In Build Process
Download the vSphere Client SDK
Set Up the Eclipse Integrated Development Environment (optional)
Register Your Local vSphere Client with the vCenter Server Instance
Manual Registration of Local vSphere Client
Automated Registration of Local vSphere Client
Using the vSphere Client SDK Samples
Location of Sample Plug-in in the vSphere Client SDK
vSphere HTML SDK Sample
Build and Deploy the vSphere HTML SDK Sample Plug-in
Running the vSphere HTML SDK Sample
Creating a vSphere Client SDK Solution
Before Creating an HTML Plug-In
Create an HTML Plug-In Project
Contents of the HTML Plug-In Project Template
Building a Plug-In Package from the Project Template
Testing the Generated Plug-Ins
Deploy the Plug-In on a Local vSphere Client
Deploying Your Plug-In on a Remote vSphere Client
Extension Points in the vSphere Client
Global Extension Points
Object Navigator Extension Points
Object Workspace Extension Points
Actions Extension Points
Extension Templates
Custom Object Extension Points
Ordering Extensions
Filtering Extensions
Using the vSphere Client JavaScript API
vSphere Client JavaScript API: Modal Interface
vSphere Client JavaScript API: Application Interface
vSphere Client JavaScript API: Event Interface
Example Using the modal API
Using Themes with vSphere Client Plug-ins
Using Style Variables in Plug-In CSS
Building Output Style Sheets for vSphere Client Plug-Ins
Configuring and Loading Theme Style Sheets in vSphere Client Local Plug-Ins
Configuring Theme-Dependent Icons for vSphere Client Local Plug-ins
Developing HTML-Based User Interface Extensions
Overview
Global View Extensions
Extending the vCenter Object Workspace
Extending an Existing Object Workspace
Creating an Object Workspace for a Custom Object
Creating Extensions to the Summary Tab
Creating Data View Extensions
Creating Actions Extensions
Actions Framework Overview
Defining an Action Set
Defining Individual Actions for HTML-Based Action Extensions
Handling Actions for HTML-Based Action Extensions
Handling Locales
Guidelines for Creating Plug-Ins Compatible with the vSphere Client
Developing for the vSphere Client Service Layer
Developing Extensions to the Service Layer
Understanding the vSphere Client Data Service
Extending the Service Layer with Custom Components
Custom Component Types
Interfaces to the Service Layer
Communications with the Service Layer
Overview of Data Service Queries
When To Use Data Service Queries
RequestSpec Data Structure in Data Service Queries
ResultSet Data Structure in Data Service Queries
Extending the Data Service with a Data Service Adapter
Advantages of Providing a Data Service Adapter
Designing a Data Service Adapter
Processing Data Service Queries
Property Provider Adapters
Data Provider Adapters
DataProviderAdapter Interface
Resolving a Custom Target Object
Registering a Data Provider Adapter
Data Provider Adapter Example
Creating a Custom Java Service
Make Java Services Available to the UI Components in the vSphere Web Client and the vSphere Client
Creating the Java Interface and Classes
Persisting Data from Your Plug-Ins to the vCenter Server Appliance and the vCenter Server System
Packaging and Exposing the Service
Importing a Service in a User Interface Plug-In Module
Creating and Deploying Plug-In Packages
Plug-In Package Overview
XML Elements of the Plug-In Package Manifest File
Deploying a Plug-In Package
Plug-In Caching
Deploying a Plug-In Package From a Remote Server
Register a Plug-In Package as a vCenter Server Extension
Creating the vCenter ServerExtension Data Object
Verifying Your Plug-In Package Deployment
Redeploying Plug-ins During Development
Unregister a Plug-In Package
Best Practices for Developing Extensions for the vSphere Client
Best Practices for Creating Plug-In Packages
Best Practices for Plug-In Modules Implementation
Best Practices for Developing HTML-Based Extensions
Best Practices for Extending the User Interface Layer
Best Practices for Extending the Service Layer
OSGi-Specific Recommendations
DataService-Specific Best Practices
Best Practices for SSL Connections
Best Practices for Using VimPortType with JAX-WS
Best Practices for Deploying and Testing Your vSphere Client Extensions
VMware Guest SDK Programming Guide
Installing the Development Kit
What the Guest SDK Contains
Displaying vSphere Guest Library Statistics
Security of Remote RPC
Accessing HA Application Monitoring
Controlling the Application Monitoring Heartbeat
Library Path or Path Environment
Compiling the Sample Program on Linux
Compiling Sample Programs on Windows
Demonstrating the HA Application Monitoring API
The VM Guest Library
About the VM Guest Library
Supported Guest Operating Systems
Prerequisite LibC Version
Virtual Machine Statistics
How to Use the VM Guest API
VM Guest API Runtime Components
VM Guest API Data Types
VM Guest Library Functions
VM Guest API Error Codes
Tools for Extended Guest Statistics
Guest OS and Statistics Fetch
Prerequisites
Guest Statistics Interfaces
Guest SDK Library
Command Line Interface
Raw RPC interface
Fetching a List of Statistics
Metadata Fields
Metrics Examples
Fetch Available Statistics
Get Session Information
Host Hardware
CPU and Memory Statistics
Storage Statistics
Network Statistics
DataSets for Guest Management
About the DataSets Service
Use Cases for DataSets
Control Through vCenter Server
DataSets Transfer to ESXi Host
Access from Guest OS
DataSets Schema for Guest Access
In-Guest Communication Limits
vSphere HA Application Monitoring
About vSphere HA
Prerequisites for HA Application Monitoring
Using the HA Application Monitoring APIs
HA Application Monitoring API Functions
Code Sample for appmon.cpp
Calling the APIs from Your Application
HA Application Monitoring API Error Messages
Virtual Disk Development Kit (VDDK) Programming Guide
The Virtual Disk API and vSphere
Virtual Disk Library VixDiskLib
VDDK Components
Virtual Disk Library
Disk Mount Library
Virtual Disk Utilities
Backup and Restore on vSphere
Backup Design for vCloud Director
Use Cases for the Virtual Disk Library
Developing for VMware Platform Products
Managed Disk and Hosted Disk
Advanced Transports
VDDK and VADP Compared
Platform Product Compatibility
Redistributing VDDK Components
Installing the Development Kit
Prerequisites for VDDK and VADP
Programming Environments
Visual Studio on Windows
C++ and C on Linux
Java Development for VADP
VMware Platform Products
Storage Device Support
Installing the VDDK Package
Repackaging VDDK Libraries
How to Find VADP Components
Virtual Disk Interfaces
VMDK File Location
Virtual Disk Types
Persistence Disk Modes
VMDK File Naming
Thin Provisioned Disk
Internationalization and Localization
Grain Directories and Grain Tables
Data Structures in Virtual Disk API
Datastore-Level Access to VMDK
Credentials and Privileges for VMDK Access
Adapter Types
Virtual Disk Transport Methods
Local File Access
SAN Transport
HotAdd Transport
About the HotAdd Proxy
NBDSSL Transport
Asynchronous Mode NBDSSL
NFC Session Limits and Timeouts
SSL Certificates and Security
Virtual Disk API Functions
Virtual Disk Library Functions
Alphabetic Table of Functions
Start Up
Initialize the Library
Connect to a Workstation or Server
VMX Specification
Disk Operations
Create a New Hosted Disk
Open a Local or Remote Disk
Read Sectors From a Disk
Write Sectors To a Disk
Close a Local or Remote Disk
Get Information About a Disk
Free Memory from Get Information
Metadata Handling
Read Metadata Key from Disk
Get Metadata Table from Disk
Write Metadata Table to Disk
Check and Repair Sparse Disk Metadata
Disk Chaining and Redo Logs
Create Child from Parent Disk
Attach Child to Parent Disk
Opening in a Chain
Redo Logs and Linked Clone Backup
Cloning a Virtual Disk
Compute Space Needed for Clone
Clone a Disk by Copying Data
Error Handling
Return Error Description Text
Free Error Description Text
Administrative Disk Operations
Rename an Existing Disk
Grow an Existing Local Disk
Defragment an Existing Disk
Shrink an Existing Local Disk
Unlink Extents to Remove Disk
Shut Down
Disconnect from Server
Clean Up and Exit
Advanced Transport APIs
Initialize Virtual Disk API
Wildcards in SAN Allow and Deny Lists
How to Enable FIPS on VDDK Proxy VM
Phone Home Support
Location of Log Files
List Available Transport Methods
Connect to VMware vSphere
Get Selected Transport Method
Prepare For Access and End Access
SAN Mode on Linux Uses Direct Mode
Clean Up After Disconnect
Ordering of Function Calls in Sequence
Updating Applications for Advanced Transport
Algorithm for vSphere Backup
Backup and Recovery Example
Multithreading Considerations
Multiple Threads and VixDiskLib
Capabilities of Library Calls
Support for Managed Disk
Support for Hosted Disk
Virtual Disk API Sample Code
Compiling the Sample Program
Visual C++ on Windows
SLN and VCPROJ Files
C++ on Linux Systems
Makefile
Library Files Required
Usage Message
Walk-Through of Sample Program
Include Files
Definitions and Structures
Dynamic Loading
Wrapper Classes
Command Functions
DoInfo()
DoCreate()
DoRedo()
Write by DoFill()
DoReadMetadata()
DoWriteMetadata()
DoDumpMetadata()
DoDump()
DoTestMultiThread()
DoClone()
SSL Certificate Thumbprint
Practical Programming Tasks
Scan VMDK for Virus Signatures
Creating Virtual Disks
Create Local Disk
Create Remote Disk
Special Consideration for ESXi Hosts
VMDK File Versions
Working with Virtual Disk Data
Reading and Writing Local Disk
Reading and Writing Remote Disk
Deleting a Disk (Unlink)
Effects of Deleting a Virtual Disk
Renaming a Disk
Effects of Renaming a Virtual Disk
Managing Child Disks
Create Redo Logs
Virtual Disk in Snapshots
RDM Disks and Virtual BIOS
Restore RDM Disks
Restore the Virtual BIOS or UEFI
Interfacing With VMware vSphere
The VIX API
Virus Scan all Hosted Disk
The vSphere Web Services API
Virus Scan All Managed Disk
Read and Write VMDK Using vSphere API
First Class Disk (FCD) Backup
Container Storage Snapshot
VADP and VM Service Managed VMs
Datasets Backup and Restore
Backing Up Virtual Disks in vSphere
Design and Implementation Overview
The VADP Backup Process
Communicating With the Server
Information Containers as Managed Objects
More About Managed Objects
Managed Object References
Unique ID for a Different vCenter
Gathering Status and Configuration Information
PropertyCollector Data
Useful Property Information
Doing a Backup Operation
Prerequisites for Backup
Create a Temporary Snapshot on the Target Virtual Machine
Changed Block Tracking
Extract Backup Data from the Target Virtual Machine
Delete the Temporary Snapshot
Restore a Virtual Machine
Doing a Restore Operation
Prerequisites for Restore
Restore an Existing Virtual Machine to a Previous State
Create a New Virtual Machine
Access Files on Virtual Disks
More VADP Details
Low Level Backup Procedures
Communicate with the Server
The PropertyCollector
PropertyCollector Arguments
Getting the Data from the PropertyCollector
Identifying Virtual Disks for Backup and Restore
Creating a Snapshot
Backing Up a Virtual Disk
Deleting a Snapshot
Query Allocated Blocks Function
Changed Block Tracking on Virtual Disks
Enable Changed Block Tracking
Gathering Changed Block Information
CBT Enhancements in vSphere 7 and 8
Limitations on Changed Block Tracking
Low Level Restore Procedures
Restoring a Virtual Machine and Disk
Creating a Virtual Machine
Using the VirtualMachineConfigInfo
Editing or Deleting a Device
Restoring Virtual Disk Data
Raw Device Mapping (RDM) Disks
Restore Incremental Backup Data
Restore with Direct Connection to ESXi Host
Tips and Best Practices
Best Practices for HotAdd Transport
Best Practices for SAN Transport
Best Practices for NBD Transport
General Backup and Restore
Best Practice for Restore with Pre-existing Snapshot
Backup and Restore of Thin-Provisioned Disk
About Changed Block Tracking
Configure SCSI Controllers in Proxy VM
Encrypted VM Backup and Restore
Backup and Restore With vTPM
Windows Backup Implementations
Deactivate Automount in Windows Proxy
Security and Remote Desktop
Working with Microsoft Shadow Copy
Enable Virtual Machine Application Consistent Quiescing
Application-Consistent Backup and Restore
New VSS Support Added in vSphere 6.5
The VMware VSS Implementation
Linux Backup Implementation
Backing Up vApps in vCloud Director
Tenant vApps in VMware Cloud
Prerequisites
Other Information
Conceptual Overview
The Backup Process
The Restore Process
Use Cases Overview
Managing Credentials
Finding a vApp
Inventory Traversal
Using the Query Service
Protecting Specified vApps
Recovering an Older Version of a vApp
Recovering a Deleted vApp
Recovering a Single Virtual Machine
Backing Up vCloud Director
vCloud API Operations
Getting Access to vCloud Director
Inventory Access
Admin Views
Admin Extensions
Retrieving Catalog information
Retrieving vApp Configuration
Methods To Retrieve vApp Configuration
Virtual Machine Information
Preventing Updates to a vApp During Backup or Restore
Associating vCloud Resources with vSphere Entities
Restoring vApps
Conclusion for vApp Backup
Virtual Disk Mount API
The VixMntapi Library
Types and Structures
Operating System Information
Disk Volume Information
Function Calls
VixMntapi_Init()
VixMntapi_Exit()
VixMntapi_OpenDiskSet()
VixMntapi_OpenDisks()
VixMntapi_GetDiskSetInfo()
VixMntapi_FreeDiskSetInfo()
VixMntapi_CloseDiskSet()
VixMntapi_GetVolumeHandles()
VixMntapi_FreeVolumeHandles()
VixMntapi_GetOsInfo()
VixMntapi_FreeOsInfo()
VixMntapi_MountVolume()
VixMntapi_DismountVolume()
VixMntapi_GetVolumeInfo()
VixMntapi_FreeVolumeInfo()
Programming with VixMntapi
File System Support
Diagnostic Logging for VixMntapi
Read-Only Mount on Linux
Sample VixMntapi Code
Restrictions on Virtual Disk Mount
Error Codes and Open Source
Recent Changes
Finding Error Code Documentation
Association With VIX API Errors
Interpreting Error Codes
Troubleshooting Dynamic Libraries
Troubleshooting Changed Block Tracking (CBT)
Open Source Components
HTML Console SDK Programming Guide
The VMware HTML Console
Architecture of the HTML Console
Compared to Other VMware Consoles
Getting Started with the HTML Console SDK
Download and Install
Steps to Start a Console
Sample Javascript Code
The Create WebMKS Method and Options
createMKS Parameters
createMKS Options
Handling Events with the HTML Console
Event Binding in jQuery
Setting the Event Handler
Copy from Remote Desktop
HTML Console SDK Methods
General API Methods
Lifecycle API Methods
Display API Methods
Full Screen API Methods
Input API Methods
Mobile API Methods
setOption API Method
Event Handler API Methods
WMKS Constants
Javascript Key Codes
Getting Started with ESXCLI
Overview of ESXCLI
Using ESXCLI for Host Management
ESXCLI Syntax
Running ESXCLI Commands
ESXCLI Command Support When Host and ESXCLI Versions Do Not Match
Installing ESXCLI
Installing and Uninstalling ESXCLI
Install ESXCLI
Uninstall ESXCLI
Running Host Management Commands in the ESXi Shell
ESXi Shell Access with the Direct Console
Enabling Local ESXi Shell Access
Enable the ESXi Shell in the Direct Console
Enable the ESXi Shell from the vSphere Client
ESXi Shell Timeout
Use the Local ESXi Shell
Remote ESXi Shell Access with SSH
Enable SSH Access in the Direct Console
Enable SSH from the vSphere Client
Access the Remote ESXi Shell with SSH
Lockdown Mode
Run an ESXCLI Command in the ESXi Shell
Running ESXCLI Host Management Commands
Overview of Running ESXCLI Host Management Commands
Targeting the Host Directly
Targeting a Host That is Managed by a vCenter Server System
Protecting Passwords
Order of Precedence for ESXCLI Host Management Commands
Authenticating Through vCenter Server and vCenter Single Sign-On
Authenticating Directly to the Host
Using Environment Variables
Using a Configuration File
Using Command-Line Options
Using the Microsoft Windows Security Support Provider Interface
ESXCLI and Lockdown Mode
Trust Relationship Requirement for ESXCLI Commands
Download and Install the vCenter Server Certificate
Using the --cacertsfile Option
Using the --thumbprint Option
Connection Options for ESXCLI Host Management Command Execution
Using ESXCLI Commands in Scripts
Run Host Management Commands from a Windows System
Run Host Management Commands from a Linux System
ESXCLI Concepts and Examples
ESXCLI Commands Overview
Introduction to ESXCLI
Targets and Protocols for ESXCLI Host Management Commands
ESXCLI Commands Available on Different ESXi Hosts
Trust Relationship Requirement for ESXCLI Commands
Download and Install the vCenter Server Certificate
Using the --cacertsfile Option
Using the --thumbprint Option
Using ESXCLI Output
Connection Options for ESXCLI Host Management Commands
ESXCLI Host Management Commands and Lockdown Mode
Managing Hosts
Stopping and Rebooting Hosts with ESXCLI
Enter and Exit Maintenance Mode with ESXCLI
Manage Modules with ESXCLI
Retrieve Information about Components, Base Image, and Add-On on a Host with ESXCLI
Manage Components with ESXCLI
Manage Base Images and Add-Ons with ESXCLI
Updating Hosts
Configuring the GuestStore Repository with ESXCLI
Set the GuestStore Repository with ESXCLI
Clear the GuestStore Repository Setting with ESXCLI
Managing Files
Introduction to Virtual Machine File Management
Managing VMFS Volumes
Managing Duplicate VMFS Datastores
Mounting Datastores with Existing Signatures
Mount a Datastore with ESXCLI
Resignaturing VMFS Copies
Resignature a VMFS Copy with ESXCLI
Reclaiming Unused Storage Space
Managing Storage
Introduction to Storage
How Virtual Machines Access Storage
Datastores
Storage Device Naming
Examining LUNs
Target and Device Representation
Examining LUNs with ESXCLI
Detach a Device and Remove a LUN
Reattach a Device
Working with Permanent Device Loss
Removing a PDL LUN
Reattach a PDL LUN
Managing Paths
Multipathing with Local Storage and FC SANs
Listing Path Information with ESXCLI
Disable a Path with ESXCLI
Managing Path Policies
Multipathing Considerations
Change the Path Policy with ESXCLI
Set Policy Details for Devices that Use Round Robin
Scheduling Queues for Virtual Machine I/O
Managing NFS/NAS Datastores
Capabilities Supported by NFS/NAS
Manage a NAS File System with ESXCLI
Monitor and Manage FibreChannel SAN Storage
Monitoring and Managing vSAN Storage
Retrieve vSAN Information
Manage a vSAN Cluster
Add and Remove vSAN Storage
Monitoring vSphere Flash Read Cache
Monitoring and Managing Virtual Volumes
Configuring FCoE Adapters
Scanning Storage Adapters
Retrieving SMART Information
Managing iSCSI Storage
iSCSI Storage Overview
Discovery Sessions
Discovery Target Names
Protecting an iSCSI SAN
Protecting Transmitted Data
Securing iSCSI Ports
Setting iSCSI CHAP
Command Syntax for esxcli iscsi
esxcli iscsi Command Syntax
Key to esxcli iscsi Short Options
iSCSI Storage Setup with ESXCLI
Set Up Software iSCSI with ESXCLI
Set Up Dependent Hardware iSCSI with ESXCLI
Set Up Independent Hardware iSCSI with ESXCLI
Listing and Setting iSCSI Options
Listing iSCSI Options with ESXCLI
Setting MTU with ESXCLI
Listing and Setting iSCSI Parameters
Listing and Setting iSCSI Parameters with ESXCLI
Returning Parameters to Default Inheritance with ESXCLI
Enabling iSCSI Authentication
Enable iSCSI Authentication with ESXCLI
Enable Mutual iSCSI Authentication with ESXCLI
Set Up Ports for iSCSI Multipathing
Managing iSCSI Sessions
Introduction to iSCSI Session Management
Listing iSCSI Sessions
Logging in to iSCSI Sessions
Removing iSCSI Sessions
Managing Third-Party Storage Arrays
Managing NMP with esxcli storage nmp
Device Management with esxcli storage nmp device
Listing Paths with esxcli storage nmp path
Managing Path Selection Policy Plug-Ins with esxcli storage nmp psp
Fixed Path Selection Policy Operations
Customizing Round Robin Setup
Managing SATPs
Path Claiming with esxcli storage core claiming
Using the Reclaim Troubleshooting Command
Unclaiming Paths or Sets of Paths
Managing Claim Rules
Change the Current Claim Rules in the VMkernel
Adding Claim Rules
Removing Claim Rules
Listing Claim Rules
Loading Claim Rules
Moving Claim Rules
Load and Apply Path Claim Rules
Running Path Claim Rules
Managing Users
Users in the vSphere Environment
Assigning Permissions with ESXCLI
Managing Virtual Machines
Forcibly Stop a Virtual Machine with ESXCLI
Managing vSphere Networking
Introduction to vSphere Networking
Networking Using vSphere Standard Switches
Networking Using vSphere Distributed Switches
Retrieving Basic Networking Information
Troubleshoot a Networking Setup
Setting Up vSphere Networking with vSphere Standard Switches
Setting Up Virtual Switches and Associating a Switch with a Network Interface
Retrieving Information About Virtual Switches with ESXCLI
Adding and Deleting Virtual Switches
Adding and Deleting Virtual Switches with ESXCLI
Setting Switch Attributes with ESXCLI
Managing Port Groups with ESXCLI
Connecting and Disconnecting Uplink Adapters and Port Groups with ESXCLI
Setting the Port Group VLAN ID with ESXCLI
Managing Uplink Adapters
Manage Uplink Adapters with ESXCLI
Specifying Multiple Uplinks with ESXCLI
Linking and Unlinking Uplink Adapters with ESXCLI
Adding and Modifying VMkernel Network Interfaces
Managing VMkernel Network Interfaces with ESXCLI
Add and Configure an IPv4 VMkernel Network Interface with ESXCLI
Add and Configure an IPv6 VMkernel Network Interface with ESXCLI
Managing Standard Networking Services in the vSphere Environment
Setting the DNS Configuration with ESXCLI
Set Up a DNS Server with ESXCLI
Modify DNS Setup for a Preconfigured Server with ESXCLI
Setting Up IPsec
Using IPsec with ESXi
Managing Security Associations
Managing Security Policies
Manage the ESXi Firewall
Monitor VXLAN
Monitoring ESXi Hosts
Managing Diagnostic Partitions
Managing Core Dumps
Manage Local Core Dumps with ESXCLI
Manage Core Dumps with ESXi Dump Collector
Configuring ESXi Syslog Services
Managing ESXi SNMP Agents
Configuring SNMP Communities
Configuring the SNMP Agent to Send Traps
Configure a Trap Destination with ESXCLI
Retrieving Hardware Information
Managing Security
Configuring and Managing the Audit System and Audit Data
Enable Local Auditing with ESXCLI
Enable the Transmission of Audit Records to a Remote Host with ESXCLI
Manage CA Certificates with ESXCLI
Configuring the Cryptographic Functionality
Configuring Virtual Machine Access to Physical Devices
Managing Configuration Settings
Sticky Bit Configuration Files
Namespaces from esx.conf
OVF Tool User Guide
VMware OVF Tool
The Open Virtualization Format
The OVF Standard
Benefits of OVF
Using the VMware OVF Tool
VMware Platforms Using the OVF Standard
Setting Up the OVF Tool
OVF Tool Highlights
Examples of OVF Tool Use
Importing and Exporting OVF Using vSphere Client
VMware OVF Tool Delta Disk Facilities
Using OVF Tool Commands
Definitions and Command Syntax
Run VMware OVF Tool From the Command Line
Run OVF Tool With ESXi and vCenter Target Locations
Deploy a Virtual Machine to Static DVS Port Group
Command-Line Options
Creating and Using the VM ID
Specifying Disk ID to Set Size
Specifying the Storage Profile ID
More Help Topics
Using the Log Settings
Specifying a Locator
File Locators
URL File or Web Syntax
vSphere Locators
vCloud Director Locators
Partial Locators
Configuration Files
Handling Authentication
Launching the OVF Tool as a Helper Process
Examples of OVF Tool Syntax
Supported File Types and Package Formats
Changing File or Package Formats
Converting an OVF Package to an OVA Archive
Converting an OVA Archive to OVF Package
Converting VMX Format to an OVF Package
Converting VMX Format to an OVA Archive
Converting an OVA Archive to VMX Format
Converting an OVF Package to VMX Format
Installing an ESXi host from an OVF Package
Installing an ESXi host from an OVF Package on a Web Server
Installing an ESXi host or Adding Files from a VMX Format
Installing a vCenter Server or Adding Files from an OVF Package
Converting a VM on ESXi or vCenter Server to an OVF Package
Installing vCenter Server from an OVF Package Using an Inventory Path
Setting OVF Package Properties
Setting OVF Properties When Deploying to vSphere or vCloud Director
Setting OVF Network Maps When Deploying to vSphere
Setting a vService Dependency
Modifying an OVF Package
Renaming the OVF Package
Omitting Disks in the VMware OVF Tool Output
Compressing an OVF Package
Chunking or Splitting OVF Packages
TPM as a Virtual Device in OVF
Deploying OVF Packages
Deploying an OVF Package Directly on an ESXi Host
Deploying an OVF Package using Pull Mode
Deploying an OVF Package through vCenter Server
Deploying an OVF Package and Powering It On
Deploying an OVF Package into vCloud Director
Deploying an OVF Package into a vApprun Workspace
Importing an OVF Package
Importing an OVF File into a vCloud instance
Importing a Virtual Machine from vSphere to vCloud
Importing VMX Files into a vApprun Workspace
Exporting Virtual Machines to OVF Packages
Exporting a Virtual Machine from a vCloud instance to an OVF Package
Exporting a Running Virtual Machine or vApp from vSphere
Exporting a vApprun Entity to an OVF Package
Displaying Summary Information
Validating an OVF 1.0 or OVF 1.1 Descriptor
Downloading an OVF Package from a Protected Web Site
Using a Proxy
Overwriting a Running Virtual Machine or vApp from vSphere
Canceling the VMware OVF Tool While it Is Running
OVF Package Signing
Publishing an OVF Package with a Digital Signature
Creating an RSA Public/Private Key Pair and Certificate
Signing an OVF Package
Validating an OVF Package
Using OVF Tool Probe Mode
About OVF Tool Probe Mode
Example of Probe Mode
Using OVF Tool Machine Mode
About Machine Mode
Running Machine Output
Running machineOutput in Probe Mode
Running machineOutput in Validate Host Mode
Running machineOutput in Import to vSphere Mode
Running the Machine Mode Export from vSphere Operation
Example Output
Output from Running machineOutput in Probe Mode
Output from Running machineOutput in Validate Host Mode
Output from Running machineOutput in Import Mode
Output from Running machineOutput in Export Mode
Documentation Legal Notice
Installing ESXCLI
Last Updated December 16, 2024
You can install ESXCLI on a Linux, Microsoft Windows, or a macOS system.
Getting Started with ESXCLI
Installing and Uninstalling ESXCLI
Content feedback and comments