Cisco Cisco Firepower Management Center 4000 Entwickleranleitung

Seite von 60
 
3-16
FireSIGHT System Remediation API Guide
 
Chapter 3      Communicating with the Remediation Subsystem 
  Defining the Configuration Template
The enumeration Element
Each 
enumeration
 element you use in a 
config_template
 represents a drop-down list of strings 
displayed in the web interface. Users can select a single value from this list.
The following diagram illustrates the child and grandchild elements of the 
enumeration
 element.
The following table describes the child elements and attributes available to the 
enumeration
 element.
Table 3-10
enumeration Attributes, Child Elements, and Grandchild 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
constraints
element
Specifies the values that the user can enter in this field.
The 
constraints
 element has one required child element, 
value
that accepts a string that represents one choice for the users. Use 
multiple 
value
 elements to provide multiple choices to the user.
yes