AADSites - New-AADSiteLink 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 create a new sitelink.  Options available to set on create include the sites that are members of the site linkt, the description, cost and frequency of replication. 

NAME

New-AADSiteLink
SYNOPSIS


Creates a new AD sitelink object
SYNTAX


New-AADSiteLink [-name] [-Sites] [[-cost] ] [[-frequency] ] [[-description] ] []


DESCRIPTION


This function enables you to create a new AD Sitelink.


You can supply any combination of sites, cost, frequency or description to set


PARAMETERS


-name
Mandatory - The name of the object you want to create.
Position 0.
-Sites
Optional - The sites you want to add to the site link.
Accepts 1 or more sites, comma separated.
Position 1.
-cost
Optional - The cost of the sitelink you want to set
Position 2.
-frequency
Optional - The frequency of replication the sitelink (in minutes) you want to set
Position 3.
-description
Optional - The description of the sitelink you want to set
Position 4.
-------------------------- EXAMPLE 1 --------------------------
Simple usage
new-AADSitelink -name sitelinkname -Sites "testsite1,testsite2" -cost 50 -frequency 30 -description "Main sitelink"
-------------------------- EXAMPLE 2 --------------------------
Simple usage - using positional parameters.
new-AADSitelink sitelinkname "testsite1,testsite2" 50 30 "Main sitelink"
-------------------------- EXAMPLE 3 --------------------------
Simple usage - only supply two values to set
new-AADSitelink -name sitelinkname -cost 50 -frequency 30