Cisco Cisco Firepower Management Center 2000 Guia Do Programador

Página de 60
 
3-15
FireSIGHT System Remediation API Guide
 
Chapter 3      Communicating with the Remediation Subsystem
  Defining the Configuration Template
The network Element
Each 
network
 element you use within a 
config_template
 represents a field in the web interface. A 
network field accepts an IP address (assumed to be a single IP address, that is, an IP address with /32 
netmask) or a CIDR block.
The following diagram illustrates the child elements of the 
network
 element.
When configuring child elements for an occurrence of a 
network
 element, you may only use each 
available child element once. The following table describes the child elements and attributes available 
to the 
network
 element.
The following portion of a 
config_template
 element definition indicates that the web interface displays 
a field labeled “Monitored Network”, which accepts either a /32 IP address or an IP address and netmask 
value, and which has a default value of 192.168.1.0/24.
<network>
<name>monitored_network</name>
<display_name>Monitored Network</display_name>
<default_value>192.168.1.0/24</default_value>
</network>
Table 3-9
network Attributes and Child Elements 
Name
Type
Description
Required?
required
attribute
Indicates whether users must provide a value in the field.
This attribute defaults to 
true
. You are not required to use this 
attribute. Therefore, if you do not use it (or if you explicitly set its 
value to 
true
), users must provide a value. If you set the value of 
the attribute to 
false
, the web interface indicates that providing a 
value is optional.
no
name
element
Provides context to the remediation module for the value entered 
in the field. Names may not contain white space and may only 
contain alphanumeric characters and the underscore (_) and dash 
(-) character. Names should be unique within modules. 
yes
display_name
element
Specifies the web interface label for this field.
yes
default_value
element
Specifies the default value for this field. If the web interface user 
does not specify a value, the remediation program uses this value 
by default.
no
example
element
Provides an example of the input that the remediation module 
expects to receive.
Note
This value is not displayed in the web interface.
no