編集

次の方法で共有

New-NetworkControllerLoadBalancerConfiguration

Module:
NetworkController Module

This cmdlet adds/updates the configuration of load balancer in Network Controller

Syntax

Default (Default) 

New-NetworkControllerLoadBalancerConfiguration
    [[-Tags] <PSObject>]
    [-Properties] <LoadBalancerManagerProperties>
    [[-Etag] <String>]
    [[-ResourceMetadata] <ResourceMetadata>]
    [[-ResourceId] <String>]
    [-Force]
    -ConnectionUri <Uri>
    [-CertificateThumbprint <String>]
    [-Credential <PSCredential>]
    [-PassInnerException]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

This cmdlet adds/updates the configuration of load balancer in Network Controller. This includes the virtual IP of load balancer service in Network Controller, different VIP pools associated with the load balancer and IP address ranges that are excluded from outbound NAT

Examples

Example 1

This example creates load balancer configuration in Network Controller, with REST endpoint as https://networkcontroller. It specifies the load balancer service IP address and a VIP pool from an existing logical network and subnet.

\\Retrieve the VIP pool
$pool=Get-NetworkControllerIpPool -ConnectionUri https://networkcontroller -NetworkId ln1 -SubnetId subnet1

\\Create load balancer configuration object
$lbConfig = New-Object Microsoft.Windows.NetworkController.LoadBalancerManagerProperties
$lbconfig.loadBalancerManagerIpAddress = "10.0.0.23"
$lbconfig.VipPools = $pool

\\Add the load balancer configuration to Network Controller
New-NetworkControllerLoadBalancerConfiguration -ConnectionUri https://networkcontroller -ResourceId lbconfig1 -Properties $lbconfig

Parameters

-CertificateThumbPrint

Specifies the digital public key X.509 certificate of a user account that has permission to perform this action. This is the certificate thumbprint of the certificate. This thumbprint must also be provided in the ClientCertificateThumbprint parameter in the Install-NetworkController or Set-NetworkController cmdlet so that Network Controller can authorize this user.

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

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

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

Parameter sets

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

-ConnectionUri

Specifies the Uniform Resource Identifier (URI) of the Network Controller, used by all Representational State Transfer (REST) clients to connect to Network Controller.

Parameter properties

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

Parameter sets

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

-Credential

Specifies a user credential that has permission to perform this action. The default value is the current user.This user must be present in the security group provided in the ClientSecurityGroup parameter in the Install-NetworkController cmdlet.

Parameter properties

Type:PSCredential
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

-Etag

Specifies the entity tag (ETag) parameter of the resource. An ETag (entity tag) is an HTTP response header returned by an HTTP-compliant web server used to determine change in the content of a resource at a given URL. The value of the header is an opaque string representing the state of the resource at the time the response was generated.

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

-Force

Forces the command to run without asking for user confirmation.

Parameter properties

Type:SwitchParameter
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

-PassInnerException

This thumbprint must also be provided in the ClientCertificateThumbprint parameter in the Install-NetworkController or Set-NetworkController cmdlet so that Network Controller can authorize this user.

The thumbprint must be provided only if the network controller client authentication is X509 certificates. Get-NetworkController retrieves that client authentication and authorization information.

Parameter properties

Type:SwitchParameter
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

-Properties

Specifies the properties of the load balancer configuration that can be changed: 1. Load balancer manager virtual IP address (Load balancer manager is a service inside Network Controller) 2. Virtual IP pools associated with the load balancer. These should be existing IP pools as part of existing logical networks 3. IP address ranges to be excluded from outbound NAT

Parameter properties

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

Parameter sets

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

-ResourceId

Specifies the unique identifier for the load balancer configuration

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

-ResourceMetadata

This parameter contains metadata information for the client, such as the tenant ID, group ID, and resource name.

Parameter properties

Type:ResourceMetadata
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

-Tags

@{Text=}

Parameter properties

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

Parameter sets

(All)
Position:1
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Parameter properties

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

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
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.

Inputs

Microsoft.Windows.NetworkController.LoadBalancerManagerProperties

Following properties can be added/changed for a load balancer configuration: 1. Load balancer manager virtual IP address (Load balancer manager is a service inside Network Controller) 2. Virtual IP pools associated with the load balancer. These should be existing IP pools as part of existing logical networks 3. IP address ranges to be excluded from outbound NAT

Outputs

Object