Cisco Cisco Security Manager 4.7 Guía Del Usuario
Cisco Security Manager 4.7 API Specification (Version 2.0)
OL- 32164-01
Page 33
applicable only for the GetPolicyConfigByName and GetPolicyConfigByDeviceGID methods. The pagination
scheme will work as follows:
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.
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:
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.
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.
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.
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.
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:
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.
been returned.
2.2.2 Method login
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. Since the introduction of write APIs from
Version 2.0, the following is the behavior of the login method in different CSM server modes and between CSM
GUI client login and API login. In the below table the CSM GUI Client denotes the pre-bundles CSM thick client
along with CSM installer and API denotes the client that used CSM API.
method must be called prior to any other method called on other services. Since the introduction of write APIs from
Version 2.0, the following is the behavior of the login method in different CSM server modes and between CSM
GUI client login and API login. In the below table the CSM GUI Client denotes the pre-bundles CSM thick client
along with CSM installer and API denotes the client that used CSM API.