IWsEndUserSetRemoveVLan Method
|
Removes a named VLAN associated with the account specified at the time of authentication. By the method SetRemoveVLan ()
WsEndUser of Aruba, you can remove the specified VLAN, if associated with the account with which you call the method.
In case you want to remove the VLAN does not exist or is associated with another account, a message will be returned
error and the operation will fail. The operation to remove the IP address can not be completed if at the time
the method call SetRemoveIpAddress () the specified address is associated with a network adapter. Similarly,
IP removal operation can not be completed if there is an operation on the specified VLAN,
appended with error or status other than Completed.
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 SetRemoveVLan(
int vLanResourceId
)
<OperationContractAttribute>
Function SetRemoveVLan (
vLanResourceId As Integer
) As WsResult
[OperationContractAttribute]
WsResult^ SetRemoveVLan(
int vLanResourceId
)
[<OperationContractAttribute>]
abstract SetRemoveVLan :
vLanResourceId : int -> WsResult
function SetRemoveVLan(
vLanResourceId : int
) : WsResult
Parameters
- vLanResourceId
- Type: SystemInt32
Value of type System.Int32 which is the unique identifier of the resource type you want to remove VLAN.
Return Value
Type:
WsResult
The method returns an object WsResult contains information about the method call.
For further details on the information returned by the method see the class definition
WsResult.
Examples
The following example shows a custom method, called RemoveVLan (), which means a call to SetRemoveVLan ()
WsEndUser of Aruba, removes the resource type with VLAN resource code 4762.
private static void RemoveVLan(WsEndUserClient client)
{
try
{
WsResult result = client.SetRemoveVLan(4762);
if (!result.Success)
{
throw new ApplicationException(
String.Format("An error has occurred while invoking SetRemoveVLan(). {0}", result.ResultMessage));
}
}
catch (Exception ex)
{
throw new ApplicationException(String.Format(
"An error has occurred while setting server note {0}", ex.Message));
}
}
See Also