Cisco Cisco Prime Collaboration 10.6 Developer's Guide

Cisco

© 2012 Cisco and/or its affiliates. All rights reserved. This document is Cisco Public.

Page 2 of 82

Contents

PREFACE ............................................................................................................................................................. 4

.......................................................................................................................................................... 4

CHAPTER 1: GETTING STARTED .......................................................................................................................... 5

ESCRIPTION OF THE

NBI ...................................................................................... 5

Audience .......................................................................................................................................................... 5

................................................................................................................................................... 6

........................................................................................................................................ 6

............................................................................................................................................... 7

.................................................................................... 7

............................................................................................................................................ 7

SDK ................................................................................... 8

CHAPTER 2: COMMON PRIME COLLABORATION PROVISIONING NBIS ............................................................... 9

................................................................................................... 9

................................................................................................................................................. 10

Object Keys..................................................................................................................................................... 11

Overview of Request Names .......................................................................................................................... 11

Overview of Object Attributes ........................................................................................................................ 11

Overview of Request Arguments .................................................................................................................... 12

Configurable Properties ................................................................................................................................. 12

Prime Collaboration Provisioning NBI Objects ............................................................................................... 13

Infrastructure Product Key Attributes ............................................................................................................ 16

Subscriber Product Key Attributes ................................................................................................................. 17

Referencing Product Attributes from the Product Catalog ............................................................................ 17

.................................................................................................. 19

Request Signature Class ................................................................................................................................. 19

Device Management Commands and Queries ............................................................................................... 19

Domain Management Commands and Queries ............................................................................................. 24

Service Area String Management Commands and Queries ........................................................................... 28

Synchronization Management Commands .................................................................................................... 32

Subscriber Management Commands and Queries ......................................................................................... 34

Overview of NBI Object Metadata ................................................................................................................. 45

Work Order Management Commands and Queries ...................................................................................... 45

Check Connectivity Request ........................................................................................................................... 51

Inventory Queries ........................................................................................................................................... 53

Prepopulation ................................................................................................................................................ 55

Prime Collaboration Provisioning NBI Status Queries .................................................................................... 56

WS-Enumeration Requests ............................................................................................................................ 61

MPLEMENTATION OF

......................................................... 64

............................................................................................................................ 64

APPENDIX A: SAMPLE CLIENTS ......................................................................................................................... 66

....................................................................................................................................................... 66

......................................... 66

...................................................................... 66

....................................................................................................................... 67

Running SDK Sample Clients .......................................................................................................................... 68

Environment Variables ................................................................................................................................... 68