RiskFactor
armis_sdk.entities.data_export.risk_factor.RiskFactor
Bases: BaseExportedEntity
This class represents a risk factor row that was exported using the data export API.
Attributes:
| Name | Type | Description |
|---|---|---|
device_id |
int | None
|
The id of the device with the risk factor |
category |
str | None
|
The category of the risk factor |
type |
str | None
|
The type of the risk factor |
description |
str | None
|
The description of the risk factor |
score |
int | None
|
The score of the risk factor |
group |
str | None
|
The group of the risk factor |
remediation_type |
str | None
|
The type of the remediation |
remediation_description |
str | None
|
The description of the remediation |
remediation_recommended_actions |
list[RiskFactorRecommendedAction] | None
|
The remediation recommended actions |
first_seen |
datetime | None
|
When the risk factor was first seen on the device |
last_seen |
datetime | None
|
When the risk factor was last seen on the device |
status |
str | None
|
The status of the risk factor in relation to the device |
status_update_time |
datetime | None
|
When was the status last changed |
status_updated_by_user_id |
int | None
|
Which used id last changed the status |
status_update_reason |
str | None
|
The reason for the status change |
device_id = None
class-attribute
instance-attribute
The id of the device with the risk factor
category = None
class-attribute
instance-attribute
The category of the risk factor
Example: BEHAVIOURAL
type = None
class-attribute
instance-attribute
The type of the risk factor
Example: SMBV1_SUPPORT
description = None
class-attribute
instance-attribute
The description of the risk factor
Example: Device Supports SMBv1
score = None
class-attribute
instance-attribute
The score of the risk factor
group = None
class-attribute
instance-attribute
The group of the risk factor
Example: INSECURE_TRAFFIC_AND_BEHAVIOR
remediation_type = None
class-attribute
instance-attribute
The type of the remediation
Example: Disable SMBv1 Protocol
remediation_description = None
class-attribute
instance-attribute
The description of the remediation
Example: Disable support for the SMBv1 protocol on devices where it is not required
for compatibility reasons. Ensure that alternative, more secure network protocols
such as SMBv3 are implemented to maintain secure network communications.
remediation_recommended_actions = None
class-attribute
instance-attribute
The remediation recommended actions
first_seen = None
class-attribute
instance-attribute
When the risk factor was first seen on the device
last_seen = None
class-attribute
instance-attribute
When the risk factor was last seen on the device
status = None
class-attribute
instance-attribute
The status of the risk factor in relation to the device
Example: OPEN
status_update_time = None
class-attribute
instance-attribute
When was the status last changed
status_updated_by_user_id = None
class-attribute
instance-attribute
Which used id last changed the status
status_update_reason = None
class-attribute
instance-attribute
The reason for the status change
Example: Matching criteria met again
armis_sdk.entities.data_export.risk_factor.RiskFactorRecommendedAction
Bases: BaseModel
Attributes:
| Name | Type | Description |
|---|---|---|
id |
int
|
The id of the recommended action |
title |
str
|
The title of the recommended action |
description |
str
|
The description of the recommended action |
type |
str
|
The type of the recommended action |
id
instance-attribute
The id of the recommended action
title
instance-attribute
The title of the recommended action
Example: Patch and Update Systems
description
instance-attribute
The description of the recommended action
Example: Regularly update all operating systems and firmware on network devices
to the latest versions to reduce the potential for exploitation of vulnerabilities
via obsolete protocols.
type
instance-attribute
The type of the recommended action
Example: Mitigation