Orion.PolicyEngine.Rule
SolarWinds Information Service 2024.4 Schema Documentation
This entity represents a rule.
Inheritance
↳ System.Entity
Access control
Operations |
Right |
read,update |
manageNodes |
read |
everyone |
Properties
Name |
Type |
Summary |
Access Control |
RuleID |
System.Int32 |
Unique identifier of this entity. |
everyone |
PolicyID |
System.Int32 |
ID of policy of this rule. |
everyone |
DisplayId |
System.String |
Short, unique identifier of the rule. |
everyone |
Name |
System.String |
Name or title of the rule. |
everyone |
Severity |
System.Int16 |
Severity of the rule. Options are: 0 (undefined), 100 (low), 200 (medium), 300 (high). |
everyone |
SeverityDescription |
System.String |
|
everyone |
UniqueId |
System.Guid |
GUID of the rule within policy, valuable for identifying imported/exported rule. |
everyone |
PreconditionYAML |
System.String |
YAML definition of the rule precondition. |
everyone |
ConditionYAML |
System.String |
YAML definition of the rule condition. |
everyone |
Description |
System.String |
Description of the rule. |
everyone |
Enabled |
System.Boolean |
The rule can be disabled by setting this to 'false'. |
everyone |
DisableReason |
System.String |
Optional reason why the rule is disabled. |
everyone |
RemediationDescription |
System.String |
Description of remediation (how to fix the rule). |
everyone |
CheckText |
System.String |
Description what steps to do to make the rule passing. |
everyone |
DetailsUrl |
System.String |
URL to the Rule details page. |
everyone |
Source Relationships
Target Relationships