KB Article

kb_article

The KB Article object contains metadata that describes the patch or update.

Contents

Attributes

Caption Name Type Is Array Default Description
Average Timespan avg_timespan Time Span The average time to patch.
Patch Bulletin bulletin String The kb article bulletin identifier.
Classification classification String The vendors classification of the kb article.
Created Time created_time Timestamp The date the kb article was released by the vendor.
Install State install_state String The install state of the kb article.
Install State ID install_state_id Integer The normalized install state ID of the kb article.
0
Unknown
1
Installed
2
Not Installed
3
Installed Pending Reboot
99
Other
The patch is superseded. is_superseded Boolean The kb article has been replaced by another.
OS os Operating System (OS) The operating system the kb article applies.
Product product Product The product details the kb article applies.
Raw Data raw_data JSON The event data as received from the event source.
Record ID record_id String Unique identifier for the object
Severity severity String The severity of the kb article.
Size size Long The size in bytes for the kb article.
Source URL src_url URL String The kb article link from the source vendor.
Title title String The title of the kb article.
Unique ID uid String The unique identifier for the kb article.
Unmapped Data unmapped Unmapped The attributes that are not mapped to the event schema. The names and values of those attributes are specific to the event source.

Context

KB Article

JSON

            
{
  "caption": "KB Article",
  "description": "The KB Article object contains metadata that describes the patch or update.",
  "extends": "object",
  "name": "kb_article",
  "attributes": {
    "avg_timespan": {
      "description": "The average time to patch.",
      "requirement": "optional",
      "caption": "Average Timespan",
      "type": "timespan"
    },
    "install_state": {
      "description": "The install state of the kb article.",
      "requirement": "recommended",
      "caption": "Install State",
      "type": "string_t"
    },
    "install_state_id": {
      "description": "The normalized install state ID of the kb article.",
      "requirement": "recommended",
      "caption": "Install State ID",
      "sibling": "install_state",
      "type": "integer_t",
      "enum": {
        "0": {
          "caption": "Unknown",
          "description": "The normalized install state is unknown."
        },
        "1": {
          "caption": "Installed",
          "description": "The item is installed."
        },
        "2": {
          "caption": "Not Installed",
          "description": "The item is not installed."
        },
        "3": {
          "caption": "Installed Pending Reboot",
          "description": "The item is installed pending reboot operation."
        },
        "99": {
          "caption": "Other",
          "description": "The install state is not mapped. See the <code>install_state</code> attribute, which contains a data source specific value."
        }
      }
    },
    "title": {
      "description": "The title of the kb article.",
      "requirement": "recommended",
      "caption": "Title",
      "type": "string_t"
    },
    "uid": {
      "description": "The unique identifier for the kb article.",
      "requirement": "required",
      "caption": "Unique ID",
      "type": "string_t"
    },
    "os": {
      "description": "The operating system the kb article applies.",
      "requirement": "recommended",
      "caption": "OS",
      "type": "os"
    },
    "severity": {
      "description": "The severity of the kb article.",
      "requirement": "recommended",
      "caption": "Severity",
      "type": "string_t"
    },
    "bulletin": {
      "description": "The kb article bulletin identifier.",
      "requirement": "optional",
      "caption": "Patch Bulletin",
      "type": "string_t"
    },
    "product": {
      "description": "The product details the kb article applies.",
      "requirement": "optional",
      "caption": "Product",
      "type": "product"
    },
    "is_superseded": {
      "description": "The kb article has been replaced by another.",
      "requirement": "optional",
      "caption": "The patch is superseded.",
      "type": "boolean_t"
    },
    "created_time": {
      "description": "The date the kb article was released by the vendor.",
      "requirement": "optional",
      "caption": "Created Time",
      "type": "timestamp_t"
    },
    "size": {
      "description": "The size in bytes for the kb article.",
      "requirement": "optional",
      "caption": "Size",
      "type": "long_t"
    },
    "src_url": {
      "description": "The kb article link from the source vendor.",
      "requirement": "optional",
      "caption": "Source URL",
      "type": "url_t"
    },
    "classification": {
      "description": "The vendors classification of the kb article.",
      "requirement": "optional",
      "caption": "Classification",
      "type": "string_t"
    },
    "raw_data": {
      "group": "context",
      "caption": "Raw Data",
      "description": "The event data as received from the event source.",
      "type": "json_t"
    },
    "record_id": {
      "description": "Unique identifier for the object",
      "group": "primary",
      "requirement": "required",
      "caption": "Record ID",
      "type": "string_t"
    },
    "unmapped": {
      "caption": "Unmapped Data",
      "description": "The attributes that are not mapped to the event schema. The names and values of those attributes are specific to the event source.",
      "type": "unmapped",
      "is_array": true
    }
  }
}