Device Management API

/api/space/device-management/devices/{id}/configurations/expanded

The following operations are supported on this resource:

GET /api/space/device-management/devices/{id}/configurations/expanded (v3)


This API is used to access configuration data with configuration groups expanded (using the inherit="inherit" option on the Junos OS "get-configuration" RPC).

Fields Selection

A particular section of a configuration can be fetched using the 'fields' criteria. For example:

    fields=(version,system:(login:(user)))

These fields should be nested properly to get the required configuration content. For example, a 'fields' selection passed as fields=(version) will fetch only version information. (See the sample output below.)

.

Access Control

The following capabilities are required to access this API:
"ReadDevices"


Example Usage

GET /api/space/device-management/devices/{id}/configurations/expanded


Parameters

NameTypeURI TypeDescriptionRequired
device-idIntegerPathThe ID of the device whose configuration data will be accessed. Y

Content Types


POST /api/space/device-management/devices/{id}/configurations/expanded (v1)


This API is used to filter expanded configuration content of a device using an XPath expression. Configuration groups are expanded (using the inherit="inherit" option on the Junos "get-configuration" RPC). Also, an XPath filter expression is passed in the HTPP body to filter the XML datafurther.

Fields Selection

A particular section of the configuration can be fetched using the 'fields' criteria. For example:

    fields=(version,system:(login:(user)))

These fields should be nested properly to get the required configuration content. For example, the 'fields' selection passed as fields=(version) will fetch only version information. (See the sample output below.)

An additional XPath filter expression can be supplied in the HTTP body.

Access Control

The following capabilities are required to access this API:
"ReadDevices"


Example Usage

POST /api/space/device-management/devices/{id}/configurations/expanded


Parameters

NameTypeURI TypeDescriptionRequired
device-idIntegerPathThe ID of the device whose expanded configuration content will be filtered. Y

Content Types