Cisco Cisco Evolved Programmable Network Manager 1.2 Developer's Guide

Cisco

Contents

Cisco EPNM RESTConf NBI Guide

iii

Table of Contents

Table of Contents ................................................................................................................. iii

Preface ........................................................................................................................ 12

Conventions..................................................................................................................... 12

1.1

Additional User Documentation ....................................................................................... 12

1.2

Obtaining Documentation, Obtaining Support, and Security Guidelines............................. 13

1.3

Northbound RESTConf/Yang Interface .......................................................................... 14

Web Services Standards ................................................................................................... 14

2.1

RESTConf Standards ......................................................................................................... 14

2.2

Communication Patterns .................................................................................................. 15

2.3

Iterator Pattern .................................................................................................................................................. 15

OSS Integration Usage Scenarios ...................................................................................... 15

2.4

Retrieving Device Inventory Flow ...................................................................................................................... 15

Supported RESTConf/Yang Interfaces ........................................................................... 16

RESTConf/Yang Interface Endpoints ................................................................................. 19

3.1

Authentication ................................................................................................................................................... 26

Authorization ..................................................................................................................................................... 26

License ................................................................................................................................................................ 26

RESTConf/Yang Interface Details .................................................................................. 27

Group Retrieval ............................................................................................................... 27

4.1

Group Data ......................................................................................................................................................... 27

Operations ......................................................................................................................................................... 27

Sample Response Data ....................................................................................................................................... 28

JSON ........................................................................................................................................... 28

ManagedElement Retrieval .............................................................................................. 31

4.2

ManagedElement Data ...................................................................................................................................... 31

Operations ......................................................................................................................................................... 32

Sample Response Data ....................................................................................................................................... 33

JSON ........................................................................................................................................... 33

Chassis Retrieval .............................................................................................................. 40

4.3

Chassis Data ....................................................................................................................................................... 40

Operations ......................................................................................................................................................... 42

Sample Response Data ....................................................................................................................................... 43

JSON ........................................................................................................................................... 43

Equipment Retrieval ........................................................................................................ 60

4.4

Equipment Data ................................................................................................................................................. 60

Operations ......................................................................................................................................................... 62

Sample Response Data ....................................................................................................................................... 63

JSON ........................................................................................................................................... 63