Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 
ON THIS PAGE
 

<get-configuration>

Usage

Description

Request configuration data from the NETCONF or Junos XML protocol server. The attributes specify the source and formatting of the data to display.

If a client application issues the Junos XML protocol <open-configuration> operation to open a specific configuration database before executing the <get-configuration> operation, the server returns the configuration data from the open configuration database. Otherwise, the server returns the configuration data from the candidate configuration. You can explicitly request the active configuration database by including the database="committed" attribute.

A client application can request the entire configuration hierarchy or a subset of it.

  • Entire configuration hierarchy—To display the entire configuration hierarchy, emit the empty <get-configuration/> tag.

  • Subset of configuration hierarchy—To display a configuration element (hierarchy level or configuration object), emit the <get-configuration> element and include the elements that represent all levels of the configuration hierarchy from the root (<configuration>) down to the level or object to display. To represent a hierarchy level or a configuration object that does not have an identifier, emit it as an empty tag. To represent an object that has one or more identifiers, emit its container tag element and identifier tag elements only, not any tag elements that represent other characteristics.

Note:

To retrieve configuration data from an instance of the ephemeral configuration database, a client application must first open the ephemeral instance using the <open-configuration> operation with the appropriate child tags before emitting the <get-configuration> operation. When retrieving ephemeral configuration data using the <get-configuration> operation, the only supported attributes are format and key.

Note:

You can use the <get-configuration> operation to request the entire logical system configuration or request specific logical system configuration hierarchies using child configuration tags.

Attributes

changed

Request that the junos:changed="changed" attribute appear in the opening tag of each changed configuration element.

The attribute appears in the opening tag of every parent tag in the path to the changed configuration element, including the top-level <configuration> tag. If the changed configuration element is represented by a single (empty) tag, the junos:changed="changed" attribute appears in the tag. If the changed element is represented by a container tag, the junos:changed="changed" attribute appears in the opening container tag and also in each child tag enclosed in the container tag element.

  • Values: changed

The database attribute can be combined with the changed="changed" attribute to request either the candidate or active configuration:

  • When you request the candidate configuration, elements added to the candidate configuration after the last commit operation are marked with the junos:changed="changed" attribute.

  • When you request the active configuration, elements added to the active configuration by the most recent commit are marked with the junos:changed="changed" attribute.

Note:

When a commit operation succeeds, the server removes the junos:changed="changed" attribute from all elements. However, if warnings are generated during the commit, the attribute is not removed. In this case, the junos:changed="changed" attribute appears in elements that changed before the commit operation as well as on those elements that changed after it. To remove the junos:changed="changed" attribute from elements that changed before the commit, you must eliminate the cause of the warning, and commit the configuration again.
commit-scripts

Request that the NETCONF or Junos XML protocol server display commit-script-style XML data. The value of the attribute determines the output.

  • Values:

    • apply—Display the configuration with commit script changes applied, including both transient and non-transient changes. The output is equivalent to the | display commit-scripts output in the CLI.

    • apply-no-transients—Display the configuration with commit script changes applied, but exclude transient changes. The output is equivalent to the | display commit-scripts no-transients output in the CLI.

    • view—Display the configuration in the XML format that is input to a commit script. The output is equivalent to viewing the configuration with the following attributes applied: inherit="inherit", groups="groups", and changed="changed". The output is equivalent to the | display commit-scripts view output in the CLI.
compare

Request that the NETCONF or Junos XML protocol server display the differences between the active or candidate configuration and a previously committed configuration (the comparison configuration). By default, the comparison uses the candidate configuration. Include the database attribute to specify the active configuration.

  • Values:

    • configuration-revision—Reference the comparison configuration by its configuration revision ID string, which you define in the configuration-revision="revision-id" attribute.

    • rollback—Reference the comparison configuration by its rollback index, which you define in the rollback="rollback-number" attribute.

If you include the compare attribute but either omit the corresponding configuration-revision or rollback attribute or provide an invalid configuration revision ID, the server uses the most recently committed configuration as the comparison configuration.

When you compare the candidate configuration to the active configuration, the compare operation returns XML output. However, you can include the format attribute to display the differences in text, XML, or JSON format. For all other comparisons, the server returns the output as text using a patch format.

Note:

When you compare the candidate and active configurations and display the differences in XML or JSON format, the device omits the root configuration object in the following cases:

  • The comparison returns no differences

  • The comparison returns differences for only non-native configuration data, for example, configuration data associated with an OpenConfig data model.
database

Specify the configuration database from which to display data.

  • Default: candidate

  • Values:

    • candidate—The candidate configuration

    • committed—The active configuration (the one most recently committed)

If you include both the database and the database-path attributes, the database attribute takes precedence.
database-path

Within a commit script, this attribute specifies the path to the session’s pre-inheritance candidate configuration. For normal configuration sessions, the commit script retrieves the normal, pre-inheritance candidate configuration. For private configuration sessions, the commit script retrieves the private, pre-inheritance candidate configuration.

  • Values: $junos-context/commit-context/database-path

If you include both the database and the database-path attributes, the database attribute takes precedence.
format

Specify the format in which the NETCONF or Junos XML protocol server returns the configuration data.

  • Default: xml

  • Values:

    • json—Configuration data format is JSON.

      Note:

      Integers in Junos OS configuration data emitted in JSON format are not enclosed in quotation marks.

    • set—Configuration data format is Junos OS configuration mode commands.

    • text—Configuration data format is ASCII text, which uses the newline character, tabs and other white space, braces, and square brackets to indicate the hierarchical relationships between the statements.

    • xml—Configuration data format is Junos XML.

Note:

Starting in Junos OS Release 21.1R1 and Junos OS Evolved Release 22.3R1, NETCONF sessions additionally support the json-minified and xml-minified formats, which return the respective format with unnecessary spaces, tabs, and newlines removed.

groups

Request that the junos:group="group-name" attribute appear in the opening tag for each configuration element that is inherited from a configuration group. The group-name variable specifies the name of the configuration group from which that element was inherited.

  • Values: groups

When you specify the groups attribute, you must also specify the inherit attribute.

inherit

Specify how the NETCONF or Junos XML protocol server displays statements that are defined in configuration groups and interface ranges. If you omit the inherit attribute, the output uses the <groups>, <apply-groups>, and <apply-groups-except> tags to represent user-defined configuration groups and uses the <interface-range> tag to represent user-defined interface ranges. The output does not include tag elements for statements defined in the junos-defaults group.

  • Values:

    • defaults—The output does not include the <groups>, <apply-groups>, and <apply-groups-except> tags, but instead displays elements that are inherited from user-defined groups and from the junos-defaults group as children of the inheriting tag elements.

    • inherit—The output does not include the <groups>, <apply-groups>, <apply-groups-except>, and <interface-range> tags, but instead displays elements that are inherited from user-defined groups and ranges as children of the inheriting tag elements. The output does not include tag elements for statements defined in the junos-defaults group.
interface-ranges

Request that the junos:interface-ranges="source-interface-range" attribute appear in the opening tag for each configuration element that is inherited from an interface range. The source-interface-range variable specifies the name of the interface range.

  • Values: interface-ranges

When you specify the interface-ranges attribute, you must also specify the inherit attribute.

junos:key | key

Request that the junos:key="key" attribute appear in the opening tag of each element that serves as an identifier for a configuration object.

  • Values: key

Release Information

This operation is a Junos XML management protocol operation. It is supported in Junos XML protocol sessions, and it is supported as a Juniper Networks proprietary extension in NETCONF sessions on Junos devices that identify the URI http://xml.juniper.net/netconf/junos/1.0 in the capabilities exchange.

interface-ranges attribute added in Junos OS Release 10.3R1.

commit-scripts attribute values apply and apply-no-transients added in Junos OS Release 12.1

database-path attribute added in Junos OS Release 12.2.

format attribute value json added in Junos OS Release 14.2.

format attribute value set added in Junos OS Release 15.1.

Starting in Junos OS Release 16.1, devices running Junos OS emit JSON-formatted configuration data using a new default implementation for serialization.

Starting in Junos OS Releases 16.1R4, 16.2R2, and 17.1R1, integers in Junos OS configuration data emitted in JSON format are not enclosed in quotation marks.

compare attribute value configuration-revision added in Junos OS Release 20.4R1 and Junos OS Evolved Release 20.4R1.

format attribute values json-minified and xml-minified added for NETCONF sessions only in Junos OS Release 21.1R1 and Junos OS Evolved Release 22.3R1.

Related Documentation