Set-SCLoadBalancer
Applies To: System Center 2012 - Virtual Machine Manager
Set-SCLoadBalancer
Modifies the properties of a load balancer.
Syntax
Parameter Set: Default
Set-SCLoadBalancer [-LoadBalancer] <LoadBalancer> [-AddLogicalNetworkDedicatedIP <LogicalNetwork[]> ] [-AddLogicalNetworkVIP <LogicalNetwork[]> ] [-AddVMHostGroup <HostGroup[]> ] [-ConfigurationProvider <ConfigurationProvider> ] [-JobVariable <String> ] [-LoadBalancerAddress <String> ] [-Manufacturer <String> ] [-Model <String> ] [-Port <UInt16> ] [-PROTipID <Guid> ] [-RemoveLogicalNetworkDedicatedIP <LogicalNetwork[]> ] [-RemoveLogicalNetworkVIP <LogicalNetwork[]> ] [-RemoveVMHostGroup <HostGroup[]> ] [-RunAsAccount <RunAsAccount> ] [-RunAsynchronously] [-VMMServer <ServerConnection> ] [ <CommonParameters>]
Detailed Description
The Set-SCLoadBalancer cmdlet modifies the properties of a load balancer.
For more information about Set-SCLoadBalancer, type: "Get-Help Set-SCLoadBalancer -online".
Parameters
-AddLogicalNetworkDedicatedIP<LogicalNetwork[]>
Specifies the logical network from which an IP address should be assigned to a virtual machine in a service tier as the back-end address for a service.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-AddLogicalNetworkVIP<LogicalNetwork[]>
Specifies the logical network from which a virtual IP (VIP) address should be assigned to a load balancer VIP as the front-end address for a service.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-AddVMHostGroup<HostGroup[]>
Adds one or more host groups to an existing host group array or private cloud.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-ConfigurationProvider<ConfigurationProvider>
Specifies a configuration provider object. A configuration provider is a plug-in to VMM that translates VMM PowerShell commands to API calls that are specific to a type of load balancer. If no configuration provider is specified, VMM uses the Manufacturer and Model information to choose an available configuration provider. If no configuration provider is found, the load balancer will not be added.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-JobVariable<String>
Specifies that job progress is tracked and stored in the variable named by this parameter.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-LoadBalancer<LoadBalancer>
Specifies a load balancer object.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
true (ByValue) |
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? |
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 include: letters (a-z), numbers (0-9), underscore (_), hyphen(-), dot(.), and 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 |
-Port<UInt16>
Specifies the network port to use when adding an object or creating a connection. Valid values are: 1 to 4095.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-PROTipID<Guid>
Specifies the ID of the PRO tip that triggered this action. This allows for auditing of PRO tips.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-RemoveLogicalNetworkDedicatedIP<LogicalNetwork[]>
Specifies the logical network from which an IP address was assigned to a virtual machine in a service tier as the front-end address for a service, and should now be removed.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-RemoveLogicalNetworkVIP<LogicalNetwork[]>
Specifies the logical network from which a virtual IP (VIP) address was assigned to a load balancer as the front-end address for a service, and should now be removed.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-RemoveVMHostGroup<HostGroup[]>
Removes one or more host groups from a host group array or private cloud.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-RunAsAccount<RunAsAccount>
Specifies a Run As account that contains credentials with permission to perform this action.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-RunAsynchronously
Indicates that the job runs asynchronously so that control returns to the command shell immediately.
Aliases |
none |
Required? |
false |
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.
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
1: Change the configuration provider for a load balancer.
The first command gets the load balancer object with the address of LB01.Contoso.com and stores the object in the $LoadBalancer variable.
The second command gets the configuration provider with the Manufacturer of LB Manufacturer 2 and the model of LB02.
The third command updates the configuration provider for the load balancer stored in $LoadBalancer to the configuration provider stored in $NewProvider.
PS C:\> $LoadBalancer = Get-SCLoadBalancer -LoadBalancerAddress "LB01.Contoso.com"
PS C:\> $NewProvider = Get-SCConfigurationProvider | where { $_.Type -eq "LoadBalancer" -and $_.Manufacturer -eq "LB Manufacturer 2" -and $_.Model -eq "LB02"}
PS C:\> Set-SCLoadBalancer -LoadBalancer $LoadBalancer -ConfigurationProvider $NewProvider -Manufacturer "LB Manufacturer 2" -Model "LB02"