GitHub
Sign in
Start for free
View Categories

Configurations

Quick guide #

A XOAP Configuration defines the desired state that should be applied and maintained on registered nodes. It describes the settings and components that must be present on a device—such as system configuration, services, files, registry values, and other enforced standards. Once assigned, XOAP applies the configuration, continuously evaluates compliance, and reports drift so you can ensure systems remain aligned with your baseline.

Create a new Configuration #

  1. Click the Add configuration button (down arrow).
  2. Select Add configuration or Create configuration.
  3. If you select Add configuration, upload the MOF file or PS1 file of the DSC configuration.
  4. If you select Create configuration, the configuration wizard opens:
    • Enter the configuration name.
    • Add the required resources.
    • Click Save to create the configuration.

Edit a Configuration #

Only configurations created with the configuration wizard can be edited.

  1. Click the Action menu (⋮) and select Edit.
  2. Update the resource settings as needed.
  3. Click Save to apply the changes.

Delete a Configuration #

  1. Click the Action menu (⋮) and select Delete.
  2. Confirm the deletion.

Additional useful information #

Configuration compilation #

When you create a configuration using the configuration wizard, allow 10–15 minutes for it to compile in the background before it can be used. Be sure all required DSC modules are uploaded in your Workspace.

MOF configuration availability #

Uploaded MOF configurations can be used immediately.

Missing resources and modules #

If you need a resource for configuration creation and it is not available, you must upload the required modules in the Configuration Management module area.

Configuration versioning #

Any change made to a configuration in the configuration wizard creates a new configuration version.

Configuration visibility #

If the configuration is not visible after 15 minutes, verify that all parameters are configured correctly and all modules are available with the correct versions.

Technical documentation #

A XOAP Configuration defines the desired state that should be applied and maintained on registered nodes. It describes the settings and components that must be present on a device—such as system configuration, services, files, registry values, and other enforced standards. Once assigned, XOAP applies the configuration, continuously evaluates compliance, and reports drift so you can ensure systems remain aligned with your baseline.

From a technical perspective, XOAP Configurations are based on PowerShell Desired State Configuration (DSC) 1.1. DSC 1.1 uses a declarative model: instead of scripting step-by-step actions, you define the end state you want, and the system evaluates and enforces that state over time. This approach makes configuration management predictable and repeatable, and it is well-suited for applying security baselines, hardening standards, and consistent operational settings across many systems.

Benefits of DSC 1.1 in XOAP #

  • Declarative and idempotent: settings can be applied repeatedly without causing unintended changes; the node converges toward the defined baseline.
  • Continuous compliance and drift remediation: XOAP can regularly evaluate the node and detect when settings deviate, providing visibility into drift and enabling re-application of the baseline.
  • Agentless configuration enforcement: DSC relies on built-in Windows capabilities, reducing the need for a separate configuration agent for enforcement.
  • Structured reporting: configuration results provide clear status (compliant/non-compliant) and resource-level details, making troubleshooting and audits easier.

Restrictions and considerations #

  • Windows-focused technology: DSC 1.1 is primarily designed for Windows and relies on Windows PowerShell 5.1. As a result, XOAP Configuration Management via DSC targets Windows nodes.
  • Resource availability and compatibility: what you can configure depends on available DSC resources (modules). If a required resource is missing or incompatible, it must be provided as a module before it can be used in a configuration.

In summary, XOAP Configurations provide a consistent, scalable way to define and enforce system baselines using DSC 1.1—delivering strong compliance visibility and repeatability, with the practical constraint that DSC-based configuration management is centered on Windows environments.

DSC terminology overview #

This glossary explains the relationship between configurations, modules, and resources in DSC:

  • Configuration: the desired-state definition (the “what”)—a set of rules the node must follow.
  • Module: a package of DSC resources (the “library/toolbox”) that provides the building blocks.
  • Resource: an individual DSC building block from a module (the “how”) that enforces one specific setting (for example, a service, registry key, file, or Windows feature).
  • Resource parameters (variables): the values you provide to a resource to control its behavior—such as a service name, startup type, registry path/value, file path, or desired state (Present/Absent).

Additional action menu options #

  • View Code
    Opens the compiled configuration code for review. This always displays the latest created version of the configuration.
  • Download
    Downloads the compiled configuration output for offline review or troubleshooting. This always downloads the latest created version of the configuration.
  • Re-Compile
    Rebuilds (recompiles) the configuration using the selected module version. This is useful when a module has been updated and you want the configuration to be compiled again against the new version without recreating it.
    In the Re-Compile dialog:
    • Module: shows which configuration module is used (read-only).
    • Version: select the module version to compile against.
    • Version message: is automatically populated.

Configuration Wizard #

The Configuration Wizard is used to create and manage XOAP configurations by selecting DSC resources, defining their parameters, and generating versioned configuration outputs.

Configuration Settings #

Use Configuration Settings to define the configuration metadata and build its content:

  • Name / Description: Provide a clear name and optional description for the configuration.
  • Add Resources: Add DSC resources from available modules and configure their parameters.
  • Use Group Policies: Create configuration settings from predefined Group Policy templates.

Add Resources #

When adding a resource, you select:

  • Module and Version
  • The Resource
  • A Resource Display Name (unique identifier in the configuration)
  • The required resource parameters

Once saved, the resource becomes part of the configuration and will be included in the compiled output.

Use Group Policies #

The Use Group Policies option allows you to select predefined policy items and convert them into DSC configuration settings.

When applied, these policies are translated into registry entries, as shown in the configuration output (registry key, value name, value data, and value type).

Versions #

The Versions tab shows all versions created for the configuration, including the creation date and version message.

From the version action menu:

  • Load: Opens the selected version in the Configuration Wizard and loads the resources used in that version, allowing you to review the configuration content as it was defined for that version.
  • Download: Downloads the selected version for offline review or troubleshooting.

Summary #

The Summary tab provides an overview of the active configuration version, including:

  • Which modules are used
  • Which resources are included
  • Which parameters are configured per resource

Powered by BetterDocs

Scroll to Top