Get-WebSitesServer

  • Reference
Module:
WebSites

Gets configuration information for a website server.

Syntax

Get-WebSitesServer
   [[-Name] <String>]
   [[-ServerType] <ServerRole>]
   [-RemoteSettings <RemoteSettings>]
   [-SuppressRequestIdLine]
   [<CommonParameters>]

Description

The Get-WebSitesServer cmdlet returns information about your website servers. Used without any parameters, Get-WebSitesServer returns information for all your servers. However, if you want to limit the returned data to a single server, you can include the Name parameter and specify the name of that server. You can also use the ServerType parameter to return information for specific types of servers. Available server types include:

  • Controller. Manages and provisions other website roles.

  • ManagementServer. Manages the website infrastructure.

  • LoadBalancer. Distributes and manages web traffic.

  • WebWorker. Hosts websites.

  • Publisher. Publishes content to file servers.

  • FileServer. Stores website content.

Examples

Example 1: Get information for a server

PS C:\> Get-WebSitesServer -Name "WServer01"

This command returns information for the server named WServer01.

Example 2: Get information for a server type

PS C:\> Get-WebSitesServer -ServerType "WebWorker"

This command returns information for all servers assigned the WebWorker role.

Parameters

-Name

Specifies the host name of the server whose configuration information is being retrieved. For example:

-Name "ContosoServer"

Type:String
Position:0
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-RemoteSettings

{{Fill RemoteSettings Description}}

Type:RemoteSettings
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ServerType

Specifies the type of server for which information is being returned. Valid values are:

  • Controller. Manages and provisions other website roles.
  • ManagementServer. Manages the website infrastructure.
  • LoadBalancer. Distributes and manages web traffic.
  • WebWorker. Hosts websites.
  • Publisher. Publishes content to file servers.
  • FileServer. Stores website content.

For example:

-ServerType "FileServer"

If this parameter is not used, Get-WebSitesServer returns information for all server roles.

Type:ServerRole
Accepted values:Controller, ManagementServer, LoadBalancer, WebWorker, Publisher, FileServer, MultiRole
Position:1
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-SuppressRequestIdLine

{{Fill SuppressRequestIdLine Description}}

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False