New-Network
Controller
Gateway
Syntax
New-NetworkControllerGateway
[-ResourceId] <String>
[[-Tags] <PSObject>]
[-Properties] <GatewayProperties>
[[-Etag] <String>]
[[-ResourceMetadata] <ResourceMetadata>]
[-Force]
-ConnectionUri <Uri>
[-CertificateThumbprint <String>]
[-Credential <PSCredential>]
[-PassInnerException]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The New-NetworkControllerGateway cmdlet adds a new gateway virtual machine configuration to the Network Controller. If the specified gateway virtual machine configuration already exists with Network Controller, this cmdlet overwrites and replaces the older configuration.
Examples
Example 1: Add a new gateway virtual machine configuration to the Network Controller
PS C:\> New-NetworkControllerGateway -ConnectionUri https://networkcontroller -ResourceId "MTGW03" -Properties $mtgw03.Properties
Confirm
Performing the operation 'New-NetworkControllerGateway' on entities of type 'Microsoft.Windows.NetworkController.Gateway' via 'https://networkcontroller/networking/v1/gateways/MTGW03'. Are you sure you
want to continue?
[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): yes
Tags :
ResourceRef : /Gateways/MTGW03
InstanceId : a856b20b-0009-4515-9d86-9a17cbda0733
Etag : W/"0383c1c2-b0b3-420b-8105-05ef854c1f7c"
ResourceMetadata :
ResourceId : MTGW03
Properties : Microsoft.Windows.NetworkController.GatewayProperties
This command adds a new gateway virtual machine configuration to the Network Controller.
Required Parameters
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 |
Specifies properties for the gateway virtual machine.
Type: | GatewayProperties |
Position: | 3 |
Default value: | None |
Accept pipeline input: | True (ByPropertyName) |
Accept wildcard characters: | False |
Species the resource ID of a gateway virtual machine.
Type: | String |
Position: | 0 |
Default value: | None |
Accept pipeline input: | True (ByPropertyName) |
Accept wildcard characters: | False |
Optional Parameters
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 |
Prompts you for confirmation before running the cmdlet.
Type: | SwitchParameter |
Aliases: | cf |
Position: | Named |
Default value: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
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 |
Specifies the entity tag (ETag) of the resource. An ETag is an HTTP response header returned by an HTTP-compliant web server. An ETag is 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: | 5 |
Default value: | None |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Forces the command to run without asking for user confirmation.
Type: | SwitchParameter |
Position: | 7 |
Default value: | None |
Accept pipeline input: | False |
Accept wildcard characters: | False |
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: | SwitchParameter |
Position: | Named |
Default value: | None |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Specifies metadata information for the client, such as the tenant ID, group ID, and resource name.
Type: | ResourceMetadata |
Position: | 6 |
Default value: | None |
Accept pipeline input: | False |
Accept wildcard characters: | False |
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: | PSObject |
Position: | 1 |
Default value: | None |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: | SwitchParameter |
Aliases: | wi |
Position: | Named |
Default value: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Outputs
This cmdlet outputs the following information:
- Resource reference URI.
- Created time of the resource.
- Instance ID of the resource.
- Resource metadata.
- Resource ID.
- Properties of the resource: "{ ""VirtualServer"" : @{ ""ResourceRef"": ""<string>"" }, ""NetworkInterfaces"": @{ ""ExternalNetworkInterface"": @{ ""ResourceRef"": ""<string>"" }, ""InternalNetworkInterface"": @{ ""ResourceRef"": ""<string>"" } }, ""BgpConfig"": @{ ""ExtASNumber"": """", ""BgpPeer"": @( @{ ""PeerIP"": """", ""PeerExtASNUmber"": """" } ), ""Pool"": @{ ""ResourceRef"": """" } }"