Get-TopOUName.ps1


Description

Purpose

A brief description of the Get-TopOUName function.

Detailed Description

A detailed description of the Get-TopOUName function.

Back to Top

Usage

Example 1

PS C:\> Get-TopOUName -DistinguishedName 'value1'

Back to Top

Notes

Additional information about the function.

Back to Top


Script

function Get-TopOUName {
	<#
		.SYNOPSIS
			A brief description of the Get-TopOUName function.
		
		.DESCRIPTION
			A detailed description of the Get-TopOUName function.
		
		.PARAMETER DistinguishedName
			A description of the DistinguishedName parameter.
		
		.EXAMPLE
			PS C:\> Get-TopOUName -DistinguishedName 'value1'
		
		.OUTPUTS
			string
		
		.NOTES
			Additional information about the function.
	#>
	
	[CmdletBinding(DefaultParameterSetName = 'Default',
		PositionalBinding = $true,
		SupportsShouldProcess = $true)]
	[OutputType([string], ParameterSetName = 'Default')]
	param
	(
		[Parameter(ParameterSetName = 'Default',
			Mandatory = $true,
			ValueFromPipeline = $true,
			ValueFromPipelineByPropertyName = $true,
			ValueFromRemainingArguments = $true,
			Position = 0,
			HelpMessage = 'A description of the DistinguishedName parameter.')]
		[string]
		$DistinguishedName
	)
	
	Begin {
		Write-Verbose "[$((Get-Date).TimeofDay) BEGIN  ] Starting $($myinvocation.mycommand)"
		#ignore case
		$rx = [System.Text.RegularExpressions.Regex]::new("^(((CN=.*?))?)OU=(?<OUName>.*?(?=,))", "IgnoreCase")
	} #begin
	
	Process {
		if ($PSCmdlet.ShouldProcess("$($Month)" + "-" + "$($DistinguishedName)", "Processing")) {
			Write-Verbose "[$((Get-Date).TimeofDay) PROCESS] Processing $DistinguishedName"
			If ($rx.IsMatch($DistinguishedName)) {
				$rx.Match($DistinguishedName).groups["OUName"].Value
			}
		} #process
	}
	End {
		Write-Verbose "[$((Get-Date).TimeofDay) END    ] Ending $($myinvocation.mycommand)"
	} #end
}

Back to Top

Download

Please feel free to copy parts of the script or if you would like to download the entire script, simply click the download button. You can download the complete repository in a zip file by clicking the Download link in the menu bar on the left hand side of the page.


Report Issues

You can report an issue or contribute to this site on GitHub. Simply click the button below and add any relevant notes. I will attempt to respond to all issues as soon as possible.

Issue


Back to Top