Setup Guide

Request Query Parameters

Following are the various request query parameters supported on REST.

• deep — Retrieves a resource with all the subresources inline.

• shallow — Retrieves a resource with no subresources inline.

• select — Client uses to select the nodes and subresources.

• with-defaults — Client uses to control and display the default data in GET request.

To request a ltered partial response, use the select query parameter in the following patterns to specify the nodes and subresources.

• Use a semicolon separated list to select multiple nodes.

• Use a/b to select a node b that is nested within node a. Use a/b/c to select a node c nested within b.

• Use expressions in parentheses ( ) after any selected node to request specic subnodes.

• Use the wildcard notation within parentheses (*) to specify all sub nodes of a specic node.

NOTE: The node a/b/c;a/b/d is equivalent to a/b(c;d).

The following request selects the routes name and next-hop/name nodes:

GET

/running/sys/routes/inet/route/10.20.0.0,16?select=name;next-hop(name)

Sample BGP Congurations

The following are the sample BGP congurations via REST API.

Figure 3. BGP Topology

The PDU structure for conguring the IP address on an interface is as follows:

cat ipaddr_config_put.xml

<name>tengig-0-0</name>

<ip>

</primary>

</address>

</ip>

</interface>

The following conguration depicts the IP address conguration for router interfaces via REST– PUT request:

curl -v -u admin:admin http://10.16.151.159:8008/api/running/dell/interfaces/interface/

tengig-0-0 -X PUT -T ipaddr_config_put.xml

138

REST API