Microsoft DHCP

Version	1.24.3 (View all)
Compatible Kibana version(s)	7.14.0 or higher 8.0.0 or higher
Supported Serverless project types What’s this?	Security Observability
Subscription level What’s this?	Basic
Level of support What’s this?	Elastic

This integration collects logs and metrics from Microsoft DHCP logs.

Compatibility

edit

This integration has been made to support the DHCP log format from Windows Server 2008 and later.

Logs

edit

Ingest logs from Microsoft DHCP Server, by default logged with the filename format: %windir%\System32\DHCP\DhcpSrvLog-*.log

Logs may also be ingested from Microsoft DHCPv6 Server, by default logged with the filename format: %windir%\System32\DHCP\DhcpV6SrvLog-*.log

Relevant documentation for Microsoft DHCP can be found on this location.

Example

An example event for log looks as following:

{
    "@timestamp": "2001-01-01T01:01:01.000-05:00",
    "agent": {
        "ephemeral_id": "599c360c-711b-41f0-8b3b-03101ce1808b",
        "id": "0874c904-40cc-4817-b0f8-557b17245c75",
        "name": "docker-fleet-agent",
        "type": "filebeat",
        "version": "8.8.0"
    },
    "data_stream": {
        "dataset": "microsoft_dhcp.log",
        "namespace": "ep",
        "type": "logs"
    },
    "ecs": {
        "version": "8.11.0"
    },
    "elastic_agent": {
        "id": "0874c904-40cc-4817-b0f8-557b17245c75",
        "snapshot": false,
        "version": "8.8.0"
    },
    "event": {
        "action": "dhcp-dns-update",
        "agent_id_status": "verified",
        "category": [
            "network"
        ],
        "code": "35",
        "dataset": "microsoft_dhcp.log",
        "ingested": "2023-10-24T00:08:40Z",
        "kind": "event",
        "original": "35,01/01/01,01:01:01,DNS update request failed,192.168.2.1,host.test.com,000000000000,",
        "outcome": "failure",
        "reason": "DNS update request failed.",
        "timezone": "America/New_York",
        "type": [
            "connection",
            "denied"
        ]
    },
    "host": {
        "ip": [
            "192.168.128.7"
        ],
        "mac": [
            "02-42-C0-A8-80-07"
        ],
        "name": "docker-fleet-agent"
    },
    "input": {
        "type": "log"
    },
    "log": {
        "file": {
            "path": "/tmp/service_logs/test-dhcp.log"
        },
        "offset": 2407
    },
    "message": "DNS update request failed",
    "observer": {
        "hostname": "docker-fleet-agent",
        "ip": [
            "192.168.128.7"
        ],
        "mac": [
            "02-42-C0-A8-80-07"
        ]
    },
    "source": {
        "address": "host.test.com",
        "domain": "host.test.com",
        "ip": "192.168.2.1",
        "mac": "00-00-00-00-00-00"
    },
    "tags": [
        "preserve_original_event",
        "forwarded",
        "microsoft_dhcp"
    ]
}

Exported fields

Field	Description	Type
@timestamp	Event timestamp.	date
data_stream.dataset	Data stream dataset.	constant_keyword
data_stream.namespace	Data stream namespace.	constant_keyword
data_stream.type	Data stream type.	constant_keyword
ecs.version	ECS version this event conforms to. `ecs.version` is a required field and must exist in all events. When querying across multiple indices — which may conform to slightly different ECS versions — this field lets integrations adjust to the schema version of the events.	keyword
event.action	The action captured by the event. This describes the information in the event. It is more specific than `event.category`. Examples are `group-add`, `process-started`, `file-created`. The value is normally defined by the implementer.	keyword
event.category	This is one of four ECS Categorization Fields, and indicates the second level in the ECS category hierarchy. `event.category` represents the "big buckets" of ECS categories. For example, filtering on `event.category:process` yields all events relating to process activity. This field is closely related to `event.type`, which is used as a subcategory. This field is an array. This will allow proper categorization of some events that fall in multiple categories.	keyword
event.code	Identification code for this event, if one exists. Some event sources use event codes to identify messages unambiguously, regardless of message language or wording adjustments over time. An example of this is the Windows Event ID.	keyword
event.dataset	Event dataset	constant_keyword
event.ingested	Timestamp when an event arrived in the central data store. This is different from `@timestamp`, which is when the event originally occurred. It’s also different from `event.created`, which is meant to capture the first time an agent saw the event. In normal conditions, assuming no tampering, the timestamps should chronologically look like this: `@timestamp` < `event.created` < `event.ingested`.	date
event.kind	This is one of four ECS Categorization Fields, and indicates the highest level in the ECS category hierarchy. `event.kind` gives high-level information about what type of information the event contains, without being specific to the contents of the event. For example, values of this field distinguish alert events from metric events. The value of this field can be used to inform how these kinds of events should be handled. They may warrant different retention, different access control, it may also help understand whether the data is coming in at a regular interval or not.	keyword
event.module	Event module	constant_keyword
event.original	Raw text message of entire event. Used to demonstrate log integrity or where the full log message (before splitting it up in multiple parts) may be required, e.g. for reindex. This field is not indexed and doc_values are disabled. It cannot be searched, but it can be retrieved from `_source`. If users wish to override this and index this field, please see `Field data types` in the `Elasticsearch Reference`.	keyword
event.outcome	This is one of four ECS Categorization Fields, and indicates the lowest level in the ECS category hierarchy. `event.outcome` simply denotes whether the event represents a success or a failure from the perspective of the entity that produced the event. Note that when a single transaction is described in multiple events, each event may populate different values of `event.outcome`, according to their perspective. Also note that in the case of a compound event (a single event that contains multiple logical events), this field should be populated with the value that best captures the overall success or failure from the perspective of the event producer. Further note that not all events will have an associated outcome. For example, this field is generally not populated for metric events, events with `event.type:info`, or any events for which an outcome does not make logical sense.	keyword
event.reason	Reason why this event happened, according to the source. This describes the why of a particular action or outcome captured in the event. Where `event.action` captures the action from the event, `event.reason` describes why that action was taken. For example, a web proxy with an `event.action` which denied the request may also populate `event.reason` with the reason why (e.g. `blocked site`).	keyword
event.timezone	This field should be populated when the event’s timestamp does not include timezone information already (e.g. default Syslog timestamps). It’s optional otherwise. Acceptable timezone formats are: a canonical ID (e.g. "Europe/Amsterdam"), abbreviated (e.g. "EST") or an HH:mm differential (e.g. "-05:00").	keyword
event.type	This is one of four ECS Categorization Fields, and indicates the third level in the ECS category hierarchy. `event.type` represents a categorization "sub-bucket" that, when used along with the `event.category` field values, enables filtering events down to a level appropriate for single visualization. This field is an array. This will allow proper categorization of some events that fall in multiple event types.	keyword
host.domain	Name of the domain of which the host is a member. For example, on Windows this could be the host’s Active Directory domain or NetBIOS domain name. For Linux this could be the domain of the host’s LDAP provider.	keyword
host.ip	Host ip addresses.	ip
host.mac	Host MAC addresses. The notation format from RFC 7042 is suggested: Each octet (that is, 8-bit byte) is represented by two [uppercase] hexadecimal digits giving the value of the octet as an unsigned integer. Successive octets are separated by a hyphen.	keyword
host.name	Name of the host. It can contain what hostname returns on Unix systems, the fully qualified domain name (FQDN), or a name specified by the user. The recommended value is the lowercase FQDN of the host.	keyword
input.type		keyword
log.file.path	Full path to the log file this event came from, including the file name. It should include the drive letter, when appropriate. If the event wasn’t read from a log file, do not populate this field.	keyword
log.offset		long
message	For log events the message field contains the log message, optimized for viewing in a log viewer. For structured logs without an original message field, other fields can be concatenated to form a human-readable summary of the event. If multiple messages exist, they can be combined into one message.	match_only_text
microsoft.dhcp.correlation_id	The NAP correlation ID related to the client/server transaction.	keyword
microsoft.dhcp.dhc_id	The related DHCID (DHC DNS record).	keyword
microsoft.dhcp.dns_error_code	DNS error code communicated to client.	keyword
microsoft.dhcp.duid.hex	The related DHCP Unique Identifier (DUID) for the host (DHCPv6).	keyword
microsoft.dhcp.duid.length	The length of the DUID field.	keyword
microsoft.dhcp.error_code	DHCP server error code.	keyword
microsoft.dhcp.probation_time	The probation time before lease ends on specific IP.	keyword
microsoft.dhcp.relay_agent_info	Information about DHCP relay agent used for the DHCP request.	keyword
microsoft.dhcp.result	The DHCP result type in numerical value, for example "NoQuarantine" is 0, "Quaratine" is 1, "Drop Packet" is 2 etc.	keyword
microsoft.dhcp.result_description	The DHCP result type from numerical value, for example, 0 is "NoQuarantine", 1 is "Quarantine", 2 is "Drop Packet" etc.	keyword
microsoft.dhcp.subnet_prefix	The number of bits for the subnet prefix.	keyword
microsoft.dhcp.transaction_id	The DHCP transaction ID.	keyword
microsoft.dhcp.user.hex	Hex representation of the user.	keyword
microsoft.dhcp.user.string	String representation of the user.	keyword
microsoft.dhcp.vendor.hex	Hex representation of the vendor.	keyword
microsoft.dhcp.vendor.string	String representation of the vendor.	keyword
observer.hostname	Hostname of the observer.	keyword
observer.ip	IP addresses of the observer.	ip
observer.mac	MAC addresses of the observer. The notation format from RFC 7042 is suggested: Each octet (that is, 8-bit byte) is represented by two [uppercase] hexadecimal digits giving the value of the octet as an unsigned integer. Successive octets are separated by a hyphen.	keyword
source.address	Some event source addresses are defined ambiguously. The event will sometimes list an IP, a domain or a unix socket. You should always store the raw address in the `.address` field. Then it should be duplicated to `.ip` or `.domain`, depending on which one it is.	keyword
source.domain	The domain name of the source system. This value may be a host name, a fully qualified domain name, or another host naming format. The value may derive from the original event or be added from enrichment.	keyword
source.ip	IP address of the source (IPv4 or IPv6).	ip
source.mac	MAC address of the source. The notation format from RFC 7042 is suggested: Each octet (that is, 8-bit byte) is represented by two [uppercase] hexadecimal digits giving the value of the octet as an unsigned integer. Successive octets are separated by a hyphen.	keyword
tags	List of keywords used to tag each event.	keyword
user.name	Short name or login of the user.	keyword
user.name.text	Multi-field of `user.name`.	match_only_text

Changelog

edit

Changelog

Version	Details	Kibana version(s)
1.24.3	Bug fix (View pull request) Use triple-brace Mustache templating when referencing variables in ingest pipelines.	7.14.0 or higher 8.0.0 or higher
1.24.2	Enhancement (View pull request) Changed owners	7.14.0 or higher 8.0.0 or higher
1.24.1	Bug fix (View pull request) Fix exclude_files pattern.	7.14.0 or higher 8.0.0 or higher
1.24.0	Enhancement (View pull request) ECS version updated to 8.11.0.	7.14.0 or higher 8.0.0 or higher
1.23.0	Enhancement (View pull request) Fix the values of host.* and introduce source.*	7.14.0 or higher 8.0.0 or higher
1.22.0	Enhancement (View pull request) Improve event.original check to avoid errors if set.	7.14.0 or higher 8.0.0 or higher
1.21.0	Enhancement (View pull request) ECS version updated to 8.10.0.	7.14.0 or higher 8.0.0 or higher
1.20.0	Enhancement (View pull request) The format_version in the package manifest changed from 2.11.0 to 3.0.0. Removed dotted YAML keys from package manifest. Added owner.type: elastic to package manifest.	7.14.0 or higher 8.0.0 or higher
1.19.0	Enhancement (View pull request) Add tags.yml file so that integration’s dashboards and saved searches are tagged with "Security Solution" and displayed in the Security Solution UI.	7.14.0 or higher 8.0.0 or higher
1.18.0	Enhancement (View pull request) Add QResult description based on numerical value	7.14.0 or higher 8.0.0 or higher
1.17.0	Enhancement (View pull request) Add long description to event.reason	7.14.0 or higher 8.0.0 or higher
1.16.0	Enhancement (View pull request) Update package to ECS 8.9.0.	7.14.0 or higher 8.0.0 or higher
1.15.0	Enhancement (View pull request) Update package-spec to 2.9.0.	7.14.0 or higher 8.0.0 or higher
1.14.0	Enhancement (View pull request) Ensure event.kind is correctly set for pipeline errors.	7.14.0 or higher 8.0.0 or higher
1.13.0	Enhancement (View pull request) Update package to ECS 8.8.0.	7.14.0 or higher 8.0.0 or higher
1.12.0	Enhancement (View pull request) Lowercase host.name field	7.14.0 or higher 8.0.0 or higher
1.11.0	Enhancement (View pull request) Update package to ECS 8.7.0.	7.14.0 or higher 8.0.0 or higher
1.10.1	Enhancement (View pull request) Added categories and/or subcategories.	7.14.0 or higher 8.0.0 or higher
1.10.0	Enhancement (View pull request) Update package to ECS 8.6.0.	7.14.0 or higher 8.0.0 or higher
1.9.0	Enhancement (View pull request) Update package to ECS 8.5.0.	7.14.0 or higher 8.0.0 or higher
1.8.0	Enhancement (View pull request) Improve handling of client ID fields.	7.14.0 or higher 8.0.0 or higher
1.7.1	Enhancement (View pull request) Fix a bug in documenation with hyperlink to Microsoft website	7.14.0 or higher 8.0.0 or higher
1.7.0	Enhancement (View pull request) Change host.domain to host.name to reflect the event data and then extract host.domain from the host.name	7.14.0 or higher 8.0.0 or higher
1.6.0	Enhancement (View pull request) Update package to ECS 8.4.0	7.14.0 or higher 8.0.0 or higher
1.5.0	Enhancement (View pull request) Update package to ECS 8.3.0.	7.14.0 or higher 8.0.0 or higher
1.4.2	Bug fix (View pull request) Change event.type value from end to stop according to ECS	7.14.0 or higher 8.0.0 or higher
1.4.1	Bug fix (View pull request) Format observer.mac as per ECS and add missing mappings for event.category, event.outcome, and event.type.	7.14.0 or higher 8.0.0 or higher
1.4.0	Enhancement (View pull request) Update to ECS 8.2	7.14.0 or higher 8.0.0 or higher
1.3.1	Enhancement (View pull request) Add documentation for multi-fields	7.14.0 or higher 8.0.0 or higher
1.3.0	Enhancement (View pull request) Update to ECS 8.0	7.14.0 or higher 8.0.0 or higher
1.2.0	Enhancement (View pull request) Add DHCPv6 Server support	—
1.1.0	Enhancement (View pull request) Add more event.action and event.outcome values	7.14.0 or higher 8.0.0 or higher
1.0.0	Enhancement (View pull request) GA integration	—
0.2.1	Bug fix (View pull request) Change test public IPs to the supported subset	—
0.2.0	Enhancement (View pull request) Add 8.0.0 version constraint	—
0.1.1	Enhancement (View pull request) Update Title and Description.	—
0.1.0	Enhancement (View pull request) Initial release	—

« Microsoft Defender for Endpoint integration Microsoft DNS Server Audit and Analytical logs »