# VMware vCenter Storage Monitoring Service API Readme
Welcome to the VMware vCenter Storage Monitoring Service API. This Readme contains these topics: About VMware vCenter Storage Monitoring Service About VMware vCenter Storage Monitoring Service API Package Contents Requirements Samples Listing Documentation VMware SMS API Reference Documentation VMware SMS API Java Samples Documentation Checklist of Setup Tasks for Development VMware Resources |
For up-to-date information:
Beta or Pre-release Products | VMware Beta Community
Released SDK Products | VMware APIs and SDKs Documentation
## 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. 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 a sample VASA provider, available in the SDK package:
Sample | Description
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. The SMS samples depend on the vSphere Web Services SDK, so you must set the VIMSDKHOME environment variable to identify the location of the vSphere Web Services SDK on your development machine: `parent-dir\SDK\vsphere-ws` 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 Developer Center Knowledge Base User Groups VMware Communities
Copyright © 2009-2016 VMware, Inc. All rights not expressly granted herein are reserved. | Last updated 15 Nov 2016 | VMware vCenter SMS API 6.5