EPN Manager: RESTConf API による CLI 設定テンプレートの実行例

fhanzawa · ‎2023-06-02

はじめに
実行方法
参考情報

はじめに

本ドキュメントでは、RESTConf API ( 以下 API ) による EPN Manager CLI 設定テンプレートの実行例を紹介しています。EPN Manager で CLI 設定テンプレートが作成済みであることを前提としています。CLI 設定テンプレートの作成方法については Cisco Evolved Programmable Network Manager 5.0.0 ユーザおよび管理者ガイドをご参照ください。

実行方法

1. API で呼び出す際の Request XML ファイルを API 実行サーバ上に作成します。

例：Request XML ファイル clitemplate.xml の内容

<?xml version="1.0" encoding="UTF-8"?>
<ns1:config-request xmlns:ns1="urn:cisco:params:xml:ns:yang:ra:v1" xmlns:ns2="urn:cisco:params:xml:ns:yang:nrf-common:v1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="urn:cisco:params:xml:ns:yang:ra:v1 cisco-resource-activation.xsd ">
  <ns1:run-cli-configuration>
    <ns1:template-name>テンプレート名</ns1:template-name>
    <ns1:target-list>
      <ns1:target>
        <ns1:node-ref>MD=CISCO_EPNM!ND=テンプレート適用先デバイス名</ns1:node-ref>
      </ns1:target>
    </ns1:target-list>
  </ns1:run-cli-configuration>
</ns1:config-request>

2. API を使用するための認証を行います。

# curl -k --cookie-jar cookie.txt --include --header 'Content-type: application/x-www-form-urlencoded' --request POST https://<EPN Manager IP>/restconf/j_spring_security_check -d 'j_username=root&j_password=<パスワード>'

3. API 経由で CLI 設定テンプレートを実行します。

# curl -k --cookie cookie.txt --include -H 'content-Type:application/yang-data+xml' -X POST -T clitemplate.xml https://<EPN Manager IP>/restconf/operations/v1/cisco-resource-activation:run-cli-configuration

コマンド実行結果の出力例：

HTTP/1.1 100

HTTP/1.1 200
Strict-Transport-Security: max-age=31536000;includeSubDomains
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Date: Fri, 26 May 2023 00:16:57 GMT
vary: accept-encoding
Content-Type: application/xml
Content-Length: 2894
Server: Prime

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><ns34:config-response xmlns:ns2="urn:cisco:params:xml:ns:yang:nrf-common:v1" xmlns:ns3="urn:cisco:params:xml:ns:yang:nrf-ce-extension:v1" xmlns:ns4="urn:cisco:params:xml:ns:yang:nrf-tdm-cem-extension:v1" 
--- snip ---
xmlns:ns42="urn:cisco:params:xml:ns:yang:xmpim:events-alarms" xmlns:ns43="urn:cisco:params:xml:ns:yang:restconf:party" xmlns:ns44="urn:cisco:params:xml:ns:yang:sb:lag:v1" xmlns:ns45="urn:cisco:params:xml:ns:yang:nrf:physical:port:v1"><ns34:job-status><ns34:job-name>ジョブ名</ns34:job-name><ns34:message>An deploy job has been successfully created. </ns34:message></ns34:job-status></ns34:config-response>

4. API によるジョブの実行結果の確認方法

# curl -k --cookie cookie.txt --include -H 'content-Type: application/yang-data+xml' https://<EPN Manager IP>/restconf/operations/v1/cisco-resource-activation:get-cli-configuration-run-status/<ジョブ名>

コマンド実行結果の出力例：

HTTP/1.1 200
Strict-Transport-Security: max-age=31536000;includeSubDomains
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Date: Fri, 26 May 2023 01:28:13 GMT
vary: accept-encoding
Content-Type: application/xml
Content-Length: 6551
Server: Prime

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><ns34:config-response xmlns:ns2="urn:cisco:params:xml:ns:yang:nrf-common:v1" xmlns:ns3="urn:cisco:params:xml:ns:yang:nrf-ce-extension:v1" xmlns:ns4="urn:cisco:params:xml:ns:yang:nrf-tdm-cem-extension:v1" 
--- snip ---
xmlns:ns45="urn:cisco:params:xml:ns:yang:nrf:physical:port:v1"><ns34:job-status><ns34:job-name>show_version_09_16_57_444_AM_05_26_2023_0</ns34:job-name><ns34:run-id>173747004</ns34:run-id><ns34:run-status>COMPLETED</ns34:run-status><ns34:status>SUCCESS</ns34:status><ns34:duration>2</ns34:duration><ns34:start-time>2023-05-26 09:16:59.437</ns34:start-time><ns34:start-time-iso8601>2023-05-26T09:16:59.437+09:00</ns34:start-time-iso8601><ns34:completion-time>2023-05-26 09:17:01.45</ns34:completion-time><ns34:completion-time-iso8601>2023-05-26T09:17:01.450+09:00</ns34:completion-time-iso8601></ns34:job-status><ns34:deploy-result-list><ns34:deploy-result><ns34:deploy-template-name>show_version</ns34:deploy-template-name><ns34:device-ip>10.71.244.24</ns34:device-ip><ns34:status>Success</ns34:status><ns34:transcript>configlet:
#MODE_ENABLE
show version
#MODE_END_ENABLE
 response:
&amp;lt;cliChunks&amp;gt;&amp;lt;cliChunk&amp;gt;&amp;lt;cli&amp;gt;terminal width 0
config t
exit
show version
config t
&amp;lt;/cli&amp;gt;&amp;lt;response&amp;gt;&amp;lt;![CDATA[terminal width 0
Router#config t
Enter configuration commands, one per line.  End with CNTL/Z.
Router(config)#exit
Router#show version
Cisco IOS XE Software, Version 03.13.07b.S - Extended Support Release
--- snip ---

参考情報

Cisco Evolved Programmable Network Manager 5.0.0 ユーザおよび管理者ガイド

Evolved Programmable Network Manager RESTConf Interface