Skip to content

Get-Site

SYNOPSIS

Gets an Item object representing a Management Server.

SYNTAX

Get-Site [-ListAvailable] [[-Name] <String>] [<CommonParameters>]

DESCRIPTION

The Get-Site cmdlet can be used to identify which site is currently selected, or which sites are available to be selected.

EXAMPLES

EXAMPLE 1

Get-Site

This command returns the Item object representing the currently selected site.

EXAMPLE 2

Get-Site -ListAvailable

This command lists all available sites in the current logon session if you have used Connect-ManagementServer -IncludeChildSites.

EXAMPLE 3

Get-Site -ListAvailable -Name Site2

This command gets the Item representing a site where the Name property equals "Site2".

EXAMPLE 4

Get-Site -ListAvailable -Name USA-*

This command gets all Items representing sites where the Name property begins with "USA-", so if all USA-based sites are named with a USA- prefix, this command gets all Items for sites in the USA.

PARAMETERS

-ListAvailable

Gets all sites available to the current logon session.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: 1
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-Name

Specifies the friendly name of the site Item to get. Wildcard characters can be used.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

VideoOS.Platform.Item

NOTES

Online Help