New-TSTMGMTSite

Add a new site to the Management Platform.

Written by Giuseppe

Last published at: August 20th, 2020

Add a new site into the ManagementPlatform


SYNTAX

New-TSTMGMTSite

New-TSTMGMTSite -SiteName <string> -SiteDescription <string> -Username <string> -Password <string> [-ParentId <guid>] [-Force] [-Disabled] [-AllowAutoAdd] [-DefaultDeviceFolderId <guid>] [-DefaultDeviceFolderName <string>] [-ForceDeviceFolder] [-Interface <guid>] [-Timeout <int>]

New-TSTMGMTSite

New-TSTMGMTSite -SiteName <string> -SiteDescription <string> -Username <string> -Password <string> -ParentFolder <Folder> [-ParentId <guid>] [-Disabled] [-AllowAutoAdd] [-DefaultDeviceFolderId <guid>] [-DefaultDeviceFolderName <string>] [-ForceDeviceFolder] [-Interface <guid>] [-Timeout <int>]


DESCRIPTION

Create a new site in the Management Platform. You can specify a fully qualified Site name a ParentFolder or a FolderId


EXAMPLES

1. Add a site to the Management Platform called "New Dev Site" with a default device folder of '\Devices\VDA

New-TSTMGMTSite -SiteName "\Sites\New Dev Site" -AllowAutoAdd -Username "siteuser" -Password "sitepassword" -DefaultDeviceFolderName "\Devices\VDA" -SiteDescription "New development test site" 



PARAMETERS


-SiteName

Fully qualified or relative name of the site to create

Type: String
Required: Yes
Accept Pipeline Input: No


-SiteDescription

Description of the site to create

Type: String
Required: Yes
Accept Pipeline Input: No


-Username

        The site username

Type: String
Required: Yes
Accept Pipeline Input: No


-Password

        The site Password

Type: String
Required: Yes
Accept Pipeline Input: No


-ParentFolder

        Parent Folder object

Type: ThinScale.Management.DataObjects.Folder
Required: Yes
Accept Pipeline Input: Yes


-ParentId

        The GUID of the folder the site is to be created in (only required if SiteName is not fully qualified)

Type: Guid
Required: No
Accept Pipeline Input: No


-DefaultDeviceFolderId

        The GUID of the folder devices will be added to if they do not exist when connecting via this site

Type: Guid
Required: No
Accept Pipeline Input: No


-DefaultDeviceFolderName

        The name of the folder devices will be added to if they do not exist when connecting via this site

Type: String
Required: No
Accept Pipeline Input: No


-Disabled

        Sets the site to disabled when created

Type: SwitchParameter
Required: No
Accept Pipeline Input: No


-AllowAutoAdd

        Allows devices to be added if they do not exist when connecting via this site

Type: SwitchParameter
Required: No
Accept Pipeline Input: No


-ForceDeviceFolder

        If multiple DefaultDeviceFolders are found with the same name, the first retrieved will be used otherwise the call will fail

Type: SwitchParameter
Required: No
Accept Pipeline Input: No


-Interface

The interface ID returned by a previously successful call to Connect-TSTMGMTServer. This parameter is only required if you are connected to 2 or more Management Platform instances at the same time. If this parameter is not specified the connection to the last successful call to Connect-TSTMgmtServer will be used.

Type: Guid
Required: No
Accept Pipeline Input: No


-Timeout

The time allowed in milliseconds for the call to complete before it is deemed to have timed out and is aborted

Type: Int32
Required: No
Accept Pipeline Input: No


-Force

         If the path for the new site does not exist then it will be created

Type: SwitchParameter
Required: No
Accept Pipeline Input: No


INPUTS

ThinScale.Management.DataObjects.Folder


OUTPUTS

ThinScale.Management.DataObjects.Site