Get-SCLoadBalancer
Gets a load balancer object.
Syntax
Get-SCLoadBalancer
[-VMMServer <ServerConnection>]
[[-LoadBalancerAddress] <String>]
[-Manufacturer <String>]
[-Model <String>]
[-All]
[-LogicalNetwork <LogicalNetwork[]>]
[-OnBehalfOfUser <String>]
[-OnBehalfOfUserRole <UserRole>]
[<CommonParameters>] Get-SCLoadBalancer
[-VMMServer <ServerConnection>]
[[-LoadBalancerAddress] <String>]
[-Manufacturer <String>]
[-Model <String>]
-VMHostGroup <HostGroup>
[-LogicalNetwork <LogicalNetwork[]>]
[-OnBehalfOfUser <String>]
[-OnBehalfOfUserRole <UserRole>]
[<CommonParameters>] Get-SCLoadBalancer
[-VMMServer <ServerConnection>]
[[-LoadBalancerAddress] <String>]
[-Manufacturer <String>]
[-Model <String>]
-Cloud <Cloud>
[-LogicalNetwork <LogicalNetwork[]>]
[-OnBehalfOfUser <String>]
[-OnBehalfOfUserRole <UserRole>]
[<CommonParameters>] Get-SCLoadBalancer
[-VMMServer <ServerConnection>]
[[-LoadBalancerAddress] <String>]
[-Manufacturer <String>]
[-Model <String>]
-ID <Guid>
[-LogicalNetwork <LogicalNetwork[]>]
[-OnBehalfOfUser <String>]
[-OnBehalfOfUserRole <UserRole>]
[<CommonParameters>] Get-SCLoadBalancer
[-VMMServer <ServerConnection>]
[[-LoadBalancerAddress] <String>]
[-Manufacturer <String>]
[-Model <String>]
-CloudRootHostGroup <HostGroup[]>
[-LogicalNetwork <LogicalNetwork[]>]
[-OnBehalfOfUser <String>]
[-OnBehalfOfUserRole <UserRole>]
[<CommonParameters>] Get-SCLoadBalancer
[-VMMServer <ServerConnection>]
[[-LoadBalancerAddress] <String>]
[-Manufacturer <String>]
[-Model <String>]
-CloudRootVMwareResourcePool <VmwResourcePool>
[-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:\> $LoadBalancersThe 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:\> $LoadBalancersThe 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.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Cloud
Specifies a private cloud object.
| Type: | Cloud |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-CloudRootHostGroup
Specifies a host group that is defined at the root level for a private cloud.
| Type: | HostGroup[] |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-CloudRootVMwareResourcePool
Specifies a VMware resource pool that is defined at the root level for a private cloud.
| Type: | VmwResourcePool |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ID
Specifies the numerical identifier as a globally unique identifier, or GUID, for a specific object.
| Type: | Guid |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | 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.
| Type: | String |
| Position: | 0 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | 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.
| Type: | LogicalNetwork[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | 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 (')
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Model
Specifies the model of a physical device.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-OnBehalfOfUser
Specifies a user name. This cmdlet operates on behalf of the user that this parameter specifies.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | 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.
| Type: | UserRole |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-VMHostGroup
Specifies a virtual machine host group object.
| Type: | HostGroup |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-VMMServer
Specifies a VMM server object.
| Type: | ServerConnection |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
Outputs
LoadBalancer
This cmdlet returns a LoadBalancer object.