Index (VMware Storage Policy SDK Samples Documentation)

A B C D E F G H I K L O P R S T V W

A

AboutInfo - Class in com.vmware.spbm.samples: AboutInfo This sample prints the basic information about the spbm end-point.
AboutInfo() - Constructor for class com.vmware.spbm.samples.AboutInfo
addToPathSet(Collection<String>) - Method in class com.vmware.spbm.connection.helpers.builders.PropertySpecBuilder
all(Boolean) - Method in class com.vmware.spbm.connection.helpers.builders.PropertySpecBuilder

B

BasicConnection - Class in com.vmware.spbm.connection: This is the basic connection implementation that establishes an authenticated session with the STS Service, VC Service, and SPBM service in that order SPBM utilizes the per-authenticated http session cookie from the vCenter server for its authentication.
BasicConnection() - Constructor for class com.vmware.spbm.connection.BasicConnection

C

CheckCompliance - Class in com.vmware.spbm.samples: CheckCompliance This sample checks the compliance of the VM's associated with a storage profile.
CheckCompliance() - Constructor for class com.vmware.spbm.samples.CheckCompliance
checkProfileCompliance() - Method in class com.vmware.spbm.samples.CheckCompliance: This method checks the compliance of entities against a profile.
close(MessageContext) - Method in class com.vmware.spbm.connection.VcSessionHandler
com.vmware.spbm.connection - package com.vmware.spbm.connection
com.vmware.spbm.connection.helpers - package com.vmware.spbm.connection.helpers
com.vmware.spbm.connection.helpers.builders - package com.vmware.spbm.connection.helpers.builders
com.vmware.spbm.samples - package com.vmware.spbm.samples
connect() - Method in class com.vmware.spbm.connection.BasicConnection
connect() - Method in interface com.vmware.spbm.connection.Connection: Establishes the authenticated connection to the various services
ConnectedServiceBase - Class in com.vmware.spbm.connection: An abstract base class, extend this class if your common needs to open a connection to the virtual center server before it can do anything useful.
ConnectedServiceBase() - Constructor for class com.vmware.spbm.connection.ConnectedServiceBase
Connection - Interface in com.vmware.spbm.connection: This simple object shows how to set up a SPBM connection.
ConnectionException - Exception in com.vmware.spbm.connection: ConnectionException is the base exception thrown by connection classes, making this a runtime exception means that catching it is optional preventing clutter, basing all connection related exceptions on this class means that you may decide to catch ConnectionException to deal with any issues underneath the connection infrastructure.
ConnectionException(String, Throwable) - Constructor for exception com.vmware.spbm.connection.ConnectionException
ConnectionException(Throwable) - Constructor for exception com.vmware.spbm.connection.ConnectionException
ConnectionException(String) - Constructor for exception com.vmware.spbm.connection.ConnectionException
ConnectionMalformedUrlException - Exception in com.vmware.spbm.connection
ConnectionMalformedUrlException(String, MalformedURLException) - Constructor for exception com.vmware.spbm.connection.ConnectionMalformedUrlException
CreateProfile - Class in com.vmware.spbm.samples: CreateProfile This sample creates a new Tag-Based Storage Profile with one rule-set.
CreateProfile() - Constructor for class com.vmware.spbm.samples.CreateProfile
createProfile() - Method in class com.vmware.spbm.samples.CreateProfile
createProfile() - Method in class com.vmware.spbm.samples.CreateVSANProfile
CreateVSANProfile - Class in com.vmware.spbm.samples: CreateVSANProfile This sample creates a new Storage Profile with one rule-set based on vSAN Capabilities.
CreateVSANProfile() - Constructor for class com.vmware.spbm.samples.CreateVSANProfile

D

DEFAULT_INTERVAL - Static variable in class com.vmware.spbm.connection.KeepAlive
DeleteProfile - Class in com.vmware.spbm.samples: DeleteProfile This sample deletes a Storage Profile.
DeleteProfile() - Constructor for class com.vmware.spbm.samples.DeleteProfile
deleteProfile() - Method in class com.vmware.spbm.samples.DeleteProfile
disconnect() - Method in class com.vmware.spbm.connection.BasicConnection
disconnect() - Method in interface com.vmware.spbm.connection.Connection: Disconnects all the services

E

EditProfile - Class in com.vmware.spbm.samples: EditProfile This sample updates a Tag-Based Storage Profile.
EditProfile() - Constructor for class com.vmware.spbm.samples.EditProfile
editProfile() - Method in class com.vmware.spbm.samples.EditProfile

F

FcdAssociateProfile - Class in com.vmware.spbm.samples: FcdAssociateProfile This sample attaches a virtual storage object to given virtual machine and associates a given storage profile to the virtual storage object.
FcdAssociateProfile() - Constructor for class com.vmware.spbm.samples.FcdAssociateProfile

G

getCapabilityMeta(String, List<PbmCapabilityMetadataPerCategory>) - Static method in class com.vmware.spbm.connection.helpers.PbmUtil: Returns the Capability Metadata for the specified capability name
getEntityProps(Connection, ManagedObjectReference, String[]) - Static method in class com.vmware.spbm.connection.helpers.VCUtil: Method to retrieve properties of a ManagedObjectReference
getHeaders() - Method in class com.vmware.spbm.connection.VcSessionHandler
getPassword() - Method in class com.vmware.spbm.connection.BasicConnection
getPassword() - Method in interface com.vmware.spbm.connection.Connection: Returns the password used for this connection
getPbmPort() - Method in class com.vmware.spbm.connection.BasicConnection
getPbmPort() - Method in interface com.vmware.spbm.connection.Connection: Returns the PbmPortType instance for the SPBM service
getPbmProfile(Connection, String) - Static method in class com.vmware.spbm.connection.helpers.PbmUtil: This method returns the Profile Spec for the given Storage Profile name
getPbmService() - Method in class com.vmware.spbm.connection.BasicConnection
getPbmService() - Method in interface com.vmware.spbm.connection.Connection: Returns the PbmService instance for the SPBM service
getPbmServiceContent() - Method in class com.vmware.spbm.connection.BasicConnection
getPbmServiceContent() - Method in interface com.vmware.spbm.connection.Connection: Returns the PbmServiceInstanceContentinstance for the SPBM service
getPbmServiceInstanceReference() - Method in class com.vmware.spbm.connection.BasicConnection
getPbmServiceInstanceReference() - Method in interface com.vmware.spbm.connection.Connection: Returns the ManagedObjectReference for the ServiceInstance for the SPBM Service
getSpbmURL() - Method in class com.vmware.spbm.connection.BasicConnection
getSpbmURL() - Method in interface com.vmware.spbm.connection.Connection: Returns the SPBM Service URL
getSsoURL() - Method in class com.vmware.spbm.connection.BasicConnection: Will attempt to return the SSO URL you set from the command line, if you forgot or didn't set one it will call getDefaultSsoUrl to attempt to calculate what the URL should have been.
getSsoURL() - Method in interface com.vmware.spbm.connection.Connection: Returns the vCenter Single Sign-On STS service URL
getStorageResourceType() - Static method in class com.vmware.spbm.connection.helpers.PbmUtil: Returns the Storage Resource Type Object
getTagCategoryMeta(String, List<PbmCapabilityMetadataPerCategory>) - Static method in class com.vmware.spbm.connection.helpers.PbmUtil: Returns the Capability Metadata associated to a Tag Category
getUsername() - Method in class com.vmware.spbm.connection.BasicConnection
getUsername() - Method in interface com.vmware.spbm.connection.Connection: Returns the username used for this connection
getUserSession() - Method in class com.vmware.spbm.connection.BasicConnection
getUserSession() - Method in interface com.vmware.spbm.connection.Connection: Returns the UserSession instance associated with the current connection
getVcURL() - Method in class com.vmware.spbm.connection.BasicConnection
getVcURL() - Method in interface com.vmware.spbm.connection.Connection: Returns the vSphere web services URL
getVimPort() - Method in class com.vmware.spbm.connection.BasicConnection
getVimPort() - Method in interface com.vmware.spbm.connection.Connection: Returns the VimPortType instance for the vsphere service
getVimService() - Method in class com.vmware.spbm.connection.BasicConnection
getVimService() - Method in interface com.vmware.spbm.connection.Connection: Returns the VimService instance for the vsphere service
getVimServiceContent() - Method in class com.vmware.spbm.connection.BasicConnection
getVimServiceContent() - Method in interface com.vmware.spbm.connection.Connection: Returns the ServiceContent instance for the vsphere service
getVimServiceInstanceReference() - Method in class com.vmware.spbm.connection.BasicConnection
getVimServiceInstanceReference() - Method in interface com.vmware.spbm.connection.Connection: Returns the ManagedObjectReference for the ServiceInstance for the vsphere service

H

handleFault(SOAPMessageContext) - Method in class com.vmware.spbm.connection.VcSessionHandler
handleMessage(SOAPMessageContext) - Method in class com.vmware.spbm.connection.VcSessionHandler

I

isConnected() - Method in class com.vmware.spbm.connection.BasicConnection
isConnected() - Method in interface com.vmware.spbm.connection.Connection: Returns if an authenticated connection to the vCenter Server is established
isRunning() - Method in class com.vmware.spbm.connection.KeepAlive

K

KeepAlive - Class in com.vmware.spbm.connection: This is a keep-alive utility class.
KeepAlive(VimPortType, ManagedObjectReference) - Constructor for class com.vmware.spbm.connection.KeepAlive: this class is immutable and acts on the supplied vimPort and serviceInstanceReference the default interval is set to 300000 milliseconds
KeepAlive(VimPortType, ManagedObjectReference, Long) - Constructor for class com.vmware.spbm.connection.KeepAlive: builds an instance of this object
keepAlive() - Method in class com.vmware.spbm.connection.KeepAlive: kicks off a thread that will call the "keep alive" method on the connection instance
keepAlive(VimPortType, ManagedObjectReference) - Static method in class com.vmware.spbm.connection.KeepAlive: Returns a thread you can start to run a keep alive on your connection.
keepAlive(VimPortType, ManagedObjectReference, Long) - Static method in class com.vmware.spbm.connection.KeepAlive: constructs a new embedded thread to keep alive

L

ListProfiles - Class in com.vmware.spbm.samples: ListProfiles This sample lists the storage profiles and their basic information Parameters: url [required] : url of the web service username [required] : username for the authentication password [required] : password for the authentication profilename [required] : Name of the storage profile Command Line: run.bat com.vmware.spbm.samples.ListProfiles --url [webserviceurl] --username [username] --password [password] --profilename [Storage Profile Name]
ListProfiles() - Constructor for class com.vmware.spbm.samples.ListProfiles
listProfiles() - Method in class com.vmware.spbm.samples.ListProfiles: Method retrieves the storage profiles created in the system.

O

obj(ManagedObjectReference) - Method in class com.vmware.spbm.connection.helpers.builders.ObjectSpecBuilder
objectSet(ObjectSpec...) - Method in class com.vmware.spbm.connection.helpers.builders.PropertyFilterSpecBuilder
ObjectSpecBuilder - Class in com.vmware.spbm.connection.helpers.builders
ObjectSpecBuilder() - Constructor for class com.vmware.spbm.connection.helpers.builders.ObjectSpecBuilder

P

pathSet(String...) - Method in class com.vmware.spbm.connection.helpers.builders.PropertySpecBuilder
PbmUtil - Class in com.vmware.spbm.connection.helpers: Utility class for PBM Samples
PbmUtil() - Constructor for class com.vmware.spbm.connection.helpers.PbmUtil
printInfo() - Method in class com.vmware.spbm.samples.AboutInfo: The method exercise both the vim API and spbm API side by side Both these APIs can be executed independently, and no particular order is implied
PropertyFilterSpecBuilder - Class in com.vmware.spbm.connection.helpers.builders
PropertyFilterSpecBuilder() - Constructor for class com.vmware.spbm.connection.helpers.builders.PropertyFilterSpecBuilder
PropertySpecBuilder - Class in com.vmware.spbm.connection.helpers.builders: a simple builder that creates a property spec
PropertySpecBuilder() - Constructor for class com.vmware.spbm.connection.helpers.builders.PropertySpecBuilder
propSet(PropertySpec...) - Method in class com.vmware.spbm.connection.helpers.builders.PropertyFilterSpecBuilder

R

reportMissingObjectsInResults(Boolean) - Method in class com.vmware.spbm.connection.helpers.builders.PropertyFilterSpecBuilder
run(VimPortType, ManagedObjectReference) - Static method in class com.vmware.spbm.connection.KeepAlive: calls "currentTime" against the supplied objects
run() - Method in class com.vmware.spbm.connection.KeepAlive: starts a keep-alive thread which will call keepAlive then sleep for the interval
run() - Method in class com.vmware.spbm.samples.FcdAssociateProfile
run() - Method in class com.vmware.spbm.samples.VMClone
run() - Method in class com.vmware.spbm.samples.VMCreate
run() - Method in class com.vmware.spbm.samples.VMRelocate

S

selectSet(SelectionSpec...) - Method in class com.vmware.spbm.connection.helpers.builders.ObjectSpecBuilder
setAddRuleSetName(Boolean) - Method in class com.vmware.spbm.samples.EditProfile
setCloneName(String) - Method in class com.vmware.spbm.samples.VMClone
setConnection(Connection) - Method in class com.vmware.spbm.connection.ConnectedServiceBase: A method for dependency injection of the connection object.
setCpuCount(String) - Method in class com.vmware.spbm.samples.VMCreate
setDataCenterName(String) - Method in class com.vmware.spbm.samples.VMClone
setDataCenterName(String) - Method in class com.vmware.spbm.samples.VMCreate
setDataStore(String) - Method in class com.vmware.spbm.samples.VMCreate
setDatastoreName(String) - Method in class com.vmware.spbm.samples.FcdAssociateProfile
setDelRuleSetName(Boolean) - Method in class com.vmware.spbm.samples.EditProfile
setDiskSize(String) - Method in class com.vmware.spbm.samples.VMCreate
setForceProvision(Boolean) - Method in class com.vmware.spbm.samples.CreateVSANProfile
setGuestOsId(String) - Method in class com.vmware.spbm.samples.VMCreate
setHostname(String) - Method in class com.vmware.spbm.samples.VMCreate
setIgnoreCert(Boolean) - Method in class com.vmware.spbm.connection.BasicConnection
setIgnoreCert(Boolean) - Method in interface com.vmware.spbm.connection.Connection: DEV ONLY option to ignore the SSL certificate check.
setMemorySize(String) - Method in class com.vmware.spbm.samples.VMCreate
setPassword(String) - Method in class com.vmware.spbm.connection.BasicConnection
setPassword(String) - Method in interface com.vmware.spbm.connection.Connection: Password for the user to be used to acquire SAML token from the STS Service for accessing vCenter Server
setProfileName(String) - Method in class com.vmware.spbm.samples.CheckCompliance
setProfileName(String) - Method in class com.vmware.spbm.samples.CreateProfile
setProfileName(String) - Method in class com.vmware.spbm.samples.CreateVSANProfile
setProfileName(String) - Method in class com.vmware.spbm.samples.DeleteProfile
setProfileName(String) - Method in class com.vmware.spbm.samples.EditProfile
setProfileName(String) - Method in class com.vmware.spbm.samples.FcdAssociateProfile
setProfileName(String) - Method in class com.vmware.spbm.samples.ViewProfile
setProfileName(String) - Method in class com.vmware.spbm.samples.VMClone
setProfileName(String) - Method in class com.vmware.spbm.samples.VMCreate
setProfileName(String) - Method in class com.vmware.spbm.samples.VMRelocate
setRuleSetName(String) - Method in class com.vmware.spbm.samples.EditProfile
setSpbmUrl(String) - Method in class com.vmware.spbm.connection.BasicConnection
setSpbmUrl(String) - Method in interface com.vmware.spbm.connection.Connection: SPBM Service URL e.g.
setSsoUrl(String) - Method in class com.vmware.spbm.connection.BasicConnection
setSsoUrl(String) - Method in interface com.vmware.spbm.connection.Connection: vCenter Single Sign-On STS service URL
setStripeWidth(Integer) - Method in class com.vmware.spbm.samples.CreateVSANProfile
setTagCategoryName(String) - Method in class com.vmware.spbm.samples.CreateProfile
setTagCategoryName(String) - Method in class com.vmware.spbm.samples.EditProfile
setUsername(String) - Method in class com.vmware.spbm.connection.BasicConnection
setUsername(String) - Method in interface com.vmware.spbm.connection.Connection: Username to be used to acquire SAML token from the STS Service for accessing vCenter Server
setVcUrl(String) - Method in class com.vmware.spbm.connection.BasicConnection
setVcUrl(String) - Method in interface com.vmware.spbm.connection.Connection: vSphere web services URL e.g https://\<vcenter>/sdk
setVirtualMachineName(String) - Method in class com.vmware.spbm.samples.VMCreate
setVmPath(String) - Method in class com.vmware.spbm.samples.FcdAssociateProfile
setVmPathName(String) - Method in class com.vmware.spbm.samples.VMClone
setVmPathName(String) - Method in class com.vmware.spbm.samples.VMRelocate
setVStorageObjectId(String) - Method in class com.vmware.spbm.samples.FcdAssociateProfile
skip(Boolean) - Method in class com.vmware.spbm.connection.helpers.builders.ObjectSpecBuilder
start() - Method in class com.vmware.spbm.connection.ConnectedServiceBase: connects this object, returns true on successful connect
stop() - Method in class com.vmware.spbm.connection.ConnectedServiceBase: disconnects this object and returns true on successful disconnect
stop() - Method in class com.vmware.spbm.connection.KeepAlive: signals the embedded thread to stop

T

type(String) - Method in class com.vmware.spbm.connection.helpers.builders.PropertySpecBuilder

V

VcSessionHandler - Class in com.vmware.spbm.connection: Handler class to add the vcSessionCookie element inside the soap header
VcSessionHandler(String) - Constructor for class com.vmware.spbm.connection.VcSessionHandler
VCUtil - Class in com.vmware.spbm.connection.helpers
VCUtil() - Constructor for class com.vmware.spbm.connection.helpers.VCUtil
ViewProfile - Class in com.vmware.spbm.samples: ViewProfile This sample prints the contents of a storage Profile.
ViewProfile() - Constructor for class com.vmware.spbm.samples.ViewProfile
viewProfile() - Method in class com.vmware.spbm.samples.ViewProfile
VMClone - Class in com.vmware.spbm.samples: VMClone This sample makes a clone of an existing VM to a new VM and associates it with the specified storage profile.
VMClone() - Constructor for class com.vmware.spbm.samples.VMClone
VMCreate - Class in com.vmware.spbm.samples: VMCreate This sample creates a VM with a storage policy based management profile.
VMCreate() - Constructor for class com.vmware.spbm.samples.VMCreate
VMRelocate - Class in com.vmware.spbm.samples: VMRelocate Used to relocate a virtual machine's virtual disks to a datastore compliant with the given storage policy based management profile.
VMRelocate() - Constructor for class com.vmware.spbm.samples.VMRelocate

W

waitForTask(Connection, ManagedObjectReference, String[], String[], Object[][]) - Static method in class com.vmware.spbm.connection.helpers.VCUtil: Handle Updates for a single object.

A B C D E F G H I K L O P R S T V W