Skip to main content

AADSites - Remove-AADsite syntax

This function is part of my AADSites module, which can be downloaded here.  For more info on the module see here.

To start the help files, I have chosen the function that has the most logic to deal with.  Remove-AADsite has to deal with linked subnets, child objects such as servers including domain controllers.

If you have subnets associated to the site, remove-AADsite will warn you as such but offer -force:$true as an override
If you have child server objects (not DC's) within the site, remove-AADsite will warn you as such but offer -force:$true as an override
If you have child domain controller objects within the site, remove-AADsite will advise you to move the DC's out of the site before continuing. No override.
The -confirm:$false switch is availale to supress the confirm prompt.


Removes the AD site object that matches the name supplied

Remove-AADsite [-Identity] [[-force] ] [[-confirm] ] []

Removes the AD site object, if one exists, that matches the name given.
If there are configured domain controllers in the site, the site will not be removed.
If there are server objects in the site (that are not DC's), the command requires -force:$true option to remove the site.
If there are subnets associated with the site, the command requires -force:$true option to remove the site.
Returns True if the the site has been removed, False if not.

Mandatory - The name of the object you want to remove.
Position 0.

Optional - Set to true if you want to ignore warnings and remove the site
Position 1.

Optional - Set to false if you want to remove the site without being
Position 2.

-------------------------- EXAMPLE 1 --------------------------

Simple usage

PS C:\> remove-AADSite -identity Sitename
-------------------------- EXAMPLE 2 --------------------------

Simple usage - remove a site without being prompted to confirm

PS C:\> remove-AADSite -identity Sitename -confirm:$false

-------------------------- EXAMPLE 3 --------------------------

Simple usage - force the removal of a site with associated subnets or non DC servers
PS C:\> remove-AADSite -identity Sitename -force:$true


Popular posts from this blog

PowerShell 3 behavioural change

It's taken me way too long to get into PowerShell 3, I guess opportunity hasn't shown it's self until now and so, here, my V3 journey begins.

I was asked to debug a script that would run fine in PS v2 and not in v3.  The issue was a that a variable length was being checked and was failing in v3.  This is why...

In v2 if a variable is undefined, this test returns false

PS C:\windows\system32> $var.length -eq 0

In v3 the same test returns true....

PS C:\windows\system32> $var.length -eq 0

Not a biggie, but as in this case, a script has broken so something to consider!



Enable Powershell Remoting (WinRM) via Group Policy

I have been doing some testing on enabling WinRM via group policy, being that WinRM is the service that Powershell v2 sets up it remoting capabilities. Here are the GPO settings that you need to configure WinRM ....

set the winrm service to auto start

Computer Configuration \ Policies \ Windows Settings \ Security Settings \ System Services

Windows Remote Management (WS-Management)  set Startup Mode to Automatic

start the service

incorporated in to the above - you may need a restart.

create a winrm listener

Computer Configuration / Policies / Administrative Templates / Windows Components / Windows Remote Management (WinRM) / WinRM Service / Allow automatic configuration of listeners

IPv4 filter: *

* is listen on all addresses, or if you only want a particular IP address to respond use an iprange eg - don't forget that this IP range has to be valid for all hosts that fall in the scope of the GPO you are creating.  You can use -, - …

compare-object in Powershell - comparing mulitple values

I'm starting to use compare-object more and more, and one thing I noticed, is that you can compare 2 objects based on multiple attributes. here is how it is constructed...
Compare-Object -ReferenceObject $object1 -DifferenceObject $object2 -Property a,b,c,d,eIf a,b,c and d are the same, but e is different, compare object will return a difference. In the following example, I use "-eq $null" as a check because by default compare-object returns $null if the objects are the same.
#create an array of objects to check against

$collection = @()
foreach ($entry in ("aaaaa","bbbbb","ccccc","ddddd")){
   $store = "" | select "a","b","c","d","e"
   $store.a = $entry*1
   $store.b = $entry*2
   $store.c = $entry*3
   $store.d = $entry*4
   $store.e = $entry*5
   $collection += $store

#create an object similar to those in the array
$object = "" | select "a","b…