Stop-WebItem

Stop-WebItem

Stops an application pool or a site.

Syntax

Stop-WebItem [-Passthru] [-Protocol <String>] [[-PSPath] <String[]>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]

Detailed Description

The Stop-WebItem cmdlet is used to stop a Site or an application pool.

Parameters

-Passthru <SwitchParameter>

Passes an object that represents the Web item to the pipeline.

Attributes

Name Value

Required?

false

Accept wildcard characters?

false

Accept Pipeline Input?

false

Position?

named

-Protocol <String>

The protocol binding of the site to stop (sites only).

Attributes

Name Value

Required?

false

Accept wildcard characters?

false

Accept Pipeline Input?

false

Position?

named

-PSPath <String[]>

The path to the site or application pool.

Attributes

Name Value

Required?

false

Accept wildcard characters?

false

Accept Pipeline Input?

true (ByPropertyName)

Position?

2

-WarningAction <ActionPreference>

Attributes

Name Value

Required?

false

Accept wildcard characters?

false

Accept Pipeline Input?

false

Position?

named

-WarningVariable <String>

Attributes

Name Value

Required?

false

Accept wildcard characters?

false

Accept Pipeline Input?

false

Position?

named

-CommonParameter

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see About Common Parameter

Input and Return Types

The input type is the type of the objects that you can pipe to the cmdlet. The return type is the type of the objects that the cmdlet emits.

Input Type

PSObject.

Return Type

PSObject.

Notes

Examples

EXAMPLE 1: Stopping a Web site

IIS:\>Stop-WebItem 'IIS:\Sites\Default Web Site'

Stops the site named Default Web Site. No output is returned.

EXAMPLE 2: Stopping a Web site with feedback

IIS:\>Stop-WebItem 'IIS:\Sites\Default Web Site' -Passthru

Stops the site named Default Web Site and reports whether the site was stopped.

Name ID State Physical Path Bindings
---- -- ----- ------------- --------
Default Web Site 1 Stopped C:\inetpub\wwwroot\Default Web http *:80:
Site

See Also

Reference

Start-WebItem
Get-WebItemState
Restart-WebItem