
Cisco Evolved Programmable Network Manager API
Evolved Programmable Network Manager API Documentation

# GET RogueApDetectionHistory

Represents Rogue AP detection history data. Use alarmId or rogueMacAddress attribute to filter detection history for a certain Rogue AP.

Since Product Version: 3.6

- Jump To

- v1
- v2
- v3
- v4

API version v1 is deprecated

This API version has been deprecated. It will be removed in a future release of the product. Please develop new clients using the latest API version. Please modify your existing clients to use a later API version.

Resource unavailable for this API version

This resource was introduced in API version 4.

Resource unavailable for this API version

This resource was introduced in API version 4.

Resource unavailable for this API version

This resource was introduced in API version 4.

### Resource Information

Rate Limiting? | Yes
Sorting? | Yes
Paging? | Yes
Filtering? | Yes
Group Filtering? | Yes
Aggregation? | Yes
Response Formats | xml json
User Group | NBI Read
HTTP Methods | GET

## Resource URL

/webacs/api/v4/data/RogueApDetectionHistory

To filter entities based on device groups, use Group Based Filtering as documented on the Filtering page on the Home page. Example: ?.group=myrouters

## Response Parameters

Attribute | Description
--- | ---
alarmId long | Id of the Rogue AP alarm.
category String | Specifies the major category for the Rogue AP alarm.
channelNumber int | Channel number of the Rogue AP.
classificationType RogueApClassificationTypeEnum | Rogue AP Classification Type. Allowed values FRIENDLY MALICIOUS UNCLASSIFIED CUSTOM
containmentLevel RogueApContainmentLevelEnum | Containment level. Allowed values UNASSIGNED LEVEL_1 LEVEL_2 LEVEL_3 LEVEL_4
createTime Date | Alarm creation time.
deviceIpAddress InetAddress | Detecting device IP address.
eventTime Date | Event time.
lradMacAddress MacAddress | Detecting AP MAC address.
lradSlotId int | Detecting AP slot Id.
message String | Contains the Event/Alarm description as free text.
onNetwork boolean | Indicates whether or not the Rogue AP is located on the network.
onWire boolean | Indicates whether or not the Rogue AP is attached to the wired network.
radioTypeDot11a boolean | Indicates if Rogue Access Point supports 802.11a standard.
radioTypeDot11ac boolean | Indicates if Rogue Access Point supports 802.11ac standard.
radioTypeDot11b boolean | Indicates if Rogue Access Point supports 802.11b standard.
radioTypeDot11g boolean | Indicates if Rogue Access Point supports 802.11g standard.
radioTypeDot11n2_4ghz boolean | Indicates if Rogue Access Point supports 802.11n 2.4GHz standard.
radioTypeDot11n5ghz boolean | Indicates if Rogue Access Point supports 802.11n 5GHz standard.
rogueClients int | Count of Rogue Clients associated to the alarmed Access Point.
rogueMacAddress MacAddress | Rogue MAC address.
rssi int | Indicates the strongest Received Signal Strength Indicator in dBm.
severity AlarmSeverityEnum | Specifies the Event/Alarm severity. Allowed values CRITICAL MAJOR MINOR WARNING CLEARED INFORMATION
ssid String | Service Set Identifier being broadcast by the Rogue Access Point Radio.
state RogueApStateEnum | Indicates the state of the Rogue Access Point. Allowed values INITIALIZING PENDING ALERT AIRESPACE_AP KNOWN ACKNOWLEDGED CONTAINED THREAT CONTAINED_PENDING KNOWN_CONTAINED TRUSTED_MISSING REMOVED WIRE_CONTAINED
switchPortTraceStatus RogueApSwitchPortTraceStatusEnum | Switch Port trace status Allowed values NOT_TRACED TRACED_AND_DETECTED_ON_NETWORK TRACED_AND_NOT_DETECTED_ON_NETWORK TRACED_AND_WIRED_CONTAINED TRACED_AND_POSSIBLY_ON_NETWORK TRACED_AND_TOO_MANY_PORTS_FOUND

## 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://10.64.88.203/webacs/api/v4/data/RogueApDetectionHistory/15

    <?xml version="1.0" ?>
    <queryResponse type="RogueApDetectionHistory" responseType="getEntity" requestUrl="https://10.64.88.203/webacs/api/v4/data/RogueApDetectionHistory/15" rootUrl="https://10.64.88.203/webacs/api/v4/data">
      <entity dtoType="rogueApDetectionHistoryDTO" type="RogueApDetectionHistory" url="https://10.64.88.203/webacs/api/v4/data/RogueApDetectionHistory/15">
        <rogueApDetectionHistoryDTO displayName="String value" id="15" uuid="String value">
          <alarmId>2</alarmId>
          <category>String value</category>
          <channelNumber>1</channelNumber>
          <classificationType>FRIENDLY</classificationType>
          <containmentLevel>UNASSIGNED</containmentLevel>
          <createTime>1986-07-24T00:00:00+05:30</createTime>
          <deviceIpAddress>
            <address>192.168.115.243</address>
          </deviceIpAddress>
          <eventTime>1986-07-24T00:00:00+05:30</eventTime>
          <lradMacAddress>
            <octets>000a959d6816</octets>
          </lradMacAddress>
          <lradSlotId>1</lradSlotId>
          <message>String value</message>
          <onNetwork>true</onNetwork>
          <onWire>true</onWire>
          <radioTypeDot11a>true</radioTypeDot11a>
          <radioTypeDot11ac>true</radioTypeDot11ac>
          <radioTypeDot11b>true</radioTypeDot11b>
          <radioTypeDot11g>true</radioTypeDot11g>
          <radioTypeDot11n2_4ghz>true</radioTypeDot11n2_4ghz>
          <radioTypeDot11n5ghz>true</radioTypeDot11n5ghz>
          <rogueClients>1</rogueClients>
          <rogueMacAddress>
            <octets>000a959d6816</octets>
          </rogueMacAddress>
          <rssi>1</rssi>
          <severity>CRITICAL</severity>
          <ssid>String value</ssid>
          <state>INITIALIZING</state>
          <switchPortTraceStatus>NOT_TRACED</switchPortTraceStatus>
        </rogueApDetectionHistoryDTO>
      </entity>
    </queryResponse>

### Sample JSON Payload

https://10.64.88.203/webacs/api/v4/data/RogueApDetectionHistory/15.json

    {
      "queryResponse" : {
        "@type" : "RogueApDetectionHistory",
        "@requestUrl" : "https://10.64.88.203/webacs/api/v4/data/RogueApDetectionHistory/15",
        "@responseType" : "getEntity",
        "@rootUrl" : "https://10.64.88.203/webacs/api/v4/data",
        "entity" : [ {
          "@dtoType" : "rogueApDetectionHistoryDTO",
          "@type" : "RogueApDetectionHistory",
          "@url" : "https://10.64.88.203/webacs/api/v4/data/RogueApDetectionHistory/15",
          "rogueApDetectionHistoryDTO" : {
            "@displayName" : "String value",
            "@id" : 15,
            "@uuid" : "String value",
            "alarmId" : 2,
            "category" : "String value",
            "channelNumber" : 1,
            "classificationType" : "FRIENDLY",
            "containmentLevel" : "UNASSIGNED",
            "createTime" : "1986-07-23T18:30:00.000Z",
            "deviceIpAddress" : {
              "address" : "192.168.115.243"
            },
            "eventTime" : "1986-07-23T18:30:00.000Z",
            "lradMacAddress" : {
              "octets" : "000a959d6816"
            },
            "lradSlotId" : 1,
            "message" : "String value",
            "onNetwork" : true,
            "onWire" : true,
            "radioTypeDot11a" : true,
            "radioTypeDot11ac" : true,
            "radioTypeDot11b" : true,
            "radioTypeDot11g" : true,
            "radioTypeDot11n2_4ghz" : true,
            "radioTypeDot11n5ghz" : true,
            "rogueClients" : 1,
            "rogueMacAddress" : {
              "octets" : "000a959d6816"
            },
            "rssi" : 1,
            "severity" : "CRITICAL",
            "ssid" : "String value",
            "state" : "INITIALIZING",
            "switchPortTraceStatus" : "NOT_TRACED"
          }
        } ]
      }
    }