Cisco Cisco Firepower Management Center 4000 Guide Du Développeur
3-12
FireSIGHT System Remediation API Guide
Chapter 3 Communicating with the Remediation Subsystem
Defining the Configuration Template
When configuring child elements for an occurrence of an
ipaddress
element, you may only use each
available child element once. The following table describes the child elements available to the
ipaddress
element.
The following portion of a
config_template
element definition indicates that the web interface displays
a field labeled “Mail Server,” which accepts a single IP address.
<ipaddress>
<name>mail_server</name>
<display_name>Mail Server</display_name>
</ipaddress>
The netmask Element
Each
netmask
element you use in a
config_template
represents a field in the web interface that accepts
netmask values. Netmask values can be denoted by a dotted quad (255.255.255.255) or a CIDR mask
(/8).
(/8).
The diagram illustrates the child elements of the
netmask
element.
Table 3-6
ipaddress 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
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.
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.
no
example
element
Provides an example of the input that the remediation module
expects to receive.
expects to receive.
Note
This value is not displayed in the web interface.
no