Set-GroupProperty

Groups: Sets the properties of an Active Directory group

Script

param(
	[Parameter(Mandatory = $true, ParameterSetName = "Local or Remote DC")]
	[Parameter(Mandatory = $true, ParameterSetName = "Remote Jumphost")]
	[string]$OUPath,

	[Parameter(Mandatory = $true, ParameterSetName = "Local or Remote DC")]
	[Parameter(Mandatory = $true, ParameterSetName = "Remote Jumphost")]
	[string]$GroupName,

	[Parameter(Mandatory = $true, ParameterSetName = "Remote Jumphost")]
	[PSCredential]$DomainAccount,

	[Parameter(ParameterSetName = "Local or Remote DC")]
	[Parameter(ParameterSetName = "Remote Jumphost")]
	[string]$DisplayName,

	[Parameter(ParameterSetName = "Local or Remote DC")]
	[Parameter(ParameterSetName = "Remote Jumphost")]
	[string]$Description,

	[Parameter(ParameterSetName = "Local or Remote DC")]
	[Parameter(ParameterSetName = "Remote Jumphost")]
	[string]$HomePage,

	[Parameter(ParameterSetName = "Local or Remote DC")]
	[Parameter(ParameterSetName = "Remote Jumphost")]
	[ValidateSet('DomainLocal', 'Global', 'Universal')]
	[string]$Scope,

	[Parameter(ParameterSetName = "Local or Remote DC")]
	[Parameter(ParameterSetName = "Remote Jumphost")]
	[ValidateSet('Distribution', 'Security')]
	[string]$Category,

	[Parameter(ParameterSetName = "Local or Remote DC")]
	[Parameter(ParameterSetName = "Remote Jumphost")]
	[string]$DomainName,

	[Parameter(ParameterSetName = "Local or Remote DC")]
	[Parameter(ParameterSetName = "Remote Jumphost")]
	[ValidateSet('Basic', 'Negotiate')]
	[string]$AuthType = "Negotiate"
)

try {
	Import-Module ActiveDirectory -ErrorAction Stop

	[hashtable]$cmdArgs = @{
		'ErrorAction' = 'Stop'
		'AuthType'    = $AuthType
	}
	if ($null -ne $DomainAccount) {
		$cmdArgs.Add("Credential", $DomainAccount)
	}
	if ([System.String]::IsNullOrWhiteSpace($DomainName)) {
		$cmdArgs.Add("Current", 'LocalComputer')
	} else {
		$cmdArgs.Add("Identity", $DomainName)
	}
	$Domain = Get-ADDomain @cmdArgs

	$setArgs = @{
		'ErrorAction' = 'Stop'
		'Server'      = $Domain.PDCEmulator
		'AuthType'    = $AuthType
		'Identity'    = $GroupName
		'Confirm'     = $false
	}
	if ($null -ne $DomainAccount) {
		$setArgs.Add("Credential", $DomainAccount)
	}
	
	if ($PSBoundParameters.ContainsKey('Scope')) { $setArgs['GroupScope'] = $Scope }
	if ($PSBoundParameters.ContainsKey('Category')) { $setArgs['GroupCategory'] = $Category }
	if ($PSBoundParameters.ContainsKey('Description')) { $setArgs['Description'] = $Description }
	if ($PSBoundParameters.ContainsKey('DisplayName')) { $setArgs['DisplayName'] = $DisplayName }
	if ($PSBoundParameters.ContainsKey('HomePage')) { $setArgs['HomePage'] = $HomePage }

	Set-ADGroup @setArgs
	Write-Output "Properties for group '$GroupName' updated successfully."
} catch {
	Write-Error $_
	exit 1
}

Customize

OUPath string

Specifies the Active Directory path (OU).

GroupName string

DistinguishedName or SamAccountName of the Active Directory group.

DomainAccount PSCredential

Active Directory Credential for remote execution on jumphost without CredSSP.

DisplayName string

Specifies the display name of the group.

Description string

Specifies a description of the group.

HomePage string

Specifies the home page of the group.

Scope string

Specifies the group scope (DomainLocal, Global, Universal).

Category string

Specifies the category (Distribution, Security).

DomainName string

Name of the Active Directory Domain.

AuthType string

Specifies the authentication method to use (Basic or Negotiate).