Set-NetworkControllerVirtualNetworkConfiguration

This cmdlet sets the global configuration for virtual networking in the Network Controller.

Syntax

Set-NetworkControllerVirtualNetworkConfiguration
   -ConnectionUri <Uri>
   -Properties <VirtualNetworkManagerProperties>
   -ResourceId <string>
   [-CertificateThumbPrint <string>]
   [-Credential <PSCredential>]
   [-Etag <string>]
   [-Force]
   [-ResourceMetadata <ResourceMetadata>]
   [-Tags <psobject>]

Description

This cmdlet sets the global configuration for virtual networking in the Network Controller. With this, you can set the network virtualization protocol of the virtual network to VXLAN or NVGRE. The default is VXLAN

Examples

Example 1

This example set the network virtualization protocol of the virtual networks to NVGRE.

$config=New-Object Microsoft.Windows.NetworkController.VirtualNetworkManagerProperties
$config.NetworkVirtualizationProtocol="NVGRE"
Set-NetworkControllerVirtualNetworkConfiguration -ConnectionUri https://networkcontroller -ResourceId vnetglobalconfig -Properties $config

Required Parameters

-ConnectionUri

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

Type:Uri
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Properties

Following properties can be changed:

  • Whether distributed router is enabled or disabled
  • Network virtualization mode (NVGRE/VXLAN)
Type:VirtualNetworkManagerProperties
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ResourceId

Specifies the unique identifier for the virtual network configuration

Type:string
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

Optional 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.

Type:string
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters: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.

Type:PSCredential
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters: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.

Type:string
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Force

Forces the command to run without asking for user confirmation.

Type:switch
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ResourceMetadata

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

Type:ResourceMetadata
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Tags

@{Text=}

Type:psobject
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

Inputs

Following properties can be changed:

  • Whether distributed router is enabled or disabled
  • Network virtualization mode (NVGRE/VXLAN)