Schedules a job to create an interface group on a Wlan Controller.
Since Product Version: 2.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/wlanProvisioning/interfaceGroup
Request Payload Parameters
controllerId
Long
|
Identifies the controller to apply the changes to. Either controllerId or controllerName must be specified.
|
controllerName
String
|
Identifies the controller to apply the changes to. Either controllerId or controllerName must be specified.
|
interfaceGroupDescription
String
|
A description of the interface group. Optional.
|
interfaceGroupName
String
|
Names the interface group.
|
interfaceMappings
InterfaceMapping[]
|
The list of interfaces mapped into this interface group.
|
interfaceName
String
|
The name of the interface mapped into the interface group.
|
|
mdnsProfileName
String
|
The mDNS profile name for this group. Optional, defaults to none.
|
quarantineInterface
Boolean
|
Is a quarantine VLAN enabled? If true, ensure all interfaces mapped to this group are quarantine interfaces; if false, ensure all interfaces mapped to this group are non-quarantine interfaces. Optional, defaults to false.
|
Response Parameters
jobName
String
|
The unique job name for this job.
|
jobType
String
|
The non-unique job type for this job.
|
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/wlanProvisioning/interfaceGroup
<?xml version="1.0" ?>
<interfaceGroup>
<controllerId>15</controllerId>
<controllerName>String value</controllerName>
<interfaceGroupDescription>String value</interfaceGroupDescription>
<interfaceGroupName>String value</interfaceGroupName>
<interfaceMappings>
<interfaceMapping>
<interfaceName>String value</interfaceName>
</interfaceMapping>
</interfaceMappings>
<mdnsProfileName>String value</mdnsProfileName>
<quarantineInterface>true</quarantineInterface>
</interfaceGroup>
Sample JSON Request Payload
https://localhost/webacs/api/v1/op/wlanProvisioning/interfaceGroup.json
{
"interfaceGroup" : {
"controllerId" : 15,
"controllerName" : "String value",
"interfaceGroupDescription" : "String value",
"interfaceGroupName" : "String value",
"interfaceMappings" : {
"interfaceMapping" : {
"interfaceName" : "String value"
}
},
"mdnsProfileName" : "String value",
"quarantineInterface" : true
}
}
Sample XML Response Payload
https://localhost/webacs/api/v1/op/wlanProvisioning/interfaceGroup
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v1/op/wlanProvisioning/interfaceGroup" rootUrl="https://localhost/webacs/api/v1/op">
<jobInformation>
<jobName>String value</jobName>
<jobType>String value</jobType>
</jobInformation>
</mgmtResponse>
Sample JSON Response Payload
https://localhost/webacs/api/v1/op/wlanProvisioning/interfaceGroup.json
{
"mgmtResponse" : {
"@responseType" : "operation",
"@requestUrl" : "https : \/\/localhost\/webacs\/api\/v1\/op\/wlanProvisioning\/interfaceGroup",
"@rootUrl" : "https : \/\/localhost\/webacs\/api\/v1\/op",
"jobInformation" : {
"jobName" : "String value",
"jobType" : "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/wlanProvisioning/interfaceGroup
Unmodified
This resource has not been modified since the previous API version.
Request Payload Parameters
controllerId
Long
|
Identifies the controller to apply the changes to. Either controllerId or controllerName must be specified.
|
controllerName
String
|
Identifies the controller to apply the changes to. Either controllerId or controllerName must be specified.
|
interfaceGroupDescription
String
|
A description of the interface group. Optional.
|
interfaceGroupName
String
|
Names the interface group.
|
interfaceMappings
InterfaceMapping[]
|
The list of interfaces mapped into this interface group.
|
interfaceName
String
|
The name of the interface mapped into the interface group.
|
|
mdnsProfileName
String
|
The mDNS profile name for this group. Optional, defaults to none.
|
quarantineInterface
Boolean
|
Is a quarantine VLAN enabled? If true, ensure all interfaces mapped to this group are quarantine interfaces; if false, ensure all interfaces mapped to this group are non-quarantine interfaces. Optional, defaults to false.
|
Response Parameters
jobName
String
|
The unique job name for this job.
|
jobType
String
|
The non-unique job type for this job.
|
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/wlanProvisioning/interfaceGroup
<?xml version="1.0" ?>
<interfaceGroup>
<controllerId>15</controllerId>
<controllerName>String value</controllerName>
<interfaceGroupDescription>String value</interfaceGroupDescription>
<interfaceGroupName>String value</interfaceGroupName>
<interfaceMappings>
<interfaceMapping>
<interfaceName>String value</interfaceName>
</interfaceMapping>
</interfaceMappings>
<mdnsProfileName>String value</mdnsProfileName>
<quarantineInterface>true</quarantineInterface>
</interfaceGroup>
Sample JSON Request Payload
https://localhost/webacs/api/v2/op/wlanProvisioning/interfaceGroup.json
{
"interfaceGroup" : {
"controllerId" : 15,
"controllerName" : "String value",
"interfaceGroupDescription" : "String value",
"interfaceGroupName" : "String value",
"interfaceMappings" : {
"interfaceMapping" : [ {
"interfaceName" : "String value"
} ]
},
"mdnsProfileName" : "String value",
"quarantineInterface" : true
}
}
Sample XML Response Payload
https://localhost/webacs/api/v2/op/wlanProvisioning/interfaceGroup
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v2/op/wlanProvisioning/interfaceGroup" rootUrl="https://localhost/webacs/api/v2/op">
<jobInformation>
<jobName>String value</jobName>
<jobType>String value</jobType>
</jobInformation>
</mgmtResponse>
Sample JSON Response Payload
https://localhost/webacs/api/v2/op/wlanProvisioning/interfaceGroup.json
{
"mgmtResponse" : {
"@requestUrl" : "https://localhost/webacs/api/v2/op/wlanProvisioning/interfaceGroup",
"@responseType" : "operation",
"@rootUrl" : "https://localhost/webacs/api/v2/op",
"jobInformation" : [ {
"jobName" : "String value",
"jobType" : "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/wlanProvisioning/interfaceGroup
Unmodified
This resource has not been modified since the previous API version.
Request Payload Parameters
controllerId
Long
|
Identifies the controller to apply the changes to. Either controllerId or controllerName must be specified.
|
controllerName
String
|
Identifies the controller to apply the changes to. Either controllerId or controllerName must be specified.
|
interfaceGroupDescription
String
|
A description of the interface group. Optional.
|
interfaceGroupName
String
|
Names the interface group.
|
interfaceMappings
InterfaceMapping[]
|
The list of interfaces mapped into this interface group.
|
interfaceName
String
|
The name of the interface mapped into the interface group.
|
|
mdnsProfileName
String
|
The mDNS profile name for this group. Optional, defaults to none.
|
quarantineInterface
Boolean
|
Is a quarantine VLAN enabled? If true, ensure all interfaces mapped to this group are quarantine interfaces; if false, ensure all interfaces mapped to this group are non-quarantine interfaces. Optional, defaults to false.
|
Response Parameters
jobName
String
|
The unique job name for this job.
|
jobType
String
|
The non-unique job type for this job.
|
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/wlanProvisioning/interfaceGroup
<?xml version="1.0" ?>
<interfaceGroup>
<controllerId>15</controllerId>
<controllerName>String value</controllerName>
<interfaceGroupDescription>String value</interfaceGroupDescription>
<interfaceGroupName>String value</interfaceGroupName>
<interfaceMappings>
<interfaceMapping>
<interfaceName>String value</interfaceName>
</interfaceMapping>
<interfaceMapping>
<interfaceName>Another string value</interfaceName>
</interfaceMapping>
</interfaceMappings>
<mdnsProfileName>String value</mdnsProfileName>
<quarantineInterface>true</quarantineInterface>
</interfaceGroup>
Sample JSON Request Payload
https://localhost/webacs/api/v3/op/wlanProvisioning/interfaceGroup.json
{
"interfaceGroup" : {
"controllerId" : 15,
"controllerName" : "String value",
"interfaceGroupDescription" : "String value",
"interfaceGroupName" : "String value",
"interfaceMappings" : {
"interfaceMapping" : [ {
"interfaceName" : "String value"
}, {
"interfaceName" : "Another string value"
} ]
},
"mdnsProfileName" : "String value",
"quarantineInterface" : true
}
}
Sample XML Response Payload
https://localhost/webacs/api/v3/op/wlanProvisioning/interfaceGroup
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v3/op/wlanProvisioning/interfaceGroup" rootUrl="https://localhost/webacs/api/v3/op">
<jobInformation>
<jobName>String value</jobName>
<jobType>String value</jobType>
</jobInformation>
</mgmtResponse>
Sample JSON Response Payload
https://localhost/webacs/api/v3/op/wlanProvisioning/interfaceGroup.json
{
"mgmtResponse" : {
"@requestUrl" : "https://localhost/webacs/api/v3/op/wlanProvisioning/interfaceGroup",
"@responseType" : "operation",
"@rootUrl" : "https://localhost/webacs/api/v3/op",
"jobInformation" : [ {
"jobName" : "String value",
"jobType" : "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/wlanProvisioning/interfaceGroup
Unmodified
This resource has not been modified since the previous API version.
Request Payload Parameters
controllerId
Long
|
Identifies the controller to apply the changes to. Either controllerId or controllerName must be specified.
|
controllerName
String
|
Identifies the controller to apply the changes to. Either controllerId or controllerName must be specified.
|
interfaceGroupDescription
String
|
A description of the interface group. Optional.
|
interfaceGroupName
String
|
Names the interface group.
|
interfaceMappings
InterfaceMapping[]
|
The list of interfaces mapped into this interface group.
|
interfaceName
String
|
The name of the interface mapped into the interface group.
|
|
mdnsProfileName
String
|
The mDNS profile name for this group. Optional, defaults to none.
|
quarantineInterface
Boolean
|
Is a quarantine VLAN enabled? If true, ensure all interfaces mapped to this group are quarantine interfaces; if false, ensure all interfaces mapped to this group are non-quarantine interfaces. Optional, defaults to false.
|
Response Parameters
jobName
String
|
The unique job name for this job.
|
jobType
String
|
The non-unique job type for this job.
|
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/wlanProvisioning/interfaceGroup
<?xml version="1.0" ?>
<interfaceGroup>
<controllerId>15</controllerId>
<controllerName>String value</controllerName>
<interfaceGroupDescription>String value</interfaceGroupDescription>
<interfaceGroupName>String value</interfaceGroupName>
<interfaceMappings>
<interfaceMapping>
<interfaceName>String value</interfaceName>
</interfaceMapping>
<interfaceMapping>
<interfaceName>Another string value</interfaceName>
</interfaceMapping>
</interfaceMappings>
<mdnsProfileName>String value</mdnsProfileName>
<quarantineInterface>true</quarantineInterface>
</interfaceGroup>
Sample JSON Request Payload
https://localhost/webacs/api/v4/op/wlanProvisioning/interfaceGroup.json
{
"interfaceGroup" : {
"controllerId" : 15,
"controllerName" : "String value",
"interfaceGroupDescription" : "String value",
"interfaceGroupName" : "String value",
"interfaceMappings" : {
"interfaceMapping" : [ {
"interfaceName" : "String value"
}, {
"interfaceName" : "Another string value"
} ]
},
"mdnsProfileName" : "String value",
"quarantineInterface" : true
}
}
Sample XML Response Payload
https://localhost/webacs/api/v4/op/wlanProvisioning/interfaceGroup
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v4/op/wlanProvisioning/interfaceGroup" rootUrl="https://localhost/webacs/api/v4/op">
<jobInformation>
<jobName>String value</jobName>
<jobType>String value</jobType>
</jobInformation>
</mgmtResponse>
Sample JSON Response Payload
https://localhost/webacs/api/v4/op/wlanProvisioning/interfaceGroup.json
{
"mgmtResponse" : {
"@requestUrl" : "https://localhost/webacs/api/v4/op/wlanProvisioning/interfaceGroup",
"@responseType" : "operation",
"@rootUrl" : "https://localhost/webacs/api/v4/op",
"jobInformation" : [ {
"jobName" : "String value",
"jobType" : "String value"
} ]
}
}