Get-SCLoadBalancer

Gets a load balancer object.

Description

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

For more information about Get-SCLoadBalancer, type: "Get-Help Get-SCLoadBalancer -online".

Parameters

LoadBalancerAddress

Required? false
Accept Pipeline Input? false
Position? 0 
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.

CloudRootHostGroup

Required? true
Accept Pipeline Input? false
Position? named 
Specifies a host group that is defined at the root level for a private cloud.

LogicalNetwork

Required? false
Accept Pipeline Input? false
Position? named 
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.

Manufacturer

Required? false
Accept Pipeline Input? false
Position? named 
Specifies the name of the company that manufactured a physical device.

Valid characters include: letters (a-z), numbers (0-9), underscore (_), hyphen(-), dot(.), and single quote(').

Model

Required? false
Accept Pipeline Input? false
Position? named 
Specifies the model of a physical device.

VMMServer

Required? false
Accept Pipeline Input? true (ByValue)
Position? named 
Specifies a VMM server object.

LoadBalancerAddress

Required? false
Accept Pipeline Input? false
Position? 0 
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.

CloudRootVMwareResourcePool

Required? true
Accept Pipeline Input? false
Position? named 
Specifies a VMware resource pool that is defined at the root level for a private cloud.

LogicalNetwork

Required? false
Accept Pipeline Input? false
Position? named 
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.

Manufacturer

Required? false
Accept Pipeline Input? false
Position? named 
Specifies the name of the company that manufactured a physical device.

Valid characters include: letters (a-z), numbers (0-9), underscore (_), hyphen(-), dot(.), and single quote(').

Model

Required? false
Accept Pipeline Input? false
Position? named 
Specifies the model of a physical device.

VMMServer

Required? false
Accept Pipeline Input? true (ByValue)
Position? named 
Specifies a VMM server object.

LoadBalancerAddress

Required? false
Accept Pipeline Input? false
Position? 0 
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.

Cloud

Required? true
Accept Pipeline Input? false
Position? named 
Specifies a private cloud object.

LogicalNetwork

Required? false
Accept Pipeline Input? false
Position? named 
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.

Manufacturer

Required? false
Accept Pipeline Input? false
Position? named 
Specifies the name of the company that manufactured a physical device.

Valid characters include: letters (a-z), numbers (0-9), underscore (_), hyphen(-), dot(.), and single quote(').

Model

Required? false
Accept Pipeline Input? false
Position? named 
Specifies the model of a physical device.

VMMServer

Required? false
Accept Pipeline Input? true (ByValue)
Position? named 
Specifies a VMM server object.

LoadBalancerAddress

Required? false
Accept Pipeline Input? false
Position? 0 
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.

VMHostGroup

Required? true
Accept Pipeline Input? false
Position? named 
Specifies a virtual machine host group object.

LogicalNetwork

Required? false
Accept Pipeline Input? false
Position? named 
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.

Manufacturer

Required? false
Accept Pipeline Input? false
Position? named 
Specifies the name of the company that manufactured a physical device.

Valid characters include: letters (a-z), numbers (0-9), underscore (_), hyphen(-), dot(.), and single quote(').

Model

Required? false
Accept Pipeline Input? false
Position? named 
Specifies the model of a physical device.

VMMServer

Required? false
Accept Pipeline Input? true (ByValue)
Position? named 
Specifies a VMM server object.

LoadBalancerAddress

Required? false
Accept Pipeline Input? false
Position? 0 
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.

ID

Required? true
Accept Pipeline Input? false
Position? named 
Specifies the numerical identifier (as a globally unique identifier, or GUID) for a specific object.

LogicalNetwork

Required? false
Accept Pipeline Input? false
Position? named 
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.

Manufacturer

Required? false
Accept Pipeline Input? false
Position? named 
Specifies the name of the company that manufactured a physical device.

Valid characters include: letters (a-z), numbers (0-9), underscore (_), hyphen(-), dot(.), and single quote(').

Model

Required? false
Accept Pipeline Input? false
Position? named 
Specifies the model of a physical device.

VMMServer

Required? false
Accept Pipeline Input? true (ByValue)
Position? named 
Specifies a VMM server object.

LoadBalancerAddress

Required? false
Accept Pipeline Input? false
Position? 0 
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.

All

Required? false
Accept Pipeline Input? false
Position? named 
Retrieves a full list of 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.

LogicalNetwork

Required? false
Accept Pipeline Input? false
Position? named 
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.

Manufacturer

Required? false
Accept Pipeline Input? false
Position? named 
Specifies the name of the company that manufactured a physical device.

Valid characters include: letters (a-z), numbers (0-9), underscore (_), hyphen(-), dot(.), and single quote(').

Model

Required? false
Accept Pipeline Input? false
Position? named 
Specifies the model of a physical device.

VMMServer

Required? false
Accept Pipeline Input? true (ByValue)
Position? named 
Specifies a VMM server object.

Examples

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 to the user.
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 to the user.

See Also