Cisco Cisco Security Manager 4.7 Guía Del Usuario
Cisco Security Manager 4.7 API Specification (Version 2.0)
OL- 32164-01
Page 117
3.2.4 Method GetDeviceListByGroup
The GetDeviceListByGroup method returns the list of devices contained within a particular group or all devices if
the wildcard argument is chosen. The group name path will be prepared by combining the entire path Items
mentioned in the request body. The list of devices will be from the combination of the path Items. For example, the
path Item is provided as San Jose alone and the CSM Server has sub groups under San Jose then the API will return
all the devices matching group San Jose and other sub groups under it as well.
the wildcard argument is chosen. The group name path will be prepared by combining the entire path Items
mentioned in the request body. The list of devices will be from the combination of the path Items. For example, the
path Item is provided as San Jose alone and the CSM Server has sub groups under San Jose then the API will return
all the devices matching group San Jose and other sub groups under it as well.
For example if the path items are San Jose and Building 14 then the devices matching group path “/San
Jose/Building 14” and its sub group (if any) will be returned.
Jose/Building 14” and its sub group (if any) will be returned.
3.2.4.1 Request
An example of the method GetDeviceListByGroup request is shown in the figure below. The fields in these
messages are described in the table below.
messages are described in the table below.
Figure 66: Method GetDeviceListByGroup Request Example
Table 59: Method GetDeviceListByGroup Request URL Argument Descriptions
HTTP/XML Content
Definition
getDeviceListByGroupRequest
Device list request that returns a list of devices contained in the group
Element: deviceGroupPath
An element that identifies the device group being requested. Contains 1 or more
pathItem entries. All the pathItems combined (separated by a slash “/”) will be
treated as one group name. The path information from the response of the
GetGroupList method can be used here. Each group in the GetGroupList has
path attribute which provide the complete path name. Each element in the path
(separated by a “/”) is encoded as pathItems. For example if device details for
group includes a path such as “/VmsVirtualRoot/San Jose/Building 13”
(obtained from the response of getGroupList API), then pathItems will be
“VmsVirtualRoot”, “San Jose” and “Building 13”. The “VmsVirtualRoot” is a
virtual “root node” for all groups.
pathItem entries. All the pathItems combined (separated by a slash “/”) will be
treated as one group name. The path information from the response of the
GetGroupList method can be used here. Each group in the GetGroupList has
path attribute which provide the complete path name. Each element in the path
(separated by a “/”) is encoded as pathItems. For example if device details for
group includes a path such as “/VmsVirtualRoot/San Jose/Building 13”
(obtained from the response of getGroupList API), then pathItems will be
“VmsVirtualRoot”, “San Jose” and “Building 13”. The “VmsVirtualRoot” is a
virtual “root node” for all groups.
URL:
https://hostname/nbi/configservice/getDeviceListByGroup
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”?>
<deviceListByGroupRequest>
https://hostname/nbi/configservice/getDeviceListByGroup
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”?>
<deviceListByGroupRequest>
<protVersion>1.0</protVersion>
<reqId>123</reqId>
<deviceGroupPath>
<pathItem>building10</pathItem>
<pathItem>4
th
floor</pathItem>
</deviceGroupPath>
</deviceListByGroupRequest>