Orion.PolicyEngine.Policy
SolarWinds Information Service 2024.4 Schema Documentation
This entity represents a policy, which is a group of rules.
Inheritance
Access control
| Operations | Right |
|---|---|
| read,update,delete,invoke | manageNodes |
| read | everyone |
Properties
| Name | Type | Summary | Access Control |
|---|---|---|---|
| PolicyID | System.Int32 | Unique identifier of this entity. | everyone |
| Name | System.String | Name of the policy. | everyone |
| PluginName | System.String | Identification of the plugin providing data. | everyone |
| Version | System.Int32 | Version of the policy. | everyone |
| BuiltIn | System.Boolean | Boolean value indicating whether policy is built-in. This property is readonly. | everyone |
| Status | System.Int32 | everyone | |
| UnManaged | System.Boolean | everyone | |
| UniqueId | System.Guid | GUID of the policy, valuable for identifying imported/exported policies. | everyone |
| DetailsUrl | System.String | URL to the Policy compliance summary. | everyone |
| RulesUrl | System.String | URL to the pre-filtered Policy rules explorer. | everyone |
Source Relationships
| Name | Type | Notes |
|---|---|---|
| Compliance | Orion.PolicyEngine.PolicyCompliance | Defined by relationship Orion.PolicyEngine.PolicyHostsCompliance (System.Hosting) |
| Rules | Orion.PolicyEngine.Rule | Defined by relationship Orion.PolicyEngine.PolicyHostsRule (System.Hosting) |
| Assignments | Orion.PolicyEngine.AssignedPolicy | Defined by relationship Orion.PolicyEngine.PolicyReferencesAssignedPolicy (System.Reference) |
Target Relationships
| Name | Type | Notes |
|---|---|---|
| PolicyComplianceChange | Orion.PolicyEngine.PolicyComplianceChange | Defined by relationship Orion.PolicyEngine.PolicyComplianceChangeRel (System.Reference) |
Verbs
ExportPolicy
Export a policy with rules into YAML format.ID of the policy to export.Exported policy in YAML format as a string.
Access control
everyone
ImportPolicy
Import a policy from YAML format to database.Imported policy in YAML format as a string.ID of the imported policy.
Access control
everyone
AssignToEntity
Assign a policy to an entity.ID of the assigning policy.Uri of the target of assignment. For SCM policies it needs to be a Node.Optional additional data for assignments.
Access control
everyone
UnassignFromEntity
Unassign a policy from an entity.ID of the policy to unassign.Uri of the target of assignment. For SCM policies it needs to be a Node.
Access control
everyone
PollNowAndEvaluate
Execute data source collection and evaluation of all rules in a policy.ID of the policy to poll and evaluate.Uri of the target of assignment. For SCM policies it needs to be a Node.
Access control
everyone