| Local Methods | ||
Managed Object Types | Data Object Types | All Properties | All Methods |
Properties
Name | Type | Description |
---|---|---|
None |
Methods
Methods defined in this Managed Object |
---|
ConfigureSyncInterval, QueryAboutInfo, QueryList, QueryStorageManager, QueryTopology, Sync, UpdateVcDbConnectionInfo |
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 |
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 |
This operation supports these entities:
See Using the QueryList Operation for more information.
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.
|
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 |
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 |
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 |
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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the SmsServiceInstance used to make the method call. |
dbConnectionSpec* | DbConnectionSpec |
database connection information.
|
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 |
Top of page | Local Methods | ||
Managed Object Types | Data Object Types | All Properties | All Methods |