Cisco Cisco Security Manager 4.7 User Guide

Page of 290
 
 
 
  
 
Cisco Security Manager 4.7 API Specification (Version 2.0) 
 
OL- 32164-01 
Page  119
 
3.2.5 Method GetDeviceConfigByGID 
The GetDeviceConfigByGID method returns a specific device object and its associated configuration based on the 
device id passed into the method. The user requesting the device configuration must have both the “view_device” 
and “view_cli” privilege on the device for which the config is being requested. The data in the “fullConfig” element 
that this method returns is equal to the data from a typical “show running-config” command exectuted on the device. 
This full configuration is returned from CSM’s Configuration Archive (CA) component. The CA is updated during 
device discovery and/or deployments. NOTEThis fullConfig will not contain any Out Of Band (OOB) 
configuration updates done directly on the device without using CSM.
 
 
 
Please also see Section 3.2.11 and Section 5. 
3.2.5.1 Request 
An example of the method GetDeviceConfigByGID request is shown in the figure below..  The fields in these 
messages are described in the table below. 
 
Figure 68: Method GetDeviceConfigByGID Request Example  
Table 60: Method GetDeviceConfigByGID Request URL Attribute Descriptions 
URL Attribute Name 
Definition 
deviceConfigByGIDRequest 
A global ID request 
gid 
The device global object identifier requested to be returned. NOTE: The device 
GID may be obtained by using any of the APIs - getDeviceListByCapability or 
getDeviceListByGroup or GetGroupList
HTTP Method 
POST 
HTTP Header: asCookie 
The cookie returned by the login method that identifies the authentication 
session 
Returns 
200 OK + XML 
 
401 Unauthorized 
 
URL: 
 
https://hostname/nbi/configservice/getDeviceConfigByGID 
  
HTTP Header: 
 
Set-Cookie: asCookie=732423sdfs73242; expires=Fri, 31-Dec-2010 23:59:59 GMT; path=/; 
domain=.hostdomain.com  
 
XML Argument: 
 
<?xml version=”1.0” encoding=”UTF-8”?> 
<deviceConfigByGIDRequest> 
 
<protVersion>1.0</protVersion> 
 
<reqId>123</reqId> 
   <gid>00000000-0000-0000-0000-051539607555</gid> 
</deviceConfigByGIDRequest>