Get-TSTMGMTSite

Get the details of a site from the Management Console.

Written by Giuseppe

Last published at: December 14th, 2022

Retrieve the details of a site from the Management Console

Note:

‘Sites’ have been replaced by ‘Access Keys’ from versions 7.0 onwards. The new commandlets for those are Get-TSTMGMTAccessKey, Get-TSTMGMTAccessKeys, Set-TSTMGMTAccessKey and New-TSTMGMTAccessKey.

 

 

SYNTAX

New-TSTMGMTFolder

        [-SiteName <string>] [-SiteId <guid>] [-Force] [-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 the Management Platform using the SiteName

        Get-TSTMGMTSite -SiteName '\Sites\ThinKiosk Site' 

 

 

2. Get the details of a Site from the Management Platform using the SiteId

        Get-TSTMGMTSite -SiteId 'B1FA2799-C1A3-472D-AE23-6B015FC5D435'

 

PARAMETERS

 

-SiteName

  The fully qualified name of the site

Type: String
Required: No
Accept Pipeline Input: No

 

-SiteId

The GUID of the site (only required if SiteName is not supplied)

Type: Guid
 
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 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

None

 

OUTPUTS

ThinScale.Management.DataObjects.Site