Cisco Cisco Prime Performance Manager 1.2 開発者ガイド

ページ / 26
 
Cisco Prim e Perform ance Manager REST API Guide  
Copyright 2012 Cis co Systems  
- 9 - 
the REST  API and Prime Performance  Manager we b ba se d application to have consistent names. T his 
also allo ws the same value s used in the we b base d GUI to be passe d to the REST  API. 
Note: 
Parame te r names/value s are  case -se nsitive
Parameter values should  be encode d to escape non-safe HTT P characters.   
Some parameters are mutually exclusive.  
5.7.1 FQDN 
Table 7 – FQ DN Para meter 
Para meter 
Notes  
FQ DN 
The FQDN (Fully Quali fi ed Do main Nam e) v alue  as defi ned in the Prim e Perfo rman ce 
Man ag er Server 
Format:  
Nod e=<host or IP>,<other keys as d efin ed in the  corres ponding  rep ort XM L  file>  
  
Following are exampl es o f v alid  formatt ed FQDN valu es.  
Nod e=em1 941kb f. cis co.com  
Nod e=10.74.125.210  
Nod e=em1 941kb f. cis co.com,i fDescr=FastEth ernet0/0  
Nod e=10.74.125.210,CPUSlot=0,CPUNum=0,pro cessorInd ex=1  
 
Refer to your Prime Performa nce Ma nag er ser ver or n etwork to det er mine your own 
FQDN values. 
Addition al Notes  
1)  Only suppo rted in the “ GET /reports/{ cat ego ry}../{rep ort Nam e} ” req uests.  
2)  If an FQDN o r sgmid is not provided, the REST API defaults to a top netwo rk lev el repo rt. A netwo rk lev el 
repo rt con sists o f in fo rmation  for th e top sampl es in that rep ort met ric.  
3)  Refer to the Prim e Perform an ce M an ag er do cum entation  for mo re in form ation ab out net work level repo rts. 
5.7.2 sgmid 
Table 8 – sgmid Para meter 
Para meter 
Notes  
sgmid  
A positive integer numb er that uniq uely id enti fi es a nod e in the Prime Perfo rmance 
Man ag er serv er 
 
Format:  
Positive integ er numb er g reater than 0 (eg. 1002, 13001, ..).   
-1 is also accepted, and it is optional. See note (3) bel ow.  
 
Refer to your Prime Performa nce Ma nag er ser ver or n etwork to det er mine your own 
FQDN values 
 
Addition al Notes  
•  Only supported in the “ GET /reports/{category}../{reportName}” requests.  
•  If an FQDN or sgmid is not provided, the REST API defaults to a top network level report. A network level 
repo rt con sists o f in fo rmation  for th e top sampl es in that rep ort met ric. Refer to the Prim e Perfo rman ce 
Man ag er do cum entation for mo re in form ation ab out net work -level repo rts. 
•  For consistency with the Prime Performance Manager web based application an “ sgmid” equal to -1means 
a network level repo rt. Howev er, this “ sgmid” param eter valu e is not requi red as a n etwo rk lev el report is 
alread y assum ed wh en “ FQDN”  and “ sgmid” are not given.