From 7f33cd456e78faf5b7590432033d8d6fa455a5b6 Mon Sep 17 00:00:00 2001 From: Cecilia Stevens <63068179+ceciliastevens@users.noreply.github.com> Date: Thu, 27 Feb 2025 16:28:46 -0500 Subject: [PATCH] update docs for health issue types --- CHANGELOG.md | 6 ++++++ src/_incydr_cli/cmds/agents.py | 2 +- src/_incydr_sdk/agents/client.py | 2 +- src/_incydr_sdk/agents/models.py | 2 +- 4 files changed, 9 insertions(+), 3 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index d6f9e7eb..ac84e277 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -9,6 +9,12 @@ how a consumer would use the library or CLI tool (e.g. adding unit tests, updating documentation, etc) are not captured here. +## Unreleased + +### Added + +- Improved documentation to clarify that all agent health issues can be queried and filtered using the CLI and SDK. + ## 2.2.3 - 2025-02-05 ### Fixed diff --git a/src/_incydr_cli/cmds/agents.py b/src/_incydr_cli/cmds/agents.py index b5cc0a8b..4c6dc932 100644 --- a/src/_incydr_cli/cmds/agents.py +++ b/src/_incydr_cli/cmds/agents.py @@ -57,7 +57,7 @@ def agents(): default=None, help="Filter by unhealthy agents. Defaults to returning all unhealthy agents." " Pass a comma delimited list of health issue types to filter by unhealthy agents that have (at least) any " - "of the given health issue type(s). Health issue types include the following: NOT_CONNECTING, NOT_SENDING_SECURITY_EVENTS.", + "of the given health issue type(s). Health issue types include the following: NOT_CONNECTING, NOT_SENDING_SECURITY_EVENTS, SECURITY_INGEST_REJECTED, MISSING_MACOS_PERMISSION_FULL_DISK_ACCESS, MISSING_MACOS_PERMISSION_ACCESSIBILITY.", cls=incompatible_with("healthy"), ) @table_format_option diff --git a/src/_incydr_sdk/agents/client.py b/src/_incydr_sdk/agents/client.py index 4681c8ad..4a370b41 100644 --- a/src/_incydr_sdk/agents/client.py +++ b/src/_incydr_sdk/agents/client.py @@ -54,7 +54,7 @@ def get_page( * **sort_dir**: `SortDirection` - `asc` or `desc`. The direction in which to sort the response based on the corresponding key. Defaults to `asc`. * **sort_key**: [`SortKeys`][agents-sort-keys] - Values on which the response will be sorted. Defaults to agent name. * **agent_healthy**: `bool | None` - Optionally retrieve agents with this health status. Agents that have no health issue types are considered healthy. - * **agent_health_issue_types**: `List[str] | str` - Optionally retrieve agents that have (at least) any of the given issue type(s). Health issue types include the following: `NOT_CONNECTING`, `NOT_SENDING_SECURITY_EVENTS`. + * **agent_health_issue_types**: `List[str] | str` - Optionally retrieve agents that have (at least) any of the given issue type(s). Health issue types include the following: `NOT_CONNECTING`, `NOT_SENDING_SECURITY_EVENTS`, `SECURITY_INGEST_REJECTED`, `MISSING_MACOS_PERMISSION_FULL_DISK_ACCESS`, `MISSING_MACOS_PERMISSION_ACCESSIBILITY`. **Returns**: An [`AgentsPage`][agentspage-model] object. """ diff --git a/src/_incydr_sdk/agents/models.py b/src/_incydr_sdk/agents/models.py index 313d5fe9..2ec6b3f7 100644 --- a/src/_incydr_sdk/agents/models.py +++ b/src/_incydr_sdk/agents/models.py @@ -47,7 +47,7 @@ class Agent(ResponseModel): * **serial_number**: `str` Authenticated agent serial number. * **active**: `bool` If the agent status is active. * **agent_type**: [`AgentType`][agent-type] The type of agent. - * **agent_health_issue_types: `List[str]` List of health issues with the agent. Health issue types include the following: `NOT_CONNECTING`, `NOT_SENDING_SECURITY_EVENTS`. + * **agent_health_issue_types: `List[str]` List of health issues with the agent. Health issue types include the following: `NOT_CONNECTING`, `NOT_SENDING_SECURITY_EVENTS`, `SECURITY_INGEST_REJECTED`, `MISSING_MACOS_PERMISSION_FULL_DISK_ACCESS`, `MISSING_MACOS_PERMISSION_ACCESSIBILITY`. * **app_version**: `str` The app version of the agent. * **product_version**: `str` The product version of the agent. * **last_connected**: `datetime` The time the agent last connected to a Code42 Authority server.