Get-NetworkControllerAccessControlListRule
Gets a rule from an access control list for a network controller.
Syntax
Get-NetworkControllerAccessControlListRule
[-AccessControlListId] <String[]>
[[-ResourceId] <String[]>]
-ConnectionUri <Uri>
[-CertificateThumbprint <String>]
[-Credential <PSCredential>]
[-PassInnerException]
[<CommonParameters>]
Description
The Get-NetworkControllerAccessControlListRule cmdlet gets a rule from an access control list for a network controller.
Examples
Example 1
This example retrieves all rules belonging to an Access Control List named Subnet1Acl from the Network Controller.
Get-NetworkControllerAccessControlListRule -ConnectionUri https://networkcontroller -AccessControlListId "Subnet1ACL"
Parameters
-AccessControlListId
Specifies the ID of the Access Control List where the rule belongs.
Type: | String[] |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-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 that all Representational State Transfer (REST) clients use to connect to that 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 is the current user. Specify this parameter only if you run this cmdlet on a computer that is not part of the Network Controller cluster.
Type: | PSCredential |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-PassInnerException
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.
The thumbprint must be provided only if the network controller client authentication is X509 certificates. Get-NetworkController retrieves that client authentication and authorization information.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ResourceId
Specifies the resource ID of the ACL rule to get.
Type: | String[] |
Position: | 1 |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Inputs
String[]
Outputs
Each rule has the following output:
- Name
- Protocol
- Source and destination port range
- Source and destination IP address prefix
- Action on the rule (Allow/Deny)
- Priority of rule
- Type of rule (inbound/outbound)
- Whether logging is enabled/disabled on the rule