Modifier

Partager via

Get-NetworkControllerVirtualGatewayPolicyMap

  • Reference
Module:
NetworkController

Gets a BGP routing policy map.

Syntax

Get-NetworkControllerVirtualGatewayPolicyMap
   [-VirtualGatewayId] <String[]>
   [[-ResourceId] <String[]>]
   -ConnectionUri <Uri>
   [-CertificateThumbprint <String>]
   [-Credential <PSCredential>]
   [-PassInnerException]
   [<CommonParameters>]

Description

The Get-NetworkControllerVirtualGatewayPolicyMap cmdlet gets the configuration of one or more Border Gateway Protocol (BGP) routing policy map(s) for a tenant.

Use the ResourceId parameter to specify the policy map to get. If you do not specify a ResourceId, this cmdlet gets all policy maps corresponding to a tenant.

Examples

Example 1: Display all policy map configurations for the tenant virtual gateway

PS C:\> Get-NetworkControllerVirtualGatewayPolicyMap -ConnectionUri "https://networkcontroller" -VirtualGatewayId "Contoso"

This command retrieves all the policy maps for the virtual gateway Contoso configured with the Network Controller.

Example 2: Display a specified policy map configuration for the tenant virtual gateway

PS C:\> Get-NetworkControllerVirtualGatewayPolicyMap -ConnectionUri "https://networkcontroller" -VirtualGatewayId "Contoso" -ResourceId "Ingress"

This command retrieves the Ingress policy map configuration 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

-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

-PassInnerException

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

-ResourceId

Specifies an array of resource IDs.

Type:String[]
Position:1
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-VirtualGatewayId

Specifies an array of virtual gateway IDs.

Type:String[]
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

Outputs

This cmdlet returns object(s) that contain the following fields:

  • Resource reference URI.
  • Created time of the resource.
  • Instance ID of the resource.
  • Resource metadata.
  • Resource ID.
  • Properties of the resource (a virtual/tenant gateway's BGP router):
    • Provisioning state.
    • List of policy map entries. Each entry has the policy type, list of match criteria, and list of set actions.
  • List of resource references to the BGP peers that have this policy map applied in ingress.
  • List of resource references to the BGP peers that have this policy map applied in egress.