Managed Object - SmsServiceInstance

See also: DbConnectionSpec, EntityReference, EntityReferenceEntityType, Map, QueryResult, QuerySpec, SmsAboutInfo, SmsStorageManager

Managed Object Description

Service interface for the Storage Monitoring Service.

Properties

Name	Type	Description
None

Methods

Methods defined in this Managed Object
ConfigureSyncInterval, QueryAboutInfo, QueryList, QueryStorageManager, QueryTopology, Sync, UpdateVcDbConnectionInfo

ConfigureSyncInterval

Deprecated. As of SMS API 4.0, this API is deprecated.

Sets the frequency with which the service cache is automatically synced with provider information. The interval is specified in seconds with a minimum value of 300 (5 minutes). NOTE: In certain concurrent invocation scenarios, it is possible that the sync timer will not be scheduled with the latest configured value until one further sync cycle has completed.

Required Privileges: StorageViews.ConfigureService

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the SmsServiceInstance used to make the method call.
interval	xsd:int	sync interval in seconds (>= 300).

Return Value

Type	Description
None

Faults

Type	Description
InvalidArgument	Thrown if specified interval is not within valid range sms.fault.InvalidSyncInterval.
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" xmlns:vim25="urn:vim25" name="ConfigureSyncInterval" type="sms:ConfigureSyncIntervalRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" xmlns:vim25="urn:vim25" name="ConfigureSyncIntervalResponse">
            <complexType/>
         </element>

QueryAboutInfo

Retrieves information about the service.

Required Privileges: StorageViews.View
Since: SMS API 2.0

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the SmsServiceInstance used to make the method call.

Return Value

Type	Description
SmsAboutInfo	AboutInfo information about the system

Faults

Type	Description
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" xmlns:vim25="urn:vim25" name="QueryAboutInfo" type="sms:QueryAboutInfoRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" xmlns:vim25="urn:vim25" name="QueryAboutInfoResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="sms:SmsAboutInfo"/>
               </sequence>
            </complexType>
         </element>

QueryList

Deprecated. As of SMS API 4.0, this API is deprecated.

Returns a result set (an instance of the QueryResult data object) containing properties of all entity instances of the specified entity type. If the optional contextEntity parameter is supplied, the result set is limited to those entities related to the specified entity. See this matrix for lists of possible relationships. You can apply additional constraints to the results by using the QuerySpec input parameter.

This operation supports these entities:

datacenter
resourcePool
storagePod
cluster
host
datastore
vm

See Using the QueryList Operation for more information.

Required Privileges: StorageViews.View

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the SmsServiceInstance used to make the method call.
contextEntity*	EntityReference	Limits result set from the query to storage attributes associated with the specified entity.
queryEntityType	EntityReferenceEntityType	Type of entities to query.
querySpec*	QuerySpec	Additional constraints (range, filtering, sorting, and so on) to be applied on the result set.

*Need not be set

Return Value

Type	Description
QueryResult	data object containing results from the query and supporting metadata.

Faults

Type	Description
EntityNotFound	Thrown if the specified entity does not exist.
InvalidArgument	Thrown if invalid input is provided. Examples include: sms.fault.InvalidEntity - invalid entity reference sms.fault.InvalidEntityType- invalid entity type. sms.fault.InvalidEntityType - null or invalid query entity type. sms.fault.InvalidQuerySpec - illegal values for maxCount and offset fields in QuerySpec. MultipleSortSpecsNotSupported - multiple sort specs are specified. sms.fault.InvalidSortSpec - invalid property value in SortSpec. sms.fault.InvalidListQuery - query for given entity types is not supported.
QueryExecutionFault	Thrown if an error is encountered while processing the query request.
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" xmlns:vim25="urn:vim25" name="QueryList" type="sms:QueryListRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" xmlns:vim25="urn:vim25" name="QueryListResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="sms:QueryResult"/>
               </sequence>
            </complexType>
         </element>

QueryStorageManager

Retrieves Storage Manager managed object.

Required Privileges: StorageViews.View
Since: SMS API 2.0

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the SmsServiceInstance used to make the method call.

Return Value

Type	Description
ManagedObjectReference to a SmsStorageManager	A managed object SmsStorageManager reference.

Faults

Type	Description
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" xmlns:vim25="urn:vim25" name="QueryStorageManager" type="sms:QueryStorageManagerRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" xmlns:vim25="urn:vim25" name="QueryStorageManagerResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vim25:ManagedObjectReference"/>
               </sequence>
            </complexType>
         </element>

QueryTopology

Deprecated. As of SMS API 2.0, this API is deprecated.

Returns the entities that are related to the given entity as a list of nodes and edges, which can be used to construct a topological map of the relationships. Entities supported by this operation: datacenter, cluster, host, datastore and vm.

Required Privileges: StorageViews.View

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the SmsServiceInstance used to make the method call.
entity	EntityReference	entity for which topology map is required.

Return Value

Type	Description
Map	structure with list of nodes and edges to construct the topology.

Faults

Type	Description
EntityNotFound	Thrown if the specified entity does not exist.
InvalidArgument	Thrown if invalid input is provided: sms.fault.InvalidEntity, sms.fault.InvalidEntityType - entity is null or contains invalid id/type. sms.fault.InvalidTopologyQuery - query is not supported for given entity type.
QueryExecutionFault	Thrown if an error is encountered while processing the query request.
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" xmlns:vim25="urn:vim25" name="QueryTopology" type="sms:QueryTopologyRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" xmlns:vim25="urn:vim25" name="QueryTopologyResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="sms:Map"/>
               </sequence>
            </complexType>
         </element>

Sync

Deprecated. As of SMS API 4.0, this API is deprecated.

Synchronizes the service cache from provider information (like the VirtualCenter database provider).

Required Privileges: StorageViews.View

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the SmsServiceInstance used to make the method call.

Return Value

Type	Description
None

Faults

Type	Description
DbConfigFailed	Thrown if database configuration fails.
ProviderSyncFailed	Thrown if an error is encountered while executing the sync operation for a provider.
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" xmlns:vim25="urn:vim25" name="Sync" type="sms:SyncRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" xmlns:vim25="urn:vim25" name="SyncResponse">
            <complexType/>
         </element>

UpdateVcDbConnectionInfo

Deprecated. As of SMS API 4.0, this API is deprecated.

Updates the connection information for the VirtualCenter database. The credentials and connection url can be explicitly specified using a DbConnectionSpec argument. Alternately, a null argument may be passed to force the service to refresh the connection information from the local registry. NOTE: The operation re-initializes the service after configuring the database information. This is akin to the service being restarted.

Required Privileges: StorageViews.ConfigureService

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the SmsServiceInstance used to make the method call.
dbConnectionSpec*	DbConnectionSpec	database connection information.

*Need not be set

Return Value

Type	Description
None

Faults

Type	Description
InvalidArgument	Thrown if DbConnectionSpec.url is null/empty or if it is in an unknown format sms.fault.UnsupportedDbUrl.
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" xmlns:vim25="urn:vim25" name="UpdateVcDbConnectionInfo" type="sms:UpdateVcDbConnectionInfoRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" xmlns:vim25="urn:vim25" name="UpdateVcDbConnectionInfoResponse">
            <complexType/>
         </element>