Skip to content

Commit 287a4a9

Browse files
committed
Fix platyps schema violation
1 parent 472b128 commit 287a4a9

File tree

2 files changed

+129
-67
lines changed

2 files changed

+129
-67
lines changed

docset/winserver2022-ps/dnsserver/Step-DnsServerSigningKeyRollover.md

Lines changed: 68 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -11,57 +11,73 @@ title: Step-DnsServerSigningKeyRollover
1111
# Step-DnsServerSigningKeyRollover
1212

1313
## SYNOPSIS
14+
1415
Rolls over a KSK that is waiting for a parent DS update.
1516

1617
## SYNTAX
1718

1819
```
1920
Step-DnsServerSigningKeyRollover [-ZoneName] <String> [-KeyId] <Guid> [-Force] [-PassThru]
20-
[-ComputerName <String>] [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-AsJob] [-WhatIf] [-Confirm]
21-
[<CommonParameters>]
21+
[-ComputerName <String>] [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-AsJob] [-WhatIf]
22+
[-Confirm] [<CommonParameters>]
2223
```
2324

2425
## DESCRIPTION
25-
The **Step-DnsServerSigningKeyRollover** cmdlet rolls over a key signing key (KSK) that is waiting for an update from a parent delegation signer (DS).
26-
If a Domain Name System (DNS) server that hosts a securely delegated zone cannot check whether the DS record in a parent is updated, use this cmdlet to force a rollover.
26+
27+
The `Step-DnsServerSigningKeyRollover` cmdlet rolls over a key signing key (KSK) that is waiting
28+
for an update from a parent delegation signer (DS). If a Domain Name System (DNS) server that hosts
29+
a securely delegated zone cannot check whether the DS record in a parent is updated, use this cmdlet
30+
to force a rollover.
2731

2832
Important: You must manually update the DS record in the parent before you run this cmdlet.
2933

3034
## EXAMPLES
3135

3236
### Example 1: Force a key signing key rollover
33-
```
37+
38+
This example gets keys for a signed zone, and then forces a KSK rollover for one of the keys in the zone.
39+
3440
The first command uses the **Get-DnsServerSigningKey** cmdlet to gets keys for the signed zone Sec.Contoso.com.
35-
PS C:\> Get-DnsServerSigningKey -ZoneName "Sec.Contoso.com"
41+
42+
```powershell
43+
Get-DnsServerSigningKey -ZoneName "Sec.Contoso.com"
44+
```
45+
46+
```Output
3647
KeyId KeyType CryptoAlgorithm KeyLength StoreKeysInAD IsRolloverEnabled
3748
----- ------- --------------- --------- ------------- -----------------
3849
5fe47b29-6bf8-457a-b457-e640893ebd53 KeySigningKey RsaSha256 2048 True True
3950
aaf3301e-feb2-4ba7-8ac6-273c6bda75af KeySigningKey RsaSha1NSec3 2048 True True
4051
fbf3116f-b0ba-4bf8-bf35-68dab6d4765b ZoneSigningKey RsaSha1NSec3 1024 True True
4152
f760fcb5-577b-4237-b0b2-513e1f68ec72 ZoneSigningKey RsaSha256 1024 True True
53+
```
4254

43-
The last command forces a KSK rollover that is waiting for a parent DS update on Contoso.com. The command performs a KSK rollover for the specified key in the zone named Sec.Contoso.com.
44-
PS C:\> Step-DnsServerSigningKeyRollover -KeyId 5fe47b29-6bf8-457a-b457-e640893ebd53 -ZoneName "Sec.Contoso.com" -Force
55+
```powershell
56+
Step-DnsServerSigningKeyRollover -KeyId 5fe47b29-6bf8-457a-b457-e640893ebd53 -ZoneName "Sec.Contoso.com" -Force
4557
```
4658

47-
This example gets keys for a signed zone, and then forces a KSK rollover for one of the keys in the zone.
59+
The last command forces a KSK rollover that is waiting for a parent DS update on Contoso.com. The
60+
command performs a KSK rollover for the specified key in the zone named Sec.Contoso.com.
4861

4962
## PARAMETERS
5063

5164
### -AsJob
52-
Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.
5365

54-
The cmdlet immediately returns an object that represents the job and then displays the command prompt.
55-
You can continue to work in the session while the job completes.
56-
To manage the job, use the `*-Job` cmdlets.
57-
To get the job results, use the [Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet.
66+
Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to
67+
complete.
68+
69+
The cmdlet immediately returns an object that represents the job and then displays the command
70+
prompt. You can continue to work in the session while the job completes. To manage the job, use the
71+
`*-Job` cmdlets. To get the job results, use the
72+
[Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet.
5873

59-
For more information about Windows PowerShell background jobs, see [about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251).
74+
For more information about Windows PowerShell background jobs, see
75+
[about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251).
6076

6177
```yaml
6278
Type: SwitchParameter
6379
Parameter Sets: (All)
64-
Aliases:
80+
Aliases:
6581

6682
Required: False
6783
Position: Named
@@ -71,9 +87,11 @@ Accept wildcard characters: False
7187
```
7288
7389
### -CimSession
74-
Runs the cmdlet in a remote session or on a remote computer.
75-
Enter a computer name or a session object, such as the output of a [New-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227967) or [Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet.
76-
The default is the current session on the local computer.
90+
91+
Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session
92+
object, such as the output of a [New-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227967)
93+
or [Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet. The default is the
94+
current session on the local computer.
7795
7896
```yaml
7997
Type: CimSession[]
@@ -88,13 +106,14 @@ Accept wildcard characters: False
88106
```
89107
90108
### -ComputerName
91-
Specifies a remote DNS server.
92-
Specify the IP address or any value that resolves to an IP address, such as a fully qualified domain name (FQDN), host name, or NETBIOS name, for the DNS server.
109+
110+
Specifies a remote DNS server. Specify the IP address or any value that resolves to an IP address,
111+
such as a fully qualified domain name (FQDN), host name, or NETBIOS name, for the DNS server.
93112
94113
```yaml
95114
Type: String
96115
Parameter Sets: (All)
97-
Aliases:
116+
Aliases:
98117

99118
Required: False
100119
Position: Named
@@ -104,6 +123,7 @@ Accept wildcard characters: False
104123
```
105124
106125
### -Confirm
126+
107127
Prompts you for confirmation before running the cmdlet.
108128
109129
```yaml
@@ -119,12 +139,13 @@ Accept wildcard characters: False
119139
```
120140
121141
### -Force
142+
122143
Forces the command to run without asking for user confirmation.
123144
124145
```yaml
125146
Type: SwitchParameter
126147
Parameter Sets: (All)
127-
Aliases:
148+
Aliases:
128149

129150
Required: False
130151
Position: Named
@@ -134,12 +155,13 @@ Accept wildcard characters: False
134155
```
135156
136157
### -KeyId
158+
137159
Specifies the ID of the key for which to perform the KSK rollover.
138160
139161
```yaml
140162
Type: Guid
141163
Parameter Sets: (All)
142-
Aliases:
164+
Aliases:
143165

144166
Required: True
145167
Position: 2
@@ -149,13 +171,14 @@ Accept wildcard characters: False
149171
```
150172
151173
### -PassThru
152-
Returns an object representing the item with which you are working.
153-
By default, this cmdlet does not generate any output.
174+
175+
Returns an object representing the item with which you are working. By default, this cmdlet does not
176+
generate any output.
154177
155178
```yaml
156179
Type: SwitchParameter
157180
Parameter Sets: (All)
158-
Aliases:
181+
Aliases:
159182

160183
Required: False
161184
Position: Named
@@ -165,14 +188,17 @@ Accept wildcard characters: False
165188
```
166189
167190
### -ThrottleLimit
168-
Specifies the maximum number of concurrent operations that can be established to run the cmdlet.
169-
If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer.
170-
The throttle limit applies only to the current cmdlet, not to the session or to the computer.
191+
192+
Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If
193+
this parameter is omitted or a value of `0` is entered, then Windows PowerShell&reg; calculates an
194+
optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the
195+
computer. The throttle limit applies only to the current cmdlet, not to the session or to the
196+
computer.
171197

172198
```yaml
173199
Type: Int32
174200
Parameter Sets: (All)
175-
Aliases:
201+
Aliases:
176202
177203
Required: False
178204
Position: Named
@@ -182,8 +208,8 @@ Accept wildcard characters: False
182208
```
183209

184210
### -WhatIf
185-
Shows what would happen if the cmdlet runs.
186-
The cmdlet is not run.
211+
212+
Shows what would happen if the cmdlet runs. The cmdlet is not run.
187213

188214
```yaml
189215
Type: SwitchParameter
@@ -198,12 +224,13 @@ Accept wildcard characters: False
198224
```
199225

200226
### -ZoneName
227+
201228
Specifies the name of the DNS zone in which the cmdlet performs the KSK rollover.
202229

203230
```yaml
204231
Type: String
205232
Parameter Sets: (All)
206-
Aliases:
233+
Aliases:
207234
208235
Required: True
209236
Position: 1
@@ -213,13 +240,18 @@ Accept wildcard characters: False
213240
```
214241

215242
### CommonParameters
216-
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).
243+
244+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
245+
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
246+
-WarningAction, and -WarningVariable. For more information, see
247+
[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
217248

218249
## INPUTS
219250

220251
## OUTPUTS
221252

222-
###
253+
### Microsoft.Management.Infrastructure.CimInstance#DnsServerSigningKey[]
254+
223255
The output object contains the following fields:
224256

225257
- ActiveKey
@@ -250,4 +282,3 @@ The output object contains the following fields:
250282
[Invoke-DnsServerSigningKeyRollover](./Invoke-DnsServerSigningKeyRollover.md)
251283

252284
[Disable-DnsServerSigningKeyRollover](./Disable-DnsServerSigningKeyRollover.md)
253-

0 commit comments

Comments
 (0)