Cisco Cisco Firepower Management Center 4000 Developer's Guide
2-28
FireSIGHT System Host Input API Guide
Chapter 2 Using the Host Input API
Host Input API Functions
DeleteAttributeValue
You can use the
DeleteAttributeValue
function to remove an attribute value for a host.
Use this syntax:
DeleteAttributeValue($source_type_id, $source_id, $addr_string, $attrib_list, $id)
Table 2-23
SetAttributeValue Fields
Field
Description
Required
Allowed Values
$source_type_id
Indicates the type of the
host input source.
host input source.
Yes
“Application” or “Scanner”
Note you should set the
$source_type_id
variable to
contain a value before invoking the
SetAttributeValue
function, and then reference
$source_type_id
in your
function call. For more information, see
.
$source_id
Indicates the source ID
for the source adding the
host input.
for the source adding the
host input.
Yes
“source_id”
Note you should set the
$source_id
variable to contain
the source ID before invoking the
SetAttributeValue
function, and then reference
$source_id
in your
function call. For more information, see
$addr_string
Indicates the string
containing the IP
address or addresses for
the affected hosts.
containing the IP
address or addresses for
the affected hosts.
Yes (unless
attribute lists
are provided)
attribute lists
are provided)
A comma-separated list of IP addresses, CIDR blocks,
and ranges of IP addresses, with each address, block, or
range enclosed in double quotes.
and ranges of IP addresses, with each address, block, or
range enclosed in double quotes.
$attrib_list
Indicates the host
attribute or attributes
specifying the hosts
affected by the host
input.
attribute or attributes
specifying the hosts
affected by the host
input.
Yes (unless IP
addresses are
provided)
addresses are
provided)
A list of attribute value hash pairs of the format:
{attribute => “Department”,
value => “Development”},
Note that
$attrib_list
must be an array or reference an
array.
$id
Indicates the host
attribute name.
attribute name.
Yes
Valid attribute names consisting of alphanumeric
characters or spaces, enclosed in double quotes.
characters or spaces, enclosed in double quotes.
$value
Indicates the host
attribute value.
attribute value.
Yes
Valid attribute values for the named attribute, consisting
of alphanumeric characters or spaces, enclosed in double
quotes. If a value is passed in for a list attribute,
of alphanumeric characters or spaces, enclosed in double
quotes. If a value is passed in for a list attribute,
$value
must be an existing named value for the list attribute.