Remove-Network Controller Fabric Route

Module:
networkcontroller
Removes a network route from the Network Controller.

Syntax 

Remove-NetworkControllerFabricRoute
      [-LogicalNetworkId] <String>
      [-SubnetId] <String>
      [-ResourceId] <String>
      [[-Etag] <String>]
      [-Force]
      -ConnectionUri <Uri>
      [-CertificateThumbprint <String>]
      [-Credential <PSCredential>]
      [-PassInnerException]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

The Remove-NetworkControllerFabricRoute cmdlet removes a network route from the Network Controller. Specify the logical network and subnet of the route that this cmdlet removes.

Examples

Example 1: Remove a route 

PS C:\> Remove-NetworkControllerFabricRoute -ConnectionUri "https://networkcontroller" -LogicalNetworkId "Network13" -SubnetId "Subnet01" -ResourceId "Route21"

This cmdlet removes a route that has the resource ID Route21 from a subnet that has the ID Subnet01. The subnet is part of the logical network Network13.

Required Parameters

-ConnectionUri

Specifies the Uniform Resource Identifier (URI) of the Network Controller. All Representational State Transfer (REST) clients use this URI to connect to Network Controller.

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

Specifies the ID of the logical network from which this cmdlet removes a route.

Type: String
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-ResourceId

Specifies the resource ID of the route that this cmdlet removes.

Type: String
Position: 2
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-SubnetId

Specifies the ID of the subnet from which this cmdlet removes a route.

Type: String
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

Optional Parameters

-CertificateThumbprint

Specifies the certificate thumbprint of a digital public key X.509 certificate of a user account that has permission to perform this action. In order for Network Controller to authorize the account, specify this thumbprint by using the ClientCertificateThumbprint parameter of the Install-NetworkController or Set-NetworkController cmdlet.

Type: String
Position: Named
Default value: None
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
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 specified in the ClientSecurityGroup parameter in Install-NetworkController .

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 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. The value of the header is an opaque string that represents the state of the resource when the response was generated.

Type: String
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Force

Forces the command to run without asking for user confirmation.

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