HP VAN SDN Controller 2.3 REST API Reference

Abstract

This guide is intended for network administrators and support personnel, and provides commands, sample requests, sample responses, and response codes for interacting with the API. The information in this guide is subject to change without notice.

HP Part Number: 5998-6080
Published: June 2014
Edition: 1

Legal Notice
Legal Notice

1 Controller REST API overview
New and changed information
2 Controller REST API list
/sdn/v2.0
/sdn/v2.0/of
/sdn/v2.0/net
3 /sdn/v2.0
Versions
{base uri}
{base uri}/{api}
Authentication
/auth
Login
Logout
Support
REST API: /sdn/v2.0/support
Licensing
Licenses
List licenses
List all licenses
Get a license
Add a license
Installid
Get the install id
Get a license
Get a license by serial number
Licenses/{sno}/action
Deactivate a license
Check if a product is licensed or not
Get license compliance level (0 to 1) for a product id and a metric id
Config
List config
Config/{component}
List config for a given component
Update (partial) config for a given component
Revert to default config for a given component
Apps
List apps
Deploy app
Apps/{app uid}
Get app info
Un-deploy app
Apps/{app uid}/action
Install a deployed app
Enable a stopped app
Disable a started app
Apps/{app uid}/health
Get app health
Monitor app health
Logs
Download controller logs as a zip file
Logs/local
Download the local controller logs as a zip file
Audit logs
Auditlog
List audit log entries
Systems
List controllers
Systems/{system uid}
Get information on the given controller
Region
Regions
List regions
Create region
Regions{region uid}
List regions
Update region
Delete region
Team
Team
List team membership
Form team
Disband team
Backup
Backup/status
Get backup status
Backup/checksum
Get backup checksum
Backup/
Get backup contents
Start backup
Restore
Restore
Start Restore
Restore/status
Get restore status
Restore/backup
Upload backup
Alerts
Alerts
List alerts
Alerts/topics
List alert topics
Alerts/listeners
List alert listeners
Create an alert listener
Alerts/listeners/{listener uid}
Get info on an alert listener
Update an alert listener
Delete an alert listener
Northbound metering REST API examples
Applications
Metrics
Metric details
Metric values
Metric Primary values
Metric Secondary values
Metric Names
4 /sdn/v2.0/of
Stats
Stats/ports
Stats/groups
Meter statistics
Datapaths
Datapaths/{dpid}
Datapaths/{dpid}/controllers
Datapaths/{dpid}/features/meter
Datapaths/{dpid}/features/group
Datapaths/{dpid}/ports
Datapaths/{dpid}/ports/{port id}
Datapaths/{dpid}/ports/{port id}/action
Datapaths/{dpid}/meters
List meters
Create meter
Datapaths/{dpid}/meters/{meter id}
Get meter info
Update meter
Delete meter
Datapaths/{dpid}/flows
List flows
Add a flow
Update a flow
Delete a flow
Datapaths/{dpid}/groups
List groups
Add new group
Datapaths/{dpid}/groups/{group id}
Get group information
Update group information
Delete group
5 /sdn/v2.0/net
Clusters
Clusters/{cluster uid}/tree
Links
Paths
Paths/forward
Nodes
Nodes
Diagnostics
Diag/observations
Get observation post info
Create an observation post
Delete an observation post
Diag/packets
List all packets
Create a packet
Diag/packets/{packet uid}
List a packet
Delete a packet
Diag/packets/{packet uid}/path
List the expected ordered path links that the packet shall take through the network
Diag/packets/{packet uid}/nexthops
Get the next hop switch of the specified switch based on the packet identifier
Diag/packets{packet uid}/action
Simulate a packet
Devices
List all devices
List details of a specific device
List all interfaces associated with a device
Delete a device
Keys
List all keys of a specified type
List details of a specific key type matching a description
Add a key using JSON
Delete a key of a specific type and description
6 Support and other resources
Gather information before contacting an authorized support representative
How to contact HP
Get connected to the HP SDN online user forum
Software technical support and software updates
Care Packs
Obtaining software updates
Warranty
Related information
7 Documentation feedback