topic Explicitly retrieving running or candidate config via XML API in Automation/API Discussions

Explicitly retrieving running or candidate config via XML API

tgarrett — Mon, 20 Jun 2011 15:44:27 GMT

If I understand correctly, the XML API can be used to retrieve and edit the latest version of the config, whether it has been committed as the running config or not. Because a running config represents the actual current configuration state of the device, it would be very helpful to be able to explicitly request a retrieval of that config version. At the minimum, when a config is retrieved it would be helpful to see in the data whether it had been committed or not (something like a committed="true|false" attribute on the root config element).

Does a capability like this exist in the API, perhaps as an undocumented option?

Thanks in advance for your help!

Tim

Re: Explicitly retrieving running or candidate config via XML API

tgarrett — Tue, 28 Jun 2011 20:57:49 GMT

Edit : moving to its own thread

Message was edited by: tgarrett

Re: Explicitly retrieving running or candidate config via XML API

SRA — Wed, 29 Jun 2011 02:53:47 GMT

You can retrieve the running config using type=config and action=show:

https://hostname/esp/restapi.esp?key=keyvalue&type=config&action=show

You can retrieve candidate config using type=config, action=get, and the xpath for appropriate config section.

https://hostname/esp/restapi.esp?key=keyvalue&type=config&action=get&xpath=/config/shared

https://hostname/esp/restapi.esp?key=keyvalue&type=config&action=get&xpath=/config/devices

https://hostname/esp/restapi.esp?key=keyvalue&type=config&action=get&xpath=/config/mgt-config

Re: Explicitly retrieving running or candidate config via XML API

tgarrett — Wed, 29 Jun 2011 14:19:13 GMT

Thanks for the info!

Re: Explicitly retrieving running or candidate config via XML API

tgarrett — Wed, 29 Jun 2011 18:21:29 GMT

I was able to verify that the rule bases reflected change as you said. However, I did also notice that the output with the "show" action is considerably smaller than the output of the "get" action. Is it possible to get predefined elements such as applications in the running config? The use of the xpath request parameter with the "show" action always seems to return an error "No such node".