Get-SiteStatus

NAME

Get-SiteStatus

SYNOPSIS

Retrieves the site summary and state information.

SYNTAX

Get-SiteStatus [[-Name] <string>] [-SiteId <uint>] [<CommonParameters>]

Get-SiteStatus [[-Id] <uint>] [-SiteId <uint>] [<CommonParameters>]

Get-SiteStatus [[-InputObject] <Site>] [-SiteId <uint>] [<CommonParameters>]

DESCRIPTION

Retrieves the site summary and state information.

To obtain the information for all sites, execute the cmdlet with no parameters.

PARAMETERS


-Name <string>
The name of the server where the master Publishing Agent is running.

This must be the actual server name used in the RAS farm. 

        Required?                    false
        Position?                    0
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-Server <string>
The name of the server where the master Publishing Agent is running.

This must be the actual server name used in the RAS farm.

This is an alias of the Name parameter. 

        Required?                    false
        Position?                    0
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-SiteId <uint>
Site ID from which to retrieve Site status information.

If the parameter is omitted, the site ID of the Licensing Server will be used. 

        Required?                    false
        Position?                    named
        Default value                0
        Accept pipeline input?       false
        Accept wildcard characters?  false

-Id <uint>
The site ID. To obtain the ID, use the Get-Site cmdlet. 

        Required?                    false
        Position?                    0
        Default value                0
        Accept pipeline input?       false
        Accept wildcard characters?  false

-InputObject <Site>
An object of type Site representing the site.

To obtain the object, use the Get-Site cmdlet. 

        Required?                    false
        Position?                    0
        Default value                
        Accept pipeline input?       true (ByValue)
        Accept wildcard characters?  false

<CommonParameters> 
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see 
        about_CommonParameters documentation.

INPUTS

Site

OUTPUTS

SiteSysInfo

EXAMPLES


---------- EXAMPLE 1 ----------

Get-SiteStatus -Id 15

Retrieves the information for the site with ID 15.

---------- EXAMPLE 2 ----------

Get-SiteStatus -Server MySiteServer

Retrieves the information for the site where master Publishing Agent server name is "MySiteServer".

---------- EXAMPLE 3 ----------

Get-SiteStatus -InputObject $Site

Retrieves the information for the site represented by the $Site object.

---------- EXAMPLE 4 ----------

Get-Site -Id 15 | Get-SiteStatus

Retrieves the information for the site represented by the object obtained from the pipeline output.

---------- EXAMPLE 5 ----------

Get-SiteStatus -SiteId 3

Retrieves the information for the specified site.

---------- EXAMPLE 6 ----------

Get-SiteStatus -SiteId 3 -Server MySiteServer

Retrieves the information for the specific site and server.

RELATED LINKS