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
Status Error
Codes
Description
201 Created A resource is created and the new resource URI returns in the Location header.
204 No Content The request is successfully completed but no response body returns.
400 Bad Request The request could not be processed because it contains missing or invalid information (such as a validation error on
an input eld, a missing required value, and so on).
401 Unauthorized The request requires user authentication. The response includes a WWW-Authenticate header eld for basic
authentication.
403 Forbidden Access to the resource is denied by the server due to authorization rules.
404 Not Found The requested resource does not exist.
405 Method Not
Allowed
The HTTP method specied in the request (DELETE, GET, HEAD, PATCH, POST, PUT) is not supported for this
resource.
406 Not Acceptable The resource this request identies is not capable of generating the requested representation, specied in the
Accept header or in the format query parameter.
409 Conict This code is used if a request tries to create a resource that already exists.
415 Unsupported
Media Type
The format of the request is not supported.
500 Internal Error The server encountered an unexpected condition which prevented it from fullling the request.
501 Not
Implemented
The server does not (currently) support the functionality required to fulll the request.
503 Unavailable The server is currently unable to handle the request because the resource is being used by someone else or is
temporarily overloaded.
REST API — Protocol Data Unit (PDU) Structure
The following features are supported to congure the REST API.
• Physical interface
• Logical interface
• BGP
• Infrastructure
• Miscellaneous
Each node is printed as: <status> <flags> <name> <opts> <type>.
• <status> is one of the following:
– + for current
– x for deprecated
– o for obsolete
• <flags> is one of the following:
– rw for conguration data
– ro for non-conguration data
– -x for rpcs
– -n for notications
• <name> is the name of the node.
– (<name>) refers that the node is a choice node
146
REST API