Concept Guide
Table Of Contents
- Dell EMC Networking Open Automation Guide 9.14.1.0 November 2018
- About this Guide
- Open Automation Framework
- Bare Metal Provisioning
- Introduction
- How it Works
- Prerequisites
- Industry Standard Upgrades with BMP
- BMP Process Overview
- BMP Operations
- Configure BMP
- BMP Commands and Examples
- System Boot and Set-up Behavior in BMP Mode
- BMP Mode - Boot and Set-up Behavior
- DHCP Offer Vendor-Specific Option for BMP
- DHCP Offer Relay Option 82
- Software Upgrade Using BMP
- Apply Configurations Using BMP Scripts
- Using the Post-configuration Script
- Using Auto-Execution Script - Normal Mode Only
- Timers in Pre–configuration and Post–configuration Scripts
- Script Examples
- BMP Operations on Servers Overview
- File Server Settings
- Domain Name Server Settings
- BMP MIB Support
- Bare Metal Provisioning CLI
- Open Management Infrastructure
- Puppet
- Smart Scripting
- Overview
- Download the Smart Scripting Package
- Dell EMC Environment Variables
- Dell EMC Proprietary Utilities
- Dell EMC SmartScript Utilities
- SQLite
- NET SNMP Client
- Limits on System Usage
- Supported UNIX Utilities
- Creating a Username and Password for Smart Scripting
- Logging in to a NetBSD UNIX Shell
- Downloading Scripts to a Switch
- Network File System (NFS)
- Setting a Search Path for Scripts
- Scheduling and Executing Scripts
- Running a Script from the UNIX Shell
- Running Scripts with User Privileges
- Smart Scripting CLI
- disable
- execute
- mount nfs
- package clear-all
- package install
- package uninstall
- script (run)
- script (stop/resume/clear/kill/unschedule)
- script event-handler
- script execute (EXEC mode)
- script execute
- script get
- script path
- script remove
- script trigger-event
- show packages
- show script
- start shell
- triggered-by
- switch script limit
- username (event handler)
- username
- SNMP MIBs
- Virtual Server Networking
- Virtual Server Networking CLI
- REST API
- HTTP and HTTPS
- XML
- Important Points to Remember
- REST Authentication
- Request Query Parameters
- Sample BGP Configurations
- HTTP Status Error Codes
- REST API — Protocol Data Unit (PDU) Structure
- Configurations
- Operational
- Operational Data for IPv6
- Management Information Base (MIB)
- IETF Interface Operations
- REST API Framework to Execute the CLIs
- Samples of the config-command
- Samples of the EXEC command
- Samples of the show-command
- REST API CLI
- Web Server
REST API
Representational state transfer (REST) application programming interface (API) is an integrated part of the Dell EMC Networking operating
system (OS) and is supported on the S4810, S4820T, S3048–ON, S4048–ON, S4048T–ON, S5048F-ON, S6000, S6000–ON, S6010–ON,
S6100–ON, Z9100–ON, C9010, S5000, and Z9500 platforms.
HTTP and HTTPS
Use REST API to congure and monitor a Dell EMC Networking switch over the hyper text transfer protocol (HTTP) and hyper text
transfer protocol secure (HTTPS).
HTTP and HTTPS are the common protocols that support read, create, update, and delete operations with the actions using methods such
as GET, POST, PUT, PATCH, and DELETE. For more information, see RFC 2616, Hypertext Transfer Protocol - HTTP/1.1.
XML
Extensible markup language (XML) is a standardized, easy-to-read and easy-to-parse method to represent data. Use the XML protocol
data unit (PDU) to exchange data between the Dell EMC Networking switch and the HTTP/HTTPS client.
The system handles up to four simultaneous REST API requests. You can use REST API on switches without having to code individual CLI
commands and open telnet, SSH, or console connections for each command.
In addition to REST API, you can use third-party management tools and other industry-standard management protocols to manage Dell
EMC Networking switches.
Important Points to Remember
• You must have Internet protocol (IP) reachability from the REST client to the Dell EMC Networking switch.
• For enabling and disabling the REST API, see REST API CLI.
• You cannot delete physical interfaces using REST API.
• Port 8008 is a nonsecure port HTTP uses; port 8888 is a secure port HTTPS uses.
REST Authentication
The REST API authenticates and authorizes the user based on the Dell EMC Networking OS AAA conguration.
You can locally congure or validate through the AAA infrastructure. For more information about the AAA Accounting mode, see the Dell
EMC Networking OS Conguration Guide, Security chapter.
The Dell EMC 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, see the Dell EMC Networking OS Command Line Reference Guide, Security chapter.
12
140 REST API