Resource Type: dsc_xgroup

Defined in:
lib/puppet/type/dsc_xgroup.rb
Providers:
powershell

Overview

The DSC xGroup resource type. Automatically generated from ‘xPSDesiredStateConfiguration/DSCResources/MSFT_xGroupResource/MSFT_xGroupResource.schema.mof’

To learn more about PowerShell Desired State Configuration, please visit technet.microsoft.com/en-us/library/dn249912.aspx.

For more information about built-in DSC Resources, please visit technet.microsoft.com/en-us/library/dn249921.aspx.

For more information about xDsc Resources, please visit github.com/PowerShell/DscResources.

Properties

  • ensure

    The basic property that the resource should be in.

    Supported values:
    • exists?
    • present
    • absent

Parameters

  • dsc_credential

    Credential - A credential to resolve non-local group members.

  • dsc_description

    Description - The description the group should have.

  • dsc_ensure

    Ensure - Indicates if the group should exist or not. Valid values are Present, Absent.

  • dsc_groupname

    GroupName - The name of the group to create, modify, or remove.

  • dsc_members

    Members - The members the group should have.

  • dsc_memberstoexclude

    MembersToExclude - The members the group should exclude.

  • dsc_memberstoinclude

    MembersToInclude - The members the group should include.

  • dsc_psdscrunascredential

    PsDscRunAsCredential

  • name (namevar)
  • provider

    The specific backend to use for this ‘dsc_xgroup` resource. You will seldom need to specify this — Puppet will usually discover the appropriate provider for your platform.