IWsEndUserSetRenameVLan Method
|
Assign a new name to a VLAN associated with the account specified at the time of authentication.
Using the method SetRenameVLan() WsEndUser of Aruba, you can change the name assigned to a VLAN.
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 SetRenameVLan(
int vLanResourceId,
string vLanName
)
<OperationContractAttribute>
Function SetRenameVLan (
vLanResourceId As Integer,
vLanName As String
) As WsResult
[OperationContractAttribute]
WsResult^ SetRenameVLan(
int vLanResourceId,
String^ vLanName
)
[<OperationContractAttribute>]
abstract SetRenameVLan :
vLanResourceId : int *
vLanName : string -> WsResult
function SetRenameVLan(
vLanResourceId : int,
vLanName : String
) : WsResult
Parameters
- vLanResourceId
- Type: SystemInt32
Value of type System.Int32 which is the unique identifier of the resource type you want to rename VLANs.
- vLanName
- Type: SystemString
Value of type System.String that represents the new name you want to assign to the 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 RenameVLan(), which means a call to SetRenameVLan ()
WsEndUser of Aruba, assign a new name to the VLAN with resource code 4762.
private static void RenameVLan(WsEndUserClient client)
{
try
{
WsResult result = client.SetRenameVLan(4762, "Old VLan");
if (!result.Success)
{
throw new ApplicationException(String.Format(
"An error has occurred while invoking SetRenameVLan(). {0}", result.ResultMessage));
}
}
catch (Exception ex)
{
throw new ApplicationException(
String.Format("An error has occurred while renaming a VLan {0}", ex.Message));
}
}
See Also