Skip to content

Commit afa3bb5

Browse files
authored
Merge pull request MicrosoftDocs#2643 from TimShererWithAquent/networkcontroller-v-tishe
NetworkController PowerShell reference update
2 parents baaede7 + ff68226 commit afa3bb5

File tree

156 files changed

+7594
-489
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

156 files changed

+7594
-489
lines changed

docset/winserver2022-ps/networkcontroller/Add-NetworkControllerNode.md

Lines changed: 38 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,9 @@ Adds a network controller node to an existing network controller deployment.
1717

1818
```
1919
Add-NetworkControllerNode -Name <String> -Server <String> -FaultDomain <String> -RestInterface <String>
20-
[-NodeCertificate <X509Certificate2>] [-Force] [-PassThru] [-ComputerName <String>] [-UseSsl]
21-
[-Credential <PSCredential>] [-CertificateThumbprint <String>] [-WhatIf] [-Confirm] [<CommonParameters>]
20+
[-NodeCertificate <X509Certificate2>] [-Force] [-PassThru] [-CertificateSubjectName <String>]
21+
[-NodeCertificateFindBy <X509FindType>] [-ComputerName <String>] [-UseSsl] [-Credential <PSCredential>]
22+
[-CertificateThumbprint <String>] [-WhatIf] [-Confirm] [<CommonParameters>]
2223
```
2324

2425
## DESCRIPTION
@@ -45,6 +46,21 @@ The FQDN of the computer is named NCNode1.contoso.com and the interface on the c
4546

4647
## PARAMETERS
4748

49+
### -CertificateSubjectName
50+
Specifies the subject name of the certificate used to perform this action.
51+
52+
```yaml
53+
Type: String
54+
Parameter Sets: (All)
55+
Aliases:
56+
57+
Required: False
58+
Position: Named
59+
Default value: None
60+
Accept pipeline input: False
61+
Accept wildcard characters: False
62+
```
63+
4864
### -CertificateThumbprint
4965
Specifies the digital public key X.509 certificate of a user account that has permission to perform this action.
5066
Specify this parameter only if you run this cmdlet on a computer that is not part of the network controller cluster.
@@ -176,6 +192,22 @@ Accept pipeline input: False
176192
Accept wildcard characters: False
177193
```
178194
195+
### -NodeCertificateFindBy
196+
Specifies the method by which to find the node certificate.
197+
198+
```yaml
199+
Type: X509FindType
200+
Parameter Sets: (All)
201+
Aliases:
202+
Accepted values: FindByThumbprint, FindBySubjectName
203+
204+
Required: False
205+
Position: Named
206+
Default value: None
207+
Accept pipeline input: False
208+
Accept wildcard characters: False
209+
```
210+
179211
### -PassThru
180212
Returns an object representing the item with which you are working.
181213
By default, this cmdlet does not generate any output.
@@ -261,9 +293,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
261293
262294
## INPUTS
263295
296+
### None
297+
264298
## OUTPUTS
265299
266-
###
300+
### System.Object
301+
267302
This cmdlet returns an object that contains the following fields:
268303
- Name of the node
269304
- Hostname, FQDN, or IP address of the node

docset/winserver2022-ps/networkcontroller/Clear-NetworkControllerNodeContent.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -88,8 +88,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
8888
8989
## INPUTS
9090
91+
### None
92+
9193
## OUTPUTS
9294
95+
### System.Object
96+
9397
## NOTES
9498
9599
## RELATED LINKS

docset/winserver2022-ps/networkcontroller/Disable-NetworkControllerNode.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -168,9 +168,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
168168
169169
## INPUTS
170170
171+
### System.String
172+
171173
## OUTPUTS
172174
173-
###
175+
### System.Object
176+
174177
The output for this cmdlet contains the following fields:
175178
- Name of the node
176179
- Hostname, fully qualified domain name (FQDN), or IP address of the node

docset/winserver2022-ps/networkcontroller/Enable-NetworkControllerNode.md

Lines changed: 23 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Enables a network controller node.
1616
## SYNTAX
1717

1818
```
19-
Enable-NetworkControllerNode -Name <String> [-PassThru] [-ComputerName <String>] [-UseSsl]
19+
Enable-NetworkControllerNode -Name <String> [-PassThru] [-IntentRejoin] [-ComputerName <String>] [-UseSsl]
2020
[-Credential <PSCredential>] [-CertificateThumbprint <String>] [-WhatIf] [-Confirm] [<CommonParameters>]
2121
```
2222

@@ -105,6 +105,24 @@ Accept pipeline input: False
105105
Accept wildcard characters: False
106106
```
107107
108+
### -IntentRejoin
109+
Indicates the intent to rejoin.
110+
111+
Use this parameter after cleaning up a node, for instance, if the node OS was replaced and the node is clean.
112+
The service fabric application data repopulates using information from the computer whose name is specified.
113+
114+
```yaml
115+
Type: SwitchParameter
116+
Parameter Sets: (All)
117+
Aliases:
118+
119+
Required: False
120+
Position: Named
121+
Default value: None
122+
Accept pipeline input: False
123+
Accept wildcard characters: False
124+
```
125+
108126
### -Name
109127
Specifies the name of the node to be enabled.
110128
@@ -174,9 +192,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
174192
175193
## INPUTS
176194
195+
### System.String
196+
177197
## OUTPUTS
178198
179-
###
199+
### System.Object
200+
180201
The output for this cmdlet contains the following fields:
181202
- Name of the node
182203
- Hostname, fully qualified domain name (FQDN), or IP address of the node

docset/winserver2022-ps/networkcontroller/Get-NetworkController.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -131,9 +131,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
131131
132132
## INPUTS
133133
134+
### None
135+
134136
## OUTPUTS
135137
136-
###
138+
### System.Object
139+
137140
This cmdlet returns an object that contains the following fields:
138141
139142
- Names of the network controller nodes

docset/winserver2022-ps/networkcontroller/Get-NetworkControllerAccessControlList.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ Accept wildcard characters: False
8484
```
8585
8686
### -PassInnerException
87-
87+
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.
8888
8989
```yaml
9090
Type: SwitchParameter
@@ -118,9 +118,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
118118
119119
## INPUTS
120120
121+
### None
122+
121123
## OUTPUTS
122124
123-
###
125+
### System.Object
126+
124127
Each access control list contains multiple ACL rules. Each rule contains the following:
125128
1. Name
126129
2. Protocol

docset/winserver2022-ps/networkcontroller/Get-NetworkControllerAccessControlListRule.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,10 @@ Accept wildcard characters: False
9898
```
9999
100100
### -PassInnerException
101+
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.
101102
103+
The thumbprint must be provided only if the network controller client authentication is X509 certificates.
104+
**Get-NetworkController** retrieves that client authentication and authorization information.
102105
103106
```yaml
104107
Type: SwitchParameter
@@ -132,9 +135,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
132135
133136
## INPUTS
134137
138+
### System.String[]
139+
135140
## OUTPUTS
136141
137-
###
142+
### System.Object
138143
139144
Each rule has the following output:
140145
1. Name
Lines changed: 118 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,118 @@
1+
---
2+
description: The Get-NetworkControllerAuditingSettingsConfiguration cmdlet gets the firewall auditing settings for a Network Controller.
3+
external help file: Microsoft.NetworkController.Powershell.dll-help.xml
4+
Module Name: NetworkController
5+
ms.date: 09/27/2021
6+
online version: https://docs.microsoft.com/powershell/module/networkcontroller/get-networkcontrollerauditingsettingsconfiguration?view=windowsserver2022-ps&wt.mc_id=ps-gethelp
7+
schema: 2.0.0
8+
title: Get-NetworkControllerAuditingSettingsConfiguration
9+
---
10+
11+
# Get-NetworkControllerAuditingSettingsConfiguration
12+
13+
## SYNOPSIS
14+
Gets the firewall auditing settings for a Network Controller.
15+
16+
## SYNTAX
17+
18+
```
19+
Get-NetworkControllerAuditingSettingsConfiguration [-ConnectionUri <Uri>] [-CertificateThumbprint <String>]
20+
[-Credential <PSCredential>] [-PassInnerException] [<CommonParameters>]
21+
```
22+
23+
## DESCRIPTION
24+
The **Get-NetworkControllerAuditingSettingsConfiguration** cmdlet gets the firewall auditing settings for a Network Controller. Firewall auditing records any flow processed by Software Defined Networking (SDN) firewall rules.
25+
26+
## EXAMPLES
27+
28+
### Example 1: Get the configuration for auditing settings
29+
```powershell
30+
Get-NetworkControllerAuditingSettingsConfiguration -ConnectionUri https://networkcontroller
31+
```
32+
33+
This example gets the auditing settings configuration for the specified Network Controller.
34+
35+
## PARAMETERS
36+
37+
### -CertificateThumbprint
38+
Specifies the digital public key X.509 certificate of a user account that has permission to perform this action.
39+
Specify this parameter only if you run this cmdlet on a computer that is not part of the network controller cluster.
40+
41+
```yaml
42+
Type: String
43+
Parameter Sets: (All)
44+
Aliases:
45+
46+
Required: False
47+
Position: Named
48+
Default value: None
49+
Accept pipeline input: False
50+
Accept wildcard characters: False
51+
```
52+
53+
### -ConnectionUri
54+
Specifies the Uniform Resource Identifier (URI) of a Network Controller.
55+
The cmdlet gets configuration for auditing settings for that controller.
56+
57+
```yaml
58+
Type: Uri
59+
Parameter Sets: (All)
60+
Aliases:
61+
62+
Required: False
63+
Position: Named
64+
Default value: None
65+
Accept pipeline input: False
66+
Accept wildcard characters: False
67+
```
68+
69+
### -Credential
70+
Specifies a user credential that has permission to perform this action.
71+
The default value is the current user.
72+
73+
This user must be present in the security group provided in the **ClientSecurityGroup** parameter in the `Install-NetworkController` cmdlet.
74+
Specify this parameter only if you run this cmdlet on a computer that is not part of the network controller cluster.
75+
76+
```yaml
77+
Type: PSCredential
78+
Parameter Sets: (All)
79+
Aliases:
80+
81+
Required: False
82+
Position: Named
83+
Default value: None
84+
Accept pipeline input: False
85+
Accept wildcard characters: False
86+
```
87+
88+
### -PassInnerException
89+
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.
90+
91+
```yaml
92+
Type: SwitchParameter
93+
Parameter Sets: (All)
94+
Aliases:
95+
96+
Required: False
97+
Position: Named
98+
Default value: None
99+
Accept pipeline input: False
100+
Accept wildcard characters: False
101+
```
102+
103+
### CommonParameters
104+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
105+
106+
## INPUTS
107+
108+
### None
109+
110+
## OUTPUTS
111+
112+
### System.Object
113+
114+
## NOTES
115+
116+
## RELATED LINKS
117+
118+
[Set-NetworkControllerAuditingSettingsConfiguration](Set-NetworkControllerAuditingSettingsConfiguration.md)

0 commit comments

Comments
 (0)