HP VAN SDN Controller REST API Guide

ManualsBrandsHP ManualsSoftwareHP VAN SDN Controller Software Products

Contents

1 Controller REST API overview........................................................................7

2 Controller REST API list................................................................................8

3 /sdn/v2.0...............................................................................................15

Versions................................................................................................................................15

{base uri}..........................................................................................................................15

{base uri}/{api}.................................................................................................................15

Support.................................................................................................................................16

REST API: /sdn/v2.0/support..............................................................................................16

Licensing...............................................................................................................................18

Licenses............................................................................................................................18

List licenses...................................................................................................................18

List all licenses..............................................................................................................18

Get a license................................................................................................................18

Add a license...............................................................................................................19

Installid............................................................................................................................20

Get the install id...........................................................................................................20

Get a license.....................................................................................................................20

Get a license by serial number........................................................................................20

Licenses{sno}action............................................................................................................20

Deactivate a license......................................................................................................20

Check if a product is licensed or not.....................................................................................21

Get license compliance level (0 to 1) for a product id and a metric id.......................................21

Config..................................................................................................................................22

List config.........................................................................................................................22

Config/{component}..........................................................................................................23

List config for a given component....................................................................................23

Update (partial) config for a given component..................................................................23

Revert to default config for a given component..................................................................24

Apps....................................................................................................................................25

List apps...........................................................................................................................25

Deploy app.......................................................................................................................26

Apps/{app uid}.................................................................................................................26

Get app info................................................................................................................26

Un-deploy app..............................................................................................................27

Apps/{app uid}/action......................................................................................................27

Install a deployed app...................................................................................................27

Enable a stopped app...................................................................................................28

Disable a started app....................................................................................................28

Apps/{app uid}/health......................................................................................................29

Get app health.............................................................................................................29

Monitor app health.......................................................................................................29

Logs......................................................................................................................................29

Download controller logs as a zip file...................................................................................29

Logs/local........................................................................................................................30

Download the local controller logs as a zip file.................................................................30

Audit logs..............................................................................................................................30

Auditlog...........................................................................................................................30

List audit log entries.......................................................................................................30

Systems.................................................................................................................................32

List controllers....................................................................................................................32

Contents 3