Get-SCLoadBalancer
Get-SCLoadBalancer
Gets a load balancer object.
Syntax
Parameter Set: GlobalList
Get-SCLoadBalancer [[-LoadBalancerAddress] <String> ] [-All] [-LogicalNetwork <LogicalNetwork[]> ] [-Manufacturer <String> ] [-Model <String> ] [-OnBehalfOfUser <System.String> ] [-OnBehalfOfUserRole <Microsoft.SystemCenter.VirtualMachineManager.UserRole> ] [-VMMServer <ServerConnection> ] [ <CommonParameters>]
Parameter Set: AccessibleToCloudRootHostGroup
Get-SCLoadBalancer [[-LoadBalancerAddress] <String> ] -CloudRootHostGroup <HostGroup[]> [-LogicalNetwork <LogicalNetwork[]> ] [-Manufacturer <String> ] [-Model <String> ] [-OnBehalfOfUser <System.String> ] [-OnBehalfOfUserRole <Microsoft.SystemCenter.VirtualMachineManager.UserRole> ] [-VMMServer <ServerConnection> ] [ <CommonParameters>]
Parameter Set: AccessibleToCloudRootVMwareResourcePool
Get-SCLoadBalancer [[-LoadBalancerAddress] <String> ] -CloudRootVMwareResourcePool <VmwResourcePool> [-LogicalNetwork <LogicalNetwork[]> ] [-Manufacturer <String> ] [-Model <String> ] [-OnBehalfOfUser <System.String> ] [-OnBehalfOfUserRole <Microsoft.SystemCenter.VirtualMachineManager.UserRole> ] [-VMMServer <ServerConnection> ] [ <CommonParameters>]
Parameter Set: ByCloud
Get-SCLoadBalancer [[-LoadBalancerAddress] <String> ] -Cloud <Cloud> [-LogicalNetwork <LogicalNetwork[]> ] [-Manufacturer <String> ] [-Model <String> ] [-OnBehalfOfUser <System.String> ] [-OnBehalfOfUserRole <Microsoft.SystemCenter.VirtualMachineManager.UserRole> ] [-VMMServer <ServerConnection> ] [ <CommonParameters>]
Parameter Set: ByHostGroup
Get-SCLoadBalancer [[-LoadBalancerAddress] <String> ] -VMHostGroup <HostGroup> [-LogicalNetwork <LogicalNetwork[]> ] [-Manufacturer <String> ] [-Model <String> ] [-OnBehalfOfUser <System.String> ] [-OnBehalfOfUserRole <Microsoft.SystemCenter.VirtualMachineManager.UserRole> ] [-VMMServer <ServerConnection> ] [ <CommonParameters>]
Parameter Set: ByID
Get-SCLoadBalancer [[-LoadBalancerAddress] <String> ] -ID <Guid> [-LogicalNetwork <LogicalNetwork[]> ] [-Manufacturer <String> ] [-Model <String> ] [-OnBehalfOfUser <System.String> ] [-OnBehalfOfUserRole <Microsoft.SystemCenter.VirtualMachineManager.UserRole> ] [-VMMServer <ServerConnection> ] [ <CommonParameters>]
Detailed Description
The Get-SCLoadBalancer cmdlet gets one or more load balancer objects.
Parameters
-All
Indicates that this cmdlet gets all subordinate objects independent of the parent object. For example, the command Get-SCVirtualDiskDrive -All
retrieves all virtual disk drive objects regardless of the virtual machine object or template object that each virtual disk drive object is associated with.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Cloud<Cloud>
Specifies a private cloud object.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-CloudRootHostGroup<HostGroup[]>
Specifies an array of host group objects that is defined at the root level for a private cloud.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-CloudRootVMwareResourcePool<VmwResourcePool>
Specifies a VMware resource pool that is defined at the root level for a private cloud.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-ID<Guid>
Specifies the numerical identifier as a globally unique identifier (GUID) for a specific object.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-LoadBalancerAddress<String>
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.
Aliases |
none |
Required? |
false |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-LogicalNetwork<LogicalNetwork[]>
Specifies an array of logical network objects. A logical network is a named grouping of IP subnets and VLANs that is used to organize and simplify network assignments.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Manufacturer<String>
Specifies the name of the company that manufactured a physical device. Valid characters are:
-- letters (a-z)
-- numbers (0-9)
-- underscore (_)
-- hyphen (-)
-- dot (.)
-- single quote (')
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Model<String>
Specifies the model of a physical device.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-OnBehalfOfUser<System.String>
Specifies a user name. This cmdlet operates on behalf of the user that this parameter specifies.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-OnBehalfOfUserRole<Microsoft.SystemCenter.VirtualMachineManager.UserRole>
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.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-VMHostGroup<HostGroup>
Specifies a virtual machine host group object.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-VMMServer<ServerConnection>
Specifies a VMM server object.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
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.
- LoadBalancer
Examples
Example 1: Get all load balancers for a host group
The first command gets the host group object named HostGroup01, and then stores the object in the $HostGroup variable.
The second command gets all load balancer objects accessible to the host group stored in $HostGroup, and then stores the objects in the $LoadBalancers variable.
The last command displays information about each of the load balancers stored in $LoadBalancers.
PS C:\> $HostGroup = Get-SCVMHostGroup | where { $_.Path -eq "All Hosts\HostGroup01" }
PS C:\> $LoadBalancers = Get-SCLoadBalancer -VMHostGroup $HostGroup
PS C:\> $LoadBalancers
Example 2: Get all load balancers of a given type for a host group
The first command gets the host group object named Production, and then 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 then stores the objects in the $LoadBalancers variable.
The last command displays information about each load balancer object stored in $LoadBalancers to the user.
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