| Local Methods | ||
Managed Object Types | Data Object Types | All Properties | All Methods |
Properties
Name | Type | Description |
---|---|---|
None | ||
Properties inherited from SmsProvider | ||
None |
Methods
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the VasaProvider used to make the method call. |
failoverParam | FailoverParam |
Settings for the failover.
|
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a SmsTask |
Faults
Type | Description |
---|---|
InactiveProvider | Thrown if the provider is inactive for the specified entity. |
InvalidArgument | Thrown if failoverParam is null or contains invalid data. |
NotImplemented | Thrown if the provider does not implement this function. |
ProviderBusy | Thrown if the provider is busy and cannot process the request. |
ProviderOutOfResource | Thrown if it is not possible to perform the operation due to lack of resources. |
ProviderUnavailable | Thrown if the provider is temporarily unavailable. |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
SmsReplicationFault | Thrown if an error is encountered while processing the request. |
TooMany | Thrown if the Provider is unable to handle the given set of replication groups in one call. The client needs to call this method based on the maxBatchSize specified in the TooMany fault. If the maxBatchSize is not specified, the client is expected to call the function for each group individually (i.e. maxBatchSize = 1). |
Events
Type | |
---|---|
None |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the VasaProvider used to make the method call. |
groupId* | ReplicationGroupId[] |
List of replication group IDs.
|
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a SmsTask |
Faults
Type | Description |
---|---|
InactiveProvider | Thrown if the provider is inactive for the specified entity. |
InvalidArgument | Thrown if groupId is null or empty. |
NotImplemented | Thrown if the provider does not implement this function. |
ProviderBusy | Thrown if the provider is busy and cannot process the request. |
ProviderOutOfResource | Thrown if it is not possible to perform the operation due to lack of resources. |
ProviderUnavailable | Thrown if the provider is temporarily unavailable. |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
SmsReplicationFault | Thrown if an error is encountered while processing the request. |
TooMany | Thrown if the Provider is unable to handle the given set of replication groups in one call. The client needs to call this method based on the maxBatchSize specified in the TooMany fault. If the maxBatchSize is not specified, the client is expected to call the function for each group individually (i.e. maxBatchSize = 1). |
Events
Type | |
---|---|
None |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the VasaProvider used to make the method call. |
promoteParam | PromoteParam |
Specifies an array of replication group IDs whose
in-test devices (ReplicationStateEnum#INTEST) need to be
promoted to failover ReplicationStateEnum#FAILEDOVER state.
|
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a SmsTask |
Faults
Type | Description |
---|---|
InactiveProvider | Thrown if the provider is inactive for the specified entity. |
InvalidArgument | Thrown if promoteParam is null or contains invalid data. |
NotImplemented | Thrown if the provider does not implement this function. |
ProviderBusy | Thrown if the provider is busy and cannot process the request. |
ProviderOutOfResource | Thrown if it is not possible to perform the operation due to lack of resources. |
ProviderUnavailable | Thrown if the provider is temporarily unavailable. |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
SmsReplicationFault | Thrown if an error is encountered while processing the request. |
TooMany | Thrown if the Provider is unable to handle the given set of replication groups in one call. The client needs to call this method based on the maxBatchSize specified in the TooMany fault. If the maxBatchSize is not specified, the client is expected to call the function for each group individually (i.e. maxBatchSize = 1). |
Events
Type | |
---|---|
None |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the VasaProvider used to make the method call. |
alarmFilter* | AlarmFilter |
Filter criteria for the alarm state.
|
Return Value
Type | Description |
---|---|
AlarmResult | AlarmResult containing all (or requested) active alarm objects owned by the VASA provider. |
Faults
Type | Description |
---|---|
InactiveProvider | Thrown if the provider is inactive for the specified entity. |
InvalidArgument | Thrown if invalid input is provided. |
NotFound | Thrown if the specified entity does not exist. |
NotImplemented | Thrown if the provider does not implement this function. |
ProviderBusy | Thrown if the provider is busy and cannot process the request. |
ProviderUnavailable | Thrown if the provider is temporarily unavailable. |
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 VasaProvider used to make the method call. |
groupId* | ReplicationGroupId[] |
List of replication group IDs.
|
queryParam* | QueryPointInTimeReplicaParam |
Search criteria specification for all the groups.
|
Return Value
Type | Description |
---|---|
GroupOperationResult[] | An array of GroupOperationResult elements. Each of these elements is either GroupErrorResult or QueryPointInTimeReplicaSuccessResult or QueryPointInTimeReplicaSummaryResult for CDP capable replicators. The fault in the result entry can be set to: |
Faults
Type | Description |
---|---|
InactiveProvider | Thrown if the provider is inactive for the specified replication groups. |
InvalidArgument | Thrown if groupId is null or empty, or queryParam is invalid. |
NotImplemented | Thrown if the provider does not implement this function. |
ProviderBusy | Thrown if the provider is busy and cannot process the request. |
ProviderUnavailable | Thrown if the provider is temporarily unavailable. |
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 VasaProvider used to make the method call. |
groupId* | ReplicationGroupId[] |
List of replication group IDs.
|
Return Value
Type | Description |
---|---|
GroupOperationResult[] | An array of sms.storage.GroupOperationResult elements. If the input array is null or empty, VASA Provider needs to return all available replication groups. Depending on the number of replication groups to be returned, VASA Provider can return either a list of sms.storage.GroupOperationResult or a list of sms.storage.QueryReplicationGroupSuccessResult. However, VASA Provider should not return a hybrid result. If the input array is not empty, VASA Provider needs to return an array of results, one for each entry in the input. Each entry in the returned array is either a sms.storage.QueryReplicationGroupSuccessResult (for success), or a sms.storage.GroupErrorResult (for failure). The length of the result arrays must be the same as the input. The fault in the result entry can be set to: |
Faults
Type | Description |
---|---|
InactiveProvider | Thrown if the provider is inactive for the specified replication groups. |
NotImplemented | Thrown if the provider does not implement this function. |
ProviderBusy | Thrown if the provider is busy and cannot process the request. |
ProviderUnavailable | Thrown if the provider is temporarily unavailable. |
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 VasaProvider used to make the method call. |
faultDomainId* | FaultDomainId[] |
An optional list of source fault domain ID.
|
Return Value
Type | Description |
---|---|
QueryReplicationPeerResult[] | An array of sms.storage.QueryReplicationPeerResult. If the input array is null or empty, VASA provider needs to return result for all available source FaultDomain(s). If the input array is not empty, VASA Provider needs to return one entry in result for each entry in the input. The length of the input and result arrays must be same in that case. The fault in the result entry can be set to: |
Faults
Type | Description |
---|---|
InactiveProvider | Thrown if the provider is inactive for the specified fault domains. |
NotImplemented | Thrown if the provider does not implement this function. |
ProviderBusy | Thrown if the provider is busy and cannot process the request. |
ProviderUnavailable | Thrown if the provider is temporarily unavailable. |
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 VasaProvider used to make the method call. |
groupId* | ReplicationGroupId[] |
Array of replication groups (currently in
ReplicationState#FAILEDOVER state) that need to be reversed.
|
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a SmsTask |
Faults
Type | Description |
---|---|
InactiveProvider | Thrown if the provider is inactive for the specified entity. |
InvalidArgument | Thrown if groupId is null or empty. |
NotImplemented | Thrown if the provider does not implement this function. |
ProviderBusy | Thrown if the provider is busy and cannot process the request. |
ProviderOutOfResource | Thrown if it is not possible to perform the operation due to lack of resources. |
ProviderUnavailable | Thrown if the provider is temporarily unavailable. |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
SmsReplicationFault | Thrown if an error is encountered while processing the request. |
TooMany | Thrown if the Provider is unable to handle the given set of replication groups in one call. The client needs to call this method based on the maxBatchSize specified in the TooMany fault. If the maxBatchSize is not specified, the client is expected to call the function for each group individually (i.e. maxBatchSize = 1). |
Events
Type | |
---|---|
None |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the VasaProvider used to make the method call. |
groupId* | ReplicationGroupId[] |
List of replication group IDs.
|
pitName | xsd:string |
Localized name for the point-in-time snapshot created.
|
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a SmsTask |
Faults
Type | Description |
---|---|
InactiveProvider | Thrown if the provider is inactive for the specified entity. |
InvalidArgument | Thrown if groupId is null or empty, or pitName is null. |
NotImplemented | Thrown if the provider does not implement this function. |
ProviderBusy | Thrown if the provider is busy and cannot process the request. |
ProviderOutOfResource | Thrown if it is not possible to perform the operation due to lack of resources. |
ProviderUnavailable | Thrown if the provider is temporarily unavailable. |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
SmsReplicationFault | Thrown if an error is encountered while processing the request. |
TooMany | Thrown if the Provider is unable to handle the given set of replication groups in one call. The client needs to call this method based on the maxBatchSize specified in the TooMany fault. If the maxBatchSize is not specified, the client is expected to call the function for each group individually (i.e. maxBatchSize = 1). |
Events
Type | |
---|---|
None |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the VasaProvider used to make the method call. |
testFailoverParam | TestFailoverParam |
Settings for the failover.
|
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a SmsTask |
Faults
Type | Description |
---|---|
InactiveProvider | Thrown if the provider is inactive for the specified entity. |
InvalidArgument | Thrown if testFailoverParam is null or contains invalid data. |
NotImplemented | Thrown if the provider does not implement this function. |
ProviderBusy | Thrown if the provider is busy and cannot process the request. |
ProviderOutOfResource | Thrown if it is not possible to perform the operation due to lack of resources. |
ProviderUnavailable | Thrown if the provider is temporarily unavailable. |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
SmsReplicationFault | Thrown if an error is encountered while processing the request. |
TooMany | Thrown if the Provider is unable to handle the given set of replication groups in one call. The client needs to call this method based on the maxBatchSize specified in the TooMany fault. If the maxBatchSize is not specified, the client is expected to call the function for each group individually (i.e. maxBatchSize = 1). |
Events
Type | |
---|---|
None |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the VasaProvider used to make the method call. |
groupId* | ReplicationGroupId[] |
Array of replication groups that need to stop test.
|
force | xsd:boolean |
- if true, VP should force-unbind all Virtual Volumes
and move the RG from INTEST to TARGET state. If false, VP will report all the
config Virtual Volumes which need to be cleaned up before a failover operation
can be triggered. The default value will be false.
|
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a SmsTask |
Faults
Type | Description |
---|---|
InactiveProvider | Thrown if the provider is inactive for the specified replication groups. |
InvalidArgument | Thrown if groupId is null or empty. |
NotImplemented | Thrown if the provider does not implement this function. |
NotSupportedByProvider | Thrown if the provider does not support force operation. |
ProviderBusy | Thrown if the provider is busy and cannot process the request. |
ProviderOutOfResource | Thrown if it is not possible to perform the operation due to lack of resources. |
ProviderUnavailable | Thrown if the provider is temporarily unavailable. |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
SmsReplicationFault | Thrown if an error is encountered while processing the request. |
TooMany | Thrown if the Provider is unable to handle the given set of replication groups in one call. The client needs to call this method based on the maxBatchSize specified in the TooMany fault. If the maxBatchSize is not specified, the client is expected to call the function for each group individually (i.e. maxBatchSize = 1). |
Events
Type | |
---|---|
None |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the VasaProvider used to make the method call. |
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a SmsTask |
Faults
Type | Description |
---|---|
InvalidCertificate | Thrown if the provider certificate is invalid |
ProviderConnectionFailed | Thrown if an error is encountered while reconnecting to the 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 VasaProvider used to make the method call. |
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a SmsTask |
Faults
Type | Description |
---|---|
CertificateRefreshFailed | Thrown if an error is encountered while refreshing CA signed certificate for the 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 VasaProvider used to make the method call. |
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a SmsTask |
Faults
Type | Description |
---|---|
CertificateRevocationFailed | Thrown if an error is encountered while revoking CA signed certificate of the 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 VasaProvider used to make the method call. |
arrayId* | xsd:string |
|
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a SmsTask |
Faults
Type | Description |
---|---|
InvalidArgument | Thrown if invalid input is provided. |
ProviderSyncFailed | Thrown if an error is encountered while executing sync operation for the 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 |
Top of page | Local Methods | ||
Managed Object Types | Data Object Types | All Properties | All Methods |