Withdraw of the 6.9.2 Release
Unfortunately, due to critical issues identified with version 6.9.2, we have decided to remove it and ensure it's no longer available for download. These issues impacted the ability to install or upgrade but none were security-related. We are diligently working to resolve these issues and are planning to release an updated version 6.9.3 in early May.
What if you've already upgraded?For customers who have already upgraded to 6.9.2, no immediate action is required, as none of these issues are security-related. Once it's available, you will still be able to upgrade to 6.9.3 as normal. We appreciate your patience and trust as we continue to enhance our software to better serve you. Thank you for your understanding.
Config - Hashtag/Keyword
Object type: keyword
Note
Even though they are calledhashtags
in the UI and documentation, they are still referenced askeywords
in the REST API.
Request URL: /rest/config/keyword
Permissions: Requires CONFIGUREKEYWORDS
Methods:
GET
— List hashtags.POST
— Create hashtag.PUT
— Update hashtag.DELETE
— Unimplemented.
Example GET Copied
{
"object" : {
"all_hosts" : "0",
"all_servicechecks" : "0",
"calculate_hard_states" : "0",
"description" : "cisco devices",
"enabled" : "1",
"exclude_handled" : "0",
"hosts" : [
{
"ref" : "/rest/config/host/7",
"name" : "cisco"
},
{
"ref" : "/rest/config/host/8",
"name" : "cisco1"
}
],
"id" : "2",
"individual_objects" : [
{
"attribute_value" : null,
"host_id" : "7",
"host_name" : "cisco",
"id" : "13",
"servicecheck_id" : "44",
"servicecheck_name" : "Check Memory"
},
{
"attribute_value" : null,
"host_id" : "8",
"host_name" : "cisco1",
"id" : "16",
"servicecheck_id" : "79",
"servicecheck_name" : "Coldstart"
},
{
"attribute_value" : null,
"host_id" : "11",
"host_name" : "cisco4",
"id" : "17",
"servicecheck_id" : "44",
"servicecheck_name" : "Check Memory"
},
{
"attribute_value" : "Ethernet0-12",
"host_id" : "11",
"host_name" : "cisco4",
"id" : "22",
"servicecheck_id" : "95",
"servicecheck_name" : "Interface"
}
],
"name" : "cisco",
"public" : "1",
"roles" : [
{
"ref" : "/rest/config/role/14",
"name" : "View some, change none"
},
{
"ref" : "/rest/config/role/15",
"name" : "View some, change none, no notify"
}
],
"servicechecks" : [
{
"ref" : "/rest/config/servicecheck/82",
"name" : "Another exception"
},
{
"ref" : "/rest/config/servicecheck/81",
"name" : "Test exceptions"
}
],
"show_contextual_menus" : "0",
"style" : "group_by_host",
"uncommitted" : "1"
}
}
Fields:
id
- ID number for this hashtag.name
- name of the hashtag.all_hosts
- if set, then all hosts with the specified service checks will be included in the bulk tagging selection.all_servicechecks
- if set, then all service checks on the specified hosts will be included in the bulk tagging selection.calculate_hard_states
— if set, the hashtag summary status will be based on the hard states of the services, not the current state. It is possible that the hashtag will have a calculated state ofOK
but in an unhandled state.description
- text to display in the hashtag detail view.enabled
- if set, this hashtag will be included in the Hashtags Summary view.exclude_handled
- if set, Opsview will exclude handled services from the calculation of the overall hashtag status. For example, with this setting enabled, a service in a handledCRITICAL
state will be ignored. If this setting is disabled, the hashtag state will becomeCRITICAL
.hosts
- list of hosts specified in this hashtag for bulk tagging.individual_objects
- returns an array of individually selected objects that will be associated with this hashtag. This column is not retrieved in a GET by default - addcols=+individual_objects
in a GET request to include this column (with the+
symbol URL encoded if required). The fields within each individual object:id
- unique ID for this individual object in this table.host_id
- ID of the host from the configuration database.host_name
- current host name for thathost_id
(from the configuration database, before an Apply Changes).servicecheck_id
- ID of the service check from the configuration database.servicecheck_name
- current name of the service check (from the configuration database, before an Apply Changes).attribute_value
- if the service check is a multi-servicecheck, this is the host variable value for that host service. Note that this value might not yet exist in the database or at runtime. It can beNULL
, but it cannot be an empty string.
public
- if set, this hashtag is visible to users in the Hashtags Summary View even if their permission does not include this hashtag.roles
- list of roles that have permission to see this hashtag.servicechecks
- list of service checks specified in this hashtag for bulk tagging.show_contextual_menus
- deprecated.style
- deprecated.uncommitted
- if set, you need to run Apply Changes to make any changes live.
Example POST/PUT Copied
{
"all_hosts" : "0",
"all_servicechecks" : "0",
"calculate_hard_states" : "0",
"description" : "cisco devices",
"enabled" : "1",
"exclude_handled" : "0",
"hosts" : [ 7, 8 ],
"id" : "2",
"individual_objects" : [
{
"attribute_value" : null,
"host_name" : "cisco",
"id" : "13",
"servicecheck_name" : "Check Memory"
},
{
"attribute_value" : "/",
"host_name" : "opsview",
"id" : "0",
"servicecheck_name" : "Disk"
},
{
"attribute_value" : "Ethernet0-12",
"host_name" : "cisco4",
"id" : "22",
"servicecheck_name" : "Interface"
}
],
"name" : "cisco",
"public" : "1",
"roles" : [ 14, 15 ],
"servicechecks" : [ 82, 81 ],
"show_contextual_menus" : "0",
"style" : "group_by_host",
"uncommitted" : "1"
}
individual_objects Copied
The input for this field is expected to be an array of objects. The logic for creating is:
- For each individual object:
- If an ID is specified and already exists for this hashtag, all other fields are assumed to have the same values as those in the database, and the rest of the object is ignored.
- If an ID is not specified, or is
0
, it is considered a new individual object. The system searches forhost_id
andservicecheck_id
in the current configuration database based on the inputhost_name
andservicecheck_name
. If either is not found, then the individual object is ignored. This means there is a potential race condition if a host name is changed while editing this object or if a host has been renamed in the configuration database but Apply Changes has not been run yet. - If an
attribute_value
is specified and it is either null or an empty string, it will be saved as null.
- Any objects currently associated with this hashtag that are not listed in this call will be removed.