Retrieving the Rescue Configuration Using the Junos XML Protocol
The rescue configuration is a configuration saved in case it
is necessary to restore a valid, nondefault configuration. (To create
a rescue configuration, use the Junos XML <request-save-rescue-configuration> tag element in a Junos XML protocol session or the request
system configuration rescue save operational mode command in
the CLI. For more information, see the Junos XML API Operational Developer Reference or
the CLI Explorer.)
In a Junos XML protocol session with a device running Junos
OS, a client application requests the rescue configuration by emitting
the Junos XML <get-rescue-information> tag element in an <rpc> element. This
operation is equivalent to the show system configuration rescue operational mode command.
To request Junos XML-tagged output, the application either
includes the <format> tag element with
the value xml or omits the <format> tag element (Junos XML output is the default):
<rpc>
<get-rescue-information/>
</rpc>
The Junos XML protocol server encloses its response in <rpc-reply>, <rescue-information>, and <configuration> tag elements.
The <load-success/> tag is a side effect
of the implementation and does not affect the results. For information
about the attributes in the opening <configuration> tag, see Specifying the Source for Configuration Information Requests in a Junos XML Protocol Session.
<rpc-reply xmlns:junos="URL">
<rescue-information>
<load-success/>
<configuration attributes>
<!-- tag elements representing the rescue configuration -->
</configuration>
</rescue-information>
</rpc-reply>
To request formatted ASCII output, the application includes
the <format> tag element with the value text.
The Junos XML protocol server encloses its response in <rpc-reply>, <rescue-information>, <configuration-information>, and <configuration-output> tag elements. For more information
about the formatted ASCII notation used in Junos OS configuration
statements, see Specifying the Output Format for Configuration Data in a Junos XML Protocol Session.
<rpc-reply xmlns:junos="URL">
<rescue-information>
<load-success/>
<configuration-information>
<configuration-output>
<!-- formatted ASCII text representing the rescue configuration -->
</configuration-output>
</configuration-information>
</rescue-information>
</rpc-reply>
Starting in Junos
OS Release 16.1, to request the rescue configuration in JSON format,
the application includes the <format> tag element with the value json in the <get-rescue-information> element. Prior to Junos OS Release 16.1, JSON-formatted data is requested
by including the format="json" attribute
in the opening <get-rescue-information> tag.
When you use the format="json" attribute to specify the format, the Junos XML protocol server encloses
its response in an <rpc-reply> element,
the field name for the top-level JSON member is "rescue-information", and the emitted configuration data uses an older implementation
for serialization. When you use the <format>json</format> element to request JSON-formatted data, the Junos XML protocol server
encloses its response in <rpc-reply>, <rescue-information>, <configuration-information>, and <json-output> tag elements, the field name for the top-level JSON member is "configuration", and the emitted configuration data
uses a newer implementation for serialization.
<rpc-reply xmlns:junos="URL">
<rescue-information>
<load-success/>
<configuration-information>
<json-output>
{ "configuration" : { <!-- JSON data representing the rescue configuration -->
} } </json-output>
</configuration-information>
</rescue-information>
</rpc-reply>
Related Documentation
Specifying the Scope of Configuration Data to Return in a Junos XML Protocol Session
Requesting the Complete Configuration Using the Junos XML Protocol
Retrieving a Previous (Rollback) Configuration Using the Junos XML Protocol
Comparing the Active or Candidate Configuration to a Prior Version Using the Junos XML Protocol
Comparing Two Previous (Rollback) Configurations Using the Junos XML Protocol
<format> tag element with the value json in the <get-rescue-information> element.