Represents detail information about a WLAN controller.
Since Product Version: 1.2
Resource Information
Rate Limiting? |
Yes |
Sorting? |
Yes |
Paging? |
Yes |
Filtering? |
Yes |
Aggregation? |
Yes |
Response Formats |
xml json |
User Group |
NBI Read |
HTTP Methods |
GET |
DevNet Discussions
Resource URL
/webacs/api/v1/data/WlanControllerDetailsResponse Parameters
Attribute | Description |
---|---|
alarmStatus AlarmSeverityEnum |
Alarm status Allowed values: |
apCount int |
Number of access points associated with the controller |
AP groups and their profiles for this device. |
|
apLimit long |
Number of access points supported by the controller. |
auditStatus AuditStatusEnum |
Audit status Allowed values: |
autoRefresh boolean |
Auto refresh state |
capwapTransportMode String |
Current CAPWAP transport mode |
CDP neighbors for this controller. |
|
contact String |
System contact |
cryptoCard1Supported String |
Crypto Card One is present. Allowed values: Absent, Present |
cryptoCard2Supported String |
Crypto Card Two is present. Allowed values: Absent, Present |
dot11aClientCount int |
Number of 802.11a/n clients associated with the controller |
dot11bClientCount int |
Number of 802.11bgn clients associated with the controller |
gigCardSupported String |
Gig Ethernet/Fiber Card is present. Allowed values: Absent, Present |
Interface groups for this device. |
|
Interfaces for this device. |
|
ipAddress String |
Management IP address of the WLAN controller |
lastBackup String |
The latest time backup time, as milliseconds from the Unix epoch. Zero if no backup were taken |
User roles for this device. |
|
location String |
Device location set in MIB2 |
macAddress String |
Burned-in MAC address |
mobilityGroupName String |
Mobility group name |
modelNumber String |
Model number |
name String |
Device name |
numberOfAPsSupported int |
Number of APs supported |
Represents port information for this controller. |
|
productDescription String |
Product description |
reachabilityStatus boolean |
SNMP reachability |
rfGroupName String |
RF group name |
serialNumber String |
Serial number |
softwareVersion String |
Software version running on the controller |
type String |
Device type |
Sample Payloads
Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.
Sample XML Payload
https://localhost/webacs/api/v1/data/WlanControllerDetails/15
<?xml version="1.0" ?>
<queryResponse type="WlanControllerDetails" responseType="getEntity" requestUrl="https://localhost/webacs/api/v1/data/WlanControllerDetails/15" rootUrl="https://localhost/webacs/api/v1/data">
<entity dtoType="wlanControllerDetailsDTO" type="WlanControllerDetails" url="https://localhost/webacs/api/v1/data/WlanControllerDetails/15">
<wlanControllerDetailsDTO displayName="String value" id="15" uuid="String value">
<alarmStatus>CRITICAL</alarmStatus>
<apCount>1</apCount>
<apGroups>
<apGroup>
<apGroupDescription>String value</apGroupDescription>
<apGroupName>String value</apGroupName>
<apGroupProfileMappings>
<apGroupProfileMapping>
<interfaceName>String value</interfaceName>
<nacOverrideSupport>true</nacOverrideSupport>
<profileName>String value</profileName>
<ssid>String value</ssid>
</apGroupProfileMapping>
</apGroupProfileMappings>
</apGroup>
</apGroups>
<apLimit>2</apLimit>
<auditStatus>NA</auditStatus>
<autoRefresh>true</autoRefresh>
<capwapTransportMode>String value</capwapTransportMode>
<cdpNeighbors>
<cdpNeighbor>
<duplexMode>NA</duplexMode>
<farEndInterface>String value</farEndInterface>
<interfaceIndex>1</interfaceIndex>
<nearEndInterface>String value</nearEndInterface>
<neighborCapabilities>String value</neighborCapabilities>
<neighborDeviceName>String value</neighborDeviceName>
<neighborDevicePlatformType>String value</neighborDevicePlatformType>
<neighborVersion>String value</neighborVersion>
</cdpNeighbor>
</cdpNeighbors>
<contact>String value</contact>
<cryptoCard1Supported>String value</cryptoCard1Supported>
<cryptoCard2Supported>String value</cryptoCard2Supported>
<dot11aClientCount>1</dot11aClientCount>
<dot11bClientCount>1</dot11bClientCount>
<gigCardSupported>String value</gigCardSupported>
<interfaceGroups>
<interfaceGroup>
<interfaceGroupDescription>String value</interfaceGroupDescription>
<interfaceGroupName>String value</interfaceGroupName>
<interfaceMappings>
<interfaceMapping>
<interfaceName>String value</interfaceName>
</interfaceMapping>
</interfaceMappings>
<mdnsProfileName>String value</mdnsProfileName>
<quarantineInterface>true</quarantineInterface>
</interfaceGroup>
</interfaceGroups>
<interfaces>
<interface>
<aclName>String value</aclName>
<dhcpOption82Enabled>true</dhcpOption82Enabled>
<dhcpProtocolEnabled>true</dhcpProtocolEnabled>
<dnsHostname>String value</dnsHostname>
<gateway>
<address>192.168.115.243</address>
</gateway>
<interfaceApManagementEnabled>true</interfaceApManagementEnabled>
<interfaceName>String value</interfaceName>
<interfaceType>STATIC</interfaceType>
<ipAddress>
<address>192.168.115.243</address>
</ipAddress>
<isGuestLan>true</isGuestLan>
<macAddress>
<octets>000a959d6816</octets>
</macAddress>
<mdnsProfileName>String value</mdnsProfileName>
<netMask>
<address>192.168.115.243</address>
</netMask>
<portNum>1</portNum>
<primaryDhcpAddress>
<address>192.168.115.243</address>
</primaryDhcpAddress>
<quarantineInterface>true</quarantineInterface>
<quarantineVlanId>1</quarantineVlanId>
<secondaryDhcpAddress>
<address>192.168.115.243</address>
</secondaryDhcpAddress>
<secondaryPortNum>1</secondaryPortNum>
<vlanId>1</vlanId>
</interface>
</interfaces>
<ipAddress>String value</ipAddress>
<lastBackup>String value</lastBackup>
<localNetUserRoles>
<localNetUserRole>
<roleName>String value</roleName>
</localNetUserRole>
</localNetUserRoles>
<location>String value</location>
<macAddress>String value</macAddress>
<mobilityGroupName>String value</mobilityGroupName>
<modelNumber>String value</modelNumber>
<name>String value</name>
<numberOfAPsSupported>1</numberOfAPsSupported>
<ports>
<port>
<adminStatus>UNKNOWN</adminStatus>
<desiredDuplexMode>UNKNOWN</desiredDuplexMode>
<portNumber>1</portNumber>
</port>
</ports>
<productDescription>String value</productDescription>
<reachabilityStatus>true</reachabilityStatus>
<rfGroupName>String value</rfGroupName>
<serialNumber>String value</serialNumber>
<softwareVersion>String value</softwareVersion>
<type>String value</type>
</wlanControllerDetailsDTO>
</entity>
</queryResponse>
Sample JSON Payload
https://localhost/webacs/api/v1/data/WlanControllerDetails/15.json
{
"queryResponse" : {
"@type" : "WlanControllerDetails",
"@responseType" : "getEntity",
"@requestUrl" : "https : \/\/localhost\/webacs\/api\/v1\/data\/WlanControllerDetails\/15",
"@rootUrl" : "https : \/\/localhost\/webacs\/api\/v1\/data",
"entity" : {
"@dtoType" : "wlanControllerDetailsDTO",
"@type" : "WlanControllerDetails",
"@url" : "https : \/\/localhost\/webacs\/api\/v1\/data\/WlanControllerDetails\/15",
"wlanControllerDetailsDTO" : {
"@displayName" : "String value",
"@id" : "15",
"@uuid" : "String value",
"alarmStatus" : "CRITICAL",
"apCount" : 1,
"apGroups" : {
"apGroup" : {
"apGroupDescription" : "String value",
"apGroupName" : "String value",
"apGroupProfileMappings" : {
"apGroupProfileMapping" : {
"interfaceName" : "String value",
"nacOverrideSupport" : true,
"profileName" : "String value",
"ssid" : "String value"
}
}
}
},
"apLimit" : 2,
"auditStatus" : "NA",
"autoRefresh" : true,
"capwapTransportMode" : "String value",
"cdpNeighbors" : {
"cdpNeighbor" : {
"duplexMode" : "NA",
"farEndInterface" : "String value",
"interfaceIndex" : 1,
"nearEndInterface" : "String value",
"neighborCapabilities" : "String value",
"neighborDeviceName" : "String value",
"neighborDevicePlatformType" : "String value",
"neighborVersion" : "String value"
}
},
"contact" : "String value",
"cryptoCard1Supported" : "String value",
"cryptoCard2Supported" : "String value",
"dot11aClientCount" : 1,
"dot11bClientCount" : 1,
"gigCardSupported" : "String value",
"interfaceGroups" : {
"interfaceGroup" : {
"interfaceGroupDescription" : "String value",
"interfaceGroupName" : "String value",
"interfaceMappings" : {
"interfaceMapping" : {
"interfaceName" : "String value"
}
},
"mdnsProfileName" : "String value",
"quarantineInterface" : true
}
},
"interfaces" : {
"interface" : {
"aclName" : "String value",
"dhcpOption82Enabled" : true,
"dhcpProtocolEnabled" : true,
"dnsHostname" : "String value",
"gateway" : {
"address" : "192.168.115.243"
},
"interfaceApManagementEnabled" : true,
"interfaceName" : "String value",
"interfaceType" : "STATIC",
"ipAddress" : {
"address" : "192.168.115.243"
},
"isGuestLan" : true,
"macAddress" : {
"octets" : "000a959d6816"
},
"mdnsProfileName" : "String value",
"netMask" : {
"address" : "192.168.115.243"
},
"portNum" : 1,
"primaryDhcpAddress" : {
"address" : "192.168.115.243"
},
"quarantineInterface" : true,
"quarantineVlanId" : 1,
"secondaryDhcpAddress" : {
"address" : "192.168.115.243"
},
"secondaryPortNum" : 1,
"vlanId" : 1
}
},
"ipAddress" : "String value",
"lastBackup" : "String value",
"localNetUserRoles" : {
"localNetUserRole" : {
"roleName" : "String value"
}
},
"location" : "String value",
"macAddress" : "String value",
"mobilityGroupName" : "String value",
"modelNumber" : "String value",
"name" : "String value",
"numberOfAPsSupported" : 1,
"ports" : {
"port" : {
"adminStatus" : "UNKNOWN",
"desiredDuplexMode" : "UNKNOWN",
"portNumber" : 1
}
},
"productDescription" : "String value",
"reachabilityStatus" : true,
"rfGroupName" : "String value",
"serialNumber" : "String value",
"softwareVersion" : "String value",
"type" : "String value"
}
}
}
}