Junos XMLプロトコルセッションの設定データの出力形式を指定する
Junos OSを実行するデバイスとのJunos XMLプロトコルセッションで、ルーティング、スイッチング、またはセキュリティプラットフォーム上の設定に関する情報を要求するために、クライアントアプリケーションは要素を<get-configuration><rpc>タグで囲みます。クライアント アプリケーションは、タグにオプション属性を設定することで、Junos XML プロトコル サーバーから返される構成データのフォーマットを<get-configuration>指定できます。
Junos XML プロトコル サーバーが Junos XML タグ付き出力で構成情報を返すように要求するには、クライアント アプリケーションはタグに属性を format="xml" 含めるか、タグを <get-configuration/> 開 <get-configuration> くか、属性を完全に省略します。Junos XML プロトコル サーバーは、属性が含まれている場合を除き、デフォルトで Junos XML タグ付き出力を compare 返します。
<rpc>
<get-configuration/>
<!-- OR -->
<get-configuration>
<!-- tag elements for the configuration elements to return -->
</get-configuration>
</rpc>
Junos XML プロトコル サーバーに、構成情報を Junos XML タグ要素でタグ付けするのではなく、フォーマットされた ASCII テキストとして返すように要求するには、クライアント アプリケーションにタグまたは開始<get-configuration>タグの属性が<get-configuration/>含まれていますformat="text"。
<rpc>
<get-configuration format="text"/>
<!-- OR -->
<get-configuration format="text">
<!-- tag elements for the configuration elements to return -->
</get-configuration>
</rpc>
Junos OS リリース 15.1 以降、クライアント アプリケーションは、Junos XML プロトコル サーバーが Junos XML タグ要素ではなく、設定モード set コマンドとして設定情報を返すように要求するタグまたは開始<get-configuration>タグの属性<get-configuration/>を含format="set"みます。クライアントアプリケーションは、リクエストをタグ要素で<rpc>囲みます。
<rpc>
<get-configuration format="set"/>
<!-- OR -->
<get-configuration format="set">
<!-- tag elements for the configuration elements to return -->
</get-configuration>
</rpc>
Junos OSリリース14.2以降、クライアントアプリケーションは、Junos XMLプロトコルサーバーに、JavaScript Object Notation(JSON)形式の設定情報を返すように要求できるようになりました。構成データを Junos XML タグ要素でタグ付けするのではなく JSON 形式で返すために、クライアント アプリケーションにはタグまたは開始<get-configuration>タグに属性が<get-configuration/>含まれますformat="json"。クライアントアプリケーションは、リクエストをタグ要素で<rpc>囲みます。
<rpc>
<get-configuration format="json"/>
<!-- OR -->
<get-configuration format="json">
<!-- tag elements for the configuration elements to return -->
</get-configuration>
</rpc>
タグ要素で囲むタグ要素については、 Junos XMLプロトコルセッションで返す設定データのスコープの指定を参照してください。<get-configuration>
要求する出力形式に関係なく、クライアント アプリケーションは表示する構成要素を表すために Junos XML タグ要素を使用します。属性は format 、Junos XML プロトコル サーバーの出力の形式のみを制御します。
アプリケーションが Junos XML タグ要素を要求すると、Junos XML プロトコル サーバーはその出力を および <configuration> タグ要素で<rpc-reply>囲みます。開始<configuration>タグの属性については、 Junos XMLプロトコルセッションにおける設定情報リクエストのソースの指定を参照してください。
<rpc-reply xmlns:junos="URL">
<configuration attributes>
<!-- Junos XML tag elements representing configuration elements -->
</configuration>
</rpc-reply>
アプリケーションがフォーマットされたASCII出力を要求すると、Junos XMLプロトコルサーバーは、CLIshow configurationコマンドが設定データを表示するのと同じ方法で応答をフォーマットします。つまり、改行文字、タブ、ブレース、角括弧を使用して、設定ステートメント間の階層関係を示します。サーバーは、フォーマットされたASCII設定ステートメントを および <configuration-text> タグ要素で<rpc-reply>囲みます。
<rpc-reply xmlns:junos="URL">
<configuration-text>
<!-- formatted ASCII configuration statements -->
</configuration-text>
</rpc-reply>
アプリケーションが設定モード set コマンドを要求すると、Junos XMLプロトコルサーバーは、CLI show configuration | display set コマンドが設定データを表示するのと同じ方法で応答をフォーマットします。サーバーは、 および タグ要素で <rpc-reply> データを <configuration-set> 囲みます。
<rpc-reply xmlns:junos="URL">
<!-- configuration mode commands -->
</rpc-reply>
アプリケーションが JSON 形式を要求すると、Junos XML プロトコル サーバーは JSON データを および <configuration-json> タグ要素で<rpc-reply>囲みます。
<rpc-reply xmlns:junos="URL">
<configuration-json>
<!-- JSON configuration data -->
</configuration-json>
</rpc-reply>
Junos OSリリース16.1以降、Junos OSを実行するデバイスは、シリアル化の新しいデフォルト実装を使用して、JSON形式の設定データを出力します。
Junos OSリリース16.1R4、16.2R2、および17.1R1以降、JSON形式で出力されるJunos OS設定データの整数は引用符で囲まれていません。以前のリリースでは、JSON 設定データの整数は文字列として扱われ、引用符で囲まれます。
属性はformat、タグまたは開始<get-configuration>タグ内の以下の他の属性の1<get-configuration/>つ以上と組み合わせることができます。
compareとcompare="rollback"を使用して、 を使用しますrollback="0"。候補コンフィギュレーションをアクティブコンフィギュレーション(rollback="0")と比較する場合、要求に属性に適切な値を含めることで、テキスト以外のフォーマットの差異をformat表示することができます。Junos OS リリース 15.1R1 以降の XML 形式の違いを表示でき、Junos OS リリース 16.1R1 以降の JSON 形式の違いを表示できます。commit-scriptsまたは の値commit-scripts="apply"を使用しますcommit-scripts="apply-no-transients"。属性はcommit-scripts="view"、属性が含まれている場合format="text"でも、デフォルトで Junos XML タグ付き出力を返します。これはスクリプトをコミットするための入力形式であるためです。databaseについては、 Junos XML プロトコル セッションにおける設定情報リクエストのソースの指定で説明されています。inheritgroupsおよび および およびinterface-rangesは、 で説明されています。これは、 Junos XMLプロトコルを使用した設定グループの出力形式とインターフェイス範囲の指定に記載されています。
属性と属性を組み合わせるformat="text"のは意味がありません(Junos XMLプロトコルを使用した構成要素の変更インジケータの要求で説明されています)、識別子の指標を要求した後に属性を含める場合は意味がありません(Junos XMLプロトコルを使用した構成要素の識別子インジケータの要求で説明されています)。changed変更および識別子インジケータは、Junos XMLタグ付きとJSON出力にのみ表示されます。
アプリケーションは、Junos-XML タグ付き出力、書式設定された ASCII テキスト、設定モード set コマンド、または設定全体またはその一部の JSON 出力を要求できます。返されるデータ量の指定方法については、 Junos XML プロトコル セッションで返す設定データのスコープの指定を参照してください。
次の例は、候補コンフィギュレーションで 階層レベルから [edit policy-options] フォーマットされたASCII出力を要求する方法を示しています。
set コマンドとして設定情報を返すように要求するタグまたは開始
<get-configuration>タグの属性
<get-configuration/>を含
format="set"みます。