Skip to content

Configuration Reference

Jump to bottom
Weatherlights edited this page Oct 1, 2021 · 8 revisions

File configurations

File configurations apply to an entire file. They tell the PolicyApplicator Agent how to create or remediate a file that is not in compliance with your configuration.

File-operation

This allows you to configure how the PolicyApplicator modifies an entire file in case of a configuration missmatch:

  • create Default
    • Creates a file if it does not exist yet and writes the configuration from the policy.
    • In case the file already exists only the missconfigured configuration is modified.
  • update
    • In case the file does not exist the PolicyApplicator does nothing.
    • In case the file already exists only the missconfigured configuration is modified.
  • replace
    • Creates a file if it does not exist yet and writes the configuration from the policy.
    • In case the file already exists and is missconfigured the entire file will be recreated from the policy.

File-encoding

Here you can specify the encoding of the file that may get recreated by the PolicyApplicator. Possible values are:

  • utf8
  • utf7
  • unicode
  • bigendianunicode
  • utf32
  • ascii
  • Default
  • OEM

JSON configurations (only with version 1.0.7.0 and higher)

operation

This allows you to configure how the PolicyApplicator will treat an element within the file in case of a configuration missmatch:

  • create
    • In case the configuration element does not exist it gets created from the policy.
    • In case the configuration element does not match the policy it is ignored.
  • delete
    • In case the configuration element does not exist it is ignored.
    • In case the configuration element does exist it is deleted.
  • update
    • In case the configuration element does not exist it is ignored.
    • In case the configuration element does not match the policy it is reconfigured from the policy.
  • replace Default
    • In case the configuration element does not exist it gets created from the policy.
    • In case the configuration element does not match the policy it is reconfigured from the policy.

JSONPath

Here you can specify the path that resolves the setting in your configuration file. The path is given as a JSON-Array in the following way:

["MyObject", 0, "Value1.1"]

This path would resolve in a JSON file like follows:

{ "MyObject" : [ { "Value1.1" : "This would be resolved", "Value1.2" : "This would not be resolved" }, { "Value2" : "This would not be resolved" } ], "AnotherObject" : "This would not be resolved" }

So you provide object references with a quotation and array references as integers and each element of the array is one node within the document.

Datatype

With the DataType you can set as what datatype your value should be written from the registry to the json file. You can use:

  • Boolean
  • Int32
  • Decimal
  • String

value

Enter your desired configuration value here.

XML configurations

operation

This allows you to configure how the PolicyApplicator will treat an element within the file in case of a configuration missmatch:

  • create
    • In case the configuration element does not exist it gets created from the policy.
    • In case the configuration element does not match the policy it is ignored.
  • delete
    • In case the configuration element does not exist it is ignored.
    • In case the configuration element does exist it is deleted.
  • update
    • In case the configuration element does not exist it is ignored.
    • In case the configuration element does not match the policy it is reconfigured from the policy.
  • replace Default
    • In case the configuration element does not exist it gets created from the policy.
    • In case the configuration element does not match the policy it is reconfigured from the policy.

namespace

Here you can configure namespaces for the xpath. Each namespace can be specified by adding the prefix and the url of the namespace seperated by .

Example: prefix1namespaceuri1prefix2namespaceuri2

xpath

Here you can specify the xpath that resolves the setting in your configuration file. You should not use complex xpath expressions.

Good: /element1/element2/@attribute

Bad: //@attribute

value

Enter your desired configuration value here.

ini configurations

operation

This allows you to configure how the PolicyApplicator will treat an element within the file in case of a configuration missmatch:

  • create
    • In case the configuration element does not exist it gets created from the policy.
    • In case the configuration element does not match the policy it is ignored.
  • delete
    • In case the configuration element does not exist it is ignored.
    • In case the configuration element does exist it is deleted.
  • update
    • In case the configuration element does not exist it is ignored.
    • In case the configuration element does not match the policy it is reconfigured from the policy.
  • replace Default
    • In case the configuration element does not exist it gets created from the policy.
    • In case the configuration element does not match the policy it is reconfigured from the policy.

section

This information is used to determine in which section your configuration resides.

key

This information is used to determine the specific key in the given section that you want to check and configure.

value

The value the you want the configuration element to be.

list configurations

operation

This allows you to configure how the PolicyApplicator will treat an element within the file in case of a configuration missmatch:

  • replace Default
    • In case the configuration element does not exist it gets created from the policy.
    • In case the configuration element does not match the policy it is reconfigured from the policy.

list

Here you can specify the list entries you want your file to have. Each entry must have a unique number and the entry value seperated by .

Example: 0EntryA1EntryB2EntryC

Clone this wiki locally