Get-NetworkControllerLogicalSubnet

Gets settings of a logical subnet in the Network Controller.

Syntax

Get-NetworkControllerLogicalSubnet
   [-LogicalNetworkId] <String[]>
   [[-ResourceId] <String[]>]
   [-CertificateThumbprint <String>]
   -ConnectionUri <Uri>
   [-Credential <PSCredential>]
   [-PassInnerException]
   [<CommonParameters>]

Description

The Get-NetworkControllerLogicalSubnet cmdlet gets settings of a logical subnet in the Network Controller. A logical subnet comprises one or more subnet/VLAN pairs. VLAN is required. If a subnet is not associated with a VLAN, VLAN takes a value of zero (0).

Examples

Example 1: Get settings for a logical subnet

PS C:\> Get-NetworkControllerLogicalSubnet -ConnectionUri "https://networkcontroller" -LogicalNetworkId "Network13" -ResourceId "Subnet01"

This command retrieves settings for a logical subnet that has the resource ID Subnet01. The subnet belongs to the logical network that has the resource ID Network13. The Network Controller is specified by the connection URI.

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 resource ID of the logical network from which this cmdlet gets subnets.

Type:String[]
Position:0
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
-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
-PassInnerException
Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ResourceId

Specifies an array of resources that this cmdlet retrieves.

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

Outputs

This cmdlet returns an object that contains the following settings:

  • Address prefix of the subnet.
  • VLAN ID of the subnet. Valid values are the range from 0 through 4095.
  • Routes that are contained in the logical subnet.
  • IP address pools that are contained in the logical subnet.
  • DNS servers that devices or hosts use to resolve DNS queries connected to the logical subnet.
  • Reference to network interfaces that are attached to this logical subnet.
  • Whether this subnet is a public subnet.
  • One or more gateways for the subnet.