Cisco Cisco Evolved Programmable Network Manager 2.0 Developer's Guide

Cisco

Contents

Cisco Evolved Programmable Network Manager 2.0 RESTCONF NBI Guide

iii

Table of Contents

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

Preface .......................................................................................................................... 5

Conventions.......................................................................................................................5

1.1

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

1.2

Northbound RESTCONF/YANG Interface ......................................................................... 7

Web Services Standards .....................................................................................................7

2.1

RESTCONF Standards .........................................................................................................7

2.2

Communication Patterns ....................................................................................................7

2.3

Containment Associations ................................................................................................................................... 7

OSS Integration Usage Scenarios ........................................................................................8

2.4

Retrieving Inventory ............................................................................................................................................. 8

Supported RESTCONF/YANG Interfaces .......................................................................... 9

RESTCONF/YANG Interface Endpoints.................................................................................9

3.1

Authentication ................................................................................................................................................... 11

Authorization ..................................................................................................................................................... 11

License ................................................................................................................................................................ 11

RESTCONF/YANG Interface Details ............................................................................... 12

Group Retrieval ............................................................................................................... 12

4.1

Group Data ......................................................................................................................................................... 12

Operations ......................................................................................................................................................... 12

Sample Response Data ....................................................................................................................................... 13

JSON ........................................................................................................................................... 13

ManagedElement Retrieval .............................................................................................. 14

4.2

ManagedElement Data ...................................................................................................................................... 14

Operations ......................................................................................................................................................... 16

Sample Response Data ....................................................................................................................................... 16

JSON ........................................................................................................................................... 16

Chassis Retrieval .............................................................................................................. 23

4.3

Chassis Data ....................................................................................................................................................... 23

Operations ......................................................................................................................................................... 26

Sample Response Data ....................................................................................................................................... 26

JSON ........................................................................................................................................... 26

Equipment Retrieval ........................................................................................................ 43

4.4

Equipment Data ................................................................................................................................................. 43

Operations ......................................................................................................................................................... 45

Sample Response Data ....................................................................................................................................... 46

JSON ........................................................................................................................................... 46

Module Retrieval ............................................................................................................. 51

4.5

Module Data ...................................................................................................................................................... 51

Operations ......................................................................................................................................................... 53