Cisco Cisco Firepower Management Center 2000 Guia Do Programador

Página de 60
 
3-6
FireSIGHT System Remediation API Guide
 
Chapter 3      Communicating with the Remediation Subsystem 
  Defining the Configuration Template
  •
  •
  •
The boolean Element
Each 
boolean
 element you use in a 
config_template
 represents a true/false choice, which appears as a 
set of radio buttons labeled 
On
 or 
Off
, users can make in the web interface. If you set the element’s 
required
 attribute to false, an additional radio button is available, labeled 
Not Selected
.
The following portion of the 
module.template
 schema diagram illustrates the 
boolean
 element’s child 
elements.
When configuring child elements for an occurrence of a 
boolean
 element, you may only use each 
available child element once. The following table describes the child elements available to the 
boolean
 
element.
Table 3-2
boolean Attributes and Child Elements 
Name
Type
Description
Required?
required
attribute
Indicates whether specifying a value in the field is optional.
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 select either 
On
 or 
Off
. If you set the 
value of the attribute to 
false
, the web interface indicates that the 
choice 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 a module.
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