Owner's Manual

Table 25. Middlebox Port Objects and Attributes

Attribute Type Mandatory for POST

request?

Description

MiddleBoxPortId String Yes IP address of the

middlebox port

MiddleBoxPortName String No Name of the middlebox

port

MiddleBoxPortDescriptio

String No Description of the

middlebox port

MiddleBoxPortIp String No IP address of the device

connected to the

middlebox port

MiddleBoxPortMac String No MAC address of the

device connected to the

middlebox port

REST Information Retrieval

To retrieve the following information, use the REST APIs :

• All instances of a resource (for example, using GET to view all configuration information for all

tenants)

• A single, specific instance of a resource (for example, configuration information for an identified

tenant)

• Resource instances that match specified criteria (for example, configuration information for all tenants

with names that include certain letters)

Viewing Information

All data is returned in JSON format. REST APIs use the following format for general information retrieval

or view requests (as specified in RFC 3986):

<scheme>://<authority>[:<port>]/sdnc/v<version-number>/<dataset-type>/<resource-

type>/[<resource-key> | ALL]?<query>

, where <resource-type> can optionally be multi-part (by separating items with a /) and the

<resource-type>/[<resource-key> tuple can be repeated multiple times. The following list

contains some examples of REST APIs:

• To view configuration information for all providers, enter http://{ControllerIP}/afcui/

sdnc/v1/providers/*

• To view all configuration information for provider with {providerId} = “pro-1,” enter http://

{ControllerIP}/afcui/sdnc/v1/providers/pro-1

• To view all networks for provider with {providerId} = “pro-1,” enter http://{ControllerIP}/

afcui/sdnc/v1/networks/*@pro-1

• To view information for a specific network (net-10) of a provider (pro-1), enter http://

{ControllerIP}/afcui/sdnc/v1/networks/net-10@pro-1

• To view aggregate statistics for all switches, enter http://{ControllerIP}/afcui/sdnc/v1/

counters/switches/*

REST APIs