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

POST wlanProvisioning/interface

Resource Information

Rate Limiting?

Yes

Sorting?

No

Paging?

No

Filtering?

No

Response Formats

xml

json

User Group

NBI Write

HTTP Methods

POST

Schedules a job to create an interface on a Wlan Controller.

Since Product Version: 2.2

Resource URL

/webacs/api/v1/op/wlanProvisioning/interface

Request Payload Parameters

Type Attribute Name Description

String

aclName

The access control list name for this interface. Optional, defaults to none; ignored if isGuestLan is true.

Long

controllerId

Identifies the controller to apply the changes to. Either controllerId or controllerName must be specified.

String

controllerName

Identifies the controller to apply the changes to. Either controllerId or controllerName must be specified.

Boolean

dhcpProtocolEnabled

Is DHCP option 82 enabled? Optional, defaults to false.

InetAddress

gateway

The gateway IP address for this interface. Ignored if isGuestLan is true.

Boolean

interfaceApManagementEnabled

Is dynamic AP management enabled? Optional, default to false; ignored if isGuestLan is true.

String

interfaceName

The name of the interface.

InetAddress

ipAddress

The IP address for this interface. Ignored if isGuestLan is true.

Boolean

isGuestLan

Is this a guest lan? Optional, defaults to false.

InetAddress

netMask

The network mask for this interface. Ignored if isGuestLan is true.

Integer

portNum

The primary port number.

InetAddress

primaryDhcpAddress

The primary DHCP server address. Ignored if isGuestLan is true.

Boolean

quarantineInterface

Is this a quarantined interface? Optional, defaults to false; ignored if isGuestLan is true.

Integer

quarantineVlanId

The quarantine vlan id for this interface. Ignored if quarantineInterface is false.

InetAddress

secondaryDhcpAddress

The secondary DHCP server address. Ignored if isGuestLan is true.

Integer

secondaryPortNum

The secondary port number. Optional.

Integer

vlanId

The vlan for this interface.

Response Parameters

Type Attribute Name Description

String

jobName

The unique job name for this job.

String

jobType

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://172.25.123.114/webacs/api/v1/op/wlanProvisioning/interface

<?xml version="1.0" ?>
<interface>
  <controllerId>15</controllerId>
  <controllerName>String value</controllerName>
  <aclName>String value</aclName>
  <dhcpProtocolEnabled>true</dhcpProtocolEnabled>
  <gateway>
    <address>192.168.115.243</address>
  </gateway>
  <interfaceApManagementEnabled>true</interfaceApManagementEnabled>
  <interfaceName>String value</interfaceName>
  <ipAddress>
    <address>192.168.115.243</address>
  </ipAddress>
  <isGuestLan>true</isGuestLan>
  <netMask>
    <address>192.168.115.243</address>
  </netMask>
  <portNum>15</portNum>
  <primaryDhcpAddress>
    <address>192.168.115.243</address>
  </primaryDhcpAddress>
  <quarantineInterface>true</quarantineInterface>
  <quarantineVlanId>15</quarantineVlanId>
  <secondaryDhcpAddress>
    <address>192.168.115.243</address>
  </secondaryDhcpAddress>
  <secondaryPortNum>15</secondaryPortNum>
  <vlanId>15</vlanId>
</interface>

Sample JSON Request Payload

https://172.25.123.114/webacs/api/v1/op/wlanProvisioning/interface.json

{
  "interface" : {
    "controllerId" : 15,
    "controllerName" : "String value",
    "aclName" : "String value",
    "dhcpProtocolEnabled" : true,
    "gateway" : {
      "address" : "192.168.115.243"
    },
    "interfaceApManagementEnabled" : true,
    "interfaceName" : "String value",
    "ipAddress" : {
      "address" : "192.168.115.243"
    },
    "isGuestLan" : true,
    "netMask" : {
      "address" : "192.168.115.243"
    },
    "portNum" : 15,
    "primaryDhcpAddress" : {
      "address" : "192.168.115.243"
    },
    "quarantineInterface" : true,
    "quarantineVlanId" : 15,
    "secondaryDhcpAddress" : {
      "address" : "192.168.115.243"
    },
    "secondaryPortNum" : 15,
    "vlanId" : 15
  }
}

Sample XML Response Payload

https://172.25.123.114/webacs/api/v1/op/wlanProvisioning/interface

<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="../../../../pages/common/login.jsp.html" rootUrl="https://172.25.123.114/webacs/api/v1/op/">
  <jobInformation>
    <jobName>String value</jobName>
    <jobType>String value</jobType>
  </jobInformation>
</mgmtResponse>

Sample JSON Response Payload

https://172.25.123.114/webacs/api/v1/op/wlanProvisioning/interface.json

{
  "mgmtResponse" : {
    "@responseType" : "operation",
    "@requestUrl" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/op\/wlanProvisioning\/interface",
    "@rootUrl" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/op\/",
    "jobInformation" : {
      "jobName" : "String value",
      "jobType" : "String value"
    }
  }
}