Cisco Cisco Security Manager 4.4 Guia De Especificaciones
Cisco Security Manager 4.4 API Specification (Version 1.1)
OL- 29074-01
Page 11
1
Overview
This document provides the protocol description and specification for the Cisco Security Manager (CSM) API as
well as the behavioral requirements for any CSM client products that will use the API on the CSM Server and CSM
Server (infrastructure device) itself. In addition, it provides the XML schema, which is the basis for the message
content carried by the CSM northbound (NB) API.
well as the behavioral requirements for any CSM client products that will use the API on the CSM Server and CSM
Server (infrastructure device) itself. In addition, it provides the XML schema, which is the basis for the message
content carried by the CSM northbound (NB) API.
The CSM NB API is designed to be used by client products that may wish to read network security configuration
information or events as well in the future of publishing changes to those configurations.
information or events as well in the future of publishing changes to those configurations.
CSM NB API is broken into services that enable various features providing access to both global as well as device
specific network configuration policies, for Cisco ASA and IPS devices
specific network configuration policies, for Cisco ASA and IPS devices
After a client receives the policy information, it can use the information to perform security analysis, link to security
events…etc.
events…etc.
1.1 Scope
This document serves as the CSM NB API 1.1 specification, the specification for the XML schema which provides
the basis of the message content carried in CSM API payload and the behavioral specification for CSM Client
products and infrastructure products implementing the CSM NB API.
the basis of the message content carried in CSM API payload and the behavioral specification for CSM Client
products and infrastructure products implementing the CSM NB API.
Note: Unless otherwise stated, all references to CSM Client or CSM "API" Client throughout this document refer to
the third party "CSM API Client Program" that uses the REST interface to communicate with the CSM Server. The
CSM client mentioned in this document should not be confused with the pre-bundled CSM GUI client application
that is installed on user desktops to access the server. Wherever necessary, any references to the pre-bundled CSM
GUI client application in the document includes a screen shot of the relevant screen to prevent any confusion. Please
see the figure below where the interaction of the CSM API Client Program is clearly denoted.
the third party "CSM API Client Program" that uses the REST interface to communicate with the CSM Server. The
CSM client mentioned in this document should not be confused with the pre-bundled CSM GUI client application
that is installed on user desktops to access the server. Wherever necessary, any references to the pre-bundled CSM
GUI client application in the document includes a screen shot of the relevant screen to prevent any confusion. Please
see the figure below where the interaction of the CSM API Client Program is clearly denoted.