Cisco Prime Infrastructure API
Prime Infrastructure API Documentation

POST wlanProvisioning/interface

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

Since Product Version: 2.2

Resource Information

Rate Limiting?

Yes

Sorting?

No

Paging?

No

Filtering?

No

Aggregation?

No

Response Formats

xml

json

User Group

NBI Write

HTTP Methods

POST

DevNet Discussions

Resource URL

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

Request Payload Parameters

Attribute Description

aclName String

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

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.

dhcpProtocolEnabled Boolean

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

gateway InetAddress

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

interfaceApManagementEnabled Boolean

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

interfaceName String

The name of the interface.

ipAddress InetAddress

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

isGuestLan Boolean

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

netMask InetAddress

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

portNum Integer

The primary port number.

primaryDhcpAddress InetAddress

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

quarantineInterface Boolean

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

quarantineVlanId Integer

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

secondaryDhcpAddress InetAddress

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

secondaryPortNum Integer

The secondary port number. Optional.

vlanId Integer

The vlan for this interface.

Response Parameters

Attribute Description

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

<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v1/op/wlanProvisioning/interface" 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/interface.json

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