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 6.7
OVF Tool User’s Guide
Examples of OVF Tool Syntax
Setting OVF Package Properties
VMware vSphere SDKs and Tools 6.7
Version 6.7
8.0
7.0
6.7
6.5
Open/Close Topics Navigation
Product Menu
Topics
Release Notes
vSphere Web Services SDK Developer’s Setup Guide
About the vSphere Web Services SDK
Knowledge Required for Using the vSphere Web Services SDK
Programming Languages Supported by the vSphere Web Services SDK
Types of Applications That You Can Build Using This SDK
Downloading the vSphere Web Services SDK
Configurations for Sample Authentication with Single Sign-On
vSphere Web Services SDK Package Contents
SDK Versions and VMware vSphere Product Compatibility
Setting Up for Java Development
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
Setting Up for Microsoft C# Development
C# Development Requirements for the Web Services SDK
Software Downloads for C# Development with the Web Services SDK
Setting Up for C# Development with the Web Services SDK
Set Up a Development Workstation To Use C# with the Web Services SDK
Building the C# SSO DLL for the Web Services SDK
Build the C# SSO DLL with the Web Services SDK
Building the C# vSphere DLLs with the Web Services SDK
Build the C# vSphere DLLs for the Web Services SDK
Building the C# Sample Programs in the Web Services SDK
Running the Microsoft .NET C# Version of SimpleClient in the Web Services SDK
Run the SimpleClient C# application
Troubleshooting the Setup of the Web Services SDK
Proxy Server Connection Problem with the Web Services API
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
VMware vSphere and 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 API 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 and C# 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 C#
vCenter Server Single Sign On Session Using C#
Persistent vCenter Server Sessions
Sample Code
Using LoginByToken in C#
LoginByTokenSample Constructor in a C# Web Services SDK Client
Security Policies in a C# Web Services SDK Client
Custom Security Assertion in a C# Web Services SDK Client
Custom Output Filter for a C# Web Services SDK Client
Login for a C# Web Services SDK Client
Session Handling in C# Web Services Client
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 and C# Sample Applications in the Web Services SDK
Java Samples in the Web Services SDK
C# Samples in the Web Services SDK
Helper Classes for C# Sample Applications in the Web Services SDK
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 Object Selection
vSphere Data Objects for Property Collection
vSphere Methods for Property Collection
Retrieve Properties with the PropertyCollector
Simple 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 (WaitForUpdatesEx)
Property Filters
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 Reference
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 Reference
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
Creating Virtual Machine Templates
Cloning a Virtual Machine
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
CPU and Memory Resource Allocation
CPU and Memory Modification for Running Virtual Machines
Number of CPUs
CPU Processors and Memory Affinity
CPU Features
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
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
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
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 Encryption APIs
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 Using Different Keys
Recrypting 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
Virtual Applications
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
Resource Pool Management Guidelines
Cluster Overview
Creating and Configuring Resource Pools
Understanding Expandable Reservation
Expandable Reservation Example 1
Expandable Reservation Example 2
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
Gathering Data with a ViewManager Object
Task Monitoring Example Using the ListView Object
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 Reference
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 Reference
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 Reference
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 VMware Infrastructure 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 (/host)
Update Package Access (/tmp)
Privilege Requirements for HTTP Access
Sample Program Overview
Java Sample Programs (JAXWS Bindings)
C# Sample Programs
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
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
CIM SMASH/Server Management API Programming Guide
Introduction to the CIM SMASH/Server Management API
Platform Product Support for the CIM API
Supported Protocols and Versions for the CIM API
CIM Version
SMASH Version for the CIM API
Supported Profiles for the CIM API
CIM and SMASH Resources Online
Installing CIM Provider VIBs
Download CIM Provider VIBs
Add a CIM Provider VIB to your ESXi Image
Adjust the Resource Pool Allocation for CIM Providers
Developing Client Applications for the CIM API
CIM Server Ports
CIM Object Namespaces
Crossing Between Namespaces
Determining the Namespaces in Your Installation
WS-Management Resource URIs
Locating a Server with SLP
CIM Ticket Authentication
Active Directory Authentication on ESXi
Make a Connection to the CIMOM
Listing Registered Profiles in the CIM Implementation
List Registered CIM Profiles
Identifying the Base Server Scoping Instance
Identify the Base Server Scoping Instance
Mapping Integer Property Values to Strings
Using the Web Services for Management Perl Library
Using the CIM Object Space
Report Manufacturer, Model, and Serial Number
Report Manufacturer, Model, and Serial Number By Using Only the Implementation Namespace
Report the BIOS Version
Reporting Installed VIBs
Installing VIBs
Monitor VIB Installation
Monitor State of All Sensors
Monitor State of All Sensors By Using Only the Implementation Namespace
Report Fan Redundancy
Report CPU Cores and Threads
Report Empty Memory Slots By Using Only the Implementation Namespace
Report the PCI Device Hierarchy By Using Parent DeviceIDs
Report the Path to a PCI Device By Using PortGroups
Monitor RAID Controller State
Monitor State of RAID Connections
Report Accessible Storage Extents
Report Storage Extents Without Third-Party Storage Provider
Work with the System Event Log
Subscribe to Indications
Troubleshooting CIM Connections
Connections from Client to CIM Server
Using SLP
Using a Web Browser
Using a Command-Line Interface
Verifying User Authentication Credentials
Rebooting the Server
Using Correct Client Samples
Using Other CIM Client Libraries
Using the WS-Management Library
Connections from CIM Server to Indication Consumer
Firewall Configuration
System Event Log
Creating Offline Bundles
Create an Offline Bundle With VMware vSphere PowerCLI
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 (.NET)
vCenter Single Sign-On Token Request Overview
vCenter Single Sign-On C# Sample Code
Send a Request for a Security Token with C#
Solution Certificate Support for the vCenter Single Sign-On Server
LoginByToken Example (.NET)
vCenter Server Single Sign-On Session
Persistent vCenter Server Sessions with LoginByToken
Sample Code for LoginByToken
Using LoginByToken
LoginByTokenSample Constructor for the vCenter Single Sign-On SDK
SAML Token Acquisition
SAML Token Security Policies
Connection and Login Code for a vCenter Single Sign-On Client
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
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
Introduction to vSphere Solution Development
Overview of the vSphere Extension APIs
Introducing the
Standard Tabs in the
Introducing vSphere ESX Agents and Agencies
Introducing
Introducing vServices
Introducing
Introducing the vCenter Extension vService
Demonstrating and vSphere ESX Agent Manager
Functions of the EAM Sample Solution
Run the EAM Sample Solution
Download the vSphere ESX Agent Manager SDK
Contents of the ESX Agent Manager SDK
Set up and Start the EAM Sample Solution
View the EAM Sample Solution in
Configure the Virtual Infrastructure for ESX Agent Deployment
Deploy ESX Agents from OVF Using the EAM Sample Solution
Monitor and Manage the Sample ESX Agency and Agent
Deploy ESX Agents and a VIB Using the EAM Sample Solution
Modifying the EAM Sample Solution
Rebuild and Redeploy the EAM Sample Solution
Creating vSphere Solutions
Contents and Structure of an Extension
Key Objects in the vSphere API for Extension and Solution Development
Register an Extension with
Create the Program that Manages the Extension
Connect the Extension to
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
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
Integrating Solutions with
SDK Objects for Integration with
Properties of the Extension Data Object That Relate to the
Data Objects
How do I integrate a solution with
Add a Solution to
Set the Icon for a Type of Virtual Machine or vApp That an Extension Manages
Add Tabs to the EAM Sample Solution
Set Up Health Monitoring for a Solution
Solution Health XML Schema
Integrating Solutions with vSphere ESX Agent Manager
Benefits of Integrating Solutions with ESX Agent Manager
Overview of 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 Integrating a Solution with ESX Agent Manager
Authenticating Against ESX Agent Manager
Availability of ESX Agent Virtual Machines
Monitoring and Resolving ESX Agent Issues
Remediation of Issues by ESX Agent Manager
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
Integrating 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 By Using the vCenter Extension vService
vCenter Extension vService XML Schema
VMware vSphere Automation SDKs Programming Guide
Introduction to the vSphere Automation SDKs
vSphere Automation SDKs Overview
Supported Programming Languages
Components of the vSphere Automation Virtualization Layer
Components and Services of a Virtual Environment
vSphere Deployment Configurations
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
.NET Example of Connecting to the Lookup Service and Retrieving a 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
.NET Example of Retrieving a Service Endpoint on a vCenter Server Instance
Python Example of Retrieving a Service Endpoint on a vCenter Server Instance
Perl Example of Retrieving a Service Endpoint from Multiple vCenter Server instances
Retrieve a vCenter Server ID by Using the Lookup Service
Java Example of Retrieving a vCenter Server ID by Using the Lookup Service
.NET 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
Perl Example of Retrieving a ID By Using the Lookup Service
Retrieve a vSphere Automation Endpoint on a vCenter Server Instance
Java Example of Retrieving a vSphere Automation Endpoint on a vCenter Server Instance
.NET 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
Perl Example of Retrieving a vSphere Automation Endpoint on a Instance
Authentication Mechanisms
Retrieve a SAML Token
Java Example of Retrieving a SAML Token
.NET Example of Retrieving a SAML Token
Python Example of Retrieving a SAML Token
Perl 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
.NET 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
Perl Example of Creating a vSphere Automation API Session with a SAML Token
Create a vSphere Automation Session with User Credentials
Java Example of Creating a vSphere Automation API Session with User Credentials
Create a Web Services Session
Python Example of Creating a Web Services Session
Perl Example of Creating a Web Services Session
Accessing vSphere Automation Services
Access a vSphere Automation Service
Java Example of Accessing a vSphere Automation Service
Content Library Service
Content Library Overview
Content Library Types
Content Library Items
Content Library Storage
Java Example of Storing Library Content on a Datastore
.NET Example of Storing Library Content on a Datastore
Python Example of Storing Library Content on a Datastore
Perl Example of Storing Library Content on a Datastore
Querying Content Libraries
Listing All Content Libraries
Java Example of Retrieving a List of All Content Libraries
.NET Example of Retrieving a List of All Content Libraries
Python Example of Retrieving a List of All Content Libraries
Perl Example of Retrieving a List of All Content Libraries
Listing Content Libraries of a Specific Type
List Content Libraries by Using Specific Search Criteria
Java Example of Retrieving a List of All Local Libraries with a Specific Name
.NET Example of Retrieving a List of All Local Libraries with a Specific Name
Python Example of Retrieving a List of All Local Libraries with a Specific Name
Perl Example of Retrieving a List of All Local Libraries with a Specific Name
Content Libraries
Create a Local Content Library
Java Example of Creating a Local Library
.NET Example of Creating a Local Content Library
Python Example of Creating a Local Content Library
Perl Example of Creating a Local Content Library
Publish an Existing Content Library
Java Example of Publishing an Existing Content Library
.NET Example of Publishing an Existing Local Library
Python Example of Publishing an Existing Content Library
Perl Example of Publishing an Existing Content Library
Publish a Library at the Time of Creation
Subscribe to a Content Library
Java Example of Subscribing to a Published Library
.NET Example of Subscribing to a Published Library
Python Example of Subscribing to a Published Library
Perl Example of Subscribing to a Published Library
Synchronize a Subscribed Content Library
Editing the Settings of a Content Library
Removing the Content of a Subscribed Library
Delete a Content Library
Library Items
Create an Empty Library Item
Java Example of Creating a Library Item
.NET Example of Creating a Library Item
Python Example of Creating a Library Item
Perl Example of Creating an Empty Library Item
Querying Library Items
List Library Items
List Library Items That Match Specific Criteria
Edit the Settings of a Library Item
Java Example of Changing the Settings for a Library Item
.NET Example of Changing the Settings for a Library Item
Python Example of Changing the Settings for a Library Item
Perl Example of Changing the Settings of a Library Item
Upload a File from a Local System to a Library Item
Java Example of Uploading Files to a Library Item from a Local System
.NET Example of Uploading Files to a Library Item from the Local System
Python Example of Uploading Files to a Library Item from a Local System
Upload a File from a URL to a Library Item
Java Example of Uploading a File from a URL to a Library Item
.NET Example of Uploading a File from a URL to a Library Item
Python Example of Uploading a File from a URL to a Library Item
Perl Example of Uploading a File from a URL to a Library Item
Download Files to a Local System from a Library Item
Java Example of Downloading Files from a Library Item to Your Local System
.NET Example of Downloading Files from a Library Item to Your Local System
Python Example of Downloading Files from a Library Item to Your Local System
Perl Example of Downloading Files from a Library Item to Your Local System
Synchronizing a Library Item in a Subscribed Content Library
Removing the Content of a Library Item
Deleting a Library Item
Create a VM Template Library Item in a Local Content Library
Python Example of Creating a VM Template Content Library Item
Deploy a Virtual Machine from a VM Template Library Item
Python Example of Deploying a VM from a VM Template Library Item
Content Library Support for OVF and OVA Packages
Using the Content Library Service to Handle OVF and OVA Packages
Upload an OVF 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 Package from a Local File System to a Library Item
Python Example of Uploading an OVF Package to a Library Item from Your Local File System
Upload an OVA Package to a Library Item
Python Example of Uploading an OVA Package to a Library Item
Using the LibraryItem Service to Execute OVF-Specific Tasks
Deploy a Virtual Machine or Virtual Appliance from an OVF Package 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
Create an OVF Package in a Content Library from a Virtual Machine
Java Example of Creating an OVF Package in a Content Library from a Virtual Machine
Python Example of Creating an OVF Package in a Content Library from a Virtual Machine
Tagging Service
Creating Tags
Creating a Tag Category
Java Example of Creating a Tag Category
.NET Example of Creating a Tag Category
Python Example of Creating a Tag Category
Perl Example of Creating a Tag Category
Creating a Tag
Java Example of Creating a Tag
.NET Example of Creating a Tag
Python Example of Creating a Tag
Perl Example of Creating a Tag
Creating Tag Associations
Assign the Tag to a Content Library
Java Example of Assigning a Tag to a Content Library
.NET Example of Assigning a Tag to a Content Library
Python Example of Assigning a Tag to a Content Library
Assign a Tag to a Cluster
Java Example of Assigning a Tag to a Cluster
Python Example of Assigning a Tag to a Cluster
Perl Example of Assigning a Tag to a Cluster
Updating a Tag
Java Example of Updating a Tag Description
.NET Example of Updating a Tag Description
Python Example of Updating a Tag Description
Virtual Machine Configuration and Operations
Filtering Virtual Machines
Java Example of Filtering Virtual Machines
Python Example of Filtering Virtual Machines
Create a Virtual Machine
Java Example of Creating a Basic Virtual Machine
Python Example of Creating a Basic Virtual Machine
Configuring a Virtual Machine
Name and Placement
Java Example of Configuring the Name and Placement of a Virtual Machine
Python Example of Configuring the Placement of a Virtual Machine
Boot Options
Java Example of Configuring the Boot Options of a Virtual Machine
Python Example of Configuring the Boot Options
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
Performing Virtual Machine Power Operations
Java Example of Powering On a Virtual Machine
Python Example of Powering On a Virtual Machine
.NET Example of Powering On a Virtual Machine
Managing Certificates
HTTP Requests for Certificate Management
cURL Examples of Certificate Management Operations
VMware Appliance Management Programming Guide
Introduction to the and APIs
About vSphere
About ESXi
vCenter Server Appliance Management Overview
Limitations of Programming for the
API Endpoints for Managing the
Supplementing the vCenter Server Appliance API
Direct Console User Interface to the
vCenter Server Appliance Management Interface
Appliance Shell and the
and the
DCLI and the
Quick Start with vCenter Server Appliance APIs
Programming Environment
Services
Platform Services in the Environment
vSphere Deployment Configurations
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
Python Example of Connecting to the Lookup Service and Retrieving a Service Registration Object
Retrieve Service Endpoints on vCenter Server Instances
Python Example of Retrieving Service Endpoints on vCenter Server Instances
Retrieve 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 Endpoint on a vCenter Server Instance
Python Example of Retrieving a vSphere Automation Endpoint on a vCenter Server Instance
Authentication Mechanisms
User Name and Password Authentication for the
Authenticate with Credentials and Create a Session
JavaScript Example of Creating a vSphere Automation API Session with vCenter Single Sign-On Credentials
Java Example of Creating a vSphere Automation API Session with User Credentials
Python Example of Creating a vSphere Automation API Session with SSO Credentials
Token Authentication for the
Retrieve a SAML Token
JavaScript Example of Retrieving 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
JavaScript Example of Creating a vSphere Automation API 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
Authorization Model for Administration of the
Authorization Model Mapping to the vCenter Single Sign-On Domain
Using the Appliance Operator Role
Using the Appliance Admin Role
Using the Appliance SuperAdmin Role
Installing, Upgrading, and Converging the and Appliance
Install Stage 2
Setting Up a Newly Installed Appliance
HTTP Requests for Install Stage 2
Use HTTP Requests to Set Up a Newly Deployed with an Embedded
Use HTTP Requests to Set Up a Newly Deployed Appliance
Use HTTP Requests to Set Up a Newly Deployed with an External
Workflows and Class Diagrams for Install Stage 2
Upgrade Stage 2
Upgrading the and Appliance
HTTP Requests for Upgrade Stage 2
Workflows and Class Diagrams for Upgrade Stage 2
Historical Data Transfer
Deferred Import
HTTP Status Codes
Historical Data Import Errors
Class Diagrams and Workflows for Deferred Import
Use the Deferred Import Sample
Python Example of Pausing and Resuming the Deferred Import Process
Converging a with an External to a with an Embedded
HTTP Requests for Convergence Operations
Converging Nodes
Decommissioning Nodes
Converge to an Embedded Node
Python Example of Converging a with an External
Decommission the External Node
Python Example of Decommissioning an External
Monitoring the
Health Monitoring of the
Check Overall System Health of the
JavaScript Example of Checking Overall System Health of the
Python Example of Checking the Overall System Health of the vCenter Server Appliance
Capacity Monitoring of the
Frequency and Retention of Statistics Collection in the
Nature of Statistics in the vCenter Server Appliance
Requesting Statistics from the vCenter Server Appliance
Statistics Collection Times
Statistics Interval Adjustment in the
Empty Data Values
Check Database Usage in the
JavaScript Example of Checking Database Usage in the
Python Example of Checking Database Usage in the
List Storage Consumption By Data Type in the
JavaScript Example of Listing Storage Consumption By Data Type in the
Python Example of Listing Storage Consumption By Data Type in the
Maintenance of the
Backing up the
Backup and Restore Protocols for the
Calculate the Size Needed To Store the Backup File
Bash Example of Calculating the Size Needed To Store the Backup File
Python Example of Calculating the Size Needed To Store the Backup Image
Back up a by Using the API
Bash Example of Backing up the Instance
Python Example of Backing Up a vCenter Server Appliance
Schedule a Backup Job
Python Example of Scheduling a Backup Job
Restoring the
Authentication When Restoring the
Availability of Services While Restoring the
Restore the by Using the API
Bash Example of Restoring the Instance
Python Example of Restoring the vCenter Server Instance
Reconcile a Instance with Nodes in Embedded Linked Mode
Managing System Logs
Configuring Syslog Forwarding
HTTP Requests for Configuring Syslog Forwarding
Python Example of Configuring Syslog Forwarding
Updating the
Applying Software Updates
Software Update Workflow
cURL Examples of Performing Software Update Operations
Virtual Disk Development Kit Programming Guide
Introduction to the Virtual Disk API
About the Virtual Disk API
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
Development Systems
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
Virtual Disk Internal Format
Grain Directories and Grain Tables
Data Structures in Virtual Disk API
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
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
Backing Up Virtual Disks in vSphere
Design and Implementation Overview
The 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
New Query Allocated Blocks Function
Changed Block Tracking on Virtual Disks
Enable Changed Block Tracking
Gathering Changed Block Information
Troubleshooting
Limitations on Changed Block Tracking
Checking for Namespace
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 SAN Transport
Best Practices for HotAdd Transport
Best Practices for NBDSSL Transport
General Backup and Restore
Backup and Restore of Thin-Provisioned Disk
About Changed Block Tracking
HotAdd and SCSI Controller IDs
Encrypted VM Backup and Restore
Backup and Restore With vTPM
Windows Backup Implementations
Disable 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
Introduction to Tenant vApps
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
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
Errors Codes and Open Source
Recent Changes
Finding Error Code Documentation
Association With VIX API Errors
Interpreting Errors Codes
Troubleshooting Dynamic Libraries
Open Source Components
vSphere SDK for Perl Installation Guide
Installing vSphere SDK for Perl
Installation Overview
Overview of Linux Installation Process
Installing and Uninstalling vCLI on Linux Systems
Installing Prerequisite Software for Linux Systems
Install the vCLI Package on a Linux System
Uninstall the vCLI Package on Linux
Installing and Uninstalling vCLI on Windows
Install the vCLI Package on Windows
Uninstall the vCLI Package on Windows
Enabling Certificate Verification
vSphere SDK for Perl Programming Guide
Getting Started with vSphere SDK for Perl
vSphere SDK for Perl Architecture
Using vSphere SDK for Perl
Typical Usage Scenarios
Common vSphere SDK for Perl Tasks
vSphere SDK for Perl Programming Conventions
vSphere SDK for Perl Common Options
Specifying Options
Authenticating Through vCenter Server and vCenter Single Sign-On
Use a Session File
Passing Parameters at the Command Line
Setting Environment Variables
Using a Configuration File
Using Microsoft Windows Security Support Provider Interface (SSPI)
Common Options Reference
Run Your First Script
Writing vSphere SDK for Perl Scripts
Basic vSphere SDK for Perl Script
Step 1: Import the vSphere SDK for Perl Modules
Step 2: (Optional) Define Script-Specific Command-Line Options
Step 3: Connect to the Server
Step 4: Obtain View Objects of Server-Side Managed Objects
Step 5: Process Views and Report Results
Step 6: Close the Server Connection
Understanding Server-Side Objects
Using the Managed Object Browser to Explore Server-Side Objects
Enable the MOB on 6.0 and Later Systems
Access the MOB on Any or System
Types of Managed Objects and the Managed Object Hierarchy
Managed Object Hierarchy
View Documentation for Server-side Objects
Managed Entities in the Inventory
Accessing Server-Side Inventory Objects
Understanding Perl View Objects
Working with View Object Property Values
Accessing Property Values
Accessing Simple Property Values
Accessing Enumeration Property Values
Modifying Property Values
Creating Data Objects with Properties
Understanding Operations and Methods
Non-Blocking and Blocking Methods
Examples of Operations
Calling Methods
Omitting Optional Arguments in Method Calls
Updating View Objects
Refining vSphere SDK for Perl Scripts
Creating and Using Filters
Using Filters with Vim::find_entity_view() or Vim::find_entity_views()
Filtering Views Selectively Using Properties
Using View Subroutines with a Properties Argument
Using Filters on the Utility Application Command Line
Retrieve the ServiceInstance Object on a vSphere Host
Saving and Using Sessions
Saving Sessions
Loading Sessions
Using Multiple Sessions
Learning About Object Structure Using Data::Dumper
Specifying Untyped Arguments in Scheduled Tasks and Callbacks
Using Advanced Subroutines
vSphere SDK for Perl Subroutine Reference
Subroutines in the Opts Package
add_options
get_option
option_is_set
parse
validate
usage
Subroutines in the Util Package
connect
disconnect
get_inventory_path
trace
Subroutines in the Vim Package
clear_session
find_entity_view
find_entity_views
get_service_instance
get_service_content
get_session_id
get_view
get_views
load_session
login
logout
save_session
update_view_data
Web Services for Management Perl Library
Web Services for Management Overview
Required Perl Modules
Install Required Perl Modules on a Windows System
Install Required Perl Modules on a Linux System
Using Sample Scripts
SOAP Message Construction with WSMan::WSBasic
WSMan::WSBasic->new
register_xml_ns
register_class_ns
Identify
Enumerate
PullRelease
Get
WSMan::WSBasic Examples
Generic CIM Operations with WSMan::GenericOps
WSMan::GenericOps->new
register_xml_ns
register_class_ns
Identify
EnumerateInstances
EnumerateInstanceNames
EnumerateAssociatedInstances
EnumerateAssociatedInstanceNames
EnumerateAssociationInstances
EnumerateAssociationInstanceNames
GetInstance
Credential Store Perl Library
Credential Store Overview
Credential Store Components
Managing the Credential Store
Using the Credential Store
vSphere Credential Store Subroutine Reference
init
get_password
add_password
remove_password
clear_passwords
get_hosts
get_usernames
close
credstore_admin.pl Utility Application
HTML Console SDK Programming Guide
The VMware HTML Console
Architecture of the HTML Console
Compared to Other VMware Consoles
Getting Started with the
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
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
Guest and HA Application Monitoring SDK Programming Guide
Installing the Development Kit
About the SDK Contents
Displaying vSphere Guest Library Statistics
Using the HA Application Monitoring SDK
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
Security of Remote RPC
The Guest Programming API
Overview of the vSphere Guest API
Supported Guest Operating Systems
Required Library Versions
Virtual Machine Statistics
How to Use the vSphere Guest API
vSphere Guest API Runtime Components
vSphere Guest API Data Types
vSphere Guest API Functions
vSphere Guest API Error Codes
Tools for Extended Guest Statistics
Introduction to 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
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
Getting Started with vSphere Command-Line Interfaces
Managing vSphere with Command-Line Interfaces
Overview of vSphere Command-Line Interfaces
Using ESXCLI for Host Management
ESXCLI Syntax
Running ESXCLI Commands Installed as Part of vCLI
ESXCLI Command Support When Host and vCLI Versions Do Not Match
Using to Manage Hosts and Virtual Machines
Using DCLI to Manage vCenter Services
DCLI Syntax
vCLI Package Contents
Installing vCLI
Installation Overview
Overview of Linux Installation Process
Installing and Uninstalling vCLI on Linux Systems
Installing Prerequisite Software for Linux Systems
Install the vCLI Package on a Linux System
Uninstall the vCLI Package on Linux
Installing and Uninstalling vCLI on Windows
Install the vCLI Package on Windows
Uninstall the vCLI Package on Windows
Enabling Certificate Verification
Running Host Management Commands in the
Access with the Direct Console
Enabling Local Access
Enable the in the Direct Console
Enable the from the
Timeout
Use the Local
Remote Access with SSH
Enable SSH Access in the Direct Console
Enable SSH from the
Access the Remote with SSH
Lockdown Mode
Run an ESXCLI Command in the
Running vCLI Host Management Commands
Overview of Running vCLI Host Management Commands
Targeting the Host Directly
Targeting a Host That is Managed by a vCenter Server System
Protecting Passwords
Order of Precedence for vCLI Host Management Commands
Authenticating Through and vCenter Single Sign-On
Authenticating Directly to the Host
Create and Use a Session File
Using Environment Variables
Using a Configuration File
Using Command-Line Options
Using the Microsoft Windows Security Support Provider Interface
vCLI and Lockdown Mode
Trust Relationship Requirement for ESXCLI Commands
Download and Install the Certificate
Using the --cacertsfile Option
Using the --thumbprint Option
Use the Credential Store
Common Options for vCLI Host Management Command Execution
Using vCLI Commands in Scripts
Run Host Management Commands from a Windows System
Run Host Management Commands from a Linux System
Running DCLI Commands
Overview of Running DCLI Commands
DCLI Syntax
DCLI Options
Run DCLI Commands in Interactive Mode
Run DCLI Commands in Non-Interactive Mode
Using DCLI Commands
Displaying Help Information for DCLI Commands
Running DCLI Commands Included in the vCLI Package
Running DCLI Commands on the
DCLI Authentication
VMware Cloud on AWS Authentication
Authentication
Using DCLI with a Credential Store File
Order of Precedence for DCLI Authentication to
Using the DCLI Configuration Store
DCLI Modules
Internal DCLI Commands
Using Default Options
Input, Output, and Return Codes
Using DCLI with Variables
DCLI Security
SSL Communication
DCLI Secret Input
Setting the DCLI Log File
DCLI History File
vSphere Command-Line Interface Concepts and Examples
vSphere CLI Command Overviews
Introduction
Documentation
Command-Line Help
List of Available Host Management Commands
Targets and Protocols for vCLI Host Management Commands
Supported Platforms for vCLI Commands
Commands with an esxcfg Prefix
ESXCLI Commands Available on Different ESXi Hosts
Trust Relationship Requirement for ESXCLI Commands
Download and Install the Certificate
Using the --cacertsfile Option
Using the --thumbprint Option
Use the Credential Store
Using ESXCLI Output
Connection Options for vCLI Host Management Commands
Connection Options for DCLI Commands
vCLI Host Management Commands and Lockdown Mode
Managing Hosts
Stopping, Rebooting, and Examining Hosts
Stopping and Rebooting Hosts with ESXCLI
Stopping, Rebooting, and Examining Hosts with vicfg-hostops
Entering and Exiting Maintenance Mode
Enter and Exit Maintenance Mode with ESXCLI
Enter and Exit Maintenance Mode with vicfg-hostops
Backing Up Configuration Information with vicfg-cfgbackup
Backup Tasks
Backing Up Configuration Data
Restore Configuration Data
Managing VMkernel Modules
Manage Modules with esxcli system module
Manage Modules with vicfg-module
Using vicfg-authconfig for Active Directory Configuration
Prepare Hosts for Active Directory Integration
Set Up Active Directory to Work with
Updating Hosts
Managing Files
Introduction to Virtual Machine File Management
Managing the Virtual Machine File System with vmkfstools
Upgrading VMFS3 Volumes to VMFS5
Managing VMFS Volumes
Managing Duplicate VMFS Datastores
Mounting Datastores with Existing Signatures
Mount a Datastore with ESXCLI
Mount a Datastore with vicfg-volume
Resignaturing VMFS Copies
Resignature a VMFS Copy with ESXCLI
Resignature a VMFS Copy with vicfg-volume
Reclaiming Unused Storage Space
Using vifs to View and Manipulate Files on Remote Hosts
vifs Options
vifs Examples
Managing Storage
Introduction to Storage
How Virtual Machines Access Storage
Datastores
Storage Device Naming
Examining LUNs
Target and Device Representation
Examining LUNs with esxcli storage core
Examining LUNs with vicfg-scsidevs
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
Changing the State of a Path
Disable a Path with ESXCLI
Disable a Path with vicfg-mpath
Managing Path Policies
Multipathing Considerations
Changing Path Policies
Change the Path Policy with ESXCLI
Change the Path Policy with vicfg-mpath
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
Adding and Deleting NAS File Systems
Manage a NAS File System with ESXCLI
Managie a NAS File System with vicfg-nas
Monitor and Manage FibreChannel SAN Storage
Monitoring and Managing Storage
Retrieve Information
Manage a Cluster
Add and Remove Storage
Monitoring vSphere Flash Read Cache
Monitoring and Managing Virtual Volumes
Migrating Virtual Machines with svmotion
Storage vMotion Uses
Storage vMotion Requirements and Limitations
Running svmotion in Interactive Mode
Running svmotion in Noninteractive Mode
Determine the Path to the Virtual Machine Configuration File and Disk File
Relocate a Virtual Machine's Storage
Relocate a Virtual Machine's Configuration File
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 and vicfg-iscsi
esxcli iscsi Command Syntax
Key to esxcli iscsi Short Options
vicfg-iscsi Command Syntax
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
iSCSI Storage Setup with vicfg-iscsi
Set Up Software iSCSI with vicfg-iscsi
Set Up Dependent Hardware iSCSI with vicfg-iscsi
Set Up Independent Hardware iSCSI with vicfg-iscsi
Listing and Setting iSCSI Options
Listing iSCSI Options with ESXCLI
Setting MTU with ESXCLI
Listing and Setting iSCSI Options with vicfg-iscsi
Listing and Setting iSCSI Parameters
Listing and Setting iSCSI Parameters with ESXCLI
Returning Parameters to Default Inheritance with ESXCLI
Listing and Setting iSCSI Parameters with vicfg-iscsi
Returning Parameters to Default Inheritance with vicfg-iscsi
Enabling iSCSI Authentication
Enable iSCSI Authentication with ESXCLI
Enable Mutual iSCSI Authentication with ESXCLI
Enable iSCSI Authentication with vicfg-iscsi
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
vicfg-user Command Syntax
Managing Users with vicfg-user
Assigning Permissions with ESXCLI
Managing Virtual Machines
vmware-cmd Overview
Connection Options for vmware-cmd
General Options for vmware-cmd
Format for Specifying Virtual Machines
List and Register Virtual Machines
Retrieving Virtual Machine Attributes
Managing Virtual Machine Snapshots with vmware-cmd
Take a Virtual Machine Snapshot
Reverting and Removing Snapshots
Powering Virtual Machines On and Off
Connecting and Disconnecting Virtual Devices
Working with the AnswerVM API
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
Retrieving Information About Virtual Switches with ESXCLI
Retrieving Information About Virtual Switches with vicfg-vswitch
Adding and Deleting Virtual Switches
Adding and Deleting Virtual Switches with ESXCLI
Adding and Deleting Virtual Switches with vicfg-vswitch
Setting Switch Attributes with ESXCLI
Setting Switch Attributes with vicfg-vswitch
Checking, Adding, and Removing Port Groups
Managing Port Groups with ESXCLI
Managing Port Groups with vicfg-vswitch
Managing Uplinks and Port Groups
Connecting and Disconnecting Uplink Adapters and Port Groups with ESXCLI
Connecting and Disconnecting Uplinks and Port Groups with vicfg-vswitch
Setting the Port Group VLAN ID
Setting the Port Group VLAN ID with ESXCLI
Setting the Port Group VLAN ID with vicfg-vswitch
Managing Uplink Adapters
Manage Uplink Adapters with ESXCLI
Specifying Multiple Uplinks with ESXCLI
Manage Uplink Adapters with vicfg-nics
Linking and Unlinking Uplink Adapters with ESXCLI
Linking and Unlinking Uplink Adapters with vicfg-vswitch
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 VMkernel Network Interfaces with vicfg-vmknic
Add and Configure an IPv4 VMkernel Network Interface with vicfg-vmknic
Add and Configure an IPv6 VMkernel Network Interface with vicfg-vmknic
Setting Up vSphere Networking with vSphere Distributed Switch
Managing Standard Networking Services in the vSphere Environment
Setting the DNS Configuration
Setting the DNS Configuration with ESXCLI
Set Up a DNS Server with ESXCLI
Modify DNS Setup for a Preconfigured Server with ESXCLI
Setting the DNS Configuration with vicfg-dns
Set Up a DNS Server with vicfg-dns
Modify DNS Setup for a Preconfigured Server with vicfg-dns
Manage an NTP Server
Manage the IP Gateway
Setting Up IPsec
Using IPsec with
Managing Security Associations
Managing Security Policies
Manage the Firewall
Monitor VXLAN
Monitoring Hosts
Using resxtop for Performance Monitoring
Managing Diagnostic Partitions
Managing Core Dumps
Manage Local Core Dumps with ESXCLI
Manage Core Dumps with ESXi Dump Collector
Manage Core Dumps with vicfg-dumppart
Configuring Syslog Services
Managing SNMP Agents
Configuring SNMP Communities
Configuring the SNMP Agent to Send Traps
Configure a Trap Destination with ESXCLI
Configure a Trap Destination with vicfg-snmp
Configuring the SNMP Agent for Polling
Configure the SNMP Agent for Polling with ESXCLI
Configure the SNMP Agent for Polling with vicfg-snmp
Retrieving Hardware Information
OVF Tool User’s Guide
Overview of the 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 the VMware OVF Tool
Definitions and Command Syntax
Run VMware OVF Tool From the Command Line
Run OVF Tool from ESXi instead of vCenter
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
Using URIs as Locators
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
Deploying OVF Packages
Deploying an OVF Package Directly on an ESXi Host
Deploying an OVF Package to 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
Creating an RSA Public/Private Key Pair and Certificate
Signing an OVF Package
Validating an OVF Package
Using the VMware OVF Tool Probe Mode
About OVF Tool Probe Mode
Example of Probe Mode
Using the VMware 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
Setting OVF Package Properties
Last Updated December 19, 2024
The following sections show you how to set properties for OVF packages.
Examples of OVF Tool Syntax
Setting OVF Properties When Deploying to vSphere or vCloud Director
Setting OVF Network Maps When Deploying to vSphere
Setting a vService Dependency
Content feedback and comments