VMware vCenter Storage Monitoring Service API Readme
 VMware SMS API Reference Documentation
VMware SMS API Java Samples Documentation
|
|
Welcome to the VMware vCenter Storage Monitoring Service API. This Readme contains these topics: |
| ||||||||||
About VMware vCenter Storage Monitoring Service
The VMware vCenter Storage Monitoring Service (SMS) provides simplified access to all vCenter storage information associated with VMware vCenter servers. It is a Web service that runs in the Apache Tomcat container, available on the vCenter Server.
SMS is installed by default on vCenter Server systems. SMS has its own in-memory database (the SMS cache)
that periodically synchronizes its data with the vCenter database. You can use the
SmsServiceInstance.ConfigureSyncInterval method to set the cache synchronization interval.
About the vCenter Storage Monitoring Service API
As with other vCenter servers (ESX, ESXi, vCenter), the vCenter Storage Monitoring Service (SMS) exposes a Web-services-based API, the SMS API. The vCenter SMS API provides programmatic access to the Storage Monitoring Service.
To obtain information about storage across the entire datacenter, it is easier to use the SMS API than the vSphere API. Developers who are familiar with the vSphere API should note that for the SMS API, entity types include:
- cluster
- datacenter
- datastore
- storagePod
- host
- nasMount
- resourcePool
- scsiAdapter
- scsiPath
- scsiTarget
- scsiVolume
- vm
- vmFile
Operations provided by the SMS API include:
- QueryList Obtain all properties associated with instances of the specified entity type.
- QueryTopology Obtain a list of nodes and edges that comprise the specified entity.
- Sync Synchronize the SMS cache with the vCenter database. Synchronization occurs every 30 minutes, by default, but you can use this operation to force synchronization. Typically, you may want to synchronize only after certain operations, such as a provisioning operation.
See the SMS API Reference documentation for complete information.
Package Contents
The VMware vCenter Storage Monitoring Service API is a component of the VMware vSphere Web Services SDK. It includes API Reference documentation, sample code, and client-side proxy code that you can use to develop your client applications.
Directory structure
| Directory or filename | Description |
| C:\Program Files\VMware\Infrastructure\VirtualCenter Server\tomcat\webapp\sms | Path to the Tomcat servlet that implements the Storage Monitoring Service API. |
| %SDKHOME%\docs\ReferenceGuide | API reference documentation for the vCenter Storage Monitoring Service API. |
| %SDKHOME%\sms | Path containing WSDL, build scripts (build.bat, build.sh), run scripts (run.bat, run.sh), and other development setup tools. |
| %SDKHOME%\java\JAXWS\samples\com\vmware\samples\sms | Samples demonstrating how to use the SMS API. |
| %SDKHOME%\docs\java\JAXWS | Javadoc documentation for the sample applications. |
Requirements
To use the vCenter Storage Monitoring Service API, you must have access to vCenter Server (5.0 or subsequent release) and the vSphere Web Services SDK. The vCenter Storage Monitoring Service runs in conjunction with vCenter Server. It is installed during the process of installing the vCenter Server. By default, the SMS package is installed in this sub-directory:
C:\Program Files\VMware\Infrastructure\VirtualCenter Server\tomcat\webapp\sms
The SMS API is supported on the Web service that runs at this path:
/sms/sdk
Samples Listing
The vCenter SMS API includes several Java samples, available in the SDK package:
| Sample | Description |
| ConfigureSyncInterval.java | Set the number of seconds between synchronizing the Storage Monitoring Service database with the vCenter (or other source) database. |
| QueryDatastoresInDcWithFilter.java | Obtain a list of datacenter objects from the inventory and then list datastores associated with each datacenter, sorting and filtering the results according to the specifications passed as command-line arguments. |
| QueryScsiVolumesInDc.java | Obtain a list of datacenter objects from the inventory and then list LUNs (SCSIvolume objects) associated with each datacenter. |
| QueryTopology.java | Display all nodes (and the edges contained in each) for the specified datacenter. |
| Sync.java.java | Synchronize the Storage Monitoring Service database cache with a source (provider), such as vCenter database. |
| UpdateVcDbConnectionInfo.java | Configures JDBC connection information (jdbcUsername, jdbcPassword, jdbcUrl) for the connection from the SMS database to the vCenter database. |
| SampleProvider.java | Demonstrates registration, listing and deregistration of a VASA provider. It requires access to an active VASA provider. |
Documentation
Documentation for this release of the SMS API includes:
- SMS-SDK-README.html (this document)
- vCenter SMS API Reference documentation
- Sample Applications Javadoc Reference
Checklist of Setup Tasks
To get started using the SMS SDK:
- Install a Java development environment.
- Configure the environment as defined in the vSphere Web Services SDK Developer’s Setup Guide. In addition to the environment variables defined in that guide, you must also set a VIMSDKHOME environment variable that identifies the location of the SDK installed on your development machine.
- Use the build script (build.bat, build.sh) to generate the client-side proxy code and compile all the samples.
- See the samples Javadoc for information about how to run any of the samples.
VMware Resources
|
Copyright © 2009-2012 VMware, Inc. All rights not expressly granted herein are reserved. |
Last updated 10Sep2012 | VMware vSphere Web Services SDK 5.1 | VMware vCenter SMS API 3.0 |