Get-NetworkControllerLogicalNetwork
Gets settings for a logical network in the Network Controller.
Syntax
Get-NetworkControllerLogicalNetwork
[[-ResourceId] <String[]>]
-ConnectionUri <Uri>
[-CertificateThumbprint <String>]
[-Credential <PSCredential>]
[-PassInnerException]
[<CommonParameters>]
Description
The Get-NetworkControllerLogicalNetwork cmdlet gets settings for a logical network in the Network Controller. A logical network represents a logical partition of a physical network that is dedicated for a particular purpose. A logical network is a collection of logical subnets.
A logical network has the following configuration settings:
- The subnets that are contained in the logical network.
- Whether network virtualization is enabled for the network.
- The virtual networks that use this logical network.
Examples
Example 1: Get configuration of a logical network
PS C:\> Get-NetworkControllerLogicalNetwork -ConnectionUri "https://networkcontroller" -ResourceId "Network13"
This command retrieves the configuration of a logical network that has resource ID Network13 from the Network Controller at the specified URI.
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 |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-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 |
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 specified in the ClientSecurityGroup parameter in Install-NetworkController.
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 resources for which this cmdlet retrieves settings.
Type: | String[] |
Position: | 0 |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |