Get-TSTMGMTSites

Get the details of a site within a folder from the Management Console.

Written by Giuseppe

Last published at: August 20th, 2020

Retrieve the details of a site within a folder from the Management Console


SYNTAX

Get-TSTMGMTSites

 [-FolderName <string>] [-FolderId <guid>] [-Force] [-Interface <guid>] [-Timeout <int>]

Get-TSTMGMTSites

         -Folder <Folder> [-FolderName <string>] [-FolderId <guid>] [-Interface <guid>] [-Timeout <int>]


DESCRIPTION

Retrieve the detail of a site to the Management Platform. You can specify a fully qualified Site name or a SiteId


EXAMPLES

1. Get the details of a Site from a folder within the Management Platform using the FolderName

        Get-TSTMGMTSites -FolderName '\Sites\Testing'       


2. Get the details of a Site from a folder within the Management Platform using the FolderId    

        Get-TSTMGMTSites -FolderId 'AD08B9BA-316B-4B38-BC8E-3407FC80AFDD'   

PARAMETERS


-FolderName

 The fully qualified name of the folder to get Sites from

Type: String
Required: No
Accept Pipeline Input: No


-FolderId

The GUID of the folder to get Sites from (not required if FolderName is supplied)

Type: Guid
Required: No
Accept Pipeline Input: No


-Folder

        Folder object to get Sites from

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


-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 multiple objects 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


INPUTS

ThinScale.Management.DataObjects.Folder


OUTPUTS

ThinScale.Management.DataObjects.Site