Cisco Cisco Security Manager 4.11 Guia De Especificaciones

 

 

 

  

Some of the service calls (say fetching a list of access rules) might return a large set of data. To prevent such large 
fetches from causing performance issues on the server and client, these results will be ‘paginated’. Pagination is 
applicable only for the GetPolicyConfigByName and GetPolicyConfigByDeviceGID methods. The pagination 
scheme will work as follows: 

 

1)  In the first request the client sends, none of the parameters startIndex, endIndex will be set. This is 
an indication to the server that this is a fresh request. 

2)  If the server determines that this request needs to be paginated (because the total result set is 
greater than the page size) then it will return a paged result and will set the following two elements: 

a. endIndex: Will be set to endIndex of the current result set. For example if this is the first request 
and 1000 rows are being returned then endIndex will be 1000. 

b. totalCount: Will contain the total count of the query itself. For example, if the total result 
contains 10,000 rows, then the element totalCount will be set to 10,000. 

3)  In the subsequent request, the client must set the startIndex in the BaseReqResp object and send 
the same query request again. In this case the startIndex of the client request will be equal to the 
endIndex of the last response received. 

4)  In the final response if there are no more data to be fetched, the server will not set any data for 
endIndex and totalCount. 

 

Consider an example where a client is querying Firewall rules on a device “A” which has 3600 rules. The page size 
configured in the system is 1000. Following are the sequence of calls: 

 

 

Client  Get Firewall Rules on device “A” 

 

Server  Response with 1000 rules and endIndex=1000 and totalCount=3600 

 

Client  Get Firewall Rule on device “A” and startIndex=1000 

 

Server  Response with 1000 rules and endIndex=2000 and totalCount=3600 

 

Client  Get Firewall Rule on device “A” and startIndex=2000 

 

Server  Response with 1000 rules and endIndex=3000 and totalCount=3600 

 

Client  Get Firewall Rule on device “A” and startIndex=3000 

 

Server  Response with 600 rules and endIndex=<not-set> and totalCount=<not-set> 

 

As a general case, if the client notices that the endIndex or totalCount is not set then all rows are expected to have 
been returned. 

 

The login method authenticates a CSM client attempting to access the services provided by the CSM server. This 
method must be called prior to any other method called on other services. 

An example of the method login request is shown in the figure below.  The fields in these messages are described in 
the table below.