Thursday, September 1, 2011

AADSites - Set-AADSite Syntax

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

This function enables you to update the options of a site.  These include the site links that the site is a member of, the location field and the description.
NAME



Set-AADSite
SYNOPSIS


Sets the values of an AD site object


SYNTAX


Set-AADSite [-Identity]  [[-SiteLinks] ] [[-description] ] [[-location] ] []


DESCRIPTION


This function allows you to set the values of an AD Site.


You can supply any combination of sitelinks, description or location to set
PARAMETERS


-Identity


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


Optional - The sitelinks of the site you want to set
Position 1.
-description


Optional - The description of the site you want to set
Position 2.
-location


Optional - The location of the site you want to set
Position 3.


-------------------------- EXAMPLE 1 --------------------------
Simple usage

PS C:\> set-AADSite -Identity mainsite1 -Sitelinks "sitelink 1" -location "au/syd/office1" -description "Site description"
-------------------------- EXAMPLE 2 --------------------------
Simple usage - using positional parameters. Also, using multiple sitelinks.

PS C:\> set-AADSite Sitename "sitelink 1,sitelink 2" "au/syd/office1" "Site description"


-------------------------- EXAMPLE 3 --------------------------
Simple usage - only supply one value to set


PS C:\> set-AADSite -identity Sitename -location "au/syd/office1"


0 comments:

Post a Comment