Cisco Cisco Firepower Management Center 4000 Entwickleranleitung

Seite von 60
 
2-12
FireSIGHT System Remediation API Guide
 
Chapter 2      Planning and Packaging Your Remediation Module 
  Data Returned by Modules
Suppose a user adds this remediation to the AdminInstance instance and provides the following values:
The 
instance.conf 
document written when the user saved the example configuration values would, after 
the section provided in the example in 
<remediation name=”AdminRemediation” type=”acl_insert”>
<config>
<integer=”acl_num”>55</integer>
</config>
</remediation>
Note that if no more remediations were added to the instance, the 
instance.conf
 should be terminated 
with 
</instance>
 at this point.
Data Returned by Modules
Remediation modules must return exit status codes, known as return codes, to the Defense Center. The 
Table View of Remediations in the Defense Center web interface displays a result message for each 
remediation launched. The return code from the remediation program determines the result message 
displayed.
Return codes must be integers in the 0 to 255 range inclusive, as defined in the following table.
See 
 for the list of predefined codes and for directions on creating 
custom codes.
Packaging and Installing Your Module
The remediation API requires that you package your remediation modules. The files that make up your 
module must be provided in a gzipped tar file.
See the following sections for more information:
  •
 provides helpful tips for packaging your binaries and 
module.template
 files for upload and installation.
  •
 explains how to install your remediation module on the Defense 
Center.
Table 2-12
Sample Values 
Field
Value
Remediation Name
AdminRemediation
ACL Number
55
Table 2-13
Return Code Ranges 
Range
Use
0 - 128
Reserved for Cisco predefined return codes
129 - 255
Available for custom remediations