IWsEndUserGetServersList Method
|
The method returns the list of User's Virtual Servers, filtered by the given request
Namespace:
Aruba.Cloud.WsEndUser
Assembly:
Aruba.Cloud.WsEndUser (in Aruba.Cloud.WsEndUser.dll) Version: 1.0.0.0 (1.0.0.0)
Syntax[OperationContractAttribute]
WsResult<ServerDetails[]> GetServersList(
GetServersListRequest operationRequest
)
<OperationContractAttribute>
Function GetServersList (
operationRequest As GetServersListRequest
) As WsResult(Of ServerDetails())
[OperationContractAttribute]
WsResult<array<ServerDetails^>^>^ GetServersList(
GetServersListRequest^ operationRequest
)
[<OperationContractAttribute>]
abstract GetServersList :
operationRequest : GetServersListRequest -> WsResult<ServerDetails[]>
function GetServersList(
operationRequest : GetServersListRequest
) : WsResult<ServerDetails[]>
Parameters
- operationRequest
- Type: Aruba.Cloud.Provisioning.EntitiesGetServersListRequest
Object of type GetServerListRequest, it allows to filter the data by server status (ServerStatus)
and to get an extended result or only basic informations (LightData)
Return Value
Type:
WsResultServerDetailsArray of type ServerDaetails, containing informations about requested virtual machines
Examplespublic ServerDetails[] GetServersList(ServerStatus[] serverStatuses, bool lightData = true)
{
using (var client = new WsEndUserClient())
{
GetServersListRequest operationRequest = new GetServersListRequest();
operationRequest.LightData = lightData;
operationRequest.ServerStatuses = serverStatuses;
WsResultOfArrayOfServerDetails result = client.GetServersList(operationRequest);
if (result.Success)
return result.Value;
else
{
throw new CodedException(GetErrorCode(result.ResultCode), result.ResultMessage);
}
}
}
See Also