Managed Object - ServiceInstance(sms.ServiceInstance)

See also
DbConnectionSpec, EntityReference, EntityReferenceEntityType, Map, QueryResult, QuerySpec


Managed Object Description

Service interface for the Storage Monitoring Service.

Properties

Name Type Description
None

Methods

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

ConfigureSyncInterval(configureSyncInterval)

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

NameTypeDescription
_thisManagedObjectReference A reference to the ServiceInstance used to make the method call.
intervalxsd:int

sync interval in seconds (>= 300).

Return Value

Type Description
None

Faults

Type Description
AuthenticationFailedThrown if the credential/permission validation of the request fails.
InvalidArgumentThrown if specified interval is not within valid range InvalidSyncInterval.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
ServiceNotInitializedThrown if the service is not in an initialized state.

Show WSDL type definition



QueryList(queryList)

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:

Required Privileges
StorageViews.View

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the ServiceInstance used to make the method call.
contextEntity*EntityReference

Optional. Limits result set from the query to storage attributes associated with the specified entity.
queryEntityTypeEntityReferenceEntityType

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
QueryResultData object containing results from the query and supporting metadata.

Faults

Type Description
AuthenticationFailedThrown if the credential/permission validation of the request fails.
EntityNotFoundThrown if the specified entity does not exist.
InvalidArgumentThrown if invalid input is provided. Examples include:
InvalidEntity - invalid entity reference
InvalidEntityType- invalid entity type.
InvalidEntityType - null or invalid query entity type.
InvalidQuerySpec - illegal values for maxCount and offset fields in QuerySpec.
MultipleSortSpecsNotSupported - multiple sort specs are specified.
InvalidSortSpec - invalid property value in SortSpec.
InvalidListQuery - query for given entity types is not supported.
QueryExecutionFailedThrown if an error is encountered while processing the query request.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
ServiceNotInitializedThrown if the service is not in an initialized state.

Show WSDL type definition



QueryTopology(queryTopology)

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

NameTypeDescription
_thisManagedObjectReference A reference to the ServiceInstance used to make the method call.
entityEntityReference

entity for which topology map is required.

Return Value

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

Faults

Type Description
AuthenticationFailedThrown if the credential/permission. validation of the request fails
EntityNotFoundThrown if the specified entity does not exist.
InvalidArgumentThrown if invalid input is provided:
InvalidEntity, InvalidEntityType - entity is null or contains invalid id/type.
InvalidTopologyQuery - query is not supported for given entity type.
QueryExecutionFailedThrown if an error is encountered while processing the query request.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
ServiceNotInitializedThrown if the service is not in an initialized state.

Show WSDL type definition



Sync(sync)

Synchronizes the service cache from provider information (like the VirtualCenter database provider).
Required Privileges
StorageViews.View

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the ServiceInstance used to make the method call.

Return Value

Type Description
None

Faults

Type Description
AuthenticationFailedThrown if the credential/permission validation of the request fails
ProviderSyncFailedThrown if an error is encountered while executing the sync operation for a provider.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
ServiceNotInitializedThrown if the service is not in an initialized state.

Show WSDL type definition



UpdateVcDbConnectionInfo(updateVcDbConnectionInfo)

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

NameTypeDescription
_thisManagedObjectReference A reference to the ServiceInstance used to make the method call.
dbConnectionSpec*DbConnectionSpec

database connection information.
*Need not be set

Return Value

Type Description
None

Faults

Type Description
AuthenticationFailedThrown if the credential/permission validation of the request fails.
InvalidArgumentThrown if DbConnectionSpec.url is null/empty or if it is in an unknown format UnsupportedDbUrl.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
ServiceInitializationFailedThrown if an error occurs during service initialization.

Show WSDL type definition