NBAPI を使用したデバイス管理
NBAPI を使用したデバイス管理
発行日;2013/11/09 | 英語版ドキュメント(2013/07/31 版) | ドキュメントご利用ガイド | ダウンロード ; この章pdf , ドキュメント全体pdf (PDF - 1MB) | フィードバック

目次

NBAPI を使用したデバイス管理

addDevice の例

updateDevice の例

deleteDevice の例

setReportStatus の例

NBAPI を使用したデバイス管理

Prime Performance Manager North Bound API(NBAPI)ではデバイスの追加や更新、削除、およびデバイス レポートの状態の設定などのいくつかのデバイス管理機能を実行することができます。

URL: https:// ppm_gateway :4440/nbapi/admin


) Prime Performance Manager が Cisco Prime キャリア管理スイートに統合されている場合、インターフェイスは https://ppm_gateway:4440/nbapi/event です。



) ユーザ アクセスが有効な場合、SOAP 要求は、HTTP Basic Authorization ヘッダーを介して Prime Performance Manager ユーザ名とパスワードを入力する必要があります。ユーザには要求された SOAP アクションを実行するために必要な権限がある必要があります。


プロジェクトの wsdl:

/opt/CSCOppm-gw/tomcat/webapps/nbapi/WEB-INF/wsdl/AdminAPI.wsdl

API 方式:

addDevice:デバイスを追加します。「addDevice の例」の例を参考にしてください。

updateDevice:デバイスを更新します。「updateDevice の例」の例を参考にしてください。

deleteDevice:デバイスを削除します。「deleteDevice の例」の例を参考にしてください。

setReportStatus:デバイスのレポートの状態を設定します。「setReportStatus の例」の例を参考にしてください。

addDevice の例

NBAPI の addDevice 方式の例を次に示します。

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ppm="http://cisco.com/ppm">
<soapenv:Header/>
<soapenv:Body>
<ppm:addDevice>
<ipaddress></ipaddress>
<name></name>
<webPort></webPort>
<timeZone></timeZone>
<location></location>
<isManaged></isManaged>
<isSendingAlarms></isSendingAlarms>
<reportPolicy></reportPolicy>
<pollingGroup></pollingGroup>
<snmpVersion></snmpVersion>
<snmpReadCommunity></snmpReadCommunity>
<snmpAuthProtocol></snmpAuthProtocol>
<snmpAuthPwd></snmpAuthPwd>
<snmpPrivProtocol></snmpPrivProtocol>
<snmpPrivPwd></snmpPrivPwd>
<snmpUserName></snmpUserName>
<loginProtocol></loginProtocol>
<loginPortNumber></loginPortNumber>
<loginUserName></loginUserName>
<loginPassword></loginPassword>
<loginEnableUserName></loginEnableUserName>
<loginEnablePassword></loginEnablePassword>
<loginSubsystem></loginSubsystem>
</ppm:addDevice>
</soapenv:Body>
</soapenv:Envelope>
 
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ppm="http://cisco.com/ppm">
<soapenv:Header/>
<soapenv:Body>
<ppm:addDevice>
<ipaddress>10.81.82.99</ipaddress>
<snmpReadCommunity>public</snmpReadCommunity>
</ppm:addDevice>
</soapenv:Body>
</soapenv:Envelope>
 
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ppm="http://cisco.com/ppm">
<soapenv:Header/>
<soapenv:Body>
<ppm:addDevice>
<ipaddress>10.81.82.98</ipaddress>
<name>somethingunique</name>
<webPort>99</webPort>
<timeZone>PST</timeZone>
<location>righthere</location>
<isManaged>false</isManaged>
<isSendingAlarms>false</isSendingAlarms>
<reportPolicy>report-policy-1</reportPolicy>
<pollingGroup>polling-group-1</pollingGroup>
<snmpVersion>3</snmpVersion>
<snmpReadCommunity>ro-string</snmpReadCommunity>
<snmpAuthProtocol>md5</snmpAuthProtocol>
<snmpAuthPwd>authpassword</snmpAuthPwd>
<snmpPrivProtocol>3des</snmpPrivProtocol>
<snmpPrivPwd>privpassword</snmpPrivPwd>
<snmpUserName>snmpusername</snmpUserName>
<loginProtocol>SSH_V2</loginProtocol>
<loginPortNumber>99</loginPortNumber>
<loginUserName>login-username</loginUserName>
<loginPassword>login-password</loginPassword>
<loginEnableUserName>login-enable-username</loginEnableUserName>
<loginEnablePassword>login-enable-password</loginEnablePassword>
<loginSubsystem>login-subsystem</loginSubsystem>
</ppm:addDevice>
</soapenv:Body>
</soapenv:Envelope>

updateDevice の例

NBAPI の updateDevice 方式の例を次に示します。

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ppm="http://cisco.com/ppm">
<soapenv:Header/>
<soapenv:Body>
<ppm:updateDevice>
<ipaddress></ipaddress>
<name></name>
<webPort></webPort>
<timeZone></timeZone>
<location></location>
<isManaged></isManaged>
<isSendingAlarms></isSendingAlarms>
<reportPolicy></reportPolicy>
<pollingGroup></pollingGroup>
<snmpVersion></snmpVersion>
<snmpReadCommunity></snmpReadCommunity>
<snmpAuthProtocol></snmpAuthProtocol>
<snmpAuthPwd></snmpAuthPwd>
<snmpPrivProtocol></snmpPrivProtocol>
<snmpPrivPwd></snmpPrivPwd>
<snmpUserName></snmpUserName>
<loginProtocol></loginProtocol>
<loginPortNumber></loginPortNumber>
<loginUserName></loginUserName>
<loginPassword></loginPassword>
<loginEnableUserName></loginEnableUserName>
<loginEnablePassword></loginEnablePassword>
<loginSubsystem></loginSubsystem>
</ppm:updateDevice>
</soapenv:Body>
</soapenv:Envelope>
 
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ppm="http://cisco.com/ppm">
<soapenv:Header/>
<soapenv:Body>
<ppm:updateDevice>
<ipaddress>10.81.82.98</ipaddress>
<name>totallyunique</name>
</ppm:updateDevice>
</soapenv:Body>
</soapenv:Envelope>
 
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ppm="http://cisco.com/ppm">
<soapenv:Header/>
<soapenv:Body>
<ppm:updateDevice>
<ipaddress>10.81.82.98</ipaddress>
<snmpVersion>2c</snmpVersion>
<snmpReadCommunity>snmp-string</snmpReadCommunity>
</ppm:updateDevice>
</soapenv:Body>
</soapenv:Envelope>
 
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ppm="http://cisco.com/ppm">
<soapenv:Header/>
<soapenv:Body>
<ppm:updateDevice>
<ipaddress>10.81.82.98</ipaddress>
<loginProtocol>Telnet</loginProtocol>
<loginPortNumber>24</loginPortNumber>
<loginUserName>un1</loginUserName>
<loginPassword>pw1</loginPassword>
<loginEnableUserName>un2</loginEnableUserName>
<loginEnablePassword>pw2</loginEnablePassword>
<loginSubsystem>test</loginSubsystem>
</ppm:updateDevice>
</soapenv:Body>
</soapenv:Envelope>
 
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ppm="http://cisco.com/ppm">
<soapenv:Header/>
<soapenv:Body>
<ppm:updateDevice>
<ipaddress>10.81.82.98</ipaddress>
<loginUserName>username</loginUserName>
<loginPassword>password</loginPassword>
</ppm:updateDevice>
</soapenv:Body>
</soapenv:Envelope>
 
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ppm="http://cisco.com/ppm">
<soapenv:Header/>
<soapenv:Body>
<ppm:updateDevice>
<ipaddress>10.81.82.98</ipaddress>
<isManaged>true</isManaged>
</ppm:updateDevice>
</soapenv:Body>
</soapenv:Envelope>
 
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ppm="http://cisco.com/ppm">
<soapenv:Header/>
<soapenv:Body>
<ppm:updateDevice>
<ipaddress>10.81.82.98</ipaddress>
<timeZone>EST</timeZone>
<loginPortNumber>30</loginPortNumber>
</ppm:updateDevice>
</soapenv:Body>
</soapenv:Envelope>
 

deleteDevice の例

deleteDevice 方式の例を次に示します。

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ppm="http://cisco.com/ppm">
<soapenv:Header/>
<soapenv:Body>
<ppm:deleteDevice>
<ipaddress>10.81.82.98</ipaddress>
</ppm:deleteDevice>
</soapenv:Body>
</soapenv:Envelope>
 

setReportStatus の例

NBAPI の setReportStatus 方式の例を次に示します。

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ppm="http://cisco.com/ppm">
<soapenv:Header/>
<soapenv:Body>
<ppm:setReportStatus>
<category></category>
<status></status>
<device></device>
<intervals></intervals>
</ppm:setReportStatus>
</soapenv:Body>
</soapenv:Envelope>
 
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ppm="http://cisco.com/ppm">
<soapenv:Header/>
<soapenv:Body>
<ppm:setReportStatus>
<category>Availability: ICMP Ping</category>
<status>enable</status>
</ppm:setReportStatus>
</soapenv:Body>
</soapenv:Envelope>
 
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ppm="http://cisco.com/ppm">
<soapenv:Header/>
<soapenv:Body>
<ppm:setReportStatus>
<category>Availability: ICMP Ping</category>
<status>disable</status>
<intervals>hourly daily</intervals>
</ppm:setReportStatus>
</soapenv:Body>
</soapenv:Envelope>
 
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ppm="http://cisco.com/ppm">
<soapenv:Header/>
<soapenv:Body>
<ppm:setReportStatus>
<category>Availability: ICMP Ping</category>
<status>enable</status>
<device>ppm-ucs-vm20</device>
</ppm:setReportStatus>
</soapenv:Body>
</soapenv:Envelope>
 
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ppm="http://cisco.com/ppm">
<soapenv:Header/>
<soapenv:Body>
<ppm:setReportStatus>
<category>Availability: ICMP Ping</category>
<status>disable</status>
<device>10.81.82.99</device>
<intervals>15min hourly monthly</intervals>
</ppm:setReportStatus>
</soapenv:Body>
</soapenv:Envelope>
 
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ppm="http://cisco.com/ppm">
<soapenv:Header/>
<soapenv:Body>
<ppm:setReportStatus>
<category>all</category>
<status>disable</status>
<device>ppm-ucs-vm20</device>
</ppm:setReportStatus>
</soapenv:Body>
</soapenv:Envelope>
 
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ppm="http://cisco.com/ppm">
<soapenv:Header/>
<soapenv:Body>
<ppm:setReportStatus>
<category>all</category>
<status>disable</status>
</ppm:setReportStatus>
</soapenv:Body>
</soapenv:Envelope>