| external help file | Module Name | online version | schema |
|---|---|---|---|
SPClientCore.dll-Help.xml |
SPClientCore |
2.0.0 |
Retrieves one or more sites.
Get-KshSite [-Identity] <Site> [-ProgressAction <ActionPreference>] [<CommonParameters>]
Get-KshSite [-SiteCollection] <SiteCollection> [-ProgressAction <ActionPreference>] [<CommonParameters>]
Get-KshSite [-List] <List> [-ProgressAction <ActionPreference>] [<CommonParameters>]
Get-KshSite [-SiteId] <Guid> [-ProgressAction <ActionPreference>] [<CommonParameters>]
Get-KshSite [-SiteUrl] <Uri> [-ProgressAction <ActionPreference>] [<CommonParameters>]
Get-KshSite [-NoEnumerate] [-ProgressAction <ActionPreference>] [<CommonParameters>]
The Get-KshSite cmdlet retrieves sub sites of the current site. In order to retrive a site of different site collections, invoke the Connect-KshSite cmdlet.
PS C:\> Get-KshSite -SiteCollection (Get-KshCurrentSiteCollection)Retrieves a root site of the site collection.
PS C:\> Get-KshSite -List (Get-KshList -ListTitle 'Announcements')Retrieves a parent site of the list.
PS C:\> Get-KshSite -SiteId 'd298e576-6985-4119-9796-050b9f371872'Retrieves a site by site ID.
PS C:\> Get-KshSite -SiteUrl '/sites/japan/hr'Retrieves a site by site URL.
PS C:\> Get-KshSiteRetrieves all sites.
Specifies the site.
Type: Site
Parameter Sets: ParamSet1
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: FalseSpecifies the list.
Type: List
Parameter Sets: ParamSet3
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: FalseIf specified, suppresses to enumerate objects.
Type: SwitchParameter
Parameter Sets: ParamSet6
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies the site collection.
Type: SiteCollection
Parameter Sets: ParamSet2
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: FalseSpecifies the site ID.
Type: Guid
Parameter Sets: ParamSet4
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies the site URL.
Type: Uri
Parameter Sets: ParamSet5
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseDetermines how PowerShell responds to progress updates generated by a script, cmdlet, or provider.
Type: ActionPreference
Parameter Sets: (All)
Aliases: proga
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThis cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.