vSphere Web Services SDK Programming Guide

• About   View
• VMware vSphere and vSphere Management APIs   View
• • vSphere Web Services SDK   View
  • SDK Developer Setup   View
  • SDK Samples   View
  • UML Diagrams Used in This Guide   View
• vSphere API Programming Model   View
• • vSphere Client-Server Architecture   View
  • vSphere API as a Web Service   View
  • • WSDL Files and the Client-Side Proxy Interface   View
    • Network Access to the vSphere Web Service   View
    • Language-Specific Classes and Methods   View
    • Mapping XML Data Types to Java and C# Data Types   View
  • Access to Managed Objects   View
  • Access to vSphere Server Data   View
  • • Obtaining Information from a Server   View
    • Working with Data Structures   View
    • Accessing Property Values   View
    • Unset Optional Properties   View
    • Escape Character in Name and Path Properties   View
• Client Applications   View
• • vCenter Server Connections   View
  • Establishing a Single Sign-On Session with a vCenter Server   View
  • • LoginByToken (C# Example)   View
    • LoginByToken (Java Example)   View
  • Establishing a Session with Username and Password Credentials   View
  • • Overview of a Java Sample Application   View
  • Web Server Session Token   View
  • • Accessing the HTTP Endpoint with JAX-WS   View
    • Accessing the vSphere Server   View
    • Closing the Connection   View
    • Using the Java Samples as Reference   View
  • Multiple Versions of the vSphere API   View
  • Identifying the API Version Supported by the Server   View
  • Java and C# Sample Applications   View
  • • Java Samples   View
    • C# Samples   View
• Datacenter Inventory   View
• • Inventory Overview   View
  • Inventory Hierarchies and ServiceInstance   View
  • • Folders in the Hierarchy   View
    • ESXi Inventory Hierarchy   View
  • Accessing Inventory Objects   View
  • Creating Inventory Objects   View
  • Privileges Required for Inventory Management   View
  • • Privileges   View
    • Permissions   View
  • Managed and Standalone ESX/ESXi Hosts   View
• Property Collector   View
• • Introduction to the PropertyCollector   View
  • • Data Retrieval   View
    • Inventory Traversal and Object Selection   View
  • vSphere Data Objects for Property Collection   View
  • vSphere Methods for Property Collection   View
  • PropertyCollector Example (RetrievePropertiesEx)   View
  • Inventory Traversal   View
  • • TraversalSpec Traversal   View
    • SelectionSpec Traversal   View
  • Client Data Synchronization (WaitForUpdatesEx)   View
  • • Property Filters   View
    • WaitForUpdatesEx   View
  • Server Data Transmission   View
  • PropertyCollector Performance   View
  • SearchIndex   View
• Authentication and Authorization   View
• • Objects for Authentication and Authorization Management   View
  • Authentication and Authorization for ESXi and vCenter Server   View
  • • ESXi User Model   View
    • vCenter Server User Model   View
    • vSphere Security Model   View
    • Setting Up Users, Groups, and Permissions   View
  • Obtaining User and Group Information from UserDirectory   View
  • Managing ESXi Users with HostLocalAccountManager   View
  • Managing Roles and Permissions with AuthorizationManager   View
  • • Using Roles to Consolidate Sets of Privileges   View
    • Modifying Sample Roles to Create New Roles   View
    • Granting Privileges Through Permissions   View
  • Authenticating Users Through SessionManager   View
  • • Using VMware Single Sign On for vCenter Server Sessions   View
  • Using the Credential Store for Automated Login   View
  • • Credential Store Methods   View
    • Credential Store Backing File   View
    • Credential Store Samples   View
    • Specifying Roles and Users with the Credential Store   View
  • Managing Licenses with LicenseManager   View
• Hosts   View
• • Host Management Objects   View
  • Retrieving Host Information   View
  • Configuring and Reconfiguring Hosts   View
  • Managing the Host Lifecycle   View
  • • Reboot and Shutdown   View
    • Using Standby Mode   View
    • Disconnecting and Reconnecting Hosts   View
  • Querying and Changing the Host Time   View
  • Querying Virtual Machine Memory Overhead   View
• Storage   View
• • Storage Management Objects   View
  • Introduction to Storage   View
  • • How Virtual Machines Access Storage   View
    • Datastores   View
  • Choosing the Storage API to Use   View
  • Configuring Disk Partitions   View
  • Multipath Management   View
  • Configuring iSCSI Storage   View
  • Creating and Managing Datastores   View
  • • Accessing Datastores   View
    • Creating and Modifying a VMFS Datastore   View
    • Removing and Updating Datastores   View
    • Managing VMFS Datastores with HostStorageSystem   View
  • Managing VMFS Volume Copies (Resignaturing)   View
  • Managing Diagnostic Partitions   View
  • • Retrieving Diagnostic Partition Information   View
    • Creating a Diagnostic Partition   View
  • Sample Code Reference   View
• vSphere Networks   View
• • Virtual Switches   View
  • Using a Distributed Virtual Switch   View
  • • Distributed Virtual Switch Configuration   View
    • Backup, Rollback, and Query Operations   View
  • VMware Standard Virtual Switch   View
  • • vNetwork Standard Switch Environment   View
    • Setting Up Networking with vSS   View
    • Defining the Host Network Policies   View
    • NIC Teaming   View
    • Setting Up IPv6 Networking   View
    • Adding Networking Services   View
  • Sample Code Reference   View
• Virtual Machine Configuration   View
• • VirtualMachine Management Objects and Methods   View
  • Creating Virtual Machines and Virtual Machine Templates   View
  • • Creating a Virtual Machine Using VirtualMachineConfigSpec   View
    • Creating Virtual Machine Templates   View
    • Cloning a Virtual Machine   View
    • Converting a Template to a Virtual Machine   View
    • Accessing Information About a Virtual Machine   View
  • Configuring a Virtual Machine   View
  • • Name and Location   View
    • Hardware Version   View
    • Boot Options   View
    • Operating System   View
    • CPU and Memory Information   View
    • Networks   View
    • Fibre Channel NPIV Settings   View
    • File Locations   View
  • Adding Devices to Virtual Machines   View
  • Performing Virtual Machine Power Operations   View
  • Registering and Unregistering Virtual Machines   View
  • Customizing the Guest Operating System   View
  • Installing VMware Tools   View
  • Upgrading a Virtual Machine   View
• Virtual Machine Management   View
• • Virtual Machine Migration   View
  • • Cold Migration   View
    • Migration with VMotion   View
    • Using Storage VMotion   View
  • Snapshots   View
  • • Creating a Snapshot   View
    • Reverting to a Snapshot   View
    • Deleting a Snapshot   View
  • Linked Virtual Machines   View
  • • Linked Virtual Machines and Disk Backings   View
    • Creating a Linked Virtual Machine   View
    • Removing Snapshots and Deleting Linked Virtual Machines   View
    • Relocating a Virtual Machine in a Linked Virtual Machine Group   View
    • Promoting a Virtual Machine's Disk   View
    • Performing Advanced Manipulation of Delta Disks   View
• Virtual Machine Encryption APIs   View
• • How Virtual Machine Encryption Protects a Datacenter   View
  • • What Keys are Used   View
    • What Is Encrypted   View
    • What Is Not Encrypted   View
    • Who Can Perform Cryptographic Operations   View
    • How Can I Perform Cryptographic Operations   View
  • vSphere Virtual Machine Encryption Components   View
  • • Key Management Server   View
    • vCenter Server   View
    • ESXi Hosts   View
    • Encryption Process Flow   View
  • Prerequisites and Required Privileges for Encryption Tasks   View
  • • Cryptography Privileges and Roles   View
    • Host Encryption Mode   View
    • Encrypted vSphere vMotion   View
  • API Methods for vSphere Virtual Machine Encryption   View
  • • vSphere API Methods for KMS Management   View
    • API Methods to Prepare an ESXi Host   View
    • vSphere API Methods for Cryptographic Operations   View
    • SPBM API Methods for Encryption   View
  • Workflows for vSphere Virtual Machine Encryption   View
  • • Set Up the Key Management Server Cluster   View
    • Create an Encryption Storage Policy   View
    • Create an Encrypted Virtual Machine   View
    • Clone an Encrypted Virtual Machine   View
    • Encrypt an Existing Virtual Machine or Disk   View
    • Decrypt an Encrypted Virtual Machine or Disk   View
    • Encrypt Using Different Keys   View
    • Recrypting Encrypted Virtual Machines   View
    • Encrypted vSphere vMotion   View
    • Virtual Disk Manager   View
  • Best Practices   View
• Virtual Applications   View
• • About Virtual Applications   View
  • • Management Overview   View
    • Direct and Linked Children   View
    • OVF Packages   View
  • Creating a VirtualApp   View
  • Managing VirtualApp Children   View
  • Exporting a Virtual Application   View
  • • VirtualApp and OvfManager Methods   View
    • VirtualApp Data Structures   View
    • OvfManager Data Structures   View
    • Example of Generating an OVF Package   View
  • Importing an OVF Package   View
  • Virtual Application Life Cycle   View
  • • Powering a Virtual Application On or Off   View
    • Unregistering a Virtual Application   View
    • Suspending a Virtual Application   View
    • Destroying a Virtual Application   View
• Resource Management   View
• • Resource Management Objects   View
  • Introduction to Resource Management   View
  • Resource Allocation   View
  • • Resource Pool Hierarchies   View
    • Resource Pool Management Guidelines   View
    • Cluster Overview   View
  • Creating and Configuring Resource Pools   View
  • • Understanding Expandable Reservation   View
    • Deleting Child Resource Pools   View
    • Moving Resource Pools or Virtual Machines Into a Resource Pool   View
  • Introduction to VMware DRS and VMware HA Clusters   View
  • • VMware DRS   View
    • VMware HA   View
  • Creating and Configuring Clusters   View
  • • Creating a Cluster   View
    • Adding a Host to a Cluster   View
    • Reconfiguring a Cluster   View
  • Managing DRS Clusters   View
  • Managing HA Clusters   View
  • • Using VMware HA and DRS Together   View
• Tasks and Scheduled Tasks   View
• • Creating Tasks   View
  • • Session Persistence   View
    • Cancelling a Task   View
    • Using TaskInfo to Determine Task Status   View
    • Monitoring TaskInfo Properties   View
  • Accessing and Manipulating Multiple Tasks   View
  • • Gathering Data with a ViewManager Object   View
    • Gathering Data with a TaskManager Interface   View
  • Understanding the ScheduledTaskManager Interface   View
  • • Scheduling Tasks   View
    • Cancelling a Scheduled Task   View
  • Using a TaskHistoryCollector   View
  • • Creating a TaskHistoryCollector Filter   View
    • Managing the HistoryCollector   View
  • Sample Code Reference   View
• Events and Alarms   View
• • Event and Alarm Management Objects   View
  • Understanding Events   View
  • • Managing Events with EventManager   View
    • Event Data Objects   View
    • Formatting Event Message Content   View
    • Creating Custom Events   View
  • Using an EventHistoryCollector   View
  • • Creating an EventHistoryCollector Filter   View
    • Managing the HistoryCollector   View
  • Using Alarms   View
  • • Obtaining a List of Alarms   View
    • Creating an Alarm   View
  • Defining Alarms Using the AlarmSpec Data Object   View
  • • Specifying Alarm Trigger Conditions with AlarmExpression   View
    • Specifying Alarm Actions   View
    • Deleting or Disabling an Alarm   View
  • Sample Code Reference   View
• vSphere Performance   View
• • vSphere Performance Data Collection   View
  • PerformanceManager Objects and Methods   View
  • Retrieving vSphere Performance Data   View
  • • Performance Counter Example (QueryPerf)   View
    • Large-Scale Performance Data Retrieval   View
    • Using the QueryPerf Method as a Raw Data Feed   View
    • Comparison of Query Methods   View
    • Retrieving Summary Performance Data   View
  • Performance Counter Metadata   View
  • Performance Intervals   View
  • vSphere Performance and Data Storage   View
  • • Modifying Historical Intervals   View
    • Modifying Performance Counter Collection Levels   View
  • Sample Code Reference   View
• Diagnostics and Troubleshooting   View
• • Troubleshooting Best Practices   View
  • Overview of Configuration Files and Log Files   View
  • • ESX/ESXi Log File   View
    • Virtual Machine Log Files   View
    • vCenter Server Log Files   View
  • Modifying the Log Level to Obtain Detailed Information   View
  • • Setting the Log Level on ESX/ESXi Systems   View
    • Generating Logs   View
    • Setting the Log Level on vCenter Server Systems   View
  • Using DiagnosticManager   View
  • Using the MOB to Explore the DiagnosticManager   View
  • Generating Diagnostic Bundles   View
• Managed Object Browser   View
• • Using the MOB to Explore the Object Model   View
  • • Accessing the MOB   View
    • Using the MOB to Navigate the VMware Infrastructure Object Model   View
  • Using the MOB to Invoke Methods   View
  • • Passing Primitive Datatypes to Method   View
    • Passing Arrays of Primitives to Methods   View
    • Passing Complex Structures to Methods   View
• HTTP Access to vSphere Server Files   View
• • Introduction to HTTP Access   View
  • URL Syntax for HTTP Access   View
  • • Datastore Access (/folder)   View
    • Host File Access (/host)   View
    • Update Package Access (/tmp)   View
    • Privilege Requirements for HTTP Access   View
• Privileges Reference   View
• • Privileges Required to Invoke Operations   View
  • Privileges Required to Read Properties   View
  • Privileges Defined for the Administrator Role   View
• Sample Program Overview   View
• • Java Sample Programs (JAXWS Bindings)   View
  • C# Sample Programs   View
  • • Axis 4.1   View