New-SCLoadBalancerHealthMonitor

New-SCLoadBalancerHealthMonitor

Creates a load balancer health monitor object that is used when you create a load balancer virtual IP.

Syntax

Parameter Set: Default
New-SCLoadBalancerHealthMonitor -IntervalSeconds <Int32> -ProtocolName <String> -TimeoutSeconds <Int32> [-Name <String> ] [-NumberOfRetries <Int32> ] [-Request <String> ] [-Response <String> ] [ <CommonParameters>]

Detailed Description

The New-SCLoadBalancerHealthMonitor cmdlet creates a load balancer health monitor object that is used when you create a load balancer virtual IP.

For information about creating a load balancer virtual IP, type Get-Help New-SCLoadBalancerVIP -detailed.

Parameters

-IntervalSeconds<Int32>

Specifies the amount of time, in seconds, that a health monitor waits between sending recurring requests to a load balancer to verify that the load balancer is available. The interval value should be larger than the timeout value.

Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Name<String>

Specifies the name of a VMM object.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-NumberOfRetries<Int32>

Specifies the number of times that a load balancer health monitor retries sending a request before marking the VIP member as down.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ProtocolName<String>

Specifies the protocol used to communicate with a load balancer.

Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Request<String>

Specifies the request that a health monitor sends to a load balancer. Typically, this command will make an HTTP GET request for the home page of the load balancer and check for a header response such as 200 OK.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Response<String>

Specifies the expected response to a request that a health monitor sends to a load balancer.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-TimeoutSeconds<Int32>

Specifies the amount of time, in seconds, that a process waits before timing out.

Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Inputs

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

Outputs

The output type is the type of the objects that the cmdlet emits.

  • LoadBalancerHealthMonitor

Examples

Example 1: Create a load balancer health monitor

This command creates a load balancer health monitor object named HTTPMonitor, and then stores the object in the $LBHealthMonitor variable.

PS C:\> $LBHealthMonitor = New-SCLoadBalancerHealthMonitor -Name HTTPMonitor -ProtocolName "HTTP" -Request "GET /Index.html HTTP/1.1" -Response 200 -IntervalSeconds 15 -TimeoutSeconds 20

New-SCLoadBalancerVIP