Groep DSC-ResourceDSC Group Resource

Van toepassing op: Windows PowerShell 4.0, Windows PowerShell 5.0Applies To: Windows PowerShell 4.0, Windows PowerShell 5.0

De bron van de groep in Windows PowerShell Desired State Configuration (DSC) biedt een mechanisme voor het beheren van lokale groepen in het doelknooppunt.The Group resource in Windows PowerShell Desired State Configuration (DSC) provides a mechanism to manage local groups on the target node.

SyntaxisSyntax

Group [string] #ResourceName
{
    GroupName          = [string]
    [ Credential       = [PSCredential] ]
    [ Description      = [string[]] ]
    [ Ensure           = [string] { Absent | Present }  ]
    [ Members          = [string[]] ]
    [ MembersToExclude = [string[]] ]
    [ MembersToInclude = [string[]] ]
    [ DependsOn        = [string[]] ]
}

EigenschappenProperties

EigenschapProperty BeschrijvingDescription
GroepsnaamGroupName De naam van de groep waarvoor u om te controleren of een specifieke status.The name of the group for which you want to ensure a specific state.
referentieCredential De referenties die zijn vereist voor toegang tot externe bronnen.The credentials required to access remote resources. Opmerking: dit account de juiste Active Directory-machtigingen voor alle niet-lokale accounts toevoegen aan de groep moet hebben; anders wordt een fout optreedt wanneer de configuratie in het doelknooppunt wordt uitgevoerd.Note: This account must have the appropriate Active Directory permissions to add all non-local accounts to the group; otherwise, an error occurs when the configuration is executed on the target node.
BeschrijvingDescription De beschrijving van de groep.The description of the group.
Zorg ervoor datEnsure Hiermee wordt aangegeven of de groep bestaat.Indicates if the group exists. Deze eigenschap instellen op 'Ontbreekt' om ervoor te zorgen dat de groep niet bestaat.Set this property to "Absent" to ensure that the group does not exist. Instellen om "" (de standaardwaarde), zorgt u ervoor dat de groep bestaat.Setting it to "Present" (the default value) ensures that the group exists.
LedenMembers Gebruik deze eigenschap het lidmaatschap van de huidige vervangt door de opgegeven leden.Use this property to replace the current group membership with the specified members. De waarde van deze eigenschap is een matrix met tekenreeksen van het formulier domein\gebruikersnaam.The value of this property is an array of strings of the form Domain\UserName. Als u deze eigenschap in een configuratie hebt ingesteld, geen gebruik van ofwel de MembersToExclude of MembersToInclude eigenschap.If you set this property in a configuration, do not use either the MembersToExclude or MembersToInclude property. In dat geval wordt een fout gegenereerd.Doing so generates an error.
MembersToExcludeMembersToExclude Gebruik deze eigenschap leden verwijderen uit het bestaande lidmaatschap van de groep.Use this property to remove members from the existing membership of the group. De waarde van deze eigenschap is een matrix met tekenreeksen van het formulier domein\gebruikersnaam.The value of this property is an array of strings of the form Domain\UserName. Als u deze eigenschap in een configuratie instellen, gebruikt u niet de leden eigenschap.If you set this property in a configuration, do not use the Members property. In dat geval wordt een fout gegenereerd.Doing so generates an error.
MembersToIncludeMembersToInclude Gebruik deze eigenschap leden toevoegen aan het bestaande lidmaatschap van de groep.Use this property to add members to the existing membership of the group. De waarde van deze eigenschap is een matrix met tekenreeksen van het formulier domein\gebruikersnaam.The value of this property is an array of strings of the form Domain\UserName. Als u deze eigenschap in een configuratie instellen, gebruikt u niet de leden eigenschap.If you set this property in a configuration, do not use the Members property. Hierdoor wordt een fout gegenereerd.Doing so will generate an error.
dependsOnDependsOn Hiermee wordt aangegeven dat de configuratie van een andere resource uitvoeren moet voordat deze bron is geconfigureerd.Indicates that the configuration of another resource must run before this resource is configured. Bijvoorbeeld, als de ID van de resourceconfiguratie scriptblok die u wilt uitvoeren eerst is ResourceName en het type ResourceType, de syntaxis voor het gebruik van deze eigenschap is ' DependsOn = '[ ResourceType] ResourceName' ''.For example, if the ID of the resource configuration script block that you want to run first is ResourceName and its type is ResourceType, the syntax for using this property is DependsOn = "[ResourceType]ResourceName"`.

Voorbeeld 1Example 1

Het volgende voorbeeld laat zien hoe om ervoor te zorgen dat een groep genaamd 'Testgroep' ontbreekt.The following example shows how to ensure that a group called "TestGroup" is absent.

Group GroupExample
{
    # This removes TestGroup, if present
    # To create a new group, set Ensure to "Present“
    Ensure = "Absent"
    GroupName = "TestGroup"
}

Voorbeeld 2Example 2

Het volgende voorbeeld laat zien hoe een Active Directory-gebruiker toevoegen aan de lokale groep administrators als onderdeel van een testlab met meerdere Machine build als u al van een PSCredential voor het lokale Administrator-account gebruikmaakt.The following example shows how to add an Active Directory User to the local administrators group as part of a Multi-Machine Lab build where you are already using a PSCredential for the Local Adminstrator account. Als dit wordt ook gebruikt voor het domein Admin-Account (na de promotie van domein), moeten we vervolgens deze bestaande PSCredential omzetten in een domein beschrijvende referentie.As this is also used for the Domain Admin Account (after Domain promotion), we then need to convert this existing PSCredential to a Domain Friendly credential. Vervolgens kunt we een domeingebruiker toevoegen aan de lokale groep Administrators op de lidserver.Then we can add a Domain User to the Local Administrators Group on the Member server.

@{
    AllNodes = @(
        @{
            NodeName = '*';
            DomainName = 'SubTest.contoso.com';
         }
        @{
            NodeName = 'Box2';
            AdminAccount = 'Admin-Dave_Alexanderson'
        }
    )
}

$domain = $node.DomainName.split('.')[0]
$DCredential = New-Object -TypeName System.Management.Automation.PSCredential -ArgumentList ("$domain\$($credential.Username)", $Credential.Password)

Group AddADUserToLocalAdminGroup {
    GroupName='Administrators'
    Ensure= 'Present'
    MembersToInclude= "$domain\$($Node.AdminAccount)"
    Credential = $dCredential
    PsDscRunAsCredential = $DCredential
}

Voorbeeld 3Example 3

Het volgende voorbeeld laat zien hoe om te controleren of een lokale groep, TigerTeamAdmins, op de server TigerTeamSource.Contoso.Com bevat niet de account van een bepaald domein, Contoso\JerryG.The following example shows how to ensure a local group, TigerTeamAdmins, on the server TigerTeamSource.Contoso.Com does not contain a particular domain account, Contoso\JerryG.

Configuration SecureTigerTeamSrouce {
  Import-DscResource -ModuleName 'PSDesiredStateConfiguration'

  Node TigerTeamSource.Contoso.Com {
    Group TigerTeamAdmins {
       GroupName        = 'TigerTeamAdmins'
       Ensure           = 'Present'
       MembersToExclude = "Contoso\JerryG"
    }
  }
}