HostSummary Notebooklet class.
Queries and displays information about a host including:
- IP address assignment
- Related alerts
- Related hunting/investigation bookmarks
- Azure subscription/resource data.
Default Options
- heartbeat: Query Heartbeat table for host information.
- azure_net: Query AzureNetworkAnalytics table for host network topology information.
- alerts: Query any alerts for the host.
- bookmarks: Query any bookmarks for the host.
- azure_api: Query Azure API for VM information.
Other Options
None
This shows a summary data for a host. It shows host properties obtained from OMS Heartbeat and Azure API. It also lists Azure Sentinel alerts and bookmakrs related to to the host. Data and plots are stored in the result class returned by this function.
Each marker on the timeline indicates one or more alerts related to the host.
These are the host entity details gathered from Heartbeat and, if applicable, AzureNetworkAnalytics and Azure management API. The data shows OS information, IP Addresses assigned the host and any Azure VM information available.
Host Details Results.
- host_entity : msticpy.datamodel.entities.HostThe host entity object contains data about the host such as name, environment, operating system version, IP addresses and Azure VM details. Depending on the type of host, not all of this data may be populated.
- related_alerts : pd.DataFramePandas DataFrame of any alerts recorded for the host within the query time span.
- alert_timeline:Bokeh time plot of alerts recorded for host.
- related_bookmarks: pd.DataFramePandas DataFrame of any investigation bookmarks relating to the host.
attrib
contains data.search_terms
.result [property] Return result of the most recent notebooklet run.
silent [property] Get the current instance setting for silent running.
<hr>
Return host summary data.
- value : str
- Host name
- data : Optional[pd.DataFrame], optional
- Not used, by default None
- timespan : TimeSpan
- Timespan over which operations such as queries will be performed, by default None. This can be a TimeStamp object or another object that has valid start, end, or period attributes.
- options : Optional[Iterable[str]], optional
- List of options to use, by default None A value of None means use default options. Options prefixed with "+" will be added to the default options. To see the list of available options type help(cls) where "cls" is the notebooklet class or an instance of this class.
- start : Union[datetime, datelike-string]
- Alternative to specifying timespan parameter.
- end : Union[datetime, datelike-string]
- Alternative to specifying timespan parameter.
- HostSummaryResult
- Result object with attributes for each result type.
- MsticnbMissingParameterError
- If required parameters are missing
- heartbeat: Query Heartbeat table for host information.
- azure_net: Query AzureNetworkAnalytics table for host network topology information.
- alerts: Query any alerts for the host.
- bookmarks: Query any bookmarks for the host.
- azure_api: Query Azure API for VM information.
None