Click or drag to resize
IComputeProviderWaitForServerState Method (String, ServerState, ServerState, Int32, NullableTimeSpan, ActionInt32, String, CloudIdentity)
Waits for the server to enter a specified state.

Namespace: net.openstack.Core.Providers
Assembly: openstacknet (in openstacknet.dll) Version: 1.7.7+Branch.master.Sha.25d803f397c8693c2c13777ef6675f796f520f2c
Syntax
Server WaitForServerState(
	string serverId,
	ServerState expectedState,
	ServerState[] errorStates,
	int refreshCount = 600,
	Nullable<TimeSpan> refreshDelay = null,
	Action<int> progressUpdatedCallback = null,
	string region = null,
	CloudIdentity identity = null
)

Parameters

serverId
Type: SystemString
The server ID. This is obtained from ServerBase.Id.
expectedState
Type: net.openstack.Core.DomainServerState
The expected state.
errorStates
Type: net.openstack.Core.DomainServerState
The error state(s) in which to throw an exception if the server enters.
refreshCount (Optional)
Type: SystemInt32
Number of times to poll the server's status.
refreshDelay (Optional)
Type: SystemNullableTimeSpan
The time to wait between polling requests for the server status. If this value is , the default is 2.4 seconds.
progressUpdatedCallback (Optional)
Type: SystemActionInt32
A callback delegate to execute each time the Progress value increases. If this value is , progress updates are not reported.
region (Optional)
Type: SystemString
The region in which to execute this action. If not specified, the user's default region will be used.
identity (Optional)
Type: net.openstack.Core.DomainCloudIdentity
The cloud identity to use for this request. If not specified, the default identity for the current provider instance will be used.

Return Value

Type: Server
A Server object containing the server details, including the final Status.
Exceptions
ExceptionCondition
ArgumentNullException If serverId is .

-or-

If expectedState is .

-or-

If errorStates is .

ArgumentException If serverId is empty.
ArgumentOutOfRangeException If refreshCount is less than 0.

-or-

If refreshDelay is negative.

NotSupportedException If the provider does not support the given identity type.

-or-

The specified region is not supported.

InvalidOperationException If identity is and no default identity is available for the provider.

-or-

If region is and no default region is available for the provider.

ServerEnteredErrorStateExceptionIf the method returned due to the server entering one of the errorStates.
ResponseExceptionIf the REST API request failed.
Remarks
Note Notes to Callers
This is a blocking operation and will not return until the server enters either the expected state, an error state, or the retry count is exceeded.
Version Information

.NET Framework

Supported in: 4.5

openstack.net

Supported in: 1.6, 1.5, 1.4, 1.3.6
See Also