Administrator Guide

REST Authentication

The REST API authenticates and authorizes the user based on the Dell Networking OS AAA configuration.

You can locally configure or validate through the AAA infrastructure. For more information about the AAA

Accounting mode, refer to the Dell Networking OS Configuration Guide, Security chapter.

The Dell Networking OS CLI user level privilege dictates the level of the REST API access. Users with

privilege level 0 or 1 have read-only access; the allowed REST API method is GET. Users with privilege

levels 2 through 15 have read-write access in REST API. The allowed methods are GET, PATCH, PUT,

POST, and DELETE.

For information about the privilege level command, refer to the Dell Networking OS Command Line

Reference Guide, Security chapter.

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.

Sample BGP Configurations

The following are the sample BGP configurations via REST API.

Figure 3. BGP Topology

The PDU structure for configuring the IP address on an interface is as follows:

cat ipaddr_config_put.xml

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

<ip>

</primary>

</address>

126

REST API