New-NetworkControllerVirtualGatewayPolicyMap
Creates a BGP routing policy map.
Syntax
New-NetworkControllerVirtualGatewayPolicyMap
[-VirtualGatewayId] <String>
[-ResourceId] <String>
[-Properties] <VGwPolicyMapProperties>
[[-ResourceMetadata] <ResourceMetadata>]
[[-Etag] <String>]
[-Force]
-ConnectionUri <Uri>
[-CertificateThumbprint <String>]
[-Credential <PSCredential>]
[-PassInnerException]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The New-NetworkControllerVirtualGatewayPolicyMap cmdlet adds a configuration for a BGP routing policy map for the specified tenant to Network Controller. If the policy map already exists, this cmdlet overwrites and replaces the older configuration.
Examples
Example 1: Add a new virtual gateway BGP routing policy map configuration to the Network Controller
PS C:\> $uri = "https://networkcontroller"
# Create a new object for policy map
PS C:\> $bgpPolicyMapPropertiesObject = New-Object Microsoft.Windows.NetworkController.VGwPolicyMapProperties
# Update the policy map properties
# Add the new policy map for tenant
PS C:\> New-NetworkControllerVirtualGatewayPolicyMap -ConnectionUri $uri -VirtualGatewayId Contoso -ResourceId "Egress_Map" -Properties $ bgpPolicyMapPropertiesObject -Force
This command adds a new BGP routing policy map for the tenant Contoso.
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 |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
Type: | SwitchParameter |
Aliases: | cf |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | 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.
Type: | Uri |
Position: | Named |
Default value: | None |
Required: | True |
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 |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Etag
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: | 6 |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Force
Forces the command to run without asking for user confirmation.
Type: | SwitchParameter |
Position: | 7 |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-PassInnerException
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Properties
Specifies the properties for the policy map.
Type: | VGwPolicyMapProperties |
Position: | 3 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-ResourceId
Specifies the resource ID of the virtual gateway policy map to create.
Type: | String |
Position: | 1 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-ResourceMetadata
Specifies metadata information for the client, such as the tenant ID, group ID, and resource name.
Type: | ResourceMetadata |
Position: | 4 |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-VirtualGatewayId
Specifies the ID of a virtual gateway.
Type: | String |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: | SwitchParameter |
Aliases: | wi |
Position: | Named |
Default value: | False |
Required: | 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:
{
""PolicyName"" : """",
""PolicyType"": """",
""MatchCriteria"": @( @{
""Clause"": """",
""Operator"": ""And"",
""Value"": """"
} ),
""SetActions"": @(@{
""Clause"": """",
""Value"": """"
} )
}