Get-SCLoadBalancer

Module:

VirtualMachineManager Module

Gets a load balancer object.

Syntax

GlobalList (Default)

Get-SCLoadBalancer
    [[-LoadBalancerAddress] <String>]
    [-VMMServer <ServerConnection>]
    [-Manufacturer <String>]
    [-Model <String>]
    [-All]
    [-LogicalNetwork <LogicalNetwork[]>]
    [-OnBehalfOfUser <String>]
    [-OnBehalfOfUserRole <UserRole>]
    [<CommonParameters>]

ByHostGroup

Get-SCLoadBalancer
    [[-LoadBalancerAddress] <String>]
    -VMHostGroup <HostGroup>
    [-VMMServer <ServerConnection>]
    [-Manufacturer <String>]
    [-Model <String>]
    [-LogicalNetwork <LogicalNetwork[]>]
    [-OnBehalfOfUser <String>]
    [-OnBehalfOfUserRole <UserRole>]
    [<CommonParameters>]

ByCloud

Get-SCLoadBalancer
    [[-LoadBalancerAddress] <String>]
    -Cloud <Cloud>
    [-VMMServer <ServerConnection>]
    [-Manufacturer <String>]
    [-Model <String>]
    [-LogicalNetwork <LogicalNetwork[]>]
    [-OnBehalfOfUser <String>]
    [-OnBehalfOfUserRole <UserRole>]
    [<CommonParameters>]

ByID

Get-SCLoadBalancer
    [[-LoadBalancerAddress] <String>]
    -ID <Guid>
    [-VMMServer <ServerConnection>]
    [-Manufacturer <String>]
    [-Model <String>]
    [-LogicalNetwork <LogicalNetwork[]>]
    [-OnBehalfOfUser <String>]
    [-OnBehalfOfUserRole <UserRole>]
    [<CommonParameters>]

AccessibleToCloudRootHostGroup

Get-SCLoadBalancer
    [[-LoadBalancerAddress] <String>]
    -CloudRootHostGroup <HostGroup[]>
    [-VMMServer <ServerConnection>]
    [-Manufacturer <String>]
    [-Model <String>]
    [-LogicalNetwork <LogicalNetwork[]>]
    [-OnBehalfOfUser <String>]
    [-OnBehalfOfUserRole <UserRole>]
    [<CommonParameters>]

AccessibleToCloudRootVMwareResourcePool

Get-SCLoadBalancer
    [[-LoadBalancerAddress] <String>]
    -CloudRootVMwareResourcePool <VmwResourcePool>
    [-VMMServer <ServerConnection>]
    [-Manufacturer <String>]
    [-Model <String>]
    [-LogicalNetwork <LogicalNetwork[]>]
    [-OnBehalfOfUser <String>]
    [-OnBehalfOfUserRole <UserRole>]
    [<CommonParameters>]

Description

The Get-SCLoadBalancer cmdlet gets one or more load balancer objects.

Examples

Example 1: Get all load balancers for a host group

PS C:\> $HostGroup = Get-SCVMHostGroup | where { $_.Path -eq "All Hosts\HostGroup01" }
PS C:\> $LoadBalancers = Get-SCLoadBalancer -VMHostGroup $HostGroup
PS C:\> $LoadBalancers

The first command gets the host group object hamed HostGroup01 and stores the object in the $HostGroup variable.

The second command gets all load balancer objects accessible to the host group stored in $HostGroup and stores the objects in the $LoadBalancers variable.

The last command displays information about each of the load balancers stored in $LoadBalancers.

Example 2: Get all load balancers of a given type for a host group

PS C:\> $HostGroup = Get-SCVMHostGroup | where { $_.Path -eq "All Hosts\HostGroup02\Production" }
PS C:\> $LoadBalancers = Get-SCLoadBalancer -VMHostGroup $HostGroup -Manufacturer "LB Manufacturer" -Model "LB01"
PS C:\> $LoadBalancers

The first command gets the host group object named Production and stores the object in the $HostGroup variable.

The second command gets the load balancer objects with the specified manufacturer and model accessible to the host group stored in $HostGroup and stores the objects in the $LoadBalancers variable.

The last command displays information about each load balancer object stored in $LoadBalancers.

Parameters

-All

Indicates that this cmdlet gets all subordinate objects independent of the parent object. For example, the command Get-SCVirtualDiskDrive -All gets all virtual disk drive objects regardless of the virtual machine object or template object that each virtual disk drive object is associated with.

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

GlobalList

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-Cloud

Specifies a private cloud object.

Parameter properties

Type:	Cloud
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

ByCloud

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-CloudRootHostGroup

Specifies a host group that is defined at the root level for a private cloud.

Parameter properties

Type:	HostGroup[]
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

AccessibleToCloudRootHostGroup

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-CloudRootVMwareResourcePool

Specifies a VMware resource pool that is defined at the root level for a private cloud.

Parameter properties

Type:	VmwResourcePool
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

AccessibleToCloudRootVMwareResourcePool

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-ID

Specifies the numerical identifier as a globally unique identifier, or GUID, for a specific object.

Parameter properties

Type:	Guid
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

ByID

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-LoadBalancerAddress

Specifies the fully qualified domain name (FQDN) or IP address of a load balancer. Usual formats are FQDN, IPv4 or IPv6 addresses, but check with the load balancer manufacturer for the valid format for your load balancer.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	0
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-LogicalNetwork

Specifies a logical network. A logical network is a named grouping of IP subnets and VLANs that is used to organize and simplify network assignments.

Parameter properties

Type:	LogicalNetwork[]
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-Manufacturer

Specifies the name of the company that manufactured a physical device. Valid characters include:

• Letters (a-z)
• Numbers (0-9)
• Underscore (_)
• Hyphen (-)
• Dot (.)
• Single quote (')

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-Model

Specifies the model of a physical device.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-OnBehalfOfUser

Specifies a user name. This cmdlet operates on behalf of the user that this parameter specifies.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-OnBehalfOfUserRole

Specifies a user role. To obtain a user role, use the Get-SCUserRole cmdlet. This cmdlet operates on behalf of the user role that this parameter specifies.

Parameter properties

Type:	UserRole
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-VMHostGroup

Specifies a virtual machine host group object.

Parameter properties

Type:	HostGroup
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

ByHostGroup

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-VMMServer

Specifies a VMM server object.

Parameter properties

Type:	ServerConnection
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	True
Value from pipeline by property name:	False
Value from remaining arguments:	False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Outputs

LoadBalancer

This cmdlet returns a LoadBalancer object.

Related Links

• Add-SCLoadBalancer
• Get-SCVMHostGroup
• Read-SCLoadBalancer
• Remove-SCLoadBalancer
• Set-SCLoadBalancer
• Test-SCLoadBalancer