Create new MAC filter template.
Since Product Version: 3.2
Resource Information
Rate Limiting?
|
No
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Write
|
HTTP Methods
|
|
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 URL
/webacs/api/v1/op/macFilter/macFilterTemplate
Request Payload Parameters
description
String
|
Required
The description of the MAC filter template.
|
deviceType
MacFilterDeviceTypeEnum
|
Required
The device type.
|
interfaceName
String
|
The name of the WLAN interface.
|
macAddress
MacAddress
|
Required
The MAC address.
|
path
String
|
Full name of folder where the template is stored. If this attribute is not specified template will be put to default "My Templates" folder.
|
profileName
String
|
Required
The WLAN Profile Name association for MAC Filtering is not supported for NGWC Devices. If the Template is created for NGWC Device, then Profile Name should be 'Any Profile'.
You can use the
WlanProfiles API for getting a list of profiles.
|
templateName
String
|
Required
The name of the MAC filter template.
|
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/v1/op/macFilter/macFilterTemplate
<?xml version="1.0" ?>
<createMacFilterTemplateDTO>
<description>String value</description>
<interfaceName>String value</interfaceName>
<profileName>String value</profileName>
<templateName>String value</templateName>
<deviceType>CUWN</deviceType>
<macAddress>
<octets>000a959d6816</octets>
</macAddress>
<path>String value</path>
</createMacFilterTemplateDTO>
Sample JSON Request Payload
https://localhost/webacs/api/v1/op/macFilter/macFilterTemplate.json
{
"createMacFilterTemplateDTO" : {
"description" : "String value",
"interfaceName" : "String value",
"profileName" : "String value",
"templateName" : "String value",
"deviceType" : "CUWN",
"macAddress" : {
"octets" : "000a959d6816"
},
"path" : "String value"
}
}
Resource Information
Rate Limiting?
|
No
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Write
|
HTTP Methods
|
|
Resource URL
/webacs/api/v2/op/macFilter/macFilterTemplate
Unmodified
This resource has not been modified since the previous API version.
Request Payload Parameters
description
String
|
Required
The description of the MAC filter template.
|
deviceType
MacFilterDeviceTypeEnum
|
Required
The device type.
|
interfaceName
String
|
The name of the WLAN interface.
|
macAddress
MacAddress
|
Required
The MAC address.
|
path
String
|
Full name of folder where the template is stored. If this attribute is not specified template will be put to default "My Templates" folder.
|
profileName
String
|
Required
The WLAN Profile Name association for MAC Filtering is not supported for NGWC Devices. If the Template is created for NGWC Device, then Profile Name should be 'Any Profile'.
You can use the
WlanProfiles API for getting a list of profiles.
|
templateName
String
|
Required
The name of the MAC filter template.
|
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/v2/op/macFilter/macFilterTemplate
<?xml version="1.0" ?>
<createMacFilterTemplateDTO>
<description>String value</description>
<interfaceName>String value</interfaceName>
<profileName>String value</profileName>
<templateName>String value</templateName>
<deviceType>CUWN</deviceType>
<macAddress>
<octets>000a959d6816</octets>
</macAddress>
<path>String value</path>
</createMacFilterTemplateDTO>
Sample JSON Request Payload
https://localhost/webacs/api/v2/op/macFilter/macFilterTemplate.json
{
"createMacFilterTemplateDTO" : {
"description" : "String value",
"deviceType" : "CUWN",
"interfaceName" : "String value",
"macAddress" : {
"octets" : "000a959d6816"
},
"path" : "String value",
"profileName" : "String value",
"templateName" : "String value"
}
}
Resource Information
Rate Limiting?
|
No
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Write
|
HTTP Methods
|
|
Resource URL
/webacs/api/v3/op/macFilter/macFilterTemplate
Unmodified
This resource has not been modified since the previous API version.
Request Payload Parameters
description
String
|
Required
The description of the MAC filter template.
|
deviceType
MacFilterDeviceTypeEnum
|
Required
The device type.
|
interfaceName
String
|
The name of the WLAN interface.
|
macAddress
MacAddress
|
Required
The MAC address.
|
path
String
|
Full name of folder where the template is stored. If this attribute is not specified template will be put to default "My Templates" folder.
|
profileName
String
|
Required
The WLAN Profile Name association for MAC Filtering is not supported for NGWC Devices. If the Template is created for NGWC Device, then Profile Name should be 'Any Profile'.
You can use the
WlanProfiles API for getting a list of profiles.
|
templateName
String
|
Required
The name of the MAC filter template.
|
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/v3/op/macFilter/macFilterTemplate
<?xml version="1.0" ?>
<createMacFilterTemplateDTO>
<description>String value</description>
<interfaceName>String value</interfaceName>
<profileName>String value</profileName>
<templateName>String value</templateName>
<deviceType>CUWN</deviceType>
<macAddress>
<octets>000a959d6816</octets>
</macAddress>
<path>String value</path>
</createMacFilterTemplateDTO>
Sample JSON Request Payload
https://localhost/webacs/api/v3/op/macFilter/macFilterTemplate.json
{
"createMacFilterTemplateDTO" : {
"description" : "String value",
"deviceType" : "CUWN",
"interfaceName" : "String value",
"macAddress" : {
"octets" : "000a959d6816"
},
"path" : "String value",
"profileName" : "String value",
"templateName" : "String value"
}
}
Resource Information
Rate Limiting?
|
No
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Write
|
HTTP Methods
|
|
Resource URL
/webacs/api/v4/op/macFilter/macFilterTemplate
Unmodified
This resource has not been modified since the previous API version.
Request Payload Parameters
description
String
|
Required
The description of the MAC filter template.
|
deviceType
MacFilterDeviceTypeEnum
|
Required
The device type.
|
interfaceName
String
|
The name of the WLAN interface.
|
macAddress
MacAddress
|
Required
The MAC address.
|
path
String
|
Full name of folder where the template is stored. If this attribute is not specified template will be put to default "My Templates" folder.
|
profileName
String
|
Required
The WLAN Profile Name association for MAC Filtering is not supported for NGWC Devices. If the Template is created for NGWC Device, then Profile Name should be 'Any Profile'.
You can use the
WlanProfiles API for getting a list of profiles.
|
templateName
String
|
Required
The name of the MAC filter template.
|
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/macFilter/macFilterTemplate
<?xml version="1.0" ?>
<createMacFilterTemplateDTO>
<description>String value</description>
<interfaceName>String value</interfaceName>
<profileName>String value</profileName>
<templateName>String value</templateName>
<deviceType>CUWN</deviceType>
<macAddress>
<octets>000a959d6816</octets>
</macAddress>
<path>String value</path>
</createMacFilterTemplateDTO>
Sample JSON Request Payload
https://localhost/webacs/api/v4/op/macFilter/macFilterTemplate.json
{
"createMacFilterTemplateDTO" : {
"description" : "String value",
"deviceType" : "CUWN",
"interfaceName" : "String value",
"macAddress" : {
"octets" : "000a959d6816"
},
"path" : "String value",
"profileName" : "String value",
"templateName" : "String value"
}
}