Configures a classification type and state for rogue access points. The classification change can be performed only for non-cleared rogue AP alarms. To get the current classification type and rogue state, see the "rogueApAlarmDetails.classificationType" and "rogueApAlarmDetails.state" response parameters from the "GET data/RogueApAlarms" resource.
Since Product Version: 3.4
Resource Information
Rate Limiting? |
No |
Sorting? |
No |
Paging? |
No |
Filtering? |
No |
Group Filtering? |
No |
Aggregation? |
No |
Response Formats |
xml json |
User Group |
NBI Write |
HTTP Methods |
PUT |
Resource URL
/webacs/api/v4/op/rogueAp/classificationRequest Payload Parameters
Attribute | Description |
---|---|
classificationTypeAndRogueState ClassificationTypeAndRogueState |
Classification type and rogue state which can be configured manually. Mandatory. UNCLASSIFIED_ALERT - classification is UNCLASSIFIED and state is ALERT, MALICIOUS_ALERT - classification is MALICIOUS and state is ALERT, FRIENDLY_EXTERNAL - classification is FRIENDLY and state is ACKNOWLEDGED (or EXTERNAL), FRIENDLY_INTERNAL - classification is FRIENDLY and state is KNOWN (or INTERNAL) Allowed values:
|
rogueApAlarmId Long |
Rogue access point alarm ID. Can be retrieved from the "GET data/RogueApAlarms" resource. Either rogueApAlarmId or rogueApMacAddress must be specified. The attribute rogueApMacAddress will be ignored if rogueApAlarmId is specified. |
rogueApMacAddress MacAddress |
MAC address of the rogue access point. Can be retrieved from the "GET data/RogueApAlarms" resource. Either rogueApAlarmId or rogueApMacAddress must be specified. The attribute rogueApMacAddress will be ignored if rogueApAlarmId is specified. |
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 Request Payload
https://localhost/webacs/api/v4/op/rogueAp/classification
<?xml version="1.0" ?>
<rogueApClassificationDTO>
<classificationTypeAndRogueState>UNCLASSIFIED_ALERT</classificationTypeAndRogueState>
<rogueApAlarmId>15</rogueApAlarmId>
<rogueApMacAddress>
<octets>000a959d6816</octets>
</rogueApMacAddress>
</rogueApClassificationDTO>
Sample JSON Request Payload
https://localhost/webacs/api/v4/op/rogueAp/classification.json
{
"rogueApClassificationDTO" : {
"classificationTypeAndRogueState" : "UNCLASSIFIED_ALERT",
"rogueApAlarmId" : 15,
"rogueApMacAddress" : {
"octets" : "000a959d6816"
}
}
}