From 85030fd7c852c14f8a0b05dbfb241b2ce99c504c Mon Sep 17 00:00:00 2001 From: Nephiaust Date: Tue, 7 Dec 2021 11:45:04 +0930 Subject: [PATCH 001/650] Update Set-ADUser.md Added note to -Country to specify the use of the ISO-3166 2 character country code & linked to AD Schema definition. --- docset/winserver2019-ps/activedirectory/Set-ADUser.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docset/winserver2019-ps/activedirectory/Set-ADUser.md b/docset/winserver2019-ps/activedirectory/Set-ADUser.md index 0cacd58ec7..55d0f27f9d 100644 --- a/docset/winserver2019-ps/activedirectory/Set-ADUser.md +++ b/docset/winserver2019-ps/activedirectory/Set-ADUser.md @@ -496,6 +496,7 @@ Accept wildcard characters: False Specifies the country or region code for the user's language of choice. This parameter sets the **Country** property of a user object. The LDAP display name (**ldapDisplayName**) of this property is c. +This value uses the ISO-3166 2 character code (see https://docs.microsoft.com/en-us/windows/win32/adschema/a-c). This value is not used by Windows 2000. ```yaml From f78d174963c967ce9214ac18ca8ef8cdd80a3cdf Mon Sep 17 00:00:00 2001 From: Nephiaust Date: Tue, 7 Dec 2021 19:26:24 +0930 Subject: [PATCH 002/650] Update docset/winserver2019-ps/activedirectory/Set-ADUser.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- docset/winserver2019-ps/activedirectory/Set-ADUser.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2019-ps/activedirectory/Set-ADUser.md b/docset/winserver2019-ps/activedirectory/Set-ADUser.md index 55d0f27f9d..80032c430f 100644 --- a/docset/winserver2019-ps/activedirectory/Set-ADUser.md +++ b/docset/winserver2019-ps/activedirectory/Set-ADUser.md @@ -496,7 +496,7 @@ Accept wildcard characters: False Specifies the country or region code for the user's language of choice. This parameter sets the **Country** property of a user object. The LDAP display name (**ldapDisplayName**) of this property is c. -This value uses the ISO-3166 2 character code (see https://docs.microsoft.com/en-us/windows/win32/adschema/a-c). +This value uses the ISO-3166 2-character code (see [Country-Name attribute](/windows/win32/adschema/a-c). This value is not used by Windows 2000. ```yaml From 165fc09b0598310e71d68157b955bc4035bb7ca5 Mon Sep 17 00:00:00 2001 From: Tungsten66 <40893034+Tungsten66@users.noreply.github.com> Date: Fri, 7 Jan 2022 14:45:40 -0500 Subject: [PATCH 003/650] Update Example Added -Active:$False to the end of the example to create a passive file screen template. Tested on Server 2019 Included outputs of old and new commands below: PS C:\Users\it> New-FsrmFileScreenTemplate "Filter Non-HTML text files" -IncludeGroup "Non-HTML text files" Active : True Description : IncludeGroup : {Non-HTML text files} Name : Filter Non-HTML text files Notification : UpdateDerived : False UpdateDerivedMatching : False PSComputerName : PS C:\Users\it> New-FsrmFileScreenTemplate "Filter Non-HTML text files" -IncludeGroup "Non-HTML text files" -Active:$False Active : False Description : IncludeGroup : {Non-HTML text files} Name : Filter Non-HTML text files Notification : UpdateDerived : False UpdateDerivedMatching : False PSComputerName : --- .../fileserverresourcemanager/New-FsrmFileScreenTemplate.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2019-ps/fileserverresourcemanager/New-FsrmFileScreenTemplate.md b/docset/winserver2019-ps/fileserverresourcemanager/New-FsrmFileScreenTemplate.md index 7aacda0f20..cff9e6cc0e 100644 --- a/docset/winserver2019-ps/fileserverresourcemanager/New-FsrmFileScreenTemplate.md +++ b/docset/winserver2019-ps/fileserverresourcemanager/New-FsrmFileScreenTemplate.md @@ -32,7 +32,7 @@ When you make changes to a template, you can choose to apply those changes to al ### Example 1: Create a passive file screen template ``` -PS C:\> New-FsrmFileScreenTemplate "Filter Non-HTML text files" -IncludeGroup "Non-HTML text files" +PS C:\> New-FsrmFileScreenTemplate "Filter Non-HTML text files" -IncludeGroup "Non-HTML text files" -Active:$False ``` This command creates a passive file screen template named "Filter Non-HTML text files" that logs any files that match the "Non-HTML text files" file group. From 6ea7ed0ac7daf719759a1942d37d5767a85aa0b2 Mon Sep 17 00:00:00 2001 From: Matthew Ige Date: Fri, 8 Jul 2022 10:44:21 -0700 Subject: [PATCH 004/650] Update hyper-v firewall documentation --- .../Disable-NetFirewallHyperVRule.md | 331 +++++++++++++++ .../Enable-NetFirewallHyperVRule.md | 329 +++++++++++++++ .../netsecurity/Get-NetFirewallHyperVPort.md | 120 ++++++ .../netsecurity/Get-NetFirewallHyperVRule.md | 334 +++++++++++++++ .../Get-NetFirewallHyperVVMCreator.md | 124 ++++++ .../Get-NetFirewallHyperVVMSetting.md | 181 ++++++++ .../netsecurity/New-NetFirewallHyperVRule.md | 394 ++++++++++++++++++ .../New-NetFirewallHyperVVMSetting.md | 219 ++++++++++ .../Remove-NetFirewallHyperVRule.md | 329 +++++++++++++++ .../Rename-NetFirewallHyperVRule.md | 340 +++++++++++++++ .../netsecurity/Set-NetFirewallHyperVRule.md | 386 +++++++++++++++++ .../Set-NetFirewallHyperVVMSetting.md | 223 ++++++++++ 12 files changed, 3310 insertions(+) create mode 100644 docset/winserver2022-ps/netsecurity/Disable-NetFirewallHyperVRule.md create mode 100644 docset/winserver2022-ps/netsecurity/Enable-NetFirewallHyperVRule.md create mode 100644 docset/winserver2022-ps/netsecurity/Get-NetFirewallHyperVPort.md create mode 100644 docset/winserver2022-ps/netsecurity/Get-NetFirewallHyperVRule.md create mode 100644 docset/winserver2022-ps/netsecurity/Get-NetFirewallHyperVVMCreator.md create mode 100644 docset/winserver2022-ps/netsecurity/Get-NetFirewallHyperVVMSetting.md create mode 100644 docset/winserver2022-ps/netsecurity/New-NetFirewallHyperVRule.md create mode 100644 docset/winserver2022-ps/netsecurity/New-NetFirewallHyperVVMSetting.md create mode 100644 docset/winserver2022-ps/netsecurity/Remove-NetFirewallHyperVRule.md create mode 100644 docset/winserver2022-ps/netsecurity/Rename-NetFirewallHyperVRule.md create mode 100644 docset/winserver2022-ps/netsecurity/Set-NetFirewallHyperVRule.md create mode 100644 docset/winserver2022-ps/netsecurity/Set-NetFirewallHyperVVMSetting.md diff --git a/docset/winserver2022-ps/netsecurity/Disable-NetFirewallHyperVRule.md b/docset/winserver2022-ps/netsecurity/Disable-NetFirewallHyperVRule.md new file mode 100644 index 0000000000..c68667216e --- /dev/null +++ b/docset/winserver2022-ps/netsecurity/Disable-NetFirewallHyperVRule.md @@ -0,0 +1,331 @@ +--- +description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. +external help file: NetFirewallHyperVRule.cmdletDefinition.cdxml-help.xml +Module Name: NetSecurity +ms.date: 12/27/2016 +online version: https://docs.microsoft.com/powershell/module/netsecurity/disable-netfirewallhypervrule?view=windowsserver2022-ps&wt.mc_id=ps-gethelp +schema: 2.0.0 +title: Disable-NetFirewallHyperVRule +--- + +# Disable-NetFirewallHyperVRule + +## SYNOPSIS +Disables one or more Hyper-V firewall rules that match the specified criteria. + +## SYNTAX + +``` +Disable-NetFirewallHyperVRule [-All] [-PolicyStore ] [-CimSession ] [-ThrottleLimit ] [-AsJob] [-PassThru] [-WhatIf] [-Confirm] [] +``` + +``` +Disable-NetFirewallHyperVRule [-Name] [-PolicyStore ] [-CimSession ] [-ThrottleLimit ] [-AsJob] [-PassThru] [-WhatIf] [-Confirm] [] +``` + +``` +Disable-NetFirewallHyperVRule -DisplayName [-PolicyStore ] [-CimSession ] [-ThrottleLimit ] [-AsJob] [-PassThru] [-WhatIf] [-Confirm] [] +``` + +``` +Disable-NetFirewallHyperVRule [-Direction {Inbound | Outbound}] [-VMCreatorId ] [-Protocol ] [-Action {NotConfigured | Allow | Block}] [-Enabled {True | False}] [-EnforcementStatus {Unknown | OK | PartiallyEnforced | NoApplicablePorts | ParsingError | Error}] [-PolicyStoreSourceType {None | Local | MDM}] [-PolicyStore ] [-CimSession ] [-ThrottleLimit ] [-AsJob] [-PassThru] [-WhatIf] [-Confirm] [] +``` + +``` +Disable-NetFirewallHyperVRule -InputObject [-CimSession ] [-ThrottleLimit ] [-AsJob] [-PassThru] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +IMPORTANT NOTE: Running this cmdlet without parameters disables all Windows Hyper-V firewall rules on the target computer. Always run this cmdlet with the WhatIf parameter if you are not targeting a specific Windows Hyper-V Firewall rule. + +The **Disable-NetFirewallHyperVRule** cmdlet disables a previously enabled Hyper-V firewall rule to be inactive. A Disabled rule will not actively modify system behavior, but the rule still exists on the computer so it can be re-enabled later. This is different from the Remove-NetFirewallHyperVRule cmdlet, which will permanently remove the rule. + +This cmdlet gets disables one or more Hyper-V firewall rules with the Name parameter, DisplayName parameter, or rule properties. + +Disabling Hyper-V firewall rules can be useful for debugging Hyper-V firewall policy mismatch issues. + +## EXAMPLES + +### EXAMPLE 1 +``` +PS C:\> Disable-NetFirewallHyperVRule -PolicyStore ActiveStore +``` + +This retrieves all of the Hyper-V firewall rules in the active store, which is a collection of all the policy stores that apply to the computer, and disables all of them. + +### EXAMPLE 2 +``` +PS C:\> Disable-NetFirewallHyperVRule -DisplayName 'MyServerIPBlock' +``` + +This retrieves all of the Hyper-V firewall rules with DisplayName 'MyServerIPBlock' and disables the rules. + +## PARAMETERS + +### -Action +Specifies that matching Hyper-V firewall rules of the indicated action are disabled. +The acceptable values for this parameter are: Allow or Block. + +- Allow: Network packets that match all criteria specified in this rule are permitted through the firewall. +This is the default value. +- Block: Network packets that match all criteria specified in this rule are dropped by the firewall. + +```yaml +Type: Action +Parameter Sets: (All) +Aliases: +Accepted values: NotConfigured, Allow, Block +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CimSession +Runs the cmdlet in a remote session or on a remote computer. +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. +The default is the current session on the local computer. + +```yaml +Type: CimSession[] +Parameter Sets: (All) +Aliases: Session +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Direction +Specifies that matching Hyper-V firewall rules of the indicated direction are disabled. +This parameter specifies which direction of traffic to match with this rule. +The acceptable values for this parameter are: Inbound or Outbound. + +```yaml +Type: Direction +Parameter Sets: (All) +Aliases: +Accepted values: Inbound, Outbound +Required: False +Position: Named +Default value: Inbound +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayName +Specifies that only matching Hyper-V firewall rules of the indicated display name are disabled. Wildcard characters are accepted. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +Specifies that matching Hyper-V firewall rules of the indicated state are disabled. +This parameter specifies that the rule object is administratively enabled or administratively disabled. +The acceptable values for this parameter are: +- True: Specifies the rule is currently enabled. +- False: Specifies the rule is currently disabled. + +Note, that the type of this parameter is not boolean, therefore `$true` and `$false` variables are not acceptable values here. Use "True" and "False" text strings instead. + +A disabled rule will not actively modify computer behavior, but the management construct still exists on the computer so it can be re-enabled. + +```yaml +Type: Enabled +Parameter Sets: (All) +Aliases: +Accepted values: True, False +Required: False +Position: Named +Default value: True +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnforcementStatus +Specifies that firewall rules that match the indicated enforcement status are disabled. +This parameter specifies the overall status of the rule. +- OK: Specifies that the rule will work as specified. +- PartiallyEnforced: Specifies that one or more parts of the rule will not be enforced. +- NoApplicablePorts: Specifies that the rule is functioning as expected, but there are no ports applicable for this rule and therefore is not active. +- ParsingError: Specifies that the rule is corrupted and the computer is unable to use the rule at all. +- Error: Specifies that the computer is unable to use the rule at all. + +```yaml +Type: PrimaryStatus[] +Parameter Sets: ByQuery +Aliases: +Accepted values: Unknown, OK, Inactive, Error + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + + +### -Name +Specifies that only matching Hyper-V firewall rules of the indicated name are disabled. +This name serves as the unique identifier for this rule. This parameter acts just like a file name, in that only one rule with a given name may exist in a policy store at a time. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: ID +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyStore +Targets the policy store from which to disable the rules. +A policy store is a container for firewall policy. +The acceptable values for this parameter are: +- PersistentStore: Sometimes called static rules, this store contains the persistent policy for the local computer. +This policy is not from GPOs, and has been created manually or programmatically (during application installation) on the computer. +Rules created in this store are attached to the ActiveStore and activated on the computer immediately. +- ActiveStore: This store contains the currently active policy, which is the sum of all policy stores that apply to the computer. +- SystemDefaults: This read-only store contains the default state of firewall rules. +- MDM: This store contains the rules configured via MDM. + +By default, the PersistentStore is queried. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyStoreSourceType +Specifies that Hyper-V firewall rules that match the indicated policy store source type are disabled. +This parameter value is automatically generated and should not be modified. +The acceptable values for this parameter are: +- Local: The object originates from the local store. +- MDM: The object originates from the MDM store. + +By default, the Local store is queried. + +```yaml +Type: PolicyStoreType[] +Parameter Sets: ByQuery +Aliases: +Accepted values: None, Local, MDM + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Protocol +Specifies that only matching Hyper-V firewall rules with the indicated Protocol are disabled. +The acceptable values for this parameter are: +- Protocols by number: 0-255. +- Protocols by name: TCP, UDP, ICMPv4, or ICMPv6. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ThrottleLimit +Specifies the maximum number of concurrent operations that can be established to run the cmdlet. +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. +The throttle limit applies only to the current cmdlet, not to the session or to the computer. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VMCreatorId +Specifies that only matching Hyper-V firewall rules with the specified VMCreatorId are disabled. +The format for this value is a Guid enclosed in brackets, i.e '{9E288F02-CE00-4D9E-BE2B-14CE463B0298}' + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +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). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Management.Infrastructure.CimInstance#root\StandardCimv2\NetFirewallHyperVRule +The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. +The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. + +## NOTES + +## RELATED LINKS + +[New-NetFirewallHyperVRule](./New-NetFirewallHyperVRule.md) + +[Get-NetFirewallHyperVRule](./Get-NetFirewallHyperVRule.md) + +[Disable-NetFirewallHyperVRule](./Disable-NetFirewallHyperVRule.md) + +[Remove-NetFirewallHyperVRule](./Remove-NetFirewallHyperVRule.md) + +[Rename-NetFirewallHyperVRule](./Rename-NetFirewallHyperVRule.md) + +[Set-NetFirewallHyperVRule](./Set-NetFirewallHyperVRule.md) + +[Get-NetfirewallHyperVVMCreator](./Get-NetFirewallHyperVVMCreator.md) \ No newline at end of file diff --git a/docset/winserver2022-ps/netsecurity/Enable-NetFirewallHyperVRule.md b/docset/winserver2022-ps/netsecurity/Enable-NetFirewallHyperVRule.md new file mode 100644 index 0000000000..a167f68b52 --- /dev/null +++ b/docset/winserver2022-ps/netsecurity/Enable-NetFirewallHyperVRule.md @@ -0,0 +1,329 @@ +--- +description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. +external help file: NetFirewallHyperVRule.cmdletDefinition.cdxml-help.xml +Module Name: NetSecurity +ms.date: 12/27/2016 +online version: https://docs.microsoft.com/powershell/module/netsecurity/enable-netfirewallhypervrule?view=windowsserver2022-ps&wt.mc_id=ps-gethelp +schema: 2.0.0 +title: Enable-NetFirewallHyperVRule +--- + +# Enable-NetFirewallHyperVRule + +## SYNOPSIS +Enables one or more Hyper-V firewall rules that match the specified criteria. + +## SYNTAX + +``` +Enable-NetFirewallHyperVRule [-All] [-PolicyStore ] [-CimSession ] [-ThrottleLimit ] [-AsJob] [-PassThru] [-WhatIf] [-Confirm] [] +``` + +``` +Enable-NetFirewallHyperVRule [-Name] [-PolicyStore ] [-CimSession ] [-ThrottleLimit ] [-AsJob] [-PassThru] [-WhatIf] [-Confirm] [] +``` + +``` +Enable-NetFirewallHyperVRule -DisplayName [-PolicyStore ] [-CimSession ] [-ThrottleLimit ] [-AsJob] [-PassThru] [-WhatIf] [-Confirm] [] +``` + +``` +Enable-NetFirewallHyperVRule [-Direction {Inbound | Outbound}] [-VMCreatorId ] [-Protocol ] [-Action {NotConfigured | Allow | Block}] [-Enabled {True | False}] [-EnforcementStatus {Unknown | OK | PartiallyEnforced | NoApplicablePorts | ParsingError | Error}] [-PolicyStoreSourceType {None | Local | MDM}] [-PolicyStore ] [-CimSession ] [-ThrottleLimit ] [-AsJob] [-PassThru] [-WhatIf] [-Confirm] [] +``` + +``` +Enable-NetFirewallHyperVRule -InputObject [-CimSession ] [-ThrottleLimit ] [-AsJob] [-PassThru] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +IMPORTANT NOTE: Running this cmdlet without parameters enables all Windows Hyper-V firewall rules on the target computer. Always run this cmdlet with the WhatIf parameter if you are not targeting a specific Windows Hyper-V Firewall rule. + +The **Enable-NetFirewallHyperVRule** cmdlet enables a previously disabled Hyper-V firewall rule to be active. A Disabled rule will not actively modify system behavior, but the rule still exists on the computer so it can be re-enabled later. + +This cmdlet enables one or more Hyper-V firewall rules with the Name parameter, DisplayName parameter, or rule properties. + +## EXAMPLES + +### EXAMPLE 1 +``` +PS C:\> Enable-NetFirewallHyperVRule -PolicyStore ActiveStore +``` + +This retrieves all of the Hyper-V firewall rules in the active store, which is a collection of all the policy stores that apply to the computer, and enables all of them. + +### EXAMPLE 2 +``` +PS C:\> Enable-NetFirewallHyperVRule -DisplayName 'MyServerIPBlock' +``` + +This retrieves all of the Hyper-V firewall rules with DisplayName 'MyServerIPBlock' and enables the rules. + +## PARAMETERS + +### -Action +Specifies that matching Hyper-V firewall rules of the indicated action are enable. +The acceptable values for this parameter are: Allow or Block. + +- Allow: Network packets that match all criteria specified in this rule are permitted through the firewall. +This is the default value. +- Block: Network packets that match all criteria specified in this rule are dropped by the firewall. + +```yaml +Type: Action +Parameter Sets: (All) +Aliases: +Accepted values: NotConfigured, Allow, Block +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CimSession +Runs the cmdlet in a remote session or on a remote computer. +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. +The default is the current session on the local computer. + +```yaml +Type: CimSession[] +Parameter Sets: (All) +Aliases: Session +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Direction +Specifies that matching Hyper-V firewall rules of the indicated direction are enabled. +This parameter specifies which direction of traffic to match with this rule. +The acceptable values for this parameter are: Inbound or Outbound. + +```yaml +Type: Direction +Parameter Sets: (All) +Aliases: +Accepted values: Inbound, Outbound +Required: False +Position: Named +Default value: Inbound +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayName +Specifies that only matching Hyper-V firewall rules of the indicated display name are enabled. Wildcard characters are accepted. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +Specifies that matching Hyper-V firewall rules of the indicated state are enabled. +This parameter specifies that the rule object is administratively enabled or administratively disabled. +The acceptable values for this parameter are: +- True: Specifies the rule is currently enabled. +- False: Specifies the rule is currently disabled. + +Note, that the type of this parameter is not boolean, therefore `$true` and `$false` variables are not acceptable values here. Use "True" and "False" text strings instead. + +A disabled rule will not actively modify computer behavior, but the management construct still exists on the computer so it can be re-enabled. + +```yaml +Type: Enabled +Parameter Sets: (All) +Aliases: +Accepted values: True, False +Required: False +Position: Named +Default value: True +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnforcementStatus +Specifies that firewall rules that match the indicated enforcement status are enabled. +This parameter specifies the overall status of the rule. +- OK: Specifies that the rule will work as specified. +- PartiallyEnforced: Specifies that one or more parts of the rule will not be enforced. +- NoApplicablePorts: Specifies that the rule is functioning as expected, but there are no ports applicable for this rule and therefore is not active. +- ParsingError: Specifies that the rule is corrupted and the computer is unable to use the rule at all. +- Error: Specifies that the computer is unable to use the rule at all. + +```yaml +Type: PrimaryStatus[] +Parameter Sets: ByQuery +Aliases: +Accepted values: Unknown, OK, Inactive, Error + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + + +### -Name +Specifies that only matching Hyper-V firewall rules of the indicated name are enabled. +This name serves as the unique identifier for this rule. This parameter acts just like a file name, in that only one rule with a given name may exist in a policy store at a time. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: ID +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyStore +Targets the policy store from which to enable the rules. +A policy store is a container for firewall policy. +The acceptable values for this parameter are: +- PersistentStore: Sometimes called static rules, this store contains the persistent policy for the local computer. +This policy is not from GPOs, and has been created manually or programmatically (during application installation) on the computer. +Rules created in this store are attached to the ActiveStore and activated on the computer immediately. +- ActiveStore: This store contains the currently active policy, which is the sum of all policy stores that apply to the computer. +- SystemDefaults: This read-only store contains the default state of firewall rules. +- MDM: This store contains the rules configured via MDM. + +By default, the PersistentStore is queried. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyStoreSourceType +Specifies that Hyper-V firewall rules that match the indicated policy store source type are enabled. +This parameter value is automatically generated and should not be modified. +The acceptable values for this parameter are: +- Local: The object originates from the local store. +- MDM: The object originates from the MDM store. + +By default, the Local store is queried. + +```yaml +Type: PolicyStoreType[] +Parameter Sets: ByQuery +Aliases: +Accepted values: None, Local, MDM + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Protocol +Specifies that only matching Hyper-V firewall rules with the indicated Protocol are enabled. +The acceptable values for this parameter are: +- Protocols by number: 0-255. +- Protocols by name: TCP, UDP, ICMPv4, or ICMPv6. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ThrottleLimit +Specifies the maximum number of concurrent operations that can be established to run the cmdlet. +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. +The throttle limit applies only to the current cmdlet, not to the session or to the computer. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VMCreatorId +Specifies that only matching Hyper-V firewall rules with the specified VMCreatorId are enabled. +The format for this value is a Guid enclosed in brackets, i.e '{9E288F02-CE00-4D9E-BE2B-14CE463B0298}' + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +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). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Management.Infrastructure.CimInstance#root\StandardCimv2\NetFirewallHyperVRule +The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. +The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. + +## NOTES + +## RELATED LINKS + +[New-NetFirewallHyperVRule](./New-NetFirewallHyperVRule.md) + +[Get-NetFirewallHyperVRule](./Get-NetFirewallHyperVRule.md) + +[Enable-NetFirewallHyperVRule](./Enable-NetFirewallHyperVRule.md) + +[Remove-NetFirewallHyperVRule](./Remove-NetFirewallHyperVRule.md) + +[Rename-NetFirewallHyperVRule](./Rename-NetFirewallHyperVRule.md) + +[Set-NetFirewallHyperVRule](./Set-NetFirewallHyperVRule.md) + +[Get-NetfirewallHyperVVMCreator](./Get-NetFirewallHyperVVMCreator.md) \ No newline at end of file diff --git a/docset/winserver2022-ps/netsecurity/Get-NetFirewallHyperVPort.md b/docset/winserver2022-ps/netsecurity/Get-NetFirewallHyperVPort.md new file mode 100644 index 0000000000..95c1575fb6 --- /dev/null +++ b/docset/winserver2022-ps/netsecurity/Get-NetFirewallHyperVPort.md @@ -0,0 +1,120 @@ +--- +description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. +external help file: NetFirewallHyperVPort.cmdletDefinition.cdxml-help.xml +Module Name: NetSecurity +ms.date: 12/27/2016 +online version: https://docs.microsoft.com/powershell/module/netsecurity/get-netfirewallhypervport?view=windowsserver2022-ps&wt.mc_id=ps-gethelp +schema: 2.0.0 +title: Get-NetFirewallHyperVPort +--- + +# Get-NetFirewallHyperVRule + +## SYNOPSIS +Retrieves Hyper-V firewall ports from the target computer. + +## SYNTAX + +``` +Get-NetFirewallHyperVPort [-All] [-CimSession ] [-ThrottleLimit ] [-AsJob] [] +``` + +## DESCRIPTION +The **Get-NetFirewallHyperVPort** cmdlet returns the instances of the Hyper-V firewall ports. Hyper-V firewall rules are applied on a per port basis. This cmdlet queries the active ports on the system and displays associated data about the port. + +## EXAMPLES + +### EXAMPLE 1 +``` +PS C:\> Get-NetFirewallHyperVPort +``` + +This retrieves all of the Hyper-V firewall ports that are currently on the system. + +## PARAMETERS + +### -All +Specifies that all Hyper-V firewall ports should be retrieved. + +```yaml +Type: SwitchParameter +Parameter Sets: GetAll +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CimSession +Runs the cmdlet in a remote session or on a remote computer. +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. +The default is the current session on the local computer. + +```yaml +Type: CimSession[] +Parameter Sets: (All) +Aliases: Session +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ThrottleLimit +Specifies the maximum number of concurrent operations that can be established to run the cmdlet. +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. +The throttle limit applies only to the current cmdlet, not to the session or to the computer. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +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). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Management.Infrastructure.CimInstance#root\StandardCimv2\NetFirewallHyperVPort +The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. +The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. + +## NOTES + +## RELATED LINKS + +[Get-NetfirewallHyperVRule](./Get-NetFirewallHyperVRule.md) + +[Get-NetfirewallHyperVVMCreator](./Get-NetFirewallHyperVVMCreator.md) + +[Get-NetFirewallHyperVVMSetting](./Get-NetFirewallHyperVVMSetting.md) + +[Set-NetFirewallHyperVVMSetting](./Set-NetFirewallHyperVVMSetting.md) \ No newline at end of file diff --git a/docset/winserver2022-ps/netsecurity/Get-NetFirewallHyperVRule.md b/docset/winserver2022-ps/netsecurity/Get-NetFirewallHyperVRule.md new file mode 100644 index 0000000000..4a6e162963 --- /dev/null +++ b/docset/winserver2022-ps/netsecurity/Get-NetFirewallHyperVRule.md @@ -0,0 +1,334 @@ +--- +description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. +external help file: NetFirewallHyperVRule.cmdletDefinition.cdxml-help.xml +Module Name: NetSecurity +ms.date: 12/27/2016 +online version: https://docs.microsoft.com/powershell/module/netsecurity/get-netfirewallhypervrule?view=windowsserver2022-ps&wt.mc_id=ps-gethelp +schema: 2.0.0 +title: Get-NetFirewallHyperVRule +--- + +# Get-NetFirewallHyperVRule + +## SYNOPSIS +Retrieves Hyper-V firewall rules from the target computer. + +## SYNTAX + +``` +Get-NetFirewallHyperVRule [-All] [-PolicyStore ] [-CimSession ] [-ThrottleLimit ] [-AsJob] [] +``` + +``` +Get-NetFirewallHyperVRule [-Name] [-PolicyStore ] [-CimSession ] [-ThrottleLimit ] [-AsJob] [] +``` + +``` +Get-NetFirewallHyperVRule -DisplayName [-PolicyStore ] [-CimSession ] [-ThrottleLimit ] [-AsJob] [] +``` + +``` +Get-NetFirewallHyperVRule [-Direction {Inbound | Outbound}] [-VMCreatorId ] [-Protocol ] [-Action {NotConfigured | Allow | Block}] [-Enabled {True | False}] [-EnforcementStatus {Unknown | OK | PartiallyEnforced | NoApplicablePorts | ParsingError | Error}] [-PolicyStoreSourceType {None | Local | Dynamic | Hardcoded | MDM}] [-PolicyStore ] [-CimSession ] [-ThrottleLimit ] [-AsJob] [] +``` + +## DESCRIPTION +The **Get-NetFirewallHyperVRule** cmdlet returns the instances of the Hyper-V firewall rules that match the search parameters from the user. See the New-NetFirewallHyperVrule cmdlet for more information. + +This cmdlet returns one or more Hyper-V firewall rules by specifying the Name parameter, the DisplayName parameter, or rule properties. The queried rules can be placed intro variables and piped to other cmdlets for further modifications. + +In addition to the rule parameters, a read-only field called 'PortStatuses' will be enumerated. A Hyper-V firewall rule is applied to individual Hyper-V firewall ports based on the rule parameters. This output displays all Hyper-V ports that this rule is currently applied to. + +## EXAMPLES + +### EXAMPLE 1 +``` +PS C:\> Get-NetFirewallHyperVRule -PolicyStore ActiveStore +``` + +This retrieves all of the Hyper-V firewall rules in the active store, which is a collection of all the policy stores that apply to the computer. Running this cmdlet without specifying the policy store retrieves the persistent store. + +### EXAMPLE 2 +``` +PS C:\> Get-NetFirewallHyperVRule -EnforcementStatus OK +``` + +This retrieves all of the Hyper-V firewall rules with EnforcementStatus OK, which means that the rule is active and being enforced. + +### EXAMPLE 3 +``` +PS C:\> Get-NetFirewallHyperVRule -Name 'MyRuleId' +``` + +This retrieves the Hyper-V firewall rule with the Name 'MyRuleId' + +## PARAMETERS + +### -Action +Specifies that matching Hyper-V firewall rules of the indicated action are retrieved. +The acceptable values for this parameter are: Allow or Block. + +- Allow: Network packets that match all criteria specified in this rule are permitted through the firewall. +This is the default value. +- Block: Network packets that match all criteria specified in this rule are dropped by the firewall. + +```yaml +Type: Action +Parameter Sets: (All) +Aliases: +Accepted values: NotConfigured, Allow, Block +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CimSession +Runs the cmdlet in a remote session or on a remote computer. +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. +The default is the current session on the local computer. + +```yaml +Type: CimSession[] +Parameter Sets: (All) +Aliases: Session +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Direction +Specifies that matching Hyper-V firewall rules of the indicated direction are retrieved. +This parameter specifies which direction of traffic to match with this rule. +The acceptable values for this parameter are: Inbound or Outbound. + +```yaml +Type: Direction +Parameter Sets: (All) +Aliases: +Accepted values: Inbound, Outbound +Required: False +Position: Named +Default value: Inbound +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayName +Specifies that only matching Hyper-V firewall rules of the indicated display name are retrieved. Wildcard characters are accepted. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +Specifies that matching Hyper-V firewall rules of the indicated state are retrieved. +This parameter specifies that the rule object is administratively enabled or administratively disabled. +The acceptable values for this parameter are: +- True: Specifies the rule is currently enabled. +- False: Specifies the rule is currently disabled. + +Note, that the type of this parameter is not boolean, therefore `$true` and `$false` variables are not acceptable values here. Use "True" and "False" text strings instead. + +A disabled rule will not actively modify computer behavior, but the management construct still exists on the computer so it can be re-enabled. + +```yaml +Type: Enabled +Parameter Sets: (All) +Aliases: +Accepted values: True, False +Required: False +Position: Named +Default value: True +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnforcementStatus +Specifies that firewall rules that match the indicated enforcement status are retrieved. +This parameter specifies the overall status of the rule. +- OK: Specifies that the rule will work as specified. +- PartiallyEnforced: Specifies that one or more parts of the rule will not be enforced. +- NoApplicablePorts: Specifies that the rule is functioning as expected, but there are no ports applicable for this rule and therefore is not active. +- ParsingError: Specifies that the rule is corrupted and the computer is unable to use the rule at all. +- Error: Specifies that the computer is unable to use the rule at all. + +```yaml +Type: PrimaryStatus[] +Parameter Sets: ByQuery +Aliases: +Accepted values: Unknown, OK, Inactive, Error + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + + +### -Name +Specifies that only matching Hyper-V firewall rules of the indicated name are retrieved. +This name serves as the unique identifier for this rule. This parameter acts just like a file name, in that only one rule with a given name may exist in a policy store at a time. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: ID +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyStore +Targets the policy store from which to retrieve the rules. +A policy store is a container for firewall policy. +The acceptable values for this parameter are: +- PersistentStore: Sometimes called static rules, this store contains the persistent policy for the local computer. +This policy is not from GPOs, and has been created manually or programmatically (during application installation) on the computer. +Rules created in this store are attached to the ActiveStore and activated on the computer immediately. +- ActiveStore: This store contains the currently active policy, which is the sum of all policy stores that apply to the computer. +- SystemDefaults: This read-only store contains the default state of firewall rules. +- MDM: This store contains the rules configured via MDM. + +By default, the PersistentStore is queried. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyStoreSourceType +Specifies that Hyper-V firewall rules that match the indicated policy store source type are retrieved. +This parameter value is automatically generated and should not be modified. +The acceptable values for this parameter are: +- Local: The object originates from the local store. +- MDM: The object originates from the MDM store. + +By default, the Local store is queried. + +```yaml +Type: PolicyStoreType[] +Parameter Sets: ByQuery +Aliases: +Accepted values: None, Local, MDM + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Protocol +Specifies that only matching Hyper-V firewall rules with the indicated Protocol are retrieved. +The acceptable values for this parameter are: +- Protocols by number: 0-255. +- Protocols by name: TCP, UDP, ICMPv4, or ICMPv6. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ThrottleLimit +Specifies the maximum number of concurrent operations that can be established to run the cmdlet. +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. +The throttle limit applies only to the current cmdlet, not to the session or to the computer. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VMCreatorId +Specifies that only matching Hyper-V firewall rules with the specified VMCreatorId are retrieved. +The format for this value is a GUID enclosed in brackets: '{9E288F02-CE00-4D9E-BE2B-14CE463B0298}'. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +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). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Management.Infrastructure.CimInstance#root\StandardCimv2\NetFirewallHyperVRule +The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. +The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. + +## NOTES + +## RELATED LINKS + +[New-NetFirewallHyperVRule](./New-NetFirewallHyperVRule.md) + +[Enable-NetFirewallHyperVRule](./Enable-NetFirewallHyperVRule.md) + +[Disable-NetFirewallHyperVRule](./Disable-NetFirewallHyperVRule.md) + +[Remove-NetFirewallHyperVRule](./Remove-NetFirewallHyperVRule.md) + +[Rename-NetFirewallHyperVRule](./Rename-NetFirewallHyperVRule.md) + +[Set-NetFirewallHyperVRule](./Set-NetFirewallHyperVRule.md) + +[Get-NetfirewallHyperVPort](./Get-NetFirewallHyperVPort.md) + +[Get-NetfirewallHyperVVMCreator](./Get-NetFirewallHyperVVMCreator.md) \ No newline at end of file diff --git a/docset/winserver2022-ps/netsecurity/Get-NetFirewallHyperVVMCreator.md b/docset/winserver2022-ps/netsecurity/Get-NetFirewallHyperVVMCreator.md new file mode 100644 index 0000000000..663aa55dc9 --- /dev/null +++ b/docset/winserver2022-ps/netsecurity/Get-NetFirewallHyperVVMCreator.md @@ -0,0 +1,124 @@ +--- +description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. +external help file: NetFirewallHyperVVMCreator.cmdletDefinition.cdxml-help.xml +Module Name: NetSecurity +ms.date: 12/27/2016 +online version: https://docs.microsoft.com/powershell/module/netsecurity/get-netfirewallhypervvmcreator?view=windowsserver2022-ps&wt.mc_id=ps-gethelp +schema: 2.0.0 +title: Get-NetFirewallHyperVVMCreator +--- + +# Get-NetFirewallHyperVVMCreator + +## SYNOPSIS +Retrieves Hyper-V firewall VM Creators from the target computer. + +## SYNTAX + +``` +Get-NetFirewallHyperVVMCreator [-All] [-CimSession ] [-ThrottleLimit ] [-AsJob] [] +``` + +## DESCRIPTION +The **Get-NetFirewallHyperVVMCreator** cmdlet returns the instances of the Hyper-V firewall VM creators on the system. + +A Hyper-V firewall rule can be scoped to apply only to Hyper-V firewall ports created by specific Hyper-V VM creators. This cmdlet is used to query the list of creators currently on the system. + +A rule can scoped to a specific VM creator even if it is not yet on the system. This can be useful when configuring policy when a particular application may be installed at an unknown point in time. + +## EXAMPLES + +### EXAMPLE 1 +``` +PS C:\> Get-NetFirewallHyperVVMCreator +``` + +This retrieves all of the Hyper-V firewall VM creators that are currently on the system. + +## PARAMETERS + +### -All +Specifies that all Hyper-V firewall VM creators should be retrieved. + +```yaml +Type: SwitchParameter +Parameter Sets: GetAll +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CimSession +Runs the cmdlet in a remote session or on a remote computer. +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. +The default is the current session on the local computer. + +```yaml +Type: CimSession[] +Parameter Sets: (All) +Aliases: Session +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ThrottleLimit +Specifies the maximum number of concurrent operations that can be established to run the cmdlet. +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. +The throttle limit applies only to the current cmdlet, not to the session or to the computer. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +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). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Management.Infrastructure.CimInstance#root\StandardCimv2\NetFirewallHyperVVMCreator +The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. +The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. + +## NOTES + +## RELATED LINKS + +[Get-NetfirewallHyperVRule](./Get-NetFirewallHyperVRule.md) + +[Get-NetFirewallHyperVPort](./Get-NetFirewallHyperVPort.md) + +[Get-NetFirewallHyperVVMSetting](./Get-NetFirewallHyperVVMSetting.md) + +[Set-NetFirewallHyperVVMSetting](./Set-NetFirewallHyperVVMSetting.md) \ No newline at end of file diff --git a/docset/winserver2022-ps/netsecurity/Get-NetFirewallHyperVVMSetting.md b/docset/winserver2022-ps/netsecurity/Get-NetFirewallHyperVVMSetting.md new file mode 100644 index 0000000000..1323519fab --- /dev/null +++ b/docset/winserver2022-ps/netsecurity/Get-NetFirewallHyperVVMSetting.md @@ -0,0 +1,181 @@ +--- +description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. +external help file: NetFirewallHyperVVMSetting.cmdletDefinition.cdxml-help.xml +Module Name: NetSecurity +ms.date: 12/27/2016 +online version: https://docs.microsoft.com/powershell/module/netsecurity/get-netfirewallhypervvmsetting?view=windowsserver2022-ps&wt.mc_id=ps-gethelp +schema: 2.0.0 +title: Get-NetFirewallHyperVVMSetting +--- + +# Get-NetFirewallHyperVVMSetting + +## SYNOPSIS +Retrieves Hyper-V firewall per-VM settings from the target computer. + +## SYNTAX + +``` +Get-NetFirewallHyperVVMSetting [-All] [-PolicyStore ] [-CimSession ] [-ThrottleLimit ] [-AsJob] [] +``` + +``` +Get-NetFirewallHyperVVMSetting [-Name] [-PolicyStore ] [-CimSession ] [-ThrottleLimit ] [-AsJob] [] +``` + +## DESCRIPTION +The **Get-NetFirewallHyperVVMSetting** cmdlet returns the the Hyper-V firewall per-VM settings on the system. These settings are applicable to all Hyper-V firewall ports created by a specific Hyper-V firewall VM creator. + +These settings are configurable on a per-store basis. By default, this cmdlet queries the local store. + +## EXAMPLES + +### EXAMPLE 1 +``` +PS C:\> Get-NetFirewallHyperVVMSetting +``` + +This retrieves all of the Hyper-V firewall per-VM settings. With no parameters, this cmdlet queries the settings in the local store. + +### EXAMPLE 2 +``` +PS C:\> Get-NetFirewallHyperVVMSetting -Name '{9E288F02-CE00-4D9E-BE2B-14CE463B0298}' +``` + +This retrieves all of the Hyper-V firewall per-VM settings for the specified VM creator Id. + +### EXAMPLE 3 +``` +PS C:\> Get-NetFirewallHyperVVMSetting -PolicyStore ActiveStore +``` + +This retrieves all of the Hyper-V firewall per-VM settings from the ActiveStore. + +## PARAMETERS + +### -All +Specifies that all Hyper-V firewall per-VM settings should be retrieved. + +```yaml +Type: SwitchParameter +Parameter Sets: GetAll +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CimSession +Runs the cmdlet in a remote session or on a remote computer. +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. +The default is the current session on the local computer. + +```yaml +Type: CimSession[] +Parameter Sets: (All) +Aliases: Session +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies that only matching Hyper-V firewall per-VM settings of the indicated Hyper-V firewall VM creator should be retrieved. +The format for this value is a GUID enclosed in brackets: '{9E288F02-CE00-4D9E-BE2B-14CE463B0298}'. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: VMCreatorId +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyStore +Targets the policy store from which to retrieve the rules. +A policy store is a container for firewall policy. +The acceptable values for this parameter are: +- PersistentStore: Sometimes called static rules, this store contains the persistent policy for the local computer. +This policy is not from GPOs, and has been created manually or programmatically (during application installation) on the computer. +Rules created in this store are attached to the ActiveStore and activated on the computer immediately. +- ActiveStore: This store contains the currently active policy, which is the sum of all policy stores that apply to the computer. +- MDM: This store contains the rules configured via MDM. + +By default, the PersistentStore is queried. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ThrottleLimit +Specifies the maximum number of concurrent operations that can be established to run the cmdlet. +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. +The throttle limit applies only to the current cmdlet, not to the session or to the computer. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +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). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Management.Infrastructure.CimInstance#root\StandardCimv2\NetFirewallHyperVVMSettings +The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. +The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. + +## NOTES + +## RELATED LINKS + +[Get-NetfirewallHyperVRule](./Get-NetFirewallHyperVRule.md) + +[Get-NetfirewallHyperVPort](./Get-NetFirewallHyperVPort.md) + +[Get-NetfirewallHyperVVMCreator](./Get-NetFirewallHyperVVMCreator.md) + +[New-NetFirewallHyperVVMSetting](./New-NetFirewallHyperVVMSetting.md) + +[Set-NetFirewallHyperVVMSetting](./Set-NetFirewallHyperVVMSetting.md) \ No newline at end of file diff --git a/docset/winserver2022-ps/netsecurity/New-NetFirewallHyperVRule.md b/docset/winserver2022-ps/netsecurity/New-NetFirewallHyperVRule.md new file mode 100644 index 0000000000..c7debd3090 --- /dev/null +++ b/docset/winserver2022-ps/netsecurity/New-NetFirewallHyperVRule.md @@ -0,0 +1,394 @@ +--- +description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. +external help file: NetFirewallHyperVRule.cmdletDefinition.cdxml-help.xml +Module Name: NetSecurity +ms.date: 12/27/2016 +online version: https://docs.microsoft.com/powershell/module/netsecurity/new-netfirewallhypervrule?view=windowsserver2022-ps&wt.mc_id=ps-gethelp +schema: 2.0.0 +title: New-NetFirewallHyperVRule +--- + +# New-NetFirewallHyperVRule + +## SYNOPSIS +Creates a new inbound or outbound Hyper-V firewall rule and adds the rule to the target computer. + +## SYNTAX + +``` +New-NetFirewallHyperVRule -DisplayName [-Name ] [-RulePriority ] [-Direction {Inbound | Outbound}] [-VMCreatorId ] [-Protocol ] [-LocalAddresses ] [-LocalPorts ] [-RemoteAddresses ] [-RemotePorts ] [-Action {NotConfigured | Allow | Block}] [-Enabled {True | False}] [-CimSession ] [-ThrottleLimit ] [-AsJob] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The **New-NetFirewallHyperVRule** cmdlet creates an inbound or outbound Hyper-V firewall rule and adds the rule to the target computer. + +Some parameters are used to specify the conditions that must be matched for the rule to apply, such as the *LocalAddress* and *RemoteAddress* parameters. + +Rules that already exist can be managed with the Get-NetFirewallHyperVRule and Set-NetFirewallHyperVRule cmdlets. + +## EXAMPLES + +### EXAMPLE 1 +``` +PS C:\> New-NetFirewallHyperVRule -DisplayName "Block Outbound Port 80" -Direction Outbound -LocalPorts 80 -Protocol TCP -Action Block +``` + +This example creates an outbound Hyper-V firewall rule to block all traffic from applicable Hyper-V VMs that originates on TCP port 80. + +### EXAMPLE 2 +``` +PS C:\> New-NetFirewallRule -DisplayName "Block HTTP from VM Creator" -Direction Outbound -Action Block -RemotePorts 443 -VMCreatorId '{9E288F02-CE00-4D9E-BE2B-14CE463B0298}' +``` + +This example creates an outbound Hyper-V firewall rule to block HTTP traffic from VMs created by the input ID. + +## PARAMETERS + +### -Action +Specifies that matching Hyper-V firewall rules of the indicated action are created. +This parameter specifies the action to take on traffic that matches this rule. +The acceptable values for this parameter are: Allow or Block. + +- Allow: Network packets that match all criteria specified in this rule are permitted through the firewall. +This is the default value. +- Block: Network packets that match all criteria specified in this rule are dropped by the firewall. + +The default value is Allow. + +```yaml +Type: Action +Parameter Sets: (All) +Aliases: +Accepted values: NotConfigured, Allow, Block +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CimSession +Runs the cmdlet in a remote session or on a remote computer. +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. +The default is the current session on the local computer. + +```yaml +Type: CimSession[] +Parameter Sets: (All) +Aliases: Session +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Direction +Specifies that matching Hyper-V firewall rules of the indicated direction are created. +This parameter specifies which direction of traffic to match with this rule. +The acceptable values for this parameter are: Inbound or Outbound. + +The default value is Inbound. + +```yaml +Type: Direction +Parameter Sets: (All) +Aliases: +Accepted values: Inbound, Outbound +Required: False +Position: Named +Default value: Inbound +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayName +Specifies that only matching Hyper-V firewall rules of the indicated display name are created. +Specifies the localized, user-facing name of the Hyper-V firewall rule being created. +When creating a rule this parameter is required. +This parameter value is locale-dependent. +When writing scripts in multi-lingual environments, the *Name* parameter should be used instead, where the default value is a randomly assigned value. +This parameter cannot be set to All. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +Specifies that matching Hyper-V firewall rules of the indicated state are created. +This parameter specifies that the rule object is administratively enabled or administratively disabled. +The acceptable values for this parameter are: +- True: Specifies the rule is currently enabled. +- False: Specifies the rule is currently disabled. + +Note, that the type of this parameter is not boolean, therefore `$true` and `$false` variables are not acceptable values here. Use "True" and "False" text strings instead. + +A disabled rule will not actively modify computer behavior, but the management construct still exists on the computer so it can be re-enabled. + +The default value is True. + +```yaml +Type: Enabled +Parameter Sets: (All) +Aliases: +Accepted values: True, False +Required: False +Position: Named +Default value: True +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LocalAddresses +Specifies that network packets with matching IP addresses match this rule. +This parameter value is an IPv4 or IPv6 address, hostname, subnet, or range. +The acceptable formats for this parameter are: + +- Single IPv4 Address: 1.2.3.4 +- Single IPv6 Address: fe80::1 +- IPv4 Subnet (by network bit count): 1.2.3.4/24 +- IPv6 Subnet (by network bit count): fe80::1/48 +- IPv4 Subnet (by network mask): 1.2.3.4/255.255.255.0 +- IPv4 Range: 1.2.3.4-1.2.3.7 +- IPv6 Range: fe80::1-fe80::9 + +The default value is Any. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` +### -LocalPorts +Specifies that network packets with matching IP local port numbers match this rule. +The acceptable values are: +- Port range: 0-65535 +- Port number: 80 + +The default value is Any. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies that only matching Hyper-V firewall rules of the indicated name are created. +This name serves as the unique identifier for this rule. This parameter acts just like a file name, in that only one rule with a given name may exist in a policy store at a time. + +The default value is a randomly assigned value. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: ID +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Protocol +Specifies that network packets with matching IP protocol match this rule. +The acceptable values for this parameter are: +- Protocols by number: 0-255. +- Protocols by name: TCP, UDP, ICMPv4, or ICMPv6. + +The default value is Any. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoteAddresses +Specifies that network packets with matching IP addresses match this rule. +This parameter value is an IPv4 or IPv6 address, subnet, or range. +The acceptable formats for this parameter are: + +- Single IPv4 Address: 1.2.3.4 +- Single IPv6 Address: fe80::1 +- IPv4 Subnet (by network bit count): 1.2.3.4/24 +- IPv6 Subnet (by network bit count): fe80::1/48 +- IPv4 Subnet (by network mask): 1.2.3.4/255.255.255.0 +- IPv4 Range: 1.2.3.4-1.2.3.7 +- IPv6 Range: fe80::1-fe80::9 + +The default value is Any. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemotePorts +Specifies that network packets with matching IP port numbers match this rule. +The acceptable values are: +- Port range: 0-65535 +- Port number: 80 + +The defauly value is Any. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RulePriority +Specifies the order in which rules are evaluated. A lower priority rule is evaluated before a higher priority rule. + +The default value is based on the Action of the rule. A rule with Action Allow is set to priority 2, and a rule with Action Block is 1. This configures, by default, Block rules to take precedence over Allow rules. + +```yaml +Type: uint16 +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ThrottleLimit +Specifies the maximum number of concurrent operations that can be established to run the cmdlet. +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. +The throttle limit applies only to the current cmdlet, not to the session or to the computer. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VMCreatorId +Specifies that network packets originating from a VM matching this VMCreatorId matches this rule. The format for this value is a GUID enclosed in brackets: '{9E288F02-CE00-4D9E-BE2B-14CE463B0298}'. + +The default value is Any. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +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). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Management.Infrastructure.CimInstance#root\StandardCimv2\NetFirewallHyperVRule +The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. +The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. + +## NOTES + +## RELATED LINKS + +[Get-NetFirewallHyperVRule](./Get-NetFirewallHyperVRule.md) + +[Enable-NetFirewallHyperVRule](./Enable-NetFirewallHyperVRule.md) + +[Disable-NetFirewallHyperVRule](./Disable-NetFirewallHyperVRule.md) + +[Remove-NetFirewallHyperVRule](./Remove-NetFirewallHyperVRule.md) + +[Rename-NetFirewallHyperVRule](./Rename-NetFirewallHyperVRule.md) + +[Set-NetFirewallHyperVRule](./Set-NetFirewallHyperVRule.md) + +[Get-NetfirewallHyperVVMCreator](./Get-NetFirewallHyperVVMCreator.md) \ No newline at end of file diff --git a/docset/winserver2022-ps/netsecurity/New-NetFirewallHyperVVMSetting.md b/docset/winserver2022-ps/netsecurity/New-NetFirewallHyperVVMSetting.md new file mode 100644 index 0000000000..119ea03023 --- /dev/null +++ b/docset/winserver2022-ps/netsecurity/New-NetFirewallHyperVVMSetting.md @@ -0,0 +1,219 @@ +--- +description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. +external help file: NetFirewallHyperVVMSetting.cmdletDefinition.cdxml-help.xml +Module Name: NetSecurity +ms.date: 12/27/2016 +online version: https://docs.microsoft.com/powershell/module/netsecurity/new-netfirewallhypervvmsetting?view=windowsserver2022-ps&wt.mc_id=ps-gethelp +schema: 2.0.0 +title: New-NetFirewallHyperVVMSetting +--- + +# New-NetFirewallHyperVVMSetting + +## SYNOPSIS +Configures Hyper-V firewall per-VM settings on the target computer. + +## SYNTAX + +``` +New-NetFirewallHyperVVMSetting [-PolicyStore ] [-GPOSession ] [-Name ] [-Enabled {False | True | NotConfigured}] [-DefaultInboundAction {NotConfigured | Allow | Block}] [-DefaultOutboundAction {NotConfigured | Allow | Block}] [-LoopbackEnabled {False | True | NotConfigured}] [-CimSession ] [-ThrottleLimit ] [-AsJob] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The **New-NetFirewallHyperVVMSetting** cmdlet configures settings for the Hyper-V firewall per-VM settings on the system. These settings are applicable to all Hyper-V firewall ports created by a specific Hyper-V firewall VM creator. + +This cmdlet should be used when none of the following are true: a Hyper-V VM creator has registered its VM creator ID with the system, when another Hyper-V per-VM setting is already configured for the specified VM creator ID, or when a Hyper-V firewall port is created with the specified VM creator ID. If any of the above are true, the Set-NetFirewallHyperVVMSetting cmdlet should be used. In other words, this cmdlet can be used to configure policy prior to the application corresponding to the specific VM creator ID has running on the system. + +## EXAMPLES + +### EXAMPLE 1 +``` +PS C:\> New-NetFirewallHyperVVMSetting -Name '9E288F02-CE00-4D9E-BE2B-14CE463B0298}' -LoopbackEnabled True +``` + +This configures the LoopbackEnabled setting for all Hyper-V firewall ports created by the Hyper-V firewall VM creator specified. + +## PARAMETERS + +### -AsJob +Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CimSession +Runs the cmdlet in a remote session or on a remote computer. +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. +The default is the current session on the local computer. + +```yaml +Type: CimSession[] +Parameter Sets: (All) +Aliases: Session +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultInboundAction +Specifies how to filter inbound traffic which does not match any Hyper-V firewall rules. +The acceptable values for this parameter are: NotConfigured, Allow, or Block. + +- Block: Blocks inbound network traffic that does not match an inbound rule. +- Allow: Allows all inbound network traffic, whether or not it matches an inbound rule. +- NotConfigured: Resets this value back to its default. + +The default setting is Block. + +```yaml +Type: Action +Parameter Sets: (All) +Aliases: +Accepted values: NotConfigured, Allow, Block + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultOutboundAction +Specifies how to filter outbound traffic which does not match any Hyper-V firewall rules. +The acceptable values for this parameter are: NotConfigured, Allow, or Block. + +- Block: Blocks outbound network traffic that does not match an outbound rule. +- Allow: Allows all outbound network traffic, whether or not it matches an outbound rule. +- NotConfigured: Resets this value back to its default. + +The default setting is Block. + +```yaml +Type: Action +Parameter Sets: (All) +Aliases: +Accepted values: NotConfigured, Allow, Block + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +Determines whether or not the Hyper-V firewall is active and enforced. +The acceptable values for this parameter are: False, True, or NotConfigured. + +- True: Enables Windows Hyper-V firewall. +- False: Disables Windows Hyper-V firewall. +- NotConfigured: Resets this value back to its default. + +The default setting is True. + +```yaml +Type: GpoBoolean +Parameter Sets: (All) +Aliases: +Accepted values: False, True, NotConfigured + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LoopbackEnabled +Determines whether or not guest-host loopback traffic is allowed. + +This setting is orthogonal to any existing Hyper-V firewall rules. That is, both this setting and the set of Hyper-V firewall rules must both be configured to allow guest-host communication. Furthermore, if either this setting or a Hyper-V firewall rule blocks the communication, it will be blocked. + +The acceptable values for this parameter are: False, True, or NotConfigured. + +- True: Hyper-V firewall allows traffic between guest and host. +- False: Hyper-V firewall blocks traffic between guest and host. +- NotConfigured: Resets this value back to its default. + +The default setting is False. + +```yaml +Type: GpoBoolean +Parameter Sets: (All) +Aliases: +Accepted values: False, True, NotConfigured + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies that the settings are applicable only to the Hyper-V firewall VM creator with the matching Id. +The format for this value is a GUID enclosed in brackets: '{9E288F02-CE00-4D9E-BE2B-14CE463B0298}'. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: VMCreatorId +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ThrottleLimit +Specifies the maximum number of concurrent operations that can be established to run the cmdlet. +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. +The throttle limit applies only to the current cmdlet, not to the session or to the computer. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +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). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Management.Infrastructure.CimInstance#root\StandardCimv2\NetFirewallHyperVVMSettings +The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. +The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. + +## NOTES + +## RELATED LINKS + +[Get-NetfirewallHyperVRule](./Get-NetFirewallHyperVRule.md) + +[Get-NetfirewallHyperVPort](./Get-NetFirewallHyperVPort.md) + +[Get-NetfirewallHyperVVMCreator](./Get-NetFirewallHyperVVMCreator.md) + +[Get-NetFirewallHyperVVMSetting](./Get-NetFirewallHyperVVMSetting.md) + +[Set-NetFirewallHyperVVMSetting](./Set-NetFirewallHyperVVMSetting.md) \ No newline at end of file diff --git a/docset/winserver2022-ps/netsecurity/Remove-NetFirewallHyperVRule.md b/docset/winserver2022-ps/netsecurity/Remove-NetFirewallHyperVRule.md new file mode 100644 index 0000000000..3104d876f9 --- /dev/null +++ b/docset/winserver2022-ps/netsecurity/Remove-NetFirewallHyperVRule.md @@ -0,0 +1,329 @@ +--- +description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. +external help file: NetFirewallHyperVRule.cmdletDefinition.cdxml-help.xml +Module Name: NetSecurity +ms.date: 12/27/2016 +online version: https://docs.microsoft.com/powershell/module/netsecurity/remove-netfirewallhypervrule?view=windowsserver2022-ps&wt.mc_id=ps-gethelp +schema: 2.0.0 +title: Remove-NetFirewallHyperVRule +--- + +# Remove-NetFirewallHyperVRule + +## SYNOPSIS +Deletes one or more Hyper-V firewall rules that match the specified criteria. + +## SYNTAX + +``` +Remove-NetFirewallHyperVRule [-All] [-PolicyStore ] [-CimSession ] [-ThrottleLimit ] [-AsJob] [-PassThru] [-WhatIf] [-Confirm] [] +``` + +``` +Remove-NetFirewallHyperVRule [-Name] [-PolicyStore ] [-CimSession ] [-ThrottleLimit ] [-AsJob] [-PassThru] [-WhatIf] [-Confirm] [] +``` + +``` +Remove-NetFirewallHyperVRule -DisplayName [-PolicyStore ] [-CimSession ] [-ThrottleLimit ] [-AsJob] [-PassThru] [-WhatIf] [-Confirm] [] +``` + +``` +Remove-NetFirewallHyperVRule [-Direction {Inbound | Outbound}] [-VMCreatorId ] [-Protocol ] [-Action {NotConfigured | Allow | Block}] [-Enabled {True | False}] [-EnforcementStatus {Unknown | OK | PartiallyEnforced | NoApplicablePorts | ParsingError | Error}] [-PolicyStoreSourceType {None | Local | MDM}] [-PolicyStore ] [-CimSession ] [-ThrottleLimit ] [-AsJob] [-PassThru] [-WhatIf] [-Confirm] [] +``` + +``` +Remove-NetFirewallHyperVRule -InputObject [-CimSession ] [-ThrottleLimit ] [-AsJob] [-PassThru] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +IMPORTANT NOTE: Running this cmdlet without parameters removes all Windows Hyper-V firewall rules on the target computer. Always run this cmdlet with the WhatIf parameter if you are not targeting a specific Windows Hyper-V Firewall rule. + +The **Remove-NetFirewallHyperVRule** cmdlet permanently deletes a Hyper-V firewall rule to be inactive. This is different from the Disable-NetFirewallHyperVRule cmdlet, which will only disable the rule. A Disabled rule will not actively modify system behavior, but the rule still exists on the computer so it can be re-enabled later. + +This cmdlet gets removes one or more Hyper-V firewall rules with the Name parameter, DisplayName parameter, or rule properties. + +## EXAMPLES + +### EXAMPLE 1 +``` +PS C:\> Remove-NetFirewallHyperVRule +``` + +This retrieves all of the Hyper-V firewall rules in the local store and removes all of them. + +### EXAMPLE 2 +``` +PS C:\> Remove-NetFirewallHyperVRule -DisplayName 'MyServerIPBlock' +``` + +This retrieves all of the Hyper-V firewall rules with DisplayName 'MyServerIPBlock' and removes them. + +## PARAMETERS + +### -Action +Specifies that matching Hyper-V firewall rules of the indicated action are removed. +The acceptable values for this parameter are: Allow or Block. + +- Allow: Network packets that match all criteria specified in this rule are permitted through the firewall. +This is the default value. +- Block: Network packets that match all criteria specified in this rule are dropped by the firewall. + +```yaml +Type: Action +Parameter Sets: (All) +Aliases: +Accepted values: NotConfigured, Allow, Block +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CimSession +Runs the cmdlet in a remote session or on a remote computer. +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. +The default is the current session on the local computer. + +```yaml +Type: CimSession[] +Parameter Sets: (All) +Aliases: Session +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Direction +Specifies that matching Hyper-V firewall rules of the indicated direction are removed. +This parameter specifies which direction of traffic to match with this rule. +The acceptable values for this parameter are: Inbound or Outbound. + +```yaml +Type: Direction +Parameter Sets: (All) +Aliases: +Accepted values: Inbound, Outbound +Required: False +Position: Named +Default value: Inbound +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayName +Specifies that only matching Hyper-V firewall rules of the indicated display name are removed. Wildcard characters are accepted. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +Specifies that matching Hyper-V firewall rules of the indicated state are removed. +This parameter specifies that the rule object is administratively enabled or administratively disabled. +The acceptable values for this parameter are: +- True: Specifies the rule is currently enabled. +- False: Specifies the rule is currently disabled. + +Note, that the type of this parameter is not boolean, therefore `$true` and `$false` variables are not acceptable values here. Use "True" and "False" text strings instead. + +A disabled rule will not actively modify computer behavior, but the management construct still exists on the computer so it can be re-enabled. + +```yaml +Type: Enabled +Parameter Sets: (All) +Aliases: +Accepted values: True, False +Required: False +Position: Named +Default value: True +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnforcementStatus +Specifies that firewall rules that match the indicated enforcement status are removed. +This parameter specifies the overall status of the rule. +- OK: Specifies that the rule will work as specified. +- PartiallyEnforced: Specifies that one or more parts of the rule will not be enforced. +- NoApplicablePorts: Specifies that the rule is functioning as expected, but there are no ports applicable for this rule and therefore is not active. +- ParsingError: Specifies that the rule is corrupted and the computer is unable to use the rule at all. +- Error: Specifies that the computer is unable to use the rule at all. + +```yaml +Type: PrimaryStatus[] +Parameter Sets: ByQuery +Aliases: +Accepted values: Unknown, OK, Inactive, Error + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + + +### -Name +Specifies that only matching Hyper-V firewall rules of the indicated name are removed. +This name serves as the unique identifier for this rule. This parameter acts just like a file name, in that only one rule with a given name may exist in a policy store at a time. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: ID +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyStore +Targets the policy store from which to remove the rules. +A policy store is a container for firewall policy. +The acceptable values for this parameter are: +- PersistentStore: Sometimes called static rules, this store contains the persistent policy for the local computer. +This policy is not from GPOs, and has been created manually or programmatically (during application installation) on the computer. +Rules created in this store are attached to the ActiveStore and activated on the computer immediately. +- ActiveStore: This store contains the currently active policy, which is the sum of all policy stores that apply to the computer. +- SystemDefaults: This read-only store contains the default state of firewall rules. +- MDM: This store contains the rules configured via MDM. + +By default, the PersistentStore is queried. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyStoreSourceType +Specifies that Hyper-V firewall rules that match the indicated policy store source type are removed. +This parameter value is automatically generated and should not be modified. +The acceptable values for this parameter are: +- Local: The object originates from the local store. +- MDM: The object originates from the MDM store. + +By default, the Local store is queried. + +```yaml +Type: PolicyStoreType[] +Parameter Sets: ByQuery +Aliases: +Accepted values: None, Local, MDM + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Protocol +Specifies that only matching Hyper-V firewall rules with the indicated Protocol are removed. +The acceptable values for this parameter are: +- Protocols by number: 0-255. +- Protocols by name: TCP, UDP, ICMPv4, or ICMPv6. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ThrottleLimit +Specifies the maximum number of concurrent operations that can be established to run the cmdlet. +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. +The throttle limit applies only to the current cmdlet, not to the session or to the computer. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VMCreatorId +Specifies that only matching Hyper-V firewall rules with the specified VMCreatorId are removed. +The format for this value is a Guid enclosed in brackets, i.e '{9E288F02-CE00-4D9E-BE2B-14CE463B0298}' + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +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). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Management.Infrastructure.CimInstance#root\StandardCimv2\NetFirewallHyperVRule +The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. +The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. + +## NOTES + +## RELATED LINKS + +[New-NetFirewallHyperVRule](./New-NetFirewallHyperVRule.md) + +[Get-NetFirewallHyperVRule](./Get-NetFirewallHyperVRule.md) + +[Enable-NetFirewallHyperVRule](./Enable-NetFirewallHyperVRule.md) + +[Disable-NetFirewallHyperVRule](./Disable-NetFirewallHyperVRule.md) + +[Rename-NetFirewallHyperVRule](./Rename-NetFirewallHyperVRule.md) + +[Set-NetFirewallHyperVRule](./Set-NetFirewallHyperVRule.md) + +[Get-NetfirewallHyperVVMCreator](./Get-NetFirewallHyperVVMCreator.md) \ No newline at end of file diff --git a/docset/winserver2022-ps/netsecurity/Rename-NetFirewallHyperVRule.md b/docset/winserver2022-ps/netsecurity/Rename-NetFirewallHyperVRule.md new file mode 100644 index 0000000000..19a1c4e977 --- /dev/null +++ b/docset/winserver2022-ps/netsecurity/Rename-NetFirewallHyperVRule.md @@ -0,0 +1,340 @@ +--- +description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. +external help file: NetFirewallHyperVRule.cmdletDefinition.cdxml-help.xml +Module Name: NetSecurity +ms.date: 12/27/2016 +online version: https://docs.microsoft.com/powershell/module/netsecurity/rename-netfirewallhypervrule?view=windowsserver2022-ps&wt.mc_id=ps-gethelp +schema: 2.0.0 +title: Rename-NetFirewallHyperVRule +--- + +# Rename-NetFirewallHyperVRule + +## SYNOPSIS +Renames a single Hyper-V firewall rule. + +## SYNTAX + +``` +Rename-NetFirewallHyperVRule -NewName [-All] [-PolicyStore ] [-CimSession ] [-ThrottleLimit ] [-AsJob] [-PassThru] [-WhatIf] [-Confirm] [] +``` + +``` +Rename-NetFirewallHyperVRule [-Name] -NewName [-PolicyStore ] [-CimSession ] [-ThrottleLimit ] [-AsJob] [-PassThru] [-WhatIf] [-Confirm] [] +``` + +``` +Rename-NetFirewallHyperVRule -DisplayName -NewName [-PolicyStore ] [-CimSession ] [-ThrottleLimit ] [-AsJob] [-PassThru] [-WhatIf] [-Confirm] [] +``` + +``` +Rename-NetFirewallHyperVRule -NewName [-Direction {Inbound | Outbound}] [-VMCreatorId ] [-Protocol ] [-Action {NotConfigured | Allow | Block}] [-Enabled {True | False}] [-EnforcementStatus {Unknown | OK | PartiallyEnforced | NoApplicablePorts | ParsingError | Error}] [-PolicyStoreSourceType {None | Local | MDM}] [-PolicyStore ] [-CimSession ] [-ThrottleLimit ] [-AsJob] [-PassThru] [-WhatIf] [-Confirm] [] +``` + +``` +Rename-NetFirewallHyperVRule -InputObject -NewName [-CimSession ] [-ThrottleLimit ] [-AsJob] [-PassThru] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The **Rename-NetFirewallHyperVRule** cmdlet renames an existing Hyper-V firewall rule. When creating a rule, if the Name parameter is not specified, then a random GUID is used. This cmdlet specifies a friendly and descriptive rule name. The newly specified name, using the NewName parameter, must still be unique since it identifies a single rule object on the computer. + +This cmdlet gets renames the Hyper-V firewall rule with the Name parameter, DisplayName parameter, or rule properties. Only one Hyper-V firewall rule can be renamed at a time. + +To modify the DisplayName parameter, run the Set-NetFirewallHyperVRule cmdlet with the NewDisplayName parameter. + +The names are unique identifiers for rules, similar to file names. Each name must be unique within a given policy store. + +## EXAMPLES + +### EXAMPLE 1 +``` +PS C:\> Rename-NetFirewallHyperVRule -Name "{ed8384a9-a78b-4d0d-8f3d-eb5615edb4a0}" -NewName "Contoso-Out-TCP-Block" +``` + +This example renames a Hyper-V firewall rule so that the identifier is descriptive and user friendly. + +## PARAMETERS + +### -Action +Specifies that matching Hyper-V firewall rules of the indicated action are renamed. +The acceptable values for this parameter are: Allow or Block. + +- Allow: Network packets that match all criteria specified in this rule are permitted through the firewall. +This is the default value. +- Block: Network packets that match all criteria specified in this rule are dropped by the firewall. + +```yaml +Type: Action +Parameter Sets: (All) +Aliases: +Accepted values: NotConfigured, Allow, Block +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CimSession +Runs the cmdlet in a remote session or on a remote computer. +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. +The default is the current session on the local computer. + +```yaml +Type: CimSession[] +Parameter Sets: (All) +Aliases: Session +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Direction +Specifies that matching Hyper-V firewall rules of the indicated direction are renamed. +This parameter specifies which direction of traffic to match with this rule. +The acceptable values for this parameter are: Inbound or Outbound. + +```yaml +Type: Direction +Parameter Sets: (All) +Aliases: +Accepted values: Inbound, Outbound +Required: False +Position: Named +Default value: Inbound +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayName +Specifies that only matching Hyper-V firewall rules of the indicated display name are renamed. Wildcard characters are accepted. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +Specifies that matching Hyper-V firewall rules of the indicated state are renamed. +This parameter specifies that the rule object is administratively enabled or administratively disabled. +The acceptable values for this parameter are: +- True: Specifies the rule is currently enabled. +- False: Specifies the rule is currently disabled. + +Note, that the type of this parameter is not boolean, therefore `$true` and `$false` variables are not acceptable values here. Use "True" and "False" text strings instead. + +A disabled rule will not actively modify computer behavior, but the management construct still exists on the computer so it can be re-enabled. + +```yaml +Type: Enabled +Parameter Sets: (All) +Aliases: +Accepted values: True, False +Required: False +Position: Named +Default value: True +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnforcementStatus +Specifies that firewall rules that match the indicated enforcement status are renamed. +This parameter specifies the overall status of the rule. +- OK: Specifies that the rule will work as specified. +- PartiallyEnforced: Specifies that one or more parts of the rule will not be enforced. +- NoApplicablePorts: Specifies that the rule is functioning as expected, but there are no ports applicable for this rule and therefore is not active. +- ParsingError: Specifies that the rule is corrupted and the computer is unable to use the rule at all. +- Error: Specifies that the computer is unable to use the rule at all. + +```yaml +Type: PrimaryStatus[] +Parameter Sets: ByQuery +Aliases: +Accepted values: Unknown, OK, Inactive, Error + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + + +### -Name +Specifies that only matching Hyper-V firewall rules of the indicated name are renamed. +This name serves as the unique identifier for this rule. This parameter acts just like a file name, in that only one rule with a given name may exist in a policy store at a time. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: ID +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + + +### -NewName +Specifies the new name for the Hyper-V firewall rule. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyStore +Targets the policy store from which to rename the rules. +A policy store is a container for firewall policy. +The acceptable values for this parameter are: +- PersistentStore: Sometimes called static rules, this store contains the persistent policy for the local computer. +This policy is not from GPOs, and has been created manually or programmatically (during application installation) on the computer. +Rules created in this store are attached to the ActiveStore and activated on the computer immediately. +- ActiveStore: This store contains the currently active policy, which is the sum of all policy stores that apply to the computer. +- SystemDefaults: This read-only store contains the default state of firewall rules. +- MDM: This store contains the rules configured via MDM. + +By default, the PersistentStore is queried. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyStoreSourceType +Specifies that Hyper-V firewall rules that match the indicated policy store source type are renamed. +This parameter value is automatically generated and should not be modified. +The acceptable values for this parameter are: +- Local: The object originates from the local store. +- MDM: The object originates from the MDM store. + +By default, the Local store is queried. + +```yaml +Type: PolicyStoreType[] +Parameter Sets: ByQuery +Aliases: +Accepted values: None, Local, MDM + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Protocol +Specifies that only matching Hyper-V firewall rules with the indicated Protocol are renamed. +The acceptable values for this parameter are: +- Protocols by number: 0-255. +- Protocols by name: TCP, UDP, ICMPv4, or ICMPv6. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ThrottleLimit +Specifies the maximum number of concurrent operations that can be established to run the cmdlet. +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. +The throttle limit applies only to the current cmdlet, not to the session or to the computer. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VMCreatorId +Specifies that only matching Hyper-V firewall rules with the specified VMCreatorId are renamed. +The format for this value is a Guid enclosed in brackets, i.e '{9E288F02-CE00-4D9E-BE2B-14CE463B0298}' + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +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). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Management.Infrastructure.CimInstance#root\StandardCimv2\NetFirewallHyperVRule +The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. +The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. + +## NOTES + +## RELATED LINKS + +[New-NetFirewallHyperVRule](./New-NetFirewallHyperVRule.md) + +[Get-NetFirewallHyperVRule](./Get-NetFirewallHyperVRule.md) + +[Enable-NetFirewallHyperVRule](./Enable-NetFirewallHyperVRule.md) + +[Disable-NetFirewallHyperVRule](./Disable-NetFirewallHyperVRule.md) + +[Remove-NetFirewallHyperVRule](./Remove-NetFirewallHyperVRule.md) + +[Set-NetFirewallHyperVRule](./Set-NetFirewallHyperVRule.md) + +[Get-NetfirewallHyperVVMCreator](./Get-NetFirewallHyperVVMCreator.md) \ No newline at end of file diff --git a/docset/winserver2022-ps/netsecurity/Set-NetFirewallHyperVRule.md b/docset/winserver2022-ps/netsecurity/Set-NetFirewallHyperVRule.md new file mode 100644 index 0000000000..201dd4e29f --- /dev/null +++ b/docset/winserver2022-ps/netsecurity/Set-NetFirewallHyperVRule.md @@ -0,0 +1,386 @@ +--- +description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. +external help file: NetFirewallHyperVRule.cmdletDefinition.cdxml-help.xml +Module Name: NetSecurity +ms.date: 12/27/2016 +online version: https://docs.microsoft.com/powershell/module/netsecurity/set-netfirewallhypervrule?view=windowsserver2022-ps&wt.mc_id=ps-gethelp +schema: 2.0.0 +title: Set-NetFirewallHyperVRule +--- + +# Set-NetFirewallHyperVRule + +## SYNOPSIS +Modifies existing Hyper-V firewall rules. + +## SYNTAX + +``` +Set-NetFirewallHyperVRule [-Name] [-NewDisplayName ] [-RulePriority ] [-Direction {Inbound | Outbound}] [-VMCreatorId ] [-Protocol ] [-LocalAddresses ] [-LocalPorts ] [-RemoteAddresses ] [-RemotePorts ] [-Action {NotConfigured | Allow | Block}] [-Enabled {True | False}] [-CimSession ] [-ThrottleLimit +] [-AsJob] [-PassThru] [-WhatIf] [-Confirm] [] +``` + +``` +Set-NetFirewallHyperVRule -DisplayName [-NewDisplayName ] [-RulePriority ] [-Direction {Inbound | Outbound}] [-VMCreatorId ] [-Protocol ] [-LocalAddresses ] [-LocalPorts ] [-RemoteAddresses ] [-RemotePorts ] [-Action {NotConfigured | Allow | Block}] [-Enabled {True | False}] [-CimSession ] [-ThrottleLimit ] [-AsJob] [-PassThru] [-WhatIf] [-Confirm] [] +``` + +``` +Set-NetFirewallHyperVRule -InputObject [-NewDisplayName ] [-RulePriority ] [-Direction {Inbound | Outbound}] [-VMCreatorId ] [-Protocol ] [-LocalAddresses ] [-LocalPorts ] [-RemoteAddresses ] [-RemotePorts ] [-Action {NotConfigured | Allow | Block}] [-Enabled {True | False}] [-CimSession ] [-ThrottleLimit ] [-AsJob] [-PassThru] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The **Set-NetFirewallHyperVRule** cmdlet modifies existing Hyper-V firewall rule properties. This cmdlet gets one or more rules to be modified using the *Name* parameter or the *DisplayName* parameter. + +Rules cannot be queried by property in this cmdlet, but the querying can be done by the Get-NetFirewallHyperVRule cmdlet and piped into this cmdlet. The remaining parameters modify the properties of the specified rules. + +## EXAMPLES + +### EXAMPLE 1 +``` +PS C:\> Set-NetFirewallHyperVRule -Name DisplayName "Block Outbound to My Servers" -RemoteAddresses "10.0.0.0/32" +``` + +This example modifies the existing Hyper-V firewall rules with DisplayName "Block Outbound to My Servers" and updates the RemoteAddresses condition. + +## PARAMETERS + +### -Action +Updates the Action value for the matching Hyper-V firewall rules. +This parameter specifies the action to take on traffic that matches this rule. +The acceptable values for this parameter are: Allow or Block. + +- Allow: Network packets that match all criteria specified in this rule are permitted through the firewall. +This is the default value. +- Block: Network packets that match all criteria specified in this rule are dropped by the firewall. + +```yaml +Type: Action +Parameter Sets: (All) +Aliases: +Accepted values: NotConfigured, Allow, Block +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CimSession +Runs the cmdlet in a remote session or on a remote computer. +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. +The default is the current session on the local computer. + +```yaml +Type: CimSession[] +Parameter Sets: (All) +Aliases: Session +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Direction +Updates the Direction value for the matching Hyper-V firewall rules. +This parameter specifies which direction of traffic to match with this rule. +The acceptable values for this parameter are: Inbound or Outbound. + +```yaml +Type: Direction +Parameter Sets: (All) +Aliases: +Accepted values: Inbound, Outbound +Required: False +Position: Named +Default value: Inbound +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayName +Specifies that only matching Hyper-V firewall rules of the indicated display name are updated. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +Updates the Enabled value of the matching Hyper-V firewall rules. +This parameter specifies that the rule object is administratively enabled or administratively disabled. +The acceptable values for this parameter are: +- True: Specifies the rule is currently enabled. +- False: Specifies the rule is currently disabled. + +Note, that the type of this parameter is not boolean, therefore `$true` and `$false` variables are not acceptable values here. Use "True" and "False" text strings instead. + +A disabled rule will not actively modify computer behavior, but the management construct still exists on the computer so it can be re-enabled. + +```yaml +Type: Enabled +Parameter Sets: (All) +Aliases: +Accepted values: True, False +Required: False +Position: Named +Default value: True +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LocalAddresses +Updates the LocalAddresses value for the matching Hyper-V firewall rules. +This parameter specifies that network packets with matching IP addresses match this rule. +This parameter value is an IPv4 or IPv6 address, hostname, subnet, or range. +The acceptable formats for this parameter are: + +- Single IPv4 Address: 1.2.3.4 +- Single IPv6 Address: fe80::1 +- IPv4 Subnet (by network bit count): 1.2.3.4/24 +- IPv6 Subnet (by network bit count): fe80::1/48 +- IPv4 Subnet (by network mask): 1.2.3.4/255.255.255.0 +- IPv4 Range: 1.2.3.4-1.2.3.7 +- IPv6 Range: fe80::1-fe80::9 + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` +### -LocalPorts +Updates the LocalPorts avlue for the matching Hyper-V firewall rules. +This parameter specifies that network packets with matching IP local port numbers match this rule. +The acceptable values are: +- Port range: 0-65535 +- Port number: 80 + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies that only matching Hyper-V firewall rules of the indicated Name are updated. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: ID +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NewDisplayName +Updates the DisplayName of the matching Hyper-V firewall rules. + +```yaml +Type: String +Parameter Sets: (All) +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Protocol +Updates the Protocol value of the matching Hyper-V firewall rules. +This parameter specifies that network packets with matching IP protocol match this rule. +The acceptable values for this parameter are: +- Protocols by number: 0-255. +- Protocols by name: TCP, UDP, ICMPv4, or ICMPv6. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoteAddresses +Updates the RemoteAddresses value of the matching Hyper-V firewall rules. +This parameter specifies that network packets with matching IP addresses match this rule. +This parameter value is an IPv4 or IPv6 address, subnet, or range. +The acceptable formats for this parameter are: + +- Single IPv4 Address: 1.2.3.4 +- Single IPv6 Address: fe80::1 +- IPv4 Subnet (by network bit count): 1.2.3.4/24 +- IPv6 Subnet (by network bit count): fe80::1/48 +- IPv4 Subnet (by network mask): 1.2.3.4/255.255.255.0 +- IPv4 Range: 1.2.3.4-1.2.3.7 +- IPv6 Range: fe80::1-fe80::9 + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemotePorts +Updates the RemotePorts value of the matching Hyper-V firewall rules. +This parameter specifies that network packets with matching IP port numbers match this rule. +The acceptable values are: +- Port range: 0-65535 +- Port number: 80 + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RulePriority +Updates the RulePriority value of the matching Hyper-V firewall rules. +This parameter specifies the order in which rules are evaluated. A lower priority rule is evaluated before a higher priority rule. + +```yaml +Type: uint16 +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ThrottleLimit +Specifies the maximum number of concurrent operations that can be established to run the cmdlet. +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. +The throttle limit applies only to the current cmdlet, not to the session or to the computer. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VMCreatorId +Updates the VMCreatorId value of the matching Hyper-V firewall rules. +This parameter specifies that network packets originating from a VM matching this VMCreatorId matches this rule. The format for this value is a GUID enclosed in brackets: '{9E288F02-CE00-4D9E-BE2B-14CE463B0298}'. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +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). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Management.Infrastructure.CimInstance#root\StandardCimv2\NetFirewallHyperVRule +The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. +The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. + +## NOTES + +## RELATED LINKS + +[New-NetFirewallHyperVRule](./New-NetFirewallHyperVRule.md) + +[Get-NetFirewallHyperVRule](./Get-NetFirewallHyperVRule.md) + +[Enable-NetFirewallHyperVRule](./Enable-NetFirewallHyperVRule.md) + +[Disable-NetFirewallHyperVRule](./Disable-NetFirewallHyperVRule.md) + +[Remove-NetFirewallHyperVRule](./Remove-NetFirewallHyperVRule.md) + +[Rename-NetFirewallHyperVRule](./Rename-NetFirewallHyperVRule.md) + +[Get-NetfirewallHyperVVMCreator](./Get-NetFirewallHyperVVMCreator.md) \ No newline at end of file diff --git a/docset/winserver2022-ps/netsecurity/Set-NetFirewallHyperVVMSetting.md b/docset/winserver2022-ps/netsecurity/Set-NetFirewallHyperVVMSetting.md new file mode 100644 index 0000000000..4cea4b68ce --- /dev/null +++ b/docset/winserver2022-ps/netsecurity/Set-NetFirewallHyperVVMSetting.md @@ -0,0 +1,223 @@ +--- +description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. +external help file: NetFirewallHyperVVMSetting.cmdletDefinition.cdxml-help.xml +Module Name: NetSecurity +ms.date: 12/27/2016 +online version: https://docs.microsoft.com/powershell/module/netsecurity/set-netfirewallhypervvmsetting?view=windowsserver2022-ps&wt.mc_id=ps-gethelp +schema: 2.0.0 +title: Set-NetFirewallHyperVVMSetting +--- + +# Set-NetFirewallHyperVVMSetting + +## SYNOPSIS +Configures Hyper-V firewall per-VM settings on the target computer. + +## SYNTAX + +``` +Set-NetFirewallHyperVVMSetting [-Name] [-Enabled {False | True | NotConfigured}] [-DefaultInboundAction {NotConfigured | Allow | Block}] [-DefaultOutboundAction {NotConfigured | Allow | Block}] [-LoopbackEnabled {False | True | NotConfigured}] [-CimSession ] [-ThrottleLimit ] [-AsJob] [-PassThru] [-WhatIf] [-Confirm] [] +``` + +``` +Set-NetFirewallHyperVVMSetting -InputObject [-Enabled {False | True | NotConfigured}] [-DefaultInboundAction {NotConfigured | Allow | Block}] [-DefaultOutboundAction {NotConfigured | Allow | Block}] [-LoopbackEnabled {False | True | NotConfigured}] [-CimSession ] [-ThrottleLimit ] [-AsJob] [-PassThru] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The **Set-NetFirewallHyperVVMSetting** cmdlet configures settings for the Hyper-V firewall per-VM settings on the system. These settings are applicable to all Hyper-V firewall ports created by a specific Hyper-V firewall VM creator. + +This cmdlet should be used when a Hyper-V VM creator has registered its VM creator ID with the system, when another Hyper-V per-VM setting is already configured for the specified VM creator ID, or when a Hyper-V firewall port is created with the specified VM creator ID. If none of the above are true, then the New-NetFirewallHyperVVMSetting cmdlet should be used. + +## EXAMPLES + +### EXAMPLE 1 +``` +PS C:\> Set-NetFirewallHyperVVMSetting -Name '9E288F02-CE00-4D9E-BE2B-14CE463B0298}' -LoopbackEnabled True +``` + +This updates the LoopbackEnabled setting for all Hyper-V firewall ports created by the Hyper-V firewall VM creator specified. + +## PARAMETERS + +### -AsJob +Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CimSession +Runs the cmdlet in a remote session or on a remote computer. +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. +The default is the current session on the local computer. + +```yaml +Type: CimSession[] +Parameter Sets: (All) +Aliases: Session +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultInboundAction +Specifies how to filter inbound traffic which does not match any Hyper-V firewall rules. +The acceptable values for this parameter are: NotConfigured, Allow, or Block. + +- Block: Blocks inbound network traffic that does not match an inbound rule. +- Allow: Allows all inbound network traffic, whether or not it matches an inbound rule. +- NotConfigured: Resets this value back to its default. + +The default setting is Block. + +```yaml +Type: Action +Parameter Sets: (All) +Aliases: +Accepted values: NotConfigured, Allow, Block + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultOutboundAction +Specifies how to filter outbound traffic which does not match any Hyper-V firewall rules. +The acceptable values for this parameter are: NotConfigured, Allow, or Block. + +- Block: Blocks outbound network traffic that does not match an outbound rule. +- Allow: Allows all outbound network traffic, whether or not it matches an outbound rule. +- NotConfigured: Resets this value back to its default. + +The default setting is Block. + +```yaml +Type: Action +Parameter Sets: (All) +Aliases: +Accepted values: NotConfigured, Allow, Block + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +Determines whether or not the Hyper-V firewall is active and enforced. +The acceptable values for this parameter are: False, True, or NotConfigured. + +- True: Enables Windows Hyper-V firewall. +- False: Disables Windows Hyper-V firewall. +- NotConfigured: Resets this value back to its default. + +The default setting is True. + +```yaml +Type: GpoBoolean +Parameter Sets: (All) +Aliases: +Accepted values: False, True, NotConfigured + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LoopbackEnabled +Determines whether or not guest-host loopback traffic is allowed. + +This setting is orthogonal to any existing Hyper-V firewall rules. That is, both this setting and the set of Hyper-V firewall rules must both be configured to allow guest-host communication. Furthermore, if either this setting or a Hyper-V firewall rule blocks the communication, it will be blocked. + +The acceptable values for this parameter are: False, True, or NotConfigured. + +- True: Hyper-V firewall allows traffic between guest and host. +- False: Hyper-V firewall blocks traffic between guest and host. +- NotConfigured: Resets this value back to its default. + +The default setting is False. + +```yaml +Type: GpoBoolean +Parameter Sets: (All) +Aliases: +Accepted values: False, True, NotConfigured + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies that the settings are applicable only to the Hyper-V firewall VM creator with the matching Id. +The format for this value is a GUID enclosed in brackets: '{9E288F02-CE00-4D9E-BE2B-14CE463B0298}'. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: VMCreatorId +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ThrottleLimit +Specifies the maximum number of concurrent operations that can be established to run the cmdlet. +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. +The throttle limit applies only to the current cmdlet, not to the session or to the computer. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +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). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Management.Infrastructure.CimInstance#root\StandardCimv2\NetFirewallHyperVVMSettings +The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. +The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. + +## NOTES + +## RELATED LINKS + +[Get-NetfirewallHyperVRule](./Get-NetFirewallHyperVRule.md) + +[Get-NetfirewallHyperVPort](./Get-NetFirewallHyperVPort.md) + +[Get-NetfirewallHyperVVMCreator](./Get-NetFirewallHyperVVMCreator.md) + +[Get-NetFirewallHyperVVMSetting](./Get-NetFirewallHyperVVMSetting.md) + +[New-NetFirewallHyperVVMSetting](./New-NetFirewallHyperVVMSetting.md) \ No newline at end of file From d17ada64ba145029df12b021acfca61d52c48b9f Mon Sep 17 00:00:00 2001 From: Paul Huijbregts <30799281+pahuijbr@users.noreply.github.com> Date: Tue, 27 Sep 2022 11:30:40 -0700 Subject: [PATCH 005/650] Update Set-MpPreference.md --- docset/winserver2022-ps/defender/Set-MpPreference.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/defender/Set-MpPreference.md b/docset/winserver2022-ps/defender/Set-MpPreference.md index 2689fbf284..0a89cc1fcf 100644 --- a/docset/winserver2022-ps/defender/Set-MpPreference.md +++ b/docset/winserver2022-ps/defender/Set-MpPreference.md @@ -654,7 +654,7 @@ Accept wildcard characters: False ``` ### -DisableScanningNetworkFiles -Indicates whether to scan for network files. If you specify a value of $False or do not specify a value, Windows Defender scans network files. If you specify a value of $True, Windows Defender does not scan network files. We do not recommend that you scan network files. +Indicates whether to scan for network files. If you specify a value of $False or do not specify a value, Windows Defender scans network files. If you specify a value of $True, Windows Defender does not scan network files. ```yaml Type: Boolean From ff11111eed7a77c50257af725803508d81724dba Mon Sep 17 00:00:00 2001 From: Rutuja Shirali Date: Tue, 11 Oct 2022 12:31:35 -0700 Subject: [PATCH 006/650] Update Set-DnsServerRecursion.md --- docset/winserver2022-ps/dnsserver/Set-DnsServerRecursion.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docset/winserver2022-ps/dnsserver/Set-DnsServerRecursion.md b/docset/winserver2022-ps/dnsserver/Set-DnsServerRecursion.md index a37b5b25b4..4ad3c8433d 100644 --- a/docset/winserver2022-ps/dnsserver/Set-DnsServerRecursion.md +++ b/docset/winserver2022-ps/dnsserver/Set-DnsServerRecursion.md @@ -29,7 +29,7 @@ Recursion occurs when a DNS server queries other DNS servers on behalf of a requ ### Example 1: Set the retry interval ``` -PS C:\> Set-DnsServerRecursion -RetryInterval 3 -PassThru +PS C:\> Set-DnsServerRecursion -RetryInterval 15 -PassThru Enable : False AdditionalTimeout(s) : 4 @@ -38,7 +38,7 @@ Timeout(s) : 8 SecureResponse : True ``` -This command sets the retry interval to 3 seconds. +This command sets the retry interval to 15 seconds. ## PARAMETERS @@ -219,7 +219,7 @@ Accept wildcard characters: False ### -Timeout Specifies the number of seconds that a DNS server waits before it stops trying to contact a remote server. The valid value is in the range of 0x1 to 0xFFFFFFFF (1 second to 15 seconds). -The default setting is 0xF (15 seconds). +The default setting is 0x8 (8 seconds). We recommend that you increase this value when recursion occurs over a slow link. ```yaml From 330c3163c56622dcb1401a18fba81b4b4ea8ae0c Mon Sep 17 00:00:00 2001 From: Nathan Bills Date: Fri, 21 Oct 2022 16:42:16 -0700 Subject: [PATCH 007/650] Update New-CIPolicy.md Fixing a typo (pretty sure) :) --- docset/winserver2022-ps/configci/New-CIPolicy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/configci/New-CIPolicy.md b/docset/winserver2022-ps/configci/New-CIPolicy.md index 87b1b0492d..23254261bb 100644 --- a/docset/winserver2022-ps/configci/New-CIPolicy.md +++ b/docset/winserver2022-ps/configci/New-CIPolicy.md @@ -36,7 +36,7 @@ New-CIPolicy [-FilePath] -Rules [-Audit] [-ScanPath ] The **New-CIPolicy** cmdlet creates a Code Integrity policy as an .xml file. If you specify **DriverFile** objects, this cmdlet generates rules based on the **Level** parameter. -This cmdlet creates a policy based on those rules for the specified drive files. +This cmdlet creates a policy based on those rules for the specified driver files. If you specify **Rule** objects, this cmdlet creates a policy based on those objects. Because the rules that you specify are created at a specific level, do not specify a level. From 9b66e5de68a29994901c6f143d48dc289debb1c6 Mon Sep 17 00:00:00 2001 From: Lindsay <45809756+lindspea@users.noreply.github.com> Date: Wed, 16 Nov 2022 08:36:13 +0200 Subject: [PATCH 008/650] Update Format-SecureBootUEFI.md Fixed typo --- docset/winserver2022-ps/secureboot/Format-SecureBootUEFI.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/secureboot/Format-SecureBootUEFI.md b/docset/winserver2022-ps/secureboot/Format-SecureBootUEFI.md index 905798e824..f386d27542 100644 --- a/docset/winserver2022-ps/secureboot/Format-SecureBootUEFI.md +++ b/docset/winserver2022-ps/secureboot/Format-SecureBootUEFI.md @@ -38,7 +38,7 @@ The **Format-SecureBootUEFI** cmdlet receives certificates or hashes as input an The Set-SecureBootUEFI cmdlet uses this object to update the variable. If you specify a signable file, this cmdlet creates a file that has the specified name that has to be signed. -This cmdlet this runs on both UEFI and BIOS (non-UEFI) computers. +This cmdlet runs on both UEFI and BIOS (non-UEFI) computers. ## EXAMPLES From 5735eed173460076e05e1d2723cd062ebe7382e1 Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Fri, 18 Nov 2022 09:46:28 +0530 Subject: [PATCH 009/650] Update Add-OdbcDsn.md Made changes to Example 4 as the variable used was incorrect --- docset/winserver2022-ps/wdac/Add-OdbcDsn.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/wdac/Add-OdbcDsn.md b/docset/winserver2022-ps/wdac/Add-OdbcDsn.md index f854da66bb..e75c12b3bc 100644 --- a/docset/winserver2022-ps/wdac/Add-OdbcDsn.md +++ b/docset/winserver2022-ps/wdac/Add-OdbcDsn.md @@ -58,7 +58,7 @@ Without *PassThru*, the cmdlet does not return anything. ### Example 4: Migrates DSNs to a newer version of a driver ``` PS C:\> $DsnArray = Get-OdbcDsn -DriverName 'SQL Server Native Client 10.0' -PS C:\> ForEach ($Dsn in $ DsnArr) { +PS C:\> ForEach ($Dsn in $ DsnArray) { Remove-OdbcDsn -InputObject $Dsn # You can change the property array as well, # if DSN attributes have been changed in the new driver version From fdac87ba3241219aa607ecb02171c707f36ff4f9 Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Fri, 18 Nov 2022 12:23:40 +0530 Subject: [PATCH 010/650] Update New-ADUser.md Updated LDAP display name for Office --- docset/winserver2022-ps/activedirectory/New-ADUser.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/activedirectory/New-ADUser.md b/docset/winserver2022-ps/activedirectory/New-ADUser.md index 58104af6b3..aed3b4a952 100644 --- a/docset/winserver2022-ps/activedirectory/New-ADUser.md +++ b/docset/winserver2022-ps/activedirectory/New-ADUser.md @@ -842,7 +842,7 @@ Accept wildcard characters: False ### -Office Specifies the location of the user's office or place of business. This parameter sets the **Office** property of a user object. -The LDAP display name (**ldapDisplayName**) of this property is office. +The LDAP display name (**ldapDisplayName**) of this property is physicalDeliveryOfficeName. ```yaml Type: String From 5b80b43110fa334405d3801c6a18affc37a5f54a Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Fri, 18 Nov 2022 17:33:56 +0530 Subject: [PATCH 011/650] Update Set-NetTCPSetting.md Updated description for AutoReusePortRangeStartPort --- docset/winserver2022-ps/nettcpip/Set-NetTCPSetting.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/nettcpip/Set-NetTCPSetting.md b/docset/winserver2022-ps/nettcpip/Set-NetTCPSetting.md index 4683d44548..bd71122cfc 100644 --- a/docset/winserver2022-ps/nettcpip/Set-NetTCPSetting.md +++ b/docset/winserver2022-ps/nettcpip/Set-NetTCPSetting.md @@ -104,7 +104,9 @@ Accept wildcard characters: False ``` ### -AutoReusePortRangeStartPort -Specifies the number of ports for the auto-reuse port range, which is a port range used for local ephemeral port selection by outbound TCP connections for which either SO_REUSE_UNICASTPORT has been set on the socket, or for which connect() has been called without calling bind() on the socket. +Specifies the starting port for the auto-reuse port range. + +This parameter sets the starting port to send and receive TCP traffic, which is a port range used for local ephemeral port selection by outbound TCP connections for which either SO_REUSE_UNICASTPORT has been set on the socket, or for which connect() has been called without calling bind() on the socket. If you specify 0, the auto-reuse feature is disabled and ephemeral ports are drawn instead from the dynamic port range as specified by *DynamicPortRangeStartPort* and *DynamicPortRangeNumberOfPorts*, even if SO_REUSE_UNICASTPORT is set on a socket. From f4dee919a3bed7b76af94b8108ca8ad3fda819c0 Mon Sep 17 00:00:00 2001 From: "microsoft-github-policy-service[bot]" <77245923+microsoft-github-policy-service[bot]@users.noreply.github.com> Date: Fri, 25 Nov 2022 06:23:08 +0000 Subject: [PATCH 012/650] Microsoft mandatory file --- SECURITY.md | 41 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 41 insertions(+) create mode 100644 SECURITY.md diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 0000000000..e138ec5d6a --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,41 @@ + + +## Security + +Microsoft takes the security of our software products and services seriously, which includes all source code repositories managed through our GitHub organizations, which include [Microsoft](https://github.com/microsoft), [Azure](https://github.com/Azure), [DotNet](https://github.com/dotnet), [AspNet](https://github.com/aspnet), [Xamarin](https://github.com/xamarin), and [our GitHub organizations](https://opensource.microsoft.com/). + +If you believe you have found a security vulnerability in any Microsoft-owned repository that meets [Microsoft's definition of a security vulnerability](https://aka.ms/opensource/security/definition), please report it to us as described below. + +## Reporting Security Issues + +**Please do not report security vulnerabilities through public GitHub issues.** + +Instead, please report them to the Microsoft Security Response Center (MSRC) at [https://msrc.microsoft.com/create-report](https://aka.ms/opensource/security/create-report). + +If you prefer to submit without logging in, send email to [secure@microsoft.com](mailto:secure@microsoft.com). If possible, encrypt your message with our PGP key; please download it from the [Microsoft Security Response Center PGP Key page](https://aka.ms/opensource/security/pgpkey). + +You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message. Additional information can be found at [microsoft.com/msrc](https://aka.ms/opensource/security/msrc). + +Please include the requested information listed below (as much as you can provide) to help us better understand the nature and scope of the possible issue: + + * Type of issue (e.g. buffer overflow, SQL injection, cross-site scripting, etc.) + * Full paths of source file(s) related to the manifestation of the issue + * The location of the affected source code (tag/branch/commit or direct URL) + * Any special configuration required to reproduce the issue + * Step-by-step instructions to reproduce the issue + * Proof-of-concept or exploit code (if possible) + * Impact of the issue, including how an attacker might exploit the issue + +This information will help us triage your report more quickly. + +If you are reporting for a bug bounty, more complete reports can contribute to a higher bounty award. Please visit our [Microsoft Bug Bounty Program](https://aka.ms/opensource/security/bounty) page for more details about our active programs. + +## Preferred Languages + +We prefer all communications to be in English. + +## Policy + +Microsoft follows the principle of [Coordinated Vulnerability Disclosure](https://aka.ms/opensource/security/cvd). + + From d0cfe20ac25748195c570ce14cfd4350a2e6fdfe Mon Sep 17 00:00:00 2001 From: LolaOy <103140748+LolaOy@users.noreply.github.com> Date: Mon, 26 Sep 2022 14:32:19 -0500 Subject: [PATCH 013/650] Adding GPU-P powershell commands to WS powershell doc --- .../hyper-v/Add-VMGpuPartitionAdapter.md | 398 ++++++++++++++++ .../hyper-v/Get-VMGpuPartitionAdapter.md | 156 +++++++ .../hyper-v/Get-VMHostPartitionableGpu.md | 136 ++++++ docset/winserver2022-ps/hyper-v/Hyper-V.md | 15 + .../hyper-v/Remove-VMGpuPartitionAdapter.md | 235 ++++++++++ .../hyper-v/Set-VMGpuPartitionAdapter.md | 427 ++++++++++++++++++ 6 files changed, 1367 insertions(+) create mode 100644 docset/winserver2022-ps/hyper-v/Add-VMGpuPartitionAdapter.md create mode 100644 docset/winserver2022-ps/hyper-v/Get-VMGpuPartitionAdapter.md create mode 100644 docset/winserver2022-ps/hyper-v/Get-VMHostPartitionableGpu.md create mode 100644 docset/winserver2022-ps/hyper-v/Remove-VMGpuPartitionAdapter.md create mode 100644 docset/winserver2022-ps/hyper-v/Set-VMGpuPartitionAdapter.md diff --git a/docset/winserver2022-ps/hyper-v/Add-VMGpuPartitionAdapter.md b/docset/winserver2022-ps/hyper-v/Add-VMGpuPartitionAdapter.md new file mode 100644 index 0000000000..f530668552 --- /dev/null +++ b/docset/winserver2022-ps/hyper-v/Add-VMGpuPartitionAdapter.md @@ -0,0 +1,398 @@ +--- +description: Add GPU Partition adapter to a virtual machine +external help file: Microsoft.HyperV.PowerShell.Cmdlets.dll-Help.xml +Module Name: Hyper-V +ms.date: 09/22/2022 +online version: https://learn.microsoft.com/en-us/powershell/module/hyper-v/add-vmgpupartitionadapter?view=windowsserver2022-ps&wt.mc_id=ps-gethelp +schema: 2.0.0 +--- + +# Add-VMGpuPartitionAdapter + +## SYNOPSIS +Add GPU Partition adapter to a virtual machine + +## SYNTAX + +### VMName (Default) +``` +Add-VMGpuPartitionAdapter [-CimSession ] [-ComputerName ] + [-Credential ] [-VMName] [-Passthru] [-InstancePath ] + [-MinPartitionVRAM ] [-MaxPartitionVRAM ] [-OptimalPartitionVRAM ] + [-MinPartitionEncode ] [-MaxPartitionEncode ] [-OptimalPartitionEncode ] + [-MinPartitionDecode ] [-MaxPartitionDecode ] [-OptimalPartitionDecode ] + [-MinPartitionCompute ] [-MaxPartitionCompute ] [-OptimalPartitionCompute ] [-WhatIf] + [-Confirm] [] +``` + +### VMObject +``` +Add-VMGpuPartitionAdapter [-VM] [-Passthru] [-InstancePath ] + [-MinPartitionVRAM ] [-MaxPartitionVRAM ] [-OptimalPartitionVRAM ] + [-MinPartitionEncode ] [-MaxPartitionEncode ] [-OptimalPartitionEncode ] + [-MinPartitionDecode ] [-MaxPartitionDecode ] [-OptimalPartitionDecode ] + [-MinPartitionCompute ] [-MaxPartitionCompute ] [-OptimalPartitionCompute ] [-WhatIf] + [-Confirm] [] +``` + +## DESCRIPTION +The **Add-VMGpuPartitionAdapter** cmdlet adds GPU Partition adapter to a virtual machine. With no parameter, it assigns a Full partition from an assignable GPU to a VM. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> $vm = Get-VM -name "TestVM" +Add-VMGpuPartitionAdapter -VM $vm +``` + +Assign a partition to a specific VM object. If you want to assign multiple GPU partitions run this command the number of times equal to the number of GPU partitions needed + +### Example 2 +```powershell +PS C:\> $vm = Get-VM -name "TestVM" +Add-VMGpuPartitionAdapter -VM $vm -Instancepath "SampleGPUInstancePath" +``` + +Assign a partition from a specific GPU to a VM. Where the instance path is the GPU device ID name on the Host + +## PARAMETERS + +### -CimSession +Runs the cmdlet in a remote session or on a remote computer. +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. +The default is the current session on the local computer. + +```yaml +Type: CimSession[] +Parameter Sets: VMName +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ComputerName +Specifies one or more Hyper-V hosts from which virtual machines are to be retrieved. +NetBIOS names, IP addresses, and fully qualified domain names are allowable. +The default is the local computer. +Use localhost or a dot (.) to specify the local computer explicitly. + +```yaml +Type: String[] +Parameter Sets: VMName +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Credential +Specifies one or more user accounts that have permission to perform this action. +The default is the current user. + +```yaml +Type: PSCredential[] +Parameter Sets: VMName +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InstancePath +Represents the Device Instance path of a GPU in the host. This value can be obtained from the “Name” property of the command Get-VMHostPartitionableGpu + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaxPartitionCompute +Maximum number of compute assigned by the Host GPU. This is defined by the manufacturer driver. + +```yaml +Type: UInt64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaxPartitionDecode +Maximum number of decoders assigned by the Host GPU. This is defined by the manufacturer driver. + +```yaml +Type: UInt64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaxPartitionEncode +Maximum number of encoders assigned by the Host GPU. This is defined by the manufacturer driver. + +```yaml +Type: UInt64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaxPartitionVRAM +Maximum VRAM supported by the Host GPU. This is defined by the manufacturer driver. + +```yaml +Type: UInt64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MinPartitionCompute +Minimum number of compute assigned by the Host GPU. This is defined by the manufacturer driver. + +```yaml +Type: UInt64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MinPartitionDecode +Minimum number of decoders assigned by the Host GPU. This is defined by the manufacturer driver. + +```yaml +Type: UInt64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MinPartitionEncode +Minimum number of encoders assigned by the Host GPU. This is defined by the manufacturer driver. + +```yaml +Type: UInt64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MinPartitionVRAM +Minimum VRAM supported by the Host GPU. This is defined by the manufacturer driver. + +```yaml +Type: UInt64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OptimalPartitionCompute +Optimal number of compute assigned by the Host GPU. This is defined by the manufacturer driver. + +```yaml +Type: UInt64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OptimalPartitionDecode +Optimal number of decoders assigned by the Host GPU. This is defined by the manufacturer driver. + +```yaml +Type: UInt64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OptimalPartitionEncode +Optimal number of encoders assigned by the Host GPU. This is defined by the manufacturer driver. + +```yaml +Type: UInt64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OptimalPartitionVRAM +Optimal VRAM supported by the Host GPU. This is defined by the manufacturer driver. + +```yaml +Type: UInt64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Passthru +Returns an object for each process that the cmdlet started. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VM +Specifies the virtual machine on which the network adapter is to be added. + +```yaml +Type: VirtualMachine[] +Parameter Sets: VMObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -VMName +Specifies the name of the virtual machine on which the network adapter is to be added. + +```yaml +Type: String[] +Parameter Sets: VMName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.HyperV.PowerShell.VirtualMachine[] + +### System.String[] + +## OUTPUTS + +### Microsoft.HyperV.PowerShell.VMGpuPartitionAdapter + +## NOTES + +## RELATED LINKS diff --git a/docset/winserver2022-ps/hyper-v/Get-VMGpuPartitionAdapter.md b/docset/winserver2022-ps/hyper-v/Get-VMGpuPartitionAdapter.md new file mode 100644 index 0000000000..071e1fdc55 --- /dev/null +++ b/docset/winserver2022-ps/hyper-v/Get-VMGpuPartitionAdapter.md @@ -0,0 +1,156 @@ +--- +description: Gets the information of assigned GPU partitions to a virtual machine. +external help file: Microsoft.HyperV.PowerShell.Cmdlets.dll-Help.xml +Module Name: Hyper-V +ms.date: 09/22/2022 +online version: https://learn.microsoft.com/en-us/powershell/module/hyper-v/get-vmgpupartitionadapter?view=windowsserver2022-ps&wt.mc_id=ps-gethelp +schema: 2.0.0 +--- + +# Get-VMGpuPartitionAdapter + +## SYNOPSIS +Gets the information of assigned GPU partitions to a virtual machine. + +## SYNTAX + +### VMName (Default) +``` +Get-VMGpuPartitionAdapter [-CimSession ] [-ComputerName ] + [-Credential ] [-VMName] [-AdapterId ] [] +``` + +### VMObject +``` +Get-VMGpuPartitionAdapter [-VM] [-AdapterId ] [] +``` + +## DESCRIPTION +The **Get-VMGpuPartitionAdapter** cmdlet gets the information of assigned graphic processing unit partitions to a virtual machine. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> $testvm = get-VM "TestVM" +Get-VMGpuPartitionAdapter -VM $testvm +``` + +Display the GPU information assigned to a VM object + +## PARAMETERS + +### -AdapterId +Virtual machine GPU partition identification number that you are interested in displaying + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CimSession +Runs the cmdlet in a remote session or on a remote computer. +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. +The default is the current session on the local computer. + +```yaml +Type: CimSession[] +Parameter Sets: VMName +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ComputerName +Specifies one or more Hyper-V hosts on the virtual network adapters are to be retrieved. +NetBIOS names, IP addresses, and fully qualified domain names are allowable. +The default is the local computer. +Use localhost or a dot (.) to specify the local computer explicitly. + +```yaml +Type: String[] +Parameter Sets: VMName +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Credential +Specifies one or more user accounts that have permission to perform this action. +The default is the current user. + +```yaml +Type: PSCredential[] +Parameter Sets: VMName +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VM +Specifies the virtual machine whose virtual network adapters are to be retrieved. +. The asterisk, "*", is the wildcard. +If it is specified the cmdlet returns virtual network adapters from every virtual machine in the system. + +```yaml +Type: VirtualMachine[] +Parameter Sets: VMObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -VMName +Specifies the name of the virtual machine whose network adapters are to be retrieved. + +```yaml +Type: String[] +Parameter Sets: VMName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String[] + +### Microsoft.HyperV.PowerShell.VirtualMachine[] + +## OUTPUTS + +### Microsoft.HyperV.PowerShell.VMGpuPartitionAdapter + +## NOTES + +## RELATED LINKS diff --git a/docset/winserver2022-ps/hyper-v/Get-VMHostPartitionableGpu.md b/docset/winserver2022-ps/hyper-v/Get-VMHostPartitionableGpu.md new file mode 100644 index 0000000000..950b6e098b --- /dev/null +++ b/docset/winserver2022-ps/hyper-v/Get-VMHostPartitionableGpu.md @@ -0,0 +1,136 @@ +--- +description: Gets the host machine’s partitionable GPU. +external help file: Microsoft.HyperV.PowerShell.Cmdlets.dll-Help.xml +Module Name: Hyper-V +ms.date: 09/22/2022 +online version: https://learn.microsoft.com/en-us/powershell/module/hyper-v/get-vmhostpartitionablegpu?view=windowsserver2022-ps&wt.mc_id=ps-gethelp +schema: 2.0.0 +--- + +# Get-VMHostPartitionableGpu + +## SYNOPSIS +Gets the host machine’s partitionable GPU. + +## SYNTAX + +### ComputerName (Default) +``` +Get-VMHostPartitionableGpu [[-ComputerName] ] [[-Credential] ] [-Name ] + [] +``` + +### CimSession +``` +Get-VMHostPartitionableGpu [-CimSession] [-Name ] [] +``` + +## DESCRIPTION +The Get-VMHostPartitionableGpu cmdlet get the host machine’s partitionable Graphic Processing Unit. +This displays the information of the GPU as provided by the manufacturer driver. + +## EXAMPLES + +### Example 1 +``` +PS C:\> Get-VMHostPartitionableGpu +``` + +Gets the details of the local partitionable graphic processing unit on the host + +### Example 2 +```powershell +PS C:\> Get-VMHostPartitionableGpu -ComputerName "SampleHost" +``` + +Display a partitionable GPU by using the Host Name. This command will display all the GPU devices available for partitioning in the host: + +### Example 3 +```powershell +PS C:\> Get-VMHostPartitionableGpu -name "SampleGPUDeviceIDName" +``` + +Display a partitionable GPU by using the specific GPU Device Name. The result will show the details of the specific GPU listed: + +## PARAMETERS + +### -CimSession +Runs the cmdlet in a remote session or on a remote computer. +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. +The default is the current session on the local computer. + +```yaml +Type: CimSession[] +Parameter Sets: CimSession +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ComputerName +Specifies one or more Hyper-V hosts that run this cmdlet. +NetBIOS names, IP addresses, and fully qualified domain names are allowable. +The default is the local computer. +Use localhost or a dot (.) to specify the local computer explicitly. + +```yaml +Type: String[] +Parameter Sets: ComputerName +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Credential +Specifies one or more user accounts that have permission to perform this action. +The default is the current user. + +```yaml +Type: PSCredential[] +Parameter Sets: ComputerName +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the graphic processing unit to be retrieved + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Management.Infrastructure.CimSession[] + +## OUTPUTS + +### Microsoft.HyperV.PowerShell.VMHostPartitionableGpu + +## NOTES + +## RELATED LINKS diff --git a/docset/winserver2022-ps/hyper-v/Hyper-V.md b/docset/winserver2022-ps/hyper-v/Hyper-V.md index 01edc1f71a..66d5ae75b5 100644 --- a/docset/winserver2022-ps/hyper-v/Hyper-V.md +++ b/docset/winserver2022-ps/hyper-v/Hyper-V.md @@ -22,6 +22,9 @@ Adds a DVD drive to a virtual machine. ### [Add-VMFibreChannelHba](./Add-VMFibreChannelHba.md) Adds a virtual Fibre Channel host bus adapter to a virtual machine. +### [Add-VMGpuPartitionAdapter](./Add-VMGpuPartitionAdapter.md) +Add GPU Partition adapter to a virtual machine + ### [Add-VMGroupMember](./Add-VMGroupMember.md) Adds group members to a virtual machine group. @@ -187,6 +190,9 @@ Gets the firmware configuration of a virtual machine. ### [Get-VMFloppyDiskDrive](./Get-VMFloppyDiskDrive.md) Gets the floppy disk drives of a virtual machine or snapshot. +### [Get-VMGpuPartitionAdapter](./Get-VMGpuPartitionAdapter.md) +Gets the information of assigned GPU partitions to a virtual machine. + ### [Get-VMGroup](./Get-VMGroup.md) Gets virtual machine groups. @@ -199,6 +205,9 @@ Gets a Hyper-V host. ### [Get-VMHostCluster](./Get-VMHostCluster.md) Gets virtual machine host clusters. +### [Get-VMHostPartitionableGpu](./Get-VMHostPartitionableGpu.md) +Gets the host machine's partitionable GPU. + ### [Get-VMHostNumaNode](./Get-VMHostNumaNode.md) Gets the NUMA topology of a virtual machine host. @@ -388,6 +397,9 @@ Deletes a DVD drive from a virtual machine. ### [Remove-VMFibreChannelHba](./Remove-VMFibreChannelHba.md) Removes a Fibre Channel host bus adapter from a virtual machine. +### [Remove-VMGpuPartitionAdapter](./Remove-VMGpuPartitionAdapter.md) +Removes an assigned GPU partition from a virtual machine. + ### [Remove-VMGroup](./Remove-VMGroup.md) Removes a virtual machine group. @@ -538,6 +550,9 @@ Configures a Hyper-V host. ### [Set-VMHostCluster](./Set-VMHostCluster.md) Configures a virtual machine host cluster. +### [Set-VMHostPartitionableGpu](./Set-VMHostPartitionableGpu.md) +Configures host partitionable GPU to the number of partitions supported by the manufacturer. + ### [Set-VMKeyProtector](./Set-VMKeyProtector.md) Configures a key protector for a virtual machine. diff --git a/docset/winserver2022-ps/hyper-v/Remove-VMGpuPartitionAdapter.md b/docset/winserver2022-ps/hyper-v/Remove-VMGpuPartitionAdapter.md new file mode 100644 index 0000000000..8dbb8e5a9a --- /dev/null +++ b/docset/winserver2022-ps/hyper-v/Remove-VMGpuPartitionAdapter.md @@ -0,0 +1,235 @@ +--- +description: Removes an assigned GPU partition from a virtual machine. +external help file: Microsoft.HyperV.PowerShell.Cmdlets.dll-Help.xml +Module Name: Hyper-V +ms.date: 09/22/2022 +online version: https://learn.microsoft.com/en-us/powershell/module/hyper-v/remove-vmgpupartitionadapter?view=windowsserver2022-ps&wt.mc_id=ps-gethelp +schema: 2.0.0 + +--- + +# Remove-VMGpuPartitionAdapter + +## SYNOPSIS +Removes an assigned GPU partition from a virtual machine. + +## SYNTAX + +### VMName (Default) +``` +Remove-VMGpuPartitionAdapter [-CimSession ] [-ComputerName ] + [-Credential ] [-VMName] [-Passthru] [-AdapterId ] [-WhatIf] [-Confirm] + [] +``` + +### VMObject +``` +Remove-VMGpuPartitionAdapter [-VM] [-Passthru] [-AdapterId ] [-WhatIf] [-Confirm] + [] +``` + +### Object +``` +Remove-VMGpuPartitionAdapter [-VMGpuPartitionAdapter] [-Passthru] [-WhatIf] + [-Confirm] [] +``` + +## DESCRIPTION +The **Remove-VMGpuPartitionAdapter** cmdlet removes an assigned graphic processing unit partition from a virtual machine and releases that partition back to the host GPU. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> $testvm = Get-VM "TestVM" +Remove-VMGpuPartitionAdapter -VM $testvm +``` + +Remove a partition assigned to a specific VM Object + +### Example 2 +```powershell +PS C:\> $testvm = Get-VM "TestVM" +$GPUpartition = Get-VMGpuPartitionAdapter -VM $testvm +Remove-VMGpuPartitionAdapter -VM $testvm -AdapterId $GPUpartiton[0].id +``` + +Remove a specific partition in a VM + +## PARAMETERS + +### -AdapterId +The virtual machine graphic processing unit partition identification number that you are interested in displaying. + +```yaml +Type: String +Parameter Sets: VMName, VMObject +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CimSession +Runs the cmdlet in a remote session or on a remote computer. +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. +The default is the current session on the local computer. + +```yaml +Type: CimSession[] +Parameter Sets: VMName +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ComputerName +Specifies one or more Hyper-V hosts on the virtual network adapters are to be retrieved. +NetBIOS names, IP addresses, and fully qualified domain names are allowable. +The default is the local computer. +Use localhost or a dot (.) to specify the local computer explicitly. + +```yaml +Type: String[] +Parameter Sets: VMName +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Credential +Specifies one or more user accounts that have permission to perform this action. +The default is the current user. + +```yaml +Type: PSCredential[] +Parameter Sets: VMName +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Passthru +Returns an object for each process that the cmdlet started. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VM +Specifies the virtual machine whose virtual network adapters are to be retrieved. +. The asterisk, "*", is the wildcard. +If it is specified the cmdlet returns virtual network adapters from every virtual machine in the system. + +```yaml +Type: VirtualMachine[] +Parameter Sets: VMObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -VMGpuPartitionAdapter +GPU partition object obtained from **Microsoft.HyperV.PowerShell.Get-VMGpuPartitionAdapter**. + +```yaml +Type: VMGpuPartitionAdapter[] +Parameter Sets: Object +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -VMName +Specifies the name of the virtual machine whose network adapters are to be retrieved. + +```yaml +Type: String[] +Parameter Sets: VMName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.HyperV.PowerShell.VirtualMachine[] + +### Microsoft.HyperV.PowerShell.VMGpuPartitionAdapter[] + +## OUTPUTS + +### Microsoft.HyperV.PowerShell.VMGpuPartitionAdapter + +## NOTES + +## RELATED LINKS diff --git a/docset/winserver2022-ps/hyper-v/Set-VMGpuPartitionAdapter.md b/docset/winserver2022-ps/hyper-v/Set-VMGpuPartitionAdapter.md new file mode 100644 index 0000000000..3e9ae21b26 --- /dev/null +++ b/docset/winserver2022-ps/hyper-v/Set-VMGpuPartitionAdapter.md @@ -0,0 +1,427 @@ +--- +description: Configures host partitionable GPU to the number of partitions supported by the manufacturer +external help file: Microsoft.HyperV.PowerShell.Cmdlets.dll-Help.xml +Module Name: Hyper-V +ms.date: 09/22/2022 +online version: https://learn.microsoft.com/en-us/powershell/module/hyper-v/set-vmgpupartitionadapter?view=windowsserver2022-ps&wt.mc_id=ps-gethelp +schema: 2.0.0 + +--- + +# Set-VMGpuPartitionAdapter + +## SYNOPSIS +Configures host partitionable GPU to the number of partitions supported by the manufacturer + +## SYNTAX + +### VMName (Default) +``` +Set-VMGpuPartitionAdapter [-CimSession ] [-ComputerName ] + [-Credential ] [-VMName] [-Passthru] [-AdapterId ] + [-MinPartitionVRAM ] [-MaxPartitionVRAM ] [-OptimalPartitionVRAM ] + [-MinPartitionEncode ] [-MaxPartitionEncode ] [-OptimalPartitionEncode ] + [-MinPartitionDecode ] [-MaxPartitionDecode ] [-OptimalPartitionDecode ] + [-MinPartitionCompute ] [-MaxPartitionCompute ] [-OptimalPartitionCompute ] [-WhatIf] + [-Confirm] [] +``` + +### VMObject +``` +Set-VMGpuPartitionAdapter [-VM] [-Passthru] [-AdapterId ] + [-MinPartitionVRAM ] [-MaxPartitionVRAM ] [-OptimalPartitionVRAM ] + [-MinPartitionEncode ] [-MaxPartitionEncode ] [-OptimalPartitionEncode ] + [-MinPartitionDecode ] [-MaxPartitionDecode ] [-OptimalPartitionDecode ] + [-MinPartitionCompute ] [-MaxPartitionCompute ] [-OptimalPartitionCompute ] [-WhatIf] + [-Confirm] [] +``` + +### Object +``` +Set-VMGpuPartitionAdapter [-VMGpuPartitionAdapter] [-Passthru] + [-MinPartitionVRAM ] [-MaxPartitionVRAM ] [-OptimalPartitionVRAM ] + [-MinPartitionEncode ] [-MaxPartitionEncode ] [-OptimalPartitionEncode ] + [-MinPartitionDecode ] [-MaxPartitionDecode ] [-OptimalPartitionDecode ] + [-MinPartitionCompute ] [-MaxPartitionCompute ] [-OptimalPartitionCompute ] [-WhatIf] + [-Confirm] [] +``` + +## DESCRIPTION +The **Set-VMGpuPartitionAdapter** cmdlet Configures host partitionable GPU to the number of partitions supported by the manufacturer. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> Set-VMHostPartitionableGpu -ComputerName �SampleHost� -partitioncount 8 +``` + +Partition a GPU in a specific host + +### Example 2 +```powershell +PS C:\> $GPU = Get-VMHostPartitionableGpu -name "SampleGPUDeviceIDName" +Set-VMHostPartitionableGpu -Name $GPU -partitionCount 4 +``` + +Partition a GPU in a host using the GPU Device ID Name: + +## PARAMETERS + +### -AdapterId +The virtual machine graphic processing unit partition identification number that you are interested in displaying. + +```yaml +Type: String +Parameter Sets: VMName, VMObject +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CimSession +Runs the cmdlet in a remote session or on a remote computer. +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. +The default is the current session on the local computer. + +```yaml +Type: CimSession[] +Parameter Sets: VMName +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ComputerName +Specifies one or more Hyper-V hosts on the virtual network adapters are to be retrieved. +NetBIOS names, IP addresses, and fully qualified domain names are allowable. +The default is the local computer. +Use localhost or a dot (.) to specify the local computer explicitly. + +```yaml +Type: String[] +Parameter Sets: VMName +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Credential +Specifies one or more user accounts that have permission to perform this action. +The default is the current user. + +```yaml +Type: PSCredential[] +Parameter Sets: VMName +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaxPartitionCompute + Maximum number of compute assigned by the Host GPU. This is defined by the manufacturer driver. + +```yaml +Type: UInt64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaxPartitionDecode +Maximum number of decoders assigned by the Host GPU. This is defined by the manufacturer driver. + +```yaml +Type: UInt64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaxPartitionEncode +Maximum number of encoders assigned by the Host GPU. This is defined by the manufacturer driver. + +```yaml +Type: UInt64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaxPartitionVRAM +Maximum VRAM supported by the Host GPU. This is defined by the manufacturer driver. + +```yaml +Type: UInt64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MinPartitionCompute +Minimum number of compute assigned by the Host GPU. This is defined by the manufacturer driver. + +```yaml +Type: UInt64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MinPartitionDecode +Minimum number of decoders assigned by the Host GPU. This is defined by the manufacturer driver. + +```yaml +Type: UInt64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MinPartitionEncode +Minimum number of encoders assigned by the Host GPU. This is defined by the manufacturer driver. + +```yaml +Type: UInt64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MinPartitionVRAM +Minimum VRAM supported by the Host GPU. This is defined by the manufacturer driver. + +```yaml +Type: UInt64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OptimalPartitionCompute +Optimal number of compute assigned by the Host GPU. This is defined by the manufacturer driver. + +```yaml +Type: UInt64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OptimalPartitionDecode +Optimal number of decoders assigned by the Host GPU. This is defined by the manufacturer driver. + +```yaml +Type: UInt64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OptimalPartitionEncode +Optimal number of encoders assigned by the Host GPU. This is defined by the manufacturer driver. + +```yaml +Type: UInt64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OptimalPartitionVRAM +Optimal VRAM supported by the Host GPU. This is defined by the manufacturer driver. + +```yaml +Type: UInt64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Passthru +Returns an object for each process that the cmdlet started. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VM +Specifies the virtual machine whose virtual network adapters are to be retrieved. +. The asterisk, "*", is the wildcard. +If it is specified the cmdlet returns virtual network adapters from every virtual machine in the system. + +```yaml +Type: VirtualMachine[] +Parameter Sets: VMObject +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -VMGpuPartitionAdapter +GPU partition object obtained from **Microsoft.HyperV.PowerShell.Get-VMGpuPartitionAdapter**. + +```yaml +Type: VMGpuPartitionAdapter[] +Parameter Sets: Object +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -VMName +Specifies the name of the virtual machine whose network adapters are to be retrieved. + +```yaml +Type: String[] +Parameter Sets: VMName +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String[] + +### Microsoft.HyperV.PowerShell.VirtualMachine[] + +### Microsoft.HyperV.PowerShell.VMGpuPartitionAdapter[] + +## OUTPUTS + +### Microsoft.HyperV.PowerShell.VMGpuPartitionAdapter + +## NOTES + +## RELATED LINKS From cfb03b82f88a20082815d75ac1c9e7f3a6bba1a4 Mon Sep 17 00:00:00 2001 From: LolaOy <103140748+LolaOy@users.noreply.github.com> Date: Mon, 24 Oct 2022 15:31:26 -0500 Subject: [PATCH 014/650] Add Set-VMGpuPartitionAdapter to Hyper-V module, add review comments Add Set-VMGpuPartitionAdapter to Hyper-V module., add review comments --- .../hyper-v/Add-VMGpuPartitionAdapter.md | 46 ++--- .../hyper-v/Get-VMGpuPartitionAdapter.md | 20 +- .../hyper-v/Get-VMHostPartitionableGpu.md | 20 +- docset/winserver2022-ps/hyper-v/Hyper-V.md | 7 +- .../hyper-v/Remove-VMGpuPartitionAdapter.md | 23 +-- .../hyper-v/Set-VMGpuPartitionAdapter.md | 60 +++--- .../hyper-v/Set-VMHostPartitionableGpu.md | 184 ++++++++++++++++++ 7 files changed, 267 insertions(+), 93 deletions(-) create mode 100644 docset/winserver2022-ps/hyper-v/Set-VMHostPartitionableGpu.md diff --git a/docset/winserver2022-ps/hyper-v/Add-VMGpuPartitionAdapter.md b/docset/winserver2022-ps/hyper-v/Add-VMGpuPartitionAdapter.md index f530668552..cbdc9ee09f 100644 --- a/docset/winserver2022-ps/hyper-v/Add-VMGpuPartitionAdapter.md +++ b/docset/winserver2022-ps/hyper-v/Add-VMGpuPartitionAdapter.md @@ -1,5 +1,5 @@ --- -description: Add GPU Partition adapter to a virtual machine +description: Adds a GPU partition adapter to a virtual machine. external help file: Microsoft.HyperV.PowerShell.Cmdlets.dll-Help.xml Module Name: Hyper-V ms.date: 09/22/2022 @@ -10,7 +10,7 @@ schema: 2.0.0 # Add-VMGpuPartitionAdapter ## SYNOPSIS -Add GPU Partition adapter to a virtual machine +Adds a GPU partition adapter to a virtual machine. ## SYNTAX @@ -36,25 +36,25 @@ Add-VMGpuPartitionAdapter [-VM] [-Passthru] [-InstancePath $vm = Get-VM -name "TestVM" +$vm = Get-VM -name "TestVM" Add-VMGpuPartitionAdapter -VM $vm ``` -Assign a partition to a specific VM object. If you want to assign multiple GPU partitions run this command the number of times equal to the number of GPU partitions needed +Assigns a partition to a specific VM object. If you want to assign multiple GPU partitions run this command the number of times equal to the number of GPU partitions needed. ### Example 2 ```powershell -PS C:\> $vm = Get-VM -name "TestVM" +$vm = Get-VM -name "TestVM" Add-VMGpuPartitionAdapter -VM $vm -Instancepath "SampleGPUInstancePath" ``` -Assign a partition from a specific GPU to a VM. Where the instance path is the GPU device ID name on the Host +Assigns a partition from a specific GPU to a VM where the instance path is the GPU device ID name on the host. ## PARAMETERS @@ -79,7 +79,7 @@ Accept wildcard characters: False Specifies one or more Hyper-V hosts from which virtual machines are to be retrieved. NetBIOS names, IP addresses, and fully qualified domain names are allowable. The default is the local computer. -Use localhost or a dot (.) to specify the local computer explicitly. +Use localhost or a dot ('.') to specify the local computer explicitly. ```yaml Type: String[] @@ -110,7 +110,7 @@ Accept wildcard characters: False ``` ### -InstancePath -Represents the Device Instance path of a GPU in the host. This value can be obtained from the “Name” property of the command Get-VMHostPartitionableGpu +Represents the Device Instance path of a GPU in the host. This value can be obtained from the "Name" property of the command Get-VMHostPartitionableGpu ```yaml Type: String @@ -125,7 +125,7 @@ Accept wildcard characters: False ``` ### -MaxPartitionCompute -Maximum number of compute assigned by the Host GPU. This is defined by the manufacturer driver. +The maximum number of compute assigned by the host GPU. This is defined by the manufacturer's driver. ```yaml Type: UInt64 @@ -140,7 +140,7 @@ Accept wildcard characters: False ``` ### -MaxPartitionDecode -Maximum number of decoders assigned by the Host GPU. This is defined by the manufacturer driver. +the maximum number of decoders assigned by the host GPU. This is defined by the manufacturer's driver. ```yaml Type: UInt64 @@ -155,7 +155,7 @@ Accept wildcard characters: False ``` ### -MaxPartitionEncode -Maximum number of encoders assigned by the Host GPU. This is defined by the manufacturer driver. +the maximum number of encoders assigned by the host GPU. This is defined by the manufacturer's driver. ```yaml Type: UInt64 @@ -170,7 +170,7 @@ Accept wildcard characters: False ``` ### -MaxPartitionVRAM -Maximum VRAM supported by the Host GPU. This is defined by the manufacturer driver. +the maximum VRAM supported by the host GPU. This is defined by the manufacturer's driver. ```yaml Type: UInt64 @@ -185,7 +185,7 @@ Accept wildcard characters: False ``` ### -MinPartitionCompute -Minimum number of compute assigned by the Host GPU. This is defined by the manufacturer driver. +the minimum number of compute assigned by the host GPU. This is defined by the manufacturer's driver. ```yaml Type: UInt64 @@ -200,7 +200,7 @@ Accept wildcard characters: False ``` ### -MinPartitionDecode -Minimum number of decoders assigned by the Host GPU. This is defined by the manufacturer driver. +the minimum number of decoders assigned by the host GPU. This is defined by the manufacturer's driver. ```yaml Type: UInt64 @@ -215,7 +215,7 @@ Accept wildcard characters: False ``` ### -MinPartitionEncode -Minimum number of encoders assigned by the Host GPU. This is defined by the manufacturer driver. +the minimum number of encoders assigned by the host GPU. This is defined by the manufacturer's driver. ```yaml Type: UInt64 @@ -230,7 +230,7 @@ Accept wildcard characters: False ``` ### -MinPartitionVRAM -Minimum VRAM supported by the Host GPU. This is defined by the manufacturer driver. +the minimum VRAM supported by the host GPU. This is defined by the manufacturer's driver. ```yaml Type: UInt64 @@ -245,7 +245,7 @@ Accept wildcard characters: False ``` ### -OptimalPartitionCompute -Optimal number of compute assigned by the Host GPU. This is defined by the manufacturer driver. +the optimal number of compute assigned by the host GPU. This is defined by the manufacturer's driver. ```yaml Type: UInt64 @@ -259,8 +259,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OptimalPartitionDecode -Optimal number of decoders assigned by the Host GPU. This is defined by the manufacturer driver. +### -the optimalPartitionDecode +the optimal number of decoders assigned by the host GPU. This is defined by the manufacturer's driver. ```yaml Type: UInt64 @@ -275,7 +275,7 @@ Accept wildcard characters: False ``` ### -OptimalPartitionEncode -Optimal number of encoders assigned by the Host GPU. This is defined by the manufacturer driver. +the optimal number of encoders assigned by the host GPU. This is defined by the manufacturer's driver. ```yaml Type: UInt64 @@ -290,7 +290,7 @@ Accept wildcard characters: False ``` ### -OptimalPartitionVRAM -Optimal VRAM supported by the Host GPU. This is defined by the manufacturer driver. +the optimal VRAM supported by the host GPU. This is defined by the manufacturer's driver. ```yaml Type: UInt64 @@ -381,7 +381,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). +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). ## INPUTS diff --git a/docset/winserver2022-ps/hyper-v/Get-VMGpuPartitionAdapter.md b/docset/winserver2022-ps/hyper-v/Get-VMGpuPartitionAdapter.md index 071e1fdc55..ed3f711e2e 100644 --- a/docset/winserver2022-ps/hyper-v/Get-VMGpuPartitionAdapter.md +++ b/docset/winserver2022-ps/hyper-v/Get-VMGpuPartitionAdapter.md @@ -26,22 +26,22 @@ Get-VMGpuPartitionAdapter [-VM] [-AdapterId ] [ $testvm = get-VM "TestVM" +$testvm = get-VM "TestVM" Get-VMGpuPartitionAdapter -VM $testvm ``` -Display the GPU information assigned to a VM object +Displays the GPU information assigned to a VM object ## PARAMETERS ### -AdapterId -Virtual machine GPU partition identification number that you are interested in displaying +A VM's GPU partition identification number used to display the GPU information assigned to a VM ```yaml Type: String @@ -73,10 +73,10 @@ Accept wildcard characters: False ``` ### -ComputerName -Specifies one or more Hyper-V hosts on the virtual network adapters are to be retrieved. -NetBIOS names, IP addresses, and fully qualified domain names are allowable. +Specifies that one or more Hyper-V hosts on the virtual network adapters are to be retrieved. +NetBIOS names, IP addresses, and fully qualified domain names are allowed. The default is the local computer. -Use localhost or a dot (.) to specify the local computer explicitly. +Use localhost or a dot ('.') to specify the local computer explicitly. ```yaml Type: String[] @@ -108,7 +108,7 @@ Accept wildcard characters: False ### -VM Specifies the virtual machine whose virtual network adapters are to be retrieved. -. The asterisk, "*", is the wildcard. +. The asterisk, ('*'), is the wildcard. If it is specified the cmdlet returns virtual network adapters from every virtual machine in the system. ```yaml @@ -120,7 +120,7 @@ Required: True Position: 0 Default value: None Accept pipeline input: True (ByValue) -Accept wildcard characters: False +Accept wildcard characters: true ``` ### -VMName @@ -139,7 +139,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). +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). ## INPUTS diff --git a/docset/winserver2022-ps/hyper-v/Get-VMHostPartitionableGpu.md b/docset/winserver2022-ps/hyper-v/Get-VMHostPartitionableGpu.md index 950b6e098b..8cc52abb73 100644 --- a/docset/winserver2022-ps/hyper-v/Get-VMHostPartitionableGpu.md +++ b/docset/winserver2022-ps/hyper-v/Get-VMHostPartitionableGpu.md @@ -26,31 +26,31 @@ Get-VMHostPartitionableGpu [-CimSession] [-Name ] [ Get-VMHostPartitionableGpu +Get-VMHostPartitionableGpu ``` Gets the details of the local partitionable graphic processing unit on the host ### Example 2 ```powershell -PS C:\> Get-VMHostPartitionableGpu -ComputerName "SampleHost" +Get-VMHostPartitionableGpu -ComputerName "SampleHost" ``` -Display a partitionable GPU by using the Host Name. This command will display all the GPU devices available for partitioning in the host: +Displays a partitionable GPU by using the host name. This command will display all the GPU devices available for partitioning in the host. ### Example 3 ```powershell -PS C:\> Get-VMHostPartitionableGpu -name "SampleGPUDeviceIDName" +Get-VMHostPartitionableGpu -name "SampleGPUDeviceIDName" ``` -Display a partitionable GPU by using the specific GPU Device Name. The result will show the details of the specific GPU listed: +Displays a partitionable GPU by using the specific GPU device name. The result will show the details of the specific GPU listed. ## PARAMETERS @@ -75,7 +75,7 @@ Accept wildcard characters: False Specifies one or more Hyper-V hosts that run this cmdlet. NetBIOS names, IP addresses, and fully qualified domain names are allowable. The default is the local computer. -Use localhost or a dot (.) to specify the local computer explicitly. +Use localhost or a dot ('.') to specify the local computer explicitly. ```yaml Type: String[] @@ -106,7 +106,7 @@ Accept wildcard characters: False ``` ### -Name -Specifies the name of the graphic processing unit to be retrieved +Specifies the name of the graphic processing unit to be retrieved. ```yaml Type: String @@ -121,7 +121,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). +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). ## INPUTS diff --git a/docset/winserver2022-ps/hyper-v/Hyper-V.md b/docset/winserver2022-ps/hyper-v/Hyper-V.md index 66d5ae75b5..d98210af0e 100644 --- a/docset/winserver2022-ps/hyper-v/Hyper-V.md +++ b/docset/winserver2022-ps/hyper-v/Hyper-V.md @@ -23,7 +23,7 @@ Adds a DVD drive to a virtual machine. Adds a virtual Fibre Channel host bus adapter to a virtual machine. ### [Add-VMGpuPartitionAdapter](./Add-VMGpuPartitionAdapter.md) -Add GPU Partition adapter to a virtual machine +Adds a GPU partition adapter to a virtual machine. ### [Add-VMGroupMember](./Add-VMGroupMember.md) Adds group members to a virtual machine group. @@ -541,6 +541,9 @@ Sets the firmware configuration of a virtual machine. ### [Set-VMFloppyDiskDrive](./Set-VMFloppyDiskDrive.md) Configures a virtual floppy disk drive. +### [Set-VMGpuPartitionAdapter](./Set-VMGpuPartitionAdapter.md) +Assigns a partition of a GPU to a virtual machine. + ### [Set-VMHardDiskDrive](./Set-VMHardDiskDrive.md) Configures a virtual hard disk. @@ -551,7 +554,7 @@ Configures a Hyper-V host. Configures a virtual machine host cluster. ### [Set-VMHostPartitionableGpu](./Set-VMHostPartitionableGpu.md) -Configures host partitionable GPU to the number of partitions supported by the manufacturer. +Configures a host partitionable GPU to the number of partitions supported by the manufacturer. ### [Set-VMKeyProtector](./Set-VMKeyProtector.md) Configures a key protector for a virtual machine. diff --git a/docset/winserver2022-ps/hyper-v/Remove-VMGpuPartitionAdapter.md b/docset/winserver2022-ps/hyper-v/Remove-VMGpuPartitionAdapter.md index 8dbb8e5a9a..573ed49a22 100644 --- a/docset/winserver2022-ps/hyper-v/Remove-VMGpuPartitionAdapter.md +++ b/docset/winserver2022-ps/hyper-v/Remove-VMGpuPartitionAdapter.md @@ -35,21 +35,21 @@ Remove-VMGpuPartitionAdapter [-VMGpuPartitionAdapter] ``` ## DESCRIPTION -The **Remove-VMGpuPartitionAdapter** cmdlet removes an assigned graphic processing unit partition from a virtual machine and releases that partition back to the host GPU. +The 'Remove-VMGpuPartitionAdapter' cmdlet removes an assigned graphic processing unit partition from a virtual machine and releases that partition back to the host GPU. ## EXAMPLES ### Example 1 ```powershell -PS C:\> $testvm = Get-VM "TestVM" +$testvm = Get-VM "TestVM" Remove-VMGpuPartitionAdapter -VM $testvm ``` -Remove a partition assigned to a specific VM Object +Removes a partition assigned to a specific VM Object. ### Example 2 ```powershell -PS C:\> $testvm = Get-VM "TestVM" +$testvm = Get-VM "TestVM" $GPUpartition = Get-VMGpuPartitionAdapter -VM $testvm Remove-VMGpuPartitionAdapter -VM $testvm -AdapterId $GPUpartiton[0].id ``` @@ -59,7 +59,7 @@ Remove a specific partition in a VM ## PARAMETERS ### -AdapterId -The virtual machine graphic processing unit partition identification number that you are interested in displaying. +A VM's GPU partition identification number used to remove a GPU from a VM. ```yaml Type: String @@ -91,10 +91,8 @@ Accept wildcard characters: False ``` ### -ComputerName -Specifies one or more Hyper-V hosts on the virtual network adapters are to be retrieved. -NetBIOS names, IP addresses, and fully qualified domain names are allowable. -The default is the local computer. -Use localhost or a dot (.) to specify the local computer explicitly. +Specifies that one or more Hyper-V hosts on the virtual network adapters are to be retrieved. NetBIOS names, IP addresses, and fully qualified domain names are allowed. +The default is the local computer.Use localhost or a dot ('.') to specify the local computer explicitly. ```yaml Type: String[] @@ -140,8 +138,7 @@ Accept wildcard characters: False ``` ### -VM -Specifies the virtual machine whose virtual network adapters are to be retrieved. -. The asterisk, "*", is the wildcard. +Specifies the virtual machine whose virtual network adapters are to be retrieved. The asterisk, ('*'), is the wildcard. If it is specified the cmdlet returns virtual network adapters from every virtual machine in the system. ```yaml @@ -157,7 +154,7 @@ Accept wildcard characters: False ``` ### -VMGpuPartitionAdapter -GPU partition object obtained from **Microsoft.HyperV.PowerShell.Get-VMGpuPartitionAdapter**. +GPU partition object obtained from 'Get-VMGpuPartitionAdapter'. ```yaml Type: VMGpuPartitionAdapter[] @@ -218,7 +215,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). +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). ## INPUTS diff --git a/docset/winserver2022-ps/hyper-v/Set-VMGpuPartitionAdapter.md b/docset/winserver2022-ps/hyper-v/Set-VMGpuPartitionAdapter.md index 3e9ae21b26..244ee70795 100644 --- a/docset/winserver2022-ps/hyper-v/Set-VMGpuPartitionAdapter.md +++ b/docset/winserver2022-ps/hyper-v/Set-VMGpuPartitionAdapter.md @@ -1,5 +1,5 @@ --- -description: Configures host partitionable GPU to the number of partitions supported by the manufacturer +description: Assigns a partition of a GPU to a virtual machine. external help file: Microsoft.HyperV.PowerShell.Cmdlets.dll-Help.xml Module Name: Hyper-V ms.date: 09/22/2022 @@ -11,7 +11,7 @@ schema: 2.0.0 # Set-VMGpuPartitionAdapter ## SYNOPSIS -Configures host partitionable GPU to the number of partitions supported by the manufacturer +Assigns a partition of a GPU to a virtual machine. ## SYNTAX @@ -47,29 +47,22 @@ Set-VMGpuPartitionAdapter [-VMGpuPartitionAdapter] [-P ``` ## DESCRIPTION -The **Set-VMGpuPartitionAdapter** cmdlet Configures host partitionable GPU to the number of partitions supported by the manufacturer. +The 'Set-VMGpuPartitionAdapter' cmdlet assigns a partition of a GPU to a virtual machine. Running the command against a virtual machine assigns a full partition. Additional parameters exist to assign more specific options to a VM. ## EXAMPLES ### Example 1 ```powershell -PS C:\> Set-VMHostPartitionableGpu -ComputerName �SampleHost� -partitioncount 8 +$vm = get-vm test +Set-VMGpuPartitionAdapter -VM $vm ``` -Partition a GPU in a specific host - -### Example 2 -```powershell -PS C:\> $GPU = Get-VMHostPartitionableGpu -name "SampleGPUDeviceIDName" -Set-VMHostPartitionableGpu -Name $GPU -partitionCount 4 -``` - -Partition a GPU in a host using the GPU Device ID Name: +Assign a partition to a VM passing a VM object. ## PARAMETERS ### -AdapterId -The virtual machine graphic processing unit partition identification number that you are interested in displaying. +A VM's GPU partition identification number used to display the GPU information assigned to a VM. ```yaml Type: String @@ -84,8 +77,7 @@ Accept wildcard characters: False ``` ### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -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. +Runs the cmdlet in a remote session or on a remote computer. 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. The default is the current session on the local computer. ```yaml @@ -101,10 +93,9 @@ Accept wildcard characters: False ``` ### -ComputerName -Specifies one or more Hyper-V hosts on the virtual network adapters are to be retrieved. -NetBIOS names, IP addresses, and fully qualified domain names are allowable. +Specifies one or more Hyper-V hosts on the virtual network adapters are to be retrieved. NetBIOS names, IP addresses, and fully qualified domain names are allowed. The default is the local computer. -Use localhost or a dot (.) to specify the local computer explicitly. +Use localhost or a dot ('.') to specify the local computer explicitly. ```yaml Type: String[] @@ -135,7 +126,7 @@ Accept wildcard characters: False ``` ### -MaxPartitionCompute - Maximum number of compute assigned by the Host GPU. This is defined by the manufacturer driver. + The maximum number of compute assigned by the host GPU. This is defined by the manufacturer's driver. ```yaml Type: UInt64 @@ -150,7 +141,7 @@ Accept wildcard characters: False ``` ### -MaxPartitionDecode -Maximum number of decoders assigned by the Host GPU. This is defined by the manufacturer driver. +The maximum number of decoders assigned by the host GPU. This is defined by the manufacturer's driver. ```yaml Type: UInt64 @@ -165,7 +156,7 @@ Accept wildcard characters: False ``` ### -MaxPartitionEncode -Maximum number of encoders assigned by the Host GPU. This is defined by the manufacturer driver. +The maximum number of encoders assigned by the host GPU. This is defined by the manufacturer's driver. ```yaml Type: UInt64 @@ -180,7 +171,7 @@ Accept wildcard characters: False ``` ### -MaxPartitionVRAM -Maximum VRAM supported by the Host GPU. This is defined by the manufacturer driver. +The maximum VRAM supported by the host GPU. This is defined by the manufacturer's driver. ```yaml Type: UInt64 @@ -195,7 +186,7 @@ Accept wildcard characters: False ``` ### -MinPartitionCompute -Minimum number of compute assigned by the Host GPU. This is defined by the manufacturer driver. +The minimum number of compute assigned by the host GPU. This is defined by the manufacturer's driver. ```yaml Type: UInt64 @@ -210,7 +201,7 @@ Accept wildcard characters: False ``` ### -MinPartitionDecode -Minimum number of decoders assigned by the Host GPU. This is defined by the manufacturer driver. +The minimum number of decoders assigned by the host GPU. This is defined by the manufacturer's driver. ```yaml Type: UInt64 @@ -225,7 +216,7 @@ Accept wildcard characters: False ``` ### -MinPartitionEncode -Minimum number of encoders assigned by the Host GPU. This is defined by the manufacturer driver. +The minimum number of encoders assigned by the host GPU. This is defined by the manufacturer's driver. ```yaml Type: UInt64 @@ -240,7 +231,7 @@ Accept wildcard characters: False ``` ### -MinPartitionVRAM -Minimum VRAM supported by the Host GPU. This is defined by the manufacturer driver. +The minimum VRAM supported by the host GPU. This is defined by the manufacturer's driver. ```yaml Type: UInt64 @@ -255,7 +246,7 @@ Accept wildcard characters: False ``` ### -OptimalPartitionCompute -Optimal number of compute assigned by the Host GPU. This is defined by the manufacturer driver. +The optimal number of compute assigned by the host GPU. This is defined by the manufacturer's driver. ```yaml Type: UInt64 @@ -270,7 +261,7 @@ Accept wildcard characters: False ``` ### -OptimalPartitionDecode -Optimal number of decoders assigned by the Host GPU. This is defined by the manufacturer driver. +The optimal number of decoders assigned by the host GPU. This is defined by the manufacturer's driver. ```yaml Type: UInt64 @@ -285,7 +276,7 @@ Accept wildcard characters: False ``` ### -OptimalPartitionEncode -Optimal number of encoders assigned by the Host GPU. This is defined by the manufacturer driver. +The optimal number of encoders assigned by the host GPU. This is defined by the manufacturer's driver. ```yaml Type: UInt64 @@ -300,7 +291,7 @@ Accept wildcard characters: False ``` ### -OptimalPartitionVRAM -Optimal VRAM supported by the Host GPU. This is defined by the manufacturer driver. +The optimal VRAM supported by the host GPU. This is defined by the manufacturer's driver. ```yaml Type: UInt64 @@ -330,8 +321,7 @@ Accept wildcard characters: False ``` ### -VM -Specifies the virtual machine whose virtual network adapters are to be retrieved. -. The asterisk, "*", is the wildcard. +Specifies the virtual machine whose virtual network adapters are to be retrieved. The asterisk, ('*'), is the wildcard. If it is specified the cmdlet returns virtual network adapters from every virtual machine in the system. ```yaml @@ -347,7 +337,7 @@ Accept wildcard characters: False ``` ### -VMGpuPartitionAdapter -GPU partition object obtained from **Microsoft.HyperV.PowerShell.Get-VMGpuPartitionAdapter**. +GPU partition object obtained from 'Get-VMGpuPartitionAdapter'' ```yaml Type: VMGpuPartitionAdapter[] @@ -408,7 +398,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). +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). ## INPUTS diff --git a/docset/winserver2022-ps/hyper-v/Set-VMHostPartitionableGpu.md b/docset/winserver2022-ps/hyper-v/Set-VMHostPartitionableGpu.md new file mode 100644 index 0000000000..5b28f6ab86 --- /dev/null +++ b/docset/winserver2022-ps/hyper-v/Set-VMHostPartitionableGpu.md @@ -0,0 +1,184 @@ +--- +external help file: Microsoft.HyperV.PowerShell.Cmdlets.dll-Help.xml +Module Name: Hyper-V +online version: +schema: 2.0.0 +--- + +# Set-VMHostPartitionableGpu + +## SYNOPSIS +Configures host partitionable GPU to the number of partitions supported by the manufacturer + +## SYNTAX + +### ComputerName (Default) +``` +Set-VMHostPartitionableGpu [[-ComputerName] ] [[-Credential] ] [-Passthru] + [-PartitionCount ] [] +``` + +### CimSession +``` +Set-VMHostPartitionableGpu [-CimSession] [-Passthru] [-PartitionCount ] + [] +``` + +### Object +``` +Set-VMHostPartitionableGpu [-HostPartitionableGpu] [-Passthru] + [-PartitionCount ] [] +``` + +### Name +``` +Set-VMHostPartitionableGpu [-Passthru] [-Name ] [-PartitionCount ] [] +``` + +## DESCRIPTION +The `Set-VMHostPartitionableGpu` cmdlet Configures host partitionable GPU to the number of partitions supported by the manufacturer. + +## EXAMPLES + +### Example 1 +```powershell +Set-VMHostPartitionableGpu -ComputerName SampleHost -partitioncount 8 +``` + +Partitions a GPU in a specific host. + +### Example 2 +```powershell +$GPU = Get-VMHostPartitionableGpu -name "SampleGPUDeviceIDName" +Set-VMHostPartitionableGpu -Name $GPU -partitionCount 4 +``` + +Partitions a GPU in a host using the GPU device ID name. + +## PARAMETERS + +### -CimSession +Runs the cmdlet in a remote session or on a remote computer. 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. +The default is the current session on the local computer. + +```yaml +Type: CimSession[] +Parameter Sets: CimSession +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ComputerName +Specifies one or more Hyper-V hosts on the virtual network adapters are to be retrieved. NetBIOS names, IP addresses, and fully qualified domain names are allowed. +The default is the local computer. +Use localhost or a dot ('.') to specify the local computer explicitly. + +```yaml +Type: String[] +Parameter Sets: ComputerName +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Credential +Specifies one or more user accounts that have permission to perform this action. +The default is the current user. + +```yaml +Type: PSCredential[] +Parameter Sets: ComputerName +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HostPartitionableGpu +Full GPU object, obtained by executing Get-VMHostPartitionableGpu. + +```yaml +Type: VMHostPartitionableGpu[] +Parameter Sets: Object +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Specifies the name of the GPU. + +```yaml +Type: String +Parameter Sets: Name +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PartitionCount +Specifies the number of partitions that the GPU will assign. The number of partitions is defined by the manufacturer. + +```yaml +Type: UInt16 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Passthru +Returns an object for each process that the cmdlet started. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +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). + +## INPUTS + +### Microsoft.Management.Infrastructure.CimSession[] + +### Microsoft.HyperV.PowerShell.VMHostPartitionableGpu[] + +## OUTPUTS + +### Microsoft.HyperV.PowerShell.VMHostPartitionableGpu + +## NOTES + +## RELATED LINKS From 330c1bc71b5f7782afbbcba326e1ca53aba3760d Mon Sep 17 00:00:00 2001 From: LolaOy <103140748+LolaOy@users.noreply.github.com> Date: Mon, 7 Nov 2022 14:15:59 -0600 Subject: [PATCH 015/650] include missed review comments --- .../hyper-v/Add-VMGpuPartitionAdapter.md | 4 ++-- .../hyper-v/Get-VMGpuPartitionAdapter.md | 11 +++++------ .../hyper-v/Get-VMHostPartitionableGpu.md | 2 +- .../hyper-v/Remove-VMGpuPartitionAdapter.md | 11 +++++------ 4 files changed, 13 insertions(+), 15 deletions(-) diff --git a/docset/winserver2022-ps/hyper-v/Add-VMGpuPartitionAdapter.md b/docset/winserver2022-ps/hyper-v/Add-VMGpuPartitionAdapter.md index cbdc9ee09f..7bc54626b8 100644 --- a/docset/winserver2022-ps/hyper-v/Add-VMGpuPartitionAdapter.md +++ b/docset/winserver2022-ps/hyper-v/Add-VMGpuPartitionAdapter.md @@ -46,7 +46,7 @@ $vm = Get-VM -name "TestVM" Add-VMGpuPartitionAdapter -VM $vm ``` -Assigns a partition to a specific VM object. If you want to assign multiple GPU partitions run this command the number of times equal to the number of GPU partitions needed. +Assigns a partition to a specific VM object. ### Example 2 ```powershell @@ -381,7 +381,7 @@ Accept wildcard characters: False ``` ### CommonParameters -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). +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). ## INPUTS diff --git a/docset/winserver2022-ps/hyper-v/Get-VMGpuPartitionAdapter.md b/docset/winserver2022-ps/hyper-v/Get-VMGpuPartitionAdapter.md index ed3f711e2e..7d1998d6c5 100644 --- a/docset/winserver2022-ps/hyper-v/Get-VMGpuPartitionAdapter.md +++ b/docset/winserver2022-ps/hyper-v/Get-VMGpuPartitionAdapter.md @@ -36,12 +36,12 @@ $testvm = get-VM "TestVM" Get-VMGpuPartitionAdapter -VM $testvm ``` -Displays the GPU information assigned to a VM object +Displays the GPU information assigned to a VM object. ## PARAMETERS ### -AdapterId -A VM's GPU partition identification number used to display the GPU information assigned to a VM +This is a VM's GPU partition identification number used to display the GPU information assigned to a VM. ```yaml Type: String @@ -73,7 +73,7 @@ Accept wildcard characters: False ``` ### -ComputerName -Specifies that one or more Hyper-V hosts on the virtual network adapters are to be retrieved. +Specifies one or more Hyper-V hosts on the virtual network adapters are to be retrieved. NetBIOS names, IP addresses, and fully qualified domain names are allowed. The default is the local computer. Use localhost or a dot ('.') to specify the local computer explicitly. @@ -107,8 +107,7 @@ Accept wildcard characters: False ``` ### -VM -Specifies the virtual machine whose virtual network adapters are to be retrieved. -. The asterisk, ('*'), is the wildcard. +Specifies the virtual machine whose virtual network adapters are to be retrieved. The asterisk, ('*'), is the wildcard. If it is specified the cmdlet returns virtual network adapters from every virtual machine in the system. ```yaml @@ -120,7 +119,7 @@ Required: True Position: 0 Default value: None Accept pipeline input: True (ByValue) -Accept wildcard characters: true +Accept wildcard characters: True ``` ### -VMName diff --git a/docset/winserver2022-ps/hyper-v/Get-VMHostPartitionableGpu.md b/docset/winserver2022-ps/hyper-v/Get-VMHostPartitionableGpu.md index 8cc52abb73..0c1ce185ec 100644 --- a/docset/winserver2022-ps/hyper-v/Get-VMHostPartitionableGpu.md +++ b/docset/winserver2022-ps/hyper-v/Get-VMHostPartitionableGpu.md @@ -73,7 +73,7 @@ Accept wildcard characters: False ### -ComputerName Specifies one or more Hyper-V hosts that run this cmdlet. -NetBIOS names, IP addresses, and fully qualified domain names are allowable. +NetBIOS names, IP addresses, and fully qualified domain names are allowed. The default is the local computer. Use localhost or a dot ('.') to specify the local computer explicitly. diff --git a/docset/winserver2022-ps/hyper-v/Remove-VMGpuPartitionAdapter.md b/docset/winserver2022-ps/hyper-v/Remove-VMGpuPartitionAdapter.md index 573ed49a22..dc0efa46b7 100644 --- a/docset/winserver2022-ps/hyper-v/Remove-VMGpuPartitionAdapter.md +++ b/docset/winserver2022-ps/hyper-v/Remove-VMGpuPartitionAdapter.md @@ -45,7 +45,7 @@ $testvm = Get-VM "TestVM" Remove-VMGpuPartitionAdapter -VM $testvm ``` -Removes a partition assigned to a specific VM Object. +Removes a partition assigned to a specific VM object. ### Example 2 ```powershell @@ -54,12 +54,12 @@ $GPUpartition = Get-VMGpuPartitionAdapter -VM $testvm Remove-VMGpuPartitionAdapter -VM $testvm -AdapterId $GPUpartiton[0].id ``` -Remove a specific partition in a VM +Remove a specific partition in a VM. ## PARAMETERS ### -AdapterId -A VM's GPU partition identification number used to remove a GPU from a VM. +This is a VM's GPU partition identification number used to remove a GPU from a VM. ```yaml Type: String @@ -91,7 +91,7 @@ Accept wildcard characters: False ``` ### -ComputerName -Specifies that one or more Hyper-V hosts on the virtual network adapters are to be retrieved. NetBIOS names, IP addresses, and fully qualified domain names are allowed. +Specifies one or more Hyper-V hosts on the virtual network adapters are to be retrieved. NetBIOS names, IP addresses, and fully qualified domain names are allowed. The default is the local computer.Use localhost or a dot ('.') to specify the local computer explicitly. ```yaml @@ -107,8 +107,7 @@ Accept wildcard characters: False ``` ### -Credential -Specifies one or more user accounts that have permission to perform this action. -The default is the current user. +Specifies one or more user accounts that have permission to perform this action. The default is the current user. ```yaml Type: PSCredential[] From ae5551621499c0a96b056e00890a29b83f2ef89f Mon Sep 17 00:00:00 2001 From: LolaOy <103140748+LolaOy@users.noreply.github.com> Date: Wed, 9 Nov 2022 14:39:02 -0600 Subject: [PATCH 016/650] adding metadata details to Set-VMGpuPartitionAdapter --- docset/winserver2022-ps/hyper-v/Set-VMHostPartitionableGpu.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/hyper-v/Set-VMHostPartitionableGpu.md b/docset/winserver2022-ps/hyper-v/Set-VMHostPartitionableGpu.md index 5b28f6ab86..df43859261 100644 --- a/docset/winserver2022-ps/hyper-v/Set-VMHostPartitionableGpu.md +++ b/docset/winserver2022-ps/hyper-v/Set-VMHostPartitionableGpu.md @@ -1,7 +1,9 @@ --- +description: Assigns a partition of a GPU to a virtual machine. external help file: Microsoft.HyperV.PowerShell.Cmdlets.dll-Help.xml Module Name: Hyper-V -online version: +ms.date: 10/21/2022 +online version: https://learn.microsoft.com/en-us/powershell/module/hyper-v/set-vmhostpartitionablegpu?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 --- From ac7c8aeb867b77bedf3fc42e68f2ed5911477774 Mon Sep 17 00:00:00 2001 From: LolaOy <103140748+LolaOy@users.noreply.github.com> Date: Mon, 14 Nov 2022 16:24:24 -0600 Subject: [PATCH 017/650] Add title to each metadata section --- docset/winserver2022-ps/hyper-v/Add-VMGpuPartitionAdapter.md | 1 + docset/winserver2022-ps/hyper-v/Get-VMGpuPartitionAdapter.md | 1 + docset/winserver2022-ps/hyper-v/Get-VMHostPartitionableGpu.md | 1 + .../winserver2022-ps/hyper-v/Remove-VMGpuPartitionAdapter.md | 2 +- docset/winserver2022-ps/hyper-v/Set-VMGpuPartitionAdapter.md | 2 +- docset/winserver2022-ps/hyper-v/Set-VMHostPartitionableGpu.md | 3 ++- 6 files changed, 7 insertions(+), 3 deletions(-) diff --git a/docset/winserver2022-ps/hyper-v/Add-VMGpuPartitionAdapter.md b/docset/winserver2022-ps/hyper-v/Add-VMGpuPartitionAdapter.md index 7bc54626b8..bf3221f119 100644 --- a/docset/winserver2022-ps/hyper-v/Add-VMGpuPartitionAdapter.md +++ b/docset/winserver2022-ps/hyper-v/Add-VMGpuPartitionAdapter.md @@ -5,6 +5,7 @@ Module Name: Hyper-V ms.date: 09/22/2022 online version: https://learn.microsoft.com/en-us/powershell/module/hyper-v/add-vmgpupartitionadapter?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 +title: Add-VMGpuPartitionAdapter --- # Add-VMGpuPartitionAdapter diff --git a/docset/winserver2022-ps/hyper-v/Get-VMGpuPartitionAdapter.md b/docset/winserver2022-ps/hyper-v/Get-VMGpuPartitionAdapter.md index 7d1998d6c5..47174cc758 100644 --- a/docset/winserver2022-ps/hyper-v/Get-VMGpuPartitionAdapter.md +++ b/docset/winserver2022-ps/hyper-v/Get-VMGpuPartitionAdapter.md @@ -5,6 +5,7 @@ Module Name: Hyper-V ms.date: 09/22/2022 online version: https://learn.microsoft.com/en-us/powershell/module/hyper-v/get-vmgpupartitionadapter?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 +title: Get-VMGpuPartitionAdapter --- # Get-VMGpuPartitionAdapter diff --git a/docset/winserver2022-ps/hyper-v/Get-VMHostPartitionableGpu.md b/docset/winserver2022-ps/hyper-v/Get-VMHostPartitionableGpu.md index 0c1ce185ec..95bbc5d857 100644 --- a/docset/winserver2022-ps/hyper-v/Get-VMHostPartitionableGpu.md +++ b/docset/winserver2022-ps/hyper-v/Get-VMHostPartitionableGpu.md @@ -5,6 +5,7 @@ Module Name: Hyper-V ms.date: 09/22/2022 online version: https://learn.microsoft.com/en-us/powershell/module/hyper-v/get-vmhostpartitionablegpu?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 +title: Get-VMHostPartitionableGpu --- # Get-VMHostPartitionableGpu diff --git a/docset/winserver2022-ps/hyper-v/Remove-VMGpuPartitionAdapter.md b/docset/winserver2022-ps/hyper-v/Remove-VMGpuPartitionAdapter.md index dc0efa46b7..fc674b8c16 100644 --- a/docset/winserver2022-ps/hyper-v/Remove-VMGpuPartitionAdapter.md +++ b/docset/winserver2022-ps/hyper-v/Remove-VMGpuPartitionAdapter.md @@ -5,7 +5,7 @@ Module Name: Hyper-V ms.date: 09/22/2022 online version: https://learn.microsoft.com/en-us/powershell/module/hyper-v/remove-vmgpupartitionadapter?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 - +title: Remove-VMGpuPartitionAdapter --- # Remove-VMGpuPartitionAdapter diff --git a/docset/winserver2022-ps/hyper-v/Set-VMGpuPartitionAdapter.md b/docset/winserver2022-ps/hyper-v/Set-VMGpuPartitionAdapter.md index 244ee70795..df7373e1e0 100644 --- a/docset/winserver2022-ps/hyper-v/Set-VMGpuPartitionAdapter.md +++ b/docset/winserver2022-ps/hyper-v/Set-VMGpuPartitionAdapter.md @@ -5,7 +5,7 @@ Module Name: Hyper-V ms.date: 09/22/2022 online version: https://learn.microsoft.com/en-us/powershell/module/hyper-v/set-vmgpupartitionadapter?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 - +title: Set-VMGpuPartitionAdapter --- # Set-VMGpuPartitionAdapter diff --git a/docset/winserver2022-ps/hyper-v/Set-VMHostPartitionableGpu.md b/docset/winserver2022-ps/hyper-v/Set-VMHostPartitionableGpu.md index df43859261..4a27933799 100644 --- a/docset/winserver2022-ps/hyper-v/Set-VMHostPartitionableGpu.md +++ b/docset/winserver2022-ps/hyper-v/Set-VMHostPartitionableGpu.md @@ -1,10 +1,11 @@ --- -description: Assigns a partition of a GPU to a virtual machine. +description: Configures host partitionable GPU to the number of partitions supported by the manufacturer. external help file: Microsoft.HyperV.PowerShell.Cmdlets.dll-Help.xml Module Name: Hyper-V ms.date: 10/21/2022 online version: https://learn.microsoft.com/en-us/powershell/module/hyper-v/set-vmhostpartitionablegpu?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 +title: Set-VMHostPartitionableGpu --- # Set-VMHostPartitionableGpu From 2306c0e2fa08315425ff14a35f2b507e9cb3bccd Mon Sep 17 00:00:00 2001 From: LolaOy <103140748+LolaOy@users.noreply.github.com> Date: Tue, 15 Nov 2022 14:55:24 -0600 Subject: [PATCH 018/650] add review comments --- .../hyper-v/Add-VMGpuPartitionAdapter.md | 30 +++++++++---------- .../hyper-v/Get-VMGpuPartitionAdapter.md | 6 ++-- .../hyper-v/Get-VMHostPartitionableGpu.md | 9 +++--- .../hyper-v/Remove-VMGpuPartitionAdapter.md | 6 ++-- .../hyper-v/Set-VMGpuPartitionAdapter.md | 14 ++++----- .../hyper-v/Set-VMHostPartitionableGpu.md | 14 ++++----- 6 files changed, 39 insertions(+), 40 deletions(-) diff --git a/docset/winserver2022-ps/hyper-v/Add-VMGpuPartitionAdapter.md b/docset/winserver2022-ps/hyper-v/Add-VMGpuPartitionAdapter.md index bf3221f119..8cff32ec80 100644 --- a/docset/winserver2022-ps/hyper-v/Add-VMGpuPartitionAdapter.md +++ b/docset/winserver2022-ps/hyper-v/Add-VMGpuPartitionAdapter.md @@ -3,7 +3,7 @@ description: Adds a GPU partition adapter to a virtual machine. external help file: Microsoft.HyperV.PowerShell.Cmdlets.dll-Help.xml Module Name: Hyper-V ms.date: 09/22/2022 -online version: https://learn.microsoft.com/en-us/powershell/module/hyper-v/add-vmgpupartitionadapter?view=windowsserver2022-ps&wt.mc_id=ps-gethelp +online version: https://learn.microsoft.com/powershell/module/hyper-v/add-vmgpupartitionadapter?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Add-VMGpuPartitionAdapter --- @@ -47,7 +47,7 @@ $vm = Get-VM -name "TestVM" Add-VMGpuPartitionAdapter -VM $vm ``` -Assigns a partition to a specific VM object. +This example assigns a partition to a specific VM object. ### Example 2 ```powershell @@ -55,7 +55,7 @@ $vm = Get-VM -name "TestVM" Add-VMGpuPartitionAdapter -VM $vm -Instancepath "SampleGPUInstancePath" ``` -Assigns a partition from a specific GPU to a VM where the instance path is the GPU device ID name on the host. +This example assigns a partition from a specific GPU to a VM where the instance path is the GPU device ID name on the host. ## PARAMETERS @@ -111,7 +111,7 @@ Accept wildcard characters: False ``` ### -InstancePath -Represents the Device Instance path of a GPU in the host. This value can be obtained from the "Name" property of the command Get-VMHostPartitionableGpu +Represents the Device Instance path of a GPU in the host. This value can be obtained from the "Name" property of the command 'Get-VMHostPartitionableGpu'. ```yaml Type: String @@ -156,7 +156,7 @@ Accept wildcard characters: False ``` ### -MaxPartitionEncode -the maximum number of encoders assigned by the host GPU. This is defined by the manufacturer's driver. +The maximum number of encoders assigned by the host GPU. This is defined by the manufacturer's driver. ```yaml Type: UInt64 @@ -171,7 +171,7 @@ Accept wildcard characters: False ``` ### -MaxPartitionVRAM -the maximum VRAM supported by the host GPU. This is defined by the manufacturer's driver. +The maximum VRAM in byte supported by the host GPU. This is defined by the manufacturer's driver. ```yaml Type: UInt64 @@ -186,7 +186,7 @@ Accept wildcard characters: False ``` ### -MinPartitionCompute -the minimum number of compute assigned by the host GPU. This is defined by the manufacturer's driver. +The minimum number of compute assigned by the host GPU. This is defined by the manufacturer's driver. ```yaml Type: UInt64 @@ -201,7 +201,7 @@ Accept wildcard characters: False ``` ### -MinPartitionDecode -the minimum number of decoders assigned by the host GPU. This is defined by the manufacturer's driver. +The minimum number of decoders assigned by the host GPU. This is defined by the manufacturer's driver. ```yaml Type: UInt64 @@ -216,7 +216,7 @@ Accept wildcard characters: False ``` ### -MinPartitionEncode -the minimum number of encoders assigned by the host GPU. This is defined by the manufacturer's driver. +The minimum number of encoders assigned by the host GPU. This is defined by the manufacturer's driver. ```yaml Type: UInt64 @@ -231,7 +231,7 @@ Accept wildcard characters: False ``` ### -MinPartitionVRAM -the minimum VRAM supported by the host GPU. This is defined by the manufacturer's driver. +The minimum VRAM in byte supported by the host GPU. This is defined by the manufacturer's driver. ```yaml Type: UInt64 @@ -246,7 +246,7 @@ Accept wildcard characters: False ``` ### -OptimalPartitionCompute -the optimal number of compute assigned by the host GPU. This is defined by the manufacturer's driver. +The optimal number of compute assigned by the host GPU. This is defined by the manufacturer's driver. ```yaml Type: UInt64 @@ -260,8 +260,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -the optimalPartitionDecode -the optimal number of decoders assigned by the host GPU. This is defined by the manufacturer's driver. +### -OptimalPartitionDecode +The optimal number of decoders assigned by the host GPU. This is defined by the manufacturer's driver. ```yaml Type: UInt64 @@ -276,7 +276,7 @@ Accept wildcard characters: False ``` ### -OptimalPartitionEncode -the optimal number of encoders assigned by the host GPU. This is defined by the manufacturer's driver. +The optimal number of encoders assigned by the host GPU. This is defined by the manufacturer's driver. ```yaml Type: UInt64 @@ -291,7 +291,7 @@ Accept wildcard characters: False ``` ### -OptimalPartitionVRAM -the optimal VRAM supported by the host GPU. This is defined by the manufacturer's driver. +The optimal VRAM in byte supported by the host GPU. This is defined by the manufacturer's driver. ```yaml Type: UInt64 diff --git a/docset/winserver2022-ps/hyper-v/Get-VMGpuPartitionAdapter.md b/docset/winserver2022-ps/hyper-v/Get-VMGpuPartitionAdapter.md index 47174cc758..321ca734b1 100644 --- a/docset/winserver2022-ps/hyper-v/Get-VMGpuPartitionAdapter.md +++ b/docset/winserver2022-ps/hyper-v/Get-VMGpuPartitionAdapter.md @@ -3,7 +3,7 @@ description: Gets the information of assigned GPU partitions to a virtual machin external help file: Microsoft.HyperV.PowerShell.Cmdlets.dll-Help.xml Module Name: Hyper-V ms.date: 09/22/2022 -online version: https://learn.microsoft.com/en-us/powershell/module/hyper-v/get-vmgpupartitionadapter?view=windowsserver2022-ps&wt.mc_id=ps-gethelp +online version: https://learn.microsoft.com/powershell/module/hyper-v/get-vmgpupartitionadapter?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Get-VMGpuPartitionAdapter --- @@ -37,7 +37,7 @@ $testvm = get-VM "TestVM" Get-VMGpuPartitionAdapter -VM $testvm ``` -Displays the GPU information assigned to a VM object. +This example gets the GPU information assigned to a VM object. ## PARAMETERS @@ -108,7 +108,7 @@ Accept wildcard characters: False ``` ### -VM -Specifies the virtual machine whose virtual network adapters are to be retrieved. The asterisk, ('*'), is the wildcard. +Specifies the virtual machine whose virtual network adapters are to be retrieved. The asterisk ('*') is the wildcard. If it is specified the cmdlet returns virtual network adapters from every virtual machine in the system. ```yaml diff --git a/docset/winserver2022-ps/hyper-v/Get-VMHostPartitionableGpu.md b/docset/winserver2022-ps/hyper-v/Get-VMHostPartitionableGpu.md index 95bbc5d857..c22e441be3 100644 --- a/docset/winserver2022-ps/hyper-v/Get-VMHostPartitionableGpu.md +++ b/docset/winserver2022-ps/hyper-v/Get-VMHostPartitionableGpu.md @@ -3,7 +3,7 @@ description: Gets the host machine’s partitionable GPU. external help file: Microsoft.HyperV.PowerShell.Cmdlets.dll-Help.xml Module Name: Hyper-V ms.date: 09/22/2022 -online version: https://learn.microsoft.com/en-us/powershell/module/hyper-v/get-vmhostpartitionablegpu?view=windowsserver2022-ps&wt.mc_id=ps-gethelp +online version: https://learn.microsoft.com/powershell/module/hyper-v/get-vmhostpartitionablegpu?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Get-VMHostPartitionableGpu --- @@ -37,14 +37,14 @@ This displays the information of the GPU as provided by the manufacturer's drive Get-VMHostPartitionableGpu ``` -Gets the details of the local partitionable graphic processing unit on the host +This example gets the details of the local partitionable graphic processing unit on the host. ### Example 2 ```powershell Get-VMHostPartitionableGpu -ComputerName "SampleHost" ``` -Displays a partitionable GPU by using the host name. This command will display all the GPU devices available for partitioning in the host. +This example gets a partitionable GPU by using the host name. This command will display all the GPU devices available for partitioning in the host. ### Example 3 ```powershell @@ -91,8 +91,7 @@ Accept wildcard characters: False ``` ### -Credential -Specifies one or more user accounts that have permission to perform this action. -The default is the current user. +Specifies one or more user accounts that have permission to perform this action. The default is the current user. ```yaml Type: PSCredential[] diff --git a/docset/winserver2022-ps/hyper-v/Remove-VMGpuPartitionAdapter.md b/docset/winserver2022-ps/hyper-v/Remove-VMGpuPartitionAdapter.md index fc674b8c16..a001c23afc 100644 --- a/docset/winserver2022-ps/hyper-v/Remove-VMGpuPartitionAdapter.md +++ b/docset/winserver2022-ps/hyper-v/Remove-VMGpuPartitionAdapter.md @@ -3,7 +3,7 @@ description: Removes an assigned GPU partition from a virtual machine. external help file: Microsoft.HyperV.PowerShell.Cmdlets.dll-Help.xml Module Name: Hyper-V ms.date: 09/22/2022 -online version: https://learn.microsoft.com/en-us/powershell/module/hyper-v/remove-vmgpupartitionadapter?view=windowsserver2022-ps&wt.mc_id=ps-gethelp +online version: https://learn.microsoft.com/powershell/module/hyper-v/remove-vmgpupartitionadapter?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Remove-VMGpuPartitionAdapter --- @@ -45,7 +45,7 @@ $testvm = Get-VM "TestVM" Remove-VMGpuPartitionAdapter -VM $testvm ``` -Removes a partition assigned to a specific VM object. +This example removes a partition assigned to a specific VM object. ### Example 2 ```powershell @@ -54,7 +54,7 @@ $GPUpartition = Get-VMGpuPartitionAdapter -VM $testvm Remove-VMGpuPartitionAdapter -VM $testvm -AdapterId $GPUpartiton[0].id ``` -Remove a specific partition in a VM. +This example removes a specific partition object from a specific VM. ## PARAMETERS diff --git a/docset/winserver2022-ps/hyper-v/Set-VMGpuPartitionAdapter.md b/docset/winserver2022-ps/hyper-v/Set-VMGpuPartitionAdapter.md index df7373e1e0..a414677e20 100644 --- a/docset/winserver2022-ps/hyper-v/Set-VMGpuPartitionAdapter.md +++ b/docset/winserver2022-ps/hyper-v/Set-VMGpuPartitionAdapter.md @@ -3,7 +3,7 @@ description: Assigns a partition of a GPU to a virtual machine. external help file: Microsoft.HyperV.PowerShell.Cmdlets.dll-Help.xml Module Name: Hyper-V ms.date: 09/22/2022 -online version: https://learn.microsoft.com/en-us/powershell/module/hyper-v/set-vmgpupartitionadapter?view=windowsserver2022-ps&wt.mc_id=ps-gethelp +online version: https://learn.microsoft.com/powershell/module/hyper-v/set-vmgpupartitionadapter?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Set-VMGpuPartitionAdapter --- @@ -57,7 +57,7 @@ $vm = get-vm test Set-VMGpuPartitionAdapter -VM $vm ``` -Assign a partition to a VM passing a VM object. +This example assign a partition to a VM passing a VM object. ## PARAMETERS @@ -126,7 +126,7 @@ Accept wildcard characters: False ``` ### -MaxPartitionCompute - The maximum number of compute assigned by the host GPU. This is defined by the manufacturer's driver. +The maximum number of compute assigned by the host GPU. This is defined by the manufacturer's driver. ```yaml Type: UInt64 @@ -171,7 +171,7 @@ Accept wildcard characters: False ``` ### -MaxPartitionVRAM -The maximum VRAM supported by the host GPU. This is defined by the manufacturer's driver. +The maximum VRAM in byte supported by the host GPU. This is defined by the manufacturer's driver. ```yaml Type: UInt64 @@ -231,7 +231,7 @@ Accept wildcard characters: False ``` ### -MinPartitionVRAM -The minimum VRAM supported by the host GPU. This is defined by the manufacturer's driver. +The minimum VRAM in byte supported by the host GPU. This is defined by the manufacturer's driver. ```yaml Type: UInt64 @@ -291,7 +291,7 @@ Accept wildcard characters: False ``` ### -OptimalPartitionVRAM -The optimal VRAM supported by the host GPU. This is defined by the manufacturer's driver. +The optimal VRAM in byte supported by the host GPU. This is defined by the manufacturer's driver. ```yaml Type: UInt64 @@ -337,7 +337,7 @@ Accept wildcard characters: False ``` ### -VMGpuPartitionAdapter -GPU partition object obtained from 'Get-VMGpuPartitionAdapter'' +GPU partition object obtained from 'Get-VMGpuPartitionAdapter'. ```yaml Type: VMGpuPartitionAdapter[] diff --git a/docset/winserver2022-ps/hyper-v/Set-VMHostPartitionableGpu.md b/docset/winserver2022-ps/hyper-v/Set-VMHostPartitionableGpu.md index 4a27933799..6cca814585 100644 --- a/docset/winserver2022-ps/hyper-v/Set-VMHostPartitionableGpu.md +++ b/docset/winserver2022-ps/hyper-v/Set-VMHostPartitionableGpu.md @@ -1,9 +1,9 @@ --- -description: Configures host partitionable GPU to the number of partitions supported by the manufacturer. +description: Configures the host partitionable GPU to the number of partitions supported by the manufacturer. external help file: Microsoft.HyperV.PowerShell.Cmdlets.dll-Help.xml Module Name: Hyper-V ms.date: 10/21/2022 -online version: https://learn.microsoft.com/en-us/powershell/module/hyper-v/set-vmhostpartitionablegpu?view=windowsserver2022-ps&wt.mc_id=ps-gethelp +online version: https://learn.microsoft.com/powershell/module/hyper-v/set-vmhostpartitionablegpu?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Set-VMHostPartitionableGpu --- @@ -11,7 +11,7 @@ title: Set-VMHostPartitionableGpu # Set-VMHostPartitionableGpu ## SYNOPSIS -Configures host partitionable GPU to the number of partitions supported by the manufacturer +Configures the host partitionable GPU to the number of partitions supported by the manufacturer. ## SYNTAX @@ -39,7 +39,7 @@ Set-VMHostPartitionableGpu [-Passthru] [-Name ] [-PartitionCount Date: Tue, 15 Nov 2022 15:16:11 -0600 Subject: [PATCH 019/650] Use proper sentence casing --- docset/winserver2022-ps/hyper-v/Add-VMGpuPartitionAdapter.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/hyper-v/Add-VMGpuPartitionAdapter.md b/docset/winserver2022-ps/hyper-v/Add-VMGpuPartitionAdapter.md index 8cff32ec80..9fc0aac35f 100644 --- a/docset/winserver2022-ps/hyper-v/Add-VMGpuPartitionAdapter.md +++ b/docset/winserver2022-ps/hyper-v/Add-VMGpuPartitionAdapter.md @@ -141,7 +141,7 @@ Accept wildcard characters: False ``` ### -MaxPartitionDecode -the maximum number of decoders assigned by the host GPU. This is defined by the manufacturer's driver. +The maximum number of decoders assigned by the host GPU. This is defined by the manufacturer's driver. ```yaml Type: UInt64 From 96d6b129cf6682c1823a98884bf5b1030beca252 Mon Sep 17 00:00:00 2001 From: LolaOy <103140748+LolaOy@users.noreply.github.com> Date: Wed, 16 Nov 2022 11:58:06 -0600 Subject: [PATCH 020/650] review comment - byte supported to bytes supported --- .../winserver2022-ps/hyper-v/Add-VMGpuPartitionAdapter.md | 6 +++--- .../winserver2022-ps/hyper-v/Set-VMGpuPartitionAdapter.md | 6 +++--- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/docset/winserver2022-ps/hyper-v/Add-VMGpuPartitionAdapter.md b/docset/winserver2022-ps/hyper-v/Add-VMGpuPartitionAdapter.md index 9fc0aac35f..e86a3aa1c8 100644 --- a/docset/winserver2022-ps/hyper-v/Add-VMGpuPartitionAdapter.md +++ b/docset/winserver2022-ps/hyper-v/Add-VMGpuPartitionAdapter.md @@ -171,7 +171,7 @@ Accept wildcard characters: False ``` ### -MaxPartitionVRAM -The maximum VRAM in byte supported by the host GPU. This is defined by the manufacturer's driver. +The maximum VRAM in bytes supported by the host GPU. This is defined by the manufacturer's driver. ```yaml Type: UInt64 @@ -231,7 +231,7 @@ Accept wildcard characters: False ``` ### -MinPartitionVRAM -The minimum VRAM in byte supported by the host GPU. This is defined by the manufacturer's driver. +The minimum VRAM in bytes supported by the host GPU. This is defined by the manufacturer's driver. ```yaml Type: UInt64 @@ -291,7 +291,7 @@ Accept wildcard characters: False ``` ### -OptimalPartitionVRAM -The optimal VRAM in byte supported by the host GPU. This is defined by the manufacturer's driver. +The optimal VRAM in bytes supported by the host GPU. This is defined by the manufacturer's driver. ```yaml Type: UInt64 diff --git a/docset/winserver2022-ps/hyper-v/Set-VMGpuPartitionAdapter.md b/docset/winserver2022-ps/hyper-v/Set-VMGpuPartitionAdapter.md index a414677e20..a1171a5118 100644 --- a/docset/winserver2022-ps/hyper-v/Set-VMGpuPartitionAdapter.md +++ b/docset/winserver2022-ps/hyper-v/Set-VMGpuPartitionAdapter.md @@ -171,7 +171,7 @@ Accept wildcard characters: False ``` ### -MaxPartitionVRAM -The maximum VRAM in byte supported by the host GPU. This is defined by the manufacturer's driver. +The maximum VRAM in bytes supported by the host GPU. This is defined by the manufacturer's driver. ```yaml Type: UInt64 @@ -231,7 +231,7 @@ Accept wildcard characters: False ``` ### -MinPartitionVRAM -The minimum VRAM in byte supported by the host GPU. This is defined by the manufacturer's driver. +The minimum VRAM in bytes supported by the host GPU. This is defined by the manufacturer's driver. ```yaml Type: UInt64 @@ -291,7 +291,7 @@ Accept wildcard characters: False ``` ### -OptimalPartitionVRAM -The optimal VRAM in byte supported by the host GPU. This is defined by the manufacturer's driver. +The optimal VRAM in bytes supported by the host GPU. This is defined by the manufacturer's driver. ```yaml Type: UInt64 From 99fb4dd9e1ba2dd5f63259af24ae0dd1378b023b Mon Sep 17 00:00:00 2001 From: Sean Wheeler Date: Tue, 29 Nov 2022 17:14:01 -0600 Subject: [PATCH 021/650] fix character formatting and rebase --- docset/winserver2022-ps/hyper-v/Get-VMGpuPartitionAdapter.md | 5 +++-- .../winserver2022-ps/hyper-v/Remove-VMGpuPartitionAdapter.md | 5 +++-- docset/winserver2022-ps/hyper-v/Set-VMGpuPartitionAdapter.md | 5 +++-- 3 files changed, 9 insertions(+), 6 deletions(-) diff --git a/docset/winserver2022-ps/hyper-v/Get-VMGpuPartitionAdapter.md b/docset/winserver2022-ps/hyper-v/Get-VMGpuPartitionAdapter.md index 321ca734b1..5df16d8162 100644 --- a/docset/winserver2022-ps/hyper-v/Get-VMGpuPartitionAdapter.md +++ b/docset/winserver2022-ps/hyper-v/Get-VMGpuPartitionAdapter.md @@ -108,8 +108,9 @@ Accept wildcard characters: False ``` ### -VM -Specifies the virtual machine whose virtual network adapters are to be retrieved. The asterisk ('*') is the wildcard. -If it is specified the cmdlet returns virtual network adapters from every virtual machine in the system. +Specifies the virtual machine whose virtual network adapters are to be retrieved. The asterisk (`*`) +is the wildcard. If it is specified the cmdlet returns virtual network adapters from every virtual +machine in the system. ```yaml Type: VirtualMachine[] diff --git a/docset/winserver2022-ps/hyper-v/Remove-VMGpuPartitionAdapter.md b/docset/winserver2022-ps/hyper-v/Remove-VMGpuPartitionAdapter.md index a001c23afc..0815ce1194 100644 --- a/docset/winserver2022-ps/hyper-v/Remove-VMGpuPartitionAdapter.md +++ b/docset/winserver2022-ps/hyper-v/Remove-VMGpuPartitionAdapter.md @@ -137,8 +137,9 @@ Accept wildcard characters: False ``` ### -VM -Specifies the virtual machine whose virtual network adapters are to be retrieved. The asterisk, ('*'), is the wildcard. -If it is specified the cmdlet returns virtual network adapters from every virtual machine in the system. +Specifies the virtual machine whose virtual network adapters are to be retrieved. The asterisk (`*`) +is the wildcard. If it is specified the cmdlet returns virtual network adapters from every virtual +machine in the system. ```yaml Type: VirtualMachine[] diff --git a/docset/winserver2022-ps/hyper-v/Set-VMGpuPartitionAdapter.md b/docset/winserver2022-ps/hyper-v/Set-VMGpuPartitionAdapter.md index a1171a5118..e6311979a5 100644 --- a/docset/winserver2022-ps/hyper-v/Set-VMGpuPartitionAdapter.md +++ b/docset/winserver2022-ps/hyper-v/Set-VMGpuPartitionAdapter.md @@ -321,8 +321,9 @@ Accept wildcard characters: False ``` ### -VM -Specifies the virtual machine whose virtual network adapters are to be retrieved. The asterisk, ('*'), is the wildcard. -If it is specified the cmdlet returns virtual network adapters from every virtual machine in the system. +Specifies the virtual machine whose virtual network adapters are to be retrieved. The asterisk (`*`) +is the wildcard. If it is specified the cmdlet returns virtual network adapters from every virtual +machine in the system. ```yaml Type: VirtualMachine[] From af142c1d2608aea0f6cce77146f65bba9f4ec83f Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Wed, 30 Nov 2022 18:51:17 +0530 Subject: [PATCH 022/650] Update Set-NetAdapterSriov.md No vports parameter available for Set-NetAdapterSriov Updated the example accordingly. Fixes #https://github.com/MicrosoftDocs/windows-powershell-docs/issues/2903 --- docset/winserver2022-ps/netadapter/Set-NetAdapterSriov.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docset/winserver2022-ps/netadapter/Set-NetAdapterSriov.md b/docset/winserver2022-ps/netadapter/Set-NetAdapterSriov.md index 962c209695..34ecc1cca9 100644 --- a/docset/winserver2022-ps/netadapter/Set-NetAdapterSriov.md +++ b/docset/winserver2022-ps/netadapter/Set-NetAdapterSriov.md @@ -54,10 +54,10 @@ This command sets the number of virtual functions available to 31 on the network ### Example 2: Set the number of virtual functions and VPorts on the specified network adapter ``` -PS C:\> Set-NetAdapterSriov -Name "Ethernet 2" -NumVFs 31 -VPorts 64 -NumQueuePairsForDefaultVPort 2 -NumQueuePairsForNonDefaultVPort 2 +PS C:\> Set-NetAdapterSriov -Name "Ethernet 2" -NumVFs 31 -NumQueuePairsForDefaultVPort 2 -NumQueuePairsForNonDefaultVPort 2 ``` -This command sets the number of virtual functions to 31 and the total number of VPorts to 64. +This command sets the number of virtual functions to 31. This results in 31 virtual functions and 32 virtual machine queues (VMQ), plus 1 used by the physical function. Since the number of queue pair is set to 2 for both default and non-default ports, the total number of queue pairs used is 128. From f58f36fe13271c6c589cf5d54a57d24de1f03788 Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Wed, 30 Nov 2022 19:13:56 +0530 Subject: [PATCH 023/650] Update New-StorageTier.md Made changes to the example to reflect the tier name fixes #https://github.com/MicrosoftDocs/windows-powershell-docs/issues/2954 --- docset/winserver2022-ps/storage/New-StorageTier.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/storage/New-StorageTier.md b/docset/winserver2022-ps/storage/New-StorageTier.md index 8fe64164f3..9ed2ac55be 100644 --- a/docset/winserver2022-ps/storage/New-StorageTier.md +++ b/docset/winserver2022-ps/storage/New-StorageTier.md @@ -58,7 +58,7 @@ The **New-StorageTier** cmdlet creates a storage tier in a storage pool. ### Example 1: Create a storage tier ``` -PS C:\> New-StorageTier -StoragePoolFriendlyName "TierPool01" -FriendlyName "Standard_HDD_Tier" -MediaType HDD +PS C:\> New-StorageTier -StoragePoolFriendlyName "TierPool01" -FriendlyName "Tier11" -MediaType HDD ``` This command creates a storage tier for hard disk drives named Tier11 in the storage pool named TierPool01. From f4cb3b45998cb04ad8cd010564717d027bdfab5c Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Wed, 30 Nov 2022 19:25:35 +0530 Subject: [PATCH 024/650] Update Get-DfsnFolder.md Change the Accept wildcard characters: True for parameter -Path fixes #https://github.com/MicrosoftDocs/windows-powershell-docs/issues/2937 --- docset/winserver2019-ps/dfsn/Get-DfsnFolder.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2019-ps/dfsn/Get-DfsnFolder.md b/docset/winserver2019-ps/dfsn/Get-DfsnFolder.md index 01e2efcb10..707b1215e1 100644 --- a/docset/winserver2019-ps/dfsn/Get-DfsnFolder.md +++ b/docset/winserver2019-ps/dfsn/Get-DfsnFolder.md @@ -99,7 +99,7 @@ Required: True Position: 0 Default value: None Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False +Accept wildcard characters: True ``` ### -ThrottleLimit From 2074a1e3a3d142a8718fd1565816441970a5022c Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Wed, 30 Nov 2022 20:52:09 +0530 Subject: [PATCH 025/650] Update Set-ClusterStorageSpacesDirectDisk.md Updated the example stating that omitting the parameter indicates that the specified physical disks can be claimed. Fixes #https://github.com/MicrosoftDocs/windows-powershell-docs/issues/2910 --- .../failoverclusters/Set-ClusterStorageSpacesDirectDisk.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/failoverclusters/Set-ClusterStorageSpacesDirectDisk.md b/docset/winserver2022-ps/failoverclusters/Set-ClusterStorageSpacesDirectDisk.md index e0477a0663..5fa843cc60 100644 --- a/docset/winserver2022-ps/failoverclusters/Set-ClusterStorageSpacesDirectDisk.md +++ b/docset/winserver2022-ps/failoverclusters/Set-ClusterStorageSpacesDirectDisk.md @@ -40,7 +40,7 @@ PS C:\> Set-ClusterStorageSpacesDirectDisk -CimSession "K0619-C1.contoso.com" -C This command configures the system that physical disks that have the IDs `55CD2E404B75A3FC` and `50014EE05950DD7C` cannot be claimed by S2D. In this example, the **CanBeClaimed** parameter is -explicitly specified as `$False`. Omitting that parameter has the same effect. +explicitly specified as `$False`. Omitting that parameter indicates that the specified physical disks can be claimed. ## PARAMETERS From 2fcfee363e4a2ddd1c0baad81bbcfd40973557fc Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Thu, 1 Dec 2022 16:36:14 +0530 Subject: [PATCH 026/650] Update New-ADUser.md Updated 2012 version of the document --- docset/winserver2012-ps/activedirectory/New-ADUser.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2012-ps/activedirectory/New-ADUser.md b/docset/winserver2012-ps/activedirectory/New-ADUser.md index 44a858d498..ec7bdc4511 100644 --- a/docset/winserver2012-ps/activedirectory/New-ADUser.md +++ b/docset/winserver2012-ps/activedirectory/New-ADUser.md @@ -989,7 +989,7 @@ Accept wildcard characters: False ### -Office Specifies the location of the user's office or place of business. This parameter sets the Office property of a user object. -The LDAP display name (ldapDisplayName) of this property is "office". +The LDAP display name (ldapDisplayName) of this property is "physicalDeliveryOfficeName". The following example shows how to set this parameter. From dc797613144f73b53f3705c1761b9551b729c07e Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Thu, 1 Dec 2022 16:36:44 +0530 Subject: [PATCH 027/650] Update New-ADUser.md updated 2016 version of the document --- docset/winserver2016-ps/activedirectory/New-ADUser.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2016-ps/activedirectory/New-ADUser.md b/docset/winserver2016-ps/activedirectory/New-ADUser.md index 3c8737362c..2d64c48b2c 100644 --- a/docset/winserver2016-ps/activedirectory/New-ADUser.md +++ b/docset/winserver2016-ps/activedirectory/New-ADUser.md @@ -840,7 +840,7 @@ Accept wildcard characters: False ### -Office Specifies the location of the user's office or place of business. This parameter sets the **Office** property of a user object. -The LDAP display name (**ldapDisplayName**) of this property is office. +The LDAP display name (**ldapDisplayName**) of this property is physicalDeliveryOfficeName. ```yaml Type: String From f329fad56c6c21b5c0cd590bc41f911ab78311cb Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Thu, 1 Dec 2022 16:37:10 +0530 Subject: [PATCH 028/650] Update New-ADUser.md Updated 2019 version of the document --- docset/winserver2019-ps/activedirectory/New-ADUser.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2019-ps/activedirectory/New-ADUser.md b/docset/winserver2019-ps/activedirectory/New-ADUser.md index 908bc89c40..13ed127b26 100644 --- a/docset/winserver2019-ps/activedirectory/New-ADUser.md +++ b/docset/winserver2019-ps/activedirectory/New-ADUser.md @@ -840,7 +840,7 @@ Accept wildcard characters: False ### -Office Specifies the location of the user's office or place of business. This parameter sets the **Office** property of a user object. -The LDAP display name (**ldapDisplayName**) of this property is office. +The LDAP display name (**ldapDisplayName**) of this property is physicalDeliveryOfficeName. ```yaml Type: String From c796de613e67ad5582bf24625601081c687c1046 Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Thu, 1 Dec 2022 16:37:34 +0530 Subject: [PATCH 029/650] Update New-ADUser.md Updated 2012r2 version of the document --- docset/winserver2012r2-ps/activedirectory/New-ADUser.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2012r2-ps/activedirectory/New-ADUser.md b/docset/winserver2012r2-ps/activedirectory/New-ADUser.md index c5f77c9baf..62bf050d69 100644 --- a/docset/winserver2012r2-ps/activedirectory/New-ADUser.md +++ b/docset/winserver2012r2-ps/activedirectory/New-ADUser.md @@ -844,7 +844,7 @@ Accept wildcard characters: False ### -Office Specifies the location of the user's office or place of business. This parameter sets the **Office** property of a user object. -The LDAP display name (**ldapDisplayName**) of this property is office. +The LDAP display name (**ldapDisplayName**) of this property is physicalDeliveryOfficeName. ```yaml Type: String From adc97e76467ccc718b7cbf6be19158ef32faf434 Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Thu, 1 Dec 2022 16:40:55 +0530 Subject: [PATCH 030/650] Update Add-OdbcDsn.md Updated 2016 version of the document --- docset/winserver2016-ps/wdac/Add-OdbcDsn.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2016-ps/wdac/Add-OdbcDsn.md b/docset/winserver2016-ps/wdac/Add-OdbcDsn.md index 4e644cf79a..b88525173f 100644 --- a/docset/winserver2016-ps/wdac/Add-OdbcDsn.md +++ b/docset/winserver2016-ps/wdac/Add-OdbcDsn.md @@ -58,7 +58,7 @@ Without *PassThru*, the cmdlet does not return anything. ### Example 4: Migrates DSNs to a newer version of a driver ``` PS C:\> $DsnArray = Get-OdbcDsn -DriverName 'SQL Server Native Client 10.0' -PS C:\> ForEach ($Dsn in $ DsnArr) { +PS C:\> ForEach ($Dsn in $DsnArray) { Remove-OdbcDsn -InputObject $Dsn # You can change the property array as well, # if DSN attributes have been changed in the new driver version From 9c7235fe33db3a7bb1fd7e371764c582df51b861 Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Thu, 1 Dec 2022 16:41:16 +0530 Subject: [PATCH 031/650] Update Add-OdbcDsn.md updated 2019 version of the document --- docset/winserver2019-ps/wdac/Add-OdbcDsn.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2019-ps/wdac/Add-OdbcDsn.md b/docset/winserver2019-ps/wdac/Add-OdbcDsn.md index 46b159fb5f..2555fc7bd4 100644 --- a/docset/winserver2019-ps/wdac/Add-OdbcDsn.md +++ b/docset/winserver2019-ps/wdac/Add-OdbcDsn.md @@ -58,7 +58,7 @@ Without *PassThru*, the cmdlet does not return anything. ### Example 4: Migrates DSNs to a newer version of a driver ``` PS C:\> $DsnArray = Get-OdbcDsn -DriverName 'SQL Server Native Client 10.0' -PS C:\> ForEach ($Dsn in $ DsnArr) { +PS C:\> ForEach ($Dsn in $DsnArray) { Remove-OdbcDsn -InputObject $Dsn # You can change the property array as well, # if DSN attributes have been changed in the new driver version From 365b5550af817b76bcd4c972d842afba0b7888af Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Thu, 1 Dec 2022 16:42:44 +0530 Subject: [PATCH 032/650] Update Add-OdbcDsn.md Updated 2012 version of the document --- docset/winserver2012-ps/wdac/Add-OdbcDsn.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docset/winserver2012-ps/wdac/Add-OdbcDsn.md b/docset/winserver2012-ps/wdac/Add-OdbcDsn.md index 33d0daddb2..8adc874625 100644 --- a/docset/winserver2012-ps/wdac/Add-OdbcDsn.md +++ b/docset/winserver2012-ps/wdac/Add-OdbcDsn.md @@ -53,8 +53,8 @@ By default, this command does not return the driver object if the "PassThru" par ### 4: ``` -C:\PS> $dsnArr = Get-OdbcDsn -DriverName 'SQL Server Native Client 10.0' -C:\PS> foreach ($dsn in $dsnArr) { +C:\PS> $DsnArray = Get-OdbcDsn -DriverName 'SQL Server Native Client 10.0' +C:\PS> foreach ($dsn in $DsnArray) { Remove-OdbcDsn $dsn # You can change the property array as well, # if DSN attributes have been changed in the new driver version From 047b7d724185df27e6528fd99919daaf2cdb38ec Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Thu, 1 Dec 2022 16:43:09 +0530 Subject: [PATCH 033/650] Update Add-OdbcDsn.md updated 2012 r2 version of the document --- docset/winserver2012r2-ps/wdac/Add-OdbcDsn.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docset/winserver2012r2-ps/wdac/Add-OdbcDsn.md b/docset/winserver2012r2-ps/wdac/Add-OdbcDsn.md index 2ab96ead2f..52e1e32cfb 100644 --- a/docset/winserver2012r2-ps/wdac/Add-OdbcDsn.md +++ b/docset/winserver2012r2-ps/wdac/Add-OdbcDsn.md @@ -56,8 +56,8 @@ Without **PassThru**, the cmdlet does not return anything. ### Example 4: Migrates DSNs to a newer version of a driver ``` -PS C:\> $dsnArr = Get-OdbcDsn -DriverName 'SQL Server Native Client 10.0' -PS C:\> foreach ($dsn in $dsnArr) { +PS C:\> $DsnArray = Get-OdbcDsn -DriverName 'SQL Server Native Client 10.0' +PS C:\> foreach ($dsn in $DsnArray) { Remove-OdbcDsn -InputObject $dsn # You can change the property array as well, # if DSN attributes have been changed in the new driver version From 39009494ff0ee6761dbc089ff1972fdc1b48f222 Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Thu, 1 Dec 2022 16:46:16 +0530 Subject: [PATCH 034/650] Update Set-NetAdapterSriov.md updated 2012 version of the document --- docset/winserver2012-ps/netadapter/Set-NetAdapterSriov.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docset/winserver2012-ps/netadapter/Set-NetAdapterSriov.md b/docset/winserver2012-ps/netadapter/Set-NetAdapterSriov.md index 6fa841f191..abe193c271 100644 --- a/docset/winserver2012-ps/netadapter/Set-NetAdapterSriov.md +++ b/docset/winserver2012-ps/netadapter/Set-NetAdapterSriov.md @@ -48,10 +48,10 @@ This example sets the number of VFs available to 31 on the network adapter named ### EXAMPLE 2 ``` -PS C:\>Set-NetAdapterSriov -Name "Ethernet 2" -NumVFs 31 -VPorts 64 -NumQueuePairsForDefaultVPort 2 -NumQueuePairsForNonDefaultVPort 2 +PS C:\>Set-NetAdapterSriov -Name "Ethernet 2" -NumVFs 31 -NumQueuePairsForDefaultVPort 2 -NumQueuePairsForNonDefaultVPort 2 ``` -This example sets the number of VFs to 31 and the total number of VPorts to 64. +This example sets the number of VFs to 31. This will result in 31 VF and `32` virtual machine queue (VMQ), plus 1 used by the physical function (PF). Since the number of queue pair is set to 2 for both default and non-default ports, the total number of queue pairs used will be `128`. From bd4c94280740215eaf9a0a3529bdaaf6752f481b Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Thu, 1 Dec 2022 16:46:39 +0530 Subject: [PATCH 035/650] Update Set-NetAdapterSriov.md updated 2016 version of the document --- docset/winserver2016-ps/netadapter/Set-NetAdapterSriov.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docset/winserver2016-ps/netadapter/Set-NetAdapterSriov.md b/docset/winserver2016-ps/netadapter/Set-NetAdapterSriov.md index 1eed29d4e5..74307ca1d3 100644 --- a/docset/winserver2016-ps/netadapter/Set-NetAdapterSriov.md +++ b/docset/winserver2016-ps/netadapter/Set-NetAdapterSriov.md @@ -54,10 +54,10 @@ This command sets the number of virtual functions available to 31 on the network ### Example 2: Set the number of virtual functions and VPorts on the specified network adapter ``` -PS C:\> Set-NetAdapterSriov -Name "Ethernet 2" -NumVFs 31 -VPorts 64 -NumQueuePairsForDefaultVPort 2 -NumQueuePairsForNonDefaultVPort 2 +PS C:\> Set-NetAdapterSriov -Name "Ethernet 2" -NumVFs 31 -NumQueuePairsForDefaultVPort 2 -NumQueuePairsForNonDefaultVPort 2 ``` -This command sets the number of virtual functions to 31 and the total number of VPorts to 64. +This command sets the number of virtual functions to 31. This results in 31 virtual functions and 32 virtual machine queues (VMQ), plus 1 used by the physical function. Since the number of queue pair is set to 2 for both default and non-default ports, the total number of queue pairs used is 128. From a401331f93cb1af6946b2fbf5875ac97d5692c5c Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Thu, 1 Dec 2022 16:47:04 +0530 Subject: [PATCH 036/650] Update Set-NetAdapterSriov.md updated 2019 version of the document --- docset/winserver2019-ps/netadapter/Set-NetAdapterSriov.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docset/winserver2019-ps/netadapter/Set-NetAdapterSriov.md b/docset/winserver2019-ps/netadapter/Set-NetAdapterSriov.md index 43085866d1..e27112b4a3 100644 --- a/docset/winserver2019-ps/netadapter/Set-NetAdapterSriov.md +++ b/docset/winserver2019-ps/netadapter/Set-NetAdapterSriov.md @@ -54,10 +54,10 @@ This command sets the number of virtual functions available to 31 on the network ### Example 2: Set the number of virtual functions and VPorts on the specified network adapter ``` -PS C:\> Set-NetAdapterSriov -Name "Ethernet 2" -NumVFs 31 -VPorts 64 -NumQueuePairsForDefaultVPort 2 -NumQueuePairsForNonDefaultVPort 2 +PS C:\> Set-NetAdapterSriov -Name "Ethernet 2" -NumVFs 31 -NumQueuePairsForDefaultVPort 2 -NumQueuePairsForNonDefaultVPort 2 ``` -This command sets the number of virtual functions to 31 and the total number of VPorts to 64. +This command sets the number of virtual functions to 31. This results in 31 virtual functions and 32 virtual machine queues (VMQ), plus 1 used by the physical function. Since the number of queue pair is set to 2 for both default and non-default ports, the total number of queue pairs used is 128. From e90778e1d71cdfeb3c73f60fa54afd6d3d069eb8 Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Thu, 1 Dec 2022 16:47:30 +0530 Subject: [PATCH 037/650] Update Set-NetAdapterSriov.md updated 2012r2 version of the document --- docset/winserver2012r2-ps/netadapter/Set-NetAdapterSriov.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docset/winserver2012r2-ps/netadapter/Set-NetAdapterSriov.md b/docset/winserver2012r2-ps/netadapter/Set-NetAdapterSriov.md index a62748b2c0..82456c31c6 100644 --- a/docset/winserver2012r2-ps/netadapter/Set-NetAdapterSriov.md +++ b/docset/winserver2012r2-ps/netadapter/Set-NetAdapterSriov.md @@ -53,10 +53,10 @@ This example sets the number of VFs available to 31 on the network adapter named ### EXAMPLE 2 ``` -PS C:\>Set-NetAdapterSriov -Name "Ethernet 2" -NumVFs 31 -VPorts 64 -NumQueuePairsForDefaultVPort 2 -NumQueuePairsForNonDefaultVPort 2 +PS C:\>Set-NetAdapterSriov -Name "Ethernet 2" -NumVFs 31 -NumQueuePairsForDefaultVPort 2 -NumQueuePairsForNonDefaultVPort 2 ``` -This example sets the number of VFs to 31 and the total number of VPorts to 64. +This example sets the number of VFs to 31. This will result in 31 VF and `32` virtual machine queue (VMQ), plus 1 used by the physical function (PF). Since the number of queue pair is set to 2 for both default and non-default ports, the total number of queue pairs used will be `128`. From d468fa07ec958e85466ca65627ced145d9199954 Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Thu, 1 Dec 2022 16:50:49 +0530 Subject: [PATCH 038/650] Update Set-ClusterStorageSpacesDirectDisk.md updated 2016 version of the document --- .../failoverclusters/Set-ClusterStorageSpacesDirectDisk.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2016-ps/failoverclusters/Set-ClusterStorageSpacesDirectDisk.md b/docset/winserver2016-ps/failoverclusters/Set-ClusterStorageSpacesDirectDisk.md index a4069455f8..cc941f7ae4 100644 --- a/docset/winserver2016-ps/failoverclusters/Set-ClusterStorageSpacesDirectDisk.md +++ b/docset/winserver2016-ps/failoverclusters/Set-ClusterStorageSpacesDirectDisk.md @@ -36,7 +36,7 @@ PS C:\> Set-ClusterStorageSpacesDirectDisk -CimSession "K0619-C1.contoso.com" -C This command configures the system that physical disks that have the IDs 55CD2E404B75A3FC and 50014EE05950DD7C cannot be claimed by S2D. In this example, the *CanBeClaimed* parameter is explicitly specified as $False. -Omitting that parameter has the same effect. +Omitting that parameter indicates that the specified physical disks can be claimed. ## PARAMETERS From 122945a908195b52f4bc0e599214eb3477366f03 Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Thu, 1 Dec 2022 16:51:08 +0530 Subject: [PATCH 039/650] Update Set-ClusterStorageSpacesDirectDisk.md updated 2019 version of the document. --- .../failoverclusters/Set-ClusterStorageSpacesDirectDisk.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2019-ps/failoverclusters/Set-ClusterStorageSpacesDirectDisk.md b/docset/winserver2019-ps/failoverclusters/Set-ClusterStorageSpacesDirectDisk.md index f4163d078c..85e0a8641e 100644 --- a/docset/winserver2019-ps/failoverclusters/Set-ClusterStorageSpacesDirectDisk.md +++ b/docset/winserver2019-ps/failoverclusters/Set-ClusterStorageSpacesDirectDisk.md @@ -36,7 +36,7 @@ PS C:\> Set-ClusterStorageSpacesDirectDisk -CimSession "K0619-C1.contoso.com" -C This command configures the system that physical disks that have the IDs 55CD2E404B75A3FC and 50014EE05950DD7C cannot be claimed by S2D. In this example, the *CanBeClaimed* parameter is explicitly specified as $False. -Omitting that parameter has the same effect. +Omitting that parameter indicates that the specified physical disks can be claimed. ## PARAMETERS From 4a59410fd928d65b293e6933b99cb397dc2cc5e7 Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Thu, 1 Dec 2022 16:52:38 +0530 Subject: [PATCH 040/650] Update Get-DfsnFolder.md updated 2012 version of the document --- docset/winserver2012-ps/dfsn/Get-DfsnFolder.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2012-ps/dfsn/Get-DfsnFolder.md b/docset/winserver2012-ps/dfsn/Get-DfsnFolder.md index 628ff2b12d..e51619ffec 100644 --- a/docset/winserver2012-ps/dfsn/Get-DfsnFolder.md +++ b/docset/winserver2012-ps/dfsn/Get-DfsnFolder.md @@ -89,7 +89,7 @@ Required: True Position: 0 Default value: None Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False +Accept wildcard characters: True ``` ### -ThrottleLimit From 8f6d38829236af4a9405654c6c257cd945656371 Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Thu, 1 Dec 2022 16:53:01 +0530 Subject: [PATCH 041/650] Update Get-DfsnFolder.md updated 2016 version of the document --- docset/winserver2016-ps/dfsn/Get-DfsnFolder.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2016-ps/dfsn/Get-DfsnFolder.md b/docset/winserver2016-ps/dfsn/Get-DfsnFolder.md index abe64a4f49..03c1e23766 100644 --- a/docset/winserver2016-ps/dfsn/Get-DfsnFolder.md +++ b/docset/winserver2016-ps/dfsn/Get-DfsnFolder.md @@ -99,7 +99,7 @@ Required: True Position: 0 Default value: None Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False +Accept wildcard characters: True ``` ### -ThrottleLimit From 2aa35485f2b5021cfce5745c5022f853279ef713 Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Thu, 1 Dec 2022 16:53:22 +0530 Subject: [PATCH 042/650] Update Get-DfsnFolder.md updated 2022 version of the document --- docset/winserver2022-ps/dfsn/Get-DfsnFolder.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/dfsn/Get-DfsnFolder.md b/docset/winserver2022-ps/dfsn/Get-DfsnFolder.md index 011a41e7e9..64de12cd53 100644 --- a/docset/winserver2022-ps/dfsn/Get-DfsnFolder.md +++ b/docset/winserver2022-ps/dfsn/Get-DfsnFolder.md @@ -99,7 +99,7 @@ Required: True Position: 0 Default value: None Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False +Accept wildcard characters: True ``` ### -ThrottleLimit From d4e2a9b3c81bb41a04b9eca8c6fb48bde4741ccb Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Thu, 1 Dec 2022 16:53:44 +0530 Subject: [PATCH 043/650] Update Get-DfsnFolder.md updated 2012R2 version of the document --- docset/winserver2012r2-ps/dfsn/Get-DfsnFolder.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2012r2-ps/dfsn/Get-DfsnFolder.md b/docset/winserver2012r2-ps/dfsn/Get-DfsnFolder.md index 452806161e..48c6811b5e 100644 --- a/docset/winserver2012r2-ps/dfsn/Get-DfsnFolder.md +++ b/docset/winserver2012r2-ps/dfsn/Get-DfsnFolder.md @@ -91,7 +91,7 @@ Required: True Position: 0 Default value: None Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False +Accept wildcard characters: True ``` ### -ThrottleLimit From 24cb562e1ff382e91d0b917c025b751ad3f65c81 Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Thu, 1 Dec 2022 16:55:16 +0530 Subject: [PATCH 044/650] Update New-StorageTier.md Updated the 2012r2 version of the document --- docset/winserver2012r2-ps/storage/New-StorageTier.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2012r2-ps/storage/New-StorageTier.md b/docset/winserver2012r2-ps/storage/New-StorageTier.md index 25dea5f314..c22cbdec72 100644 --- a/docset/winserver2012r2-ps/storage/New-StorageTier.md +++ b/docset/winserver2012r2-ps/storage/New-StorageTier.md @@ -45,7 +45,7 @@ The **New-StorageTier** cmdlet creates a storage tier in a storage pool. ### Example 1: Create a storage tier ``` -PS C:\> New-StorageTier -StoragePoolFriendlyName "TierPool01" -FriendlyName "Standard_HDD_Tier" -MediaType HDD +PS C:\> New-StorageTier -StoragePoolFriendlyName "TierPool01" -FriendlyName "Tier11" -MediaType HDD ``` This command creates a storage tier for hard disk drives named Tier11 in the storage pool named TierPool01. From fdb1661a288c40b73ad071fc70cec4a23f4c74e0 Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Thu, 1 Dec 2022 16:55:40 +0530 Subject: [PATCH 045/650] Update New-StorageTier.md updated 2016 version of the document --- docset/winserver2016-ps/storage/New-StorageTier.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2016-ps/storage/New-StorageTier.md b/docset/winserver2016-ps/storage/New-StorageTier.md index 4ad21973bc..7d6d033970 100644 --- a/docset/winserver2016-ps/storage/New-StorageTier.md +++ b/docset/winserver2016-ps/storage/New-StorageTier.md @@ -58,7 +58,7 @@ The **New-StorageTier** cmdlet creates a storage tier in a storage pool. ### Example 1: Create a storage tier ``` -PS C:\> New-StorageTier -StoragePoolFriendlyName "TierPool01" -FriendlyName "Standard_HDD_Tier" -MediaType HDD +PS C:\> New-StorageTier -StoragePoolFriendlyName "TierPool01" -FriendlyName "Tier11" -MediaType HDD ``` This command creates a storage tier for hard disk drives named Tier11 in the storage pool named TierPool01. From af96b734c3175703853dbf97097faaff4b92ff9d Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Thu, 1 Dec 2022 16:56:03 +0530 Subject: [PATCH 046/650] Update New-StorageTier.md updated 2019 version of the document --- docset/winserver2019-ps/storage/New-StorageTier.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2019-ps/storage/New-StorageTier.md b/docset/winserver2019-ps/storage/New-StorageTier.md index b073476e93..2785d081d5 100644 --- a/docset/winserver2019-ps/storage/New-StorageTier.md +++ b/docset/winserver2019-ps/storage/New-StorageTier.md @@ -58,7 +58,7 @@ The **New-StorageTier** cmdlet creates a storage tier in a storage pool. ### Example 1: Create a storage tier ``` -PS C:\> New-StorageTier -StoragePoolFriendlyName "TierPool01" -FriendlyName "Standard_HDD_Tier" -MediaType HDD +PS C:\> New-StorageTier -StoragePoolFriendlyName "TierPool01" -FriendlyName "Tier11" -MediaType HDD ``` This command creates a storage tier for hard disk drives named Tier11 in the storage pool named TierPool01. From 1507fa7739987df8fcb658324f3a32e0da3e1b59 Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Thu, 1 Dec 2022 16:58:18 +0530 Subject: [PATCH 047/650] Update Set-NetTCPSetting.md updated 2016 version of the document --- docset/winserver2016-ps/nettcpip/Set-NetTCPSetting.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docset/winserver2016-ps/nettcpip/Set-NetTCPSetting.md b/docset/winserver2016-ps/nettcpip/Set-NetTCPSetting.md index 1859d01566..ab3dd43927 100644 --- a/docset/winserver2016-ps/nettcpip/Set-NetTCPSetting.md +++ b/docset/winserver2016-ps/nettcpip/Set-NetTCPSetting.md @@ -104,9 +104,9 @@ Accept wildcard characters: False ``` ### -AutoReusePortRangeStartPort -Specifies the number of ports for the auto-reuse port range, which is a port range used for local ephemeral port selection by outbound TCP connections for which either SO_REUSE_UNICASTPORT has been set on the socket, or for which connect() has been called without calling bind() on the socket. +Specifies the starting port for the auto-reuse port range. -If you specify 0, the auto-reuse feature is disabled and ephemeral ports are drawn instead from the dynamic port range as specified by *DynamicPortRangeStartPort* and *DynamicPortRangeNumberOfPorts*, even if SO_REUSE_UNICASTPORT is set on a socket. +This parameter sets the starting port to send and receive TCP traffic, which is a port range used for local ephemeral port selection by outbound TCP connections for which either SO_REUSE_UNICASTPORT has been set on the socket, or for which connect() has been called without calling bind() on the socket. ```yaml Type: UInt16 From f5985367267af9771768ea3178ce72de1a77c611 Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Thu, 1 Dec 2022 16:58:44 +0530 Subject: [PATCH 048/650] Update Set-NetTCPSetting.md Updated 2019 version of the document --- docset/winserver2019-ps/nettcpip/Set-NetTCPSetting.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docset/winserver2019-ps/nettcpip/Set-NetTCPSetting.md b/docset/winserver2019-ps/nettcpip/Set-NetTCPSetting.md index 7437f4de59..9b4026b327 100644 --- a/docset/winserver2019-ps/nettcpip/Set-NetTCPSetting.md +++ b/docset/winserver2019-ps/nettcpip/Set-NetTCPSetting.md @@ -104,9 +104,9 @@ Accept wildcard characters: False ``` ### -AutoReusePortRangeStartPort -Specifies the number of ports for the auto-reuse port range, which is a port range used for local ephemeral port selection by outbound TCP connections for which either SO_REUSE_UNICASTPORT has been set on the socket, or for which connect() has been called without calling bind() on the socket. +Specifies the starting port for the auto-reuse port range. -If you specify 0, the auto-reuse feature is disabled and ephemeral ports are drawn instead from the dynamic port range as specified by *DynamicPortRangeStartPort* and *DynamicPortRangeNumberOfPorts*, even if SO_REUSE_UNICASTPORT is set on a socket. +This parameter sets the starting port to send and receive TCP traffic, which is a port range used for local ephemeral port selection by outbound TCP connections for which either SO_REUSE_UNICASTPORT has been set on the socket, or for which connect() has been called without calling bind() on the socket. ```yaml Type: UInt16 From 5d7ad85235bf06ff80183883086066c7abfec712 Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Thu, 1 Dec 2022 16:59:09 +0530 Subject: [PATCH 049/650] Update Set-NetTCPSetting.md updated 2012R2 version of the document --- docset/winserver2012r2-ps/nettcpip/Set-NetTCPSetting.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docset/winserver2012r2-ps/nettcpip/Set-NetTCPSetting.md b/docset/winserver2012r2-ps/nettcpip/Set-NetTCPSetting.md index bf3d87b3c1..58d3534e6d 100644 --- a/docset/winserver2012r2-ps/nettcpip/Set-NetTCPSetting.md +++ b/docset/winserver2012r2-ps/nettcpip/Set-NetTCPSetting.md @@ -93,9 +93,9 @@ Accept wildcard characters: False ``` ### -AutoReusePortRangeStartPort -Specifies the number of ports for the auto-reuse port range, which is a port range used for local ephemeral port selection by outbound TCP connections for which either SO_REUSE_UNICASTPORT has been set on the socket, or for which connect() has been called without calling bind() on the socket. +Specifies the starting port for the auto-reuse port range. -If you specify 0, the auto-reuse feature is disabled and ephemeral ports are drawn instead from the dynamic port range as specified by *DynamicPortRangeStartPort* and *DynamicPortRangeNumberOfPorts*, even if SO_REUSE_UNICASTPORT is set on a socket. +This parameter sets the starting port to send and receive TCP traffic, which is a port range used for local ephemeral port selection by outbound TCP connections for which either SO_REUSE_UNICASTPORT has been set on the socket, or for which connect() has been called without calling bind() on the socket. ```yaml Type: UInt16 From 839b876ac5df0048381a33ace5e012d9f44763fc Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Fri, 2 Dec 2022 20:04:01 +0530 Subject: [PATCH 050/650] Update docset/winserver2012r2-ps/nettcpip/Set-NetTCPSetting.md Co-authored-by: Dario Woitasen <33589238+dariomws@users.noreply.github.com> --- docset/winserver2012r2-ps/nettcpip/Set-NetTCPSetting.md | 1 - 1 file changed, 1 deletion(-) diff --git a/docset/winserver2012r2-ps/nettcpip/Set-NetTCPSetting.md b/docset/winserver2012r2-ps/nettcpip/Set-NetTCPSetting.md index 58d3534e6d..60d357506b 100644 --- a/docset/winserver2012r2-ps/nettcpip/Set-NetTCPSetting.md +++ b/docset/winserver2012r2-ps/nettcpip/Set-NetTCPSetting.md @@ -93,7 +93,6 @@ Accept wildcard characters: False ``` ### -AutoReusePortRangeStartPort -Specifies the starting port for the auto-reuse port range. This parameter sets the starting port to send and receive TCP traffic, which is a port range used for local ephemeral port selection by outbound TCP connections for which either SO_REUSE_UNICASTPORT has been set on the socket, or for which connect() has been called without calling bind() on the socket. From 2c0883aef0d83b67029964ced242034f6f65d8ba Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Fri, 2 Dec 2022 20:04:06 +0530 Subject: [PATCH 051/650] Update docset/winserver2012r2-ps/nettcpip/Set-NetTCPSetting.md Co-authored-by: Dario Woitasen <33589238+dariomws@users.noreply.github.com> --- docset/winserver2012r2-ps/nettcpip/Set-NetTCPSetting.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docset/winserver2012r2-ps/nettcpip/Set-NetTCPSetting.md b/docset/winserver2012r2-ps/nettcpip/Set-NetTCPSetting.md index 60d357506b..5c27ccd9d8 100644 --- a/docset/winserver2012r2-ps/nettcpip/Set-NetTCPSetting.md +++ b/docset/winserver2012r2-ps/nettcpip/Set-NetTCPSetting.md @@ -94,7 +94,9 @@ Accept wildcard characters: False ### -AutoReusePortRangeStartPort -This parameter sets the starting port to send and receive TCP traffic, which is a port range used for local ephemeral port selection by outbound TCP connections for which either SO_REUSE_UNICASTPORT has been set on the socket, or for which connect() has been called without calling bind() on the socket. +Specifies the starting port for the auto-reuse port range, which is a port range used for local ephemeral port selection by outbound TCP connections for which either SO_REUSE_UNICASTPORT has been set on the socket, or for which connect() has been called without calling bind() on the socket. + +This parameter is required if you specify a value other than 0 for the AutoReusePortRangeStartPort parameter. ```yaml Type: UInt16 From 443607a1a70a87b85493b8616ee12f095d5ccbc3 Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Fri, 2 Dec 2022 20:04:30 +0530 Subject: [PATCH 052/650] Update docset/winserver2012-ps/wdac/Add-OdbcDsn.md Co-authored-by: Dario Woitasen <33589238+dariomws@users.noreply.github.com> --- docset/winserver2012-ps/wdac/Add-OdbcDsn.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2012-ps/wdac/Add-OdbcDsn.md b/docset/winserver2012-ps/wdac/Add-OdbcDsn.md index 8adc874625..8aa37df68a 100644 --- a/docset/winserver2012-ps/wdac/Add-OdbcDsn.md +++ b/docset/winserver2012-ps/wdac/Add-OdbcDsn.md @@ -51,7 +51,7 @@ PS C:\> $newDsn = Add-OdbcDsn MyPayroll -DriverName "SQL Server Native Client 10 This command is equivalent to example 2, but it saves the newly-created System DSN object into a PowerShell variable for future use. By default, this command does not return the driver object if the "PassThru" parameter is not specified: -### 4: +### Example 4: Migrates DSNs to a newer version of a driver ``` C:\PS> $DsnArray = Get-OdbcDsn -DriverName 'SQL Server Native Client 10.0' C:\PS> foreach ($dsn in $DsnArray) { From f3f26d9317d28de92e66a6298da8d87677d3deab Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Sat, 3 Dec 2022 00:11:06 +0530 Subject: [PATCH 053/650] Update Set-NetAdapterSriov.md updated 2012 version of the article --- docset/winserver2012-ps/netadapter/Set-NetAdapterSriov.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2012-ps/netadapter/Set-NetAdapterSriov.md b/docset/winserver2012-ps/netadapter/Set-NetAdapterSriov.md index abe193c271..59edcb1d53 100644 --- a/docset/winserver2012-ps/netadapter/Set-NetAdapterSriov.md +++ b/docset/winserver2012-ps/netadapter/Set-NetAdapterSriov.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Set-NetAdapterSriov ## SYNOPSIS -Sets the Single-Root I/O Virtualization (SR-IOV) properties of the network adapter, such as the number of virtual functions (VFs), the number of virtual ports (VPorts), and the number of queue pairs for default and non-default VPorts. +Sets the Single-Root I/O Virtualization (SR-IOV) properties of the network adapter, such as the number of virtual functions (VFs), and the number of queue pairs for default and non-default VPorts. ## SYNTAX From eccd5023ada0ef5b58098bcfef72394e72101f3b Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Sat, 3 Dec 2022 00:13:08 +0530 Subject: [PATCH 054/650] Update Set-NetAdapterSriov.md updated 2016 version of the article --- docset/winserver2016-ps/netadapter/Set-NetAdapterSriov.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2016-ps/netadapter/Set-NetAdapterSriov.md b/docset/winserver2016-ps/netadapter/Set-NetAdapterSriov.md index 74307ca1d3..8d0e8b7907 100644 --- a/docset/winserver2016-ps/netadapter/Set-NetAdapterSriov.md +++ b/docset/winserver2016-ps/netadapter/Set-NetAdapterSriov.md @@ -11,7 +11,7 @@ title: Set-NetAdapterSriov # Set-NetAdapterSriov ## SYNOPSIS -Sets the SR-IOV properties of the network adapter, such as the number of virtual functions, the number of VPorts, and the number of queue pairs for default and non-default VPorts. +Sets the SR-IOV properties of the network adapter, such as the number of virtual functions, and the number of queue pairs for default and non-default VPorts. ## SYNTAX From c9ea90e8159a0913efece28e4972d9bc996219b5 Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Sat, 3 Dec 2022 00:15:14 +0530 Subject: [PATCH 055/650] Update Set-NetAdapterSriov.md Updated 2019 version of the article --- docset/winserver2019-ps/netadapter/Set-NetAdapterSriov.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2019-ps/netadapter/Set-NetAdapterSriov.md b/docset/winserver2019-ps/netadapter/Set-NetAdapterSriov.md index e27112b4a3..b1b7acd8e8 100644 --- a/docset/winserver2019-ps/netadapter/Set-NetAdapterSriov.md +++ b/docset/winserver2019-ps/netadapter/Set-NetAdapterSriov.md @@ -38,7 +38,7 @@ Set-NetAdapterSriov -InputObject [-NumVFs ] [-Enabled Date: Sat, 3 Dec 2022 00:15:54 +0530 Subject: [PATCH 056/650] Update Set-NetAdapterSriov.md updated the 2022 version of the article --- docset/winserver2022-ps/netadapter/Set-NetAdapterSriov.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/netadapter/Set-NetAdapterSriov.md b/docset/winserver2022-ps/netadapter/Set-NetAdapterSriov.md index 34ecc1cca9..aebe32af26 100644 --- a/docset/winserver2022-ps/netadapter/Set-NetAdapterSriov.md +++ b/docset/winserver2022-ps/netadapter/Set-NetAdapterSriov.md @@ -11,7 +11,7 @@ title: Set-NetAdapterSriov # Set-NetAdapterSriov ## SYNOPSIS -Sets the SR-IOV properties of the network adapter, such as the number of virtual functions, the number of VPorts, and the number of queue pairs for default and non-default VPorts. +Sets the SR-IOV properties of the network adapter, such as the number of virtual functions, and the number of queue pairs for default and non-default VPorts. ## SYNTAX From 2974b6db5a80df2da88cd6880ba204fb5998db2f Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Sat, 3 Dec 2022 00:20:14 +0530 Subject: [PATCH 057/650] Update Set-NetAdapterSriov.md updated 2012 R2version of the article --- docset/winserver2012r2-ps/netadapter/Set-NetAdapterSriov.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2012r2-ps/netadapter/Set-NetAdapterSriov.md b/docset/winserver2012r2-ps/netadapter/Set-NetAdapterSriov.md index 82456c31c6..2322ee3335 100644 --- a/docset/winserver2012r2-ps/netadapter/Set-NetAdapterSriov.md +++ b/docset/winserver2012r2-ps/netadapter/Set-NetAdapterSriov.md @@ -10,7 +10,7 @@ title: Set-NetAdapterSriov # Set-NetAdapterSriov ## SYNOPSIS -Sets the Single-Root I/O Virtualization (SR-IOV) properties of the network adapter, such as the number of virtual functions (VFs), the number of virtual ports (VPorts), and the number of queue pairs for default and non-default VPorts. +Sets the Single-Root I/O Virtualization (SR-IOV) properties of the network adapter, such as the number of virtual functions (VFs), and the number of queue pairs for default and non-default VPorts. ## SYNTAX From 4d7d4108b7d4ee54bff03771f7137510d9213e14 Mon Sep 17 00:00:00 2001 From: Denise Vangel-MSFT Date: Tue, 3 Jan 2023 11:37:25 -0800 Subject: [PATCH 058/650] Update Set-MpPreference.md --- docset/winserver2022-ps/defender/Set-MpPreference.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/defender/Set-MpPreference.md b/docset/winserver2022-ps/defender/Set-MpPreference.md index 0a89cc1fcf..bedccf9973 100644 --- a/docset/winserver2022-ps/defender/Set-MpPreference.md +++ b/docset/winserver2022-ps/defender/Set-MpPreference.md @@ -2,7 +2,7 @@ description: The Set-MpPreference cmdlet configures preferences for Windows Defender scans and updates. external help file: MSFT_MpPreference.cdxml-help.xml Module Name: Defender -ms.date: 09/20/2022 +ms.date: 01/03/2023 online version: https://learn.microsoft.com/powershell/module/defender/set-mppreference?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Set-MpPreference From 3d70648870b769f980cd03a9e0099ce5cc58954f Mon Sep 17 00:00:00 2001 From: robinharwood <19212983+robinharwood@users.noreply.github.com> Date: Wed, 23 Nov 2022 00:31:10 +0000 Subject: [PATCH 059/650] Buld update of examples --- .../Remove-ClusterCheckpoint.md | 19 +++----- .../Remove-ClusterFaultDomain.md | 10 ++--- .../failoverclusters/Remove-ClusterGroup.md | 22 +++++----- .../Remove-ClusterGroupFromSet.md | 9 ++-- .../Remove-ClusterGroupSet.md | 10 ++--- .../Remove-ClusterGroupSetDependency.md | 14 +++--- .../failoverclusters/Remove-ClusterNode.md | 15 ++++--- .../Remove-ClusterResource.md | 14 +++--- .../Remove-ClusterResourceDependency.md | 29 ++++++------- .../Remove-ClusterResourceType.md | 8 ++-- .../Remove-ClusterSharedVolume.md | 20 +++------ .../Remove-ClusterVMMonitoredItem.md | 14 +++--- .../Repair-ClusterStorageSpacesDirect.md | 11 +++-- .../Reset-ClusterVMMonitoredState.md | 8 ++-- .../failoverclusters/Resume-ClusterNode.md | 32 +++++--------- .../Resume-ClusterResource.md | 20 +++------ .../Set-ClusterFaultDomain.md | 12 +++--- .../Set-ClusterFaultDomainXML.md | 15 +++---- .../failoverclusters/Set-ClusterGroupSet.md | 10 ++--- .../failoverclusters/Set-ClusterLog.md | 18 +++----- .../failoverclusters/Set-ClusterOwnerNode.md | 18 ++++---- .../failoverclusters/Set-ClusterParameter.md | 43 ++++--------------- .../failoverclusters/Set-ClusterQuorum.md | 41 +++++++++--------- .../Set-ClusterResourceDependency.md | 29 ++++++++----- .../Set-ClusterStorageSpacesDirect.md | 10 ++--- .../Set-ClusterStorageSpacesDirectDisk.md | 20 ++++++--- .../failoverclusters/Start-Cluster.md | 20 +++------ .../failoverclusters/Start-ClusterGroup.md | 22 ++++------ .../failoverclusters/Start-ClusterNode.md | 27 ++++-------- 29 files changed, 234 insertions(+), 306 deletions(-) diff --git a/docset/winserver2022-ps/failoverclusters/Remove-ClusterCheckpoint.md b/docset/winserver2022-ps/failoverclusters/Remove-ClusterCheckpoint.md index f6584dff5f..761620eead 100644 --- a/docset/winserver2022-ps/failoverclusters/Remove-ClusterCheckpoint.md +++ b/docset/winserver2022-ps/failoverclusters/Remove-ClusterCheckpoint.md @@ -2,7 +2,7 @@ description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. external help file: Microsoft.FailoverClusters.PowerShell.dll-Help.xml Module Name: FailoverClusters -ms.date: 11/21/2022 +ms.date: 10/21/2022 online version: https://learn.microsoft.com/powershell/module/failoverclusters/remove-clustercheckpoint?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Remove-ClusterCheckpoint @@ -36,20 +36,13 @@ local server. ### Example 1 +```powershell +Get-ClusterResource "Cluster Name" | Remove-ClusterCheckpoint -RegistryCheckpoint +Remove-ClusterCheckpoint -Confirm:$false ``` -PS C:\> Get-ClusterResource "Cluster Name" | Remove-ClusterCheckpoint -RegistryCheckpoint - - -PS C:\> Remove-ClusterCheckpoint -Are you sure you want to remove registry checkpoint 'software\clusname' on resource 'Cluster Name'? - - -[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"):Y -``` - -This example removes the registry checkpoint called software\clusname for the resource named Cluster -Name. +This example removes the registry checkpoint called `software\clusname` for the resource named +`Cluster Name` without user confirmation. ## PARAMETERS diff --git a/docset/winserver2022-ps/failoverclusters/Remove-ClusterFaultDomain.md b/docset/winserver2022-ps/failoverclusters/Remove-ClusterFaultDomain.md index 9cfdfa5bb8..ab3abaf597 100644 --- a/docset/winserver2022-ps/failoverclusters/Remove-ClusterFaultDomain.md +++ b/docset/winserver2022-ps/failoverclusters/Remove-ClusterFaultDomain.md @@ -2,7 +2,7 @@ description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. external help file: ClusterFaultDomain.cdxml-help.xml Module Name: FailoverClusters -ms.date: 11/21/2022 +ms.date: 10/21/2022 online version: https://learn.microsoft.com/powershell/module/failoverclusters/remove-clusterfaultdomain?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Remove-ClusterFaultDomain @@ -39,11 +39,11 @@ The `Remove-ClusterFaultDomain` cmdlet removes a fault domain. The fault domain ### Example 1: Remove a cluster fault domain -``` -PS C:\> Remove-ClusterFaultDomain -Name "Rack001" +```powershell +Remove-ClusterFaultDomain -Name "Rack001" ``` -This command removes the cluster fault domain named Rack001. +This command removes the cluster fault domain named `Rack001`. ## PARAMETERS @@ -191,7 +191,7 @@ Accept wildcard characters: False ### -ThrottleLimit Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If -this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an +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. The throttle limit applies only to the current cmdlet, not to the session or to the computer. diff --git a/docset/winserver2022-ps/failoverclusters/Remove-ClusterGroup.md b/docset/winserver2022-ps/failoverclusters/Remove-ClusterGroup.md index 445ed89784..f94e8f4417 100644 --- a/docset/winserver2022-ps/failoverclusters/Remove-ClusterGroup.md +++ b/docset/winserver2022-ps/failoverclusters/Remove-ClusterGroup.md @@ -2,7 +2,7 @@ description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. external help file: Microsoft.FailoverClusters.PowerShell.dll-Help.xml Module Name: FailoverClusters -ms.date: 11/21/2022 +ms.date: 10/21/2022 online version: https://learn.microsoft.com/powershell/module/failoverclusters/remove-clustergroup?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Remove-ClusterGroup @@ -32,30 +32,30 @@ resources first, or specify the **RemoveResources** parameter. ### Example 1 -``` -PS C:\> Remove-ClusterGroup -Name MyFileServer +```powershell +Remove-ClusterGroup -Name MyFileServer ``` This example prompts the user for confirmation and then removes the clustered role named -MyFileServer, if the resources have first been removed from it. +`MyFileServer`, if the resources have first been removed from it. ### Example 2 -``` -PS C:\> Remove-ClusterGroup -Name MyFileServer -Force +```powershell +Remove-ClusterGroup -Name MyFileServer -Force ``` -This example removes the clustered role named MyFileServer, if the resources have first been removed +This example removes the clustered role named `MyFileServer`, if the resources have first been removed from it. The cmdlet doesn't prompt for confirmation. ### Example 3 -``` -PS C:\> Remove-ClusterGroup -Name MyFileServer -Force -RemoveResources +```powershell +Remove-ClusterGroup -Name MyFileServer -Force -RemoveResources ``` -This example removes the clustered role named MyFileServer, without prompting for confirmation. All -cluster resources in MyFileServer will be deleted. +This example removes the clustered role named `MyFileServer`, without prompting for confirmation. +All cluster resources in `MyFileServer` will be deleted. ## PARAMETERS diff --git a/docset/winserver2022-ps/failoverclusters/Remove-ClusterGroupFromSet.md b/docset/winserver2022-ps/failoverclusters/Remove-ClusterGroupFromSet.md index 2282dd0e2c..e41bdf7a8e 100644 --- a/docset/winserver2022-ps/failoverclusters/Remove-ClusterGroupFromSet.md +++ b/docset/winserver2022-ps/failoverclusters/Remove-ClusterGroupFromSet.md @@ -2,7 +2,7 @@ description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. external help file: ClusterCollection.cdxml-help.xml Module Name: FailoverClusters -ms.date: 11/21/2022 +ms.date: 10/21/2022 online version: https://learn.microsoft.com/powershell/module/failoverclusters/remove-clustergroupfromset?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Remove-ClusterGroupFromSet @@ -37,11 +37,12 @@ The `Remove-ClusterGroupFromSet` cmdlet removes a group from a set. ### Example 1: Remove a group from the specified group set -``` -PS C:\> Remove-ClusterGroupFromSet -Name "Set001" -Group "Group001" +```powershell +Remove-ClusterGroupSetDependency -Name "Set001" -Provider "Set002" ``` -This command removes the group named Group001 from group set named Set001. +This command removes the group set named `Set002` from being a provider for the group set named +`Set001`. ## PARAMETERS diff --git a/docset/winserver2022-ps/failoverclusters/Remove-ClusterGroupSet.md b/docset/winserver2022-ps/failoverclusters/Remove-ClusterGroupSet.md index fd1e88b4ff..2c12a7f65f 100644 --- a/docset/winserver2022-ps/failoverclusters/Remove-ClusterGroupSet.md +++ b/docset/winserver2022-ps/failoverclusters/Remove-ClusterGroupSet.md @@ -2,7 +2,7 @@ description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. external help file: ClusterCollection.cdxml-help.xml Module Name: FailoverClusters -ms.date: 11/21/2022 +ms.date: 10/21/2022 online version: https://learn.microsoft.com/powershell/module/failoverclusters/remove-clustergroupset?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Remove-ClusterGroupSet @@ -37,11 +37,11 @@ Removes a group set from the cluster. The group set cannot be a provider for ano ### Example 1: Remove a group set from the cluster -``` -PS C:\> Remove-ClusterGroupSet -Name "Set001" +```powershell +Remove-ClusterGroupSet -Name "Set001" ``` -This command removes the group set named Set001 from the cluster. +This command removes the group set named `Set001` from the cluster. ## PARAMETERS @@ -157,7 +157,7 @@ Accept wildcard characters: False ### -ThrottleLimit Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If -this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an +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. The throttle limit applies only to the current cmdlet, not to the session or to the computer. diff --git a/docset/winserver2022-ps/failoverclusters/Remove-ClusterGroupSetDependency.md b/docset/winserver2022-ps/failoverclusters/Remove-ClusterGroupSetDependency.md index ad938ec322..f75875aaa3 100644 --- a/docset/winserver2022-ps/failoverclusters/Remove-ClusterGroupSetDependency.md +++ b/docset/winserver2022-ps/failoverclusters/Remove-ClusterGroupSetDependency.md @@ -2,7 +2,7 @@ description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. external help file: ClusterCollection.cdxml-help.xml Module Name: FailoverClusters -ms.date: 11/21/2022 +ms.date: 10/21/2022 online version: https://learn.microsoft.com/powershell/module/failoverclusters/remove-clustergroupsetdependency?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Remove-ClusterGroupSetDependency @@ -33,14 +33,12 @@ The `Remove-ClusterGroupSetDependency` cmdlet removes a dependency from a group ## EXAMPLES -### Example 1: Remove a group set dependency on another group set - -``` -PS C:\> Remove-ClusterGroupSetDependency -Name "Set001" -Provider "Set002" +```powershell +Remove-ClusterGroupSetDependency -Name "Set001" -Provider "Set002" ``` -This command removes the group set named Set002 from being a provider for the group set named -Set001. +This command removes the group set named `Set002` from being a provider for the group set named +`Set001`. ## PARAMETERS @@ -156,7 +154,7 @@ Accept wildcard characters: False ### -ThrottleLimit Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If -this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an +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. The throttle limit applies only to the current cmdlet, not to the session or to the computer. diff --git a/docset/winserver2022-ps/failoverclusters/Remove-ClusterNode.md b/docset/winserver2022-ps/failoverclusters/Remove-ClusterNode.md index fc09ff2335..93728e0245 100644 --- a/docset/winserver2022-ps/failoverclusters/Remove-ClusterNode.md +++ b/docset/winserver2022-ps/failoverclusters/Remove-ClusterNode.md @@ -2,7 +2,7 @@ description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. external help file: Microsoft.FailoverClusters.PowerShell.dll-Help.xml Module Name: FailoverClusters -ms.date: 11/21/2022 +ms.date: 10/21/2022 online version: https://learn.microsoft.com/powershell/module/failoverclusters/remove-clusternode?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Remove-ClusterNode @@ -34,19 +34,20 @@ authentication on the server computer. ### Example 1 -``` -PS C:\> Remove-ClusterNode -Name node4 +```powershell +Remove-ClusterNode -Name node4 ``` -This example removes the node named node4 from the local cluster. +This example removes the node named `node4` from the local cluster. ### Example 2 -``` -PS C:\> Remove-ClusterNode -Name node4 -Force +```powershell +Remove-ClusterNode -Name node4 -Force ``` -This example removes the node named node4 from the local cluster without prompting for confirmation. +This example removes the node named `node4` from the local cluster without prompting for +confirmation. ## PARAMETERS diff --git a/docset/winserver2022-ps/failoverclusters/Remove-ClusterResource.md b/docset/winserver2022-ps/failoverclusters/Remove-ClusterResource.md index 48d0a6e9db..a1e01087de 100644 --- a/docset/winserver2022-ps/failoverclusters/Remove-ClusterResource.md +++ b/docset/winserver2022-ps/failoverclusters/Remove-ClusterResource.md @@ -2,7 +2,7 @@ description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. external help file: Microsoft.FailoverClusters.PowerShell.dll-Help.xml Module Name: FailoverClusters -ms.date: 11/21/2022 +ms.date: 10/21/2022 online version: https://learn.microsoft.com/powershell/module/failoverclusters/remove-clusterresource?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Remove-ClusterResource @@ -29,20 +29,20 @@ removing a resource, be sure to review whether any other resource is dependent o ### Example 1 -``` -PS C:\> Remove-ClusterResource -Name "Cluster Disk 4" +```powershell +Remove-ClusterResource -Name "Cluster Disk 4" ``` -This example prompts the user for confirmation and then deletes the cluster named Cluster Disk 4 +This example prompts the user for confirmation and then deletes the cluster named `Cluster Disk 4` from the local cluster. ### Example 2 -``` -PS C:\> Remove-ClusterResource -Name "Cluster Disk 5" -Force +```powershell +Remove-ClusterResource -Name "Cluster Disk 5" -Force ``` -This example deletes the cluster named Cluster Disk 5 from the local cluster without prompting for +This example deletes the cluster named `Cluster Disk 5` from the local cluster without prompting for confirmation. ## PARAMETERS diff --git a/docset/winserver2022-ps/failoverclusters/Remove-ClusterResourceDependency.md b/docset/winserver2022-ps/failoverclusters/Remove-ClusterResourceDependency.md index 6cd001d399..f2f45e0645 100644 --- a/docset/winserver2022-ps/failoverclusters/Remove-ClusterResourceDependency.md +++ b/docset/winserver2022-ps/failoverclusters/Remove-ClusterResourceDependency.md @@ -2,7 +2,7 @@ description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. external help file: Microsoft.FailoverClusters.PowerShell.dll-Help.xml Module Name: FailoverClusters -ms.date: 11/21/2022 +ms.date: 10/21/2022 online version: https://learn.microsoft.com/powershell/module/failoverclusters/remove-clusterresourcedependency?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Remove-ClusterResourceDependency @@ -34,27 +34,26 @@ offline might vary. ### Example 1 -``` -PS C:\> Remove-ClusterResourceDependency -Resource cluster1FS -Provider "IP Address 2001:4898:9:2:: (3)" -Name State Group ResourceType ----- ----- ----- ------------ -cluster1FS Online cluster1FS Network Name +```powershell +Remove-ClusterResourceDependency -Resource cluster1FS -Provider "IP Address 2001:4898:9:2:: (3)" ``` -This example removes the dependency between cluster resource cluster1FS and the resource named IP -Address 2001:4898:9:2:: (3). +This example removes the dependency between cluster resource `cluster1FS` and the resource named IP +Address `2001:4898:9:2:: (3)`. ### Example 2 -``` -PS C:\> Get-ClusterResource -Name cluster1FS | Remove-ClusterResourceDependency -Provider "IP Address 2001:4898:9:2:: (3)" -Name State Group ResourceType ----- ----- ----- ------------ -cluster1FS Online cluster1FS Network Name +```powershell +$parameters = @{ + Provider = 'IP Address 2001:4898:9:2:: (3)' +} +Get-ClusterResource -Name cluster1FS | Remove-ClusterResourceDependency @parameters ``` -This example removes the dependency between the cluster resource named cluster1FS and the resource -named IP Address 2001:4898:9:2:: (3). +This example removes the dependency between the cluster resource named `cluster1FS` and the resource +named IP Address `2001:4898:9:2:: (3)`. This example uses splatting to pass parameter values from +the `$Parameters` variable to the command. Learn more about +[Splatting](/powershell/module/microsoft.powershell.core/about/about_splatting). ## PARAMETERS diff --git a/docset/winserver2022-ps/failoverclusters/Remove-ClusterResourceType.md b/docset/winserver2022-ps/failoverclusters/Remove-ClusterResourceType.md index 60108eb3e7..7cc4fd2475 100644 --- a/docset/winserver2022-ps/failoverclusters/Remove-ClusterResourceType.md +++ b/docset/winserver2022-ps/failoverclusters/Remove-ClusterResourceType.md @@ -2,7 +2,7 @@ description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. external help file: Microsoft.FailoverClusters.PowerShell.dll-Help.xml Module Name: FailoverClusters -ms.date: 11/21/2022 +ms.date: 10/21/2022 online version: https://learn.microsoft.com/powershell/module/failoverclusters/remove-clusterresourcetype?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Remove-ClusterResourceType @@ -31,11 +31,11 @@ resources of that type will not be able to be used in the cluster. ### Example 1 -``` -PS C:\> Remove-ClusterResourceType -Name ResType1 +```powershell +Remove-ClusterResourceType -Name ResType1 ``` -This example removes the registered resource type named ResType1 on the local cluster. +This example removes the registered resource type named `ResType1` on the local cluster. ## PARAMETERS diff --git a/docset/winserver2022-ps/failoverclusters/Remove-ClusterSharedVolume.md b/docset/winserver2022-ps/failoverclusters/Remove-ClusterSharedVolume.md index c0e982724c..98f83dd6ab 100644 --- a/docset/winserver2022-ps/failoverclusters/Remove-ClusterSharedVolume.md +++ b/docset/winserver2022-ps/failoverclusters/Remove-ClusterSharedVolume.md @@ -2,7 +2,7 @@ description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. external help file: Microsoft.FailoverClusters.PowerShell.dll-Help.xml Module Name: FailoverClusters -ms.date: 11/21/2022 +ms.date: 10/21/2022 online version: https://learn.microsoft.com/powershell/module/failoverclusters/remove-clustersharedvolume?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Remove-ClusterSharedVolume @@ -31,26 +31,20 @@ Available Storage, you can use the volume when you configure a new clustered rol ### Example 1 -``` -PS C:\> Remove-ClusterSharedVolume -Name "Cluster Disk 3" -Name State Group ResourceType ----- ----- ----- ------------ -Cluster Disk 3 Online Available Storage Physical Disk +```powershell +Remove-ClusterSharedVolume -Name "Cluster Disk 3" ``` -This example removes the CSV named Cluster Disk 3 from the Cluster Shared Volumes on the local +This example removes the CSV named `Cluster Disk 3` from the Cluster Shared Volumes on the local cluster, and places it in Available Storage. ### Example 2 -``` -PS C:\> Get-ClusterSharedVolume -Name "Cluster Disk 4" | Remove-ClusterSharedVolume -Name State Group ResourceType ----- ----- ----- ------------ -Cluster Disk 4 Online Available Storage Physical Disk +```powershell +Get-ClusterSharedVolume -Name "Cluster Disk 4" | Remove-ClusterSharedVolume ``` -This example removes the CSV named Cluster Disk 4 from the Cluster Shared Volumes on the local +This example removes the CSV named `Cluster Disk 4` from the Cluster Shared Volumes on the local cluster, and places it in Available Storage. ## PARAMETERS diff --git a/docset/winserver2022-ps/failoverclusters/Remove-ClusterVMMonitoredItem.md b/docset/winserver2022-ps/failoverclusters/Remove-ClusterVMMonitoredItem.md index a5144c912b..c314e06e1e 100644 --- a/docset/winserver2022-ps/failoverclusters/Remove-ClusterVMMonitoredItem.md +++ b/docset/winserver2022-ps/failoverclusters/Remove-ClusterVMMonitoredItem.md @@ -2,7 +2,7 @@ description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. external help file: Microsoft.FailoverClusters.PowerShell.dll-Help.xml Module Name: FailoverClusters -ms.date: 11/21/2022 +ms.date: 10/21/2022 online version: https://learn.microsoft.com/powershell/module/failoverclusters/remove-clustervmmonitoreditem?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Remove-ClusterVMMonitoredItem @@ -39,19 +39,19 @@ no longer take an action, such as restarting the virtual machine. ### Example 1 -``` -PS C:\> Get-ClusterVMMonitoredItem -VirtualMachine VM1 | Remove-ClusterVMMonitoredItem -VirtualMachine VM1 +```powershell +Get-ClusterVMMonitoredItem -VirtualMachine VM1 | Remove-ClusterVMMonitoredItem -VirtualMachine VM1 ``` -This example removes all of the items being monitored on the virtual machine named VM1. +This example removes all of the items being monitored on the virtual machine named `VM1`. ### Example 2 -``` -PS C:\> Remove-ClusterVMMonitoredItem -VirtualMachine VM1 -Service spooler +```powershell +Remove-ClusterVMMonitoredItem -VirtualMachine VM1 -Service spooler ``` -This example removes monitoring on the print spooler service on the virtual machine named VM1. +This example removes monitoring on the print spooler service on the virtual machine named `VM1`. ## PARAMETERS diff --git a/docset/winserver2022-ps/failoverclusters/Repair-ClusterStorageSpacesDirect.md b/docset/winserver2022-ps/failoverclusters/Repair-ClusterStorageSpacesDirect.md index efb2ef185f..4b952d36c0 100644 --- a/docset/winserver2022-ps/failoverclusters/Repair-ClusterStorageSpacesDirect.md +++ b/docset/winserver2022-ps/failoverclusters/Repair-ClusterStorageSpacesDirect.md @@ -2,7 +2,7 @@ description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. external help file: ClusterStorageSpacesDirect.cdxml-help.xml Module Name: FailoverClusters -ms.date: 11/21/2022 +ms.date: 10/21/2022 online version: https://learn.microsoft.com/powershell/module/failoverclusters/repair-clusterstoragespacesdirect?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Repair-ClusterStorageSpacesDirect @@ -39,12 +39,11 @@ The `Repair-ClusterStorageSpacesDirect` cmdlet repairs Storage Spaces Direct (S2 ### Example 1: Repair S2D on all nodes -``` -PS C:\> Repair-ClusterStorageSpacesDirect -Verbose -Confirm:$False -VERBOSE: Performing operation 'Repair Cluster Storage Spaces Direct' on Target 'K0619-C1'. +```powershell +Repair-ClusterStorageSpacesDirect -Verbose -Confirm:$False ``` -This command repairs S2D on all nodes. +This command repairs S2D on all nodes without user confirmation. ## PARAMETERS @@ -181,7 +180,7 @@ Accept wildcard characters: False ### -ThrottleLimit Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If -this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an +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. The throttle limit applies only to the current cmdlet, not to the session or to the computer. diff --git a/docset/winserver2022-ps/failoverclusters/Reset-ClusterVMMonitoredState.md b/docset/winserver2022-ps/failoverclusters/Reset-ClusterVMMonitoredState.md index 061b581a06..7fb32af424 100644 --- a/docset/winserver2022-ps/failoverclusters/Reset-ClusterVMMonitoredState.md +++ b/docset/winserver2022-ps/failoverclusters/Reset-ClusterVMMonitoredState.md @@ -2,7 +2,7 @@ description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. external help file: Microsoft.FailoverClusters.PowerShell.dll-Help.xml Module Name: FailoverClusters -ms.date: 11/21/2022 +ms.date: 10/21/2022 online version: https://learn.microsoft.com/powershell/module/failoverclusters/reset-clustervmmonitoredstate?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Reset-ClusterVMMonitoredState @@ -25,14 +25,14 @@ Reset-ClusterVMMonitoredState [-Wait ] [] The `Reset-ClusterVMMonitoredState` cmdlet resets the Application Critical state of a virtual machine, so that the virtual machine is no longer marked as being in a critical state in the cluster. Note: This cmdlet can only be run locally on the virtual machine or through Windows -PowerShell® remoting to the virtual machine. +PowerShell remoting to the virtual machine. ## EXAMPLES ### Example 1 -``` -PS C:\> Reset-ClusterVMMoniteredState +```powershell +Reset-ClusterVMMoniteredState ``` This example resets the state of the virtual machine and clears the critical state. diff --git a/docset/winserver2022-ps/failoverclusters/Resume-ClusterNode.md b/docset/winserver2022-ps/failoverclusters/Resume-ClusterNode.md index 6074303a19..010b13211a 100644 --- a/docset/winserver2022-ps/failoverclusters/Resume-ClusterNode.md +++ b/docset/winserver2022-ps/failoverclusters/Resume-ClusterNode.md @@ -2,7 +2,7 @@ description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. external help file: Microsoft.FailoverClusters.PowerShell.dll-Help.xml Module Name: FailoverClusters -ms.date: 11/21/2022 +ms.date: 10/21/2022 online version: https://learn.microsoft.com/powershell/module/failoverclusters/resume-clusternode?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Resume-ClusterNode @@ -31,44 +31,32 @@ that are currently offline can be brought online on that node. ### Example 1 -``` -PS C:\> Resume-ClusterNode node1 -Name State ----- ----- -node1 Up +```powershell +Resume-ClusterNode node1 ``` This example resumes node1 on the local cluster. ### Example 2 -``` -PS C:\> Resume-ClusterNode node2 -Cluster mycluster -Name State ----- ----- -node2 Up +```powershell +Resume-ClusterNode node2 -Cluster mycluster ``` -This example resumes node2 on the cluster called mycluster. +This example resumes node2 on the cluster called `mycluster`. ### Example 3 -``` -PS C:\> Get-ClusterNode | Resume-ClusterNode -Name State ----- ----- -node1 Up +```powershell +Get-ClusterNode | Resume-ClusterNode ``` This example resumes all cluster nodes that are suspended, or paused, on the local cluster. ### Example 4 -``` -PS C:\> Get-ClusterNode | Resume-ClusterNode -Failback Immediate -Name State ----- ----- -node2 Up +```powershell +Get-ClusterNode | Resume-ClusterNode -Failback Immediate ``` This example resumes all cluster nodes that are suspended, or paused, on the local cluster and diff --git a/docset/winserver2022-ps/failoverclusters/Resume-ClusterResource.md b/docset/winserver2022-ps/failoverclusters/Resume-ClusterResource.md index 84071c18dc..40bb5ebb0c 100644 --- a/docset/winserver2022-ps/failoverclusters/Resume-ClusterResource.md +++ b/docset/winserver2022-ps/failoverclusters/Resume-ClusterResource.md @@ -2,7 +2,7 @@ description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. external help file: Microsoft.FailoverClusters.PowerShell.dll-Help.xml Module Name: FailoverClusters -ms.date: 11/21/2022 +ms.date: 10/21/2022 online version: https://learn.microsoft.com/powershell/module/failoverclusters/resume-clusterresource?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Resume-ClusterResource @@ -32,25 +32,19 @@ turned off for a disk or Cluster Shared Volume as soon as the maintenance tasks ### Example 1 -``` -PS C:\> Resume-ClusterResource "Cluster Disk 2" -Name State Group ResourceType ----- ----- ----- ------------ -Cluster Disk 2 Online Available Storage Physical Disk +```powershell +Resume-ClusterResource "Cluster Disk 2" ``` -This example turns off maintenance for the CSV named Cluster Disk 2. +This example turns off maintenance for the CSV named `Cluster Disk 2`. ### Example 2 -``` -PS C:\> Get-ClusterSharedVolume "Cluster Disk 5" | Resume-ClusterResource -Name State Node ----- ----- ---- -Cluster Disk 5 Online node2 +```powershell +Get-ClusterSharedVolume "Cluster Disk 5" | Resume-ClusterResource ``` -This example turns off maintenance for all volumes on the CSV named Cluster Disk 5. +This example turns off maintenance for all volumes on the CSV named `Cluster Disk 5`. ## PARAMETERS diff --git a/docset/winserver2022-ps/failoverclusters/Set-ClusterFaultDomain.md b/docset/winserver2022-ps/failoverclusters/Set-ClusterFaultDomain.md index af1ffa6b70..c8e0d6b1ae 100644 --- a/docset/winserver2022-ps/failoverclusters/Set-ClusterFaultDomain.md +++ b/docset/winserver2022-ps/failoverclusters/Set-ClusterFaultDomain.md @@ -2,7 +2,7 @@ description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. external help file: ClusterFaultDomain.cdxml-help.xml Module Name: FailoverClusters -ms.date: 11/21/2022 +ms.date: 10/21/2022 online version: https://learn.microsoft.com/powershell/module/failoverclusters/set-clusterfaultdomain?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Set-ClusterFaultDomain @@ -41,12 +41,12 @@ the fault domain. ### Example 1: Update an existing fault domain -``` -PS C:\> Set-ClusterFaultDomain -Name "NMALIWA-VM-1101" -FaultDomain "Rack1" +```powershell +Set-ClusterFaultDomain -Name "VM-1101" -FaultDomain "Rack1" ``` -This command sets the parent of the fault domain named NMALIWA-VM-1101 to the fault domain named -Rack1. +This command sets the parent of the fault domain named `VM-1101` to the fault domain named +`Rack1`. ## PARAMETERS @@ -243,7 +243,7 @@ Accept wildcard characters: False ### -ThrottleLimit Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If -this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an +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. The throttle limit applies only to the current cmdlet, not to the session or to the computer. diff --git a/docset/winserver2022-ps/failoverclusters/Set-ClusterFaultDomainXML.md b/docset/winserver2022-ps/failoverclusters/Set-ClusterFaultDomainXML.md index 3e6dd15ea4..332012e235 100644 --- a/docset/winserver2022-ps/failoverclusters/Set-ClusterFaultDomainXML.md +++ b/docset/winserver2022-ps/failoverclusters/Set-ClusterFaultDomainXML.md @@ -2,7 +2,7 @@ description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. external help file: ClusterFaultDomain.cdxml-help.xml Module Name: FailoverClusters -ms.date: 11/21/2022 +ms.date: 10/21/2022 online version: https://learn.microsoft.com/powershell/module/failoverclusters/set-clusterfaultdomainxml?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Set-ClusterFaultDomainXML @@ -26,12 +26,11 @@ The `Set-ClusterFaultDomainXML` cmdlet sets the cluster fault domain using XML. ## EXAMPLES -### Example 1: +### Example 1 -``` -PS C:\> Set-ClusterFaultDomainXML -XML @" +```powershell +Set-ClusterFaultDomainXML -XML @" - @@ -40,7 +39,6 @@ PS C:\> Set-ClusterFaultDomainXML -XML @" - @@ -49,7 +47,6 @@ PS C:\> Set-ClusterFaultDomainXML -XML @" - @@ -58,7 +55,6 @@ PS C:\> Set-ClusterFaultDomainXML -XML @" - @@ -67,7 +63,6 @@ PS C:\> Set-ClusterFaultDomainXML -XML @" - "@ ``` @@ -139,7 +134,7 @@ Accept wildcard characters: False ### -ThrottleLimit Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If -this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an +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. The throttle limit applies only to the current cmdlet, not to the session or to the computer. diff --git a/docset/winserver2022-ps/failoverclusters/Set-ClusterGroupSet.md b/docset/winserver2022-ps/failoverclusters/Set-ClusterGroupSet.md index 58be285f56..bb31bc8e2c 100644 --- a/docset/winserver2022-ps/failoverclusters/Set-ClusterGroupSet.md +++ b/docset/winserver2022-ps/failoverclusters/Set-ClusterGroupSet.md @@ -2,7 +2,7 @@ description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. external help file: ClusterCollection.cdxml-help.xml Module Name: FailoverClusters -ms.date: 11/21/2022 +ms.date: 10/21/2022 online version: https://learn.microsoft.com/powershell/module/failoverclusters/set-clustergroupset?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Set-ClusterGroupSet @@ -41,11 +41,11 @@ use the `Add-ClusterGroupSetDependency` and `Remove-ClusterGroupSetDependency` c ### Example 1: Change a group set to the specified startup setting -``` -PS C:\> Set-ClusterGroupSet -Name "Set002" -StartupSetting Online +```powershell +Set-ClusterGroupSet -Name "Set002" -StartupDelayTrigger Online ``` -This command changes the group set named Set002 to the startup setting Online. +This command changes the group set named `Set002` to the startup setting Online. ## PARAMETERS @@ -214,7 +214,7 @@ Accept wildcard characters: False ### -ThrottleLimit Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If -this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an +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. The throttle limit applies only to the current cmdlet, not to the session or to the computer. diff --git a/docset/winserver2022-ps/failoverclusters/Set-ClusterLog.md b/docset/winserver2022-ps/failoverclusters/Set-ClusterLog.md index f06bec8430..2a0254c6fd 100644 --- a/docset/winserver2022-ps/failoverclusters/Set-ClusterLog.md +++ b/docset/winserver2022-ps/failoverclusters/Set-ClusterLog.md @@ -2,7 +2,7 @@ description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. external help file: Microsoft.FailoverClusters.PowerShell.dll-Help.xml Module Name: FailoverClusters -ms.date: 11/21/2022 +ms.date: 10/21/2022 online version: https://learn.microsoft.com/powershell/module/failoverclusters/set-clusterlog?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Set-ClusterLog @@ -29,22 +29,16 @@ level, `3`, includes errors, warnings, and additional information. ### Example 1 -``` -PS C:\> Set-ClusterLog -Level 1 -Name ----- -cluster1 +```powershell +Set-ClusterLog -Level 1 ``` -This example sets the cluster log to a detail level of 1. +This example sets the cluster log to a detail level of `1`. ### Example 2 -``` -PS C:\> Set-ClusterLog -Size 1024 -Name ----- -cluster1 +```powershell +Set-ClusterLog -Size 1024 ``` This example sets the cluster log size to 1024 MB. diff --git a/docset/winserver2022-ps/failoverclusters/Set-ClusterOwnerNode.md b/docset/winserver2022-ps/failoverclusters/Set-ClusterOwnerNode.md index 8511048461..6d711db363 100644 --- a/docset/winserver2022-ps/failoverclusters/Set-ClusterOwnerNode.md +++ b/docset/winserver2022-ps/failoverclusters/Set-ClusterOwnerNode.md @@ -2,7 +2,7 @@ description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. external help file: Microsoft.FailoverClusters.PowerShell.dll-Help.xml Module Name: FailoverClusters -ms.date: 11/21/2022 +ms.date: 10/21/2022 online version: https://learn.microsoft.com/powershell/module/failoverclusters/set-clusterownernode?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Set-ClusterOwnerNode @@ -32,21 +32,21 @@ failure of a resource or a clustered role. ### Example 1 -``` -PS C:\> Get-ClusterResource -Name "Cluster Disk 3" | Set-ClusterOwnerNode -Owners node1,node2 +```powershell +Get-ClusterResource -Name "Cluster Disk 3" | Set-ClusterOwnerNode -Owners node1,node2 ``` -This example sets the possible owners for cluster named Cluster Disk 3 on the local cluster to the -nodes named node1 and node2. +This example sets the possible owners for cluster named `Cluster Disk 3` on the local cluster to the +nodes named `node1` and `node2`. ### Example 2 -``` -PS C:\> Set-ClusterOwnerNode -Group cluster12FS -Owners node3,node2 +```powershell +Set-ClusterOwnerNode -Group cluster12FS -Owners node3,node2 ``` -This example sets the preferred owners for the clustered service named cluster12FS to the node named -node3 followed by the node named node2 on the local cluster. +This example sets the preferred owners for the clustered service named `cluster12FS` to the node +named `node3` followed by the node named `node2` on the local cluster. ## PARAMETERS diff --git a/docset/winserver2022-ps/failoverclusters/Set-ClusterParameter.md b/docset/winserver2022-ps/failoverclusters/Set-ClusterParameter.md index 62e1d8a723..6c0acd36c9 100644 --- a/docset/winserver2022-ps/failoverclusters/Set-ClusterParameter.md +++ b/docset/winserver2022-ps/failoverclusters/Set-ClusterParameter.md @@ -2,7 +2,7 @@ description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. external help file: Microsoft.FailoverClusters.PowerShell.dll-Help.xml Module Name: FailoverClusters -ms.date: 11/21/2022 +ms.date: 10/21/2022 online version: https://learn.microsoft.com/powershell/module/failoverclusters/set-clusterparameter?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Set-ClusterParameter @@ -56,46 +56,21 @@ such as a resource, a group, or a network. ### Example 1 -``` -PS C:\> Get-ClusterResource -Name cluster1FS | Set-ClusterParameter -Name HostRecordTTL -Value 300 +```powershell +Get-ClusterResource -Name "Cluster Disk 3" | Set-ClusterOwnerNode -Owners node1,node2 ``` -This example configures the clustered resource called cluster1FS on the local cluster, by setting -the value of HostRecordTTL to 300. +This example sets the possible owners for cluster named `Cluster Disk 3` on the local cluster to the +nodes named `node1` and `node2`. ### Example 2 -``` -PS C:\> Get-ClusterResource -Name "Cluster IP Address" | Set-ClusterParameter -Multiple @{"Address"="172.24.22.168";"Network"="Cluster Network 2";"EnableDhcp"=1} -``` - -This example uses the **Multiple** parameter to configure the clustered resource called Cluster IP -Address, by setting the **Address**, **Network**, and **EnableDhcp** parameters simultaneously. - -### Example 3 - -``` -PS C:\> $res = Get-ClusterResource -Name "IP Address" - - - -PS C:\> $param1 = New-Object -ComObject Microsoft.FailoverClusters.PowerShell.ClusterParameter -Property $res,Address,10.55.88.46 - - - -PS C:\> $param2 = New-Object -ComObject Microsoft.FailoverClusters.PowerShell.ClusterParameter -Property $res,SubnetMask,255.0.0.0 - - - -PS C:\> $params = $param1,$param2 - - - -PS C:\> $params | Set-ClusterParameter +```powershell +Set-ClusterOwnerNode -Group cluster12FS -Owners node3,node2 ``` -This example configures the clustered resource called IP Address to use a new static IP. Because the -new address and subnet mask are required, both parameters must be passed to this cmdlet together. +This example sets the preferred owners for the clustered service named `cluster12FS` to the node +named `node3` followed by the node named `node2` on the local cluster. ## PARAMETERS diff --git a/docset/winserver2022-ps/failoverclusters/Set-ClusterQuorum.md b/docset/winserver2022-ps/failoverclusters/Set-ClusterQuorum.md index 113f2fa2e9..63b4265343 100644 --- a/docset/winserver2022-ps/failoverclusters/Set-ClusterQuorum.md +++ b/docset/winserver2022-ps/failoverclusters/Set-ClusterQuorum.md @@ -2,7 +2,7 @@ description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. external help file: Microsoft.FailoverClusters.PowerShell.dll-Help.xml Module Name: FailoverClusters -ms.date: 11/21/2022 +ms.date: 10/21/2022 online version: https://learn.microsoft.com/powershell/module/failoverclusters/set-clusterquorum?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Set-ClusterQuorum @@ -33,44 +33,45 @@ cluster configuration) or file share witness. ### Example 1 -``` -PS C:\> Set-ClusterQuorum -NodeMajority -Cluster QuorumResource QuorumType -------- -------------- ---------- -cluster1 NodeMajority +```powershell +Set-ClusterQuorum -NodeMajority ``` This example changes the quorum configuration to Node Majority on the local cluster. ### Example 2 -``` -PS C:\> Set-ClusterQuorum -DiskWitness "Cluster Disk 7" -Cluster QuorumResource QuorumType -------- -------------- ---------- -cluster1 Cluster Disk 7 NodeAndDiskMajority +```powershell +Set-ClusterQuorum -DiskWitness "Cluster Disk 7" ``` This example changes the quorum configuration to Node and Disk Majority on the local cluster, using -the disk resource named Cluster Disk 7 for the disk witness. +the disk resource named `Cluster Disk 7` for the disk witness. ### Example 3 -``` -PS C:\> Set-ClusterQuorum -NodeAndFileShareMajority \\fileserver\fsw -Cluster QuorumResource QuorumType -------- -------------- ---------- -cluster1 File Share Witness NodeAndFileShareMajority +```powershell +Set-ClusterQuorum -NodeAndFileShareMajority \\fileserver\fsw ``` This example changes the quorum configuration to Node and File Share Majority on the local cluster, -using the disk resource at \\\\fileserver\fsw for the file share witness. +using the disk resource at `\\fileserver\fsw` for the file share witness. ### Example 4 +```powershell +$parameters = @{ + CloudWitness = $true + AccountName = '' + AccessKey = '' +Set-ClusterQuorum @parameters ``` -PS C:\> Set-ClusterQuorum -CloudWitness -AccountName -AccessKey -``` + +This example changes the quorum configuration to use an Azure Storage Account to use as a Cloud +Witness. + +The example uses splatting to pass parameter values from the `$Parameters` variable to the command. +Learn more about [Splatting](/powershell/module/microsoft.powershell.core/about/about_splatting). ## PARAMETERS diff --git a/docset/winserver2022-ps/failoverclusters/Set-ClusterResourceDependency.md b/docset/winserver2022-ps/failoverclusters/Set-ClusterResourceDependency.md index 78eaaf2092..e22c364f85 100644 --- a/docset/winserver2022-ps/failoverclusters/Set-ClusterResourceDependency.md +++ b/docset/winserver2022-ps/failoverclusters/Set-ClusterResourceDependency.md @@ -2,7 +2,7 @@ description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. external help file: Microsoft.FailoverClusters.PowerShell.dll-Help.xml Module Name: FailoverClusters -ms.date: 11/21/2022 +ms.date: 10/21/2022 online version: https://learn.microsoft.com/powershell/module/failoverclusters/set-clusterresourcedependency?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Set-ClusterResourceDependency @@ -35,28 +35,35 @@ deployments. ### Example 1 -``` -PS C:\> Set-ClusterResourceDependency -Resource cluster1FS12 -Dependency "[IP Address 151.56.48.0]" +```powershell +Set-ClusterResourceDependency -Resource cluster1FS12 -Dependency "[IP Address 151.56.48.0]" ``` -This example makes the resource called cluster1FS12 dependent on \[IP Address 151.56.48.0\]. +This example makes the resource called cluster1FS12 dependent on `[IP Address 151.56.48.0]`. ### Example 2 -``` -C:\PS>Set-ClusterResourceDependency -Resource cluster1FS12 -Dependency "[IP Address 151.56.48.0] or [New IP Address]" +```powershell +$parameters = @{ + Resource = 'cluster1FS12' + Dependency = '[IP Address 151.56.48.0]' +} +Set-ClusterResourceDependency @parameters ``` -This example makes the resource called cluster1FS12 dependent on either \[IP Address 151.56.48.0\] -or \[New IP Address\]. +This example makes the resource called `cluster1FS12` dependent on either `[IP Address 151.56.48.0]` +or `[New IP Address]`. + +This example uses splatting to pass parameter values from the `$Parameters` variable to the command. +Learn more about [Splatting](/powershell/module/microsoft.powershell.core/about/about_splatting). ### Example 3 -``` -C:\PS>Set-ClusterResourceDependency -Resource cluster1FS12 -Dependency "" +```powershell +Set-ClusterResourceDependency -Resource cluster1FS12 -Dependency "" ``` -This example clears the dependency list for the resource named cluster1FS12, so that it no longer +This example clears the dependency list for the resource named `cluster1FS12`, so that it no longer depends on any other resources. ## PARAMETERS diff --git a/docset/winserver2022-ps/failoverclusters/Set-ClusterStorageSpacesDirect.md b/docset/winserver2022-ps/failoverclusters/Set-ClusterStorageSpacesDirect.md index 11a268084e..b1c631c739 100644 --- a/docset/winserver2022-ps/failoverclusters/Set-ClusterStorageSpacesDirect.md +++ b/docset/winserver2022-ps/failoverclusters/Set-ClusterStorageSpacesDirect.md @@ -2,7 +2,7 @@ description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. external help file: ClusterStorageSpacesDirect.cdxml-help.xml Module Name: FailoverClusters -ms.date: 11/21/2022 +ms.date: 10/21/2022 online version: https://learn.microsoft.com/powershell/module/failoverclusters/set-clusterstoragespacesdirect?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Set-ClusterStorageSpacesDirect @@ -29,12 +29,12 @@ The `Set-ClusterStorageSpacesDirect` cmdlet sets Storage Spaces Direct (S2D) cac ### Example 1: Set S2D cache parameters -``` -PS C:\> Set-ClusterStorageSpacesDirect -CimSession "K0619-C2.cfdev.nttest.contoso.com" -CacheModeHDD ReadWrite +```powershell +Set-ClusterStorageSpacesDirect -CimSession "cluster01.contoso.com" -CacheModeHDD ReadWrite ``` The following command sets the S2D cache parameter as ReadWrite on the cluster named -K0619-C2.cfdev.nttest.contoso.com. +`cluster01.contoso.com`. ## PARAMETERS @@ -179,7 +179,7 @@ Accept wildcard characters: False ### -ThrottleLimit Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If -this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an +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. The throttle limit applies only to the current cmdlet, not to the session or to the computer. diff --git a/docset/winserver2022-ps/failoverclusters/Set-ClusterStorageSpacesDirectDisk.md b/docset/winserver2022-ps/failoverclusters/Set-ClusterStorageSpacesDirectDisk.md index e0477a0663..f8b70b4f79 100644 --- a/docset/winserver2022-ps/failoverclusters/Set-ClusterStorageSpacesDirectDisk.md +++ b/docset/winserver2022-ps/failoverclusters/Set-ClusterStorageSpacesDirectDisk.md @@ -2,7 +2,7 @@ description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. external help file: ClusterStorageSpacesDirect.cdxml-help.xml Module Name: FailoverClusters -ms.date: 11/21/2022 +ms.date: 10/21/2022 online version: https://learn.microsoft.com/powershell/module/failoverclusters/set-clusterstoragespacesdirectdisk?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Set-ClusterStorageSpacesDirectDisk @@ -34,14 +34,24 @@ S2D. Alternatively, you can run this cmdlet after you enable S2D. ### Example 1: Configure disks not to be claimed -``` -PS C:\> Set-ClusterStorageSpacesDirectDisk -CimSession "K0619-C1.contoso.com" -CanBeClaimed:$False -PhysicalDiskIds "55CD2E404B75A3FC","50014EE05950DD7C" +```powershell +$parameters = @{ + CimSession = 'K0619-C1.contoso.com' + CanBeClaimed = $False + PhysicalDiskIds = '55CD2E404B75A3FC', + '50014EE05950DD7C' +} +Set-ClusterStorageSpacesDirectDisk @parameters ``` This command configures the system that physical disks that have the IDs `55CD2E404B75A3FC` and -`50014EE05950DD7C` cannot be claimed by S2D. In this example, the **CanBeClaimed** parameter is +`50014EE05950DD7C` cannot be claimed by S2D. In this example, the `CanBeClaimed` parameter is explicitly specified as `$False`. Omitting that parameter has the same effect. + +This example uses splatting to pass parameter values from the `$Parameters` variable to the command. +Learn more about [Splatting](/powershell/module/microsoft.powershell.core/about/about_splatting). + ## PARAMETERS ### -AsJob @@ -142,7 +152,7 @@ Accept wildcard characters: False ### -ThrottleLimit Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If -this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an +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. The throttle limit applies only to the current cmdlet, not to the session or to the computer. diff --git a/docset/winserver2022-ps/failoverclusters/Start-Cluster.md b/docset/winserver2022-ps/failoverclusters/Start-Cluster.md index cfbe0d5e04..584734064d 100644 --- a/docset/winserver2022-ps/failoverclusters/Start-Cluster.md +++ b/docset/winserver2022-ps/failoverclusters/Start-Cluster.md @@ -2,7 +2,7 @@ description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. external help file: Microsoft.FailoverClusters.PowerShell.dll-Help.xml Module Name: FailoverClusters -ms.date: 11/21/2022 +ms.date: 10/21/2022 online version: https://learn.microsoft.com/powershell/module/failoverclusters/start-cluster?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Start-Cluster @@ -32,26 +32,20 @@ authentication on the server computer. ### Example 1 -``` -PS C:\> Start-Cluster -Name ----- -mycluster +```powershell +Start-Cluster ``` This example starts all cluster nodes on the local cluster. ### Example 2 -``` -PS C:\> Start-Cluster -Name node2 -Name ----- -mycluster +```powershell +Start-Cluster -Name node2 ``` -This example starts all cluster nodes on the cluster of which the node named node2 is a part. A node -name is required if all cluster nodes are stopped. If the cluster is already running, then the +This example starts all cluster nodes on the cluster of which the node named `node2` is a part. A +node name is required if all cluster nodes are stopped. If the cluster is already running, then the cluster name, assuming the cluster name resource is online, can be used instead of the node name. ## PARAMETERS diff --git a/docset/winserver2022-ps/failoverclusters/Start-ClusterGroup.md b/docset/winserver2022-ps/failoverclusters/Start-ClusterGroup.md index 051b1bb719..cdac379827 100644 --- a/docset/winserver2022-ps/failoverclusters/Start-ClusterGroup.md +++ b/docset/winserver2022-ps/failoverclusters/Start-ClusterGroup.md @@ -2,7 +2,7 @@ description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. external help file: Microsoft.FailoverClusters.PowerShell.dll-Help.xml Module Name: FailoverClusters -ms.date: 11/21/2022 +ms.date: 10/21/2022 online version: https://learn.microsoft.com/powershell/module/failoverclusters/start-clustergroup?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Start-ClusterGroup @@ -30,26 +30,20 @@ maintenance or diagnosis. ### Example 1 -``` -PS C:\> Start-ClusterGroup FileServer1 -Name OwnerNode State ----- --------- ----- -FileServer1 node1 Online +```powershell +Start-ClusterGroup FileServer1 ``` -This example starts the clustered file server, or resource group, called FileServer1. +This example starts the clustered file server, or resource group, called `FileServer1`. ### Example 2 -``` -PS C:\> Start-ClusterGroup FileServer1 -Wait 0 -Name OwnerNode State ----- --------- ----- -FileServer1 node1 Pending +```powershell +Start-ClusterGroup FileServer1 -Wait 0 ``` -This example starts the clustered file server, or resource group, called FileServer1. The Windows -PowerShell® prompt returns as soon as the action has been initiated. +This example starts the clustered file server, or resource group, called `FileServer1`. +The Windows PowerShell prompt returns as soon as the action has been initiated. ## PARAMETERS diff --git a/docset/winserver2022-ps/failoverclusters/Start-ClusterNode.md b/docset/winserver2022-ps/failoverclusters/Start-ClusterNode.md index bf5d8df6e1..cff15cf5bc 100644 --- a/docset/winserver2022-ps/failoverclusters/Start-ClusterNode.md +++ b/docset/winserver2022-ps/failoverclusters/Start-ClusterNode.md @@ -2,7 +2,7 @@ description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. external help file: Microsoft.FailoverClusters.PowerShell.dll-Help.xml Module Name: FailoverClusters -ms.date: 11/21/2022 +ms.date: 10/21/2022 online version: https://learn.microsoft.com/powershell/module/failoverclusters/start-clusternode?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Start-ClusterNode @@ -45,33 +45,24 @@ authentication on the server computer. ### Example 1 -``` -PS C:\> Start-ClusterNode -Name node3 -Name State ----- ----- -node3 Joining +```powershell +Start-ClusterNode -Name node3 ``` -This example starts the Cluster service on the node named node3 on the local cluster. +This example starts the Cluster service on the node named `node3` on the local cluster. ### Example 2 -``` -PS C:\> Start-ClusterNode -Name node1 -Cluster cluster2 -Name State ----- ----- -node1 Joining +```powershell +Start-ClusterNode -Name node1 -Cluster cluster2 ``` -This example starts the Cluster service on the node named node1 on the cluster named cluster2. +This example starts the Cluster service on the node named `node1` on the cluster named `cluster2`. ### Example 3 -``` -PS C:\> Start-ClusterNode -FixQuorum -Name State ----- ----- -node1 Joining +```powershell +Start-ClusterNode -FixQuorum ``` This example forces the local node and the local cluster to start, even if quorum hasn't been From 61b72521ed951ed88033300f2201ec6a99f7311d Mon Sep 17 00:00:00 2001 From: robinharwood <19212983+robinharwood@users.noreply.github.com> Date: Wed, 23 Nov 2022 00:41:12 +0000 Subject: [PATCH 060/650] Build validation fix --- .../failoverclusters/Remove-ClusterGroupSetDependency.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docset/winserver2022-ps/failoverclusters/Remove-ClusterGroupSetDependency.md b/docset/winserver2022-ps/failoverclusters/Remove-ClusterGroupSetDependency.md index f75875aaa3..4e049418ac 100644 --- a/docset/winserver2022-ps/failoverclusters/Remove-ClusterGroupSetDependency.md +++ b/docset/winserver2022-ps/failoverclusters/Remove-ClusterGroupSetDependency.md @@ -11,6 +11,8 @@ title: Remove-ClusterGroupSetDependency # Remove-ClusterGroupSetDependency ## SYNOPSIS +Removes a dependency from a group set. + ## SYNTAX ### Query (cdxml) (Default) @@ -33,6 +35,8 @@ The `Remove-ClusterGroupSetDependency` cmdlet removes a dependency from a group ## EXAMPLES +### Example 1: Remove a group set dependency on another group set + ```powershell Remove-ClusterGroupSetDependency -Name "Set001" -Provider "Set002" ``` From 7f42746b5334f77ed98acec878e020fda1603ae8 Mon Sep 17 00:00:00 2001 From: Robin Harwood <19212983+robinharwood@users.noreply.github.com> Date: Fri, 16 Dec 2022 10:28:57 +0000 Subject: [PATCH 061/650] Apply suggestions from code review Co-authored-by: Mikey Lombardi (He/Him) --- .../failoverclusters/Remove-ClusterGroup.md | 2 +- .../failoverclusters/Remove-ClusterResourceDependency.md | 6 +++--- .../winserver2022-ps/failoverclusters/Set-ClusterQuorum.md | 5 +++-- .../failoverclusters/Set-ClusterResourceDependency.md | 2 +- .../failoverclusters/Set-ClusterStorageSpacesDirectDisk.md | 3 +-- 5 files changed, 9 insertions(+), 9 deletions(-) diff --git a/docset/winserver2022-ps/failoverclusters/Remove-ClusterGroup.md b/docset/winserver2022-ps/failoverclusters/Remove-ClusterGroup.md index f94e8f4417..3d8a40be2e 100644 --- a/docset/winserver2022-ps/failoverclusters/Remove-ClusterGroup.md +++ b/docset/winserver2022-ps/failoverclusters/Remove-ClusterGroup.md @@ -54,7 +54,7 @@ from it. The cmdlet doesn't prompt for confirmation. Remove-ClusterGroup -Name MyFileServer -Force -RemoveResources ``` -This example removes the clustered role named `MyFileServer`, without prompting for confirmation. +This example removes the clustered role named `MyFileServer`, without prompting for confirmation. All cluster resources in `MyFileServer` will be deleted. ## PARAMETERS diff --git a/docset/winserver2022-ps/failoverclusters/Remove-ClusterResourceDependency.md b/docset/winserver2022-ps/failoverclusters/Remove-ClusterResourceDependency.md index f2f45e0645..80beca8a57 100644 --- a/docset/winserver2022-ps/failoverclusters/Remove-ClusterResourceDependency.md +++ b/docset/winserver2022-ps/failoverclusters/Remove-ClusterResourceDependency.md @@ -38,8 +38,8 @@ offline might vary. Remove-ClusterResourceDependency -Resource cluster1FS -Provider "IP Address 2001:4898:9:2:: (3)" ``` -This example removes the dependency between cluster resource `cluster1FS` and the resource named IP -Address `2001:4898:9:2:: (3)`. +This example removes the dependency between cluster resource `cluster1FS` and the resource named +`IP Address 2001:4898:9:2:: (3)`. ### Example 2 @@ -51,7 +51,7 @@ Get-ClusterResource -Name cluster1FS | Remove-ClusterResourceDependency @paramet ``` This example removes the dependency between the cluster resource named `cluster1FS` and the resource -named IP Address `2001:4898:9:2:: (3)`. This example uses splatting to pass parameter values from +named `IP Address 2001:4898:9:2:: (3)`. This example uses splatting to pass parameter values from the `$Parameters` variable to the command. Learn more about [Splatting](/powershell/module/microsoft.powershell.core/about/about_splatting). diff --git a/docset/winserver2022-ps/failoverclusters/Set-ClusterQuorum.md b/docset/winserver2022-ps/failoverclusters/Set-ClusterQuorum.md index 63b4265343..4a3ebb11af 100644 --- a/docset/winserver2022-ps/failoverclusters/Set-ClusterQuorum.md +++ b/docset/winserver2022-ps/failoverclusters/Set-ClusterQuorum.md @@ -62,8 +62,9 @@ using the disk resource at `\\fileserver\fsw` for the file share witness. ```powershell $parameters = @{ CloudWitness = $true - AccountName = '' - AccessKey = '' + AccountName = '' + AccessKey = '' +} Set-ClusterQuorum @parameters ``` diff --git a/docset/winserver2022-ps/failoverclusters/Set-ClusterResourceDependency.md b/docset/winserver2022-ps/failoverclusters/Set-ClusterResourceDependency.md index e22c364f85..9a9bcc7e80 100644 --- a/docset/winserver2022-ps/failoverclusters/Set-ClusterResourceDependency.md +++ b/docset/winserver2022-ps/failoverclusters/Set-ClusterResourceDependency.md @@ -46,7 +46,7 @@ This example makes the resource called cluster1FS12 dependent on `[IP Address 15 ```powershell $parameters = @{ Resource = 'cluster1FS12' - Dependency = '[IP Address 151.56.48.0]' + Dependency = '[IP Address 151.56.48.0] or [New IP Address]' } Set-ClusterResourceDependency @parameters ``` diff --git a/docset/winserver2022-ps/failoverclusters/Set-ClusterStorageSpacesDirectDisk.md b/docset/winserver2022-ps/failoverclusters/Set-ClusterStorageSpacesDirectDisk.md index f8b70b4f79..46a04f239a 100644 --- a/docset/winserver2022-ps/failoverclusters/Set-ClusterStorageSpacesDirectDisk.md +++ b/docset/winserver2022-ps/failoverclusters/Set-ClusterStorageSpacesDirectDisk.md @@ -38,8 +38,7 @@ S2D. Alternatively, you can run this cmdlet after you enable S2D. $parameters = @{ CimSession = 'K0619-C1.contoso.com' CanBeClaimed = $False - PhysicalDiskIds = '55CD2E404B75A3FC', - '50014EE05950DD7C' + PhysicalDiskIds = '55CD2E404B75A3FC', '50014EE05950DD7C' } Set-ClusterStorageSpacesDirectDisk @parameters ``` From 55f8cbd57c1af420eaf4a7a61eba292f99d6b355 Mon Sep 17 00:00:00 2001 From: Robin Harwood <19212983+robinharwood@users.noreply.github.com> Date: Mon, 9 Jan 2023 14:48:01 +0000 Subject: [PATCH 062/650] Applied review suggestion Co-authored-by: Mikey Lombardi (He/Him) --- .../failoverclusters/Remove-ClusterResourceDependency.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/failoverclusters/Remove-ClusterResourceDependency.md b/docset/winserver2022-ps/failoverclusters/Remove-ClusterResourceDependency.md index 80beca8a57..c024529e5a 100644 --- a/docset/winserver2022-ps/failoverclusters/Remove-ClusterResourceDependency.md +++ b/docset/winserver2022-ps/failoverclusters/Remove-ClusterResourceDependency.md @@ -35,7 +35,11 @@ offline might vary. ### Example 1 ```powershell -Remove-ClusterResourceDependency -Resource cluster1FS -Provider "IP Address 2001:4898:9:2:: (3)" +$parameters = @{ + Resource = 'cluster1FS' + Provider = 'IP Address 2001:4898:9:2:: (3)' +} +Remove-ClusterResourceDependency @parameters ``` This example removes the dependency between cluster resource `cluster1FS` and the resource named From dfe9f32c0fd8b77a55c96a54790108a027836904 Mon Sep 17 00:00:00 2001 From: robinharwood <19212983+robinharwood@users.noreply.github.com> Date: Mon, 9 Jan 2023 15:21:19 +0000 Subject: [PATCH 063/650] Updated Remove-ClusterCheckpoint.md after feedback --- .../failoverclusters/Remove-ClusterCheckpoint.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docset/winserver2022-ps/failoverclusters/Remove-ClusterCheckpoint.md b/docset/winserver2022-ps/failoverclusters/Remove-ClusterCheckpoint.md index 761620eead..a00142bd42 100644 --- a/docset/winserver2022-ps/failoverclusters/Remove-ClusterCheckpoint.md +++ b/docset/winserver2022-ps/failoverclusters/Remove-ClusterCheckpoint.md @@ -2,7 +2,7 @@ description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. external help file: Microsoft.FailoverClusters.PowerShell.dll-Help.xml Module Name: FailoverClusters -ms.date: 10/21/2022 +ms.date: 01/09/2023 online version: https://learn.microsoft.com/powershell/module/failoverclusters/remove-clustercheckpoint?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Remove-ClusterCheckpoint @@ -37,12 +37,12 @@ local server. ### Example 1 ```powershell -Get-ClusterResource "Cluster Name" | Remove-ClusterCheckpoint -RegistryCheckpoint -Remove-ClusterCheckpoint -Confirm:$false +$checkpoint = Get-ClusterCheckpoint -ResourceName "Cluster Name" -RegistryCheckpoint +$checkpoint | Remove-ClusterCheckpoint -Confirm:$false ``` -This example removes the registry checkpoint called `software\clusname` for the resource named -`Cluster Name` without user confirmation. +This example returns all registry checkpoints for the resource named `Cluster Name`, then removes +them without user confirmation. ## PARAMETERS From a313b229d77f0da34e673c34df5e90555b4f40e8 Mon Sep 17 00:00:00 2001 From: robinharwood <19212983+robinharwood@users.noreply.github.com> Date: Tue, 22 Nov 2022 22:41:55 +0000 Subject: [PATCH 064/650] Buld update of examples --- .../Get-ClusterFaultDomainXML.md | 11 +- .../failoverclusters/Get-ClusterGroup.md | 53 ++------ .../failoverclusters/Get-ClusterGroupSet.md | 23 +--- .../Get-ClusterGroupSetDependency.md | 18 +-- .../failoverclusters/Get-ClusterLog.md | 32 ++--- .../failoverclusters/Get-ClusterNetwork.md | 17 +-- .../Get-ClusterNetworkInterface.md | 22 +--- .../failoverclusters/Get-ClusterNode.md | 35 ++---- .../failoverclusters/Get-ClusterOwnerNode.md | 20 ++- .../failoverclusters/Get-ClusterParameter.md | 35 ++---- .../failoverclusters/Get-ClusterQuorum.md | 18 +-- .../failoverclusters/Get-ClusterResource.md | 117 ++++-------------- .../Get-ClusterResourceDependency.md | 27 ++-- .../Get-ClusterResourceDependencyReport.md | 23 ++-- .../Get-ClusterResourceType.md | 50 ++------ .../Get-ClusterSharedVolume.md | 28 ++--- .../Get-ClusterSharedVolumeState.md | 30 +---- .../Get-ClusterStorageSpacesDirect.md | 28 ++--- .../Get-ClusterVMMonitoredItem.md | 14 +-- .../failoverclusters/Grant-ClusterAccess.md | 14 +-- .../failoverclusters/Move-ClusterGroup.md | 44 +++---- .../failoverclusters/Move-ClusterResource.md | 13 +- .../Move-ClusterSharedVolume.md | 20 ++- .../Move-ClusterVirtualMachineRole.md | 50 +++----- .../failoverclusters/New-Cluster.md | 68 ++++------ .../New-ClusterFaultDomain.md | 15 +-- .../failoverclusters/New-ClusterGroupSet.md | 17 +-- .../New-ClusterNameAccount.md | 18 +-- .../failoverclusters/Remove-Cluster.md | 20 +-- .../failoverclusters/Remove-ClusterAccess.md | 8 +- 30 files changed, 264 insertions(+), 624 deletions(-) diff --git a/docset/winserver2022-ps/failoverclusters/Get-ClusterFaultDomainXML.md b/docset/winserver2022-ps/failoverclusters/Get-ClusterFaultDomainXML.md index 1a44f3fde3..b98ce26c15 100644 --- a/docset/winserver2022-ps/failoverclusters/Get-ClusterFaultDomainXML.md +++ b/docset/winserver2022-ps/failoverclusters/Get-ClusterFaultDomainXML.md @@ -2,7 +2,7 @@ description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. external help file: ClusterFaultDomain.cdxml-help.xml Module Name: FailoverClusters -ms.date: 11/21/2022 +ms.date: 11/22/2022 online version: https://learn.microsoft.com/powershell/module/failoverclusters/get-clusterfaultdomainxml?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Get-ClusterFaultDomainXML @@ -28,11 +28,8 @@ The `Get-ClusterFaultDomainXML` cmdlet gets the fault domain as an XML string. ### Example 1: Get all fault domains in the cluster in XML form -``` -PS C:\> Get-ClusterFaultDomainXML - - - +```powershell +Get-ClusterFaultDomainXML ``` This command gets all the fault domains in the cluster on the local node in XML form. @@ -103,7 +100,7 @@ Accept wildcard characters: False ### -ThrottleLimit Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If -this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an +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. The throttle limit applies only to the current cmdlet, not to the session or to the computer. diff --git a/docset/winserver2022-ps/failoverclusters/Get-ClusterGroup.md b/docset/winserver2022-ps/failoverclusters/Get-ClusterGroup.md index e886242a5a..dfe8bf2a7a 100644 --- a/docset/winserver2022-ps/failoverclusters/Get-ClusterGroup.md +++ b/docset/winserver2022-ps/failoverclusters/Get-ClusterGroup.md @@ -2,7 +2,7 @@ description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. external help file: Microsoft.FailoverClusters.PowerShell.dll-Help.xml Module Name: FailoverClusters -ms.date: 11/21/2022 +ms.date: 11/22/2022 online version: https://learn.microsoft.com/powershell/module/failoverclusters/get-clustergroup?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Get-ClusterGroup @@ -32,14 +32,8 @@ together. ### Example 1 -``` -PS C:\> Get-ClusterGroup -Name OwnerNode State ----- --------- ----- -Available Storage node1 Online -Cluster Group node2 Online -cluster1FS node1 Online -cluster1FS-Other node1 Online +```powershell +Get-ClusterGroup ``` This example lists the state and owner node of each clustered role, or resource group, in the local @@ -47,52 +41,29 @@ cluster. ### Example 2 -``` -PS C:\> Get-ClusterGroup -Name "Cluster Group" | Get-ClusterResource -Name State Group ResourceType ----- ----- ----- ------------ -Cluster Disk 1 Online Cluster Group Physical Disk -Cluster IP Address Online Cluster Group IP Address -Cluster IP Addre... Online Cluster Group IPv6 Address -Cluster Name Online Cluster Group Network Name +```powershell +Get-ClusterGroup -Name "Cluster Group" | Get-ClusterResource ``` -This example lists the resources in Cluster Group on the local cluster. +This example lists the resources in `Cluster Group` on the local cluster. ### Example 3 -``` -PS C:\> Get-ClusterNode -Name node1 | Get-ClusterGroup -Name OwnerNode State ----- --------- ----- -Cluster Group node1 Online +```powershell +Get-ClusterNode -Name node1 | Get-ClusterGroup ``` This example lists the clustered services and applications, or resource groups, that are currently -owned by node1 in the local cluster. +owned by `node1` in the local cluster. ### Example 4 -``` -PS C:\> Get-ClusterGroup -Name FileServer1 | Format-List -Property * -Cluster : Cluster1 -IsCoreGroup : False -OwnerNode : node1 -State : Online -Name : FileServer1 -Description : -PersistentState : 0 -FailoverThreshold : 4294967295 -FailoverPeriod : 6 -AutoFailbackType : 0 -FailbackWindowStart : 4294967295 -FailbackWindowEnd : 4294967295 -AntiAffinityClassNames : {} -Id : 189ec8ad-1831-4f57-9bb0-3ffb9cbb9227 +```powershell +Get-ClusterGroup -Name FileServer1 | Format-List -Property * ``` This example displays the properties of a clustered file server, or resource group, called -FileServer1, in the form of a list. +`FileServer1`, in the form of a list. ## PARAMETERS diff --git a/docset/winserver2022-ps/failoverclusters/Get-ClusterGroupSet.md b/docset/winserver2022-ps/failoverclusters/Get-ClusterGroupSet.md index b2fb1308a5..9a734e61da 100644 --- a/docset/winserver2022-ps/failoverclusters/Get-ClusterGroupSet.md +++ b/docset/winserver2022-ps/failoverclusters/Get-ClusterGroupSet.md @@ -2,7 +2,7 @@ description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. external help file: ClusterCollection.cdxml-help.xml Module Name: FailoverClusters -ms.date: 11/21/2022 +ms.date: 11/22/2022 online version: https://learn.microsoft.com/powershell/module/failoverclusters/get-clustergroupset?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Get-ClusterGroupSet @@ -28,23 +28,8 @@ The `Get-ClusterGroupSet` cmdlet gets all the group sets in the cluster. ### Example 1: Get all the group sets in the cluster -``` -PS C:\> Get-ClusterGroupSet -Name : Set1 -GroupNames : {g1} -ProviderNames : {Set2} -StartupDelayTrigger : Delay -StartupCount : 4294967295 -IsGlobal : False -StartupDelay : 20 - -Name : Set2 -GroupNames : {g2} -ProviderNames : {} -StartupDelayTrigger : Delay -StartupCount : 4294967295 -IsGlobal : False -StartupDelay : 20 +```powershell +Get-ClusterGroupSet ``` This command enumerates the group sets in the cluster. @@ -130,7 +115,7 @@ Accept wildcard characters: False ### -ThrottleLimit Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If -this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an +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. The throttle limit applies only to the current cmdlet, not to the session or to the computer. diff --git a/docset/winserver2022-ps/failoverclusters/Get-ClusterGroupSetDependency.md b/docset/winserver2022-ps/failoverclusters/Get-ClusterGroupSetDependency.md index d08fa943e5..b50111d023 100644 --- a/docset/winserver2022-ps/failoverclusters/Get-ClusterGroupSetDependency.md +++ b/docset/winserver2022-ps/failoverclusters/Get-ClusterGroupSetDependency.md @@ -2,7 +2,7 @@ description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. external help file: ClusterCollection.cdxml-help.xml Module Name: FailoverClusters -ms.date: 11/21/2022 +ms.date: 11/22/2022 online version: https://learn.microsoft.com/powershell/module/failoverclusters/get-clustergroupsetdependency?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Get-ClusterGroupSetDependency @@ -30,19 +30,11 @@ relationships. You can get all sets that are dependent on a specific set. ### Example 1: Get all the group sets that are provided by the specified set -``` -PS C:\> Get-ClusterGroupSetDependency -Provider "Set2" - -Name : Set1 -GroupNames : {g1} -ProviderNames : {Set2} -StartupDelayTrigger : Delay -StartupCount : 4294967295 -IsGlobal : False -StartupDelay : 20 +```powershell +Get-ClusterGroupSetDependency -Provider "Set2" ``` -This command gets all the group sets that are provided by set named Set2. +This command gets all the group sets that are provided by set named `Set2`. ## PARAMETERS @@ -157,7 +149,7 @@ Accept wildcard characters: False ### -ThrottleLimit Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If -this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an +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. The throttle limit applies only to the current cmdlet, not to the session or to the computer. diff --git a/docset/winserver2022-ps/failoverclusters/Get-ClusterLog.md b/docset/winserver2022-ps/failoverclusters/Get-ClusterLog.md index 129b0cf5f7..335922ee3b 100644 --- a/docset/winserver2022-ps/failoverclusters/Get-ClusterLog.md +++ b/docset/winserver2022-ps/failoverclusters/Get-ClusterLog.md @@ -2,7 +2,7 @@ description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. external help file: Microsoft.FailoverClusters.PowerShell.dll-Help.xml Module Name: FailoverClusters -ms.date: 11/21/2022 +ms.date: 11/22/2022 online version: https://learn.microsoft.com/powershell/module/failoverclusters/get-clusterlog?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Get-ClusterLog @@ -36,25 +36,17 @@ authentication on the server computer. ### Example 1: Create a log file for the local cluster -``` -PS C:\> Get-ClusterLog -Mode LastWriteTime Length Name ----- ------------- ------ ---- --a--- 9/4/2008 3:53 PM 2211301 Cluster.log --a--- 9/4/2008 3:53 PM 1261025 Cluster.log +```powershell +Get-ClusterLog ``` This command creates a log file for the local cluster in the cluster reports folder -(C:\Windows\Cluster\Reports) on each node of the cluster. +`C:\Windows\Cluster\Reports` on each node of the cluster. ### Example 2: Create log files for each node and save them locally -``` -PS C:\> Get-ClusterLog -Destination . -Mode LastWriteTime Length Name ----- ------------- ------ ---- --a--- 9/4/2008 3:55 PM 2211301 node1_cluster.log --a--- 9/4/2008 3:55 PM 1261025 node2_cluster.log +```powershell +Get-ClusterLog -Destination . ``` This command creates a log file for each node of the local cluster, and copies all logs to the local @@ -62,16 +54,12 @@ folder. ### Example 3: Create a log file for the local cluster for previous five minutes -``` -PS C:\> Get-ClusterLog -TimeSpan 5 -Mode LastWriteTime Length Name ----- ------------- ------ ---- --a--- 9/4/2008 3:58 PM 128299 Cluster.log --a--- 9/4/2008 4:01 PM 104181 Cluster.log +```powershell +Get-ClusterLog -TimeSpan 5 ``` This command creates a log file for the local cluster in the cluster reports folder -(C:\Windows\Cluster\Reports) on each node of the cluster. The log covers the last 5 minutes. +`C:\Windows\Cluster\Reports` on each node of the cluster. The log covers the last 5 minutes. ## PARAMETERS @@ -95,7 +83,7 @@ Accept wildcard characters: False ### -Destination Specifies the location to which to copy one or more cluster logs. To copy to the current folder, use -`.` for this parameter input. Default location is C:\Windows\Cluster\Reports. +`.` for this parameter input. Default location is `C:\Windows\Cluster\Reports`. ```yaml Type: String diff --git a/docset/winserver2022-ps/failoverclusters/Get-ClusterNetwork.md b/docset/winserver2022-ps/failoverclusters/Get-ClusterNetwork.md index dcd72b39c1..dbcedc1bc5 100644 --- a/docset/winserver2022-ps/failoverclusters/Get-ClusterNetwork.md +++ b/docset/winserver2022-ps/failoverclusters/Get-ClusterNetwork.md @@ -2,7 +2,7 @@ description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. external help file: Microsoft.FailoverClusters.PowerShell.dll-Help.xml Module Name: FailoverClusters -ms.date: 11/21/2022 +ms.date: 11/22/2022 online version: https://learn.microsoft.com/powershell/module/failoverclusters/get-clusternetwork?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Get-ClusterNetwork @@ -29,24 +29,19 @@ A failover cluster requires network connectivity among nodes and between clients ### Example 1 -``` -PS C:\> Get-ClusterNetwork -Name State ----- ----- -Cluster Network 1 Up -Cluster Network 2 Up -Cluster Network 3 Up +```powershell +Get-ClusterNetwork ``` This example gets information about the networks used by the local cluster. ### Example 2 -``` -PS C:\> (Get-ClusterNetwork -Name "Cluster Network 1").Name = "Cluster Network 3" +```powershell +(Get-ClusterNetwork -Name "Cluster Network 1").Name = "Cluster Network 3" ``` -This example renames Cluster Network 1 to Cluster Network 3. +This example renames `Cluster Network 1` to `Cluster Network 3`. ## PARAMETERS diff --git a/docset/winserver2022-ps/failoverclusters/Get-ClusterNetworkInterface.md b/docset/winserver2022-ps/failoverclusters/Get-ClusterNetworkInterface.md index e7a88c6248..cd6cb0187d 100644 --- a/docset/winserver2022-ps/failoverclusters/Get-ClusterNetworkInterface.md +++ b/docset/winserver2022-ps/failoverclusters/Get-ClusterNetworkInterface.md @@ -2,7 +2,7 @@ description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. external help file: Microsoft.FailoverClusters.PowerShell.dll-Help.xml Module Name: FailoverClusters -ms.date: 11/21/2022 +ms.date: 11/22/2022 online version: https://learn.microsoft.com/powershell/module/failoverclusters/get-clusternetworkinterface?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Get-ClusterNetworkInterface @@ -30,29 +30,19 @@ and nodes. ### Example 1 -``` -PS C:\> Get-ClusterNetworkInterface -Name Node Network State ----- ---- ------- ----- -node1 - Local A ... node1 Cluster Network 1 Up -node2 - Local A ... node2 Cluster Network 1 Up -node1 - Local A ... node1 Cluster Network 2 Up -node2 - Local A ... node2 Cluster Network 2 Up +```powershell +Get-ClusterNetworkInterface ``` This example displays information about the physical network adapters used by the local cluster. ### Example 2 -``` -PS C:\> Get-ClusterNode -Name node1 | Get-ClusterNetworkInterface -Name Node Network State ----- ---- ------- ----- -node1 - Local A ... node1 Cluster Network 1 Up -node1 - Local A ... node1 Cluster Network 2 Up +```powershell +Get-ClusterNode -Name node1 | Get-ClusterNetworkInterface ``` -This example displays information about the physical network adapters used by node1 in the local +This example displays information about the physical network adapters used by `node1` in the local cluster. This cmdlet is equivalent to `Get-ClusterNetworkInterface -Node node1`. ## PARAMETERS diff --git a/docset/winserver2022-ps/failoverclusters/Get-ClusterNode.md b/docset/winserver2022-ps/failoverclusters/Get-ClusterNode.md index 03c340df5c..4f9aee9d36 100644 --- a/docset/winserver2022-ps/failoverclusters/Get-ClusterNode.md +++ b/docset/winserver2022-ps/failoverclusters/Get-ClusterNode.md @@ -2,7 +2,7 @@ description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. external help file: Microsoft.FailoverClusters.PowerShell.dll-Help.xml Module Name: FailoverClusters -ms.date: 11/21/2022 +ms.date: 11/22/2022 online version: https://learn.microsoft.com/powershell/module/failoverclusters/get-clusternode?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Get-ClusterNode @@ -33,45 +33,28 @@ a particular node, specify that node in this cmdlet and then pipe the results th ### Example 1 -``` -PS C:\> Get-ClusterNode -Name ID State ----- -- ----- -node1 1 Up -node2 2 Up -node3 3 Up -node4 4 Up +```powershell +Get-ClusterNode ``` This example displays the name, id, and state of each node, or server, in the local cluster. ### Example 2 -``` -PS C:\> Get-ClusterNode -Cluster cluster1 -Name ID State ----- -- ----- -node1 1 Up -node2 2 Up +```powershell +Get-ClusterNode -Cluster cluster1 ``` This example displays the name, id, and state of each node, or server, in the cluster named -cluster1. +`cluster1`. ### Example 3 -``` -PS C:\> Get-ClusterNode -Name node1 | Get-ClusterResource -Name State Group ResourceType ----- ----- ----- ------------ -Cluster Disk 1 Online Cluster Group Physical Disk -Cluster IP Address Online Cluster Group IP Address -Cluster IP Addre... Online Cluster Group IPv6 Address -Cluster Name Online Cluster Group Network Name -File Share Witness Offline Cluster Group File Share Witness +```powershell +Get-ClusterNode -Name node1 | Get-ClusterResource ``` -This example lists all cluster resources that are currently owned by node named node1 on the local +This example lists all cluster resources that are currently owned by node named `node1` on the local cluster. ## PARAMETERS diff --git a/docset/winserver2022-ps/failoverclusters/Get-ClusterOwnerNode.md b/docset/winserver2022-ps/failoverclusters/Get-ClusterOwnerNode.md index dc64a9ed26..a84bd012c0 100644 --- a/docset/winserver2022-ps/failoverclusters/Get-ClusterOwnerNode.md +++ b/docset/winserver2022-ps/failoverclusters/Get-ClusterOwnerNode.md @@ -2,7 +2,7 @@ description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. external help file: Microsoft.FailoverClusters.PowerShell.dll-Help.xml Module Name: FailoverClusters -ms.date: 11/21/2022 +ms.date: 11/22/2022 online version: https://learn.microsoft.com/powershell/module/failoverclusters/get-clusterownernode?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Get-ClusterOwnerNode @@ -34,26 +34,20 @@ failure of a resource or a clustered role. ### Example 1 -``` -PS C:\> Get-ClusterResource -Cluster "Cluster Disk 1" | Get-ClusterOwnerNode -ClusterObject OwnerNodes -------------- ---------- -Cluster Disk 1 {node1, node2} +```powershell +Get-ClusterResource -Cluster "Cluster Disk 1" | Get-ClusterOwnerNode ``` -This example lists the possible owners for the cluster named Cluster Disk 1 in the local cluster. +This example lists the possible owners for the cluster named `Cluster Disk 1` in the local cluster. ### Example 2 -``` -PS C:\> Get-ClusterGroup -Group cluster1FS12 | Get-ClusterOwnerNode -ClusterObject OwnerNodes -------------- ---------- -cluster1FS12 {} +```powershell +Get-ClusterGroup -Group cluster1FS12 | Get-ClusterOwnerNode ``` This example lists the preferred owners for the clustered file server, or resource group, called -cluster1FS12 on the local cluster. +`cluster1FS12` on the local cluster. ## PARAMETERS diff --git a/docset/winserver2022-ps/failoverclusters/Get-ClusterParameter.md b/docset/winserver2022-ps/failoverclusters/Get-ClusterParameter.md index d9958015e8..67413e7a79 100644 --- a/docset/winserver2022-ps/failoverclusters/Get-ClusterParameter.md +++ b/docset/winserver2022-ps/failoverclusters/Get-ClusterParameter.md @@ -2,7 +2,7 @@ description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. external help file: Microsoft.FailoverClusters.PowerShell.dll-Help.xml Module Name: FailoverClusters -ms.date: 11/21/2022 +ms.date: 11/22/2022 online version: https://learn.microsoft.com/powershell/module/failoverclusters/get-clusterparameter?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Get-ClusterParameter @@ -48,41 +48,22 @@ with it. For example: ### Example 1 -``` -PS C:\> Get-ClusterResource -Name cluster1FS | Get-ClusterParameter -Object Name Value Type ------- ---- ----- ---- -cluster1FS Name cluster1FS String -cluster1FS DnsName cluster1FS String -cluster1FS RemapPipeNames 0 UInt32 -cluster1FS HostRecordTTL 1200 UInt32 -cluster1FS RegisterAllProvi... 0 UInt32 -cluster1FS PublishPTRRecords 0 UInt32 -cluster1FS TimerCallbackAdd... 5 UInt32 -cluster1FS ResourceData {1, 0, 0, 0...} ByteArray -cluster1FS StatusNetBIOS 0 UInt32 -cluster1FS StatusDNS 0 UInt32 -cluster1FS StatusKerberos 0 UInt32 -cluster1FS CreatingDC \\DOMAIN12-DC-05... String -cluster1FS LastDNSUpdateTime 10/15/2008 9:50:... DateTime -cluster1FS ObjectGUID 8054680893fd5943... String +```powershell +Get-ClusterResource -Name cluster1FS | Get-ClusterParameter ``` This example gets the parameters, including the detailed information, for the cluster resource named -cluster1FS on the local cluster. The displayed parameters will vary according to the type of +`cluster1FS` on the local cluster. The displayed parameters will vary according to the type of resource being viewed. ### Example 2 -``` -PS C:\> Get-ClusterResource -Name cluster1FS | Get-ClusterParameter -Name HostRecordTTL -Object Name Value Type ------- ---- ----- ---- -cluster1FS HostRecordTTL 1200 UInt32 +```powershell +Get-ClusterResource -Name cluster1FS | Get-ClusterParameter -Name HostRecordTTL ``` -This example displays the HostRecordTTL parameter for the cluster resource named cluster1FS on the -local cluster, if that parameter is applicable to cluster1FS. +This example displays the HostRecordTTL parameter for the cluster resource named `cluster1FS` on the +local cluster, if that parameter is applicable to `cluster1FS`. ## PARAMETERS diff --git a/docset/winserver2022-ps/failoverclusters/Get-ClusterQuorum.md b/docset/winserver2022-ps/failoverclusters/Get-ClusterQuorum.md index 159452c50c..18c77cdd94 100644 --- a/docset/winserver2022-ps/failoverclusters/Get-ClusterQuorum.md +++ b/docset/winserver2022-ps/failoverclusters/Get-ClusterQuorum.md @@ -2,7 +2,7 @@ description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. external help file: Microsoft.FailoverClusters.PowerShell.dll-Help.xml Module Name: FailoverClusters -ms.date: 11/21/2022 +ms.date: 11/22/2022 online version: https://learn.microsoft.com/powershell/module/failoverclusters/get-clusterquorum?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Get-ClusterQuorum @@ -33,25 +33,19 @@ a copy of the cluster configuration) or file share witness. ### Example 1 -``` -PS C:\> Get-ClusterQuorum -Cluster QuorumResource QuorumType -------- -------------- ---------- -cluster1 Cluster Disk 1 NodeAndDiskMajority +```powershell +Get-ClusterQuorum ``` This example displays the quorum configuration for the local cluster. ### Example 2 -``` -PS C:\> Get-ClusterQuorum -Cluster Cluster1 -Cluster QuorumResource QuorumType -------- -------------- ---------- -mycluster NodeMajority +```powershell +Get-ClusterQuorum -Cluster Cluster1 ``` -This example displays the quorum configuration for the cluster named Cluster1. +This example displays the quorum configuration for the cluster named `Cluster1`. ## PARAMETERS diff --git a/docset/winserver2022-ps/failoverclusters/Get-ClusterResource.md b/docset/winserver2022-ps/failoverclusters/Get-ClusterResource.md index 39c79be45b..f4192a30e7 100644 --- a/docset/winserver2022-ps/failoverclusters/Get-ClusterResource.md +++ b/docset/winserver2022-ps/failoverclusters/Get-ClusterResource.md @@ -2,7 +2,7 @@ description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. external help file: Microsoft.FailoverClusters.PowerShell.dll-Help.xml Module Name: FailoverClusters -ms.date: 11/21/2022 +ms.date: 11/22/2022 online version: https://learn.microsoft.com/powershell/module/failoverclusters/get-clusterresource?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Get-ClusterResource @@ -34,131 +34,64 @@ and `Set-ClusterParameter`. ### Example 1 -``` -PS C:\> Get-ClusterResource -Name State Group ResourceType ----- ----- ----- ------------ -Cluster Disk 1 Online Cluster Group Physical Disk -Cluster Disk 2 Online Available Storage Physical Disk -Cluster Disk 3 Online Available Storage Physical Disk -Cluster Disk 4 Online Available Storage Physical Disk -Cluster Disk 5 Online Available Storage Physical Disk -Cluster Disk 6 Online Available Storage Physical Disk -Cluster Disk 7 Online Available Storage Physical Disk -Cluster IP Address Online Cluster Group IP Address -Cluster IP Addre... Online Cluster Group IPv6 Address -Cluster Name Online Cluster Group Network Name +```powershell +Get-ClusterResource ``` This example lists all cluster resources on the local cluster. ### Example 2 -``` -PS C:\> Get-ClusterResource -Name "Cluster Disk 2" | Format-List -Property * -Cluster : cluster1 -IsCoreResource : False -IsNetworkClassResource : False -IsStorageClassResource : True -OwnerNode : node2 -ResourceType : Physical Disk -State : Online -OwnerGroup : Available Storage -Name : Cluster Disk 2 -MaintenanceMode : False -MonitorProcessId : 524 -Description : -SeparateMonitor : False -PersistentState : 1 -LooksAlivePollInterval : 4294967295 -IsAlivePollInterval : 4294967295 -RestartAction : 2 -RestartThreshold : 1 -RestartDelay : 500 -RestartPeriod : 900000 -RetryPeriodOnFailure : 3600000 -PendingTimeout : 180000 -DeadlockTimeout : 300000 -ResourceSpecificStatus : -Id : 6e394089-145a-4279-b75d-b14015cc36e4 +```powershell +Get-ClusterResource -Name "Cluster Disk 2" | Format-List -Property * ``` -This example displays information about Cluster Disk 2, on the local cluster, in the form of a list. +This example displays information about `Cluster Disk 2`, on the local cluster, in the form of a +list. ### Example 3 -``` -PS C:\> Get-ClusterResource -Name "Cluster Disk 2" | Get-ClusterParameter -Object Name Value Type ------- ---- ----- ---- -Cluster Disk 2 DiskIdType 0 UInt32 -Cluster Disk 2 DiskSignature 2654136047 UInt32 -Cluster Disk 2 DiskIdGuid String -Cluster Disk 2 DiskRunChkDsk 0 UInt32 -Cluster Disk 2 DiskUniqueIds {16, 0, 0, 0...} ByteArray -Cluster Disk 2 DiskVolumeInfo {1, 0, 0, 0...} ByteArray -Cluster Disk 2 DiskArbInterval 3 UInt32 -Cluster Disk 2 DiskPath String -Cluster Disk 2 DiskReload 0 UInt32 -Cluster Disk 2 MaintenanceMode 0 UInt32 -Cluster Disk 2 MaxIoLatency 1000 UInt32 -Cluster Disk 2 CsvEnforseWriteT... 0 UInt32 -Cluster Disk 2 DiskPnpUpdate {0, 0, 0, 0...} ByteArray +```powershell +Get-ClusterResource -Name "Cluster Disk 2" | Get-ClusterParameter ``` -This example displays detailed parameters for Cluster Disk 2 on the local cluster. +This example displays detailed parameters for `Cluster Disk 2` on the local cluster. ### Example 4 -``` -PS C:\> Get-ClusterGroup -Name FileServer1 | Get-ClusterResource -Name State Group ResourceType ----- ----- ----- ------------ -Cluster Disk 1 Online FileServer1 Physical Disk -Cluster IP Address Online FileServer1 IP Address -Cluster IP Addre... Online FileServer1 IPv6 Address -FileServer1 Online FileServer1 Network Name +```powershell +Get-ClusterGroup -Name FileServer1 | Get-ClusterResource ``` -This example lists cluster resources in cluster group named FileServer1, a clustered file server on -the local cluster. +This example lists cluster resources in cluster group named `FileServer1`, a clustered file server +on the local cluster. ### Example 5 -``` -PS C:\> Get-ClusterResource -Name "Cluster Disk 2" | ForEach-Object -Process {$_.RestartDelay = 600} +```powershell +Get-ClusterResource -Name "Cluster Disk 2" | ForEach-Object -Process {$_.RestartDelay = 600} ``` -This example sets the common property RestartDelay for the Cluster Disk 2 resource on the local -cluster to 600. +This example sets the common property `RestartDelay` for the `Cluster Disk 2` resource on the local +cluster to `600`. ### Example 6 -``` -PS C:\> Get-ClusterResource -Name "cluster pool 1" | Format-List -Property OwnerNode -OwnerNode : cluster-node1 +```powershell +Get-ClusterResource -Name "cluster pool 1" | Format-List -Property OwnerNode ``` This example shows how to display the owner of a cluster pooled disk. ### Example 7 -``` -PS C:\> Get-ClusterResource -Name *print-VM1 | Get-VM | Stop-VM -Verbose -VERBOSE: Current VMobject = Microsoft.HyperV.PowerShell.VirtualMachine[] -VERBOSE: Stop-VM will shutdown the virtual machine "print-VM1". - -Confirm -Hyper-V cannot shut down virtual machine print-VM1 because the Shutdown integration service is unavailable. To avoid -potential data loss, you can pause or save the state of the virtual machine. The other option is to turn off the -virtual machine, but data loss might occur. - - -[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"):Y +```powershell +Get-ClusterResource -Name *print-VM1 | Get-VM | Stop-VM -Verbose -Confirm:$false ``` -This example enumerates the cluster resources for wildcard characters *print-VM1 and stops the -corresponding virtual machines. Verbose mode is turned on for details of the operation. +This example enumerates the cluster resources for wildcard characters `*print-VM1` and stops the +corresponding virtual machines without user confirmation.. Verbose mode is turned on for details of +the operation. ## PARAMETERS diff --git a/docset/winserver2022-ps/failoverclusters/Get-ClusterResourceDependency.md b/docset/winserver2022-ps/failoverclusters/Get-ClusterResourceDependency.md index 5bb6db0e97..3952d04225 100644 --- a/docset/winserver2022-ps/failoverclusters/Get-ClusterResourceDependency.md +++ b/docset/winserver2022-ps/failoverclusters/Get-ClusterResourceDependency.md @@ -2,7 +2,7 @@ description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. external help file: Microsoft.FailoverClusters.PowerShell.dll-Help.xml Module Name: FailoverClusters -ms.date: 11/21/2022 +ms.date: 11/22/2022 online version: https://learn.microsoft.com/powershell/module/failoverclusters/get-clusterresourcedependency?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Get-ClusterResourceDependency @@ -31,31 +31,20 @@ order in which resources are brought online or taken offline in the cluster. ### Example 1 -``` -PS C:\> Get-ClusterResourceDependency -Resource cluster1FS12 -Resource DependencyExpression --------- -------------------- -cluster1FS12 [IP Address 172.24.11.0] or [IP Add ... +```powershell +Get-ClusterResourceDependency -Resource cluster1FS12 ``` -This example displays the dependencies for the resource called cluster1FS12. +This example displays the dependencies for the resource called `cluster1FS12`. ### Example 2 -``` -PS C:\> Get-ClusterGroup -Name cluster1FS12 | Get-ClusterResource | Get-ClusterResourceDependency -Resource DependencyExpression --------- -------------------- -cluster1FS12 [IP Address 172.24.11.0] or [IP Add ... - -Cluster Disk 6 -IP Address 157.56.48.0 -IP Address 2001:4898:9:2:: -IP Address 2002:9d38:31ca:8:: +```powershell +Get-ClusterGroup -Name cluster1FS12 | Get-ClusterResource | Get-ClusterResourceDependency ``` -This example displays the dependencies for each resource in the clustered file server ─resource -group─ called cluster1FS12. Some resources don't have dependencies. +This example displays the dependencies for each resource in the clustered file server resource +group called `cluster1FS12`. Some resources don't have dependencies. ## PARAMETERS diff --git a/docset/winserver2022-ps/failoverclusters/Get-ClusterResourceDependencyReport.md b/docset/winserver2022-ps/failoverclusters/Get-ClusterResourceDependencyReport.md index 07e6ea29ee..a95a970b33 100644 --- a/docset/winserver2022-ps/failoverclusters/Get-ClusterResourceDependencyReport.md +++ b/docset/winserver2022-ps/failoverclusters/Get-ClusterResourceDependencyReport.md @@ -2,7 +2,7 @@ description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. external help file: Microsoft.FailoverClusters.PowerShell.dll-Help.xml Module Name: FailoverClusters -ms.date: 11/21/2022 +ms.date: 11/22/2022 online version: https://learn.microsoft.com/powershell/module/failoverclusters/get-clusterresourcedependencyreport?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Get-ClusterResourceDependencyReport @@ -33,33 +33,30 @@ specify a destination folder into which to copy the report. ### Example 1 -``` -PS C:\> Get-ClusterResourceDependencyReport -Group cluster1FS12 -Mode LastWriteTime Length Name ----- ------------- ------ ---- --a--- 10/15/2008 6:29 PM 59299 fb509e66-8d02-4881-8184-6be5b1bfa4c2.mht +```powershell +Get-ClusterResourceDependencyReport -Group cluster1FS12 ``` This example creates a dependency report file for the clustered file server, or resource group, -named cluster1FS12 on the local cluster. +named `cluster1FS12` on the local cluster. ### Example 2 -``` -PS C:\> Get-ClusterResourceDependencyReport -Group cluster1FS12 | Copy-Item -Destination C:\users\user1 +```powershell +Get-ClusterResourceDependencyReport -Group cluster1FS12 | Copy-Item -Destination C:\users\user1 ``` This example creates a dependency report file for the clustered file server, or resource group, -named cluster1FS12 on the local cluster. The dependency report is copied to C:\users\user1. +named `cluster1FS12` on the local cluster. The dependency report is copied to `C:\users\user1`. ### Example 3 -``` -PS C:\> Get-ClusterGroup | Get-ClusterResourceDependencyReport | Copy-Item -Destination \\fileserver\share +```powershell +Get-ClusterGroup | Get-ClusterResourceDependencyReport | Copy-Item -Destination \\fileserver\share ``` This example creates a dependency report file for each clustered role, or resource group, on the -local cluster, and copies all reports to \\\\fileserver\share. +local cluster, and copies all reports to `\\fileserver\share`. ## PARAMETERS diff --git a/docset/winserver2022-ps/failoverclusters/Get-ClusterResourceType.md b/docset/winserver2022-ps/failoverclusters/Get-ClusterResourceType.md index 191571539d..edf3efa78a 100644 --- a/docset/winserver2022-ps/failoverclusters/Get-ClusterResourceType.md +++ b/docset/winserver2022-ps/failoverclusters/Get-ClusterResourceType.md @@ -2,7 +2,7 @@ description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. external help file: Microsoft.FailoverClusters.PowerShell.dll-Help.xml Module Name: FailoverClusters -ms.date: 11/21/2022 +ms.date: 11/22/2022 online version: https://learn.microsoft.com/powershell/module/failoverclusters/get-clusterresourcetype?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Get-ClusterResourceType @@ -30,56 +30,20 @@ which the Cluster service communicates with a particular resource type. ### Example 1 -``` -PS C:\> Get-ClusterResourceType -Name DisplayName ----- ----------- -DFS Replicated Folder DFS Replicated Folder -DHCP Service DHCP Service -Distributed File System Distributed File System -Distributed Transaction Coordinator Distributed Transaction Coordinator -File Server File Server -File Share Witness File Share Quorum Witness -Generic Application Generic Application -Generic Script Generic Script -Generic Service Generic Service -IP Address IP Address -IPv6 Address IPv6 Address -IPv6 Tunnel Address IPv6 Tunnel Address -Microsoft iSNS iSNSClusRes -MSMQ (Resource Type Unavailable) -MSMQTriggers (Resource Type Unavailable) -Network Name Network Name -NFS Share NFS Share -Physical Disk Physical Disk -Print Spooler Print Spooler -Virtual Machine Virtual Machine -Virtual Machine Configuration Virtual Machine Configuration -Volume Shadow Copy Service Task Volume Shadow Copy Service Task -WINS Service WINS Service +```powershell +Get-ClusterResourceType ``` This example lists all the resource types that can be used in configurations on the local cluster. ### Example 2 -``` -PS C:\> Get-ClusterResourceType -Name "File Server" | Format-List -Property * -Cluster : Cluster1 -DisplayName : File Server -Name : file server -DllName : clusres.dll -Description : -AdminExtensions : {} -LooksAlivePollInterval : 5000 -IsAlivePollInterval : 60000 -PendingTimeout : 180000 -DeadlockTimeout : 300000 -Id : f582c84f-0066-0069-6c65-207365727665 +```powershell +Get-ClusterResourceType -Name "File Server" | Format-List -Property * ``` -This example gets information about the File Server resource type on the local cluster, and displays -the information in the form of a list. +This example gets information about the `File Server` resource type on the local cluster, and +displays the information in the form of a list. ## PARAMETERS diff --git a/docset/winserver2022-ps/failoverclusters/Get-ClusterSharedVolume.md b/docset/winserver2022-ps/failoverclusters/Get-ClusterSharedVolume.md index d852eed946..9b76c96b3f 100644 --- a/docset/winserver2022-ps/failoverclusters/Get-ClusterSharedVolume.md +++ b/docset/winserver2022-ps/failoverclusters/Get-ClusterSharedVolume.md @@ -2,7 +2,7 @@ description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. external help file: Microsoft.FailoverClusters.PowerShell.dll-Help.xml Module Name: FailoverClusters -ms.date: 11/21/2022 +ms.date: 11/22/2022 online version: https://learn.microsoft.com/powershell/module/failoverclusters/get-clustersharedvolume?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Get-ClusterSharedVolume @@ -29,37 +29,27 @@ cluster. ### Example 1 -``` -PS C:\> Get-ClusterSharedVolume -Name State Node ----- ----- ---- -Cluster Disk 3 Online node1 -Cluster Disk 4 Online node2 +```powershell +Get-ClusterSharedVolume ``` This example lists all the Cluster Shared Volumes on the local cluster. ### Example 2 -``` -PS C:\> Get-ClusterSharedVolume -Cluster cluster1 -Name State Node ----- ----- ---- -Cluster Disk 1 Online node4 +```powershell +Get-ClusterSharedVolume -Cluster cluster1 ``` -This example lists all the Cluster Shared Volumes on the cluster named cluster1. +This example lists all the Cluster Shared Volumes on the cluster named `cluster1`. ### Example 3 -``` -PS C:\> Get-ClusterSharedVolume -Name "Cluster Disk 4" -Name State Node ----- ----- ---- -Cluster Disk 4 Online node2 +```powershell +Get-ClusterSharedVolume -Name "Cluster Disk 4" ``` -This example displays the state of the Cluster Shared Volume called Cluster Disk 4. +This example displays the state of the Cluster Shared Volume called `Cluster Disk 4`. ## PARAMETERS diff --git a/docset/winserver2022-ps/failoverclusters/Get-ClusterSharedVolumeState.md b/docset/winserver2022-ps/failoverclusters/Get-ClusterSharedVolumeState.md index c3913b1d57..802901abd3 100644 --- a/docset/winserver2022-ps/failoverclusters/Get-ClusterSharedVolumeState.md +++ b/docset/winserver2022-ps/failoverclusters/Get-ClusterSharedVolumeState.md @@ -2,7 +2,7 @@ description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. external help file: Microsoft.FailoverClusters.PowerShell.dll-Help.xml Module Name: FailoverClusters -ms.date: 11/21/2022 +ms.date: 11/22/2022 online version: https://learn.microsoft.com/powershell/module/failoverclusters/get-clustersharedvolumestate?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Get-ClusterSharedVolumeState @@ -26,32 +26,10 @@ The `Get-ClusterSharedVolumeState` cmdlet gets the state of Cluster Shared Volum ## EXAMPLES -### 1: +### Example 1 -``` -PS C:\> Get-ClusterSharedVolumeState -Name : Cluster Disk X -VolumeName : \\?\Volume{2297f079-53c2-41e9-94d1-483d61ea94d7}\ -Node : ClusterNode1 -State : Direct - -VolumeFriendlyName : Volume1 -RedirectedIOReason : NotRedirected - -Name : Cluster Disk Y -VolumeName : \\?\Volume{0312ef48-74c7-4a4d-946e-4bb4a397ad1f}\ -Node : ClusterNode2 -State : File System Redirected - -VolumeFriendlyName : Volume2 -RedirectedIOReason : UserRequest - -Name : Cluster Disk Z -VolumeName : \\?\Volume{c4689cef-83e3-4f47-9eaf-161a9e31c5a0}\ -Node : ClusterNode3 -State : Block Redirected -VolumeFriendlyName : Volume3 -RedirectedIOReason : NoDiskConnectivity +```powershell +Get-ClusterSharedVolumeState ``` This command gets the state of Cluster Shared Volumes on the local cluster. diff --git a/docset/winserver2022-ps/failoverclusters/Get-ClusterStorageSpacesDirect.md b/docset/winserver2022-ps/failoverclusters/Get-ClusterStorageSpacesDirect.md index 4d90a79698..699bc6420a 100644 --- a/docset/winserver2022-ps/failoverclusters/Get-ClusterStorageSpacesDirect.md +++ b/docset/winserver2022-ps/failoverclusters/Get-ClusterStorageSpacesDirect.md @@ -2,7 +2,7 @@ description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. external help file: ClusterStorageSpacesDirect.cdxml-help.xml Module Name: FailoverClusters -ms.date: 11/21/2022 +ms.date: 11/22/2022 online version: https://learn.microsoft.com/powershell/module/failoverclusters/get-clusterstoragespacesdirect?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Get-ClusterStorageSpacesDirect @@ -29,28 +29,20 @@ cluster. ### Example 1: Get the Storage Spaces Direct settings from a cluster -``` -PS C:\> Get-ClusterStorageSpacesDirect -Node "K0617-C1.contoso.com" -S2DCacheBehavior : Default -S2DCacheDesiredState : ReadWrite -S2DCacheMetadataReserveBytes : 34359738368 -S2DEnabled : 1 +```powershell +Get-ClusterStorageSpacesDirect -Node "K0617-C1.contoso.com" ``` -This command sets the S2D settings from the K0617-C1.contoso.com cluster. +This command sets the S2D settings from the `K0617-C1.contoso.com` cluster. -### Example 2: Get the Storage Spaces Direct settings from a cluster by using the pipeline operator for input +### Example 2: Get the Storage Spaces Direct settings from a cluster -``` -PS C:\> Get-Cluster "K0617-C1.contoso.com" | Get-ClusterStorageSpacesDirect -S2DCacheBehavior : Default -S2DCacheDesiredState : ReadWrite -S2DCacheMetadataReserveBytes : 34359738368 -S2DEnabled : 1 +```powershell +Get-Cluster "K0617-C1.contoso.com" | Get-ClusterStorageSpacesDirect ``` -This command gets the S2D settings from cluster K0617-C1.contoso.com and pipes the cluster object to -`Get-ClusterStorageSpacesDirect`. +This command gets the S2D settings from cluster `K0617-C1.contoso.com` and pipes the cluster object +to `Get-ClusterStorageSpacesDirect`. ## PARAMETERS @@ -117,7 +109,7 @@ Accept wildcard characters: False ### -ThrottleLimit Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If -this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an +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. The throttle limit applies only to the current cmdlet, not to the session or to the computer. diff --git a/docset/winserver2022-ps/failoverclusters/Get-ClusterVMMonitoredItem.md b/docset/winserver2022-ps/failoverclusters/Get-ClusterVMMonitoredItem.md index 58f641a5e4..255540b4c9 100644 --- a/docset/winserver2022-ps/failoverclusters/Get-ClusterVMMonitoredItem.md +++ b/docset/winserver2022-ps/failoverclusters/Get-ClusterVMMonitoredItem.md @@ -2,7 +2,7 @@ description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. external help file: Microsoft.FailoverClusters.PowerShell.dll-Help.xml Module Name: FailoverClusters -ms.date: 11/21/2022 +ms.date: 11/22/2022 online version: https://learn.microsoft.com/powershell/module/failoverclusters/get-clustervmmonitoreditem?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Get-ClusterVMMonitoredItem @@ -46,16 +46,12 @@ resource. For example, the configuration might specify that the virtual machine ### Example 1 -``` -PS C:\> Get-Cluster -Name Cluster1 | Get-ClusterVMMonitoredItem -VirtualMachine vm1 -Name ----- -Microsoft-Windows-FailoverClustering-Manager+Admin,Microsoft-Windows-FailoverClustering-Manager,4708 -Spooler +```powershell +Get-Cluster -Name Cluster1 | Get-ClusterVMMonitoredItem -VirtualMachine vm1 ``` -This example returns the services and events being monitored in the virtual machine named vm1 on the -cluster named Cluster1. +This example returns the services and events being monitored in the virtual machine named `vm1` on +the cluster named `Cluster1`. ## PARAMETERS diff --git a/docset/winserver2022-ps/failoverclusters/Grant-ClusterAccess.md b/docset/winserver2022-ps/failoverclusters/Grant-ClusterAccess.md index cebc34ad3d..36f79e0725 100644 --- a/docset/winserver2022-ps/failoverclusters/Grant-ClusterAccess.md +++ b/docset/winserver2022-ps/failoverclusters/Grant-ClusterAccess.md @@ -2,7 +2,7 @@ description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. external help file: Microsoft.FailoverClusters.PowerShell.dll-Help.xml Module Name: FailoverClusters -ms.date: 11/21/2022 +ms.date: 11/22/2022 online version: https://learn.microsoft.com/powershell/module/failoverclusters/grant-clusteraccess?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Grant-ClusterAccess @@ -30,19 +30,19 @@ parameter. ### Example 1 -``` -PS C:\> Grant-ClusterAccess -User contoso\johnj99 -Full +```powershell +Grant-ClusterAccess -User contoso\johnj99 -Full ``` -This example grants full access to the local cluster to johnj99 in the contoso domain. +This example grants full access to the local cluster to `johnj99` in the `contoso` domain. ### Example 2 -``` -PS C:\> Grant-ClusterAccess -User contoso\johnj99 -ReadOnly +```powershell +Grant-ClusterAccess -User contoso\johnj99 -ReadOnly ``` -This example grants read-only access to the local cluster to johnj99 in the contoso domain. +This example grants read-only access to the local cluster to `johnj99` in the `contoso` domain. ## PARAMETERS diff --git a/docset/winserver2022-ps/failoverclusters/Move-ClusterGroup.md b/docset/winserver2022-ps/failoverclusters/Move-ClusterGroup.md index 357b19c3e2..7efb078ef0 100644 --- a/docset/winserver2022-ps/failoverclusters/Move-ClusterGroup.md +++ b/docset/winserver2022-ps/failoverclusters/Move-ClusterGroup.md @@ -2,7 +2,7 @@ description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. external help file: Microsoft.FailoverClusters.PowerShell.dll-Help.xml Module Name: FailoverClusters -ms.date: 11/21/2022 +ms.date: 11/22/2022 online version: https://learn.microsoft.com/powershell/module/failoverclusters/move-clustergroup?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Move-ClusterGroup @@ -32,53 +32,39 @@ step to take in preparation for routine maintenance on a node. ### Example 1 -``` -PS C:\> Move-ClusterGroup -Name MyFileServer -Name OwnerNode State ----- --------- ----- -MyFileServer node1 Online +```powershell +Move-ClusterGroup -Name MyFileServer ``` -This example moves the clustered service called MyFileServer from the current owner node to any +This example moves the clustered service called `MyFileServer` from the current owner node to any other node. ### Example 2 -``` -PS C:\> Move-ClusterGroup -Name MyFileServer -Node node2 -Name OwnerNode State ----- --------- ----- -MyFileServer node2 Online +```powershell +Move-ClusterGroup -Name MyFileServer -Node node2 ``` -This example moves the resource group called MyFileServer from the current owner node to the node -named node2. +This example moves the resource group called `MyFileServer` from the current owner node to the node +named `node2`. ### Example 3 -``` -PS C:\> Get-ClusterNode node3 | Get-ClusterGroup | Move-ClusterGroup -Name OwnerNode State ----- --------- ----- -Available Storage node4 Online -Cluster Group node1 Online -MyFileServer node1 Online +```powershell +Get-ClusterNode node3 | Get-ClusterGroup | Move-ClusterGroup ``` -This example moves all resource groups that are currently owned by the node named node3 to other +This example moves all resource groups that are currently owned by the node named `node3` to other nodes. Use this cmdlet before performing maintenance on the specified node. ### Example 4 -``` -PS C:\> Move-ClusterGroup -Name MyFileServer -Node node2 -Wait 0 -Name OwnerNode State ----- --------- ----- -MyFileServer node2 Pending +```powershell +Move-ClusterGroup -Name MyFileServer -Node node2 -Wait 0 ``` -This example moves the resource group called MyFileServer from the current owner node to the node -named `node2`. Information about MyFileServer is displayed immediately, while it is in the process +This example moves the resource group called `MyFileServer` from the current owner node to the node +named `node2`. Information about `MyFileServer` is displayed immediately, while it is in the process of being moved. ## PARAMETERS diff --git a/docset/winserver2022-ps/failoverclusters/Move-ClusterResource.md b/docset/winserver2022-ps/failoverclusters/Move-ClusterResource.md index 9b66cadaf2..8dbec364fd 100644 --- a/docset/winserver2022-ps/failoverclusters/Move-ClusterResource.md +++ b/docset/winserver2022-ps/failoverclusters/Move-ClusterResource.md @@ -2,7 +2,7 @@ description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. external help file: Microsoft.FailoverClusters.PowerShell.dll-Help.xml Module Name: FailoverClusters -ms.date: 11/21/2022 +ms.date: 11/22/2022 online version: https://learn.microsoft.com/powershell/module/failoverclusters/move-clusterresource?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Move-ClusterResource @@ -30,15 +30,12 @@ clustered resource will then fail over with that clustered role. ### Example 1 -``` -PS C:\> Move-ClusterResource -Name resource1 -Group group2 -Name State Group ResourceType ----- ----- ----- ------------ -resource1 Offline group2 IP Address +```powershell +Move-ClusterResource -Name resource1 -Group group2 ``` -This command moves the cluster resource called resource1 to the resource group called group2 on the -local cluster. +This command moves the cluster resource called `resource1` to the resource group called `group2` on +the local cluster. ## PARAMETERS diff --git a/docset/winserver2022-ps/failoverclusters/Move-ClusterSharedVolume.md b/docset/winserver2022-ps/failoverclusters/Move-ClusterSharedVolume.md index 86eb029fba..5f024398cb 100644 --- a/docset/winserver2022-ps/failoverclusters/Move-ClusterSharedVolume.md +++ b/docset/winserver2022-ps/failoverclusters/Move-ClusterSharedVolume.md @@ -2,7 +2,7 @@ description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. external help file: Microsoft.FailoverClusters.PowerShell.dll-Help.xml Module Name: FailoverClusters -ms.date: 11/21/2022 +ms.date: 11/22/2022 online version: https://learn.microsoft.com/powershell/module/failoverclusters/move-clustersharedvolume?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Move-ClusterSharedVolume @@ -34,25 +34,19 @@ nodes. ### Example 1 -``` -PS C:\> Move-ClusterSharedVolume -Name "Cluster Disk 3" -Name State Node ----- ----- ---- -Cluster Disk 3 Online node2 +```powershell +Move-ClusterSharedVolume -Name "Cluster Disk 3" ``` -This example moves the Cluster Shared Volume called Cluster Disk 3 to another cluster node. +This example moves the Cluster Shared Volume called `Cluster Disk 3` to another cluster node. ### Example 2 -``` -PS C:\> Move-ClusterSharedVolume -Name "Cluster Disk 3" -Node node1 -Name State Node ----- ----- ---- -Cluster Disk 3 Online node1 +```powershell +Move-ClusterSharedVolume -Name "Cluster Disk 3" -Node node1 ``` -This example moves the Cluster Shared Volume called Cluster Disk 3 to the node named node1. +This example moves the Cluster Shared Volume called `Cluster Disk 3` to the node named `node1`. ## PARAMETERS diff --git a/docset/winserver2022-ps/failoverclusters/Move-ClusterVirtualMachineRole.md b/docset/winserver2022-ps/failoverclusters/Move-ClusterVirtualMachineRole.md index 8003d655a6..8b03d0fcae 100644 --- a/docset/winserver2022-ps/failoverclusters/Move-ClusterVirtualMachineRole.md +++ b/docset/winserver2022-ps/failoverclusters/Move-ClusterVirtualMachineRole.md @@ -2,7 +2,7 @@ description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. external help file: Microsoft.FailoverClusters.PowerShell.dll-Help.xml Module Name: FailoverClusters -ms.date: 11/21/2022 +ms.date: 11/22/2022 online version: https://learn.microsoft.com/powershell/module/failoverclusters/move-clustervirtualmachinerole?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Move-ClusterVirtualMachineRole @@ -37,58 +37,42 @@ authentication on the server computer. ### Example 1 -``` -PS C:\> Move-ClusterVirtualMachineRole -Name "Virtual Machine1" -Node node2 -Name OwnerNode State ----- --------- ----- -Virtual Machine1 node2 Online +```powershell +Move-ClusterVirtualMachineRole -Name "Virtual Machine1" -Node node2 ``` This example performs a live migration of the clustered virtual machine named Virtual Machine1 to -the node named node2. The Windows PowerShell prompt doesn't return until the action is complete. +the node named `node2`. The Windows PowerShell prompt doesn't return until the action is complete. ### Example 2 -``` -PS C:\> Get-ClusterGroup -Name "Virtual Machine1" | Move-ClusterVirtualMachineRole -Node node2 -Wait 0 -Name OwnerNode State ----- --------- ----- -Virtual Machine1 node2 Online +```powershell +Get-ClusterGroup -Name "Virtual Machine1" | Move-ClusterVirtualMachineRole -Node node2 -Wait 0 ``` -This example performs a live migration of clustered virtual machine named Virtual Machine1 to the -node named node2. The Windows PowerShell® prompt returns as soon as the action has been initiated. +This example performs a live migration of clustered virtual machine named `Virtual Machine1` to the +node named `node2`. The Windows PowerShell prompt returns as soon as the action has been initiated. ### Example 3 -``` -PS C:\> Move-ClusterVirtualMachineRole -Name "Virtual Machine1" -Cancel -Name OwnerNode State ----- --------- ----- -Virtual Machine1 node1 Online +```powershell +Move-ClusterVirtualMachineRole -Name "Virtual Machine1" -Cancel ``` -This example cancels the live migration in progress for the clustered virtual machine named Virtual -Machine1. +This example cancels the live migration in progress for the clustered virtual machine named `Virtual +Machine1`. ### Example 4 -``` -PS C:\> $groups = Get-ClusterNode -Name node1 | Get-ClusterGroup | Where-Object -FilterScript {$_ | Get-ClusterResource | Where-Object -FilterScript {$_.ResourceType -Like "Virtual Machine"}} - - -PS C:\> ForEach-Object -InputObject $groups -Process { $_ | Move-ClusterVirtualMachineRole -Node node2 } -Name OwnerNode State ----- --------- ----- -Virtual Machine1 node2 Online -Virtual Machine2 node2 Online -Virtual Machine3 node2 Online +```powershell +$groups = Get-ClusterNode -Name node1 | Get-ClusterGroup | Where-Object -FilterScript {$_ | Get-ClusterResource | Where-Object -FilterScript {$_.ResourceType -Like "Virtual Machine"}} +ForEach-Object -InputObject $groups -Process { $_ | Move-ClusterVirtualMachineRole -Node node2 } ``` This example performs a live migration of all clustered virtual machines that are currently owned by the node named node1 to the node named node2. The migration of each virtual machine should complete -before the next migration is started. Use this cmdlet before performing maintenance on the specified -node. +before the next migration is startqed. Use this cmdlet before performing maintenance on the +specified node. ## PARAMETERS diff --git a/docset/winserver2022-ps/failoverclusters/New-Cluster.md b/docset/winserver2022-ps/failoverclusters/New-Cluster.md index 4dc07fedca..da139180d0 100644 --- a/docset/winserver2022-ps/failoverclusters/New-Cluster.md +++ b/docset/winserver2022-ps/failoverclusters/New-Cluster.md @@ -2,7 +2,7 @@ description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. external help file: Microsoft.FailoverClusters.PowerShell.dll-Help.xml Module Name: FailoverClusters -ms.date: 11/21/2022 +ms.date: 11/22/2022 online version: https://learn.microsoft.com/powershell/module/failoverclusters/new-cluster?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: New-Cluster @@ -35,86 +35,66 @@ System Configuration, Network, Storage, and other types of tests. ### Example 1 ```powershell -PS C:\> New-Cluster -Name cluster1 -Node node1,node2,node3,node4 -``` -```output -Name ----- -cluster1 +New-Cluster -Name cluster1 -Node node1,node2,node3,node4 ``` -This example creates a four-node cluster named cluster1, using default settings for IP addressing. +This example creates a four-node cluster named `cluster1`, using default settings for IP addressing. ### Example 2 ```powershell -PS C:\> New-Cluster -Name cluster1 -Node node1,node2 -NoStorage -``` -```output -Name ----- -cluster1 +New-Cluster -Name cluster1 -Node node1,node2 -NoStorage ``` -This example creates a two-node cluster named cluster1. The cluster will not have any clustered +This example creates a two-node cluster named `cluster1`. The cluster will not have any clustered storage, or disk resources. Storage can be added using the `Get-ClusterAvailableDisk` cmdlet with the `Add-ClusterDisk` cmdlet. ### Example 3 ```powershell -PS C:\> New-Cluster -Name cluster1 -Node node1,node2,node3,node4 -StaticAddress 2.0.0.123 -``` -```output -Name ----- -cluster1 +New-Cluster -Name cluster1 -Node node1,node2,node3,node4 -StaticAddress 2.0.0.123 ``` -This example creates a four-node cluster named cluster1 that uses the static IP address 2.0.0.123. +This example creates a four-node cluster named `cluster1` that uses the static IP address +`2.0.0.123`. ### Example 4 ```powershell -PS C:\> New-Cluster -Name cluster1 -Node node1,node2,node3,node4 -StaticAddress 2.0.0.123,3.0.0.123 -``` -```output -Name ----- -cluster1 +New-Cluster -Name cluster1 -Node node1,node2,node3,node4 -StaticAddress 2.0.0.123,3.0.0.123 ``` -This example creates a four-node cluster named cluster1 that uses the static IP addresses 2.0.0.123 -and 3.0.0.123. +This example creates a four-node cluster named `cluster1` that uses the static IP addresses +`2.0.0.123` and `3.0.0.123`. ### Example 5 ```powershell -PS C:\> New-Cluster -Name cluster1 -Node node1,node2,node3,node4 -IgnoreNetwork 2.0.0.0/8 -``` -```output -Name ----- -cluster1 +New-Cluster -Name cluster1 -Node node1,node2,node3,node4 -IgnoreNetwork 2.0.0.0/8 ``` -This example creates a four-node cluster named cluster1. The cluster uses default settings for IP -addressing, and doesn't use the network 2.0.0.0/8. +This example creates a four-node cluster named `cluster1`. The cluster uses default settings for IP +addressing, and doesn't use the network `2.0.0.0/8`. ### Example 6 ```powershell -PS C:\> New-Cluster -Name cluster1 -Node node1,node2,node3,node4 -StaticAddress 2.0.0.123 -IgnoreNetwork 3.0.0.0/8 -``` -```output -Name ----- -cluster1 +$parameters = @{ + Name = 'cluster1' + Node = 'node1','node2','node3','node4' + StaticAddress = '2.0.0.123' + IgnoreNetwork = '3.0.0.0/8' +} +New-Cluster @parameters ``` This example creates a four-node cluster named cluster1. The cluster uses the static IP address 2.0.0.123, and doesn't use the network 3.0.0.0/8. +This example uses splatting to pass parameter values from the `$Parameters` variable to the command. +Learn more about [Splatting](/powershell/module/microsoft.powershell.core/about/about_splatting). + ## PARAMETERS ### -AdministrativeAccessPoint diff --git a/docset/winserver2022-ps/failoverclusters/New-ClusterFaultDomain.md b/docset/winserver2022-ps/failoverclusters/New-ClusterFaultDomain.md index c21b651fee..edf433e807 100644 --- a/docset/winserver2022-ps/failoverclusters/New-ClusterFaultDomain.md +++ b/docset/winserver2022-ps/failoverclusters/New-ClusterFaultDomain.md @@ -2,7 +2,7 @@ description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. external help file: ClusterFaultDomain.cdxml-help.xml Module Name: FailoverClusters -ms.date: 11/21/2022 +ms.date: 11/22/2022 online version: https://learn.microsoft.com/powershell/module/failoverclusters/new-clusterfaultdomain?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: New-ClusterFaultDomain @@ -30,15 +30,12 @@ specify the relationship between the fault domains when they are created. ### Example 1: Create a cluster fault domain in an existing fault domain -``` -PS C:\> New-ClusterFaultDomain -Type Rack -Name "Rack1" -FaultDomain "Site001" -Name Type ParentName ChildrenNames ----- ---- ---------- ------------- -Rack1 Rack Site1 +```powershell +New-ClusterFaultDomain -Type Rack -Name "Rack1" -FaultDomain "Site001" ``` -This command creates a cluster fault domain of type Rack named Rack1 in the existing fault domain -named Site001. +This command creates a cluster fault domain of type Rack named `Rack1` in the existing fault domain +named `Site001`. ## PARAMETERS @@ -193,7 +190,7 @@ Accept wildcard characters: False ### -ThrottleLimit Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If -this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an +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. The throttle limit applies only to the current cmdlet, not to the session or to the computer. diff --git a/docset/winserver2022-ps/failoverclusters/New-ClusterGroupSet.md b/docset/winserver2022-ps/failoverclusters/New-ClusterGroupSet.md index 93bd5dea36..14bee882e7 100644 --- a/docset/winserver2022-ps/failoverclusters/New-ClusterGroupSet.md +++ b/docset/winserver2022-ps/failoverclusters/New-ClusterGroupSet.md @@ -2,7 +2,7 @@ description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. external help file: ClusterCollection.cdxml-help.xml Module Name: FailoverClusters -ms.date: 10/21/2022 +ms.date: 11/22/2022 online version: https://learn.microsoft.com/powershell/module/failoverclusters/new-clustergroupset?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: New-ClusterGroupSet @@ -29,18 +29,11 @@ based on dependencies between sets. ### Example 1: Create a cluster group set -``` -PS C:\> New-ClusterGroupSet -Name "Set001" -Group "Group001" -Name : Set1 -GroupNames : {g1} -ProviderNames : {} -StartupDelayTrigger : Delay -StartupCount : 4294967295 -IsGlobal : False -StartupDelay : 20 +```powershell +New-ClusterGroupSet -Name "Set001" -Group "Group001" ``` -This command creates a cluster group set named Set001 that contains the group named Group001. +This command creates a cluster group set named `Set001` that contains the group named `Group001`. ## PARAMETERS @@ -139,7 +132,7 @@ Accept wildcard characters: False ### -ThrottleLimit Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If -this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an +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. The throttle limit applies only to the current cmdlet, not to the session or to the computer. diff --git a/docset/winserver2022-ps/failoverclusters/New-ClusterNameAccount.md b/docset/winserver2022-ps/failoverclusters/New-ClusterNameAccount.md index 92033a8900..b1c71cc0ec 100644 --- a/docset/winserver2022-ps/failoverclusters/New-ClusterNameAccount.md +++ b/docset/winserver2022-ps/failoverclusters/New-ClusterNameAccount.md @@ -2,7 +2,7 @@ description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. external help file: Microsoft.FailoverClusters.PowerShell.dll-Help.xml Module Name: FailoverClusters -ms.date: 11/21/2022 +ms.date: 11/22/2022 online version: https://learn.microsoft.com/powershell/module/failoverclusters/new-clusternameaccount?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: New-ClusterNameAccount @@ -40,21 +40,21 @@ name account already exists for a cluster, this cmdlet has no effect. ### Example 1: Create a cluster name account for the current cluster -``` -PS C:\> New-ClusterNameAccount -Name "cluster_17" -Domain "production.contoso.com" +```powershell +New-ClusterNameAccount -Name "cluster_17" -Domain "production.contoso.com" ``` -This command creates a cluster name account for the current cluster in the specified domain. The -current cluster is the default value for the cluster on which this cmdlet operates. +This command creates a cluster name account for the current cluster in the specified domain. +The current cluster is the default value for the cluster on which this cmdlet operates. ### Example 2: Create a cluster name account by using credentials -``` -PS C:\> $Credential = Get-Credential -PS C:\> New-ClusterNameAccount -Name "cluster27" -Domain "production.contoso.com" -Credentials $Credential +```powershell +$Credential = Get-Credential +New-ClusterNameAccount -Name "cluster27" -Domain "production.contoso.com" -Credentials $Credential ``` -The first command prompts you for credentials, and then stores them in the **$Credential** variable. +The first command prompts you for credentials, and then stores them in the `$Credential` variable. The second command creates a cluster name account for the current cluster in the specified domain. The command supplies the credentials stored in `$Credential` to access Active Directory Domain diff --git a/docset/winserver2022-ps/failoverclusters/Remove-Cluster.md b/docset/winserver2022-ps/failoverclusters/Remove-Cluster.md index 2cd3533ee5..ef3dc1a22e 100644 --- a/docset/winserver2022-ps/failoverclusters/Remove-Cluster.md +++ b/docset/winserver2022-ps/failoverclusters/Remove-Cluster.md @@ -2,7 +2,7 @@ description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. external help file: Microsoft.FailoverClusters.PowerShell.dll-Help.xml Module Name: FailoverClusters -ms.date: 11/21/2022 +ms.date: 11/22/2022 online version: https://learn.microsoft.com/powershell/module/failoverclusters/remove-cluster?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Remove-Cluster @@ -34,8 +34,8 @@ authentication on the server computer. ### Example 1 -``` -PS C:\> Remove-Cluster +```powershell +Remove-Cluster ``` This example prompts the user for confirmation, then destroys the local failover cluster and removes @@ -43,8 +43,8 @@ cluster configuration information from the cluster nodes. ### Example 2 -``` -PS C:\> Remove-Cluster -Force +```powershell +Remove-Cluster -Force ``` This example destroys the local failover cluster and removes cluster configuration information from @@ -52,13 +52,13 @@ the cluster nodes. The cmdlet doesn't prompt for confirmation. ### Example 3 -``` -PS C:\> Get-Cluster -Name Cluster1 | Remove-Cluster -Force -CleanupAD +```powershell +Get-Cluster -Name Cluster1 | Remove-Cluster -Force -CleanupAD ``` -This example destroys the cluster named Cluster1, removes cluster configuration information from the -cluster nodes, and deletes the cluster objects in Active Directory. The cmdlet doesn't prompt for -confirmation. +This example destroys the cluster named `Cluster1`, removes cluster configuration information from +the cluster nodes, and deletes the cluster objects in Active Directory. The cmdlet doesn't prompt +for confirmation. ## PARAMETERS diff --git a/docset/winserver2022-ps/failoverclusters/Remove-ClusterAccess.md b/docset/winserver2022-ps/failoverclusters/Remove-ClusterAccess.md index acea4290c0..58de9f269f 100644 --- a/docset/winserver2022-ps/failoverclusters/Remove-ClusterAccess.md +++ b/docset/winserver2022-ps/failoverclusters/Remove-ClusterAccess.md @@ -2,7 +2,7 @@ description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. external help file: Microsoft.FailoverClusters.PowerShell.dll-Help.xml Module Name: FailoverClusters -ms.date: 11/21/2022 +ms.date: 11/22/2022 online version: https://learn.microsoft.com/powershell/module/failoverclusters/remove-clusteraccess?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Remove-ClusterAccess @@ -30,11 +30,11 @@ another user group which is on the cluster access list. ### Example 1 -``` -PS C:\> Remove-ClusterAccess -User contoso\johnj99 +```powershell +Remove-ClusterAccess -User contoso\johnj99 ``` -This example removes the user johnj99 in the contoso domain from the access list of the local +This example removes the user `johnj99` in the `contoso` domain from the access list of the local cluster. After this cmdlet runs, the user might still have access to the cluster if the user is part of another user group granted access to the cluster. From 219b02ddafffba8d68462f5b278e9460641bd727 Mon Sep 17 00:00:00 2001 From: Robin Harwood <19212983+robinharwood@users.noreply.github.com> Date: Wed, 23 Nov 2022 16:23:31 +0000 Subject: [PATCH 065/650] Apply suggestions from code review Co-authored-by: Mikey Lombardi (He/Him) --- .../failoverclusters/Get-ClusterResource.md | 6 ++++-- .../failoverclusters/Move-ClusterVirtualMachineRole.md | 2 +- 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/docset/winserver2022-ps/failoverclusters/Get-ClusterResource.md b/docset/winserver2022-ps/failoverclusters/Get-ClusterResource.md index f4192a30e7..236366b071 100644 --- a/docset/winserver2022-ps/failoverclusters/Get-ClusterResource.md +++ b/docset/winserver2022-ps/failoverclusters/Get-ClusterResource.md @@ -69,7 +69,9 @@ on the local cluster. ### Example 5 ```powershell -Get-ClusterResource -Name "Cluster Disk 2" | ForEach-Object -Process {$_.RestartDelay = 600} +Get-ClusterResource -Name "Cluster Disk 2" | ForEach-Object -Process { + $_.RestartDelay = 600 +} ``` This example sets the common property `RestartDelay` for the `Cluster Disk 2` resource on the local @@ -90,7 +92,7 @@ Get-ClusterResource -Name *print-VM1 | Get-VM | Stop-VM -Verbose -Confirm:$false ``` This example enumerates the cluster resources for wildcard characters `*print-VM1` and stops the -corresponding virtual machines without user confirmation.. Verbose mode is turned on for details of +corresponding virtual machines without user confirmation. Verbose mode is turned on for details of the operation. ## PARAMETERS diff --git a/docset/winserver2022-ps/failoverclusters/Move-ClusterVirtualMachineRole.md b/docset/winserver2022-ps/failoverclusters/Move-ClusterVirtualMachineRole.md index 8b03d0fcae..4dbdc0583f 100644 --- a/docset/winserver2022-ps/failoverclusters/Move-ClusterVirtualMachineRole.md +++ b/docset/winserver2022-ps/failoverclusters/Move-ClusterVirtualMachineRole.md @@ -71,7 +71,7 @@ ForEach-Object -InputObject $groups -Process { $_ | Move-ClusterVirtualMachineRo This example performs a live migration of all clustered virtual machines that are currently owned by the node named node1 to the node named node2. The migration of each virtual machine should complete -before the next migration is startqed. Use this cmdlet before performing maintenance on the +before the next migration is started. Use this cmdlet before performing maintenance on the specified node. ## PARAMETERS From 1de26910a220bc0f2ab2ed83b02ccd14f555f519 Mon Sep 17 00:00:00 2001 From: Robin Harwood <19212983+robinharwood@users.noreply.github.com> Date: Mon, 9 Jan 2023 15:57:58 +0000 Subject: [PATCH 066/650] UpdateMove-ClusterVirtualMachineRole.md with review suggestion Co-authored-by: Mikey Lombardi (He/Him) --- .../failoverclusters/Move-ClusterVirtualMachineRole.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/failoverclusters/Move-ClusterVirtualMachineRole.md b/docset/winserver2022-ps/failoverclusters/Move-ClusterVirtualMachineRole.md index 4dbdc0583f..18bfaeb44d 100644 --- a/docset/winserver2022-ps/failoverclusters/Move-ClusterVirtualMachineRole.md +++ b/docset/winserver2022-ps/failoverclusters/Move-ClusterVirtualMachineRole.md @@ -65,7 +65,12 @@ Machine1`. ### Example 4 ```powershell -$groups = Get-ClusterNode -Name node1 | Get-ClusterGroup | Where-Object -FilterScript {$_ | Get-ClusterResource | Where-Object -FilterScript {$_.ResourceType -Like "Virtual Machine"}} +$vmGroups = Get-ClusterNode -Name node1 | + Get-ClusterGroup | + Where-Object -FilterScript { + Get-ClusterResource -InputObject $_ | + Where-Object ResourceType -Like "Virtual Machine" + } ForEach-Object -InputObject $groups -Process { $_ | Move-ClusterVirtualMachineRole -Node node2 } ``` From 088ad7f8b76617323b7f188171e113fbac1a4bc7 Mon Sep 17 00:00:00 2001 From: robinharwood <19212983+robinharwood@users.noreply.github.com> Date: Tue, 10 Jan 2023 10:46:55 +0000 Subject: [PATCH 067/650] Updated examples for Move-ClusterVirtualMachineRole --- .../Move-ClusterVirtualMachineRole.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/docset/winserver2022-ps/failoverclusters/Move-ClusterVirtualMachineRole.md b/docset/winserver2022-ps/failoverclusters/Move-ClusterVirtualMachineRole.md index 18bfaeb44d..07ff08ea6e 100644 --- a/docset/winserver2022-ps/failoverclusters/Move-ClusterVirtualMachineRole.md +++ b/docset/winserver2022-ps/failoverclusters/Move-ClusterVirtualMachineRole.md @@ -71,13 +71,15 @@ $vmGroups = Get-ClusterNode -Name node1 | Get-ClusterResource -InputObject $_ | Where-Object ResourceType -Like "Virtual Machine" } -ForEach-Object -InputObject $groups -Process { $_ | Move-ClusterVirtualMachineRole -Node node2 } +ForEach-Object -InputObject $vmGroups -Process { $_ | Move-ClusterVirtualMachineRole -Node node2 } ``` -This example performs a live migration of all clustered virtual machines that are currently owned by -the node named node1 to the node named node2. The migration of each virtual machine should complete -before the next migration is started. Use this cmdlet before performing maintenance on the -specified node. +This example queries a specific cluster node, `node1`, to find the currently owned groups. The +example further filters the owned groups where there resource type is a virtual machine cluster +resource. The filtered groups are stored in the `$vmGroups` variable. For each cluster group in the +variable, the command will perform a live migration of all clustered virtual machines to the node +named `node2`. The migration of each virtual machine will complete before the next migration is +started. ## PARAMETERS From 7f9cd8fe937f17226e9deced326515a6c35b03ed Mon Sep 17 00:00:00 2001 From: robinharwood <19212983+robinharwood@users.noreply.github.com> Date: Tue, 10 Jan 2023 10:59:29 +0000 Subject: [PATCH 068/650] Update ms.date --- .../failoverclusters/Move-ClusterVirtualMachineRole.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/failoverclusters/Move-ClusterVirtualMachineRole.md b/docset/winserver2022-ps/failoverclusters/Move-ClusterVirtualMachineRole.md index 07ff08ea6e..efa6adf023 100644 --- a/docset/winserver2022-ps/failoverclusters/Move-ClusterVirtualMachineRole.md +++ b/docset/winserver2022-ps/failoverclusters/Move-ClusterVirtualMachineRole.md @@ -2,7 +2,7 @@ description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. external help file: Microsoft.FailoverClusters.PowerShell.dll-Help.xml Module Name: FailoverClusters -ms.date: 11/22/2022 +ms.date: 01/10/2023 online version: https://learn.microsoft.com/powershell/module/failoverclusters/move-clustervirtualmachinerole?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Move-ClusterVirtualMachineRole From 48147442c6a63fc77e9bf04844d63007181ab7a6 Mon Sep 17 00:00:00 2001 From: Ned pyle Date: Fri, 20 Jan 2023 16:46:41 -0800 Subject: [PATCH 069/650] Update Get-SmbShare.md Redesigned help to not be misleading about scopename vs cimsession and added a remote server example I am going to do this against get-smbshare, new-smbshare, set-smbshare, remove-smbshare as needed. --- .../winserver2022-ps/smbshare/Get-SmbShare.md | 53 ++++++++----------- 1 file changed, 23 insertions(+), 30 deletions(-) diff --git a/docset/winserver2022-ps/smbshare/Get-SmbShare.md b/docset/winserver2022-ps/smbshare/Get-SmbShare.md index d6ea9a170c..da9ed1b503 100644 --- a/docset/winserver2022-ps/smbshare/Get-SmbShare.md +++ b/docset/winserver2022-ps/smbshare/Get-SmbShare.md @@ -30,32 +30,17 @@ The **Get-SmbShare** cmdlet retrieves objects that represent the Server Message ## EXAMPLES -### Example 1: Get SMB shares +### Example 1: Get SMB shares on a local computer ``` PS C:\>Get-SMBShare Name ScopeName Path Description ---- --------- ---- ----------- ADMIN$ * C:\Windows Remote Admin C$ * C:\ Default share -ClusterStorage$ Contoso-SO C:\ClusterStorage Cluster Shared Volumes Def... D$ * D:\ Default share F$ * F:\ Default share -G$ * G:\ Default share -H$ * H:\ Default share -I$ Contoso-FS I:\ Cluster Default Share -I$ * I:\ Default share IPC$ * Remote IPC -J$ Contoso-FS J:\ Cluster Default Share -J$ * J:\ Default share -K$ * K:\ Default share -L$ * L:\ Default share -M$ * M:\ Default share -N$ * N:\ Default share -VMS1 Contoso-FS I:\VMS -VMS2 Contoso-FS J:\VMS -VMS3 Contoso-SO C:\ClusterStorage\Volume1\VMS -VMS4 Contoso-SO C:\ClusterStorage\Volume2\VMS -VMS5 * D:\VMS +VMS1 * I:\VMS ``` This command retrieves the SMB shares on the computer. @@ -65,21 +50,29 @@ This command retrieves the SMB shares on the computer. PS C:\>Get-SmbShare -Name "VMS1" Name ScopeName Path Description ---- --------- ---- ----------- -VMS1 Contoso-FS I:\VMS +VMS1 * I:\VMS ``` This command retrieves information about the SMB share named 'VMS1' on the local computer. -### Example 3: Display information about the SMB share named 'VMS1' on the local computer in a list +### Example 3: Display information about the SMB shares on a remote computer. ``` -PS C:\>Get-SmbShare -Name "VMS1" | Format-List -Name : VMS1 -ScopeName : Contoso-FS -Path : I:\VMS -Description : +PS C:\>get-smbshare -CimSession "NEDFS1" + +Name ScopeName Path Description PSComputerName +---- --------- ---- ----------- -------------- +ADMIN$ * C:\Windows Remote Admin ae-dfsr-sr-01 +C$ * C:\ Default share ae-dfsr-sr-01 +D$ * D:\ Default share ae-dfsr-sr-01 +E$ * E:\ Default share ae-dfsr-sr-01 +IPC$ * Remote IPC ae-dfsr-sr-01 +IT dept * D:\data\IT dept ae-dfsr-sr-01 +procedures * D:\hr\procedures ae-dfsr-sr-01 +VHD and ISO * D:\data\VHD and ISO ae-dfsr-sr-01 + ``` -This command displays the information about the SMB share named 'VMS1' on the local computer as a formatted list. +This command displays the information about the SMB shares on the remote computer NEDFS1. ### Example 4: Display all properties about a specific SMB share on the local computer in a list ``` @@ -99,7 +92,7 @@ EncryptData : False Name : VMS1 Path : I:\VMS Scoped : True -ScopeName : Contoso-FS +ScopeName : * SecurityDescriptor : O:BAG:DUD:(A;;FA;;;S-1-5-21-219828122-4198910963-4161819395-500)(A;;FA;;;S-1-5-21-219828122-419 8910963-4161819395-1106)(A;;FA;;;S-1-5-21-219828122-4198910963-4161819395-1109) ShadowCopy : False @@ -114,7 +107,7 @@ CimSystemProperties : Microsoft.Management.Infrastructure.CimSystemProperties This command displays all of the information about the SMB share named 'VMS1' on the local computer as a formatted list. -### Example 5: Get shares on the local computer that have scaled out availability +### Example 5: Get shares on the local failover cluster computer that have scale out availability ``` PS C:\>Get-SmbShare | Where-Object -Property AvailabilityType -Eq ScaleOut Name ScopeName Path Description @@ -126,7 +119,7 @@ VMS4 Contoso-SO C:\ClusterStorage\Vo This command retrieves the SMB shares on the computer that have scaled out availability. -### Example 6: Get shares that are connected to a specific server +### Example 6: Get shares that are connected to a local failover cluster file server resource named "Contoso-FS" ``` PS C:\>Get-SmbShare -ScopeName "Contoso-FS" Name ScopeName Path Description @@ -137,7 +130,7 @@ VMS1 Contoso-FS I:\VMS VMS2 Contoso-FS J:\VMS ``` -This command retrieves the SMB shares on the computer that are connected to the SMB server named Contoso-FS. +This command retrieves the SMB shares on the Windows Server failover cluster that are connected to the clustered file server resource named Contoso-FS. ## PARAMETERS @@ -342,7 +335,7 @@ Accept wildcard characters: False ``` ### -ScopeName -Specifies the scope of the share by name. +Specifies the scope of the share by name. For use with Windows Server failover cluster file server resources. ```yaml Type: String[] From 1cb3ca49ebfd36bce79b87a8835f5ee0e93936bb Mon Sep 17 00:00:00 2001 From: Ned pyle Date: Fri, 20 Jan 2023 16:55:36 -0800 Subject: [PATCH 070/650] Update Get-SmbShare.md for scopename and related example --- docset/winserver2022-ps/smbshare/New-SmbShare.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docset/winserver2022-ps/smbshare/New-SmbShare.md b/docset/winserver2022-ps/smbshare/New-SmbShare.md index 9c1c45496e..a3c5a3e9ee 100644 --- a/docset/winserver2022-ps/smbshare/New-SmbShare.md +++ b/docset/winserver2022-ps/smbshare/New-SmbShare.md @@ -39,8 +39,8 @@ To delete a share that was created by this cmdlet, use the `Remove-SmbShare` cmd ```powershell $Parameters = @{ - Name = 'VMSFiles' - Path = 'C:\ClusterStorage\Volume1\VMFiles' + Name = 'Public' + Path = 'D:\Public' FullAccess = 'Contoso\Administrator', 'Contoso\Contoso-HV1$' } New-SmbShare @Parameters @@ -422,7 +422,7 @@ Accept wildcard characters: False ### -ScopeName -Specifies the scope name of the share. +Specifies the scope name of the share. For use with Windows Server failover cluster file server resources. ```yaml Type: String From 09a9330ac2e977adc4327a5416ee3e78e9472c8c Mon Sep 17 00:00:00 2001 From: Ned pyle Date: Fri, 20 Jan 2023 17:00:52 -0800 Subject: [PATCH 071/650] Update Remove-SmbShare.md for scopename and related example --- docset/winserver2022-ps/smbshare/Remove-SmbShare.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docset/winserver2022-ps/smbshare/Remove-SmbShare.md b/docset/winserver2022-ps/smbshare/Remove-SmbShare.md index b5747a442b..9e27520442 100644 --- a/docset/winserver2022-ps/smbshare/Remove-SmbShare.md +++ b/docset/winserver2022-ps/smbshare/Remove-SmbShare.md @@ -50,12 +50,12 @@ Performing operation 'Remove-Share' on Target 'Contoso-FS,Data'. This command deletes the SMB share named Data. -### Example 2: Delete an SMB share without confirmation +### Example 2: Delete a Windows Server failover cluster file server resource SMB share without confirmation ``` PS C:\>Remove-SmbShare -Name "VMFiles" -ScopeName "Contoso-SO" -Force ``` -This command deletes the SMB share named VMFiles without user confirmation. +This command deletes the SMB share named VMFiles on the Contoso-SO file server resource without user confirmation. ## PARAMETERS @@ -153,7 +153,7 @@ Accept wildcard characters: False ``` ### -ScopeName -Specifies an array of the scopes of the SMB share to delete. +Specifies an array of the scopes of the SMB share to delete. For use with Windows Server failover cluster file server resources. ```yaml Type: String[] From 77550aa70d35b802920562f712ccb55accb2ff7d Mon Sep 17 00:00:00 2001 From: Ned pyle Date: Fri, 20 Jan 2023 17:13:13 -0800 Subject: [PATCH 072/650] Update Remove-SmbShare.md for scopename --- docset/winserver2022-ps/smbshare/Set-SmbShare.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/smbshare/Set-SmbShare.md b/docset/winserver2022-ps/smbshare/Set-SmbShare.md index 1b945df3c8..ce2929ed2e 100644 --- a/docset/winserver2022-ps/smbshare/Set-SmbShare.md +++ b/docset/winserver2022-ps/smbshare/Set-SmbShare.md @@ -323,7 +323,7 @@ Accept wildcard characters: False ``` ### -ScopeName -Specifies the scope name of the SMB share. +Specifies the scope name of the SMB share. For use with Windows Server failover cluster file server resources. ```yaml Type: String[] From 9c27e0e51997fb30bb241895e48bf6babe2b7d11 Mon Sep 17 00:00:00 2001 From: Ned pyle Date: Mon, 23 Jan 2023 12:39:50 -0800 Subject: [PATCH 073/650] Update docset/winserver2022-ps/smbshare/Get-SmbShare.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- docset/winserver2022-ps/smbshare/Get-SmbShare.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/smbshare/Get-SmbShare.md b/docset/winserver2022-ps/smbshare/Get-SmbShare.md index da9ed1b503..a5f4a87637 100644 --- a/docset/winserver2022-ps/smbshare/Get-SmbShare.md +++ b/docset/winserver2022-ps/smbshare/Get-SmbShare.md @@ -55,7 +55,7 @@ VMS1 * I:\VMS This command retrieves information about the SMB share named 'VMS1' on the local computer. -### Example 3: Display information about the SMB shares on a remote computer. +### Example 3: Display information about the SMB shares on a remote computer ``` PS C:\>get-smbshare -CimSession "NEDFS1" From 168b8389867eec4e54aa1203982a2b08eaa21636 Mon Sep 17 00:00:00 2001 From: Ned pyle Date: Fri, 27 Jan 2023 16:39:00 -0800 Subject: [PATCH 074/650] Clarified support & fixed synopsis for global mapping Fixed the synopsis and updated the supported and unsupported scenarios for use of New-SmbGlobalMapping --- docset/winserver2022-ps/smbshare/New-SmbGlobalMapping.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docset/winserver2022-ps/smbshare/New-SmbGlobalMapping.md b/docset/winserver2022-ps/smbshare/New-SmbGlobalMapping.md index d48686fbdf..2b4798997c 100644 --- a/docset/winserver2022-ps/smbshare/New-SmbGlobalMapping.md +++ b/docset/winserver2022-ps/smbshare/New-SmbGlobalMapping.md @@ -11,7 +11,7 @@ title: New-SmbGlobalMapping # New-SmbGlobalMapping ## SYNOPSIS -Specifies Server Message Block (SMB) leasing and oplock behaviors. +Creates an SMB global mapping. ## SYNTAX @@ -23,7 +23,7 @@ New-SmbGlobalMapping [[-LocalPath] ] [-RemotePath] -Credential ``` ## DESCRIPTION -The **New-SmbGlobalMapping** cmdlet creates an SMB global mapping on the SMB client to an SMB share. Global mappings allow all users to use the same mapping. Its primary use is for Windows Containers. +The **New-SmbGlobalMapping** cmdlet creates an SMB global mapping on the SMB client to an SMB share. Global mappings allow all users to use the same mapping. Its primary use is for Windows Containers. Global mappings support standalone and failover cluster SMB shares, they do not support DFS Namspace folder shares. ## EXAMPLES From 20760b3e46d800ae67041a19dd93ca7f71660a6d Mon Sep 17 00:00:00 2001 From: Ned pyle Date: Mon, 30 Jan 2023 12:27:58 -0800 Subject: [PATCH 075/650] Update docset/winserver2022-ps/smbshare/New-SmbGlobalMapping.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- docset/winserver2022-ps/smbshare/New-SmbGlobalMapping.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/smbshare/New-SmbGlobalMapping.md b/docset/winserver2022-ps/smbshare/New-SmbGlobalMapping.md index 2b4798997c..9f3fdf6993 100644 --- a/docset/winserver2022-ps/smbshare/New-SmbGlobalMapping.md +++ b/docset/winserver2022-ps/smbshare/New-SmbGlobalMapping.md @@ -23,7 +23,7 @@ New-SmbGlobalMapping [[-LocalPath] ] [-RemotePath] -Credential ``` ## DESCRIPTION -The **New-SmbGlobalMapping** cmdlet creates an SMB global mapping on the SMB client to an SMB share. Global mappings allow all users to use the same mapping. Its primary use is for Windows Containers. Global mappings support standalone and failover cluster SMB shares, they do not support DFS Namspace folder shares. +The **New-SmbGlobalMapping** cmdlet creates an SMB global mapping on the SMB client to an SMB share. Global mappings allow all users to use the same mapping. Its primary use is for Windows Containers. Global mappings support standalone and failover cluster SMB shares, they do not support DFS Namespace folder shares. ## EXAMPLES From 096397f77a9b9695570f3560092c828e01c155af Mon Sep 17 00:00:00 2001 From: Michael Lombardi Date: Fri, 3 Feb 2023 12:29:55 -0600 Subject: [PATCH 076/650] (AB-62329) Update GHA/templates This change updates the github actions and templates to align with the label changes and use of project automation. - Fixes AB#62329 --- .github/ISSUE_TEMPLATE/00-bug.yml | 2 +- .github/ISSUE_TEMPLATE/01-article.yml | 2 +- .github/ISSUE_TEMPLATE/02-quality.yml | 2 ++ .github/workflows/quality.issue.yml | 11 ----------- .github/workflows/quality.pr.yml | 5 ++--- 5 files changed, 6 insertions(+), 16 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/00-bug.yml b/.github/ISSUE_TEMPLATE/00-bug.yml index 8aa79a0e42..1399a0e08e 100644 --- a/.github/ISSUE_TEMPLATE/00-bug.yml +++ b/.github/ISSUE_TEMPLATE/00-bug.yml @@ -2,7 +2,7 @@ name: "🐛 Report a documentation issue" description: >- Report an issue with current documentation. labels: - - doc-bug + - issue-doc-bug - needs-triage body: - type: markdown diff --git a/.github/ISSUE_TEMPLATE/01-article.yml b/.github/ISSUE_TEMPLATE/01-article.yml index aaa3b8d222..944310c939 100644 --- a/.github/ISSUE_TEMPLATE/01-article.yml +++ b/.github/ISSUE_TEMPLATE/01-article.yml @@ -2,7 +2,7 @@ name: "💡 Suggest a new document or idea" description: >- Suggest a new document or major rewrite of an existing one. labels: - - doc-idea + - issue-doc-idea - needs-triage body: - type: checkboxes diff --git a/.github/ISSUE_TEMPLATE/02-quality.yml b/.github/ISSUE_TEMPLATE/02-quality.yml index 2d2ceadee8..9923e2f6d3 100644 --- a/.github/ISSUE_TEMPLATE/02-quality.yml +++ b/.github/ISSUE_TEMPLATE/02-quality.yml @@ -1,6 +1,8 @@ name: "🦾 Commit to a Quality Contribution" description: >- File an issue to take part in the PowerShell Docs Quality Contributions project. +labels: + - project-quality title: "Quality: " body: - type: markdown diff --git a/.github/workflows/quality.issue.yml b/.github/workflows/quality.issue.yml index 636d3c0413..de956745b2 100644 --- a/.github/workflows/quality.issue.yml +++ b/.github/workflows/quality.issue.yml @@ -19,17 +19,6 @@ jobs: regex: "Quality: Foo" flags: gm - project: - name: Add to project - needs: quality - if: needs.quality.outputs.check == 'true' - runs-on: ubuntu-latest - steps: - - uses: actions/add-to-project@v0.3.0 - with: - project-url: https://github.com/orgs/MicrosoftDocs/projects/15/views/1 - github-token: ${{ secrets.quality_token }} - assign: name: Assign to author needs: quality diff --git a/.github/workflows/quality.pr.yml b/.github/workflows/quality.pr.yml index ea7e33624a..ad1feedba6 100644 --- a/.github/workflows/quality.pr.yml +++ b/.github/workflows/quality.pr.yml @@ -33,7 +33,6 @@ jobs: needs.check.outputs.title == 'true' runs-on: ubuntu-latest steps: - - uses: actions/add-to-project@v0.3.0 + - uses: actions-ecosystem/action-add-labels@v1 with: - project-url: https://github.com/orgs/MicrosoftDocs/projects/15/views/1 - github-token: ${{ secrets.quality_token }} + labels: project-quality From a1b1a32c279674ce79dff0d12565e1906840367e Mon Sep 17 00:00:00 2001 From: Docs Allowlist Management Date: Mon, 13 Mar 2023 09:40:31 +0000 Subject: [PATCH 077/650] Remove ms.technology = windows paired with ms.prod=w10 from all content. replace with ms.prod = w10. --- docset/docfx.json | 1 - 1 file changed, 1 deletion(-) diff --git a/docset/docfx.json b/docset/docfx.json index db6155d8ff..9e769dcb50 100644 --- a/docset/docfx.json +++ b/docset/docfx.json @@ -67,7 +67,6 @@ "ROBOTS": "INDEX, FOLLOW", "breadcrumb_path": "/powershell/windows/bread/toc.json", "ms.prod": "w10", - "ms.technology": "windows", "ms.topic": "managed-reference", "ms.author": "jgerend", "author": "JasonGerend", From 4a1e7e79ba30d7b71376d22372b8f91b97dcb5f8 Mon Sep 17 00:00:00 2001 From: robinharwood <19212983+robinharwood@users.noreply.github.com> Date: Mon, 13 Mar 2023 11:49:25 +0000 Subject: [PATCH 078/650] Added alert tip to New-Cluster --- docset/winserver2022-ps/failoverclusters/New-Cluster.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/failoverclusters/New-Cluster.md b/docset/winserver2022-ps/failoverclusters/New-Cluster.md index da139180d0..0ef8af0462 100644 --- a/docset/winserver2022-ps/failoverclusters/New-Cluster.md +++ b/docset/winserver2022-ps/failoverclusters/New-Cluster.md @@ -2,7 +2,7 @@ description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. external help file: Microsoft.FailoverClusters.PowerShell.dll-Help.xml Module Name: FailoverClusters -ms.date: 11/22/2022 +ms.date: 03/13/2023 online version: https://learn.microsoft.com/powershell/module/failoverclusters/new-cluster?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: New-Cluster @@ -30,6 +30,11 @@ Use Test-Cluster to run the validation tests. The tests will confirm that the ha are compatible with failover clustering. There are multiple types of tests, including Inventory, System Configuration, Network, Storage, and other types of tests. +> [!TIP] +> You should run the `New-Cluster` command from a cluster node or client that is the same version as +> the cluster nodes. Running `New-Cluster` from a lower-level (down-level) client machine may +> require `Update-ClusterFunctionalLevel` to be run after `New-Cluster` has been run. + ## EXAMPLES ### Example 1 From f0e263ccd9f091e3b49077ca2ecaa7458cb23be5 Mon Sep 17 00:00:00 2001 From: Robin Harwood <19212983+robinharwood@users.noreply.github.com> Date: Wed, 15 Mar 2023 10:22:34 +0000 Subject: [PATCH 079/650] Applied review suggestion Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- docset/winserver2022-ps/failoverclusters/New-Cluster.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/failoverclusters/New-Cluster.md b/docset/winserver2022-ps/failoverclusters/New-Cluster.md index 0ef8af0462..98a6c68fd7 100644 --- a/docset/winserver2022-ps/failoverclusters/New-Cluster.md +++ b/docset/winserver2022-ps/failoverclusters/New-Cluster.md @@ -32,7 +32,7 @@ System Configuration, Network, Storage, and other types of tests. > [!TIP] > You should run the `New-Cluster` command from a cluster node or client that is the same version as -> the cluster nodes. Running `New-Cluster` from a lower-level (down-level) client machine may +> the cluster nodes. Running `New-Cluster` from a lower-level (down-level) client computer may > require `Update-ClusterFunctionalLevel` to be run after `New-Cluster` has been run. ## EXAMPLES From 4c76a07b2247b3bb6e4227c12e5dda1eb3e8459d Mon Sep 17 00:00:00 2001 From: robinharwood <19212983+robinharwood@users.noreply.github.com> Date: Wed, 8 Feb 2023 13:55:23 +0000 Subject: [PATCH 080/650] Added new example to Get-Cluster --- .../failoverclusters/Get-Cluster.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/failoverclusters/Get-Cluster.md b/docset/winserver2022-ps/failoverclusters/Get-Cluster.md index a851010ffb..1474bd1952 100644 --- a/docset/winserver2022-ps/failoverclusters/Get-Cluster.md +++ b/docset/winserver2022-ps/failoverclusters/Get-Cluster.md @@ -2,7 +2,7 @@ description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. external help file: Microsoft.FailoverClusters.PowerShell.dll-Help.xml Module Name: FailoverClusters -ms.date: 11/22/2022 +ms.date: 02/08/2023 online version: https://learn.microsoft.com/powershell/module/failoverclusters/get-cluster?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Get-Cluster @@ -89,6 +89,18 @@ local cluster. - **QuarantineDuration**: This setting, set to 7200 seconds or 2 hours by default, controls how long a host will remain quarantined. +### Example 7 + +```powershell +(Get-Cluster).MaximumParallelMigrations = 2 +``` + +This example sets the cluster property MaximumParallelMigrations to a value of `2`, limiting the +number of live migrations that a cluster node can participate in. Both existing and new cluster +nodes inherit this value of `2` because it's a cluster property. Setting the cluster +property overrides any values configured using the [Set-VMHost](../hyper-v/Set-VMHost.md) +command. + ## PARAMETERS ### -Domain From 7a7470bc448eee875091354edaec0222ed143e22 Mon Sep 17 00:00:00 2001 From: robinharwood <19212983+robinharwood@users.noreply.github.com> Date: Wed, 8 Feb 2023 14:12:29 +0000 Subject: [PATCH 081/650] Add clarity to MaximumVirtualMachineMigrations parameter --- docset/winserver2022-ps/hyper-v/Set-VMHost.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/docset/winserver2022-ps/hyper-v/Set-VMHost.md b/docset/winserver2022-ps/hyper-v/Set-VMHost.md index af93a8d708..8879cb4707 100644 --- a/docset/winserver2022-ps/hyper-v/Set-VMHost.md +++ b/docset/winserver2022-ps/hyper-v/Set-VMHost.md @@ -2,7 +2,7 @@ description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. external help file: Microsoft.HyperV.PowerShell.Cmdlets.dll-Help.xml Module Name: Hyper-V -ms.date: 12/20/2016 +ms.date: 02/08/2023 online version: https://learn.microsoft.com/powershell/module/hyper-v/set-vmhost?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Set-VMHost @@ -281,7 +281,10 @@ Accept wildcard characters: False ``` ### -MaximumVirtualMachineMigrations -Specifies the maximum number of live migrations that can be performed at the same time on the Hyper-V host. +Specifies the maximum number of live migrations that can be performed at the same time on the +Hyper-V host. If your host is part a Failover Cluster, the cluster property takes precedence any +values set by the **MaximumVirtualMachineMigrations** parameter. To check the cluster property, +you can run the PowerShell command `(Get-Cluster).MaximumParallelMigrations`. ```yaml Type: UInt32 From 7008927e03227d6f3b0700a4bd908199885ee781 Mon Sep 17 00:00:00 2001 From: robinharwood <19212983+robinharwood@users.noreply.github.com> Date: Tue, 14 Feb 2023 11:43:38 +0000 Subject: [PATCH 082/650] Updated Get-Cluster example --- docset/winserver2022-ps/failoverclusters/Get-Cluster.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docset/winserver2022-ps/failoverclusters/Get-Cluster.md b/docset/winserver2022-ps/failoverclusters/Get-Cluster.md index 1474bd1952..cfbf281f36 100644 --- a/docset/winserver2022-ps/failoverclusters/Get-Cluster.md +++ b/docset/winserver2022-ps/failoverclusters/Get-Cluster.md @@ -95,6 +95,11 @@ local cluster. (Get-Cluster).MaximumParallelMigrations = 2 ``` +Beginning with the 2022-09 Cumulative Update, you can now configure the number of parallel live +migrations within a cluster. For more information, see +[KB5017381](https://support.microsoft.com/help/5017381) for Windows Server 2022 and +[KB5017382](https://support.microsoft.com/help/5017382) for Azure Stack HCI, version 21H2. + This example sets the cluster property MaximumParallelMigrations to a value of `2`, limiting the number of live migrations that a cluster node can participate in. Both existing and new cluster nodes inherit this value of `2` because it's a cluster property. Setting the cluster From 08d59640b292c1ee0ded06438a9f8bb879ffb3e3 Mon Sep 17 00:00:00 2001 From: Denise Vangel-MSFT Date: Tue, 21 Mar 2023 09:00:15 -0700 Subject: [PATCH 083/650] Update Set-MpPreference.md --- .../defender/Set-MpPreference.md | 20 ++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/defender/Set-MpPreference.md b/docset/winserver2022-ps/defender/Set-MpPreference.md index bedccf9973..f0d79583f0 100644 --- a/docset/winserver2022-ps/defender/Set-MpPreference.md +++ b/docset/winserver2022-ps/defender/Set-MpPreference.md @@ -2,7 +2,7 @@ description: The Set-MpPreference cmdlet configures preferences for Windows Defender scans and updates. external help file: MSFT_MpPreference.cdxml-help.xml Module Name: Defender -ms.date: 01/03/2023 +ms.date: 03/21/2023 online version: https://learn.microsoft.com/powershell/module/defender/set-mppreference?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Set-MpPreference @@ -46,6 +46,7 @@ Set-MpPreference [-ExclusionPath ] [-ExclusionExtension ] [- [-LowThreatDefaultAction ] [-ModerateThreatDefaultAction ] [-HighThreatDefaultAction ] [-SevereThreatDefaultAction ] [-Force] [-DisableBlockAtFirstSeen ] [-PUAProtection ] + [-ThrottleLimit ] [-AsJob] [] [-DisableGradualRelease ] [-DefinitionUpdatesChannel ] [-EngineUpdatesChannel ] [-PlatformUpdatesChannel ][-CloudBlockLevel ][-ServiceHealthReportInterval ] [-CloudBlockLevel ] [-CloudExtendedTimeout ] [-EnableNetworkProtection ] [-EnableControlledFolderAccess ] [-AttackSurfaceReductionOnlyExclusions ] [-ControlledFolderAccessAllowedApplications ] @@ -1440,6 +1441,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ServiceHealthReportInterval +This policy setting configures the time interval (in minutes) for the service health reports to be sent from endpoints. + +If you do not configure this setting, the default value will be applied. The default value is set at 60 minutes (one hour). +If you configure this setting to 0, no service health reports will be sent. +The maximum value allowed to be set is 14400 minutes (ten days). + +```yaml +Type: UInt32 +Aliases: shri +Accepted values: 0-14400 +Position: Named +Default value: 60 +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -SevereThreatDefaultAction Specifies which automatic remediation action to take for a severe level threat. The acceptable values for this parameter are: From c3b591bfc4263f5bb2dab9d771e3ffbb3e509ef3 Mon Sep 17 00:00:00 2001 From: JosephPilov-MSFT <23519517+PiJoCoder@users.noreply.github.com> Date: Tue, 21 Mar 2023 11:12:53 -0500 Subject: [PATCH 084/650] Learn Editor: Update New-ScheduledTaskPrincipal.md --- .../scheduledtasks/New-ScheduledTaskPrincipal.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/scheduledtasks/New-ScheduledTaskPrincipal.md b/docset/winserver2022-ps/scheduledtasks/New-ScheduledTaskPrincipal.md index cca715d5c4..77bb366d96 100644 --- a/docset/winserver2022-ps/scheduledtasks/New-ScheduledTaskPrincipal.md +++ b/docset/winserver2022-ps/scheduledtasks/New-ScheduledTaskPrincipal.md @@ -140,10 +140,12 @@ The acceptable values for this parameter are: - None - Password - S4U -- Interactive +- - Interactive - Group - ServiceAccount - InteractiveOrPassword + +For more information on LogonType values, see [Principal.LogonType](/windows/win32/taskschd/principal-logontype#property-value) ```yaml Type: LogonTypeEnum @@ -272,3 +274,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Register-ScheduledTask](./Register-ScheduledTask.md) + From 0ec1862f1287574976bd6230a0a57b79c3fabfd7 Mon Sep 17 00:00:00 2001 From: JosephPilov-MSFT <23519517+PiJoCoder@users.noreply.github.com> Date: Tue, 21 Mar 2023 11:13:25 -0500 Subject: [PATCH 085/650] Learn Editor: Update New-ScheduledTaskPrincipal.md From 770c3380dae755d054c9ce2a1a722be744a5fcdb Mon Sep 17 00:00:00 2001 From: Michael Lombardi Date: Tue, 21 Mar 2023 12:38:05 -0500 Subject: [PATCH 086/650] (AB-62321) Update outputs for GHA This change updates the GitHub Actions workflows to use the environment file instead of the `::set-output` command. This is required by May 31, 2023, as [announced by GitHub][01]. [01]: https://github.blog/changelog/2022-10-11-github-actions-deprecating-save-state-and-set-output-commands/ --- .github/workflows/quality.pr.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/quality.pr.yml b/.github/workflows/quality.pr.yml index ad1feedba6..072672cdc8 100644 --- a/.github/workflows/quality.pr.yml +++ b/.github/workflows/quality.pr.yml @@ -24,7 +24,7 @@ jobs: run: | $Check = "${{ contains(github.event.pull_request.title, 'Quality:') }}" "Check: $Check" - "::set-output name=check::$Check" + "check=$Check" >> $env:GITHUB_OUTPUT project: name: Add pull request to project From 2fdb1b9495605a7624fb240fb5e0f06eadaad5b4 Mon Sep 17 00:00:00 2001 From: Denise Vangel-MSFT Date: Wed, 22 Mar 2023 11:28:33 -0700 Subject: [PATCH 087/650] Update Set-MpPreference.md --- docset/winserver2022-ps/defender/Set-MpPreference.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docset/winserver2022-ps/defender/Set-MpPreference.md b/docset/winserver2022-ps/defender/Set-MpPreference.md index f0d79583f0..ebc82cdc85 100644 --- a/docset/winserver2022-ps/defender/Set-MpPreference.md +++ b/docset/winserver2022-ps/defender/Set-MpPreference.md @@ -2,7 +2,7 @@ description: The Set-MpPreference cmdlet configures preferences for Windows Defender scans and updates. external help file: MSFT_MpPreference.cdxml-help.xml Module Name: Defender -ms.date: 03/21/2023 +ms.date: 03/22/2023 online version: https://learn.microsoft.com/powershell/module/defender/set-mppreference?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Set-MpPreference @@ -1442,7 +1442,7 @@ Accept wildcard characters: False ``` ### -ServiceHealthReportInterval -This policy setting configures the time interval (in minutes) for the service health reports to be sent from endpoints. +This policy setting configures the time interval (in minutes) for the service health reports to be sent from endpoints. These are for Microsoft Defender Antivirus events 1150 and 1151. For more information, see [Microsoft Defender Antivirus event IDs](/microsoft-365/security/defender-endpoint/troubleshoot-microsoft-defender-antivirus#microsoft-defender-antivirus-event-ids). If you do not configure this setting, the default value will be applied. The default value is set at 60 minutes (one hour). If you configure this setting to 0, no service health reports will be sent. From 6b6dc42b9729d717f61d735deee28ff9ffbed85b Mon Sep 17 00:00:00 2001 From: Denise Vangel-MSFT Date: Wed, 22 Mar 2023 11:31:18 -0700 Subject: [PATCH 088/650] Update Set-MpPreference.md --- docset/winserver2019-ps/defender/Set-MpPreference.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docset/winserver2019-ps/defender/Set-MpPreference.md b/docset/winserver2019-ps/defender/Set-MpPreference.md index 7c99cf3d20..4c5ccfe3cb 100644 --- a/docset/winserver2019-ps/defender/Set-MpPreference.md +++ b/docset/winserver2019-ps/defender/Set-MpPreference.md @@ -2,7 +2,7 @@ description: Use this article to help manage Windows and Windows Server technologies with Windows PowerShell. external help file: MSFT_MpPreference.cdxml-help.xml Module Name: Defender -ms.date: 09/20/2022 +ms.date: 03/22/2023 online version: https://learn.microsoft.com/powershell/module/defender/set-mppreference?view=windowsserver2019-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Set-MpPreference @@ -1024,7 +1024,7 @@ Accept wildcard characters: False ``` ### -ServiceHealthReportInterval -This policy setting configures the time interval (in minutes) for the service health reports to be sent from endpoints. +This policy setting configures the time interval (in minutes) for the service health reports to be sent from endpoints. These are for Microsoft Defender Antivirus events 1150 and 1151. For more information, see [Microsoft Defender Antivirus event IDs](/microsoft-365/security/defender-endpoint/troubleshoot-microsoft-defender-antivirus#microsoft-defender-antivirus-event-ids). If you don’t configure this setting, the default value will be applied. The default value is set at 60 minutes (one hour). If you configure this setting to 0, no service health reports will be sent. From 944db4361953c63810a6ff29f9a81e58197b500a Mon Sep 17 00:00:00 2001 From: JosephPilov-MSFT <23519517+PiJoCoder@users.noreply.github.com> Date: Sat, 25 Mar 2023 12:32:37 -0500 Subject: [PATCH 089/650] Update docset/winserver2022-ps/scheduledtasks/New-ScheduledTaskPrincipal.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- .../scheduledtasks/New-ScheduledTaskPrincipal.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/scheduledtasks/New-ScheduledTaskPrincipal.md b/docset/winserver2022-ps/scheduledtasks/New-ScheduledTaskPrincipal.md index 77bb366d96..9e37ee0348 100644 --- a/docset/winserver2022-ps/scheduledtasks/New-ScheduledTaskPrincipal.md +++ b/docset/winserver2022-ps/scheduledtasks/New-ScheduledTaskPrincipal.md @@ -145,7 +145,7 @@ The acceptable values for this parameter are: - ServiceAccount - InteractiveOrPassword -For more information on LogonType values, see [Principal.LogonType](/windows/win32/taskschd/principal-logontype#property-value) +For more information about LogonType values, see [Principal.LogonType](/windows/win32/taskschd/principal-logontype#property-value) ```yaml Type: LogonTypeEnum From 89694e73c107044fcd560586eebf57b10ec7a5f6 Mon Sep 17 00:00:00 2001 From: JosephPilov-MSFT <23519517+PiJoCoder@users.noreply.github.com> Date: Sat, 25 Mar 2023 12:33:02 -0500 Subject: [PATCH 090/650] Update docset/winserver2022-ps/scheduledtasks/New-ScheduledTaskPrincipal.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- .../scheduledtasks/New-ScheduledTaskPrincipal.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/scheduledtasks/New-ScheduledTaskPrincipal.md b/docset/winserver2022-ps/scheduledtasks/New-ScheduledTaskPrincipal.md index 9e37ee0348..0606602fab 100644 --- a/docset/winserver2022-ps/scheduledtasks/New-ScheduledTaskPrincipal.md +++ b/docset/winserver2022-ps/scheduledtasks/New-ScheduledTaskPrincipal.md @@ -140,7 +140,7 @@ The acceptable values for this parameter are: - None - Password - S4U -- - Interactive +- Interactive - Group - ServiceAccount - InteractiveOrPassword From d2825f825d2a2cdb546cf4ce75dc9503f44c4a4e Mon Sep 17 00:00:00 2001 From: Meghan Stewart <33289333+mestew@users.noreply.github.com> Date: Thu, 30 Mar 2023 14:04:13 -0700 Subject: [PATCH 091/650] Default processingtype for get-windowsupdatelog is XML --- docset/winserver2016-ps/windowsupdate/Get-WindowsUpdateLog.md | 2 +- docset/winserver2019-ps/windowsupdate/Get-WindowsUpdateLog.md | 2 +- docset/winserver2022-ps/windowsupdate/Get-WindowsUpdateLog.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docset/winserver2016-ps/windowsupdate/Get-WindowsUpdateLog.md b/docset/winserver2016-ps/windowsupdate/Get-WindowsUpdateLog.md index 5f97bb34b9..8e3bb19471 100644 --- a/docset/winserver2016-ps/windowsupdate/Get-WindowsUpdateLog.md +++ b/docset/winserver2016-ps/windowsupdate/Get-WindowsUpdateLog.md @@ -151,7 +151,7 @@ The acceptable values for this parameter are: - CSV (comma-separated values) - XML -By default, the value is CSV. +By default, the value is XML. The temporary files are in $env:TEMP\WindowsUpdateLog. ```yaml diff --git a/docset/winserver2019-ps/windowsupdate/Get-WindowsUpdateLog.md b/docset/winserver2019-ps/windowsupdate/Get-WindowsUpdateLog.md index 4fd192bc4b..1f8c425539 100644 --- a/docset/winserver2019-ps/windowsupdate/Get-WindowsUpdateLog.md +++ b/docset/winserver2019-ps/windowsupdate/Get-WindowsUpdateLog.md @@ -151,7 +151,7 @@ The acceptable values for this parameter are: - CSV (comma-separated values) - XML -By default, the value is CSV. +By default, the value is XML. The temporary files are in $env:TEMP\WindowsUpdateLog. ```yaml diff --git a/docset/winserver2022-ps/windowsupdate/Get-WindowsUpdateLog.md b/docset/winserver2022-ps/windowsupdate/Get-WindowsUpdateLog.md index 940475fdaf..2f9e8132ec 100644 --- a/docset/winserver2022-ps/windowsupdate/Get-WindowsUpdateLog.md +++ b/docset/winserver2022-ps/windowsupdate/Get-WindowsUpdateLog.md @@ -151,7 +151,7 @@ The acceptable values for this parameter are: - CSV (comma-separated values) - XML -By default, the value is CSV. +By default, the value is XML. The temporary files are in $env:TEMP\WindowsUpdateLog. ```yaml From 901152d1a68488dd78b17c7d58951c443cd71f0c Mon Sep 17 00:00:00 2001 From: Sa Yang <31430559+yangsa666@users.noreply.github.com> Date: Tue, 4 Apr 2023 11:12:25 +0800 Subject: [PATCH 092/650] Update Set-MpPreference.md According to the Syntax [-ScanScheduleTime ] The original example `PS C:\> Set-MpPreference -SignatureScheduleTime 120` should be a mistake. The correct example should be `PS C:\> Set-MpPreference -SignatureScheduleTime 02:00:00` --- docset/winserver2022-ps/defender/Set-MpPreference.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/defender/Set-MpPreference.md b/docset/winserver2022-ps/defender/Set-MpPreference.md index ebc82cdc85..793842a17b 100644 --- a/docset/winserver2022-ps/defender/Set-MpPreference.md +++ b/docset/winserver2022-ps/defender/Set-MpPreference.md @@ -93,7 +93,7 @@ This command configures preferences to check for definition updates every day. ### Example 2: Schedule a time of day to check for definition updates ``` -PS C:\> Set-MpPreference -SignatureScheduleTime 120 +PS C:\> Set-MpPreference -SignatureScheduleTime 02:00:00 ``` This command configures preferences to check for definition updates 120 minutes after midnight on days when it's scheduled to check. From 73b1cff627ec25fb23332781a8193ed914295030 Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Fri, 14 Apr 2023 19:44:14 +0530 Subject: [PATCH 093/650] Update Set-MpPreference.md Added AllowSwitchToAsyncInspection parameter fixes https://github.com/MicrosoftDocs/windows-powershell-docs/issues/3252 --- .../defender/Set-MpPreference.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/docset/winserver2022-ps/defender/Set-MpPreference.md b/docset/winserver2022-ps/defender/Set-MpPreference.md index ebc82cdc85..59c419e3ce 100644 --- a/docset/winserver2022-ps/defender/Set-MpPreference.md +++ b/docset/winserver2022-ps/defender/Set-MpPreference.md @@ -145,6 +145,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` + +### -AllowSwitchToAsyncInspection + +Specifies whether to enable a performance optimization that allows synchronously inspected network flows to switch to async inspection once they've been checked and validated. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + + ### -AsJob Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. From 3b7fbec08d84c5c780245d7e2229056999fca4b9 Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Fri, 14 Apr 2023 19:46:08 +0530 Subject: [PATCH 094/650] Update Set-MpPreference.md --- docset/winserver2022-ps/defender/Set-MpPreference.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/defender/Set-MpPreference.md b/docset/winserver2022-ps/defender/Set-MpPreference.md index 59c419e3ce..85a0dc8c4d 100644 --- a/docset/winserver2022-ps/defender/Set-MpPreference.md +++ b/docset/winserver2022-ps/defender/Set-MpPreference.md @@ -40,7 +40,7 @@ Set-MpPreference [-ExclusionPath ] [-ExclusionExtension ] [- [-DisableCatchupFullScan ] [-DisableCatchupQuickScan ] [-DisableEmailScanning ] [-DisableRemovableDriveScanning ] [-DisableRestorePoint ] [-DisableScanningMappedNetworkDrivesForFullScan ] [-DisableScanningNetworkFiles ] - [-DisableIOAVProtection ] + [-DisableIOAVProtection ] [-AllowSwitchToAsyncInspection ] [-UILockdown ] [-ThreatIDDefaultAction_Ids ] [-ThreatIDDefaultAction_Actions ] [-UnknownThreatDefaultAction ] [-LowThreatDefaultAction ] [-ModerateThreatDefaultAction ] From 88416fc5e9cfe688dbeb3c6ae1aa6ad1883b5d64 Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Fri, 14 Apr 2023 19:46:13 +0530 Subject: [PATCH 095/650] Update Set-MpPreference.md --- .../defender/Set-MpPreference.md | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/docset/winserver2019-ps/defender/Set-MpPreference.md b/docset/winserver2019-ps/defender/Set-MpPreference.md index 4c5ccfe3cb..277a3efca6 100644 --- a/docset/winserver2019-ps/defender/Set-MpPreference.md +++ b/docset/winserver2019-ps/defender/Set-MpPreference.md @@ -24,7 +24,7 @@ Set-MpPreference [-ExclusionPath ] [-ExclusionExtension ] [- [-CheckForSignaturesBeforeRunningScan ] [-ScanPurgeItemsAfterDelay ] [-ScanOnlyIfIdleEnabled ] [-ScanParameters ] [-ScanScheduleDay ] [-ScanScheduleQuickScanTime ] [-ScanScheduleOffset ] [-SignatureFirstAuGracePeriod ] - [-ScanScheduleTime ] + [-ScanScheduleTime ] [-AllowSwitchToAsyncInspection ] [-SignatureAuGracePeriod ] [-SignatureDefinitionUpdateFileSharesSources ] [-SignatureDisableUpdateOnStartupWithoutEngine ] [-SignatureFallbackOrder ] [-SignatureScheduleDay ] [-SignatureScheduleTime ] [-SignatureUpdateCatchupInterval ] @@ -85,6 +85,23 @@ This command configures preferences to check for definition updates 120 minutes ## PARAMETERS +### -AllowSwitchToAsyncInspection + +Specifies whether to enable a performance optimization that allows synchronously inspected network flows to switch to async inspection once they've been checked and validated. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + + ### -AsJob Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. From e64280ed27cc483c48c356ba651fdf905c1cc5c5 Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Fri, 14 Apr 2023 19:46:23 +0530 Subject: [PATCH 096/650] Update Set-MpPreference.md --- .../defender/Set-MpPreference.md | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/docset/winserver2016-ps/defender/Set-MpPreference.md b/docset/winserver2016-ps/defender/Set-MpPreference.md index 0f158508da..5d60ca8509 100644 --- a/docset/winserver2016-ps/defender/Set-MpPreference.md +++ b/docset/winserver2016-ps/defender/Set-MpPreference.md @@ -35,7 +35,7 @@ Set-MpPreference [-ExclusionPath ] [-ExclusionExtension ] [- [-DisableCatchupFullScan ] [-DisableCatchupQuickScan ] [-DisableCpuThrottleOnIdleScans ] [-DisableEmailScanning ] [-DisableRemovableDriveScanning ] [-DisableRestorePoint ] [-DisableScanningMappedNetworkDrivesForFullScan ] [-DisableScanningNetworkFiles ] - [-UILockdown ] [-ThreatIDDefaultAction_Ids ] + [-UILockdown ] [-ThreatIDDefaultAction_Ids ] [-AllowSwitchToAsyncInspection ] [-ThreatIDDefaultAction_Actions ] [-UnknownThreatDefaultAction ] [-LowThreatDefaultAction ] [-ModerateThreatDefaultAction ] [-HighThreatDefaultAction ] [-SevereThreatDefaultAction ] [-Force] @@ -102,6 +102,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -AllowSwitchToAsyncInspection + +Specifies whether to enable a performance optimization that allows synchronously inspected network flows to switch to async inspection once they've been checked and validated. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Enabled +Accept pipeline input: False +Accept wildcard characters: False +``` + + ### -CheckForSignaturesBeforeRunningScan Indicates whether to check for new virus and spyware definitions before Windows Defender runs a scan. If you specify a value of $True, Windows Defender checks for new definitions. From 448fd4fc37c37a9cffbf9f392bf6ef6194e6ade4 Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Fri, 14 Apr 2023 19:51:23 +0530 Subject: [PATCH 097/650] Update Set-MpPreference.md made changes to -CheckForSignaturesBeforeRunningScan as per group policy description Fixes https://github.com/MicrosoftDocs/windows-powershell-docs/issues/3251 --- docset/winserver2022-ps/defender/Set-MpPreference.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/defender/Set-MpPreference.md b/docset/winserver2022-ps/defender/Set-MpPreference.md index ebc82cdc85..2656182bd5 100644 --- a/docset/winserver2022-ps/defender/Set-MpPreference.md +++ b/docset/winserver2022-ps/defender/Set-MpPreference.md @@ -220,7 +220,7 @@ Accept wildcard characters: False Indicates whether to check for new virus and spyware definitions before Windows Defender runs a scan. If you specify a value of $True, Windows Defender checks for new definitions. If you specify $False or don't specify a value, the scan begins with existing definitions. -This value applies to scheduled scans and to scans that you start from the command line, but it doesn't affect scans that you start from the user interface. +This setting applies to scheduled scans, but it has no effect on scans initiated manually from the user interface or to the ones started from the command line using "mpcmdrun -Scan" ```yaml Type: Boolean From 1b35e81f6e54a39ca16a105b3b5508bfb1a322cf Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Fri, 14 Apr 2023 19:52:33 +0530 Subject: [PATCH 098/650] Update Set-MpPreference.md --- docset/winserver2019-ps/defender/Set-MpPreference.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2019-ps/defender/Set-MpPreference.md b/docset/winserver2019-ps/defender/Set-MpPreference.md index 4c5ccfe3cb..3e47d7bbec 100644 --- a/docset/winserver2019-ps/defender/Set-MpPreference.md +++ b/docset/winserver2019-ps/defender/Set-MpPreference.md @@ -114,7 +114,7 @@ Accept wildcard characters: False Indicates whether to check for new virus and spyware definitions before Windows Defender runs a scan. If you specify a value of `$True`, Windows Defender checks for new definitions. If you specify `$False` or don’t specify a value, the scan begins with existing definitions. -This value applies to scheduled scans, but it doesn’t affect scans that you start from the user interface or to scans that you start from the command line. +This setting applies to scheduled scans, but it has no effect on scans initiated manually from the user interface or to the ones started from the command line using "mpcmdrun -Scan" ```yaml Type: Boolean From 7582c115bca4ce95ecb3838bbe44352a4f3a3148 Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Fri, 14 Apr 2023 19:52:35 +0530 Subject: [PATCH 099/650] Update Set-MpPreference.md --- docset/winserver2016-ps/defender/Set-MpPreference.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2016-ps/defender/Set-MpPreference.md b/docset/winserver2016-ps/defender/Set-MpPreference.md index 0f158508da..76f27dd2ab 100644 --- a/docset/winserver2016-ps/defender/Set-MpPreference.md +++ b/docset/winserver2016-ps/defender/Set-MpPreference.md @@ -106,7 +106,7 @@ Accept wildcard characters: False Indicates whether to check for new virus and spyware definitions before Windows Defender runs a scan. If you specify a value of $True, Windows Defender checks for new definitions. If you specify $False or don't specify a value, the scan begins with existing definitions. -This value applies to scheduled scans and to scans that you start from the command line, but it doesn't affect scans that you start from the user interface. +This setting applies to scheduled scans, but it has no effect on scans initiated manually from the user interface or to the ones started from the command line using "mpcmdrun -Scan" ```yaml Type: Boolean From f4a64864e5eb3071ad517485835df4285c010b0c Mon Sep 17 00:00:00 2001 From: Jay Simmons Date: Sat, 15 Apr 2023 09:33:59 -0700 Subject: [PATCH 100/650] Create PowerShell documentation for new Windows LAPS feature --- .../laps/Find-LapsADExtendedRights.md | 153 +++++++ .../laps/Get-LapsAADPassword.md | 240 ++++++++++ .../laps/Get-LapsADPassword.md | 428 ++++++++++++++++++ .../laps/Get-LapsDiagnostics.md | 155 +++++++ .../laps/Invoke-LapsPolicyProcessing.md | 65 +++ docset/winserver2022-ps/laps/LAPS.md | 79 ++++ .../laps/Reset-LapsPassword.md | 73 +++ .../laps/Set-LapsADAuditing.md | 209 +++++++++ .../laps/Set-LapsADComputerSelfPermission.md | 171 +++++++ .../laps/Set-LapsADPasswordExpirationTime.md | 187 ++++++++ .../laps/Set-LapsADReadPasswordPermission.md | 234 ++++++++++ .../laps/Set-LapsADResetPasswordPermission.md | 234 ++++++++++ .../laps/Update-LapsADSchema.md | 119 +++++ 13 files changed, 2347 insertions(+) create mode 100644 docset/winserver2022-ps/laps/Find-LapsADExtendedRights.md create mode 100644 docset/winserver2022-ps/laps/Get-LapsAADPassword.md create mode 100644 docset/winserver2022-ps/laps/Get-LapsADPassword.md create mode 100644 docset/winserver2022-ps/laps/Get-LapsDiagnostics.md create mode 100644 docset/winserver2022-ps/laps/Invoke-LapsPolicyProcessing.md create mode 100644 docset/winserver2022-ps/laps/LAPS.md create mode 100644 docset/winserver2022-ps/laps/Reset-LapsPassword.md create mode 100644 docset/winserver2022-ps/laps/Set-LapsADAuditing.md create mode 100644 docset/winserver2022-ps/laps/Set-LapsADComputerSelfPermission.md create mode 100644 docset/winserver2022-ps/laps/Set-LapsADPasswordExpirationTime.md create mode 100644 docset/winserver2022-ps/laps/Set-LapsADReadPasswordPermission.md create mode 100644 docset/winserver2022-ps/laps/Set-LapsADResetPasswordPermission.md create mode 100644 docset/winserver2022-ps/laps/Update-LapsADSchema.md diff --git a/docset/winserver2022-ps/laps/Find-LapsADExtendedRights.md b/docset/winserver2022-ps/laps/Find-LapsADExtendedRights.md new file mode 100644 index 0000000000..691282afe9 --- /dev/null +++ b/docset/winserver2022-ps/laps/Find-LapsADExtendedRights.md @@ -0,0 +1,153 @@ +--- +description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. +external help file: lapspsh.dll-Help.xml +Module Name: LAPS +online version: https://learn.microsoft.com/powershell/module/laps/find-lapsadextendedrights?view=windowsserver2022-ps&wt.mc_id=ps-gethelp +schema: 2.0.0 +Locale: en-US +ms.date: 04/10/2023 +title: Find-LapsADExtendedRights +--- + +# Find-LapsADExtendedRights + +## SYNOPSIS + +Queries Active Directory to find principals that have been granted permission to read Windows Local +Administrator Password Solution (LAPS) password attributes. + +## SYNTAX + +```powershell +Find-LapsADExtendedRights [-Credential ] -Identity [-Domain ] + [-DomainController ] [-IncludeComputers] [] +``` + +## DESCRIPTION + +The **Find-LapsADExtendedRights** cmdlet is used by administrators to query which principals have +been granted permissions to read the LAPS password attributes. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> Find-LapsADExtendedRights -Identity LapsTestOU + +ObjectDN ExtendedRightHolders +-------- -------------------- +OU=LapsTestOU,DC=laps,DC=com {NT AUTHORITY\SYSTEM, LAPS\Domain Admins, LAPS\LapsAdmins} +``` + +This example shows how to run the cmdlet. + +## PARAMETERS + +### -Credential + +Specifies the credentials to use when updating Active Directory. If not specified the current user's +credentials will be used. + +```yaml +Type: System.Management.Automation.PSCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Domain + +Specifies which Active Directory domain to connect to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController + +Specifies which Active Directory domain controller to connect to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +Specifies which Active Directory Organizational Unit to query. + +This parameter accepts several different name formats which influence the criteria used in the +resultant Active Directory search. The supported name formats are as follows: + +distinguishedName (begins with a "CN=") +name (for all other inputs) + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -IncludeComputers + +Specify this parameter to also check computer objects for the permissions. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, +-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, +-WarningAction, and -WarningVariable. For more information, see +[about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String[] + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Windows LAPS Overview](https://go.microsoft.com/fwlink/?linkid=2233901) diff --git a/docset/winserver2022-ps/laps/Get-LapsAADPassword.md b/docset/winserver2022-ps/laps/Get-LapsAADPassword.md new file mode 100644 index 0000000000..88526d1ff6 --- /dev/null +++ b/docset/winserver2022-ps/laps/Get-LapsAADPassword.md @@ -0,0 +1,240 @@ +--- +description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. +external help file: LAPS-help.xml +Module Name: LAPS +online version: https://learn.microsoft.com/powershell/module/laps/get-lapsaadpassword?view=windowsserver2022-ps&wt.mc_id=ps-gethelp +schema: 2.0.0 +Locale: en-US +ms.date: 04/10/2023 +title: Get-LapsAADPassword +--- + +# Get-LapsAADPassword + +## SYNOPSIS + +Queries Azure Active Directory for the Windows Local Administrator Password Solution (LAPS) +credentials on a specified Azure AD device. + +## SYNTAX + +```powershell +Get-LapsAADPassword -DeviceIds [-IncludePasswords] [-IncludeHistory] [-AsPlainText] + [] +``` + +## DESCRIPTION + +The **Get-LapsAADPassword** cmdlet allows administrators to retrieve LAPS passwords and password +history for an Azure Active Directory-joined device. This is implemented by sending queries to +Microsoft Graph over the deviceLocalCredentials collection. + +The **Get-LapsAADPassword** cmdlet supports two basic modes when querying LAPS passwords: + +The first mode queries for non-sensitive metadata, for example time the password was backed up to +Azure and the expected expiration time of a password. This mode requires that the client be granted +the Microsoft Graph `DeviceLocalCredential.ReadBasic.All` permission. + +The second mode queries for all password information including both the metadata information +described above and the clear-text form of the password(s). This mode requires that the client be +granted the Microsoft Graph `DeviceLocalCredential.Read.All` permission. + +The '-DeviceIds' parameter accepts either device names or device IDs, but the underlying Microsoft +Graph queries only supports querying by device ID. To support this the cmdlet will map a device name +input to its corresponding device ID by issuing a separate Microsoft Graph query. This extra query +requires the `Device.Read.All` permission. If the target is a Microsoft Managed Desktop device, the +`DeviceManagementManagedDevices.Read.All` permission may also be required. + +> [!TIP] +> If there are multiple devices in the tenant with the same name, the cmdlet will fail. The +> workaround is to input the device ID directly. + +> [!IMPORTANT] +> The **Get-LapsAADPassword** cmdlet is implemented as a wrapper around the Microsoft Graph +> PowerShell library which must be manually installed on the device before **Get-LapsAADPassword** +> can work. Additional configuration steps are required in your Azure Active Directory tenant to +> enable authentication to Microsoft Graph and to grant the necessary Microsoft Graph permissions as +> described above. See the following topic for more information: +> [Get started with Windows LAPS and Azure Active Directory](https://go.microsoft.com/fwlink/?linkid=2233704) + +The -Verbose parameter may be used to get additional information about the cmdlet's operation. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> Connect-MgGraph -TenantId b20f5886-bddf-43bb-aee6-dda0c87c5fa2 -ClientId +9fa98e34-277f-47fa-9847-e36bdf6bca1f Welcome To Microsoft Graph! PS C:\> Get-LapsAADPassword +-DeviceIds LAPSAAD + +DeviceName DeviceId PasswordExpirationTime +---------- -------- ---------------------- +LAPSAAD dfc6d5f0-225a-4b46-adcf-73a349a31e70 4/22/2023 8:45:29 AM +``` + +This example shows how to query basic LAPS password metadata information for the target device which +is specified by device name. + +### Example 2 + +```powershell +PS C:\> Connect-MgGraph -TenantId b20f5886-bddf-43bb-aee6-dda0c87c5fa2 -ClientId 9fa98e34-277f-47fa-9847-e36bdf6bca1f +Welcome To Microsoft Graph! +PS C:\> Get-LapsAADPassword -DeviceIds dfc6d5f0-225a-4b46-adcf-73a349a31e70 -IncludePasswords + +DeviceName : LAPSAAD +DeviceId : dfc6d5f0-225a-4b46-adcf-73a349a31e70 +Account : LapsAdmin +Password : System.Security.SecureString +PasswordExpirationTime : 4/22/2023 8:45:29 AM +PasswordUpdateTime : 4/11/2023 8:45:29 AM +``` + +This example shows how to query the full LAPS password information for the target device which is +specified by device ID. + +### Example 3 + +```powershell +PS C:\> Connect-MgGraph -TenantId b20f5886-bddf-43bb-aee6-dda0c87c5fa2 -ClientId 9fa98e34-277f-47fa-9847-e36bdf6bca1f +Welcome To Microsoft Graph! +PS C:\> Get-LapsAADPassword -DeviceIds dfc6d5f0-225a-4b46-adcf-73a349a31e70 -IncludePasswords -AsPlainText + +DeviceName : LAPSAAD +DeviceId : dfc6d5f0-225a-4b46-adcf-73a349a31e70 +Account : LapsAdmin +Password : g4q22s[Xz8}!T32[4;Z#0M}v35udF[xB0}iB;P@xk%9E9Tgw,W]7)vx9O!- +PasswordExpirationTime : 4/22/2023 8:45:29 AM +PasswordUpdateTime : 4/11/2023 8:45:29 AM +``` + +This example shows how to query the full LAPS password information for the target device which is +specified by device ID, and displaying the password in clear-text form. + +### Example 4 + +```powershell +PS C:\> Connect-MgGraph -TenantId b20f5886-bddf-43bb-aee6-dda0c87c5fa2 -ClientId 9fa98e34-277f-47fa-9847-e36bdf6bca1f +Welcome To Microsoft Graph! +PS C:\> Get-LapsAADPassword -DeviceIds lapsAAD -IncludePasswords -AsPlainText -IncludeHistory + +DeviceName : LAPSAAD +DeviceId : dfc6d5f0-225a-4b46-adcf-73a349a31e70 +Account : LapsAdmin +Password : ]5j)1fi]Rv&Pj+IMiAzq1R9b+yJ.@Q,80#01U541vsC8$Vv${hac8TJlkT8 +PasswordExpirationTime : 4/22/2023 8:55:20 AM +PasswordUpdateTime : 4/11/2023 8:55:21 AM + +DeviceName : LAPSAAD +DeviceId : dfc6d5f0-225a-4b46-adcf-73a349a31e70 +Account : LapsAdmin +Password : t&.1P%9891]24I0X4AA4O22a30R1lz(ar7N9{tTf349.Iz{L82O6v{I+,gg +PasswordExpirationTime : +PasswordUpdateTime : 4/11/2023 8:55:16 AM + +DeviceName : LAPSAAD +DeviceId : dfc6d5f0-225a-4b46-adcf-73a349a31e70 +Account : LapsAdmin +Password : g4q22s[Xz8}!T32[4;Z#0M}v35udF[xB0}iB;P@xk%9E9Tgw,W]7)vx9O!- +PasswordExpirationTime : +PasswordUpdateTime : 4/11/2023 8:45:29 AM +``` + +This example shows how to query the full LAPS password information for the target device which is +specified by device name, requesting password history, and displaying the passwords in clear-text +form. + +## PARAMETERS + +### -AsPlainText + +Specify this parameter to return the LAPS passwords in clear-text format. The default behavior is to +return the LAPS passwords wrapped in a .NET SecureString object. + +> [!IMPORTANT] +> Using this parameter exposes the returned clear-text password to casual viewing and may pose a +> security risk. This parameter should be used with caution and only in support or testing +> situations. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeviceIds + +Specifies the device name or device ID to query LAPS credentials. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeHistory + +Specifies that any older LAPS credentials on the device object should also be displayed. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludePasswords + +Specifies whether to return password information. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, +-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, +-WarningAction, and -WarningVariable. For more information, see +[about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Windows LAPS Overview](https://go.microsoft.com/fwlink/?linkid=2233901) +[Get started with Windows LAPS and Azure Active Directory](https://go.microsoft.com/fwlink/?linkid=2233704) \ No newline at end of file diff --git a/docset/winserver2022-ps/laps/Get-LapsADPassword.md b/docset/winserver2022-ps/laps/Get-LapsADPassword.md new file mode 100644 index 0000000000..fd292c92c3 --- /dev/null +++ b/docset/winserver2022-ps/laps/Get-LapsADPassword.md @@ -0,0 +1,428 @@ +--- +description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. +external help file: lapspsh.dll-Help.xml +Module Name: LAPS +online version: https://learn.microsoft.com/powershell/module/laps/get-lapsadpassword?view=windowsserver2022-ps&wt.mc_id=ps-gethelp +schema: 2.0.0 +Locale: en-US +ms.date: 04/10/2023 +title: Get-LapsADPassword +--- + +# Get-LapsADPassword + +## SYNOPSIS + +Queries Windows Local Administrator Password Solution (LAPS) credentials from Active Directory on a +specified AD computer or domain controller object. + +## SYNTAX + +### NormalMode (Default) + +```powershell +Get-LapsADPassword [-Credential ] [-DecryptionCredential ] [-IncludeHistory] + [-AsPlainText] [-Identity] [] +``` + +### DomainMode + +```powershell +Get-LapsADPassword [-Credential ] [-DecryptionCredential ] [-IncludeHistory] + [-AsPlainText] [-Identity] -Domain [] +``` + +### DomainControllerMode + +```powershell +Get-LapsADPassword [-Credential ] [-DecryptionCredential ] [-IncludeHistory] + [-AsPlainText] [-Identity] -DomainController [] +``` + +### SnapshotBrowserMode + +```powershell +Get-LapsADPassword [-Credential ] [-DecryptionCredential ] [-IncludeHistory] + [-AsPlainText] -Port [-Identity] [-DomainController ] [] +``` + +### RecoveryMode + +```powershell +Get-LapsADPassword [-IncludeHistory] [-AsPlainText] [-RecoveryMode] [-Identity] [] +``` + +### SnapshotBrowserRecoveryMode + +```powershell +Get-LapsADPassword [-IncludeHistory] [-AsPlainText] [-RecoveryMode] -Port [-Identity] + [] +``` + +## DESCRIPTION + +The **Get-LapsADPassword** cmdlet allows administrators to retrieve LAPS passwords and password +history for an Active Directory computer or domain controller object. Depending on policy +configuration, LAPS passwords may be stored in either clear-text form or encrypted form. The +**Get-LapsADPassword** cmdlet will automatically perform decryption of encrypted passwords. + +The **Get-LapsADPassword** cmdlet may also be used to connected to a mounted Active Directory snapshot. + +The -Verbose parameter may be used to get additional information about the cmdlet's operation. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> Get-LapsADPassword lapsClient + +ComputerName : LAPSCLIENT +DistinguishedName : CN=LAPSCLIENT,OU=LapsTestOU,DC=laps,DC=com +Account : Administrator +Password : System.Security.SecureString +PasswordUpdateTime : 4/9/2023 10:03:41 AM +ExpirationTimestamp : 4/14/2023 10:03:41 AM +Source : CleartextPassword +DecryptionStatus : NotApplicable +AuthorizedDecryptor : NotApplicable +``` + +This example demonstrates querying the current LAPS password for the 'lapsClient' computer in the +current domain. The password was stored in Active Directory in clear-text form and did not require +decryption. The password was returned wrapped in a SecureString object. + +### Example 2 + +```powershell +PS C:\> Get-LapsADPassword -Identity lapsClient -DomainController lapsDC -AsPlainText + +ComputerName : LAPSCLIENT +DistinguishedName : CN=LAPSCLIENT,OU=LapsTestOU,DC=laps,DC=com +Account : Administrator +Password : k8P]Xl5T-ky!aj4s21el3S#.x44!e{8+,{L!M +PasswordUpdateTime : 4/9/2023 10:03:41 AM +ExpirationTimestamp : 4/14/2023 10:03:41 AM +Source : CleartextPassword +DecryptionStatus : NotApplicable +AuthorizedDecryptor : NotApplicable +``` + +This example demonstrates querying the current LAPS password on a specific domain controller +('lapsDC'), for the 'lapsClient' computer, requesting that the password be displayed in clear-text +form. The password was stored in Active Directory in clear-text form and did not require decryption. +The password was returned in clear-text form. + +### Example 3 + +```powershell +PS C:\> Get-LapsADPassword -Identity $lapsClient2 -Domain laps.com -AsPlainText -IncludeHistory + +ComputerName : LAPSCLIENT2 +DistinguishedName : CN=LAPSCLIENT2,OU=LapsTestEncryptedOU,DC=laps,DC=com +Account : Administrator +Password : q64!7KI3BOe/&S%buM0nBaW{B]261zN5L0{;{ +PasswordUpdateTime : 4/9/2023 9:39:38 AM +ExpirationTimestamp : 4/14/2023 9:39:38 AM +Source : EncryptedPassword +DecryptionStatus : Success +AuthorizedDecryptor : LAPS\LAPS Admins + +ComputerName : LAPSCLIENT2 +DistinguishedName : CN=LAPSCLIENT2,OU=LapsTestEncryptedOU,DC=laps,DC=com +Account : Administrator +Password : O{P61q6bu(3kZ6&#p2y.&F$cWd;0dm8!]Wl5j +PasswordUpdateTime : 4/9/2023 9:38:10 AM +ExpirationTimestamp : +Source : EncryptedPasswordHistory +DecryptionStatus : Success +AuthorizedDecryptor : LAPS\LAPS Admins +``` + +This example demonstrates querying the current LAPS password for the 'lapsClient2' computer, in a +specific Active Directory domain ('laps.com'), requesting that the password be displayed in +clear-text form. The password was stored in Active Directory in encrypted form and was successfully +decrypted. + +Note that ExpirationTimestamp will always be empty for any older LAPS passwords returned. + +### Example 4 + +```powershell +PS C:\> Get-LapsADPassword -Identity lapsDC.laps.com -AsPlainText + +ComputerName : LAPSDC +DistinguishedName : CN=LAPSDC,OU=Domain Controllers,DC=laps,DC=com +Account : Administrator +Password : 118y$rsw.3y58yG]on$Hii +PasswordUpdateTime : 4/9/2023 10:17:51 AM +ExpirationTimestamp : 4/19/2023 10:17:51 AM +Source : EncryptedDSRMPassword +DecryptionStatus : Success +AuthorizedDecryptor : LAPS\Domain Admins +``` + +This example demonstrates querying the current LAPS password for the 'lapsDC.laps.com' domain +controller, requesting that the password be displayed in clear-text form. The password was stored in +Active Directory in encrypted form and was successfully decrypted. + +### Example 5 + +```powershell +PS C:\> Get-LapsADPassword lapsClient2 + +ComputerName : LAPSDC +DistinguishedName : CN=LAPSDC,OU=Domain Controllers,DC=laps,DC=com +Account : +Password : +PasswordUpdateTime : 4/9/2023 10:17:51 AM +ExpirationTimestamp : 4/19/2023 10:17:51 AM +Source : EncryptedDSRMPassword +DecryptionStatus : Unauthorized +AuthorizedDecryptor : LAPS\Domain Admins +``` + +This example demonstrates querying the current LAPS password for the 'lapsDC' domain controller when +the user does not have permissions to decrypt the LAPS DSRM password. + +### Example 6 + +```powershell +PS C:\> Get-LapsADPassword lapsLegacyClient -AsPlainText + +ComputerName : LAPSLEGACYCLIENT +DistinguishedName : CN=LAPSLEGACYCLIENT,OU=LegacyLapsOU,DC=laps,DC=com +Account : +Password : Z#x}&7BluHf3{r+C218 +PasswordUpdateTime : +ExpirationTimestamp : 5/14/2023 1:55:39 PM +Source : LegacyLapsCleartextPassword +DecryptionStatus : NotApplicable +AuthorizedDecryptor : NotApplicable +``` + +This example demonstrates querying the current LAPS password for the 'lapsLegacyClient' machine +which is currently running in legacy LAPS emulation mode. Note that when querying legacy LAPS-style +passwords, the Account and PasswordUpdateTime fields will always be unavailable. + +### Example 7 + +```powershell +PS C:\> Get-LapsADPassword -Identity lapsClient -Port 50000 -AsPlainText + +ComputerName : LAPSCLIENT +DistinguishedName : CN=LAPSCLIENT,OU=LapsTestOU,DC=laps,DC=com +Account : Administrator +Password : H6UycL[vj#zzTNVpS//G2{j&t9aO}k[K5l4)X +PasswordUpdateTime : 4/15/2023 6:51:45 AM +ExpirationTimestamp : 4/20/2023 6:51:45 AM +Source : CleartextPassword +DecryptionStatus : NotApplicable +AuthorizedDecryptor : NotApplicable +``` + +This example demonstrates querying an Active Directory Snapshot browser instance for the current +LAPS password for the 'LAPSCLIENT' machine. This example assumes that that the snapshot browser has +been previously started on the local machine listening on an LDAP port of 50000. + +## PARAMETERS + +### -AsPlainText + +Specify this parameter to return the LAPS passwords in clear-text format. The default behavior is to +return the LAPS passwords wrapped in a .NET SecureString object. + +> [!IMPORTANT] Using this parameter exposes the returned clear-text password to casual viewing and +> may pose a security risk. This parameter should be used with caution and only in support or +> testing situations. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Credential + +Specifies a set of credentials to use when querying Active Directory for the LAPS credentials. If +not specified the current user's credentials will be used. + +```yaml +Type: System.Management.Automation.PSCredential +Parameter Sets: NormalMode, DomainMode, DomainControllerMode, SnapshotBrowserMode +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DecryptionCredential + +Specifies a set of credentials to use when decrypting encrypted LAPS credentials. If not specified +the current user's credentials will be used. + +```yaml +Type: System.Management.Automation.PSCredential +Parameter Sets: NormalMode, DomainMode, DomainControllerMode, SnapshotBrowserMode +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Domain + +Specifies which Active Directory domain to connect to. + +```yaml +Type: System.String +Parameter Sets: DomainMode +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController + +Specifies which Active Directory domain controller to connect to, or the remote server on which an +Active Directory snapshot browser is running. + +```yaml +Type: System.String +Parameter Sets: DomainControllerMode +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: SnapshotBrowserMode +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +Specifies which Active Directory computer or domain controller object to retrieve LAPS credentials +from. + +This parameter accepts several different name formats which influence the criteria used when +searching Active Directory for the target device. The supported name formats are as follows: + +distinguishedName (begins with a "CN=") +samAccountName (begins with a '$") +dnsHostName (contains at least one '.' character) +name (for all other inputs) + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -IncludeHistory + +Specifies that any older LAPS credentials on the computer object should also be displayed. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Port + +Specifies which Active Directory Snapshot Browser port to connect to. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: SnapshotBrowserMode, SnapshotBrowserRecoveryMode +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecoveryMode + +This parameter provides a last-ditch option when it is no longer possible to decrypt a given LAPS +credential via the normal mechanisms. For example, this might be necessary if a LAPS credential was +encrypted against a group which has since been deleted. + +>[!IMPORTANT] +>When specifying this parameter, you MUST be logged-in locally as a Domain Administrator on a writable domain controller. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: RecoveryMode, SnapshotBrowserRecoveryMode +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, +-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, +-WarningAction, and -WarningVariable. For more information, see +[about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String[] + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Windows LAPS Overview](https://go.microsoft.com/fwlink/?linkid=2233901) +[Get started with Windows LAPS and Windows Server Active Directory](https://go.microsoft.com/fwlink/?linkid=2233705) diff --git a/docset/winserver2022-ps/laps/Get-LapsDiagnostics.md b/docset/winserver2022-ps/laps/Get-LapsDiagnostics.md new file mode 100644 index 0000000000..33a61a6bd7 --- /dev/null +++ b/docset/winserver2022-ps/laps/Get-LapsDiagnostics.md @@ -0,0 +1,155 @@ +--- +description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. +external help file: LAPS-help.xml +Module Name: LAPS +online version: https://learn.microsoft.com/powershell/module/laps/get-lapsdiagnostics?view=windowsserver2022-ps&wt.mc_id=ps-gethelp +schema: 2.0.0 +Locale: en-US +ms.date: 04/10/2023 +title: Get-LapsDiagnostics +--- + +# Get-LapsDiagnostics + +## SYNOPSIS + +Collects Windows Local Administrator Password Solution (LAPS) logs and tracing from the local +machine. + +## SYNTAX + +```powershell +Get-LapsDiagnostics [[-OutputFolder] ] [-CollectNetworkTrace] [-ResetPassword] [] +``` + +## DESCRIPTION + +The **Get-LapsDiagnostics** cmdlet collects LAPS logs and tracing from the local machine, and copies +them into a .zip file. This cmdlet is primarily intended for support and testing scenarios but of +course may be used at any time. The name of the resultant .zip file includes the machine name and +current timestamp, and by default is written under the %TEMP%\LapsDiagnostics folder. The output +folder may be customized using the -OutputFolder parameter. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> Get-LapsDiagnostics +Get-LapsDiagnostics: all data for this run was written to the following zip file: + +C:\Users\ADMINI~1\AppData\Local\Temp\LapsDiagnostics\LapsDiagnostics_LAPSCLIENT_2023041004_072649.zip +``` + +This example demonstrates basic collection of LAPS diagnostic info using all default parameters. + +### Example 2 + +```powershell +PS C:\> Get-LapsDiagnostics -OutputFolder c:\LapsDiagFolder +Get-LapsDiagnostics: all data for this run was written to the following zip file: + +c:\LapsDiagFolder\LapsDiagnostics_LAPSCLIENT_2023041004_072702.zip +``` + +This example demonstrates basic collection of LAPS diagnostic info to a specific output folder. + +### Example 3 + +```powershell +PS C:\> Get-LapsDiagnostics -OutputFolder c:\LapsDiagFolder -ResetPassword +Get-LapsDiagnostics: all data for this run was written to the following zip file: + +c:\LapsDiagFolder\LapsDiagnostics_LAPSCLIENT_2023041004_072709.zip +``` + +This example demonstrates basic collection of LAPS diagnostic info across a forced password reset +operation to a specific output folder. + +### Example 4 + +```powershell +PS C:\> Get-LapsDiagnostics -CollectNetworkTrace +Get-LapsDiagnostics: all data for this run was written to the following zip file: + +C:\Users\ADMINI~1\AppData\Local\Temp\LapsDiagnostics\LapsDiagnostics_LAPSCLIENT_2023041004_072719.zip +``` + +This example demonstrates basic collection of LAPS diagnostic info while also collecting network +tracing. + +## PARAMETERS + +### -CollectNetworkTrace + +Specifies that network tracing should also be collected and included in the resultant .zip file. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OutputFolder + +Specifies that the resultant .zip file should be placed under the specified folder. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResetPassword + +Specifies that logs and tracing should be collected across a forced password reset for the currently +managed local account. In this mode the cmdlet collects tracing across a call to the +**Reset-LapsPassword** cmdlet. + +If this parameter is not specified, the cmdlet collects tracing across a call to the +**Invoke-LapsProcessingCycle** cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, +-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, +-WarningAction, and -WarningVariable. For more information, see +[about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Windows LAPS Overview](https://go.microsoft.com/fwlink/?linkid=2233901) diff --git a/docset/winserver2022-ps/laps/Invoke-LapsPolicyProcessing.md b/docset/winserver2022-ps/laps/Invoke-LapsPolicyProcessing.md new file mode 100644 index 0000000000..5f6b3b63cd --- /dev/null +++ b/docset/winserver2022-ps/laps/Invoke-LapsPolicyProcessing.md @@ -0,0 +1,65 @@ +--- +description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. +external help file: lapspsh.dll-Help.xml +Module Name: LAPS +online version: https://learn.microsoft.com/powershell/module/laps/invoke-lapspolicyprocessing?view=windowsserver2022-ps&wt.mc_id=ps-gethelp +schema: 2.0.0 +Locale: en-US +ms.date: 04/10/2023 +title: Invoke-LapsPolicyProcessing +--- + +# Invoke-LapsPolicyProcessing + +## SYNOPSIS + +Causes Windows Local Administrator Password Solution (LAPS) to process the currently configured LAPS policy. + +## SYNTAX + +```powershell +Invoke-LapsPolicyProcessing [] +``` + +## DESCRIPTION + +The **Invoke-LapsPolicyProcessing** cmdlet tells Windows Local Administrator Password Solution +(LAPS) to process the currently configured LAPS policy. + +The cmdlet does not return detailed information about the results of the operation. See +[Use Windows LAPS event logs](https://go.microsoft.com/fwlink/?linkid=2234103) for more +information on querying the resultant event log entries to get specific information on the outcome +of the operation. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> Invoke-LapsPolicyProcessing +``` + +This example shows how to run the Invoke-LapsPolicyProcessing cmdlet. + +## PARAMETERS + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, +-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, +-WarningAction, and -WarningVariable. For more information, see +[about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Windows LAPS Overview](https://go.microsoft.com/fwlink/?linkid=2233901) diff --git a/docset/winserver2022-ps/laps/LAPS.md b/docset/winserver2022-ps/laps/LAPS.md new file mode 100644 index 0000000000..72c2a65358 --- /dev/null +++ b/docset/winserver2022-ps/laps/LAPS.md @@ -0,0 +1,79 @@ +--- +description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. +Module Name: LAPS +Module Guid: 8eb7ddf9-7890-49ae-9af1-3b41d7e63c41 +Download Help Link: https://aka.ms/winsvr-2022-pshelp +Help Version: 1.0.0.0 +Locale: en-US +ms.date: 04/10/2023 +title: LAPS +--- + +# LAPS Module + +## Description + +This reference provides cmdlet descriptions and syntax for all Windows Local Administrator Password +Solution (LAPS)-specific cmdlets. It lists the cmdlets in alphabetical order. + +## LAPS Cmdlets + +### [Find-LapsADExtendedRights](Find-LapsADExtendedRights.md) + +Queries Active Directory to find principals that have been granted permission to read Windows Local +Administrator Password Solution (LAPS) password attributes. + +### [Get-LapsAADPassword](Get-LapsAADPassword.md) + +Queries Azure Active Directory for the Windows Local Administrator Password Solution (LAPS) +credentials on a specified Azure AD device. + +### [Get-LapsADPassword](Get-LapsADPassword.md) + +Queries Windows Local Administrator Password Solution (LAPS) credentials from Active Directory on a +specified AD computer or domain controller object. + +### [Get-LapsDiagnostics](Get-LapsDiagnostics.md) + +Collects Windows Local Administrator Password Solution (LAPS) logs and tracing from the local +machine. + +### [Invoke-LapsPolicyProcessing](Invoke-LapsPolicyProcessing.md) + +Causes Windows Local Administrator Password Solution (LAPS) to process the currently configured LAPS +policy. + +### [Reset-LapsPassword](Reset-LapsPassword.md) + +Causes Windows Local Administrator Password Solution (LAPS) to immediately rotate the password for +the currently managed local account. + +### [Set-LapsADAuditing](Set-LapsADAuditing.md) + +Configures an Active Directory Organizational Unit to enable auditing on the Windows Local +Administrator Password Solution (LAPS) password schema attributes. + +### [Set-LapsADComputerSelfPermission](Set-LapsADComputerSelfPermission.md) + +Configures permissions on an Active Directory Organizational Unit to enable computers in that OU to +update their LAPS passwords. + +### [Set-LapsADPasswordExpirationTime](Set-LapsADPasswordExpirationTime.md) + +Sets the Windows Local Administrator Password Solution (LAPS) password expiration timestamp on an +Active Directory computer or domain controller object. + +### [Set-LapsADReadPasswordPermission](Set-LapsADReadPasswordPermission.md) + +Configures security on an Active Directory Organizational Unit to grant specific users or groups +permission to query Windows Local Administrator Password Solution (LAPS) passwords. + +### [Set-LapsADResetPasswordPermission](Set-LapsADResetPasswordPermission.md) + +Configures security on an Active Directory Organizational Unit to grant specific users or groups +permission to set the Windows Local Administrator Password Solution (LAPS) password expiration time. + +### [Update-LapsADSchema](Update-LapsADSchema.md) + +Extends the Active Directory schema with the Windows Local Administrator Password Solution (LAPS) +schema attributes. diff --git a/docset/winserver2022-ps/laps/Reset-LapsPassword.md b/docset/winserver2022-ps/laps/Reset-LapsPassword.md new file mode 100644 index 0000000000..d19eabfe38 --- /dev/null +++ b/docset/winserver2022-ps/laps/Reset-LapsPassword.md @@ -0,0 +1,73 @@ +--- +description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. +external help file: lapspsh.dll-Help.xml +Module Name: LAPS +online version: https://learn.microsoft.com/powershell/module/laps/reset-lapspassword?view=windowsserver2022-ps&wt.mc_id=ps-gethelp +schema: 2.0.0 +Locale: en-US +ms.date: 04/10/2023 +title: Reset-LapsPassword +--- + +# Reset-LapsPassword + +## SYNOPSIS + +Causes Windows Local Administrator Password Solution (LAPS) to immediately rotate the password for +the currently managed local account. + +## SYNTAX + +```powershell +Reset-LapsPassword [] +``` + +## DESCRIPTION + +The **Reset-LapsPassword** cmdlet tells Windows Local Administrator Password Solution (LAPS) to +immediately rotate the password for the currently managed local account. This operation is performed +regardless of the state of the current password, for example it does not matter whether the current +password is considered expired or not. + +> [!IMPORTANT] +> This cmdlet is intended and recommended only for rare situations that require an +> immediate password rotation, for example as a response to a machine security breach situation. +> Excessively frequent usage of this cmdlet is not recommended. + +The cmdlet does not return detailed information about the results of the operation. See +[Use Windows LAPS event logs](https://go.microsoft.com/fwlink/?linkid=2234103) for more +information on querying the resultant event log entries to get specific information on the outcome +of the operation. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> Reset-LapsPassword +``` + +This example shows how to run the Reset-LapsPassword cmdlet. + +## PARAMETERS + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, +-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, +-WarningAction, and -WarningVariable. For more information, see +[about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Windows LAPS Overview](https://go.microsoft.com/fwlink/?linkid=2233901) diff --git a/docset/winserver2022-ps/laps/Set-LapsADAuditing.md b/docset/winserver2022-ps/laps/Set-LapsADAuditing.md new file mode 100644 index 0000000000..3f8be8d695 --- /dev/null +++ b/docset/winserver2022-ps/laps/Set-LapsADAuditing.md @@ -0,0 +1,209 @@ +--- +description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. +external help file: lapspsh.dll-Help.xml +Module Name: LAPS +online version: https://learn.microsoft.com/powershell/module/laps/set-lapsadauditing?view=windowsserver2022-ps&wt.mc_id=ps-gethelp +schema: 2.0.0 +Locale: en-US +ms.date: 04/10/2023 +title: Set-LapsADAuditing +--- + +# Set-LapsADAuditing + +## SYNOPSIS + +Configures an Active Directory Organizational Unit to enable auditing on the Windows Local +Administrator Password Solution (LAPS) password schema attributes. + +## SYNTAX + +``` +Set-LapsADAuditing [-Credential ] -Identity -AuditedPrincipals + [-AuditType ] [-Domain ] [-DomainController ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> Set-LapsADAuditing -Identity LapsTestOU -AuditedPrincipals "laps.com\LapsAdmin" -AuditType Success +OU=LapsTestOU,DC=laps,DC=com +``` + +This example demonstrates configuring Success audits on an OU. + +### Example 2 + +```powershell +PS C:\> Set-LapsADAuditing -Identity LapsTestOU -AuditedPrincipals "laps.com\LapsAdminsGroup" -AuditType Failure +OU=LapsTestOU,DC=laps,DC=com +``` + +This example demonstrates configuring Failure audits on an OU. + +## PARAMETERS + +### -AuditedPrincipals + +Specifies which users or groups should be configured for auditing. Users or groups may be specified +in either name or SID format. If specified in name format, the name must always include the +identifying domain name portion unless the name maps to a well-known or built-in account. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AuditType + +Specifies whether to configure Success or Failure auditing. + +```yaml +Type: System.Security.AccessControl.AuditFlags +Parameter Sets: (All) +Aliases: +Accepted values: None, Success, Failure + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Credential + +Specifies the credentials to use when updating Active Directory. If not specified the current user's +credentials will be used. + +```yaml +Type: System.Management.Automation.PSCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Domain + +Specifies which Active Directory domain to connect to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController + +Specifies which Active Directory domain controller to connect to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +Specifies which Active Directory Organizational Unit to update. + +This parameter accepts several different name formats which influence the criteria used in the +resultant Active Directory search. The supported name formats are as follows: + +distinguishedName (begins with a "CN=") +name (for all other inputs) + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, +-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, +-WarningAction, and -WarningVariable. For more information, see +[about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String[] + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Windows LAPS Overview](https://go.microsoft.com/fwlink/?linkid=2233901) diff --git a/docset/winserver2022-ps/laps/Set-LapsADComputerSelfPermission.md b/docset/winserver2022-ps/laps/Set-LapsADComputerSelfPermission.md new file mode 100644 index 0000000000..c02f744b10 --- /dev/null +++ b/docset/winserver2022-ps/laps/Set-LapsADComputerSelfPermission.md @@ -0,0 +1,171 @@ +--- +description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. +external help file: lapspsh.dll-Help.xml +Module Name: LAPS +online version: https://learn.microsoft.com/powershell/module/laps/set-lapsadcomputerselfpermission?view=windowsserver2022-ps&wt.mc_id=ps-gethelp +schema: 2.0.0 +Locale: en-US +ms.date: 04/10/2023 +title: Set-LapsADComputerSelfPermission +--- + +# Set-LapsADComputerSelfPermission + +## SYNOPSIS + +Configures permissions on an Active Directory Organizational Unit to enable computers in that OU to +update their Windows Local Administrator Password Solution (LAPS) passwords. + +## SYNTAX + +``` +Set-LapsADComputerSelfPermission -Identity [-Domain ] [-DomainController ] + [-Credential ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION + +The **Set-LapsADComputerSelfPermission** cmdlet is used by administrators to configure security +permissions on an Active Directory Organizational Unit (OU) to allow computers in that OU to update +their LAPS passwords. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> Set-LapsADComputerSelfPermission -Identity LapsTestOU + +Name DistinguishedName +---- ----------------- +LapsTestOU OU=LapsTestOU,DC=laps,DC=com +``` + +This example demonstrates how to run the cmdlet. + +## PARAMETERS + +### -Credential + +Specifies the credentials to use when updating Active Directory. If not specified the current user's +credentials will be used. + +```yaml +Type: System.Management.Automation.PSCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Domain + +Specifies which Active Directory domain to connect to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController + +Specifies which Active Directory domain controller to connect to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +Specifies which Active Directory Organizational Unit to update. + +This parameter accepts several different name formats which influence the criteria used in the +resultant Active Directory search. The supported name formats are as follows: + +distinguishedName (begins with a "CN=") +name (for all other inputs) + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, +-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, +-WarningAction, and -WarningVariable. For more information, see +[about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String[] + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Windows LAPS Overview](https://go.microsoft.com/fwlink/?linkid=2233901) diff --git a/docset/winserver2022-ps/laps/Set-LapsADPasswordExpirationTime.md b/docset/winserver2022-ps/laps/Set-LapsADPasswordExpirationTime.md new file mode 100644 index 0000000000..8e128b22d0 --- /dev/null +++ b/docset/winserver2022-ps/laps/Set-LapsADPasswordExpirationTime.md @@ -0,0 +1,187 @@ +--- +description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. +external help file: lapspsh.dll-Help.xml +Module Name: LAPS +online version: https://learn.microsoft.com/powershell/module/laps/set-lapsadpasswordexpirationtime?view=windowsserver2022-ps&wt.mc_id=ps-gethelp +schema: 2.0.0 +Locale: en-US +ms.date: 04/10/2023 +title: Set-LapsADPasswordExpirationTime +--- + +# Set-LapsADPasswordExpirationTime + +## SYNOPSIS + +Sets the Windows Local Administrator Password Solution (LAPS) password expiration timestamp on an +Active Directory computer or domain controller object. + +## SYNTAX + +```powershell +Set-LapsADPasswordExpirationTime [-Credential ] -Identity [-WhenEffective ] + [-Domain ] [-DomainController ] [] +``` + +## DESCRIPTION + +The **Set-LapsADPasswordExpirationTime** cmdlet is used by administrators to configure the LAPS +password expiration time on an Active Directory computer or domain controller object. + +> [!TIP] +> Running this cmdlet sets the LAPS password expiration time on the Active Directory computer or +> domain controller object, but the new expiration time will not be honored until the next time the +> target device executes a LAPS policy processing cycle. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> Set-LapsADPasswordExpirationTime -Identity lapsClient + +DistinguishedName Status +----------------- ------ +CN=LAPSCLIENT,OU=LapsTestOU,DC=laps,DC=com PasswordReset +``` + +This examples show setting the LAPS password expiration time to the current time (or in other words, +expiring the password immediately). + +### Example 2 + +```powershell +PS C:\> Set-LapsADPasswordExpirationTime -Identity lapsFe -WhenEffective (Get-Date -Date "07/04/2023 13:00:00") + +DistinguishedName Status +----------------- ------ +CN=LAPSCLIENT,OU=LapsTestOU,DC=laps,DC=com PasswordReset +``` + +This examples show setting the LAPS password expiration time to a specific date. + +### Example 3 + +```powershell +PS C:\> Set-LapsADPasswordExpirationTime -Identity lapsFe -WhenEffective (DateTime::Now.AddDays(1)) + +DistinguishedName Status +----------------- ------ +CN=LAPSCLIENT,OU=LapsTestOU,DC=laps,DC=com PasswordReset +``` + +This examples show setting the LAPS password expiration time to one day in the future. + +## PARAMETERS + +### -Credential + +Specifies the credentials to use when updating Active Directory. If not specified the current user's +credentials will be used. + +```yaml +Type: System.Management.Automation.PSCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Domain + +Specifies which Active Directory domain to connect to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController + +Specifies which Active Directory domain controller to connect to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +Specifies which Active Directory computer or domain controller object to set the LAPS password +expiration time on. + +This parameter accepts several different name formats which influence the criteria used when +searching Active Directory for the target device. The supported name formats are as follows: + +distinguishedName (begins with a "CN=") +samAccountName (begins with a '$") +dnsHostName (contains at least one '.' character) +name (for all other inputs) + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -WhenEffective + +Specifies the new LAPS password expiration time. If not specified the current time will be used, in +other words the password is immediately expired. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, +-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, +-WarningAction, and -WarningVariable. For more information, see +[about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String[] + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Windows LAPS Overview](https://go.microsoft.com/fwlink/?linkid=2233901) diff --git a/docset/winserver2022-ps/laps/Set-LapsADReadPasswordPermission.md b/docset/winserver2022-ps/laps/Set-LapsADReadPasswordPermission.md new file mode 100644 index 0000000000..faddd76397 --- /dev/null +++ b/docset/winserver2022-ps/laps/Set-LapsADReadPasswordPermission.md @@ -0,0 +1,234 @@ +--- +description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. +external help file: lapspsh.dll-Help.xml +Module Name: LAPS +online version: https://learn.microsoft.com/powershell/module/laps/set-lapsadreadpasswordpermission?view=windowsserver2022-ps&wt.mc_id=ps-gethelp +schema: 2.0.0 +Locale: en-US +ms.date: 04/10/2023 +title: Set-LapsADReadPasswordPermission +--- + +# Set-LapsADReadPasswordPermission + +## SYNOPSIS + +Configures security on an Active Directory Organizational Unit to grant specific users or groups +permission to query Windows Local Administrator Password Solution (LAPS) passwords. + +## SYNTAX + +```powershell +Set-LapsADReadPasswordPermission [-Credential ] -Identity + -AllowedPrincipals [-Domain ] [-DomainController ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION + +The **Set-LapsADReadPasswordPermission** cmdlet is used by administrators to configure security +permissions on an Active Directory Organizational Unit (OU) to allow specific users or groups to +query LAPS passwords on computers in that OU. Users and groups must be fully qualified with both +domain and user name components; the only exception to this is when the specified name resolves to a +built-in principal (for example "Domain Admins"). + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> Set-LapsADReadPasswordPermission -Identity LapsTestOU -AllowedPrincipals "Domain Admins" + +Name DistinguishedName +---- ----------------- +LapsTestOU OU=LapsTestOU,DC=laps,DC=com +``` + +This example shows how to run the cmdlet with an isolated name that successfully maps to a +well-known user or group. + +### Example 2 + +```powershell +PS C:\> Set-LapsADReadPasswordPermission -Identity LapsTestOU -AllowedPrincipals @("S-1-5-21-2889755270-1324585639-743026605-1215") + +Name DistinguishedName +---- ----------------- +LapsTestOU OU=LapsTestOU,DC=laps,DC=com +``` + +This example shows how to run the cmdlet specifying a user SID as input. + +### Example 3 + +```powershell +PS C:\> Set-LapsADReadPasswordPermission -Identity 'OU=LapsTestOU,DC=laps,DC=com' -AllowedPrincipals @("laps.com\LapsAdmin1", "LapsAdmin2@laps.com") + +Name DistinguishedName +---- ----------------- +LapsTestOU OU=LapsTestOU,DC=laps,DC=com +``` + +This example shows how to run the cmdlet specifying two fully qualified user names (in different +formats) as input. + +### Example 4 + +```powershell +PS C:\> Set-LapsADReadPasswordPermission -Identity LapsTestOU -AllowedPrincipals @("LapsAdministratorsGroup") +Set-LapsADReadPasswordPermission : The 'LapsAdministratorsGroup' account appears to be an isolated name but is not a well-known name. Please use a +fully qualified name instead, such as "LAPSAdmins@contoso.com" or "contoso\LAPSAdmins" +At line:1 char:1 ++ Set-LapsADReadPasswordPermission -Identity LapsTestOU -AllowedPrincip ... ++ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + + CategoryInfo : InvalidArgument: (:) [Set-LapsADReadPasswordPermission], LapsPowershellException + + FullyQualifiedErrorId : Invalid principal specified,Microsoft.Windows.LAPS.SetLapsADReadPasswordPermission +``` + +This example shows a failure caused by specifying an isolated name that did not resolve to a +well-known or built-in account. The fix for this error would be to add a domain name qualifier to +the input name, for example "LapsAdministratorsGroup@laps.com". + +## PARAMETERS + +### -AllowedPrincipals + +Specifies which users or groups should be granted the permissions. Users or groups may be specified +in either name or SID format. If specified in name format, the name must always include the +identifying domain name portion unless the name maps to a well-known or built-in account. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Credential + +Specifies the credentials to use when updating Active Directory. If not specified the current user's +credentials will be used. + +```yaml +Type: System.Management.Automation.PSCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Domain + +Specifies which Active Directory domain to connect to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController + +Specifies which Active Directory domain controller to connect to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +Specifies which Active Directory Organizational Unit to update. + +This parameter accepts several different name formats which influence the criteria used in the +resultant Active Directory search. The supported name formats are as follows: + +distinguishedName (begins with a "CN=") +name (for all other inputs) + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, +-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, +-WarningAction, and -WarningVariable. For more information, see +[about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String[] + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Windows LAPS Overview](https://go.microsoft.com/fwlink/?linkid=2233901) diff --git a/docset/winserver2022-ps/laps/Set-LapsADResetPasswordPermission.md b/docset/winserver2022-ps/laps/Set-LapsADResetPasswordPermission.md new file mode 100644 index 0000000000..87eaa3c4b0 --- /dev/null +++ b/docset/winserver2022-ps/laps/Set-LapsADResetPasswordPermission.md @@ -0,0 +1,234 @@ +--- +description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. +external help file: lapspsh.dll-Help.xml +Module Name: LAPS +online version: https://learn.microsoft.com/powershell/module/laps/set-lapsadresetpasswordpermission?view=windowsserver2022-ps&wt.mc_id=ps-gethelp +schema: 2.0.0 +Locale: en-US +ms.date: 04/10/2023 +title: Set-LapsADResetPasswordPermission +--- + +# Set-LapsADResetPasswordPermission + +## SYNOPSIS + +Configures security on an Active Directory Organizational Unit to grant specific users or groups +permission to set the Windows Local Administrator Password Solution (LAPS) password expiration time. + +## SYNTAX + +```powershell +Set-LapsADResetPasswordPermission [-Credential ] -Identity + -AllowedPrincipals [-Domain ] [-DomainController ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION + +The **Set-LapsADResetPasswordPermission** cmdlet is used by administrators to configure security +permissions on an Active Directory Organizational Unit (OU) to allow specific users or groups to +reset the LAPS password expiration time on computers in that OU. Users and groups must be fully +qualified with both domain and user name components; the only exception to this is when the +specified name resolves to a built-in principal (for example "Domain Admins"). + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> Set-LapsADResetPasswordPermission -Identity LapsTestOU -AllowedPrincipals "Domain Admins" + +Name DistinguishedName +---- ----------------- +LapsTestOU OU=LapsTestOU,DC=laps,DC=com +``` + +This example shows how to run the cmdlet with an isolated name that successfully maps to a +well-known user or group. + +### Example 2 + +```powershell +PS C:\> Set-LapsADResetPasswordPermission -Identity LapsTestOU -AllowedPrincipals @("S-1-5-21-2889755270-1324585639-743026605-1215") + +Name DistinguishedName +---- ----------------- +LapsTestOU OU=LapsTestOU,DC=laps,DC=com +``` + +This example shows how to run the cmdlet specifying a user SID as input. + +### Example 3 + +```powershell +PS C:\> Set-LapsADResetPasswordPermission -Identity 'OU=LapsTestOU,DC=laps,DC=com' -AllowedPrincipals @("laps.com\LapsAdmin1", "LapsAdmin2@laps.com") + +Name DistinguishedName +---- ----------------- +LapsTestOU OU=LapsTestOU,DC=laps,DC=com +``` + +This example shows how to run the cmdlet specifying two fully qualified user names (in different +formats) as input. + +### Example 4 + +```powershell +PS C:\> Set-LapsADResetPasswordPermission -Identity LapsTestOU -AllowedPrincipals @("LapsAdministratorsGroup") +Set-LapsADReadPasswordPermission : The 'LapsAdministratorsGroup' account appears to be an isolated name but is not a well-known name. Please use a +fully qualified name instead, such as "LapsAdministratorsGroup@contoso.com" or "contoso\LapsAdministratorsGroup" +At line:1 char:1 ++ Set-LapsADReadPasswordPermission -Identity LapsTestOU -AllowedPrincip ... ++ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + + CategoryInfo : InvalidArgument: (:) [Set-LapsADReadPasswordPermission], LapsPowershellException + + FullyQualifiedErrorId : Invalid principal specified,Microsoft.Windows.LAPS.SetLapsADReadPasswordPermission +``` + +This example shows a failure caused by specifying an isolated name that did not resolve to a +well-known or built-in account. The fix for this error would be to add a domain name qualifier to +the input name, for example "LapsAdministratorsGroup@laps.com". + +## PARAMETERS + +### -AllowedPrincipals + +Specifies which users or groups should be granted the permissions. Users or groups may be specified +in either name or SID format. If specified in name format, the name must always include the +identifying domain name portion unless the name maps to a well-known or built-in account. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Credential + +Specifies the credentials to use when updating Active Directory. If not specified the current user's +credentials will be used. + +```yaml +Type: System.Management.Automation.PSCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Domain + +Specifies which Active Directory domain to connect to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController + +Specifies which Active Directory domain controller to connect to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +Specifies which Active Directory Organizational Unit to update. + +This parameter accepts several different name formats which influence the criteria used in the +resultant Active Directory search. The supported name formats are as follows: + +distinguishedName (begins with a "CN=") +name (for all other inputs) + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, +-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, +-WarningAction, and -WarningVariable. For more information, see +[about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String[] + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Windows LAPS Overview](https://go.microsoft.com/fwlink/?linkid=2233901) diff --git a/docset/winserver2022-ps/laps/Update-LapsADSchema.md b/docset/winserver2022-ps/laps/Update-LapsADSchema.md new file mode 100644 index 0000000000..5952d03ef7 --- /dev/null +++ b/docset/winserver2022-ps/laps/Update-LapsADSchema.md @@ -0,0 +1,119 @@ +--- +description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. +external help file: lapspsh.dll-Help.xml +Module Name: LAPS +online version: https://learn.microsoft.com/powershell/module/laps/update-lapsadschema?view=windowsserver2022-ps&wt.mc_id=ps-gethelp +schema: 2.0.0 +Locale: en-US +ms.date: 04/10/2023 +title: Update-LapsADSchema +--- + +# Update-LapsADSchema + +## SYNOPSIS + +Extends the Active Directory schema with the Windows Local Administrator Password Solution (LAPS) +schema attributes. + +## SYNTAX + +```powershell +Update-LapsADSchema [-Credential ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION + +The **Update-LapsADSchema** cmdlet extends the Active Directory schema with the Windows Local +Administrator Password Solution (LAPS) schema attributes. The specific nature of the schema +extensions is documented in +[Windows LAPS schema extensions reference](https://go.microsoft.com/fwlink/?linkid=2233804). + +The -Verbose parameter may be used to get additional information about the cmdlet's operation. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> Update-LapsADSchema + +The 'ms-LAPS-Password' schema attribute needs to be added to the AD schema. +Do you want to proceed? +[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): A +``` + +This example shows how to run the Update-LapsADSchema cmdlet. + +## PARAMETERS + +### -Credential + +Specifies a set of credentials to use when extending the schema. If not specified the current user's +credentials will be used. + +```yaml +Type: System.Management.Automation.PSCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, +-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, +-WarningAction, and -WarningVariable. For more information, see +[about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Windows LAPS Overview](https://go.microsoft.com/fwlink/?linkid=2233901) +[Windows LAPS schema extensions reference](https://go.microsoft.com/fwlink/?linkid=2233804) From 3018aaa874e0099963a60160bd2148d4552d02d1 Mon Sep 17 00:00:00 2001 From: Jay Simmons Date: Sat, 15 Apr 2023 09:54:03 -0700 Subject: [PATCH 101/650] Fix !Important block. --- docset/winserver2022-ps/laps/Get-LapsADPassword.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/docset/winserver2022-ps/laps/Get-LapsADPassword.md b/docset/winserver2022-ps/laps/Get-LapsADPassword.md index fd292c92c3..78061a1b7a 100644 --- a/docset/winserver2022-ps/laps/Get-LapsADPassword.md +++ b/docset/winserver2022-ps/laps/Get-LapsADPassword.md @@ -232,9 +232,10 @@ been previously started on the local machine listening on an LDAP port of 50000. Specify this parameter to return the LAPS passwords in clear-text format. The default behavior is to return the LAPS passwords wrapped in a .NET SecureString object. -> [!IMPORTANT] Using this parameter exposes the returned clear-text password to casual viewing and -> may pose a security risk. This parameter should be used with caution and only in support or -> testing situations. +> [!IMPORTANT] +> Using this parameter exposes the returned clear-text password to casual viewing and may pose a +> security risk. This parameter should be used with caution and only in support or testing +> situations. ```yaml Type: System.Management.Automation.SwitchParameter From d920e0e0222ee1795685f42099f4b424b6c6f099 Mon Sep 17 00:00:00 2001 From: Sean Wheeler Date: Sat, 15 Apr 2023 12:36:57 -0500 Subject: [PATCH 102/650] Remove language label from syntax blocks The syntax blocks should not have the PowerShell language label. They BNF-style syntax descriptions not PowerShell code. --- .../laps/Find-LapsADExtendedRights.md | 2 +- .../winserver2022-ps/laps/Get-LapsAADPassword.md | 2 +- .../winserver2022-ps/laps/Get-LapsADPassword.md | 16 ++++++++-------- .../winserver2022-ps/laps/Get-LapsDiagnostics.md | 2 +- .../laps/Invoke-LapsPolicyProcessing.md | 2 +- .../winserver2022-ps/laps/Reset-LapsPassword.md | 2 +- .../laps/Set-LapsADPasswordExpirationTime.md | 2 +- .../laps/Set-LapsADReadPasswordPermission.md | 2 +- .../laps/Set-LapsADResetPasswordPermission.md | 2 +- .../winserver2022-ps/laps/Update-LapsADSchema.md | 2 +- 10 files changed, 17 insertions(+), 17 deletions(-) diff --git a/docset/winserver2022-ps/laps/Find-LapsADExtendedRights.md b/docset/winserver2022-ps/laps/Find-LapsADExtendedRights.md index 691282afe9..0013e71489 100644 --- a/docset/winserver2022-ps/laps/Find-LapsADExtendedRights.md +++ b/docset/winserver2022-ps/laps/Find-LapsADExtendedRights.md @@ -18,7 +18,7 @@ Administrator Password Solution (LAPS) password attributes. ## SYNTAX -```powershell +``` Find-LapsADExtendedRights [-Credential ] -Identity [-Domain ] [-DomainController ] [-IncludeComputers] [] ``` diff --git a/docset/winserver2022-ps/laps/Get-LapsAADPassword.md b/docset/winserver2022-ps/laps/Get-LapsAADPassword.md index 88526d1ff6..b25b3226a1 100644 --- a/docset/winserver2022-ps/laps/Get-LapsAADPassword.md +++ b/docset/winserver2022-ps/laps/Get-LapsAADPassword.md @@ -18,7 +18,7 @@ credentials on a specified Azure AD device. ## SYNTAX -```powershell +```s Get-LapsAADPassword -DeviceIds [-IncludePasswords] [-IncludeHistory] [-AsPlainText] [] ``` diff --git a/docset/winserver2022-ps/laps/Get-LapsADPassword.md b/docset/winserver2022-ps/laps/Get-LapsADPassword.md index 78061a1b7a..050ef83ae0 100644 --- a/docset/winserver2022-ps/laps/Get-LapsADPassword.md +++ b/docset/winserver2022-ps/laps/Get-LapsADPassword.md @@ -20,41 +20,41 @@ specified AD computer or domain controller object. ### NormalMode (Default) -```powershell +``` Get-LapsADPassword [-Credential ] [-DecryptionCredential ] [-IncludeHistory] [-AsPlainText] [-Identity] [] ``` ### DomainMode -```powershell +``` Get-LapsADPassword [-Credential ] [-DecryptionCredential ] [-IncludeHistory] [-AsPlainText] [-Identity] -Domain [] ``` ### DomainControllerMode -```powershell +``` Get-LapsADPassword [-Credential ] [-DecryptionCredential ] [-IncludeHistory] [-AsPlainText] [-Identity] -DomainController [] ``` ### SnapshotBrowserMode -```powershell +``` Get-LapsADPassword [-Credential ] [-DecryptionCredential ] [-IncludeHistory] [-AsPlainText] -Port [-Identity] [-DomainController ] [] ``` ### RecoveryMode -```powershell +``` Get-LapsADPassword [-IncludeHistory] [-AsPlainText] [-RecoveryMode] [-Identity] [] ``` ### SnapshotBrowserRecoveryMode -```powershell +``` Get-LapsADPassword [-IncludeHistory] [-AsPlainText] [-RecoveryMode] -Port [-Identity] [] ``` @@ -141,7 +141,7 @@ AuthorizedDecryptor : LAPS\LAPS Admins This example demonstrates querying the current LAPS password for the 'lapsClient2' computer, in a specific Active Directory domain ('laps.com'), requesting that the password be displayed in -clear-text form. The password was stored in Active Directory in encrypted form and was successfully +clear-text form. The password was stored in Active Directory in encrypted form and was successfully decrypted. Note that ExpirationTimestamp will always be empty for any older LAPS passwords returned. @@ -164,7 +164,7 @@ AuthorizedDecryptor : LAPS\Domain Admins This example demonstrates querying the current LAPS password for the 'lapsDC.laps.com' domain controller, requesting that the password be displayed in clear-text form. The password was stored in -Active Directory in encrypted form and was successfully decrypted. +Active Directory in encrypted form and was successfully decrypted. ### Example 5 diff --git a/docset/winserver2022-ps/laps/Get-LapsDiagnostics.md b/docset/winserver2022-ps/laps/Get-LapsDiagnostics.md index 33a61a6bd7..e8f6848f55 100644 --- a/docset/winserver2022-ps/laps/Get-LapsDiagnostics.md +++ b/docset/winserver2022-ps/laps/Get-LapsDiagnostics.md @@ -18,7 +18,7 @@ machine. ## SYNTAX -```powershell +``` Get-LapsDiagnostics [[-OutputFolder] ] [-CollectNetworkTrace] [-ResetPassword] [] ``` diff --git a/docset/winserver2022-ps/laps/Invoke-LapsPolicyProcessing.md b/docset/winserver2022-ps/laps/Invoke-LapsPolicyProcessing.md index 5f6b3b63cd..07c734ffe8 100644 --- a/docset/winserver2022-ps/laps/Invoke-LapsPolicyProcessing.md +++ b/docset/winserver2022-ps/laps/Invoke-LapsPolicyProcessing.md @@ -17,7 +17,7 @@ Causes Windows Local Administrator Password Solution (LAPS) to process the curre ## SYNTAX -```powershell +``` Invoke-LapsPolicyProcessing [] ``` diff --git a/docset/winserver2022-ps/laps/Reset-LapsPassword.md b/docset/winserver2022-ps/laps/Reset-LapsPassword.md index d19eabfe38..5914604ec8 100644 --- a/docset/winserver2022-ps/laps/Reset-LapsPassword.md +++ b/docset/winserver2022-ps/laps/Reset-LapsPassword.md @@ -18,7 +18,7 @@ the currently managed local account. ## SYNTAX -```powershell +``` Reset-LapsPassword [] ``` diff --git a/docset/winserver2022-ps/laps/Set-LapsADPasswordExpirationTime.md b/docset/winserver2022-ps/laps/Set-LapsADPasswordExpirationTime.md index 8e128b22d0..c1ce99c815 100644 --- a/docset/winserver2022-ps/laps/Set-LapsADPasswordExpirationTime.md +++ b/docset/winserver2022-ps/laps/Set-LapsADPasswordExpirationTime.md @@ -18,7 +18,7 @@ Active Directory computer or domain controller object. ## SYNTAX -```powershell +``` Set-LapsADPasswordExpirationTime [-Credential ] -Identity [-WhenEffective ] [-Domain ] [-DomainController ] [] ``` diff --git a/docset/winserver2022-ps/laps/Set-LapsADReadPasswordPermission.md b/docset/winserver2022-ps/laps/Set-LapsADReadPasswordPermission.md index faddd76397..a98fdf04b1 100644 --- a/docset/winserver2022-ps/laps/Set-LapsADReadPasswordPermission.md +++ b/docset/winserver2022-ps/laps/Set-LapsADReadPasswordPermission.md @@ -18,7 +18,7 @@ permission to query Windows Local Administrator Password Solution (LAPS) passwor ## SYNTAX -```powershell +``` Set-LapsADReadPasswordPermission [-Credential ] -Identity -AllowedPrincipals [-Domain ] [-DomainController ] [-WhatIf] [-Confirm] [] diff --git a/docset/winserver2022-ps/laps/Set-LapsADResetPasswordPermission.md b/docset/winserver2022-ps/laps/Set-LapsADResetPasswordPermission.md index 87eaa3c4b0..93813295e1 100644 --- a/docset/winserver2022-ps/laps/Set-LapsADResetPasswordPermission.md +++ b/docset/winserver2022-ps/laps/Set-LapsADResetPasswordPermission.md @@ -18,7 +18,7 @@ permission to set the Windows Local Administrator Password Solution (LAPS) passw ## SYNTAX -```powershell +``` Set-LapsADResetPasswordPermission [-Credential ] -Identity -AllowedPrincipals [-Domain ] [-DomainController ] [-WhatIf] [-Confirm] [] diff --git a/docset/winserver2022-ps/laps/Update-LapsADSchema.md b/docset/winserver2022-ps/laps/Update-LapsADSchema.md index 5952d03ef7..821c0439b4 100644 --- a/docset/winserver2022-ps/laps/Update-LapsADSchema.md +++ b/docset/winserver2022-ps/laps/Update-LapsADSchema.md @@ -18,7 +18,7 @@ schema attributes. ## SYNTAX -```powershell +``` Update-LapsADSchema [-Credential ] [-WhatIf] [-Confirm] [] ``` From 73d6b1d463f0861f17bee460a1496c3ad0b80164 Mon Sep 17 00:00:00 2001 From: Sean Wheeler Date: Sat, 15 Apr 2023 13:08:41 -0500 Subject: [PATCH 103/650] Formatting and PS Style cleanup - Cmdlet names in backticks - File paths in backticks - Parameter values in backticks - Parameter names in bold - No blank line after SYNOPSIS header - List items must be bulleted or numbered --- .../laps/Find-LapsADExtendedRights.md | 7 ++--- .../laps/Get-LapsAADPassword.md | 17 +++++------ .../laps/Get-LapsADPassword.md | 29 ++++++++++--------- .../laps/Get-LapsDiagnostics.md | 22 +++++++------- .../laps/Invoke-LapsPolicyProcessing.md | 6 ++-- .../laps/Reset-LapsPassword.md | 3 +- .../laps/Set-LapsADAuditing.md | 5 ++-- .../laps/Set-LapsADComputerSelfPermission.md | 12 ++++---- .../laps/Set-LapsADPasswordExpirationTime.md | 7 ++--- .../laps/Set-LapsADReadPasswordPermission.md | 17 +++++------ .../laps/Set-LapsADResetPasswordPermission.md | 7 ++--- .../laps/Update-LapsADSchema.md | 5 ++-- 12 files changed, 65 insertions(+), 72 deletions(-) diff --git a/docset/winserver2022-ps/laps/Find-LapsADExtendedRights.md b/docset/winserver2022-ps/laps/Find-LapsADExtendedRights.md index 0013e71489..eb0bddc7b6 100644 --- a/docset/winserver2022-ps/laps/Find-LapsADExtendedRights.md +++ b/docset/winserver2022-ps/laps/Find-LapsADExtendedRights.md @@ -12,7 +12,6 @@ title: Find-LapsADExtendedRights # Find-LapsADExtendedRights ## SYNOPSIS - Queries Active Directory to find principals that have been granted permission to read Windows Local Administrator Password Solution (LAPS) password attributes. @@ -25,7 +24,7 @@ Find-LapsADExtendedRights [-Credential ] -Identity [-Do ## DESCRIPTION -The **Find-LapsADExtendedRights** cmdlet is used by administrators to query which principals have +The `Find-LapsADExtendedRights` cmdlet is used by administrators to query which principals have been granted permissions to read the LAPS password attributes. ## EXAMPLES @@ -100,8 +99,8 @@ Specifies which Active Directory Organizational Unit to query. This parameter accepts several different name formats which influence the criteria used in the resultant Active Directory search. The supported name formats are as follows: -distinguishedName (begins with a "CN=") -name (for all other inputs) +- distinguishedName (begins with a "CN=") +- name (for all other inputs) ```yaml Type: System.String[] diff --git a/docset/winserver2022-ps/laps/Get-LapsAADPassword.md b/docset/winserver2022-ps/laps/Get-LapsAADPassword.md index b25b3226a1..4da61966aa 100644 --- a/docset/winserver2022-ps/laps/Get-LapsAADPassword.md +++ b/docset/winserver2022-ps/laps/Get-LapsAADPassword.md @@ -12,24 +12,23 @@ title: Get-LapsAADPassword # Get-LapsAADPassword ## SYNOPSIS - Queries Azure Active Directory for the Windows Local Administrator Password Solution (LAPS) credentials on a specified Azure AD device. ## SYNTAX -```s +``` Get-LapsAADPassword -DeviceIds [-IncludePasswords] [-IncludeHistory] [-AsPlainText] [] ``` ## DESCRIPTION -The **Get-LapsAADPassword** cmdlet allows administrators to retrieve LAPS passwords and password +The `Get-LapsAADPassword` cmdlet allows administrators to retrieve LAPS passwords and password history for an Azure Active Directory-joined device. This is implemented by sending queries to Microsoft Graph over the deviceLocalCredentials collection. -The **Get-LapsAADPassword** cmdlet supports two basic modes when querying LAPS passwords: +The `Get-LapsAADPassword` cmdlet supports two basic modes when querying LAPS passwords: The first mode queries for non-sensitive metadata, for example time the password was backed up to Azure and the expected expiration time of a password. This mode requires that the client be granted @@ -39,7 +38,7 @@ The second mode queries for all password information including both the metadata described above and the clear-text form of the password(s). This mode requires that the client be granted the Microsoft Graph `DeviceLocalCredential.Read.All` permission. -The '-DeviceIds' parameter accepts either device names or device IDs, but the underlying Microsoft +The **DeviceIds** parameter accepts either device names or device IDs, but the underlying Microsoft Graph queries only supports querying by device ID. To support this the cmdlet will map a device name input to its corresponding device ID by issuing a separate Microsoft Graph query. This extra query requires the `Device.Read.All` permission. If the target is a Microsoft Managed Desktop device, the @@ -50,14 +49,14 @@ requires the `Device.Read.All` permission. If the target is a Microsoft Managed > workaround is to input the device ID directly. > [!IMPORTANT] -> The **Get-LapsAADPassword** cmdlet is implemented as a wrapper around the Microsoft Graph -> PowerShell library which must be manually installed on the device before **Get-LapsAADPassword** +> The `Get-LapsAADPassword` cmdlet is implemented as a wrapper around the Microsoft Graph +> PowerShell library which must be manually installed on the device before `Get-LapsAADPassword` > can work. Additional configuration steps are required in your Azure Active Directory tenant to > enable authentication to Microsoft Graph and to grant the necessary Microsoft Graph permissions as > described above. See the following topic for more information: > [Get started with Windows LAPS and Azure Active Directory](https://go.microsoft.com/fwlink/?linkid=2233704) -The -Verbose parameter may be used to get additional information about the cmdlet's operation. +The **Verbose** may be used to get additional information about the cmdlet's operation. ## EXAMPLES @@ -171,7 +170,7 @@ Accept wildcard characters: False ### -DeviceIds -Specifies the device name or device ID to query LAPS credentials. +Specifies the device name or device ID to query LAPS credentials. ```yaml Type: System.String[] diff --git a/docset/winserver2022-ps/laps/Get-LapsADPassword.md b/docset/winserver2022-ps/laps/Get-LapsADPassword.md index 050ef83ae0..2010f21eeb 100644 --- a/docset/winserver2022-ps/laps/Get-LapsADPassword.md +++ b/docset/winserver2022-ps/laps/Get-LapsADPassword.md @@ -12,7 +12,6 @@ title: Get-LapsADPassword # Get-LapsADPassword ## SYNOPSIS - Queries Windows Local Administrator Password Solution (LAPS) credentials from Active Directory on a specified AD computer or domain controller object. @@ -21,15 +20,15 @@ specified AD computer or domain controller object. ### NormalMode (Default) ``` -Get-LapsADPassword [-Credential ] [-DecryptionCredential ] [-IncludeHistory] - [-AsPlainText] [-Identity] [] +Get-LapsADPassword [-Credential ] [-DecryptionCredential ] + [-IncludeHistory] [-AsPlainText] [-Identity] [] ``` ### DomainMode ``` -Get-LapsADPassword [-Credential ] [-DecryptionCredential ] [-IncludeHistory] - [-AsPlainText] [-Identity] -Domain [] +Get-LapsADPassword [-Credential ] [-DecryptionCredential ] + [-IncludeHistory] [-AsPlainText] [-Identity] -Domain [] ``` ### DomainControllerMode @@ -42,33 +41,35 @@ Get-LapsADPassword [-Credential ] [-DecryptionCredential ] [-DecryptionCredential ] [-IncludeHistory] - [-AsPlainText] -Port [-Identity] [-DomainController ] [] +Get-LapsADPassword [-Credential ] [-DecryptionCredential ] + [-IncludeHistory] [-AsPlainText] -Port [-Identity] [-DomainController ] + [] ``` ### RecoveryMode ``` -Get-LapsADPassword [-IncludeHistory] [-AsPlainText] [-RecoveryMode] [-Identity] [] +Get-LapsADPassword [-IncludeHistory] [-AsPlainText] [-RecoveryMode] [-Identity] + [] ``` ### SnapshotBrowserRecoveryMode ``` -Get-LapsADPassword [-IncludeHistory] [-AsPlainText] [-RecoveryMode] -Port [-Identity] - [] +Get-LapsADPassword [-IncludeHistory] [-AsPlainText] [-RecoveryMode] -Port + [-Identity] [] ``` ## DESCRIPTION -The **Get-LapsADPassword** cmdlet allows administrators to retrieve LAPS passwords and password +The `Get-LapsADPassword` cmdlet allows administrators to retrieve LAPS passwords and password history for an Active Directory computer or domain controller object. Depending on policy configuration, LAPS passwords may be stored in either clear-text form or encrypted form. The -**Get-LapsADPassword** cmdlet will automatically perform decryption of encrypted passwords. +`Get-LapsADPassword` cmdlet will automatically perform decryption of encrypted passwords. -The **Get-LapsADPassword** cmdlet may also be used to connected to a mounted Active Directory snapshot. +The `Get-LapsADPassword` cmdlet may also be used to connected to a mounted Active Directory snapshot. -The -Verbose parameter may be used to get additional information about the cmdlet's operation. +The **Verbose** may be used to get additional information about the cmdlet's operation. ## EXAMPLES diff --git a/docset/winserver2022-ps/laps/Get-LapsDiagnostics.md b/docset/winserver2022-ps/laps/Get-LapsDiagnostics.md index e8f6848f55..6186411aa7 100644 --- a/docset/winserver2022-ps/laps/Get-LapsDiagnostics.md +++ b/docset/winserver2022-ps/laps/Get-LapsDiagnostics.md @@ -12,23 +12,23 @@ title: Get-LapsDiagnostics # Get-LapsDiagnostics ## SYNOPSIS - Collects Windows Local Administrator Password Solution (LAPS) logs and tracing from the local machine. ## SYNTAX ``` -Get-LapsDiagnostics [[-OutputFolder] ] [-CollectNetworkTrace] [-ResetPassword] [] +Get-LapsDiagnostics [[-OutputFolder] ] [-CollectNetworkTrace] [-ResetPassword] + [] ``` ## DESCRIPTION -The **Get-LapsDiagnostics** cmdlet collects LAPS logs and tracing from the local machine, and copies -them into a .zip file. This cmdlet is primarily intended for support and testing scenarios but of -course may be used at any time. The name of the resultant .zip file includes the machine name and -current timestamp, and by default is written under the %TEMP%\LapsDiagnostics folder. The output -folder may be customized using the -OutputFolder parameter. +The `Get-LapsDiagnostics` cmdlet collects LAPS logs and tracing from the local machine, and copies +them into a `.zip` file. This cmdlet is primarily intended for support and testing scenarios but of +course may be used at any time. The name of the resultant `.zip` file includes the machine name and +current timestamp, and by default is written under the `$env:TEMP\LapsDiagnostics` folder. The +output folder may be customized using the **OutputFolder**. ## EXAMPLES @@ -82,7 +82,7 @@ tracing. ### -CollectNetworkTrace -Specifies that network tracing should also be collected and included in the resultant .zip file. +Specifies that network tracing should also be collected and included in the resultant `.zip` file. ```yaml Type: System.Management.Automation.SwitchParameter @@ -98,7 +98,7 @@ Accept wildcard characters: False ### -OutputFolder -Specifies that the resultant .zip file should be placed under the specified folder. +Specifies that the resultant `.zip` file should be placed under the specified folder. ```yaml Type: System.String @@ -116,10 +116,10 @@ Accept wildcard characters: False Specifies that logs and tracing should be collected across a forced password reset for the currently managed local account. In this mode the cmdlet collects tracing across a call to the -**Reset-LapsPassword** cmdlet. +`Reset-LapsPassword` cmdlet. If this parameter is not specified, the cmdlet collects tracing across a call to the -**Invoke-LapsProcessingCycle** cmdlet. +`Invoke-LapsProcessingCycle` cmdlet. ```yaml Type: System.Management.Automation.SwitchParameter diff --git a/docset/winserver2022-ps/laps/Invoke-LapsPolicyProcessing.md b/docset/winserver2022-ps/laps/Invoke-LapsPolicyProcessing.md index 07c734ffe8..b02a4ab4ce 100644 --- a/docset/winserver2022-ps/laps/Invoke-LapsPolicyProcessing.md +++ b/docset/winserver2022-ps/laps/Invoke-LapsPolicyProcessing.md @@ -12,8 +12,8 @@ title: Invoke-LapsPolicyProcessing # Invoke-LapsPolicyProcessing ## SYNOPSIS - -Causes Windows Local Administrator Password Solution (LAPS) to process the currently configured LAPS policy. +Causes Windows Local Administrator Password Solution (LAPS) to process the currently configured LAPS +policy. ## SYNTAX @@ -23,7 +23,7 @@ Invoke-LapsPolicyProcessing [] ## DESCRIPTION -The **Invoke-LapsPolicyProcessing** cmdlet tells Windows Local Administrator Password Solution +The `Invoke-LapsPolicyProcessing` cmdlet tells Windows Local Administrator Password Solution (LAPS) to process the currently configured LAPS policy. The cmdlet does not return detailed information about the results of the operation. See diff --git a/docset/winserver2022-ps/laps/Reset-LapsPassword.md b/docset/winserver2022-ps/laps/Reset-LapsPassword.md index 5914604ec8..d880412796 100644 --- a/docset/winserver2022-ps/laps/Reset-LapsPassword.md +++ b/docset/winserver2022-ps/laps/Reset-LapsPassword.md @@ -12,7 +12,6 @@ title: Reset-LapsPassword # Reset-LapsPassword ## SYNOPSIS - Causes Windows Local Administrator Password Solution (LAPS) to immediately rotate the password for the currently managed local account. @@ -24,7 +23,7 @@ Reset-LapsPassword [] ## DESCRIPTION -The **Reset-LapsPassword** cmdlet tells Windows Local Administrator Password Solution (LAPS) to +The `Reset-LapsPassword` cmdlet tells Windows Local Administrator Password Solution (LAPS) to immediately rotate the password for the currently managed local account. This operation is performed regardless of the state of the current password, for example it does not matter whether the current password is considered expired or not. diff --git a/docset/winserver2022-ps/laps/Set-LapsADAuditing.md b/docset/winserver2022-ps/laps/Set-LapsADAuditing.md index 3f8be8d695..7eaa46aaa6 100644 --- a/docset/winserver2022-ps/laps/Set-LapsADAuditing.md +++ b/docset/winserver2022-ps/laps/Set-LapsADAuditing.md @@ -12,7 +12,6 @@ title: Set-LapsADAuditing # Set-LapsADAuditing ## SYNOPSIS - Configures an Active Directory Organizational Unit to enable auditing on the Windows Local Administrator Password Solution (LAPS) password schema attributes. @@ -140,8 +139,8 @@ Specifies which Active Directory Organizational Unit to update. This parameter accepts several different name formats which influence the criteria used in the resultant Active Directory search. The supported name formats are as follows: -distinguishedName (begins with a "CN=") -name (for all other inputs) +- distinguishedName (begins with a "CN=") +- name (for all other inputs) ```yaml Type: System.String[] diff --git a/docset/winserver2022-ps/laps/Set-LapsADComputerSelfPermission.md b/docset/winserver2022-ps/laps/Set-LapsADComputerSelfPermission.md index c02f744b10..6776574293 100644 --- a/docset/winserver2022-ps/laps/Set-LapsADComputerSelfPermission.md +++ b/docset/winserver2022-ps/laps/Set-LapsADComputerSelfPermission.md @@ -12,20 +12,20 @@ title: Set-LapsADComputerSelfPermission # Set-LapsADComputerSelfPermission ## SYNOPSIS - Configures permissions on an Active Directory Organizational Unit to enable computers in that OU to update their Windows Local Administrator Password Solution (LAPS) passwords. ## SYNTAX ``` -Set-LapsADComputerSelfPermission -Identity [-Domain ] [-DomainController ] - [-Credential ] [-WhatIf] [-Confirm] [] +Set-LapsADComputerSelfPermission -Identity [-Domain ] + [-DomainController ] [-Credential ] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION -The **Set-LapsADComputerSelfPermission** cmdlet is used by administrators to configure security +The `Set-LapsADComputerSelfPermission` cmdlet is used by administrators to configure security permissions on an Active Directory Organizational Unit (OU) to allow computers in that OU to update their LAPS passwords. @@ -101,8 +101,8 @@ Specifies which Active Directory Organizational Unit to update. This parameter accepts several different name formats which influence the criteria used in the resultant Active Directory search. The supported name formats are as follows: -distinguishedName (begins with a "CN=") -name (for all other inputs) +- distinguishedName (begins with a "CN=") +- name (for all other inputs) ```yaml Type: System.String[] diff --git a/docset/winserver2022-ps/laps/Set-LapsADPasswordExpirationTime.md b/docset/winserver2022-ps/laps/Set-LapsADPasswordExpirationTime.md index c1ce99c815..77aed60311 100644 --- a/docset/winserver2022-ps/laps/Set-LapsADPasswordExpirationTime.md +++ b/docset/winserver2022-ps/laps/Set-LapsADPasswordExpirationTime.md @@ -12,20 +12,19 @@ title: Set-LapsADPasswordExpirationTime # Set-LapsADPasswordExpirationTime ## SYNOPSIS - Sets the Windows Local Administrator Password Solution (LAPS) password expiration timestamp on an Active Directory computer or domain controller object. ## SYNTAX ``` -Set-LapsADPasswordExpirationTime [-Credential ] -Identity [-WhenEffective ] - [-Domain ] [-DomainController ] [] +Set-LapsADPasswordExpirationTime [-Credential ] -Identity + [-WhenEffective ] [-Domain ] [-DomainController ] [] ``` ## DESCRIPTION -The **Set-LapsADPasswordExpirationTime** cmdlet is used by administrators to configure the LAPS +The `Set-LapsADPasswordExpirationTime` cmdlet is used by administrators to configure the LAPS password expiration time on an Active Directory computer or domain controller object. > [!TIP] diff --git a/docset/winserver2022-ps/laps/Set-LapsADReadPasswordPermission.md b/docset/winserver2022-ps/laps/Set-LapsADReadPasswordPermission.md index a98fdf04b1..488ad86c7b 100644 --- a/docset/winserver2022-ps/laps/Set-LapsADReadPasswordPermission.md +++ b/docset/winserver2022-ps/laps/Set-LapsADReadPasswordPermission.md @@ -12,7 +12,6 @@ title: Set-LapsADReadPasswordPermission # Set-LapsADReadPasswordPermission ## SYNOPSIS - Configures security on an Active Directory Organizational Unit to grant specific users or groups permission to query Windows Local Administrator Password Solution (LAPS) passwords. @@ -26,11 +25,11 @@ Set-LapsADReadPasswordPermission [-Credential ] -Identity Set-LapsADAuditing -Identity LapsTestOU -AuditedPrincipals "laps.com\LapsAdminsGroup" -AuditType Failure +Set-LapsADAuditing -Identity LapsTestOU -AuditedPrincipals "laps.com\LapsAdminsGroup" -AuditType Failure OU=LapsTestOU,DC=laps,DC=com ``` diff --git a/docset/winserver2022-ps/laps/Set-LapsADComputerSelfPermission.md b/docset/winserver2022-ps/laps/Set-LapsADComputerSelfPermission.md index 6776574293..5878118f08 100644 --- a/docset/winserver2022-ps/laps/Set-LapsADComputerSelfPermission.md +++ b/docset/winserver2022-ps/laps/Set-LapsADComputerSelfPermission.md @@ -34,8 +34,10 @@ their LAPS passwords. ### Example 1 ```powershell -PS C:\> Set-LapsADComputerSelfPermission -Identity LapsTestOU +Set-LapsADComputerSelfPermission -Identity LapsTestOU +``` +```Output Name DistinguishedName ---- ----------------- LapsTestOU OU=LapsTestOU,DC=laps,DC=com diff --git a/docset/winserver2022-ps/laps/Set-LapsADPasswordExpirationTime.md b/docset/winserver2022-ps/laps/Set-LapsADPasswordExpirationTime.md index 77aed60311..96863f1726 100644 --- a/docset/winserver2022-ps/laps/Set-LapsADPasswordExpirationTime.md +++ b/docset/winserver2022-ps/laps/Set-LapsADPasswordExpirationTime.md @@ -37,8 +37,10 @@ password expiration time on an Active Directory computer or domain controller ob ### Example 1 ```powershell -PS C:\> Set-LapsADPasswordExpirationTime -Identity lapsClient +Set-LapsADPasswordExpirationTime -Identity lapsClient +``` +```Output DistinguishedName Status ----------------- ------ CN=LAPSCLIENT,OU=LapsTestOU,DC=laps,DC=com PasswordReset @@ -50,8 +52,10 @@ expiring the password immediately). ### Example 2 ```powershell -PS C:\> Set-LapsADPasswordExpirationTime -Identity lapsFe -WhenEffective (Get-Date -Date "07/04/2023 13:00:00") +Set-LapsADPasswordExpirationTime -Identity lapsClient -WhenEffective (Get-Date -Date "07/04/2023 13:00:00") +``` +```Output DistinguishedName Status ----------------- ------ CN=LAPSCLIENT,OU=LapsTestOU,DC=laps,DC=com PasswordReset @@ -62,8 +66,10 @@ This examples show setting the LAPS password expiration time to a specific date. ### Example 3 ```powershell -PS C:\> Set-LapsADPasswordExpirationTime -Identity lapsFe -WhenEffective (DateTime::Now.AddDays(1)) +Set-LapsADPasswordExpirationTime -Identity lapsClient -WhenEffective (DateTime::Now.AddDays(1)) +``` +```Output DistinguishedName Status ----------------- ------ CN=LAPSCLIENT,OU=LapsTestOU,DC=laps,DC=com PasswordReset @@ -130,10 +136,10 @@ expiration time on. This parameter accepts several different name formats which influence the criteria used when searching Active Directory for the target device. The supported name formats are as follows: -distinguishedName (begins with a "CN=") -samAccountName (begins with a '$") -dnsHostName (contains at least one '.' character) -name (for all other inputs) +- distinguishedName (begins with a "CN=") +- samAccountName (begins with a `$`) +- dnsHostName (contains at least one `.` character) +- name (for all other inputs) ```yaml Type: System.String[] diff --git a/docset/winserver2022-ps/laps/Set-LapsADReadPasswordPermission.md b/docset/winserver2022-ps/laps/Set-LapsADReadPasswordPermission.md index 488ad86c7b..1936e942da 100644 --- a/docset/winserver2022-ps/laps/Set-LapsADReadPasswordPermission.md +++ b/docset/winserver2022-ps/laps/Set-LapsADReadPasswordPermission.md @@ -36,8 +36,10 @@ built-in principal, such as `Domain Admins`. ### Example 1 ```powershell -PS C:\> Set-LapsADReadPasswordPermission -Identity LapsTestOU -AllowedPrincipals "Domain Admins" +Set-LapsADReadPasswordPermission -Identity LapsTestOU -AllowedPrincipals "Domain Admins" +``` +```Output Name DistinguishedName ---- ----------------- LapsTestOU OU=LapsTestOU,DC=laps,DC=com @@ -49,8 +51,10 @@ well-known user or group. ### Example 2 ```powershell -PS C:\> Set-LapsADReadPasswordPermission -Identity LapsTestOU -AllowedPrincipals @("S-1-5-21-2889755270-1324585639-743026605-1215") +Set-LapsADReadPasswordPermission -Identity LapsTestOU -AllowedPrincipals @("S-1-5-21-2889755270-1324585639-743026605-1215") +``` +```Output Name DistinguishedName ---- ----------------- LapsTestOU OU=LapsTestOU,DC=laps,DC=com @@ -61,8 +65,10 @@ This example shows how to run the cmdlet specifying a user SID as input. ### Example 3 ```powershell -PS C:\> Set-LapsADReadPasswordPermission -Identity 'OU=LapsTestOU,DC=laps,DC=com' -AllowedPrincipals @("laps.com\LapsAdmin1", "LapsAdmin2@laps.com") +Set-LapsADReadPasswordPermission -Identity 'OU=LapsTestOU,DC=laps,DC=com' -AllowedPrincipals @("laps.com\LapsAdmin1", "LapsAdmin2@laps.com") +``` +```Output Name DistinguishedName ---- ----------------- LapsTestOU OU=LapsTestOU,DC=laps,DC=com @@ -74,9 +80,13 @@ formats. ### Example 4 ```powershell -PS C:\> Set-LapsADReadPasswordPermission -Identity LapsTestOU -AllowedPrincipals @("LapsAdministratorsGroup") -Set-LapsADReadPasswordPermission : The 'LapsAdministratorsGroup' account appears to be an isolated name but is not a well-known name. Please use a -fully qualified name instead, such as "LAPSAdmins@contoso.com" or "contoso\LAPSAdmins" +Set-LapsADReadPasswordPermission -Identity LapsTestOU -AllowedPrincipals @("LapsAdministratorsGroup") +``` + +```Output +Set-LapsADReadPasswordPermission : The 'LapsAdministratorsGroup' account appears to be an isolated +name but is not a well-known name. Please use a fully qualified name instead, such as +"LAPSAdmins@contoso.com" or "contoso\LAPSAdmins" At line:1 char:1 + Set-LapsADReadPasswordPermission -Identity LapsTestOU -AllowedPrincip ... + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/docset/winserver2022-ps/laps/Set-LapsADResetPasswordPermission.md b/docset/winserver2022-ps/laps/Set-LapsADResetPasswordPermission.md index b60c54b486..c4a0cff861 100644 --- a/docset/winserver2022-ps/laps/Set-LapsADResetPasswordPermission.md +++ b/docset/winserver2022-ps/laps/Set-LapsADResetPasswordPermission.md @@ -36,8 +36,10 @@ specified name resolves to a built-in principal (for example "Domain Admins"). ### Example 1 ```powershell -PS C:\> Set-LapsADResetPasswordPermission -Identity LapsTestOU -AllowedPrincipals "Domain Admins" +Set-LapsADResetPasswordPermission -Identity LapsTestOU -AllowedPrincipals "Domain Admins" +``` +```Output Name DistinguishedName ---- ----------------- LapsTestOU OU=LapsTestOU,DC=laps,DC=com @@ -49,8 +51,10 @@ well-known user or group. ### Example 2 ```powershell -PS C:\> Set-LapsADResetPasswordPermission -Identity LapsTestOU -AllowedPrincipals @("S-1-5-21-2889755270-1324585639-743026605-1215") +Set-LapsADResetPasswordPermission -Identity LapsTestOU -AllowedPrincipals @("S-1-5-21-2889755270-1324585639-743026605-1215") +``` +```Output Name DistinguishedName ---- ----------------- LapsTestOU OU=LapsTestOU,DC=laps,DC=com @@ -61,8 +65,10 @@ This example shows how to run the cmdlet specifying a user SID as input. ### Example 3 ```powershell -PS C:\> Set-LapsADResetPasswordPermission -Identity 'OU=LapsTestOU,DC=laps,DC=com' -AllowedPrincipals @("laps.com\LapsAdmin1", "LapsAdmin2@laps.com") +Set-LapsADResetPasswordPermission -Identity 'OU=LapsTestOU,DC=laps,DC=com' -AllowedPrincipals @("laps.com\LapsAdmin1", "LapsAdmin2@laps.com") +``` +```Output Name DistinguishedName ---- ----------------- LapsTestOU OU=LapsTestOU,DC=laps,DC=com @@ -74,9 +80,13 @@ formats) as input. ### Example 4 ```powershell -PS C:\> Set-LapsADResetPasswordPermission -Identity LapsTestOU -AllowedPrincipals @("LapsAdministratorsGroup") -Set-LapsADReadPasswordPermission : The 'LapsAdministratorsGroup' account appears to be an isolated name but is not a well-known name. Please use a -fully qualified name instead, such as "LapsAdministratorsGroup@contoso.com" or "contoso\LapsAdministratorsGroup" +Set-LapsADResetPasswordPermission -Identity LapsTestOU -AllowedPrincipals @("LapsAdministratorsGroup") +``` + +```Output +Set-LapsADReadPasswordPermission : The 'LapsAdministratorsGroup' account appears to be an isolated +name but is not a well-known name. Please use a fully qualified name instead, such as +"LapsAdministratorsGroup@contoso.com" or "contoso\LapsAdministratorsGroup" At line:1 char:1 + Set-LapsADReadPasswordPermission -Identity LapsTestOU -AllowedPrincip ... + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/docset/winserver2022-ps/laps/Update-LapsADSchema.md b/docset/winserver2022-ps/laps/Update-LapsADSchema.md index 43ca246850..b42063d797 100644 --- a/docset/winserver2022-ps/laps/Update-LapsADSchema.md +++ b/docset/winserver2022-ps/laps/Update-LapsADSchema.md @@ -23,7 +23,7 @@ Update-LapsADSchema [-Credential ] [-WhatIf] [-Confirm] [ Update-LapsADSchema +Update-LapsADSchema +``` +```Output The 'ms-LAPS-Password' schema attribute needs to be added to the AD schema. Do you want to proceed? [Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): A ``` -This example shows how to run the Update-LapsADSchema cmdlet. +This example extends the AD schema to add the LAPS attributes. ## PARAMETERS @@ -115,4 +117,5 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS [Windows LAPS Overview](https://go.microsoft.com/fwlink/?linkid=2233901) + [Windows LAPS schema extensions reference](https://go.microsoft.com/fwlink/?linkid=2233804) From bc9dd2722edbedd4ddfe3a0ea68ba0ae2be6e94f Mon Sep 17 00:00:00 2001 From: Jay Simmons Date: Sat, 15 Apr 2023 11:32:18 -0700 Subject: [PATCH 105/650] Remove dangling character. --- docset/winserver2022-ps/laps/Get-LapsAADPassword.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/laps/Get-LapsAADPassword.md b/docset/winserver2022-ps/laps/Get-LapsAADPassword.md index b25b3226a1..852aeb04a3 100644 --- a/docset/winserver2022-ps/laps/Get-LapsAADPassword.md +++ b/docset/winserver2022-ps/laps/Get-LapsAADPassword.md @@ -18,7 +18,7 @@ credentials on a specified Azure AD device. ## SYNTAX -```s +``` Get-LapsAADPassword -DeviceIds [-IncludePasswords] [-IncludeHistory] [-AsPlainText] [] ``` From dbef4cc0525858d4f16986eb4ad56e4edff74f62 Mon Sep 17 00:00:00 2001 From: Sean Wheeler Date: Sat, 15 Apr 2023 14:00:19 -0500 Subject: [PATCH 106/650] Grammar cleanup - which vs that - see https://owl.purdue.edu/owl/general_writing/grammar/that_vs_which.html - avoid using `will` - more formatting cleanup --- .../laps/Find-LapsADExtendedRights.md | 8 +-- .../laps/Get-LapsAADPassword.md | 42 ++++++----- .../laps/Get-LapsADPassword.md | 70 +++++++++++-------- .../laps/Get-LapsDiagnostics.md | 2 +- .../laps/Invoke-LapsPolicyProcessing.md | 2 +- .../laps/Reset-LapsPassword.md | 6 +- .../laps/Set-LapsADAuditing.md | 10 +-- .../laps/Set-LapsADComputerSelfPermission.md | 10 +-- .../laps/Set-LapsADPasswordExpirationTime.md | 20 +++--- .../laps/Set-LapsADReadPasswordPermission.md | 12 ++-- .../laps/Set-LapsADResetPasswordPermission.md | 25 +++---- .../laps/Update-LapsADSchema.md | 6 +- 12 files changed, 117 insertions(+), 96 deletions(-) diff --git a/docset/winserver2022-ps/laps/Find-LapsADExtendedRights.md b/docset/winserver2022-ps/laps/Find-LapsADExtendedRights.md index 78b9266cfb..500e2ddfc4 100644 --- a/docset/winserver2022-ps/laps/Find-LapsADExtendedRights.md +++ b/docset/winserver2022-ps/laps/Find-LapsADExtendedRights.md @@ -47,8 +47,8 @@ This example shows how to run the cmdlet. ### -Credential -Specifies the credentials to use when updating Active Directory. If not specified the current user's -credentials will be used. +Specifies the credentials to use when updating Active Directory. If not specified, the current +user's credentials are used. ```yaml Type: System.Management.Automation.PSCredential @@ -98,10 +98,10 @@ Accept wildcard characters: False Specifies which Active Directory Organizational Unit to query. -This parameter accepts several different name formats which influence the criteria used in the +This parameter accepts several different name formats that influence the criteria used in the resultant Active Directory search. The supported name formats are as follows: -- distinguishedName (begins with a "CN=") +- distinguishedName (begins with a `CN=`) - name (for all other inputs) ```yaml diff --git a/docset/winserver2022-ps/laps/Get-LapsAADPassword.md b/docset/winserver2022-ps/laps/Get-LapsAADPassword.md index eb74c60bc7..6bed0d7f03 100644 --- a/docset/winserver2022-ps/laps/Get-LapsAADPassword.md +++ b/docset/winserver2022-ps/laps/Get-LapsAADPassword.md @@ -39,21 +39,21 @@ described above and the clear-text form of the password(s). This mode requires t granted the Microsoft Graph `DeviceLocalCredential.Read.All` permission. The **DeviceIds** parameter accepts either device names or device IDs, but the underlying Microsoft -Graph queries only supports querying by device ID. To support this the cmdlet will map a device name -input to its corresponding device ID by issuing a separate Microsoft Graph query. This extra query -requires the `Device.Read.All` permission. If the target is a Microsoft Managed Desktop device, the -`DeviceManagementManagedDevices.Read.All` permission may also be required. +Graph queries only supports querying by device ID. To support this query, the cmdlet maps a device +name input to its corresponding device ID by issuing a separate Microsoft Graph query. This extra +query requires the `Device.Read.All` permission. If the target is a Microsoft Managed Desktop +device, the `DeviceManagementManagedDevices.Read.All` permission may also be required. > [!TIP] -> If there are multiple devices in the tenant with the same name, the cmdlet will fail. The -> workaround is to input the device ID directly. +> If there are multiple devices in the tenant with the same name, the cmdlet fails. The workaround +> is to input the device ID directly. > [!IMPORTANT] -> The `Get-LapsAADPassword` cmdlet is implemented as a wrapper around the Microsoft Graph -> PowerShell library which must be manually installed on the device before `Get-LapsAADPassword` -> can work. Additional configuration steps are required in your Azure Active Directory tenant to -> enable authentication to Microsoft Graph and to grant the necessary Microsoft Graph permissions as -> described above. See the following topic for more information: +> The `Get-LapsAADPassword` cmdlet is implemented as a wrapper around the Microsoft Graph PowerShell +> library, which must be manually installed on the device before `Get-LapsAADPassword` can work. +> Additional configuration steps are required in your Azure Active Directory tenant to enable +> authentication to Microsoft Graph and to grant the necessary Microsoft Graph permissions. For more +> information, see > [Get started with Windows LAPS and Azure Active Directory](https://go.microsoft.com/fwlink/?linkid=2233704) The **Verbose** may be used to get additional information about the cmdlet's operation. @@ -75,7 +75,7 @@ DeviceName DeviceId PasswordExpirationTime LAPSAAD dfc6d5f0-225a-4b46-adcf-73a349a31e70 4/22/2023 8:45:29 AM ``` -This example shows how to query basic LAPS password metadata information for the target device which +This example shows how to query basic LAPS password metadata information for the target device that is specified by device name. ### Example 2 @@ -93,15 +93,18 @@ PasswordExpirationTime : 4/22/2023 8:45:29 AM PasswordUpdateTime : 4/11/2023 8:45:29 AM ``` -This example shows how to query the full LAPS password information for the target device which is +This example shows how to query the full LAPS password information for the target device that is specified by device ID. ### Example 3 ```powershell Connect-MgGraph -TenantId b20f5886-bddf-43bb-aee6-dda0c87c5fa2 -ClientId 9fa98e34-277f-47fa-9847-e36bdf6bca1f -Welcome To Microsoft Graph! Get-LapsAADPassword -DeviceIds dfc6d5f0-225a-4b46-adcf-73a349a31e70 -IncludePasswords -AsPlainText +``` + +```Output +Welcome To Microsoft Graph! DeviceName : LAPSAAD DeviceId : dfc6d5f0-225a-4b46-adcf-73a349a31e70 @@ -111,15 +114,18 @@ PasswordExpirationTime : 4/22/2023 8:45:29 AM PasswordUpdateTime : 4/11/2023 8:45:29 AM ``` -This example shows how to query the full LAPS password information for the target device which is +This example shows how to query the full LAPS password information for the target device that is specified by device ID, and displaying the password in clear-text form. ### Example 4 ```powershell Connect-MgGraph -TenantId b20f5886-bddf-43bb-aee6-dda0c87c5fa2 -ClientId 9fa98e34-277f-47fa-9847-e36bdf6bca1f -Welcome To Microsoft Graph! Get-LapsAADPassword -DeviceIds lapsAAD -IncludePasswords -AsPlainText -IncludeHistory +``` + +```Output +Welcome To Microsoft Graph! DeviceName : LAPSAAD DeviceId : dfc6d5f0-225a-4b46-adcf-73a349a31e70 @@ -143,7 +149,7 @@ PasswordExpirationTime : PasswordUpdateTime : 4/11/2023 8:45:29 AM ``` -This example shows how to query the full LAPS password information for the target device which is +This example shows how to query the full LAPS password information for the target device that is specified by device name, requesting password history, and displaying the passwords in clear-text form. @@ -152,7 +158,7 @@ form. ### -AsPlainText Specify this parameter to return the LAPS passwords in clear-text format. The default behavior is to -return the LAPS passwords wrapped in a .NET SecureString object. +return the LAPS passwords wrapped in a .NET **SecureString** object. > [!IMPORTANT] > Using this parameter exposes the returned clear-text password to casual viewing and may pose a diff --git a/docset/winserver2022-ps/laps/Get-LapsADPassword.md b/docset/winserver2022-ps/laps/Get-LapsADPassword.md index 2520c9417c..98a11c9c5e 100644 --- a/docset/winserver2022-ps/laps/Get-LapsADPassword.md +++ b/docset/winserver2022-ps/laps/Get-LapsADPassword.md @@ -65,9 +65,10 @@ Get-LapsADPassword [-IncludeHistory] [-AsPlainText] [-RecoveryMode] -Port [!IMPORTANT] > Using this parameter exposes the returned clear-text password to casual viewing and may pose a @@ -255,7 +268,7 @@ Accept wildcard characters: False ### -Credential Specifies a set of credentials to use when querying Active Directory for the LAPS credentials. If -not specified the current user's credentials will be used. +not specified, the current user's credentials are used. ```yaml Type: System.Management.Automation.PSCredential @@ -271,8 +284,8 @@ Accept wildcard characters: False ### -DecryptionCredential -Specifies a set of credentials to use when decrypting encrypted LAPS credentials. If not specified -the current user's credentials will be used. +Specifies a set of credentials to use when decrypting encrypted LAPS credentials. If not specified, +the current user's credentials are used. ```yaml Type: System.Management.Automation.PSCredential @@ -336,13 +349,13 @@ Accept wildcard characters: False Specifies which Active Directory computer or domain controller object to retrieve LAPS credentials from. -This parameter accepts several different name formats which influence the criteria used when +This parameter accepts several different name formats that influence the criteria used when searching Active Directory for the target device. The supported name formats are as follows: -distinguishedName (begins with a "CN=") -samAccountName (begins with a '$") -dnsHostName (contains at least one '.' character) -name (for all other inputs) +- distinguishedName (begins with a `CN=`) +- samAccountName (begins with a '$") +- dnsHostName (contains at least one '.' character) +- name (for all other inputs) ```yaml Type: System.String[] @@ -390,12 +403,13 @@ Accept wildcard characters: False ### -RecoveryMode -This parameter provides a last-ditch option when it is no longer possible to decrypt a given LAPS +This parameter provides a last-ditch option when it's no longer possible to decrypt a given LAPS credential via the normal mechanisms. For example, this might be necessary if a LAPS credential was -encrypted against a group which has since been deleted. +encrypted against a group that has since been deleted. >[!IMPORTANT] ->When specifying this parameter, you MUST be logged-in locally as a Domain Administrator on a writable domain controller. +> When specifying this parameter, you MUST be logged-in locally as a Domain Administrator on a +> writable domain controller. ```yaml Type: System.Management.Automation.SwitchParameter diff --git a/docset/winserver2022-ps/laps/Get-LapsDiagnostics.md b/docset/winserver2022-ps/laps/Get-LapsDiagnostics.md index ca34ed862d..5bb0ad8332 100644 --- a/docset/winserver2022-ps/laps/Get-LapsDiagnostics.md +++ b/docset/winserver2022-ps/laps/Get-LapsDiagnostics.md @@ -130,7 +130,7 @@ Specifies that logs and tracing should be collected across a forced password res managed local account. In this mode the cmdlet collects tracing across a call to the `Reset-LapsPassword` cmdlet. -If this parameter is not specified, the cmdlet collects tracing across a call to the +If this parameter isn't specified, the cmdlet collects tracing across a call to the `Invoke-LapsProcessingCycle` cmdlet. ```yaml diff --git a/docset/winserver2022-ps/laps/Invoke-LapsPolicyProcessing.md b/docset/winserver2022-ps/laps/Invoke-LapsPolicyProcessing.md index ad6c3ff8af..337dbc397d 100644 --- a/docset/winserver2022-ps/laps/Invoke-LapsPolicyProcessing.md +++ b/docset/winserver2022-ps/laps/Invoke-LapsPolicyProcessing.md @@ -26,7 +26,7 @@ Invoke-LapsPolicyProcessing [] The `Invoke-LapsPolicyProcessing` cmdlet tells Windows Local Administrator Password Solution (LAPS) to process the currently configured LAPS policy. -The cmdlet does not return detailed information about the results of the operation. See +The cmdlet doesn't return detailed information about the results of the operation. See [Use Windows LAPS event logs](https://go.microsoft.com/fwlink/?linkid=2234103) for more information on querying the resultant event log entries to get specific information on the outcome of the operation. diff --git a/docset/winserver2022-ps/laps/Reset-LapsPassword.md b/docset/winserver2022-ps/laps/Reset-LapsPassword.md index 2bcc24379d..1fc2e7ef34 100644 --- a/docset/winserver2022-ps/laps/Reset-LapsPassword.md +++ b/docset/winserver2022-ps/laps/Reset-LapsPassword.md @@ -25,15 +25,15 @@ Reset-LapsPassword [] The `Reset-LapsPassword` cmdlet tells Windows Local Administrator Password Solution (LAPS) to immediately rotate the password for the currently managed local account. This operation is performed -regardless of the state of the current password, for example it does not matter whether the current +regardless of the state of the current password, for example it doesn't matter whether the current password is considered expired or not. > [!IMPORTANT] > This cmdlet is intended and recommended only for rare situations that require an > immediate password rotation, for example as a response to a machine security breach situation. -> Excessively frequent usage of this cmdlet is not recommended. +> Excessively frequent usage of this cmdlet isn't recommended. -The cmdlet does not return detailed information about the results of the operation. See +The cmdlet doesn't return detailed information about the results of the operation. See [Use Windows LAPS event logs](https://go.microsoft.com/fwlink/?linkid=2234103) for more information on querying the resultant event log entries to get specific information on the outcome of the operation. diff --git a/docset/winserver2022-ps/laps/Set-LapsADAuditing.md b/docset/winserver2022-ps/laps/Set-LapsADAuditing.md index 15a128a969..3c70ae0615 100644 --- a/docset/winserver2022-ps/laps/Set-LapsADAuditing.md +++ b/docset/winserver2022-ps/laps/Set-LapsADAuditing.md @@ -85,8 +85,8 @@ Accept wildcard characters: False ### -Credential -Specifies the credentials to use when updating Active Directory. If not specified the current user's -credentials will be used. +Specifies the credentials to use when updating Active Directory. If not specified, the current +user's credentials are used. ```yaml Type: System.Management.Automation.PSCredential @@ -136,10 +136,10 @@ Accept wildcard characters: False Specifies which Active Directory Organizational Unit to update. -This parameter accepts several different name formats which influence the criteria used in the +This parameter accepts several different name formats that influence the criteria used in the resultant Active Directory search. The supported name formats are as follows: -- distinguishedName (begins with a "CN=") +- distinguishedName (begins with a `CN=`) - name (for all other inputs) ```yaml @@ -172,7 +172,7 @@ Accept wildcard characters: False ### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. +Shows what would happen if the cmdlet runs. The cmdlet isn't run. ```yaml Type: System.Management.Automation.SwitchParameter diff --git a/docset/winserver2022-ps/laps/Set-LapsADComputerSelfPermission.md b/docset/winserver2022-ps/laps/Set-LapsADComputerSelfPermission.md index 5878118f08..2c7770cb14 100644 --- a/docset/winserver2022-ps/laps/Set-LapsADComputerSelfPermission.md +++ b/docset/winserver2022-ps/laps/Set-LapsADComputerSelfPermission.md @@ -49,8 +49,8 @@ This example demonstrates how to run the cmdlet. ### -Credential -Specifies the credentials to use when updating Active Directory. If not specified the current user's -credentials will be used. +Specifies the credentials to use when updating Active Directory. If not specified, the current +user's credentials are used. ```yaml Type: System.Management.Automation.PSCredential @@ -100,10 +100,10 @@ Accept wildcard characters: False Specifies which Active Directory Organizational Unit to update. -This parameter accepts several different name formats which influence the criteria used in the +This parameter accepts several different name formats that influence the criteria used in the resultant Active Directory search. The supported name formats are as follows: -- distinguishedName (begins with a "CN=") +- distinguishedName (begins with a `CN=`) - name (for all other inputs) ```yaml @@ -137,7 +137,7 @@ Accept wildcard characters: False ### -WhatIf Shows what would happen if the cmdlet runs. -The cmdlet is not run. +The cmdlet isn't run. ```yaml Type: System.Management.Automation.SwitchParameter diff --git a/docset/winserver2022-ps/laps/Set-LapsADPasswordExpirationTime.md b/docset/winserver2022-ps/laps/Set-LapsADPasswordExpirationTime.md index 96863f1726..d0c1db5451 100644 --- a/docset/winserver2022-ps/laps/Set-LapsADPasswordExpirationTime.md +++ b/docset/winserver2022-ps/laps/Set-LapsADPasswordExpirationTime.md @@ -29,8 +29,8 @@ password expiration time on an Active Directory computer or domain controller ob > [!TIP] > Running this cmdlet sets the LAPS password expiration time on the Active Directory computer or -> domain controller object, but the new expiration time will not be honored until the next time the -> target device executes a LAPS policy processing cycle. +> domain controller object, but the new expiration time isn't honored until the next time the target +> device executes a LAPS policy processing cycle. ## EXAMPLES @@ -46,8 +46,8 @@ DistinguishedName Status CN=LAPSCLIENT,OU=LapsTestOU,DC=laps,DC=com PasswordReset ``` -This examples show setting the LAPS password expiration time to the current time (or in other words, -expiring the password immediately). +This example shows setting the LAPS password expiration time to the current time, which expires the +password immediately. ### Example 2 @@ -81,8 +81,8 @@ This examples show setting the LAPS password expiration time to one day in the f ### -Credential -Specifies the credentials to use when updating Active Directory. If not specified the current user's -credentials will be used. +Specifies the credentials to use when updating Active Directory. If not specified, the current +user's credentials are used. ```yaml Type: System.Management.Automation.PSCredential @@ -133,10 +133,10 @@ Accept wildcard characters: False Specifies which Active Directory computer or domain controller object to set the LAPS password expiration time on. -This parameter accepts several different name formats which influence the criteria used when +This parameter accepts several different name formats that influence the criteria used when searching Active Directory for the target device. The supported name formats are as follows: -- distinguishedName (begins with a "CN=") +- distinguishedName (begins with a `CN=`) - samAccountName (begins with a `$`) - dnsHostName (contains at least one `.` character) - name (for all other inputs) @@ -155,8 +155,8 @@ Accept wildcard characters: False ### -WhenEffective -Specifies the new LAPS password expiration time. If not specified the current time will be used, in -other words the password is immediately expired. +Specifies the new LAPS password expiration time. If not specified, the current time is used, which +expires the password is immediately. ```yaml Type: System.DateTime diff --git a/docset/winserver2022-ps/laps/Set-LapsADReadPasswordPermission.md b/docset/winserver2022-ps/laps/Set-LapsADReadPasswordPermission.md index 1936e942da..24501ed5bd 100644 --- a/docset/winserver2022-ps/laps/Set-LapsADReadPasswordPermission.md +++ b/docset/winserver2022-ps/laps/Set-LapsADReadPasswordPermission.md @@ -94,7 +94,7 @@ At line:1 char:1 + FullyQualifiedErrorId : Invalid principal specified,Microsoft.Windows.LAPS.SetLapsADReadPasswordPermission ``` -This example shows a failure caused by specifying an isolated name that did not resolve to a +This example shows a failure caused by specifying an isolated name that didn't resolve to a well-known or built-in account. The fix for this error would be to add a domain name qualifier to the input name, for example `LapsAdministratorsGroup@laps.com`. @@ -120,8 +120,8 @@ Accept wildcard characters: False ### -Credential -Specifies the credentials to use when updating Active Directory. If not specified the current user's -credentials will be used. +Specifies the credentials to use when updating Active Directory. If not specified, the current +user's credentials are used. ```yaml Type: System.Management.Automation.PSCredential @@ -171,10 +171,10 @@ Accept wildcard characters: False Specifies which Active Directory Organizational Unit to update. -This parameter accepts several different name formats which influence the criteria used in the +This parameter accepts several different name formats that influence the criteria used in the resultant Active Directory search. The supported name formats are as follows: -- distinguishedName (begins with a "CN=") +- distinguishedName (begins with a `CN=`) - name (for all other inputs) ```yaml @@ -207,7 +207,7 @@ Accept wildcard characters: False ### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. +Shows what would happen if the cmdlet runs. The cmdlet isn't run. ```yaml Type: System.Management.Automation.SwitchParameter diff --git a/docset/winserver2022-ps/laps/Set-LapsADResetPasswordPermission.md b/docset/winserver2022-ps/laps/Set-LapsADResetPasswordPermission.md index c4a0cff861..aa413f9830 100644 --- a/docset/winserver2022-ps/laps/Set-LapsADResetPasswordPermission.md +++ b/docset/winserver2022-ps/laps/Set-LapsADResetPasswordPermission.md @@ -12,8 +12,9 @@ title: Set-LapsADResetPasswordPermission # Set-LapsADResetPasswordPermission ## SYNOPSIS -Configures security on an Active Directory Organizational Unit to grant specific users or groups -permission to set the Windows Local Administrator Password Solution (LAPS) password expiration time. +Configures security on an Active Directory (AD) Organizational Unit (OU) to grant specific users or +groups permission to set the Windows Local Administrator Password Solution (LAPS) password +expiration time. ## SYNTAX @@ -26,10 +27,10 @@ Set-LapsADResetPasswordPermission [-Credential ] -Identity [!IMPORTANT] -> When specifying this parameter, you MUST be logged-in locally as a Domain Administrator on a +> When specifying this parameter, you must be logged-in locally as a Domain Administrator on a > writable domain controller. ```yaml diff --git a/docset/winserver2022-ps/laps/Invoke-LapsPolicyProcessing.md b/docset/winserver2022-ps/laps/Invoke-LapsPolicyProcessing.md index 337dbc397d..ca931a1bd3 100644 --- a/docset/winserver2022-ps/laps/Invoke-LapsPolicyProcessing.md +++ b/docset/winserver2022-ps/laps/Invoke-LapsPolicyProcessing.md @@ -12,7 +12,7 @@ title: Invoke-LapsPolicyProcessing # Invoke-LapsPolicyProcessing ## SYNOPSIS -Causes Windows Local Administrator Password Solution (LAPS) to process the currently configured LAPS +Causes Windows Local Administrator Password Solution (LAPS) to process the currently configured policy. ## SYNTAX @@ -23,13 +23,12 @@ Invoke-LapsPolicyProcessing [] ## DESCRIPTION -The `Invoke-LapsPolicyProcessing` cmdlet tells Windows Local Administrator Password Solution -(LAPS) to process the currently configured LAPS policy. +The `Invoke-LapsPolicyProcessing` cmdlet tells LAPS to process the currently configured policy. The cmdlet doesn't return detailed information about the results of the operation. See -[Use Windows LAPS event logs](https://go.microsoft.com/fwlink/?linkid=2234103) for more -information on querying the resultant event log entries to get specific information on the outcome -of the operation. +[Use Windows LAPS event logs](https://go.microsoft.com/fwlink/?linkid=2234103) for more information +on querying the resultant event log entries to get specific information on the outcome of the +operation. ## EXAMPLES diff --git a/docset/winserver2022-ps/laps/LAPS.md b/docset/winserver2022-ps/laps/LAPS.md index 72c2a65358..9d4605d564 100644 --- a/docset/winserver2022-ps/laps/LAPS.md +++ b/docset/winserver2022-ps/laps/LAPS.md @@ -1,5 +1,6 @@ --- -description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. +description: This reference provides cmdlet descriptions and syntax for all Windows Local Administrator Password +Solution (LAPS) module. Module Name: LAPS Module Guid: 8eb7ddf9-7890-49ae-9af1-3b41d7e63c41 Download Help Link: https://aka.ms/winsvr-2022-pshelp @@ -14,24 +15,24 @@ title: LAPS ## Description This reference provides cmdlet descriptions and syntax for all Windows Local Administrator Password -Solution (LAPS)-specific cmdlets. It lists the cmdlets in alphabetical order. +Solution (LAPS) module. It lists the cmdlets in alphabetical order. ## LAPS Cmdlets ### [Find-LapsADExtendedRights](Find-LapsADExtendedRights.md) -Queries Active Directory to find principals that have been granted permission to read Windows Local -Administrator Password Solution (LAPS) password attributes. +Queries Active Directory (AD) to find principals that have been granted permission to read Windows +Local Administrator Password Solution (LAPS) password attributes. ### [Get-LapsAADPassword](Get-LapsAADPassword.md) -Queries Azure Active Directory for the Windows Local Administrator Password Solution (LAPS) +Queries Azure Active Directory (AAD) for the Windows Local Administrator Password Solution (LAPS) credentials on a specified Azure AD device. ### [Get-LapsADPassword](Get-LapsADPassword.md) -Queries Windows Local Administrator Password Solution (LAPS) credentials from Active Directory on a -specified AD computer or domain controller object. +Queries Windows Local Administrator Password Solution (LAPS) credentials from Active Directory (AD) +on a specified AD computer or domain controller object. ### [Get-LapsDiagnostics](Get-LapsDiagnostics.md) @@ -40,7 +41,7 @@ machine. ### [Invoke-LapsPolicyProcessing](Invoke-LapsPolicyProcessing.md) -Causes Windows Local Administrator Password Solution (LAPS) to process the currently configured LAPS +Causes Windows Local Administrator Password Solution (LAPS) to process the currently configured policy. ### [Reset-LapsPassword](Reset-LapsPassword.md) @@ -50,30 +51,31 @@ the currently managed local account. ### [Set-LapsADAuditing](Set-LapsADAuditing.md) -Configures an Active Directory Organizational Unit to enable auditing on the Windows Local +Configures an Active Directory (AD) Organizational Unit (OU) to enable auditing on the Windows Local Administrator Password Solution (LAPS) password schema attributes. ### [Set-LapsADComputerSelfPermission](Set-LapsADComputerSelfPermission.md) -Configures permissions on an Active Directory Organizational Unit to enable computers in that OU to -update their LAPS passwords. +Configures permissions on an Active Directory (AD) Organizational Unit (OU) to enable computers in +that OU to update their Windows Local Administrator Password Solution (LAPS) passwords. ### [Set-LapsADPasswordExpirationTime](Set-LapsADPasswordExpirationTime.md) Sets the Windows Local Administrator Password Solution (LAPS) password expiration timestamp on an -Active Directory computer or domain controller object. +Active Directory (AD) computer or domain controller object. ### [Set-LapsADReadPasswordPermission](Set-LapsADReadPasswordPermission.md) -Configures security on an Active Directory Organizational Unit to grant specific users or groups -permission to query Windows Local Administrator Password Solution (LAPS) passwords. +Configures security on an Active Directory (AD) Organizational Unit (OU) to grant specific users or +groups permission to query Windows Local Administrator Password Solution (LAPS) passwords. ### [Set-LapsADResetPasswordPermission](Set-LapsADResetPasswordPermission.md) -Configures security on an Active Directory Organizational Unit to grant specific users or groups -permission to set the Windows Local Administrator Password Solution (LAPS) password expiration time. +Configures security on an Active Directory (AD) Organizational Unit (OU) to grant specific users or +groups permission to set the Windows Local Administrator Password Solution (LAPS) password +expiration time. ### [Update-LapsADSchema](Update-LapsADSchema.md) -Extends the Active Directory schema with the Windows Local Administrator Password Solution (LAPS) -schema attributes. +Extends the Active Directory (AD) schema with the Windows Local Administrator Password Solution +(LAPS) schema attributes. diff --git a/docset/winserver2022-ps/laps/Reset-LapsPassword.md b/docset/winserver2022-ps/laps/Reset-LapsPassword.md index 1fc2e7ef34..65d605e3a0 100644 --- a/docset/winserver2022-ps/laps/Reset-LapsPassword.md +++ b/docset/winserver2022-ps/laps/Reset-LapsPassword.md @@ -23,10 +23,9 @@ Reset-LapsPassword [] ## DESCRIPTION -The `Reset-LapsPassword` cmdlet tells Windows Local Administrator Password Solution (LAPS) to -immediately rotate the password for the currently managed local account. This operation is performed -regardless of the state of the current password, for example it doesn't matter whether the current -password is considered expired or not. +The `Reset-LapsPassword` cmdlet tells LAPS to immediately rotate the password for the currently +managed local account. This operation is performed regardless of the state of the current password, +for example it doesn't matter whether the current password is considered expired or not. > [!IMPORTANT] > This cmdlet is intended and recommended only for rare situations that require an @@ -34,9 +33,9 @@ password is considered expired or not. > Excessively frequent usage of this cmdlet isn't recommended. The cmdlet doesn't return detailed information about the results of the operation. See -[Use Windows LAPS event logs](https://go.microsoft.com/fwlink/?linkid=2234103) for more -information on querying the resultant event log entries to get specific information on the outcome -of the operation. +[Use Windows LAPS event logs](https://go.microsoft.com/fwlink/?linkid=2234103) for more information +on querying the resultant event log entries to get specific information on the outcome of the +operation. ## EXAMPLES diff --git a/docset/winserver2022-ps/laps/Set-LapsADAuditing.md b/docset/winserver2022-ps/laps/Set-LapsADAuditing.md index 3c70ae0615..4b92621d7b 100644 --- a/docset/winserver2022-ps/laps/Set-LapsADAuditing.md +++ b/docset/winserver2022-ps/laps/Set-LapsADAuditing.md @@ -12,7 +12,7 @@ title: Set-LapsADAuditing # Set-LapsADAuditing ## SYNOPSIS -Configures an Active Directory Organizational Unit to enable auditing on the Windows Local +Configures an Active Directory (AD) Organizational Unit (OU) to enable auditing on the Windows Local Administrator Password Solution (LAPS) password schema attributes. ## SYNTAX @@ -35,7 +35,7 @@ Set-LapsADAuditing -Identity LapsTestOU -AuditedPrincipals "laps.com\LapsAdmin" OU=LapsTestOU,DC=laps,DC=com ``` -This example demonstrates configuring Success audits on an OU. +This example demonstrates configuring `Success` audits on an OU. ### Example 2 @@ -44,15 +44,15 @@ Set-LapsADAuditing -Identity LapsTestOU -AuditedPrincipals "laps.com\LapsAdminsG OU=LapsTestOU,DC=laps,DC=com ``` -This example demonstrates configuring Failure audits on an OU. +This example demonstrates configuring `Failure` audits on an OU. ## PARAMETERS ### -AuditedPrincipals -Specifies which users or groups should be configured for auditing. Users or groups may be specified -in either name or SID format. If specified in name format, the name must always include the -identifying domain name portion unless the name maps to a well-known or built-in account. +Specifies the name of the users or groups should be configured for auditing. Users or groups may be +specified in either name or SID format. If specified in name format, the name must always include +the identifying domain name portion unless the name maps to a well-known or built-in account. ```yaml Type: System.String[] @@ -85,8 +85,8 @@ Accept wildcard characters: False ### -Credential -Specifies the credentials to use when updating Active Directory. If not specified, the current -user's credentials are used. +Specifies the credentials to use when updating AD. If not specified, the current user's credentials +are used. ```yaml Type: System.Management.Automation.PSCredential @@ -102,7 +102,7 @@ Accept wildcard characters: False ### -Domain -Specifies which Active Directory domain to connect to. +Specifies the name of the domain to connect to. ```yaml Type: System.String @@ -118,7 +118,7 @@ Accept wildcard characters: False ### -DomainController -Specifies which Active Directory domain controller to connect to. +Specifies the name of the domain controller to connect to. ```yaml Type: System.String @@ -134,10 +134,10 @@ Accept wildcard characters: False ### -Identity -Specifies which Active Directory Organizational Unit to update. +Specifies the name of the OU to update. This parameter accepts several different name formats that influence the criteria used in the -resultant Active Directory search. The supported name formats are as follows: +resultant AD search. The supported name formats are as follows: - distinguishedName (begins with a `CN=`) - name (for all other inputs) diff --git a/docset/winserver2022-ps/laps/Set-LapsADComputerSelfPermission.md b/docset/winserver2022-ps/laps/Set-LapsADComputerSelfPermission.md index 2c7770cb14..e95452f787 100644 --- a/docset/winserver2022-ps/laps/Set-LapsADComputerSelfPermission.md +++ b/docset/winserver2022-ps/laps/Set-LapsADComputerSelfPermission.md @@ -12,8 +12,8 @@ title: Set-LapsADComputerSelfPermission # Set-LapsADComputerSelfPermission ## SYNOPSIS -Configures permissions on an Active Directory Organizational Unit to enable computers in that OU to -update their Windows Local Administrator Password Solution (LAPS) passwords. +Configures permissions on an Active Directory (AD) Organizational Unit (OU) to enable computers in +that OU to update their Windows Local Administrator Password Solution (LAPS) passwords. ## SYNTAX @@ -26,8 +26,7 @@ Set-LapsADComputerSelfPermission -Identity [-Domain ] ## DESCRIPTION The `Set-LapsADComputerSelfPermission` cmdlet is used by administrators to configure security -permissions on an Active Directory Organizational Unit (OU) to allow computers in that OU to update -their LAPS passwords. +permissions on an OU to allow computers in that OU to update their LAPS passwords. ## EXAMPLES @@ -49,7 +48,7 @@ This example demonstrates how to run the cmdlet. ### -Credential -Specifies the credentials to use when updating Active Directory. If not specified, the current +Specifies the credentials to use when updating AD. If not specified, the current user's credentials are used. ```yaml @@ -66,7 +65,7 @@ Accept wildcard characters: False ### -Domain -Specifies which Active Directory domain to connect to. +Specifies the name of the domain to connect to. ```yaml Type: System.String @@ -82,7 +81,7 @@ Accept wildcard characters: False ### -DomainController -Specifies which Active Directory domain controller to connect to. +Specifies the name of the domain controller to connect to. ```yaml Type: System.String @@ -98,10 +97,10 @@ Accept wildcard characters: False ### -Identity -Specifies which Active Directory Organizational Unit to update. +Specifies the name of the OU to update. This parameter accepts several different name formats that influence the criteria used in the -resultant Active Directory search. The supported name formats are as follows: +resultant AD search. The supported name formats are as follows: - distinguishedName (begins with a `CN=`) - name (for all other inputs) @@ -136,8 +135,7 @@ Accept wildcard characters: False ### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet isn't run. +Shows what would happen if the cmdlet runs. The cmdlet isn't run. ```yaml Type: System.Management.Automation.SwitchParameter diff --git a/docset/winserver2022-ps/laps/Set-LapsADPasswordExpirationTime.md b/docset/winserver2022-ps/laps/Set-LapsADPasswordExpirationTime.md index d0c1db5451..22dc59c194 100644 --- a/docset/winserver2022-ps/laps/Set-LapsADPasswordExpirationTime.md +++ b/docset/winserver2022-ps/laps/Set-LapsADPasswordExpirationTime.md @@ -13,7 +13,7 @@ title: Set-LapsADPasswordExpirationTime ## SYNOPSIS Sets the Windows Local Administrator Password Solution (LAPS) password expiration timestamp on an -Active Directory computer or domain controller object. +Active Directory (AD) computer or domain controller object. ## SYNTAX @@ -25,12 +25,12 @@ Set-LapsADPasswordExpirationTime [-Credential ] -Identity [!TIP] -> Running this cmdlet sets the LAPS password expiration time on the Active Directory computer or -> domain controller object, but the new expiration time isn't honored until the next time the target -> device executes a LAPS policy processing cycle. +> Running this cmdlet sets the LAPS password expiration time on the AD computer or domain controller +> object, but the new expiration time isn't honored until the next time the target device executes a +> LAPS policy processing cycle. ## EXAMPLES @@ -81,8 +81,8 @@ This examples show setting the LAPS password expiration time to one day in the f ### -Credential -Specifies the credentials to use when updating Active Directory. If not specified, the current -user's credentials are used. +Specifies the credentials to use when updating AD. If not specified, the current user's credentials +are used. ```yaml Type: System.Management.Automation.PSCredential @@ -98,7 +98,7 @@ Accept wildcard characters: False ### -Domain -Specifies which Active Directory domain to connect to. +Specifies the name of the domain to connect to. ```yaml Type: System.String @@ -114,7 +114,7 @@ Accept wildcard characters: False ### -DomainController -Specifies which Active Directory domain controller to connect to. +Specifies the name of the domain controller to connect to. ```yaml Type: System.String @@ -130,11 +130,11 @@ Accept wildcard characters: False ### -Identity -Specifies which Active Directory computer or domain controller object to set the LAPS password -expiration time on. +Specifies the name of the computer or domain controller object to set the LAPS password expiration +time on. This parameter accepts several different name formats that influence the criteria used when -searching Active Directory for the target device. The supported name formats are as follows: +searching AD for the target device. The supported name formats are as follows: - distinguishedName (begins with a `CN=`) - samAccountName (begins with a `$`) diff --git a/docset/winserver2022-ps/laps/Set-LapsADReadPasswordPermission.md b/docset/winserver2022-ps/laps/Set-LapsADReadPasswordPermission.md index 24501ed5bd..99456a051e 100644 --- a/docset/winserver2022-ps/laps/Set-LapsADReadPasswordPermission.md +++ b/docset/winserver2022-ps/laps/Set-LapsADReadPasswordPermission.md @@ -12,8 +12,8 @@ title: Set-LapsADReadPasswordPermission # Set-LapsADReadPasswordPermission ## SYNOPSIS -Configures security on an Active Directory Organizational Unit to grant specific users or groups -permission to query Windows Local Administrator Password Solution (LAPS) passwords. +Configures security on an Active Directory (AD) Organizational Unit (OU) to grant specific users or +groups permission to query Windows Local Administrator Password Solution (LAPS) passwords. ## SYNTAX @@ -26,10 +26,10 @@ Set-LapsADReadPasswordPermission [-Credential ] -Identity ] [-WhatIf] [-Confirm] [ Date: Sat, 15 Apr 2023 14:52:53 -0500 Subject: [PATCH 108/650] Update description metadata - Descriptions should be unique - This improves SEO --- docset/winserver2022-ps/laps/Find-LapsADExtendedRights.md | 2 +- docset/winserver2022-ps/laps/Get-LapsAADPassword.md | 2 +- docset/winserver2022-ps/laps/Get-LapsADPassword.md | 2 +- docset/winserver2022-ps/laps/Get-LapsDiagnostics.md | 2 +- docset/winserver2022-ps/laps/Invoke-LapsPolicyProcessing.md | 2 +- docset/winserver2022-ps/laps/Reset-LapsPassword.md | 2 +- docset/winserver2022-ps/laps/Set-LapsADAuditing.md | 2 +- .../winserver2022-ps/laps/Set-LapsADComputerSelfPermission.md | 2 +- .../winserver2022-ps/laps/Set-LapsADPasswordExpirationTime.md | 2 +- .../winserver2022-ps/laps/Set-LapsADReadPasswordPermission.md | 2 +- .../winserver2022-ps/laps/Set-LapsADResetPasswordPermission.md | 2 +- docset/winserver2022-ps/laps/Update-LapsADSchema.md | 3 ++- 12 files changed, 13 insertions(+), 12 deletions(-) diff --git a/docset/winserver2022-ps/laps/Find-LapsADExtendedRights.md b/docset/winserver2022-ps/laps/Find-LapsADExtendedRights.md index c9d82f5e65..0df4fb363d 100644 --- a/docset/winserver2022-ps/laps/Find-LapsADExtendedRights.md +++ b/docset/winserver2022-ps/laps/Find-LapsADExtendedRights.md @@ -1,5 +1,5 @@ --- -description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. +description: Queries Active Directory (AD) to find principals that have been granted permission to read Windows Local Administrator Password Solution (LAPS) password attributes. external help file: lapspsh.dll-Help.xml Module Name: LAPS online version: https://learn.microsoft.com/powershell/module/laps/find-lapsadextendedrights?view=windowsserver2022-ps&wt.mc_id=ps-gethelp diff --git a/docset/winserver2022-ps/laps/Get-LapsAADPassword.md b/docset/winserver2022-ps/laps/Get-LapsAADPassword.md index ddd9c16d1c..5bad16447c 100644 --- a/docset/winserver2022-ps/laps/Get-LapsAADPassword.md +++ b/docset/winserver2022-ps/laps/Get-LapsAADPassword.md @@ -1,5 +1,5 @@ --- -description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. +description: Queries Azure Active Directory (AAD) for the Windows Local Administrator Password Solution (LAPS) credentials on a specified Azure AD device. external help file: LAPS-help.xml Module Name: LAPS online version: https://learn.microsoft.com/powershell/module/laps/get-lapsaadpassword?view=windowsserver2022-ps&wt.mc_id=ps-gethelp diff --git a/docset/winserver2022-ps/laps/Get-LapsADPassword.md b/docset/winserver2022-ps/laps/Get-LapsADPassword.md index 1446e1132e..007a82beb3 100644 --- a/docset/winserver2022-ps/laps/Get-LapsADPassword.md +++ b/docset/winserver2022-ps/laps/Get-LapsADPassword.md @@ -1,5 +1,5 @@ --- -description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. +description: Queries Windows Local Administrator Password Solution (LAPS) credentials from Active Directory (AD) on a specified AD computer or domain controller object. external help file: lapspsh.dll-Help.xml Module Name: LAPS online version: https://learn.microsoft.com/powershell/module/laps/get-lapsadpassword?view=windowsserver2022-ps&wt.mc_id=ps-gethelp diff --git a/docset/winserver2022-ps/laps/Get-LapsDiagnostics.md b/docset/winserver2022-ps/laps/Get-LapsDiagnostics.md index 5bb0ad8332..2ee760b3e9 100644 --- a/docset/winserver2022-ps/laps/Get-LapsDiagnostics.md +++ b/docset/winserver2022-ps/laps/Get-LapsDiagnostics.md @@ -1,5 +1,5 @@ --- -description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. +description: Collects Windows Local Administrator Password Solution (LAPS) logs and tracing from the local machine. external help file: LAPS-help.xml Module Name: LAPS online version: https://learn.microsoft.com/powershell/module/laps/get-lapsdiagnostics?view=windowsserver2022-ps&wt.mc_id=ps-gethelp diff --git a/docset/winserver2022-ps/laps/Invoke-LapsPolicyProcessing.md b/docset/winserver2022-ps/laps/Invoke-LapsPolicyProcessing.md index ca931a1bd3..01655b4a8c 100644 --- a/docset/winserver2022-ps/laps/Invoke-LapsPolicyProcessing.md +++ b/docset/winserver2022-ps/laps/Invoke-LapsPolicyProcessing.md @@ -1,5 +1,5 @@ --- -description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. +description: Causes Windows Local Administrator Password Solution (LAPS) to process the currently configured policy. external help file: lapspsh.dll-Help.xml Module Name: LAPS online version: https://learn.microsoft.com/powershell/module/laps/invoke-lapspolicyprocessing?view=windowsserver2022-ps&wt.mc_id=ps-gethelp diff --git a/docset/winserver2022-ps/laps/Reset-LapsPassword.md b/docset/winserver2022-ps/laps/Reset-LapsPassword.md index 65d605e3a0..dbc005ee7e 100644 --- a/docset/winserver2022-ps/laps/Reset-LapsPassword.md +++ b/docset/winserver2022-ps/laps/Reset-LapsPassword.md @@ -1,5 +1,5 @@ --- -description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. +description: Causes Windows Local Administrator Password Solution (LAPS) to immediately rotate the password for the currently managed local account. external help file: lapspsh.dll-Help.xml Module Name: LAPS online version: https://learn.microsoft.com/powershell/module/laps/reset-lapspassword?view=windowsserver2022-ps&wt.mc_id=ps-gethelp diff --git a/docset/winserver2022-ps/laps/Set-LapsADAuditing.md b/docset/winserver2022-ps/laps/Set-LapsADAuditing.md index 4b92621d7b..bdee473f46 100644 --- a/docset/winserver2022-ps/laps/Set-LapsADAuditing.md +++ b/docset/winserver2022-ps/laps/Set-LapsADAuditing.md @@ -1,5 +1,5 @@ --- -description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. +description: Configures an Active Directory (AD) Organizational Unit (OU) to enable auditing on the Windows Local Administrator Password Solution (LAPS) password schema attributes. external help file: lapspsh.dll-Help.xml Module Name: LAPS online version: https://learn.microsoft.com/powershell/module/laps/set-lapsadauditing?view=windowsserver2022-ps&wt.mc_id=ps-gethelp diff --git a/docset/winserver2022-ps/laps/Set-LapsADComputerSelfPermission.md b/docset/winserver2022-ps/laps/Set-LapsADComputerSelfPermission.md index e95452f787..4539be98c8 100644 --- a/docset/winserver2022-ps/laps/Set-LapsADComputerSelfPermission.md +++ b/docset/winserver2022-ps/laps/Set-LapsADComputerSelfPermission.md @@ -1,5 +1,5 @@ --- -description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. +description: Configures permissions on an Active Directory (AD) Organizational Unit (OU) to enable computers in that OU to update their Windows Local Administrator Password Solution (LAPS) passwords. external help file: lapspsh.dll-Help.xml Module Name: LAPS online version: https://learn.microsoft.com/powershell/module/laps/set-lapsadcomputerselfpermission?view=windowsserver2022-ps&wt.mc_id=ps-gethelp diff --git a/docset/winserver2022-ps/laps/Set-LapsADPasswordExpirationTime.md b/docset/winserver2022-ps/laps/Set-LapsADPasswordExpirationTime.md index 22dc59c194..097e5cef19 100644 --- a/docset/winserver2022-ps/laps/Set-LapsADPasswordExpirationTime.md +++ b/docset/winserver2022-ps/laps/Set-LapsADPasswordExpirationTime.md @@ -1,5 +1,5 @@ --- -description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. +description: Sets the Windows Local Administrator Password Solution (LAPS) password expiration timestamp on an Active Directory (AD) computer or domain controller object. external help file: lapspsh.dll-Help.xml Module Name: LAPS online version: https://learn.microsoft.com/powershell/module/laps/set-lapsadpasswordexpirationtime?view=windowsserver2022-ps&wt.mc_id=ps-gethelp diff --git a/docset/winserver2022-ps/laps/Set-LapsADReadPasswordPermission.md b/docset/winserver2022-ps/laps/Set-LapsADReadPasswordPermission.md index 99456a051e..50971ab84e 100644 --- a/docset/winserver2022-ps/laps/Set-LapsADReadPasswordPermission.md +++ b/docset/winserver2022-ps/laps/Set-LapsADReadPasswordPermission.md @@ -1,5 +1,5 @@ --- -description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. +description: Configures security on an Active Directory (AD) Organizational Unit (OU) to grant specific users or groups permission to query Windows Local Administrator Password Solution (LAPS) passwords. external help file: lapspsh.dll-Help.xml Module Name: LAPS online version: https://learn.microsoft.com/powershell/module/laps/set-lapsadreadpasswordpermission?view=windowsserver2022-ps&wt.mc_id=ps-gethelp diff --git a/docset/winserver2022-ps/laps/Set-LapsADResetPasswordPermission.md b/docset/winserver2022-ps/laps/Set-LapsADResetPasswordPermission.md index 304566803e..eae1ea4a3a 100644 --- a/docset/winserver2022-ps/laps/Set-LapsADResetPasswordPermission.md +++ b/docset/winserver2022-ps/laps/Set-LapsADResetPasswordPermission.md @@ -1,5 +1,5 @@ --- -description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. +description: Configures security on an Active Directory (AD) Organizational Unit (OU) to grant specific users or groups permission to set the Windows Local Administrator Password Solution (LAPS) password expiration time. external help file: lapspsh.dll-Help.xml Module Name: LAPS online version: https://learn.microsoft.com/powershell/module/laps/set-lapsadresetpasswordpermission?view=windowsserver2022-ps&wt.mc_id=ps-gethelp diff --git a/docset/winserver2022-ps/laps/Update-LapsADSchema.md b/docset/winserver2022-ps/laps/Update-LapsADSchema.md index 7b0c96b558..533f7dc0ea 100644 --- a/docset/winserver2022-ps/laps/Update-LapsADSchema.md +++ b/docset/winserver2022-ps/laps/Update-LapsADSchema.md @@ -1,5 +1,6 @@ --- -description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. +description: Extends the Active Directory (AD) schema with the Windows Local Administrator Password Solution +(LAPS) schema attributes. external help file: lapspsh.dll-Help.xml Module Name: LAPS online version: https://learn.microsoft.com/powershell/module/laps/update-lapsadschema?view=windowsserver2022-ps&wt.mc_id=ps-gethelp From d806c78afe84a472a1d6203f2d4b65b61550fb9c Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Sun, 16 Apr 2023 05:48:12 +0530 Subject: [PATCH 109/650] Update docset/winserver2022-ps/defender/Set-MpPreference.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- docset/winserver2022-ps/defender/Set-MpPreference.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/defender/Set-MpPreference.md b/docset/winserver2022-ps/defender/Set-MpPreference.md index 85a0dc8c4d..d6f791808f 100644 --- a/docset/winserver2022-ps/defender/Set-MpPreference.md +++ b/docset/winserver2022-ps/defender/Set-MpPreference.md @@ -148,7 +148,7 @@ Accept wildcard characters: False ### -AllowSwitchToAsyncInspection -Specifies whether to enable a performance optimization that allows synchronously inspected network flows to switch to async inspection once they've been checked and validated. +Specifies whether to enable a performance optimization that allows synchronously inspected network flows to switch to async inspection once they have been checked and validated. ```yaml Type: Boolean From 7713ff6f2ba1ecaf6aa7d317e4a088aac32abb2d Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Sun, 16 Apr 2023 05:48:23 +0530 Subject: [PATCH 110/650] Update docset/winserver2016-ps/defender/Set-MpPreference.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- docset/winserver2016-ps/defender/Set-MpPreference.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2016-ps/defender/Set-MpPreference.md b/docset/winserver2016-ps/defender/Set-MpPreference.md index 5d60ca8509..a30d61400d 100644 --- a/docset/winserver2016-ps/defender/Set-MpPreference.md +++ b/docset/winserver2016-ps/defender/Set-MpPreference.md @@ -104,7 +104,7 @@ Accept wildcard characters: False ### -AllowSwitchToAsyncInspection -Specifies whether to enable a performance optimization that allows synchronously inspected network flows to switch to async inspection once they've been checked and validated. +Specifies whether to enable a performance optimization that allows synchronously inspected network flows to switch to async inspection once they have been checked and validated. ```yaml Type: Boolean From c7b1206eab968a6cd07693203a50388af8553699 Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Sun, 16 Apr 2023 05:48:53 +0530 Subject: [PATCH 111/650] Update docset/winserver2019-ps/defender/Set-MpPreference.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- docset/winserver2019-ps/defender/Set-MpPreference.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2019-ps/defender/Set-MpPreference.md b/docset/winserver2019-ps/defender/Set-MpPreference.md index 277a3efca6..f7d5841ce0 100644 --- a/docset/winserver2019-ps/defender/Set-MpPreference.md +++ b/docset/winserver2019-ps/defender/Set-MpPreference.md @@ -87,7 +87,7 @@ This command configures preferences to check for definition updates 120 minutes ### -AllowSwitchToAsyncInspection -Specifies whether to enable a performance optimization that allows synchronously inspected network flows to switch to async inspection once they've been checked and validated. +Specifies whether to enable a performance optimization that allows synchronously inspected network flows to switch to async inspection once they have been checked and validated. ```yaml Type: Boolean From 99037ca0e761a2b9b63786b8d9b49542938ed540 Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Sun, 16 Apr 2023 05:49:19 +0530 Subject: [PATCH 112/650] Update docset/winserver2022-ps/defender/Set-MpPreference.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- docset/winserver2022-ps/defender/Set-MpPreference.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/defender/Set-MpPreference.md b/docset/winserver2022-ps/defender/Set-MpPreference.md index 2656182bd5..1c936f9d41 100644 --- a/docset/winserver2022-ps/defender/Set-MpPreference.md +++ b/docset/winserver2022-ps/defender/Set-MpPreference.md @@ -220,7 +220,7 @@ Accept wildcard characters: False Indicates whether to check for new virus and spyware definitions before Windows Defender runs a scan. If you specify a value of $True, Windows Defender checks for new definitions. If you specify $False or don't specify a value, the scan begins with existing definitions. -This setting applies to scheduled scans, but it has no effect on scans initiated manually from the user interface or to the ones started from the command line using "mpcmdrun -Scan" +This setting applies to scheduled scans, but it has no effect on scans initiated manually from the user interface or on scans started from the command line using "mpcmdrun -Scan" ```yaml Type: Boolean From 7279398c96bfe85dcd65bb1d75c940fde962a512 Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Sun, 16 Apr 2023 05:49:33 +0530 Subject: [PATCH 113/650] Update docset/winserver2016-ps/defender/Set-MpPreference.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- docset/winserver2016-ps/defender/Set-MpPreference.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2016-ps/defender/Set-MpPreference.md b/docset/winserver2016-ps/defender/Set-MpPreference.md index 76f27dd2ab..df9caeeca9 100644 --- a/docset/winserver2016-ps/defender/Set-MpPreference.md +++ b/docset/winserver2016-ps/defender/Set-MpPreference.md @@ -106,7 +106,7 @@ Accept wildcard characters: False Indicates whether to check for new virus and spyware definitions before Windows Defender runs a scan. If you specify a value of $True, Windows Defender checks for new definitions. If you specify $False or don't specify a value, the scan begins with existing definitions. -This setting applies to scheduled scans, but it has no effect on scans initiated manually from the user interface or to the ones started from the command line using "mpcmdrun -Scan" +This setting applies to scheduled scans, but it has no effect on scans initiated manually from the user interface or on scans started from the command line using "mpcmdrun -Scan" ```yaml Type: Boolean From 78f1bade7475ad631eeea63badb51d4a4197e652 Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Sun, 16 Apr 2023 05:49:48 +0530 Subject: [PATCH 114/650] Update docset/winserver2019-ps/defender/Set-MpPreference.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- docset/winserver2019-ps/defender/Set-MpPreference.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2019-ps/defender/Set-MpPreference.md b/docset/winserver2019-ps/defender/Set-MpPreference.md index 3e47d7bbec..d9910b2313 100644 --- a/docset/winserver2019-ps/defender/Set-MpPreference.md +++ b/docset/winserver2019-ps/defender/Set-MpPreference.md @@ -114,7 +114,7 @@ Accept wildcard characters: False Indicates whether to check for new virus and spyware definitions before Windows Defender runs a scan. If you specify a value of `$True`, Windows Defender checks for new definitions. If you specify `$False` or don’t specify a value, the scan begins with existing definitions. -This setting applies to scheduled scans, but it has no effect on scans initiated manually from the user interface or to the ones started from the command line using "mpcmdrun -Scan" +This setting applies to scheduled scans, but it has no effect on scans initiated manually from the user interface or on scans started from the command line using "mpcmdrun -Scan" ```yaml Type: Boolean From c1198ae5cb3604d0da6833c5653a16621d07ab36 Mon Sep 17 00:00:00 2001 From: Jay Simmons Date: Sun, 16 Apr 2023 04:52:12 -0700 Subject: [PATCH 115/650] Minor fixes on top of previous edits. --- .../winserver2022-ps/laps/Get-LapsAADPassword.md | 7 +++---- docset/winserver2022-ps/laps/Get-LapsADPassword.md | 14 +++++++------- docset/winserver2022-ps/laps/LAPS.md | 2 +- .../winserver2022-ps/laps/Update-LapsADSchema.md | 2 +- 4 files changed, 12 insertions(+), 13 deletions(-) diff --git a/docset/winserver2022-ps/laps/Get-LapsAADPassword.md b/docset/winserver2022-ps/laps/Get-LapsAADPassword.md index 5bad16447c..5cffde76a8 100644 --- a/docset/winserver2022-ps/laps/Get-LapsAADPassword.md +++ b/docset/winserver2022-ps/laps/Get-LapsAADPassword.md @@ -51,12 +51,11 @@ device, the `DeviceManagementManagedDevices.Read.All` permission may also be req > [!IMPORTANT] > The `Get-LapsAADPassword` cmdlet is implemented as a wrapper around the Microsoft Graph PowerShell > library, which must be manually installed on the device before `Get-LapsAADPassword` can work. -> Additional configuration steps are required in your AAD tenant to enable -> authentication to Microsoft Graph and to grant the necessary Microsoft Graph permissions. For more -> information, see +> Additional configuration steps are required in your AAD tenant to enable authentication to +> Microsoft Graph and to grant the necessary Microsoft Graph permissions. For more information, see > [Get started with Windows LAPS and Azure Active Directory](https://go.microsoft.com/fwlink/?linkid=2233704) -The **Verbose** may be used to get additional information about the cmdlet's operation. +The **Verbose** parameter may be used to get additional information about the cmdlet's operation. ## EXAMPLES diff --git a/docset/winserver2022-ps/laps/Get-LapsADPassword.md b/docset/winserver2022-ps/laps/Get-LapsADPassword.md index 007a82beb3..bd66614048 100644 --- a/docset/winserver2022-ps/laps/Get-LapsADPassword.md +++ b/docset/winserver2022-ps/laps/Get-LapsADPassword.md @@ -68,10 +68,10 @@ history for an Active Directory computer or domain controller object. Depending configuration, LAPS passwords may be stored in either clear-text form or encrypted form. The `Get-LapsADPassword` cmdlet automatically decrypts encrypted passwords. -The `Get-LapsADPassword` cmdlet may also be used to connected to a mounted AD +The `Get-LapsADPassword` cmdlet may also be used to connect to a mounted AD snapshot. -The **Verbose** may be used to get additional information about the cmdlet's operation. +The **Verbose** parameter may be used to get additional information about the cmdlet's operation. ## EXAMPLES @@ -181,7 +181,7 @@ AD in encrypted form and was successfully decrypted. ### Example 5 ```powershell -Get-LapsADPassword LAPSCLIENT2 +Get-LapsADPassword LAPSDC ``` ```Output @@ -196,13 +196,13 @@ DecryptionStatus : Unauthorized AuthorizedDecryptor : LAPS\Domain Admins ``` -This example demonstrates querying the current LAPS password for the `lapsDC` domain controller when +This example demonstrates querying the current LAPS password for the `LAPSDC` domain controller when the user doesn't have permissions to decrypt the LAPS DSRM password. ### Example 6 ```powershell -Get-LapsADPassword lapsLegacyClient -AsPlainText +Get-LapsADPassword LAPSLEGACYCLIENT -AsPlainText ``` ```Output @@ -217,7 +217,7 @@ DecryptionStatus : NotApplicable AuthorizedDecryptor : NotApplicable ``` -This example demonstrates querying the current LAPS password for the 'lapsLegacyClient' machine +This example demonstrates querying the current LAPS password for the 'LAPSLEGACYCLIENT' machine which is currently running in legacy LAPS emulation mode. > [!NOTE] @@ -391,7 +391,7 @@ Accept wildcard characters: False ### -Port -Specifies the name of the AD Snapshot Browser port to connect to. +Specifies the AD Snapshot Browser port to connect to. ```yaml Type: System.Nullable`1[System.Int32] diff --git a/docset/winserver2022-ps/laps/LAPS.md b/docset/winserver2022-ps/laps/LAPS.md index 9d4605d564..55d22549f6 100644 --- a/docset/winserver2022-ps/laps/LAPS.md +++ b/docset/winserver2022-ps/laps/LAPS.md @@ -14,7 +14,7 @@ title: LAPS ## Description -This reference provides cmdlet descriptions and syntax for all Windows Local Administrator Password +This reference provides cmdlet descriptions and syntax for the Windows Local Administrator Password Solution (LAPS) module. It lists the cmdlets in alphabetical order. ## LAPS Cmdlets diff --git a/docset/winserver2022-ps/laps/Update-LapsADSchema.md b/docset/winserver2022-ps/laps/Update-LapsADSchema.md index 533f7dc0ea..15daffa46f 100644 --- a/docset/winserver2022-ps/laps/Update-LapsADSchema.md +++ b/docset/winserver2022-ps/laps/Update-LapsADSchema.md @@ -28,7 +28,7 @@ The `Update-LapsADSchema` cmdlet extends the AD schema with the LAPS schema attr nature of the schema extensions is documented in [Windows LAPS schema extensions reference](https://go.microsoft.com/fwlink/?linkid=2233804). -The **Verbose** may be used to get additional information about the cmdlet's operation. +The **Verbose** parameter may be used to get additional information about the cmdlet's operation. ## EXAMPLES From 0c20452ccb5f8cb0b3982f670f2abd6b423eee07 Mon Sep 17 00:00:00 2001 From: Jay Simmons Date: Sun, 16 Apr 2023 05:12:39 -0700 Subject: [PATCH 116/650] Remove "Welcome to MS Graph" from output examples since this spew may or may not be present in actual operation. --- docset/winserver2022-ps/laps/Get-LapsAADPassword.md | 8 -------- 1 file changed, 8 deletions(-) diff --git a/docset/winserver2022-ps/laps/Get-LapsAADPassword.md b/docset/winserver2022-ps/laps/Get-LapsAADPassword.md index 5cffde76a8..dbe3857fd4 100644 --- a/docset/winserver2022-ps/laps/Get-LapsAADPassword.md +++ b/docset/winserver2022-ps/laps/Get-LapsAADPassword.md @@ -67,8 +67,6 @@ Get-LapsAADPassword -DeviceIds LAPSAAD ``` ```Output -Welcome To Microsoft Graph! - DeviceName DeviceId PasswordExpirationTime ---------- -------- ---------------------- LAPSAAD dfc6d5f0-225a-4b46-adcf-73a349a31e70 4/22/2023 8:45:29 AM @@ -85,8 +83,6 @@ Get-LapsAADPassword -DeviceIds dfc6d5f0-225a-4b46-adcf-73a349a31e70 -IncludePass ``` ```Output -Welcome To Microsoft Graph! - DeviceName : LAPSAAD DeviceId : dfc6d5f0-225a-4b46-adcf-73a349a31e70 Account : LapsAdmin @@ -106,8 +102,6 @@ Get-LapsAADPassword -DeviceIds dfc6d5f0-225a-4b46-adcf-73a349a31e70 -IncludePass ``` ```Output -Welcome To Microsoft Graph! - DeviceName : LAPSAAD DeviceId : dfc6d5f0-225a-4b46-adcf-73a349a31e70 Account : LapsAdmin @@ -127,8 +121,6 @@ Get-LapsAADPassword -DeviceIds lapsAAD -IncludePasswords -AsPlainText -IncludeHi ``` ```Output -Welcome To Microsoft Graph! - DeviceName : LAPSAAD DeviceId : dfc6d5f0-225a-4b46-adcf-73a349a31e70 Account : LapsAdmin From c2c4039d1ba6144e5d3ed53dc7073e80641a6982 Mon Sep 17 00:00:00 2001 From: Jay Simmons Date: Sun, 16 Apr 2023 05:24:02 -0700 Subject: [PATCH 117/650] Clone new LAPS PSH content into the winserver2019-ps/laps folder and fixup "online version" links to match. --- .../laps/Find-LapsADExtendedRights.md | 154 ++++++ .../laps/Get-LapsAADPassword.md | 243 ++++++++++ .../laps/Get-LapsADPassword.md | 451 ++++++++++++++++++ .../laps/Get-LapsDiagnostics.md | 167 +++++++ .../laps/Invoke-LapsPolicyProcessing.md | 64 +++ docset/winserver2019-ps/laps/LAPS.md | 81 ++++ .../laps/Reset-LapsPassword.md | 71 +++ .../laps/Set-LapsADAuditing.md | 208 ++++++++ .../laps/Set-LapsADComputerSelfPermission.md | 171 +++++++ .../laps/Set-LapsADPasswordExpirationTime.md | 192 ++++++++ .../laps/Set-LapsADReadPasswordPermission.md | 243 ++++++++++ .../laps/Set-LapsADResetPasswordPermission.md | 244 ++++++++++ .../laps/Update-LapsADSchema.md | 121 +++++ docset/winserver2022-ps/laps/LAPS.md | 2 +- 14 files changed, 2411 insertions(+), 1 deletion(-) create mode 100644 docset/winserver2019-ps/laps/Find-LapsADExtendedRights.md create mode 100644 docset/winserver2019-ps/laps/Get-LapsAADPassword.md create mode 100644 docset/winserver2019-ps/laps/Get-LapsADPassword.md create mode 100644 docset/winserver2019-ps/laps/Get-LapsDiagnostics.md create mode 100644 docset/winserver2019-ps/laps/Invoke-LapsPolicyProcessing.md create mode 100644 docset/winserver2019-ps/laps/LAPS.md create mode 100644 docset/winserver2019-ps/laps/Reset-LapsPassword.md create mode 100644 docset/winserver2019-ps/laps/Set-LapsADAuditing.md create mode 100644 docset/winserver2019-ps/laps/Set-LapsADComputerSelfPermission.md create mode 100644 docset/winserver2019-ps/laps/Set-LapsADPasswordExpirationTime.md create mode 100644 docset/winserver2019-ps/laps/Set-LapsADReadPasswordPermission.md create mode 100644 docset/winserver2019-ps/laps/Set-LapsADResetPasswordPermission.md create mode 100644 docset/winserver2019-ps/laps/Update-LapsADSchema.md diff --git a/docset/winserver2019-ps/laps/Find-LapsADExtendedRights.md b/docset/winserver2019-ps/laps/Find-LapsADExtendedRights.md new file mode 100644 index 0000000000..b18a92a38f --- /dev/null +++ b/docset/winserver2019-ps/laps/Find-LapsADExtendedRights.md @@ -0,0 +1,154 @@ +--- +description: Queries Active Directory (AD) to find principals that have been granted permission to read Windows Local Administrator Password Solution (LAPS) password attributes. +external help file: lapspsh.dll-Help.xml +Module Name: LAPS +online version: https://learn.microsoft.com/powershell/module/laps/find-lapsadextendedrights?view=windowsserver2019-ps&wt.mc_id=ps-gethelp +schema: 2.0.0 +Locale: en-US +ms.date: 04/10/2023 +title: Find-LapsADExtendedRights +--- + +# Find-LapsADExtendedRights + +## SYNOPSIS +Queries Active Directory (AD) to find principals that have been granted permission to read Windows +Local Administrator Password Solution (LAPS) password attributes. + +## SYNTAX + +``` +Find-LapsADExtendedRights [-Credential ] -Identity [-Domain ] + [-DomainController ] [-IncludeComputers] [] +``` + +## DESCRIPTION + +The `Find-LapsADExtendedRights` cmdlet is used by administrators to query which principals have +been granted permissions to read the LAPS password attributes. + +## EXAMPLES + +### Example 1 + +```powershell +Find-LapsADExtendedRights -Identity LapsTestOU +``` + +```Output +ObjectDN ExtendedRightHolders +-------- -------------------- +OU=LapsTestOU,DC=laps,DC=com {NT AUTHORITY\SYSTEM, LAPS\Domain Admins, LAPS\LapsAdmins} +``` + +This example shows how to run the cmdlet. + +## PARAMETERS + +### -Credential + +Specifies the credentials to use when updating AD. If not specified, the current +user's credentials are used. + +```yaml +Type: System.Management.Automation.PSCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Domain + +Specifies the name of the domain to connect to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController + +Specifies the name of the domain controller to connect to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +Specifies the name of the OU to query. + +This parameter accepts several different name formats that influence the criteria used in the +resultant AD search. The supported name formats are as follows: + +- distinguishedName (begins with a `CN=`) +- name (for all other inputs) + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -IncludeComputers + +Specify this parameter to also check computer objects for the permissions. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, +-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, +-WarningAction, and -WarningVariable. For more information, see +[about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String[] + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Windows LAPS Overview](https://go.microsoft.com/fwlink/?linkid=2233901) diff --git a/docset/winserver2019-ps/laps/Get-LapsAADPassword.md b/docset/winserver2019-ps/laps/Get-LapsAADPassword.md new file mode 100644 index 0000000000..480ba0bc76 --- /dev/null +++ b/docset/winserver2019-ps/laps/Get-LapsAADPassword.md @@ -0,0 +1,243 @@ +--- +description: Queries Azure Active Directory (AAD) for the Windows Local Administrator Password Solution (LAPS) credentials on a specified Azure AD device. +external help file: LAPS-help.xml +Module Name: LAPS +online version: https://learn.microsoft.com/powershell/module/laps/get-lapsaadpassword?view=windowsserver2019-ps&wt.mc_id=ps-gethelp +schema: 2.0.0 +Locale: en-US +ms.date: 04/10/2023 +title: Get-LapsAADPassword +--- + +# Get-LapsAADPassword + +## SYNOPSIS +Queries Azure Active Directory (AAD) for the Windows Local Administrator Password Solution (LAPS) +credentials on a specified Azure AD device. + +## SYNTAX + +``` +Get-LapsAADPassword -DeviceIds [-IncludePasswords] [-IncludeHistory] [-AsPlainText] + [] +``` + +## DESCRIPTION + +The `Get-LapsAADPassword` cmdlet allows administrators to retrieve LAPS passwords and password +history for an AAD-joined device. This is implemented by sending queries to Microsoft Graph over the +deviceLocalCredentials collection. + +The `Get-LapsAADPassword` cmdlet supports two basic modes when querying LAPS passwords: + +The first mode queries for non-sensitive metadata, for example time the password was backed up to +Azure and the expected expiration time of a password. This mode requires that the client be granted +the Microsoft Graph `DeviceLocalCredential.ReadBasic.All` permission. + +The second mode queries for all password information including both the metadata information +described above and the clear-text form of the password(s). This mode requires that the client be +granted the Microsoft Graph `DeviceLocalCredential.Read.All` permission. + +The **DeviceIds** parameter accepts either device names or device IDs, but the underlying Microsoft +Graph queries only supports querying by device ID. To support this query, the cmdlet maps a device +name input to its corresponding device ID by issuing a separate Microsoft Graph query. This extra +query requires the `Device.Read.All` permission. If the target is a Microsoft Managed Desktop +device, the `DeviceManagementManagedDevices.Read.All` permission may also be required. + +> [!TIP] +> If there are multiple devices in the tenant with the same name, the cmdlet fails. The workaround +> is to input the device ID directly. + +> [!IMPORTANT] +> The `Get-LapsAADPassword` cmdlet is implemented as a wrapper around the Microsoft Graph PowerShell +> library, which must be manually installed on the device before `Get-LapsAADPassword` can work. +> Additional configuration steps are required in your AAD tenant to enable authentication to +> Microsoft Graph and to grant the necessary Microsoft Graph permissions. For more information, see +> [Get started with Windows LAPS and Azure Active Directory](https://go.microsoft.com/fwlink/?linkid=2233704) + +The **Verbose** parameter may be used to get additional information about the cmdlet's operation. + +## EXAMPLES + +### Example 1 + +```powershell +Connect-MgGraph -TenantId b20f5886-bddf-43bb-aee6-dda0c87c5fa2 -ClientId 9fa98e34-277f-47fa-9847-e36bdf6bca1f +Get-LapsAADPassword -DeviceIds LAPSAAD +``` + +```Output +DeviceName DeviceId PasswordExpirationTime +---------- -------- ---------------------- +LAPSAAD dfc6d5f0-225a-4b46-adcf-73a349a31e70 4/22/2023 8:45:29 AM +``` + +This example shows how to query basic LAPS password metadata information for the target device that +is specified by device name. + +### Example 2 + +```powershell +Connect-MgGraph -TenantId b20f5886-bddf-43bb-aee6-dda0c87c5fa2 -ClientId 9fa98e34-277f-47fa-9847-e36bdf6bca1f +Get-LapsAADPassword -DeviceIds dfc6d5f0-225a-4b46-adcf-73a349a31e70 -IncludePasswords +``` + +```Output +DeviceName : LAPSAAD +DeviceId : dfc6d5f0-225a-4b46-adcf-73a349a31e70 +Account : LapsAdmin +Password : System.Security.SecureString +PasswordExpirationTime : 4/22/2023 8:45:29 AM +PasswordUpdateTime : 4/11/2023 8:45:29 AM +``` + +This example shows how to query the full LAPS password information for the target device that is +specified by device ID. + +### Example 3 + +```powershell +Connect-MgGraph -TenantId b20f5886-bddf-43bb-aee6-dda0c87c5fa2 -ClientId 9fa98e34-277f-47fa-9847-e36bdf6bca1f +Get-LapsAADPassword -DeviceIds dfc6d5f0-225a-4b46-adcf-73a349a31e70 -IncludePasswords -AsPlainText +``` + +```Output +DeviceName : LAPSAAD +DeviceId : dfc6d5f0-225a-4b46-adcf-73a349a31e70 +Account : LapsAdmin +Password : g4q22s[Xz8}!T32[4;Z#0M}v35udF[xB0}iB;P@xk%9E9Tgw,W]7)vx9O!- +PasswordExpirationTime : 4/22/2023 8:45:29 AM +PasswordUpdateTime : 4/11/2023 8:45:29 AM +``` + +This example shows how to query the full LAPS password information for the target device that is +specified by device ID, and displaying the password in clear-text form. + +### Example 4 + +```powershell +Connect-MgGraph -TenantId b20f5886-bddf-43bb-aee6-dda0c87c5fa2 -ClientId 9fa98e34-277f-47fa-9847-e36bdf6bca1f +Get-LapsAADPassword -DeviceIds lapsAAD -IncludePasswords -AsPlainText -IncludeHistory +``` + +```Output +DeviceName : LAPSAAD +DeviceId : dfc6d5f0-225a-4b46-adcf-73a349a31e70 +Account : LapsAdmin +Password : ]5j)1fi]Rv&Pj+IMiAzq1R9b+yJ.@Q,80#01U541vsC8$Vv${hac8TJlkT8 +PasswordExpirationTime : 4/22/2023 8:55:20 AM +PasswordUpdateTime : 4/11/2023 8:55:21 AM + +DeviceName : LAPSAAD +DeviceId : dfc6d5f0-225a-4b46-adcf-73a349a31e70 +Account : LapsAdmin +Password : t&.1P%9891]24I0X4AA4O22a30R1lz(ar7N9{tTf349.Iz{L82O6v{I+,gg +PasswordExpirationTime : +PasswordUpdateTime : 4/11/2023 8:55:16 AM + +DeviceName : LAPSAAD +DeviceId : dfc6d5f0-225a-4b46-adcf-73a349a31e70 +Account : LapsAdmin +Password : g4q22s[Xz8}!T32[4;Z#0M}v35udF[xB0}iB;P@xk%9E9Tgw,W]7)vx9O!- +PasswordExpirationTime : +PasswordUpdateTime : 4/11/2023 8:45:29 AM +``` + +This example shows how to query the full LAPS password information for the target device that is +specified by device name, requesting password history, and displaying the passwords in clear-text +form. + +## PARAMETERS + +### -AsPlainText + +Specify this parameter to return the LAPS passwords in clear-text format. The default behavior is to +return the LAPS passwords wrapped in a .NET **SecureString** object. + +> [!IMPORTANT] +> Using this parameter exposes the returned clear-text password to casual viewing and may pose a +> security risk. This parameter should be used with caution and only in support or testing +> situations. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeviceIds + +Specifies the device name or device ID to query LAPS credentials. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeHistory + +Specifies that any older LAPS credentials on the device object should also be displayed. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludePasswords + +Specifies whether to return password information. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, +-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, +-WarningAction, and -WarningVariable. For more information, see +[about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Windows LAPS Overview](https://go.microsoft.com/fwlink/?linkid=2233901) + +[Get started with Windows LAPS and Azure Active Directory](https://go.microsoft.com/fwlink/?linkid=2233704) \ No newline at end of file diff --git a/docset/winserver2019-ps/laps/Get-LapsADPassword.md b/docset/winserver2019-ps/laps/Get-LapsADPassword.md new file mode 100644 index 0000000000..2b69a31a90 --- /dev/null +++ b/docset/winserver2019-ps/laps/Get-LapsADPassword.md @@ -0,0 +1,451 @@ +--- +description: Queries Windows Local Administrator Password Solution (LAPS) credentials from Active Directory (AD) on a specified AD computer or domain controller object. +external help file: lapspsh.dll-Help.xml +Module Name: LAPS +online version: https://learn.microsoft.com/powershell/module/laps/get-lapsadpassword?view=windowsserver2019-ps&wt.mc_id=ps-gethelp +schema: 2.0.0 +Locale: en-US +ms.date: 04/10/2023 +title: Get-LapsADPassword +--- + +# Get-LapsADPassword + +## SYNOPSIS +Queries Windows Local Administrator Password Solution (LAPS) credentials from Active Directory (AD) +on a specified AD computer or domain controller object. + +## SYNTAX + +### NormalMode (Default) + +``` +Get-LapsADPassword [-Credential ] [-DecryptionCredential ] + [-IncludeHistory] [-AsPlainText] [-Identity] [] +``` + +### DomainMode + +``` +Get-LapsADPassword [-Credential ] [-DecryptionCredential ] + [-IncludeHistory] [-AsPlainText] [-Identity] -Domain [] +``` + +### DomainControllerMode + +``` +Get-LapsADPassword [-Credential ] [-DecryptionCredential ] + [-IncludeHistory] [-AsPlainText] [-Identity] -DomainController + [] +``` + +### SnapshotBrowserMode + +``` +Get-LapsADPassword [-Credential ] [-DecryptionCredential ] + [-IncludeHistory] [-AsPlainText] -Port [-Identity] [-DomainController ] + [] +``` + +### RecoveryMode + +``` +Get-LapsADPassword [-IncludeHistory] [-AsPlainText] [-RecoveryMode] [-Identity] + [] +``` + +### SnapshotBrowserRecoveryMode + +``` +Get-LapsADPassword [-IncludeHistory] [-AsPlainText] [-RecoveryMode] -Port + [-Identity] [] +``` + +## DESCRIPTION + +The `Get-LapsADPassword` cmdlet allows administrators to retrieve LAPS passwords and password +history for an Active Directory computer or domain controller object. Depending on policy +configuration, LAPS passwords may be stored in either clear-text form or encrypted form. The +`Get-LapsADPassword` cmdlet automatically decrypts encrypted passwords. + +The `Get-LapsADPassword` cmdlet may also be used to connect to a mounted AD +snapshot. + +The **Verbose** parameter may be used to get additional information about the cmdlet's operation. + +## EXAMPLES + +### Example 1 + +```powershell +Get-LapsADPassword LAPSCLIENT +``` + +```Output +ComputerName : LAPSCLIENT +DistinguishedName : CN=LAPSCLIENT,OU=LapsTestOU,DC=laps,DC=com +Account : Administrator +Password : System.Security.SecureString +PasswordUpdateTime : 4/9/2023 10:03:41 AM +ExpirationTimestamp : 4/14/2023 10:03:41 AM +Source : CleartextPassword +DecryptionStatus : NotApplicable +AuthorizedDecryptor : NotApplicable +``` + +This example demonstrates querying the current LAPS password for the `LAPSCLIENT` computer in the +current domain. The password was stored in AD in clear-text form and didn't require decryption. The +password was returned wrapped in a **SecureString** object. + +### Example 2 + +```powershell +Get-LapsADPassword -Identity LAPSCLIENT -DomainController lapsDC -AsPlainText +``` + +```Output +ComputerName : LAPSCLIENT +DistinguishedName : CN=LAPSCLIENT,OU=LapsTestOU,DC=laps,DC=com +Account : Administrator +Password : k8P]Xl5T-ky!aj4s21el3S#.x44!e{8+,{L!M +PasswordUpdateTime : 4/9/2023 10:03:41 AM +ExpirationTimestamp : 4/14/2023 10:03:41 AM +Source : CleartextPassword +DecryptionStatus : NotApplicable +AuthorizedDecryptor : NotApplicable +``` + +This example demonstrates querying the current LAPS password on a specific domain controller +(`lapsDC`), for the `LAPSCLIENT` computer, requesting that the password be displayed in clear-text +form. The password was stored in AD in clear-text form and didn't require decryption. The password +was returned in clear-text form. + +### Example 3 + +```powershell +Get-LapsADPassword -Identity LAPSCLIENT2 -Domain laps.com -AsPlainText -IncludeHistory +``` + +```Output +ComputerName : LAPSCLIENT2 +DistinguishedName : CN=LAPSCLIENT2,OU=LapsTestEncryptedOU,DC=laps,DC=com +Account : Administrator +Password : q64!7KI3BOe/&S%buM0nBaW{B]261zN5L0{;{ +PasswordUpdateTime : 4/9/2023 9:39:38 AM +ExpirationTimestamp : 4/14/2023 9:39:38 AM +Source : EncryptedPassword +DecryptionStatus : Success +AuthorizedDecryptor : LAPS\LAPS Admins + +ComputerName : LAPSCLIENT2 +DistinguishedName : CN=LAPSCLIENT2,OU=LapsTestEncryptedOU,DC=laps,DC=com +Account : Administrator +Password : O{P61q6bu(3kZ6&#p2y.&F$cWd;0dm8!]Wl5j +PasswordUpdateTime : 4/9/2023 9:38:10 AM +ExpirationTimestamp : +Source : EncryptedPasswordHistory +DecryptionStatus : Success +AuthorizedDecryptor : LAPS\LAPS Admins +``` + +This example demonstrates querying the current LAPS password for the `LAPSCLIENT2` computer, in a +specific AD domain (`laps.com`), requesting that the password be displayed in +clear-text form. The password was stored in AD in encrypted form and was successfully +decrypted. + +> [!NOTE] +> **ExpirationTimestamp** is always empty for any older LAPS passwords returned. + +### Example 4 + +```powershell +Get-LapsADPassword -Identity lapsDC.laps.com -AsPlainText +``` + +```Output +ComputerName : LAPSDC +DistinguishedName : CN=LAPSDC,OU=Domain Controllers,DC=laps,DC=com +Account : Administrator +Password : 118y$rsw.3y58yG]on$Hii +PasswordUpdateTime : 4/9/2023 10:17:51 AM +ExpirationTimestamp : 4/19/2023 10:17:51 AM +Source : EncryptedDSRMPassword +DecryptionStatus : Success +AuthorizedDecryptor : LAPS\Domain Admins +``` + +This example demonstrates querying the current LAPS password for the `lapsDC.laps.com` domain +controller, requesting that the password be displayed in clear-text form. The password was stored in +AD in encrypted form and was successfully decrypted. + +### Example 5 + +```powershell +Get-LapsADPassword LAPSDC +``` + +```Output +ComputerName : LAPSDC +DistinguishedName : CN=LAPSDC,OU=Domain Controllers,DC=laps,DC=com +Account : +Password : +PasswordUpdateTime : 4/9/2023 10:17:51 AM +ExpirationTimestamp : 4/19/2023 10:17:51 AM +Source : EncryptedDSRMPassword +DecryptionStatus : Unauthorized +AuthorizedDecryptor : LAPS\Domain Admins +``` + +This example demonstrates querying the current LAPS password for the `LAPSDC` domain controller when +the user doesn't have permissions to decrypt the LAPS DSRM password. + +### Example 6 + +```powershell +Get-LapsADPassword LAPSLEGACYCLIENT -AsPlainText +``` + +```Output +ComputerName : LAPSLEGACYCLIENT +DistinguishedName : CN=LAPSLEGACYCLIENT,OU=LegacyLapsOU,DC=laps,DC=com +Account : +Password : Z#x}&7BluHf3{r+C218 +PasswordUpdateTime : +ExpirationTimestamp : 5/14/2023 1:55:39 PM +Source : LegacyLapsCleartextPassword +DecryptionStatus : NotApplicable +AuthorizedDecryptor : NotApplicable +``` + +This example demonstrates querying the current LAPS password for the 'LAPSLEGACYCLIENT' machine +which is currently running in legacy LAPS emulation mode. + +> [!NOTE] +> When querying legacy LAPS-style passwords, the **Account** and **PasswordUpdateTime** fields are +> always unavailable. + +### Example 7 + +```powershell +Get-LapsADPassword -Identity LAPSCLIENT -Port 50000 -AsPlainText +``` + +```Output +ComputerName : LAPSCLIENT +DistinguishedName : CN=LAPSCLIENT,OU=LapsTestOU,DC=laps,DC=com +Account : Administrator +Password : H6UycL[vj#zzTNVpS//G2{j&t9aO}k[K5l4)X +PasswordUpdateTime : 4/15/2023 6:51:45 AM +ExpirationTimestamp : 4/20/2023 6:51:45 AM +Source : CleartextPassword +DecryptionStatus : NotApplicable +AuthorizedDecryptor : NotApplicable +``` + +This example demonstrates querying an AD Snapshot browser instance for the current LAPS password for +the `LAPSCLIENT` machine. This example assumes that that the snapshot browser has been previously +started on the local machine listening on an LDAP port of `50000`. + +## PARAMETERS + +### -AsPlainText + +Specify this parameter to return the LAPS passwords in clear-text format. The default behavior is to +return the LAPS passwords wrapped in a .NET **SecureString** object. + +> [!IMPORTANT] +> Using this parameter exposes the returned clear-text password to casual viewing and may pose a +> security risk. This parameter should be used with caution and only in support or testing +> situations. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Credential + +Specifies a set of credentials to use when querying AD for the LAPS credentials. If not specified, +the current user's credentials are used. + +```yaml +Type: System.Management.Automation.PSCredential +Parameter Sets: NormalMode, DomainMode, DomainControllerMode, SnapshotBrowserMode +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DecryptionCredential + +Specifies a set of credentials to use when decrypting encrypted LAPS credentials. If not specified, +the current user's credentials are used. + +```yaml +Type: System.Management.Automation.PSCredential +Parameter Sets: NormalMode, DomainMode, DomainControllerMode, SnapshotBrowserMode +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Domain + +Specifies the name of the domain to connect to. + +```yaml +Type: System.String +Parameter Sets: DomainMode +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController + +Specifies the name of the domain controller to connect to, or the remote server on which an AD +Snapshot Browser is running. + +```yaml +Type: System.String +Parameter Sets: DomainControllerMode +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: SnapshotBrowserMode +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +Specifies the name of the computer or domain controller object to retrieve LAPS credentials from. + +This parameter accepts several different name formats that influence the criteria used when +searching AD for the target device. The supported name formats are as follows: + +- distinguishedName (begins with a `CN=`) +- samAccountName (begins with a '$") +- dnsHostName (contains at least one '.' character) +- name (for all other inputs) + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -IncludeHistory + +Specifies that any older LAPS credentials on the computer object should also be displayed. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Port + +Specifies the AD Snapshot Browser port to connect to. + +```yaml +Type: System.Nullable`1[System.Int32] +Parameter Sets: SnapshotBrowserMode, SnapshotBrowserRecoveryMode +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RecoveryMode + +This parameter provides a last-ditch option when it's no longer possible to decrypt a given LAPS +credential via the normal mechanisms. For example, this might be necessary if a LAPS credential was +encrypted against a group that has since been deleted. + +>[!IMPORTANT] +> When specifying this parameter, you must be logged-in locally as a Domain Administrator on a +> writable domain controller. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: RecoveryMode, SnapshotBrowserRecoveryMode +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, +-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, +-WarningAction, and -WarningVariable. For more information, see +[about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String[] + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Windows LAPS Overview](https://go.microsoft.com/fwlink/?linkid=2233901) + +[Get started with Windows LAPS and Windows Server Active Directory](https://go.microsoft.com/fwlink/?linkid=2233705) diff --git a/docset/winserver2019-ps/laps/Get-LapsDiagnostics.md b/docset/winserver2019-ps/laps/Get-LapsDiagnostics.md new file mode 100644 index 0000000000..bf989e7bce --- /dev/null +++ b/docset/winserver2019-ps/laps/Get-LapsDiagnostics.md @@ -0,0 +1,167 @@ +--- +description: Collects Windows Local Administrator Password Solution (LAPS) logs and tracing from the local machine. +external help file: LAPS-help.xml +Module Name: LAPS +online version: https://learn.microsoft.com/powershell/module/laps/get-lapsdiagnostics?view=windowsserver2019-ps&wt.mc_id=ps-gethelp +schema: 2.0.0 +Locale: en-US +ms.date: 04/10/2023 +title: Get-LapsDiagnostics +--- + +# Get-LapsDiagnostics + +## SYNOPSIS +Collects Windows Local Administrator Password Solution (LAPS) logs and tracing from the local +machine. + +## SYNTAX + +``` +Get-LapsDiagnostics [[-OutputFolder] ] [-CollectNetworkTrace] [-ResetPassword] + [] +``` + +## DESCRIPTION + +The `Get-LapsDiagnostics` cmdlet collects LAPS logs and tracing from the local machine, and copies +them into a `.zip` file. This cmdlet is primarily intended for support and testing scenarios but of +course may be used at any time. The name of the resultant `.zip` file includes the machine name and +current timestamp, and by default is written under the `$env:TEMP\LapsDiagnostics` folder. The +output folder may be customized using the **OutputFolder**. + +## EXAMPLES + +### Example 1 + +```powershell +Get-LapsDiagnostics +``` + +```Output +Get-LapsDiagnostics: all data for this run was written to the following zip file: + +C:\Users\ADMINI~1\AppData\Local\Temp\LapsDiagnostics\LapsDiagnostics_LAPSCLIENT_2023041004_072649.zip +``` + +This example demonstrates basic collection of LAPS diagnostic info using all default parameters. + +### Example 2 + +```powershell +Get-LapsDiagnostics -OutputFolder c:\LapsDiagFolder +``` + +```Output +Get-LapsDiagnostics: all data for this run was written to the following zip file: + +c:\LapsDiagFolder\LapsDiagnostics_LAPSCLIENT_2023041004_072702.zip +``` + +This example demonstrates basic collection of LAPS diagnostic info to a specific output folder. + +### Example 3 + +```powershell +Get-LapsDiagnostics -OutputFolder c:\LapsDiagFolder -ResetPassword +``` + +```Output +Get-LapsDiagnostics: all data for this run was written to the following zip file: + +c:\LapsDiagFolder\LapsDiagnostics_LAPSCLIENT_2023041004_072709.zip +``` + +This example demonstrates basic collection of LAPS diagnostic info across a forced password reset +operation to a specific output folder. + +### Example 4 + +```powershell +Get-LapsDiagnostics -CollectNetworkTrace +``` + +```Output +Get-LapsDiagnostics: all data for this run was written to the following zip file: + +C:\Users\ADMINI~1\AppData\Local\Temp\LapsDiagnostics\LapsDiagnostics_LAPSCLIENT_2023041004_072719.zip +``` + +This example demonstrates basic collection of LAPS diagnostic info while also collecting network +tracing. + +## PARAMETERS + +### -CollectNetworkTrace + +Specifies that network tracing should also be collected and included in the resultant `.zip` file. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OutputFolder + +Specifies that the resultant `.zip` file should be placed under the specified folder. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResetPassword + +Specifies that logs and tracing should be collected across a forced password reset for the currently +managed local account. In this mode the cmdlet collects tracing across a call to the +`Reset-LapsPassword` cmdlet. + +If this parameter isn't specified, the cmdlet collects tracing across a call to the +`Invoke-LapsProcessingCycle` cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, +-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, +-WarningAction, and -WarningVariable. For more information, see +[about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Windows LAPS Overview](https://go.microsoft.com/fwlink/?linkid=2233901) diff --git a/docset/winserver2019-ps/laps/Invoke-LapsPolicyProcessing.md b/docset/winserver2019-ps/laps/Invoke-LapsPolicyProcessing.md new file mode 100644 index 0000000000..86fd2c0c58 --- /dev/null +++ b/docset/winserver2019-ps/laps/Invoke-LapsPolicyProcessing.md @@ -0,0 +1,64 @@ +--- +description: Causes Windows Local Administrator Password Solution (LAPS) to process the currently configured policy. +external help file: lapspsh.dll-Help.xml +Module Name: LAPS +online version: https://learn.microsoft.com/powershell/module/laps/invoke-lapspolicyprocessing?view=windowsserver2019-ps&wt.mc_id=ps-gethelp +schema: 2.0.0 +Locale: en-US +ms.date: 04/10/2023 +title: Invoke-LapsPolicyProcessing +--- + +# Invoke-LapsPolicyProcessing + +## SYNOPSIS +Causes Windows Local Administrator Password Solution (LAPS) to process the currently configured +policy. + +## SYNTAX + +``` +Invoke-LapsPolicyProcessing [] +``` + +## DESCRIPTION + +The `Invoke-LapsPolicyProcessing` cmdlet tells LAPS to process the currently configured policy. + +The cmdlet doesn't return detailed information about the results of the operation. See +[Use Windows LAPS event logs](https://go.microsoft.com/fwlink/?linkid=2234103) for more information +on querying the resultant event log entries to get specific information on the outcome of the +operation. + +## EXAMPLES + +### Example 1 + +```powershell +Invoke-LapsPolicyProcessing +``` + +This example starts the processing of the configured LAPS policy. + +## PARAMETERS + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, +-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, +-WarningAction, and -WarningVariable. For more information, see +[about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Windows LAPS Overview](https://go.microsoft.com/fwlink/?linkid=2233901) diff --git a/docset/winserver2019-ps/laps/LAPS.md b/docset/winserver2019-ps/laps/LAPS.md new file mode 100644 index 0000000000..8128683a39 --- /dev/null +++ b/docset/winserver2019-ps/laps/LAPS.md @@ -0,0 +1,81 @@ +--- +description: This reference provides cmdlet descriptions and syntax for the Windows Local Administrator Password +Solution (LAPS) module. +Module Name: LAPS +Module Guid: 8eb7ddf9-7890-49ae-9af1-3b41d7e63c41 +Download Help Link: https://aka.ms/winsvr-2019-pshelp +Help Version: 1.0.0.0 +Locale: en-US +ms.date: 04/10/2023 +title: LAPS +--- + +# LAPS Module + +## Description + +This reference provides cmdlet descriptions and syntax for the Windows Local Administrator Password +Solution (LAPS) module. It lists the cmdlets in alphabetical order. + +## LAPS Cmdlets + +### [Find-LapsADExtendedRights](Find-LapsADExtendedRights.md) + +Queries Active Directory (AD) to find principals that have been granted permission to read Windows +Local Administrator Password Solution (LAPS) password attributes. + +### [Get-LapsAADPassword](Get-LapsAADPassword.md) + +Queries Azure Active Directory (AAD) for the Windows Local Administrator Password Solution (LAPS) +credentials on a specified Azure AD device. + +### [Get-LapsADPassword](Get-LapsADPassword.md) + +Queries Windows Local Administrator Password Solution (LAPS) credentials from Active Directory (AD) +on a specified AD computer or domain controller object. + +### [Get-LapsDiagnostics](Get-LapsDiagnostics.md) + +Collects Windows Local Administrator Password Solution (LAPS) logs and tracing from the local +machine. + +### [Invoke-LapsPolicyProcessing](Invoke-LapsPolicyProcessing.md) + +Causes Windows Local Administrator Password Solution (LAPS) to process the currently configured +policy. + +### [Reset-LapsPassword](Reset-LapsPassword.md) + +Causes Windows Local Administrator Password Solution (LAPS) to immediately rotate the password for +the currently managed local account. + +### [Set-LapsADAuditing](Set-LapsADAuditing.md) + +Configures an Active Directory (AD) Organizational Unit (OU) to enable auditing on the Windows Local +Administrator Password Solution (LAPS) password schema attributes. + +### [Set-LapsADComputerSelfPermission](Set-LapsADComputerSelfPermission.md) + +Configures permissions on an Active Directory (AD) Organizational Unit (OU) to enable computers in +that OU to update their Windows Local Administrator Password Solution (LAPS) passwords. + +### [Set-LapsADPasswordExpirationTime](Set-LapsADPasswordExpirationTime.md) + +Sets the Windows Local Administrator Password Solution (LAPS) password expiration timestamp on an +Active Directory (AD) computer or domain controller object. + +### [Set-LapsADReadPasswordPermission](Set-LapsADReadPasswordPermission.md) + +Configures security on an Active Directory (AD) Organizational Unit (OU) to grant specific users or +groups permission to query Windows Local Administrator Password Solution (LAPS) passwords. + +### [Set-LapsADResetPasswordPermission](Set-LapsADResetPasswordPermission.md) + +Configures security on an Active Directory (AD) Organizational Unit (OU) to grant specific users or +groups permission to set the Windows Local Administrator Password Solution (LAPS) password +expiration time. + +### [Update-LapsADSchema](Update-LapsADSchema.md) + +Extends the Active Directory (AD) schema with the Windows Local Administrator Password Solution +(LAPS) schema attributes. diff --git a/docset/winserver2019-ps/laps/Reset-LapsPassword.md b/docset/winserver2019-ps/laps/Reset-LapsPassword.md new file mode 100644 index 0000000000..f6657361fc --- /dev/null +++ b/docset/winserver2019-ps/laps/Reset-LapsPassword.md @@ -0,0 +1,71 @@ +--- +description: Causes Windows Local Administrator Password Solution (LAPS) to immediately rotate the password for the currently managed local account. +external help file: lapspsh.dll-Help.xml +Module Name: LAPS +online version: https://learn.microsoft.com/powershell/module/laps/reset-lapspassword?view=windowsserver2019-ps&wt.mc_id=ps-gethelp +schema: 2.0.0 +Locale: en-US +ms.date: 04/10/2023 +title: Reset-LapsPassword +--- + +# Reset-LapsPassword + +## SYNOPSIS +Causes Windows Local Administrator Password Solution (LAPS) to immediately rotate the password for +the currently managed local account. + +## SYNTAX + +``` +Reset-LapsPassword [] +``` + +## DESCRIPTION + +The `Reset-LapsPassword` cmdlet tells LAPS to immediately rotate the password for the currently +managed local account. This operation is performed regardless of the state of the current password, +for example it doesn't matter whether the current password is considered expired or not. + +> [!IMPORTANT] +> This cmdlet is intended and recommended only for rare situations that require an +> immediate password rotation, for example as a response to a machine security breach situation. +> Excessively frequent usage of this cmdlet isn't recommended. + +The cmdlet doesn't return detailed information about the results of the operation. See +[Use Windows LAPS event logs](https://go.microsoft.com/fwlink/?linkid=2234103) for more information +on querying the resultant event log entries to get specific information on the outcome of the +operation. + +## EXAMPLES + +### Example 1 + +```powershell +Reset-LapsPassword +``` + +This example forces immediate rotation of the managed local account. + +## PARAMETERS + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, +-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, +-WarningAction, and -WarningVariable. For more information, see +[about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Windows LAPS Overview](https://go.microsoft.com/fwlink/?linkid=2233901) diff --git a/docset/winserver2019-ps/laps/Set-LapsADAuditing.md b/docset/winserver2019-ps/laps/Set-LapsADAuditing.md new file mode 100644 index 0000000000..bff3843852 --- /dev/null +++ b/docset/winserver2019-ps/laps/Set-LapsADAuditing.md @@ -0,0 +1,208 @@ +--- +description: Configures an Active Directory (AD) Organizational Unit (OU) to enable auditing on the Windows Local Administrator Password Solution (LAPS) password schema attributes. +external help file: lapspsh.dll-Help.xml +Module Name: LAPS +online version: https://learn.microsoft.com/powershell/module/laps/set-lapsadauditing?view=windowsserver2019-ps&wt.mc_id=ps-gethelp +schema: 2.0.0 +Locale: en-US +ms.date: 04/10/2023 +title: Set-LapsADAuditing +--- + +# Set-LapsADAuditing + +## SYNOPSIS +Configures an Active Directory (AD) Organizational Unit (OU) to enable auditing on the Windows Local +Administrator Password Solution (LAPS) password schema attributes. + +## SYNTAX + +``` +Set-LapsADAuditing [-Credential ] -Identity -AuditedPrincipals + [-AuditType ] [-Domain ] [-DomainController ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 + +```powershell +Set-LapsADAuditing -Identity LapsTestOU -AuditedPrincipals "laps.com\LapsAdmin" -AuditType Success +OU=LapsTestOU,DC=laps,DC=com +``` + +This example demonstrates configuring `Success` audits on an OU. + +### Example 2 + +```powershell +Set-LapsADAuditing -Identity LapsTestOU -AuditedPrincipals "laps.com\LapsAdminsGroup" -AuditType Failure +OU=LapsTestOU,DC=laps,DC=com +``` + +This example demonstrates configuring `Failure` audits on an OU. + +## PARAMETERS + +### -AuditedPrincipals + +Specifies the name of the users or groups should be configured for auditing. Users or groups may be +specified in either name or SID format. If specified in name format, the name must always include +the identifying domain name portion unless the name maps to a well-known or built-in account. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AuditType + +Specifies whether to configure Success or Failure auditing. + +```yaml +Type: System.Security.AccessControl.AuditFlags +Parameter Sets: (All) +Aliases: +Accepted values: None, Success, Failure + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Credential + +Specifies the credentials to use when updating AD. If not specified, the current user's credentials +are used. + +```yaml +Type: System.Management.Automation.PSCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Domain + +Specifies the name of the domain to connect to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController + +Specifies the name of the domain controller to connect to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +Specifies the name of the OU to update. + +This parameter accepts several different name formats that influence the criteria used in the +resultant AD search. The supported name formats are as follows: + +- distinguishedName (begins with a `CN=`) +- name (for all other inputs) + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. The cmdlet isn't run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, +-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, +-WarningAction, and -WarningVariable. For more information, see +[about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String[] + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Windows LAPS Overview](https://go.microsoft.com/fwlink/?linkid=2233901) diff --git a/docset/winserver2019-ps/laps/Set-LapsADComputerSelfPermission.md b/docset/winserver2019-ps/laps/Set-LapsADComputerSelfPermission.md new file mode 100644 index 0000000000..33aca11f0e --- /dev/null +++ b/docset/winserver2019-ps/laps/Set-LapsADComputerSelfPermission.md @@ -0,0 +1,171 @@ +--- +description: Configures permissions on an Active Directory (AD) Organizational Unit (OU) to enable computers in that OU to update their Windows Local Administrator Password Solution (LAPS) passwords. +external help file: lapspsh.dll-Help.xml +Module Name: LAPS +online version: https://learn.microsoft.com/powershell/module/laps/set-lapsadcomputerselfpermission?view=windowsserver2019-ps&wt.mc_id=ps-gethelp +schema: 2.0.0 +Locale: en-US +ms.date: 04/10/2023 +title: Set-LapsADComputerSelfPermission +--- + +# Set-LapsADComputerSelfPermission + +## SYNOPSIS +Configures permissions on an Active Directory (AD) Organizational Unit (OU) to enable computers in +that OU to update their Windows Local Administrator Password Solution (LAPS) passwords. + +## SYNTAX + +``` +Set-LapsADComputerSelfPermission -Identity [-Domain ] + [-DomainController ] [-Credential ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION + +The `Set-LapsADComputerSelfPermission` cmdlet is used by administrators to configure security +permissions on an OU to allow computers in that OU to update their LAPS passwords. + +## EXAMPLES + +### Example 1 + +```powershell +Set-LapsADComputerSelfPermission -Identity LapsTestOU +``` + +```Output +Name DistinguishedName +---- ----------------- +LapsTestOU OU=LapsTestOU,DC=laps,DC=com +``` + +This example demonstrates how to run the cmdlet. + +## PARAMETERS + +### -Credential + +Specifies the credentials to use when updating AD. If not specified, the current +user's credentials are used. + +```yaml +Type: System.Management.Automation.PSCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Domain + +Specifies the name of the domain to connect to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController + +Specifies the name of the domain controller to connect to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +Specifies the name of the OU to update. + +This parameter accepts several different name formats that influence the criteria used in the +resultant AD search. The supported name formats are as follows: + +- distinguishedName (begins with a `CN=`) +- name (for all other inputs) + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. The cmdlet isn't run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, +-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, +-WarningAction, and -WarningVariable. For more information, see +[about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String[] + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Windows LAPS Overview](https://go.microsoft.com/fwlink/?linkid=2233901) diff --git a/docset/winserver2019-ps/laps/Set-LapsADPasswordExpirationTime.md b/docset/winserver2019-ps/laps/Set-LapsADPasswordExpirationTime.md new file mode 100644 index 0000000000..2a0a2381dd --- /dev/null +++ b/docset/winserver2019-ps/laps/Set-LapsADPasswordExpirationTime.md @@ -0,0 +1,192 @@ +--- +description: Sets the Windows Local Administrator Password Solution (LAPS) password expiration timestamp on an Active Directory (AD) computer or domain controller object. +external help file: lapspsh.dll-Help.xml +Module Name: LAPS +online version: https://learn.microsoft.com/powershell/module/laps/set-lapsadpasswordexpirationtime?view=windowsserver2019-ps&wt.mc_id=ps-gethelp +schema: 2.0.0 +Locale: en-US +ms.date: 04/10/2023 +title: Set-LapsADPasswordExpirationTime +--- + +# Set-LapsADPasswordExpirationTime + +## SYNOPSIS +Sets the Windows Local Administrator Password Solution (LAPS) password expiration timestamp on an +Active Directory (AD) computer or domain controller object. + +## SYNTAX + +``` +Set-LapsADPasswordExpirationTime [-Credential ] -Identity + [-WhenEffective ] [-Domain ] [-DomainController ] [] +``` + +## DESCRIPTION + +The `Set-LapsADPasswordExpirationTime` cmdlet is used by administrators to configure the LAPS +password expiration time on an AD computer or domain controller object. + +> [!TIP] +> Running this cmdlet sets the LAPS password expiration time on the AD computer or domain controller +> object, but the new expiration time isn't honored until the next time the target device executes a +> LAPS policy processing cycle. + +## EXAMPLES + +### Example 1 + +```powershell +Set-LapsADPasswordExpirationTime -Identity lapsClient +``` + +```Output +DistinguishedName Status +----------------- ------ +CN=LAPSCLIENT,OU=LapsTestOU,DC=laps,DC=com PasswordReset +``` + +This example shows setting the LAPS password expiration time to the current time, which expires the +password immediately. + +### Example 2 + +```powershell +Set-LapsADPasswordExpirationTime -Identity lapsClient -WhenEffective (Get-Date -Date "07/04/2023 13:00:00") +``` + +```Output +DistinguishedName Status +----------------- ------ +CN=LAPSCLIENT,OU=LapsTestOU,DC=laps,DC=com PasswordReset +``` + +This examples show setting the LAPS password expiration time to a specific date. + +### Example 3 + +```powershell +Set-LapsADPasswordExpirationTime -Identity lapsClient -WhenEffective (DateTime::Now.AddDays(1)) +``` + +```Output +DistinguishedName Status +----------------- ------ +CN=LAPSCLIENT,OU=LapsTestOU,DC=laps,DC=com PasswordReset +``` + +This examples show setting the LAPS password expiration time to one day in the future. + +## PARAMETERS + +### -Credential + +Specifies the credentials to use when updating AD. If not specified, the current user's credentials +are used. + +```yaml +Type: System.Management.Automation.PSCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Domain + +Specifies the name of the domain to connect to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController + +Specifies the name of the domain controller to connect to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +Specifies the name of the computer or domain controller object to set the LAPS password expiration +time on. + +This parameter accepts several different name formats that influence the criteria used when +searching AD for the target device. The supported name formats are as follows: + +- distinguishedName (begins with a `CN=`) +- samAccountName (begins with a `$`) +- dnsHostName (contains at least one `.` character) +- name (for all other inputs) + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -WhenEffective + +Specifies the new LAPS password expiration time. If not specified, the current time is used, which +expires the password is immediately. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, +-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, +-WarningAction, and -WarningVariable. For more information, see +[about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String[] + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Windows LAPS Overview](https://go.microsoft.com/fwlink/?linkid=2233901) diff --git a/docset/winserver2019-ps/laps/Set-LapsADReadPasswordPermission.md b/docset/winserver2019-ps/laps/Set-LapsADReadPasswordPermission.md new file mode 100644 index 0000000000..47c3f012a7 --- /dev/null +++ b/docset/winserver2019-ps/laps/Set-LapsADReadPasswordPermission.md @@ -0,0 +1,243 @@ +--- +description: Configures security on an Active Directory (AD) Organizational Unit (OU) to grant specific users or groups permission to query Windows Local Administrator Password Solution (LAPS) passwords. +external help file: lapspsh.dll-Help.xml +Module Name: LAPS +online version: https://learn.microsoft.com/powershell/module/laps/set-lapsadreadpasswordpermission?view=windowsserver2019-ps&wt.mc_id=ps-gethelp +schema: 2.0.0 +Locale: en-US +ms.date: 04/10/2023 +title: Set-LapsADReadPasswordPermission +--- + +# Set-LapsADReadPasswordPermission + +## SYNOPSIS +Configures security on an Active Directory (AD) Organizational Unit (OU) to grant specific users or +groups permission to query Windows Local Administrator Password Solution (LAPS) passwords. + +## SYNTAX + +``` +Set-LapsADReadPasswordPermission [-Credential ] -Identity + -AllowedPrincipals [-Domain ] [-DomainController ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION + +The `Set-LapsADReadPasswordPermission` cmdlet is used by administrators to configure security +permissions on an OU to allow specific users or groups to query LAPS passwords on computers in that +OU. Users and groups must be fully qualified with both domain and user name components. The only +exception to this is when the specified name resolves to a built-in principal, such as +`Domain Admins`. + +## EXAMPLES + +### Example 1 + +```powershell +Set-LapsADReadPasswordPermission -Identity LapsTestOU -AllowedPrincipals "Domain Admins" +``` + +```Output +Name DistinguishedName +---- ----------------- +LapsTestOU OU=LapsTestOU,DC=laps,DC=com +``` + +This example shows how to run the cmdlet with an isolated name that successfully maps to a +well-known user or group. + +### Example 2 + +```powershell +Set-LapsADReadPasswordPermission -Identity LapsTestOU -AllowedPrincipals @("S-1-5-21-2889755270-1324585639-743026605-1215") +``` + +```Output +Name DistinguishedName +---- ----------------- +LapsTestOU OU=LapsTestOU,DC=laps,DC=com +``` + +This example shows how to run the cmdlet specifying a user SID as input. + +### Example 3 + +```powershell +Set-LapsADReadPasswordPermission -Identity 'OU=LapsTestOU,DC=laps,DC=com' -AllowedPrincipals @("laps.com\LapsAdmin1", "LapsAdmin2@laps.com") +``` + +```Output +Name DistinguishedName +---- ----------------- +LapsTestOU OU=LapsTestOU,DC=laps,DC=com +``` + +This example shows how to run the cmdlet specifying two fully qualified user names in different +formats. + +### Example 4 + +```powershell +Set-LapsADReadPasswordPermission -Identity LapsTestOU -AllowedPrincipals @("LapsAdministratorsGroup") +``` + +```Output +Set-LapsADReadPasswordPermission : The 'LapsAdministratorsGroup' account appears to be an isolated +name but is not a well-known name. Please use a fully qualified name instead, such as +"LAPSAdmins@contoso.com" or "contoso\LAPSAdmins" +At line:1 char:1 ++ Set-LapsADReadPasswordPermission -Identity LapsTestOU -AllowedPrincip ... ++ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + + CategoryInfo : InvalidArgument: (:) [Set-LapsADReadPasswordPermission], LapsPowershellException + + FullyQualifiedErrorId : Invalid principal specified,Microsoft.Windows.LAPS.SetLapsADReadPasswordPermission +``` + +This example shows a failure caused by specifying an isolated name that didn't resolve to a +well-known or built-in account. The fix for this error would be to add a domain name qualifier to +the input name, for example `LapsAdministratorsGroup@laps.com`. + +## PARAMETERS + +### -AllowedPrincipals + +Specifies the name of the users or groups should be granted the permissions. Users or groups may be +specified in either name or SID format. If specified in name format, the name must always include +the identifying domain name portion unless the name maps to a well-known or built-in account. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Credential + +Specifies the credentials to use when updating AD. If not specified, the current +user's credentials are used. + +```yaml +Type: System.Management.Automation.PSCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Domain + +Specifies the name of the domain to connect to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController + +Specifies the name of the domain controller to connect to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +Specifies the name of the OU to update. + +This parameter accepts several different name formats that influence the criteria used in the +resultant AD search. The supported name formats are as follows: + +- distinguishedName (begins with a `CN=`) +- name (for all other inputs) + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. The cmdlet isn't run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, +-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, +-WarningAction, and -WarningVariable. For more information, see +[about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String[] + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Windows LAPS Overview](https://go.microsoft.com/fwlink/?linkid=2233901) diff --git a/docset/winserver2019-ps/laps/Set-LapsADResetPasswordPermission.md b/docset/winserver2019-ps/laps/Set-LapsADResetPasswordPermission.md new file mode 100644 index 0000000000..675eae07c5 --- /dev/null +++ b/docset/winserver2019-ps/laps/Set-LapsADResetPasswordPermission.md @@ -0,0 +1,244 @@ +--- +description: Configures security on an Active Directory (AD) Organizational Unit (OU) to grant specific users or groups permission to set the Windows Local Administrator Password Solution (LAPS) password expiration time. +external help file: lapspsh.dll-Help.xml +Module Name: LAPS +online version: https://learn.microsoft.com/powershell/module/laps/set-lapsadresetpasswordpermission?view=windowsserver2019-ps&wt.mc_id=ps-gethelp +schema: 2.0.0 +Locale: en-US +ms.date: 04/10/2023 +title: Set-LapsADResetPasswordPermission +--- + +# Set-LapsADResetPasswordPermission + +## SYNOPSIS +Configures security on an Active Directory (AD) Organizational Unit (OU) to grant specific users or +groups permission to set the Windows Local Administrator Password Solution (LAPS) password +expiration time. + +## SYNTAX + +``` +Set-LapsADResetPasswordPermission [-Credential ] -Identity + -AllowedPrincipals [-Domain ] [-DomainController ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION + +The `Set-LapsADResetPasswordPermission` cmdlet is used by administrators to configure security +permissions on an OU to allow specific users or groups to reset the LAPS password expiration time on +computers in that OU. Users and groups must be fully qualified with both domain and user name +components. The only exception to this is when the specified name resolves to a built-in principal, +such as `Domain Admins`. + +## EXAMPLES + +### Example 1 + +```powershell +Set-LapsADResetPasswordPermission -Identity LapsTestOU -AllowedPrincipals "Domain Admins" +``` + +```Output +Name DistinguishedName +---- ----------------- +LapsTestOU OU=LapsTestOU,DC=laps,DC=com +``` + +This example shows how to run the cmdlet with an isolated name that successfully maps to a +well-known user or group. + +### Example 2 + +```powershell +Set-LapsADResetPasswordPermission -Identity LapsTestOU -AllowedPrincipals @("S-1-5-21-2889755270-1324585639-743026605-1215") +``` + +```Output +Name DistinguishedName +---- ----------------- +LapsTestOU OU=LapsTestOU,DC=laps,DC=com +``` + +This example shows how to run the cmdlet specifying a user SID as input. + +### Example 3 + +```powershell +Set-LapsADResetPasswordPermission -Identity 'OU=LapsTestOU,DC=laps,DC=com' -AllowedPrincipals @("laps.com\LapsAdmin1", "LapsAdmin2@laps.com") +``` + +```Output +Name DistinguishedName +---- ----------------- +LapsTestOU OU=LapsTestOU,DC=laps,DC=com +``` + +This example shows how to run the cmdlet specifying two fully qualified user names in different +formats. + +### Example 4 + +```powershell +Set-LapsADResetPasswordPermission -Identity LapsTestOU -AllowedPrincipals @("LapsAdministratorsGroup") +``` + +```Output +Set-LapsADReadPasswordPermission : The 'LapsAdministratorsGroup' account appears to be an isolated +name but is not a well-known name. Please use a fully qualified name instead, such as +"LapsAdministratorsGroup@contoso.com" or "contoso\LapsAdministratorsGroup" +At line:1 char:1 ++ Set-LapsADReadPasswordPermission -Identity LapsTestOU -AllowedPrincip ... ++ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + + CategoryInfo : InvalidArgument: (:) [Set-LapsADReadPasswordPermission], LapsPowershellException + + FullyQualifiedErrorId : Invalid principal specified,Microsoft.Windows.LAPS.SetLapsADReadPasswordPermission +``` + +This example shows a failure caused by specifying an isolated name that didn't resolve to a +well-known or built-in account. The fix for this error would be to add a domain name qualifier to +the input name, for example "LapsAdministratorsGroup@laps.com". + +## PARAMETERS + +### -AllowedPrincipals + +Specifies the name of the users or groups should be granted the permissions. Users or groups may be +specified in either name or SID format. If specified in name format, the name must always include +the identifying domain name portion unless the name maps to a well-known or built-in account. + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Credential + +Specifies the credentials to use when updating AD. If not specified, the current user's credentials +are used. + +```yaml +Type: System.Management.Automation.PSCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Domain + +Specifies the name of the domain to connect to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController + +Specifies the name of the domain controller to connect to. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +Specifies the name of the OU to update. + +This parameter accepts several different name formats that influence the criteria used in the +resultant AD search. The supported name formats are as follows: + +- distinguishedName (begins with a `CN=`) +- name (for all other inputs) + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. The cmdlet isn't run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, +-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, +-WarningAction, and -WarningVariable. For more information, see +[about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String[] + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Windows LAPS Overview](https://go.microsoft.com/fwlink/?linkid=2233901) diff --git a/docset/winserver2019-ps/laps/Update-LapsADSchema.md b/docset/winserver2019-ps/laps/Update-LapsADSchema.md new file mode 100644 index 0000000000..2608593912 --- /dev/null +++ b/docset/winserver2019-ps/laps/Update-LapsADSchema.md @@ -0,0 +1,121 @@ +--- +description: Extends the Active Directory (AD) schema with the Windows Local Administrator Password Solution +(LAPS) schema attributes. +external help file: lapspsh.dll-Help.xml +Module Name: LAPS +online version: https://learn.microsoft.com/powershell/module/laps/update-lapsadschema?view=windowsserver2019-ps&wt.mc_id=ps-gethelp +schema: 2.0.0 +Locale: en-US +ms.date: 04/10/2023 +title: Update-LapsADSchema +--- + +# Update-LapsADSchema + +## SYNOPSIS +Extends the Active Directory (AD) schema with the Windows Local Administrator Password Solution +(LAPS) schema attributes. + +## SYNTAX + +``` +Update-LapsADSchema [-Credential ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION + +The `Update-LapsADSchema` cmdlet extends the AD schema with the LAPS schema attributes. The specific +nature of the schema extensions is documented in +[Windows LAPS schema extensions reference](https://go.microsoft.com/fwlink/?linkid=2233804). + +The **Verbose** parameter may be used to get additional information about the cmdlet's operation. + +## EXAMPLES + +### Example 1 + +```powershell +Update-LapsADSchema +``` + +```Output +The 'ms-LAPS-Password' schema attribute needs to be added to the AD schema. +Do you want to proceed? +[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): A +``` + +This example extends the AD schema to add the LAPS attributes. + +## PARAMETERS + +### -Credential + +Specifies a set of credentials to use when extending the schema. If not specified, the current +user's credentials are used. + +```yaml +Type: System.Management.Automation.PSCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. The cmdlet isn't run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, +-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, +-WarningAction, and -WarningVariable. For more information, see +[about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Windows LAPS Overview](https://go.microsoft.com/fwlink/?linkid=2233901) + +[Windows LAPS schema extensions reference](https://go.microsoft.com/fwlink/?linkid=2233804) diff --git a/docset/winserver2022-ps/laps/LAPS.md b/docset/winserver2022-ps/laps/LAPS.md index 55d22549f6..c13436bc3d 100644 --- a/docset/winserver2022-ps/laps/LAPS.md +++ b/docset/winserver2022-ps/laps/LAPS.md @@ -1,5 +1,5 @@ --- -description: This reference provides cmdlet descriptions and syntax for all Windows Local Administrator Password +description: This reference provides cmdlet descriptions and syntax for the Windows Local Administrator Password Solution (LAPS) module. Module Name: LAPS Module Guid: 8eb7ddf9-7890-49ae-9af1-3b41d7e63c41 From 3bfcb139db5a2c7ad9ec220ba6b202c5afaf096b Mon Sep 17 00:00:00 2001 From: MattTB <49200399+mtrilbybassett@users.noreply.github.com> Date: Wed, 19 Apr 2023 16:28:01 -0400 Subject: [PATCH 118/650] Update Update-LapsADSchema.md --- docset/winserver2019-ps/laps/Update-LapsADSchema.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docset/winserver2019-ps/laps/Update-LapsADSchema.md b/docset/winserver2019-ps/laps/Update-LapsADSchema.md index 2608593912..4c056d6f84 100644 --- a/docset/winserver2019-ps/laps/Update-LapsADSchema.md +++ b/docset/winserver2019-ps/laps/Update-LapsADSchema.md @@ -1,6 +1,5 @@ --- -description: Extends the Active Directory (AD) schema with the Windows Local Administrator Password Solution -(LAPS) schema attributes. +description: Extends the Active Directory (AD) schema with the Windows Local Administrator Password Solution (LAPS) schema attributes. external help file: lapspsh.dll-Help.xml Module Name: LAPS online version: https://learn.microsoft.com/powershell/module/laps/update-lapsadschema?view=windowsserver2019-ps&wt.mc_id=ps-gethelp From 92eb5626efccf34ea00e1a7be31c2df3df180e7a Mon Sep 17 00:00:00 2001 From: MattTB <49200399+mtrilbybassett@users.noreply.github.com> Date: Thu, 20 Apr 2023 14:19:44 -0400 Subject: [PATCH 119/650] Update LAPS.md --- docset/winserver2019-ps/laps/LAPS.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docset/winserver2019-ps/laps/LAPS.md b/docset/winserver2019-ps/laps/LAPS.md index 8128683a39..902661693d 100644 --- a/docset/winserver2019-ps/laps/LAPS.md +++ b/docset/winserver2019-ps/laps/LAPS.md @@ -1,6 +1,5 @@ --- -description: This reference provides cmdlet descriptions and syntax for the Windows Local Administrator Password -Solution (LAPS) module. +description: This reference provides cmdlet descriptions and syntax for the Windows Local Administrator Password Solution (LAPS) module. Module Name: LAPS Module Guid: 8eb7ddf9-7890-49ae-9af1-3b41d7e63c41 Download Help Link: https://aka.ms/winsvr-2019-pshelp From df3b0c11bb9df0e12d880cda6b1fa5286189314e Mon Sep 17 00:00:00 2001 From: MattTB <49200399+mtrilbybassett@users.noreply.github.com> Date: Thu, 20 Apr 2023 14:21:41 -0400 Subject: [PATCH 120/650] Update LAPS.md --- docset/winserver2022-ps/laps/LAPS.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docset/winserver2022-ps/laps/LAPS.md b/docset/winserver2022-ps/laps/LAPS.md index c13436bc3d..84b98e43a0 100644 --- a/docset/winserver2022-ps/laps/LAPS.md +++ b/docset/winserver2022-ps/laps/LAPS.md @@ -1,6 +1,5 @@ --- -description: This reference provides cmdlet descriptions and syntax for the Windows Local Administrator Password -Solution (LAPS) module. +description: This reference provides cmdlet descriptions and syntax for the Windows Local Administrator Password Solution (LAPS) module. Module Name: LAPS Module Guid: 8eb7ddf9-7890-49ae-9af1-3b41d7e63c41 Download Help Link: https://aka.ms/winsvr-2022-pshelp From 9cadf9876b6d87daddffc0b906bce092138edbf9 Mon Sep 17 00:00:00 2001 From: MattTB <49200399+mtrilbybassett@users.noreply.github.com> Date: Thu, 20 Apr 2023 15:04:46 -0400 Subject: [PATCH 121/650] Update Update-LapsADSchema.md --- docset/winserver2022-ps/laps/Update-LapsADSchema.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docset/winserver2022-ps/laps/Update-LapsADSchema.md b/docset/winserver2022-ps/laps/Update-LapsADSchema.md index 15daffa46f..9f4c825eb7 100644 --- a/docset/winserver2022-ps/laps/Update-LapsADSchema.md +++ b/docset/winserver2022-ps/laps/Update-LapsADSchema.md @@ -1,6 +1,5 @@ --- -description: Extends the Active Directory (AD) schema with the Windows Local Administrator Password Solution -(LAPS) schema attributes. +description: Extends the Active Directory (AD) schema with the Windows Local Administrator Password Solution (LAPS) schema attributes. external help file: lapspsh.dll-Help.xml Module Name: LAPS online version: https://learn.microsoft.com/powershell/module/laps/update-lapsadschema?view=windowsserver2022-ps&wt.mc_id=ps-gethelp From 4d0ff81435cd4576945b65b367bc8b2a86227e0b Mon Sep 17 00:00:00 2001 From: Tina Burden Date: Thu, 27 Apr 2023 08:35:44 -0700 Subject: [PATCH 122/650] Apply suggestions from code review Co-authored-by: Dario Woitasen <33589238+dariomws@users.noreply.github.com> --- docset/winserver2016-ps/defender/Set-MpPreference.md | 2 +- docset/winserver2019-ps/defender/Set-MpPreference.md | 2 +- docset/winserver2022-ps/defender/Set-MpPreference.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docset/winserver2016-ps/defender/Set-MpPreference.md b/docset/winserver2016-ps/defender/Set-MpPreference.md index df9caeeca9..9adcabb2a6 100644 --- a/docset/winserver2016-ps/defender/Set-MpPreference.md +++ b/docset/winserver2016-ps/defender/Set-MpPreference.md @@ -106,7 +106,7 @@ Accept wildcard characters: False Indicates whether to check for new virus and spyware definitions before Windows Defender runs a scan. If you specify a value of $True, Windows Defender checks for new definitions. If you specify $False or don't specify a value, the scan begins with existing definitions. -This setting applies to scheduled scans, but it has no effect on scans initiated manually from the user interface or on scans started from the command line using "mpcmdrun -Scan" +This setting applies to scheduled scans, but it has no effect on scans initiated manually from the user interface or scans started from the command line using "mpcmdrun -Scan". ```yaml Type: Boolean diff --git a/docset/winserver2019-ps/defender/Set-MpPreference.md b/docset/winserver2019-ps/defender/Set-MpPreference.md index d9910b2313..d2dbe48781 100644 --- a/docset/winserver2019-ps/defender/Set-MpPreference.md +++ b/docset/winserver2019-ps/defender/Set-MpPreference.md @@ -114,7 +114,7 @@ Accept wildcard characters: False Indicates whether to check for new virus and spyware definitions before Windows Defender runs a scan. If you specify a value of `$True`, Windows Defender checks for new definitions. If you specify `$False` or don’t specify a value, the scan begins with existing definitions. -This setting applies to scheduled scans, but it has no effect on scans initiated manually from the user interface or on scans started from the command line using "mpcmdrun -Scan" +This setting applies to scheduled scans, but it has no effect on scans initiated manually from the user interface or on scans started from the command line using "mpcmdrun -Scan". ```yaml Type: Boolean diff --git a/docset/winserver2022-ps/defender/Set-MpPreference.md b/docset/winserver2022-ps/defender/Set-MpPreference.md index 1c936f9d41..32289f87fe 100644 --- a/docset/winserver2022-ps/defender/Set-MpPreference.md +++ b/docset/winserver2022-ps/defender/Set-MpPreference.md @@ -220,7 +220,7 @@ Accept wildcard characters: False Indicates whether to check for new virus and spyware definitions before Windows Defender runs a scan. If you specify a value of $True, Windows Defender checks for new definitions. If you specify $False or don't specify a value, the scan begins with existing definitions. -This setting applies to scheduled scans, but it has no effect on scans initiated manually from the user interface or on scans started from the command line using "mpcmdrun -Scan" +This setting applies to scheduled scans, but it has no effect on scans initiated manually from the user interface or on scans started from the command line using "mpcmdrun -Scan". ```yaml Type: Boolean From eab5ed4de9f1b4887a70eaefa52f11ff7abcc77b Mon Sep 17 00:00:00 2001 From: Sean Wheeler Date: Thu, 27 Apr 2023 10:22:46 -0700 Subject: [PATCH 123/650] Update Add-CAAuthorityInformationAccess.md Removed example 3 - does not use this cmdlet --- .../Add-CAAuthorityInformationAccess.md | 24 +++++-------------- 1 file changed, 6 insertions(+), 18 deletions(-) diff --git a/docset/winserver2022-ps/adcsadministration/Add-CAAuthorityInformationAccess.md b/docset/winserver2022-ps/adcsadministration/Add-CAAuthorityInformationAccess.md index 47fbb01a14..260ae18376 100644 --- a/docset/winserver2022-ps/adcsadministration/Add-CAAuthorityInformationAccess.md +++ b/docset/winserver2022-ps/adcsadministration/Add-CAAuthorityInformationAccess.md @@ -40,32 +40,20 @@ An AIA URI should specify either an AIA extension or an OCSP extension, but not ## EXAMPLES ### Example 1: Add AIA to the specified authority -``` -PS C:\> Add-CAAuthorityInformationAccess -AddToCertificateAia -Uri http://ca1.corp.contoso.com/pki + +```powershell +Add-CAAuthorityInformationAccess -AddToCertificateAia -Uri http://ca1.corp.contoso.com/pki ``` This command adds Authority Information Access (AIA) for the specified certification authority to 'http://ca1.corp.contoso.com/pki'. ### Example 2: Add AIA for OCSP -``` -PS C:\> Add-CAAuthorityInformationAccess -AddToCertificateOcsp -Uri http://www.corp.contoso.com/ocsp. -``` - -This command adds AIA for OCSP pointing to `http://www.corp.contoso.com/ocsp`. -### Example 3: Remove all AIA entries +```powershell +Add-CAAuthorityInformationAccess -AddToCertificateOcsp -Uri http://www.corp.contoso.com/ocsp. ``` -PS C:\> $AIA = Get-CAAuthorityInformationAccess - -PS C:\> $AIA | Remove-CAAuthorityInformationAccess -``` - -This example removes all AIA entries - -The first command gets the certificate authority information and stores the information in the variable named $AIA. - -The second command removes all the AIA entries that are stored in the $AIA variable. +This command adds AIA for OCSP pointing to `http://www.corp.contoso.com/ocsp`. ## PARAMETERS From 1297c6a9c76f005b3feb5a16ddc767791a732e56 Mon Sep 17 00:00:00 2001 From: Sean Wheeler Date: Thu, 27 Apr 2023 10:32:13 -0700 Subject: [PATCH 124/650] Add remove example to Remove cmdlet --- .../Remove-CAAuthorityInformationAccess.md | 20 +++++++++++++++---- 1 file changed, 16 insertions(+), 4 deletions(-) diff --git a/docset/winserver2022-ps/adcsadministration/Remove-CAAuthorityInformationAccess.md b/docset/winserver2022-ps/adcsadministration/Remove-CAAuthorityInformationAccess.md index 528f65cb7c..735c39b2ef 100644 --- a/docset/winserver2022-ps/adcsadministration/Remove-CAAuthorityInformationAccess.md +++ b/docset/winserver2022-ps/adcsadministration/Remove-CAAuthorityInformationAccess.md @@ -53,6 +53,18 @@ PS C:\> Remove-CAAuthorityInformationAccess -Uri "http://www.contoso.com/pki/orc This command removes all AIA and OCSP entries that match the URL `http://www.contoso.com/pki/orca1.crt`. +### Example 4: Remove all AIA entries + +```powershell +$AIA = Get-CAAuthorityInformationAccess +$AIA | Remove-CAAuthorityInformationAccess +``` + +This example removes all AIA entries + +The first command gets the certificate authority information and stores the information in the variable named $AIA. + +The second command removes all the AIA entries that are stored in the $AIA variable. ## PARAMETERS ### -AddToCertificateAia @@ -61,7 +73,7 @@ Indicates that the cmdlet adds the AIA URI. ```yaml Type: SwitchParameter Parameter Sets: RemoveAsAIA -Aliases: +Aliases: Required: False Position: Named @@ -76,7 +88,7 @@ Indicates that the cmdlet adds an Online Responder's URI. ```yaml Type: SwitchParameter Parameter Sets: RemoveAsOCSP -Aliases: +Aliases: Required: False Position: Named @@ -106,7 +118,7 @@ Forces the command to run without asking for user confirmation. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -122,7 +134,7 @@ This information is added to the CA properties and registry. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 1 From 2f4168efcbad09a0cc9da096d0e5f825fac1d4ba Mon Sep 17 00:00:00 2001 From: Mike Soule Date: Thu, 27 Apr 2023 14:41:05 -0700 Subject: [PATCH 125/650] m --- temp | 1 + 1 file changed, 1 insertion(+) create mode 100644 temp diff --git a/temp b/temp new file mode 100644 index 0000000000..8b13789179 --- /dev/null +++ b/temp @@ -0,0 +1 @@ + From 8f8ee5f1c4f5f84b1eaa4df78f1282f5fe6066d5 Mon Sep 17 00:00:00 2001 From: Mike Soule Date: Thu, 27 Apr 2023 14:42:44 -0700 Subject: [PATCH 126/650] Clean --- temp | 1 - 1 file changed, 1 deletion(-) delete mode 100644 temp diff --git a/temp b/temp deleted file mode 100644 index 8b13789179..0000000000 --- a/temp +++ /dev/null @@ -1 +0,0 @@ - From 3f98e1d9f4bddb3998b139a2dd00bbb053ae559f Mon Sep 17 00:00:00 2001 From: Anthony Howell Date: Thu, 27 Apr 2023 14:43:39 -0700 Subject: [PATCH 127/650] fix header spacing --- .../activedirectory/New-ADUser.md | 74 +++++++++++++++++++ 1 file changed, 74 insertions(+) diff --git a/docset/winserver2022-ps/activedirectory/New-ADUser.md b/docset/winserver2022-ps/activedirectory/New-ADUser.md index aed3b4a952..dd6ee070c0 100644 --- a/docset/winserver2022-ps/activedirectory/New-ADUser.md +++ b/docset/winserver2022-ps/activedirectory/New-ADUser.md @@ -11,6 +11,7 @@ title: New-ADUser # New-ADUser ## SYNOPSIS + Creates an Active Directory user. ## SYNTAX @@ -37,6 +38,7 @@ New-ADUser [-WhatIf] [-Confirm] [-AccountExpirationDate ] [-AccountNot ``` ## DESCRIPTION + The **New-ADUser** cmdlet creates an Active Directory user. You can set commonly used user property values by using the cmdlet parameters. @@ -68,7 +70,9 @@ Then pass these objects through the pipeline to the **New-ADUser** cmdlet to cre ## EXAMPLES + ### Example 1: Create a user with an imported certificate + ``` PS C:\> New-ADUser -Name "ChewDavid" -Certificate (New-Object System.Security.Cryptography.X509Certificates.X509Certificate -ArgumentList "Export.cer") ``` @@ -76,6 +80,7 @@ PS C:\> New-ADUser -Name "ChewDavid" -Certificate (New-Object System.Security.Cr This command creates a user named ChewDavid with a certificate imported from the file Export.cer. ### Example 2: Create a user and set properties + ``` PS C:\> New-ADUser -Name "ChewDavid" -OtherAttributes @{'title'="director";'mail'="chewdavid@fabrikam.com"} ``` @@ -83,6 +88,7 @@ PS C:\> New-ADUser -Name "ChewDavid" -OtherAttributes @{'title'="director";'mail This command creates a new user named ChewDavid and sets the **title** and **mail** properties on the new object. ### Example 3: Create an inetOrgPerson user + ``` PS C:\> New-ADUser -Name "ChewDavid" -Type iNetOrgPerson -Path "DC=AppNC" -Server lds.Fabrikam.com:50000 ``` @@ -90,6 +96,7 @@ PS C:\> New-ADUser -Name "ChewDavid" -Type iNetOrgPerson -Path "DC=AppNC" -Serve This command creates an **inetOrgPerson**-class user named ChewDavid on an AD LDS instance. ### Example 4: Create a user and set password + ``` PS C:\> New-ADUser -Name "ChewDavid" -Accountpassword (Read-Host -AsSecureString "AccountPassword") -Enabled $true ``` @@ -99,6 +106,7 @@ This command creates a new user named ChewDavid and sets the account password. ## PARAMETERS ### -AccountExpirationDate + Specifies the expiration date for an account. This parameter sets the **AccountExpirationDate** property of an account object. The LDAP display name (**ldapDisplayName**) for this property is accountExpires. @@ -121,6 +129,7 @@ Accept wildcard characters: False ``` ### -AccountNotDelegated + Indicates whether the security context of the user is delegated to a service. When this parameter is set to $True, the security context of the account is not delegated to a service even when the service account is set as trusted for Kerberos delegation. This parameter sets the **AccountNotDelegated** property for an Active Directory account. @@ -143,6 +152,7 @@ Accept wildcard characters: False ``` ### -AccountPassword + Specifies a new password value for an account. This value is stored as an encrypted string. @@ -172,6 +182,7 @@ Accept wildcard characters: False ``` ### -AllowReversiblePasswordEncryption + Indicates whether reversible password encryption is allowed for the account. This parameter sets the **AllowReversiblePasswordEncryption** property of the account. This parameter also sets the **ADS_UF_ENCRYPTED_TEXT_PASSWORD_ALLOWED** flag of the Active Directory User Account Control (UAC) attribute. @@ -195,6 +206,7 @@ Accept wildcard characters: False ### -AuthenticationPolicy + Specifies an Active Directory Domain Services authentication policy object. Specify the authentication policy object in one of the following formats: @@ -220,6 +232,7 @@ Accept wildcard characters: False ``` ### -AuthenticationPolicySilo + Specifies an Active Directory Domain Services authentication policy silo object. Specify the authentication policy silo object in one of the following formats: @@ -245,6 +258,7 @@ Accept wildcard characters: False ``` ### -AuthType + Specifies the authentication method to use. The acceptable values for this parameter are: @@ -269,6 +283,7 @@ Accept wildcard characters: False ``` ### -CannotChangePassword + Indicates whether the account password can be changed. This parameter sets the **CannotChangePassword** property of an account. The acceptable values for this parameter are: @@ -289,6 +304,7 @@ Accept wildcard characters: False ``` ### -Certificates + Specifies the DER-encoded X.509v3 certificates of the account. These certificates include the public key certificates issued to this account by the Microsoft Certificate Service. This parameter sets the Certificates property of the account object. The LDAP display name (ldapDisplayName) for this property is userCertificate. ```yaml @@ -304,6 +320,7 @@ Accept wildcard characters: False ``` ### -ChangePasswordAtLogon + Indicates whether a password must be changed during the next logon attempt. The acceptable values for this parameter are: @@ -325,6 +342,7 @@ Accept wildcard characters: False ``` ### -City + Specifies the user's town or city. This parameter sets the **City** property of a user object. The LDAP display name (**ldapDisplayName**) of this property is l. @@ -342,6 +360,7 @@ Accept wildcard characters: False ``` ### -Company + Specifies the user's company. This parameter sets the **Company** property of a user object. The LDAP display name (**ldapDisplayName**) of this property is company. @@ -359,6 +378,7 @@ Accept wildcard characters: False ``` ### -CompoundIdentitySupported + Specifies whether an account supports Kerberos service tickets which includes the authorization data for the user's device. This value sets the compound identity supported flag of the Active Directory **msDS-SupportedEncryptionTypes** attribute. The acceptable values for this parameter are: @@ -382,6 +402,7 @@ Accept wildcard characters: False ``` ### -Confirm + Prompts you for confirmation before running the cmdlet. ```yaml @@ -397,6 +418,7 @@ Accept wildcard characters: False ``` ### -Country + Specifies the country or region code for the user's language of choice. This parameter sets the **Country** property of a user object. The LDAP display name (**ldapDisplayName**) of this property is c. @@ -415,6 +437,7 @@ Accept wildcard characters: False ``` ### -Credential + Specifies the user account credentials to use to perform this task. The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory PowerShell provider drive. If the cmdlet is run from such a provider drive, the account associated with the drive is the default. @@ -440,6 +463,7 @@ Accept wildcard characters: False ``` ### -Department + Specifies the user's department. This parameter sets the **Department** property of a user object. The LDAP display name (**ldapDisplayName**) of this property is department. @@ -457,6 +481,7 @@ Accept wildcard characters: False ``` ### -Description + Specifies a description of the object. This parameter sets the value of the **Description** property for the user object. The LDAP display name (**ldapDisplayName**) for this property is description. @@ -474,6 +499,7 @@ Accept wildcard characters: False ``` ### -DisplayName + Specifies the display name of the object. This parameter sets the **DisplayName** property of the user object. The LDAP display name (**ldapDisplayName**) for this property is displayName. @@ -491,6 +517,7 @@ Accept wildcard characters: False ``` ### -Division + Specifies the user's division. This parameter sets the **Division** property of a user object. The LDAP display name (**ldapDisplayName**) of this property is division. @@ -508,6 +535,7 @@ Accept wildcard characters: False ``` ### -EmailAddress + Specifies the user's e-mail address. This parameter sets the **EmailAddress** property of a user object. The LDAP display name (**ldapDisplayName**) of this property is mail. @@ -525,6 +553,7 @@ Accept wildcard characters: False ``` ### -EmployeeID + Specifies the user's employee ID. This parameter sets the **EmployeeID** property of a user object. The LDAP display name (**ldapDisplayName**) of this property is employeeID. @@ -542,6 +571,7 @@ Accept wildcard characters: False ``` ### -EmployeeNumber + Specifies the user's employee number. This parameter sets the **EmployeeNumber** property of a user object. The LDAP display name (**ldapDisplayName**) of this property is employeeNumber. @@ -559,6 +589,7 @@ Accept wildcard characters: False ``` ### -Enabled + Specifies if an account is enabled. An enabled account requires a password. This parameter sets the **Enabled** property for an account object. @@ -581,6 +612,7 @@ Accept wildcard characters: False ``` ### -Fax + Specifies the user's fax phone number. This parameter sets the **Fax** property of a user object. The LDAP display name (**ldapDisplayName**) of this property is facsimileTelephoneNumber. @@ -598,6 +630,7 @@ Accept wildcard characters: False ``` ### -GivenName + Specifies the user's given name. This parameter sets the **GivenName** property of a user object. The LDAP display name (**ldapDisplayName**) of this property is givenName. @@ -615,6 +648,7 @@ Accept wildcard characters: False ``` ### -HomeDirectory + Specifies a user's home directory. This parameter sets the **HomeDirectory** property of a user object. The LDAP display name (**ldapDisplayName**) for this property is homeDirectory. @@ -632,6 +666,7 @@ Accept wildcard characters: False ``` ### -HomeDrive + Specifies a drive that is associated with the UNC path defined by the **HomeDirectory** property. The drive letter is specified as ``: where `` indicates the letter of the drive to associate. The `` must be a single, uppercase letter and the colon is required. @@ -651,6 +686,7 @@ Accept wildcard characters: False ``` ### -HomePage + Specifies the URL of the home page of the object. This parameter sets the **homePage** property of a user object. The LDAP display name (**ldapDisplayName**) for this property is wWWHomePage. @@ -668,6 +704,7 @@ Accept wildcard characters: False ``` ### -HomePhone + Specifies the user's home telephone number. This parameter sets the **HomePhone** property of a user object. The LDAP display name (**ldapDisplayName**) of this property is homePhone. @@ -685,6 +722,7 @@ Accept wildcard characters: False ``` ### -Initials + Specifies the initials that represent part of a user's name. You can use this value for the user's middle initial. This parameter sets the **Initials** property of a user object. @@ -703,6 +741,7 @@ Accept wildcard characters: False ``` ### -Instance + Specifies an instance of a user object to use as a template for a new user object. You can use an instance of an existing user object as a template or you can construct a new user object for template use. @@ -731,6 +770,7 @@ Accept wildcard characters: False ``` ### -KerberosEncryptionType + Specifies whether an account supports Kerberos encryption types which are used during creation of service tickets. This value sets the encryption types supported flags of the Active Directory **msDS-SupportedEncryptionTypes** attribute. Possible values for this parameter are: @@ -762,6 +802,7 @@ Accept wildcard characters: False ``` ### -LogonWorkstations + Specifies the computers that the user can access. To specify more than one computer, create a single comma-separated list. You can identify a computer by using the Security Account Manager (SAM) account name (sAMAccountName) or the DNS host name of the computer. @@ -782,6 +823,7 @@ Accept wildcard characters: False ``` ### -Manager + Specifies the user's manager. This parameter sets the **Manager** property of a user object. This parameter is set by providing one of the following property values. @@ -806,6 +848,7 @@ Accept wildcard characters: False ``` ### -MobilePhone + Specifies the user's mobile phone number. This parameter sets the **MobilePhone** property of a user object. The LDAP display name (**ldapDisplayName**) of this property is mobile. @@ -823,6 +866,7 @@ Accept wildcard characters: False ``` ### -Name + Specifies the name of the object. This parameter sets the **Name** property of a user object. The LDAP display name (**ldapDisplayName**) of this property is name. @@ -840,6 +884,7 @@ Accept wildcard characters: False ``` ### -Office + Specifies the location of the user's office or place of business. This parameter sets the **Office** property of a user object. The LDAP display name (**ldapDisplayName**) of this property is physicalDeliveryOfficeName. @@ -857,6 +902,7 @@ Accept wildcard characters: False ``` ### -OfficePhone + Specifies the user's office telephone number. This parameter sets the **OfficePhone** property of a user object. The LDAP display name (**ldapDisplayName**) of this property is telephoneNumber. @@ -874,6 +920,7 @@ Accept wildcard characters: False ``` ### -Organization + Specifies the user's organization. This parameter sets the **Organization** property of a user object. The LDAP display name (**ldapDisplayName**) of this property is o. @@ -891,6 +938,7 @@ Accept wildcard characters: False ``` ### -OtherAttributes + Specifies object attribute values for attributes that are not represented by cmdlet parameters. You can set one or more parameters at the same time with this parameter. If an attribute takes more than one value, you can assign multiple values. @@ -921,6 +969,7 @@ Accept wildcard characters: False ``` ### -OtherName + Specifies a name in addition to a user's given name and surname, such as the user's middle name. This parameter sets the **OtherName** property of a user object. The LDAP display name (**ldapDisplayName**) of this property is middleName. @@ -938,6 +987,7 @@ Accept wildcard characters: False ``` ### -PassThru + Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output. @@ -954,6 +1004,7 @@ Accept wildcard characters: False ``` ### -PasswordNeverExpires + Specifies whether the password of an account can expire. This parameter sets the **PasswordNeverExpires** property of an account object. This parameter also sets the **ADS_UF_DONT_EXPIRE_PASSWD** flag of the Active Directory User Account Control attribute. @@ -977,6 +1028,7 @@ Accept wildcard characters: False ``` ### -PasswordNotRequired + Specifies whether the account requires a password. A password is not required for a new account. This parameter sets the **PasswordNotRequired** property of an account object. @@ -994,6 +1046,7 @@ Accept wildcard characters: False ``` ### -Path + Specifies the X.500 path of the OU or container where the new object is created. In many cases, a default value is used for the *Path* parameter if no value is specified. @@ -1031,6 +1084,7 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` ### -POBox + Specifies the user's post office box number. This parameter sets the **POBox** property of a user object. The LDAP display name (**ldapDisplayName**) of this property is postOfficeBox. @@ -1047,6 +1101,7 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` ### -PostalCode + Specifies the user's postal code or zip code. This parameter sets the **PostalCode** property of a user object. The LDAP display name (**ldapDisplayName**) of this property is postalCode. @@ -1064,6 +1119,7 @@ Accept wildcard characters: False ``` ### -PrincipalsAllowedToDelegateToAccount + Specifies an array of principal objects. This parameter sets the **msDS-AllowedToActOnBehalfOfOtherIdentity** attribute of a computer account object. @@ -1080,6 +1136,7 @@ Accept wildcard characters: False ``` ### -ProfilePath + Specifies a path to the user's profile. This value can be a local absolute path or a Universal Naming Convention (UNC) path. This parameter sets the **ProfilePath** property of the user object. @@ -1098,6 +1155,7 @@ Accept wildcard characters: False ``` ### -SamAccountName + Specifies the Security Account Manager (SAM) account name of the user, group, computer, or service account. The maximum length of the description is 256 characters. To be compatible with older operating systems, create a SAM account name that is 20 characters or less. @@ -1119,6 +1177,7 @@ Accept wildcard characters: False ``` ### -ScriptPath + Specifies a path to the user's log on script. This value can be a local absolute path or a Universal Naming Convention (UNC) path. This parameter sets the **ScriptPath** property of the user object. @@ -1137,6 +1196,7 @@ Accept wildcard characters: False ``` ### -Server + Specifies the AD DS instance to connect to, by providing one of the following values for a corresponding domain name or directory server. The service may be any of the following: AD LDS, AD DS, or Active Directory snapshot instance. @@ -1172,6 +1232,7 @@ Accept wildcard characters: False ``` ### -ServicePrincipalNames + Specifies the service principal names for the account. This parameter sets the **ServicePrincipalNames** property of the account. The LDAP display name (**ldapDisplayName**) for this property is servicePrincipalName. @@ -1190,6 +1251,7 @@ Accept wildcard characters: False ``` ### -SmartcardLogonRequired + Specifies whether a smart card is required to logon. This parameter sets the **SmartCardLoginRequired** property for a user object. This parameter also sets the **ADS_UF_SMARTCARD_REQUIRED** flag of the Active Directory User Account Control attribute. @@ -1211,6 +1273,7 @@ Accept wildcard characters: False ``` ### -State + Specifies the user's or Organizational Unit's state or province. This parameter sets the **State** property of a user object. The LDAP display name (**ldapDisplayName**) of this property is st. @@ -1228,6 +1291,7 @@ Accept wildcard characters: False ``` ### -StreetAddress + Specifies the user's street address. This parameter sets the **StreetAddress** property of a user object. The LDAP display name (**ldapDisplayName**) of this property is streetAddress. @@ -1245,6 +1309,7 @@ Accept wildcard characters: False ``` ### -Surname + Specifies the user's last name or surname. This parameter sets the **Surname** property of a user object. The LDAP display name (**ldapDisplayName**) of this property is sn. @@ -1262,6 +1327,7 @@ Accept wildcard characters: False ``` ### -Title + Specifies the user's title. This parameter sets the **Title** property of a user object. The LDAP display name (**ldapDisplayName**) of this property is title. @@ -1279,6 +1345,7 @@ Accept wildcard characters: False ``` ### -TrustedForDelegation + Indicates whether an account is trusted for Kerberos delegation. A service that runs under an account that is trusted for Kerberos delegation can assume the identity of a client requesting the service. This parameter sets the **TrustedForDelegation** property of an account object. @@ -1301,6 +1368,7 @@ Accept wildcard characters: False ``` ### -Type + Specifies the type of object to create. Set the *Type* parameter to the LDAP display name of the Active Directory schema class that represents the type of object that you want to create. The selected type must be a subclass of the User schema class. @@ -1319,6 +1387,7 @@ Accept wildcard characters: False ``` ### -UserPrincipalName + Specifies a user principal name (UPN) in the format `@`. A UPN is a friendly name assigned by an administrator that is shorter than the LDAP distinguished name used by the system and easier to remember. The UPN is independent of the user object's distinguished name, so a user object can be moved or renamed without affecting the user logon name. @@ -1337,6 +1406,7 @@ Accept wildcard characters: False ``` ### -WhatIf + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -1353,20 +1423,24 @@ Accept wildcard characters: False ``` ### CommonParameters + 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). ## INPUTS ### None or Microsoft.ActiveDirectory.Management.ADUser + A user object that is a template for the new user object is received by the *Instance* parameter. ## OUTPUTS ### None or Microsoft.ActiveDirectory.Management.ADUser + Returns the new user object when the *PassThru* parameter is specified. By default, this cmdlet does not generate any output. ## NOTES + * This cmdlet does not work with an Active Directory snapshot. * This cmdlet does not work with a read-only domain controller. From 627a12bf4c673e0ffbfd685d9c9239a6125e4467 Mon Sep 17 00:00:00 2001 From: Anthony Howell Date: Thu, 27 Apr 2023 14:46:33 -0700 Subject: [PATCH 128/650] switch * to _ --- .../activedirectory/New-ADUser.md | 50 +++++++++---------- 1 file changed, 25 insertions(+), 25 deletions(-) diff --git a/docset/winserver2022-ps/activedirectory/New-ADUser.md b/docset/winserver2022-ps/activedirectory/New-ADUser.md index dd6ee070c0..a8983a17a4 100644 --- a/docset/winserver2022-ps/activedirectory/New-ADUser.md +++ b/docset/winserver2022-ps/activedirectory/New-ADUser.md @@ -42,27 +42,27 @@ New-ADUser [-WhatIf] [-Confirm] [-AccountExpirationDate ] [-AccountNot The **New-ADUser** cmdlet creates an Active Directory user. You can set commonly used user property values by using the cmdlet parameters. -You can set property values that are not associated with cmdlet parameters by using the *OtherAttributes* parameter. +You can set property values that are not associated with cmdlet parameters by using the _OtherAttributes_ parameter. When using this parameter, be sure to place single quotes around the attribute name. -You must specify the *SamAccountName* parameter to create a user. +You must specify the _SamAccountName_ parameter to create a user. You can use the **New-ADUser** cmdlet to create different types of user accounts such as iNetOrgPerson accounts. -To do this in Active Directory Domain Services (AD DS), set the *Type* parameter to the Lightweight Directory Access Protocol (LDAP) display name for the type of account you want to create. +To do this in Active Directory Domain Services (AD DS), set the _Type_ parameter to the Lightweight Directory Access Protocol (LDAP) display name for the type of account you want to create. This type can be any class in the Active Directory schema that is a subclass of user and that has an object category of person. -The *Path* parameter specifies the container or organizational unit (OU) for the new user. -When you do not specify the *Path* parameter, the cmdlet creates a user object in the default container for user objects in the domain. +The _Path_ parameter specifies the container or organizational unit (OU) for the new user. +When you do not specify the _Path_ parameter, the cmdlet creates a user object in the default container for user objects in the domain. The following methods explain different ways to create an object by using this cmdlet. Method 1: Use the **New-ADUser** cmdlet, specify the required parameters, and set any additional property values by using the cmdlet parameters. Method 2: Use a template to create the new object. -To do this, create a new user object or retrieve a copy of an existing user object and set the *Instance* parameter to this object. -The object provided to the *Instance* parameter is used as a template for the new object. +To do this, create a new user object or retrieve a copy of an existing user object and set the _Instance_ parameter to this object. +The object provided to the _Instance_ parameter is used as a template for the new object. You can override property values from the template by setting cmdlet parameters. -For examples and more information, see the *Instance* parameter description for this cmdlet. +For examples and more information, see the _Instance_ parameter description for this cmdlet. Method 3: Use the Import-Csv cmdlet with the **New-ADUser** cmdlet to create multiple Active Directory user objects. To do this, use the **Import-Csv** cmdlet to create the custom objects from a comma-separated value (CSV) file that contains a list of object properties. @@ -446,7 +446,7 @@ To specify this parameter, you can type a user name, such as User1 or Domain01\U If you specify a user name for this parameter, the cmdlet prompts for a password. You can also create a **PSCredential** object by using a script or by using the **Get-Credential** cmdlet. -You can then set the *Credential* parameter to the **PSCredential** object. +You can then set the _Credential_ parameter to the **PSCredential** object. If the acting credentials do not have directory-level permission to perform the task, Active Directory PowerShell returns a terminating error. @@ -749,11 +749,11 @@ You can construct a new user object using the Windows PowerShell command line or Method 1: Use an existing user object as a template for a new object. To retrieve an instance of an existing user object, use a cmdlet such as **Get-ADUser**. -Then provide this object to the *Instance* parameter of the **New-ADUser** cmdlet to create a new user object. +Then provide this object to the _Instance_ parameter of the **New-ADUser** cmdlet to create a new user object. You can override property values of the new object by setting the appropriate parameters. Method 2: Create a new **ADUser** object and set the property values by using the Windows PowerShell command line interface. -Then pass this object to the *Instance* parameter of the **New-ADUser** cmdlet to create the new Active Directory user object. +Then pass this object to the _Instance_ parameter of the **New-ADUser** cmdlet to create the new Active Directory user object. Note: Specified attributes are not validated, so attempting to set attributes that do not exist or cannot be set raises an error. @@ -1049,28 +1049,28 @@ Accept wildcard characters: False Specifies the X.500 path of the OU or container where the new object is created. -In many cases, a default value is used for the *Path* parameter if no value is specified. +In many cases, a default value is used for the _Path_ parameter if no value is specified. The rules for determining the default value are given below. Note that rules listed first are evaluated first and when a default value can be determined, no further rules are evaluated. -In Active Directory Domain Services (AD DS) environments, a default value for *Path* is set in the following cases: +In Active Directory Domain Services (AD DS) environments, a default value for _Path_ is set in the following cases: - If the cmdlet is run from an Active Directory PowerShell provider drive, the parameter is set to the current path of the provider drive. - If the cmdlet has a default path, this is used. -For example: in New-ADUser, the *Path* parameter defaults to the Users container. -- If none of the previous cases apply, the default value of *Path* is set to the default partition or naming context of the target domain. +For example: in New-ADUser, the _Path_ parameter defaults to the Users container. +- If none of the previous cases apply, the default value of _Path_ is set to the default partition or naming context of the target domain. -In AD LDS environments, a default value for *Path* is set in the following cases: +In AD LDS environments, a default value for _Path_ is set in the following cases: - If the cmdlet is run from an Active Directory module for PowerShell provider drive, the parameter is set to the current path of the provider drive. - If the cmdlet has a default path, this is used. -For example: in **New-ADUser**, the *Path* parameter defaults to the Users container. -- If the target AD LDS instance has a default naming context, the default value of *Path* is set to the default naming context. +For example: in **New-ADUser**, the _Path_ parameter defaults to the Users container. +- If the target AD LDS instance has a default naming context, the default value of _Path_ is set to the default naming context. To specify a default naming context for an AD LDS environment, set the **msDS-defaultNamingContext** property of the Active Directory directory service agent object (**nTDSDSA**) for the AD LDS instance. -- If none of the previous cases apply, the *Path* parameter does not take any default value. +- If none of the previous cases apply, the _Path_ parameter does not take any default value. -Note: The Active Directory Provider cmdlets, such New-Item, Remove-Item, Remove-ItemProperty, *Rename-Item*, and Set-ItemProperty also contain a *Path* property. -However, for the Active Directory Provider cmdlets, the *Path* parameter identifies the path of the actual object rather than the container. +Note: The Active Directory Provider cmdlets, such New-Item, Remove-Item, Remove-ItemProperty, *Rename-Item*, and Set-ItemProperty also contain a _Path_ property. +However, for the Active Directory Provider cmdlets, the _Path_ parameter identifies the path of the actual object rather than the container. ```yaml Type: String @@ -1215,7 +1215,7 @@ Directory server values: The default value for this parameter is determined by one of the following methods in the order that they are listed: -- By using the *Server* value from objects passed through the pipeline +- By using the _Server_ value from objects passed through the pipeline - By using the server information associated with the AD DS Windows PowerShell provider drive, when the cmdlet runs in that drive - By using the domain of the computer running Windows PowerShell @@ -1370,7 +1370,7 @@ Accept wildcard characters: False ### -Type Specifies the type of object to create. -Set the *Type* parameter to the LDAP display name of the Active Directory schema class that represents the type of object that you want to create. +Set the _Type_ parameter to the LDAP display name of the Active Directory schema class that represents the type of object that you want to create. The selected type must be a subclass of the User schema class. If this parameter is not specified it defaults to User. @@ -1430,13 +1430,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ### None or Microsoft.ActiveDirectory.Management.ADUser -A user object that is a template for the new user object is received by the *Instance* parameter. +A user object that is a template for the new user object is received by the _Instance_ parameter. ## OUTPUTS ### None or Microsoft.ActiveDirectory.Management.ADUser -Returns the new user object when the *PassThru* parameter is specified. +Returns the new user object when the _PassThru_ parameter is specified. By default, this cmdlet does not generate any output. ## NOTES From 2a3c856bdb2a3daafacce289202b3869c3512d73 Mon Sep 17 00:00:00 2001 From: Anthony Howell Date: Thu, 27 Apr 2023 14:48:36 -0700 Subject: [PATCH 129/650] cmdlet backticks --- .../activedirectory/New-ADUser.md | 38 +++++++++---------- 1 file changed, 19 insertions(+), 19 deletions(-) diff --git a/docset/winserver2022-ps/activedirectory/New-ADUser.md b/docset/winserver2022-ps/activedirectory/New-ADUser.md index a8983a17a4..5081770549 100644 --- a/docset/winserver2022-ps/activedirectory/New-ADUser.md +++ b/docset/winserver2022-ps/activedirectory/New-ADUser.md @@ -39,7 +39,7 @@ New-ADUser [-WhatIf] [-Confirm] [-AccountExpirationDate ] [-AccountNot ## DESCRIPTION -The **New-ADUser** cmdlet creates an Active Directory user. +The `New-ADUser` cmdlet creates an Active Directory user. You can set commonly used user property values by using the cmdlet parameters. You can set property values that are not associated with cmdlet parameters by using the _OtherAttributes_ parameter. @@ -47,7 +47,7 @@ When using this parameter, be sure to place single quotes around the attribute n You must specify the _SamAccountName_ parameter to create a user. -You can use the **New-ADUser** cmdlet to create different types of user accounts such as iNetOrgPerson accounts. +You can use the `New-ADUser` cmdlet to create different types of user accounts such as iNetOrgPerson accounts. To do this in Active Directory Domain Services (AD DS), set the _Type_ parameter to the Lightweight Directory Access Protocol (LDAP) display name for the type of account you want to create. This type can be any class in the Active Directory schema that is a subclass of user and that has an object category of person. @@ -56,7 +56,7 @@ When you do not specify the _Path_ parameter, the cmdlet creates a user object i The following methods explain different ways to create an object by using this cmdlet. -Method 1: Use the **New-ADUser** cmdlet, specify the required parameters, and set any additional property values by using the cmdlet parameters. +Method 1: Use the `New-ADUser` cmdlet, specify the required parameters, and set any additional property values by using the cmdlet parameters. Method 2: Use a template to create the new object. To do this, create a new user object or retrieve a copy of an existing user object and set the _Instance_ parameter to this object. @@ -64,9 +64,9 @@ The object provided to the _Instance_ parameter is used as a template for the ne You can override property values from the template by setting cmdlet parameters. For examples and more information, see the _Instance_ parameter description for this cmdlet. -Method 3: Use the Import-Csv cmdlet with the **New-ADUser** cmdlet to create multiple Active Directory user objects. -To do this, use the **Import-Csv** cmdlet to create the custom objects from a comma-separated value (CSV) file that contains a list of object properties. -Then pass these objects through the pipeline to the **New-ADUser** cmdlet to create the user objects. +Method 3: Use the Import-Csv cmdlet with the `New-ADUser` cmdlet to create multiple Active Directory user objects. +To do this, use the `Import-Csv` cmdlet to create the custom objects from a comma-separated value (CSV) file that contains a list of object properties. +Then pass these objects through the pipeline to the `New-ADUser` cmdlet to create the user objects. ## EXAMPLES @@ -380,14 +380,14 @@ Accept wildcard characters: False ### -CompoundIdentitySupported Specifies whether an account supports Kerberos service tickets which includes the authorization data for the user's device. -This value sets the compound identity supported flag of the Active Directory **msDS-SupportedEncryptionTypes** attribute. +This value sets the compound identity supported flag of the Active Directory `msDS-SupportedEncryptionTypes` attribute. The acceptable values for this parameter are: - $False or 0 - $True or 1 -Warning: Domain-joined Windows systems and services such as clustering manage their own **msDS-SupportedEncryptionTypes** attribute. -Therefore any changes to the flag on the **msDS-SupportedEncryptionTypes** attribute are overwritten by the service or system that manages the setting. +Warning: Domain-joined Windows systems and services such as clustering manage their own `msDS-SupportedEncryptionTypes` attribute. +Therefore any changes to the flag on the `msDS-SupportedEncryptionTypes` attribute are overwritten by the service or system that manages the setting. ```yaml Type: Boolean @@ -445,7 +445,7 @@ If the cmdlet is run from such a provider drive, the account associated with the To specify this parameter, you can type a user name, such as User1 or Domain01\User01 or you can specify a **PSCredential** object. If you specify a user name for this parameter, the cmdlet prompts for a password. -You can also create a **PSCredential** object by using a script or by using the **Get-Credential** cmdlet. +You can also create a **PSCredential** object by using a script or by using the `Get-Credential` cmdlet. You can then set the _Credential_ parameter to the **PSCredential** object. If the acting credentials do not have directory-level permission to perform the task, Active Directory PowerShell returns a terminating error. @@ -748,12 +748,12 @@ You can use an instance of an existing user object as a template or you can cons You can construct a new user object using the Windows PowerShell command line or by using a script. Method 1: Use an existing user object as a template for a new object. -To retrieve an instance of an existing user object, use a cmdlet such as **Get-ADUser**. -Then provide this object to the _Instance_ parameter of the **New-ADUser** cmdlet to create a new user object. +To retrieve an instance of an existing user object, use a cmdlet such as `Get-ADUser`. +Then provide this object to the _Instance_ parameter of the `New-ADUser` cmdlet to create a new user object. You can override property values of the new object by setting the appropriate parameters. Method 2: Create a new **ADUser** object and set the property values by using the Windows PowerShell command line interface. -Then pass this object to the _Instance_ parameter of the **New-ADUser** cmdlet to create the new Active Directory user object. +Then pass this object to the _Instance_ parameter of the `New-ADUser` cmdlet to create the new Active Directory user object. Note: Specified attributes are not validated, so attempting to set attributes that do not exist or cannot be set raises an error. @@ -772,7 +772,7 @@ Accept wildcard characters: False ### -KerberosEncryptionType Specifies whether an account supports Kerberos encryption types which are used during creation of service tickets. -This value sets the encryption types supported flags of the Active Directory **msDS-SupportedEncryptionTypes** attribute. +This value sets the encryption types supported flags of the Active Directory `msDS-SupportedEncryptionTypes` attribute. Possible values for this parameter are: - None @@ -785,8 +785,8 @@ None removes all encryption types from the account, resulting in the KDC being u DES is a weak encryption type that is not supported by default since Windows 7 and Windows Server 2008 R2. -Warning: Domain-joined Windows systems and services such as clustering manage their own **msDS-SupportedEncryptionTypes** attribute. -Therefore any changes to the flag on the **msDS-SupportedEncryptionTypes** attribute are overwritten by the service or system that manages the setting. +Warning: Domain-joined Windows systems and services such as clustering manage their own `msDS-SupportedEncryptionTypes` attribute. +Therefore any changes to the flag on the `msDS-SupportedEncryptionTypes` attribute are overwritten by the service or system that manages the setting. ```yaml Type: ADKerberosEncryptionType @@ -1064,9 +1064,9 @@ In AD LDS environments, a default value for _Path_ is set in the following cases - If the cmdlet is run from an Active Directory module for PowerShell provider drive, the parameter is set to the current path of the provider drive. - If the cmdlet has a default path, this is used. -For example: in **New-ADUser**, the _Path_ parameter defaults to the Users container. +For example: in `New-ADUser`, the _Path_ parameter defaults to the Users container. - If the target AD LDS instance has a default naming context, the default value of _Path_ is set to the default naming context. -To specify a default naming context for an AD LDS environment, set the **msDS-defaultNamingContext** property of the Active Directory directory service agent object (**nTDSDSA**) for the AD LDS instance. +To specify a default naming context for an AD LDS environment, set the `msDS-defaultNamingContext` property of the Active Directory directory service agent object (**nTDSDSA**) for the AD LDS instance. - If none of the previous cases apply, the _Path_ parameter does not take any default value. Note: The Active Directory Provider cmdlets, such New-Item, Remove-Item, Remove-ItemProperty, *Rename-Item*, and Set-ItemProperty also contain a _Path_ property. @@ -1121,7 +1121,7 @@ Accept wildcard characters: False ### -PrincipalsAllowedToDelegateToAccount Specifies an array of principal objects. -This parameter sets the **msDS-AllowedToActOnBehalfOfOtherIdentity** attribute of a computer account object. +This parameter sets the `msDS-AllowedToActOnBehalfOfOtherIdentity` attribute of a computer account object. ```yaml Type: ADPrincipal[] From 916b6826038b19bd567801d54110a4c999409310 Mon Sep 17 00:00:00 2001 From: Kevin Marquette Date: Thu, 27 Apr 2023 21:51:10 +0000 Subject: [PATCH 130/650] auto format --- .../activedirectory/Get-ADComputer.md | 108 +++++++++++------- 1 file changed, 67 insertions(+), 41 deletions(-) diff --git a/docset/winserver2022-ps/activedirectory/Get-ADComputer.md b/docset/winserver2022-ps/activedirectory/Get-ADComputer.md index d8920e3020..7b978a715c 100644 --- a/docset/winserver2022-ps/activedirectory/Get-ADComputer.md +++ b/docset/winserver2022-ps/activedirectory/Get-ADComputer.md @@ -11,11 +11,13 @@ title: Get-ADComputer # Get-ADComputer ## SYNOPSIS + Gets one or more Active Directory computers. ## SYNTAX ### Filter (Default) + ```powershell Get-ADComputer [-AuthType ] [-Credential ] -Filter [-Properties ] [-ResultPageSize ] [-ResultSetSize ] [-SearchBase ] [-SearchScope ] @@ -23,12 +25,14 @@ Get-ADComputer [-AuthType ] [-Credential ] -Filter ] [-Credential ] [-Identity] [-Partition ] [-Properties ] [-Server ] [] ``` ### LdapFilter + ```powershell Get-ADComputer [-AuthType ] [-Credential ] -LDAPFilter [-Properties ] [-ResultPageSize ] [-ResultSetSize ] [-SearchBase ] @@ -36,25 +40,27 @@ Get-ADComputer [-AuthType ] [-Credential ] -LDAPFilter ``` ## DESCRIPTION + The **Get-ADComputer** cmdlet gets a computer or performs a search to retrieve multiple computers. -The *Identity* parameter specifies the Active Directory computer to retrieve. +The _Identity_ parameter specifies the Active Directory computer to retrieve. You can identify a computer by its distinguished name, GUID, security identifier (SID) or Security Accounts Manager (SAM) account name. -You can also set the parameter to a computer object variable, such as `$` or pass a computer object through the pipeline to the *Identity* parameter. +You can also set the parameter to a computer object variable, such as `$` or pass a computer object through the pipeline to the _Identity_ parameter. -To search for and retrieve more than one computer, use the *Filter* or *LDAPFilter* parameters. -The *Filter* parameter uses the PowerShell Expression Language to write query strings for Active Directory. -PowerShell Expression Language syntax provides rich type conversion support for value types received by the *Filter* parameter. -For more information about the *Filter* parameter syntax, type `Get-Help` [about_ActiveDirectory_Filter](/previous-versions/windows/server/hh531527(v=ws.10)). -If you have existing Lightweight Directory Access Protocol (LDAP) query strings, you can use the *LDAPFilter* parameter. +To search for and retrieve more than one computer, use the _Filter_ or _LDAPFilter_ parameters. +The _Filter_ parameter uses the PowerShell Expression Language to write query strings for Active Directory. +PowerShell Expression Language syntax provides rich type conversion support for value types received by the _Filter_ parameter. +For more information about the _Filter_ parameter syntax, type `Get-Help` [about_ActiveDirectory_Filter](/previous-versions/windows/server/hh531527(v=ws.10)). +If you have existing Lightweight Directory Access Protocol (LDAP) query strings, you can use the _LDAPFilter_ parameter. This cmdlet retrieves a default set of computer object properties. -To retrieve additional properties use the *Properties* parameter. -For more information about the how to determine the properties for computer objects, see the *Properties* parameter description. +To retrieve additional properties use the _Properties_ parameter. +For more information about the how to determine the properties for computer objects, see the _Properties_ parameter description. ## EXAMPLES ### Example 1: Get specific computer that shows all properties + ```powershell PS C:\> Get-ADComputer -Identity "User01-SRV1" -Properties * @@ -140,6 +146,7 @@ whenCreated : 3/16/2009 4:15:00 PM This command gets a specific computer showing all the properties. ### Example 2: Get all computers with a name starting with a particular string + ```powershell PS C:\> Get-ADComputer -Filter 'Name -like "User01*"' -Properties IPv4Address | FT Name,DNSHostName,IPv4Address -A name dnshostname ipv4address @@ -151,6 +158,7 @@ User01-SRV2 User01-SRV2.User01.com 10.194.100.3 This command gets all the computers with a name starting with a particular string and shows the name, dns hostname, and IPv4 address. ### Example 3: Gets all computers that have changed their password in specific time frame + ```powershell PS C:\> $Date = [DateTime]::Today.AddDays(-90) PS C:\> Get-ADComputer -Filter 'PasswordLastSet -ge $Date' -Properties PasswordLastSet | FT Name,PasswordLastSet @@ -163,6 +171,7 @@ USER01-SRV5 3/12/2009 7:05:45 PM This command gets all the computers that have changed their password in the last 90 days. ### Example 4: Get computer accounts in a specific location using an LDAPFilter + ```powershell PS C:\> Get-ADComputer -LDAPFilter "(name=*laptop*)" -SearchBase "CN=Computers,DC= User01,DC=com" name @@ -171,9 +180,10 @@ pattiful-laptop davidche-laptop ``` -This command gets the computer accounts in the location CN=Computers,DC=User01,DC=com that are listed as laptops by using an *LDAPFilter*. +This command gets the computer accounts in the location CN=Computers,DC=User01,DC=com that are listed as laptops by using an _LDAPFilter_. ### Example 5: Get all computer accounts using a filter + ```powershell PS C:\> Get-ADComputer -Filter * ``` @@ -181,6 +191,7 @@ PS C:\> Get-ADComputer -Filter * This command gets all computer accounts. ### Example 6: Get all computers with a name starting with Computer01 or Computer02 + ```powershell PS C:\> Get-ADComputer -Filter 'Name -like "Computer01*" -or Name -like "Computer02*"' -Properties IPv4Address | FT Name,DNSHostName,IPv4Address -A name dnshostname ipv4address @@ -190,6 +201,7 @@ Computer02-SRV2 Computer02-SRV2.Computer02.com 10.194.100.3 ``` ### Example 7: Get all computers with a name starting with a string AND password last set before 30 days + ```powershell PS C:\> $Date = [DateTime]::Today.AddDays(-30) PS C:\> Get-ADComputer -Filter 'Name -like "Computer01*" -and PasswordLastSet -ge $Date' -Properties IPv4Address | FT Name,DNSHostName,IPv4Address -A @@ -200,10 +212,10 @@ Computer01-SRV1 Computer01-SRV1.Computer01.com 10.194.99.181 This command shows the name, DNS hostname, and IPv4 address. - ## PARAMETERS ### -AuthType + Specifies the authentication method to use. The acceptable values for this parameter are: @@ -228,6 +240,7 @@ Accept wildcard characters: False ``` ### -Credential + Specifies the user account credentials to use to perform this task. The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory module for Windows PowerShell provider drive. If the cmdlet is run from such a provider drive, the account associated with the drive is the default. @@ -236,7 +249,7 @@ To specify this parameter, you can type a user name, such as User1 or Domain01\U If you specify a user name for this parameter, the cmdlet prompts for a password. You can also create a **PSCredential** object by using a script or by using the **Get-Credential** cmdlet. -You can then set the *Credential* parameter to the **PSCredential** object. +You can then set the _Credential_ parameter to the **PSCredential** object. If the acting credentials do not have directory-level permission to perform the task, Active Directory module for Windows PowerShell returns a terminating error. @@ -253,11 +266,12 @@ Accept wildcard characters: False ``` ### -Filter + Specifies a query string that retrieves Active Directory objects. This string uses the Windows PowerShell Expression Language syntax. -The Windows PowerShell Expression Language syntax provides rich type-conversion support for value types received by the *Filter* parameter. +The Windows PowerShell Expression Language syntax provides rich type-conversion support for value types received by the _Filter_ parameter. The syntax uses an in-order representation, which means that the operator is placed between the operand and the value. -For more information about the *Filter* parameter, type `Get-Help` [about_ActiveDirectory_Filter](/previous-versions/windows/server/hh531527(v=ws.10)). +For more information about the _Filter_ parameter, type `Get-Help` [about_ActiveDirectory_Filter](/previous-versions/windows/server/hh531527(v=ws.10)). Syntax: @@ -281,10 +295,9 @@ The following syntax uses Backus-Naur form to show how to use the Windows PowerS For a list of supported types for \, type `Get-Help about_ActiveDirectory_ObjectModel`. -Note: Windows PowerShell wildcards other than \*, such as ?, are not supported by the *Filter* syntax. - -Note: To query using LDAP query strings, use the *LDAPFilter* parameter. +Note: Windows PowerShell wildcards other than \*, such as ?, are not supported by the _Filter_ syntax. +Note: To query using LDAP query strings, use the _LDAPFilter_ parameter. ```yaml Type: String @@ -299,13 +312,14 @@ Accept wildcard characters: False ``` ### -Identity + Specifies an Active Directory computer object by providing one of the following property values. The identifier in parentheses is the LDAP display name for the attribute. The acceptable values for this parameter are: - A distinguished name -- A GUID (objectGUID) -- A security identifier (objectSid) +- A GUID (objectGUID) +- A security identifier (objectSid) - A Security Accounts Manager account name (sAMAccountName) The cmdlet searches the default naming context or partition to find the object. @@ -327,10 +341,11 @@ Accept wildcard characters: False ``` ### -LDAPFilter + Specifies an LDAP query string that is used to filter Active Directory objects. You can use this parameter to run your existing LDAP queries. -The *Filter* parameter syntax supports the same functionality as the LDAP syntax. -For more information, see the *Filter* parameter description or type `Get-Help` [about_ActiveDirectory_Filter](/previous-versions/windows/server/hh531527(v=ws.10)). +The _Filter_ parameter syntax supports the same functionality as the LDAP syntax. +For more information, see the _Filter_ parameter description or type `Get-Help` [about_ActiveDirectory_Filter](/previous-versions/windows/server/hh531527(v=ws.10)). ```yaml Type: String @@ -345,27 +360,28 @@ Accept wildcard characters: False ``` ### -Partition + Specifies the distinguished name of an Active Directory partition. The distinguished name must be one of the naming contexts on the current directory server. -The cmdlet searches this partition to find the object defined by the *Identity* parameter. +The cmdlet searches this partition to find the object defined by the _Identity_ parameter. -In many cases, a default value is used for the *Partition* parameter if no value is specified. +In many cases, a default value is used for the _Partition_ parameter if no value is specified. The rules for determining the default value are given below. Note that rules listed first are evaluated first and once a default value can be determined, no further rules are evaluated. -In Active Directory Domain Services environments, a default value for *Partition* is set in the following cases: +In Active Directory Domain Services environments, a default value for _Partition_ is set in the following cases: -- If the *Identity* parameter is set to a distinguished name, the default value of *Partition* is automatically generated from this distinguished name. -- If running cmdlets from an Active Directory provider drive, the default value of *Partition* is automatically generated from the current path in the drive. -- If none of the previous cases apply, the default value of *Partition* is set to the default partition or naming context of the target domain. +- If the _Identity_ parameter is set to a distinguished name, the default value of _Partition_ is automatically generated from this distinguished name. +- If running cmdlets from an Active Directory provider drive, the default value of _Partition_ is automatically generated from the current path in the drive. +- If none of the previous cases apply, the default value of _Partition_ is set to the default partition or naming context of the target domain. -In Active Directory Lightweight Directory Services (AD LDS) environments, a default value for *Partition* is set in the following cases: +In Active Directory Lightweight Directory Services (AD LDS) environments, a default value for _Partition_ is set in the following cases: -- If the *Identity* parameter is set to a distinguished name, the default value of *Partition* is automatically generated from this distinguished name. -- If running cmdlets from an Active Directory provider drive, the default value of *Partition* is automatically generated from the current path in the drive. -- If the target AD LDS instance has a default naming context, the default value of *Partition* is set to the default naming context. -To specify a default naming context for an AD LDS environment, set the **msDS-defaultNamingContext** property of the Active Directory directory service agent (DSA) object (**nTDSDSA**) for the AD LDS instance. -- If none of the previous cases apply, the *Partition* parameter will not take any default value. +- If the _Identity_ parameter is set to a distinguished name, the default value of _Partition_ is automatically generated from this distinguished name. +- If running cmdlets from an Active Directory provider drive, the default value of _Partition_ is automatically generated from the current path in the drive. +- If the target AD LDS instance has a default naming context, the default value of _Partition_ is set to the default naming context. +To specify a default naming context for an AD LDS environment, set the **msDS-defaultNamingContext** property of the Active Directory directory service agent (DSA) object (**nTDSDSA**) for the AD LDS instance. +- If none of the previous cases apply, the _Partition_ parameter will not take any default value. ```yaml Type: String @@ -380,6 +396,7 @@ Accept wildcard characters: False ``` ### -Properties + Specifies the properties of the output object to retrieve from the server. Use this parameter to retrieve properties that are not included in the default set. @@ -404,6 +421,7 @@ Accept wildcard characters: False ``` ### -ResultPageSize + Specifies the number of objects to include in one page for an Active Directory Domain Services query. The default is 256 objects per page. @@ -421,6 +439,7 @@ Accept wildcard characters: False ``` ### -ResultSetSize + Specifies the maximum number of objects to return for an Active Directory Domain Services query. If you want to receive all of the objects, set this parameter to $Null (null value). You can use Ctrl+C to stop the query and return of objects. @@ -440,6 +459,7 @@ Accept wildcard characters: False ``` ### -SearchBase + Specifies an Active Directory path to search under. When you run a cmdlet from an Active Directory provider drive, the default value of this parameter is the current path of the drive. @@ -449,8 +469,8 @@ When you run a cmdlet outside of an Active Directory provider drive against an A When you run a cmdlet outside of an Active Directory provider drive against an AD LDS target, the default value is the default naming context of the target AD LDS instance if one has been specified by setting the **msDS-defaultNamingContext** property of the Active Directory directory service agent object (**nTDSDSA**) for the AD LDS instance. If no default naming context has been specified for the target AD LDS instance, then this parameter has no default value. -When the value of the *SearchBase* parameter is set to an empty string and you are connected to a global catalog port, all partitions are searched. -If the value of the *SearchBase* parameter is set to an empty string and you are not connected to a global catalog port, an error is thrown. +When the value of the _SearchBase_ parameter is set to an empty string and you are connected to a global catalog port, all partitions are searched. +If the value of the _SearchBase_ parameter is set to an empty string and you are not connected to a global catalog port, an error is thrown. ```yaml Type: String @@ -465,6 +485,7 @@ Accept wildcard characters: False ``` ### -SearchScope + Specifies the scope of an Active Directory search. The acceptable values for this parameter are: @@ -490,17 +511,18 @@ Accept wildcard characters: False ``` ### -Server + Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory snapshot instance. -Specify the Active Directory Domain Services instance in one of the following ways: +Specify the Active Directory Domain Services instance in one of the following ways: Domain name values: - Fully qualified domain name - NetBIOS name -Directory server values: +Directory server values: - Fully qualified directory server name - NetBIOS name @@ -508,7 +530,7 @@ Directory server values: The default value for this parameter is determined by one of the following methods in the order that they are listed: -- By using the *Server* value from objects passed through the pipeline +- By using the _Server_ value from objects passed through the pipeline - By using the server information associated with the Active Directory Domain Services Windows PowerShell provider drive, when the cmdlet runs in that drive - By using the domain of the computer running Windows PowerShell @@ -525,20 +547,23 @@ Accept wildcard characters: False ``` ### CommonParameters + 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). ## INPUTS ### None or Microsoft.ActiveDirectory.Management.ADComputer -A computer object is received by the *Identity* parameter. + +A computer object is received by the _Identity_ parameter. ## OUTPUTS ### Microsoft.ActiveDirectory.Management.ADComputer + Returns one or more computer objects. This Get-ADComputer cmdlet returns a default set of **ADComputer** property values. -To retrieve additional **ADComputer** properties, use the *Properties* parameter of this cmdlet. +To retrieve additional **ADComputer** properties, use the _Properties_ parameter of this cmdlet. To view the properties for an **ADComputer** object, see the following examples. To run these examples, replace \ with a computer identifier such as the SAM account name of your local computer. @@ -552,7 +577,8 @@ To get a list of all the properties of an ADComputer object, use the following c `Get-ADComputer`\`-Properties ALL | Get-Member` ## NOTES -* This cmdlet does not work with AD LDS with its default schema. By default AD LDS schema does not have a computer class, but if the schema is extended to include it, this cmdlet will work with LDS. + +- This cmdlet does not work with AD LDS with its default schema. By default AD LDS schema does not have a computer class, but if the schema is extended to include it, this cmdlet will work with LDS. ## RELATED LINKS From 64cb2d62b148bc360866e984d0c35dc66a0a627a Mon Sep 17 00:00:00 2001 From: Kevin Marquette Date: Thu, 27 Apr 2023 21:59:36 +0000 Subject: [PATCH 131/650] fix code blocks --- .../activedirectory/Get-ADComputer.md | 40 ++++++++++++++----- 1 file changed, 31 insertions(+), 9 deletions(-) diff --git a/docset/winserver2022-ps/activedirectory/Get-ADComputer.md b/docset/winserver2022-ps/activedirectory/Get-ADComputer.md index 7b978a715c..2cb88a4e26 100644 --- a/docset/winserver2022-ps/activedirectory/Get-ADComputer.md +++ b/docset/winserver2022-ps/activedirectory/Get-ADComputer.md @@ -62,7 +62,10 @@ For more information about the how to determine the properties for computer obje ### Example 1: Get specific computer that shows all properties ```powershell -PS C:\> Get-ADComputer -Identity "User01-SRV1" -Properties * +Get-ADComputer -Identity "User01-SRV1" -Properties * +``` + +```Output AccountExpirationDate : @@ -148,7 +151,11 @@ This command gets a specific computer showing all the properties. ### Example 2: Get all computers with a name starting with a particular string ```powershell -PS C:\> Get-ADComputer -Filter 'Name -like "User01*"' -Properties IPv4Address | FT Name,DNSHostName,IPv4Address -A +Get-ADComputer -Filter 'Name -like "User01*"' -Properties IPv4Address | + Format-Table Name,DNSHostName,IPv4Address -AutoSize +``` + +```Output name dnshostname ipv4address ---- ----------- ----------- User01-SRV1 User01-SRV1.User01.com 10.194.99.181 @@ -160,8 +167,12 @@ This command gets all the computers with a name starting with a particular strin ### Example 3: Gets all computers that have changed their password in specific time frame ```powershell -PS C:\> $Date = [DateTime]::Today.AddDays(-90) -PS C:\> Get-ADComputer -Filter 'PasswordLastSet -ge $Date' -Properties PasswordLastSet | FT Name,PasswordLastSet +$Date = [DateTime]::Today.AddDays(-90) +Get-ADComputer -Filter 'PasswordLastSet -ge $Date' -Properties PasswordLastSet | + Format-Table Name,PasswordLastSet +``` + +```Output Name PasswordLastSet ---- --------------- USER01-SRV4 3/12/2009 6:40:37 PM @@ -173,7 +184,10 @@ This command gets all the computers that have changed their password in the last ### Example 4: Get computer accounts in a specific location using an LDAPFilter ```powershell -PS C:\> Get-ADComputer -LDAPFilter "(name=*laptop*)" -SearchBase "CN=Computers,DC= User01,DC=com" +Get-ADComputer -LDAPFilter "(name=*laptop*)" -SearchBase "CN=Computers,DC= User01,DC=com" +``` + +```Output name ---- pattiful-laptop @@ -185,7 +199,7 @@ This command gets the computer accounts in the location CN=Computers,DC=User01,D ### Example 5: Get all computer accounts using a filter ```powershell -PS C:\> Get-ADComputer -Filter * +Get-ADComputer -Filter * ``` This command gets all computer accounts. @@ -193,7 +207,11 @@ This command gets all computer accounts. ### Example 6: Get all computers with a name starting with Computer01 or Computer02 ```powershell -PS C:\> Get-ADComputer -Filter 'Name -like "Computer01*" -or Name -like "Computer02*"' -Properties IPv4Address | FT Name,DNSHostName,IPv4Address -A +Get-ADComputer -Filter 'Name -like "Computer01*" -or Name -like "Computer02*"' -Properties IPv4Address | + Format-Table Name,DNSHostName,IPv4Address -AutoSize +``` + +```Output name dnshostname ipv4address ---- ----------- ----------- Computer01-SRV1 Computer01-SRV1.Computer01.com 10.194.99.181 @@ -203,8 +221,12 @@ Computer02-SRV2 Computer02-SRV2.Computer02.com 10.194.100.3 ### Example 7: Get all computers with a name starting with a string AND password last set before 30 days ```powershell -PS C:\> $Date = [DateTime]::Today.AddDays(-30) -PS C:\> Get-ADComputer -Filter 'Name -like "Computer01*" -and PasswordLastSet -ge $Date' -Properties IPv4Address | FT Name,DNSHostName,IPv4Address -A +$Date = [DateTime]::Today.AddDays(-30) +Get-ADComputer -Filter 'Name -like "Computer01*" -and PasswordLastSet -ge $Date' -Properties IPv4Address | + Format-Table Name,DNSHostName,IPv4Address -AutoSize +``` + +```Output name dnshostname ipv4address ---- ----------- ----------- Computer01-SRV1 Computer01-SRV1.Computer01.com 10.194.99.181 From 5c317fd4c7d69332577384dc3ed4765d04f09d94 Mon Sep 17 00:00:00 2001 From: Matthew Dowst <7384306+mdowst@users.noreply.github.com> Date: Thu, 27 Apr 2023 15:00:01 -0700 Subject: [PATCH 132/650] syntax cleanup on Get-WindowsUpdateLog.md --- .../windowsupdate/Get-WindowsUpdateLog.md | 52 +++++++++++++------ 1 file changed, 36 insertions(+), 16 deletions(-) diff --git a/docset/winserver2022-ps/windowsupdate/Get-WindowsUpdateLog.md b/docset/winserver2022-ps/windowsupdate/Get-WindowsUpdateLog.md index 2f9e8132ec..5f980d3b27 100644 --- a/docset/winserver2022-ps/windowsupdate/Get-WindowsUpdateLog.md +++ b/docset/winserver2022-ps/windowsupdate/Get-WindowsUpdateLog.md @@ -11,28 +11,37 @@ title: Get-WindowsUpdateLog # Get-WindowsUpdateLog ## SYNOPSIS + Merges Windows Update .etl files into a single log file. ## SYNTAX -``` +```powershell Get-WindowsUpdateLog [[-ETLPath] ] [[-LogPath] ] [-ProcessingType ] [-ForceFlush] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION -The **Get-WindowsUpdateLog** cmdlet merges and converts Windows Update .etl files into a single readable WindowsUpdate.log file. -Windows Update Agent uses Event Tracing for Windows (ETW) to generate diagnostic logs. -Windows Update no longer directly produces a WindowsUpdate.log file. + +The **Get-WindowsUpdateLog** cmdlet merges and converts Windows Update .etl files into a single +readable WindowsUpdate.log file. Windows Update Agent uses Event Tracing for Windows (ETW) to +generate diagnostic logs. Windows Update no longer directly produces a WindowsUpdate.log file. Instead, it produces .etl files that are not immediately readable as written. -For Windows 10 versions prior to 1709 (OS Build 16299), this cmdlet requires access to a Microsoft symbol server, and log decoding must be run from a Windows 10 version earlier than 1709. Logs from Windows 10, version 1709 onward do not require a Microsoft symbol server, and need to be decoded from Windows 10, versions 1709 or higher. +For Windows 10 versions prior to 1709 (OS Build 16299), this cmdlet requires access to a Microsoft +symbol server, and log decoding must be run from a Windows 10 version earlier than 1709. Logs from +Windows 10, version 1709 onward do not require a Microsoft symbol server, and need to be decoded +from Windows 10, versions 1709 or higher. ## EXAMPLES ### Example 1: Merge and convert Windows Update trace files + +```powershell +Get-WindowsUpdateLog ``` -PS C:\> Get-WindowsUpdateLog + +```Output Converting C:\Windows\logs\WindowsUpdate into C:\Users\Admin\Desktop\WindowsUpdate.log @@ -70,11 +79,13 @@ The command completed successfully. WindowsUpdate.log written to C:\Users\admin\Desktop\WindowsUpdate.log ``` -This command merges and converts Windows Update trace files (.etl files) into a single readable WindowsUpdate.log file. +This command merges and converts Windows Update trace files (.etl files) into a single readable +WindowsUpdate.log file. ## PARAMETERS ### -Confirm + Prompts you for confirmation before running the cmdlet. ```yaml @@ -90,8 +101,9 @@ Accept wildcard characters: False ``` ### -ETLPath -Specifies an array of paths of Windows Update .etl files to convert into WindowsUpdate.log. -The default value for this parameter is the Windows Update trace file directory for the current device. + +Specifies an array of paths of Windows Update .etl files to convert into WindowsUpdate.log. The +default value for this parameter is the Windows Update trace file directory for the current device. The acceptable values for this parameter are: - The full path of a directory that contains one or more .etl files. @@ -111,10 +123,11 @@ Accept wildcard characters: False ``` ### -ForceFlush -Indicates that this cmdlet forces the Windows Update Agent on the current device to flush all of its traces to .etl files. -This process stops the Update Orchestrator and Windows Update services. -Running this cmdlet with this parameter requires administrative credentials. -You can start Windows PowerShell with administrative credentials by using the Run as administrator command. + +Indicates that this cmdlet forces the Windows Update Agent on the current device to flush all of its +traces to .etl files. This process stops the Update Orchestrator and Windows Update services. +Running this cmdlet with this parameter requires administrative credentials. You can start Windows +PowerShell with administrative credentials by using the Run as administrator command. ```yaml Type: SwitchParameter @@ -129,6 +142,7 @@ Accept wildcard characters: False ``` ### -LogPath + Specifies the full path to which **Get-WindowsUpdateLog** writes WindowsUpdate.log. The default value is WindowsUpdate.log in the Desktop folder of the current user. @@ -145,8 +159,9 @@ Accept wildcard characters: False ``` ### -ProcessingType -Specifies the file type that **Get-WindowsUpdateLog** uses for temporary files that are created during intermediate processing. -The acceptable values for this parameter are: + +Specifies the file type that **Get-WindowsUpdateLog** uses for temporary files that are created +during intermediate processing. The acceptable values for this parameter are: - CSV (comma-separated values) - XML @@ -168,6 +183,7 @@ Accept wildcard characters: False ``` ### -WhatIf + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -184,7 +200,11 @@ Accept wildcard characters: False ``` ### CommonParameters -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). + +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). ## INPUTS From a595a087e545e9525ac7e1015891897d7ded680b Mon Sep 17 00:00:00 2001 From: Anthony Howell Date: Thu, 27 Apr 2023 15:01:46 -0700 Subject: [PATCH 133/650] fixing line length --- .../activedirectory/New-ADUser.md | 407 ++++++++++++++---- 1 file changed, 316 insertions(+), 91 deletions(-) diff --git a/docset/winserver2022-ps/activedirectory/New-ADUser.md b/docset/winserver2022-ps/activedirectory/New-ADUser.md index 5081770549..991c11d78f 100644 --- a/docset/winserver2022-ps/activedirectory/New-ADUser.md +++ b/docset/winserver2022-ps/activedirectory/New-ADUser.md @@ -42,35 +42,40 @@ New-ADUser [-WhatIf] [-Confirm] [-AccountExpirationDate ] [-AccountNot The `New-ADUser` cmdlet creates an Active Directory user. You can set commonly used user property values by using the cmdlet parameters. -You can set property values that are not associated with cmdlet parameters by using the _OtherAttributes_ parameter. -When using this parameter, be sure to place single quotes around the attribute name. +You can set property values that are not associated with cmdlet parameters by using the +_OtherAttributes_ parameter. When using this parameter, be sure to place single quotes around the +attribute name. You must specify the _SamAccountName_ parameter to create a user. -You can use the `New-ADUser` cmdlet to create different types of user accounts such as iNetOrgPerson accounts. -To do this in Active Directory Domain Services (AD DS), set the _Type_ parameter to the Lightweight Directory Access Protocol (LDAP) display name for the type of account you want to create. -This type can be any class in the Active Directory schema that is a subclass of user and that has an object category of person. +You can use the `New-ADUser` cmdlet to create different types of user accounts such as iNetOrgPerson +accounts. To do this in Active Directory Domain Services (AD DS), set the _Type_ parameter to the +Lightweight Directory Access Protocol (LDAP) display name for the type of account you want to +create. This type can be any class in the Active Directory schema that is a subclass of user and +that has an object category of person. -The _Path_ parameter specifies the container or organizational unit (OU) for the new user. -When you do not specify the _Path_ parameter, the cmdlet creates a user object in the default container for user objects in the domain. +The _Path_ parameter specifies the container or organizational unit (OU) for the new user. When you +do not specify the _Path_ parameter, the cmdlet creates a user object in the default container for +user objects in the domain. The following methods explain different ways to create an object by using this cmdlet. -Method 1: Use the `New-ADUser` cmdlet, specify the required parameters, and set any additional property values by using the cmdlet parameters. +Method 1: Use the `New-ADUser` cmdlet, specify the required parameters, and set any additional +property values by using the cmdlet parameters. -Method 2: Use a template to create the new object. -To do this, create a new user object or retrieve a copy of an existing user object and set the _Instance_ parameter to this object. -The object provided to the _Instance_ parameter is used as a template for the new object. -You can override property values from the template by setting cmdlet parameters. -For examples and more information, see the _Instance_ parameter description for this cmdlet. +Method 2: Use a template to create the new object. To do this, create a new user object or retrieve +a copy of an existing user object and set the _Instance_ parameter to this object. The object +provided to the _Instance_ parameter is used as a template for the new object. You can override +property values from the template by setting cmdlet parameters. For examples and more information, +see the _Instance_ parameter description for this cmdlet. -Method 3: Use the Import-Csv cmdlet with the `New-ADUser` cmdlet to create multiple Active Directory user objects. -To do this, use the `Import-Csv` cmdlet to create the custom objects from a comma-separated value (CSV) file that contains a list of object properties. -Then pass these objects through the pipeline to the `New-ADUser` cmdlet to create the user objects. +Method 3: Use the Import-Csv cmdlet with the `New-ADUser` cmdlet to create multiple Active Directory +user objects. To do this, use the `Import-Csv` cmdlet to create the custom objects from a +comma-separated value (CSV) file that contains a list of object properties. Then pass these objects +through the pipeline to the `New-ADUser` cmdlet to create the user objects. ## EXAMPLES - ### Example 1: Create a user with an imported certificate ``` @@ -85,7 +90,8 @@ This command creates a user named ChewDavid with a certificate imported from the PS C:\> New-ADUser -Name "ChewDavid" -OtherAttributes @{'title'="director";'mail'="chewdavid@fabrikam.com"} ``` -This command creates a new user named ChewDavid and sets the **title** and **mail** properties on the new object. +This command creates a new user named ChewDavid and sets the **title** and **mail** properties on +the new object. ### Example 3: Create an inetOrgPerson user @@ -108,12 +114,17 @@ This command creates a new user named ChewDavid and sets the account password. ### -AccountExpirationDate Specifies the expiration date for an account. + This parameter sets the **AccountExpirationDate** property of an account object. + The LDAP display name (**ldapDisplayName**) for this property is accountExpires. Use the **DateTime** syntax when you specify this parameter. + Time is assumed to be local time unless otherwise specified. + When a time value is not specified, the time is assumed to 12:00:00 AM local time. + When a date is not specified, the date is assumed to be the current date. ```yaml @@ -130,10 +141,15 @@ Accept wildcard characters: False ### -AccountNotDelegated -Indicates whether the security context of the user is delegated to a service. -When this parameter is set to $True, the security context of the account is not delegated to a service even when the service account is set as trusted for Kerberos delegation. +Indicates whether the security context of the user is delegated to a service. When this parameter is +set to $True, the security context of the account is not delegated to a service even when the +service account is set as trusted for Kerberos delegation. + This parameter sets the **AccountNotDelegated** property for an Active Directory account. -This parameter also sets the **ADS_UF_NOT_DELEGATED** flag of the Active Directory User Account Control (UAC) attribute. + +This parameter also sets the **ADS_UF_NOT_DELEGATED** flag of the Active Directory User Account +Control (UAC) attribute. + The acceptable values for this parameter are: - $False or 0 @@ -154,18 +170,23 @@ Accept wildcard characters: False ### -AccountPassword Specifies a new password value for an account. + This value is stored as an encrypted string. The following conditions apply based on the manner in which the password parameter is used: -- $Null password is specified: No password is set and the account is disabled unless it is requested to be enabled. -- No password is specified: No password is set and the account is disabled unless it is requested to be enabled. -- User password is specified: Password is set and the account is disabled unless it is requested to be enabled. +- $Null password is specified: No password is set and the account is disabled unless it is requested + to be enabled. +- No password is specified: No password is set and the account is disabled unless it is requested to + be enabled. +- User password is specified: Password is set and the account is disabled unless it is requested to + be enabled. -User accounts, by default, are created without a password. -If you provide a password, an attempt will be made to set that password however, this can fail due to password policy restrictions. -The user account will still be created and you may use Set-ADAccountPassword to set the password on that account. -In order to ensure that accounts remain secure, user accounts will never be enabled unless a valid password is set or **PasswordNotRequired** is set to $True. +User accounts, by default, are created without a password. If you provide a password, an attempt +will be made to set that password however, this can fail due to password policy restrictions. The +user account will still be created and you may use Set-ADAccountPassword to set the password on that +account. In order to ensure that accounts remain secure, user accounts will never be enabled unless +a valid password is set or **PasswordNotRequired** is set to $True. The account is created if the password fails for any reason. @@ -184,8 +205,12 @@ Accept wildcard characters: False ### -AllowReversiblePasswordEncryption Indicates whether reversible password encryption is allowed for the account. + This parameter sets the **AllowReversiblePasswordEncryption** property of the account. -This parameter also sets the **ADS_UF_ENCRYPTED_TEXT_PASSWORD_ALLOWED** flag of the Active Directory User Account Control (UAC) attribute. + +This parameter also sets the **ADS_UF_ENCRYPTED_TEXT_PASSWORD_ALLOWED** flag of the Active Directory +User Account Control (UAC) attribute. + The acceptable values for this parameter are: - $False or 0 @@ -208,13 +233,15 @@ Accept wildcard characters: False ### -AuthenticationPolicy Specifies an Active Directory Domain Services authentication policy object. + Specify the authentication policy object in one of the following formats: - Distinguished name - GUID - Name -This parameter can also get this object through the pipeline or you can set this parameter to an object instance. +This parameter can also get this object through the pipeline or you can set this parameter to an +object instance. The cmdlet searches the default naming context or partition to find the object. If the cmdlet finds two or more objects, the cmdlet returns a non-terminating error. @@ -234,13 +261,15 @@ Accept wildcard characters: False ### -AuthenticationPolicySilo Specifies an Active Directory Domain Services authentication policy silo object. + Specify the authentication policy silo object in one of the following formats: - Distinguished name - GUID - Name -This parameter can also get this object through the pipeline or you can set this parameter to an object instance. +This parameter can also get this object through the pipeline or you can set this parameter to an +object instance. The cmdlet searches the default naming context or partition to find the object. If the cmdlet finds two or more objects, the cmdlet returns a non-terminating error. @@ -285,7 +314,9 @@ Accept wildcard characters: False ### -CannotChangePassword Indicates whether the account password can be changed. + This parameter sets the **CannotChangePassword** property of an account. + The acceptable values for this parameter are: - $False or 0 @@ -305,7 +336,10 @@ Accept wildcard characters: False ### -Certificates -Specifies the DER-encoded X.509v3 certificates of the account. These certificates include the public key certificates issued to this account by the Microsoft Certificate Service. This parameter sets the Certificates property of the account object. The LDAP display name (ldapDisplayName) for this property is userCertificate. +Specifies the DER-encoded X.509v3 certificates of the account. These certificates include the public +key certificates issued to this account by the Microsoft Certificate Service. This parameter sets +the Certificates property of the account object. The LDAP display name (ldapDisplayName) for this +property is userCertificate. ```yaml Type: X509Certificate[] @@ -322,12 +356,14 @@ Accept wildcard characters: False ### -ChangePasswordAtLogon Indicates whether a password must be changed during the next logon attempt. + The acceptable values for this parameter are: - $False or 0 - $True or 1 -This parameter cannot be set to $True or 1 for an account that also has the **PasswordNeverExpires** property set to $True. +This parameter cannot be set to $True or 1 for an account that also has the **PasswordNeverExpires** +property set to $True. ```yaml Type: Boolean @@ -344,7 +380,9 @@ Accept wildcard characters: False ### -City Specifies the user's town or city. + This parameter sets the **City** property of a user object. + The LDAP display name (**ldapDisplayName**) of this property is l. ```yaml @@ -362,7 +400,9 @@ Accept wildcard characters: False ### -Company Specifies the user's company. + This parameter sets the **Company** property of a user object. + The LDAP display name (**ldapDisplayName**) of this property is company. ```yaml @@ -379,15 +419,21 @@ Accept wildcard characters: False ### -CompoundIdentitySupported -Specifies whether an account supports Kerberos service tickets which includes the authorization data for the user's device. -This value sets the compound identity supported flag of the Active Directory `msDS-SupportedEncryptionTypes` attribute. +Specifies whether an account supports Kerberos service tickets which includes the authorization data +for the user's device. + +This value sets the compound identity supported flag of the Active Directory +`msDS-SupportedEncryptionTypes` attribute. + The acceptable values for this parameter are: - $False or 0 - $True or 1 -Warning: Domain-joined Windows systems and services such as clustering manage their own `msDS-SupportedEncryptionTypes` attribute. -Therefore any changes to the flag on the `msDS-SupportedEncryptionTypes` attribute are overwritten by the service or system that manages the setting. +Warning: Domain-joined Windows systems and services such as clustering manage their own +`msDS-SupportedEncryptionTypes` attribute. Therefore any changes to the flag on the +`msDS-SupportedEncryptionTypes` attribute are overwritten by the service or system that manages the +setting. ```yaml Type: Boolean @@ -420,8 +466,11 @@ Accept wildcard characters: False ### -Country Specifies the country or region code for the user's language of choice. + This parameter sets the **Country** property of a user object. + The LDAP display name (**ldapDisplayName**) of this property is c. + This value is not used by Windows 2000. ```yaml @@ -439,16 +488,25 @@ Accept wildcard characters: False ### -Credential Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. -To specify this parameter, you can type a user name, such as User1 or Domain01\User01 or you can specify a **PSCredential** object. +The default credentials are the credentials of the currently logged on user unless the cmdlet is run +from an Active Directory PowerShell provider drive. + +If the cmdlet is run from such a provider drive, the account associated with the drive is the +default. + +To specify this parameter, you can type a user name, such as User1 or Domain01\User01 or you can +specify a **PSCredential** object. + If you specify a user name for this parameter, the cmdlet prompts for a password. -You can also create a **PSCredential** object by using a script or by using the `Get-Credential` cmdlet. +You can also create a **PSCredential** object by using a script or by using the `Get-Credential` +cmdlet. + You can then set the _Credential_ parameter to the **PSCredential** object. -If the acting credentials do not have directory-level permission to perform the task, Active Directory PowerShell returns a terminating error. +If the acting credentials do not have directory-level permission to perform the task, Active +Directory PowerShell returns a terminating error. ```yaml Type: PSCredential @@ -465,7 +523,9 @@ Accept wildcard characters: False ### -Department Specifies the user's department. + This parameter sets the **Department** property of a user object. + The LDAP display name (**ldapDisplayName**) of this property is department. ```yaml @@ -483,7 +543,9 @@ Accept wildcard characters: False ### -Description Specifies a description of the object. + This parameter sets the value of the **Description** property for the user object. + The LDAP display name (**ldapDisplayName**) for this property is description. ```yaml @@ -501,7 +563,9 @@ Accept wildcard characters: False ### -DisplayName Specifies the display name of the object. + This parameter sets the **DisplayName** property of the user object. + The LDAP display name (**ldapDisplayName**) for this property is displayName. ```yaml @@ -519,7 +583,9 @@ Accept wildcard characters: False ### -Division Specifies the user's division. + This parameter sets the **Division** property of a user object. + The LDAP display name (**ldapDisplayName**) of this property is division. ```yaml @@ -537,7 +603,9 @@ Accept wildcard characters: False ### -EmailAddress Specifies the user's e-mail address. + This parameter sets the **EmailAddress** property of a user object. + The LDAP display name (**ldapDisplayName**) of this property is mail. ```yaml @@ -555,7 +623,9 @@ Accept wildcard characters: False ### -EmployeeID Specifies the user's employee ID. + This parameter sets the **EmployeeID** property of a user object. + The LDAP display name (**ldapDisplayName**) of this property is employeeID. ```yaml @@ -573,7 +643,9 @@ Accept wildcard characters: False ### -EmployeeNumber Specifies the user's employee number. + This parameter sets the **EmployeeNumber** property of a user object. + The LDAP display name (**ldapDisplayName**) of this property is employeeNumber. ```yaml @@ -591,9 +663,14 @@ Accept wildcard characters: False ### -Enabled Specifies if an account is enabled. + An enabled account requires a password. + This parameter sets the **Enabled** property for an account object. -This parameter also sets the **ADS_UF_ACCOUNTDISABLE** flag of the Active Directory User Account Control (UAC) attribute. + +This parameter also sets the **ADS_UF_ACCOUNTDISABLE** flag of the Active Directory User Account +Control (UAC) attribute. + The acceptable values for this parameter are: - $False or 0 @@ -614,7 +691,9 @@ Accept wildcard characters: False ### -Fax Specifies the user's fax phone number. + This parameter sets the **Fax** property of a user object. + The LDAP display name (**ldapDisplayName**) of this property is facsimileTelephoneNumber. ```yaml @@ -632,7 +711,9 @@ Accept wildcard characters: False ### -GivenName Specifies the user's given name. + This parameter sets the **GivenName** property of a user object. + The LDAP display name (**ldapDisplayName**) of this property is givenName. ```yaml @@ -650,7 +731,9 @@ Accept wildcard characters: False ### -HomeDirectory Specifies a user's home directory. + This parameter sets the **HomeDirectory** property of a user object. + The LDAP display name (**ldapDisplayName**) for this property is homeDirectory. ```yaml @@ -668,9 +751,14 @@ Accept wildcard characters: False ### -HomeDrive Specifies a drive that is associated with the UNC path defined by the **HomeDirectory** property. -The drive letter is specified as ``: where `` indicates the letter of the drive to associate. + +The drive letter is specified as ``: where `` indicates the letter of the +drive to associate. + The `` must be a single, uppercase letter and the colon is required. + This parameter sets the **HomeDrive** property of the user object. + The LDAP display name (**ldapDisplayName**) for this property is homeDrive. ```yaml @@ -688,7 +776,9 @@ Accept wildcard characters: False ### -HomePage Specifies the URL of the home page of the object. + This parameter sets the **homePage** property of a user object. + The LDAP display name (**ldapDisplayName**) for this property is wWWHomePage. ```yaml @@ -706,7 +796,9 @@ Accept wildcard characters: False ### -HomePhone Specifies the user's home telephone number. + This parameter sets the **HomePhone** property of a user object. + The LDAP display name (**ldapDisplayName**) of this property is homePhone. ```yaml @@ -724,8 +816,11 @@ Accept wildcard characters: False ### -Initials Specifies the initials that represent part of a user's name. + You can use this value for the user's middle initial. + This parameter sets the **Initials** property of a user object. + The LDAP display name (**ldapDisplayName**) of this property is initials. ```yaml @@ -744,18 +839,28 @@ Accept wildcard characters: False Specifies an instance of a user object to use as a template for a new user object. -You can use an instance of an existing user object as a template or you can construct a new user object for template use. +You can use an instance of an existing user object as a template or you can construct a new user +object for template use. + You can construct a new user object using the Windows PowerShell command line or by using a script. Method 1: Use an existing user object as a template for a new object. + To retrieve an instance of an existing user object, use a cmdlet such as `Get-ADUser`. -Then provide this object to the _Instance_ parameter of the `New-ADUser` cmdlet to create a new user object. + +Then provide this object to the _Instance_ parameter of the `New-ADUser` cmdlet to create a new user +object. + You can override property values of the new object by setting the appropriate parameters. -Method 2: Create a new **ADUser** object and set the property values by using the Windows PowerShell command line interface. -Then pass this object to the _Instance_ parameter of the `New-ADUser` cmdlet to create the new Active Directory user object. +Method 2: Create a new **ADUser** object and set the property values by using the Windows PowerShell +command line interface. + +Then pass this object to the _Instance_ parameter of the `New-ADUser` cmdlet to create the new +Active Directory user object. -Note: Specified attributes are not validated, so attempting to set attributes that do not exist or cannot be set raises an error. +Note: Specified attributes are not validated, so attempting to set attributes that do not exist or +cannot be set raises an error. ```yaml Type: ADUser @@ -771,8 +876,12 @@ Accept wildcard characters: False ### -KerberosEncryptionType -Specifies whether an account supports Kerberos encryption types which are used during creation of service tickets. -This value sets the encryption types supported flags of the Active Directory `msDS-SupportedEncryptionTypes` attribute. +Specifies whether an account supports Kerberos encryption types which are used during creation of +service tickets. + +This value sets the encryption types supported flags of the Active Directory +`msDS-SupportedEncryptionTypes` attribute. + Possible values for this parameter are: - None @@ -781,12 +890,17 @@ Possible values for this parameter are: - AES128 - AES256 -None removes all encryption types from the account, resulting in the KDC being unable to issue service tickets for services using the account. +None removes all encryption types from the account, resulting in the KDC being unable to issue +service tickets for services using the account. -DES is a weak encryption type that is not supported by default since Windows 7 and Windows Server 2008 R2. +DES is a weak encryption type that is not supported by default since Windows 7 and Windows Server +2008 R2. -Warning: Domain-joined Windows systems and services such as clustering manage their own `msDS-SupportedEncryptionTypes` attribute. -Therefore any changes to the flag on the `msDS-SupportedEncryptionTypes` attribute are overwritten by the service or system that manages the setting. +Warning: Domain-joined Windows systems and services such as clustering manage their own +`msDS-SupportedEncryptionTypes` attribute. + +Therefore any changes to the flag on the `msDS-SupportedEncryptionTypes` attribute are overwritten +by the service or system that manages the setting. ```yaml Type: ADKerberosEncryptionType @@ -804,8 +918,12 @@ Accept wildcard characters: False ### -LogonWorkstations Specifies the computers that the user can access. + To specify more than one computer, create a single comma-separated list. -You can identify a computer by using the Security Account Manager (SAM) account name (sAMAccountName) or the DNS host name of the computer. + +You can identify a computer by using the Security Account Manager (SAM) account name +(sAMAccountName) or the DNS host name of the computer. + The SAM account name is the same as the NetBIOS name of the computer. The LDAP display name (**ldapDisplayName**) for this property is userWorkStations. @@ -825,9 +943,13 @@ Accept wildcard characters: False ### -Manager Specifies the user's manager. + This parameter sets the **Manager** property of a user object. + This parameter is set by providing one of the following property values. + Note: The identifier in parentheses is the LDAP display name for the property. + The acceptable values for this parameter are: - A distinguished name @@ -850,7 +972,9 @@ Accept wildcard characters: False ### -MobilePhone Specifies the user's mobile phone number. + This parameter sets the **MobilePhone** property of a user object. + The LDAP display name (**ldapDisplayName**) of this property is mobile. ```yaml @@ -868,7 +992,9 @@ Accept wildcard characters: False ### -Name Specifies the name of the object. + This parameter sets the **Name** property of a user object. + The LDAP display name (**ldapDisplayName**) of this property is name. ```yaml @@ -886,7 +1012,9 @@ Accept wildcard characters: False ### -Office Specifies the location of the user's office or place of business. + This parameter sets the **Office** property of a user object. + The LDAP display name (**ldapDisplayName**) of this property is physicalDeliveryOfficeName. ```yaml @@ -904,7 +1032,9 @@ Accept wildcard characters: False ### -OfficePhone Specifies the user's office telephone number. + This parameter sets the **OfficePhone** property of a user object. + The LDAP display name (**ldapDisplayName**) of this property is telephoneNumber. ```yaml @@ -922,7 +1052,9 @@ Accept wildcard characters: False ### -Organization Specifies the user's organization. + This parameter sets the **Organization** property of a user object. + The LDAP display name (**ldapDisplayName**) of this property is o. ```yaml @@ -940,21 +1072,31 @@ Accept wildcard characters: False ### -OtherAttributes Specifies object attribute values for attributes that are not represented by cmdlet parameters. + You can set one or more parameters at the same time with this parameter. + If an attribute takes more than one value, you can assign multiple values. -To identify an attribute, specify the LDAP display name (**ldapDisplayName**) defined for it in the Active Directory schema. + +To identify an attribute, specify the LDAP display name (**ldapDisplayName**) defined for it in the +Active Directory schema. To specify a single value for an attribute: -`-OtherAttributes @{'AttributeLDAPDisplayName'=value}` +```powershell +-OtherAttributes @{'AttributeLDAPDisplayName'=value} +``` To specify multiple values for an attribute: -`-OtherAttributes @{'AttributeLDAPDisplayName'=value1,value2,...}` +```powershell +-OtherAttributes @{'AttributeLDAPDisplayName'=value1,value2,...} +``` To specify values for multiple attributes: -`-OtherAttributes @{'Attribute1LDAPDisplayName'=value; 'Attribute2LDAPDisplayName'=value1,value2;...}` +```powershell +-OtherAttributes @{'Attribute1LDAPDisplayName'=value; 'Attribute2LDAPDisplayName'=value1,value2;...} +``` ```yaml Type: Hashtable @@ -971,7 +1113,9 @@ Accept wildcard characters: False ### -OtherName Specifies a name in addition to a user's given name and surname, such as the user's middle name. + This parameter sets the **OtherName** property of a user object. + The LDAP display name (**ldapDisplayName**) of this property is middleName. ```yaml @@ -989,6 +1133,7 @@ Accept wildcard characters: False ### -PassThru Returns an object representing the item with which you are working. + By default, this cmdlet does not generate any output. ```yaml @@ -1006,14 +1151,19 @@ Accept wildcard characters: False ### -PasswordNeverExpires Specifies whether the password of an account can expire. + This parameter sets the **PasswordNeverExpires** property of an account object. -This parameter also sets the **ADS_UF_DONT_EXPIRE_PASSWD** flag of the Active Directory User Account Control attribute. + +This parameter also sets the **ADS_UF_DONT_EXPIRE_PASSWD** flag of the Active Directory User Account +Control attribute. + The acceptable values for this parameter are: - $False or 0 - $True or 1 -Note: This parameter cannot be set to $True or 1 for an account that also has the **ChangePasswordAtLogon** property set to $True. +Note: This parameter cannot be set to $True or 1 for an account that also has the +**ChangePasswordAtLogon** property set to $True. ```yaml Type: Boolean @@ -1030,7 +1180,9 @@ Accept wildcard characters: False ### -PasswordNotRequired Specifies whether the account requires a password. + A password is not required for a new account. + This parameter sets the **PasswordNotRequired** property of an account object. ```yaml @@ -1050,27 +1202,39 @@ Accept wildcard characters: False Specifies the X.500 path of the OU or container where the new object is created. In many cases, a default value is used for the _Path_ parameter if no value is specified. + The rules for determining the default value are given below. -Note that rules listed first are evaluated first and when a default value can be determined, no further rules are evaluated. -In Active Directory Domain Services (AD DS) environments, a default value for _Path_ is set in the following cases: +Note that rules listed first are evaluated first and when a default value can be determined, no +further rules are evaluated. + +In Active Directory Domain Services (AD DS) environments, a default value for _Path_ is set in the +following cases: -- If the cmdlet is run from an Active Directory PowerShell provider drive, the parameter is set to the current path of the provider drive. -- If the cmdlet has a default path, this is used. -For example: in New-ADUser, the _Path_ parameter defaults to the Users container. -- If none of the previous cases apply, the default value of _Path_ is set to the default partition or naming context of the target domain. +- If the cmdlet is run from an Active Directory PowerShell provider drive, the parameter is set to + the current path of the provider drive. +- If the cmdlet has a default path, this is used. For example: in New-ADUser, the _Path_ parameter + defaults to the Users container. +- If none of the previous cases apply, the default value of _Path_ is set to the default partition + or naming context of the target domain. In AD LDS environments, a default value for _Path_ is set in the following cases: -- If the cmdlet is run from an Active Directory module for PowerShell provider drive, the parameter is set to the current path of the provider drive. -- If the cmdlet has a default path, this is used. -For example: in `New-ADUser`, the _Path_ parameter defaults to the Users container. -- If the target AD LDS instance has a default naming context, the default value of _Path_ is set to the default naming context. -To specify a default naming context for an AD LDS environment, set the `msDS-defaultNamingContext` property of the Active Directory directory service agent object (**nTDSDSA**) for the AD LDS instance. +- If the cmdlet is run from an Active Directory module for PowerShell provider drive, the parameter + is set to the current path of the provider drive. +- If the cmdlet has a default path, this is used. For example: in `New-ADUser`, the _Path_ parameter + defaults to the Users container. +- If the target AD LDS instance has a default naming context, the default value of _Path_ is set to + the default naming context. To specify a default naming context for an AD LDS environment, set the + `msDS-defaultNamingContext` property of the Active Directory directory service agent object + (**nTDSDSA**) for the AD LDS instance. - If none of the previous cases apply, the _Path_ parameter does not take any default value. -Note: The Active Directory Provider cmdlets, such New-Item, Remove-Item, Remove-ItemProperty, *Rename-Item*, and Set-ItemProperty also contain a _Path_ property. -However, for the Active Directory Provider cmdlets, the _Path_ parameter identifies the path of the actual object rather than the container. +Note: The Active Directory Provider cmdlets, such New-Item, Remove-Item, Remove-ItemProperty, +*Rename-Item*, and Set-ItemProperty also contain a _Path_ property. + +However, for the Active Directory Provider cmdlets, the _Path_ parameter identifies the path of the +actual object rather than the container. ```yaml Type: String @@ -1086,7 +1250,9 @@ Accept wildcard characters: False ### -POBox Specifies the user's post office box number. + This parameter sets the **POBox** property of a user object. + The LDAP display name (**ldapDisplayName**) of this property is postOfficeBox. ```yaml @@ -1103,7 +1269,9 @@ Accept wildcard characters: False ### -PostalCode Specifies the user's postal code or zip code. + This parameter sets the **PostalCode** property of a user object. + The LDAP display name (**ldapDisplayName**) of this property is postalCode. ```yaml @@ -1121,7 +1289,9 @@ Accept wildcard characters: False ### -PrincipalsAllowedToDelegateToAccount Specifies an array of principal objects. -This parameter sets the `msDS-AllowedToActOnBehalfOfOtherIdentity` attribute of a computer account object. + +This parameter sets the `msDS-AllowedToActOnBehalfOfOtherIdentity` attribute of a computer account +object. ```yaml Type: ADPrincipal[] @@ -1138,8 +1308,11 @@ Accept wildcard characters: False ### -ProfilePath Specifies a path to the user's profile. + This value can be a local absolute path or a Universal Naming Convention (UNC) path. + This parameter sets the **ProfilePath** property of the user object. + The LDAP display name (**ldapDisplayName**) for this property is profilePath. ```yaml @@ -1156,13 +1329,20 @@ Accept wildcard characters: False ### -SamAccountName -Specifies the Security Account Manager (SAM) account name of the user, group, computer, or service account. +Specifies the Security Account Manager (SAM) account name of the user, group, computer, or service +account. + The maximum length of the description is 256 characters. -To be compatible with older operating systems, create a SAM account name that is 20 characters or less. + +To be compatible with older operating systems, create a SAM account name that is 20 characters or +less. + This parameter sets the **SAMAccountName** for an account object. + The LDAP display name (**ldapDisplayName**) for this property is sAMAccountName. -Note: If the string value provided is not terminated with a $ character, the system adds one if needed. +Note: If the string value provided is not terminated with a $ character, the system adds one if +needed. ```yaml Type: String @@ -1179,8 +1359,11 @@ Accept wildcard characters: False ### -ScriptPath Specifies a path to the user's log on script. + This value can be a local absolute path or a Universal Naming Convention (UNC) path. + This parameter sets the **ScriptPath** property of the user object. + The LDAP display name (**ldapDisplayName**) for this property is scriptPath. ```yaml @@ -1197,7 +1380,9 @@ Accept wildcard characters: False ### -Server -Specifies the AD DS instance to connect to, by providing one of the following values for a corresponding domain name or directory server. +Specifies the AD DS instance to connect to, by providing one of the following values for a +corresponding domain name or directory server. + The service may be any of the following: AD LDS, AD DS, or Active Directory snapshot instance. Specify the AD DS instance in one of the following ways: @@ -1213,10 +1398,12 @@ Directory server values: - NetBIOS name - Fully qualified directory server name and port -The default value for this parameter is determined by one of the following methods in the order that they are listed: +The default value for this parameter is determined by one of the following methods in the order that +they are listed: - By using the _Server_ value from objects passed through the pipeline -- By using the server information associated with the AD DS Windows PowerShell provider drive, when the cmdlet runs in that drive +- By using the server information associated with the AD DS Windows PowerShell provider drive, when + the cmdlet runs in that drive - By using the domain of the computer running Windows PowerShell ```yaml @@ -1234,9 +1421,14 @@ Accept wildcard characters: False ### -ServicePrincipalNames Specifies the service principal names for the account. + This parameter sets the **ServicePrincipalNames** property of the account. + The LDAP display name (**ldapDisplayName**) for this property is servicePrincipalName. -To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`." + +To enter multiple values, use the following syntax: `,,...`. If the values +contain spaces or otherwise require quotation marks, use the following syntax: +`"","",...""`." ```yaml Type: String[] @@ -1253,8 +1445,12 @@ Accept wildcard characters: False ### -SmartcardLogonRequired Specifies whether a smart card is required to logon. + This parameter sets the **SmartCardLoginRequired** property for a user object. -This parameter also sets the **ADS_UF_SMARTCARD_REQUIRED** flag of the Active Directory User Account Control attribute. + +This parameter also sets the **ADS_UF_SMARTCARD_REQUIRED** flag of the Active Directory User Account +Control attribute. + The acceptable values for this parameter are: - $False or 0 @@ -1275,7 +1471,9 @@ Accept wildcard characters: False ### -State Specifies the user's or Organizational Unit's state or province. + This parameter sets the **State** property of a user object. + The LDAP display name (**ldapDisplayName**) of this property is st. ```yaml @@ -1293,7 +1491,9 @@ Accept wildcard characters: False ### -StreetAddress Specifies the user's street address. + This parameter sets the **StreetAddress** property of a user object. + The LDAP display name (**ldapDisplayName**) of this property is streetAddress. ```yaml @@ -1311,7 +1511,9 @@ Accept wildcard characters: False ### -Surname Specifies the user's last name or surname. + This parameter sets the **Surname** property of a user object. + The LDAP display name (**ldapDisplayName**) of this property is sn. ```yaml @@ -1329,7 +1531,9 @@ Accept wildcard characters: False ### -Title Specifies the user's title. + This parameter sets the **Title** property of a user object. + The LDAP display name (**ldapDisplayName**) of this property is title. ```yaml @@ -1347,9 +1551,15 @@ Accept wildcard characters: False ### -TrustedForDelegation Indicates whether an account is trusted for Kerberos delegation. -A service that runs under an account that is trusted for Kerberos delegation can assume the identity of a client requesting the service. + +A service that runs under an account that is trusted for Kerberos delegation can assume the identity +of a client requesting the service. + This parameter sets the **TrustedForDelegation** property of an account object. -This value also sets the **ADS_UF_TRUSTED_FOR_DELEGATION** flag of the Active Directory User Account Control attribute. + +This value also sets the **ADS_UF_TRUSTED_FOR_DELEGATION** flag of the Active Directory User Account +Control attribute. + The acceptable values for this parameter are: - $False or 0 @@ -1370,8 +1580,12 @@ Accept wildcard characters: False ### -Type Specifies the type of object to create. -Set the _Type_ parameter to the LDAP display name of the Active Directory schema class that represents the type of object that you want to create. + +Set the _Type_ parameter to the LDAP display name of the Active Directory schema class that +represents the type of object that you want to create. + The selected type must be a subclass of the User schema class. + If this parameter is not specified it defaults to User. ```yaml @@ -1389,9 +1603,15 @@ Accept wildcard characters: False ### -UserPrincipalName Specifies a user principal name (UPN) in the format `@`. -A UPN is a friendly name assigned by an administrator that is shorter than the LDAP distinguished name used by the system and easier to remember. -The UPN is independent of the user object's distinguished name, so a user object can be moved or renamed without affecting the user logon name. -When logging on using a UPN, users no longer have to choose a domain from a list on the logon dialog box. + +A UPN is a friendly name assigned by an administrator that is shorter than the LDAP distinguished +name used by the system and easier to remember. + +The UPN is independent of the user object's distinguished name, so a user object can be moved or +renamed without affecting the user logon name. + +When logging on using a UPN, users no longer have to choose a domain from a list on the logon dialog +box. ```yaml Type: String @@ -1408,6 +1628,7 @@ Accept wildcard characters: False ### -WhatIf Shows what would happen if the cmdlet runs. + The cmdlet is not run. ```yaml @@ -1424,7 +1645,10 @@ Accept wildcard characters: False ### CommonParameters -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). +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). ## INPUTS @@ -1437,6 +1661,7 @@ A user object that is a template for the new user object is received by the _Ins ### None or Microsoft.ActiveDirectory.Management.ADUser Returns the new user object when the _PassThru_ parameter is specified. + By default, this cmdlet does not generate any output. ## NOTES From 9fde6786015aa571b4d43c48a1a8cea060e8d619 Mon Sep 17 00:00:00 2001 From: Anthony Howell Date: Thu, 27 Apr 2023 15:04:16 -0700 Subject: [PATCH 134/650] backticks around $true/$false --- .../activedirectory/New-ADUser.md | 48 +++++++++---------- 1 file changed, 24 insertions(+), 24 deletions(-) diff --git a/docset/winserver2022-ps/activedirectory/New-ADUser.md b/docset/winserver2022-ps/activedirectory/New-ADUser.md index 991c11d78f..4c22fdde9e 100644 --- a/docset/winserver2022-ps/activedirectory/New-ADUser.md +++ b/docset/winserver2022-ps/activedirectory/New-ADUser.md @@ -142,7 +142,7 @@ Accept wildcard characters: False ### -AccountNotDelegated Indicates whether the security context of the user is delegated to a service. When this parameter is -set to $True, the security context of the account is not delegated to a service even when the +set to `$True`, the security context of the account is not delegated to a service even when the service account is set as trusted for Kerberos delegation. This parameter sets the **AccountNotDelegated** property for an Active Directory account. @@ -152,8 +152,8 @@ Control (UAC) attribute. The acceptable values for this parameter are: -- $False or 0 -- $True or 1 +- `$False` or 0 +- `$True` or 1 ```yaml Type: Boolean @@ -186,7 +186,7 @@ User accounts, by default, are created without a password. If you provide a pass will be made to set that password however, this can fail due to password policy restrictions. The user account will still be created and you may use Set-ADAccountPassword to set the password on that account. In order to ensure that accounts remain secure, user accounts will never be enabled unless -a valid password is set or **PasswordNotRequired** is set to $True. +a valid password is set or **PasswordNotRequired** is set to `$True`. The account is created if the password fails for any reason. @@ -213,8 +213,8 @@ User Account Control (UAC) attribute. The acceptable values for this parameter are: -- $False or 0 -- $True or 1 +- `$False` or 0 +- `$True` or 1 ```yaml Type: Boolean @@ -319,8 +319,8 @@ This parameter sets the **CannotChangePassword** property of an account. The acceptable values for this parameter are: -- $False or 0 -- $True or 1 +- `$False` or 0 +- `$True` or 1 ```yaml Type: Boolean @@ -359,11 +359,11 @@ Indicates whether a password must be changed during the next logon attempt. The acceptable values for this parameter are: -- $False or 0 -- $True or 1 +- `$False` or 0 +- `$True` or 1 -This parameter cannot be set to $True or 1 for an account that also has the **PasswordNeverExpires** -property set to $True. +This parameter cannot be set to `$True` or 1 for an account that also has the +**PasswordNeverExpires** property set to `$True`. ```yaml Type: Boolean @@ -427,8 +427,8 @@ This value sets the compound identity supported flag of the Active Directory The acceptable values for this parameter are: -- $False or 0 -- $True or 1 +- `$False` or 0 +- `$True` or 1 Warning: Domain-joined Windows systems and services such as clustering manage their own `msDS-SupportedEncryptionTypes` attribute. Therefore any changes to the flag on the @@ -673,8 +673,8 @@ Control (UAC) attribute. The acceptable values for this parameter are: -- $False or 0 -- $True or 1 +- `$False` or 0 +- `$True` or 1 ```yaml Type: Boolean @@ -1159,11 +1159,11 @@ Control attribute. The acceptable values for this parameter are: -- $False or 0 -- $True or 1 +- `$False` or 0 +- `$True` or 1 -Note: This parameter cannot be set to $True or 1 for an account that also has the -**ChangePasswordAtLogon** property set to $True. +Note: This parameter cannot be set to `$True` or 1 for an account that also has the +**ChangePasswordAtLogon** property set to `$True`. ```yaml Type: Boolean @@ -1453,8 +1453,8 @@ Control attribute. The acceptable values for this parameter are: -- $False or 0 -- $True or 1 +- `$False` or 0 +- `$True` or 1 ```yaml Type: Boolean @@ -1562,8 +1562,8 @@ Control attribute. The acceptable values for this parameter are: -- $False or 0 -- $True or 1 +- `$False` or 0 +- `$True` or 1 ```yaml Type: Boolean From f3ae6a7e382a1fa984dab27d6960c8bdde9165ea Mon Sep 17 00:00:00 2001 From: Matthew Dowst <7384306+mdowst@users.noreply.github.com> Date: Thu, 27 Apr 2023 15:06:04 -0700 Subject: [PATCH 135/650] fix syntax block --- .../winserver2022-ps/windowsupdate/Get-WindowsUpdateLog.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docset/winserver2022-ps/windowsupdate/Get-WindowsUpdateLog.md b/docset/winserver2022-ps/windowsupdate/Get-WindowsUpdateLog.md index 5f980d3b27..7d5c54362c 100644 --- a/docset/winserver2022-ps/windowsupdate/Get-WindowsUpdateLog.md +++ b/docset/winserver2022-ps/windowsupdate/Get-WindowsUpdateLog.md @@ -16,9 +16,9 @@ Merges Windows Update .etl files into a single log file. ## SYNTAX -```powershell -Get-WindowsUpdateLog [[-ETLPath] ] [[-LogPath] ] [-ProcessingType ] [-ForceFlush] - [-WhatIf] [-Confirm] [] +``` +Get-WindowsUpdateLog [[-ETLPath] ] [[-LogPath] ] +[-ProcessingType ] [-ForceFlush] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION From d12059f476d503a6f7163a92766a547f4cf9e29c Mon Sep 17 00:00:00 2001 From: Anthony Howell Date: Thu, 27 Apr 2023 15:07:20 -0700 Subject: [PATCH 136/650] decorating code blocks --- docset/winserver2022-ps/activedirectory/New-ADUser.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docset/winserver2022-ps/activedirectory/New-ADUser.md b/docset/winserver2022-ps/activedirectory/New-ADUser.md index 4c22fdde9e..4486e570b2 100644 --- a/docset/winserver2022-ps/activedirectory/New-ADUser.md +++ b/docset/winserver2022-ps/activedirectory/New-ADUser.md @@ -16,7 +16,7 @@ Creates an Active Directory user. ## SYNTAX -``` +```powershell New-ADUser [-WhatIf] [-Confirm] [-AccountExpirationDate ] [-AccountNotDelegated ] [-AccountPassword ] [-AllowReversiblePasswordEncryption ] [-AuthenticationPolicy ] [-AuthenticationPolicySilo ] @@ -78,7 +78,7 @@ through the pipeline to the `New-ADUser` cmdlet to create the user objects. ### Example 1: Create a user with an imported certificate -``` +```powershell PS C:\> New-ADUser -Name "ChewDavid" -Certificate (New-Object System.Security.Cryptography.X509Certificates.X509Certificate -ArgumentList "Export.cer") ``` @@ -86,7 +86,7 @@ This command creates a user named ChewDavid with a certificate imported from the ### Example 2: Create a user and set properties -``` +```powershell PS C:\> New-ADUser -Name "ChewDavid" -OtherAttributes @{'title'="director";'mail'="chewdavid@fabrikam.com"} ``` @@ -95,7 +95,7 @@ the new object. ### Example 3: Create an inetOrgPerson user -``` +```powershell PS C:\> New-ADUser -Name "ChewDavid" -Type iNetOrgPerson -Path "DC=AppNC" -Server lds.Fabrikam.com:50000 ``` @@ -103,7 +103,7 @@ This command creates an **inetOrgPerson**-class user named ChewDavid on an AD LD ### Example 4: Create a user and set password -``` +```powershell PS C:\> New-ADUser -Name "ChewDavid" -Accountpassword (Read-Host -AsSecureString "AccountPassword") -Enabled $true ``` From 13896ef7827628386dbf83dc533dd00b506a7063 Mon Sep 17 00:00:00 2001 From: Anthony Howell Date: Thu, 27 Apr 2023 15:07:37 -0700 Subject: [PATCH 137/650] removing prompt --- docset/winserver2022-ps/activedirectory/New-ADUser.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docset/winserver2022-ps/activedirectory/New-ADUser.md b/docset/winserver2022-ps/activedirectory/New-ADUser.md index 4486e570b2..22cb44a886 100644 --- a/docset/winserver2022-ps/activedirectory/New-ADUser.md +++ b/docset/winserver2022-ps/activedirectory/New-ADUser.md @@ -79,7 +79,7 @@ through the pipeline to the `New-ADUser` cmdlet to create the user objects. ### Example 1: Create a user with an imported certificate ```powershell -PS C:\> New-ADUser -Name "ChewDavid" -Certificate (New-Object System.Security.Cryptography.X509Certificates.X509Certificate -ArgumentList "Export.cer") +New-ADUser -Name "ChewDavid" -Certificate (New-Object System.Security.Cryptography.X509Certificates.X509Certificate -ArgumentList "Export.cer") ``` This command creates a user named ChewDavid with a certificate imported from the file Export.cer. @@ -87,7 +87,7 @@ This command creates a user named ChewDavid with a certificate imported from the ### Example 2: Create a user and set properties ```powershell -PS C:\> New-ADUser -Name "ChewDavid" -OtherAttributes @{'title'="director";'mail'="chewdavid@fabrikam.com"} +New-ADUser -Name "ChewDavid" -OtherAttributes @{'title'="director";'mail'="chewdavid@fabrikam.com"} ``` This command creates a new user named ChewDavid and sets the **title** and **mail** properties on @@ -96,7 +96,7 @@ the new object. ### Example 3: Create an inetOrgPerson user ```powershell -PS C:\> New-ADUser -Name "ChewDavid" -Type iNetOrgPerson -Path "DC=AppNC" -Server lds.Fabrikam.com:50000 +New-ADUser -Name "ChewDavid" -Type iNetOrgPerson -Path "DC=AppNC" -Server lds.Fabrikam.com:50000 ``` This command creates an **inetOrgPerson**-class user named ChewDavid on an AD LDS instance. @@ -104,7 +104,7 @@ This command creates an **inetOrgPerson**-class user named ChewDavid on an AD LD ### Example 4: Create a user and set password ```powershell -PS C:\> New-ADUser -Name "ChewDavid" -Accountpassword (Read-Host -AsSecureString "AccountPassword") -Enabled $true +New-ADUser -Name "ChewDavid" -Accountpassword (Read-Host -AsSecureString "AccountPassword") -Enabled $true ``` This command creates a new user named ChewDavid and sets the account password. From 05f852e404ed0f2ce4d1752b6081b313f70a889a Mon Sep 17 00:00:00 2001 From: Anthony Howell Date: Thu, 27 Apr 2023 15:08:24 -0700 Subject: [PATCH 138/650] fixing casing --- docset/winserver2022-ps/activedirectory/New-ADUser.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/activedirectory/New-ADUser.md b/docset/winserver2022-ps/activedirectory/New-ADUser.md index 22cb44a886..15db90ac50 100644 --- a/docset/winserver2022-ps/activedirectory/New-ADUser.md +++ b/docset/winserver2022-ps/activedirectory/New-ADUser.md @@ -104,7 +104,7 @@ This command creates an **inetOrgPerson**-class user named ChewDavid on an AD LD ### Example 4: Create a user and set password ```powershell -New-ADUser -Name "ChewDavid" -Accountpassword (Read-Host -AsSecureString "AccountPassword") -Enabled $true +New-ADUser -Name "ChewDavid" -AccountPassword (Read-Host -AsSecureString "AccountPassword") -Enabled $true ``` This command creates a new user named ChewDavid and sets the account password. From 3b68bbc20f2b671f89c52b99ed320f90c7001696 Mon Sep 17 00:00:00 2001 From: Anthony Howell Date: Thu, 27 Apr 2023 15:12:09 -0700 Subject: [PATCH 139/650] switch param update --- docset/winserver2022-ps/activedirectory/New-ADUser.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docset/winserver2022-ps/activedirectory/New-ADUser.md b/docset/winserver2022-ps/activedirectory/New-ADUser.md index 15db90ac50..59cd73f367 100644 --- a/docset/winserver2022-ps/activedirectory/New-ADUser.md +++ b/docset/winserver2022-ps/activedirectory/New-ADUser.md @@ -452,7 +452,7 @@ Accept wildcard characters: False Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf @@ -1137,7 +1137,7 @@ Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -1632,7 +1632,7 @@ Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi From 95b5bdd685b9555cc3d0357218157f71d6992b56 Mon Sep 17 00:00:00 2001 From: Mike Soule Date: Thu, 27 Apr 2023 15:13:02 -0700 Subject: [PATCH 140/650] formatting --- .../Uninstall-AdcsWebEnrollment.md | 23 +++++++++++++------ 1 file changed, 16 insertions(+), 7 deletions(-) diff --git a/docset/winserver2022-ps/adcsdeployment/Uninstall-AdcsWebEnrollment.md b/docset/winserver2022-ps/adcsdeployment/Uninstall-AdcsWebEnrollment.md index 71f7303ed9..869c76a973 100644 --- a/docset/winserver2022-ps/adcsdeployment/Uninstall-AdcsWebEnrollment.md +++ b/docset/winserver2022-ps/adcsdeployment/Uninstall-AdcsWebEnrollment.md @@ -20,13 +20,16 @@ Uninstall-AdcsWebEnrollment [-Force] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION -The **Uninstall-AdcsWebEnrollment** cmdlet removes the Certification Authority (CA) Web Enrollment role service. + +The `Uninstall-AdcsWebEnrollment` cmdlet removes the Certification Authority (CA) Web Enrollment +role service. ## EXAMPLES ### Example 1: Uninstall the CA Web Enrollment role service -``` -PS C:\> Uninstall-AdcsWebEnrollment -Force + +```powershell +Uninstall-AdcsWebEnrollment -Force ``` This command uninstalls the CA Web Enrollment role service without requiring confirmation. @@ -34,6 +37,7 @@ This command uninstalls the CA Web Enrollment role service without requiring con ## PARAMETERS ### -Confirm + Prompts you for confirmation before running the cmdlet. ```yaml @@ -49,6 +53,7 @@ Accept wildcard characters: False ``` ### -Force + Forces the command to run without asking for user confirmation. ```yaml @@ -64,6 +69,7 @@ Accept wildcard characters: False ``` ### -WhatIf + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -80,7 +86,11 @@ Accept wildcard characters: False ``` ### CommonParameters -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). + +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). ## INPUTS @@ -91,11 +101,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ### Microsoft.CertificateServices.Deployment.Common.WEP.WebEnrollmentResult ## NOTES -* Ensure you run Windows PowerShell as an administrator. You can use the *Force* parameter to bypass the prompt for confirmation. - +- Ensure you run Windows PowerShell as an administrator. You can use the **Force** parameter to + bypass the prompt for confirmation. ## RELATED LINKS [Install-AdcsWebEnrollment](./Install-AdcsWebEnrollment.md) - From ae11c64549c0007557e308285db8b7be188d8a2d Mon Sep 17 00:00:00 2001 From: Anthony Howell Date: Thu, 27 Apr 2023 15:13:42 -0700 Subject: [PATCH 141/650] string and boolean --- .../activedirectory/New-ADUser.md | 96 +++++++++---------- 1 file changed, 48 insertions(+), 48 deletions(-) diff --git a/docset/winserver2022-ps/activedirectory/New-ADUser.md b/docset/winserver2022-ps/activedirectory/New-ADUser.md index 59cd73f367..8afbf91da2 100644 --- a/docset/winserver2022-ps/activedirectory/New-ADUser.md +++ b/docset/winserver2022-ps/activedirectory/New-ADUser.md @@ -156,7 +156,7 @@ The acceptable values for this parameter are: - `$True` or 1 ```yaml -Type: Boolean +Type: System.Boolean Parameter Sets: (All) Aliases: @@ -217,7 +217,7 @@ The acceptable values for this parameter are: - `$True` or 1 ```yaml -Type: Boolean +Type: System.Boolean Parameter Sets: (All) Aliases: @@ -323,7 +323,7 @@ The acceptable values for this parameter are: - `$True` or 1 ```yaml -Type: Boolean +Type: System.Boolean Parameter Sets: (All) Aliases: @@ -366,7 +366,7 @@ This parameter cannot be set to `$True` or 1 for an account that also has the **PasswordNeverExpires** property set to `$True`. ```yaml -Type: Boolean +Type: System.Boolean Parameter Sets: (All) Aliases: @@ -386,7 +386,7 @@ This parameter sets the **City** property of a user object. The LDAP display name (**ldapDisplayName**) of this property is l. ```yaml -Type: String + System.String Parameter Sets: (All) Aliases: @@ -406,7 +406,7 @@ This parameter sets the **Company** property of a user object. The LDAP display name (**ldapDisplayName**) of this property is company. ```yaml -Type: String + System.String Parameter Sets: (All) Aliases: @@ -436,7 +436,7 @@ Warning: Domain-joined Windows systems and services such as clustering manage th setting. ```yaml -Type: Boolean +Type: System.Boolean Parameter Sets: (All) Aliases: @@ -474,7 +474,7 @@ The LDAP display name (**ldapDisplayName**) of this property is c. This value is not used by Windows 2000. ```yaml -Type: String + System.String Parameter Sets: (All) Aliases: @@ -529,7 +529,7 @@ This parameter sets the **Department** property of a user object. The LDAP display name (**ldapDisplayName**) of this property is department. ```yaml -Type: String + System.String Parameter Sets: (All) Aliases: @@ -549,7 +549,7 @@ This parameter sets the value of the **Description** property for the user objec The LDAP display name (**ldapDisplayName**) for this property is description. ```yaml -Type: String + System.String Parameter Sets: (All) Aliases: @@ -569,7 +569,7 @@ This parameter sets the **DisplayName** property of the user object. The LDAP display name (**ldapDisplayName**) for this property is displayName. ```yaml -Type: String + System.String Parameter Sets: (All) Aliases: @@ -589,7 +589,7 @@ This parameter sets the **Division** property of a user object. The LDAP display name (**ldapDisplayName**) of this property is division. ```yaml -Type: String + System.String Parameter Sets: (All) Aliases: @@ -609,7 +609,7 @@ This parameter sets the **EmailAddress** property of a user object. The LDAP display name (**ldapDisplayName**) of this property is mail. ```yaml -Type: String + System.String Parameter Sets: (All) Aliases: @@ -629,7 +629,7 @@ This parameter sets the **EmployeeID** property of a user object. The LDAP display name (**ldapDisplayName**) of this property is employeeID. ```yaml -Type: String + System.String Parameter Sets: (All) Aliases: @@ -649,7 +649,7 @@ This parameter sets the **EmployeeNumber** property of a user object. The LDAP display name (**ldapDisplayName**) of this property is employeeNumber. ```yaml -Type: String + System.String Parameter Sets: (All) Aliases: @@ -677,7 +677,7 @@ The acceptable values for this parameter are: - `$True` or 1 ```yaml -Type: Boolean +Type: System.Boolean Parameter Sets: (All) Aliases: @@ -697,7 +697,7 @@ This parameter sets the **Fax** property of a user object. The LDAP display name (**ldapDisplayName**) of this property is facsimileTelephoneNumber. ```yaml -Type: String + System.String Parameter Sets: (All) Aliases: @@ -717,7 +717,7 @@ This parameter sets the **GivenName** property of a user object. The LDAP display name (**ldapDisplayName**) of this property is givenName. ```yaml -Type: String + System.String Parameter Sets: (All) Aliases: @@ -737,7 +737,7 @@ This parameter sets the **HomeDirectory** property of a user object. The LDAP display name (**ldapDisplayName**) for this property is homeDirectory. ```yaml -Type: String + System.String Parameter Sets: (All) Aliases: @@ -762,7 +762,7 @@ This parameter sets the **HomeDrive** property of the user object. The LDAP display name (**ldapDisplayName**) for this property is homeDrive. ```yaml -Type: String + System.String Parameter Sets: (All) Aliases: @@ -782,7 +782,7 @@ This parameter sets the **homePage** property of a user object. The LDAP display name (**ldapDisplayName**) for this property is wWWHomePage. ```yaml -Type: String + System.String Parameter Sets: (All) Aliases: @@ -802,7 +802,7 @@ This parameter sets the **HomePhone** property of a user object. The LDAP display name (**ldapDisplayName**) of this property is homePhone. ```yaml -Type: String + System.String Parameter Sets: (All) Aliases: @@ -824,7 +824,7 @@ This parameter sets the **Initials** property of a user object. The LDAP display name (**ldapDisplayName**) of this property is initials. ```yaml -Type: String + System.String Parameter Sets: (All) Aliases: @@ -929,7 +929,7 @@ The SAM account name is the same as the NetBIOS name of the computer. The LDAP display name (**ldapDisplayName**) for this property is userWorkStations. ```yaml -Type: String + System.String Parameter Sets: (All) Aliases: @@ -978,7 +978,7 @@ This parameter sets the **MobilePhone** property of a user object. The LDAP display name (**ldapDisplayName**) of this property is mobile. ```yaml -Type: String + System.String Parameter Sets: (All) Aliases: @@ -998,7 +998,7 @@ This parameter sets the **Name** property of a user object. The LDAP display name (**ldapDisplayName**) of this property is name. ```yaml -Type: String + System.String Parameter Sets: (All) Aliases: @@ -1018,7 +1018,7 @@ This parameter sets the **Office** property of a user object. The LDAP display name (**ldapDisplayName**) of this property is physicalDeliveryOfficeName. ```yaml -Type: String + System.String Parameter Sets: (All) Aliases: @@ -1038,7 +1038,7 @@ This parameter sets the **OfficePhone** property of a user object. The LDAP display name (**ldapDisplayName**) of this property is telephoneNumber. ```yaml -Type: String + System.String Parameter Sets: (All) Aliases: @@ -1058,7 +1058,7 @@ This parameter sets the **Organization** property of a user object. The LDAP display name (**ldapDisplayName**) of this property is o. ```yaml -Type: String + System.String Parameter Sets: (All) Aliases: @@ -1119,7 +1119,7 @@ This parameter sets the **OtherName** property of a user object. The LDAP display name (**ldapDisplayName**) of this property is middleName. ```yaml -Type: String + System.String Parameter Sets: (All) Aliases: @@ -1166,7 +1166,7 @@ Note: This parameter cannot be set to `$True` or 1 for an account that also has **ChangePasswordAtLogon** property set to `$True`. ```yaml -Type: Boolean +Type: System.Boolean Parameter Sets: (All) Aliases: @@ -1186,7 +1186,7 @@ A password is not required for a new account. This parameter sets the **PasswordNotRequired** property of an account object. ```yaml -Type: Boolean +Type: System.Boolean Parameter Sets: (All) Aliases: @@ -1237,7 +1237,7 @@ However, for the Active Directory Provider cmdlets, the _Path_ parameter identif actual object rather than the container. ```yaml -Type: String + System.String Parameter Sets: (All) Aliases: @@ -1256,7 +1256,7 @@ This parameter sets the **POBox** property of a user object. The LDAP display name (**ldapDisplayName**) of this property is postOfficeBox. ```yaml -Type: String + System.String Parameter Sets: (All) Aliases: @@ -1275,7 +1275,7 @@ This parameter sets the **PostalCode** property of a user object. The LDAP display name (**ldapDisplayName**) of this property is postalCode. ```yaml -Type: String + System.String Parameter Sets: (All) Aliases: @@ -1316,7 +1316,7 @@ This parameter sets the **ProfilePath** property of the user object. The LDAP display name (**ldapDisplayName**) for this property is profilePath. ```yaml -Type: String + System.String Parameter Sets: (All) Aliases: @@ -1345,7 +1345,7 @@ Note: If the string value provided is not terminated with a $ character, the sys needed. ```yaml -Type: String + System.String Parameter Sets: (All) Aliases: @@ -1367,7 +1367,7 @@ This parameter sets the **ScriptPath** property of the user object. The LDAP display name (**ldapDisplayName**) for this property is scriptPath. ```yaml -Type: String + System.String Parameter Sets: (All) Aliases: @@ -1407,7 +1407,7 @@ they are listed: - By using the domain of the computer running Windows PowerShell ```yaml -Type: String + System.String Parameter Sets: (All) Aliases: @@ -1431,7 +1431,7 @@ contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`." ```yaml -Type: String[] + System.String[] Parameter Sets: (All) Aliases: @@ -1457,7 +1457,7 @@ The acceptable values for this parameter are: - `$True` or 1 ```yaml -Type: Boolean +Type: System.Boolean Parameter Sets: (All) Aliases: @@ -1477,7 +1477,7 @@ This parameter sets the **State** property of a user object. The LDAP display name (**ldapDisplayName**) of this property is st. ```yaml -Type: String + System.String Parameter Sets: (All) Aliases: @@ -1497,7 +1497,7 @@ This parameter sets the **StreetAddress** property of a user object. The LDAP display name (**ldapDisplayName**) of this property is streetAddress. ```yaml -Type: String + System.String Parameter Sets: (All) Aliases: @@ -1517,7 +1517,7 @@ This parameter sets the **Surname** property of a user object. The LDAP display name (**ldapDisplayName**) of this property is sn. ```yaml -Type: String + System.String Parameter Sets: (All) Aliases: @@ -1537,7 +1537,7 @@ This parameter sets the **Title** property of a user object. The LDAP display name (**ldapDisplayName**) of this property is title. ```yaml -Type: String + System.String Parameter Sets: (All) Aliases: @@ -1566,7 +1566,7 @@ The acceptable values for this parameter are: - `$True` or 1 ```yaml -Type: Boolean +Type: System.Boolean Parameter Sets: (All) Aliases: @@ -1589,7 +1589,7 @@ The selected type must be a subclass of the User schema class. If this parameter is not specified it defaults to User. ```yaml -Type: String + System.String Parameter Sets: (All) Aliases: @@ -1614,7 +1614,7 @@ When logging on using a UPN, users no longer have to choose a domain from a list box. ```yaml -Type: String + System.String Parameter Sets: (All) Aliases: From 23ed7ec360069753d3e8c0d11235f0185dfa9925 Mon Sep 17 00:00:00 2001 From: Anthony Howell Date: Thu, 27 Apr 2023 15:14:47 -0700 Subject: [PATCH 142/650] fixing string --- .../activedirectory/New-ADUser.md | 76 +++++++++---------- 1 file changed, 38 insertions(+), 38 deletions(-) diff --git a/docset/winserver2022-ps/activedirectory/New-ADUser.md b/docset/winserver2022-ps/activedirectory/New-ADUser.md index 8afbf91da2..32c50a1287 100644 --- a/docset/winserver2022-ps/activedirectory/New-ADUser.md +++ b/docset/winserver2022-ps/activedirectory/New-ADUser.md @@ -386,7 +386,7 @@ This parameter sets the **City** property of a user object. The LDAP display name (**ldapDisplayName**) of this property is l. ```yaml - System.String +Type: System.String Parameter Sets: (All) Aliases: @@ -406,7 +406,7 @@ This parameter sets the **Company** property of a user object. The LDAP display name (**ldapDisplayName**) of this property is company. ```yaml - System.String +Type: System.String Parameter Sets: (All) Aliases: @@ -474,7 +474,7 @@ The LDAP display name (**ldapDisplayName**) of this property is c. This value is not used by Windows 2000. ```yaml - System.String +Type: System.String Parameter Sets: (All) Aliases: @@ -529,7 +529,7 @@ This parameter sets the **Department** property of a user object. The LDAP display name (**ldapDisplayName**) of this property is department. ```yaml - System.String +Type: System.String Parameter Sets: (All) Aliases: @@ -549,7 +549,7 @@ This parameter sets the value of the **Description** property for the user objec The LDAP display name (**ldapDisplayName**) for this property is description. ```yaml - System.String +Type: System.String Parameter Sets: (All) Aliases: @@ -569,7 +569,7 @@ This parameter sets the **DisplayName** property of the user object. The LDAP display name (**ldapDisplayName**) for this property is displayName. ```yaml - System.String +Type: System.String Parameter Sets: (All) Aliases: @@ -589,7 +589,7 @@ This parameter sets the **Division** property of a user object. The LDAP display name (**ldapDisplayName**) of this property is division. ```yaml - System.String +Type: System.String Parameter Sets: (All) Aliases: @@ -609,7 +609,7 @@ This parameter sets the **EmailAddress** property of a user object. The LDAP display name (**ldapDisplayName**) of this property is mail. ```yaml - System.String +Type: System.String Parameter Sets: (All) Aliases: @@ -629,7 +629,7 @@ This parameter sets the **EmployeeID** property of a user object. The LDAP display name (**ldapDisplayName**) of this property is employeeID. ```yaml - System.String +Type: System.String Parameter Sets: (All) Aliases: @@ -649,7 +649,7 @@ This parameter sets the **EmployeeNumber** property of a user object. The LDAP display name (**ldapDisplayName**) of this property is employeeNumber. ```yaml - System.String +Type: System.String Parameter Sets: (All) Aliases: @@ -697,7 +697,7 @@ This parameter sets the **Fax** property of a user object. The LDAP display name (**ldapDisplayName**) of this property is facsimileTelephoneNumber. ```yaml - System.String +Type: System.String Parameter Sets: (All) Aliases: @@ -717,7 +717,7 @@ This parameter sets the **GivenName** property of a user object. The LDAP display name (**ldapDisplayName**) of this property is givenName. ```yaml - System.String +Type: System.String Parameter Sets: (All) Aliases: @@ -737,7 +737,7 @@ This parameter sets the **HomeDirectory** property of a user object. The LDAP display name (**ldapDisplayName**) for this property is homeDirectory. ```yaml - System.String +Type: System.String Parameter Sets: (All) Aliases: @@ -762,7 +762,7 @@ This parameter sets the **HomeDrive** property of the user object. The LDAP display name (**ldapDisplayName**) for this property is homeDrive. ```yaml - System.String +Type: System.String Parameter Sets: (All) Aliases: @@ -782,7 +782,7 @@ This parameter sets the **homePage** property of a user object. The LDAP display name (**ldapDisplayName**) for this property is wWWHomePage. ```yaml - System.String +Type: System.String Parameter Sets: (All) Aliases: @@ -802,7 +802,7 @@ This parameter sets the **HomePhone** property of a user object. The LDAP display name (**ldapDisplayName**) of this property is homePhone. ```yaml - System.String +Type: System.String Parameter Sets: (All) Aliases: @@ -824,7 +824,7 @@ This parameter sets the **Initials** property of a user object. The LDAP display name (**ldapDisplayName**) of this property is initials. ```yaml - System.String +Type: System.String Parameter Sets: (All) Aliases: @@ -929,7 +929,7 @@ The SAM account name is the same as the NetBIOS name of the computer. The LDAP display name (**ldapDisplayName**) for this property is userWorkStations. ```yaml - System.String +Type: System.String Parameter Sets: (All) Aliases: @@ -978,7 +978,7 @@ This parameter sets the **MobilePhone** property of a user object. The LDAP display name (**ldapDisplayName**) of this property is mobile. ```yaml - System.String +Type: System.String Parameter Sets: (All) Aliases: @@ -998,7 +998,7 @@ This parameter sets the **Name** property of a user object. The LDAP display name (**ldapDisplayName**) of this property is name. ```yaml - System.String +Type: System.String Parameter Sets: (All) Aliases: @@ -1018,7 +1018,7 @@ This parameter sets the **Office** property of a user object. The LDAP display name (**ldapDisplayName**) of this property is physicalDeliveryOfficeName. ```yaml - System.String +Type: System.String Parameter Sets: (All) Aliases: @@ -1038,7 +1038,7 @@ This parameter sets the **OfficePhone** property of a user object. The LDAP display name (**ldapDisplayName**) of this property is telephoneNumber. ```yaml - System.String +Type: System.String Parameter Sets: (All) Aliases: @@ -1058,7 +1058,7 @@ This parameter sets the **Organization** property of a user object. The LDAP display name (**ldapDisplayName**) of this property is o. ```yaml - System.String +Type: System.String Parameter Sets: (All) Aliases: @@ -1119,7 +1119,7 @@ This parameter sets the **OtherName** property of a user object. The LDAP display name (**ldapDisplayName**) of this property is middleName. ```yaml - System.String +Type: System.String Parameter Sets: (All) Aliases: @@ -1237,7 +1237,7 @@ However, for the Active Directory Provider cmdlets, the _Path_ parameter identif actual object rather than the container. ```yaml - System.String +Type: System.String Parameter Sets: (All) Aliases: @@ -1256,7 +1256,7 @@ This parameter sets the **POBox** property of a user object. The LDAP display name (**ldapDisplayName**) of this property is postOfficeBox. ```yaml - System.String +Type: System.String Parameter Sets: (All) Aliases: @@ -1275,7 +1275,7 @@ This parameter sets the **PostalCode** property of a user object. The LDAP display name (**ldapDisplayName**) of this property is postalCode. ```yaml - System.String +Type: System.String Parameter Sets: (All) Aliases: @@ -1316,7 +1316,7 @@ This parameter sets the **ProfilePath** property of the user object. The LDAP display name (**ldapDisplayName**) for this property is profilePath. ```yaml - System.String +Type: System.String Parameter Sets: (All) Aliases: @@ -1345,7 +1345,7 @@ Note: If the string value provided is not terminated with a $ character, the sys needed. ```yaml - System.String +Type: System.String Parameter Sets: (All) Aliases: @@ -1367,7 +1367,7 @@ This parameter sets the **ScriptPath** property of the user object. The LDAP display name (**ldapDisplayName**) for this property is scriptPath. ```yaml - System.String +Type: System.String Parameter Sets: (All) Aliases: @@ -1407,7 +1407,7 @@ they are listed: - By using the domain of the computer running Windows PowerShell ```yaml - System.String +Type: System.String Parameter Sets: (All) Aliases: @@ -1431,7 +1431,7 @@ contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`." ```yaml - System.String[] +Type: System.String[] Parameter Sets: (All) Aliases: @@ -1477,7 +1477,7 @@ This parameter sets the **State** property of a user object. The LDAP display name (**ldapDisplayName**) of this property is st. ```yaml - System.String +Type: System.String Parameter Sets: (All) Aliases: @@ -1497,7 +1497,7 @@ This parameter sets the **StreetAddress** property of a user object. The LDAP display name (**ldapDisplayName**) of this property is streetAddress. ```yaml - System.String +Type: System.String Parameter Sets: (All) Aliases: @@ -1517,7 +1517,7 @@ This parameter sets the **Surname** property of a user object. The LDAP display name (**ldapDisplayName**) of this property is sn. ```yaml - System.String +Type: System.String Parameter Sets: (All) Aliases: @@ -1537,7 +1537,7 @@ This parameter sets the **Title** property of a user object. The LDAP display name (**ldapDisplayName**) of this property is title. ```yaml - System.String +Type: System.String Parameter Sets: (All) Aliases: @@ -1589,7 +1589,7 @@ The selected type must be a subclass of the User schema class. If this parameter is not specified it defaults to User. ```yaml - System.String +Type: System.String Parameter Sets: (All) Aliases: @@ -1614,7 +1614,7 @@ When logging on using a UPN, users no longer have to choose a domain from a list box. ```yaml - System.String +Type: System.String Parameter Sets: (All) Aliases: From 05823ef9614e4d427f6fdec0a76485a02dcb4648 Mon Sep 17 00:00:00 2001 From: Anthony Howell Date: Thu, 27 Apr 2023 15:15:16 -0700 Subject: [PATCH 143/650] updating credential --- docset/winserver2022-ps/activedirectory/New-ADUser.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/activedirectory/New-ADUser.md b/docset/winserver2022-ps/activedirectory/New-ADUser.md index 32c50a1287..ecf73e6331 100644 --- a/docset/winserver2022-ps/activedirectory/New-ADUser.md +++ b/docset/winserver2022-ps/activedirectory/New-ADUser.md @@ -509,7 +509,7 @@ If the acting credentials do not have directory-level permission to perform the Directory PowerShell returns a terminating error. ```yaml -Type: PSCredential +Type: System.Management.Automation.PSCredential Parameter Sets: (All) Aliases: From 9b16e0c0388a1a3c7108479bfa94ea5ed0c28fdd Mon Sep 17 00:00:00 2001 From: Vanda Paladino Date: Thu, 27 Apr 2023 18:16:03 -0400 Subject: [PATCH 144/650] Corrections to Disable-ServerManagerStandardUserRemoting.md --- ...sable-ServerManagerStandardUserRemoting.md | 60 ++++++++++++++----- 1 file changed, 44 insertions(+), 16 deletions(-) diff --git a/docset/winserver2022-ps/ServerManager/Disable-ServerManagerStandardUserRemoting.md b/docset/winserver2022-ps/ServerManager/Disable-ServerManagerStandardUserRemoting.md index 425e762d18..ad1acd6bfc 100644 --- a/docset/winserver2022-ps/ServerManager/Disable-ServerManagerStandardUserRemoting.md +++ b/docset/winserver2022-ps/ServerManager/Disable-ServerManagerStandardUserRemoting.md @@ -11,8 +11,10 @@ title: Disable-ServerManagerStandardUserRemoting # Disable-ServerManagerStandardUserRemoting ## SYNOPSIS -Disables access for specified standard users to event, service, performance counter, and role and feature inventory data that is collected by Server Manager for a server. -This cmdlet performs the opposite action, for specified users, of the Enable-ServerManagerStandardUserRemoting cmdlet. + +Disables access for specified standard users to event, service, performance counter, and role and +feature inventory data that is collected by Server Manager for a server. This cmdlet performs the +opposite action, for specified users, of the Enable-ServerManagerStandardUserRemoting cmdlet. ## SYNTAX @@ -21,40 +23,57 @@ Disable-ServerManagerStandardUserRemoting [-User] [-Force] [-WhatIf] ``` ## DESCRIPTION -Disables access for one or more standard, non-Administrator users to event, service, performance counter, and role and feature inventory data for a server that you are managing by using Server Manager. -The cmdlet restores the default, administrator-only access to this data, and must be run locally on the server that is being managed by using Server Manager. -The cmdlet works by performing the following actions: -- Deletes access rights for specified standard users to the root\cimv2 namespace on the local server (for access to role and feature inventory information). +Disables access for one or more standard, non-Administrator users to event, service, performance +counter, and role and feature inventory data for a server that you are managing by using Server +Manager. The cmdlet restores the default, administrator-only access to this data, and must be run +locally on the server that is being managed by using Server Manager. The cmdlet works by performing +the following actions: + +- Deletes access rights for specified standard users to the root\cimv2 namespace on the local server + (for access to role and feature inventory information). -- Removes specified standard users from user groups (Remote Management Users, Event Log Readers, and Performance Log Readers) that allow remote access to event and performance counter logs on the local server. +- Removes specified standard users from user groups (Remote Management Users, Event Log Readers, and + Performance Log Readers) that allow remote access to event and performance counter logs on the + local server. -- Removes access rights in the Service Control Manager for specified standard users who have access to the status of services on the local server. +- Removes access rights in the Service Control Manager for specified standard users who have access + to the status of services on the local server. ## EXAMPLES ### Example 1 + ```powershell Disable-ServerManagerStandardUserRemoting -User JennyL ``` -In the following example, the administrator disables access to event, performance counter, service status, and role and feature inventory data for a server that is being managed by using either a local or remote Server Manager console, and for which there is a standard user named JennyL. +In this example, the administrator disables access to event, performance counter, service +status, and role and feature inventory data for a server that is being managed by using either a +local or remote Server Manager console, and for which there is a standard user named JennyL. ### Example 2 + ```powershell Disable-ServerManagerStandardUserRemoting -User JennyL -WhatIf ``` -In the following example, the administrator views the outcome of running a command to deny a standard user named JennyL access to event, performance counter, service status, and role and feature inventory data for a server that is being managed by using the Server Manager console running on either the local or a remote computer. -The `WhatIf` parameter is added, meaning that the command actions are not carried out. +In this example, the administrator views the outcome of running a command to deny a standard user +named JennyL access to event, performance counter, service status, and role and feature inventory +data for a server that is being managed by using the Server Manager console running on either the +local or a remote computer. The **WhatIf** parameter is added, meaning that the command actions are +not carried out. ### Example 3 + ```powershell Disable-ServerManagerStandardUserRemoting -User JennyL -Confirm ``` -In the following example, the administrator denies a standard user named JennyL access to event, performance counter, service status, and role and feature inventory data for a server that is being managed by using the Server Manager console running on either the local or a remote computer. -The `Confirm` parameter is added, meaning that the command prompts for confirmation before performing the action. +In this example, the administrator denies a standard user named JennyL access to event, performance +counter, service status, and role and feature inventory data for a server that is being managed by +using the Server Manager console running on either the local or a remote computer. The **Confirm** +parameter is added, meaning that the command prompts for confirmation before performing the action. ## PARAMETERS @@ -75,7 +94,10 @@ Accept wildcard characters: False ``` ### -User -Specifies the user account name of a standard user who runs Server Manager, and no longer requires access to event, performance counter, service, and role and feature inventory data for a server that is being managed by using either a local or remote Server Manager console. + +Specifies the user account name of a standard user who runs Server Manager and no longer requires +access to event, performance counter, service, and role and feature inventory data for a server that +is being managed by using either a local or remote Server Manager console. ```yaml Type: String[] @@ -90,6 +112,7 @@ Accept wildcard characters: False ``` ### -Confirm + Prompts you for confirmation before running the cmdlet. ```yaml @@ -105,7 +128,8 @@ Accept wildcard characters: False ``` ### -WhatIf -Shows what would happen if the cmdlet runs. + +Shows what would happen if the cmdlet were run. The cmdlet is not run. ```yaml @@ -121,7 +145,11 @@ Accept wildcard characters: False ``` ### CommonParameters -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). + +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). ## INPUTS From 9295375b98275f6ee5af9255abd5de55b3b9b9db Mon Sep 17 00:00:00 2001 From: Kevin Marquette Date: Thu, 27 Apr 2023 22:19:22 +0000 Subject: [PATCH 145/650] fix long lines --- .../activedirectory/Get-ADComputer.md | 213 ++++++++++++------ 1 file changed, 138 insertions(+), 75 deletions(-) diff --git a/docset/winserver2022-ps/activedirectory/Get-ADComputer.md b/docset/winserver2022-ps/activedirectory/Get-ADComputer.md index 2cb88a4e26..eab19f43cb 100644 --- a/docset/winserver2022-ps/activedirectory/Get-ADComputer.md +++ b/docset/winserver2022-ps/activedirectory/Get-ADComputer.md @@ -19,24 +19,27 @@ Gets one or more Active Directory computers. ### Filter (Default) ```powershell -Get-ADComputer [-AuthType ] [-Credential ] -Filter [-Properties ] - [-ResultPageSize ] [-ResultSetSize ] [-SearchBase ] [-SearchScope ] - [-Server ] [] +Get-ADComputer [-AuthType ] [-Credential ] + -Filter [-Properties ] [-ResultPageSize ] + [-ResultSetSize ] [-SearchBase ] [-SearchScope ] + [-Server ] [] ``` ### Identity ```powershell -Get-ADComputer [-AuthType ] [-Credential ] [-Identity] - [-Partition ] [-Properties ] [-Server ] [] +Get-ADComputer [-AuthType ] [-Credential ] + [-Identity] [-Partition ] [-Properties ] + [-Server ] [] ``` ### LdapFilter ```powershell Get-ADComputer [-AuthType ] [-Credential ] -LDAPFilter - [-Properties ] [-ResultPageSize ] [-ResultSetSize ] [-SearchBase ] - [-SearchScope ] [-Server ] [] + [-Properties ] [-ResultPageSize ] [-ResultSetSize ] + [-SearchBase ] [-SearchScope ] [-Server ] + [] ``` ## DESCRIPTION @@ -44,18 +47,25 @@ Get-ADComputer [-AuthType ] [-Credential ] -LDAPFilter The **Get-ADComputer** cmdlet gets a computer or performs a search to retrieve multiple computers. The _Identity_ parameter specifies the Active Directory computer to retrieve. -You can identify a computer by its distinguished name, GUID, security identifier (SID) or Security Accounts Manager (SAM) account name. -You can also set the parameter to a computer object variable, such as `$` or pass a computer object through the pipeline to the _Identity_ parameter. - -To search for and retrieve more than one computer, use the _Filter_ or _LDAPFilter_ parameters. -The _Filter_ parameter uses the PowerShell Expression Language to write query strings for Active Directory. -PowerShell Expression Language syntax provides rich type conversion support for value types received by the _Filter_ parameter. -For more information about the _Filter_ parameter syntax, type `Get-Help` [about_ActiveDirectory_Filter](/previous-versions/windows/server/hh531527(v=ws.10)). -If you have existing Lightweight Directory Access Protocol (LDAP) query strings, you can use the _LDAPFilter_ parameter. - -This cmdlet retrieves a default set of computer object properties. -To retrieve additional properties use the _Properties_ parameter. -For more information about the how to determine the properties for computer objects, see the _Properties_ parameter description. +You can identify a computer by its distinguished name, GUID, security identifier +(SID) or Security Accounts Manager (SAM) account name. You can also set the +parameter to a computer object variable, such as `$` or +pass a computer object through the pipeline to the _Identity_ parameter. + +To search for and retrieve more than one computer, use the _Filter_ or +_LDAPFilter_ parameters. The _Filter_ parameter uses the PowerShell Expression +Language to write query strings for Active Directory. PowerShell Expression +Language syntax provides rich type conversion support for value types received +by the _Filter_ parameter. For more information about the _Filter_ parameter +syntax, type `Get-Help` +[about_ActiveDirectory_Filter](/previous-versions/windows/server/hh531527(v=ws.10)). +If you have existing Lightweight Directory Access Protocol (LDAP) query strings, +you can use the _LDAPFilter_ parameter. + +This cmdlet retrieves a default set of computer object properties. To retrieve +additional properties use the _Properties_ parameter. For more information about +the how to determine the properties for computer objects, see the _Properties_ +parameter description. ## EXAMPLES @@ -162,7 +172,8 @@ User01-SRV1 User01-SRV1.User01.com 10.194.99.181 User01-SRV2 User01-SRV2.User01.com 10.194.100.3 ``` -This command gets all the computers with a name starting with a particular string and shows the name, dns hostname, and IPv4 address. +This command gets all the computers with a name starting with a particular +string and shows the name, dns hostname, and IPv4 address. ### Example 3: Gets all computers that have changed their password in specific time frame @@ -194,7 +205,9 @@ pattiful-laptop davidche-laptop ``` -This command gets the computer accounts in the location CN=Computers,DC=User01,DC=com that are listed as laptops by using an _LDAPFilter_. +This command gets the computer accounts in the location +CN=Computers,DC=User01,DC=com that are listed as laptops by using an +_LDAPFilter_. ### Example 5: Get all computer accounts using a filter @@ -263,17 +276,23 @@ Accept wildcard characters: False ### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory module for Windows PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. +Specifies the user account credentials to use to perform this task. The default +credentials are the credentials of the currently logged on user unless the +cmdlet is run from an Active Directory module for Windows PowerShell provider +drive. If the cmdlet is run from such a provider drive, the account associated +with the drive is the default. -To specify this parameter, you can type a user name, such as User1 or Domain01\User01 or you can specify a **PSCredential** object. -If you specify a user name for this parameter, the cmdlet prompts for a password. +To specify this parameter, you can type a user name, such as User1 or +Domain01\User01 or you can specify a **PSCredential** object. If you specify a +user name for this parameter, the cmdlet prompts for a password. -You can also create a **PSCredential** object by using a script or by using the **Get-Credential** cmdlet. -You can then set the _Credential_ parameter to the **PSCredential** object. +You can also create a **PSCredential** object by using a script or by using the +**Get-Credential** cmdlet. You can then set the _Credential_ parameter to the +**PSCredential** object. -If the acting credentials do not have directory-level permission to perform the task, Active Directory module for Windows PowerShell returns a terminating error. +If the acting credentials do not have directory-level permission to perform the +task, Active Directory module for Windows PowerShell returns a terminating +error. ```yaml Type: PSCredential @@ -289,15 +308,18 @@ Accept wildcard characters: False ### -Filter -Specifies a query string that retrieves Active Directory objects. -This string uses the Windows PowerShell Expression Language syntax. -The Windows PowerShell Expression Language syntax provides rich type-conversion support for value types received by the _Filter_ parameter. -The syntax uses an in-order representation, which means that the operator is placed between the operand and the value. -For more information about the _Filter_ parameter, type `Get-Help` [about_ActiveDirectory_Filter](/previous-versions/windows/server/hh531527(v=ws.10)). +Specifies a query string that retrieves Active Directory objects. This string +uses the Windows PowerShell Expression Language syntax. The Windows PowerShell +Expression Language syntax provides rich type-conversion support for value types +received by the _Filter_ parameter. The syntax uses an in-order representation, +which means that the operator is placed between the operand and the value. For +more information about the _Filter_ parameter, type `Get-Help` +[about_ActiveDirectory_Filter](/previous-versions/windows/server/hh531527(v=ws.10)). Syntax: -The following syntax uses Backus-Naur form to show how to use the Windows PowerShell Expression Language for this parameter. +The following syntax uses Backus-Naur form to show how to use the Windows +PowerShell Expression Language for this parameter. \ ::= "{" \ "}" @@ -317,7 +339,8 @@ The following syntax uses Backus-Naur form to show how to use the Windows PowerS For a list of supported types for \, type `Get-Help about_ActiveDirectory_ObjectModel`. -Note: Windows PowerShell wildcards other than \*, such as ?, are not supported by the _Filter_ syntax. +Note: Windows PowerShell wildcards other than \*, such as ?, are not supported +by the _Filter_ syntax. Note: To query using LDAP query strings, use the _LDAPFilter_ parameter. @@ -345,10 +368,12 @@ The acceptable values for this parameter are: - A Security Accounts Manager account name (sAMAccountName) The cmdlet searches the default naming context or partition to find the object. -If the identifier given is a distinguished name, the partition to search is computed from that distinguished name. -If two or more objects are found, the cmdlet returns a non-terminating error. +If the identifier given is a distinguished name, the partition to search is +computed from that distinguished name. If two or more objects are found, the +cmdlet returns a non-terminating error. -This parameter can also get this object through the pipeline or you can set this parameter to a computer object instance. +This parameter can also get this object through the pipeline or you can set this +parameter to a computer object instance. ```yaml Type: ADComputer @@ -365,9 +390,10 @@ Accept wildcard characters: False ### -LDAPFilter Specifies an LDAP query string that is used to filter Active Directory objects. -You can use this parameter to run your existing LDAP queries. -The _Filter_ parameter syntax supports the same functionality as the LDAP syntax. -For more information, see the _Filter_ parameter description or type `Get-Help` [about_ActiveDirectory_Filter](/previous-versions/windows/server/hh531527(v=ws.10)). +You can use this parameter to run your existing LDAP queries. The _Filter_ +parameter syntax supports the same functionality as the LDAP syntax. For more +information, see the _Filter_ parameter description or type `Get-Help` +[about_ActiveDirectory_Filter](/previous-versions/windows/server/hh531527(v=ws.10)). ```yaml Type: String @@ -387,22 +413,33 @@ Specifies the distinguished name of an Active Directory partition. The distinguished name must be one of the naming contexts on the current directory server. The cmdlet searches this partition to find the object defined by the _Identity_ parameter. -In many cases, a default value is used for the _Partition_ parameter if no value is specified. -The rules for determining the default value are given below. -Note that rules listed first are evaluated first and once a default value can be determined, no further rules are evaluated. - -In Active Directory Domain Services environments, a default value for _Partition_ is set in the following cases: - -- If the _Identity_ parameter is set to a distinguished name, the default value of _Partition_ is automatically generated from this distinguished name. -- If running cmdlets from an Active Directory provider drive, the default value of _Partition_ is automatically generated from the current path in the drive. -- If none of the previous cases apply, the default value of _Partition_ is set to the default partition or naming context of the target domain. - -In Active Directory Lightweight Directory Services (AD LDS) environments, a default value for _Partition_ is set in the following cases: - -- If the _Identity_ parameter is set to a distinguished name, the default value of _Partition_ is automatically generated from this distinguished name. -- If running cmdlets from an Active Directory provider drive, the default value of _Partition_ is automatically generated from the current path in the drive. -- If the target AD LDS instance has a default naming context, the default value of _Partition_ is set to the default naming context. -To specify a default naming context for an AD LDS environment, set the **msDS-defaultNamingContext** property of the Active Directory directory service agent (DSA) object (**nTDSDSA**) for the AD LDS instance. +In many cases, a default value is used for the _Partition_ parameter if no value +is specified. The rules for determining the default value are given below. Note +that rules listed first are evaluated first and once a default value can be +determined, no further rules are evaluated. + +In Active Directory Domain Services environments, a default value for +_Partition_ is set in the following cases: + +- If the _Identity_ parameter is set to a distinguished name, the default value + of _Partition_ is automatically generated from this distinguished name. +- If running cmdlets from an Active Directory provider drive, the default value + of _Partition_ is automatically generated from the current path in the drive. +- If none of the previous cases apply, the default value of _Partition_ is set + to the default partition or naming context of the target domain. + +In Active Directory Lightweight Directory Services (AD LDS) environments, a +default value for _Partition_ is set in the following cases: + +- If the _Identity_ parameter is set to a distinguished name, the default value + of _Partition_ is automatically generated from this distinguished name. +- If running cmdlets from an Active Directory provider drive, the default value + of _Partition_ is automatically generated from the current path in the drive. +- If the target AD LDS instance has a default naming context, the default value + of _Partition_ is set to the default naming context. To specify a default + naming context for an AD LDS environment, set the + **msDS-defaultNamingContext** property of the Active Directory directory + service agent (DSA) object (**nTDSDSA**) for the AD LDS instance. - If none of the previous cases apply, the _Partition_ parameter will not take any default value. ```yaml @@ -425,10 +462,13 @@ Use this parameter to retrieve properties that are not included in the default s Specify properties for this parameter as a comma-separated list of names. To display all of the attributes that are set on the object, specify * (asterisk). -To specify an individual extended property, use the name of the property. -For properties that are not default or extended properties, you must specify the LDAP display name of the attribute. +To specify an individual extended property, use the name of the property. For +properties that are not default or extended properties, you must specify the +LDAP display name of the attribute. -To retrieve properties and display them for an object, you can use the Get-* cmdlet associated with the object and pass the output to the **Get-Member** cmdlet. +To retrieve properties and display them for an object, you can use the Get-* +cmdlet associated with the object and pass the output to the **Get-Member** +cmdlet. ```yaml Type: String[] @@ -444,7 +484,8 @@ Accept wildcard characters: False ### -ResultPageSize -Specifies the number of objects to include in one page for an Active Directory Domain Services query. +Specifies the number of objects to include in one page for an Active Directory +Domain Services query. The default is 256 objects per page. @@ -484,15 +525,25 @@ Accept wildcard characters: False Specifies an Active Directory path to search under. -When you run a cmdlet from an Active Directory provider drive, the default value of this parameter is the current path of the drive. +When you run a cmdlet from an Active Directory provider drive, the default value +of this parameter is the current path of the drive. -When you run a cmdlet outside of an Active Directory provider drive against an Active Directory Domain Services target, the default value of this parameter is the default naming context of the target domain. +When you run a cmdlet outside of an Active Directory provider drive against an +Active Directory Domain Services target, the default value of this parameter is +the default naming context of the target domain. -When you run a cmdlet outside of an Active Directory provider drive against an AD LDS target, the default value is the default naming context of the target AD LDS instance if one has been specified by setting the **msDS-defaultNamingContext** property of the Active Directory directory service agent object (**nTDSDSA**) for the AD LDS instance. -If no default naming context has been specified for the target AD LDS instance, then this parameter has no default value. +When you run a cmdlet outside of an Active Directory provider drive against an +AD LDS target, the default value is the default naming context of the target AD +LDS instance if one has been specified by setting the +**msDS-defaultNamingContext** property of the Active Directory directory service +agent object (**nTDSDSA**) for the AD LDS instance. If no default naming context +has been specified for the target AD LDS instance, then this parameter has no +default value. -When the value of the _SearchBase_ parameter is set to an empty string and you are connected to a global catalog port, all partitions are searched. -If the value of the _SearchBase_ parameter is set to an empty string and you are not connected to a global catalog port, an error is thrown. +When the value of the _SearchBase_ parameter is set to an empty string and you +are connected to a global catalog port, all partitions are searched. If the +value of the _SearchBase_ parameter is set to an empty string and you are not +connected to a global catalog port, an error is thrown. ```yaml Type: String @@ -534,8 +585,11 @@ Accept wildcard characters: False ### -Server -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory snapshot instance. +Specifies the Active Directory Domain Services instance to connect to, by +providing one of the following values for a corresponding domain name or +directory server. The service may be any of the following: Active Directory +Lightweight Domain Services, Active Directory Domain Services or Active +Directory snapshot instance. Specify the Active Directory Domain Services instance in one of the following ways: @@ -550,10 +604,12 @@ Directory server values: - NetBIOS name - Fully qualified directory server name and port -The default value for this parameter is determined by one of the following methods in the order that they are listed: +The default value for this parameter is determined by one of the following +methods in the order that they are listed: - By using the _Server_ value from objects passed through the pipeline -- By using the server information associated with the Active Directory Domain Services Windows PowerShell provider drive, when the cmdlet runs in that drive +- By using the server information associated with the Active Directory Domain + Services Windows PowerShell provider drive, when the cmdlet runs in that drive - By using the domain of the computer running Windows PowerShell ```yaml @@ -570,7 +626,11 @@ Accept wildcard characters: False ### CommonParameters -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). +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). ## INPUTS @@ -588,7 +648,8 @@ This Get-ADComputer cmdlet returns a default set of **ADComputer** property valu To retrieve additional **ADComputer** properties, use the _Properties_ parameter of this cmdlet. To view the properties for an **ADComputer** object, see the following examples. -To run these examples, replace \ with a computer identifier such as the SAM account name of your local computer. +To run these examples, replace \ with a computer identifier such as +the SAM account name of your local computer. To get a list of the default set of properties of an ADComputer object, use the following command: @@ -600,7 +661,9 @@ To get a list of all the properties of an ADComputer object, use the following c ## NOTES -- This cmdlet does not work with AD LDS with its default schema. By default AD LDS schema does not have a computer class, but if the schema is extended to include it, this cmdlet will work with LDS. +- This cmdlet does not work with AD LDS with its default schema. By default AD + LDS schema does not have a computer class, but if the schema is extended to + include it, this cmdlet will work with LDS. ## RELATED LINKS From 45dbfe3d852f281cf39a0fd0a9011892070d36c5 Mon Sep 17 00:00:00 2001 From: Anthony Howell Date: Thu, 27 Apr 2023 15:22:10 -0700 Subject: [PATCH 146/650] splats --- .../winserver2022-ps/activedirectory/New-ADUser.md | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/docset/winserver2022-ps/activedirectory/New-ADUser.md b/docset/winserver2022-ps/activedirectory/New-ADUser.md index ecf73e6331..056f044860 100644 --- a/docset/winserver2022-ps/activedirectory/New-ADUser.md +++ b/docset/winserver2022-ps/activedirectory/New-ADUser.md @@ -79,7 +79,11 @@ through the pipeline to the `New-ADUser` cmdlet to create the user objects. ### Example 1: Create a user with an imported certificate ```powershell -New-ADUser -Name "ChewDavid" -Certificate (New-Object System.Security.Cryptography.X509Certificates.X509Certificate -ArgumentList "Export.cer") +$splat = @{ + Name = 'ChewDavid' + Certificate = (New-Object System.Security.Cryptography.X509Certificates.X509Certificate -ArgumentList "Export.cer") +} +New-ADUser @splat ``` This command creates a user named ChewDavid with a certificate imported from the file Export.cer. @@ -104,7 +108,12 @@ This command creates an **inetOrgPerson**-class user named ChewDavid on an AD LD ### Example 4: Create a user and set password ```powershell -New-ADUser -Name "ChewDavid" -AccountPassword (Read-Host -AsSecureString "AccountPassword") -Enabled $true +$splat = @{ + Name = "ChewDavid" + AccountPassword = (Read-Host -AsSecureString "AccountPassword") + Enabled = $true +} +New-ADUser @splat ``` This command creates a new user named ChewDavid and sets the account password. From b0ed61ed717ed08bb257b06437e143b8fa8792f3 Mon Sep 17 00:00:00 2001 From: Matthew Dowst <7384306+mdowst@users.noreply.github.com> Date: Thu, 27 Apr 2023 15:24:25 -0700 Subject: [PATCH 147/650] Update docset/winserver2022-ps/windowsupdate/Get-WindowsUpdateLog.md Co-authored-by: Mikey Lombardi (He/Him) --- docset/winserver2022-ps/windowsupdate/Get-WindowsUpdateLog.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/windowsupdate/Get-WindowsUpdateLog.md b/docset/winserver2022-ps/windowsupdate/Get-WindowsUpdateLog.md index 7d5c54362c..457407902f 100644 --- a/docset/winserver2022-ps/windowsupdate/Get-WindowsUpdateLog.md +++ b/docset/winserver2022-ps/windowsupdate/Get-WindowsUpdateLog.md @@ -23,7 +23,7 @@ Get-WindowsUpdateLog [[-ETLPath] ] [[-LogPath] ] ## DESCRIPTION -The **Get-WindowsUpdateLog** cmdlet merges and converts Windows Update .etl files into a single +The `Get-WindowsUpdateLog` cmdlet merges and converts Windows Update .etl files into a single readable WindowsUpdate.log file. Windows Update Agent uses Event Tracing for Windows (ETW) to generate diagnostic logs. Windows Update no longer directly produces a WindowsUpdate.log file. Instead, it produces .etl files that are not immediately readable as written. From c53ff60af4024ba31a7922f99e9ec4e4ad075a19 Mon Sep 17 00:00:00 2001 From: Joe Gast Date: Thu, 27 Apr 2023 15:24:26 -0700 Subject: [PATCH 148/650] ConvertTo-HGSKeyProtector.md - documentation formatting --- .../hgsclient/ConvertTo-HgsKeyProtector.md | 89 +++++++++++-------- 1 file changed, 53 insertions(+), 36 deletions(-) diff --git a/docset/winserver2022-ps/hgsclient/ConvertTo-HgsKeyProtector.md b/docset/winserver2022-ps/hgsclient/ConvertTo-HgsKeyProtector.md index 3bdff425d8..427ca8e4cb 100644 --- a/docset/winserver2022-ps/hgsclient/ConvertTo-HgsKeyProtector.md +++ b/docset/winserver2022-ps/hgsclient/ConvertTo-HgsKeyProtector.md @@ -16,49 +16,55 @@ Converts a key protector into a Host Guardian Service key protector. ## SYNTAX ``` -ConvertTo-HgsKeyProtector [-Bytes] [-CimSession ] [-ThrottleLimit ] [-AsJob] - [] +ConvertTo-HgsKeyProtector [-Bytes] [-CimSession ] [-ThrottleLimit ] +[-AsJob] [] ``` ## DESCRIPTION -The **ConvertTo-HgsKeyProtector** cmdlet converts an existing key protector into a Host Guardian Service key protector object. -Specify the existing key protector as a byte array. -You might use this cmdlet to import a key protector from a virtual machine configuration file. + +The **ConvertTo-HgsKeyProtector** cmdlet converts an existing key protector into a Host Guardian +Service key protector object. Specify the existing key protector as a byte array. You might use this +cmdlet to import a key protector from a virtual machine configuration file. ## EXAMPLES ### Example 1: Convert a key protector -``` -PS C:\> $VirtualTPM = Get-VMTPM -Name "Shielded Virtual Machine 17" -PS C:\> $VirtualMachineKeyProtector = $VirtualTPM.KeyProtector -PS C:\> $KeyProtector = ConvertTo-HgsKeyProtector -Bytes $VirtualMachineKeyProtector + +```powershell +$VirtualTPM = Get-VMTPM -Name "Shielded Virtual Machine 17" +$VirtualMachineKeyProtector = $VirtualTPM.KeyProtector +$KeyProtector = ConvertTo-HgsKeyProtector -Bytes $VirtualMachineKeyProtector ``` -The first command gets the Trusted Platform Module (TPM) object for the virtual machine named Shielded Virtual Machine 17. -The command stores the object in the **$VirtualTPM** variable. +The first command gets the Trusted Platform Module (TPM) object for the virtual machine named +Shielded Virtual Machine 17. The command stores the object in the **$VirtualTPM** variable. -The second command stores the **KeyProtector** property of the object stored in **$VirtualTPM** in the **$VirtualMachineKeyProtector** variable. +The second command stores the **KeyProtector** property of the object stored in **$VirtualTPM** in +the **$VirtualMachineKeyProtector** variable. -The final command creates a Host Guardian Service key protector object from the byte array representation stored in **$VirtualMachineKeyProtector**. -The command stores the new key protector in the **$KeyProtector** variable. +The final command creates a Host Guardian Service key protector object from the byte array +representation stored in **$VirtualMachineKeyProtector**. The command stores the new key protector +in the **$KeyProtector** variable. ## PARAMETERS ### -AsJob -Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. -The cmdlet immediately returns an object that represents the job and then displays the command prompt. -You can continue to work in the session while the job completes. -To manage the job, use the `*-Job` cmdlets. -To get the job results, use the [Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. +Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to +complete. -For more information about Windows PowerShell background jobs, see [about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). +The cmdlet immediately returns an object that represents the job and then displays the command +prompt. You can continue to work in the session while the job completes. To manage the job, use the +`*-Job` cmdlets. To get the job results, use the +[Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. +For more information about Windows PowerShell background jobs, see +[about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -68,13 +74,14 @@ Accept wildcard characters: False ``` ### -Bytes -Specifies the existing key protector as a byte array. -This cmdlet generates a key protector object from the existing key protector that this parameter specifies. + +Specifies the existing key protector as a byte array. This cmdlet generates a key protector object +from the existing key protector that this parameter specifies. ```yaml Type: Byte[] Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 1 @@ -84,9 +91,11 @@ Accept wildcard characters: False ``` ### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -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. -The default is the current session on the local computer. + +Runs the cmdlet in a remote session or on a remote computer. 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. The default is the +current session on the local computer. ```yaml Type: CimSession[] @@ -101,14 +110,17 @@ Accept wildcard characters: False ``` ### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -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. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. + +Specifies the maximum number of concurrent operations that can be established to run the cmdlet. 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. The throttle limit applies only to the current cmdlet, not to the session or to the +computer. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -118,21 +130,26 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, +-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, +-WarningAction, and -WarningVariable. For more information, see +[about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS ## OUTPUTS ### Microsoft.Management.Infrastructure.CimInstance#MSFT_HgsKeyProtector + This cmdlet returns a key protector. -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. +The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays +Windows Management Instrumentation (WMI) objects. The path after the pound sign (`#`) provides the +namespace and class name for the underlying WMI object. ## NOTES ## RELATED LINKS -[New-HgsKeyProtector](./New-HgsKeyProtector.md) - +[New-HgsKeyProtector](./New-HgsKeyProtector.md) \ No newline at end of file From 7bf41f3e942e9a2ea2903204b5638c9599f10b4a Mon Sep 17 00:00:00 2001 From: Matthew Dowst <7384306+mdowst@users.noreply.github.com> Date: Thu, 27 Apr 2023 15:24:35 -0700 Subject: [PATCH 149/650] Update docset/winserver2022-ps/windowsupdate/Get-WindowsUpdateLog.md Co-authored-by: Mikey Lombardi (He/Him) --- docset/winserver2022-ps/windowsupdate/Get-WindowsUpdateLog.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/windowsupdate/Get-WindowsUpdateLog.md b/docset/winserver2022-ps/windowsupdate/Get-WindowsUpdateLog.md index 457407902f..f0ec8ebb12 100644 --- a/docset/winserver2022-ps/windowsupdate/Get-WindowsUpdateLog.md +++ b/docset/winserver2022-ps/windowsupdate/Get-WindowsUpdateLog.md @@ -24,7 +24,7 @@ Get-WindowsUpdateLog [[-ETLPath] ] [[-LogPath] ] ## DESCRIPTION The `Get-WindowsUpdateLog` cmdlet merges and converts Windows Update .etl files into a single -readable WindowsUpdate.log file. Windows Update Agent uses Event Tracing for Windows (ETW) to +readable `WindowsUpdate.log` file. Windows Update Agent uses Event Tracing for Windows (ETW) to generate diagnostic logs. Windows Update no longer directly produces a WindowsUpdate.log file. Instead, it produces .etl files that are not immediately readable as written. From 37628e4f8ce5867786e6ebe5ddc26352b8cd8348 Mon Sep 17 00:00:00 2001 From: Matthew Dowst <7384306+mdowst@users.noreply.github.com> Date: Thu, 27 Apr 2023 15:24:43 -0700 Subject: [PATCH 150/650] Update docset/winserver2022-ps/windowsupdate/Get-WindowsUpdateLog.md Co-authored-by: Mikey Lombardi (He/Him) --- docset/winserver2022-ps/windowsupdate/Get-WindowsUpdateLog.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/windowsupdate/Get-WindowsUpdateLog.md b/docset/winserver2022-ps/windowsupdate/Get-WindowsUpdateLog.md index f0ec8ebb12..6e27328531 100644 --- a/docset/winserver2022-ps/windowsupdate/Get-WindowsUpdateLog.md +++ b/docset/winserver2022-ps/windowsupdate/Get-WindowsUpdateLog.md @@ -25,7 +25,7 @@ Get-WindowsUpdateLog [[-ETLPath] ] [[-LogPath] ] The `Get-WindowsUpdateLog` cmdlet merges and converts Windows Update .etl files into a single readable `WindowsUpdate.log` file. Windows Update Agent uses Event Tracing for Windows (ETW) to -generate diagnostic logs. Windows Update no longer directly produces a WindowsUpdate.log file. +generate diagnostic logs. Windows Update no longer directly produces a `WindowsUpdate.log` file. Instead, it produces .etl files that are not immediately readable as written. For Windows 10 versions prior to 1709 (OS Build 16299), this cmdlet requires access to a Microsoft From 608c7350b90f17eff4a5e470f5d740af22835dd8 Mon Sep 17 00:00:00 2001 From: Matthew Dowst <7384306+mdowst@users.noreply.github.com> Date: Thu, 27 Apr 2023 15:24:55 -0700 Subject: [PATCH 151/650] Update docset/winserver2022-ps/windowsupdate/Get-WindowsUpdateLog.md Co-authored-by: Mikey Lombardi (He/Him) --- docset/winserver2022-ps/windowsupdate/Get-WindowsUpdateLog.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docset/winserver2022-ps/windowsupdate/Get-WindowsUpdateLog.md b/docset/winserver2022-ps/windowsupdate/Get-WindowsUpdateLog.md index 6e27328531..68d8207751 100644 --- a/docset/winserver2022-ps/windowsupdate/Get-WindowsUpdateLog.md +++ b/docset/winserver2022-ps/windowsupdate/Get-WindowsUpdateLog.md @@ -79,8 +79,8 @@ The command completed successfully. WindowsUpdate.log written to C:\Users\admin\Desktop\WindowsUpdate.log ``` -This command merges and converts Windows Update trace files (.etl files) into a single readable -WindowsUpdate.log file. +This command merges and converts Windows Update trace files (`.etl` files) into a single readable +`WindowsUpdate.log` file. ## PARAMETERS From b7d27421eb29283718aee37a9e1381db8eb576fe Mon Sep 17 00:00:00 2001 From: Matthew Dowst <7384306+mdowst@users.noreply.github.com> Date: Thu, 27 Apr 2023 15:25:07 -0700 Subject: [PATCH 152/650] Update docset/winserver2022-ps/windowsupdate/Get-WindowsUpdateLog.md Co-authored-by: Mikey Lombardi (He/Him) --- docset/winserver2022-ps/windowsupdate/Get-WindowsUpdateLog.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/windowsupdate/Get-WindowsUpdateLog.md b/docset/winserver2022-ps/windowsupdate/Get-WindowsUpdateLog.md index 68d8207751..a42604ce19 100644 --- a/docset/winserver2022-ps/windowsupdate/Get-WindowsUpdateLog.md +++ b/docset/winserver2022-ps/windowsupdate/Get-WindowsUpdateLog.md @@ -102,7 +102,7 @@ Accept wildcard characters: False ### -ETLPath -Specifies an array of paths of Windows Update .etl files to convert into WindowsUpdate.log. The +Specifies an array of paths of Windows Update `.etl` files to convert into `WindowsUpdate.log`. The default value for this parameter is the Windows Update trace file directory for the current device. The acceptable values for this parameter are: From 27132656ec1cc02f1159a19f281da55d7530bae0 Mon Sep 17 00:00:00 2001 From: Matthew Dowst <7384306+mdowst@users.noreply.github.com> Date: Thu, 27 Apr 2023 15:25:21 -0700 Subject: [PATCH 153/650] Update docset/winserver2022-ps/windowsupdate/Get-WindowsUpdateLog.md Co-authored-by: Mikey Lombardi (He/Him) --- docset/winserver2022-ps/windowsupdate/Get-WindowsUpdateLog.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/windowsupdate/Get-WindowsUpdateLog.md b/docset/winserver2022-ps/windowsupdate/Get-WindowsUpdateLog.md index a42604ce19..a3339d5001 100644 --- a/docset/winserver2022-ps/windowsupdate/Get-WindowsUpdateLog.md +++ b/docset/winserver2022-ps/windowsupdate/Get-WindowsUpdateLog.md @@ -160,7 +160,7 @@ Accept wildcard characters: False ### -ProcessingType -Specifies the file type that **Get-WindowsUpdateLog** uses for temporary files that are created +Specifies the file type that `Get-WindowsUpdateLog` uses for temporary files that are created during intermediate processing. The acceptable values for this parameter are: - CSV (comma-separated values) From 58c6bc844bcfdee0fb1df28b4e9baab5d79d083c Mon Sep 17 00:00:00 2001 From: Matthew Dowst <7384306+mdowst@users.noreply.github.com> Date: Thu, 27 Apr 2023 15:25:29 -0700 Subject: [PATCH 154/650] Update docset/winserver2022-ps/windowsupdate/Get-WindowsUpdateLog.md Co-authored-by: Mikey Lombardi (He/Him) --- docset/winserver2022-ps/windowsupdate/Get-WindowsUpdateLog.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/windowsupdate/Get-WindowsUpdateLog.md b/docset/winserver2022-ps/windowsupdate/Get-WindowsUpdateLog.md index a3339d5001..5eadba6ccf 100644 --- a/docset/winserver2022-ps/windowsupdate/Get-WindowsUpdateLog.md +++ b/docset/winserver2022-ps/windowsupdate/Get-WindowsUpdateLog.md @@ -125,7 +125,7 @@ Accept wildcard characters: False ### -ForceFlush Indicates that this cmdlet forces the Windows Update Agent on the current device to flush all of its -traces to .etl files. This process stops the Update Orchestrator and Windows Update services. +traces to `.etl` files. This process stops the Update Orchestrator and Windows Update services. Running this cmdlet with this parameter requires administrative credentials. You can start Windows PowerShell with administrative credentials by using the Run as administrator command. From d5cbe2c1961cb8897314262b6f793a095ab1744d Mon Sep 17 00:00:00 2001 From: Joe Gast Date: Thu, 27 Apr 2023 15:30:41 -0700 Subject: [PATCH 155/650] Export-HgsGuardian.md - documentation formatting --- .../hgsclient/Export-HgsGuardian.md | 21 ++++++++++++------- 1 file changed, 14 insertions(+), 7 deletions(-) diff --git a/docset/winserver2022-ps/hgsclient/Export-HgsGuardian.md b/docset/winserver2022-ps/hgsclient/Export-HgsGuardian.md index 0da9f3fd5f..a99e1ddbec 100644 --- a/docset/winserver2022-ps/hgsclient/Export-HgsGuardian.md +++ b/docset/winserver2022-ps/hgsclient/Export-HgsGuardian.md @@ -20,22 +20,26 @@ Export-HgsGuardian [-InputObject] [-Path] [ Get-HgsGuardian -Name "Guardian11" | Export-HGsGuardian -Path "C:\LocalHGSFiles\Guardian11.xml" + +```powershell +Get-HgsGuardian -Name "Guardian11" | Export-HGsGuardian -Path "C:\LocalHGSFiles\Guardian11.xml" ``` -This command uses the **Get-HgsGuardian** cmdlet to get the guardian named Guardian11, and then passes the object to the current cmdlet by using the pipeline operator. -That cmdlet exports the guardian to the specified file. +This command uses the **Get-HgsGuardian** cmdlet to get the guardian named `Guardian11`, and then +passes the object to the current cmdlet by using the pipeline operator. That cmdlet exports the +guardian to the specified file. ## PARAMETERS ### -InputObject -Specifies the input to this cmdlet. + +Specifies the input to this cmdlet. You can use this parameter, or you can pipe the input to this cmdlet. ```yaml @@ -51,6 +55,7 @@ Accept wildcard characters: False ``` ### -Path + Specifies the path to the file to write an XML representation of the guardian. ```yaml @@ -66,7 +71,10 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, +-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, +-WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -83,4 +91,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [New-HgsGuardian](./New-HgsGuardian.md) [Remove-HgsGuardian](./Remove-HgsGuardian.md) - From 556ce69d47ecd25c19c581d1e6d2b51c909d2fd3 Mon Sep 17 00:00:00 2001 From: Joe Gast Date: Thu, 27 Apr 2023 15:35:39 -0700 Subject: [PATCH 156/650] Get-HgsAttestationBaselinePolicy.md - documentation formatting --- .../Get-HgsAttestationBaselinePolicy.md | 30 ++++++++++++------- 1 file changed, 20 insertions(+), 10 deletions(-) diff --git a/docset/winserver2022-ps/hgsclient/Get-HgsAttestationBaselinePolicy.md b/docset/winserver2022-ps/hgsclient/Get-HgsAttestationBaselinePolicy.md index fa8b295e29..657264cbf5 100644 --- a/docset/winserver2022-ps/hgsclient/Get-HgsAttestationBaselinePolicy.md +++ b/docset/winserver2022-ps/hgsclient/Get-HgsAttestationBaselinePolicy.md @@ -26,31 +26,35 @@ Get-HgsAttestationBaselinePolicy [-Console] [-SkipValidation] [ Get-HgsAttestationBaselinePolicy -Path "C:\Logs\AttestationBaselinePolicy001" -Force ``` -This command generates a byte array that represents the baseline policy in the file C:\Logs\AttestationBaselinePolicy001. +This command generates a byte array that represents the baseline policy in the file `C:\Logs\AttestationBaselinePolicy001`. ## PARAMETERS ### -Console + Indicates that this cmdlet operates in console mode. ```yaml Type: SwitchParameter Parameter Sets: Console -Aliases: +Aliases: Required: True Position: Named @@ -60,12 +64,13 @@ Accept wildcard characters: False ``` ### -Force + Indicates that this cmdlet overwrites an existing file that the **Output** object specifies. ```yaml Type: SwitchParameter Parameter Sets: File -Aliases: +Aliases: Required: False Position: Named @@ -75,6 +80,7 @@ Accept wildcard characters: False ``` ### -Path + Specifies a file path. This cmdlet writes the policy to the file that this parameter specifies. @@ -91,12 +97,13 @@ Accept wildcard characters: False ``` ### -SkipValidation + Indicates that this cmdlet skips validation. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -106,7 +113,11 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, +-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, +-WarningAction, and -WarningVariable. For more information, see +[about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -117,4 +128,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS - From dce9d8ff78b3f1b424c0189c733d19d551ab5a39 Mon Sep 17 00:00:00 2001 From: Matthew Dowst <7384306+mdowst@users.noreply.github.com> Date: Thu, 27 Apr 2023 15:37:09 -0700 Subject: [PATCH 157/650] added backticks to file names and extensions --- .../windowsupdate/Get-WindowsUpdateLog.md | 24 +++++++++---------- 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/docset/winserver2022-ps/windowsupdate/Get-WindowsUpdateLog.md b/docset/winserver2022-ps/windowsupdate/Get-WindowsUpdateLog.md index 5eadba6ccf..8f9e914656 100644 --- a/docset/winserver2022-ps/windowsupdate/Get-WindowsUpdateLog.md +++ b/docset/winserver2022-ps/windowsupdate/Get-WindowsUpdateLog.md @@ -12,7 +12,7 @@ title: Get-WindowsUpdateLog ## SYNOPSIS -Merges Windows Update .etl files into a single log file. +Merges Windows Update `.etl` files into a single log file. ## SYNTAX @@ -23,10 +23,10 @@ Get-WindowsUpdateLog [[-ETLPath] ] [[-LogPath] ] ## DESCRIPTION -The `Get-WindowsUpdateLog` cmdlet merges and converts Windows Update .etl files into a single +The `Get-WindowsUpdateLog` cmdlet merges and converts Windows Update `.etl` files into a single readable `WindowsUpdate.log` file. Windows Update Agent uses Event Tracing for Windows (ETW) to generate diagnostic logs. Windows Update no longer directly produces a `WindowsUpdate.log` file. -Instead, it produces .etl files that are not immediately readable as written. +Instead, it produces `.etl` files that are not immediately readable as written. For Windows 10 versions prior to 1709 (OS Build 16299), this cmdlet requires access to a Microsoft symbol server, and log decoding must be run from a Windows 10 version earlier than 1709. Logs from @@ -106,9 +106,9 @@ Specifies an array of paths of Windows Update `.etl` files to convert into `Wind default value for this parameter is the Windows Update trace file directory for the current device. The acceptable values for this parameter are: -- The full path of a directory that contains one or more .etl files. -- The full path of a single .etl file. -- A comma-separated list of full paths of .etl files. +- The full path of a directory that contains one or more `.etl` files. +- The full path of a single `.etl` file. +- A comma-separated list of full paths of `.etl` files. ```yaml Type: String[] @@ -143,8 +143,8 @@ Accept wildcard characters: False ### -LogPath -Specifies the full path to which **Get-WindowsUpdateLog** writes WindowsUpdate.log. -The default value is WindowsUpdate.log in the Desktop folder of the current user. +Specifies the full path to which `Get-WindowsUpdateLog` writes `WindowsUpdate.log`. +The default value is `WindowsUpdate.log` in the Desktop folder of the current user. ```yaml Type: String @@ -163,11 +163,11 @@ Accept wildcard characters: False Specifies the file type that `Get-WindowsUpdateLog` uses for temporary files that are created during intermediate processing. The acceptable values for this parameter are: -- CSV (comma-separated values) -- XML +- `CSV` (comma-separated values) +- `XML` -By default, the value is XML. -The temporary files are in $env:TEMP\WindowsUpdateLog. +By default, the value is `XML`. +The temporary files are in `$env:TEMP\WindowsUpdateLog`. ```yaml Type: String From 814df203d7faddfd320bac2c0d592a920638b57d Mon Sep 17 00:00:00 2001 From: Missy Januszko Date: Thu, 27 Apr 2023 18:37:33 -0400 Subject: [PATCH 158/650] clean up line length, CR/LF, trailing spaces --- .../defender/Add-MpPreference.md | 127 +++++++++++------- 1 file changed, 80 insertions(+), 47 deletions(-) diff --git a/docset/winserver2022-ps/defender/Add-MpPreference.md b/docset/winserver2022-ps/defender/Add-MpPreference.md index 993db0e5ed..7bcdb31a2d 100644 --- a/docset/winserver2022-ps/defender/Add-MpPreference.md +++ b/docset/winserver2022-ps/defender/Add-MpPreference.md @@ -16,31 +16,37 @@ Modifies settings for Windows Defender. ## SYNTAX ``` -Add-MpPreference [-ExclusionPath ] [-ExclusionExtension ] [-ExclusionProcess ] - [-ExclusionIpAddress ] [-ThreatIDDefaultAction_Ids ] - [-ThreatIDDefaultAction_Actions ] [-AttackSurfaceReductionOnlyExclusions ] - [-ControlledFolderAccessAllowedApplications ] [-ControlledFolderAccessProtectedFolders ] - [-AttackSurfaceReductionRules_Ids ] [-AttackSurfaceReductionRules_Actions ] - [-Force] [-CimSession ] [-ThrottleLimit ] [-AsJob] [] +Add-MpPreference [-ExclusionPath ] [-ExclusionExtension ] +[-ExclusionProcess ] [-ExclusionIpAddress ] +[-ThreatIDDefaultAction_Ids ] [-ThreatIDDefaultAction_Actions ] +[-AttackSurfaceReductionOnlyExclusions ] +[-ControlledFolderAccessAllowedApplications ] +[-ControlledFolderAccessProtectedFolders ] [-AttackSurfaceReductionRules_Ids ] +[-AttackSurfaceReductionRules_Actions ] [-Force] [-CimSession ] +[-ThrottleLimit ] [-AsJob] [] ``` ## DESCRIPTION -The **Add-MpPreference** cmdlet modifies settings for Windows Defender. -Use this cmdlet to add exclusions for file name extensions, paths, and processes, and to add default actions for high, moderate, and low threats. + +The `Add-MpPreference` cmdlet modifies settings for Windows Defender. Use this cmdlet to add +exclusions for file name extensions, paths, and processes, and to add default actions for high, +moderate, and low threats. ## EXAMPLES ### Example 1: Add a folder to the exclusion list + ```powershell -Add-MpPreference -ExclusionPath "C:\Temp" +Add-MpPreference -ExclusionPath 'C:\Temp' ``` This command adds the folder C:\Temp to the exclusion list. The command disables Windows Defender scheduled and real-time scanning for files in this folder. ### Example 2: Allow an application to access folders + ```powershell -Add-MpPreference -ControlledFolderAccessAllowedApplications "c:\apps\test.exe" +Add-MpPreference -ControlledFolderAccessAllowedApplications 'c:\apps\test.exe' ``` This command allows the specified application to make changes in controlled folders. @@ -48,14 +54,17 @@ This command allows the specified application to make changes in controlled fold ## PARAMETERS ### -AsJob -Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. -The cmdlet immediately returns an object that represents the job and then displays the command prompt. -You can continue to work in the session while the job completes. -To manage the job, use the `*-Job` cmdlets. -To get the job results, use the [Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. +Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to +complete. -For more information about Windows PowerShell background jobs, see [about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). +The cmdlet immediately returns an object that represents the job and then displays the command +prompt. You can continue to work in the session while the job completes. To manage the job, use the +`*-Job` cmdlets. To get the job results, use the +[Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. + +For more information about Windows PowerShell background jobs, see +[about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). ```yaml Type: SwitchParameter @@ -70,9 +79,15 @@ Accept wildcard characters: False ``` ### -AttackSurfaceReductionOnlyExclusions -Specifies the files and paths to exclude from attack surface reduction (ASR) rules. Specifies the folders or files and resources that should be excluded from ASR rules. Enter a folder path or a fully qualified resource name. For example, `C:\Windows` excludes all files in that directory. `C:\Windows\App.exe` excludes only that specific file in that specific folder. -See the [ASR rules](/windows/security/threat-protection/microsoft-defender-atp/enable-attack-surface-reduction#exclude-files-and-folders-from-asr-rules) topic for more information about excluding files and folders from ASR rules. +Specifies the files and paths to exclude from attack surface reduction (ASR) rules. Specifies the +folders or files and resources that should be excluded from ASR rules. Enter a folder path or a +fully qualified resource name. For example, `C:\Windows` excludes all files in that directory. +`C:\Windows\App.exe` excludes only that specific file in that specific folder. + +See the +[ASR rules](/windows/security/threat-protection/microsoft-defender-atp/enable-attack-surface-reduction#exclude-files-and-folders-from-asr-rules) +topic for more information about excluding files and folders from ASR rules. ```yaml Type: String[] @@ -87,8 +102,10 @@ Accept wildcard characters: False ``` ### -AttackSurfaceReductionRules_Actions -Specifies the states of attack surface reduction rules specified by using the **AttackSurfaceReductionRules_Ids** parameter. -If you add multiple rules as a comma-separated list, specify their states separately as a comma-separated list. + +Specifies the states of attack surface reduction rules specified by using the +**AttackSurfaceReductionRules_Ids** parameter. If you add multiple rules as a comma-separated list, +specify their states separately as a comma-separated list. ```yaml Type: ASRRuleActionType[] @@ -103,10 +120,10 @@ Accept wildcard characters: False ``` ### -AttackSurfaceReductionRules_Ids -Specifies the IDs of attack surface reduction rules. -Use the **AttackSurfaceReductionRules_Actions** parameter to specify the state for each rule. -If you add multiple rules as a comma-separated list, specify their states separately as a comma-separated list. +Specifies the IDs of attack surface reduction rules. Use the **AttackSurfaceReductionRules_Actions** +parameter to specify the state for each rule. If you add multiple rules as a comma-separated list, +specify their states separately as a comma-separated list. ```yaml Type: String[] @@ -121,9 +138,11 @@ Accept wildcard characters: False ``` ### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -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. -The default is the current session on the local computer. + +Runs the cmdlet in a remote session or on a remote computer. 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. The default is the +current session on the local computer. ```yaml Type: CimSession[] @@ -138,6 +157,7 @@ Accept wildcard characters: False ``` ### -ControlledFolderAccessAllowedApplications + Specifies applications that can make changes in controlled folders. ```yaml @@ -153,6 +173,7 @@ Accept wildcard characters: False ``` ### -ControlledFolderAccessProtectedFolders + Specifies more folders to protect. ```yaml @@ -168,8 +189,9 @@ Accept wildcard characters: False ``` ### -ExclusionExtension -Specifies an array of file name extensions, such as obj or lib, to exclude from scheduled, custom, and real-time scanning. -This cmdlet adds these file name extensions to the exclusions. + +Specifies an array of file name extensions, such as obj or lib, to exclude from scheduled, custom, +and real-time scanning. This cmdlet adds these file name extensions to the exclusions. ```yaml Type: String[] @@ -184,6 +206,7 @@ Accept wildcard characters: False ``` ### -ExclusionIpAddress + Specifies an array of IP addresses to exclude from scheduled and real-time scanning. ```yaml @@ -199,6 +222,7 @@ Accept wildcard characters: False ``` ### -ExclusionPath + Specifies an array of file paths to exclude from scheduled and real-time scanning. You can specify a folder to exclude all the files under the folder. @@ -215,11 +239,11 @@ Accept wildcard characters: False ``` ### -ExclusionProcess -Specifies an array of processes, as paths to process images. -This cmdlet excludes any files opened by the processes that you specify from scheduled and real-time scanning. -Specifying this parameter excludes files opened by executable programs only. -The cmdlet does not exclude the processes themselves. -To exclude a process, specify it by using the **ExclusionPath** parameter. + +Specifies an array of processes, as paths to process images. This cmdlet excludes any files opened +by the processes that you specify from scheduled and real-time scanning. Specifying this parameter +excludes files opened by executable programs only. The cmdlet does not exclude the processes +themselves. To exclude a process, specify it by using the **ExclusionPath** parameter. ```yaml Type: String[] @@ -234,6 +258,7 @@ Accept wildcard characters: False ``` ### -Force + Forces the command to run without asking for user confirmation. ```yaml @@ -249,15 +274,16 @@ Accept wildcard characters: False ``` ### -ThreatIDDefaultAction_Actions -Specifies an array of the actions to take for the IDs specified by using the **ThreatIDDefaultAction_Ids** parameter. -The acceptable values for this parameter are: - -- 1: Clean -- 2: Quarantine -- 3: Remove -- 6: Allow -- 8: UserDefined -- 9: NoAction + +Specifies an array of the actions to take for the IDs specified by using the +**ThreatIDDefaultAction_Ids** parameter. The acceptable values for this parameter are: + +- 1: Clean +- 2: Quarantine +- 3: Remove +- 6: Allow +- 8: UserDefined +- 9: NoAction - 10: Block ```yaml @@ -274,6 +300,7 @@ Accept wildcard characters: False ``` ### -ThreatIDDefaultAction_Ids + Specifies an array of threat IDs. This cmdlet adds the default action for the threat IDs that you specify. @@ -290,9 +317,12 @@ Accept wildcard characters: False ``` ### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -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. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. + +Specifies the maximum number of concurrent operations that can be established to run the cmdlet. 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. The throttle limit applies only to the current cmdlet, not to the session or to the +computer. ```yaml Type: Int32 @@ -307,7 +337,11 @@ Accept wildcard characters: False ``` ### CommonParameters -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). + +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). ## INPUTS @@ -322,4 +356,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-MpPreference](./Remove-MpPreference.md) [Set-MpPreference](./Set-MpPreference.md) - From 94a2007685285666d0e2b1b75d4bc3332a91ada8 Mon Sep 17 00:00:00 2001 From: Robert Biddle Date: Thu, 27 Apr 2023 18:37:55 -0400 Subject: [PATCH 159/650] Style fixes --- .../addsdeployment/Install-ADDSDomain.md | 226 ++++++++++++------ 1 file changed, 149 insertions(+), 77 deletions(-) diff --git a/docset/winserver2022-ps/addsdeployment/Install-ADDSDomain.md b/docset/winserver2022-ps/addsdeployment/Install-ADDSDomain.md index 0f1e46292d..e3552bfc8a 100644 --- a/docset/winserver2022-ps/addsdeployment/Install-ADDSDomain.md +++ b/docset/winserver2022-ps/addsdeployment/Install-ADDSDomain.md @@ -11,39 +11,56 @@ title: Install-ADDSDomain # Install-ADDSDomain ## SYNOPSIS + Creates a new domain in an existing Active Directory forest. ## SYNTAX ``` Install-ADDSDomain [-SkipPreChecks] -NewDomainName -ParentDomainName - [-SafeModeAdministratorPassword ] [-ADPrepCredential ] [-AllowDomainReinstall] - [-CreateDnsDelegation] [-Credential ] [-DatabasePath ] - [-DnsDelegationCredential ] [-NoDnsOnNetwork] [-DomainMode ] - [-DomainType ] [-NoGlobalCatalog] [-InstallDns] [-LogPath ] - [-NewDomainNetbiosName ] [-NoRebootOnCompletion] [-ReplicationSourceDC ] [-SiteName ] - [-SkipAutoConfigureDns] [-SysvolPath ] [-Force] [-WhatIf] [-Confirm] [] +[-SafeModeAdministratorPassword ] [-ADPrepCredential ] +[-AllowDomainReinstall] [-CreateDnsDelegation] [-Credential ] +[-DatabasePath ] [-DnsDelegationCredential ] [-NoDnsOnNetwork] +[-DomainMode ] [-DomainType ] [-NoGlobalCatalog] [-InstallDns] +[-LogPath ] [-NewDomainNetbiosName ] [-NoRebootOnCompletion] +[-ReplicationSourceDC ] [-SiteName ] [-SkipAutoConfigureDns] +[-SysvolPath ] [-Force] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION -The **Install-ADDSDomain** cmdlet installs an Active Directory domain configuration. + +The `Install-ADDSDomain` cmdlet installs an Active Directory domain configuration. ## EXAMPLES ### Example 1: Install a new child domain + ``` -PS C:\> Install-ADDSDomain -Credential (Get-Credential CORP\EnterpriseAdmin1) -NewDomainName child -ParentDomainName "corp.contoso.com" -InstallDNS -CreateDNSDelegation -DomainMode Win2003 -ReplicationSourceDC "DC1.corp.contoso.com" -SiteName "Houston" -DatabasePath "D:\NTDS" -SYSVOLPath "D:\SYSVOL" -LogPath "E:\Logs" -NoRebootOnCompletion +Install-ADDSDomain -Credential (Get-Credential CORP\EnterpriseAdmin1) ` +-NewDomainName child -ParentDomainName "corp.contoso.com" -InstallDNS ` +-CreateDNSDelegation -DomainMode Win2003 ` +-ReplicationSourceDC "DC1.corp.contoso.com" -SiteName "Houston" ` +-DatabasePath "D:\NTDS" -SYSVOLPath "D:\SYSVOL" -LogPath "E:\Logs" ` +-NoRebootOnCompletion ``` -This command installs a new child domain named child.corp.contoso.com using credentials of CORP\EnterpriseAdmin1. -This command also installs a DNS server, creates a DNS delegation in the corp.contoso.com domain, sets the domain functional level to Windows Server 2003, makes the domain controller a global catalog server in a site named Houston, uses DC1.corp.contoso.com as the replication source domain controller, installs the Active Directory database and SYSVOL on the D:\ drive. -Additionally this command also installs the log files on the E:\ drive, has the server not automatically restart after the domain installation is complete and causes the user to be prompted to provide and confirm the Directory Services Restore Mode (DSRM) password to complete and commit the installation of the domain in Active Directory. +This command installs a new child domain named child.corp.contoso.com using credentials of +CORP\EnterpriseAdmin1. This command also installs a DNS server, creates a DNS delegation in the +corp.contoso.com domain, sets the domain functional level to Windows Server 2003, makes the domain +controller a global catalog server in a site named Houston, uses DC1.corp.contoso.com as the +replication source domain controller, installs the Active Directory database and SYSVOL on the `D:\` +drive. Additionally this command also installs the log files on the `E:\` drive, has the server not +automatically restart after the domain installation is complete and causes the user to be prompted +to provide and confirm the Directory Services Restore Mode (DSRM) password to complete and commit +the installation of the domain in Active Directory. ## PARAMETERS ### -ADPrepCredential -Specifies the user name and password that corresponds to the account to be used for running operations to prepare Active Directory prior to the installation of this domain. -Use the **Get-Credential** cmdlet to prompt the user to supply a password. + +Specifies the user name and password that corresponds to the account to be used for running +operations to prepare Active Directory prior to the installation of this domain. Use the +**Get-Credential** cmdlet to prompt the user to supply a password. ```yaml Type: PSCredential @@ -58,6 +75,7 @@ Accept wildcard characters: False ``` ### -AllowDomainReinstall + Indicates that the cmdlet recreates an existing domain. ```yaml @@ -73,6 +91,7 @@ Accept wildcard characters: False ``` ### -Confirm + Prompts you for confirmation before running the cmdlet. ```yaml @@ -88,9 +107,10 @@ Accept wildcard characters: False ``` ### -CreateDnsDelegation -Indicates that the cmdlet creates a DNS delegation that references the new DNS server that you install along with the domain controller. -Valid for Active Directory-integrated DNS only. -The default is computed automatically based on the environment. + +Indicates that the cmdlet creates a DNS delegation that references the new DNS server that you +install along with the domain controller. Valid for Active Directory-integrated DNS only. The +default is computed automatically based on the environment. ```yaml Type: SwitchParameter @@ -105,8 +125,9 @@ Accept wildcard characters: False ``` ### -Credential -Specifies the user name and password that corresponds to the account used to install the domain controller. -Use the **Get-Credential** cmdlet to prompt the user to supply a password. + +Specifies the user name and password that corresponds to the account used to install the domain +controller. Use the **Get-Credential** cmdlet to prompt the user to supply a password. ```yaml Type: PSCredential @@ -121,8 +142,10 @@ Accept wildcard characters: False ``` ### -DatabasePath -Specifies the fully qualified, non-Universal Naming Convention (UNC) path to a directory on a fixed disk of the local computer that contains the domain database, for instance, C:\Windows\NTDS. -The default is %SYSTEMROOT%\NTDS. + +Specifies the fully qualified, non-Universal Naming Convention (UNC) path to a directory on a fixed +disk of the local computer that contains the domain database, for instance, `C:\Windows\NTDS`. The +default is `%SYSTEMROOT%\NTDS`. ```yaml Type: String @@ -137,8 +160,10 @@ Accept wildcard characters: False ``` ### -DnsDelegationCredential -Specifies the user name and password (account credentials) for creating the DNS delegation. -This parameter is skipped if the value for the *CreateDnsDelegation* parameter is either specified or computed to be $false. + +Specifies the user name and password (account credentials) for creating the DNS delegation. This +parameter is skipped if the value for the _CreateDnsDelegation_ parameter is either specified or +computed to be $false. ```yaml Type: PSCredential @@ -153,9 +178,11 @@ Accept wildcard characters: False ``` ### -DomainMode -Specifies the domain functional level of the first domain in the creation of a new forest. -Supported values for this parameter can be either a valid integer or a corresponding enumerated string value. -For instance, to set the domain mode level to Windows Server 2008 R2, you can specify either a value of 4 or Win2008R2. + +Specifies the domain functional level of the first domain in the creation of a new forest. Supported +values for this parameter can be either a valid integer or a corresponding enumerated string value. +For instance, to set the domain mode level to Windows Server 2008 R2, you can specify either a value +of 4 or Win2008R2. The acceptable values for this parameter are: @@ -183,9 +210,10 @@ Accept wildcard characters: False ``` ### -DomainType -Specifies the type of domain that this cmdlet creates. -You can create a new domain tree in an existing forest (supported values are TreeDomain or tree) or a child of an existing domain (supported values are ChildDomain or child). -The default is ChildDomain. + +Specifies the type of domain that this cmdlet creates. You can create a new domain tree in an +existing forest (supported values are TreeDomain or tree) or a child of an existing domain +(supported values are ChildDomain or child). The default is ChildDomain. ```yaml Type: DomainType @@ -201,6 +229,7 @@ Accept wildcard characters: False ``` ### -Force + Forces the command to run without asking for user confirmation. ```yaml @@ -216,12 +245,18 @@ Accept wildcard characters: False ``` ### -InstallDns -Indicates that the cmdlet installs and configures the DNS Server service for the domain or domain tree. -For domain installation, if this parameter is left unspecified and the parent domain (or in the case of a domain tree, the forest root domain) already hosts and stores the DNS names for the domain, then the default for this parameter is $true and the DNS server is installed. -Otherwise, if DNS domain names are hosted outside of Active Directory, the default is $false and no DNS server is installed. -To test if DNS domain names are hosted outside of Active Directory, this cmdlet uses a start of authority (SOA) type DNS query. -For instance, if the value of *NewDomainName* parameter is corp.contoso.com, Active Directory performs an SOA query for corp.contoso.com and ensures that the zone name in the response is corp.contoso.com. +Indicates that the cmdlet installs and configures the DNS Server service for the domain or domain +tree. For domain installation, if this parameter is left unspecified and the parent domain (or in +the case of a domain tree, the forest root domain) already hosts and stores the DNS names for the +domain, then the default for this parameter is $true and the DNS server is installed. Otherwise, if +DNS domain names are hosted outside of Active Directory, the default is $false and no DNS server is +installed. + +To test if DNS domain names are hosted outside of Active Directory, this cmdlet uses a start of +authority (SOA) type DNS query. For instance, if the value of _NewDomainName_ parameter is +corp.contoso.com, Active Directory performs an SOA query for corp.contoso.com and ensures that the +zone name in the response is corp.contoso.com. ```yaml Type: SwitchParameter @@ -236,8 +271,10 @@ Accept wildcard characters: False ``` ### -LogPath -Specifies the fully qualified, non-UNC path to a directory on a fixed disk of the local computer that contains the domain log files, for instance, C:\Windows\Logs. -The default is %SYSTEMROOT%\NTDS. + +Specifies the fully qualified, non-UNC path to a directory on a fixed disk of the local computer +that contains the domain log files, for instance, `C:\Windows\Logs`. The default is +`%SYSTEMROOT%\NTDS`. ```yaml Type: String @@ -252,9 +289,11 @@ Accept wildcard characters: False ``` ### -NewDomainName -Specifies the new domain name that this cmdlet installs. -If the value set for the *DomainType* parameter is set to TreeDomain, this parameter can be used to specify the fully qualified domain name (FQDN) for the new domain tree. -If the value set for the *DomainType* parameter is set to ChildDomain, this parameter can be used to specify a single label domain name for the child domain. + +Specifies the new domain name that this cmdlet installs. If the value set for the _DomainType_ +parameter is set to TreeDomain, this parameter can be used to specify the fully qualified domain +name (FQDN) for the new domain tree. If the value set for the _DomainType_ parameter is set to +ChildDomain, this parameter can be used to specify a single label domain name for the child domain. ```yaml Type: String @@ -269,16 +308,21 @@ Accept wildcard characters: False ``` ### -NewDomainNetbiosName -Specifies the NetBIOS name for the new domain. -For NetBIOS names to be valid for use with this parameter they must be single label names of 15 characters or less. -If this parameter is set with a valid NetBIOS name value, then promotion continues with the name specified. -If this parameter is not set, then the default is automatically computed from the value of the *NewDomainName* parameter. +Specifies the NetBIOS name for the new domain. For NetBIOS names to be valid for use with this +parameter they must be single label names of 15 characters or less. -For instance, if this parameter is not specified and a single-label prefix domain name of 15 characters or less is specified within the value of the *NewDomainName* parameter, then promotion continues with an automatically generated NetBIOS domain name. -For example, the prefix label corp within a full domain name value of corp.contoso.com would be a successful name choice. +If this parameter is set with a valid NetBIOS name value, then promotion continues with the name +specified. If this parameter is not set, then the default is automatically computed from the value +of the _NewDomainName_ parameter. -Note that if the name value given for this parameter is a name of 16 characters or more, then the domain installation will fail. +For instance, if this parameter is not specified and a single-label prefix domain name of 15 +characters or less is specified within the value of the _NewDomainName_ parameter, then promotion +continues with an automatically generated NetBIOS domain name. For example, the prefix label corp +within a full domain name value of corp.contoso.com would be a successful name choice. + +Note that if the name value given for this parameter is a name of 16 characters or more, then the +domain installation will fail. ```yaml Type: String @@ -293,13 +337,17 @@ Accept wildcard characters: False ``` ### -NoDnsOnNetwork -Indicates that the DNS service is not available on the network. -This parameter is used only when the IP setting of the network adapter for this computer is not configured with the name of a DNS server for name resolution. -It indicates that a DNS server is installed on this computer for name resolution. -Otherwise, the IP settings of the network adapter must first be configured with the address of a DNS server. -Omitting this parameter (the default) indicates that the TCP/IP client settings of the network adapter on this server computer is used to contact a DNS server. -Therefore, if you do not specify this parameter, ensure that TCP/IP client settings are first configured with a preferred DNS server address. +Indicates that the DNS service is not available on the network. This parameter is used only when the +IP setting of the network adapter for this computer is not configured with the name of a DNS server +for name resolution. It indicates that a DNS server is installed on this computer for name +resolution. Otherwise, the IP settings of the network adapter must first be configured with the +address of a DNS server. + +Omitting this parameter (the default) indicates that the TCP/IP client settings of the network +adapter on this server computer is used to contact a DNS server. Therefore, if you do not specify +this parameter, ensure that TCP/IP client settings are first configured with a preferred DNS server +address. ```yaml Type: SwitchParameter @@ -314,6 +362,7 @@ Accept wildcard characters: False ``` ### -NoGlobalCatalog + Specifies that the read-only domain controller (RODC) will not be a global catalog server. By default, the domain controller that you are installing is a global catalog server. @@ -330,9 +379,12 @@ Accept wildcard characters: False ``` ### -NoRebootOnCompletion -Indicates that the cmdlet does not reboot the computer upon completion. -By default, reboot upon completion occurs when this cmdlet is used and this parameter is omitted. -As a general rule, Microsoft support recommends that you not use this parameter except for testing or troubleshooting purposes because once configuration has completed the server will not function correctly as either a member server or a DC until it is rebooted. + +Indicates that the cmdlet does not reboot the computer upon completion. By default, reboot upon +completion occurs when this cmdlet is used and this parameter is omitted. As a general rule, +Microsoft support recommends that you not use this parameter except for testing or troubleshooting +purposes because once configuration has completed the server will not function correctly as either a +member server or a DC until it is rebooted. ```yaml Type: SwitchParameter @@ -347,6 +399,7 @@ Accept wildcard characters: False ``` ### -ParentDomainName + Specifies the fully qualified domain name (FQDN) of an existing parent domain. ```yaml @@ -362,8 +415,10 @@ Accept wildcard characters: False ``` ### -ReplicationSourceDC -Specifies the fully qualified domain name (FQDN) of the domain controller to be used as the source for replicating to this domain. -The default value for this parameter is automatically computed from the environment. + +Specifies the fully qualified domain name (FQDN) of the domain controller to be used as the source +for replicating to this domain. The default value for this parameter is automatically computed from +the environment. ```yaml Type: String @@ -378,15 +433,19 @@ Accept wildcard characters: False ``` ### -SafeModeAdministratorPassword -Specifies the password for the administrator account when the computer is started in Safe Mode or a variant of Safe Mode, such as Directory Services Restore Mode. -You must supply a password that meets the password complexity rules of the domain and the password cannot be blank. -If specified with a value, the value must be a secure string. + +Specifies the password for the administrator account when the computer is started in Safe Mode or a +variant of Safe Mode, such as Directory Services Restore Mode. You must supply a password that meets +the password complexity rules of the domain and the password cannot be blank. If specified with a +value, the value must be a secure string. If this parameter is not specified, the cmdlet prompts you to enter and confirm a masked password. -This is the preferred usage when running the cmdlet interactively. -If there are no other arguments specified with the cmdlet, you are prompted to enter a masked password for this parameter but no confirmation of the password entered is made. -This is not recommended as it could allow a mistyped password to be configured. -Another available advanced option is to use the **ConvertTo-SecureString** cmdlet and specify the password string inline as unmasked console input, which is also not a recommended security best practice in production deployments. +This is the preferred usage when running the cmdlet interactively. If there are no other arguments +specified with the cmdlet, you are prompted to enter a masked password for this parameter but no +confirmation of the password entered is made. This is not recommended as it could allow a mistyped +password to be configured. Another available advanced option is to use the +**ConvertTo-SecureString** cmdlet and specify the password string inline as unmasked console input, +which is also not a recommended security best practice in production deployments. ```yaml Type: SecureString @@ -401,9 +460,10 @@ Accept wildcard characters: False ``` ### -SiteName -Specifies the name of an existing site where you can place the new domain controller. -The default value is the site that is associated with the subnet that includes the IP address of this server. -If no such site exists, the default is the site of the replication source domain controller. + +Specifies the name of an existing site where you can place the new domain controller. The default +value is the site that is associated with the subnet that includes the IP address of this server. If +no such site exists, the default is the site of the replication source domain controller. ```yaml Type: String @@ -418,8 +478,9 @@ Accept wildcard characters: False ``` ### -SkipAutoConfigureDns -Indicates that the cmdlet skips automatic configuration of DNS client settings, forwarders, and root hints. -This parameter is in effect only if the DNS Server service is already installed. + +Indicates that the cmdlet skips automatic configuration of DNS client settings, forwarders, and root +hints. This parameter is in effect only if the DNS Server service is already installed. ```yaml Type: SwitchParameter @@ -434,10 +495,14 @@ Accept wildcard characters: False ``` ### -SkipPreChecks -Indicates that the cmdlet performs only a base set of validations. -This behavior is equivalent to the validations that were performed when using Dcpromo.exe in earlier versions of Windows Server to add a new domain. -When this switch parameter is set, it specifies that additional preliminary checks should be bypassed. -For more information on the scope of these additional preliminary checks that the ADDSDeployment module performs by default when using Windows Server 2012, refer to the table in the section ADPrep and Prerequisite Checking Architecture in [AD DS Simplified Administration](https://go.microsoft.com/fwlink/?LinkID=237244). + +Indicates that the cmdlet performs only a base set of validations. This behavior is equivalent to +the validations that were performed when using Dcpromo.exe in earlier versions of Windows Server to +add a new domain. When this switch parameter is set, it specifies that additional preliminary checks +should be bypassed. For more information on the scope of these additional preliminary checks that +the ADDSDeployment module performs by default when using Windows Server 2012, refer to the table in +the section ADPrep and Prerequisite Checking Architecture in +[AD DS Simplified Administration](https://go.microsoft.com/fwlink/?LinkID=237244). ```yaml Type: SwitchParameter @@ -452,8 +517,9 @@ Accept wildcard characters: False ``` ### -SysvolPath -Specifies the fully qualified, non-UNC path to a directory on a fixed disk of the local computer, for example, C:\Windows\SYSVOL. -The default is %SYSTEMROOT%\SYSVOL. + +Specifies the fully qualified, non-UNC path to a directory on a fixed disk of the local computer, +for example, `C:\Windows\SYSVOL`. The default is `%SYSTEMROOT%\SYSVOL`. ```yaml Type: String @@ -468,6 +534,7 @@ Accept wildcard characters: False ``` ### -WhatIf + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -484,14 +551,20 @@ Accept wildcard characters: False ``` ### CommonParameters -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). + +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). ## INPUTS ## OUTPUTS ## NOTES -* When a new domain tree is created in an existing forest, a two-way, transitive tree root trust is established by default. + +- When a new domain tree is created in an existing forest, a two-way, transitive tree root trust is + established by default. ## RELATED LINKS @@ -504,4 +577,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Get-Credential](https://go.microsoft.com/fwlink/?LinkID=293936) [ConvertTo-SecureString](https://go.microsoft.com/fwlink/p/?LinkId=113291) - From be6dbd9ee78d40ad7e7146a6b507549571c72968 Mon Sep 17 00:00:00 2001 From: Joe Gast Date: Thu, 27 Apr 2023 15:39:54 -0700 Subject: [PATCH 160/650] Get-HgsClienConfiguration.md - documentation formatting --- .../hgsclient/Get-HgsClientConfiguration.md | 58 ++++++++++++------- 1 file changed, 37 insertions(+), 21 deletions(-) diff --git a/docset/winserver2022-ps/hgsclient/Get-HgsClientConfiguration.md b/docset/winserver2022-ps/hgsclient/Get-HgsClientConfiguration.md index aabf41fd10..6e46797846 100644 --- a/docset/winserver2022-ps/hgsclient/Get-HgsClientConfiguration.md +++ b/docset/winserver2022-ps/hgsclient/Get-HgsClientConfiguration.md @@ -16,16 +16,20 @@ Gets the configuration of a Host Guardian Service client. ## SYNTAX ``` -Get-HgsClientConfiguration [-CimSession ] [-ThrottleLimit ] [-AsJob] [] +Get-HgsClientConfiguration [-CimSession ] [-ThrottleLimit ] [-AsJob] + [] ``` ## DESCRIPTION -The **Get-HgsClientConfiguration** cmdlet get the configuration of the local Host Guardian Service client. + +The **Get-HgsClientConfiguration** cmdlet get the configuration of the local Host Guardian Service +client. ## EXAMPLES ### Example 1: Get client configuration -``` + +```powershell PS C:\> Get-HgsClientConfiguration ``` @@ -34,20 +38,22 @@ This command gets the configuration of the local Host Guardian Service client. ## PARAMETERS ### -AsJob -Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. -The cmdlet immediately returns an object that represents the job and then displays the command prompt. -You can continue to work in the session while the job completes. -To manage the job, use the `*-Job` cmdlets. -To get the job results, use the [Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. +Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to +complete. -For more information about Windows PowerShell background jobs, see [about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). +The cmdlet immediately returns an object that represents the job and then displays the command +prompt. You can continue to work in the session while the job completes. To manage the job, use the +`*-Job` cmdlets. To get the job results, use the +[Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. +For more information about Windows PowerShell background jobs, see +[about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -57,9 +63,11 @@ Accept wildcard characters: False ``` ### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -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. -The default is the current session on the local computer. + +Runs the cmdlet in a remote session or on a remote computer. 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. The default is the +current session on the local computer. ```yaml Type: CimSession[] @@ -74,14 +82,17 @@ Accept wildcard characters: False ``` ### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -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. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. + +Specifies the maximum number of concurrent operations that can be established to run the cmdlet. 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. The throttle limit applies only to the current cmdlet, not to the session or to the +computer. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -91,20 +102,25 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, +-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, +-WarningAction, and -WarningVariable. For more information, see +[about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS ## OUTPUTS ### CimInstance#MSFT_HgsClientConfiguration + This cmdlet returns the configuration of a Host Guardian Service client as a **CimInstance** object. -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. +The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays +Windows Management Instrumentation (WMI) objects. The path after the pound sign (`#`) provides the +namespace and class name for the underlying WMI object. ## NOTES ## RELATED LINKS [Set-HgsClientConfiguration](./Set-HgsClientConfiguration.md) - From e425fb9c52e624802ef21984e431492ddd4571ba Mon Sep 17 00:00:00 2001 From: Missy Januszko Date: Thu, 27 Apr 2023 18:40:36 -0400 Subject: [PATCH 161/650] Add cr/lf and remove extra cr/lf --- docset/winserver2022-ps/defender/Defender.md | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-) diff --git a/docset/winserver2022-ps/defender/Defender.md b/docset/winserver2022-ps/defender/Defender.md index 61e9e2d9fb..e9d673959e 100644 --- a/docset/winserver2022-ps/defender/Defender.md +++ b/docset/winserver2022-ps/defender/Defender.md @@ -10,7 +10,9 @@ title: Defender --- # Defender Module + ## Description + This reference provides functions descriptions and syntax for all Defender-specific functions. It lists the functions in alphabetical order based on the verb at the beginning of the functions. @@ -18,40 +20,51 @@ It lists the functions in alphabetical order based on the verb at the beginning > You might also hear these functions being referred to as cmdlets. They were designed to appear like cmdlets, even though they were developed as PowerShell functions. ## Defender Cmdlets + ### [Add-MpPreference](./Add-MpPreference.md) + Modifies settings for Windows Defender. ### [Get-MpComputerStatus](./Get-MpComputerStatus.md) + Gets the status of antimalware software on the computer. ### [Get-MpPreference](./Get-MpPreference.md) + Gets preferences for the Windows Defender scans and updates. ### [Get-MpThreat](./Get-MpThreat.md) + Gets the history of threats detected on the computer. ### [Get-MpThreatCatalog](./Get-MpThreatCatalog.md) + Gets known threats from the definitions catalog. ### [Get-MpThreatDetection](./Get-MpThreatDetection.md) + Gets active and past malware threats that Windows Defender detected. ### [Remove-MpPreference](./Remove-MpPreference.md) + Removes exclusions or default actions. ### [Remove-MpThreat](./Remove-MpThreat.md) + Removes active threats from a computer. ### [Set-MpPreference](./Set-MpPreference.md) + Configures preferences for Windows Defender scans and updates. ### [Start-MpScan](./Start-MpScan.md) + Starts a scan on a computer. ### [Start-MpWDOScan](./Start-MpWDOScan.md) + Starts a Windows Defender offline scan. ### [Update-MpSignature](./Update-MpSignature.md) -Updates the antimalware definitions on a computer. - +Updates the antimalware definitions on a computer. From a0f547648254ea17a275b2124645113f51c83da3 Mon Sep 17 00:00:00 2001 From: Joe Gast Date: Thu, 27 Apr 2023 15:43:44 -0700 Subject: [PATCH 162/650] Get-HgsGuardian.md - documentation formatting --- .../hgsclient/Get-HgsGuardian.md | 45 ++++++++++++------- 1 file changed, 28 insertions(+), 17 deletions(-) diff --git a/docset/winserver2022-ps/hgsclient/Get-HgsGuardian.md b/docset/winserver2022-ps/hgsclient/Get-HgsGuardian.md index 57044caab4..fa06f2f03a 100644 --- a/docset/winserver2022-ps/hgsclient/Get-HgsGuardian.md +++ b/docset/winserver2022-ps/hgsclient/Get-HgsGuardian.md @@ -21,6 +21,7 @@ Get-HgsGuardian [[-Name] ] [-CimSession ] [-ThrottleLimi ``` ## DESCRIPTION + The **Get-HgsGuardian** cmdlet gets Host Guardian Service guardian objects from persistent storage. For a computer configured in **HostGuardianService** mode, this cmdlet returns no result. The **New-HgsKeyProtector** cmdlet requires **HgsGuardian** objects. @@ -28,14 +29,16 @@ The **New-HgsKeyProtector** cmdlet requires **HgsGuardian** objects. ## EXAMPLES ### Example 1: Get all guardians -``` -PS C:\> Get-HgsGuardian + +```powershell +Get-HgsGuardian ``` This command gets all guardians configured for this computer. ### Example 2: Get a guardian by using its name -``` + +```powershell PS C:\> Get-HgsGuardian -Name "Guardian11" ``` @@ -44,20 +47,22 @@ This command gets a guardian named Guardian11. ## PARAMETERS ### -AsJob -Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. -The cmdlet immediately returns an object that represents the job and then displays the command prompt. -You can continue to work in the session while the job completes. -To manage the job, use the `*-Job` cmdlets. -To get the job results, use the [Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. +Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to +complete. -For more information about Windows PowerShell background jobs, see [about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). +The cmdlet immediately returns an object that represents the job and then displays the command +prompt. You can continue to work in the session while the job completes. To manage the job, use the +`*-Job` cmdlets. To get the job results, use the +[Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. +For more information about Windows PowerShell background jobs, see +[about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -67,6 +72,7 @@ Accept wildcard characters: False ``` ### -CimSession + Runs the cmdlet in a remote session or on a remote computer. 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. The default is the current session on the local computer. @@ -84,12 +90,13 @@ Accept wildcard characters: False ``` ### -Name + Specifies an array of names of guardians to get. ```yaml Type: String[] Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: 1 @@ -99,14 +106,17 @@ Accept wildcard characters: False ``` ### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -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. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. + +Specifies the maximum number of concurrent operations that can be established to run the cmdlet. 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. The throttle limit applies only to the current cmdlet, not to the session or to the +computer. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -116,13 +126,15 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS ## OUTPUTS ### CimInstance#MSFT_HgsGuardian + The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. @@ -137,4 +149,3 @@ The path after the pound sign (`#`) provides the namespace and class name for th [New-HgsGuardian](./New-HgsGuardian.md) [Remove-HgsGuardian](./Remove-HgsGuardian.md) - From 5f9fba60214f5cc31ba53b3d12ee4865bbf0d7fb Mon Sep 17 00:00:00 2001 From: Dave Carroll Date: Thu, 27 Apr 2023 15:43:49 -0700 Subject: [PATCH 163/650] pshsummit doc-a-thon --- .../tls/Disable-TlsCipherSuite.md | 33 ++++--- .../tls/Disable-TlsEccCurve.md | 35 +++++--- .../tls/Disable-TlsSessionTicketKey.md | 43 ++++++---- .../tls/Enable-TlsCipherSuite.md | 85 +++++++++++-------- .../tls/Enable-TlsEccCurve.md | 45 +++++++--- .../tls/Enable-TlsSessionTicketKey.md | 69 +++++++++------ .../tls/Export-TlsSessionTicketKey.md | 54 +++++++----- .../tls/Get-TlsCipherSuite.md | 53 +++++++----- .../winserver2022-ps/tls/Get-TlsEccCurve.md | 34 +++++--- .../tls/New-TlsSessionTicketKey.md | 50 ++++++----- docset/winserver2022-ps/tls/TLS.md | 18 +++- 11 files changed, 332 insertions(+), 187 deletions(-) diff --git a/docset/winserver2022-ps/tls/Disable-TlsCipherSuite.md b/docset/winserver2022-ps/tls/Disable-TlsCipherSuite.md index c6c10e50b6..f3237d81ef 100644 --- a/docset/winserver2022-ps/tls/Disable-TlsCipherSuite.md +++ b/docset/winserver2022-ps/tls/Disable-TlsCipherSuite.md @@ -15,21 +15,24 @@ Disables a TLS cipher suite. ## SYNTAX -``` +```powershell Disable-TlsCipherSuite [-Name] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION -The **Disable-TlsCipherSuite** cmdlet disables a cipher suite. -This cmdlet removes the cipher suite from the list of Transport Layer Security (TLS) protocol cipher suites for the computer. -For more information about the TLS cipher suites, see the documentation for the Enable-TlsCipherSuite cmdlet or type `Get-Help Enable-TlsCipherSuite`. +The `Disable-TlsCipherSuite` cmdlet disables a cipher suite. This cmdlet removes the cipher suite +from the list of Transport Layer Security (TLS) protocol cipher suites for the computer. + +For more information about the TLS cipher suites, see the documentation for the +Enable-TlsCipherSuite cmdlet or type `Get-Help Enable-TlsCipherSuite`. ## EXAMPLES ### Example 1: Disable a cipher suite -``` -PS C:\>Disable-TlsCipherSuite -Name "TLS_RSA_WITH_3DES_EDE_CBC_SHA" + +```powershell +Disable-TlsCipherSuite -Name 'TLS_RSA_WITH_3DES_EDE_CBC_SHA' ``` This command disables the cipher suite named TLS_RSA_WITH_3DES_EDE_CBC_SHA. @@ -38,12 +41,13 @@ The command removes the cipher suite from the list of TLS protocol cipher suites ## PARAMETERS ### -Name + Specifies the name of the TLS cipher suite to disable. ```yaml -Type: String +Type: System.String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 1 @@ -53,10 +57,11 @@ Accept wildcard characters: False ``` ### -Confirm + Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf @@ -68,10 +73,11 @@ Accept wildcard characters: False ``` ### -WhatIf + Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi @@ -83,7 +89,11 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, +-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, +-WarningAction, and -WarningVariable. For more information, see about_CommonParameters +(http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -96,4 +106,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Enable-TlsCipherSuite](./Enable-TlsCipherSuite.md) [Get-TlsCipherSuite](./Get-TlsCipherSuite.md) - diff --git a/docset/winserver2022-ps/tls/Disable-TlsEccCurve.md b/docset/winserver2022-ps/tls/Disable-TlsEccCurve.md index 53de56b95c..4bdcb38f43 100644 --- a/docset/winserver2022-ps/tls/Disable-TlsEccCurve.md +++ b/docset/winserver2022-ps/tls/Disable-TlsEccCurve.md @@ -11,35 +11,40 @@ title: Disable-TlsEccCurve # Disable-TlsEccCurve ## SYNOPSIS -Disables the Elliptic Curve Cryptography (ECC) cipher suites available for TLS(Transport Layer Security) for a computer. +Disables the Elliptic Curve Cryptography (ECC) cipher suites available for TLS(Transport Layer +Security) for a computer. ## SYNTAX -``` +```powershell Disable-TlsEccCurve [-Name] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION -This Command disables the Elliptic Curve Cryptography (ECC) cipher suites available for TLS(Transport Layer Security) for a computer. + +This Command disables the Elliptic Curve Cryptography (ECC) cipher suites available for +TLS(Transport Layer Security) for a computer. ## EXAMPLES ### Example 1 -``` -PS C:\> Disable-TlsEccCurve -Name curve25519 + +```powershell +Disable-TlsEccCurve -Name curve25519 ``` -This will disable the ECC Curve "curve25519". +This will disable the ECC Curve 'curve25519'. ## PARAMETERS ### -Name + Specifies the name of the ECC curve to disable. ```yaml -Type: String +Type: System.String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 0 @@ -49,10 +54,11 @@ Accept wildcard characters: False ``` ### -Confirm + Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf @@ -64,11 +70,12 @@ Accept wildcard characters: False ``` ### -WhatIf + Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi @@ -80,13 +87,16 @@ Accept wildcard characters: False ``` ### CommonParameters -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). + +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). ## INPUTS ### System.String - ## OUTPUTS ### System.Object @@ -94,4 +104,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS - diff --git a/docset/winserver2022-ps/tls/Disable-TlsSessionTicketKey.md b/docset/winserver2022-ps/tls/Disable-TlsSessionTicketKey.md index 787c866fae..4484be28be 100644 --- a/docset/winserver2022-ps/tls/Disable-TlsSessionTicketKey.md +++ b/docset/winserver2022-ps/tls/Disable-TlsSessionTicketKey.md @@ -15,26 +15,31 @@ Disables a TLS session ticket key. ## SYNTAX -``` +```powershell Disable-TlsSessionTicketKey [-ServiceAccountName] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION -The **Disable-TlsSessionTicketKey** cmdlet disables an administrator managed Transport Layer Security (TLS) session ticket key for the service account. -The cmdlet disables the key for the TLS session by deleting the key and the corresponding rule that uses the key. -When you disable a TLS session ticket key for the service account, the service account cannot decrypt existing TLS session tickets. -Disabling the TLS session ticket key can affect the performance of the TLS server. -The TLS server cannot create new session tickets and must negotiate session information between the client and the server every time the client connects to the TLS server. +The `Disable-TlsSessionTicketKey` cmdlet disables an administrator managed Transport Layer +Security (TLS) session ticket key for the service account. The cmdlet disables the key for the TLS +session by deleting the key and the corresponding rule that uses the key. + +When you disable a TLS session ticket key for the service account, the service account cannot +decrypt existing TLS session tickets. Disabling the TLS session ticket key can affect the +performance of the TLS server. The TLS server cannot create new session tickets and must negotiate +session information between the client and the server every time the client connects to the TLS +server. TLS creates a session ticket by using the TLS Session Resumption without Server-Side State mechanism. -For more information, see New-TlsSessionTicketKey or type `Get-Help New-TlsSessionTicketKey`. +For more information, see `New-TlsSessionTicketKey` or type `Get-Help New-TlsSessionTicketKey`. ## EXAMPLES -### Example 1: Disable a TLS session ticket key. -``` -PS C:\> Disable-TlsSessionTicketKey -ServiceAccountName "NetworkService" +### Example 1: Disable a TLS session ticket key + +```powershell +Disable-TlsSessionTicketKey -ServiceAccountName NetworkService ``` This command disables the TLS session ticket key for the service account named NetworkService. @@ -42,14 +47,15 @@ This command disables the TLS session ticket key for the service account named N ## PARAMETERS ### -ServiceAccountName + Specifies the name of a service account. The cmdlet disables the TLS session ticket key for the service account. Only System, LocalService, NetworkService, and SID of virtual accounts are supported. ```yaml -Type: NTAccount +Type: System.Security.Principal.NTAccount Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 1 @@ -59,10 +65,11 @@ Accept wildcard characters: False ``` ### -Confirm + Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf @@ -74,11 +81,12 @@ Accept wildcard characters: False ``` ### -WhatIf + Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi @@ -90,7 +98,11 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, +-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, +-WarningAction, and -WarningVariable. For more information, see about_CommonParameters +(http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -105,4 +117,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [New-TlsSessionTicketKey](./New-TlsSessionTicketKey.md) [Export-TlsSessionTicketKey](./Export-TlsSessionTicketKey.md) - diff --git a/docset/winserver2022-ps/tls/Enable-TlsCipherSuite.md b/docset/winserver2022-ps/tls/Enable-TlsCipherSuite.md index 2ca91dcda9..4bb14b43a4 100644 --- a/docset/winserver2022-ps/tls/Enable-TlsCipherSuite.md +++ b/docset/winserver2022-ps/tls/Enable-TlsCipherSuite.md @@ -15,61 +15,70 @@ Enables a TLS cipher suite. ## SYNTAX -``` +```powershell Enable-TlsCipherSuite [[-Position] ] [-Name] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION -The **Enable-TlsCipherSuite** cmdlet enables a cipher suite. -This cmdlet adds the cipher suite to the list of Transport Layer Security (TLS) protocol cipher suites for the computer. -If you do not specify a position in the list, this cmdlet adds it at the lowest position. No restart is required for changes to take effect. -If a cipher suite is not enabled for TLS based secure channel (Schannel) registry settings, then the cipher suite is not used. +The `Enable-TlsCipherSuite` cmdlet enables a cipher suite. This cmdlet adds the cipher suite to the +list of Transport Layer Security (TLS) protocol cipher suites for the computer. If you do not +specify a position in the list, this cmdlet adds it at the lowest position. No restart is required +for changes to take effect. + +If a cipher suite is not enabled for TLS based secure channel (Schannel) registry settings, then the +cipher suite is not used. -This cmdlet is based on Cryptography Next Generation (CNG) Cryptographic Configuration. -Schannel registry settings and settings specified by means of Security Support Provider Interface (SSPI) by each app can override CNG Cryptographic Configuration. -Other settings under HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\SecurityProviders\SCHANNEL can also configure cipher suites. -These settings can impact whether a cipher suite can be used. -For example, disabling of SHA hashes supported by TLS disables the corresponding cipher suites. -Additionally, applications can limit the algorithms using SSPI. -For more information about TLS settings, see [How to restrict the use of certain cryptographic algorithms and protocols in Schannel.dll](https://support.microsoft.com/kb/245030). +This cmdlet is based on Cryptography Next Generation (CNG) Cryptographic Configuration. Schannel +registry settings and settings specified by means of Security Support Provider Interface (SSPI) by +each app can override CNG Cryptographic Configuration. Other settings under +HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\SecurityProviders\SCHANNEL can also configure +cipher suites. These settings can impact whether a cipher suite can be used. For example, disabling +of SHA hashes supported by TLS disables the corresponding cipher suites. Additionally, applications +can limit the algorithms using SSPI. For more information about TLS settings, see +[How to restrict the use of certain cryptographic algorithms and protocols in Schannel.dll](https://support.microsoft.com/kb/245030). ## EXAMPLES ### Example 1: Enable a cipher suite -``` -PS C:\>Enable-TlsCipherSuite -Name "TLS_DHE_DSS_WITH_AES_256_CBC_SHA" + +```powershell +Enable-TlsCipherSuite -Name TLS_DHE_DSS_WITH_AES_256_CBC_SHA ``` This command enables cipher suite named TLS_DHE_DSS_WITH_AES_256_CBC_SHA. This command adds the cipher suite the TLS cipher suite list as the lowest priority. ### Example 2: Enable a cipher suite as the lowest priority -``` -PS C:\>Enable-TlsCipherSuite -Name "TLS_DHE_DSS_WITH_AES_256_CBC_SHA" -Position 4294967295 + +```powershell +Enable-TlsCipherSuite -Name TLS_DHE_DSS_WITH_AES_256_CBC_SHA -Position 4294967295 ``` -This command enables cipher suite named TLS_DHE_DSS_WITH_AES_256_CBC_SHA. -This command adds the cipher suite the TLS cipher suite list as the lowest priority. -Unlike the first example, this command explicitly specifies position number 4294967295, which is the value of CRYPT_PRIORITY_BOTTOM. +This command enables cipher suite named TLS_DHE_DSS_WITH_AES_256_CBC_SHA. This command adds the +cipher suite the TLS cipher suite list as the lowest priority. Unlike the first example, this +command explicitly specifies position number 4294967295, which is the value of +CRYPT_PRIORITY_BOTTOM. ### Example 3: Enable a cipher suite as the highest priority -``` -PS C:\>Enable-TlsCipherSuite -Name "TLS_DHE_DSS_WITH_AES_256_CBC_SHA" -Position 0 + +```powershell +Enable-TlsCipherSuite -Name TLS_DHE_DSS_WITH_AES_256_CBC_SHA -Position 0 ``` -This command enables cipher suite named TLS_DHE_DSS_WITH_AES_256_CBC_SHA. -This command adds the cipher suite the TLS cipher suite list at position 0, which is the highest priority. +This command enables cipher suite named TLS_DHE_DSS_WITH_AES_256_CBC_SHA. This command adds the +cipher suite the TLS cipher suite list at position 0, which is the highest priority. ## PARAMETERS ### -Name + Specifies the name of the TLS cipher suite to enable. ```yaml -Type: String +Type: System.String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 1 @@ -79,16 +88,19 @@ Accept wildcard characters: False ``` ### -Position + Specifies the position at which to insert the cipher suite in the ordered list of TLS cipher suites. -The cmdlet inserts the cipher suite at the position that this parameter specifies, ahead of any existing cipher suites. +The cmdlet inserts the cipher suite at the position that this parameter specifies, ahead of any +existing cipher suites. -Specify a value of 0 or CRYPT_PRIORITY_TOP to insert the function at the top of the list. -Specify a value of 4294967295 or 0xFFFFFFFF or CRYPT_PRIORITY_BOTTOM to insert the function at the end of the list. +Specify a value of 0 or CRYPT_PRIORITY_TOP to insert the function at the top of the list. Specify a +value of 4294967295 or 0xFFFFFFFF or CRYPT_PRIORITY_BOTTOM to insert the function at the end of the +list. ```yaml -Type: UInt32 +Type: System.UInt32 Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: 2 @@ -98,10 +110,11 @@ Accept wildcard characters: False ``` ### -Confirm + Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf @@ -113,10 +126,11 @@ Accept wildcard characters: False ``` ### -WhatIf + Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi @@ -128,7 +142,11 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, +-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, +-WarningAction, and -WarningVariable. For more information, see about_CommonParameters +(http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -141,4 +159,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Disable-TlsCipherSuite](./Disable-TlsCipherSuite.md) [Get-TlsCipherSuite](./Get-TlsCipherSuite.md) - diff --git a/docset/winserver2022-ps/tls/Enable-TlsEccCurve.md b/docset/winserver2022-ps/tls/Enable-TlsEccCurve.md index 8a938b9d85..6bcc2e8b46 100644 --- a/docset/winserver2022-ps/tls/Enable-TlsEccCurve.md +++ b/docset/winserver2022-ps/tls/Enable-TlsEccCurve.md @@ -15,31 +15,35 @@ Enables Elliptic Curve Cryptography (ECC) cipher suites available for TLS. ## SYNTAX -``` +```powershell Enable-TlsEccCurve [[-Position] ] [-Name] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION + Enables Elliptic Curve Cryptography (ECC) cipher suites available for TLS for a computer. ## EXAMPLES ### Example 1 -``` -PS C:\> Enable-TlsEccCurve "NistP384" -Position 0 + +```powershell +Enable-TlsEccCurve 'NistP384' -Position 0 ``` -This command enables Elliptic Curve Cryptography cipher suite named "NistP384" at position 0, which is the highest priority. +This command enables Elliptic Curve Cryptography cipher suite named 'NistP384' at position 0, which +is the highest priority. ## PARAMETERS ### -Name + Specifies the name of the ECC cipher suite to enable. ```yaml -Type: String +Type: System.String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 0 @@ -49,14 +53,19 @@ Accept wildcard characters: False ``` ### -Position -Specifies the position at which to insert the cipher suite in the ordered list of ECC cipher suites. The cmdlet inserts the cipher suite at the position that this parameter specifies, ahead of any existing cipher suites. -Specify a value of 0 or CRYPT_PRIORITY_TOP to insert the function at the top of the list. Specify a value of 4294967295 or 0xFFFFFFFF or CRYPT_PRIORITY_BOTTOM to insert the function at the end of the list. +Specifies the position at which to insert the cipher suite in the ordered list of ECC cipher suites. +The cmdlet inserts the cipher suite at the position that this parameter specifies, ahead of any +existing cipher suites. + +Specify a value of 0 or CRYPT_PRIORITY_TOP to insert the function at the top of the list. Specify a +value of 4294967295 or 0xFFFFFFFF or CRYPT_PRIORITY_BOTTOM to insert the function at the end of the +list. ```yaml -Type: UInt32 +Type: System.UInt32 Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: 1 @@ -66,10 +75,11 @@ Accept wildcard characters: False ``` ### -Confirm + Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf @@ -81,11 +91,12 @@ Accept wildcard characters: False ``` ### -WhatIf + Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi @@ -97,13 +108,16 @@ Accept wildcard characters: False ``` ### CommonParameters -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). + +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). ## INPUTS ### System.String - ## OUTPUTS ### System.Object @@ -112,3 +126,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS +[Get-TlsEccCurve](./Get-TlsEccCurv.md) + +[Disable-TlsEccCurve](./Disable-TlsEccCurve.md) diff --git a/docset/winserver2022-ps/tls/Enable-TlsSessionTicketKey.md b/docset/winserver2022-ps/tls/Enable-TlsSessionTicketKey.md index c245c41048..fb8848b513 100644 --- a/docset/winserver2022-ps/tls/Enable-TlsSessionTicketKey.md +++ b/docset/winserver2022-ps/tls/Enable-TlsSessionTicketKey.md @@ -15,14 +15,17 @@ Configures a TLS server with a TLS session ticket key. ## SYNTAX -``` +```powershell Enable-TlsSessionTicketKey [-ServiceAccountName] [-Path] [-Password] [-Force] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION -The **Enable-TlsSessionTicketKey** cmdlet configures a Transport Layer Security (TLS) server with an administrator-managed TLS session ticket key, created with New-TlsSessionTicketKey, and configures the rule that uses the key for the application service account. -For example, Internet Information Services (IIS) runs under System account so the **ServiceAccountName** parameter should be System. + +The `Enable-TlsSessionTicketKey` cmdlet configures a Transport Layer Security (TLS) server with an +administrator-managed TLS session ticket key, created with New-TlsSessionTicketKey, and configures +the rule that uses the key for the application service account. For example, Internet Information +Services (IIS) runs under System account so the __ServiceAccountName_ parameter should be System. TLS creates a session ticket by using the TLS Session Resumption without Server-Side State mechanism. For more information, see New-TlsSessionTicketKey or type `Get-Help New-TlsSessionTicketKey`. @@ -30,34 +33,42 @@ For more information, see New-TlsSessionTicketKey or type `Get-Help New-TlsSessi ## EXAMPLES ### Example 1: Configure a TLS server with a TLS session ticket key for the NetworkService account -``` -PS C:\>$Password = Read-Host -AsSecureString -PS C:\> Enable-TlsSessionTicketKey -Password $Password -Path "C:\KeyConfig\TlsSessionTicketKey.config" -ServiceAccountName "NetworkService" + +```powershell +$Password = Read-Host -AsSecureString +Enable-TlsSessionTicketKey -Password $Password -Path 'C:\KeyConfig\TlsSessionTicketKey.config' -ServiceAccountName NetworkService ``` -The second command configures the session ticket key for the TLS server. -The command specifies the path for the configuration file on the TLS server, and specifies that the TLS session use the password stored in **$Password** to access the configuration file and configure the key for the specified service account. +The second command configures the session ticket key for the TLS server. The command specifies the +path for the configuration file on the TLS server, and specifies that the TLS session use the +password stored in `$Password` to access the configuration file and configure the key for the +specified service account. ### Example 2: Configure a TLS server with a TLS session ticket key for System account -``` -PS C:\>$Password = Read-Host -AsSecureString -PS C:\> Enable-TlsSessionTicketKey -Password $Password -Path "C:\KeyConfig\TlsSessionTicketKey.config" -ServiceAccountName "System" + +```powershell +$Password = Read-Host -AsSecureString +Enable-TlsSessionTicketKey -Password $Password -Path 'C:\KeyConfig\TlsSessionTicketKey.config' -ServiceAccountName System ``` -The second command configures the session ticket key for the TLS server. -The command specifies the path for the configuration file on the TLS server, and specifies that the TLS session use the password stored in **$Password** to access the configuration file and configure the key for the specified service account. +The second command configures the session ticket key for the TLS server. The command specifies the +path for the configuration file on the TLS server, and specifies that the TLS session use the +password stored in `$Password` to access the configuration file and configure the key for the +specified service account. ## PARAMETERS ### -Force + Forces the command to run without asking for user confirmation. -If you specify this parameter, the cmdlet overwrites the existing session ticket key and configuration. +If you specify this parameter, the cmdlet overwrites the existing session ticket key and +configuration. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -67,12 +78,13 @@ Accept wildcard characters: False ``` ### -Password + Specifies the password, as a secure string, for the configuration file of the TLS server. ```yaml -Type: SecureString +Type: System.Security.SecureString Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 1 @@ -82,10 +94,11 @@ Accept wildcard characters: False ``` ### -Path + Specifies the path of the configuration file for the TLS server. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: FullName @@ -97,14 +110,15 @@ Accept wildcard characters: False ``` ### -ServiceAccountName + Specifies the name of a service account. The cmdlet configures the TLS session ticket key for the service account. Only System, LocalService, NetworkService, and SID of virtual accounts are supported. ```yaml -Type: NTAccount +Type: System.Security.Principal.NTAccount Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 3 @@ -114,10 +128,11 @@ Accept wildcard characters: False ``` ### -Confirm + Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf @@ -129,11 +144,12 @@ Accept wildcard characters: False ``` ### -WhatIf + Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi @@ -145,7 +161,11 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, +-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, +-WarningAction, and -WarningVariable. For more information, see about_CommonParameters +(http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -160,4 +180,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Export-TlsSessionTicketKey](./Export-TlsSessionTicketKey.md) [Disable-TlsSessionTicketKey](./Disable-TlsSessionTicketKey.md) - diff --git a/docset/winserver2022-ps/tls/Export-TlsSessionTicketKey.md b/docset/winserver2022-ps/tls/Export-TlsSessionTicketKey.md index 6cd6a6a65f..7bc764ee8c 100644 --- a/docset/winserver2022-ps/tls/Export-TlsSessionTicketKey.md +++ b/docset/winserver2022-ps/tls/Export-TlsSessionTicketKey.md @@ -15,42 +15,49 @@ Exports a TLS session ticket key. ## SYNTAX -``` +```powershell Export-TlsSessionTicketKey [-ServiceAccountName] [[-Path] ] [-Password] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION -The **Export-TlsSessionTicketKey** cmdlet exports the administrator managed Transport Layer Security (TLS) session ticket key for a service account. -TLS creates a session ticket by using the TLS Session Resumption without Server-Side State mechanism. -For more information, see New-TlsSessionTicketKey or type `Get-Help New-TlsSessionTicketKey`. +The `Export-TlsSessionTicketKey` cmdlet exports the administrator managed Transport Layer Security +(TLS) session ticket key for a service account. + +TLS creates a session ticket by using the TLS Session Resumption without Server-Side State +mechanism. For more information, see New-TlsSessionTicketKey or type +`Get-Help New-TlsSessionTicketKey`. ## EXAMPLES ### Example 1: Export a TLS session ticket key -``` -PS C:\>$Password = Read-Host -AsSecureString -PS C:\> Export-TlsSessionTicketKey -Password $Password -Path "C:\KeyConfig\TlsSessionTicketKey.config" -ServiceAccountName "NetworkService" + +```powershell +$Password = Read-Host -AsSecureString +Export-TlsSessionTicketKey -Password $Password -Path 'C:\KeyConfig\TlsSessionTicketKey.config' -ServiceAccountName NetworkService ``` -The first command prompts the user to enter a password by using the **Read-Host** cmdlet. +The first command prompts the user to enter a password by using the `Read-Host` cmdlet. The command masks the password that the user types at the prompt. For more information, type `Get-Help Read-Host`. -The command stores the password in the **$Password** variable. +The command stores the password in the `$Password` variable. -The second command exports the session ticket key for the service account named NetworkService from the configuration file on the TLS server. -The command specifies the path for the configuration file on the TLS server, and specifies that the TLS session use the password stored in **$Password** to access the configuration file. +The second command exports the session ticket key for the service account named NetworkService from +the configuration file on the TLS server. The command specifies the path for the configuration file +on the TLS server, and specifies that the TLS session use the password stored in `$Password` to +access the configuration file. ## PARAMETERS ### -Password + Specifies the password, as a secure string, for the key. ```yaml -Type: SecureString +Type: System.Security.SecureString Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 1 @@ -60,10 +67,11 @@ Accept wildcard characters: False ``` ### -Path + Specifies the path of the configuration file for the TLS server. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: FullName @@ -75,14 +83,15 @@ Accept wildcard characters: False ``` ### -ServiceAccountName + Specifies the name of a service account. The cmdlet exports the configuration of the TLS session ticket key for the service account. Only System, LocalService, NetworkService, and SID of virtual accounts are supported. ```yaml -Type: NTAccount +Type: System.Security.Principal.NTAccount Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 3 @@ -92,10 +101,11 @@ Accept wildcard characters: False ``` ### -Confirm + Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf @@ -107,11 +117,12 @@ Accept wildcard characters: False ``` ### -WhatIf + Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi @@ -123,7 +134,11 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, +-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, +-WarningAction, and -WarningVariable. For more information, see about_CommonParameters +(http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -138,4 +153,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [New-TlsSessionTicketKey](./New-TlsSessionTicketKey.md) [Disable-TlsSessionTicketKey](./Disable-TlsSessionTicketKey.md) - diff --git a/docset/winserver2022-ps/tls/Get-TlsCipherSuite.md b/docset/winserver2022-ps/tls/Get-TlsCipherSuite.md index 730e1f0a3c..fe10b9b74d 100644 --- a/docset/winserver2022-ps/tls/Get-TlsCipherSuite.md +++ b/docset/winserver2022-ps/tls/Get-TlsCipherSuite.md @@ -15,29 +15,36 @@ Gets the TLS cipher suites for a computer. ## SYNTAX -``` +```powershell Get-TlsCipherSuite [[-Name] ] [] ``` ## DESCRIPTION -The **Get-TlsCipherSuite** cmdlet gets an ordered collection of cipher suites for a computer that Transport Layer Security (TLS) can use. -For more information about the TLS cipher suites, see the documentation for the Enable-TlsCipherSuite cmdlet or type `Get-Help Enable-TlsCipherSuite`. +The `Get-TlsCipherSuite` cmdlet gets an ordered collection of cipher suites for a computer that +Transport Layer Security (TLS) can use. + +For more information about the TLS cipher suites, see the documentation for the +`Enable-TlsCipherSuite` cmdlet or type `Get-Help Enable-TlsCipherSuite`. For more information about protocol versions , see [BCRYPT_KDF_TLS_PRF (L"TLS_PRF")](/windows/desktop/api/bcrypt/nf-bcrypt-bcryptderivekey#bcrypt_kdf_tls_prf-ltls_prf). ## EXAMPLES ### Example 1: Get all cipher suites + +```powershell +Get-TlsCipherSuite ``` -PS C:\>Get-TlsCipherSuite + +```output KeyType : 0 Certificate : RSA MaximumExchangeLength : 65536 MinimumExchangeLength : 0 Exchange : ECDH HashLength : 0 -Hash : +Hash : CipherBlockLength : 16 CipherLength : 256 BaseCipherSuite : 49200 @@ -46,14 +53,13 @@ Cipher : AES Name : TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 Protocols : {771} - KeyType : 0 Certificate : RSA MaximumExchangeLength : 65536 MinimumExchangeLength : 0 Exchange : ECDH HashLength : 0 -Hash : +Hash : CipherBlockLength : 16 CipherLength : 128 BaseCipherSuite : 49199 @@ -66,8 +72,12 @@ Protocols : {771} This command gets all TLS cipher suites for the computer. ### Example 2: Get the cipher suites that match a string + +```powershell +Get-TlsCipherSuite -Name AES ``` -PS C:\>Get-TlsCipherSuite -Name "AES" + +```output KeyType : 0 Certificate : ECDSA MaximumExchangeLength : 65536 @@ -99,23 +109,24 @@ Name : TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 Protocols : {771, 65277} ``` -This command gets all the cipher suites that have names that contain the string `AES`. -Note that the name match is case sensitive and this command returns no output for the name `aes`. -The output includes a field for the TLS/SSL protocols supported by the cipher. -See [Cipher Suites in TLS/SSL (Schannel SSP)](/windows/desktop/secauthn/cipher-suites-in-schannel) for more information. - +This command gets all the cipher suites that have names that contain the string `AES`. Note that the +name match is case sensitive and this command returns no output for the name `aes`. The output +includes a field for the TLS/SSL protocols supported by the cipher. See +[Cipher Suites in TLS/SSL (Schannel SSP)](/windows/desktop/secauthn/cipher-suites-in-schannel) for +more information. ## PARAMETERS ### -Name -Specifies the name of the TLS cipher suite to get. -The cmdlet gets cipher suites that match the string that this cmdlet specifies, so you can specify a partial name. -The name match is case sensitive. + +Specifies the name of the TLS cipher suite to get. The cmdlet gets cipher suites that match the +string that this cmdlet specifies, so you can specify a partial name. The name match is case +sensitive. ```yaml -Type: String +Type: System.String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: 1 @@ -125,7 +136,11 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, +-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, +-WarningAction, and -WarningVariable. For more information, see about_CommonParameters +(http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/docset/winserver2022-ps/tls/Get-TlsEccCurve.md b/docset/winserver2022-ps/tls/Get-TlsEccCurve.md index f8cd2ffdeb..f1107762d9 100644 --- a/docset/winserver2022-ps/tls/Get-TlsEccCurve.md +++ b/docset/winserver2022-ps/tls/Get-TlsEccCurve.md @@ -14,51 +14,57 @@ Gets the list of Elliptic Curve Cryptography (ECC) cipher suites available for T ## SYNTAX -``` +```powershell Get-TlsEccCurve [[-Name] ] [] ``` ## DESCRIPTION + Gets the list of Elliptic Curve Cryptography (ECC) cipher suites available for TLS for a computer. ## EXAMPLES ### Example 1: Get all ECC curves + ```powershell Get-TlsEccCurve ``` This generates the following output: - +```output curve25519 NistP256 NistP384 - +``` This command gets all ECC curves for the computer. ### Example 2: Get the ECC curves that match a string + ```powershell Get-TlsEccCurve -Name 'Nist' ``` This generates the following output: - +```output NistP256 NistP384 +``` - -This command gets all the ECC curves that have names that contain the string 'Nist' (case-sensitive). +This command gets all the ECC curves that have names that contain the string 'Nist' +(case-sensitive). ## PARAMETERS ### -Name -Specifies the name of the ECC curve to get. The cmdlet gets ECC curves that match the string that this cmdlet specifies, so you can specify a partial name. This parameter is case-sensitive. + +Specifies the name of the ECC curve to get. The cmdlet gets ECC curves that match the string that +this cmdlet specifies, so you can specify a partial name. This parameter is case-sensitive. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: None @@ -70,13 +76,16 @@ Accept wildcard characters: False ``` ### CommonParameters -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). + +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). ## INPUTS ### System.String - ## OUTPUTS ### System.Object @@ -84,6 +93,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -[Enable-TlsEccCurve]() -[Disable-TlsEccCurve]() +[Enable-TlsEccCurve](./Enable-TlsEccCurv.md) + +[Disable-TlsEccCurve](./Disable-TlsEccCurve.md) diff --git a/docset/winserver2022-ps/tls/New-TlsSessionTicketKey.md b/docset/winserver2022-ps/tls/New-TlsSessionTicketKey.md index d24d957a2a..c1c609a4b6 100644 --- a/docset/winserver2022-ps/tls/New-TlsSessionTicketKey.md +++ b/docset/winserver2022-ps/tls/New-TlsSessionTicketKey.md @@ -15,45 +15,51 @@ Creates a TLS session ticket key configuration file. ## SYNTAX -``` +```powershell New-TlsSessionTicketKey [[-Path] ] [-Password] [] ``` ## DESCRIPTION -The **New-TlsSessionTicketKey** cmdlet creates a password protected Transport Layer Security (TLS) Session Ticket key configuration file. -TLS creates a session ticket by using the TLS Session Resumption without Server-Side State mechanism. -This mechanism helps to improve the performance of TLS. -The TLS server uses this mechanism to create a key to encrypt a session ticket. -The client can later use the encrypted session ticket to resume communication with the TLS server. -Otherwise, the client must restart the communication by acquiring of new session ticket. -For more information, see [RFC 5077, Transport Layer Security (TLS) Session Resumption without Server-Side State](http://rfc5077.openrfc.org/). +The `New-TlsSessionTicketKey` cmdlet creates a password protected Transport Layer Security (TLS) +Session Ticket key configuration file. + +TLS creates a session ticket by using the TLS Session Resumption without Server-Side State +mechanism. This mechanism helps to improve the performance of TLS. The TLS server uses this +mechanism to create a key to encrypt a session ticket. The client can later use the encrypted +session ticket to resume communication with the TLS server. Otherwise, the client must restart the +communication by acquiring of new session ticket. For more information, see +[RFC 5077, Transport Layer Security (TLS) Session Resumption without Server-Side State](http://rfc5077.openrfc.org/). ## EXAMPLES ### Example 1: Create a TLS session ticket key -``` -PS C:\> $Password = Read-Host -AsSecureString -PS C:\> New-TlsSessionTicketKey -Password $Password -Path "C:\KeyConfig\TlsSessionTicketKey.config" + +```powershell +$Password = Read-Host -AsSecureString +New-TlsSessionTicketKey -Password $Password -Path 'C:\KeyConfig\TlsSessionTicketKey.config' ``` -The first command prompts the user to enter a password by using the **Read-Host** cmdlet. +The first command prompts the user to enter a password by using the `Read-Host` cmdlet. The command masks the password that the user types at the prompt. For more information, type `Get-Help Read-Host`. -The command stores the password in the **$Password** variable. +The command stores the password in the `$Password` variable. -The second command creates the session ticket key configuration file which can be used to enable the TLS session ticket for a service account. -The command specifies the path for the output configuration file on the TLS server, and specifies that the TLS session use the password stored in **$Password** to access the configuration file. +The second command creates the session ticket key configuration file which can be used to enable the +TLS session ticket for a service account. The command specifies the path for the output +configuration file on the TLS server, and specifies that the TLS session use the password stored in +`$Password` to access the configuration file. ## PARAMETERS ### -Password + Specifies the password, as a secure string, for the configuration file of the TLS server. ```yaml -Type: SecureString +Type: System.Security.SecureString Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 1 @@ -63,11 +69,12 @@ Accept wildcard characters: False ``` ### -Path + Specifies the path of the configuration file for the TLS server. The cmdlet outputs the generated configuration file to this path. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: FullName @@ -79,7 +86,11 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, +-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, +-WarningAction, and -WarningVariable. For more information, see about_CommonParameters +(http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -94,4 +105,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Export-TlsSessionTicketKey](./Export-TlsSessionTicketKey.md) [Disable-TlsSessionTicketKey](./Disable-TlsSessionTicketKey.md) - diff --git a/docset/winserver2022-ps/tls/TLS.md b/docset/winserver2022-ps/tls/TLS.md index 22db00bac3..48a9178549 100644 --- a/docset/winserver2022-ps/tls/TLS.md +++ b/docset/winserver2022-ps/tls/TLS.md @@ -8,37 +8,51 @@ title: TLS --- # TLS Module + ## Description -This reference provides cmdlet descriptions and syntax for all Transport Layer Security (TLS) cmdlets. It lists the cmdlets in alphabetical order based on the verb at the beginning of the cmdlet. + +This reference provides cmdlet descriptions and syntax for all Transport Layer Security (TLS) +cmdlets. It lists the cmdlets in alphabetical order based on the verb at the beginning of the +cmdlet. ## TLS Cmdlets + ### [Disable-TlsCipherSuite](Disable-TlsCipherSuite.md) + Disables a TLS cipher suite. ### [Disable-TlsEccCurve](Disable-TlsEccCurve.md) + Disables TLS Ecc Curve. ### [Disable-TlsSessionTicketKey](Disable-TlsSessionTicketKey.md) + Disables a TLS session ticket key. ### [Enable-TlsEccCurve](Enable-TlsEccCurve.md) + Enables TLS Ecc Curve. ### [Enable-TlsCipherSuite](Enable-TlsCipherSuite.md) + Enables a TLS cipher suite. ### [Enable-TlsSessionTicketKey](Enable-TlsSessionTicketKey.md) + Configures a TLS server with a TLS session ticket key. ### [Export-TlsSessionTicketKey](Export-TlsSessionTicketKey.md) + Exports a TLS session ticket key. ### [Get-TlsCipherSuite](Get-TlsCipherSuite.md) + Gets the list of cipher suites for TLS for a computer. ### [Get-TlsEccCurve](Get-TlsEccCurve.md) + Gets the status TLS Ecc Curve. ### [New-TlsSessionTicketKey](New-TlsSessionTicketKey.md) -Creates a TLS session ticket key configuration file. +Creates a TLS session ticket key configuration file. From 4564613e064cf3ba929e5c54a19009a96a7d0447 Mon Sep 17 00:00:00 2001 From: Robert Biddle Date: Thu, 27 Apr 2023 18:46:27 -0400 Subject: [PATCH 164/650] Undoing line continuation from previous commit --- .../winserver2022-ps/addsdeployment/Install-ADDSDomain.md | 7 +------ 1 file changed, 1 insertion(+), 6 deletions(-) diff --git a/docset/winserver2022-ps/addsdeployment/Install-ADDSDomain.md b/docset/winserver2022-ps/addsdeployment/Install-ADDSDomain.md index e3552bfc8a..0c893d1361 100644 --- a/docset/winserver2022-ps/addsdeployment/Install-ADDSDomain.md +++ b/docset/winserver2022-ps/addsdeployment/Install-ADDSDomain.md @@ -36,12 +36,7 @@ The `Install-ADDSDomain` cmdlet installs an Active Directory domain configuratio ### Example 1: Install a new child domain ``` -Install-ADDSDomain -Credential (Get-Credential CORP\EnterpriseAdmin1) ` --NewDomainName child -ParentDomainName "corp.contoso.com" -InstallDNS ` --CreateDNSDelegation -DomainMode Win2003 ` --ReplicationSourceDC "DC1.corp.contoso.com" -SiteName "Houston" ` --DatabasePath "D:\NTDS" -SYSVOLPath "D:\SYSVOL" -LogPath "E:\Logs" ` --NoRebootOnCompletion +Install-ADDSDomain -Credential (Get-Credential CORP\EnterpriseAdmin1) -NewDomainName child -ParentDomainName "corp.contoso.com" -InstallDNS -CreateDNSDelegation -DomainMode Win2003 -ReplicationSourceDC "DC1.corp.contoso.com" -SiteName "Houston" -DatabasePath "D:\NTDS" -SYSVOLPath "D:\SYSVOL" -LogPath "E:\Logs" -NoRebootOnCompletion ``` This command installs a new child domain named child.corp.contoso.com using credentials of From 40b308bff40b7d375fdcdb7c4b66df522c157d59 Mon Sep 17 00:00:00 2001 From: Michael Svegmar Date: Fri, 28 Apr 2023 00:48:56 +0200 Subject: [PATCH 165/650] Formatted Get-NetVirtualizationProviderAddress --- .../Get-NetVirtualizationProviderAddress.md | 103 +++++++++++------- 1 file changed, 64 insertions(+), 39 deletions(-) diff --git a/docset/winserver2022-ps/netwnv/Get-NetVirtualizationProviderAddress.md b/docset/winserver2022-ps/netwnv/Get-NetVirtualizationProviderAddress.md index ae359a03ee..ad2dc6a7e0 100644 --- a/docset/winserver2022-ps/netwnv/Get-NetVirtualizationProviderAddress.md +++ b/docset/winserver2022-ps/netwnv/Get-NetVirtualizationProviderAddress.md @@ -23,25 +23,32 @@ Get-NetVirtualizationProviderAddress [-ProviderAddress ] [-InterfaceIn ``` ## DESCRIPTION -The **Get-NetVirtualizationProviderAddress** cmdlet gets Provider Addresses configured in Microsoft® Hyper-V® Server 2016 Network Virtualization. -A Provider Address is an IPv4 or IPv6 address that Network Virtualization uses for multiple virtual Customer Addresses. -For more information, see [Network Virtualization technical details](https://technet.microsoft.com/library/jj134174.aspx) on TechNet. -You can specify which Provider Addresses to get by using address state, interface index, prefix length, IP address, or VLAN ID. -You can use this cmdlet to get Provider Addresses for other cmdlets, such as the Set-NetVirtualizationProviderAddress cmdlet or the Remove-NetVirtualizationProviderAddress cmdlet. +The `Get-NetVirtualizationProviderAddress` cmdlet gets Provider Addresses configured in Microsoft® +Hyper-V® Server 2016 Network Virtualization. A Provider Address is an IPv4 or IPv6 address that +Network Virtualization uses for multiple virtual Customer Addresses. For more information, see +[Network Virtualization technical details](https://technet.microsoft.com/library/jj134174.aspx) on +TechNet. + +You can specify which Provider Addresses to get by using address state, interface index, prefix +length, IP address, or VLAN ID. You can use this cmdlet to get Provider Addresses for other cmdlets, +such as the `Set-NetVirtualizationProviderAddress` cmdlet or the +`Remove-NetVirtualizationProviderAddress` cmdlet. ## EXAMPLES ### Example 1: Get Provider Addresses for an interface -``` -PS C:\> Get-NetVirtualizationProviderAddress -InterfaceIndex 13 + +```powershell +Get-NetVirtualizationProviderAddress -InterfaceIndex 13 ``` This command gets the Provider Address for the interface with the specified index. ### Example 2: Get a specific Provider Address -``` -PS C:\>Get-NetVirtualizationProviderAddress -ProviderAddress "172.16.2.3" + +```powershell +Get-NetVirtualizationProviderAddress -ProviderAddress '172.16.2.3' ``` This command gets the Provider Address that has the IP address 172.16.2.3. @@ -49,22 +56,22 @@ This command gets the Provider Address that has the IP address 172.16.2.3. ## PARAMETERS ### -AddressState -Specifies an array of states of Provider Addresses. -The acceptable values for this parameter are: + +Specifies an array of states of Provider Addresses. The acceptable values for this parameter are: - Preferred. -The address is unique. + The address is unique. - Tentative. -The address is not yet verified. + The address is not yet verified. - Duplicate. -There is a duplicate address on the network. + There is a duplicate address on the network. - Invalid. -The address lifetime has expired. + The address lifetime has expired. - Deprecated. -The address cannot start new connections. + The address cannot start new connections. ```yaml -Type: AddressState[] +Type: AddressState [] Parameter Sets: (All) Aliases: Accepted values: Invalid, Tentative, Duplicate, Deprecated, Preferred @@ -77,10 +84,12 @@ Accept wildcard characters: False ``` ### -AsJob -Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. + +Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to +complete. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -92,12 +101,14 @@ Accept wildcard characters: False ``` ### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -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. -The default is the current session on the local computer. + +Runs the cmdlet in a remote session or on a remote computer. 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. The default is the +current session on the local computer. ```yaml -Type: CimSession[] +Type: Microsoft.Management.Infrastructure.CimSession[] Parameter Sets: (All) Aliases: Session @@ -109,10 +120,12 @@ Accept wildcard characters: False ``` ### -InterfaceIndex -Specifies an array of indexes for network interfaces that have Hyper-V Server 2016 Network Virtualization enabled. + +Specifies an array of indexes for network interfaces that have Hyper-V Server 2016 Network +Virtualization enabled. ```yaml -Type: UInt32[] +Type: System.UInt32[] Parameter Sets: (All) Aliases: @@ -124,10 +137,11 @@ Accept wildcard characters: False ``` ### -MACAddress + Specifies an array of media access control (MAC) addresses that corresponds to the Provider Address. ```yaml -Type: String[] +Type: System.String[] Parameter Sets: (All) Aliases: @@ -139,12 +153,14 @@ Accept wildcard characters: False ``` ### -ManagedByCluster -Specifies an array of Boolean values that determines whether a highly available Provider Address configuration entry exists on a Hyper-V Network Virtualization gateway. -If you use a Provider Address cluster resource, this value is $True; otherwise, the value is $False. -This parameter is a read-only parameter, used by an administrator to diagnose problems. + +Specifies an array of Boolean values that determines whether a highly available Provider Address +configuration entry exists on a Hyper-V Network Virtualization gateway. If you use a Provider +Address cluster resource, this value is $True; otherwise, the value is $False. This parameter is a +read-only parameter, used by an administrator to diagnose problems. ```yaml -Type: Boolean[] +Type: System.Boolean[] Parameter Sets: (All) Aliases: @@ -156,10 +172,11 @@ Accept wildcard characters: False ``` ### -PrefixLength + Specifies an array of lengths of IP prefixes. ```yaml -Type: Byte[] +Type: System.Byte[] Parameter Sets: (All) Aliases: @@ -171,11 +188,12 @@ Accept wildcard characters: False ``` ### -ProviderAddress + Specifies an array of IP addresses. You can use IPv4 and IPv6 addresses. ```yaml -Type: String[] +Type: System.String[] Parameter Sets: (All) Aliases: @@ -187,12 +205,15 @@ Accept wildcard characters: False ``` ### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -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. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. + +Specifies the maximum number of concurrent operations that can be established to run the cmdlet. 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. The throttle limit applies only to the current cmdlet, not to the session or to the +computer. ```yaml -Type: Int32 +Type: System.Int32 Parameter Sets: (All) Aliases: @@ -204,10 +225,11 @@ Accept wildcard characters: False ``` ### -VlanID + Specifies an array of IDs for VLANs for Provider Addresses. ```yaml -Type: UInt16[] +Type: System.UInt16[] Parameter Sets: (All) Aliases: @@ -219,7 +241,11 @@ Accept wildcard characters: False ``` ### CommonParameters -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). + +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). ## INPUTS @@ -234,4 +260,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-NetVirtualizationProviderAddress](./Remove-NetVirtualizationProviderAddress.md) [Set-NetVirtualizationProviderAddress](./Set-NetVirtualizationProviderAddress.md) - From 2eaf210f1e509576a1afa0fb659fd0b61d975a5f Mon Sep 17 00:00:00 2001 From: Robert Biddle Date: Thu, 27 Apr 2023 18:49:09 -0400 Subject: [PATCH 166/650] Adding powershell label to code block --- docset/winserver2022-ps/addsdeployment/Install-ADDSDomain.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/addsdeployment/Install-ADDSDomain.md b/docset/winserver2022-ps/addsdeployment/Install-ADDSDomain.md index 0c893d1361..cf406e6335 100644 --- a/docset/winserver2022-ps/addsdeployment/Install-ADDSDomain.md +++ b/docset/winserver2022-ps/addsdeployment/Install-ADDSDomain.md @@ -35,7 +35,7 @@ The `Install-ADDSDomain` cmdlet installs an Active Directory domain configuratio ### Example 1: Install a new child domain -``` +```powershell Install-ADDSDomain -Credential (Get-Credential CORP\EnterpriseAdmin1) -NewDomainName child -ParentDomainName "corp.contoso.com" -InstallDNS -CreateDNSDelegation -DomainMode Win2003 -ReplicationSourceDC "DC1.corp.contoso.com" -SiteName "Houston" -DatabasePath "D:\NTDS" -SYSVOLPath "D:\SYSVOL" -LogPath "E:\Logs" -NoRebootOnCompletion ``` From 1280f77e7d56d6a523c8f2060e53c81a9495ff8e Mon Sep 17 00:00:00 2001 From: Joe Gast Date: Thu, 27 Apr 2023 15:52:34 -0700 Subject: [PATCH 167/650] Grant-HgsKeyProtectorAccess.md - documentation formatting --- .../hgsclient/ConvertTo-HgsKeyProtector.md | 4 +- .../hgsclient/Export-HgsGuardian.md | 2 +- .../hgsclient/Grant-HgsKeyProtectorAccess.md | 55 +++++++++++-------- 3 files changed, 36 insertions(+), 25 deletions(-) diff --git a/docset/winserver2022-ps/hgsclient/ConvertTo-HgsKeyProtector.md b/docset/winserver2022-ps/hgsclient/ConvertTo-HgsKeyProtector.md index 427ca8e4cb..e51776c176 100644 --- a/docset/winserver2022-ps/hgsclient/ConvertTo-HgsKeyProtector.md +++ b/docset/winserver2022-ps/hgsclient/ConvertTo-HgsKeyProtector.md @@ -62,7 +62,7 @@ For more information about Windows PowerShell background jobs, see [about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -79,7 +79,7 @@ Specifies the existing key protector as a byte array. This cmdlet generates a ke from the existing key protector that this parameter specifies. ```yaml -Type: Byte[] +Type: System.Byte[] Parameter Sets: (All) Aliases: diff --git a/docset/winserver2022-ps/hgsclient/Export-HgsGuardian.md b/docset/winserver2022-ps/hgsclient/Export-HgsGuardian.md index a99e1ddbec..3026278601 100644 --- a/docset/winserver2022-ps/hgsclient/Export-HgsGuardian.md +++ b/docset/winserver2022-ps/hgsclient/Export-HgsGuardian.md @@ -59,7 +59,7 @@ Accept wildcard characters: False Specifies the path to the file to write an XML representation of the guardian. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: FilePath diff --git a/docset/winserver2022-ps/hgsclient/Grant-HgsKeyProtectorAccess.md b/docset/winserver2022-ps/hgsclient/Grant-HgsKeyProtectorAccess.md index 948f9e3b82..adc8414e9a 100644 --- a/docset/winserver2022-ps/hgsclient/Grant-HgsKeyProtectorAccess.md +++ b/docset/winserver2022-ps/hgsclient/Grant-HgsKeyProtectorAccess.md @@ -16,49 +16,54 @@ Grants access to a guardian for a key protector. ## SYNTAX ### InputObject + ``` -Grant-HgsKeyProtectorAccess -KeyProtector -Guardian [-AllowUntrustedRoot] - [-AllowExpired] [] +Grant-HgsKeyProtectorAccess -KeyProtector -Guardian + [-AllowUntrustedRoot] [-AllowExpired] [] ``` ### FriendlyName ``` -Grant-HgsKeyProtectorAccess -KeyProtector -GuardianFriendlyName [-AllowUntrustedRoot] - [-AllowExpired] [] +Grant-HgsKeyProtectorAccess -KeyProtector -GuardianFriendlyName + [-AllowUntrustedRoot] [-AllowExpired] [] ``` ## DESCRIPTION + The **Grant-HgsKeyProtectorAccess** cmdlet grants a Host Guardian Service guardian access to a key protector. This operation requires the private signing key of the owner of the key protector. ## EXAMPLES ### Example 1: Grant access to a guardian -``` -PS C:\> $Owner = Get-HgsGuardian -Name "Guardian06" -PS C:\> $Guardian01 = Get-HgsGuardian -Name "Guardian11" -PS C:\> $KeyProtector = New-HgsKeyProtector -Owner $Owner -PS C:\> Grant-HgsKeyProtectorAccess -KeyProtector $KeyProtector -Guardian $Guardian01 + +```powershell +$Owner = Get-HgsGuardian -Name "Guardian06" +$Guardian01 = Get-HgsGuardian -Name "Guardian11" +$KeyProtector = New-HgsKeyProtector -Owner $Owner +Grant-HgsKeyProtectorAccess -KeyProtector $KeyProtector -Guardian $Guardian01 ``` -The first command gets the guardian object named Guardian06 by using the **Get-HgsGuardian** cmdlet, and then stores that object in the **$Owner** variable. +The first command gets the guardian object named `Guardian06` by using the `Get-HgsGuardian` cmdlet, +and then stores that object in the `$Owner` variable. -The second commands get the guardian object named Guardian11, and then stores it in the **$Guardian01** variable. +The second commands get the guardian object named `Guardian11`, and then stores it in the `$Guardian01` variable. The third command creates a key protector. -The command defines Guardian06, stored in **$Owner**, as the **Owner**. +The command defines `Guardian06`, stored in `$Owner`, as the **Owner**. -The final command grants access to the guardian stored in **$Guardian01** for the key protector. +The final command grants access to the guardian stored in `$Guardian01` for the key protector. ## PARAMETERS ### -AllowExpired + Indicates that this cmdlet can grant permissions to a guardian that contains certificates that are expired. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -68,12 +73,13 @@ Accept wildcard characters: False ``` ### -AllowUntrustedRoot + Indicates that this cmdlet can grant permissions to a guardian that uses self-signed certificates. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -83,12 +89,13 @@ Accept wildcard characters: False ``` ### -Guardian + Specifies a guardian to which to grant access to the key. ```yaml Type: CimInstance Parameter Sets: InputObject -Aliases: +Aliases: Required: True Position: Named @@ -98,12 +105,13 @@ Accept wildcard characters: False ``` ### -GuardianFriendlyName + Specifies a friendly name for the guardian. ```yaml Type: String Parameter Sets: FriendlyName -Aliases: +Aliases: Required: True Position: Named @@ -113,12 +121,13 @@ Accept wildcard characters: False ``` ### -KeyProtector + Specifies the key protector to which to grant access. ```yaml Type: CimInstance Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: Named @@ -128,15 +137,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS ## OUTPUTS ### CimInstance#MSFT_HgsKeyProtector -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. + +The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays +Windows Management Instrumentation (WMI) objects. The path after the pound sign (`#`) provides the +namespace and class name for the underlying WMI object. ## NOTES @@ -147,4 +159,3 @@ The path after the pound sign (`#`) provides the namespace and class name for th [Revoke-HgsKeyProtectorAccess](./Revoke-HgsKeyProtectorAccess.md) [Get-HgsGuardian](./Get-HgsGuardian.md) - From 7cb1b6fc2d3d053e3ab93781badbde329242379c Mon Sep 17 00:00:00 2001 From: Missy Januszko Date: Thu, 27 Apr 2023 18:56:35 -0400 Subject: [PATCH 168/650] Add CR/LF, remove trailing spaces --- .../defender/Get-MpComputerStatus.md | 48 ++++++++++++------ .../defender/Get-MpPreference.md | 50 +++++++++++++------ .../winserver2022-ps/defender/Get-MpThreat.md | 48 ++++++++++++------ .../defender/Get-MpThreatCatalog.md | 44 ++++++++++------ 4 files changed, 129 insertions(+), 61 deletions(-) diff --git a/docset/winserver2022-ps/defender/Get-MpComputerStatus.md b/docset/winserver2022-ps/defender/Get-MpComputerStatus.md index 3b839ac75c..bb9c3c3753 100644 --- a/docset/winserver2022-ps/defender/Get-MpComputerStatus.md +++ b/docset/winserver2022-ps/defender/Get-MpComputerStatus.md @@ -16,15 +16,19 @@ Gets the status of antimalware software on the computer. ## SYNTAX ``` -Get-MpComputerStatus [-CimSession ] [-ThrottleLimit ] [-AsJob] [] +Get-MpComputerStatus [-CimSession ] [-ThrottleLimit ] [-AsJob] +[] ``` ## DESCRIPTION -The **Get-MpComputerStatus** cmdlet gets the status of antimalware software installed on the computer. + +The `Get-MpComputerStatus` cmdlet gets the status of antimalware software installed on the +computer. ## EXAMPLES ### Example 1: Get the computer status + ``` PS C:\> Get-MpComputerStatus AMEngineVersion : 1.1.9700.0 @@ -66,14 +70,17 @@ This command gets the status of antimalware protection software installed on the ## PARAMETERS ### -AsJob -Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. -The cmdlet immediately returns an object that represents the job and then displays the command prompt. -You can continue to work in the session while the job completes. -To manage the job, use the `*-Job` cmdlets. -To get the job results, use the [Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. +Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to +complete. -For more information about Windows PowerShell background jobs, see [about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). +The cmdlet immediately returns an object that represents the job and then displays the command +prompt. You can continue to work in the session while the job completes. To manage the job, use the +`*-Job` cmdlets. To get the job results, use the +[Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. + +For more information about Windows PowerShell background jobs, see +[about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). ```yaml Type: SwitchParameter @@ -88,9 +95,11 @@ Accept wildcard characters: False ``` ### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -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. -The default is the current session on the local computer. + +Runs the cmdlet in a remote session or on a remote computer. 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. The default is the +current session on the local computer. ```yaml Type: CimSession[] @@ -105,9 +114,12 @@ Accept wildcard characters: False ``` ### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -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. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. + +Specifies the maximum number of concurrent operations that can be established to run the cmdlet. 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. The throttle limit applies only to the current cmdlet, not to the session or to the +computer. ```yaml Type: Int32 @@ -122,12 +134,16 @@ Accept wildcard characters: False ``` ### CommonParameters -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). -## INPUTS + +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). ## INPUTS ## OUTPUTS ## NOTES ## RELATED LINKS + [Get-MpComputerStatus Properties](/previous-versions/windows/desktop/defender/msft-mpcomputerstatus#properties) diff --git a/docset/winserver2022-ps/defender/Get-MpPreference.md b/docset/winserver2022-ps/defender/Get-MpPreference.md index f37d733b47..edc27371bf 100644 --- a/docset/winserver2022-ps/defender/Get-MpPreference.md +++ b/docset/winserver2022-ps/defender/Get-MpPreference.md @@ -16,15 +16,20 @@ Gets preferences for the Windows Defender scans and updates. ## SYNTAX ``` -Get-MpPreference [-CimSession ] [-ThrottleLimit ] [-AsJob] [] +Get-MpPreference [-CimSession ] [-ThrottleLimit ] [-AsJob] +[] ``` ## DESCRIPTION -The **Get-MpPreference** cmdlet gets preferences for the Windows Defender scans and updates. For more information about the preferences that this cmdlet retrieves, see [Windows Defender Preferences Class](/previous-versions/windows/desktop/legacy/dn455323(v=vs.85)). + +The `Get-MpPreference` cmdlet gets preferences for the Windows Defender scans and updates. For more +information about the preferences that this cmdlet retrieves, see +[Windows Defender Preferences Class](/previous-versions/windows/desktop/legacy/dn455323(v=vs.85)). ## EXAMPLES ### Example 1: View the scheduled scan day + ``` PS C:\> $Preferences = Get-MpPreference PS C:\> $Preferences.ScanScheduleDay @@ -32,19 +37,23 @@ PS C:\> $Preferences.ScanScheduleDay The first command gets the preferences, and then stores them in the **$Preferences** variable. -The second command uses standard dot syntax to display the **ScanScheduleDay** property of the object stored in the **$Preferences** variable. +The second command uses standard dot syntax to display the **ScanScheduleDay** property of the +object stored in the **$Preferences** variable. ## PARAMETERS ### -AsJob -Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. -The cmdlet immediately returns an object that represents the job and then displays the command prompt. -You can continue to work in the session while the job completes. -To manage the job, use the `*-Job` cmdlets. -To get the job results, use the [Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. +Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to +complete. + +The cmdlet immediately returns an object that represents the job and then displays the command +prompt. You can continue to work in the session while the job completes. To manage the job, use the +`*-Job` cmdlets. To get the job results, use the +[Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. -For more information about Windows PowerShell background jobs, see [about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). +For more information about Windows PowerShell background jobs, see +[about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). ```yaml Type: SwitchParameter @@ -59,9 +68,11 @@ Accept wildcard characters: False ``` ### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -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. -The default is the current session on the local computer. + +Runs the cmdlet in a remote session or on a remote computer. 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. The default is the +current session on the local computer. ```yaml Type: CimSession[] @@ -76,9 +87,12 @@ Accept wildcard characters: False ``` ### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -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. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. + +Specifies the maximum number of concurrent operations that can be established to run the cmdlet. 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. The throttle limit applies only to the current cmdlet, not to the session or to the +computer. ```yaml Type: Int32 @@ -93,7 +107,11 @@ Accept wildcard characters: False ``` ### CommonParameters -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). + +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). ## INPUTS diff --git a/docset/winserver2022-ps/defender/Get-MpThreat.md b/docset/winserver2022-ps/defender/Get-MpThreat.md index 289d13177f..73688aa3a1 100644 --- a/docset/winserver2022-ps/defender/Get-MpThreat.md +++ b/docset/winserver2022-ps/defender/Get-MpThreat.md @@ -16,22 +16,27 @@ Gets the history of threats detected on the computer. ## SYNTAX ### DefaultSet (Default) + ``` Get-MpThreat [] ``` ### ById + ``` Get-MpThreat [-ThreatID ] [-CimSession ] [-ThrottleLimit ] [-AsJob] - [] +[] ``` ## DESCRIPTION -The **Get-MpThreat** cmdlet gets the history of threats that Windows Defender detected on the computer. + +The `Get-MpThreat` cmdlet gets the history of threats that Windows Defender detected on the +computer. ## EXAMPLES ### Example 1: Get the history of a detected threat + ``` PS C:\> Get-MpThreat -ThreatID 1994 ``` @@ -41,14 +46,17 @@ This command gets the history of the threat on the local computer that has the I ## PARAMETERS ### -AsJob -Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. -The cmdlet immediately returns an object that represents the job and then displays the command prompt. -You can continue to work in the session while the job completes. -To manage the job, use the `*-Job` cmdlets. -To get the job results, use the [Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. +Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to +complete. + +The cmdlet immediately returns an object that represents the job and then displays the command +prompt. You can continue to work in the session while the job completes. To manage the job, use the +`*-Job` cmdlets. To get the job results, use the +[Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. -For more information about Windows PowerShell background jobs, see [about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). +For more information about Windows PowerShell background jobs, see +[about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). ```yaml Type: SwitchParameter @@ -63,9 +71,11 @@ Accept wildcard characters: False ``` ### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -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. -The default is the current session on the local computer. + +Runs the cmdlet in a remote session or on a remote computer. 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. The default is the +current session on the local computer. ```yaml Type: CimSession[] @@ -80,6 +90,7 @@ Accept wildcard characters: False ``` ### -ThreatID + Specifies an array of threat IDs. This cmdlet gets the history of the threats that you specify. @@ -96,9 +107,12 @@ Accept wildcard characters: False ``` ### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -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. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. + +Specifies the maximum number of concurrent operations that can be established to run the cmdlet. 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. The throttle limit applies only to the current cmdlet, not to the session or to the +computer. ```yaml Type: Int32 @@ -113,7 +127,11 @@ Accept wildcard characters: False ``` ### CommonParameters -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). + +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). ## INPUTS diff --git a/docset/winserver2022-ps/defender/Get-MpThreatCatalog.md b/docset/winserver2022-ps/defender/Get-MpThreatCatalog.md index ec4adeab88..b6999aafca 100644 --- a/docset/winserver2022-ps/defender/Get-MpThreatCatalog.md +++ b/docset/winserver2022-ps/defender/Get-MpThreatCatalog.md @@ -16,23 +16,27 @@ Gets known threats from the definitions catalog. ## SYNTAX ### DefaultSet (Default) + ``` Get-MpThreatCatalog [] ``` ### ById + ``` Get-MpThreatCatalog [-ThreatID ] [-CimSession ] [-ThrottleLimit ] [-AsJob] [] ``` ## DESCRIPTION + The **Get-MpThreatCatalog** cmdlet gets known threats from the Windows Defender definitions catalog. The definitions catalog contains references to all known threats that Windows Defender can identify. ## EXAMPLES ### Example 1: Get a known threat from the definitions catalog + ``` PS C:\> Get-MpThreatCatalog -ThreatID 1994 ``` @@ -42,14 +46,17 @@ This command gets the known threat that has the ID 1994. ## PARAMETERS ### -AsJob -Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. -The cmdlet immediately returns an object that represents the job and then displays the command prompt. -You can continue to work in the session while the job completes. -To manage the job, use the `*-Job` cmdlets. -To get the job results, use the [Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. +Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to +complete. + +The cmdlet immediately returns an object that represents the job and then displays the command +prompt. You can continue to work in the session while the job completes. To manage the job, use the +`*-Job` cmdlets. To get the job results, use the +[Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. -For more information about Windows PowerShell background jobs, see [about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). +For more information about Windows PowerShell background jobs, see +[about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). ```yaml Type: SwitchParameter @@ -64,9 +71,11 @@ Accept wildcard characters: False ``` ### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -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. -The default is the current session on the local computer. + +Runs the cmdlet in a remote session or on a remote computer. 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. The default is the +current session on the local computer. ```yaml Type: CimSession[] @@ -81,6 +90,7 @@ Accept wildcard characters: False ``` ### -ThreatID + Specifies an array of threat IDs. This cmdlet gets the threats that you specify from the definitions catalog. @@ -97,9 +107,12 @@ Accept wildcard characters: False ``` ### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -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. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. + +Specifies the maximum number of concurrent operations that can be established to run the cmdlet. 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. The throttle limit applies only to the current cmdlet, not to the session or to the +computer. ```yaml Type: Int32 @@ -114,7 +127,11 @@ Accept wildcard characters: False ``` ### CommonParameters -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). + +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). ## INPUTS @@ -129,4 +146,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-MpThreat](./Remove-MpThreat.md) [Get-MpThreatDetection](./Get-MpThreatDetection.md) - From d72072d19e36cc2645651e3c9ae4c80c27a2c450 Mon Sep 17 00:00:00 2001 From: Vanda Paladino Date: Thu, 27 Apr 2023 19:00:31 -0400 Subject: [PATCH 169/650] Update docset/winserver2022-ps/ServerManager/Disable-ServerManagerStandardUserRemoting.md Co-authored-by: Mikey Lombardi (He/Him) --- .../ServerManager/Disable-ServerManagerStandardUserRemoting.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/ServerManager/Disable-ServerManagerStandardUserRemoting.md b/docset/winserver2022-ps/ServerManager/Disable-ServerManagerStandardUserRemoting.md index ad1acd6bfc..f937e76e5c 100644 --- a/docset/winserver2022-ps/ServerManager/Disable-ServerManagerStandardUserRemoting.md +++ b/docset/winserver2022-ps/ServerManager/Disable-ServerManagerStandardUserRemoting.md @@ -30,7 +30,7 @@ Manager. The cmdlet restores the default, administrator-only access to this data locally on the server that is being managed by using Server Manager. The cmdlet works by performing the following actions: -- Deletes access rights for specified standard users to the root\cimv2 namespace on the local server +- Deletes access rights for specified standard users to the `root\cimv2` namespace on the local server (for access to role and feature inventory information). - Removes specified standard users from user groups (Remote Management Users, Event Log Readers, and From 9aa9086d4b20090c47b893ce0c797e112f622852 Mon Sep 17 00:00:00 2001 From: Vanda Paladino Date: Thu, 27 Apr 2023 19:00:45 -0400 Subject: [PATCH 170/650] Update docset/winserver2022-ps/ServerManager/Disable-ServerManagerStandardUserRemoting.md Co-authored-by: Mikey Lombardi (He/Him) --- .../ServerManager/Disable-ServerManagerStandardUserRemoting.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/ServerManager/Disable-ServerManagerStandardUserRemoting.md b/docset/winserver2022-ps/ServerManager/Disable-ServerManagerStandardUserRemoting.md index f937e76e5c..65c4711433 100644 --- a/docset/winserver2022-ps/ServerManager/Disable-ServerManagerStandardUserRemoting.md +++ b/docset/winserver2022-ps/ServerManager/Disable-ServerManagerStandardUserRemoting.md @@ -14,7 +14,7 @@ title: Disable-ServerManagerStandardUserRemoting Disables access for specified standard users to event, service, performance counter, and role and feature inventory data that is collected by Server Manager for a server. This cmdlet performs the -opposite action, for specified users, of the Enable-ServerManagerStandardUserRemoting cmdlet. +opposite action, for specified users, of the `Enable-ServerManagerStandardUserRemoting` cmdlet. ## SYNTAX From 2b6e10ad7c9ac76ae78a90f1316c5101d6807ce0 Mon Sep 17 00:00:00 2001 From: Vanda Paladino Date: Thu, 27 Apr 2023 19:00:56 -0400 Subject: [PATCH 171/650] Update docset/winserver2022-ps/ServerManager/Disable-ServerManagerStandardUserRemoting.md Co-authored-by: Mikey Lombardi (He/Him) --- .../ServerManager/Disable-ServerManagerStandardUserRemoting.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/ServerManager/Disable-ServerManagerStandardUserRemoting.md b/docset/winserver2022-ps/ServerManager/Disable-ServerManagerStandardUserRemoting.md index 65c4711433..f4c12ec6ce 100644 --- a/docset/winserver2022-ps/ServerManager/Disable-ServerManagerStandardUserRemoting.md +++ b/docset/winserver2022-ps/ServerManager/Disable-ServerManagerStandardUserRemoting.md @@ -59,7 +59,7 @@ Disable-ServerManagerStandardUserRemoting -User JennyL -WhatIf ``` In this example, the administrator views the outcome of running a command to deny a standard user -named JennyL access to event, performance counter, service status, and role and feature inventory +named `JennyL` access to event, performance counter, service status, and role and feature inventory data for a server that is being managed by using the Server Manager console running on either the local or a remote computer. The **WhatIf** parameter is added, meaning that the command actions are not carried out. From 3ce768c4454df6637578a88eb29be4d639501707 Mon Sep 17 00:00:00 2001 From: Vanda Paladino Date: Thu, 27 Apr 2023 19:01:04 -0400 Subject: [PATCH 172/650] Update docset/winserver2022-ps/ServerManager/Disable-ServerManagerStandardUserRemoting.md Co-authored-by: Mikey Lombardi (He/Him) --- .../ServerManager/Disable-ServerManagerStandardUserRemoting.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/ServerManager/Disable-ServerManagerStandardUserRemoting.md b/docset/winserver2022-ps/ServerManager/Disable-ServerManagerStandardUserRemoting.md index f4c12ec6ce..0f8bc185ea 100644 --- a/docset/winserver2022-ps/ServerManager/Disable-ServerManagerStandardUserRemoting.md +++ b/docset/winserver2022-ps/ServerManager/Disable-ServerManagerStandardUserRemoting.md @@ -70,7 +70,7 @@ not carried out. Disable-ServerManagerStandardUserRemoting -User JennyL -Confirm ``` -In this example, the administrator denies a standard user named JennyL access to event, performance +In this example, the administrator denies a standard user named `JennyL` access to event, performance counter, service status, and role and feature inventory data for a server that is being managed by using the Server Manager console running on either the local or a remote computer. The **Confirm** parameter is added, meaning that the command prompts for confirmation before performing the action. From b734f76aad5e11d4d779b3c605226e807734f9e5 Mon Sep 17 00:00:00 2001 From: Vanda Paladino Date: Thu, 27 Apr 2023 19:01:15 -0400 Subject: [PATCH 173/650] Update docset/winserver2022-ps/ServerManager/Disable-ServerManagerStandardUserRemoting.md Co-authored-by: Mikey Lombardi (He/Him) --- .../Disable-ServerManagerStandardUserRemoting.md | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/docset/winserver2022-ps/ServerManager/Disable-ServerManagerStandardUserRemoting.md b/docset/winserver2022-ps/ServerManager/Disable-ServerManagerStandardUserRemoting.md index 0f8bc185ea..df94e867b7 100644 --- a/docset/winserver2022-ps/ServerManager/Disable-ServerManagerStandardUserRemoting.md +++ b/docset/winserver2022-ps/ServerManager/Disable-ServerManagerStandardUserRemoting.md @@ -146,10 +146,7 @@ Accept wildcard characters: False ### CommonParameters -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). +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). ## INPUTS From 5bb9cb5a7e78c995ff8c58286b0ced9c8e5b3935 Mon Sep 17 00:00:00 2001 From: Dave Carroll Date: Thu, 27 Apr 2023 16:03:59 -0700 Subject: [PATCH 174/650] fix output --- docset/winserver2022-ps/tls/Get-TlsEccCurve.md | 4 ---- 1 file changed, 4 deletions(-) diff --git a/docset/winserver2022-ps/tls/Get-TlsEccCurve.md b/docset/winserver2022-ps/tls/Get-TlsEccCurve.md index f1107762d9..e71d7d9417 100644 --- a/docset/winserver2022-ps/tls/Get-TlsEccCurve.md +++ b/docset/winserver2022-ps/tls/Get-TlsEccCurve.md @@ -30,8 +30,6 @@ Gets the list of Elliptic Curve Cryptography (ECC) cipher suites available for T Get-TlsEccCurve ``` -This generates the following output: - ```output curve25519 NistP256 @@ -46,8 +44,6 @@ This command gets all ECC curves for the computer. Get-TlsEccCurve -Name 'Nist' ``` -This generates the following output: - ```output NistP256 NistP384 From c2bbd4ac4b45349d15df4bfd2021e8dda7d1f27e Mon Sep 17 00:00:00 2001 From: 53883 Date: Fri, 28 Apr 2023 01:05:29 +0200 Subject: [PATCH 175/650] formatting changes --- .../ServerManager/Get-WindowsFeature.md | 83 ++++++++++++++----- 1 file changed, 60 insertions(+), 23 deletions(-) diff --git a/docset/winserver2022-ps/ServerManager/Get-WindowsFeature.md b/docset/winserver2022-ps/ServerManager/Get-WindowsFeature.md index 2cde727771..6aa9c5af6a 100644 --- a/docset/winserver2022-ps/ServerManager/Get-WindowsFeature.md +++ b/docset/winserver2022-ps/ServerManager/Get-WindowsFeature.md @@ -11,43 +11,55 @@ title: Get-WindowsFeature # Get-WindowsFeature ## SYNOPSIS -Gets information about Windows Server roles, role services, and features that are available for installation and installed on a specified server. +Gets information about Windows Server roles, role services, and features that are available for +installation and installed on a specified server. ## SYNTAX ``` -Get-WindowsFeature [[-Name] ] [-Vhd ] [-ComputerName ] [-Credential ] - [-LogPath ] [] +Get-WindowsFeature [[-Name] ] [-Vhd ] [-ComputerName ] +[-Credential ] [-LogPath ] [] ``` ## DESCRIPTION -The `Get-WindowsFeature` cmdlet gets information about features that are both available for installation and already installed on a computer that is running Windows Server or an offline virtual hard disk (VHD) that is running Windows Server. + +The `Get-WindowsFeature` cmdlet gets information about features that are both available for +installation and already installed on a computer that is running Windows Server or an offline +virtual hard disk (VHD) that is running Windows Server. ## EXAMPLES ### Example 1 + ```powershell Get-WindowsFeature -ComputerName Server1 -Credential contoso.com\user1 ``` -This example gets a list of features that is available and installed on the target computer named Server1. -The credentials for user user1 in the Contoso.com domain, a user who has Administrator rights on Server1, are provided. +This example gets a list of features that is available and installed on the +target computer named Server1. +The credentials for user user1 in the Contoso.com domain, a user who has +Administrator rights on Server1, are provided. ### Example 2 + ```powershell Get-WindowsFeature -Vhd D:\ps-test\vhd1.vhd ``` -This example returns a list of features that is available and installed on the specified offline VHD located at D:\ps-test\vhd1.vhd. +This example returns a list of features that is available and installed on the specified offline VHD +located at D:\ps-test\vhd1.vhd. ### Example 3 + ```powershell Get-WindowsFeature -Name AD*, Web* ``` -This example returns a list of available and installed features that have a command ID starting with AD or Web. +This example returns a list of available and installed features that have a command ID starting with +AD or Web. ### Example 4 + ```powershell Get-WindowsFeature -ComputerName Server01 | Where Installed ``` @@ -55,23 +67,34 @@ Get-WindowsFeature -ComputerName Server01 | Where Installed This example returns a list of features installed on a specified server, Server01. ### Example 5 + ```powershell Get-WindowsFeature -ComputerName Server01 | Where InstallState -Eq Removed ``` -This example returns a list of features on a specified server, Server01, that have installation files removed from the local side-by-side store, and require an external file source for installation. +This example returns a list of features on a specified server, Server01, that have installation +files removed from the local side-by-side store, and require an external file source for +installation. ## PARAMETERS ### -ComputerName -Gets the list of available features from the specified remote computer that is running Windows Server. -The parameter accepts only one computer name. -If this parameter is not added, or no computer name is specified, the default target is the local computer. -Valid values for the parameter include a NetBIOS name, an IP address, or a fully qualified domain name of a remote computer. -To use a remote computer's IP address as the value of this parameter, your command must include the `Credential` parameter. -The computer must either be configured for HTTPS transport, or the IP address of the remote computer must be included in the WinRM TrustedHosts list on the local computer. -For information about adding a computer name to the WinRM TrustedHosts list, see "How to Add a Computer to the Trusted Host List" in [about_Remote_Troubleshooting](https://go.microsoft.com/fwlink/p/?LinkID=135188). +Gets the list of available features from the specified remote computer that is running +Windows Server. +The parameter accepts only one computer name. +If this parameter is not added, or no computer name is specified, the default target is the local +computer. +Valid values for the parameter include a NetBIOS name, an IP address, or a fully qualified domain +name of a remote computer. + +To use a remote computer's IP address as the value of this parameter, your command must include the +`Credential` parameter. +The computer must either be configured for HTTPS transport, or the IP address of the remote computer +must be included in the WinRM TrustedHosts list on the local computer. +For information about adding a computer name to the WinRM TrustedHosts list, see "How to Add a +Computer to the Trusted Host List" in +[about_Remote_Troubleshooting](https://go.microsoft.com/fwlink/p/?LinkID=135188). ```yaml Type: String @@ -86,15 +109,18 @@ Accept wildcard characters: False ``` ### -Credential + Specifies a user account that has access rights to perform this action. -If the parameter is not added, or no value is specified, the default value of this parameter is the current user. +If the parameter is not added, or no value is specified, the default value of this parameter is the +current user. Enter a user name in one of the following formats. Quotation marks are optional. -- "UserName" -- "Domain\User" -- "User@Domain.com" --- A Credential object returned by the [Get-Credential](https://go.microsoft.com/fwlink/p/?LinkID=113311) cmdlet. +-- A Credential object returned by the + [Get-Credential](https://go.microsoft.com/fwlink/p/?LinkID=113311) cmdlet. If a user name is entered, then a prompt for a password is displayed. @@ -111,6 +137,7 @@ Accept wildcard characters: False ``` ### -LogPath + Specifies a name and path to a log file. Add this parameter if the results of this cmdlet must be stored in a log. @@ -127,6 +154,7 @@ Accept wildcard characters: False ``` ### -Name + Specifies the command IDs of roles, role services, or features about which to return information. ```yaml @@ -142,19 +170,25 @@ Accept wildcard characters: False ``` ### -Vhd + Specifies the path to an offline VHD. -The path can either point to a VHD file, or to a location on which the VHD is already mounted by using Deployment Image Servicing and Management (DISM) tools. +The path can either point to a VHD file, or to a location on which the VHD is already mounted by +using Deployment Image Servicing and Management (DISM) tools. The VHD can be on a local disk on the target computer, or on a network shared folder. If the VHD is in a network shared folder, then the value of this parameter is a UNC path to the VHD. -In this case, the computer account of the computer that you are using to mount the VHD must have read and write permissions (Read/Write permissions in the File Sharing dialog box, or Full Control on the Security tab of the folder Properties dialog box) on the shared folder, or the VHD will not be accessible. +In this case, the computer account of the computer that you are using to mount the VHD must have +read and write permissions (Read/Write permissions in the File Sharing dialog box, or Full Control +on the Security tab of the folder Properties dialog box) on the shared folder, or the VHD will not +be accessible. Local loopback UNC paths are not supported. Use either of the following formats for the computer account: DOMAIN\SERVERNAME$ or SERVERNAME$. Add the `ComputerName` parameter to specify the target computer you want to use to mount the VHD. If the `ComputerName` parameter is not specified, then the local computer is used. The computer that you are using to mount the VHD must be running Windows Server. -Any local path, such as D:\myFolder, that is specified by using this parameter is always relative to the target computer. +Any local path, such as D:\myFolder, that is specified by using this parameter is always relative to +the target computer. ```yaml Type: String @@ -169,7 +203,11 @@ Accept wildcard characters: False ``` ### CommonParameters -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). + +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). ## INPUTS @@ -190,4 +228,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Enable-ServerManagerStandardUserRemoting](./Enable-ServerManagerStandardUserRemoting.md) [Disable-ServerManagerStandardUserRemoting](./Disable-ServerManagerStandardUserRemoting.md) - From e4274fcd850374ccbdfdfa9ef78c891e8a4d8065 Mon Sep 17 00:00:00 2001 From: Joe Gast Date: Thu, 27 Apr 2023 16:06:12 -0700 Subject: [PATCH 176/650] Changed files to use full class names --- .../hgsclient/ConvertTo-HgsKeyProtector.md | 7 ++++--- .../winserver2022-ps/hgsclient/Export-HgsGuardian.md | 2 +- .../hgsclient/Get-HgsAttestationBaselinePolicy.md | 8 ++++---- .../hgsclient/Get-HgsClientConfiguration.md | 6 +++--- docset/winserver2022-ps/hgsclient/Get-HgsGuardian.md | 2 +- .../hgsclient/Grant-HgsKeyProtectorAccess.md | 4 ++-- .../winserver2022-ps/hgsclient/Import-HgsGuardian.md | 8 ++++---- docset/winserver2022-ps/hgsclient/New-HgsGuardian.md | 10 +++++----- .../winserver2022-ps/hgsclient/New-HgsKeyProtector.md | 4 ++-- .../winserver2022-ps/hgsclient/Remove-HgsGuardian.md | 4 ++-- .../hgsclient/Set-HgsClientConfiguration.md | 6 +++--- .../hgsclient/Test-HgsClientConfiguration.md | 4 ++-- 12 files changed, 33 insertions(+), 32 deletions(-) diff --git a/docset/winserver2022-ps/hgsclient/ConvertTo-HgsKeyProtector.md b/docset/winserver2022-ps/hgsclient/ConvertTo-HgsKeyProtector.md index e51776c176..aec3e59df8 100644 --- a/docset/winserver2022-ps/hgsclient/ConvertTo-HgsKeyProtector.md +++ b/docset/winserver2022-ps/hgsclient/ConvertTo-HgsKeyProtector.md @@ -11,6 +11,7 @@ title: ConvertTo-HgsKeyProtector # ConvertTo-HgsKeyProtector ## SYNOPSIS + Converts a key protector into a Host Guardian Service key protector. ## SYNTAX @@ -98,7 +99,7 @@ or [Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet. Th current session on the local computer. ```yaml -Type: CimSession[] +Type: Microsoft.Management.Infrastructure.CimSession[] Parameter Sets: (All) Aliases: Session @@ -118,7 +119,7 @@ computer. The throttle limit applies only to the current cmdlet, not to the sess computer. ```yaml -Type: Int32 +Type: System.Int32 Parameter Sets: (All) Aliases: @@ -152,4 +153,4 @@ namespace and class name for the underlying WMI object. ## RELATED LINKS -[New-HgsKeyProtector](./New-HgsKeyProtector.md) \ No newline at end of file +[New-HgsKeyProtector](./New-HgsKeyProtector.md) diff --git a/docset/winserver2022-ps/hgsclient/Export-HgsGuardian.md b/docset/winserver2022-ps/hgsclient/Export-HgsGuardian.md index 3026278601..3524873d41 100644 --- a/docset/winserver2022-ps/hgsclient/Export-HgsGuardian.md +++ b/docset/winserver2022-ps/hgsclient/Export-HgsGuardian.md @@ -43,7 +43,7 @@ Specifies the input to this cmdlet. You can use this parameter, or you can pipe the input to this cmdlet. ```yaml -Type: CimInstance +Type: Microsoft.Management.Infrastructure.CimInstance Parameter Sets: (All) Aliases: Guardian diff --git a/docset/winserver2022-ps/hgsclient/Get-HgsAttestationBaselinePolicy.md b/docset/winserver2022-ps/hgsclient/Get-HgsAttestationBaselinePolicy.md index 657264cbf5..b36cff4f3e 100644 --- a/docset/winserver2022-ps/hgsclient/Get-HgsAttestationBaselinePolicy.md +++ b/docset/winserver2022-ps/hgsclient/Get-HgsAttestationBaselinePolicy.md @@ -52,7 +52,7 @@ This command generates a byte array that represents the baseline policy in the f Indicates that this cmdlet operates in console mode. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: Console Aliases: @@ -68,7 +68,7 @@ Accept wildcard characters: False Indicates that this cmdlet overwrites an existing file that the **Output** object specifies. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: File Aliases: @@ -85,7 +85,7 @@ Specifies a file path. This cmdlet writes the policy to the file that this parameter specifies. ```yaml -Type: String +Type: System.String Parameter Sets: File Aliases: FilePath @@ -101,7 +101,7 @@ Accept wildcard characters: False Indicates that this cmdlet skips validation. ```yaml -Type: SwitchParameter +Type: System.Diagnostics.Switch Parameter Sets: (All) Aliases: diff --git a/docset/winserver2022-ps/hgsclient/Get-HgsClientConfiguration.md b/docset/winserver2022-ps/hgsclient/Get-HgsClientConfiguration.md index 6e46797846..3c5333ca11 100644 --- a/docset/winserver2022-ps/hgsclient/Get-HgsClientConfiguration.md +++ b/docset/winserver2022-ps/hgsclient/Get-HgsClientConfiguration.md @@ -51,7 +51,7 @@ For more information about Windows PowerShell background jobs, see [about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). ```yaml -Type: SwitchParameter +Type: System.Diagnostics.Switch Parameter Sets: (All) Aliases: @@ -70,7 +70,7 @@ or [Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet. Th current session on the local computer. ```yaml -Type: CimSession[] +Type: Microsoft.Management.Infrastructure.CimSession[] Parameter Sets: (All) Aliases: Session @@ -90,7 +90,7 @@ computer. The throttle limit applies only to the current cmdlet, not to the sess computer. ```yaml -Type: Int32 +Type: System.Int32 Parameter Sets: (All) Aliases: diff --git a/docset/winserver2022-ps/hgsclient/Get-HgsGuardian.md b/docset/winserver2022-ps/hgsclient/Get-HgsGuardian.md index fa06f2f03a..e936114040 100644 --- a/docset/winserver2022-ps/hgsclient/Get-HgsGuardian.md +++ b/docset/winserver2022-ps/hgsclient/Get-HgsGuardian.md @@ -60,7 +60,7 @@ For more information about Windows PowerShell background jobs, see [about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: diff --git a/docset/winserver2022-ps/hgsclient/Grant-HgsKeyProtectorAccess.md b/docset/winserver2022-ps/hgsclient/Grant-HgsKeyProtectorAccess.md index adc8414e9a..48222ba9d5 100644 --- a/docset/winserver2022-ps/hgsclient/Grant-HgsKeyProtectorAccess.md +++ b/docset/winserver2022-ps/hgsclient/Grant-HgsKeyProtectorAccess.md @@ -61,7 +61,7 @@ The final command grants access to the guardian stored in `$Guardian01` for the Indicates that this cmdlet can grant permissions to a guardian that contains certificates that are expired. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -77,7 +77,7 @@ Accept wildcard characters: False Indicates that this cmdlet can grant permissions to a guardian that uses self-signed certificates. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: diff --git a/docset/winserver2022-ps/hgsclient/Import-HgsGuardian.md b/docset/winserver2022-ps/hgsclient/Import-HgsGuardian.md index add47de27f..e7d4eeb04b 100644 --- a/docset/winserver2022-ps/hgsclient/Import-HgsGuardian.md +++ b/docset/winserver2022-ps/hgsclient/Import-HgsGuardian.md @@ -39,7 +39,7 @@ This command imports a guardian from the specified .xml file. Indicates whether to allow guardian creation with certificates that are expired. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -54,7 +54,7 @@ Accept wildcard characters: False Indicates whether to allow a guardian to be created using self-signed certificates. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -99,7 +99,7 @@ Accept wildcard characters: False Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf @@ -114,7 +114,7 @@ Accept wildcard characters: False Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi diff --git a/docset/winserver2022-ps/hgsclient/New-HgsGuardian.md b/docset/winserver2022-ps/hgsclient/New-HgsGuardian.md index 456a7e403d..f39c2cc776 100644 --- a/docset/winserver2022-ps/hgsclient/New-HgsGuardian.md +++ b/docset/winserver2022-ps/hgsclient/New-HgsGuardian.md @@ -69,7 +69,7 @@ The passwords stored in the **$SecureStringPassword01** and **$SecureStringPassw Indicates that this cmdlet can create a guardian by using certificates that are expired. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: AcceptCertificates, ByThumbprints Aliases: @@ -84,7 +84,7 @@ Accept wildcard characters: False Indicates that this cmdlet can create a guardian by using self-signed certificates. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: AcceptCertificates, ByThumbprints Aliases: @@ -149,7 +149,7 @@ If you specify this parameter, the new guardian does not have a trusted root. Therefore, you must also specify the **AllowUntrustedRoot** parameter. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: GenerateCertificates Aliases: @@ -225,7 +225,7 @@ Accept wildcard characters: False Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf @@ -241,7 +241,7 @@ Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi diff --git a/docset/winserver2022-ps/hgsclient/New-HgsKeyProtector.md b/docset/winserver2022-ps/hgsclient/New-HgsKeyProtector.md index f44550e6c4..97471f1a1e 100644 --- a/docset/winserver2022-ps/hgsclient/New-HgsKeyProtector.md +++ b/docset/winserver2022-ps/hgsclient/New-HgsKeyProtector.md @@ -53,7 +53,7 @@ The command also grants access to the guardians stored in **$GuardianA** and **$ Indicates that this cmdlet can create a key protector by using certificates that are expired. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -68,7 +68,7 @@ Accept wildcard characters: False Indicates that this cmdlet can create a key protector by using self-signed certificates. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: diff --git a/docset/winserver2022-ps/hgsclient/Remove-HgsGuardian.md b/docset/winserver2022-ps/hgsclient/Remove-HgsGuardian.md index 2bebe40b1f..d1b362105a 100644 --- a/docset/winserver2022-ps/hgsclient/Remove-HgsGuardian.md +++ b/docset/winserver2022-ps/hgsclient/Remove-HgsGuardian.md @@ -73,7 +73,7 @@ Accept wildcard characters: False Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf @@ -89,7 +89,7 @@ Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi diff --git a/docset/winserver2022-ps/hgsclient/Set-HgsClientConfiguration.md b/docset/winserver2022-ps/hgsclient/Set-HgsClientConfiguration.md index 938cf954e6..71a70340ea 100644 --- a/docset/winserver2022-ps/hgsclient/Set-HgsClientConfiguration.md +++ b/docset/winserver2022-ps/hgsclient/Set-HgsClientConfiguration.md @@ -79,7 +79,7 @@ Indicates that this cmdlet changes the mode of client from Host Guardian Service A change in mode to Local resets the attestation server and key protection server URLs. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: ChangeToLocalMode Aliases: @@ -140,7 +140,7 @@ Accept wildcard characters: False Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf @@ -156,7 +156,7 @@ Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi diff --git a/docset/winserver2022-ps/hgsclient/Test-HgsClientConfiguration.md b/docset/winserver2022-ps/hgsclient/Test-HgsClientConfiguration.md index f2a3aab4bc..f91352588f 100644 --- a/docset/winserver2022-ps/hgsclient/Test-HgsClientConfiguration.md +++ b/docset/winserver2022-ps/hgsclient/Test-HgsClientConfiguration.md @@ -58,7 +58,7 @@ Performs an attestation attempt using the fallback HGS server. Specifies that the HGS client should only attest against the fallback attestation server. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: Fallback Aliases: @@ -73,7 +73,7 @@ Accept wildcard characters: False Specifies that the HGS client should only attest against the primary attestation server. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: Primary Aliases: From 560447f4637485496775ab5290f17225d4456aed Mon Sep 17 00:00:00 2001 From: Paula Kingsley Date: Thu, 27 Apr 2023 16:10:28 -0700 Subject: [PATCH 177/650] Line breaks and bold asterisks and stuff --- .../winserver2022-ps/grouppolicy/Get-GPO.md | 107 ++++++++++++------ 1 file changed, 73 insertions(+), 34 deletions(-) diff --git a/docset/winserver2022-ps/grouppolicy/Get-GPO.md b/docset/winserver2022-ps/grouppolicy/Get-GPO.md index 1c955208c6..29dd4f43ce 100644 --- a/docset/winserver2022-ps/grouppolicy/Get-GPO.md +++ b/docset/winserver2022-ps/grouppolicy/Get-GPO.md @@ -16,32 +16,42 @@ Gets one GPO or all the GPOs in a domain. ## SYNTAX ### ByGUID (Default) + ``` Get-GPO [-Guid] [[-Domain] ] [[-Server] ] [-All] [] ``` ### ByName + ``` Get-GPO [-Name] [[-Domain] ] [[-Server] ] [-All] [] ``` ### GetAll + ``` Get-GPO [[-Domain] ] [[-Server] ] [-All] [] ``` ## DESCRIPTION + The **Get-GPO** cmdlet gets one Group Policy Object (GPO) or all the GPOs in a domain. -You can specify a GPO by its display name or by its globally unique identifier (GUID) to get a single GPO, or you can get all the GPOs in the domain through the *All* parameter. +You can specify a GPO by its display name or by its globally unique identifier (GUID) to get a +single GPO, or you can get all the GPOs in the domain through the **All** parameter. This cmdlet returns one or more objects that represent the requested GPOs. -By default, properties of the requested GPOs are printed to the display; however, you can also pipe the output of the **Get-GPO** cmdlet to other Group Policy cmdlets. +By default, properties of the requested GPOs are printed to the display; however, you can also pipe +the output of the **Get-GPO** cmdlet to other Group Policy cmdlets. ## EXAMPLES ### Example 1: Get a single GPO from a domain + +```powershell +Get-GPO -Name "Group Policy Test" +``` + ``` -PS C:\> Get-GPO -Name "Group Policy Test" DisplayName : Group Policy Test DomainName : contoso.com @@ -66,12 +76,17 @@ WmiFilter : ``` This command gets the GPO named Group Policy Test. -The GPO must exist in the domain of the user that is running the session (or, for startup and shutdown scripts, the computer). +The GPO must exist in the domain of the user that is running the session (or, for startup and +shutdown scripts, the computer). The command gets the GPO information by contacting the primary domain controller (PDC). ### Example 2: Get a single GPO by GUID + +```powershell +Get-GPO -Guid 31a09564-cd4a-4520-98fa-446a2af23b4b -Domain "sales.contoso.com" ``` -PS C:\> Get-GPO -Guid 31a09564-cd4a-4520-98fa-446a2af23b4b -Domain "sales.contoso.com" + +```output DisplayName : Group Policy Test DomainName : sales.contoso.com @@ -95,13 +110,16 @@ ComputerVersion : AD Version: 0, SysVol Version: 0 WmiFilter : ``` -This command gets the GPO that has the ID (GUID) 331a09564-cd4a-4520-98fa-446a2af23b4b in the sales.contoso.com domain. -If the domain of the user that is running the session (or, for startup and shutdown scripts, the computer) is different that sales.contoso.com, a trust must exist between the two domains. +This command gets the GPO that has the ID (GUID) 331a09564-cd4a-4520-98fa-446a2af23b4b in the +sales.contoso.com domain. +If the domain of the user that is running the session (or, for startup and shutdown scripts, the +computer) is different that sales.contoso.com, a trust must exist between the two domains. The command retrieves the GPO information by contacting the PDC (in the sales.contoso.com domain). ### Example 3: Get all GPOs from a domain -``` -PS C:\> Get-GPO -All -Domain "sales.contoso.com" + +```powershell +Get-GPO -All -Domain "sales.contoso.com" ``` This command get all the GPOs in the sales.contoso.com domain. @@ -109,6 +127,7 @@ This command get all the GPOs in the sales.contoso.com domain. ## PARAMETERS ### -All + Indicates that the cmdlet gets all the GPOs in the domain. ```yaml @@ -124,19 +143,24 @@ Accept wildcard characters: False ``` ### -Domain + Specifies the domain for this cmdlet. You must specify the fully qualified domain name (FQDN) of the domain. For the **Get-GPO** cmdlet, the GPO (or GPOs) to that this cmdlet gets must exist in this domain. -If you do not specify the *Domain* parameter, the domain of the user that is running the current session is used. -If the cmdlet is being run from a computer startup or shutdown script, the domain of the computer is used. +If you do not specify the **Domain** parameter, the domain of the user that is running the current +session is used. +If the cmdlet is being run from a computer startup or shutdown script, the domain of the computer +is used. For more information, see the Notes section in the full Help. -If you specify a domain that is different from the domain of the user that is running the current session (or, for a startup or shutdown script, the computer), a trust must exist between that domain and the domain of the user or the computer. +If you specify a domain that is different from the domain of the user that is running the current +session (or, for a startup or shutdown script, the computer), a trust must exist between that +domain and the domain of the user or the computer. -You can also refer to the *Domain* parameter by its built-in alias, domainname. -For more information, see about_Aliases. +You can also refer to the **Domain** parameter by its built-in alias, **domainname.** +For more information, see **about_Aliases.** ```yaml Type: String @@ -151,10 +175,11 @@ Accept wildcard characters: False ``` ### -Guid + Specifies the GPO to retrieve by its globally unique identifier (GUID). The GUID uniquely identifies the GPO. -You can also refer to the *Guid* parameter by its built-in alias, id. +You can also refer to the **Guid** parameter by its built-in alias, **id.** ```yaml Type: Guid @@ -169,13 +194,14 @@ Accept wildcard characters: False ``` ### -Name + Specifies the GPO to retrieve by its display name. The display name is not guaranteed to be unique in the domain. If another GPO with the same display name exists in the domain an error occurs. You can use the Guid parameter to uniquely identify a GPO. -You can also refer to the *Name* parameter by its built-in alias, displayname. +You can also refer to the **Name** parameter by its built-in alias, **displayname.** ```yaml Type: String @@ -190,12 +216,14 @@ Accept wildcard characters: False ``` ### -Server + Specifies the name of the domain controller that this cmdlet contacts to complete the operation. You can specify either the fully qualified domain name (FQDN) or the host name. -If you do not specify the name by using the Server parameter, the primary domain controller (PDC) emulator is contacted. +If you do not specify the name by using the Server parameter, the primary domain controller (PDC) +emulator is contacted. -You can also refer to the Server parameter by its built-in alias, dc. +You can also refer to the **Server** parameter by its built-in alias, **dc.** ```yaml Type: String @@ -210,11 +238,16 @@ Accept wildcard characters: False ``` ### CommonParameters -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). + +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). ## INPUTS ### Microsoft.GroupPolicy.Gpo + You can pipe a GPO for which to get information to this cmdlet. You can pipe GPO objects into this cmdlet to display information about the GPOs. Collections that contain GPOs from different domains are not supported. @@ -222,24 +255,30 @@ Collections that contain GPOs from different domains are not supported. ## OUTPUTS ### Microsoft.GroupPolicy.Gpo + This cmdlet returns an object that represents the requested GPO. ## NOTES -* You can use the *Domain* parameter to explicitly specify the domain for this cmdlet. - - If you do not explicitly specify the domain, the cmdlet uses a default domain. -The default domain is the domain that is used to access network resources by the security context under which the current session is running. -This domain is typically the domain of the user that is running the session. -For example, the domain of the user who started the session by opening Windows PowerShell from the Program Files menu, or the domain of a user that is specified in a runas command. -However, computer startup and shutdown scripts run under the context of the LocalSystem account. -The LocalSystem account is a built-in local account, and it accesses network resources under the context of the computer account. -Therefore, when this cmdlet is run from a startup or shutdown script, the default domain is the domain to which the computer is joined. - - Only one domain can be used by an instance of this cmdlet. -If you pipe a collection of GPO (Microsoft.GroupPolicy.Gpo) objects to this cmdlet, the DomainName property of the first GPO object in the collection specifies the domain for the cmdlet. -This is because domainname is a built-in alias for the *Domain* parameter, and the *Domain* parameter can take its value by property name from the pipeline. -A non-terminating error occurs for any GPOs in the collection that are not in this domain. -If this domain is different from the domain of the user account (for startup or shutdown scripts, the computer account), a trust must exist between the two domains. + +- You can use the **Domain** parameter to explicitly specify the domain for this cmdlet. + + If you do not explicitly specify the domain, the cmdlet uses a default domain. The default domain + is the domain that is used to access network resources by the security context under which the + current session is running. This domain is typically the domain of the user that is running the + session. For example, the domain of the user who started the session by opening Windows PowerShell + from the Program Files menu, or the domain of a user that is specified in a runas command. + However, computer startup and shutdown scripts run under the context of the LocalSystem account. + The LocalSystem account is a built-in local account, and it accesses network resources under the + context of the computer account. Therefore, when this cmdlet is run from a startup or shutdown + script, the default domain is the domain to which the computer is joined. + + Only one domain can be used by an instance of this cmdlet. If you pipe a collection of GPO + (Microsoft.GroupPolicy.Gpo) objects to this cmdlet, the DomainName property of the first GPO + object in the collection specifies the domain for the cmdlet. This is because **domainname** is a + built-in alias for the **Domain** parameter, and the **Domain** parameter can take its value by + property name from the pipeline. A non-terminating error occurs for any GPOs in the collection + that are not in this domain. If this domain is different from the domain of the user account (for + startup or shutdown scripts, the computer account), a trust must exist between the two domains. ## RELATED LINKS From 913ad4c92ce87c128ada55a8c1b84fd62809ea11 Mon Sep 17 00:00:00 2001 From: 53883 Date: Fri, 28 Apr 2023 01:11:14 +0200 Subject: [PATCH 178/650] typenames --- .../ServerManager/Get-WindowsFeature.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docset/winserver2022-ps/ServerManager/Get-WindowsFeature.md b/docset/winserver2022-ps/ServerManager/Get-WindowsFeature.md index 6aa9c5af6a..1a47056053 100644 --- a/docset/winserver2022-ps/ServerManager/Get-WindowsFeature.md +++ b/docset/winserver2022-ps/ServerManager/Get-WindowsFeature.md @@ -97,7 +97,7 @@ Computer to the Trusted Host List" in [about_Remote_Troubleshooting](https://go.microsoft.com/fwlink/p/?LinkID=135188). ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: Cn @@ -120,12 +120,12 @@ Quotation marks are optional. -- "Domain\User" -- "User@Domain.com" -- A Credential object returned by the - [Get-Credential](https://go.microsoft.com/fwlink/p/?LinkID=113311) cmdlet. + [Get-Credential](https://go.microsoft.com/fwlink/p/?LinkID=113311) cmdlet. If a user name is entered, then a prompt for a password is displayed. ```yaml -Type: PSCredential +Type: System.Management.Automation.PSCredential Parameter Sets: (All) Aliases: @@ -142,7 +142,7 @@ Specifies a name and path to a log file. Add this parameter if the results of this cmdlet must be stored in a log. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -158,7 +158,7 @@ Accept wildcard characters: False Specifies the command IDs of roles, role services, or features about which to return information. ```yaml -Type: String[] +Type: System.String[] Parameter Sets: (All) Aliases: @@ -191,7 +191,7 @@ Any local path, such as D:\myFolder, that is specified by using this parameter i the target computer. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: From 5eea27043019992c9d744539b7379caf945ff692 Mon Sep 17 00:00:00 2001 From: Rob Derickson Date: Thu, 27 Apr 2023 18:31:49 -0400 Subject: [PATCH 179/650] Resolved formatting issues to comply with PowerShell-Docs style guide. --- .../Add-CertificateEnrollmentPolicyServer.md | 126 ++++++++++++------ 1 file changed, 83 insertions(+), 43 deletions(-) diff --git a/docset/winserver2022-ps/pki/Add-CertificateEnrollmentPolicyServer.md b/docset/winserver2022-ps/pki/Add-CertificateEnrollmentPolicyServer.md index fc8b19a27d..e39c378093 100644 --- a/docset/winserver2022-ps/pki/Add-CertificateEnrollmentPolicyServer.md +++ b/docset/winserver2022-ps/pki/Add-CertificateEnrollmentPolicyServer.md @@ -11,83 +11,109 @@ title: Add-CertificateEnrollmentPolicyServer # Add-CertificateEnrollmentPolicyServer ## SYNOPSIS + Adds an enrollment policy server to the current user or local system configuration. ## SYNTAX ``` Add-CertificateEnrollmentPolicyServer [-NoClobber] -Url [-RequireStrongValidation] - [-Credential ] -context [-AutoEnrollmentEnabled] [-WhatIf] [-Confirm] - [] + [-Credential ] -context [-AutoEnrollmentEnabled] [-WhatIf] + [-Confirm] [] ``` ## DESCRIPTION -The **Add-CertificateEnrollmentPolicyServer** cmdlet adds an enrollment policy server to the current user or local system configuration. -If an enrollment policy server already exists, then this cmdlet will overwrite it. -Group Policy can be configured to prevent enrollment policy servers from being added. -Delegation may be required when using this cmdlet with Windows PowerShell® remoting and changing user configuration. +The `Add-CertificateEnrollmentPolicyServer` cmdlet adds an enrollment policy server to the current +user or local system configuration. If an enrollment policy server already exists, then this cmdlet +will overwrite it. Group Policy can be configured to prevent enrollment policy servers from being +added. + +Delegation may be required when using this cmdlet with Windows PowerShell remoting and changing +user configuration. ## EXAMPLES ### EXAMPLE 1 -``` -PS C:\>Add-CertificateEnrollmentPolicyServer -Url $url -Context Machine + +```powershell +Add-CertificateEnrollmentPolicyServer -Url $url -Context Machine ``` -This example loads a policy from $url using Windows integrated authentication under the computer context, using the computer account credentials. -This example also adds the policy server to the local computer configuration. -Auto enrollment is off and strong validation is off. +This example loads a policy from `$url` using Windows integrated authentication under the computer +context, using the computer account credentials. This example also adds the policy server to the +local computer configuration. Auto enrollment is off and strong validation is off. ### EXAMPLE 2 -``` -PS C:\>$cert = Get-ChildItem -Path cert:\LocalMachine\My\EEDEF61D4FF6EDBAAD538BB08CCAADDC3EE28FF -PS C:\>Add-CertificateEnrollmentPolicyServer -Url $cert.EnrollmentPolicyEndPoint.Url -Credential $cert -Context Machine +```powershell +$cert = Get-ChildItem -Path cert:\LocalMachine\My\EEDEF61D4FF6EDBAAD538BB08CCAADDC3EE28FF + +$parameters = @{ + Url = $cert.EnrollmentPolicyEndPoint.Url + Credential = $cert + Context = 'Machine' +} +Add-CertificateEnrollmentPolicyServer @parameters ``` -This example loads a policy using $cert as the authentication credential and adds the policy to the local computer local configuration since the context is the local computer (Machine). +This example loads a policy using `$cert` as the authentication credential and adds the policy to +the local computer local configuration since the context is the local computer (Machine). ### EXAMPLE 3 -``` -PS C:\>$up = Get-Credential -PS C:\>Add-CertificateEnrollmentPolicyServer -Url $url -Context Machine -Credential $up +```powershell +$up = Get-Credential + +Add-CertificateEnrollmentPolicyServer -Url $url -Context Machine -Credential $up ``` -This example loads a policy using the username and password from $url. +This example loads a policy using the username and password from `$url`. This example adds the policy server to the local computer configuration. ### EXAMPLE 4 -``` -PS C:\>$cert = Get-ChildItem -Path cert:\CurrentUser\My\EEDEF61D4FF6EDBAAD538BB08CCAADDC3EE28FF -PS C:\>Add-CertificateEnrollmentPolicyServer -Url $cert.EnrollmentPolicyEndPoint.Url -Credential $cert.PSPath -Context Machine +```powershell +$cert = Get-ChildItem -Path cert:\CurrentUser\My\EEDEF61D4FF6EDBAAD538BB08CCAADDC3EE28FF + +$parameters = @{ + Url = $cert.EnrollmentPolicyEnd + Credential = $cert.PSPath + Context = 'Machine' +} +Add-CertificateEnrollmentPolicyServer @parameters ``` -This example loads policy using the Path object for a certificate. -Use the certificate to authenticate to the URL and add the policy server into the local user configuration. +This example loads policy using the Path object for a certificate. Use the certificate to +authenticate to the URL and add the policy server into the local user configuration. ### EXAMPLE 5 + +```powershell +$up = Get-Credential + +Add-CertificateEnrollmentPolicyServer -Url $url -Context User -Credential $up -WhatIf ``` -PS C:\>$up = Get-Credential -PS C:\>Add-CertificateEnrollmentPolicyServer -Url $url -Context User -Credential $up -WhatIf +```Output What if: Policy successfully loaded from {$url} using username/password credentials. Policy server configuration will be added to current user context. ``` -This example shows that if the policy cannot be loaded or if there is a conflict with an identifier (ID) or URL, then this will be the output. +This example shows that if the policy cannot be loaded or if there is a conflict with an identifier +(ID) or URL, then this will be the output. -If the policy server already exists, then the output will state that the existing policy server configuration will be overwritten. +If the policy server already exists, then the output will state that the existing policy server +configuration will be overwritten. ## PARAMETERS ### -AutoEnrollmentEnabled + Enables auto-enrollment for the policy server being added. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -99,10 +125,11 @@ Accept wildcard characters: False ``` ### -Confirm + Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf @@ -114,12 +141,13 @@ Accept wildcard characters: False ``` ### -Credential -Specifies the credential used to authenticate to the policy server. -This credential can be a **PSCredential** object, which is a username and password, an x509 certificate, or a path to an x509 certificate. -Kerberos authentication is used if no credential is specified. + +Specifies the credential used to authenticate to the policy server. This credential can be a +**PSCredential** object, which is a username and password, an x509 certificate, or a path to an x509 +certificate. Kerberos authentication is used if no credential is specified. ```yaml -Type: PkiCredential +Type: Microsoft.CertificateServices.Commands.PkiCredential Parameter Sets: (All) Aliases: @@ -131,10 +159,11 @@ Accept wildcard characters: False ``` ### -NoClobber + Prevents an enrollment policy server from overwriting an existing one. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -146,10 +175,12 @@ Accept wildcard characters: False ``` ### -RequireStrongValidation -Specifies that the certificate obtained through this enrollment policy server must be trusted on the client. + +Specifies that the certificate obtained through this enrollment policy server must be trusted on the +client. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -161,10 +192,11 @@ Accept wildcard characters: False ``` ### -Url + Identifies the uniform resource locator (URL) of the enrollment policy server to configure. ```yaml -Type: Uri +Type: System.Uri Parameter Sets: (All) Aliases: @@ -176,6 +208,7 @@ Accept wildcard characters: False ``` ### -WhatIf + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -191,11 +224,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -context -Stores information about the policy server in the configuration for the Current User or Local computer. +### -Context + +Stores information about the policy server in the configuration for the Current User or Local +computer. ```yaml -Type: Context +Type: Microsoft.CertificateServices.Commands.Context Parameter Sets: (All) Aliases: Accepted values: Machine, User @@ -208,16 +243,22 @@ Accept wildcard characters: False ``` ### CommonParameters -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). + +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). ## INPUTS ### Microsoft.CertificateServices.Commands.EnrollmentPolicyServer + The **EnrollmentPolicyServer** object contains information about the certificate enrollment policy. ## OUTPUTS ### Microsoft.CertificateServices.Commands.EnrollmentPolicyServer + The **EnrollmentPolicyServer** object contains information about the certificate enrollment policy. ## NOTES @@ -231,4 +272,3 @@ The **EnrollmentPolicyServer** object contains information about the certificate [Get-CertificateEnrollmentPolicyServer](./Get-CertificateEnrollmentPolicyServer.md) [Remove-CertificateEnrollmentPolicyServer](./Remove-CertificateEnrollmentPolicyServer.md) - From 665042742385d26c34a89fde35007f9e512a39bd Mon Sep 17 00:00:00 2001 From: thepowerstring Date: Thu, 27 Apr 2023 16:13:58 -0700 Subject: [PATCH 180/650] Update Set-ADUser.md Updated set-aduser help --- .../activedirectory/Set-ADUser.md | 387 ++++++++++++------ 1 file changed, 252 insertions(+), 135 deletions(-) diff --git a/docset/winserver2022-ps/activedirectory/Set-ADUser.md b/docset/winserver2022-ps/activedirectory/Set-ADUser.md index 42e7f3940e..3e75667534 100644 --- a/docset/winserver2022-ps/activedirectory/Set-ADUser.md +++ b/docset/winserver2022-ps/activedirectory/Set-ADUser.md @@ -11,11 +11,13 @@ title: Set-ADUser # Set-ADUser ## SYNOPSIS + Modifies an Active Directory user. ## SYNTAX ### Identity + ``` Set-ADUser [-WhatIf] [-Confirm] [-AccountExpirationDate ] [-AccountNotDelegated ] [-Add ] [-AllowReversiblePasswordEncryption ] @@ -38,12 +40,14 @@ Set-ADUser [-WhatIf] [-Confirm] [-AccountExpirationDate ] [-AccountNot ``` ### Instance + ``` Set-ADUser [-WhatIf] [-Confirm] [-AuthType ] [-Credential ] -Instance [-PassThru] [-SamAccountName ] [-Server ] [] ``` ## DESCRIPTION + The **Set-ADUser** cmdlet modifies the properties of an Active Directory user. You can modify commonly used property values by using the cmdlet parameters. You can set property values that are not associated with cmdlet parameters by using the *Add*, *Remove*, *Replace*, and *Clear* parameters. @@ -70,6 +74,7 @@ To specify a default naming context for an AD LDS environment, set the **msDS-de ## EXAMPLES ### Example 1: Set properties for a user + ```powershell PS C:\> Set-ADUser -Identity ChewDavid -HomePage 'http://fabrikam.com/employees/ChewDavid' -LogonWorkstations 'ChewDavid-DSKTOP,ChewDavid-LPTOP' ``` @@ -77,6 +82,7 @@ PS C:\> Set-ADUser -Identity ChewDavid -HomePage 'http://fabrikam.com/employees/ This command sets the specified user's **homepage** property to http://fabrikam.com/employees/ChewDavid and the **LogonWorkstations** property to ChewDavid-DSKTOP,ChewDavid-LPTOP. ### Example 2: Set properties for multiple users + ```powershell PS C:\> Get-ADUser -Filter 'Name -like "*"' -SearchBase 'OU=HumanResources,OU=UserAccounts,DC=FABRIKAM,DC=COM' -Properties DisplayName | % {Set-ADUser $_ -DisplayName ($_.Surname + ' ' + $_.GivenName)} ``` @@ -85,6 +91,7 @@ This command gets all the users in the directory that are located in the OU=Huma The command sets the **DisplayName** property on these user objects to the concatenation of the **Surname** property and the **GivenName** property. ### Example 3: Set properties + ```powershell PS C:\> Set-ADUser -Identity GlenJohn -Replace @{title="director";mail="glenjohn@fabrikam.com"} ``` @@ -92,6 +99,7 @@ PS C:\> Set-ADUser -Identity GlenJohn -Replace @{title="director";mail="glenjohn This command sets the specified user's **title** property to director and the **mail** property to glenjohn@fabrikam.com. ### Example 4: Modify a user otherMailbox property + ```powershell PS C:\> Set-ADUser -Identity GlenJohn -Remove @{otherMailbox="glen.john"} -Add @{url="fabrikam.com"} -Replace @{title="manager"} -Clear description ``` @@ -99,6 +107,7 @@ PS C:\> Set-ADUser -Identity GlenJohn -Remove @{otherMailbox="glen.john"} -Add @ This command modifies the user with the SAM account name GlenJohn's object by removing glen.john from the **otherMailbox** property, adding fabrikam.com to the **url** property, replacing the **title** property with manager, and clearing the **description** property. ### Example 5: Set user properties to a local instance + ```powershell PS C:\> $User = Get-ADUser -Identity GlenJohn -Properties mail,department PS C:\> $User.mail = "glen@fabrikam.com" @@ -109,6 +118,7 @@ PS C:\> Set-ADUser -Instance $User This example sets the **mail** and **department** properties on the user object with the SAM account name GlenJohn by using the *Instance* parameter. ### Example 6: Set attributes for a user + ```powershell PS C:\> $Hours = New-Object byte[] 21 PS C:\> $Hours[5] = 255; $Hours[8] = 255; $Hours[11] = 255; $Hours[14] = 255; $Hours[17] = 255; @@ -123,6 +133,7 @@ This example sets the user logon hours to Monday through Friday from 8:00 AM to It updates the **logonHours** attribute with the specified byte array and the **description** attribute with the specified string. ### Example 7: Set a property for a user + ```powershell PS C:\> $Manager = Get-ADUser -Identity GlenJohn -Server Corp-DC01 PS C:\> Set-ADUser -Identity ChewDavid -Manager $Manager -Server Branch-DC02 @@ -131,6 +142,7 @@ PS C:\> Set-ADUser -Identity ChewDavid -Manager $Manager -Server Branch-DC02 This example sets the **Manager** property for the user with the SAM account name of ChewDavid where the manager, GlenJohn, is a user in another domain. ### Example 8: Get a user and set a property + ```powershell PS C:\> Get-ADUser -Identity "DavidChew" | Set-ADUser -Manager "ElisaDaugherty" ``` @@ -141,6 +153,7 @@ The command uses the **Get-ADUser** cmdlet to get the user DavidChew, and then p ## PARAMETERS ### -AccountExpirationDate + Specifies the expiration date for an account. This parameter sets the AccountExpirationDate property of an account object. The LDAP display name (ldapDisplayName) for this property is accountExpires. @@ -163,6 +176,7 @@ Accept wildcard characters: False ``` ### -AccountNotDelegated + Indicates whether the security context of the user is delegated to a service. When this parameter is set to $True, the security context of the account is not delegated to a service even when the service account is set as trusted for Kerberos delegation. This parameter sets the **AccountNotDelegated** property for an Active Directory account. @@ -185,11 +199,13 @@ Accept wildcard characters: False ``` ### -Add -Specifies values to add to an object property. -Use this parameter to add one or more values to a property that cannot be modified using a cmdlet parameter. -To modify an object property, you must use the LDAP display name. -You can specify multiple values to a property by specifying a comma-separated list of values, and more than one property by separating them using a semicolon. If any of the properties have a null or empty value the cmdlet will return an error. -The format for this parameter is: + +Specifies values to add to an object property. Use this parameter to add one or more values to a +property that cannot be modified using a cmdlet parameter. To modify an object property, you must +use the LDAP display name. You can specify multiple values to a property by specifying a +comma-separated list of values, and more than one property by separating them using a semicolon. If +any of the properties have a null or empty value the cmdlet will return an error. The format for +this parameter is: `-Add @{Attribute1LDAPDisplayName=value1, value2, ...; Attribute2LDAPDisplayName=value1, value2, ...; AttributeNLDAPDisplayName=value1, value2, ...}` @@ -213,10 +229,11 @@ Accept wildcard characters: False ``` ### -AllowReversiblePasswordEncryption -Indicates whether reversible password encryption is allowed for the account. -This parameter sets the **AllowReversiblePasswordEncryption** property of the account. -This parameter also sets the **ADS_UF_ENCRYPTED_TEXT_PASSWORD_ALLOWED** flag of the Active Directory User Account Control (UAC) attribute. -The acceptable values for this parameter are: + +Indicates whether reversible password encryption is allowed for the account. This parameter sets the +**AllowReversiblePasswordEncryption** property of the account. This parameter also sets the +**ADS_UF_ENCRYPTED_TEXT_PASSWORD_ALLOWED** flag of the Active Directory User Account Control (UAC) +attribute. The acceptable values for this parameter are: - $False or 0 - $True or 1 @@ -234,14 +251,16 @@ Accept wildcard characters: False ``` ### -AuthenticationPolicy + Specifies an Active Directory Domain Services authentication policy object. -Specify the authentication policy object in one of the following formats: +Specify the authentication policy object in one of the following formats: - Distinguished name - GUID - Name -This parameter can also get this object through the pipeline or you can set this parameter to an object instance. +This parameter can also get this object through the pipeline or you can set this parameter to an +object instance. The cmdlet searches the default naming context or partition to find the object. If the cmdlet finds two or more objects, the cmdlet returns a non-terminating error. @@ -259,14 +278,16 @@ Accept wildcard characters: False ``` ### -AuthenticationPolicySilo + Specifies an Active Directory Domain Services authentication policy silo object. -Specify the authentication policy silo object in one of the following formats: +Specify the authentication policy silo object in one of the following formats: - Distinguished name - GUID - Name -This parameter can also get this object through the pipeline or you can set this parameter to an object instance. +This parameter can also get this object through the pipeline or you can set this parameter to an +object instance. The cmdlet searches the default naming context or partition to find the object. If the cmdlet finds two or more objects, the cmdlet returns a non-terminating error. @@ -284,6 +305,7 @@ Accept wildcard characters: False ``` ### -AuthType + Specifies the authentication method to use. The acceptable values for this parameter are: @@ -308,6 +330,7 @@ Accept wildcard characters: False ``` ### -CannotChangePassword + Indicates whether the account password can be changed. This parameter sets the **CannotChangePassword** property of an account. The acceptable values for this parameter are: @@ -328,11 +351,12 @@ Accept wildcard characters: False ``` ### -Certificates -Specifies an array of certificates. -The cmdlet modifies the DER-encoded X.509v3 certificates of the account. -These certificates include the public key certificates issued to this account by the Microsoft Certificate Service. -This parameter sets the **Certificates** property of the account object. -The Lightweight Directory Access Protocol (LDAP) display name (**ldapDisplayName**) for this property is userCertificate. + +Specifies an array of certificates. The cmdlet modifies the DER-encoded X.509v3 certificates of the +account. These certificates include the public key certificates issued to this account by the +Microsoft Certificate Service. This parameter sets the **Certificates** property of the account +object. The Lightweight Directory Access Protocol (LDAP) display name (**ldapDisplayName**) for this +property is userCertificate. To add values: @@ -355,7 +379,7 @@ For example, use the following syntax to add and remove **Certificates** values: `-Certificates @{Add=value1;Remove=value3}` -The operators are applied in the following sequence: +The operators are applied in the following sequence: - Remove - Add @@ -374,7 +398,8 @@ Accept wildcard characters: False ``` ### -ChangePasswordAtLogon -Indicates whether a password must be changed during the next logon attempt. + +Indicates whether a password must be changed during the next logon attempt. The acceptable values for this parameter are: - $False or 0 @@ -393,6 +418,7 @@ Accept wildcard characters: False ``` ### -City + Specifies the user's town or city. This parameter sets the **City** property of a user object. The LDAP display name (**ldapDisplayName**) of this property is l. @@ -410,15 +436,16 @@ Accept wildcard characters: False ``` ### -Clear -Specifies an array of object properties that are cleared in the directory. -Use this parameter to clear one or more values of a property that cannot be modified using a cmdlet parameter. -To modify an object property, you must use the LDAP display name. -You can modify more than one property by specifying a comma-separated list. -The format for this parameter is: + +Specifies an array of object properties that are cleared in the directory. Use this parameter to +clear one or more values of a property that cannot be modified using a cmdlet parameter. To modify +an object property, you must use the LDAP display name. You can modify more than one property by +specifying a comma-separated list. The format for this parameter is: `-Clear Attribute1LDAPDisplayName, Attribute2LDAPDisplayName` -When you use the *Add*, *Remove*, *Replace*, and *Clear* parameters together, the operations are performed in the following order: +When you use the *Add*, *Remove*, *Replace*, and *Clear* parameters together, the operations are +performed in the following order: - **Remove** - **Add** @@ -438,6 +465,7 @@ Accept wildcard characters: False ``` ### -Company + Specifies the user's company. This parameter sets the **Company** property of a user object. The LDAP display name (**ldapDisplayName**) of this property is company. @@ -455,15 +483,18 @@ Accept wildcard characters: False ``` ### -CompoundIdentitySupported -Indicates whether an account supports Kerberos service tickets which includes the authorization data for the user's device. -This value sets the compound identity supported flag of the Active Directory **msDS-SupportedEncryptionTypes** attribute. -The acceptable values for this parameter are: + +Indicates whether an account supports Kerberos service tickets which includes the authorization data +for the user's device. This value sets the compound identity supported flag of the Active Directory +**msDS-SupportedEncryptionTypes** attribute. The acceptable values for this parameter are: - $False or 0 - $True or 1 -Warning: Domain-joined Windows systems and services such as clustering manage their own **msDS-SupportedEncryptionTypes** attribute. -Therefore any changes to the flag on the **msDS-SupportedEncryptionTypes** attribute are overwritten by the service or system that manages the setting. +Warning: Domain-joined Windows systems and services such as clustering manage their own +**msDS-SupportedEncryptionTypes** attribute. Therefore any changes to the flag on the +**msDS-SupportedEncryptionTypes** attribute are overwritten by the service or system that manages +the setting. ```yaml Type: Boolean @@ -478,6 +509,7 @@ Accept wildcard characters: False ``` ### -Confirm + Prompts you for confirmation before running the cmdlet. ```yaml @@ -493,6 +525,7 @@ Accept wildcard characters: False ``` ### -Country + Specifies the country or region code for the user's language of choice. This parameter sets the **Country** property of a user object. The LDAP display name (**ldapDisplayName**) of this property is c. @@ -511,17 +544,20 @@ Accept wildcard characters: False ``` ### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. + +Specifies the user account credentials to use to perform this task. The default credentials are the +credentials of the currently logged on user unless the cmdlet is run from an Active Directory +PowerShell provider drive. If the cmdlet is run from such a provider drive, the account associated +with the drive is the default. To specify this parameter, you can type a user name, such as `User1` or `Domain01\User01` or you can specify a **PSCredential** object. If you specify a user name for this parameter, the cmdlet prompts for a password. -You can also create a **PSCredential** object by using a script or by using the Get-Credential cmdlet. -You can then set the *Credential* parameter to the **PSCredential** object. +You can also create a **PSCredential** object by using a script or by using the Get-Credential +cmdlet. You can then set the _Credential_ parameter to the **PSCredential** object. -If the acting credentials do not have directory-level permission to perform the task, Active Directory PowerShell returns a terminating error. +If the acting credentials do not have directory-level permission to perform the task, Active +Directory PowerShell returns a terminating error. ```yaml Type: PSCredential @@ -536,6 +572,7 @@ Accept wildcard characters: False ``` ### -Department + Specifies the user's department. This parameter sets the **Department** property of a user object. The LDAP display name (**ldapDisplayName**) of this property is department. @@ -553,6 +590,7 @@ Accept wildcard characters: False ``` ### -Description + Specifies a description of the object. This parameter sets the value of the **Description** property for the user object. The LDAP display name (**ldapDisplayName**) for this property is description. @@ -570,6 +608,7 @@ Accept wildcard characters: False ``` ### -DisplayName + Specifies the display name of the object. This parameter sets the **DisplayName** property of the user object. The LDAP display name (**ldapDisplayName**) for this property is displayName. @@ -587,6 +626,7 @@ Accept wildcard characters: False ``` ### -Division + Specifies the user's division. This parameter sets the **Division** property of a user object. The LDAP display name (**ldapDisplayName**) of this property is division. @@ -604,6 +644,7 @@ Accept wildcard characters: False ``` ### -EmailAddress + Specifies the user's e-mail address. This parameter sets the **EmailAddress** property of a user object. The LDAP display name (**ldapDisplayName**) of this property is mail. @@ -621,6 +662,7 @@ Accept wildcard characters: False ``` ### -EmployeeID + Specifies the user's employee ID. This parameter sets the **EmployeeID** property of a user object. The LDAP display name (**ldapDisplayName**) of this property is employeeID. @@ -638,6 +680,7 @@ Accept wildcard characters: False ``` ### -EmployeeNumber + Specifies the user's employee number. This parameter sets the **EmployeeNumber** property of a user object. The LDAP display name (**ldapDisplayName**) of this property is employeeNumber. @@ -655,11 +698,11 @@ Accept wildcard characters: False ``` ### -Enabled -Indicates whether an account is enabled. -An enabled account requires a password. -This parameter sets the **Enabled** property for an account object. -This parameter also sets the **ADS_UF_ACCOUNTDISABLE** flag of the Active Directory User Account Control (UAC) attribute. -The acceptable values for this parameter are: + +Indicates whether an account is enabled. An enabled account requires a password. This parameter sets +the **Enabled** property for an account object. This parameter also sets the +**ADS_UF_ACCOUNTDISABLE** flag of the Active Directory User Account Control (UAC) attribute. The +acceptable values for this parameter are: - $False or 0 - $True or 1 @@ -677,6 +720,7 @@ Accept wildcard characters: False ``` ### -Fax + Specifies the user's fax phone number. This parameter sets the **Fax** property of a user object. The LDAP display name (**ldapDisplayName**) of this property is facsimileTelephoneNumber. @@ -694,6 +738,7 @@ Accept wildcard characters: False ``` ### -GivenName + Specifies the user's given name. This parameter sets the **GivenName** property of a user object. The LDAP display name (**ldapDisplayName**) of this property is givenName. @@ -711,6 +756,7 @@ Accept wildcard characters: False ``` ### -HomeDirectory + Specifies a user's home directory. This parameter sets the **HomeDirectory** property of a user object. The LDAP display name (**ldapDisplayName**) for this property is homeDirectory. @@ -728,11 +774,12 @@ Accept wildcard characters: False ``` ### -HomeDrive + Specifies a drive that is associated with the UNC path defined by the **HomeDirectory** property. -The drive letter is specified as ``: where `` indicates the letter of the drive to associate. -The `` must be a single, uppercase letter and the colon is required. -This parameter sets the **HomeDrive** property of the user object. -The LDAP display name (**ldapDisplayName**) for this property is homeDrive. +The drive letter is specified as ``: where `` indicates the letter of the +drive to associate. The `` must be a single, uppercase letter and the colon is +required. This parameter sets the **HomeDrive** property of the user object. The LDAP display name +(**ldapDisplayName**) for this property is homeDrive. ```yaml Type: String @@ -747,6 +794,7 @@ Accept wildcard characters: False ``` ### -HomePage + Specifies the URL of the home page of the object. This parameter sets the **homePage** property of an Active Directory object. The LDAP display name (**ldapDisplayName**) for this property is wWWHomePage. @@ -764,6 +812,7 @@ Accept wildcard characters: False ``` ### -HomePhone + Specifies the user's home telephone number. This parameter sets the **HomePhone** property of a user. The LDAP display name (**ldapDisplayName**) of this property is homePhone. @@ -781,19 +830,21 @@ Accept wildcard characters: False ``` ### -Identity + Specifies an Active Directory user object by providing one of the following property values. The identifier in parentheses is the LDAP display name for the attribute. The acceptable values for this parameter are: - A distinguished name -- A GUID (objectGUID) -- A security identifier (objectSid) +- A GUID (objectGUID) +- A security identifier (objectSid) - A SAM account name (sAMAccountName) The cmdlet searches the default naming context or partition to find the object. If two or more objects are found, the cmdlet returns a non-terminating error. -This parameter can also get this object through the pipeline or you can set this parameter to an object instance. +This parameter can also get this object through the pipeline or you can set this parameter to an +object instance. ```yaml Type: ADUser @@ -808,6 +859,7 @@ Accept wildcard characters: False ``` ### -Initials + Specifies the initials that represent part of a user's name. You can use this value for the user's middle initial. This parameter sets the **Initials** property of a user. @@ -826,12 +878,15 @@ Accept wildcard characters: False ``` ### -Instance -Specifies an **ADUser** object that identifies the Active Directory user object that should be modified and the set of changes that should be made to that object. -When this parameter is specified, any modifications made to the **ADUser** object are also made to the corresponding Active Directory object. -The cmdlet only updates the object properties that have changed. -The **ADUser** object specified as the value of the *Instance* parameter must have been retrieved by using the **Get-ADUser** cmdlet. -When you specify the *Instance* parameter, you cannot specify other parameters that set individual properties on the object. +Specifies an **ADUser** object that identifies the Active Directory user object that should be +modified and the set of changes that should be made to that object. When this parameter is +specified, any modifications made to the **ADUser** object are also made to the corresponding Active +Directory object. The cmdlet only updates the object properties that have changed. + +The **ADUser** object specified as the value of the _Instance_ parameter must have been retrieved by +using the **Get-ADUser** cmdlet. When you specify the _Instance_ parameter, you cannot specify other +parameters that set individual properties on the object. ```yaml Type: ADUser @@ -846,9 +901,10 @@ Accept wildcard characters: False ``` ### -KerberosEncryptionType -Specifies whether an account supports Kerberos encryption types which are used during creation of service tickets. -This value sets the encryption types supported flags of the Active Directory **msDS-SupportedEncryptionTypes** attribute. -The acceptable values for this parameter are: + +Specifies whether an account supports Kerberos encryption types which are used during creation of +service tickets. This value sets the encryption types supported flags of the Active Directory +**msDS-SupportedEncryptionTypes** attribute. The acceptable values for this parameter are: - None - DES @@ -856,12 +912,16 @@ The acceptable values for this parameter are: - AES128 - AES256 -None removes all encryption types from the account, resulting in the KDC being unable to issue service tickets for services using the account. +None removes all encryption types from the account, resulting in the KDC being unable to issue +service tickets for services using the account. -DES is a weak encryption type that is not supported by default since Windows 7 and Windows Server 2008 R2. +DES is a weak encryption type that is not supported by default since Windows 7 and Windows Server +2008 R2. -Warning: Domain-joined Windows systems and services such as clustering manage their own **msDS-SupportedEncryptionTypes** attribute. -Therefore any changes to the flag on the **msDS-SupportedEncryptionTypes** attribute are overwritten by the service or system that manages the setting. +Warning: Domain-joined Windows systems and services such as clustering manage their own +**msDS-SupportedEncryptionTypes** attribute. Therefore any changes to the flag on the +**msDS-SupportedEncryptionTypes** attribute are overwritten by the service or system that manages +the setting. ```yaml Type: ADKerberosEncryptionType @@ -877,10 +937,11 @@ Accept wildcard characters: False ``` ### -LogonWorkstations -Specifies the computers that the user can access. -To specify more than one computer, create a single comma-separated list. -You can identify a computer by using the Security Account Manager (SAM) account name (sAMAccountName) or the DNS host name of the computer. -The SAM account name is the same as the NetBIOS name of the computer. + +Specifies the computers that the user can access. To specify more than one computer, create a single +comma-separated list. You can identify a computer by using the Security Account Manager (SAM) +account name (sAMAccountName) or the DNS host name of the computer. The SAM account name is the same +as the NetBIOS name of the computer. The LDAP display name (**ldapDisplayName**) for this property is userWorkStations. @@ -897,6 +958,7 @@ Accept wildcard characters: False ``` ### -Manager + Specifies the user's manager. This parameter sets the **Manager** property of a user object. This parameter is set by providing one of the following property values. @@ -904,8 +966,8 @@ Note: The identifier in parentheses is the LDAP display name for the property. The acceptable values for this parameter are: - A distinguished name -- A GUID (objectGUID) -- A security identifier (objectSid) +- A GUID (objectGUID) +- A security identifier (objectSid) - A SAM account name (sAMAccountName) The LDAP display name (**ldapDisplayName**) of this property is manager. @@ -923,6 +985,7 @@ Accept wildcard characters: False ``` ### -MobilePhone + Specifies the user's mobile phone number. This parameter sets the **MobilePhone** property of a user object. The LDAP display name (**ldapDisplayName**) of this property is mobile. @@ -940,6 +1003,7 @@ Accept wildcard characters: False ``` ### -Office + Specifies the location of the user's office or place of business. This parameter sets the **Office** property of a user object. The LDAP display name (**ldapDisplayName**) of this property is physicalDeliveryOfficeName. @@ -957,6 +1021,7 @@ Accept wildcard characters: False ``` ### -OfficePhone + Specifies the user's office telephone number. This parameter sets the **OfficePhone** property of a user object. The LDAP display name (**ldapDisplayName**) of this property is telephoneNumber. @@ -974,6 +1039,7 @@ Accept wildcard characters: False ``` ### -Organization + Specifies the user's organization. This parameter sets the **Organization** property of a user object. The LDAP display name (**ldapDisplayName**) of this property is o. @@ -991,6 +1057,7 @@ Accept wildcard characters: False ``` ### -OtherName + Specifies a name in addition to a user's given name and surname, such as the user's middle name. This parameter sets the **OtherName** property of a user object. The LDAP display name (**ldapDisplayName**) of this property is middleName. @@ -1008,27 +1075,35 @@ Accept wildcard characters: False ``` ### -Partition + Specifies the distinguished name of an Active Directory partition. The distinguished name must be one of the naming contexts on the current directory server. -The cmdlet searches this partition to find the object defined by the *Identity* parameter. +The cmdlet searches this partition to find the object defined by the _Identity_ parameter. -In many cases, a default value is used for the *Partition* parameter if no value is specified. -The rules for determining the default value are given below. -Note that rules listed first are evaluated first and when a default value can be determined, no further rules are evaluated. +In many cases, a default value is used for the _Partition_ parameter if no value is specified. The +rules for determining the default value are given below. Note that rules listed first are evaluated +first and when a default value can be determined, no further rules are evaluated. -In AD DS environments, a default value for *Partition* are set in the following cases: +In AD DS environments, a default value for _Partition_ are set in the following cases: -- If the *Identity* parameter is set to a distinguished name, the default value of *Partition* is automatically generated from this distinguished name. -- If running cmdlets from an Active Directory provider drive, the default value of *Partition* is automatically generated from the current path in the drive. -- If none of the previous cases apply, the default value of *Partition* is set to the default partition or naming context of the target domain. +- If the _Identity_ parameter is set to a distinguished name, the default value of _Partition_ is + automatically generated from this distinguished name. +- If running cmdlets from an Active Directory provider drive, the default value of _Partition_ is + automatically generated from the current path in the drive. +- If none of the previous cases apply, the default value of_Partition_ is set to the default + partition or naming context of the target domain. -In AD LDS environments, a default value for *Partition* will be set in the following cases: +In AD LDS environments, a default value for _Partition_ will be set in the following cases: -- If the *Identity* parameter is set to a distinguished name, the default value of *Partition* is automatically generated from this distinguished name. -- If running cmdlets from an Active Directory provider drive, the default value of *Partition* is automatically generated from the current path in the drive. -- If the target AD LDS instance has a default naming context, the default value of *Partition* is set to the default naming context. -To specify a default naming context for an AD LDS environment, set the **msDS-defaultNamingContext** property of the Active Directory directory service agent object (**nTDSDSA**) for the AD LDS instance. -- If none of the previous cases apply, the *Partition* parameter does not take any default value. +- If the _Identity_ parameter is set to a distinguished name, the default value of _Partition_ is + automatically generated from this distinguished name. +- If running cmdlets from an Active Directory provider drive, the default value of _Partition_ is + automatically generated from the current path in the drive. +- If the target AD LDS instance has a default naming context, the default value of _Partition_ is + set to the default naming context. To specify a default naming context for an AD LDS environment, + set the **msDS-defaultNamingContext** property of the Active Directory directory service agent + object (**nTDSDSA**) for the AD LDS instance. +- If none of the previous cases apply, the _Partition_ parameter does not take any default value. ```yaml Type: String @@ -1043,6 +1118,7 @@ Accept wildcard characters: False ``` ### -PassThru + Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output. @@ -1059,15 +1135,17 @@ Accept wildcard characters: False ``` ### -PasswordNeverExpires -Specifies whether the password of an account can expire. -This parameter sets the **PasswordNeverExpires** property of an account object. -This parameter also sets the **ADS_UF_DONT_EXPIRE_PASSWD** flag of the Active Directory User Account Control attribute. -The acceptable values for this parameter are: + +Specifies whether the password of an account can expire. This parameter sets the +**PasswordNeverExpires** property of an account object. This parameter also sets the +**ADS_UF_DONT_EXPIRE_PASSWD** flag of the Active Directory User Account Control attribute. The +acceptable values for this parameter are: - $False or 0 - $True or 1 -Note: This parameter cannot be set to $True or 1 for an account that also has the **ChangePasswordAtLogon** property set to $True. +Note: This parameter cannot be set to $True or 1 for an account that also has the +**ChangePasswordAtLogon** property set to $True. ```yaml Type: Boolean @@ -1082,10 +1160,11 @@ Accept wildcard characters: False ``` ### -PasswordNotRequired -Specifies whether the account requires a password. -This parameter sets the **PasswordNotRequired** property of an account, such as a user or computer account. -This parameter also sets the **ADS_UF_PASSWD_NOTREQD** flag of the Active Directory User Account Control attribute. -The acceptable values for this parameter are: + +Specifies whether the account requires a password. This parameter sets the **PasswordNotRequired** +property of an account, such as a user or computer account. This parameter also sets the +**ADS_UF_PASSWD_NOTREQD** flag of the Active Directory User Account Control attribute. The +acceptable values for this parameter are: - $False or 0 - $True or 1 @@ -1103,6 +1182,7 @@ Accept wildcard characters: False ``` ### -POBox + Specifies the user's post office box number. This parameter sets the **POBox** property of a user object. The LDAP display name (**ldapDisplayName**) of this property is postOfficeBox. @@ -1120,6 +1200,7 @@ Accept wildcard characters: False ``` ### -PostalCode + Specifies the postal code or zip code. This parameter sets the **PostalCode** property of a user object. The LDAP display name (**ldapDisplayName**) of this property is postalCode. @@ -1137,8 +1218,9 @@ Accept wildcard characters: False ``` ### -PrincipalsAllowedToDelegateToAccount -Specifies an array of principal objects. -This parameter sets the **msDS-AllowedToActOnBehalfOfOtherIdentity** attribute of a computer account object. + +Specifies an array of principal objects. This parameter sets the +**msDS-AllowedToActOnBehalfOfOtherIdentity** attribute of a computer account object. ```yaml Type: ADPrincipal[] @@ -1153,6 +1235,7 @@ Accept wildcard characters: False ``` ### -ProfilePath + Specifies a path to the user's profile. This value can be a local absolute path or a Universal Naming Convention (UNC) path. This parameter sets the **ProfilePath** property of the user object. @@ -1171,15 +1254,18 @@ Accept wildcard characters: False ``` ### -Remove -Specifies that the cmdlet remove values of an object property. -Use this parameter to remove one or more values of a property that cannot be modified using a cmdlet parameter. -To remove an object property, you must use the LDAP display name. -You can specify multiple values to a property by specifying a comma-separated list of values, and more than one property by separating them using a semicolon. If any of the properties have a null or empty value the cmdlet will return an error. -The format for this parameter is: + +Specifies that the cmdlet remove values of an object property. Use this parameter to remove one or +more values of a property that cannot be modified using a cmdlet parameter. To remove an object +property, you must use the LDAP display name. You can specify multiple values to a property by +specifying a comma-separated list of values, and more than one property by separating them using a +semicolon. If any of the properties have a null or empty value the cmdlet will return an error. The +format for this parameter is: `-Remove @{Attribute1LDAPDisplayName=value1, value2, ...; Attribute2LDAPDisplayName=value1, value2, ...; AttributeNLDAPDisplayName=value1, value2, ...}` -When you use the *Add*, *Remove*, *Replace*, and *Clear* parameters together, the parameters are applied in the following sequence: +When you use the _Add_, _Remove_, _Replace_, and _Clear_ parameters together, the parameters are +applied in the following sequence: - **Remove** - **Add** @@ -1199,15 +1285,18 @@ Accept wildcard characters: False ``` ### -Replace -Specifies values for an object property that will replace the current values. -Use this parameter to replace one or more values of a property that cannot be modified using a cmdlet parameter. -To modify an object property, you must use the LDAP display name. -You can specify multiple values to a property by specifying a comma-separated list of values, and more than one property by separating them using a semicolon. If any of the properties have a null or empty value the cmdlet will return an error. -The format for this parameter is: + +Specifies values for an object property that will replace the current values. Use this parameter to +replace one or more values of a property that cannot be modified using a cmdlet parameter. To modify +an object property, you must use the LDAP display name. You can specify multiple values to a +property by specifying a comma-separated list of values, and more than one property by separating +them using a semicolon. If any of the properties have a null or empty value the cmdlet will return +an error. The format for this parameter is: `-Replace @{Attribute1LDAPDisplayName=value1, value2, ...; Attribute2LDAPDisplayName=value1, value2, ...; AttributeNLDAPDisplayName=value1, value2, ...}` -When you use the *Add*, *Remove*, *Replace*, and *Clear* parameters together, the operations will be performed in the following order: +When you use the _Add_, _Remove_, _Replace_, and _Clear_ parameters together, the operations will be +performed in the following order: - **Remove** - **Add** @@ -1227,13 +1316,15 @@ Accept wildcard characters: False ``` ### -SamAccountName -Specifies the Security Account Manager (SAM) account name of the user, group, computer, or service account. -The maximum length of the description is 256 characters. -To be compatible with older operating systems, create a SAM account name that is 20 characters or less. -This parameter sets the **SAMAccountName** for an account object. -The LDAP display name (**ldapDisplayName**) for this property is sAMAccountName. -Note: If the string value provided is not terminated with a $ character, the system adds one if needed. +Specifies the Security Account Manager (SAM) account name of the user, group, computer, or service +account. The maximum length of the description is 256 characters. To be compatible with older +operating systems, create a SAM account name that is 20 characters or less. This parameter sets the +**SAMAccountName** for an account object. The LDAP display name (**ldapDisplayName**) for this +property is sAMAccountName. + +Note: If the string value provided is not terminated with a $ character, the system adds one if +needed. ```yaml Type: String @@ -1248,6 +1339,7 @@ Accept wildcard characters: False ``` ### -ScriptPath + Specifies a path to the user's log on script. This value can be a local absolute path or a Universal Naming Convention (UNC) path. This parameter sets the **ScriptPath** property of the user. @@ -1266,26 +1358,29 @@ Accept wildcard characters: False ``` ### -Server + Specifies the AD DS instance to connect to, by providing one of the following values for a corresponding domain name or directory server. The service may be any of the following: AD LDS, AD DS, or Active Directory snapshot instance. -Specify the AD DS instance in one of the following ways: +Specify the AD DS instance in one of the following ways: Domain name values: - Fully qualified domain name - NetBIOS name -Directory server values: +Directory server values: - Fully qualified directory server name - NetBIOS name - Fully qualified directory server name and port -The default value for this parameter is determined by one of the following methods in the order that they are listed: +The default value for this parameter is determined by one of the following methods in the order that +they are listed: -- By using the *Server* value from objects passed through the pipeline -- By using the server information associated with the AD DS Windows PowerShell provider drive, when the cmdlet runs in that drive +- By using the _Server_ value from objects passed through the pipeline +- By using the server information associated with the AD DS Windows PowerShell provider drive, when + the cmdlet runs in that drive - By using the domain of the computer running Windows PowerShell ```yaml @@ -1301,7 +1396,11 @@ Accept wildcard characters: False ``` ### -ServicePrincipalNames -Specifies the service principal names for the account. This parameter sets the ServicePrincipalNames property of the account. The LDAP display name (ldapDisplayName) for this property is servicePrincipalName. This parameter uses the following syntax to add, remove, replace or clear service principal name values. + +Specifies the service principal names for the account. This parameter sets the ServicePrincipalNames +property of the account. The LDAP display name (ldapDisplayName) for this property is +servicePrincipalName. This parameter uses the following syntax to add, remove, replace or clear +service principal name values. Syntax: @@ -1321,7 +1420,8 @@ To clear all values: `-ServicePrincipalNames $null` -You can specify more than one change by using a list separated by semicolons. For example, use the following syntax to add and remove service principal names. +You can specify more than one change by using a list separated by semicolons. For example, use the +following syntax to add and remove service principal names. `@{Add=value1,value2,...};@{Remove=value3,value4,...}` @@ -1348,10 +1448,11 @@ Accept wildcard characters: False ``` ### -SmartcardLogonRequired -Indicates whether a smart card is required to logon. -This parameter sets the **SmartCardLoginRequired** property for a user. -This parameter also sets the **ADS_UF_SMARTCARD_REQUIRED** flag of the Active Directory User Account Control attribute. -The acceptable values for this parameter are: + +Indicates whether a smart card is required to logon. This parameter sets the +**SmartCardLoginRequired** property for a user. This parameter also sets the +**ADS_UF_SMARTCARD_REQUIRED** flag of the Active Directory User Account Control attribute. The +acceptable values for this parameter are: - $False or 0 - $True or 1 @@ -1369,6 +1470,7 @@ Accept wildcard characters: False ``` ### -State + Specifies the user's state or province. This parameter sets the **State** property of a user object. The LDAP display name (**ldapDisplayName**) of this property is st. @@ -1386,6 +1488,7 @@ Accept wildcard characters: False ``` ### -StreetAddress + Specifies the user's street address. This parameter sets the **StreetAddress** property of a user object. The LDAP display name (**ldapDisplayName**) of this property is streetAddress. @@ -1403,6 +1506,7 @@ Accept wildcard characters: False ``` ### -Surname + Specifies the user's last name or surname. This parameter sets the **Surname** property of a user object. The LDAP display name (**ldapDisplayName**) of this property is sn. @@ -1420,6 +1524,7 @@ Accept wildcard characters: False ``` ### -Title + Specifies the user's title. This parameter sets the **Title** property of a user object. The LDAP display name (**ldapDisplayName**) of this property is title. @@ -1437,11 +1542,12 @@ Accept wildcard characters: False ``` ### -TrustedForDelegation -Specifies whether an account is trusted for Kerberos delegation. -A service that runs under an account that is trusted for Kerberos delegation can assume the identity of a client requesting the service. -This parameter sets the **TrustedForDelegation** property of an account object. -This value also sets the **ADS_UF_TRUSTED_FOR_DELEGATION** flag of the Active Directory User Account Control attribute. -The acceptable values for this parameter are: + +Specifies whether an account is trusted for Kerberos delegation. A service that runs under an +account that is trusted for Kerberos delegation can assume the identity of a client requesting the +service. This parameter sets the **TrustedForDelegation** property of an account object. This value +also sets the **ADS_UF_TRUSTED_FOR_DELEGATION** flag of the Active Directory User Account Control +attribute. The acceptable values for this parameter are: - $False or 0 - $True or 1 @@ -1459,10 +1565,12 @@ Accept wildcard characters: False ``` ### -UserPrincipalName -Specifies a user principal name (UPN) in the format `@`. -A UPN is a friendly name assigned by an administrator that is shorter than the LDAP distinguished name used by the system and easier to remember. -The UPN is independent of the user object's distinguished name, so a user object can be moved or renamed without affecting the user logon name. -When logging on using a UPN, users don't have to choose a domain from a list on the logon dialog box. + +Specifies a user principal name (UPN) in the format `@`. A UPN is a friendly +name assigned by an administrator that is shorter than the LDAP distinguished name used by the +system and easier to remember. The UPN is independent of the user object's distinguished name, so a +user object can be moved or renamed without affecting the user logon name. When logging on using a +UPN, users don't have to choose a domain from a list on the logon dialog box. ```yaml Type: String @@ -1477,6 +1585,7 @@ Accept wildcard characters: False ``` ### -WhatIf + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -1493,24 +1602,32 @@ Accept wildcard characters: False ``` ### CommonParameters -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). + +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). ## INPUTS ### None or Microsoft.ActiveDirectory.Management.ADUser -A user object is received by the *Identity* parameter. -A user object that was retrieved by using the **Get-ADUser** cmdlet and then modified is received by the *Instance* parameter. +A user object is received by the _Identity_ parameter. + +A user object that was retrieved by using the **Get-ADUser** cmdlet and then modified is received by +the _Instance_ parameter. ## OUTPUTS ### None or Microsoft.ActiveDirectory.Management.ADUser + Returns the modified user object when the **PassThru** parameter is specified. By default, this cmdlet does not generate any output. ## NOTES -* This cmdlet does not work with an Active Directory snapshot. -* This cmdlet does not work with a read-only domain controller. + +- This cmdlet does not work with an Active Directory snapshot. +- This cmdlet does not work with a read-only domain controller. ## RELATED LINKS From 6a1ac530cfd2a62b13cf0526b4e173e3961e961f Mon Sep 17 00:00:00 2001 From: Mike Soule Date: Thu, 27 Apr 2023 15:51:39 -0700 Subject: [PATCH 181/650] formatting --- .../Uninstall-AdcsOnlineResponder.md | 22 +++++++++++++------ 1 file changed, 15 insertions(+), 7 deletions(-) diff --git a/docset/winserver2022-ps/adcsdeployment/Uninstall-AdcsOnlineResponder.md b/docset/winserver2022-ps/adcsdeployment/Uninstall-AdcsOnlineResponder.md index 966c1f06a7..7965f84d3c 100644 --- a/docset/winserver2022-ps/adcsdeployment/Uninstall-AdcsOnlineResponder.md +++ b/docset/winserver2022-ps/adcsdeployment/Uninstall-AdcsOnlineResponder.md @@ -20,13 +20,15 @@ Uninstall-AdcsOnlineResponder [-Force] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION -The **Uninstall-AdcsOnlineResponder** cmdlet uninstalls the Online Responder role service. + +The `Uninstall-AdcsOnlineResponder` cmdlet uninstalls the Online Responder role service. ## EXAMPLES ### Example 1: Uninstall the Online Responder role service -``` -PS C:\> Uninstall-AdcsOnlineResponder -Force + +```powershell +Uninstall-AdcsOnlineResponder -Force ``` This command removes Online Responder role service without requiring confirmation. @@ -34,6 +36,7 @@ This command removes Online Responder role service without requiring confirmatio ## PARAMETERS ### -Confirm + Prompts you for confirmation before running the cmdlet. ```yaml @@ -49,6 +52,7 @@ Accept wildcard characters: False ``` ### -Force + Forces the command to run without asking for user confirmation. ```yaml @@ -64,6 +68,7 @@ Accept wildcard characters: False ``` ### -WhatIf + Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml @@ -79,7 +84,11 @@ Accept wildcard characters: False ``` ### CommonParameters -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). + +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). ## INPUTS @@ -90,11 +99,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ### Microsoft.CertificateServices.Deployment.Common.OCSP.OnlineResponderResult ## NOTES -* Ensure you run Windows PowerShell as an administrator. You can use the *Force* parameter to bypass the prompt for confirmation. - +- Ensure you run Windows PowerShell as an administrator. You can use the **Force** parameter to + bypass the prompt for confirmation. ## RELATED LINKS [Install-AdcsOnlineResponder](./Install-AdcsOnlineResponder.md) - From 9239bcce5f1fb7757e0f1d097a945f010f023c70 Mon Sep 17 00:00:00 2001 From: Dave Carroll Date: Thu, 27 Apr 2023 16:20:24 -0700 Subject: [PATCH 182/650] fix about_CommonParameters link, syntax code block --- docset/winserver2022-ps/tls/Disable-TlsCipherSuite.md | 5 ++--- docset/winserver2022-ps/tls/Disable-TlsEccCurve.md | 2 +- docset/winserver2022-ps/tls/Disable-TlsSessionTicketKey.md | 5 ++--- docset/winserver2022-ps/tls/Enable-TlsCipherSuite.md | 5 ++--- docset/winserver2022-ps/tls/Enable-TlsEccCurve.md | 2 +- docset/winserver2022-ps/tls/Enable-TlsSessionTicketKey.md | 5 ++--- docset/winserver2022-ps/tls/Export-TlsSessionTicketKey.md | 5 ++--- docset/winserver2022-ps/tls/Get-TlsCipherSuite.md | 5 ++--- docset/winserver2022-ps/tls/Get-TlsEccCurve.md | 2 +- docset/winserver2022-ps/tls/New-TlsSessionTicketKey.md | 5 ++--- 10 files changed, 17 insertions(+), 24 deletions(-) diff --git a/docset/winserver2022-ps/tls/Disable-TlsCipherSuite.md b/docset/winserver2022-ps/tls/Disable-TlsCipherSuite.md index f3237d81ef..7cfddda317 100644 --- a/docset/winserver2022-ps/tls/Disable-TlsCipherSuite.md +++ b/docset/winserver2022-ps/tls/Disable-TlsCipherSuite.md @@ -15,7 +15,7 @@ Disables a TLS cipher suite. ## SYNTAX -```powershell +``` Disable-TlsCipherSuite [-Name] [-WhatIf] [-Confirm] [] ``` @@ -92,8 +92,7 @@ Accept wildcard characters: False This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, --WarningAction, and -WarningVariable. For more information, see about_CommonParameters -(http://go.microsoft.com/fwlink/?LinkID=113216). +-WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/docset/winserver2022-ps/tls/Disable-TlsEccCurve.md b/docset/winserver2022-ps/tls/Disable-TlsEccCurve.md index 4bdcb38f43..15bf0bfb36 100644 --- a/docset/winserver2022-ps/tls/Disable-TlsEccCurve.md +++ b/docset/winserver2022-ps/tls/Disable-TlsEccCurve.md @@ -16,7 +16,7 @@ Security) for a computer. ## SYNTAX -```powershell +``` Disable-TlsEccCurve [-Name] [-WhatIf] [-Confirm] [] ``` diff --git a/docset/winserver2022-ps/tls/Disable-TlsSessionTicketKey.md b/docset/winserver2022-ps/tls/Disable-TlsSessionTicketKey.md index 4484be28be..56ef9a12e0 100644 --- a/docset/winserver2022-ps/tls/Disable-TlsSessionTicketKey.md +++ b/docset/winserver2022-ps/tls/Disable-TlsSessionTicketKey.md @@ -15,7 +15,7 @@ Disables a TLS session ticket key. ## SYNTAX -```powershell +``` Disable-TlsSessionTicketKey [-ServiceAccountName] [-WhatIf] [-Confirm] [] ``` @@ -101,8 +101,7 @@ Accept wildcard characters: False This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, --WarningAction, and -WarningVariable. For more information, see about_CommonParameters -(http://go.microsoft.com/fwlink/?LinkID=113216). +-WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/docset/winserver2022-ps/tls/Enable-TlsCipherSuite.md b/docset/winserver2022-ps/tls/Enable-TlsCipherSuite.md index 4bb14b43a4..d4ee7939b4 100644 --- a/docset/winserver2022-ps/tls/Enable-TlsCipherSuite.md +++ b/docset/winserver2022-ps/tls/Enable-TlsCipherSuite.md @@ -15,7 +15,7 @@ Enables a TLS cipher suite. ## SYNTAX -```powershell +``` Enable-TlsCipherSuite [[-Position] ] [-Name] [-WhatIf] [-Confirm] [] ``` @@ -145,8 +145,7 @@ Accept wildcard characters: False This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, --WarningAction, and -WarningVariable. For more information, see about_CommonParameters -(http://go.microsoft.com/fwlink/?LinkID=113216). +-WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/docset/winserver2022-ps/tls/Enable-TlsEccCurve.md b/docset/winserver2022-ps/tls/Enable-TlsEccCurve.md index 6bcc2e8b46..1a02e62046 100644 --- a/docset/winserver2022-ps/tls/Enable-TlsEccCurve.md +++ b/docset/winserver2022-ps/tls/Enable-TlsEccCurve.md @@ -15,7 +15,7 @@ Enables Elliptic Curve Cryptography (ECC) cipher suites available for TLS. ## SYNTAX -```powershell +``` Enable-TlsEccCurve [[-Position] ] [-Name] [-WhatIf] [-Confirm] [] ``` diff --git a/docset/winserver2022-ps/tls/Enable-TlsSessionTicketKey.md b/docset/winserver2022-ps/tls/Enable-TlsSessionTicketKey.md index fb8848b513..95a7c66ee8 100644 --- a/docset/winserver2022-ps/tls/Enable-TlsSessionTicketKey.md +++ b/docset/winserver2022-ps/tls/Enable-TlsSessionTicketKey.md @@ -15,7 +15,7 @@ Configures a TLS server with a TLS session ticket key. ## SYNTAX -```powershell +``` Enable-TlsSessionTicketKey [-ServiceAccountName] [-Path] [-Password] [-Force] [-WhatIf] [-Confirm] [] ``` @@ -164,8 +164,7 @@ Accept wildcard characters: False This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, --WarningAction, and -WarningVariable. For more information, see about_CommonParameters -(http://go.microsoft.com/fwlink/?LinkID=113216). +-WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/docset/winserver2022-ps/tls/Export-TlsSessionTicketKey.md b/docset/winserver2022-ps/tls/Export-TlsSessionTicketKey.md index 7bc764ee8c..31d1cc0a04 100644 --- a/docset/winserver2022-ps/tls/Export-TlsSessionTicketKey.md +++ b/docset/winserver2022-ps/tls/Export-TlsSessionTicketKey.md @@ -15,7 +15,7 @@ Exports a TLS session ticket key. ## SYNTAX -```powershell +``` Export-TlsSessionTicketKey [-ServiceAccountName] [[-Path] ] [-Password] [-WhatIf] [-Confirm] [] ``` @@ -137,8 +137,7 @@ Accept wildcard characters: False This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, --WarningAction, and -WarningVariable. For more information, see about_CommonParameters -(http://go.microsoft.com/fwlink/?LinkID=113216). +-WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/docset/winserver2022-ps/tls/Get-TlsCipherSuite.md b/docset/winserver2022-ps/tls/Get-TlsCipherSuite.md index fe10b9b74d..a8e08f3e1b 100644 --- a/docset/winserver2022-ps/tls/Get-TlsCipherSuite.md +++ b/docset/winserver2022-ps/tls/Get-TlsCipherSuite.md @@ -15,7 +15,7 @@ Gets the TLS cipher suites for a computer. ## SYNTAX -```powershell +``` Get-TlsCipherSuite [[-Name] ] [] ``` @@ -139,8 +139,7 @@ Accept wildcard characters: False This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, --WarningAction, and -WarningVariable. For more information, see about_CommonParameters -(http://go.microsoft.com/fwlink/?LinkID=113216). +-WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/docset/winserver2022-ps/tls/Get-TlsEccCurve.md b/docset/winserver2022-ps/tls/Get-TlsEccCurve.md index e71d7d9417..86196f45cf 100644 --- a/docset/winserver2022-ps/tls/Get-TlsEccCurve.md +++ b/docset/winserver2022-ps/tls/Get-TlsEccCurve.md @@ -14,7 +14,7 @@ Gets the list of Elliptic Curve Cryptography (ECC) cipher suites available for T ## SYNTAX -```powershell +``` Get-TlsEccCurve [[-Name] ] [] ``` diff --git a/docset/winserver2022-ps/tls/New-TlsSessionTicketKey.md b/docset/winserver2022-ps/tls/New-TlsSessionTicketKey.md index c1c609a4b6..7e4e5fdacd 100644 --- a/docset/winserver2022-ps/tls/New-TlsSessionTicketKey.md +++ b/docset/winserver2022-ps/tls/New-TlsSessionTicketKey.md @@ -15,7 +15,7 @@ Creates a TLS session ticket key configuration file. ## SYNTAX -```powershell +``` New-TlsSessionTicketKey [[-Path] ] [-Password] [] ``` @@ -89,8 +89,7 @@ Accept wildcard characters: False This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, --WarningAction, and -WarningVariable. For more information, see about_CommonParameters -(http://go.microsoft.com/fwlink/?LinkID=113216). +-WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS From f9be55fd79d2024f9c69154bfe2fe871c8e7fb37 Mon Sep 17 00:00:00 2001 From: Dave Carroll Date: Thu, 27 Apr 2023 16:22:53 -0700 Subject: [PATCH 183/650] fix related links --- docset/winserver2022-ps/tls/Enable-TlsEccCurve.md | 2 +- docset/winserver2022-ps/tls/Get-TlsEccCurve.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docset/winserver2022-ps/tls/Enable-TlsEccCurve.md b/docset/winserver2022-ps/tls/Enable-TlsEccCurve.md index 1a02e62046..5cd1f20a3f 100644 --- a/docset/winserver2022-ps/tls/Enable-TlsEccCurve.md +++ b/docset/winserver2022-ps/tls/Enable-TlsEccCurve.md @@ -126,6 +126,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-TlsEccCurve](./Get-TlsEccCurv.md) +[Get-TlsEccCurve](./Get-TlsEccCurve.md) [Disable-TlsEccCurve](./Disable-TlsEccCurve.md) diff --git a/docset/winserver2022-ps/tls/Get-TlsEccCurve.md b/docset/winserver2022-ps/tls/Get-TlsEccCurve.md index 86196f45cf..d634a709fb 100644 --- a/docset/winserver2022-ps/tls/Get-TlsEccCurve.md +++ b/docset/winserver2022-ps/tls/Get-TlsEccCurve.md @@ -90,6 +90,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Enable-TlsEccCurve](./Enable-TlsEccCurv.md) +[Enable-TlsEccCurve](./Enable-TlsEccCurve.md) [Disable-TlsEccCurve](./Disable-TlsEccCurve.md) From de0ffc5cee661b84a7ad69bda8e27d8c118b879e Mon Sep 17 00:00:00 2001 From: Dave Carroll Date: Thu, 27 Apr 2023 16:39:24 -0700 Subject: [PATCH 184/650] fix HKLM and ECC curve --- docset/winserver2022-ps/tls/Disable-TlsEccCurve.md | 2 +- docset/winserver2022-ps/tls/Enable-TlsCipherSuite.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docset/winserver2022-ps/tls/Disable-TlsEccCurve.md b/docset/winserver2022-ps/tls/Disable-TlsEccCurve.md index 15bf0bfb36..6508d6a846 100644 --- a/docset/winserver2022-ps/tls/Disable-TlsEccCurve.md +++ b/docset/winserver2022-ps/tls/Disable-TlsEccCurve.md @@ -33,7 +33,7 @@ TLS(Transport Layer Security) for a computer. Disable-TlsEccCurve -Name curve25519 ``` -This will disable the ECC Curve 'curve25519'. +This will disable the ECC Curve `curve25519`. ## PARAMETERS diff --git a/docset/winserver2022-ps/tls/Enable-TlsCipherSuite.md b/docset/winserver2022-ps/tls/Enable-TlsCipherSuite.md index d4ee7939b4..fc1e26723c 100644 --- a/docset/winserver2022-ps/tls/Enable-TlsCipherSuite.md +++ b/docset/winserver2022-ps/tls/Enable-TlsCipherSuite.md @@ -32,7 +32,7 @@ cipher suite is not used. This cmdlet is based on Cryptography Next Generation (CNG) Cryptographic Configuration. Schannel registry settings and settings specified by means of Security Support Provider Interface (SSPI) by each app can override CNG Cryptographic Configuration. Other settings under -HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\SecurityProviders\SCHANNEL can also configure +`HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\SecurityProviders\SCHANNEL` can also configure cipher suites. These settings can impact whether a cipher suite can be used. For example, disabling of SHA hashes supported by TLS disables the corresponding cipher suites. Additionally, applications can limit the algorithms using SSPI. For more information about TLS settings, see From 7b3d1e7ff931dd4e3771eef1b4c8a5e806d53562 Mon Sep 17 00:00:00 2001 From: Robert Biddle Date: Thu, 27 Apr 2023 19:43:35 -0400 Subject: [PATCH 185/650] Converting codeblock example to use splatted parameters --- .../addsdeployment/Install-ADDSDomain.md | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/addsdeployment/Install-ADDSDomain.md b/docset/winserver2022-ps/addsdeployment/Install-ADDSDomain.md index cf406e6335..bb47b2d967 100644 --- a/docset/winserver2022-ps/addsdeployment/Install-ADDSDomain.md +++ b/docset/winserver2022-ps/addsdeployment/Install-ADDSDomain.md @@ -36,7 +36,21 @@ The `Install-ADDSDomain` cmdlet installs an Active Directory domain configuratio ### Example 1: Install a new child domain ```powershell -Install-ADDSDomain -Credential (Get-Credential CORP\EnterpriseAdmin1) -NewDomainName child -ParentDomainName "corp.contoso.com" -InstallDNS -CreateDNSDelegation -DomainMode Win2003 -ReplicationSourceDC "DC1.corp.contoso.com" -SiteName "Houston" -DatabasePath "D:\NTDS" -SYSVOLPath "D:\SYSVOL" -LogPath "E:\Logs" -NoRebootOnCompletion +$HashArguments = @{ + Credential = (Get-Credential CORP\EnterpriseAdmin1) + NewDomainName = "child" + ParentDomainName = "corp.contoso.com" + InstallDNS = $true + CreateDNSDelegation = $true + DomainMode = "Win2003" + ReplicationSourceDC = "DC1.corp.contoso.com" + SiteName = "Houston" + DatabasePath = "D:\NTDS" + SYSVOLPath = "D:\SYSVOL" + LogPath = "E:\Logs" + NoRebootOnCompletion = $true +} +Install-ADDSDomain @HashArguments ``` This command installs a new child domain named child.corp.contoso.com using credentials of From 71565590ebcfb5c72a839cdcd0e79ca756f16d3f Mon Sep 17 00:00:00 2001 From: Robert Biddle Date: Thu, 27 Apr 2023 19:44:10 -0400 Subject: [PATCH 186/650] Changing Types to full names --- .../addsdeployment/Install-ADDSDomain.md | 48 +++++++++---------- 1 file changed, 24 insertions(+), 24 deletions(-) diff --git a/docset/winserver2022-ps/addsdeployment/Install-ADDSDomain.md b/docset/winserver2022-ps/addsdeployment/Install-ADDSDomain.md index bb47b2d967..bc9667fd64 100644 --- a/docset/winserver2022-ps/addsdeployment/Install-ADDSDomain.md +++ b/docset/winserver2022-ps/addsdeployment/Install-ADDSDomain.md @@ -72,7 +72,7 @@ operations to prepare Active Directory prior to the installation of this domain. **Get-Credential** cmdlet to prompt the user to supply a password. ```yaml -Type: PSCredential +Type: System.Management.Automation.PSCredential Parameter Sets: (All) Aliases: @@ -88,7 +88,7 @@ Accept wildcard characters: False Indicates that the cmdlet recreates an existing domain. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -104,7 +104,7 @@ Accept wildcard characters: False Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf @@ -122,7 +122,7 @@ install along with the domain controller. Valid for Active Directory-integrated default is computed automatically based on the environment. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -139,7 +139,7 @@ Specifies the user name and password that corresponds to the account used to ins controller. Use the **Get-Credential** cmdlet to prompt the user to supply a password. ```yaml -Type: PSCredential +Type: System.Management.Automation.PSCredential Parameter Sets: (All) Aliases: @@ -157,7 +157,7 @@ disk of the local computer that contains the domain database, for instance, `C:\ default is `%SYSTEMROOT%\NTDS`. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -175,7 +175,7 @@ parameter is skipped if the value for the _CreateDnsDelegation_ parameter is eit computed to be $false. ```yaml -Type: PSCredential +Type: System.Management.Automation.PSCredential Parameter Sets: (All) Aliases: @@ -206,7 +206,7 @@ The domain functional level cannot be lower than the forest functional level, bu The default is automatically computed and set. ```yaml -Type: DomainMode +Type: System.DirectoryServices.ActiveDirectory.DomainMode Parameter Sets: (All) Aliases: Accepted values: Win2008, Win2008R2, Win2012, Win2012R2, WinThreshold, Default @@ -242,7 +242,7 @@ Accept wildcard characters: False Forces the command to run without asking for user confirmation. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -268,7 +268,7 @@ corp.contoso.com, Active Directory performs an SOA query for corp.contoso.com an zone name in the response is corp.contoso.com. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -286,7 +286,7 @@ that contains the domain log files, for instance, `C:\Windows\Logs`. The default `%SYSTEMROOT%\NTDS`. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -305,7 +305,7 @@ name (FQDN) for the new domain tree. If the value set for the _DomainType_ param ChildDomain, this parameter can be used to specify a single label domain name for the child domain. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -334,7 +334,7 @@ Note that if the name value given for this parameter is a name of 16 characters domain installation will fail. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -359,7 +359,7 @@ this parameter, ensure that TCP/IP client settings are first configured with a p address. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -376,7 +376,7 @@ Specifies that the read-only domain controller (RODC) will not be a global catal By default, the domain controller that you are installing is a global catalog server. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -396,7 +396,7 @@ purposes because once configuration has completed the server will not function c member server or a DC until it is rebooted. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -412,7 +412,7 @@ Accept wildcard characters: False Specifies the fully qualified domain name (FQDN) of an existing parent domain. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -430,7 +430,7 @@ for replicating to this domain. The default value for this parameter is automati the environment. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -457,7 +457,7 @@ password to be configured. Another available advanced option is to use the which is also not a recommended security best practice in production deployments. ```yaml -Type: SecureString +Type: System.Security.SecureString Parameter Sets: (All) Aliases: @@ -475,7 +475,7 @@ value is the site that is associated with the subnet that includes the IP addres no such site exists, the default is the site of the replication source domain controller. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -492,7 +492,7 @@ Indicates that the cmdlet skips automatic configuration of DNS client settings, hints. This parameter is in effect only if the DNS Server service is already installed. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -514,7 +514,7 @@ the section ADPrep and Prerequisite Checking Architecture in [AD DS Simplified Administration](https://go.microsoft.com/fwlink/?LinkID=237244). ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -531,7 +531,7 @@ Specifies the fully qualified, non-UNC path to a directory on a fixed disk of th for example, `C:\Windows\SYSVOL`. The default is `%SYSTEMROOT%\SYSVOL`. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -548,7 +548,7 @@ Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi From a8ee2662c5643d476ed8481db6c837043126003c Mon Sep 17 00:00:00 2001 From: Steven Judd Date: Thu, 27 Apr 2023 16:49:31 -0700 Subject: [PATCH 187/650] updating doc to standards --- .../scheduledtasks/Disable-ScheduledTask.md | 77 +++++++++++++------ 1 file changed, 52 insertions(+), 25 deletions(-) diff --git a/docset/winserver2022-ps/scheduledtasks/Disable-ScheduledTask.md b/docset/winserver2022-ps/scheduledtasks/Disable-ScheduledTask.md index 7aef0cebe0..80065671ce 100644 --- a/docset/winserver2022-ps/scheduledtasks/Disable-ScheduledTask.md +++ b/docset/winserver2022-ps/scheduledtasks/Disable-ScheduledTask.md @@ -16,25 +16,32 @@ Disables a scheduled task. ## SYNTAX ### Name + ``` Disable-ScheduledTask [-TaskName] [[-TaskPath] ] [-CimSession ] [-ThrottleLimit ] [-AsJob] [] ``` ### Object + ``` -Disable-ScheduledTask [-InputObject] [-CimSession ] [-ThrottleLimit ] - [-AsJob] [] +Disable-ScheduledTask [-InputObject] [-CimSession ] + [-ThrottleLimit ] [-AsJob] [] ``` ## DESCRIPTION -The **Disable-ScheduledTask** cmdlet disables a scheduled task. + +The `Disable-ScheduledTask` cmdlet disables a scheduled task. ## EXAMPLES ### Example 1: Disable a scheduled task + +```powershell +Disable-ScheduledTask -TaskName 'SystemScan' ``` -PS C:\> Disable-ScheduledTask -TaskName "SystemScan" + +```output TaskPath TaskName State -------- -------- -------- \ SystemScan Disabled @@ -43,24 +50,31 @@ TaskPath TaskName State This command disables the SystemScan task in the root folder. ### Example 2: Disable all scheduled tasks in a folder + +```powershell +Get-ScheduledTask -TaskPath '\UpdateTasks\' | Disable-ScheduledTask ``` -PS C:\> Get-ScheduledTask -TaskPath "\UpdateTasks\" | Disable-ScheduledTask + +```output TaskPath TaskName State -------- -------- -------- \UpdateTasks\ UpdateApps Disabled \UpdateTasks\ UpdateDrivers Disabled ``` -This command uses the **Get-Scheduledtask** cmdlet to get all scheduled tasks in the \UpdateTasks\ folder. -The command pipes this information to the **Disable-ScheduledTasks** cmdlet, which disables these scheduled tasks. +This command uses the `Get-Scheduledtask` cmdlet to get all scheduled tasks in the `\UpdateTasks\` +folder. The command pipes this information to the `Disable-ScheduledTasks` cmdlet, which disables +these scheduled tasks. ## PARAMETERS ### -AsJob -Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. + +Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to +complete. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -72,12 +86,15 @@ Accept wildcard characters: False ``` ### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -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. -The default is the current session on the local computer. + +Runs the cmdlet in a remote session or on a remote computer. 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. The +default is the current session on the local computer. ```yaml -Type: CimSession[] +Type: Microsoft.Management.Infrastructure.CimSession[] Parameter Sets: (All) Aliases: Session @@ -89,10 +106,11 @@ Accept wildcard characters: False ``` ### -InputObject + Specifies the input object that is used in a pipeline command. ```yaml -Type: CimInstance +Type: Microsoft.Management.Infrastructure.CimInstance Parameter Sets: Object Aliases: @@ -104,10 +122,11 @@ Accept wildcard characters: False ``` ### -TaskName + Specifies the name of a scheduled task. ```yaml -Type: String +Type: System.String Parameter Sets: Name Aliases: @@ -119,12 +138,14 @@ Accept wildcard characters: False ``` ### -TaskPath -Specifies an array of one or more paths for scheduled tasks in Task Scheduler namespace. You can use **"*"** for a wildcard character query. -You can use **\\*** for the root folder. To specify a full TaskPath you need to include the leading and trailing **\\**. -If you do not specify a path, the cmdlet uses the root folder. + +Specifies an array of one or more paths for scheduled tasks in Task Scheduler namespace. You can use +`*` for a wildcard character query. You can use `\` for the root folder. To specify a full TaskPath +you need to include the leading and trailing `\`. If you do not specify a path, the cmdlet uses the +root folder. ```yaml -Type: String +Type: System.String Parameter Sets: Name Aliases: @@ -136,12 +157,15 @@ Accept wildcard characters: False ``` ### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -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. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. + +Specifies the maximum number of concurrent operations that can be established to run the cmdlet. 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. The throttle limit applies only to the current cmdlet, not to the session or to the +computer. ```yaml -Type: Int32 +Type: System.Int32 Parameter Sets: (All) Aliases: @@ -153,7 +177,11 @@ Accept wildcard characters: False ``` ### CommonParameters -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). + +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). ## INPUTS @@ -182,4 +210,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Stop-ScheduledTask](./Stop-ScheduledTask.md) [Unregister-ScheduledTask](./Unregister-ScheduledTask.md) - From a3ab025ab0deb5b4d6b56258e22d93da79517294 Mon Sep 17 00:00:00 2001 From: Steven Judd Date: Thu, 27 Apr 2023 17:18:06 -0700 Subject: [PATCH 188/650] Update docset/winserver2022-ps/scheduledtasks/Disable-ScheduledTask.md Co-authored-by: Mikey Lombardi (He/Him) --- docset/winserver2022-ps/scheduledtasks/Disable-ScheduledTask.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/scheduledtasks/Disable-ScheduledTask.md b/docset/winserver2022-ps/scheduledtasks/Disable-ScheduledTask.md index 80065671ce..cfce69068c 100644 --- a/docset/winserver2022-ps/scheduledtasks/Disable-ScheduledTask.md +++ b/docset/winserver2022-ps/scheduledtasks/Disable-ScheduledTask.md @@ -41,7 +41,7 @@ The `Disable-ScheduledTask` cmdlet disables a scheduled task. Disable-ScheduledTask -TaskName 'SystemScan' ``` -```output +```Output TaskPath TaskName State -------- -------- -------- \ SystemScan Disabled From 7ebb2b938e5ea4d0cc314ab1a882829cee3d0c6e Mon Sep 17 00:00:00 2001 From: Steven Judd Date: Thu, 27 Apr 2023 17:18:17 -0700 Subject: [PATCH 189/650] Update docset/winserver2022-ps/scheduledtasks/Disable-ScheduledTask.md Co-authored-by: Mikey Lombardi (He/Him) --- docset/winserver2022-ps/scheduledtasks/Disable-ScheduledTask.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/scheduledtasks/Disable-ScheduledTask.md b/docset/winserver2022-ps/scheduledtasks/Disable-ScheduledTask.md index cfce69068c..2f5a05c71a 100644 --- a/docset/winserver2022-ps/scheduledtasks/Disable-ScheduledTask.md +++ b/docset/winserver2022-ps/scheduledtasks/Disable-ScheduledTask.md @@ -55,7 +55,7 @@ This command disables the SystemScan task in the root folder. Get-ScheduledTask -TaskPath '\UpdateTasks\' | Disable-ScheduledTask ``` -```output +```Output TaskPath TaskName State -------- -------- -------- \UpdateTasks\ UpdateApps Disabled From ea8816d184abd8ce47708fbdaec5238161eedae8 Mon Sep 17 00:00:00 2001 From: Steven Judd Date: Thu, 27 Apr 2023 17:18:48 -0700 Subject: [PATCH 190/650] Update docset/winserver2022-ps/scheduledtasks/Disable-ScheduledTask.md Co-authored-by: Mikey Lombardi (He/Him) --- docset/winserver2022-ps/scheduledtasks/Disable-ScheduledTask.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/scheduledtasks/Disable-ScheduledTask.md b/docset/winserver2022-ps/scheduledtasks/Disable-ScheduledTask.md index 2f5a05c71a..9634455765 100644 --- a/docset/winserver2022-ps/scheduledtasks/Disable-ScheduledTask.md +++ b/docset/winserver2022-ps/scheduledtasks/Disable-ScheduledTask.md @@ -140,7 +140,7 @@ Accept wildcard characters: False ### -TaskPath Specifies an array of one or more paths for scheduled tasks in Task Scheduler namespace. You can use -`*` for a wildcard character query. You can use `\` for the root folder. To specify a full TaskPath +`*` for a wildcard character query. You can use `\` for the root folder. To specify a full **TaskPath** you need to include the leading and trailing `\`. If you do not specify a path, the cmdlet uses the root folder. From edd019695da5c5feb6031e3851399721fe7d7aeb Mon Sep 17 00:00:00 2001 From: Michael Svegmar Date: Fri, 28 Apr 2023 03:15:59 +0200 Subject: [PATCH 191/650] Formatting improvements --- .../Get-NetVirtualizationProviderAddress.md | 23 ++++++++----------- 1 file changed, 9 insertions(+), 14 deletions(-) diff --git a/docset/winserver2022-ps/netwnv/Get-NetVirtualizationProviderAddress.md b/docset/winserver2022-ps/netwnv/Get-NetVirtualizationProviderAddress.md index ad2dc6a7e0..78b1e3e79b 100644 --- a/docset/winserver2022-ps/netwnv/Get-NetVirtualizationProviderAddress.md +++ b/docset/winserver2022-ps/netwnv/Get-NetVirtualizationProviderAddress.md @@ -51,7 +51,7 @@ This command gets the Provider Address for the interface with the specified inde Get-NetVirtualizationProviderAddress -ProviderAddress '172.16.2.3' ``` -This command gets the Provider Address that has the IP address 172.16.2.3. +This command gets the Provider Address that has the IP address `172.16.2.3`. ## PARAMETERS @@ -59,16 +59,11 @@ This command gets the Provider Address that has the IP address 172.16.2.3. Specifies an array of states of Provider Addresses. The acceptable values for this parameter are: -- Preferred. - The address is unique. -- Tentative. - The address is not yet verified. -- Duplicate. - There is a duplicate address on the network. -- Invalid. - The address lifetime has expired. -- Deprecated. - The address cannot start new connections. +- `Preferred` - The address is unique. +- `Tentative` - The address is not yet verified. +- `Duplicate` - There is a duplicate address on the network. +- `Invalid` - The address lifetime has expired. +- `Deprecated` - The address cannot start new connections. ```yaml Type: AddressState [] @@ -154,10 +149,10 @@ Accept wildcard characters: False ### -ManagedByCluster -Specifies an array of Boolean values that determines whether a highly available Provider Address +Specifies an array of **Boolean** values that determines whether a highly available Provider Address configuration entry exists on a Hyper-V Network Virtualization gateway. If you use a Provider -Address cluster resource, this value is $True; otherwise, the value is $False. This parameter is a -read-only parameter, used by an administrator to diagnose problems. +Address cluster resource, this value is `$true`. Otherwise, the value is `$false`. This parameter is +a read-only parameter, used by an administrator to diagnose problems. ```yaml Type: System.Boolean[] From 7e409a5c97fbbae9c0463e55f89178c2120879a0 Mon Sep 17 00:00:00 2001 From: Mike Soule Date: Thu, 27 Apr 2023 20:01:01 -0700 Subject: [PATCH 192/650] formatting --- ...tall-AdcsNetworkDeviceEnrollmentService.md | 23 +++++++++++++------ 1 file changed, 16 insertions(+), 7 deletions(-) diff --git a/docset/winserver2022-ps/adcsdeployment/Uninstall-AdcsNetworkDeviceEnrollmentService.md b/docset/winserver2022-ps/adcsdeployment/Uninstall-AdcsNetworkDeviceEnrollmentService.md index 9f3b2e778c..17ff193233 100644 --- a/docset/winserver2022-ps/adcsdeployment/Uninstall-AdcsNetworkDeviceEnrollmentService.md +++ b/docset/winserver2022-ps/adcsdeployment/Uninstall-AdcsNetworkDeviceEnrollmentService.md @@ -20,13 +20,16 @@ Uninstall-AdcsNetworkDeviceEnrollmentService [-Force] [-WhatIf] [-Confirm] [ Uninstall-AdcsNetworkDeviceEnrollmentService -Force + +```powershell +Uninstall-AdcsNetworkDeviceEnrollmentService -Force ``` This command uninstalls the NDES role service and does not prompt for user input. @@ -34,6 +37,7 @@ This command uninstalls the NDES role service and does not prompt for user input ## PARAMETERS ### -Confirm + Prompts you for confirmation before running the cmdlet. ```yaml @@ -49,6 +53,7 @@ Accept wildcard characters: False ``` ### -Force + Forces the command to run without asking for user confirmation. ```yaml @@ -64,6 +69,7 @@ Accept wildcard characters: False ``` ### -WhatIf + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -80,7 +86,11 @@ Accept wildcard characters: False ``` ### CommonParameters -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). + +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). ## INPUTS @@ -91,11 +101,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ### Microsoft.CertificateServices.Deployment.Common.NDES.NetworkDeviceEnrollmentServiceResult ## NOTES -* Ensure you run Windows PowerShell as an administrator. You can use the *Force* parameter to bypass the prompt for confirmation. - +- Ensure you run Windows PowerShell as an administrator. You can use the **Force** parameter to + bypass the prompt for confirmation. ## RELATED LINKS [Install-AdcsNetworkDeviceEnrollmentService](./Install-AdcsNetworkDeviceEnrollmentService.md) - From 42a54c324705342396e97b72d04223b1b8ec6f23 Mon Sep 17 00:00:00 2001 From: Mike Soule Date: Thu, 27 Apr 2023 20:17:02 -0700 Subject: [PATCH 193/650] formatting #3365 --- .../Uninstall-AdcsEnrollmentWebService.md | 59 +++++++++++++------ 1 file changed, 41 insertions(+), 18 deletions(-) diff --git a/docset/winserver2022-ps/adcsdeployment/Uninstall-AdcsEnrollmentWebService.md b/docset/winserver2022-ps/adcsdeployment/Uninstall-AdcsEnrollmentWebService.md index 4453069bd0..6136dfa6a1 100644 --- a/docset/winserver2022-ps/adcsdeployment/Uninstall-AdcsEnrollmentWebService.md +++ b/docset/winserver2022-ps/adcsdeployment/Uninstall-AdcsEnrollmentWebService.md @@ -16,40 +16,53 @@ Uninstalls the Certificate Enrollment Web service or individual instances of it. ## SYNTAX ### UninstallSingleInstance (Default) + ``` -Uninstall-AdcsEnrollmentWebService -CAConfig -AuthenticationType [-Force] - [-WhatIf] [-Confirm] [] +Uninstall-AdcsEnrollmentWebService -CAConfig -AuthenticationType + [-Force] [-WhatIf] [-Confirm] [] ``` ### UninstallAll + ``` -Uninstall-AdcsEnrollmentWebService [-AllEnrollmentServices] [-Force] [-WhatIf] [-Confirm] [] +Uninstall-AdcsEnrollmentWebService [-AllEnrollmentServices] [-Force] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION -The **Uninstall-AdcsEnrollmentWebService** cmdlet uninstalls the Certificate Enrollment Web Service either entirely removing all instances of it or partially by removing individual instances. + +The `Uninstall-AdcsEnrollmentWebService` cmdlet uninstalls the Certificate Enrollment Web Service +either entirely removing all instances of it or partially by removing individual instances. ## EXAMPLES ### Example 1: Uninstall all Enrollment Web Service role services -``` -PS C:\> Uninstall-AdcsEnrollmentWebService -AllEnrollmentServices -Force + +```powershell +Uninstall-AdcsEnrollmentWebService -AllEnrollmentServices -Force ``` -This command uninstalls all the Enrollment Web Service role services without prompting for confirmation. +This command uninstalls all the Enrollment Web Service role services without prompting for +confirmation. ### Example 2: Uninstall an Enrollment Web Service role service using the specified CA -``` -PS C:\> Uninstall-AdcsEnrollmentWebService -CAConfig "APP1.corp.contoso.com\corp-APP1-CA" -AuthenticationType Certificate + +```powershell +$params = @{ + CAConfig = "APP1.corp.contoso.com\corp-APP1-CA" + AuthenticationType = Certificate +} +Uninstall-AdcsEnrollmentWebService @params ``` -This command uninstalls the Certificate Enrollment Web Service using the CA specified by the configuration named APP1.corp.contoso.com\corp-APP1-CA. -The CA configuration is the CA Computer Name and CA common name separated by a backslash. -The authentication type in use is Certificate. +This command uninstalls the Certificate Enrollment Web Service using the CA specified by the +configuration named `APP1.corp.contoso.com\corp-APP1-CA`. The CA configuration is the CA Computer +Name and CA common name separated by a backslash. The authentication type in use is Certificate. ## PARAMETERS ### -AllEnrollmentServices + Indicates that this cmdlet removes all Certificate Enrollment Web Service instances. ```yaml @@ -65,6 +78,7 @@ Accept wildcard characters: False ``` ### -AuthenticationType + Specifies the authentication type of the of enrollment services instance to be uninstalled. ```yaml @@ -81,8 +95,10 @@ Accept wildcard characters: False ``` ### -CAConfig -Specifies the configuration string of the certification authority (CA) for which this cmdlet uninstalls enrollment services. -This parameter is used to identify which instance of the Certificate Enrollment Web Service is to be uninstalled when multiple are present. + +Specifies the configuration string of the certification authority (CA) for which this cmdlet +uninstalls enrollment services. This parameter is used to identify which instance of the Certificate +Enrollment Web Service is to be uninstalled when multiple are present. ```yaml Type: String @@ -97,6 +113,7 @@ Accept wildcard characters: False ``` ### -Confirm + Prompts you for confirmation before running the cmdlet. ```yaml @@ -112,6 +129,7 @@ Accept wildcard characters: False ``` ### -Force + Forces the command to run without asking for user confirmation. ```yaml @@ -127,6 +145,7 @@ Accept wildcard characters: False ``` ### -WhatIf + Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml @@ -142,7 +161,11 @@ Accept wildcard characters: False ``` ### CommonParameters -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). + +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). ## INPUTS @@ -157,11 +180,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ### Microsoft.CertificateServices.Deployment.Common.CES.EnrollmentServiceResult ## NOTES -* The application directories are removed from their respective instance folders in the file system. The uninstall command does not remove the Secure Sockets Layer/Transport Layer Security (SSL/TLS) or the secure hypertext transfer protocol (https) bindings. - +- The application directories are removed from their respective instance folders in the file system. + The uninstall command does not remove the Secure Sockets Layer/Transport Layer Security (SSL/TLS) + or the secure hypertext transfer protocol (https) bindings. ## RELATED LINKS [Install-AdcsEnrollmentWebService](./Install-AdcsEnrollmentWebService.md) - From def7fd86adbb7fd6d023d2630fc672215430a9e5 Mon Sep 17 00:00:00 2001 From: Mike Soule Date: Thu, 27 Apr 2023 20:24:14 -0700 Subject: [PATCH 194/650] formatting #3367 --- ...ninstall-AdcsEnrollmentPolicyWebService.md | 57 +++++++++++++------ 1 file changed, 40 insertions(+), 17 deletions(-) diff --git a/docset/winserver2022-ps/adcsdeployment/Uninstall-AdcsEnrollmentPolicyWebService.md b/docset/winserver2022-ps/adcsdeployment/Uninstall-AdcsEnrollmentPolicyWebService.md index 08cb12cd6f..8a64854e8c 100644 --- a/docset/winserver2022-ps/adcsdeployment/Uninstall-AdcsEnrollmentPolicyWebService.md +++ b/docset/winserver2022-ps/adcsdeployment/Uninstall-AdcsEnrollmentPolicyWebService.md @@ -16,38 +16,48 @@ Uninstalls the Certificate Enrollment Policy Web service. ## SYNTAX ### UninstallSingleInstance (Default) + ``` -Uninstall-AdcsEnrollmentPolicyWebService -AuthenticationType [-KeyBasedRenewal] [-Force] - [-WhatIf] [-Confirm] [] +Uninstall-AdcsEnrollmentPolicyWebService -AuthenticationType + [-KeyBasedRenewal] [-Force] [-WhatIf] [-Confirm] [] ``` ### UninstallAll + ``` -Uninstall-AdcsEnrollmentPolicyWebService [-AllPolicyServers] [-Force] [-WhatIf] [-Confirm] [] +Uninstall-AdcsEnrollmentPolicyWebService [-AllPolicyServers] [-Force] + [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION -The **Uninstall-AdcsEnrollmentPolicyWebService** cmdlet uninstalls the Certificate Enrollment Policy (CEP) Web Service. + +The `Uninstall-AdcsEnrollmentPolicyWebService` cmdlet uninstalls the Certificate Enrollment Policy +(CEP) Web Service. ## EXAMPLES ### Example 1: Uninstall all configuration in the CEP Web Service -``` -PS C:\> Uninstall-AdcsEnrollmentPolicyWebService -AllPolicyServers -Force + +```powershell +Uninstall-AdcsEnrollmentPolicyWebService -AllPolicyServers -Force ``` -This command uninstalls all configurations in the CEP Web Service without prompting for confirmation. +This command uninstalls all configurations in the CEP Web Service without prompting for +confirmation. ### Example 2: Uninstall an instance of the CEP Web Service -``` -PS C:\> Uninstall-AdcsEnrollmentPolicyWebService -AuthenticationType Certificate -KeyBasedRenewal -Force + +```powershell +Uninstall-AdcsEnrollmentPolicyWebService -AuthenticationType Certificate -KeyBasedRenewal -Force ``` -This command uninstalls the instance of CEP Web Service that is utilizing certificate authentication and is in key-based renewal mode without prompting for confirmation. +This command uninstalls the instance of CEP Web Service that is utilizing certificate authentication +and is in key-based renewal mode without prompting for confirmation. ## PARAMETERS ### -AllPolicyServers + Indicates that the cmdlet uninstall all instances of the CEP Web Service. ```yaml @@ -63,7 +73,9 @@ Accept wildcard characters: False ``` ### -AuthenticationType -Specifies the authentication type for the CEP Web Service instance to be uninstalled when multiple instances are present. + +Specifies the authentication type for the CEP Web Service instance to be uninstalled when multiple +instances are present. ```yaml Type: AuthenticationType @@ -79,6 +91,7 @@ Accept wildcard characters: False ``` ### -Confirm + Prompts you for confirmation before running the cmdlet. ```yaml @@ -94,6 +107,7 @@ Accept wildcard characters: False ``` ### -Force + Forces the command to run without asking for user confirmation. ```yaml @@ -109,10 +123,12 @@ Accept wildcard characters: False ``` ### -KeyBasedRenewal -Indicates that this cmdlet uninstalls the instance of the CEP Web Service running in key-based renewal mode. -This parameter is optional. -It is used to distinguish which instance of the CEP Web Service is to be uninstalled if there are multiple instances that use the same authentication type. -If this option is not specified, the instance of the CEP Web Service that is using the defined AuthenticationType that is not enabled for KeyBasedRenewal mode is uninstalled. + +Indicates that this cmdlet uninstalls the instance of the CEP Web Service running in key-based +renewal mode. This parameter is optional. It is used to distinguish which instance of the CEP Web +Service is to be uninstalled if there are multiple instances that use the same authentication type. +If this option is not specified, the instance of the CEP Web Service that is using the defined +AuthenticationType that is not enabled for KeyBasedRenewal mode is uninstalled. ```yaml Type: SwitchParameter @@ -127,6 +143,7 @@ Accept wildcard characters: False ``` ### -WhatIf + Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml @@ -142,7 +159,11 @@ Accept wildcard characters: False ``` ### CommonParameters -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). + +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). ## INPUTS @@ -155,7 +176,9 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ### Microsoft.CertificateServices.Deployment.Common.CEP.EnrollmentPolicyServiceResult ## NOTES -* Ensure you run Windows PowerShell as an administrator. You can use the *Force* parameter to bypass the prompt for confirmation. + +- Ensure you run Windows PowerShell as an administrator. You can use the **Force** parameter to + bypass the prompt for confirmation. ## RELATED LINKS From 5231e1a31992520fe74b8b263fc67f14c0e7d050 Mon Sep 17 00:00:00 2001 From: Mike Soule Date: Thu, 27 Apr 2023 20:29:26 -0700 Subject: [PATCH 195/650] formatting #3369 --- .../Uninstall-AdcsCertificationAuthority.md | 29 ++++++++++++++----- 1 file changed, 21 insertions(+), 8 deletions(-) diff --git a/docset/winserver2022-ps/adcsdeployment/Uninstall-AdcsCertificationAuthority.md b/docset/winserver2022-ps/adcsdeployment/Uninstall-AdcsCertificationAuthority.md index c742f5bd18..e9eeb9fb6c 100644 --- a/docset/winserver2022-ps/adcsdeployment/Uninstall-AdcsCertificationAuthority.md +++ b/docset/winserver2022-ps/adcsdeployment/Uninstall-AdcsCertificationAuthority.md @@ -16,24 +16,30 @@ Uninstalls the CA role service and removes the configuration information. ## SYNTAX ``` -Uninstall-AdcsCertificationAuthority [-Force] [-WhatIf] [-Confirm] [] +Uninstall-AdcsCertificationAuthority [-Force] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION -The **Uninstall-AdcsCertificationAuthority** cmdlet removes the Active certificate authority (CA) role and removes the configuration information. + +The `Uninstall-AdcsCertificationAuthority` cmdlet removes the Active certificate authority (CA) role +and removes the configuration information. ## EXAMPLES ### Example 1: Uninstall the Active Directory CA role service -``` -PS C:\> Uninstall-AdcsCertificationAuthority -Force + +```powershell +Uninstall-AdcsCertificationAuthority -Force ``` -This command uninstalls the Active Directory Certification Authority role service and does not prompt for user confirmation. +This command uninstalls the Active Directory Certification Authority role service and does not +prompt for user confirmation. ## PARAMETERS ### -Confirm + Prompts you for confirmation before running the cmdlet. ```yaml @@ -49,6 +55,7 @@ Accept wildcard characters: False ``` ### -Force + Forces the command to run without asking for user confirmation. ```yaml @@ -64,6 +71,7 @@ Accept wildcard characters: False ``` ### -WhatIf + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -80,7 +88,11 @@ Accept wildcard characters: False ``` ### CommonParameters -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). + +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). ## INPUTS @@ -91,9 +103,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ### Microsoft.CertificateServices.Deployment.Common.CA.CertificationAuthoritySetupResult ## NOTES -* To uninstall the CA role service, ensure you run Windows PowerShell as an administrator. You can run the command with the *Force* parameter to bypass the prompt for confirmation. + +- To uninstall the CA role service, ensure you run Windows PowerShell as an administrator. You can + run the command with the *Force* parameter to bypass the prompt for confirmation. ## RELATED LINKS [Install-AdcsCertificationAuthority](./Install-AdcsCertificationAuthority.md) - From 936422748128320bd6aca602afb7e790f4f42899 Mon Sep 17 00:00:00 2001 From: Mike Soule Date: Thu, 27 Apr 2023 20:34:08 -0700 Subject: [PATCH 196/650] formatting #3371 --- .../Install-AdcsWebEnrollment.md | 59 ++++++++++++------- 1 file changed, 38 insertions(+), 21 deletions(-) diff --git a/docset/winserver2022-ps/adcsdeployment/Install-AdcsWebEnrollment.md b/docset/winserver2022-ps/adcsdeployment/Install-AdcsWebEnrollment.md index 926740034d..c1e3cf65b4 100644 --- a/docset/winserver2022-ps/adcsdeployment/Install-AdcsWebEnrollment.md +++ b/docset/winserver2022-ps/adcsdeployment/Install-AdcsWebEnrollment.md @@ -16,13 +16,15 @@ Installs the Certification Authority Web Enrollment. ## SYNTAX ``` -Install-AdcsWebEnrollment [-CAConfig ] [-Force] [-Credential ] [-WhatIf] [-Confirm] - [] +Install-AdcsWebEnrollment [-CAConfig ] [-Force] + [-Credential ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION -The **Install-AdcsWebEnrollment** cmdlet performs initial installation and configuration of the Certification Authority (CA) Web Enrollment role service. -To remove the Web Enrollment role service use the **Uninstall-AdcsWebEnrollment** cmdlet. + +The `Install-AdcsWebEnrollment` cmdlet performs initial installation and configuration of the +Certification Authority (CA) Web Enrollment role service. To remove the Web Enrollment role service +use the `Uninstall-AdcsWebEnrollment` cmdlet. You can import the cmdlet by running the following commands from Windows PowerShell: @@ -32,24 +34,30 @@ You can import the cmdlet by running the following commands from Windows PowerSh ## EXAMPLES ### Example 1: Install the Web Enrollment role service to a CA with confirmation -``` -PS C:\> Install-AdcsWebEnrollment -CAConfig "\" + +```powershell +Install-AdcsWebEnrollment -CAConfig "\" ``` -This command installs the Web Enrollment role service to a CA specified by `\`. -Replace the computer name of the CA for `` and replace the CA common name for `` when running the command. +This command installs the Web Enrollment role service to a CA specified by +`\`. Replace the computer name of the CA for `` and +replace the CA common name for `` when running the command. ### Example 1: Install the Web Enrollment role service to a CA without confirmation -``` -PS C:\> Install-AdcsWebEnrollment -CAConfig "\" -Force + +```powershell +Install-AdcsWebEnrollment -CAConfig "\" -Force ``` -This command installs the Web Enrollment role service to a CA specified by `\` without requiring user confirmation. -Replace the computer name of the CA for `` and replace the CA common name for `` when running the command. +This command installs the Web Enrollment role service to a CA specified by +`\` without requiring user confirmation. Replace the computer name of +the CA for `` and replace the CA common name for `` when running the +command. ## PARAMETERS ### -CAConfig + Specifies the CA config parameter string. Do not specify this if there is a local CA installed. @@ -66,6 +74,7 @@ Accept wildcard characters: False ``` ### -Confirm + Prompts you for confirmation before running the cmdlet. ```yaml @@ -81,11 +90,12 @@ Accept wildcard characters: False ``` ### -Credential -Specifies a **PSCredential** object for the CA Web Enrollment. -To obtain a credential object, use the **Get-Credential** cmdlet. -For more information, type `Get-Help Get-Credential`. -If the Web Enrollment service is configured to use Standalone CA, then an account that is a member of the local Administrators on the CA is required. -If the Web Enrollment service is configured to use an Enterprise CA, then an account that is a member of Domain Admins is required. + +Specifies a `PSCredential` object for the CA Web Enrollment. To obtain a credential object, use the +`Get-Credential` cmdlet. For more information, type `Get-Help Get-Credential`. If the Web Enrollment +service is configured to use Standalone CA, then an account that is a member of the local +Administrators on the CA is required. If the Web Enrollment service is configured to use an +Enterprise CA, then an account that is a member of Domain Admins is required. ```yaml Type: PSCredential @@ -100,6 +110,7 @@ Accept wildcard characters: False ``` ### -Force + Forces the command to run without asking for user confirmation. ```yaml @@ -115,6 +126,7 @@ Accept wildcard characters: False ``` ### -WhatIf + Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml @@ -130,7 +142,11 @@ Accept wildcard characters: False ``` ### CommonParameters -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). + +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). ## INPUTS @@ -143,12 +159,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ### Microsoft.CertificateServices.Deployment.Common.WEP.WebEnrollmentResult ## NOTES -* Ensure you run Windows PowerShell as an administrator. You can use the *Force* parameter to bypass the prompt for confirmation. -To see parameters, run the following command: `Install-AdcsWebEnrollment -?` + +- Ensure you run Windows PowerShell as an administrator. You can use the **Force** parameter to + bypass the prompt for confirmation. To see parameters, run the following command: + `Install-AdcsWebEnrollment -?` ## RELATED LINKS [Uninstall-AdcsWebEnrollment](./Uninstall-AdcsWebEnrollment.md) [Get-Credential](https://go.microsoft.com/fwlink/?LinkID=293936) - From 7f2cccb9b9d511867c51c02c9a4450a43c55e0ae Mon Sep 17 00:00:00 2001 From: Mike Soule Date: Thu, 27 Apr 2023 20:39:24 -0700 Subject: [PATCH 197/650] formatting #3373 --- .../Install-AdcsOnlineResponder.md | 49 ++++++++++++------- 1 file changed, 32 insertions(+), 17 deletions(-) diff --git a/docset/winserver2022-ps/adcsdeployment/Install-AdcsOnlineResponder.md b/docset/winserver2022-ps/adcsdeployment/Install-AdcsOnlineResponder.md index 7b3fd3a601..708cb93bd6 100644 --- a/docset/winserver2022-ps/adcsdeployment/Install-AdcsOnlineResponder.md +++ b/docset/winserver2022-ps/adcsdeployment/Install-AdcsOnlineResponder.md @@ -16,12 +16,15 @@ Installs the Online Responder service. ## SYNTAX ``` -Install-AdcsOnlineResponder [-Force] [-Credential ] [-WhatIf] [-Confirm] [] +Install-AdcsOnlineResponder [-Force] [-Credential ] [-WhatIf] + [-Confirm] [] ``` ## DESCRIPTION -The **Install-AdcsOnlineResponder** cmdlet installs the Online Responder service, which provides Online Certificate Status Protocol (OSCP) services. -To remove the role service, use the **Uninstall-AdcsOnlineResponder** cmdlet. + +The `Install-AdcsOnlineResponder` cmdlet installs the Online Responder service, which provides +Online Certificate Status Protocol (OSCP) services. To remove the role service, use the +`Uninstall-AdcsOnlineResponder` cmdlet. You can import the cmdlet by running the following commands from Windows PowerShell: @@ -31,15 +34,17 @@ You can import the cmdlet by running the following commands from Windows PowerSh ## EXAMPLES ### Example 1: Install the Online Responder role service -``` -PS C:\> Install-AdcsOnlineResponder + +```powershell +Install-AdcsOnlineResponder ``` This command installs the Online Responder role service. ### Example 2: Force the installation of the Online Responder role service -``` -PS C:\> Install-AdcsOnlineResponder -Force + +```powershell +Install-AdcsOnlineResponder -Force ``` This command forces the installation of the Online Responder role service. @@ -47,6 +52,7 @@ This command forces the installation of the Online Responder role service. ## PARAMETERS ### -Confirm + Prompts you for confirmation before running the cmdlet. ```yaml @@ -62,12 +68,14 @@ Accept wildcard characters: False ``` ### -Credential -Specifies a **PSCredential** object for the Online Responder service. -To obtain a credential object, use the **Get-Credential** cmdlet. -For more information, type `Get-Help Get-Credential`. -You can install the Online Responder role service only on servers that are members of Active Directory Domain Services (AD DS) domains. -If you are installing an online responder configured to use a standalone certification authority (CA), then an account that is a member of the local Administrators group of the target server is required. -If you are installing an online responder to target an Enterprise CA, then an account that is a member of the Domain Admins group is required. + +Specifies a **PSCredential** object for the Online Responder service. To obtain a credential object, +use the `Get-Credential` cmdlet. For more information, type `Get-Help Get-Credential`. You can +install the Online Responder role service only on servers that are members of Active Directory +Domain Services (AD DS) domains. If you are installing an online responder configured to use a +standalone certification authority (CA), then an account that is a member of the local +Administrators group of the target server is required. If you are installing an online responder to +target an Enterprise CA, then an account that is a member of the Domain Admins group is required. ```yaml Type: PSCredential @@ -82,6 +90,7 @@ Accept wildcard characters: False ``` ### -Force + Forces the command to run without asking for user confirmation. ```yaml @@ -97,6 +106,7 @@ Accept wildcard characters: False ``` ### -WhatIf + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -113,7 +123,11 @@ Accept wildcard characters: False ``` ### CommonParameters -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). + +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). ## INPUTS @@ -124,12 +138,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ### Microsoft.CertificateServices.Deployment.Common.OCSP.OnlineResponderResult ## NOTES -* Ensure you run Windows PowerShell as an administrator. You can use the *Force* parameter to bypass the prompt for confirmation. -To see parameters, run the following command: `Install-AdcsOnlineResponder -?` + +- Ensure you run Windows PowerShell as an administrator. You can use the **Force** parameter to + bypass the prompt for confirmation. To see parameters, run the following command: + `Install-AdcsOnlineResponder -?` ## RELATED LINKS [Uninstall-AdcsOnlineResponder](./Uninstall-AdcsOnlineResponder.md) [Get-Credential](https://go.microsoft.com/fwlink/?LinkID=293936) - From 3655dae19ca3e0441a37fd554945f55186654096 Mon Sep 17 00:00:00 2001 From: Mike Soule Date: Thu, 27 Apr 2023 21:08:36 -0700 Subject: [PATCH 198/650] formatting #3375 --- ...tall-AdcsNetworkDeviceEnrollmentService.md | 150 ++++++++++++------ 1 file changed, 105 insertions(+), 45 deletions(-) diff --git a/docset/winserver2022-ps/adcsdeployment/Install-AdcsNetworkDeviceEnrollmentService.md b/docset/winserver2022-ps/adcsdeployment/Install-AdcsNetworkDeviceEnrollmentService.md index 2e00333a74..eaaf43bd58 100644 --- a/docset/winserver2022-ps/adcsdeployment/Install-AdcsNetworkDeviceEnrollmentService.md +++ b/docset/winserver2022-ps/adcsdeployment/Install-AdcsNetworkDeviceEnrollmentService.md @@ -16,27 +16,36 @@ Installs the NDES role service. ## SYNTAX ### DefaultParameterSet (Default) + ``` -Install-AdcsNetworkDeviceEnrollmentService [-ApplicationPoolIdentity] [-RAName ] [-RAEmail ] - [-RACompany ] [-RADepartment ] [-RACity ] [-RAState ] [-RACountry ] - [-SigningProviderName ] [-SigningKeyLength ] [-EncryptionProviderName ] - [-EncryptionKeyLength ] [-CAConfig ] [-Force] [-Credential ] [-WhatIf] [-Confirm] - [] +Install-AdcsNetworkDeviceEnrollmentService [-ApplicationPoolIdentity] + [-RAName ] [-RAEmail ] [-RACompany ] + [-RADepartment ] [-RACity ] [-RAState ] + [-RACountry ] [-SigningProviderName ] + [-SigningKeyLength ] [-EncryptionProviderName ] + [-EncryptionKeyLength ] [-CAConfig ] [-Force] + [-Credential ] [-WhatIf] [-Confirm] [] ``` ### ServiceAccountParameterSet + ``` -Install-AdcsNetworkDeviceEnrollmentService -ServiceAccountName -ServiceAccountPassword - [-RAName ] [-RAEmail ] [-RACompany ] [-RADepartment ] [-RACity ] - [-RAState ] [-RACountry ] [-SigningProviderName ] [-SigningKeyLength ] - [-EncryptionProviderName ] [-EncryptionKeyLength ] [-CAConfig ] [-Force] - [-Credential ] [-WhatIf] [-Confirm] [] +Install-AdcsNetworkDeviceEnrollmentService -ServiceAccountName + -ServiceAccountPassword [-RAName ] + [-RAEmail ] [-RACompany ] [-RADepartment ] + [-RACity ] [-RAState ] [-RACountry ] + [-SigningProviderName ] [-SigningKeyLength ] + [-EncryptionProviderName ] [-EncryptionKeyLength ] + [-CAConfig ] [-Force] [-Credential ] [-WhatIf] + [-Confirm] [] ``` ## DESCRIPTION -The **Install-AdcsNetworkDeviceEnrollmentService** cmdlet performs the configuration of the Network Device Enrollment Service (NDES) role service. -To remove the NDES role service, use the **Uninstall-AdcsNetworkDeviceEnrollmentService** cmdlet. +The `Install-AdcsNetworkDeviceEnrollmentService` cmdlet performs the configuration of the Network +Device Enrollment Service (NDES) role service. + +To remove the NDES role service, use the `Uninstall-AdcsNetworkDeviceEnrollmentService` cmdlet. You can import the cmdlet by running the following commands from Windows PowerShell: @@ -48,42 +57,70 @@ Int is equivalent to Int32 in the [.NET Framework](https://msdn.microsoft.com/en ## EXAMPLES ### Example 1: Display the default NDES settings -``` -PS C:\> Install-AdcsNetworkDeviceEnrollmentService -ApplicationPoolIdentity -WhatIf + +```powershell +Install-AdcsNetworkDeviceEnrollmentService -ApplicationPoolIdentity -WhatIf ``` This command displays the default NDES settings that will be configured if it is installed. ### Example 2: Display the default NDES settings using a service account name and password -``` -PS C:\> Install-AdcsNetworkDeviceEnrollmentService -ServiceAccountName "CONTOSO\svcNDES" -ServiceAccountPassword (read-host "Set user password" -assecurestring) -WhatIf + +```powershell +$params = @{ + ServiceAccountName = "CONTOSO\svcNDES" + ServiceAccountPassword = (read-host "Set user password" -assecurestring) + WhatIf = $true +} +Install-AdcsNetworkDeviceEnrollmentService @params ``` -This command displays the default settings when NDES is using a service account without making any changes to the configuration. -This command uses the service account named "CONTOSO\svcNDES" that is a member of the local computer's IIS_USRS group. +This command displays the default settings when NDES is using a service account without making any +changes to the configuration. This command uses the service account named `"CONTOSO\svcNDES"` that +is a member of the local computer's `IIS_USRS` group. ### Example 3: Install NDES using the application pool identity -``` -PS C:\> Install-AdcsNetworkDeviceEnrollmentService -ApplicationPoolIdentity -CAConfig "\" + +```powershell +$params = @{ + ApplicationPoolIdentity = $true + CAConfig = "\" +} +Install-AdcsNetworkDeviceEnrollmentService @params ``` -This command installs NDES using the application pool identity to use a remote CA as specified by the CA computer `\`. -Substitute the appropriate CA computer name and common name for `` and ``. +This command installs NDES using the application pool identity to use a remote CA as specified by +the CA computer `\`. Substitute the appropriate CA computer name and +common name for `` and ``. ### Example 4: Install NDES using a specific service account -``` -PS C:\> Install-AdcsNetworkDeviceEnrollmentService -ServiceAccountName "CONTOSO\svcNDES" -ServiceAccountPassword (read-host "Set user password" -assecurestring) -CAConfig "CAComputerName\CAName" -RAName "Contoso-NDES-RA" -RACountry "US" -RACompany "Contoso" -SigningProviderName "Microsoft Strong Cryptographic Provider" -SigningKeyLength 4096 -EncryptionProviderName "Microsoft Strong Cryptographic Provider" -EncryptionKeyLength 4096 + +```powershell +$params = @{ + ServiceAccountName = "CONTOSO\svcNDES" + ServiceAccountPassword = (read-host "Set user password" -assecurestring) + CAConfig = "CAComputerName\CAName" + RAName = "Contoso-NDES-RA" + RACountry = "US" + RACompany = "Contoso" + SigningProviderName = "Microsoft Strong Cryptographic Provider" + SigningKeyLength = 4096 + EncryptionProviderName = "Microsoft Strong Cryptographic Provider" + EncryptionKeyLength = 4096 +} +Install-AdcsNetworkDeviceEnrollmentService @params ``` -This command installs the NDES using a service account named "CONTOSO\svcNDES" that is a member of the local computer's IIS_USRS group. -The command also specifies several non-default parameters. +This command installs the NDES using a service account named `"CONTOSO\svcNDES"` that is a member of +the local computer's `IIS_USRS` group. The command also specifies several non-default parameters. ## PARAMETERS ### -ApplicationPoolIdentity -Indicates that the cmdlet the identity that the Network Device Enrollment Service (NDES) uses when communicating with the certification authority (CA). -This parameter is only valid when NDES is using a remote CA. -If the CA is local, the application pool identity account cannot be used. + +Indicates that the cmdlet the identity that the Network Device Enrollment Service (NDES) uses when +communicating with the certification authority (CA). This parameter is only valid when NDES is using +a remote CA. If the CA is local, the application pool identity account cannot be used. ```yaml Type: SwitchParameter @@ -98,9 +135,10 @@ Accept wildcard characters: False ``` ### -CAConfig -Specifies remote certification authority (CA) that the Network Device Enrollment Service uses. -This parameter is mandatory when used within the *ApplicationPoolIdentity* parameter. -Do not use this parameter when a local CA is installed. + +Specifies remote certification authority (CA) that the Network Device Enrollment Service uses. This +parameter is mandatory when used within the **ApplicationPoolIdentity** parameter. Do not use this +parameter when a local CA is installed. ```yaml Type: String @@ -115,6 +153,7 @@ Accept wildcard characters: False ``` ### -Confirm + Prompts you for confirmation before running the cmdlet. ```yaml @@ -130,12 +169,13 @@ Accept wildcard characters: False ``` ### -Credential -Specifies a **PSCredential** object that this cmdlet use to connect to the NDES role service. -To obtain a credential object, use the **Get-Credential** cmdlet. -For more information, type `Get-Help Get-Credential`. -The NDES must be installed on a server that is a member of an Active Directory Domain Services (AD DS) domain. -If NDES is configured to use a Standalone CA, then an account that is a member of the local Administrators on the CA is required. -If NDES is installed to use an Enterprise CA, then using an account that is a member of Domain Admins group is required. + +Specifies a **PSCredential** object that this cmdlet use to connect to the NDES role service. To +obtain a credential object, use the `Get-Credential` cmdlet. For more information, type +`Get-Help Get-Credential`. The NDES must be installed on a server that is a member of an Active +Directory Domain Services (AD DS) domain. If NDES is configured to use a Standalone CA, then an +account that is a member of the local Administrators on the CA is required. If NDES is installed to +use an Enterprise CA, then using an account that is a member of Domain Admins group is required. ```yaml Type: PSCredential @@ -150,6 +190,7 @@ Accept wildcard characters: False ``` ### -EncryptionKeyLength + Specifies the encryption key length. This option is not valid if you use existing keys during installation. @@ -166,7 +207,9 @@ Accept wildcard characters: False ``` ### -EncryptionProviderName -Specifies the name of the encryption provider, such as the name of cryptographic service provider (CSP). + +Specifies the name of the encryption provider, such as the name of cryptographic service provider +(CSP). ```yaml Type: String @@ -181,6 +224,7 @@ Accept wildcard characters: False ``` ### -Force + Forces the command to run without asking for user confirmation. ```yaml @@ -196,6 +240,7 @@ Accept wildcard characters: False ``` ### -RACity + Specifies the city of the registration authority. ```yaml @@ -211,6 +256,7 @@ Accept wildcard characters: False ``` ### -RACompany + Specifies the organization or company that the registration authority represents. ```yaml @@ -226,6 +272,7 @@ Accept wildcard characters: False ``` ### -RACountry + Specifies the country of the registration authority. ```yaml @@ -241,6 +288,7 @@ Accept wildcard characters: False ``` ### -RADepartment + Specifies the department of the registration authority. ```yaml @@ -256,6 +304,7 @@ Accept wildcard characters: False ``` ### -RAEmail + Specifies the email address of the registration authority. ```yaml @@ -271,6 +320,7 @@ Accept wildcard characters: False ``` ### -RAName + Specifies the name of the NDES registration authority. ```yaml @@ -286,7 +336,9 @@ Accept wildcard characters: False ``` ### -RAState -Specifies the state or province (geographical political boundary), if applicable, of the registration authority. + +Specifies the state or province (geographical political boundary), if applicable, of the +registration authority. ```yaml Type: String @@ -301,6 +353,7 @@ Accept wildcard characters: False ``` ### -ServiceAccountName + Specifies the name of the account that is used by the Network Device Enrollment Service. ```yaml @@ -316,6 +369,7 @@ Accept wildcard characters: False ``` ### -ServiceAccountPassword + Specifies the password of the service account that is used by the Network Device Enrollment Service. ```yaml @@ -331,6 +385,7 @@ Accept wildcard characters: False ``` ### -SigningKeyLength + Specifies the signing key length. ```yaml @@ -346,6 +401,7 @@ Accept wildcard characters: False ``` ### -SigningProviderName + Specifies the name of the signing device. ```yaml @@ -361,6 +417,7 @@ Accept wildcard characters: False ``` ### -WhatIf + Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml @@ -376,7 +433,11 @@ Accept wildcard characters: False ``` ### CommonParameters -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). + +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). ## INPUTS @@ -395,14 +456,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ### Microsoft.CertificateServices.Deployment.Common.NDES.NetworkDeviceEnrollmentServiceResult ## NOTES -* Ensure you run Windows PowerShell as an administrator. You can use the *Force* parameter to bypass the prompt for confirmation. -To see parameters, run the following command: `Install-AdcsNetworkDeviceEnrollmentService -?` - +- Ensure you run Windows PowerShell as an administrator. You can use the **Force** parameter to bypass + the prompt for confirmation. To see parameters, run the following command: + `Install-AdcsNetworkDeviceEnrollmentService -?` ## RELATED LINKS [Uninstall-AdcsNetworkDeviceEnrollmentService](./Uninstall-AdcsNetworkDeviceEnrollmentService.md) [Get-Credential](https://go.microsoft.com/fwlink/?LinkID=293936) - From c57f4892df762555017967e7b28976efd4c636b9 Mon Sep 17 00:00:00 2001 From: Missy Januszko Date: Fri, 28 Apr 2023 12:22:40 -0400 Subject: [PATCH 199/650] add backticks --- .../defender/Add-MpPreference.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/docset/winserver2022-ps/defender/Add-MpPreference.md b/docset/winserver2022-ps/defender/Add-MpPreference.md index 7bcdb31a2d..96c95090d6 100644 --- a/docset/winserver2022-ps/defender/Add-MpPreference.md +++ b/docset/winserver2022-ps/defender/Add-MpPreference.md @@ -190,7 +190,7 @@ Accept wildcard characters: False ### -ExclusionExtension -Specifies an array of file name extensions, such as obj or lib, to exclude from scheduled, custom, +Specifies an array of file name extensions, such as `obj` or `lib`, to exclude from scheduled, custom, and real-time scanning. This cmdlet adds these file name extensions to the exclusions. ```yaml @@ -278,13 +278,13 @@ Accept wildcard characters: False Specifies an array of the actions to take for the IDs specified by using the **ThreatIDDefaultAction_Ids** parameter. The acceptable values for this parameter are: -- 1: Clean -- 2: Quarantine -- 3: Remove -- 6: Allow -- 8: UserDefined -- 9: NoAction -- 10: Block +- `1`: Clean +- `2`: Quarantine +- `3`: Remove +- `6`: Allow +- `8`: UserDefined +- `9`: NoAction +- `10`: Block ```yaml Type: ThreatAction[] From 21958329fa06c8394fbacd55b151e2a09c1b08a2 Mon Sep 17 00:00:00 2001 From: Michael Date: Fri, 28 Apr 2023 10:02:37 -0700 Subject: [PATCH 200/650] Update docset/winserver2022-ps/adcsdeployment/Install-AdcsWebEnrollment.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- .../adcsdeployment/Install-AdcsWebEnrollment.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/adcsdeployment/Install-AdcsWebEnrollment.md b/docset/winserver2022-ps/adcsdeployment/Install-AdcsWebEnrollment.md index c1e3cf65b4..c0be238bf9 100644 --- a/docset/winserver2022-ps/adcsdeployment/Install-AdcsWebEnrollment.md +++ b/docset/winserver2022-ps/adcsdeployment/Install-AdcsWebEnrollment.md @@ -162,7 +162,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable - Ensure you run Windows PowerShell as an administrator. You can use the **Force** parameter to bypass the prompt for confirmation. To see parameters, run the following command: - `Install-AdcsWebEnrollment -?` + + `Install-AdcsWebEnrollment -?` ## RELATED LINKS From f0d5f0cda7f81140e514ef2fa125d79a4d8b2581 Mon Sep 17 00:00:00 2001 From: Michael Date: Fri, 28 Apr 2023 10:04:11 -0700 Subject: [PATCH 201/650] Update docset/winserver2022-ps/adcsdeployment/Install-AdcsOnlineResponder.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- .../adcsdeployment/Install-AdcsOnlineResponder.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/adcsdeployment/Install-AdcsOnlineResponder.md b/docset/winserver2022-ps/adcsdeployment/Install-AdcsOnlineResponder.md index 708cb93bd6..165a724c60 100644 --- a/docset/winserver2022-ps/adcsdeployment/Install-AdcsOnlineResponder.md +++ b/docset/winserver2022-ps/adcsdeployment/Install-AdcsOnlineResponder.md @@ -141,7 +141,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable - Ensure you run Windows PowerShell as an administrator. You can use the **Force** parameter to bypass the prompt for confirmation. To see parameters, run the following command: - `Install-AdcsOnlineResponder -?` + + `Install-AdcsOnlineResponder -?` ## RELATED LINKS From 6aad9b170917a1ee8c3ae676a5439b105157c46a Mon Sep 17 00:00:00 2001 From: Phil Bossman Date: Fri, 28 Apr 2023 10:04:50 -0700 Subject: [PATCH 202/650] Backup-GPO --- .../grouppolicy/Backup-GPO.md | 156 +++++++++++------- 1 file changed, 96 insertions(+), 60 deletions(-) diff --git a/docset/winserver2022-ps/grouppolicy/Backup-GPO.md b/docset/winserver2022-ps/grouppolicy/Backup-GPO.md index a97f3ac027..75b88aa35f 100644 --- a/docset/winserver2022-ps/grouppolicy/Backup-GPO.md +++ b/docset/winserver2022-ps/grouppolicy/Backup-GPO.md @@ -11,79 +11,95 @@ title: Backup-GPO # Backup-GPO ## SYNOPSIS + Backs up one GPO or all the GPOs in a domain. ## SYNTAX ### BackupOne(GUID) (Default) + ``` -Backup-GPO -Guid -Path [-Comment ] [-Domain ] [-Server ] [-WhatIf] - [-Confirm] [] +Backup-GPO -Guid -Path [-Comment ] [-Domain ] [-Server ] + [-WhatIf] [-Confirm] [] ``` ### BackupOne(Name) + ``` -Backup-GPO [-Name] -Path [-Comment ] [-Domain ] [-Server ] [-WhatIf] - [-Confirm] [] +Backup-GPO [-Name] -Path [-Comment ] [-Domain ] + [-Server ] [-WhatIf] [-Confirm] [] ``` ### BackupAll + ``` -Backup-GPO -Path [-Comment ] [-Domain ] [-Server ] [-All] [-WhatIf] [-Confirm] - [] +Backup-GPO -Path [-Comment ] [-Domain ] [-Server ] [-All] + [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION -The **Backup-GPO** cmdlet backs up a specified Group Policy Object (GPO) or all the GPOs in a domain to a backup directory. -The backup directory and GPO must already exist. + +The **Backup-GPO** cmdlet backs up a specified Group Policy Object (GPO) or all the GPOs in a domain +to a backup directory. The backup directory and GPO must already exist. ## EXAMPLES ### Example 1: Backup a GPO to a specific directory + +```powershell +Backup-Gpo -Name TestGPO -Path C:\GpoBackups -Comment "Weekly Backup" ``` -PS C:\> Backup-Gpo -Name TestGPO -Path C:\GpoBackups -Comment "Weekly Backup" -DisplayName : TestGPO +```output +DisplayName : TestGPO GpoId : 35c12ab3-956c-45d5-973b-46b17d225f47 - Id : 2b509d4e-40f5-4337-82f7-458584555d0c - BackupDirectory : C:\GpoBackups - CreationTime : 2/25/2009 8:48:19 PM - DomainName : contoso.com - Comment : Weekly Backup ``` -This command backs up the "TestGPO" GPO to the C:\GpoBackups directory. +This command backs up the `TestGPO` GPO to the `C:\GpoBackups` directory. The specified comment is included in the GPO backup. ### Example 2: Backup a GPO with the specified GUID to a directory -``` -PS C:\> Backup-Gpo -GUID fa4a9473-6e2a-4b87-ab78-175e68d97bde -Domain "contoso.com" -Server "DC1" -Path "\\Server1\GpoBackups" + +```powershell +$params = @{ + GUID = 'fa4a9473-6e2a-4b87-ab78-175e68d97bde' + Domain = 'contoso.com' + Server = 'DC1' + Path = '\\Server1\GpoBackups' +} +Backup-Gpo @params ``` -This command backs up the GPO with the specified GUID in the contoso.com domain to the \\\\Server1\GpoBackups directory. -The domain controller at DC1.contoso.com is contacted to complete the operation. +This command backs up the GPO with the specified **GUID** in the `contoso.com` domain to the +`\\Server1\GpoBackups` directory. The domain controller at `DC1` is contacted to complete +the operation. -If the domain of the user running the session (or, for startup and shutdown scripts, the computer) is different from the contoso.com domain, a trust must exist between the two domains or the command fails. +If the domain of the user running the session (or, for startup and shutdown scripts, the computer) +is different from the `contoso.com` domain, a trust must exist between the two domains or the command +fails. ### Example 3: Backup all GPOs in the domain of the user that is running the session + ``` -PS C:\> Backup-Gpo -All -Path "\\Server1\GpoBackups" +Backup-Gpo -All -Path "\\Server1\GpoBackups" ``` -This command backs up all the GPOs in the domain of the user that is running the session (or, for startup and shutdown scripts, the computer) to the \\\\Server1\GpoBackups directory. +This command backs up all the GPOs in the domain of the user that is running the session (or, for +startup and shutdown scripts, the computer) to the `\\Server1\GpoBackups` directory. ## PARAMETERS ### -All + Specifies that all the GPOs in the domain are backed up. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: BackupAll Aliases: @@ -95,11 +111,12 @@ Accept wildcard characters: False ``` ### -Comment -Specifies a comment for the backed-up GPO. -The comment string must be enclosed in double-quotation or single-quotation marks and can contain 2,047 characters. + +Specifies a comment for the backed-up GPO. The comment string must be enclosed in double-quotation +or single-quotation marks and can contain 2,047 characters. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -111,10 +128,11 @@ Accept wildcard characters: False ``` ### -Confirm + Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf @@ -126,21 +144,25 @@ Accept wildcard characters: False ``` ### -Domain -Specifies the domain for this cmdlet. -You must specify the fully qualified domain name (FQDN) of the domain (for example: sales.contoso.com). + +Specifies the domain for this cmdlet. You must specify the fully qualified domain name (FQDN) of the +domain (for example: sales.contoso.com). For the **Backup-GPO** cmdlet, the GPO to back up must exist in this domain. -If you do not specify the *Domain* parameter, the domain of the user that is running the current session is used. -(If the cmdlet is being run from a computer startup or shutdown script, the domain of the computer is used.) For more information, see the Notes section in the full Help. +If you do not specify the **Domain** parameter, the domain of the user that is running the current +session is used. (If the cmdlet is being run from a computer startup or shutdown script, the domain +of the computer is used.) For more information, see the Notes section in the full Help. -If you specify a domain that is different from the domain of the user that is running the current session (or, for a startup or shutdown script, the computer), a trust must exist between that domain and the domain of the user (or the computer). +If you specify a domain that is different from the domain of the user that is running the current +session (or, for a startup or shutdown script, the computer), a trust must exist between that domain +and the domain of the user (or the computer). -You can also refer to Domain by its built-in alias, domainname. -For more information, see about_Aliases. +You can also refer to Domain by its built-in alias, domain name. +For more information, see [about_Aliases](????????). ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: DomainName @@ -152,14 +174,15 @@ Accept wildcard characters: False ``` ### -Guid + Specifies the GPO to backup by its globally unique identifier (GUID). -The GUID uniquely identifies the GPO. +The `GUID` uniquely identifies the GPO. -You can also refer to the *Guid* parameter by its built-in alias, id. -For more information, see **about_Aliases**. +You can also refer to the **Guid** parameter by its built-in alias, id. +For more information, see [about_Aliases](????????????). ```yaml -Type: Guid +Type: Guid ???????????? Parameter Sets: BackupOne(GUID) Aliases: Id @@ -171,17 +194,18 @@ Accept wildcard characters: False ``` ### -Name + Specifies the GPO to backup by its display name. The display name is not guaranteed to be unique in the domain. If another GPO with the same display name exists in the domain an error occurs. -You can use the *Guid* parameter to uniquely identify a GPO. +You can use the **Guid** parameter to uniquely identify a GPO. -You can also refer to the Name parameter by its built-in alias, displayname. -For more information, see **about_Aliases**. +You can also refer to the Name parameter by its built-in alias, **DisplayName**. +For more information, see [about_Aliases](??????????????). ```yaml -Type: String +Type: System.String Parameter Sets: BackupOne(Name) Aliases: DisplayName @@ -193,12 +217,13 @@ Accept wildcard characters: False ``` ### -Path -Specifies the path to the backup directory; for instance, "C:\Backups" or "\\\\MyServer\Backups". + +Specifies the path to the backup directory; for instance, `C:\Backups` or `\\MyServer\Backups`. ```yaml -Type: String +Type: System.String Parameter Sets: (All) -Aliases: backupLocation +Aliases: BackupLocation Required: True Position: Named @@ -208,13 +233,14 @@ Accept wildcard characters: False ``` ### -Server + Specifies the name of the domain controller that this cmdlet contacts to complete the operation. You can specify either the fully qualified domain name (FQDN) or the host name. -If you do not specify the name by using the *Server* parameter, the PDC emulator is contacted. +If you do not specify the name by using the **Server** parameter, the PDC emulator is contacted. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: DC @@ -226,11 +252,12 @@ Accept wildcard characters: False ``` ### -WhatIf + Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi @@ -242,29 +269,38 @@ Accept wildcard characters: False ``` ### CommonParameters -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). + +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). ## INPUTS ### Microsoft.GroupPolicy.Gpo + A GPO to be backed up. Collections that contain GPOs from different domains are not supported. ## OUTPUTS ### Microsoft.GroupPolicy.GpoBackup + This cmdlet returns an object that represents the file that holds the settings of the backed-up GPO. ## NOTES -* You can use the *Domain* parameter to explicitly specify the domain for this cmdlet. - - If you do not explicitly specify the domain, the cmdlet uses a default domain. -The default domain is the domain that is used to access network resources by the security context under which the current session is running. -This domain is typically the domain of the user that is running the session. -For instance, the domain of the user who started the session by opening Windows PowerShell from the Program Files menu, or the domain of a user that is specified in a runas command. -However, computer startup and shutdown scripts run under the context of the LocalSystem account. -The LocalSystem account is a built-in local account, and it accesses network resources under the context of the computer account. -Therefore, when this cmdlet is run from a startup or shutdown script, the default domain is the domain to which the computer is joined. + +* You can use the **Domain** parameter to explicitly specify the domain for this cmdlet. + + If you do not explicitly specify the domain, the cmdlet uses a default domain. The default domain + is the domain that is used to access network resources by the security context under which the + current session is running. This domain is typically the domain of the user that is running the + session. For instance, the domain of the user who started the session by opening Windows + PowerShell from the Program Files menu, or the domain of a user that is specified in a runas + command. However, computer startup and shutdown scripts run under the context of the LocalSystem + account. The LocalSystem account is a built-in local account, and it accesses network resources + under the context of the computer account. Therefore, when this cmdlet is run from a startup or + shutdown script, the default domain is the domain to which the computer is joined. ## RELATED LINKS From 274a6205d27e13fce9e78c60e59cde6b43de209d Mon Sep 17 00:00:00 2001 From: Michael Date: Fri, 28 Apr 2023 10:09:12 -0700 Subject: [PATCH 203/650] Update docset/winserver2022-ps/adcsdeployment/Install-AdcsNetworkDeviceEnrollmentService.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- .../Install-AdcsNetworkDeviceEnrollmentService.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/adcsdeployment/Install-AdcsNetworkDeviceEnrollmentService.md b/docset/winserver2022-ps/adcsdeployment/Install-AdcsNetworkDeviceEnrollmentService.md index eaaf43bd58..ae7a518bce 100644 --- a/docset/winserver2022-ps/adcsdeployment/Install-AdcsNetworkDeviceEnrollmentService.md +++ b/docset/winserver2022-ps/adcsdeployment/Install-AdcsNetworkDeviceEnrollmentService.md @@ -459,7 +459,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable - Ensure you run Windows PowerShell as an administrator. You can use the **Force** parameter to bypass the prompt for confirmation. To see parameters, run the following command: - `Install-AdcsNetworkDeviceEnrollmentService -?` + + `Install-AdcsNetworkDeviceEnrollmentService -?` ## RELATED LINKS From 144aa2a41f5e2b072f192bff2983f956fb32ce2b Mon Sep 17 00:00:00 2001 From: Michael Date: Fri, 28 Apr 2023 10:09:38 -0700 Subject: [PATCH 204/650] Update docset/winserver2022-ps/adcsdeployment/Install-AdcsNetworkDeviceEnrollmentService.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- .../Install-AdcsNetworkDeviceEnrollmentService.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/adcsdeployment/Install-AdcsNetworkDeviceEnrollmentService.md b/docset/winserver2022-ps/adcsdeployment/Install-AdcsNetworkDeviceEnrollmentService.md index ae7a518bce..e98a27bb33 100644 --- a/docset/winserver2022-ps/adcsdeployment/Install-AdcsNetworkDeviceEnrollmentService.md +++ b/docset/winserver2022-ps/adcsdeployment/Install-AdcsNetworkDeviceEnrollmentService.md @@ -170,7 +170,7 @@ Accept wildcard characters: False ### -Credential -Specifies a **PSCredential** object that this cmdlet use to connect to the NDES role service. To +Specifies a **PSCredential** object that this cmdlet uses to connect to the NDES role service. To obtain a credential object, use the `Get-Credential` cmdlet. For more information, type `Get-Help Get-Credential`. The NDES must be installed on a server that is a member of an Active Directory Domain Services (AD DS) domain. If NDES is configured to use a Standalone CA, then an From 0904a986abc2b310f7fe7d996e7171b6407347ec Mon Sep 17 00:00:00 2001 From: Michael Date: Fri, 28 Apr 2023 10:09:52 -0700 Subject: [PATCH 205/650] Update docset/winserver2022-ps/adcsdeployment/Install-AdcsNetworkDeviceEnrollmentService.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- .../Install-AdcsNetworkDeviceEnrollmentService.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/adcsdeployment/Install-AdcsNetworkDeviceEnrollmentService.md b/docset/winserver2022-ps/adcsdeployment/Install-AdcsNetworkDeviceEnrollmentService.md index e98a27bb33..f46637c5da 100644 --- a/docset/winserver2022-ps/adcsdeployment/Install-AdcsNetworkDeviceEnrollmentService.md +++ b/docset/winserver2022-ps/adcsdeployment/Install-AdcsNetworkDeviceEnrollmentService.md @@ -136,7 +136,7 @@ Accept wildcard characters: False ### -CAConfig -Specifies remote certification authority (CA) that the Network Device Enrollment Service uses. This +Specifies the remote certification authority (CA) that the Network Device Enrollment Service uses. This parameter is mandatory when used within the **ApplicationPoolIdentity** parameter. Do not use this parameter when a local CA is installed. From 7634b815f38bc02e565fe50b05aaf99411c2f823 Mon Sep 17 00:00:00 2001 From: Michael Date: Fri, 28 Apr 2023 10:13:51 -0700 Subject: [PATCH 206/650] Update Install-AdcsNetworkDeviceEnrollmentService.md --- .../Install-AdcsNetworkDeviceEnrollmentService.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docset/winserver2022-ps/adcsdeployment/Install-AdcsNetworkDeviceEnrollmentService.md b/docset/winserver2022-ps/adcsdeployment/Install-AdcsNetworkDeviceEnrollmentService.md index f46637c5da..e97b1ee959 100644 --- a/docset/winserver2022-ps/adcsdeployment/Install-AdcsNetworkDeviceEnrollmentService.md +++ b/docset/winserver2022-ps/adcsdeployment/Install-AdcsNetworkDeviceEnrollmentService.md @@ -118,8 +118,8 @@ the local computer's `IIS_USRS` group. The command also specifies several non-de ### -ApplicationPoolIdentity -Indicates that the cmdlet the identity that the Network Device Enrollment Service (NDES) uses when -communicating with the certification authority (CA). This parameter is only valid when NDES is using +Indicates the identity that the Network Device Enrollment Service (NDES) uses when communicating +with the certification authority (CA). This parameter is only valid when NDES is using a remote CA. If the CA is local, the application pool identity account cannot be used. ```yaml From 8bcc337e5877a1fe495b93a5eef99d16a722b872 Mon Sep 17 00:00:00 2001 From: Phil Bossman Date: Fri, 28 Apr 2023 10:17:47 -0700 Subject: [PATCH 207/650] Copy-GPO --- .../winserver2022-ps/grouppolicy/Copy-GPO.md | 249 +++++++++++------- 1 file changed, 150 insertions(+), 99 deletions(-) diff --git a/docset/winserver2022-ps/grouppolicy/Copy-GPO.md b/docset/winserver2022-ps/grouppolicy/Copy-GPO.md index 525a1af1b3..7dfa83cf2e 100644 --- a/docset/winserver2022-ps/grouppolicy/Copy-GPO.md +++ b/docset/winserver2022-ps/grouppolicy/Copy-GPO.md @@ -11,108 +11,131 @@ title: Copy-GPO # Copy-GPO ## SYNOPSIS + Copies a GPO. ## SYNTAX ### SourcebyGUID (Default) + ``` Copy-GPO -SourceGuid -TargetName [-SourceDomain ] [-TargetDomain ] - [-SourceDomainController ] [-TargetDomainController ] [-MigrationTable ] [-CopyAcl] - [-WhatIf] [-Confirm] [] + [-SourceDomainController ] [-TargetDomainController ] [-MigrationTable ] + [-CopyAcl] [-WhatIf] [-Confirm] [] ``` ### SourcebyName + ``` -Copy-GPO [-SourceName] -TargetName [-SourceDomain ] [-TargetDomain ] - [-SourceDomainController ] [-TargetDomainController ] [-MigrationTable ] [-CopyAcl] - [-WhatIf] [-Confirm] [] +Copy-GPO [-SourceName] -TargetName [-SourceDomain ] + [-TargetDomain ] [-SourceDomainController ] [-TargetDomainController ] + [-MigrationTable ] [-CopyAcl] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION -The **Copy-GPO** cmdlet creates a destination Group Policy Object (GPO) and copies the settings from the source GPO to the new GPO. -The cmdlet can be used to copy a GPO from one domain to another domain within the same forest. -You can specify a migration table to map security principals and paths when copying across domains. -You can also specify whether to copy the access control list (ACL) from the source GPO to the destination GPO. -This cmdlet does not copy the source GPO if a GPO with the specified target display name already exists in the destination domain. -In this case, an error occurs and the GPO is not copied. +The **Copy-GPO** cmdlet creates a destination Group Policy Object (GPO) and copies the settings from +the source GPO to the new GPO. The cmdlet can be used to copy a GPO from one domain to another +domain within the same forest. You can specify a migration table to map security principals and +paths when copying across domains. You can also specify whether to copy the access control list +(ACL) from the source GPO to the destination GPO. + +This cmdlet does not copy the source GPO if a GPO with the specified target display name already +exists in the destination domain. In this case, an error occurs and the GPO is not copied. ## EXAMPLES ### Example 1: Copy a GPO + +```powershell +Copy-GPO -SourceName "TestGpo1" -TargetName "TestGpo2" ``` -PS C:\> Copy-GPO -SourceName "TestGpo1" -TargetName "TestGpo2" -DisplayName : TestGpo2 +```Output +DisplayName : TestGpo2 DomainName : contoso.com - Owner : CONTOSO\Domain - Admins Id : 37eeb072-cc31-42bb-8c3a-446c2b6ddd3f - GpoStatus : AllSettingsEnabled - Description : - CreationTime : 2/25/2009 9:12:05 PM - ModificationTime : 2/25/2009 9:12:05 PM - UserVersion : AD Version: 1, SysVol Version: 1 - ComputerVersion : AD Version: 1, SysVol Version: 1 - WmiFilter : ``` -This command copies the TestGpo1 GPO to a GPO named TestGpo2. +This command copies the `TestGpo1` GPO to a GPO named `TestGpo2`. The GPOs exist in the domain of the user that is running the session. ### Example 2: Copy a GPO from a domain to another domain -``` -PS C:\> Copy-GPO -SourceName "TestGpo1" -SourceDomain "test.contoso.com" TargetName "TestGpo1" -TargetDomain "sales.contoso.com" + +```powershell +$params = @{ + SourceName = 'TestGpo1"' + SourceDomain = 'test.contoso.com' + TargetName = 'TestGpo1' + TargetDomain = 'sales.contoso.com' +} +Copy-GPO @params ``` -This command copies the TestGpo1 GPO from the test.contoso.com domain to a GPO named TestGpo1 in the sales.contoso.com domain. +This command copies the `TestGpo1` GPO from the `test.contoso.com` domain to a GPO named `TestGpo1` +in the `sales.contoso.com` domain. -A trust relationship must exist between the source domain and the destination domain. -In addition, if the source domain or the destination domain (or both) is different than the domain of the user that is running the session.a trust must exist between that domain and the domain of the user. +A trust relationship must exist between the source domain and the destination domain. In addition, +if the source domain or the destination domain (or both) is different than the domain of the user +that is running the session.a trust must exist between that domain and the domain of the user. ### Example 3: Copy all GPOs from a domain to another domain -``` -PS C:\> Get-GPO -All -Domain "sales1.contoso.com" | ForEach-Object {$_ | Copy-GPO -TargetName ($_.DisplayName) -TargetDomain "sales2.contoso.com" -CopyAcl -MigrationTable "c:\tables\MigrationTable.migtable"} -``` -This command copies all the GPOs in the sales1.contoso.com domain to the sales2.contoso.com domain. +```powershell +Get-GPO -All -Domain "sales1.contoso.com" | ForEach-Object { + $params = @{ + 'TargetName' = $_.DisplayName + } -All the GPOs in the source domain are retrieved by using the **Get-GPO** cmdlet using the *All* parameter. -The output of **Get-GPO** is piped into the ForEach-Object command. -When each GPO is evaluated, it is piped into **Copy-GPO** and its display name is specified for the *TargetName* parameter "-TargetName ($_.DisplayName)". -The *CopyACL* parameter is specified to copy the ACLs for each GPO to the destination domain. -The *MigrationTable* parameter specifies a migration table to use to migrate Security principals and UNC paths to the destination domain. -Both the *CopyACL* and the *MigrationTable* parameters are optional. +?????????????????????? -If a GPO with the same display name as a source GPO already exists in the destination domain, an error occurs when this command attempts to copy the source GPO. -Because this command copies all GPOs in the source domain, errors occur for default GPOs; for instance, the Default Domain Policy GPO and the Default Domain Controllers Policy GPO. -These GPOs are not copied. -You can suppress these error messages by supplying the *ErrorAction* parameter with a value of SilentlyContinue to **Copy-GPO**. -For more information about the *ErrorAction* parameter, see about_CommonParameters. + $_ | Copy-GPO -TargetName ($_.DisplayName) -TargetDomain "sales2.contoso.com" -CopyAcl -MigrationTable 'c:\tables\MigrationTable.migtable' } +``` -The destination GPOs that were successfully copied are returned by this command. -By default, they are printed to the display, but you can add commands to the end of the pipeline to further configure these GPOs. -For example you can add a Set-GPLink cmdlet to the end of the pipeline to link all the destination GPOs to a site, domain, or organizational unit. +This command copies all the GPOs in the sales1.contoso.com domain to the sales2.contoso.com domain. -A trust relationship must exist between the source domain and the destination domain. -In addition, if the source domain or the destination domain (or both) is different than the domain of the user that is running the session a trust must exist between that domain and the domain of the user or the computer. +All the GPOs in the source domain are retrieved by using the **Get-GPO** cmdlet using the **All** +parameter. The output of **Get-GPO** is piped into the ForEach-Object command. When each GPO is +evaluated, it is piped into **Copy-GPO** and its display name is specified for the **TargetName** +parameter `-TargetName ($_.DisplayName)`. The **CopyACL** parameter is specified to copy the ACLs for +each GPO to the destination domain. The **MigrationTable** parameter specifies a migration table to +use to migrate Security principals and UNC paths to the destination domain. Both the **CopyACL** and +the **MigrationTable** parameters are optional. + +If a GPO with the same display name as a source GPO already exists in the destination domain, an +error occurs when this command attempts to copy the source GPO. Because this command copies all GPOs +in the source domain, errors occur for default GPOs; for instance, the Default Domain Policy GPO and +the Default Domain Controllers Policy GPO. These GPOs are not copied. You can suppress these error +messages by supplying the **ErrorAction** parameter with a value of SilentlyContinue to +**Copy-GPO**. For more information about the **ErrorAction** parameter, see +[about_CommonParameters](?????????). + +The destination GPOs that were successfully copied are returned by this command. By default, they +are printed to the display, but you can add commands to the end of the pipeline to further configure +these GPOs. For example you can add a Set-GPLink cmdlet to the end of the pipeline to link all the +destination GPOs to a site, domain, or organizational unit. + +A trust relationship must exist between the source domain and the destination domain. In addition, +if the source domain or the destination domain (or both) is different than the domain of the user +that is running the session a trust must exist between that domain and the domain of the user or the +computer. ## PARAMETERS ### -Confirm + Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf @@ -124,10 +147,11 @@ Accept wildcard characters: False ``` ### -CopyAcl + Indicates that the cmdlet copies the ACL of the source GPO to the destination GPO. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -139,13 +163,15 @@ Accept wildcard characters: False ``` ### -MigrationTable -Specifies the location of the migration table to use for the command. -You must specify the full path to the file; for instance, \\\\Server1\MigrationTables\TestToSalesTable.migtable. -If you supply a migration table, security principals and Universal Naming Convention (UNC) paths are mapped to the destination GPO when you copy a GPO across domains. -If you do not supply a migration table, security principals and UNC paths are not modified in the destination GPO. + +Specifies the location of the migration table to use for the command. You must specify the full path +to the file; for instance, `\\Server1\MigrationTables\TestToSalesTable.migtable`. If you supply a +migration table, security principals and Universal Naming Convention (UNC) paths are mapped to the +destination GPO when you copy a GPO across domains. If you do not supply a migration table, security +principals and UNC paths are not modified in the destination GPO. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -157,20 +183,23 @@ Accept wildcard characters: False ``` ### -SourceDomain + Specifies the domain of the source GPO. You must specify the fully qualified domain name (FQDN) of the domain. -If you do not specify the *SourceDomain* parameter, the domain of the user that is running the current session is used. -If the cmdlet is being run from a computer startup or shutdown script, the domain of the computer is used. -For more information, see the Notes section in the full Help. +If you do not specify the **SourceDomain** parameter, the domain of the user that is running the +current session is used. If the cmdlet is being run from a computer startup or shutdown script, the +domain of the computer is used. For more information, see the Notes section in the full Help. -If you specify a domain that is different from the domain of the user that is running the current session (or, for a startup or shutdown script, the computer), a trust must exist between that domain and the domain of the user or the computer. +If you specify a domain that is different from the domain of the user that is running the current +session (or, for a startup or shutdown script, the computer), a trust must exist between that domain +and the domain of the user or the computer. -You can also refer to the *SourceDomain* parameter by its built-in alias, domainname. -For more information, see about_Aliases. +You can also refer to the **SourceDomain** parameter by its built-in alias, **DomainName**. For more +information, see [about_Aliases](/powershell/module/microsoft.powershell.core/about/about_aliases). ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: DomainName @@ -182,13 +211,15 @@ Accept wildcard characters: False ``` ### -SourceDomainController -Specifies the name of the domain controller that this cmdlet contacts for the source domain. -You can specify either the fully qualified domain name (FQDN) or the host name. -If you do not specify the name by using the *SourceDomainController* parameter, the primary domain controller (PDC) emulator is contacted. +Specifies the name of the domain controller that this cmdlet contacts for the source domain. You can +specify either the fully qualified domain name (FQDN) or the host name. + +If you do not specify the name by using the **SourceDomainController** parameter, the primary domain +controller (PDC) emulator is contacted. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -200,13 +231,14 @@ Accept wildcard characters: False ``` ### -SourceGuid -Specifies the source GPO by its globally unique identifier (GUID). -The GUID uniquely identifies the GPO. -You can also refer to the *SourceGuid* parameter by its built-in alias, id. +Specifies the source GPO by its globally unique identifier `GUID`. The `GUID` uniquely identifies the +GPO. + +You can also refer to the **SourceGuid** parameter by its built-in alias, `Id`. ```yaml -Type: Guid +Type: System.Management.Automation.Guid Parameter Sets: SourcebyGUID Aliases: Id @@ -218,16 +250,19 @@ Accept wildcard characters: False ``` ### -SourceName + Specifies the source GPO by its display name. -The display name is not guaranteed to be unique in the domain. -If another GPO with the same display name exists in the domain an error occurs. -You can use the *SourceGuid* parameter to uniquely identify a GPO. +The display name is not guaranteed to be unique in the domain. If another GPO with the same display +name exists in the domain an error occurs. You can use the **SourceGuid** parameter to uniquely +identify a GPO. -You can also refer to the *SourceName* parameter by its built-in alias, displayname. +You can also refer to the **SourceDomain** parameter by its built-in alias, **DomainName**. For more +information, see [about_Aliases](/powershell/module/microsoft.powershell.core/about/about_aliases). +parameter by its built-in alias, **DisplayName**. ```yaml -Type: String +Type: System.String Parameter Sets: SourcebyName Aliases: DisplayName @@ -239,17 +274,19 @@ Accept wildcard characters: False ``` ### -TargetDomain + Specifies the domain to which you want to copy the GPO. You must specify the fully qualified domain name (FQDN) of the domain. -If you do not specify the *TargetDomain* parameter, the domain of the user that is running the current session is used. -If the cmdlet is being run from a computer startup or shutdown script, the domain of the computer is used. -For more information, see the Notes section in the full Help. +If you do not specify the **TargetDomain** parameter, the domain of the user that is running the +current session is used. If the cmdlet is being run from a computer startup or shutdown script, the +domain of the computer is used. For more information, see the Notes section in the full Help. -If you specify a domain that is different from the domain of the user that is running the current session, a trust must exist between that domain and the domain of the user or the computer. +If you specify a domain that is different from the domain of the user that is running the current +session, a trust must exist between that domain and the domain of the user or the computer. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -261,13 +298,15 @@ Accept wildcard characters: False ``` ### -TargetDomainController + Specifies the name of the domain controller that this cmdlet contacts for the destination domain. You can specify either the FQDN or the host name. -If you do not specify the name by using the *TargetDomainController* parameter, the primary domain controller primary domain controller (PDC) emulator is contacted. +If you do not specify the name by using the **TargetDomainController** parameter, the primary domain +controller primary domain controller (PDC) emulator is contacted. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -279,11 +318,12 @@ Accept wildcard characters: False ``` ### -TargetName -Specifies the display name for the destination GPO. -If another GPO with the same display name exists in the target domain, an error occurs. + +Specifies the display name for the destination GPO. If another GPO with the same display name exists +in the target domain, an error occurs. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -295,11 +335,11 @@ Accept wildcard characters: False ``` ### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. + +Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi @@ -311,11 +351,16 @@ Accept wildcard characters: False ``` ### CommonParameters -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). + +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). ## INPUTS ### Microsoft.GroupPolicy.Gpo + The cmdlet takes a GPO as input. GPO objects that are piped into the cmdlet are used as the source GPO. Collections that contain GPOs from different domains are not supported. @@ -323,20 +368,26 @@ Collections that contain GPOs from different domains are not supported. ## OUTPUTS ### Microsoft.GroupPolicy.Gpo + This cmdlet outputs a copy of the specified GPO. ## NOTES -* You can use the **Copy-GPO** cmdlet to copy a GPO within a domain or from one domain to another within the same forest. - - You can use the *SourceDomain* and *TargetDomain* parameters to explicitly specify the source domain or the target domain for this cmdlet. - If you do not explicitly specify the domain, the cmdlet uses a default domain. -The default domain is the domain that is used to access network resources by the security context under which the current session is running. -This domain is typically the domain of the user that is running the session. -For example, the domain of the user who started the session by opening Windows PowerShell from the Program Files menu, or the domain of a user that is specified in a runas command. -However, computer startup and shutdown scripts run under the context of the LocalSystem account. -The LocalSystem account is a built-in local account, and it accesses network resources under the context of the computer account. -Therefore, when this cmdlet is run from a startup or shutdown script, the default domain is the domain to which the computer is joined. +* You can use the **Copy-GPO** cmdlet to copy a GPO within a domain or from one domain to another + within the same forest. + + You can use the **SourceDomain** and **TargetDomain** parameters to explicitly specify the source + domain or the target domain for this cmdlet. + + If you do not explicitly specify the domain, the cmdlet uses a default domain. The default domain + is the domain that is used to access network resources by the security context under which the + current session is running. This domain is typically the domain of the user that is running the + session. For example, the domain of the user who started the session by opening Windows PowerShell + from the Program Files menu, or the domain of a user that is specified in a runas command. + However, computer startup and shutdown scripts run under the context of the LocalSystem account. + The LocalSystem account is a built-in local account, and it accesses network resources under the + context of the computer account. Therefore, when this cmdlet is run from a startup or shutdown + script, the default domain is the domain to which the computer is joined. ## RELATED LINKS From 7872d44746f17c538cb3d3b182447349fa214676 Mon Sep 17 00:00:00 2001 From: Phil Bossman Date: Fri, 28 Apr 2023 10:41:01 -0700 Subject: [PATCH 208/650] Get-GPInheritance --- .../grouppolicy/Get-GPInheritance.md | 262 +++++++++--------- 1 file changed, 135 insertions(+), 127 deletions(-) diff --git a/docset/winserver2022-ps/grouppolicy/Get-GPInheritance.md b/docset/winserver2022-ps/grouppolicy/Get-GPInheritance.md index 6596bb565a..ef6812986e 100644 --- a/docset/winserver2022-ps/grouppolicy/Get-GPInheritance.md +++ b/docset/winserver2022-ps/grouppolicy/Get-GPInheritance.md @@ -11,6 +11,7 @@ title: Get-GPInheritance # Get-GPInheritance ## SYNOPSIS + Gets Group Policy inheritance information for a specified domain or OU. ## SYNTAX @@ -20,166 +21,160 @@ Get-GPInheritance [-Target] [-Domain ] [-Server ] [ Get-GPInheritance -Target "ou=MyOU,dc=contoso,dc=com" -ContainerName : myou - -ContainerType : OU - -Path : ou=myou,dc=contoso,dc=com - -GpoInheritanceBlocked : No -GpoLinks : {TestGPO-0, TestGPO-1, TestGPO-2, TestGPO-3...} +```powershell +Get-GPInheritance -Target 'ou=MyOU,dc=contoso,dc=com' +``` +```Output +ContainerName : myou +ContainerType : OU +Path : ou=myou,dc=contoso,dc=com +GpoInheritanceBlocked : No +GpoLinks : {TestGPO-0, TestGPO-1, TestGPO-2, TestGPO-3...} InheritedGpoLinks : {TestGPO-2, TestGPO-3, Default Domain Policy} ``` -This command gets Group Policy inheritance information for the OU named MyOU in the contoso.com domain. +This command gets Group Policy inheritance information for the OU named MyOU in the `contoso.com` +domain. -The **GpoLinks** property contains a list of all the GPOs that are linked directly to the GPO, whether their links are enabled or not. +The **GpoLinks** property contains a list of all the GPOs that are linked directly to the GPO, +whether their links are enabled or not. -The **InheritedGpoLinks** property contains a list of all the GPOs that are applied when Group Policy is processed on the client. -TestGPO-2 and TestGPO-3 appear in this list because their links are enabled. +The **InheritedGpoLinks** property contains a list of all the GPOs that are applied when Group +Policy is processed on the client. `TestGPO-2` and `TestGPO-3` appear in this list because their +links are enabled. -The Default Domain Policy GPO is inherited from the contoso.com domain. -If inheritance is blocked, it does not appear in the **InheritedGpoLinks** property unless its link is enforced at the domain. +The Default Domain Policy GPO is inherited from the `contoso.com` domain. If inheritance is blocked, +it does not appear in the **InheritedGpoLinks** property unless its link is enforced at the domain. If its link is enforced, it appears first in the list. ### Example 2: Get Group Policy inheritance for a specific domain -``` -PS C:\> Get-GPInheritance -Target "dc=contoso,dc=com" -Domain "contoso.com" -Server "DomainController1" -Name : contoso.com - -ContainerType : Domain - -Path : dc=contoso,dc=com - -GpoInheritanceBlocked : No - -GpoLinks : {Default Domain Policy} -InheritedGpoLinks : {Default Domain Policy} +```powershell +Get-GPInheritance -Target "dc=contoso,dc=com" -Domain "contoso.com" -Server "DomainController1" ``` -This command gets Group Policy inheritance information for the contoso.com domain. -The domain controller with the host name DomainController1 is contacted to complete the operation. - -The domain does not have to be explicitly specified using the *Domain* parameter in this example. -If the domain of the user that is running the session (or, for startup and shutdown scripts, the computer) is the same as the target domain, or a trust exists between it and the target domain, you do not have to specify the *Domain* parameter. - -### Example 3: Get GPOs that are linked to a specific organizational unit by evaluating the SOM object +```Output +Name : contoso.com +ContainerType : Domain +Path : dc=contoso,dc=com +GpoInheritanceBlocked : No +GpoLinks : {Default Domain Policy} +InheritedGpoLinks : {Default Domain Policy} ``` -PS C:\> (Get-GPInheritance -Target "ou=myou,dc=contoso,dc=com").GpoLinks | foreach-object { Get-GPO -Name ($_.DisplayName)} - -DisplayName : TestGPO-3 - -DomainName : contoso.com - -Owner : CONTOSO\Domain Admins - -Id : d02126d4-82e8-4e87-b4a0-2d44b6891411 - -GpoStatus : AllSettingsEnabled - -Description : - -CreationTime : 2/27/2009 2:59:51 PM - -ModificationTime : 2/27/2009 4:00:44 PM -UserVersion : AD Version: 13, SysVol Version: 13 +This command gets Group Policy inheritance information for the `contoso.com` domain. The domain +controller with the host name `DomainController1` is contacted to complete the operation. -ComputerVersion : AD Version: 0, SysVol Version: 0 +The domain does not have to be explicitly specified using the **Domain** parameter in this example. If +the domain of the user that is running the session (or, for startup and shutdown scripts, the +computer) is the same as the target domain, or a trust exists between it and the target domain, you +do not have to specify the **Domain** parameter. -WmiFilter : +### Example 3: Get GPOs that are linked to a specific organizational unit by evaluating the SOM + object +```powershell +(Get-GPInheritance -Target "ou=myou,dc=contoso,dc=com").GpoLinks | + Foreach-Object { Get-GPO -Name ($_.DisplayName) } +``` +```Output +DisplayName : TestGPO-3 +DomainName : contoso.com +Owner : CONTOSO\Domain Admins +Id : d02126d4-82e8-4e87-b4a0-2d44b6891411 +GpoStatus : AllSettingsEnabled +Description : +CreationTime : 2/27/2009 2:59:51 PM +ModificationTime : 2/27/2009 4:00:44 PM +UserVersion : AD Version: 13, SysVol Version: 13 +ComputerVersion : AD Version: 0, SysVol Version: 0 +WmiFilter : -DisplayName : TestGPO-2 - -DomainName : contoso.com - -Owner : CONTOSO\Domain Admins - -Id : 375865b2-3b5f-480f-8f56-2a994ea6e725 - -GpoStatus : AllSettingsEnabled - -Description : - -CreationTime : 2/26/2009 11:28:08 PM - -ModificationTime : 3/1/2009 11:07:30 AM - -UserVersion : AD Version: 0, SysVol Version: 0 - -ComputerVersion : AD Version: 1, SysVol Version: 1 +DisplayName : TestGPO-2 +DomainName : contoso.com +Owner : CONTOSO\Domain Admins +Id : 375865b2-3b5f-480f-8f56-2a994ea6e725 +GpoStatus : AllSettingsEnabled +Description : +CreationTime : 2/26/2009 11:28:08 PM +ModificationTime : 3/1/2009 11:07:30 AM +UserVersion : AD Version: 0, SysVol Version: 0 +ComputerVersion : AD Version: 1, SysVol Version: 1 WmiFilter : ``` -This command evaluates the SOM object (Microsoft.GroupPolicy.SOM) returned by **Get-GPInheritance** and returns the GPOs that are linked to the MyOU organizational unit. -You can use this command to set properties of the GPOs by piping its output into other cmdlets. -For instance, you can pipe the output to the **Set-GPPermissions** cmdlet to delegate permissions to administrators of the OU for each of the GPOs linked to the OU. +This command evaluates the SOM object `Microsoft.GroupPolicy.SOM` returned by **Get-GPInheritance** +and returns the GPOs that are linked to the MyOU organizational unit. You can use this command to +set properties of the GPOs by piping its output into other cmdlets. For instance, you can pipe the +output to the **Set-GPPermissions** cmdlet to delegate permissions to administrators of the OU for +each of the GPOs linked to the OU. The **GpoLinks** property of the SOM object contains a list of all the GPO links for the OU. -Each object in this list is of type **Microsoft.GroupPolicy.GpoLink**. +Each object in this list is of type `Microsoft.GroupPolicy.GpoLink`. The following shows one such object: -GpoId : d02126d4-82e8-4e87-b4a0-2d44b6891411 - +GpoId : d02126d4-82e8-4e87-b4a0-2d44b6891411 DisplayName : TestGPO-3 +Enabled : True +Enforced : False +Target : ou=myou,dc=contoso,dc=com +Order : 1 -Enabled : True - -Enforced : False - -Target : ou=myou,dc=contoso,dc=com - -Order : 1 - -The collection is piped into a foreach-object command, which retrieves each GPO by using the DisplayName property of the GpoLink object. +The collection is piped into a foreach-object command, which retrieves each GPO by using the +DisplayName property of the GpoLink object. ## PARAMETERS ### -Domain + Specifies the domain for this cmdlet. You must specify the fully qualified domain name (FQDN) of the domain. -For the **Get-GPInheritance** cmdlet, this is typically the domain of the container (domain or OU) for which you want to retrieve inheritance information. -If the specified domain is different than the domain of the container, a trust must exist between the two domains. +For the **Get-GPInheritance** cmdlet, this is typically the domain of the container (domain or OU) +for which you want to retrieve inheritance information. If the specified domain is different than +the domain of the container, a trust must exist between the two domains. -If you do not specify the *Domain* parameter, the domain of the user that is running the current session is used. -If the cmdlet is being run from a computer startup or shutdown script, the domain of the computer is used. -For more information, see the Notes section in the full Help. +If you do not specify the **Domain** parameter, the domain of the user that is running the current +session is used. If the cmdlet is being run from a computer startup or shutdown script, the domain +of the computer is used. For more information, see the Notes section in the full Help. -If you specify a domain that is different from the domain of the user that is running the current session (or, for a startup or shutdown script, the computer), a trust must exist between that domain and the domain of the user or the computer. +If you specify a domain that is different from the domain of the user that is running the current +session (or, for a startup or shutdown script, the computer), a trust must exist between that domain +and the domain of the user or the computer. -You can also refer to the *Domain* parameter by its built-in alias, domainname. -For more information, see about_Aliases. +You can also refer to the **Domain** parameter by its built-in alias, `DomainName`. For more +information, see [about_Aliases](???????). ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: DomainName @@ -191,15 +186,17 @@ Accept wildcard characters: False ``` ### -Server -Specifies the name of the domain controller that this cmdlet contacts to complete the operation. -You can specify either the fully qualified domain name (FQDN) or the host name. -If you do not specify the name by using the *Server* parameter, the primary domain controller (PDC) emulator is contacted. +Specifies the name of the domain controller that this cmdlet contacts to complete the operation. You +can specify either the fully qualified domain name (FQDN) or the host name. + +If you do not specify the name by using the **Server** parameter, the primary domain controller +(PDC) emulator is contacted. -You can also refer to the *Server* parameter by its built-in alias, dc. +You can also refer to the **Server** parameter by its built-in alias, dc. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: DC @@ -211,15 +208,17 @@ Accept wildcard characters: False ``` ### -Target -Specifies the domain or the OU for which to retrieve the Group Policy inheritance information by its Lightweight Directory Access Protocol (LDAP) distinguished name. -For instance, the MyOU organizational unit in the contoso.com domain is specified as ou=MyOU,dc=contoso,dc=com. -You can also refer to the *Target* parameter by its built-in alias, path. +Specifies the domain or the OU for which to retrieve the Group Policy inheritance information by its +Lightweight Directory Access Protocol (LDAP) distinguished name. For instance, the `MyOU` +organizational unit in the `contoso.com` domain is specified as `ou=MyOU,dc=contoso,dc=com`. + +You can also refer to the **Target** parameter by its built-in alias, **Path**. ```yaml -Type: String +Type: System.String Parameter Sets: (All) -Aliases: path +Aliases: Path Required: True Position: 0 @@ -229,30 +228,39 @@ Accept wildcard characters: False ``` ### CommonParameters -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). + +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). ## INPUTS ### Microsoft.GroupPolicy.Som + An object that represents a domain or an OU. ## OUTPUTS ### Microsoft.GroupPolicy.Som -This cmdlet returns an object that represents the domain or OU. -The **GpoInheritanceBlocked** property indicates whether inheritance is blocked. -You can modify inheritance for the domain or OU by using the **Set-GPInheritance** cmdlet. + +This cmdlet returns an object that represents the domain or OU. The **GpoInheritanceBlocked** +property indicates whether inheritance is blocked. You can modify inheritance for the domain or OU +by using the **Set-GPInheritance** cmdlet. ## NOTES + * You can use the *Domain* parameter to explicitly specify the domain for this cmdlet. - If you do not explicitly specify the domain, the cmdlet uses a default domain. -The default domain is the domain that is used to access network resources by the security context under which the current session is running. -This domain is typically the domain of the user that is running the session. -For example, the domain of the user who started the session by opening Windows PowerShell from the Program Files menu, or the domain of a user that is specified in a runas command. -However, computer startup and shutdown scripts run under the context of the LocalSystem account. -The LocalSystem account is a built-in local account, and it accesses network resources under the context of the computer account. -Therefore, when this cmdlet is run from a startup or shutdown script, the default domain is the domain to which the computer is joined. + If you do not explicitly specify the domain, the cmdlet uses a default domain. The default domain + is the domain that is used to access network resources by the security context under which the + current session is running. This domain is typically the domain of the user that is running the + session. For example, the domain of the user who started the session by opening Windows PowerShell + from the Program Files menu, or the domain of a user that is specified in a runas command. + However, computer startup and shutdown scripts run under the context of the LocalSystem account. + The LocalSystem account is a built-in local account, and it accesses network resources under the + context of the computer account. Therefore, when this cmdlet is run from a startup or shutdown + script, the default domain is the domain to which the computer is joined. ## RELATED LINKS From a9fae1e996966b868534a68c57db75c6c7038cba Mon Sep 17 00:00:00 2001 From: Phil Bossman Date: Fri, 28 Apr 2023 11:08:00 -0700 Subject: [PATCH 209/650] Backup-GPO --- docset/winserver2022-ps/grouppolicy/Backup-GPO.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/grouppolicy/Backup-GPO.md b/docset/winserver2022-ps/grouppolicy/Backup-GPO.md index 75b88aa35f..15e39f23f1 100644 --- a/docset/winserver2022-ps/grouppolicy/Backup-GPO.md +++ b/docset/winserver2022-ps/grouppolicy/Backup-GPO.md @@ -178,7 +178,7 @@ Accept wildcard characters: False Specifies the GPO to backup by its globally unique identifier (GUID). The `GUID` uniquely identifies the GPO. -You can also refer to the **Guid** parameter by its built-in alias, id. +You can also refer to the **Guid** parameter by its built-in alias, **Id**. For more information, see [about_Aliases](????????????). ```yaml From 610c2d1bbc6b9d69e9eb3ac44fa14a1094a962e7 Mon Sep 17 00:00:00 2001 From: Phil Bossman Date: Fri, 28 Apr 2023 11:08:24 -0700 Subject: [PATCH 210/650] Get-GPInheritance --- .../grouppolicy/Get-GPInheritance.md | 2 +- .../winserver2022-ps/grouppolicy/Get-GPO.md | 162 ++++++++++-------- .../grouppolicy/Get-GPOReport.md | 22 +-- .../grouppolicy/Get-GPPermission.md | 20 ++- .../grouppolicy/Get-GPPrefRegistryValue.md | 22 +-- .../grouppolicy/Get-GPRegistryValue.md | 20 ++- .../grouppolicy/Get-GPResultantSetOfPolicy.md | 10 +- .../grouppolicy/Get-GPStarterGPO.md | 21 ++- .../grouppolicy/Import-GPO.md | 32 ++-- .../grouppolicy/Invoke-GPUpdate.md | 16 +- .../grouppolicy/New-GPLink.md | 25 +-- .../winserver2022-ps/grouppolicy/New-GPO.md | 52 +++--- .../grouppolicy/New-GPStarterGPO.md | 22 +-- .../grouppolicy/Remove-GPLink.md | 25 +-- .../grouppolicy/Remove-GPO.md | 23 +-- .../grouppolicy/Remove-GPPrefRegistryValue.md | 28 +-- .../grouppolicy/Remove-GPRegistryValue.md | 28 +-- .../grouppolicy/Rename-GPO.md | 26 +-- .../grouppolicy/Restore-GPO.md | 28 +-- .../grouppolicy/Set-GPInheritance.md | 19 +- .../grouppolicy/Set-GPLink.md | 25 +-- .../grouppolicy/Set-GPPermission.md | 28 +-- .../grouppolicy/Set-GPPrefRegistryValue.md | 30 ++-- .../grouppolicy/Set-GPRegistryValue.md | 34 ++-- 24 files changed, 402 insertions(+), 318 deletions(-) diff --git a/docset/winserver2022-ps/grouppolicy/Get-GPInheritance.md b/docset/winserver2022-ps/grouppolicy/Get-GPInheritance.md index ef6812986e..d2d2b1413c 100644 --- a/docset/winserver2022-ps/grouppolicy/Get-GPInheritance.md +++ b/docset/winserver2022-ps/grouppolicy/Get-GPInheritance.md @@ -193,7 +193,7 @@ can specify either the fully qualified domain name (FQDN) or the host name. If you do not specify the name by using the **Server** parameter, the primary domain controller (PDC) emulator is contacted. -You can also refer to the **Server** parameter by its built-in alias, dc. +You can also refer to the **Server** parameter by its built-in alias, **DC**. ```yaml Type: System.String diff --git a/docset/winserver2022-ps/grouppolicy/Get-GPO.md b/docset/winserver2022-ps/grouppolicy/Get-GPO.md index 1c955208c6..8b298a097c 100644 --- a/docset/winserver2022-ps/grouppolicy/Get-GPO.md +++ b/docset/winserver2022-ps/grouppolicy/Get-GPO.md @@ -11,28 +11,34 @@ title: Get-GPO # Get-GPO ## SYNOPSIS + Gets one GPO or all the GPOs in a domain. ## SYNTAX ### ByGUID (Default) + ``` Get-GPO [-Guid] [[-Domain] ] [[-Server] ] [-All] [] ``` ### ByName + ``` Get-GPO [-Name] [[-Domain] ] [[-Server] ] [-All] [] ``` ### GetAll + ``` Get-GPO [[-Domain] ] [[-Server] ] [-All] [] ``` ## DESCRIPTION -The **Get-GPO** cmdlet gets one Group Policy Object (GPO) or all the GPOs in a domain. -You can specify a GPO by its display name or by its globally unique identifier (GUID) to get a single GPO, or you can get all the GPOs in the domain through the *All* parameter. + +The **Get-GPO** cmdlet gets one Group Policy Object (GPO) or all the GPOs in a domain. You can +specify a GPO by its display name or by its globally unique identifier (GUID) to get a single GPO, +or you can get all the GPOs in the domain through the **All** parameter. This cmdlet returns one or more objects that represent the requested GPOs. By default, properties of the requested GPOs are printed to the display; however, you can also pipe the output of the **Get-GPO** cmdlet to other Group Policy cmdlets. @@ -40,79 +46,71 @@ By default, properties of the requested GPOs are printed to the display; however ## EXAMPLES ### Example 1: Get a single GPO from a domain -``` -PS C:\> Get-GPO -Name "Group Policy Test" -DisplayName : Group Policy Test - -DomainName : contoso.com - -Owner : CONTOSO\Domain Admins - -Id : 31a09564-cd4a-4520-98fa-446a2af23b4b -GpoStatus : AllSettingsEnabled +```powershell +Get-GPO -Name "Group Policy Test" +``` +```Output +DisplayName : Group Policy Test +DomainName : contoso.com +Owner : CONTOSO\Domain Admins +Id : 31a09564-cd4a-4520-98fa-446a2af23b4b +GpoStatus : AllSettingsEnabled Description : - -CreationTime : 2/26/2009 12:15:42 AM - -ModificationTime : 2/26/2009 12:15:42 AM - -UserVersion : AD Version: 0, SysVol Version: 0 - -ComputerVersion : AD Version: 0, SysVol Version: 0 - +CreationTime : 2/26/2009 12:15:42 AM +ModificationTime : 2/26/2009 12:15:42 AM +UserVersion : AD Version: 0, SysVol Version: 0 +ComputerVersion : AD Version: 0, SysVol Version: 0 WmiFilter : ``` -This command gets the GPO named Group Policy Test. -The GPO must exist in the domain of the user that is running the session (or, for startup and shutdown scripts, the computer). -The command gets the GPO information by contacting the primary domain controller (PDC). +This command gets the GPO named `Group Policy Test`. The GPO must exist in the domain of the user that +is running the session (or, for startup and shutdown scripts, the computer). The command gets the +GPO information by contacting the primary domain controller (PDC). ### Example 2: Get a single GPO by GUID -``` -PS C:\> Get-GPO -Guid 31a09564-cd4a-4520-98fa-446a2af23b4b -Domain "sales.contoso.com" -DisplayName : Group Policy Test - -DomainName : sales.contoso.com -Owner : SALES\Domain Admins - -Id : 31a09564-cd4a-4520-98fa-446a2af23b4b - -GpoStatus : AllSettingsEnabled - -Description : - -CreationTime : 2/26/2009 12:15:42 AM - -ModificationTime : 2/26/2009 12:15:42 AM - -UserVersion : AD Version: 0, SysVol Version: 0 - -ComputerVersion : AD Version: 0, SysVol Version: 0 +```powershell +Get-GPO -Guid 31a09564-cd4a-4520-98fa-446a2af23b4b -Domain "sales.contoso.com" +``` +```Output +DisplayName : Group Policy Test +DomainName : sales.contoso.com +Owner : SALES\Domain Admins +Id : 31a09564-cd4a-4520-98fa-446a2af23b4b +GpoStatus : AllSettingsEnabled +Description : +CreationTime : 2/26/2009 12:15:42 AM +ModificationTime : 2/26/2009 12:15:42 AM +UserVersion : AD Version: 0, SysVol Version: 0 +ComputerVersion : AD Version: 0, SysVol Version: 0 WmiFilter : ``` -This command gets the GPO that has the ID (GUID) 331a09564-cd4a-4520-98fa-446a2af23b4b in the sales.contoso.com domain. -If the domain of the user that is running the session (or, for startup and shutdown scripts, the computer) is different that sales.contoso.com, a trust must exist between the two domains. -The command retrieves the GPO information by contacting the PDC (in the sales.contoso.com domain). +This command gets the GPO that has the ID (GUID) `331a09564-cd4a-4520-98fa-446a2af23b4b` in the +`sales.contoso.com` domain. If the domain of the user that is running the session (or, for startup and +shutdown scripts, the computer) is different that `sales.contoso.com`, a trust must exist between the +two domains. The command retrieves the GPO information by contacting the PDC (in the +`sales.contoso.com` domain). ### Example 3: Get all GPOs from a domain -``` -PS C:\> Get-GPO -All -Domain "sales.contoso.com" + +```powershell +Get-GPO -All -Domain "sales.contoso.com" ``` -This command get all the GPOs in the sales.contoso.com domain. +This command get all the GPOs in the `sales.contoso.com` domain. ## PARAMETERS ### -All + Indicates that the cmdlet gets all the GPOs in the domain. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -124,22 +122,23 @@ Accept wildcard characters: False ``` ### -Domain -Specifies the domain for this cmdlet. -You must specify the fully qualified domain name (FQDN) of the domain. + +Specifies the domain for this cmdlet. You must specify the fully qualified domain name (FQDN) of the +domain. For the **Get-GPO** cmdlet, the GPO (or GPOs) to that this cmdlet gets must exist in this domain. -If you do not specify the *Domain* parameter, the domain of the user that is running the current session is used. -If the cmdlet is being run from a computer startup or shutdown script, the domain of the computer is used. -For more information, see the Notes section in the full Help. +If you do not specify the **Domain** parameter, the domain of the user that is running the current +session is used. If the cmdlet is being run from a computer startup or shutdown script, the domain +of the computer is used. For more information, see the Notes section in the full Help. If you specify a domain that is different from the domain of the user that is running the current session (or, for a startup or shutdown script, the computer), a trust must exist between that domain and the domain of the user or the computer. -You can also refer to the *Domain* parameter by its built-in alias, domainname. -For more information, see about_Aliases. +You can also refer to the **Domain** parameter by its built-in alias, **DomainName**. +For more information, see [about_Aliases](????????????). ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: DomainName @@ -151,10 +150,11 @@ Accept wildcard characters: False ``` ### -Guid -Specifies the GPO to retrieve by its globally unique identifier (GUID). -The GUID uniquely identifies the GPO. -You can also refer to the *Guid* parameter by its built-in alias, id. +Specifies the GPO to retrieve by its globally unique identifier (GUID). The GUID uniquely identifies +the GPO. + +You can also refer to the **Guid** parameter by its built-in alias, **Id**. ```yaml Type: Guid @@ -169,16 +169,17 @@ Accept wildcard characters: False ``` ### -Name + Specifies the GPO to retrieve by its display name. -The display name is not guaranteed to be unique in the domain. -If another GPO with the same display name exists in the domain an error occurs. -You can use the Guid parameter to uniquely identify a GPO. +The display name is not guaranteed to be unique in the domain. If another GPO with the same display +name exists in the domain an error occurs. You can use the **Guid** parameter to uniquely identify a +GPO. -You can also refer to the *Name* parameter by its built-in alias, displayname. +You can also refer to the **Name** parameter by its built-in alias, **DisplayName**. ```yaml -Type: String +Type: System.String Parameter Sets: ByName Aliases: DisplayName @@ -190,15 +191,17 @@ Accept wildcard characters: False ``` ### -Server -Specifies the name of the domain controller that this cmdlet contacts to complete the operation. -You can specify either the fully qualified domain name (FQDN) or the host name. -If you do not specify the name by using the Server parameter, the primary domain controller (PDC) emulator is contacted. +Specifies the name of the domain controller that this cmdlet contacts to complete the operation. You +can specify either the fully qualified domain name (FQDN) or the host name. -You can also refer to the Server parameter by its built-in alias, dc. +If you do not specify the name by using the **Server** parameter, the primary domain controller +(PDC) emulator is contacted. + +You can also refer to the **Server** parameter by its built-in alias, **DC**. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: DC @@ -210,21 +213,28 @@ Accept wildcard characters: False ``` ### CommonParameters -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). + +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). ## INPUTS ### Microsoft.GroupPolicy.Gpo -You can pipe a GPO for which to get information to this cmdlet. -You can pipe GPO objects into this cmdlet to display information about the GPOs. -Collections that contain GPOs from different domains are not supported. + +You can pipe a GPO for which to get information to this cmdlet. You can pipe GPO objects into this +cmdlet to display information about the GPOs. Collections that contain GPOs from different domains +are not supported. ## OUTPUTS ### Microsoft.GroupPolicy.Gpo + This cmdlet returns an object that represents the requested GPO. ## NOTES + * You can use the *Domain* parameter to explicitly specify the domain for this cmdlet. If you do not explicitly specify the domain, the cmdlet uses a default domain. diff --git a/docset/winserver2022-ps/grouppolicy/Get-GPOReport.md b/docset/winserver2022-ps/grouppolicy/Get-GPOReport.md index 9baf2d109e..21269fcb82 100644 --- a/docset/winserver2022-ps/grouppolicy/Get-GPOReport.md +++ b/docset/winserver2022-ps/grouppolicy/Get-GPOReport.md @@ -74,7 +74,7 @@ Because no *Path* parameter is supplied, the report is written to the display. Indicates that the cmdlet generates a report for all GPOs in the domain. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: ReportAll Aliases: @@ -101,11 +101,11 @@ For more information, see the Notes section in the full Help. If you specify a domain that is different from the domain of the user that is running the current session or, (for a startup or shutdown script, the computer), a trust must exist between that domain and the domain of the user or the computer. -You can also refer to Domain by its built-in alias, domainname. -For more information, see about_Aliases. +You can also refer to Domain by its built-in alias, **DomainName**. +For more information, see [about_Aliases](????????????). ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: DomainName @@ -120,7 +120,7 @@ Accept wildcard characters: False Specifies the GPO for which to generate the report by its globally unique identifier (GUID). The GUID uniquely identifies the GPO. -You can also refer to the *Guid* parameter by its built-in alias, id. +You can also refer to the *Guid* parameter by its built-in alias, **Id**. For more information, see **about_Aliases**. ```yaml @@ -142,11 +142,11 @@ The display name is not guaranteed to be unique in the domain. If another GPO with the same display name exists in the domain an error occurs. You can use the *Guid* parameter to uniquely identify a GPO. -You can also refer to the *Name* parameter by its built-in alias, displayname. +You can also refer to the **Name** parameter by its built-in alias, **DisplayName**. For more information, see **about_Aliases**. ```yaml -Type: String +Type: System.String Parameter Sets: ByName Aliases: DisplayName @@ -162,7 +162,7 @@ Specifies the path to the report file; for instance, c:\Reports\GpoReport.xml. If no path is specified, the report is printed to the display. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -199,11 +199,11 @@ You can specify either the fully qualified domain name (FQDN) or the host name. If you do not specify the name by using the *Server* parameter, the primary domain controller (PDC) emulator is contacted. -You can refer to this parameter by its built-in alias, dc. +You can refer to this parameter by its built-in alias, **DC**. For more information, see **about_Aliases**. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: DC @@ -215,6 +215,7 @@ Accept wildcard characters: False ``` ### CommonParameters + 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). ## INPUTS @@ -229,6 +230,7 @@ Collections that contain GPOs from different domains are not supported. This cmdlet does not generate any output. ## NOTES + * You can use the *Domain* parameter to explicitly specify the domain for this cmdlet. If you do not explicitly specify the domain, the cmdlet uses a default domain. diff --git a/docset/winserver2022-ps/grouppolicy/Get-GPPermission.md b/docset/winserver2022-ps/grouppolicy/Get-GPPermission.md index f34e9fe4e5..994af42cbb 100644 --- a/docset/winserver2022-ps/grouppolicy/Get-GPPermission.md +++ b/docset/winserver2022-ps/grouppolicy/Get-GPPermission.md @@ -121,7 +121,7 @@ For more information about the ErrorAction parameter, see about_CommonParameters Indicates that the cmdlet gets the permission level for each user, group, or computer that has permissions on the GPO. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -145,10 +145,10 @@ For more information, see the Notes section in the full Help. If you specify a domain that is different from the domain of the user that is running the current session (or, for a startup or shutdown script, the computer), a trust must exist between that domain and the domain of the user or the computer. You can also refer to the *Server* parameter by its built-in alias, domain. -For more information, see about_Aliases. +For more information, see [about_Aliases](????????????). ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: Domain @@ -163,7 +163,7 @@ Accept wildcard characters: False Specifies the GPO from which to retrieve the permission level by its globally unique identifier (GUID). The GUID uniquely identifies the GPO. -You can also refer to the *Guid* parameter by its built-in alias, id. +You can also refer to the *Guid* parameter by its built-in alias, **Id**. For more information, see **about_Aliases**. ```yaml @@ -185,11 +185,11 @@ The display name is not guaranteed to be unique in the domain. If another GPO with the same display name exists in the domain an error occurs. You can use the *Guid* parameter to uniquely identify a GPO. -You can also refer to the *Name* parameter by its built-in alias, displayname. +You can also refer to the **Name** parameter by its built-in alias, **DisplayName**. For more information, see **about_Aliases**. ```yaml -Type: String +Type: System.String Parameter Sets: SourcebyName Aliases: DisplayName @@ -206,11 +206,11 @@ You can specify either the fully qualified domain name (FQDN) or the host name. If you do not specify the name by using the *Server* parameter, the PDC emulator is contacted. -You can also refer to the *Server* parameter by its built-in alias, dc. +You can also refer to the *Server* parameter by its built-in alias, **DC**. For more information, see **about_Aliases**. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: DC @@ -235,7 +235,7 @@ For instance, in the contoso.com domain, to specify: - The computer "computer-01", use "contoso\computer-01" or "computer-01". ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -271,6 +271,7 @@ Accept wildcard characters: False ``` ### CommonParameters + 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). ## INPUTS @@ -285,6 +286,7 @@ Collections that contain GPOs from different domains are not supported. This cmdlet returns an object that represents permissions for the specified security principal (user, group, or computer) on the GPO. ## NOTES + * You can use the *DomainName* parameter to explicitly specify the domain for this cmdlet. If you do not explicitly specify the domain, the cmdlet uses the default domain. diff --git a/docset/winserver2022-ps/grouppolicy/Get-GPPrefRegistryValue.md b/docset/winserver2022-ps/grouppolicy/Get-GPPrefRegistryValue.md index c39a536324..6f28fa2543 100644 --- a/docset/winserver2022-ps/grouppolicy/Get-GPPrefRegistryValue.md +++ b/docset/winserver2022-ps/grouppolicy/Get-GPPrefRegistryValue.md @@ -137,11 +137,11 @@ For more information, see the Notes section in the full Help. If you specify a domain that is different from the domain of the user that is running the current session (or, for a startup or shutdown script, the computer), a trust must exist between that domain and the domain of the user or the computer. -You can also refer to the *Domain* parameter by its built-in alias, domainname. -For more information, see about_Aliases. +You can also refer to the **Domain** parameter by its built-in alias, **DomainName**. +For more information, see [about_Aliases](????????????)s](????????????). ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: DomainName @@ -156,7 +156,7 @@ Accept wildcard characters: False Specifies the GPO from which this cmdlet gets the Registry preference item by its globally unique identifier (GUID). The GUID uniquely identifies the GPO. -You can also refer to the *Guid* parameter by its built-in alias, id. +You can also refer to the *Guid* parameter by its built-in alias, **Id**. For more information, see **about_Aliases**. ```yaml @@ -194,7 +194,7 @@ You can also refer to the Key parameter by its built-in alias, FullKeyPath. For more information, see **about_Aliases**. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: FullKeyPath @@ -212,11 +212,11 @@ The display name is not guaranteed to be unique in the domain. If another GPO with the same display name exists in the domain an error occurs. You can use the *Guid* parameter to uniquely identify a GPO. -You can also refer to the *Name* parameter by its built-in alias, displayname. +You can also refer to the **Name** parameter by its built-in alias, **DisplayName**. For more information, **see about_Aliases**. ```yaml -Type: String +Type: System.String Parameter Sets: GetByName Aliases: DisplayName @@ -248,11 +248,11 @@ You can specify either the fully qualified domain name (FQDN) or the host name. If you do not specify the name through the *Server* parameter, the primary domain controller (PDC) emulator is contacted. -You can also refer to the *Server* parameter by its built-in alias, dc. +You can also refer to the *Server* parameter by its built-in alias, **DC**. For more information, see **about_Aliases**. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: DC @@ -272,7 +272,7 @@ When you want to gets Registry preference items for a registry key and all its f When you want to get Registry preference items only for a specific registry value, specify this parameter together with the *Key* parameter. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -284,6 +284,7 @@ Accept wildcard characters: False ``` ### CommonParameters + 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). ## INPUTS @@ -303,6 +304,7 @@ You can pipe these objects to the following cmdlets: - Remove-GPPrefRegistryValue ## NOTES + * If a Registry preference item for the specified registry key or value is not found, a non-terminating error occurs. You can use the *Domain* parameter to explicitly specify the domain for this cmdlet. diff --git a/docset/winserver2022-ps/grouppolicy/Get-GPRegistryValue.md b/docset/winserver2022-ps/grouppolicy/Get-GPRegistryValue.md index 39c70eb80e..9995255eca 100644 --- a/docset/winserver2022-ps/grouppolicy/Get-GPRegistryValue.md +++ b/docset/winserver2022-ps/grouppolicy/Get-GPRegistryValue.md @@ -110,11 +110,11 @@ For more information, see the Notes section in the full Help. If you specify a domain that is different from the domain of the user that is running the current session (or, for a startup or shutdown script, the computer), a trust must exist between that domain and the domain of the user or the computer. -You can also refer to Domain by its built-in alias, domainname. -For more information, see about_Aliases. +You can also refer to Domain by its built-in alias, **DomainName**. +For more information, see [about_Aliases](????????????). ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: DomainName @@ -129,7 +129,7 @@ Accept wildcard characters: False Specifies the GPO from which to retrieve the registry-based policy setting by its globally unique identifier (GUID). The GUID uniquely identifies the GPO. -You can also refer to the *Guid* parameter by its built-in alias, id. +You can also refer to the *Guid* parameter by its built-in alias, **Id**. For more information, see **about_Aliases**. ```yaml @@ -164,7 +164,7 @@ You can also refer to the *Key* parameter by its built-in alias FullKeyPath. For more information, see **about_Aliases**. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: FullKeyPath @@ -182,11 +182,11 @@ The display name is not guaranteed to be unique in the domain. If another GPO with the same display name exists in the domain an error occurs. You can use the *Guid* parameter to uniquely identify a GPO. -You can also refer to the *Name* parameter by its built-in alias, displayname. +You can also refer to the **Name** parameter by its built-in alias, **DisplayName**. For more information, see **about_Aliases**. ```yaml -Type: String +Type: System.String Parameter Sets: GetByName Aliases: DisplayName @@ -204,7 +204,7 @@ You can specify either the fully qualified domain name (FQDN) or the host name. If you do not specify the name by using the *Server* parameter, the primary domain controller (PDC) emulator is contacted. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: DC @@ -223,7 +223,7 @@ For the default value of a registry key, specify "(default)" or an empty string You must also specify the *Key* parameter with this parameter. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -235,6 +235,7 @@ Accept wildcard characters: False ``` ### CommonParameters + 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). ## INPUTS @@ -254,6 +255,7 @@ These objects can be piped into the following cmdlets: - Remove-GPRegistryValue ## NOTES + * The hive of the registry key that you specify (HKLM or HKCU) indicates whether the registry-based policy setting is retrieved from Computer Configuration or User Configuration. If the specified registry key cannot be located in policy (the registry key is not configured), a corresponding error message is displayed. diff --git a/docset/winserver2022-ps/grouppolicy/Get-GPResultantSetOfPolicy.md b/docset/winserver2022-ps/grouppolicy/Get-GPResultantSetOfPolicy.md index 1c6d3749f1..c21e039b05 100644 --- a/docset/winserver2022-ps/grouppolicy/Get-GPResultantSetOfPolicy.md +++ b/docset/winserver2022-ps/grouppolicy/Get-GPResultantSetOfPolicy.md @@ -91,7 +91,7 @@ You can specify the computer name in one of the following formats: - Computer name (host name): for instance, computer-01. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -106,10 +106,10 @@ Accept wildcard characters: False Specifies the path to the report file; for instance, c:\Reports\GpRsopReport.xml. You can also refer to the *Path* parameter by its built-in alias, filepath. -For more information, see about_Aliases. +For more information, see [about_Aliases](????????????). ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -151,7 +151,7 @@ You can specify the user name in one of the following formats: - User name: for example, someuser. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -163,6 +163,7 @@ Accept wildcard characters: False ``` ### CommonParameters + 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). ## INPUTS @@ -176,6 +177,7 @@ This cmdlet does not take any object as input. This cmdlet returns an RSoP object. ## NOTES + * This cmdlet provides only the logging results for a specified computer and user. You must use the GPMC to generate RSoP modeling information. ## RELATED LINKS diff --git a/docset/winserver2022-ps/grouppolicy/Get-GPStarterGPO.md b/docset/winserver2022-ps/grouppolicy/Get-GPStarterGPO.md index e72606c58e..ca2c81a4fc 100644 --- a/docset/winserver2022-ps/grouppolicy/Get-GPStarterGPO.md +++ b/docset/winserver2022-ps/grouppolicy/Get-GPStarterGPO.md @@ -83,7 +83,7 @@ The command uses the **Get-SPStarterGPO** cmdlet to get the Starter GPO and is t Returns all the Starter GPOs in the domain. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -106,11 +106,11 @@ For more information, see the Notes section in the full Help. If you specify a domain that is different from the domain of the user that is running the current session (or, for a startup or shutdown script, the computer), a trust must exist between that domain and the domain of the user, or the computer. -You can also refer to the *Domain* parameter by its built-in alias, domainname. -For more information, see about_Aliases. +You can also refer to the **Domain** parameter by its built-in alias, **DomainName**. +For more information, see [about_Aliases](????????????). ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: DomainName @@ -125,7 +125,7 @@ Accept wildcard characters: False Specifies the Starter GPO that this cmdlet gets by its globally unique identifier (GUID). The GUID uniquely identifies the Starter GPO. -You can also refer to the *Guid* parameter by its built-in alias, id. +You can also refer to the *Guid* parameter by its built-in alias, **Id**. For more information, see **about_Aliases**. ```yaml @@ -147,11 +147,11 @@ The display name is not guaranteed to be unique in the domain. If another Starter GPO with the same display name exists in the domain an error occurs. You can use the *Guid* parameter to uniquely identify a Starter GPO. -You can also refer to the *Name* parameter by its built-in alias, displayname. +You can also refer to the **Name** parameter by its built-in alias, **DisplayName**. For more information, see **about_Aliases**. ```yaml -Type: String +Type: System.String Parameter Sets: ByName Aliases: DisplayName @@ -168,11 +168,11 @@ You can specify either the fully qualified domain name (FQDN) or the host name. If you do not specify the name by using the *Server* parameter, the primary domain controller (PDC) emulator is contacted. -You can also refer to the *Server* parameter by its built-in alias, dc. +You can also refer to the *Server* parameter by its built-in alias, **DC**. For more information, see **about_Aliases**. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: DC @@ -184,11 +184,13 @@ Accept wildcard characters: False ``` ### CommonParameters + 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). ## INPUTS ### Microsoft.GroupPolicy.StarterGpo + You can pipe a Starter GPO to this cmdlet. ## OUTPUTS @@ -197,6 +199,7 @@ You can pipe a Starter GPO to this cmdlet. This cmdlet returns a Starter GPO object. ## NOTES + * You can use the *Domain* parameter to explicitly specify the domain for this cmdlet. If you do not explicitly specify the domain, the cmdlet uses a default domain. diff --git a/docset/winserver2022-ps/grouppolicy/Import-GPO.md b/docset/winserver2022-ps/grouppolicy/Import-GPO.md index 3b8bbdf63a..773d8dc279 100644 --- a/docset/winserver2022-ps/grouppolicy/Import-GPO.md +++ b/docset/winserver2022-ps/grouppolicy/Import-GPO.md @@ -114,11 +114,11 @@ Specifies the display name of the backed-up GPO from which this cmdlet imports t The most recent backup of the GPO is used. You can use the *BackupId* parameter to specify a particular version to use when multiple backups of the same GPO exist in the backup directory. -You can also refer to the *BackupGpoName* parameter by its built-in alias, displayname. -For more information, see about_Aliases. +You can also refer to the *BackupGpoName* parameter by its built-in alias, **DisplayName**. +For more information, see [about_Aliases](????????????). ```yaml -Type: String +Type: System.String Parameter Sets: ImportName Aliases: DisplayName @@ -136,7 +136,7 @@ You can use this parameter to specify a particular version of a backed-up GPO in The backup ID is different from the ID of the GPO that was backed up. -You can also refer to the *BackupId* parameter by its built-in alias, id. +You can also refer to the *BackupId* parameter by its built-in alias, **Id**. For more information, see **about_Aliases**. ```yaml @@ -155,7 +155,7 @@ Accept wildcard characters: False Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf @@ -170,7 +170,7 @@ Accept wildcard characters: False Indicates that the cmdlet creates a GPO from the backup if the specified target GPO does not exist. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -193,11 +193,11 @@ For more information, see the Notes section in the full Help. If you specify a domain that is different from the domain of the user that is running the current session (or, for a startup or shutdown script, the computer), a trust must exist between that domain and the domain of the user, or the computer. -You can also refer to the *Domain* parameter by its built-in alias, domainname. +You can also refer to the **Domain** parameter by its built-in alias, **DomainName**. For more information, see **about_Aliases**. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: DomainName @@ -213,7 +213,7 @@ Specifies the path to a migration table file. You can use a migration table to map security principals and UNC paths across domains. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -230,7 +230,7 @@ Specifies the path to the backup directory. You can also refer to the *Path* parameter by its built-in aliases: backuplocation or backupdirectory. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: backupLocation, BackupDirectory @@ -247,10 +247,10 @@ You can specify either the fully qualified domain name (FQDN) or the host name If you do not specify the name by using the *Server* parameter, the primary domain controller (PDC) emulator is contacted. -You can also refer to the *Server* parameter by its built-in alias, dc. +You can also refer to the *Server* parameter by its built-in alias, **DC**. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: DC @@ -286,7 +286,7 @@ Use the *CreateIfNeeded* parameter to force the GPO to be created if it does not You must specify either the *TargetGuid* parameter or the *TargetName* parameter. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -298,11 +298,12 @@ Accept wildcard characters: False ``` ### -WhatIf + Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi @@ -314,6 +315,7 @@ Accept wildcard characters: False ``` ### CommonParameters + 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). ## INPUTS @@ -324,9 +326,11 @@ You can pipe an object that represents a GPO backup on the file system to this c ## OUTPUTS ### Microsoft.GroupPolicy.Gpo + This cmdlet returns an object that represents the GPO after the settings have been imported. ## NOTES + * You can use the **Import-GPO** to copy settings from a GPO backup in one domain to the same domain or another domain in the same or different forest. You can use the *Domain* parameter to explicitly specify the domain for this cmdlet. diff --git a/docset/winserver2022-ps/grouppolicy/Invoke-GPUpdate.md b/docset/winserver2022-ps/grouppolicy/Invoke-GPUpdate.md index 546f059eca..bdd8f98387 100644 --- a/docset/winserver2022-ps/grouppolicy/Invoke-GPUpdate.md +++ b/docset/winserver2022-ps/grouppolicy/Invoke-GPUpdate.md @@ -62,7 +62,7 @@ To get the job results, use the [Receive-Job](https://go.microsoft.com/fwlink/?L For more information about Windows PowerShell® background jobs, see [about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -80,7 +80,7 @@ This is required for those Group Policy client side extensions (CSEs) that do no This parameter has no effect if there are no CSEs called that require a restart. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -106,7 +106,7 @@ You can specify the computer name in one of the following formats: If the computer name is not specified, the computer in which this cmdlet is run will have its Group Policy settings refreshed. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: DNSHostName @@ -121,7 +121,7 @@ Accept wildcard characters: False Forces the command to run without asking for user confirmation. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: NonSyncSet Aliases: @@ -140,7 +140,7 @@ Examples include per-user Software Installation policy settings and the Folder R This parameter has no effect if there are no CSEs called that require a logoff. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -182,7 +182,7 @@ On a client computer, by default, Group Policy processes synchronously at comput On a server, by default, Group Policy processes synchronously at computer startup and at user logon. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: SyncSet Aliases: @@ -205,7 +205,7 @@ The acceptable values for this parameter are: If the *Target* parameter is not specified both user and computer policy settings are refreshed. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -217,6 +217,7 @@ Accept wildcard characters: False ``` ### CommonParameters + 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). ## INPUTS @@ -230,6 +231,7 @@ This cmdlet does not take any object as input. This cmdlet does not generate any output. ## NOTES + * This cmdlet does not support scheduling a Group Policy refresh for computers running Windows XP or earlier. * In order to successfully schedule a Group Policy refresh for computers using this cmdlet, the following Firewall rules must be set on each client computer to allow the following connections: diff --git a/docset/winserver2022-ps/grouppolicy/New-GPLink.md b/docset/winserver2022-ps/grouppolicy/New-GPLink.md index ec429931b1..334cced92d 100644 --- a/docset/winserver2022-ps/grouppolicy/New-GPLink.md +++ b/docset/winserver2022-ps/grouppolicy/New-GPLink.md @@ -87,7 +87,7 @@ This command links the TestGPO GPO to the site named Test-Site and sets the link Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf @@ -116,11 +116,11 @@ For more information, see the Notes section in the full Help. If you specify a domain that is different from the domain of the user that is running the current session (or, for a startup or shutdown script, the computer), a trust must exist between that domain and the domain of the user, or the computer. -You can also refer to *Domain* by its built-in alias, domainname. -For more information, see about_Aliases. +You can also refer to *Domain* by its built-in alias, **DomainName**. +For more information, see [about_Aliases](????????????). ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: DomainName @@ -161,7 +161,7 @@ Accept wildcard characters: False Specifies the GPO to link by its globally unique identifier (GUID). The GUID uniquely identifies the GPO in the domain. -You can also refer to the Guid parameter by its built-in alias, id. +You can also refer to the Guid parameter by its built-in alias, **Id**. For more information, see **about_Aliases**. ```yaml @@ -206,11 +206,11 @@ The display name is not guaranteed to be unique in the domain. If another GPO with the same display name exists in the domain, an error occurs. You can use the *Guid* parameter to uniquely identify a GPO. -You can also refer to the *Name* parameter by its built-in alias, displayname. +You can also refer to the **Name** parameter by its built-in alias, **DisplayName**. For more information, see **about_Aliases**. ```yaml -Type: String +Type: System.String Parameter Sets: LinkbyName Aliases: DisplayName @@ -252,11 +252,11 @@ You can specify either the FQDN or the host name. If you do not specify the name by using the *Server* parameter, the primary domain controller (PDC) emulator is contacted. -You can also refer to the *Server* parameter by its built-in alias, dc. +You can also refer to the *Server* parameter by its built-in alias, **DC**. For more information, see **about_Aliases**. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: DC @@ -272,7 +272,7 @@ Specifies the LDAP distinguished name of the site, domain, or OU to which to lin For example, for the MyOU organizational unit in the contoso.com domain, the LDAP distinguished name is ou=MyOU,dc=contoso,dc=com. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -284,11 +284,12 @@ Accept wildcard characters: False ``` ### -WhatIf + Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi @@ -300,6 +301,7 @@ Accept wildcard characters: False ``` ### CommonParameters + 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). ## INPUTS @@ -314,6 +316,7 @@ Collections that contain GPOs from different domains are not supported. This cmdlet returns an object that represents the link between the GPO and the site, domain, or OU. ## NOTES + * To link a GPO to a site, domain, or OU, you must have Link GPOs permission on that site, domain, or OU. By default, only domain administrators and enterprise administrators have this privilege for domains and OUs. Enterprise administrators and domain administrators of the forest root domain have this privilege for sites. You can use the *Domain* parameter to explicitly specify the domain for this cmdlet. diff --git a/docset/winserver2022-ps/grouppolicy/New-GPO.md b/docset/winserver2022-ps/grouppolicy/New-GPO.md index 20fef85fe3..5594bf6127 100644 --- a/docset/winserver2022-ps/grouppolicy/New-GPO.md +++ b/docset/winserver2022-ps/grouppolicy/New-GPO.md @@ -102,7 +102,7 @@ Use the comment to document the GPO and its implementation in your environment. Or, if you insert keywords in the comment, you can use the keyword filter to find GPOs that have matching keywords. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -117,7 +117,7 @@ Accept wildcard characters: False Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf @@ -144,11 +144,11 @@ For more information, see the Notes section in the full help. If you specify a domain that is different from the domain of the user running the current session (or the computer for a startup or shutdown script), then a trust must exist between that domain and the domain of the user, or computer. -You can also refer to the *Domain* by its built-in alias, domainname. -For more information, see about_Aliases. +You can also refer to the *Domain* by its built-in alias, **DomainName**. +For more information, see [about_Aliases](????????????). ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: DomainName @@ -164,11 +164,11 @@ Specifies a display name for the new GPO. If another GPO with the same display name exists in the domain an error occurs. -You can also refer to the *Name* parameter by its built-in alias, displayname. +You can also refer to the **Name** parameter by its built-in alias, **DisplayName**. For more information, see **about_Aliases**. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: DisplayName @@ -185,11 +185,11 @@ You can specify either the fully qualified domain name (FQDN) or the host name. If you do not specify the name by using the *Server* parameter, the primary domain controller (PDC) emulator is contacted. -You can also refer to the *Server* parameter by its built-in alias, dc. +You can also refer to the *Server* parameter by its built-in alias, **DC**. For more information, see **about_Aliases**. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: DC @@ -205,7 +205,7 @@ Specifies a Starter GPO by its globally unique identifier (GUID). The GUID uniquely identifies the Starter GPO. If a Starter GPO is specified, the GPO is created with its settings. -You can also refer to the *StarterGpoGuid* parameter by its built-in alias, id. +You can also refer to the **StarterGpoGuid* *parameter by its built-in alias, **Id**. For more information, see **about_Aliases**. ```yaml @@ -228,13 +228,13 @@ If a Starter GPO is specified, the GPO is created with its settings. The display name is not guaranteed to be unique in the domain. If another Starter GPO with the same display name exists in the domain, an error occurs. -You can use the *StarterGpoGuid* parameter to uniquely identify a Starter GPO. +You can use the **StarterGpoGuid* *parameter to uniquely identify a Starter GPO. -You can also refer to the *Name* parameter by its built-in alias, displayname. +You can also refer to the **Name** parameter by its built-in alias, **DisplayName**. For more information, see **about_Aliases**. ```yaml -Type: String +Type: System.String Parameter Sets: NewStarterName Aliases: @@ -246,11 +246,12 @@ Accept wildcard characters: False ``` ### -WhatIf + Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi @@ -262,30 +263,37 @@ Accept wildcard characters: False ``` ### CommonParameters + 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). ## INPUTS ### Microsoft.GroupPolicy.StarterGpo + You can pipe a Starter GPO that has predefined settings to this cmdlet. ## OUTPUTS ### Microsoft.GroupPolicy.Gpo + This cmdlet returns the GPO that was created. ## NOTES -* Only domain administrators, enterprise administrators, and members of the Group Policy creator owners group can create GPOs. These users must run Windows PowerShell in an elevated state. + +* Only domain administrators, enterprise administrators, and members of the Group Policy creator + owners group can create GPOs. These users must run Windows PowerShell in an elevated state. You can use the *Domain* parameter to explicitly specify the domain for this cmdlet. - If you do not explicitly specify the domain, the cmdlet uses a default domain. -The default domain is the domain that is used to access network resources by the security context under which the current session is running. -This domain is typically the domain of the user that is running the session. -For instance, the domain of the user who started the session by opening Windows PowerShell from the Program Files menu, or the domain of a user that is specified in a RunAs command. -However, computer startup and shutdown scripts run under the context of the LocalSystem account. -The LocalSystem account is a built-in local account, and it accesses network resources under the context of the computer account. -Therefore, when this cmdlet is run from a startup or shutdown script, the default domain is the domain to which the computer is joined. + If you do not explicitly specify the domain, the cmdlet uses a default domain. The default domain + is the domain that is used to access network resources by the security context under which the + current session is running. This domain is typically the domain of the user that is running the + session. For instance, the domain of the user who started the session by opening Windows + PowerShell from the Program Files menu, or the domain of a user that is specified in a RunAs + command. However, computer startup and shutdown scripts run under the context of the LocalSystem + account. The LocalSystem account is a built-in local account, and it accesses network resources + under the context of the computer account. Therefore, when this cmdlet is run from a startup or + shutdown script, the default domain is the domain to which the computer is joined. ## RELATED LINKS diff --git a/docset/winserver2022-ps/grouppolicy/New-GPStarterGPO.md b/docset/winserver2022-ps/grouppolicy/New-GPStarterGPO.md index 89e2dd5812..fc9e8ec80a 100644 --- a/docset/winserver2022-ps/grouppolicy/New-GPStarterGPO.md +++ b/docset/winserver2022-ps/grouppolicy/New-GPStarterGPO.md @@ -41,7 +41,7 @@ Specifies a comment for the new Starter GPO. The comment string must be enclosed in double-quotation marks or single-quotation marks and can contain a maximum of 2,047 characters. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -56,7 +56,7 @@ Accept wildcard characters: False Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf @@ -76,11 +76,11 @@ If you specify a domain that is different from the domain of the user that is ru If you do not specify the *Domain* parameter, the domain of the user that is running the current session is used. -You can also refer to the *Domain* parameter by its built-in alias, domainname. -For more information, see about_Aliases. +You can also refer to the **Domain** parameter by its built-in alias, **DomainName**. +For more information, see [about_Aliases](????????????). ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: DomainName @@ -96,11 +96,11 @@ Specifies the display name for the new Starter GPO. If another Starter GPO with the same display name exists in the domain, an error occurs. -You can also refer to the *Name* parameter by its built-in alias, displayname. +You can also refer to the **Name** parameter by its built-in alias, **DisplayName**. For more information, see **about_Aliases**. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: DisplayName @@ -117,11 +117,11 @@ You can specify either the fully qualified domain name (FQDN) or the host name. If you do not specify the name by using the *Server* parameter, the primary domain controller (PDC) emulator is contacted. -You can also refer to the *Server* parameter by its built-in alias, dc. +You can also refer to the *Server* parameter by its built-in alias, **DC**. For more information, see **about_Aliases**. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: DC @@ -133,11 +133,12 @@ Accept wildcard characters: False ``` ### -WhatIf + Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi @@ -149,6 +150,7 @@ Accept wildcard characters: False ``` ### CommonParameters + 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). ## INPUTS diff --git a/docset/winserver2022-ps/grouppolicy/Remove-GPLink.md b/docset/winserver2022-ps/grouppolicy/Remove-GPLink.md index eab0ff3518..a71aded868 100644 --- a/docset/winserver2022-ps/grouppolicy/Remove-GPLink.md +++ b/docset/winserver2022-ps/grouppolicy/Remove-GPLink.md @@ -100,7 +100,7 @@ The GPOs for which links have been removed are returned. Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf @@ -129,11 +129,11 @@ For more information, see the Notes section in the full Help. If you specify a domain that is different from the domain of the user that is running the current session (or, for a startup or shutdown script, the computer), a trust must exist between that domain and the domain of the user, or the computer. -You can also refer to the *Domain* parameter by its built-in alias, domainname. -For more information, see about_Aliases. +You can also refer to the **Domain** parameter by its built-in alias, **DomainName**. +For more information, see [about_Aliases](????????????). ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: DomainName @@ -170,11 +170,11 @@ The display name is not guaranteed to be unique in the domain. If another GPO with the same display name exists in the domain an error occurs. You can use the *Guid* parameter to uniquely identify a GPO. -You can also refer to the *Name* parameter by its built-in alias, displayname. +You can also refer to the **Name** parameter by its built-in alias, **DisplayName**. For more information, see **about_Aliases**. ```yaml -Type: String +Type: System.String Parameter Sets: LinkbyName Aliases: DisplayName @@ -191,11 +191,11 @@ You can specify either the fully qualified domain name (FQDN) or the host name. If you do not specify the name by using the *Server* parameter, the primary domain controller (PDC) emulator is contacted. -You can also refer to the *Server* parameter by its built-in alias, dc. +You can also refer to the *Server* parameter by its built-in alias, **DC**. For more information, see **about_Aliases**. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: DC @@ -211,7 +211,7 @@ Specifies the Lightweight Directory Access Protocol (LDAP) distinguished name of For instance, for the MyOU organizational unit in the contoso.com domain, the LDAP distinguished name is ou=MyOU,dc=contoso,dc=com. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -223,11 +223,14 @@ Accept wildcard characters: False ``` ### -WhatIf + Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter +nt.Automation.SwitchParameter + Parameter Sets: (All) Aliases: wi @@ -239,6 +242,7 @@ Accept wildcard characters: False ``` ### CommonParameters + 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). ## INPUTS @@ -249,6 +253,7 @@ This cmdlet accepts an object that represents the link between a GPO and a site, ## OUTPUTS ### Microsoft.GroupPolicy.Gpo + This cmdlet returns the GPO for which the link has been removed. ## NOTES diff --git a/docset/winserver2022-ps/grouppolicy/Remove-GPO.md b/docset/winserver2022-ps/grouppolicy/Remove-GPO.md index 9d1833d5f9..f7bf2c7d83 100644 --- a/docset/winserver2022-ps/grouppolicy/Remove-GPO.md +++ b/docset/winserver2022-ps/grouppolicy/Remove-GPO.md @@ -54,7 +54,7 @@ Because the *KeepLinks* parameter is not specified, links between the GPO and al Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf @@ -74,7 +74,7 @@ If you do not specify the *Domain* parameter, the domain of the computer that yo If you specify a domain that differs from the domain of your user object, a trust must exist between the domain from which you want to remove the GPO and the domain of your user object. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: DomainName @@ -89,8 +89,8 @@ Accept wildcard characters: False Specifies the GPO to remove by its globally unique identifier (GUID). The GUID uniquely identifies the GPO. -You can also refer to the *Guid* parameter by its built-in alias, id. -For more information, see about_Aliases. +You can also refer to the *Guid* parameter by its built-in alias, **Id**. +For more information, see [about_Aliases](????????????). ```yaml Type: Guid @@ -108,7 +108,7 @@ Accept wildcard characters: False Indicates that the cmdlet preserves the links to the GPO in the specified domain, including OUs, and all sites when the GPO is removed. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -126,11 +126,11 @@ The display name is not guaranteed to be unique in the domain. If another GPO with the same display name exists in the domain an error occurs. You can use the *Guid* parameter to uniquely identify a GPO. -You can also refer to the *Name* parameter by its built-in alias, displayname. +You can also refer to the **Name** parameter by its built-in alias, **DisplayName**. For more information, see **about_Aliases**. ```yaml -Type: String +Type: System.String Parameter Sets: ByName Aliases: DisplayName @@ -147,11 +147,11 @@ You can specify either the fully qualified domain name (FQDN) or the host name. If you do not specify the name by using the *Server* parameter, the primary domain controller (PDC) emulator is contacted. -You can also refer to the *Server* parameter by its built-in alias, dc. +You can also refer to the *Server* parameter by its built-in alias, **DC**. For more information, see **about_Aliases**. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: DC @@ -163,11 +163,12 @@ Accept wildcard characters: False ``` ### -WhatIf + Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi @@ -179,6 +180,7 @@ Accept wildcard characters: False ``` ### CommonParameters + 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). ## INPUTS @@ -193,6 +195,7 @@ Collections that contain GPOs from different domains are not supported. This cmdlet does not generate any output. ## NOTES + * When you remove a GPO, by default, all links to that GPO in the domain of the GPO are deleted. To remove a link to a GPO, you must have permission to link Group Policy Objects for the organizational unit or domain. If you do not have rights to delete a link, the GPO is deleted, but the link remains. Links from other domains and sites are not removed. The link to a deleted GPO appears in the GPMC as Not Found. To remove Not Found links, you must either have permission on the site, domain, or organizational unit containing the link, or ask someone with sufficient rights to delete it. ## RELATED LINKS diff --git a/docset/winserver2022-ps/grouppolicy/Remove-GPPrefRegistryValue.md b/docset/winserver2022-ps/grouppolicy/Remove-GPPrefRegistryValue.md index a25862a870..74b6db5286 100644 --- a/docset/winserver2022-ps/grouppolicy/Remove-GPPrefRegistryValue.md +++ b/docset/winserver2022-ps/grouppolicy/Remove-GPPrefRegistryValue.md @@ -127,7 +127,7 @@ For more information about the *ErrorAction* parameter, see about_CommonParamete Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf @@ -166,11 +166,11 @@ If you do not specify the *Domain* parameter, the domain of the user that is run If you specify a domain that is different from the domain of the user that is running the current session, a trust must exist between that domain and the domain of the user or the computer. -You can also refer to the Domain parameter by its built-in alias, domainname. -For more information, see about_Aliases. +You can also refer to the Domain parameter by its built-in alias, **DomainName**. +For more information, see [about_Aliases](????????????). ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: DomainName @@ -185,7 +185,7 @@ Accept wildcard characters: False Specifies the GPO from which to remove the Registry preference item by its globally unique identifier (GUID). The GUID uniquely identifies the GPO. -You can also refer to the *Guid* parameter by its built-in alias, id. +You can also refer to the *Guid* parameter by its built-in alias, **Id**. ```yaml Type: Guid @@ -214,7 +214,7 @@ The *Key* parameter can be specified with or without the *ValueName* parameter: You can also refer to the *Key* parameter by its built-in alias, FullKeyPath. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: FullKeyPath @@ -232,10 +232,10 @@ The display name is not guaranteed to be unique in the domain. If another GPO with the same display name exists in the domain an error occurs. You can use the Guid parameter to uniquely identify a GPO. -You can also refer to the *Name* parameter by its built-in alias, displayname. +You can also refer to the **Name** parameter by its built-in alias, **DisplayName**. ```yaml -Type: String +Type: System.String Parameter Sets: GetByName Aliases: DisplayName @@ -267,10 +267,10 @@ You can specify either the fully qualified domain name (FQDN) or the host name. If you do not specify the name by using the *Server* parameter, the primary domain controller (PDC) emulator is contacted. -You can also refer to the *Server* parameter by its built-in alias, dc. +You can also refer to the *Server* parameter by its built-in alias, **DC**. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: DC @@ -286,7 +286,7 @@ Specifies the name of a registry value for which to remove all Registry preferen If you specify the *ValueName* parameter, you must also specify the *Key* parameter. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -298,11 +298,12 @@ Accept wildcard characters: False ``` ### -WhatIf + Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi @@ -314,6 +315,7 @@ Accept wildcard characters: False ``` ### CommonParameters + 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). ## INPUTS @@ -327,9 +329,11 @@ Collections that contain GPOs from different domains are not supported. ## OUTPUTS ### Microsoft.GroupPolicy.Gpo + This cmdlet returns the GPO from which the Registry preference item or items that have been removed. ## NOTES + * You can use the *Domain* parameter to explicitly specify the domain for this cmdlet. If you do not explicitly specify the domain, the cmdlet uses a default domain. diff --git a/docset/winserver2022-ps/grouppolicy/Remove-GPRegistryValue.md b/docset/winserver2022-ps/grouppolicy/Remove-GPRegistryValue.md index ed4f76e7fc..02ae68e1c6 100644 --- a/docset/winserver2022-ps/grouppolicy/Remove-GPRegistryValue.md +++ b/docset/winserver2022-ps/grouppolicy/Remove-GPRegistryValue.md @@ -83,7 +83,7 @@ If there are registry-based policy settings in User Configuration that configure Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf @@ -106,11 +106,11 @@ For more information, see the Notes section in the full Help. If you specify a domain that is different from the domain of the user that is running the current session (or, for a startup or shutdown script, the computer), a trust must exist between that domain and the domain of the user or the computer. -You can also refer to the *Domain* parameter by its built-in alias, domainname. -For more information, see about_Aliases. +You can also refer to the **Domain** parameter by its built-in alias, **DomainName**. +For more information, see [about_Aliases](????????????). ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: DomainName @@ -125,7 +125,7 @@ Accept wildcard characters: False Specifies the GPO from which to remove the registry-based policy setting by its globally unique identifier (GUID). The GUID uniquely identifies the GPO. -You can also refer to the *Guid* parameter by its built-in alias, id. +You can also refer to the *Guid* parameter by its built-in alias, **Id**. ```yaml Type: Guid @@ -158,7 +158,7 @@ If there are registry-based policy settings that configure any subkeys or their You can also refer to the Key parameter by its built-in alias, FullKeyPath. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: FullKeyPath @@ -176,10 +176,10 @@ The display name is not guaranteed to be unique in the domain. If another GPO with the same display name exists in the domain an error occurs. You can use the *Guid* parameter to uniquely identify a GPO. -You can also refer to the *Name* parameter by its built-in alias, displayname. +You can also refer to the **Name** parameter by its built-in alias, **DisplayName**. ```yaml -Type: String +Type: System.String Parameter Sets: GetByName Aliases: DisplayName @@ -196,10 +196,10 @@ You can specify either the fully qualified domain name (FQDN) or the host name. If you do not specify the name by using the *Server* parameter, the primary domain controller (PDC) emulator is contacted. -You can also refer to the *Server* parameter by its built-in alias, dc. +You can also refer to the *Server* parameter by its built-in alias, **DC**. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: DC @@ -215,7 +215,7 @@ Specifies the name of the registry value for which to remove the registry-based If you specify the *ValueName* parameter, you must also specify the *Key* parameter. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -227,11 +227,12 @@ Accept wildcard characters: False ``` ### -WhatIf + Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi @@ -243,6 +244,7 @@ Accept wildcard characters: False ``` ### CommonParameters + 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). ## INPUTS @@ -254,9 +256,11 @@ Collections that contain GPOs from different domains are not supported. ## OUTPUTS ### Microsoft.GroupPolicy.Gpo + This cmdlet returns the GPO from which the registry-based policy setting (or settings) has been removed. ## NOTES + * The hive of the registry key that you specify -- HKEY_LOCAL_MACHINE (HKLM) or HKEY_CURRENT_USER (HKCU) indicates whether the registry-based policy setting is removed from Computer Configuration or User Configuration. If a value for the registry key cannot be located (the registry key is not configured) or if subkeys are present, an error occurs and a corresponding error message is displayed. diff --git a/docset/winserver2022-ps/grouppolicy/Rename-GPO.md b/docset/winserver2022-ps/grouppolicy/Rename-GPO.md index 1ddf05409b..091e8aa30c 100644 --- a/docset/winserver2022-ps/grouppolicy/Rename-GPO.md +++ b/docset/winserver2022-ps/grouppolicy/Rename-GPO.md @@ -57,7 +57,7 @@ This command renames the GPO named SampleGPO to SecurityGPO. Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf @@ -80,11 +80,11 @@ For more information, see the Notes section in the full Help. If you specify a domain that is different from the domain of the user that is running the current session (or, for a startup or shutdown script, the computer), a trust must exist between that domain and the domain of the user or the computer. -You can also refer to the *Domain* parameter by its built-in alias, domainname. -For more information, see about_Aliases. +You can also refer to the **Domain** parameter by its built-in alias, **DomainName**. +For more information, see [about_Aliases](????????????). ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: DomainName @@ -99,7 +99,7 @@ Accept wildcard characters: False Specifies the GPO to rename by its globally unique identifier (GUID). The GUID uniquely identifies the GPO. -You can also refer to the *Guid* parameter by its built-in alias, id. +You can also refer to the *Guid* parameter by its built-in alias, **Id**. ```yaml Type: Guid @@ -120,10 +120,10 @@ The display name is not guaranteed to be unique in the domain. If another GPO with the same display name exists in the domain, an error occurs. You can use the *Guid* parameter to uniquely identify a GPO. -You can also refer to the Name parameter by its built-in alias, displayname. +You can also refer to the Name parameter by its built-in alias, **DisplayName**. ```yaml -Type: String +Type: System.String Parameter Sets: RenameByName Aliases: DisplayName @@ -140,10 +140,10 @@ You can specify either the fully qualified domain name (FQDN) or the host name. If you do not specify the name by using the *Server* parameter, the primary domain controller (PDC) emulator is contacted. -You can also refer to the *Server* parameter by its built-in alias, dc. +You can also refer to the *Server* parameter by its built-in alias, **DC**. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: DC @@ -159,7 +159,7 @@ Specifies the new display name of the GPO. Because the display name may not be unique, an error is returned if another GPO in the domain has the same display name. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -171,11 +171,12 @@ Accept wildcard characters: False ``` ### -WhatIf + Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi @@ -187,6 +188,7 @@ Accept wildcard characters: False ``` ### CommonParameters + 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). ## INPUTS @@ -198,9 +200,11 @@ Collections that contain GPOs from different domains are not supported. ## OUTPUTS ### Microsoft.GroupPolicy.Gpo + This cmdlet returns the GPO with the new display name. ## NOTES + * You can use the *Domain* parameter to explicitly specify the domain for this cmdlet. If you do not explicitly specify the domain, the cmdlet uses a default domain. diff --git a/docset/winserver2022-ps/grouppolicy/Restore-GPO.md b/docset/winserver2022-ps/grouppolicy/Restore-GPO.md index 7a4dce9dfe..bb9ae259ee 100644 --- a/docset/winserver2022-ps/grouppolicy/Restore-GPO.md +++ b/docset/winserver2022-ps/grouppolicy/Restore-GPO.md @@ -95,7 +95,7 @@ Indicates that the cmdlet restores all GPOs in the domain that have backups in t Each GPO is restored from its most recent backup in the directory. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: RestoreAll Aliases: @@ -129,7 +129,7 @@ Accept wildcard characters: False Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf @@ -153,11 +153,11 @@ For more information, see the Notes section in the full Help. If you specify a domain that is different from the domain of the user that is running the current session (or, for a startup or shutdown script, the computer), a trust must exist between that domain and the domain of the user or the computer. -You can also refer to the *Domain* parameter by its built-in alias, domainname. -For more information, see about_Aliases. +You can also refer to the **Domain** parameter by its built-in alias, **DomainName**. +For more information, see [about_Aliases](????????????). ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: DomainName @@ -175,7 +175,7 @@ The GUID uniquely identifies the GPO. The GPO is restored from its most recent backup in the backup directory. To specify a different backup than the most recent backup, use the *BackupId* parameter. -You can also refer to the *Guid* parameter by its built-in alias, id. +You can also refer to the *Guid* parameter by its built-in alias, **Id**. ```yaml Type: Guid @@ -198,10 +198,10 @@ The display name is not guaranteed to be unique in the domain. If another GPO with the same display name exists in the domain an error occurs. You can use the *Guid* parameter to uniquely identify a GPO. -You can also refer to the Name parameter by its built-in alias, displayname. +You can also refer to the Name parameter by its built-in alias, **DisplayName**. ```yaml -Type: String +Type: System.String Parameter Sets: RestoreFromGpo(Name) Aliases: DisplayName @@ -218,7 +218,7 @@ Specifies the path to the backup directory. You can also refer to the *Path* parameter by its built-in alias, backuplocation. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: backupLocation, BackupDirectory @@ -235,10 +235,10 @@ You can specify either the fully qualified domain name (FQDN) or the host name. If you do not specify the name by using the *Server* parameter, the primary domain controller (PDC) emulator is contacted. -You can also refer to the *Server* parameter by its built-in alias, dc. +You can also refer to the *Server* parameter by its built-in alias, **DC**. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: DC @@ -250,11 +250,12 @@ Accept wildcard characters: False ``` ### -WhatIf + Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi @@ -266,6 +267,7 @@ Accept wildcard characters: False ``` ### CommonParameters + 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). ## INPUTS @@ -276,9 +278,11 @@ You can pipe a GPO backup, a separate file that holds the settings of a GPO that ## OUTPUTS ### Microsoft.GroupPolicy.Gpo + This cmdlet returns the restored GPO. ## NOTES + * You can use the *Domain* parameter to explicitly specify the domain for this cmdlet. If you do not explicitly specify the domain, the cmdlet uses a default domain. diff --git a/docset/winserver2022-ps/grouppolicy/Set-GPInheritance.md b/docset/winserver2022-ps/grouppolicy/Set-GPInheritance.md index 95f813e267..1f9bb13edc 100644 --- a/docset/winserver2022-ps/grouppolicy/Set-GPInheritance.md +++ b/docset/winserver2022-ps/grouppolicy/Set-GPInheritance.md @@ -79,7 +79,7 @@ For instance, the Default Domain Policy GPO is linked at the domain level. Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf @@ -103,11 +103,11 @@ For more information, see the Notes section in the full Help. If you specify a domain that is different from the domain of the user that is running the current session (or, for a startup or shutdown script, the computer), a trust must exist between that domain and the domain of the user or the computer. -You can also refer to the *Domain* parameter by its built-in alias, domainname. -For more information, see about_Aliases. +You can also refer to the **Domain** parameter by its built-in alias, **DomainName**. +For more information, see [about_Aliases](????????????). ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: DomainName @@ -143,10 +143,10 @@ You can specify either the fully qualified domain name (FQDN) or the host name. If you do not specify the name by using the *Server* parameter, the primary domain controller (PDC) emulator is contacted. -You can also refer to the Server parameter by its built-in alias, dc. +You can also refer to the **Server** parameter by its built-in alias, **DC**. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: DC @@ -164,7 +164,7 @@ For instance, the MyOU organizational unit in the contoso.com domain is specifie You can also refer to the *Target* parameter by its built-in alias, path. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: path @@ -176,11 +176,12 @@ Accept wildcard characters: False ``` ### -WhatIf + Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi @@ -192,6 +193,7 @@ Accept wildcard characters: False ``` ### CommonParameters + 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). ## INPUTS @@ -207,6 +209,7 @@ The properties of this object that are displayed by default describe the Group P The **GpoInheritanceBlocked** property indicates whether inheritance is blocked. ## NOTES + * GPO links that are enforced cannot be blocked. This cmdlet should be used sparingly. Casual use of this cmdlet can complicate troubleshooting. You can use the *Domain* parameter to explicitly specify the domain for this cmdlet. diff --git a/docset/winserver2022-ps/grouppolicy/Set-GPLink.md b/docset/winserver2022-ps/grouppolicy/Set-GPLink.md index fb4de3f6d6..b8836d0ff0 100644 --- a/docset/winserver2022-ps/grouppolicy/Set-GPLink.md +++ b/docset/winserver2022-ps/grouppolicy/Set-GPLink.md @@ -86,7 +86,7 @@ Inheritance cannot be blocked for this link at containers that are at lower-leve Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf @@ -115,11 +115,11 @@ For more information, see the Notes section in the full Help. If you specify a domain that is different from the domain of the user that is running the current session (or, for a startup or shutdown script, the computer), a trust must exist between that domain and the domain of the user or the computer. -You can also refer to the *Domain* parameter by its built-in alias, domainname. -For more information, see about_Aliases. +You can also refer to the **Domain** parameter by its built-in alias, **DomainName**. +For more information, see [about_Aliases](????????????). ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: DomainName @@ -163,7 +163,7 @@ Accept wildcard characters: False Specifies the GPO of the link by its globally unique identifier (GUID). The GUID uniquely identifies the GPO. -You can also refer to the *Guid* parameter by its built-in alias, id. +You can also refer to the *Guid* parameter by its built-in alias, **Id**. ```yaml Type: Guid @@ -206,10 +206,10 @@ The display name is not guaranteed to be unique in the domain. If another GPO with the same display name exists in the domain, an error occurs. You can use the *Guid* parameter to uniquely identify a GPO. -You can also refer to the *Name* parameter by its built-in alias, displayname. +You can also refer to the **Name** parameter by its built-in alias, **DisplayName**. ```yaml -Type: String +Type: System.String Parameter Sets: LinkName Aliases: DisplayName @@ -250,10 +250,10 @@ You can specify either the fully qualified domain name (FQDN) or the host name. If you do not specify the name by using the *Server* parameter, the primary domain controller (PDC) emulator is contacted. -You can also refer to the *Server* parameter by its built-in alias, dc. +You can also refer to the *Server* parameter by its built-in alias, **DC**. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: DC @@ -269,7 +269,7 @@ Specifies the Lightweight Directory Access Protocol (LDAP) distinguished name of For instance, for the MyOU organizational unit in the contoso.com domain, the LDAP distinguished name is "ou=MyOU,dc=contoso,dc=com". ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -281,11 +281,12 @@ Accept wildcard characters: False ``` ### -WhatIf + Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi @@ -297,6 +298,7 @@ Accept wildcard characters: False ``` ### CommonParameters + 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). ## INPUTS @@ -310,6 +312,7 @@ A GPO link between a GPO and a site, domain, or OU. This cmdlet returns the GPO link after the change has been applied. ## NOTES + * You can use the *Domain* parameter to explicitly specify the domain for this cmdlet. If you do not explicitly specify the domain, the cmdlet uses a default domain. diff --git a/docset/winserver2022-ps/grouppolicy/Set-GPPermission.md b/docset/winserver2022-ps/grouppolicy/Set-GPPermission.md index cacf142074..4946bfbde8 100644 --- a/docset/winserver2022-ps/grouppolicy/Set-GPPermission.md +++ b/docset/winserver2022-ps/grouppolicy/Set-GPPermission.md @@ -112,7 +112,7 @@ For more information about the *ErrorAction* parameter, see about_CommonParamete Specifies that the permission level is set for the specified security principal for all GPOs in the domain. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: PermissionAll Aliases: @@ -127,7 +127,7 @@ Accept wildcard characters: False Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf @@ -151,10 +151,10 @@ For more information, see the Notes section in the full Help. If you specify a domain that is different from the domain of the user that is running the current session (or, for a startup or shutdown script, the computer), a trust must exist between that domain and the domain of the user or the computer. You can also refer to the *DomainName* parameter by its built-in alias, domain. -For more information, see about_Aliases. +For more information, see [about_Aliases](????????????). ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: Domain @@ -169,7 +169,7 @@ Accept wildcard characters: False Specifies the GPO for which to set the permission level by its globally unique identifier (GUID). The GUID uniquely identifies the GPO. -You can also refer to the *Guid* parameter by its built-in alias, id. +You can also refer to the *Guid* parameter by its built-in alias, **Id**. ```yaml Type: Guid @@ -190,10 +190,10 @@ The display name is not guaranteed to be unique in the domain. If another GPO with the same display name exists in the domain, an error occurs. You can use the *Guid* parameter to uniquely identify a GPO. -You can also refer to the Name parameter by its built-in alias, displayname. +You can also refer to the Name parameter by its built-in alias, **DisplayName**. ```yaml -Type: String +Type: System.String Parameter Sets: PermissionOne(Name) Aliases: DisplayName @@ -233,7 +233,7 @@ Specifies that the existing permission level for the group or user is removed be If a security principal is already granted a permission level that is higher than the specified permission level and you do not use the *Replace* parameter, no change is made. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -250,10 +250,10 @@ You can specify either the fully qualified domain name (FQDN) or the host name. If you do not specify the name by using the *Server* parameter, the primary domain controller (PDC) emulator is contacted. -You can also refer to the *Server* parameter by its built-in alias, dc. +You can also refer to the *Server* parameter by its built-in alias, **DC**. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: DC @@ -278,7 +278,7 @@ For instance, in the contoso.com domain, to specify: - The computer "computer-01", use "contoso\computer-01" or "computer-01". ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -313,11 +313,12 @@ Accept wildcard characters: False ``` ### -WhatIf + Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi @@ -329,6 +330,7 @@ Accept wildcard characters: False ``` ### CommonParameters + 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). ## INPUTS @@ -340,9 +342,11 @@ Collections that contain GPOs from different domains are not supported. ## OUTPUTS ### Microsoft.GroupPolicy.Gpo + This cmdlet returns an object that represents the GPO for which the permission level was set. ## NOTES + * You can use the *DomainName* parameter to explicitly specify the domain for this cmdlet. If you do not explicitly specify the domain, the cmdlet uses a default domain. diff --git a/docset/winserver2022-ps/grouppolicy/Set-GPPrefRegistryValue.md b/docset/winserver2022-ps/grouppolicy/Set-GPPrefRegistryValue.md index b84ce1fa3d..c5613937a2 100644 --- a/docset/winserver2022-ps/grouppolicy/Set-GPPrefRegistryValue.md +++ b/docset/winserver2022-ps/grouppolicy/Set-GPPrefRegistryValue.md @@ -196,7 +196,7 @@ Accept wildcard characters: False Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf @@ -236,7 +236,7 @@ You can use the **Remove-GPPrefRegistryValue** cmdlet to remove any existing Reg This ensures that after you create the disabled Registry preference item, it will be the only Registry preference item associated with the key or value in the specified configuration in the GPO. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -259,11 +259,11 @@ For more information, see the Notes section in the full Help. If you specify a domain that is different from the domain of the user that is running the current session (or, for a startup or shutdown script, the computer), a trust must exist between that domain and the domain of the user or the computer. -You can also refer to the *Domain* parameter by its built-in alias, domainname. -For more information, see about_Aliases. +You can also refer to the **Domain** parameter by its built-in alias, **DomainName**. +For more information, see [about_Aliases](????????????). ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: DomainName @@ -278,7 +278,7 @@ Accept wildcard characters: False Specifies the GPO in which to configure the Registry preference item by its globally unique identifier (GUID). The GUID uniquely identifies the GPO. -You can also refer to the *Guid* parameter by its built-in alias, id. +You can also refer to the *Guid* parameter by its built-in alias, **Id**. ```yaml Type: Guid @@ -305,7 +305,7 @@ You can configure a preference registry setting for a registry key or a registry - To configure a setting for a registry value, specify the *Key* parameter together with the *ValueName*, *Value*, and *Type* parameters. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: FullKeyPath @@ -323,10 +323,10 @@ The display name is not guaranteed to be unique in the domain. If another GPO with the same display name exists in the domain, an error occurs. You can use the *Guid* parameter to uniquely identify a GPO. -You can also refer to the *Name* parameter by its built-in alias, displayname. +You can also refer to the **Name** parameter by its built-in alias, **DisplayName**. ```yaml -Type: String +Type: System.String.String.String Parameter Sets: ByName Aliases: DisplayName @@ -366,10 +366,10 @@ You can specify either the fully qualified domain name (FQDN) or the host name. If you do not specify the name by using the *Server* parameter, the primary domain controller (PDC) emulator is contacted. -You can also refer to the *Server* parameter by its built-in alias, dc. +You can also refer to the *Server* parameter by its built-in alias, **DC**. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: DC @@ -439,7 +439,7 @@ When you configure a Registry preference item for a registry key, do not specify When you configure a Registry preference item for a registry value, specify this parameter together with the *Key*, *Value*, and *Type* parameters. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -451,11 +451,12 @@ Accept wildcard characters: False ``` ### -WhatIf + Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi @@ -467,6 +468,7 @@ Accept wildcard characters: False ``` ### CommonParameters + 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). ## INPUTS @@ -478,9 +480,11 @@ Collections that contain GPOs from different domains are not supported. ## OUTPUTS ### Microsoft.GroupPolicy.Gpo + This cmdlet returns the GPO in which the Registry preference item was configured. ## NOTES + * You can use the *Domain* parameter to explicitly specify the domain for this cmdlet. If you do not explicitly specify the domain, the cmdlet uses a default domain. diff --git a/docset/winserver2022-ps/grouppolicy/Set-GPRegistryValue.md b/docset/winserver2022-ps/grouppolicy/Set-GPRegistryValue.md index 2b70c0f4fd..cd278aa380 100644 --- a/docset/winserver2022-ps/grouppolicy/Set-GPRegistryValue.md +++ b/docset/winserver2022-ps/grouppolicy/Set-GPRegistryValue.md @@ -140,7 +140,7 @@ By using the *Additive* parameter for a registry-based policy setting, you can s You cannot specify the *Disable* parameter with this parameter. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -155,7 +155,7 @@ Accept wildcard characters: False Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf @@ -183,7 +183,7 @@ To remove a policy setting from a GPO without affecting existing registry keys o You cannot specify the *Additive*, *Type*, *Value*, or *ValuePrefix* parameters with the *Disable* parameter. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -206,11 +206,11 @@ For more information, see the Notes section in the full Help. If you specify a domain that is different from the domain of the user that is running the current session (or, for a startup or shutdown script, the computer), a trust must exist between that domain and the domain of the user or the computer. -You can also refer to the *Domain* parameter by its built-in alias, domainname. -For more information, see about_Aliases. +You can also refer to the **Domain** parameter by its built-in alias, **DomainName**. +For more information, see [about_Aliases](????????????). ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: DomainName @@ -225,7 +225,7 @@ Accept wildcard characters: False Specifies the GPO in which to configure the registry-based policy setting by its globally unique identifier (GUID). The GUID uniquely identifies the GPO. -You can also refer to the *Guid* parameter by its built-in alias, id. +You can also refer to the *Guid* parameter by its built-in alias, **Id**. ```yaml Type: Guid @@ -251,7 +251,7 @@ The key must be in one of the two following registry hives: You can also refer to the Key parameter by its built-in alias, FullKeyPath. ```yaml -Type: String +Type: System.String.String Parameter Sets: (All) Aliases: FullKeyPath @@ -269,10 +269,10 @@ The display name is not guaranteed to be unique in the domain. If another GPO with the same display name exists in the domain, an error occurs. You can use the *Guid* parameter to uniquely identify a GPO. -You can also refer to the *Name* parameter by its built-in alias, displayname. +You can also refer to the **Name** parameter by its built-in alias, **DisplayName**. ```yaml -Type: String +Type: System.String Parameter Sets: ByName Aliases: DisplayName @@ -289,10 +289,10 @@ You can specify either the fully qualified domain name (FQDN) or the host name. If you do not specify the name by using the *Server* parameter, the primary domain controller (PDC) emulator is contacted. -You can also refer to the *Server* parameter by its built-in alias, dc. +You can also refer to the *Server* parameter by its built-in alias, **DC**. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: DC @@ -367,7 +367,7 @@ Only the String and ExpandString data types are supported for an array of values You cannot specify this parameter with the *ValuePrefix* parameter. ```yaml -Type: String[] +Type: System.String[] Parameter Sets: (All) Aliases: @@ -394,7 +394,7 @@ Only the String and ExpandString data types are supported with the *ValuePrefix* You cannot specify this parameter with the *ValueName* parameter or the *Disable* parameter. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -406,11 +406,12 @@ Accept wildcard characters: False ``` ### -WhatIf + Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi @@ -422,6 +423,7 @@ Accept wildcard characters: False ``` ### CommonParameters + 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). ## INPUTS @@ -433,9 +435,11 @@ Collections that contain GPOs from different domains are not supported. ## OUTPUTS ### Microsoft.GroupPolicy.Gpo + This cmdlet returns the GPO in which the registry-based policy setting has been configured. ## NOTES + * The hive of the registry key that you specify, HKEY_LOCAL_MACHINE (HKLM) or HKEY_CURRENT_USER (HKCU), determines whether the registry-based policy setting is in Computer Configuration or User Configuration. You can use the *Domain* parameter to explicitly specify the domain for this cmdlet. From a1f2948d339c59f121721849ca92ed7ba43e57ce Mon Sep 17 00:00:00 2001 From: Mike Soule Date: Fri, 28 Apr 2023 15:57:19 -0700 Subject: [PATCH 211/650] formatting #3380 --- .../Install-AdcsEnrollmentWebService.md | 154 ++++++++++++------ 1 file changed, 100 insertions(+), 54 deletions(-) diff --git a/docset/winserver2022-ps/adcsdeployment/Install-AdcsEnrollmentWebService.md b/docset/winserver2022-ps/adcsdeployment/Install-AdcsEnrollmentWebService.md index fc002127dc..55148e8e6e 100644 --- a/docset/winserver2022-ps/adcsdeployment/Install-AdcsEnrollmentWebService.md +++ b/docset/winserver2022-ps/adcsdeployment/Install-AdcsEnrollmentWebService.md @@ -16,24 +16,31 @@ Performs the initial configuration of the Certificate Enrollment Web service. ## SYNTAX ### DefaultParameterSet (Default) + ``` -Install-AdcsEnrollmentWebService [-CAConfig ] [-ApplicationPoolIdentity] - [-AuthenticationType ] [-SSLCertThumbprint ] [-RenewalOnly] - [-AllowKeyBasedRenewal] [-Force] [-Credential ] [-WhatIf] [-Confirm] [] +Install-AdcsEnrollmentWebService [-CAConfig ] +[-ApplicationPoolIdentity] [-AuthenticationType ] +[-SSLCertThumbprint ] [-RenewalOnly] [-AllowKeyBasedRenewal] +[-Force] [-Credential ] [-WhatIf] [-Confirm] +[] ``` ### ServiceAccountParameterSet + ``` -Install-AdcsEnrollmentWebService [-CAConfig ] -ServiceAccountName - -ServiceAccountPassword [-AuthenticationType ] - [-SSLCertThumbprint ] [-RenewalOnly] [-AllowKeyBasedRenewal] [-Force] [-Credential ] - [-WhatIf] [-Confirm] [] +Install-AdcsEnrollmentWebService [-CAConfig ] +-ServiceAccountName -ServiceAccountPassword +[-AuthenticationType ] [-SSLCertThumbprint ] +[-RenewalOnly] [-AllowKeyBasedRenewal] [-Force] [-Credential ] +[-WhatIf] [-Confirm] [] ``` ## DESCRIPTION -The **Install-AdcsEnrollmentWebService** cmdlet performs the configuration of Certificate Enrollment Web service. -It is also used to create additional instances of the service within an existing installation. -To remove the Certificate Enrollment Web Service role service use the **Uninstall-AdcsEnrollmentWebService** cmdlet. + +The `Install-AdcsEnrollmentWebService` cmdlet performs the configuration of the Certificate +Enrollment Web service. It is also used to create and configure additional instances of the service +within an existing installation. To remove the Certificate Enrollment Web Service role service use +the `Uninstall-AdcsEnrollmentWebService` cmdlet. You can import the cmdlet by running the following commands from Windows PowerShell: @@ -43,27 +50,45 @@ You can import the cmdlet by running the following commands from Windows PowerSh ## EXAMPLES ### Example 1: Installs the Certificate Enrollment Web Service to use the certification authority -``` -PS C:\> Install-AdcsEnrollmentWebService -ApplicationPoolIdentity -CAConfig "CA1.contoso.com\contoso-CA1-CA" -SSLCertThumbprint "Thumbprint001" -AuthenticationType Certificate + +```powershell +$params = @{ + ApplicationPoolIdentity = $true + CAConfig = "CA1.contoso.com\contoso-CA1-CA" + SSLCertThumbprint = "a909502dd82ae41433e6f83886b00d4277a32a7b" + AuthenticationType = Certificate +} +Install-AdcsEnrollmentWebService @params ``` -This command installs the Certificate Enrollment Web Service to use the certification authority with a computer name of CA1.contoso.com and a CA common name contoso-CA1-CA. -The identity of the Certificate Enrollment Web Service is specified as the default application pool identity. -The authentication type is certificate based. +This command installs the Certificate Enrollment Web Service to use the certification authority with +a computer name of `CA1.contoso.com` and a CA common name `contoso-CA1-CA`. The identity of the +Certificate Enrollment Web Service is specified as the default application pool identity. The +authentication type is certificate based. ### Example 2: Installs the Certificate Enrollment Web Service to use the certification authority that prompts for password -``` -PS C:\> Install-AdcsEnrollmentWebService -CAConfig "APP1.corp.contoso.com\corp-APP1-CA" -SSLCertThumbprint "Thumbprint001" -ServiceAccountName "Corp\CEPAcct1" -ServiceAccountPassword (read-host "Set user password" -assecurestring) + +```powershell +$params = @{ + CAConfig = "APP1.corp.contoso.com\corp-APP1-CA" + SSLCertThumbprint = "a909502dd82ae41433e6f83886b00d4277a32a7b" + ServiceAccountName = "Corp\CEPAcct1" + ServiceAccountPassword = (Read-Host "Set user password" -AsSecureString) +} +Install-AdcsEnrollmentWebService @params ``` -This command installs the Certificate Enrollment Web Service to use the certification authority with a computer name of APP1.corp.contoso.com and a CA common name corp-APP1-CA. -The identity of the Certificate Enrollment Web Service is specified as CEPAcct1 from the Corp domain. -The command will prompt for the user password. +This command installs the Certificate Enrollment Web Service to use the certification authority with +a computer name of `APP1.corp.contoso.com` and a CA common name `corp-APP1-CA`. The identity of the +Certificate Enrollment Web Service is specified as `CEPAcct1` from the `Corp` domain. The command +will prompt for the user password. ## PARAMETERS ### -AllowKeyBasedRenewal -Indicates that the cmdlet accept key based renewal requests for the enrollment server, which are valid client certificates for authentication that do not directly map to a security principal. + +Indicates that the cmdlet accepts key based renewal requests for the enrollment server, which are +valid client certificates for authentication that do not directly map to a security principal. ```yaml Type: SwitchParameter @@ -78,11 +103,13 @@ Accept wildcard characters: False ``` ### -ApplicationPoolIdentity -Indicates that the cmdlet uses the application pool identity that the Certificate Enrollment Web Service uses when communicating with the Certification Authority (CA). -This parameter is only valid when Certificate Enrollment Web Service targets a remote CA. -If not specified, the local application pool identity is used. -This parameter is only valid when installing the first instance of the Certificate Enrollment Web Service. -If this installation will be for an additional instance of Certificate Enrollment Web Service on this server, then this parameter should not be specified. + +Indicates that the cmdlet configures the Certificate Enrollment Web Service to use the application +pool identity when communicating with the Certification Authority (CA). This parameter is only valid +when Certificate Enrollment Web Service targets a remote CA. If not specified, the local application +pool identity is used. This parameter is only valid when installing the first instance of the +Certificate Enrollment Web Service. If this installation will be for an additional instance of +Certificate Enrollment Web Service on this server, then this parameter should not be specified. ```yaml Type: SwitchParameter @@ -97,6 +124,7 @@ Accept wildcard characters: False ``` ### -AuthenticationType + Specifies the authentication type. The acceptable values for this parameter are: @@ -118,12 +146,13 @@ Accept wildcard characters: False ``` ### -CAConfig -Specifies the configuration string of the CA used by the Certificate Enrollment Web Service to process enrollment requests. -This parameter depends upon whether a local CA is installed. -If the CA is local, then the parameter is optional and defaults to the local CA when not specified. -If there is not a local CA, then the parameter is required. -The input is the configuration string is `\`. -Replace the computer name of the (CA) for `` and replace the CA common name for ``. + +Specifies the configuration string of the CA used by the Certificate Enrollment Web Service to +process enrollment requests. This parameter depends upon whether a local CA is installed. If the CA +is local, then the parameter is optional and defaults to the local CA when not specified. If there +is not a local CA, then the parameter is required. The input of the configuration string is +`\`. Replace the computer name of the (CA) for `` and +replace the CA common name for ``. ```yaml Type: String @@ -138,6 +167,7 @@ Accept wildcard characters: False ``` ### -Confirm + Prompts you for confirmation before running the cmdlet. ```yaml @@ -153,12 +183,14 @@ Accept wildcard characters: False ``` ### -Credential -Specifies the credentials for installing the Certificate Enrollment Web Service. -To obtain a credential object, use the **Get-Credential** cmdlet. -For more information, type `Get-Help Get-Credential`. -The Certificate Enrollment Web Service must be installed on a server that is a member of an Active Directory Domain Services (AD DS) domain. -If the Certificate Enrollment Web Service is configured to use a Standalone certification authority (CA), then an account that is a member of the local Administrators on the CA is required. -If the Enrollment Web Service is installed to use an Enterprise CA, then using an account that is a member of Domain Admins group is required. + +Specifies the credentials for installing the Certificate Enrollment Web Service. To obtain a +credential object, use the `Get-Credential` cmdlet. For more information, type +`Get-Help Get-Credential`. The Certificate Enrollment Web Service must be installed on a server that +is a member of an Active Directory Domain Services (AD DS) domain. If the Certificate Enrollment Web +Service is configured to use a Standalone certification authority (CA), then an account that is a +member of the local Administrators on the CA is required. If the Enrollment Web Service is installed +to use an Enterprise CA, then using an account that is a member of Domain Admins group is required. ```yaml Type: PSCredential @@ -173,6 +205,7 @@ Accept wildcard characters: False ``` ### -Force + Forces the command to run without asking for user confirmation. ```yaml @@ -188,6 +221,7 @@ Accept wildcard characters: False ``` ### -RenewalOnly + Indicates that the cmdlet enables renewal only mode. ```yaml @@ -203,12 +237,14 @@ Accept wildcard characters: False ``` ### -SSLCertThumbprint -Specifies the hash or thumbprint of the Secure Sockets Layer/Transport Layer Security (SSL/TLS) certificate for a web site as a string value. -This parameter is optional. -If used, it establishes the necessary binding with Internet Information Server (IIS) to enable support for the required SSL/TLS connectivity. -If a binding already exists within IIS, specifying this parameter overwrites the existing binding. -If this parameter is not specified, any existing binding is used. -If no bindings exist, installation succeeds, but the service will not function until the binding is established manually. + +Specifies the hash or thumbprint of the Secure Sockets Layer/Transport Layer Security (SSL/TLS) +certificate for a web site as a string value. This parameter is optional. If used, it establishes +the necessary binding with Internet Information Server (IIS) to enable support for the required +SSL/TLS connectivity. If a binding already exists within IIS, specifying this parameter overwrites +the existing binding. If this parameter is not specified, any existing binding is used. If no +bindings exist, installation succeeds, but the service will not function until the binding is +established manually. ```yaml Type: String @@ -223,9 +259,10 @@ Accept wildcard characters: False ``` ### -ServiceAccountName -Specifies the domain account for use with the service. -The input string should be in the form of `\`. -For instance, to specify an account named WebEnroll in the Corp.contoso.com domain, you would type `CORP\WebEnroll`. + +Specifies the domain account for use with the service. The input string should be in the form of +`\`. For instance, to specify an account named `WebEnroll` in the +`Corp.contoso.com` domain, you would type `CORP\WebEnroll`. ```yaml Type: String @@ -240,6 +277,7 @@ Accept wildcard characters: False ``` ### -ServiceAccountPassword + Specifies the password for the domain account used as the service account. ```yaml @@ -255,6 +293,7 @@ Accept wildcard characters: False ``` ### -WhatIf + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -271,7 +310,11 @@ Accept wildcard characters: False ``` ### CommonParameters -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). + +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). ## INPUTS @@ -290,15 +333,18 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ### Microsoft.CertificateServices.Deployment.Common.CES.EnrollmentServiceResult ## NOTES -* Ensure you run Windows PowerShell as an administrator. You can use the *Force* parameter to bypass the prompt for confirmation. -To see parameters, run the following command: `Install-AdcsEnrollmentWebService cmdlet -?` -* You can get the CA configuration, which is the computer name and CA name by running certutil without any parameters. You can see the SSL certificate thumbprints assigned to the local computer by running the following commands: - - `cd cert:\LocalMachine\My` - - `dir | format-list` + +- Ensure you run Windows PowerShell as an administrator. You can use the **Force** parameter to + bypass the prompt for confirmation. To see parameters, run the following command: + `Install-AdcsEnrollmentWebService cmdlet -?` +- You can get the CA configuration, which is the computer name and CA name by running certutil + without any parameters. You can see the SSL certificate thumbprints assigned to the local computer + by running the following commands: + - `cd cert:\LocalMachine\My` + - `dir | format-list` ## RELATED LINKS [Uninstall-AdcsEnrollmentWebService](./Uninstall-AdcsEnrollmentWebService.md) [Get-Credential](https://go.microsoft.com/fwlink/?LinkID=293936) - From 75c71e62abc836c5c87414a091d7c552cd2a56df Mon Sep 17 00:00:00 2001 From: Michael Date: Fri, 28 Apr 2023 16:00:30 -0700 Subject: [PATCH 212/650] Update Install-AdcsEnrollmentWebService.md --- .../adcsdeployment/Install-AdcsEnrollmentWebService.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docset/winserver2022-ps/adcsdeployment/Install-AdcsEnrollmentWebService.md b/docset/winserver2022-ps/adcsdeployment/Install-AdcsEnrollmentWebService.md index 55148e8e6e..c8d78cffd5 100644 --- a/docset/winserver2022-ps/adcsdeployment/Install-AdcsEnrollmentWebService.md +++ b/docset/winserver2022-ps/adcsdeployment/Install-AdcsEnrollmentWebService.md @@ -19,10 +19,10 @@ Performs the initial configuration of the Certificate Enrollment Web service. ``` Install-AdcsEnrollmentWebService [-CAConfig ] -[-ApplicationPoolIdentity] [-AuthenticationType ] -[-SSLCertThumbprint ] [-RenewalOnly] [-AllowKeyBasedRenewal] -[-Force] [-Credential ] [-WhatIf] [-Confirm] -[] + [-ApplicationPoolIdentity] [-AuthenticationType ] + [-SSLCertThumbprint ] [-RenewalOnly] [-AllowKeyBasedRenewal] + [-Force] [-Credential ] [-WhatIf] [-Confirm] + [] ``` ### ServiceAccountParameterSet From fba1b748db6703eea7c1105f572162837750f84b Mon Sep 17 00:00:00 2001 From: Mike Soule Date: Fri, 28 Apr 2023 16:10:16 -0700 Subject: [PATCH 213/650] formatting #3382 --- .../Install-AdcsEnrollmentPolicyWebService.md | 103 ++++++++++++------ 1 file changed, 71 insertions(+), 32 deletions(-) diff --git a/docset/winserver2022-ps/adcsdeployment/Install-AdcsEnrollmentPolicyWebService.md b/docset/winserver2022-ps/adcsdeployment/Install-AdcsEnrollmentPolicyWebService.md index 10cd13901e..2329c67e18 100644 --- a/docset/winserver2022-ps/adcsdeployment/Install-AdcsEnrollmentPolicyWebService.md +++ b/docset/winserver2022-ps/adcsdeployment/Install-AdcsEnrollmentPolicyWebService.md @@ -11,19 +11,23 @@ title: Install-AdcsEnrollmentPolicyWebService # Install-AdcsEnrollmentPolicyWebService ## SYNOPSIS -Performs the configuration of Certificate Enrollment Policy Web service. +Performs the configuration of Certificate Enrollment Policy Web Service. ## SYNTAX ``` -Install-AdcsEnrollmentPolicyWebService [-AuthenticationType ] [-SSLCertThumbprint ] - [-KeyBasedRenewal] [-Force] [-Credential ] [-WhatIf] [-Confirm] [] +Install-AdcsEnrollmentPolicyWebService + [-AuthenticationType ] [-SSLCertThumbprint ] + [-KeyBasedRenewal] [-Force] [-Credential ] [-WhatIf] + [-Confirm] [] ``` ## DESCRIPTION -The **Install-AdcsEnrollmentPolicyWebService** cmdlet performs the configuration of Certificate Enrollment Policy Web service. -It is also used to create additional instances of the service within an existing installation. -To remove the certification authority (CA) role service use the **Uninstall-AdcsEnrollmentPolicyWebService** cmdlet. + +The `Install-AdcsEnrollmentPolicyWebService` cmdlet performs the configuration of Certificate +Enrollment Policy Web Service. It is also used to create and configure additional instances of the +service within an existing installation. To remove the certification authority (CA) role service use +the `Uninstall-AdcsEnrollmentPolicyWebService` cmdlet. You can import the cmdlet by running the following commands from Windows PowerShell: @@ -33,30 +37,51 @@ You can import the cmdlet by running the following commands from Windows PowerSh ## EXAMPLES ### Example 1: Install the Certificate Enrollment Policy Web Service using Kerberos -``` -PS C:\> Install-AdcsEnrollmentPolicyWebService -AuthenticationType Kerberos -SSLCertThumbprint "sslCertThumbPrint" + +```powershell +$params = @{ + AuthenticationType = Kerberos + SSLCertThumbprint = "a909502dd82ae41433e6f83886b00d4277a32a7b" +} +Install-AdcsEnrollmentPolicyWebService @params ``` -This command installs the Certificate Enrollment Policy Web Service using Kerberos for authentication. -For information on obtaining a certificate thumbprint using Windows PowerShell, see [Certificate Provider](https://go.microsoft.com/fwlink/?LinkId=225044). +This command installs the Certificate Enrollment Policy Web Service using Kerberos for +authentication. For information on obtaining a certificate thumbprint using Windows PowerShell, see +[Certificate Provider](https://go.microsoft.com/fwlink/?LinkId=225044). ### Example 2: Install the Certificate Enrollment Policy Web Service specifying a username and password -``` -PS C:\> Install-AdcsEnrollmentPolicyWebService -AuthenticationType Username -SSLCertThumbprint "sslCertThumbPrint" + +```powershell +$params = @{ + AuthenticationType = Username + SSLCertThumbprint = "a909502dd82ae41433e6f83886b00d4277a32a7b" +} +Install-AdcsEnrollmentPolicyWebService @params ``` -This command installs the Certificate Enrollment Policy Web Service specifying that a username and password is used for authentication. +This command installs the Certificate Enrollment Policy Web Service specifying that a username and +password is used for authentication. ### Example 3: Install the Certificate Enrollment Policy Web Service specifying a username and password for Key-Based Renewal -``` -PS C:\> Install-AdcsEnrollmentPolicyWebService -AuthenticationType Username -SSLCertThumbprint -KeyBasedRenewal + +```powershell +$params = @{ + AuthenticationType = Username + SSLCertThumbprint = "a909502dd82ae41433e6f83886b00d4277a32a7b" + KeyBasedRenewal = $true +} +Install-AdcsEnrollmentPolicyWebService @params ``` -This command installs the Certificate Enrollment Policy Web Service specifying that a username and password is used for authentication and configures the service for Key-Based Renewal of the certificate. +This command installs the Certificate Enrollment Policy Web Service specifying that a username and +password is used for authentication and configures the service for Key-Based Renewal of the +certificate. ## PARAMETERS ### -AuthenticationType + Specifies the authentication type used by the Certificate Enrollment Policy Web Service. The acceptable values for this parameter are: @@ -78,6 +103,7 @@ Accept wildcard characters: False ``` ### -Confirm + Prompts you for confirmation before running the cmdlet. ```yaml @@ -93,11 +119,12 @@ Accept wildcard characters: False ``` ### -Credential -Specifies the credentials for installing the Enrollment Policy Web Service. -To obtain a credential object, use the **Get-Credential** cmdlet. -For more information, type `Get-Help Get-Credential`. -The Enrollment Policy Web Service must be installed on a server that is a member of an Active Directory Domain Services (AD DS) domain. -You must use an account that is a member of Domain Admins group to install this service. + +Specifies the credentials for installing the Enrollment Policy Web Service. To obtain a credential +object, use the `Get-Credential` cmdlet. For more information, type `Get-Help Get-Credential`. The +Enrollment Policy Web Service must be installed on a server that is a member of an Active Directory +Domain Services (AD DS) domain. You must use an account that is a member of Domain Admins group to +install this service. ```yaml Type: PSCredential @@ -112,6 +139,7 @@ Accept wildcard characters: False ``` ### -Force + Forces the command to run without asking for user confirmation. ```yaml @@ -127,9 +155,11 @@ Accept wildcard characters: False ``` ### -KeyBasedRenewal -Indicates that this cmdlet configures the Certificate Enrollment Policy Web Service to operate in key-based renewal mode. -Key-based renewal allows certificate clients to renew their certificates using the key of their existing certificate for authentication. -When in key-based renewal mode, the service will only return certificate templates that are set for key based renewal. + +Indicates that this cmdlet configures the Certificate Enrollment Policy Web Service to operate in +key-based renewal mode. Key-based renewal allows certificate clients to renew their certificates +using the key of their existing certificate for authentication. When in key-based renewal mode, the +service will only return certificate templates that are set for key based renewal. ```yaml Type: SwitchParameter @@ -144,7 +174,9 @@ Accept wildcard characters: False ``` ### -SSLCertThumbprint -Specifies the thumbprint of the certificate used by Internet Information Service (IIS) to enable support for required Secure Sockets Layer (SSL). + +Specifies the thumbprint of the certificate used by Internet Information Service (IIS) to enable +support for required Secure Sockets Layer/Transport Layer Security (SSL/TLS). ```yaml Type: String @@ -159,6 +191,7 @@ Accept wildcard characters: False ``` ### -WhatIf + Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml @@ -174,7 +207,11 @@ Accept wildcard characters: False ``` ### CommonParameters -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). + +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). ## INPUTS @@ -191,15 +228,17 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ### Microsoft.CertificateServices.Deployment.Common.CEP.EnrollmentPolicyServiceResult ## NOTES -* Ensure you run Windows PowerShell as an administrator. You can use the *Force* parameter to bypass the prompt for confirmation. - To see parameters, run the following command: `Install-AdcsEnrollmentPolicyWebService -?` +- Ensure you run Windows PowerShell as an administrator. You can use the **Force** parameter to + bypass the prompt for confirmation. To see parameters, run the following command: + `Install-AdcsEnrollmentPolicyWebService -?` -* You can get the CA configuration, which is the computer name and CA name by running certutil without any parameters. You can see the certificate SSL certificate thumbprints assigned to the local computer by running the following commands: - - `cd cert:\LocalMachine\My` - - `dir | format-list` +- You can get the CA configuration, which is the computer name and CA name by running certutil + without any parameters. You can see the certificate SSL certificate thumbprints assigned to the + local computer by running the following commands: + - `cd cert:\LocalMachine\My` + - `dir | format-list` ## RELATED LINKS [Uninstall-AdcsEnrollmentPolicyWebService](./Uninstall-AdcsEnrollmentPolicyWebService.md) - From 744abdd793032b8d1c2562e7bef78cf3b18c99c9 Mon Sep 17 00:00:00 2001 From: Mike Soule Date: Fri, 28 Apr 2023 16:32:37 -0700 Subject: [PATCH 214/650] formatting #3384 --- .../Install-AdcsCertificationAuthority.md | 191 +++++++++++++----- 1 file changed, 138 insertions(+), 53 deletions(-) diff --git a/docset/winserver2022-ps/adcsdeployment/Install-AdcsCertificationAuthority.md b/docset/winserver2022-ps/adcsdeployment/Install-AdcsCertificationAuthority.md index 450e657cb3..696c3d9bf8 100644 --- a/docset/winserver2022-ps/adcsdeployment/Install-AdcsCertificationAuthority.md +++ b/docset/winserver2022-ps/adcsdeployment/Install-AdcsCertificationAuthority.md @@ -11,93 +11,145 @@ title: Install-AdcsCertificationAuthority # Install-AdcsCertificationAuthority ## SYNOPSIS -Performs installation and configuration of the AD CS Certification Authority role service. +Performs installation and configuration of the Active Directory Certificate Services (AD CS) +Certification Authority (CA) role service. ## SYNTAX ### NewKeyParameterSet (Default) + ``` -Install-AdcsCertificationAuthority [-AllowAdministratorInteraction] [-ValidityPeriod ] - [-ValidityPeriodUnits ] [-CACommonName ] [-CADistinguishedNameSuffix ] - [-CAType ] [-CryptoProviderName ] [-DatabaseDirectory ] [-HashAlgorithmName ] - [-IgnoreUnicode] [-KeyLength ] [-LogDirectory ] [-OutputCertRequestFile ] - [-OverwriteExistingCAinDS] [-OverwriteExistingKey] [-ParentCA ] [-OverwriteExistingDatabase] - [-Credential ] [-Force] [-WhatIf] [-Confirm] [] +Install-AdcsCertificationAuthority [-AllowAdministratorInteraction] + [-ValidityPeriod ] [-ValidityPeriodUnits ] + [-CACommonName ] [-CADistinguishedNameSuffix ] + [-CAType ] [-CryptoProviderName ] + [-DatabaseDirectory ] [-HashAlgorithmName ] + [-IgnoreUnicode] [-KeyLength ] [-LogDirectory ] + [-OutputCertRequestFile ] [-OverwriteExistingCAinDS] + [-OverwriteExistingKey] [-ParentCA ] [-OverwriteExistingDatabase] + [-Credential ] [-Force] [-WhatIf] [-Confirm] + [] ``` ### ExistingCertificateParameterSet + ``` -Install-AdcsCertificationAuthority [-AllowAdministratorInteraction] [-CertFilePassword ] - [-CertFile ] [-CAType ] [-CertificateID ] [-DatabaseDirectory ] - [-LogDirectory ] [-OverwriteExistingKey] [-OverwriteExistingDatabase] [-Credential ] - [-Force] [-WhatIf] [-Confirm] [] +Install-AdcsCertificationAuthority [-AllowAdministratorInteraction] + [-CertFilePassword ] [-CertFile ] [-CAType ] + [-CertificateID ] [-DatabaseDirectory ] + [-LogDirectory ] [-OverwriteExistingKey] + [-OverwriteExistingDatabase] [-Credential ] [-Force] + [-WhatIf] [-Confirm] [] ``` ### ExistingKeyParameterSet + ``` -Install-AdcsCertificationAuthority [-AllowAdministratorInteraction] [-ValidityPeriod ] - [-ValidityPeriodUnits ] [-CADistinguishedNameSuffix ] [-CAType ] - [-CryptoProviderName ] [-DatabaseDirectory ] [-HashAlgorithmName ] [-IgnoreUnicode] - [-KeyContainerName ] [-LogDirectory ] [-OutputCertRequestFile ] - [-OverwriteExistingCAinDS] [-ParentCA ] [-OverwriteExistingDatabase] [-Credential ] - [-Force] [-WhatIf] [-Confirm] [] +Install-AdcsCertificationAuthority [-AllowAdministratorInteraction] + [-ValidityPeriod ] [-ValidityPeriodUnits ] + [-CADistinguishedNameSuffix ] [-CAType ] + [-CryptoProviderName ] [-DatabaseDirectory ] + [-HashAlgorithmName ] [-IgnoreUnicode] [-KeyContainerName ] + [-LogDirectory ] [-OutputCertRequestFile ] + [-OverwriteExistingCAinDS] [-ParentCA ] + [-OverwriteExistingDatabase] [-Credential ] [-Force] + [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION -The **Install-AdcsCertificationAuthority** cmdlet performs installation and configuration of the Active Directory Certificate Services (AD CS) Certification Authority (CA) role service. -To remove the certification authority role service use the **Uninstall-AdcsCertificationAuthority** cmdlet. + +The `Install-AdcsCertificationAuthority` cmdlet performs installation and configuration of the +Active Directory Certificate Services (AD CS) Certification Authority (CA) role service. To remove +the certification authority role service use the `Uninstall-AdcsCertificationAuthority` cmdlet. You can import the cmdlet by running the following commands from Windows PowerShell: - `Install-WindowsFeature Adcs-Cert-Authority` -To include the Certification Authority and Certificate Templates consoles in a CA installation, you must use the *IncludeManagementTools* parameter at the end of the `Install-WindowsFeature Adcs-Cert-Authority` command. +To include the Certification Authority and Certificate Templates consoles in a CA installation, you +must use the **IncludeManagementTools** parameter at the end of the +`Install-WindowsFeature Adcs-Cert-Authority` command. -Int is equivalent to Int32 in the [.NET Framework](/dotnet/csharp/language-reference/builtin-types/built-in-types). +Int is equivalent to Int32 in the +[.NET Framework](/dotnet/csharp/language-reference/builtin-types/built-in-types). ## EXAMPLES ### Example 1: Install a new Standalone Root CA with default settings + ```powershell -PS C:\> Install-AdcsCertificationAuthority -CAType StandaloneRootCa +Install-AdcsCertificationAuthority -CAType StandaloneRootCa ``` This command installs a new Standalone Root CA with default settings. ### Example 2: Install a new Enterprise Root CA using a specific provider and key length + ```powershell -PS C:\> Install-AdcsCertificationAuthority -CAType EnterpriseRootCa -CryptoProviderName "ECDSA_P256#Microsoft Software Key Storage Provider" -KeyLength 256 -HashAlgorithmName SHA256 +$params = @{ + CAType = EnterpriseRootCa + CryptoProviderName = "ECDSA_P256#Microsoft Software Key Storage Provider" + KeyLength = 256 + HashAlgorithmName = SHA256 +} +Install-AdcsCertificationAuthority @params ``` -This command installs a new Enterprise Root CA using the provider named ECDSA_P256 Microsoft Software Key Storage Provider, key length of 256, and the hash algorithm named SHA 256. +This command installs a new Enterprise Root CA using the provider named ECDSA_P256 Microsoft +Software Key Storage Provider, key length of 256, and the hash algorithm named SHA 256. ### Example 3: Install a new Enterprise Root CA using a specific provider and a validity period + ```powershell -PS C:\> Install-AdcsCertificationAuthority -CAType EnterpriseRootCa -CryptoProviderName "RSA#Microsoft Software Key Storage Provider" -KeyLength 2048 -HashAlgorithmName SHA1 -ValidityPeriod Years -ValidityPeriodUnits 3 +$params = @{ + CAType = EnterpriseRootCa + CryptoProviderName = "RSA#Microsoft Software Key Storage Provider" + KeyLength = 2048 + HashAlgorithmName = SHA1 + ValidityPeriod = Years + ValidityPeriodUnits = 3 +} +Install-AdcsCertificationAuthority @params ``` -This command installs a new Enterprise Root CA using a RSA algorithm using the provider named Microsoft Software Key Storage Provider, a key length of 2048, a hash algorithm named SHA 1, and validity period of three years. +This command installs a new Enterprise Root CA using the RSA algorithm using the provider named +Microsoft Software Key Storage Provider, a key length of 2048, a hash algorithm named SHA 1, and +validity period of three years. ### Example 4: Install a new Enterprise Subordinate CA using a parent CA + ```powershell -PS C:\> Install-AdcsCertificationAuthority -CAType EnterpriseSubordinateCa -ParentCA SERVER75.corp.contoso.com\SERVER75-CA +$params = @{ + CAType = EnterpriseSubordinateCa + ParentCA = "SERVER75.corp.contoso.com\SERVER75-CA" +} +Install-AdcsCertificationAuthority @params ``` -This command installs a new Enterprise subordinate CA, the parent CA is SERVER75 in the CORP domain of Contoso.com. +This command installs a new Enterprise subordinate CA, the parent CA is `SERVER75` in the CORP domain +of Contoso.com. ### Example 5: Install a new Enterprise Subordinate CA using an existing certificate + ```powershell -PS C:\> Install-AdcsCertificationAuthority -CAType EnterpriseSubordinateCa -CertFile C:\Cert\SERVER80-CA.p12 -CertFilePassword (read-host "Set user password" -assecurestring) +$params = @{ + CAType = EnterpriseSubordinateCa + CertFile = "C:\Cert\SERVER80-CA.p12" + CertFilePassword = (Read-Host "Set user password" -AsSecureString) +} +Install-AdcsCertificationAuthority @params ``` -This command installs an Enterprise Subordinate CA using an existing certificate from a PFX/P12 file that is located on the local C:\Cert folder named SERVER80-CA.p12. +This command installs an Enterprise Subordinate CA using an existing certificate from a PFX/P12 file +that is located on the local `C:\Cert` folder named `SERVER80-CA.p12`. ## PARAMETERS ### -AllowAdministratorInteraction -Indicates that the cmdlet enables prompting when the private key is accessed. -This is not required for any of the Microsoft default providers. -For enhanced security components, such as a hardware security module (HSM), review the enhanced security component vendor documentation. + +Indicates that the cmdlet enables prompting when the private key is accessed. This is not required +for any of the Microsoft default providers. For enhanced security components, such as a hardware +security module (HSM), review the enhanced security component vendor documentation. ```yaml Type: SwitchParameter @@ -112,6 +164,7 @@ Accept wildcard characters: False ``` ### -CACommonName + Specifies the certification authority common name. ```yaml @@ -127,6 +180,7 @@ Accept wildcard characters: False ``` ### -CADistinguishedNameSuffix + Specifies the certification authority distinguished name suffix. ```yaml @@ -142,6 +196,7 @@ Accept wildcard characters: False ``` ### -CAType + Specifies the type of certification authority that this cmdlet installs. The acceptable values for this parameter are: @@ -164,6 +219,7 @@ Accept wildcard characters: False ``` ### -CertFile + Specifies the file name of certification authority PKCS #12 formatted certificate file. ```yaml @@ -179,6 +235,7 @@ Accept wildcard characters: False ``` ### -CertFilePassword + Specifies the password for certification authority certificate file. ```yaml @@ -194,6 +251,7 @@ Accept wildcard characters: False ``` ### -CertificateID + Specifies the thumbprint or serial number of certification authority certificate. ```yaml @@ -209,6 +267,7 @@ Accept wildcard characters: False ``` ### -Confirm + Prompts you for confirmation before running the cmdlet. ```yaml @@ -224,13 +283,14 @@ Accept wildcard characters: False ``` ### -Credential -Specifies a **PSCredential** object for the connection to AD DS. -To obtain a credential object, use the **Get-Credential** cmdlet. -For more information, type `Get-Help Get-Credential`. -To install an enterprise certification authority, the computer must be joined to an AD DS domain and a user account that is a member of the Enterprise Admin group is required. -To install a standalone certification authority, the computer can be in a workgroup or AD DS domain. -If the computer is in a workgroup, a user account that is a member of Administrators is required. -If the computer is in an AD DS domain, a user account that is a member of Domain Admins is required. + +Specifies a **PSCredential** object for the connection to AD DS. To obtain a credential object, use +the `Get-Credential` cmdlet. For more information, type `Get-Help Get-Credential`. To install an +enterprise certification authority, the computer must be joined to an AD DS domain and a user +account that is a member of the Enterprise Admin group is required. To install a standalone +certification authority, the computer can be in a workgroup or AD DS domain. If the computer is in a +workgroup, a user account that is a member of Administrators is required. If the computer is in an +AD DS domain, a user account that is a member of Domain Admins is required. ```yaml Type: PSCredential @@ -245,7 +305,9 @@ Accept wildcard characters: False ``` ### -CryptoProviderName -Specifies the name of the cryptographic service provider (CSP) or key storage provider (KSP) that is used to generate or store the private key for the CA. + +Specifies the name of the cryptographic service provider (CSP) or key storage provider (KSP) that is +used to generate or store the private key for the CA. ```yaml Type: String @@ -260,6 +322,7 @@ Accept wildcard characters: False ``` ### -DatabaseDirectory + Specifies the folder location of the certification authority database. ```yaml @@ -275,6 +338,7 @@ Accept wildcard characters: False ``` ### -Force + Forces the command to run without asking for user confirmation. ```yaml @@ -290,6 +354,7 @@ Accept wildcard characters: False ``` ### -HashAlgorithmName + Specifies the signature hash algorithm used by the certification authority. ```yaml @@ -305,6 +370,7 @@ Accept wildcard characters: False ``` ### -IgnoreUnicode + Indicates that the cmdlet allows Unicode characters in the certification authority name string. ```yaml @@ -320,6 +386,7 @@ Accept wildcard characters: False ``` ### -KeyContainerName + Specifies the name of an existing private key container. ```yaml @@ -335,6 +402,7 @@ Accept wildcard characters: False ``` ### -KeyLength + Specifies the bit length for new certification authority key. ```yaml @@ -350,6 +418,7 @@ Accept wildcard characters: False ``` ### -LogDirectory + Specifies the folder location of the certification authority database log. ```yaml @@ -365,7 +434,8 @@ Accept wildcard characters: False ``` ### -OutputCertRequestFile -Specifies the folder location for certificate request file. + +Specifies the folder location for the certificate request file. ```yaml Type: String @@ -380,7 +450,9 @@ Accept wildcard characters: False ``` ### -OverwriteExistingCAinDS -Indicates that the cmdlet overwrites the computer object in the Active Directory Domain Service domain with the same computer name. + +Indicates that the cmdlet overwrites the computer object in the Active Directory Domain Service +domain with the same computer name. ```yaml Type: SwitchParameter @@ -395,6 +467,7 @@ Accept wildcard characters: False ``` ### -OverwriteExistingDatabase + Indicates that the cmdlet overwrites the existing certification authority database. ```yaml @@ -410,6 +483,7 @@ Accept wildcard characters: False ``` ### -OverwriteExistingKey + Indicates that the cmdlet overwrites the existing key container with the same name. ```yaml @@ -425,6 +499,7 @@ Accept wildcard characters: False ``` ### -ParentCA + Specifies the configuration string of the parent certification authority that will certify this CA. ```yaml @@ -440,8 +515,10 @@ Accept wildcard characters: False ``` ### -ValidityPeriod -Specifies the validity period of the certification authority (CA) certificate in hours, days, weeks, months or years. -If this is a subordinate CA, do not use this parameter, because the validity period is determined by the parent CA. + +Specifies the validity period of the certification authority (CA) certificate in hours, days, weeks, +months or years. If this is a subordinate CA, do not use this parameter, because the validity period +is determined by the parent CA. ```yaml Type: ValidityPeriod @@ -457,8 +534,9 @@ Accept wildcard characters: False ``` ### -ValidityPeriodUnits -Specifies the validity period of the CA certificate. -If this is a subordinate CA, do not specify this parameter because the validity period is determined by the parent CA. + +Specifies the validity period of the CA certificate. If this is a subordinate CA, do not specify +this parameter because the validity period is determined by the parent CA. ```yaml Type: Int32 @@ -473,8 +551,8 @@ Accept wildcard characters: False ``` ### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. + +Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml Type: SwitchParameter @@ -489,7 +567,11 @@ Accept wildcard characters: False ``` ### CommonParameters -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). + +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). ## INPUTS @@ -512,9 +594,12 @@ This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVar ### Microsoft.CertificateServices.Deployment.Common.CA.CertificationAuthoritySetupResult ## NOTES -* Ensure you run Windows PowerShell as an administrator. You can use the *force* parameter to bypass the prompt for confirmation. -To see parameters, run the following command: `Install-AdcsCertificationAuthority -?` -If you have installation issues, try using the *verbose* parameter to get verbose output and review the information in the %windir%\cerocm.log file. + +- Ensure you run Windows PowerShell as an administrator. You can use the **force** parameter to + bypass the prompt for confirmation. To see parameters, run the following command: + `Install-AdcsCertificationAuthority -?` +- If you have installation issues, try using the **verbose** parameter to get verbose output and + review the information in the %windir%\cerocm.log file. ## RELATED LINKS From ebc982cd9061f89277e5bfa5c38edbb6fcc39972 Mon Sep 17 00:00:00 2001 From: Mike Soule Date: Fri, 28 Apr 2023 16:35:16 -0700 Subject: [PATCH 215/650] formatting #3386 --- .../adcsdeployment/ADCSDeployment.md | 21 ++++++++++++++++--- 1 file changed, 18 insertions(+), 3 deletions(-) diff --git a/docset/winserver2022-ps/adcsdeployment/ADCSDeployment.md b/docset/winserver2022-ps/adcsdeployment/ADCSDeployment.md index bed2db8405..adc52c534b 100644 --- a/docset/winserver2022-ps/adcsdeployment/ADCSDeployment.md +++ b/docset/winserver2022-ps/adcsdeployment/ADCSDeployment.md @@ -10,44 +10,59 @@ title: ADCSDeployment --- # ADCSDeployment Module + ## Description -This topic contains the brief descriptions of the Windows PowerShell® cmdlets that are for use in deploying Active Directory Certificate Services (AD CS). Each cmdlet in the table is linked to additional information about that cmdlet. + +This topic contains the brief descriptions of the Windows PowerShell® cmdlets that are for use in +deploying Active Directory Certificate Services (AD CS). Each cmdlet in the table is linked to +additional information about that cmdlet. ## ADCSDeployment Cmdlets + ### [Install-AdcsCertificationAuthority](./Install-AdcsCertificationAuthority.md) + Performs installation and configuration of the AD CS Certification Authority role service. ### [Install-AdcsEnrollmentPolicyWebService](./Install-AdcsEnrollmentPolicyWebService.md) + Performs the configuration of Certificate Enrollment Policy Web service. ### [Install-AdcsEnrollmentWebService](./Install-AdcsEnrollmentWebService.md) + Performs the initial configuration of the Certificate Enrollment Web service. ### [Install-AdcsNetworkDeviceEnrollmentService](./Install-AdcsNetworkDeviceEnrollmentService.md) + Installs the NDES role service. ### [Install-AdcsOnlineResponder](./Install-AdcsOnlineResponder.md) + Installs the Online Responder service. ### [Install-AdcsWebEnrollment](./Install-AdcsWebEnrollment.md) + Installs the Certification Authority Web Enrollment. ### [Uninstall-AdcsCertificationAuthority](./Uninstall-AdcsCertificationAuthority.md) + Uninstalls the CA role service and removes the configuration information. ### [Uninstall-AdcsEnrollmentPolicyWebService](./Uninstall-AdcsEnrollmentPolicyWebService.md) + Uninstalls the Certificate Enrollment Policy Web service. ### [Uninstall-AdcsEnrollmentWebService](./Uninstall-AdcsEnrollmentWebService.md) + Uninstalls the Certificate Enrollment Web service or individual instances of it. ### [Uninstall-AdcsNetworkDeviceEnrollmentService](./Uninstall-AdcsNetworkDeviceEnrollmentService.md) + Uninstalls the NDES role service. ### [Uninstall-AdcsOnlineResponder](./Uninstall-AdcsOnlineResponder.md) + Uninstalls the Online Responder service. ### [Uninstall-AdcsWebEnrollment](./Uninstall-AdcsWebEnrollment.md) -Uninstalls the CA Web Enrollment role service. - +Uninstalls the CA Web Enrollment role service. From 563c76c91561625eee8f94350c33d2cf8c8e58b2 Mon Sep 17 00:00:00 2001 From: Robert Biddle Date: Sat, 29 Apr 2023 15:48:40 -0400 Subject: [PATCH 216/650] Fixing cmdlet reference style --- .../winserver2022-ps/addsdeployment/Install-ADDSDomain.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docset/winserver2022-ps/addsdeployment/Install-ADDSDomain.md b/docset/winserver2022-ps/addsdeployment/Install-ADDSDomain.md index bc9667fd64..8a10d3d524 100644 --- a/docset/winserver2022-ps/addsdeployment/Install-ADDSDomain.md +++ b/docset/winserver2022-ps/addsdeployment/Install-ADDSDomain.md @@ -69,7 +69,7 @@ the installation of the domain in Active Directory. Specifies the user name and password that corresponds to the account to be used for running operations to prepare Active Directory prior to the installation of this domain. Use the -**Get-Credential** cmdlet to prompt the user to supply a password. +`Get-Credential` cmdlet to prompt the user to supply a password. ```yaml Type: System.Management.Automation.PSCredential @@ -136,7 +136,7 @@ Accept wildcard characters: False ### -Credential Specifies the user name and password that corresponds to the account used to install the domain -controller. Use the **Get-Credential** cmdlet to prompt the user to supply a password. +controller. Use the `Get-Credential` cmdlet to prompt the user to supply a password. ```yaml Type: System.Management.Automation.PSCredential @@ -453,7 +453,7 @@ This is the preferred usage when running the cmdlet interactively. If there are specified with the cmdlet, you are prompted to enter a masked password for this parameter but no confirmation of the password entered is made. This is not recommended as it could allow a mistyped password to be configured. Another available advanced option is to use the -**ConvertTo-SecureString** cmdlet and specify the password string inline as unmasked console input, +`ConvertTo-SecureString` cmdlet and specify the password string inline as unmasked console input, which is also not a recommended security best practice in production deployments. ```yaml From f67495bec1aaec94ab301eccdb523b74003be27e Mon Sep 17 00:00:00 2001 From: Vanda Paladino Date: Sat, 29 Apr 2023 17:10:06 -0400 Subject: [PATCH 217/650] Corrections to Enable-ServerManagerStandardUserRemoting.md Get-WindowsFeature.md Install-WindowsFeature.md ServerManager.md Uninstall-WindowsFeature.md Disable-ServerManagerStandardUserRemoting.md --- ...sable-ServerManagerStandardUserRemoting.md | 7 +- ...nable-ServerManagerStandardUserRemoting.md | 77 +++++-- .../ServerManager/Get-WindowsFeature.md | 90 +++++--- .../ServerManager/Install-WindowsFeature.md | 198 +++++++++++------- .../ServerManager/ServerManager.md | 25 ++- .../ServerManager/Uninstall-WindowsFeature.md | 124 +++++++---- 6 files changed, 345 insertions(+), 176 deletions(-) diff --git a/docset/winserver2022-ps/ServerManager/Disable-ServerManagerStandardUserRemoting.md b/docset/winserver2022-ps/ServerManager/Disable-ServerManagerStandardUserRemoting.md index df94e867b7..6e0dda0aa1 100644 --- a/docset/winserver2022-ps/ServerManager/Disable-ServerManagerStandardUserRemoting.md +++ b/docset/winserver2022-ps/ServerManager/Disable-ServerManagerStandardUserRemoting.md @@ -50,7 +50,7 @@ Disable-ServerManagerStandardUserRemoting -User JennyL In this example, the administrator disables access to event, performance counter, service status, and role and feature inventory data for a server that is being managed by using either a -local or remote Server Manager console, and for which there is a standard user named JennyL. +local or remote Server Manager console, and for which there is a standard user named `JennyL`. ### Example 2 @@ -146,7 +146,10 @@ Accept wildcard characters: False ### CommonParameters -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). +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). ## INPUTS diff --git a/docset/winserver2022-ps/ServerManager/Enable-ServerManagerStandardUserRemoting.md b/docset/winserver2022-ps/ServerManager/Enable-ServerManagerStandardUserRemoting.md index 7b39cba245..a4d66d22e3 100644 --- a/docset/winserver2022-ps/ServerManager/Enable-ServerManagerStandardUserRemoting.md +++ b/docset/winserver2022-ps/ServerManager/Enable-ServerManagerStandardUserRemoting.md @@ -11,7 +11,10 @@ title: Enable-ServerManagerStandardUserRemoting # Enable-ServerManagerStandardUserRemoting ## SYNOPSIS -Provides one or more standard, non-Administrator users access to event, service, performance counter, and role and feature inventory data for a server that you are managing by using Server Manager. + +Provides one or more standard, non-Administrator users access to event, service, performance +counter, and role and feature inventory data for a server that you are managing by using Server +Manager. ## SYNTAX @@ -20,48 +23,69 @@ Enable-ServerManagerStandardUserRemoting [-User] [-Force] [-WhatIf] [ ``` ## DESCRIPTION -Provides one or more standard, non-Administrator users access to event, service, performance counter, and role and feature inventory data for a server that you are managing, either locally or remotely, by using Server Manager. -The cmdlet must be run locally on the server that you are managing by using Server Manager. -The cmdlet works by performing the following actions: -- Adds access rights for specified standard users to the root\cimv2 namespace on the local server (for access to role and feature inventory information). +Provides one or more standard, non-Administrator users access to event, service, performance +counter, and role and feature inventory data for a server that you are managing, either locally or +remotely, by using Server Manager. The cmdlet must be run locally on the server that you are +managing by using Server Manager. The cmdlet works by performing the following actions: + +- Adds access rights for specified standard users to the root\cimv2 namespace on the local server + (for access to role and feature inventory information). -- Adds specified standard users to required user groups (Remote Management Users, Event Log Readers, and Performance Log Readers) that allow remote access to event and performance counter logs on the managed server. +- Adds specified standard users to required user groups (Remote Management Users, Event Log Readers, + and Performance Log Readers) that allow remote access to event and performance counter logs on the + managed server. -- Changes access rights in the Service Control Manager to allow specified standard users remote access to the status of services on the managed server. +- Changes access rights in the Service Control Manager to allow specified standard users remote + access to the status of services on the managed server. -This cmdlet does not provide standard users access to bpa (BPA) results, or allow standard users to run BPA scans. -Aside from the preceding list of changes, this cmdlet provides no additional access that a standard user does not already have, by default, on managed servers. +This cmdlet does not provide standard users access to bpa (BPA) results, or allow standard users to +run BPA scans. Aside from the preceding list of changes, this cmdlet provides no additional access +that a standard user does not already have, by default, on managed servers. -Running this cmdlet has security implications for your network environment because it grants specified non-Administrator users access rights to information that, by default, is restricted to members of the Administrators group on the local computer. -The cmdlet provides access to other WMI providers in the root\cimv2 namespace, but only those providers that can be used by standard users. -We recommend that you run this cmdlet only when you must add a specific standard user to the users who require access to remote server data by using Server Manager. -Additionally, you should promptly run `Disable-ServerManagerStandardUserRemoting` to deny this access to users as soon as they no longer require it. +Running this cmdlet has security implications for your network environment because it grants +specified non-Administrator users access rights to information that, by default, is restricted to +members of the Administrators group on the local computer. The cmdlet provides access to other WMI +providers in the root\cimv2 namespace, but only those providers that can be used by standard users. +We recommend that you run this cmdlet only when you must add a specific standard user to the users +who require access to remote server data by using Server Manager. Additionally, you should promptly +run `Disable-ServerManagerStandardUserRemoting` to deny this access to users as soon as they no +longer require it. ## EXAMPLES ### Example 1 + ```powershell Enable-ServerManagerStandardUserRemoting -User JennyL ``` -In the following example, the administrator gives a standard user named JennyL access to event, performance counter, service status, and role and feature inventory data on a server that is being managed, either locally or remotely, by using Server Manager. +In this example, the administrator gives a standard user named `JennyL` access to event, performance +counter, service status, and role and feature inventory data on a server that is being managed, +either locally or remotely, by using Server Manager. ### Example 2 + ```powershell Enable-ServerManagerStandardUserRemoting -User JennyL -WhatIf ``` -In the following example, the administrator views the outcome of running a command to give a standard user named JennyL access to event, performance counter, service status, and role and feature inventory data on a server that is being managed, either locally or remotely, by using Server Manager. -The `WhatIf` parameter is added, meaning that the command actions are not carried out. +In the following example, the administrator views the outcome of running a command to give a +standard user named JennyL access to event, performance counter, service status, and role and +feature inventory data on a server that is being managed, either locally or remotely, by using +Server Manager. The `WhatIf` parameter is added, meaning that the command actions are not carried +out. ### Example 3 + ```powershell Enable-ServerManagerStandardUserRemoting -User JennyL -Confirm ``` -In the following example, the administrator gives a standard user named JennyL access to event, performance counter, service status, and role and feature inventory data on a server that is being managed, either locally or remotely, by using Server Manager. -The `Confirm` parameter is added, meaning that the command prompts for confirmation before performing the action. +In the following example, the administrator gives a standard user named `JennyL` access to event, +performance counter, service status, and role and feature inventory data on a server that is being +managed, either locally or remotely, by using Server Manager. The `Confirm` parameter is added, +meaning that the command prompts for confirmation before performing the action. ## PARAMETERS @@ -82,7 +106,10 @@ Accept wildcard characters: False ``` ### -User -Specifies the user account name of a standard user who runs Server Manager, and requires access to event, performance counter, service, and role and feature inventory data for remote servers that are managed by using the local Server Manager console. + +Specifies the user account name of a standard user who runs Server Manager, and requires access to +event, performance counter, service, and role and feature inventory data for remote servers that are +managed by using the local Server Manager console. ```yaml Type: String[] @@ -97,6 +124,7 @@ Accept wildcard characters: False ``` ### -Confirm + Prompts you for confirmation before running the cmdlet. ```yaml @@ -111,7 +139,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` ### -WhatIf -Shows what would happen if the cmdlet runs. + +Shows what would happen if the cmdlet were run. The cmdlet is not run. ```yaml @@ -127,11 +156,16 @@ Accept wildcard characters: False ``` ### CommonParameters -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). + +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). ## INPUTS ### None + ## OUTPUTS ### System.Object @@ -147,4 +181,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Uninstall-WindowsFeature](./Uninstall-WindowsFeature.md) [Disable-ServerManagerStandardUserRemoting](./Disable-ServerManagerStandardUserRemoting.md) - diff --git a/docset/winserver2022-ps/ServerManager/Get-WindowsFeature.md b/docset/winserver2022-ps/ServerManager/Get-WindowsFeature.md index 2cde727771..c1cbcb28ba 100644 --- a/docset/winserver2022-ps/ServerManager/Get-WindowsFeature.md +++ b/docset/winserver2022-ps/ServerManager/Get-WindowsFeature.md @@ -11,7 +11,9 @@ title: Get-WindowsFeature # Get-WindowsFeature ## SYNOPSIS -Gets information about Windows Server roles, role services, and features that are available for installation and installed on a specified server. + +Gets information about Windows Server roles, role services, and features that are available for +installation and installed on a specified server. ## SYNTAX @@ -21,57 +23,73 @@ Get-WindowsFeature [[-Name] ] [-Vhd ] [-ComputerName ] ``` ## DESCRIPTION -The `Get-WindowsFeature` cmdlet gets information about features that are both available for installation and already installed on a computer that is running Windows Server or an offline virtual hard disk (VHD) that is running Windows Server. + +The `Get-WindowsFeature` cmdlet gets information about features that are both available for +installation and already installed on a computer that is running Windows Server, or an offline +virtual hard disk (VHD) that is running Windows Server. ## EXAMPLES ### Example 1 + ```powershell Get-WindowsFeature -ComputerName Server1 -Credential contoso.com\user1 ``` -This example gets a list of features that is available and installed on the target computer named Server1. -The credentials for user user1 in the Contoso.com domain, a user who has Administrator rights on Server1, are provided. +This example gets a list of features that are available and installed on the target computer named `Server1`. +The credentials for user `user1` in the Contoso.com domain, a user who has Administrator rights on `Server1`, are provided. ### Example 2 + ```powershell Get-WindowsFeature -Vhd D:\ps-test\vhd1.vhd ``` -This example returns a list of features that is available and installed on the specified offline VHD located at D:\ps-test\vhd1.vhd. +This example returns a list of features that are available and installed on the specified offline +VHD located at `D:\ps-test\vhd1.vhd`. ### Example 3 + ```powershell Get-WindowsFeature -Name AD*, Web* ``` -This example returns a list of available and installed features that have a command ID starting with AD or Web. +This example returns a list of available and installed features that have a command ID starting with +`AD` or `Web`. ### Example 4 + ```powershell Get-WindowsFeature -ComputerName Server01 | Where Installed ``` -This example returns a list of features installed on a specified server, Server01. +This example returns a list of features installed on a specified server, `Server01`. ### Example 5 + ```powershell Get-WindowsFeature -ComputerName Server01 | Where InstallState -Eq Removed ``` -This example returns a list of features on a specified server, Server01, that have installation files removed from the local side-by-side store, and require an external file source for installation. +This example returns a list of features on a specified server, `Server01`, that have installation +files removed from the local side-by-side store and require an external file source for +installation. ## PARAMETERS ### -ComputerName -Gets the list of available features from the specified remote computer that is running Windows Server. -The parameter accepts only one computer name. -If this parameter is not added, or no computer name is specified, the default target is the local computer. -Valid values for the parameter include a NetBIOS name, an IP address, or a fully qualified domain name of a remote computer. -To use a remote computer's IP address as the value of this parameter, your command must include the `Credential` parameter. -The computer must either be configured for HTTPS transport, or the IP address of the remote computer must be included in the WinRM TrustedHosts list on the local computer. -For information about adding a computer name to the WinRM TrustedHosts list, see "How to Add a Computer to the Trusted Host List" in [about_Remote_Troubleshooting](https://go.microsoft.com/fwlink/p/?LinkID=135188). +Gets the list of available features from the specified remote computer that is running Windows +Server. The parameter accepts only one computer name. If this parameter is not added, or no computer +name is specified, the default target is the local computer. Valid values for the parameter include +a NetBIOS name, an IP address, or a fully qualified domain name of a remote computer. + +To use a remote computer's IP address as the value of this parameter, your command must include the +**Credential** parameter. The computer must either be configured for HTTPS transport, or the IP +address of the remote computer must be included in the WinRM TrustedHosts list on the local +computer. For information about adding a computer name to the WinRM TrustedHosts list, see "How to +Add a Computer to the Trusted Host List" in +[about_Remote_Troubleshooting](https://go.microsoft.com/fwlink/p/?LinkID=135188). ```yaml Type: String @@ -86,10 +104,10 @@ Accept wildcard characters: False ``` ### -Credential -Specifies a user account that has access rights to perform this action. -If the parameter is not added, or no value is specified, the default value of this parameter is the current user. -Enter a user name in one of the following formats. -Quotation marks are optional. + +Specifies a user account that has access rights to perform this action. If the parameter is not +added, or no value is specified, the default value of this parameter is the current user. Enter a +user name in one of the following formats. Quotation marks are optional. -- "UserName" -- "Domain\User" @@ -111,6 +129,7 @@ Accept wildcard characters: False ``` ### -LogPath + Specifies a name and path to a log file. Add this parameter if the results of this cmdlet must be stored in a log. @@ -127,6 +146,7 @@ Accept wildcard characters: False ``` ### -Name + Specifies the command IDs of roles, role services, or features about which to return information. ```yaml @@ -142,19 +162,22 @@ Accept wildcard characters: False ``` ### -Vhd -Specifies the path to an offline VHD. -The path can either point to a VHD file, or to a location on which the VHD is already mounted by using Deployment Image Servicing and Management (DISM) tools. -The VHD can be on a local disk on the target computer, or on a network shared folder. -If the VHD is in a network shared folder, then the value of this parameter is a UNC path to the VHD. -In this case, the computer account of the computer that you are using to mount the VHD must have read and write permissions (Read/Write permissions in the File Sharing dialog box, or Full Control on the Security tab of the folder Properties dialog box) on the shared folder, or the VHD will not be accessible. -Local loopback UNC paths are not supported. -Use either of the following formats for the computer account: DOMAIN\SERVERNAME$ or SERVERNAME$. +Specifies the path to an offline VHD. The path can either point to a VHD file, or to a location on +which the VHD is already mounted by using Deployment Image Servicing and Management (DISM) tools. -Add the `ComputerName` parameter to specify the target computer you want to use to mount the VHD. -If the `ComputerName` parameter is not specified, then the local computer is used. -The computer that you are using to mount the VHD must be running Windows Server. -Any local path, such as D:\myFolder, that is specified by using this parameter is always relative to the target computer. +The VHD can be on a local disk on the target computer or on a network shared folder. If the VHD is +in a network shared folder, then the value of this parameter is a UNC path to the VHD. In this case, +the computer account of the computer that you are using to mount the VHD must have read and write +permissions (Read/Write permissions in the File Sharing dialog box or Full Control on the Security +tab of the folder Properties dialog box) on the shared folder or the VHD will not be accessible. +Local loopback UNC paths are not supported. Use either of the following formats for the computer +account: DOMAIN\SERVERNAME$ or SERVERNAME$. + +Add the **ComputerName** parameter to specify the target computer you want to use to mount the VHD. +If the **ComputerName** parameter is not specified, then the local computer is used. The computer +that you are using to mount the VHD must be running Windows Server. Any local path, such as +`D:\myFolder`, that is specified by using this parameter is always relative to the target computer. ```yaml Type: String @@ -169,7 +192,11 @@ Accept wildcard characters: False ``` ### CommonParameters -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). + +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). ## INPUTS @@ -190,4 +217,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Enable-ServerManagerStandardUserRemoting](./Enable-ServerManagerStandardUserRemoting.md) [Disable-ServerManagerStandardUserRemoting](./Disable-ServerManagerStandardUserRemoting.md) - diff --git a/docset/winserver2022-ps/ServerManager/Install-WindowsFeature.md b/docset/winserver2022-ps/ServerManager/Install-WindowsFeature.md index 261f9bffb8..68a5e2a1a5 100644 --- a/docset/winserver2022-ps/ServerManager/Install-WindowsFeature.md +++ b/docset/winserver2022-ps/ServerManager/Install-WindowsFeature.md @@ -11,11 +11,14 @@ title: Install-WindowsFeature # Install-WindowsFeature ## SYNOPSIS -Installs one or more roles, role services, or features on either the local or a specified remote server that is running Windows Server. + +Installs one or more roles, role services, or features on either the local or a specified remote +server that is running Windows Server. ## SYNTAX ### ComponentNamesAndRunningComputer (Default) + ``` Install-WindowsFeature [-Name] [-Restart] [-IncludeAllSubFeature] [-IncludeManagementTools] [-Source ] [-ComputerName ] [-Credential ] [-LogPath ] [-WhatIf] @@ -23,6 +26,7 @@ Install-WindowsFeature [-Name] [-Restart] [-IncludeAllSubFeature] [- ``` ### ComponentNamesAndVhdPath + ``` Install-WindowsFeature [-Name] -Vhd [-IncludeAllSubFeature] [-IncludeManagementTools] [-Source ] [-ComputerName ] [-Credential ] [-LogPath ] [-WhatIf] @@ -30,6 +34,7 @@ Install-WindowsFeature [-Name] -Vhd [-IncludeAllSubFeature] ``` ### ConfigurationFile + ``` Install-WindowsFeature -ConfigurationFilePath [-Vhd ] [-Restart] [-Source ] [-ComputerName ] [-Credential ] [-LogPath ] [-WhatIf] [-Confirm] @@ -37,76 +42,101 @@ Install-WindowsFeature -ConfigurationFilePath [-Vhd ] [-Restart ``` ## DESCRIPTION -The `Install-WindowsFeature` cmdlet installs the specified features on a computer that is running Windows Server, or on an offline virtual hard disk (VHD) on which Windows Server is installed. -This cmdlet works similarly to the installation of roles and features in Server Manager, with an important exception: the cmdlet does not install management tools for the features by default. -To install management tools such as snap-ins on a target server, you must add the `IncludeManagementTools` parameter to your command. -This cmdlet requires elevation; you must be running a Windows PowerShell session as an administrator to use this cmdlet. +The `Install-WindowsFeature` cmdlet installs the specified features on a computer that is running +Windows Server, or on an offline virtual hard disk (VHD) on which Windows Server is installed. This +cmdlet works similarly to the installation of roles and features in Server Manager, with an +important exception: the cmdlet does not install management tools for the features by default. To +install management tools such as snap-ins on a target server, you must add the +`IncludeManagementTools` parameter to your command. + +This cmdlet requires elevation; you must be running a Windows PowerShell session as an administrator +to use this cmdlet. ## EXAMPLES ### Example 1 + ```powershell Install-WindowsFeature -Name Web-Server -IncludeAllSubFeature -ComputerName Server1 -WhatIf ``` -This example shows what is installed with Web Server (IIS), including all role services, on a computer named Server1. -By adding the `WhatIf` parameter, you can view the results of the installation command without running it. +This example shows what is installed with Web Server (IIS), including all role services, on a +computer named `Server1`. By adding the **WhatIf** parameter, you can view the results of the +installation command without running it. ### Example 2 + ```powershell Install-WindowsFeature -Name Web-Server -IncludeAllSubFeature -IncludeManagementTools -ComputerName Server1 -Credential contoso.com\johnj99 ``` -This example installs Web Server (IIS), including all role services and applicable management tools, on a computer named Server1, by using the credentials of a user account named contoso.com\johnj99. +This example installs Web Server (IIS), including all role services and applicable management tools, +on a computer named `Server1`, by using the credentials of a user account named `contoso.com\johnj99`. ### Example 3 + ```powershell Install-WindowsFeature -ConfigurationFilePath d:\ConfigurationFiles\ADCSConfigFile.xml ``` -This example installs all roles, role services and features that are specified in a configuration file named ADCSConfigFile.xml. -The configuration file was created by clicking Export configuration settings on the Confirm installation selections page of the Add Roles and Features Wizard in Server Manager. +This example installs all roles, role services and features that are specified in a configuration +file named `ADCSConfigFile.xml`. The configuration file was created by clicking Export configuration +settings on the Confirm installation selections page of the Add Roles and Features Wizard in Server +Manager. ### Example 4 + ```powershell -PS> $servers = ('server1', 'server2') -PS> foreach ($server in $servers) {Install-WindowsFeature -ConfigurationFilePath D:\ConfigurationFiles\ADCSConfigFile.xml -ComputerName $server} +$servers = ('server1', 'server2') +foreach ($server in $servers) {Install-WindowsFeature -ConfigurationFilePath D:\ConfigurationFiles\ADCSConfigFile.xml -ComputerName $server} ``` -This example installs Active Directory Certificate Services (AD CS) as specified in a configuration file named ADCSConfigFile.xml. -AD CS is installed on a list of computers that is contained in the variable $servers. -The configuration file was created by clicking Export configuration settings on the Confirm installation selections page of the Add Roles and Feature Wizard in Server Manager. -On the first line, the value of the $servers variable is set; on the second line, the installation instructions in the ADCSConfigFile.xml configuration file are applied to each of the servers that has been named in $servers. +This example installs Active Directory Certificate Services (AD CS) as specified in a configuration +file named `ADCSConfigFile.xml`. AD CS is installed on a list of computers that is contained in the +variable `$servers`. The configuration file was created by clicking Export configuration settings on +the Confirm installation selections page of the Add Roles and Feature Wizard in Server Manager. On +the first line, the value of the `$servers` variable is set; on the second line, the installation +instructions in the ADCSConfigFile.xml configuration file are applied to each of the servers that +has been named in `$servers`. ### Example 5 + ```powershell Get-WindowsFeature -Name Web-* | Install-WindowsFeature ``` -This example retrieves a list of all Windows features beginning with the characters Web, and then pipes the resulting list to `Install-WindowsFeature`. -The result of this cmdlet is all features that start with Web are installed on the local computer. +This example retrieves a list of all Windows features beginning with the characters `Web`, and then +pipes the resulting list to `Install-WindowsFeature`. The result of this cmdlet is all features that +start with `Web` are installed on the local computer. ### Example 6 + ```powershell Install-WindowsFeature -Name Web-Server -Source \\server2\winsxs ``` -This example installs Web Server (IIS) on the local computer, specifying that the source of feature files for the installation is a folder, winsxs, on a computer named Server2. -The computer account of the local computer must have Read permissions on the specified share. +This example installs Web Server (IIS) on the local computer, specifying that the source of feature +files for the installation is a folder, `winsxs`, on a computer named `Server2`. The computer +account of the local computer must have Read permissions on the specified share. ## PARAMETERS ### -ComputerName -Installs one or more available features on a specified remote computer. -This parameter accepts only one computer name. -If this parameter is not added, or no computer name is specified, the default target is the local computer. -Valid values for the parameter include a NetBIOS name, an IP address, or a fully qualified domain name of a remote computer that is running Windows Server +Installs one or more available features on a specified remote computer. This parameter accepts only +one computer name. If this parameter is not added, or no computer name is specified, the default +target is the local computer. + +Valid values for the parameter include a NetBIOS name, an IP address, or a fully qualified domain +name of a remote computer that is running Windows Server -To use an IP address of a remote computer as the value of this parameter, your command must include the `Credential` parameter. -The computer must either be configured for HTTPS transport, or the IP address of the remote computer must be included in the WinRM TrustedHosts list on the local computer. -For information about adding a computer name to the WinRM TrustedHosts list, see "How to Add a Computer to the Trusted Host List" in [about_Remote_Troubleshooting](https://go.microsoft.com/fwlink/p/?LinkID=135188). +To use an IP address of a remote computer as the value of this parameter, your command must include +the **Credential** parameter. The computer must either be configured for HTTPS transport, or the IP +address of the remote computer must be included in the WinRM TrustedHosts list on the local +computer. For information about adding a computer name to the WinRM TrustedHosts list, see "How to +Add a Computer to the Trusted Host List" in +[about_Remote_Troubleshooting](https://go.microsoft.com/fwlink/p/?LinkID=135188). ```yaml Type: String @@ -121,9 +151,12 @@ Accept wildcard characters: False ``` ### -ConfigurationFilePath -Provides a single path to a configuration file which specifies roles and features to be installed, and any configuration parameters needed. -The path can be specified by using a local relative path (such as D:\myfolder) or by using built-in environment variables prefixed with the `$env` tag (such as $env:systemdrive\filename). -A configuration file can be generated by running the Add Roles and Feature Wizard in Server Manager. + +Provides a single path to a configuration file which specifies roles and features to be installed +and any configuration parameters needed. The path can be specified by using a local relative path +(such as `D:\myfolder`) or by using built-in environment variables prefixed with the `$env` tag (such +as `$env:systemdrive\filename`). A configuration file can be generated by running the Add Roles and +Feature Wizard in Server Manager. If this parameter is specified, then the Name parameter cannot be used. @@ -140,10 +173,10 @@ Accept wildcard characters: False ``` ### -Credential -Specifies a user account that has access rights to perform this action. -If the parameter is not added, or no value is specified, the default value of this parameter is the current user. -Enter a user name in one of the following formats. -Quotation marks are optional. + +Specifies a user account that has access rights to perform this action. If the parameter is not +added, or no value is specified, the default value of this parameter is the current user. Enter a +user name in one of the following formats. Quotation marks are optional. "UserName" @@ -151,7 +184,8 @@ Quotation marks are optional. "User@Domain.com" -A Credential object returned by the [Get-Credential](https://go.microsoft.com/fwlink/p/?LinkID=113311) cmdlet. +A Credential object returned by the +[Get-Credential](https://go.microsoft.com/fwlink/p/?LinkID=113311) cmdlet. If a user name is entered, then a prompt for a password is displayed. @@ -168,7 +202,9 @@ Accept wildcard characters: False ``` ### -IncludeAllSubFeature -Specifies that all subordinate role services, and all subfeatures of parent roles, role services, or features specified by the `Name` parameter should be installed. + +Specifies that all subordinate role services and all subfeatures of parent roles, role services, or +features specified by the **Name** parameter should be installed. ```yaml Type: SwitchParameter @@ -183,8 +219,9 @@ Accept wildcard characters: False ``` ### -IncludeManagementTools + Specifies that all applicable management tools of the roles, role services, or features specified by -the `Name` parameter should be installed. +the **Name** parameter should be installed. Note: Although management tools are installed by default when you are installing features by using the Add Roles and Feature Wizard, management tools are not installed by default when you install @@ -204,8 +241,9 @@ Accept wildcard characters: False ``` ### -LogPath -Specifies a name and path to a log file. -Add this parameter if the results of your command must be stored in a log. + +Specifies a name and path to a log file. Add this parameter if the results of your command must be +stored in a log. ```yaml Type: String @@ -220,9 +258,9 @@ Accept wildcard characters: False ``` ### -Name -Specifies a list of features to install. -This parameter does not support wildcard characters. -If this parameter is specified, then the **ConfigurationFilePath** parameter cannot be used. + +Specifies a list of features to install. This parameter does not support wildcard characters. If +this parameter is specified, then the **ConfigurationFilePath** parameter cannot be used. ```yaml Type: Feature[] @@ -237,8 +275,10 @@ Accept wildcard characters: False ``` ### -Restart -Specifies that the target computer is restarted automatically, if a restart is required by the installation process for the specified roles or features. -This parameter cannot be used with the `Vhd` parameter. + +Specifies that the target computer is restarted automatically if a restart is required by the +installation process for the specified roles or features. This parameter cannot be used with the +**Vhd** parameter. ```yaml Type: SwitchParameter @@ -253,25 +293,34 @@ Accept wildcard characters: False ``` ### -Source -Specifies the path to feature files, if the files are not available in the local feature store of the target computer or VHD. -Valid values for this parameter are either a network path or the path to a Windows image file (WIM). -If you are installing roles or features on an offline VHD, you must use a mounted WIM. -It is not necessary to mount the WIM file for installing on a running physical computer, because a WIM is mounted internally for deployments to a physical computer. -Specify the path by using a local relative path, or by using built-in environment variables that are prefixed with the `$env` tag as shown in the following examples. -If this parameter is used in combination with the -ComputerName parameter, the source path must be accessible by the target computer (e.g. local devices/drives/paths on the client system will cause the installation to fail). +Specifies the path to feature files if the files are not available in the local feature store of +the target computer or VHD. Valid values for this parameter are either a network path or the path to +a Windows image file (WIM). If you are installing roles or features on an offline VHD, you must use +a mounted WIM. It is not necessary to mount the WIM file for installing on a running physical +computer, because a WIM is mounted internally for deployments to a physical computer. Specify the +path by using a local relative path, or by using built-in environment variables that are prefixed +with the `$env` tag as shown in the following examples. + +If this parameter is used in combination with the **-ComputerName** parameter, the source path must +be accessible by the target computer (e.g. local devices/drives/paths on the client system will +cause the installation to fail). -The path specified in this parameter is only used if the command cannot find feature files in the local side-by-side store of the specified target computer or VHD. -The command searches for feature files in the following order: +The path specified in this parameter is only used if the command cannot find feature files in the +local side-by-side store of the specified target computer or VHD. The command searches for feature +files in the following order: 1) On the target computer or offline VHD. -2) Path specified as the value of this parameter. -If you add a UNC path, verify that the computer account of the target server has Read permissions on the share. -The computer account should be in one of the following formats: DOMAIN\SERVERNAME$ or SERVER$ +2) Path specified as the value of this parameter. If you add a UNC path, verify that the computer +account of the target server has Read permissions on the share. The computer account should be in +one of the following formats: DOMAIN\SERVERNAME$ or SERVER$ -3) Repository path specified by the Group Policy Object (GPO), Specify settings for optional component installation and component repair, located in Computer Configuration/Administrative Templates/System in Local Group Policy Editor. -This Group Policy setting controls the following Windows Registry setting: HKEY_LOCAL_MACHINE\Software\Microsoft\Windows\CurrentVersion\Policies\Servicing\LocalSourcePath. +3) Repository path specified by the Group Policy Object (GPO). Specify settings for optional +component installation and component repair located in Computer Configuration/Administrative +Templates/System in Local Group Policy Editor. This Group Policy setting controls the following +Windows Registry setting: +HKEY_LOCAL_MACHINE\Software\Microsoft\Windows\CurrentVersion\Policies\Servicing\LocalSourcePath. 4) Windows Update. @@ -290,19 +339,22 @@ Accept wildcard characters: False ``` ### -Vhd -Specifies the path to an offline VHD. -The path can either point to a VHD file, or to a location on which the VHD is already mounted by using Deployment Image Servicing and Management (DISM) tools. -The VHD can be on a local disk on the target computer, or on a network shared folder. -If the VHD is in a network shared folder, then the value of this parameter is a UNC path to the VHD. -In this case, the computer account of the computer that you are using to mount the VHD must have read and write permissions (Read/Write permissions in the File Sharing dialog box, or Full Control on the Security tab of the folder Properties dialog box) on the shared folder, or the VHD will not be accessible. -Local loopback UNC paths are not supported. -Use either of the following formats for the computer account: DOMAIN\SERVERNAME$ or SERVERNAME$. +Specifies the path to an offline VHD. The path can either point to a VHD file or to a location on +which the VHD is already mounted by using Deployment Image Servicing and Management (DISM) tools. + +The VHD can be on a local disk on the target computer or on a network shared folder. If the VHD is +in a network shared folder, then the value of this parameter is a UNC path to the VHD. In this case, +the computer account of the computer that you are using to mount the VHD must have read and write +permissions (Read/Write permissions in the File Sharing dialog box or Full Control on the Security +tab of the folder Properties dialog box) on the shared folder or the VHD will not be accessible. +Local loopback UNC paths are not supported. Use either of the following formats for the computer +account: DOMAIN\SERVERNAME$ or SERVERNAME$. -Add the `ComputerName` parameter to specify the target computer you want to use to mount the VHD. -If the `ComputerName` parameter is not specified, then the local computer is used. -The computer that you are using to mount the VHD must be running Windows Server. -Any local path, such as D:\myFolder, that is specified by using this parameter is always relative to the target computer. +Add the **ComputerName** parameter to specify the target computer you want to use to mount the VHD. +If the **ComputerName** parameter is not specified, then the local computer is used. The computer that +you are using to mount the VHD must be running Windows Server. Any local path, such as `D:\myFolder`. +that is specified by using this parameter is always relative to the target computer. ```yaml Type: String @@ -329,6 +381,7 @@ Accept wildcard characters: False ``` ### -Confirm + Prompts you for confirmation before running the cmdlet. ```yaml @@ -344,7 +397,8 @@ Accept wildcard characters: False ``` ### -WhatIf -Shows what would happen if the cmdlet runs. + +Shows what would happen if the cmdlet were run. The cmdlet is not run. ```yaml @@ -360,7 +414,11 @@ Accept wildcard characters: False ``` ### CommonParameters -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). + +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). ## INPUTS diff --git a/docset/winserver2022-ps/ServerManager/ServerManager.md b/docset/winserver2022-ps/ServerManager/ServerManager.md index 25a3063080..35c3b26067 100644 --- a/docset/winserver2022-ps/ServerManager/ServerManager.md +++ b/docset/winserver2022-ps/ServerManager/ServerManager.md @@ -12,21 +12,34 @@ title: ServerManager # ServerManager Module ## Description -This reference provides cmdlet descriptions and syntax for all Server Manager-specific cmdlets. It lists the cmdlets in alphabetical order based on the verb at the beginning of the cmdlet. + +This reference provides cmdlet descriptions and syntax for all Server Manager-specific cmdlets. It +lists the cmdlets in alphabetical order based on the verb at the beginning of the cmdlet. ## ServerManager Cmdlets + ### [Disable-ServerManagerStandardUserRemoting](./Disable-ServerManagerStandardUserRemoting.md) -Disables access for specified standard users to event, service, performance counter, and role and feature inventory data that is collected by Server Manager for a server. + +Disables access for specified standard users to event, service, performance counter, and role and +feature inventory data that is collected by Server Manager for a server. ### [Enable-ServerManagerStandardUserRemoting](./Enable-ServerManagerStandardUserRemoting.md) -Provides one or more standard, non-Administrator users access to event, service, performance counter, and role and feature inventory data for a server that you are managing by using Server Manager. + +Provides one or more standard, non-Administrator, users access to event, service, performance +counter, and role and feature inventory data for a server that you are managing by using Server +Manager. ### [Get-WindowsFeature](./Get-WindowsFeature.md) -Gets information about Windows Server roles, role services, and features that are available for installation and installed on a specified server. + +Gets information about Windows Server roles, role services, and features that are available for +installation and installed on a specified server. ### [Install-WindowsFeature](./Install-WindowsFeature.md) -Installs one or more roles, role services, or features on either the local or a specified remote server that is running Windows Server. + +Installs one or more roles, role services, or features on either the local or a specified remote +server that is running Windows Server. ### [Uninstall-WindowsFeature](./Uninstall-WindowsFeature.md) -Uninstalls specified Windows Server roles, role services, and features from a computer that is running Windows Server. +Uninstalls specified Windows Server roles, role services, and features from a computer that is +running Windows Server. diff --git a/docset/winserver2022-ps/ServerManager/Uninstall-WindowsFeature.md b/docset/winserver2022-ps/ServerManager/Uninstall-WindowsFeature.md index aea16d4696..945e109d70 100644 --- a/docset/winserver2022-ps/ServerManager/Uninstall-WindowsFeature.md +++ b/docset/winserver2022-ps/ServerManager/Uninstall-WindowsFeature.md @@ -11,12 +11,15 @@ title: Uninstall-WindowsFeature # Uninstall-WindowsFeature ## SYNOPSIS -Uninstalls specified Windows Server roles, role services, and features from a computer that is running Windows Server. -By adding the Remove parameter, also deletes feature files, or payload, from a computer. + +Uninstalls specified Windows Server roles, role services, and features from a computer that is +running Windows Server. By adding the Remove parameter, also deletes feature files or payload, from +a computer. ## SYNTAX ### RunningComputer (Default) + ``` Uninstall-WindowsFeature [-Name] [-Restart] [-IncludeManagementTools] [-Remove] [-ComputerName ] [-Credential ] [-LogPath ] [-WhatIf] [-Confirm] @@ -24,6 +27,7 @@ Uninstall-WindowsFeature [-Name] [-Restart] [-IncludeManagementTools ``` ### VhdPath + ``` Uninstall-WindowsFeature [-Name] [-Vhd ] [-IncludeManagementTools] [-Remove] [-ComputerName ] [-Credential ] [-LogPath ] [-WhatIf] [-Confirm] @@ -31,14 +35,21 @@ Uninstall-WindowsFeature [-Name] [-Vhd ] [-IncludeManagement ``` ## DESCRIPTION -The `Uninstall-WindowsFeature` cmdlet uninstalls and optionally removes specified roles, role services, and features from a computer that is running Windows Server, or from an offline virtual hard disk (VHD) on which Windows Server is installed. -This cmdlet works similarly to the uninstallation of roles and features in Server Manager, with an important exception: by default, management tools are not uninstalled when you run the `Uninstall-WindowsFeature` cmdlet; you must add the `IncludeManagementTools` parameter to uninstall associated management tools. -This cmdlet requires elevation; you must be running a Windows PowerShell session as an administrator to use this cmdlet. +The `Uninstall-WindowsFeature` cmdlet uninstalls and optionally removes specified roles, role +services, and features from a computer that is running Windows Server or from an offline virtual +hard disk (VHD) on which Windows Server is installed. This cmdlet works similarly to the +uninstallation of roles and features in Server Manager with an important exception: by default, +management tools are not uninstalled when you run the `Uninstall-WindowsFeature` cmdlet; you must +add the `IncludeManagementTools` parameter to uninstall associated management tools. + +This cmdlet requires elevation; you must be running a Windows PowerShell session as an administrator +to use this cmdlet. ## EXAMPLES ### Example 1 + ```powershell Get-WindowsFeature | Where-Object -FilterScript { $_.Installed -Eq $TRUE } | Uninstall-WindowsFeature ``` @@ -46,32 +57,40 @@ Get-WindowsFeature | Where-Object -FilterScript { $_.Installed -Eq $TRUE } | Uni This example uninstalls any roles or features that are currently installed on the target server. ### Example 2 + ```powershell Uninstall-WindowsFeature -Name Web-Server -ComputerName Server1 -Credential contoso\user1 ``` -This example removes Web Server (IIS) from Server1, including all role services. -The user account specified to perform the operation is contoso\user1. +This example removes Web Server (IIS) from `Server1`, including all role services. The user account +specified to perform the operation is `contoso\user1`. ### Example 3 + ``` Get-WindowsFeature | Where-Object -FilterScript { $_.Installed -Eq $FALSE } | Uninstall-WindowsFeature -Remove ``` -This example deletes the feature files for any roles or features that currently are not installed on the local server. +This example deletes the feature files for any roles or features that currently are not installed on +the local server. ## PARAMETERS ### -ComputerName + Uninstalls and optionally removes one or more roles or features from a specified remote computer. -This parameter accepts only one computer name. -If this parameter is not added, or no computer name is specified, the default target is the local computer. +This parameter accepts only one computer name. If this parameter is not added or no computer name +is specified, the default target is the local computer. -Valid values for the parameter include a NetBIOS name, an IP address, or a fully qualified domain name of a remote computer that is running Windows Server. +Valid values for the parameter include a NetBIOS name, an IP address, or a fully qualified domain +name of a remote computer that is running Windows Server. -To use an IP address of a remote computer as the value of this parameter, your command must include the `Credential` parameter. -The computer must either be configured for HTTPS transport, or the IP address of the remote computer must be included in the WinRM TrustedHosts list on the local computer. -For information about adding a computer name to the WinRM TrustedHosts list, see "How to Add a Computer to the Trusted Host List" in [about_Remote_Troubleshooting](https://go.microsoft.com/fwlink/p/?LinkID=135188). +To use an IP address of a remote computer as the value of this parameter, your command must include +the **Credential** parameter. The computer must either be configured for HTTPS transport or the IP +address of the remote computer must be included in the WinRM TrustedHosts list on the local +computer. For information about adding a computer name to the WinRM TrustedHosts list, see "How to +Add a Computer to the Trusted Host List" in +[about_Remote_Troubleshooting](https://go.microsoft.com/fwlink/p/?LinkID=135188). ```yaml Type: String @@ -86,10 +105,10 @@ Accept wildcard characters: False ``` ### -Credential -Specifies a user account that has access rights to perform this action. -If the parameter is not added, or no value is specified, the default value of this parameter is the current user. -Enter a user name in one of the following formats. -Quotation marks are optional. + +Specifies a user account that has access rights to perform this action. If the parameter is not +added or no value is specified, the default value of this parameter is the current user. Enter a +user name in one of the following formats. Quotation marks are optional. -- "UserName" -- "Domain\User" @@ -111,8 +130,11 @@ Accept wildcard characters: False ``` ### -IncludeManagementTools -Specifies the uninstallation of all applicable management tools along with the roles, role services, or features that are specified in the `Name` parameter. -Note that by default, management tools are not uninstalled when you run the `Uninstall-WindowsFeature` cmdlet; you must add this parameter to uninstall associated management tools. + +Specifies the uninstallation of all applicable management tools along with the roles, role services, +or features that are specified in the `Name` parameter. Note that by default, management tools are +not uninstalled when you run the `Uninstall-WindowsFeature` cmdlet; you must add this parameter to +uninstall associated management tools. ```yaml Type: SwitchParameter @@ -127,8 +149,9 @@ Accept wildcard characters: False ``` ### -LogPath -Specifies a name and path to a log file. -Add this parameter if the results of this cmdlet must be stored in a log. + +Specifies a name and path to a log file. Add this parameter if the results of this cmdlet must be +stored in a log. ```yaml Type: String @@ -143,8 +166,8 @@ Accept wildcard characters: False ``` ### -Name -Specifies a list of features to uninstall. -This parameter does not support wildcard characters. + +Specifies a list of features to uninstall. This parameter does not support wildcard characters. ```yaml Type: Feature[] @@ -159,11 +182,14 @@ Accept wildcard characters: False ``` ### -Remove -Deletes feature files for the specified features from the side-by-side store, located at %SystemDrive%:\Windows\WinSxS. -If the feature is not yet uninstalled, the command uninstalls the feature. -When you delete feature files, features that depend upon the files you remove are also deleted. -When you delete feature files for a subfeature, and no other subfeatures for the parent feature are installed, then files for the entire parent role or feature are deleted. +Deletes feature files for the specified features from the side-by-side store, located at +`%SystemDrive%:\Windows\WinSxS`. If the feature is not yet uninstalled, the command uninstalls the +feature. + +When you delete feature files, features that depend upon the files you remove are also deleted. When +you delete feature files for a subfeature, and no other subfeatures for the parent feature are +installed, then files for the entire parent role or feature are deleted. ```yaml Type: SwitchParameter @@ -178,8 +204,10 @@ Accept wildcard characters: False ``` ### -Restart -Specifies that the target computer is restarted automatically, if a restart is required by the uninstallation process for the specified roles or features. -This parameter cannot be used with the `Vhd` parameter. + +Specifies that the target computer is restarted automatically, if a restart is required by the +uninstallation process for the specified roles or features. This parameter cannot be used with the +**Vhd** parameter. ```yaml Type: SwitchParameter @@ -194,19 +222,22 @@ Accept wildcard characters: False ``` ### -Vhd -Specifies the path to an offline VHD. -The path can either point to a VHD file, or to a location on which the VHD is already mounted by using Deployment Image Servicing and Management (DISM) tools. -The VHD can be on a local disk on the target computer, or on a network shared folder. -If the VHD is in a network shared folder, then the value of this parameter is a UNC path to the VHD. -In this case, the computer account of the computer that you are using to mount the VHD must have read and write permissions (Read/Write permissions in the File Sharing dialog box, or Full Control on the Security tab of the folder Properties dialog box) on the shared folder, or the VHD will not be accessible. -Local loopback UNC paths are not supported. -Use either of the following formats for the computer account: DOMAIN\SERVERNAME$ or SERVERNAME$. +Specifies the path to an offline VHD. The path can either point to a VHD file or to a location on +which the VHD is already mounted by using Deployment Image Servicing and Management (DISM) tools. + +The VHD can be on a local disk on the target computer or on a network shared folder. If the VHD is +in a network shared folder, then the value of this parameter is a UNC path to the VHD. In this case, +the computer account of the computer that you are using to mount the VHD must have read and write +permissions (Read/Write permissions in the File Sharing dialog box or Full Control on the Security +tab of the folder Properties dialog box) on the shared folder or the VHD will not be accessible. +Local loopback UNC paths are not supported. Use either of the following formats for the computer +account: DOMAIN\SERVERNAME$ or SERVERNAME$. -Add the `ComputerName` parameter to specify the target computer you want to use to mount the VHD. -If the `ComputerName` parameter is not specified, then the local computer is used. -The computer that you are using to mount the VHD must be running Windows Server. -Any local path, such as D:\myFolder, that is specified by using this parameter is always relative to the target computer. +Add the **ComputerName** parameter to specify the target computer you want to use to mount the VHD. +If the **ComputerName** parameter is not specified, then the local computer is used. The computer +that you are using to mount the VHD must be running Windows Server. Any local path, such as +`D:\myFolder`, that is specified by using this parameter is always relative to the target computer. ```yaml Type: String @@ -221,6 +252,7 @@ Accept wildcard characters: False ``` ### -Confirm + Prompts you for confirmation before running the cmdlet. ```yaml @@ -236,7 +268,8 @@ Accept wildcard characters: False ``` ### -WhatIf -Shows what would happen if the cmdlet runs. + +Shows what would happen if the cmdlet were run. The cmdlet is not run. ```yaml @@ -252,7 +285,11 @@ Accept wildcard characters: False ``` ### CommonParameters -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). + +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). ## INPUTS @@ -273,4 +310,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Enable-ServerManagerStandardUserRemoting](./Enable-ServerManagerStandardUserRemoting.md) [Disable-ServerManagerStandardUserRemoting](./Disable-ServerManagerStandardUserRemoting.md) - From 672034158f9ca9522f0e4629140674a28d9fa7cb Mon Sep 17 00:00:00 2001 From: Robert Biddle Date: Sat, 29 Apr 2023 17:41:03 -0400 Subject: [PATCH 218/650] Spelling dictionary addition --- .vscode/cspell/winmodules/dictionaries/winps.txt | 1 + 1 file changed, 1 insertion(+) diff --git a/.vscode/cspell/winmodules/dictionaries/winps.txt b/.vscode/cspell/winmodules/dictionaries/winps.txt index 24bfe10a49..d664bd7483 100644 --- a/.vscode/cspell/winmodules/dictionaries/winps.txt +++ b/.vscode/cspell/winmodules/dictionaries/winps.txt @@ -1,2 +1,3 @@ ADCS NTDS +RODC From 84282be48cc14010233598e73ab635e055d4a857 Mon Sep 17 00:00:00 2001 From: Robert Biddle Date: Sat, 29 Apr 2023 17:42:04 -0400 Subject: [PATCH 219/650] Style guideline fixes --- .../addsdeployment/ADDSDeployment.md | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) diff --git a/docset/winserver2022-ps/addsdeployment/ADDSDeployment.md b/docset/winserver2022-ps/addsdeployment/ADDSDeployment.md index e24a63062e..188d313afc 100644 --- a/docset/winserver2022-ps/addsdeployment/ADDSDeployment.md +++ b/docset/winserver2022-ps/addsdeployment/ADDSDeployment.md @@ -10,38 +10,49 @@ title: ADDSDeployment --- # ADDSDeployment Module + ## Description + The following contains the names and a brief description of each ADDSDeployment cmdlet. ## ADDSDeployment Cmdlets + ### [Add-ADDSReadOnlyDomainControllerAccount](./Add-ADDSReadOnlyDomainControllerAccount.md) + Creates a RODC account that can be used to install an RODC in Active Directory. ### [Install-ADDSDomain](./Install-ADDSDomain.md) + Installs an Active Directory domain configuration. ### [Install-ADDSDomainController](./Install-ADDSDomainController.md) + Installs a domain controller in Active Directory. ### [Install-ADDSForest](./Install-ADDSForest.md) + Installs an Active Directory forest configuration. ### [Test-ADDSDomainControllerInstallation](./Test-ADDSDomainControllerInstallation.md) + Runs the prerequisites (only) for installing a domain controller in Active Directory. ### [Test-ADDSDomainControllerUninstallation](./Test-ADDSDomainControllerUninstallation.md) + Runs the prerequisites for uninstalling a domain controller in Active Directory. ### [Test-ADDSDomainInstallation](./Test-ADDSDomainInstallation.md) + Runs the prerequisites for installing a new Active Directory domain configuration. ### [Test-ADDSForestInstallation](./Test-ADDSForestInstallation.md) + Runs the prerequisites for installing a new forest in Active Directory. ### [Test-ADDSReadOnlyDomainControllerAccountCreation](./Test-ADDSReadOnlyDomainControllerAccountCreation.md) + Runs the prerequisites for adding a RODC account. ### [Uninstall-ADDSDomainController](./Uninstall-ADDSDomainController.md) -Uninstalls a domain controller in Active Directory. - +Uninstalls a domain controller in Active Directory. From 80b070d2aa4d77f36e2a6d2edc3176d8ac70500c Mon Sep 17 00:00:00 2001 From: Rob Derickson Date: Sun, 30 Apr 2023 20:59:02 -0400 Subject: [PATCH 220/650] Fix formatting for New-SelfSignedCertificate. --- .../pki/New-SelfSignedCertificate.md | 761 +++++++++++------- 1 file changed, 465 insertions(+), 296 deletions(-) diff --git a/docset/winserver2022-ps/pki/New-SelfSignedCertificate.md b/docset/winserver2022-ps/pki/New-SelfSignedCertificate.md index 701e9f0668..d5f3cc4a7f 100644 --- a/docset/winserver2022-ps/pki/New-SelfSignedCertificate.md +++ b/docset/winserver2022-ps/pki/New-SelfSignedCertificate.md @@ -11,6 +11,7 @@ title: New-SelfSignedCertificate # New-SelfSignedCertificate ## SYNOPSIS + Creates a new self-signed certificate for testing purposes. ## SYNTAX @@ -18,132 +19,229 @@ Creates a new self-signed certificate for testing purposes. ``` New-SelfSignedCertificate [-SecurityDescriptor ] [-TextExtension ] [-Extension ] [-HardwareKeyUsage ] - [-KeyUsageProperty ] [-KeyUsage ] [-KeyProtection ] - [-KeyExportPolicy ] [-KeyLength ] [-KeyAlgorithm ] [-SmimeCapabilities] - [-ExistingKey] [-KeyLocation ] [-SignerReader ] [-Reader ] [-SignerPin ] - [-Pin ] [-KeyDescription ] [-KeyFriendlyName ] [-Container ] - [-Provider ] [-CurveExport ] [-KeySpec ] [-Type ] - [-FriendlyName ] [-NotAfter ] [-NotBefore ] [-SerialNumber ] - [-Subject ] [-DnsName ] [-SuppressOid ] [-HashAlgorithm ] - [-AlternateSignatureAlgorithm] [-TestRoot] [-Signer ] [-CloneCert ] + [-KeyUsageProperty ] [-KeyUsage ] + [-KeyProtection ] [-KeyExportPolicy ] + [-KeyLength ] [-KeyAlgorithm ] [-SmimeCapabilities] [-ExistingKey] + [-KeyLocation ] [-SignerReader ] [-Reader ] + [-SignerPin ] [-Pin ] [-KeyDescription ] + [-KeyFriendlyName ] [-Container ] [-Provider ] + [-CurveExport ] [-KeySpec ] [-Type ] + [-FriendlyName ] [-NotAfter ] [-NotBefore ] + [-SerialNumber ] [-Subject ] [-DnsName ] + [-SuppressOid ] [-HashAlgorithm ] [-AlternateSignatureAlgorithm] + [-TestRoot] [-Signer ] [-CloneCert ] [-CertStoreLocation ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION -The **New-SelfSignedCertificate** cmdlet creates a self-signed certificate for testing purposes. -Using the **CloneCert** parameter, a test certificate can be created based on an existing certificate with all settings copied from the original certificate except for the public key. -The cmdlet creates a new key of the same algorithm and length. -Delegation may be required when using this cmdlet with Windows PowerShell remoting and changing user configuration. +The `New-SelfSignedCertificate` cmdlet creates a self-signed certificate for testing purposes. Using +the **CloneCert** parameter, a test certificate can be created based on an existing certificate with +all settings copied from the original certificate except for the public key. The cmdlet creates a +new key of the same algorithm and length. + +Delegation may be required when using this cmdlet with Windows PowerShell remoting and changing user +configuration. ## EXAMPLES ### EXAMPLE 1 -``` -PS C:\> New-SelfSignedCertificate -DnsName "www.fabrikam.com", "www.contoso.com" -CertStoreLocation "cert:\LocalMachine\My" + +```powershell +$params = @{ + DnsName = 'www.fabrikam.com', 'www.contoso.com' + CertStoreLocation = 'Cert:\LocalMachine\My' +} +New-SelfSignedCertificate @params ``` -This example creates a self-signed SSL server certificate in the computer MY store with the subject alternative name set to www.fabrikam.com, www.contoso.com and Subject and Issuer name set to www.fabrikam.com. +This example creates a self-signed SSL server certificate in the computer MY store with the subject +alternative names `www.fabrikam.com` and `www.contoso.com` and the Subject and Issuer name set to +`www.fabrikam.com`. ### EXAMPLE 2 -``` -PS C:\> Set-Location -Path "cert:\LocalMachine\My" + +```powershell +Set-Location -Path 'Cert:\LocalMachine\My' PS Cert:\LocalMachine\My> $OldCert = (Get-ChildItem -Path E42DBC3B3F2771990A9B3E35D0C3C422779DACD7) PS Cert:\LocalMachine\My> New-SelfSignedCertificate -CloneCert $OldCert ``` -This example creates a copy of the certificate specified by the **CloneCert** parameter and puts it in the computer MY store. +This example creates a copy of the certificate specified by the **CloneCert** parameter and puts it +in the computer MY store. ### EXAMPLE 3 -``` -PS C:\>New-SelfSignedCertificate -Type Custom -Subject "E=patti.fuller@contoso.com,CN=Patti Fuller" -TextExtension @("2.5.29.37={text}1.3.6.1.5.5.7.3.4","2.5.29.17={text}email=patti.fuller@contoso.com&upn=pattifuller@contoso.com") -KeyAlgorithm RSA -KeyLength 2048 -SmimeCapabilities -CertStoreLocation "Cert:\CurrentUser\My" + +```powershell +$params = @{ + Type = 'Custom' + Subject = 'E=patti.fuller@contoso.com,CN=Patti Fuller' + TextExtension = @( + '2.5.29.37={text}1.3.6.1.5.5.7.3.4', + '2.5.29.17={text}email=patti.fuller@contoso.com&upn=pattifuller@contoso.com' ) + KeyAlgorithm = 'RSA' + KeyLength = 2048 + SmimeCapabilities = $true + CertStoreLocation = 'Cert:\CurrentUser\My' +} +New-SelfSignedCertificate @params ``` -This example creates a self-signed S/MIME certificate in the user MY store. -The certificate uses the default provider, which is the Microsoft Software Key Storage Provider. -The certificate uses an RSA asymmetric key with a key size of 2048 bits. -This certificate has the subject alternative names of patti.fuller@contoso.com as RFC822 and pattifuller@contoso.com as Principal Name. +This example creates a self-signed S/MIME certificate in the user MY store. The certificate uses the +default provider, which is the `Microsoft Software Key Storage Provider`. The certificate uses an +`RSA` asymmetric key with a key size of `2048` bits. This certificate has the subject alternative +names of `patti.fuller@contoso.com` as RFC822 and `pattifuller@contoso.com` as Principal Name. -This command does not specify the **NotAfter** parameter. -Therefore, the certificate expires in one year. +This command does not specify the **NotAfter** parameter. Therefore, the certificate expires in one +year. ### EXAMPLE 4 -``` -PS C:\>New-SelfSignedCertificate -Type Custom -Subject "CN=Patti Fuller,OU=UserAccounts,DC=corp,DC=contoso,DC=com" -TextExtension @("2.5.29.37={text}1.3.6.1.5.5.7.3.2","2.5.29.17={text}upn=pattifuller@contoso.com") -KeyUsage DigitalSignature -KeyAlgorithm RSA -KeyLength 2048 -CertStoreLocation "Cert:\CurrentUser\My" + +```powershell +$params = @{ + Type = 'Custom' + Subject = 'CN=Patti Fuller,OU=UserAccounts,DC=corp,DC=contoso,DC=com' + TextExtension = @( + '2.5.29.37={text}1.3.6.1.5.5.7.3.2', + '2.5.29.17={text}upn=pattifuller@contoso.com' ) + KeyUsage = 'DigitalSignature' + KeyAlgorithm = 'RSA' + KeyLength = 2048 + CertStoreLocation = 'Cert:\CurrentUser\My' +} +New-SelfSignedCertificate @params ``` -This example creates a self-signed client authentication certificate in the user MY store. -The certificate uses the default provider, which is the Microsoft Software Key Storage Provider. -The certificate uses an RSA asymmetric key with a key size of 2048 bits. -The certificate has a subject alternative name of pattifuller@contoso.com. +This example creates a self-signed client authentication certificate in the user MY store. The +certificate uses the default provider, which is the `Microsoft Software Key Storage Provider`. The +certificate uses an `RSA` asymmetric key with a key size of `2048` bits. The certificate has a +subject alternative name of `pattifuller@contoso.com`. The certificate expires in one year. ### EXAMPLE 5 -``` -PS C:\>New-SelfSignedCertificate -Type Custom -Subject "CN=Patti Fuller,OU=UserAccounts,DC=corp,DC=contoso,DC=com" -TextExtension @("2.5.29.37={text}1.3.6.1.5.5.7.3.2","2.5.29.17={text}upn=pattifuller@contoso.com") -KeyUsage DigitalSignature -KeyAlgorithm ECDSA_nistP256 -CurveExport CurveName -CertStoreLocation "Cert:\CurrentUser\My" + +```powershell +$params = @{ + Type = 'Custom' + Subject = 'CN=Patti Fuller,OU=UserAccounts,DC=corp,DC=contoso,DC=com' + TextExtension @( + '2.5.29.37={text}1.3.6.1.5.5.7.3.2', + '2.5.29.17={text}upn=pattifuller@contoso.com' ) + KeyUsage = 'DigitalSignature' + KeyAlgorithm = 'ECDSA_nistP256' + CurveExport = 'CurveName' + CertStoreLocation = 'Cert:\CurrentUser\My' +} +New-SelfSignedCertificate @params ``` -This example creates a self-signed client authentication certificate in the user MY store. -The certificate uses the default provider, which is the Microsoft Software Key Storage Provider. -The certificate uses an elliptic curve asymmetric key and the curve parameters nist256, which creates a 256-bit key. -The subject alternative name is pattifuller@contoso.com. +This example creates a self-signed client authentication certificate in the user MY store. The +certificate uses the default provider, which is the `Microsoft Software Key Storage Provider`. The +certificate uses an elliptic curve asymmetric key and the curve parameters nist256, which creates a +256-bit key. The subject alternative name is `pattifuller@contoso.com`. The certificate expires in one year. ### EXAMPLE 6 -``` -PS C:\>New-SelfSignedCertificate -Type Custom -Provider "Microsoft Platform Crypto Provider" -Subject "CN=Patti Fuller" -TextExtension @("2.5.29.37={text}1.3.6.1.5.5.7.3.2","2.5.29.17={text}upn=pattifuller@contoso.com") -KeyExportPolicy NonExportable -KeyUsage DigitalSignature -KeyAlgorithm RSA -KeyLength 2048 -CertStoreLocation "Cert:\CurrentUser\My" + +```powershell +$params = @{ + Type = 'Custom' + Provider = 'Microsoft Platform Crypto Provider' + Subject = 'CN=Patti Fuller' + TextExtension = @( + '2.5.29.37={text}1.3.6.1.5.5.7.3.2', + '2.5.29.17={text}upn=pattifuller@contoso.com' ) + KeyExportPolicy = 'NonExportable' + KeyUsage = 'DigitalSignature' + KeyAlgorithm = 'RSA' + KeyLength = 2048 + CertStoreLocation = 'Cert:\CurrentUser\My' +} +New-SelfSignedCertificate @params ``` -This example creates a self-signed client authentication certificate in the user MY store. -The certificate uses the Microsoft Platform Crypto Provider. -This provider uses the Trusted Platform Module (TPM) of the device to create the asymmetric key. -The key is an RSA 2048-bit key that cannot be exported. -The subject alternative name is pattifuller@contoso.com. -The certificate expires in one year. +This example creates a self-signed client authentication certificate in the user MY store. The +certificate uses the `Microsoft Platform Crypto Provider`. This provider uses the Trusted Platform +Module (TPM) of the device to create the asymmetric key. The certificate uses an `RSA` asymmetric +key with a key size of `2048` bits. The key is not exportable. The subject alternative name is +`pattifuller@contoso.com`. The certificate expires in one year. ### EXAMPLE 7 -``` -PS C:\>New-SelfSignedCertificate -Type Custom -Container test* -Subject "CN=Patti Fuller" -TextExtension @("2.5.29.37={text}1.3.6.1.5.5.7.3.2","2.5.29.17={text}upn=pattifuller@contoso.com") -KeyUsage DigitalSignature -KeyAlgorithm RSA -KeyLength 2048 -NotAfter (Get-Date).AddMonths(6) + +```powershell +$params = @{ + Type = 'Custom' + Container = 'test*' + Subject = 'CN=Patti Fuller' + TextExtension = @( + '2.5.29.37={text}1.3.6.1.5.5.7.3.2', + '2.5.29.17={text}upn=pattifuller@contoso.com' ) + KeyUsage = 'DigitalSignature' + KeyAlgorithm = 'RSA' + KeyLength = 2048 + NotAfter = (Get-Date).AddMonths(6) +} +New-SelfSignedCertificate @params ``` -This example creates a self-signed client authentication certificate in the user MY store. -The certificate uses the default provider, which is the Microsoft Software Key Storage Provider. -The certificate uses an RSA asymmetric key with a key size of 2048 bits. -The subject alternative name is pattifuller@contoso.com. +This example creates a self-signed client authentication certificate in the user MY store. The +certificate uses the default provider, which is the `Microsoft Software Key Storage Provider`. The +certificate uses an `RSA` asymmetric key with a key size of `2048` bits. The subject alternative +name is `pattifuller@contoso.com`. -This command specifies a value for **NotAfter**. -The certificate expires in six months. +This command specifies a value for **NotAfter**. The certificate expires in six months. ### EXAMPLE 8 -``` -PS C:\>New-SelfSignedCertificate -Type Custom -Subject "E=patti.fuller@contoso.com,CN=Patti Fuller" -TextExtension @("2.5.29.37={text}1.3.6.1.5.5.7.3.4","2.5.29.17={text}email=patti.fuller@contoso.com&email=pattifuller@contoso.com") -KeyAlgorithm RSA -KeyLength 2048 -SmimeCapabilities -CertStoreLocation "Cert:\CurrentUser\My" + +```powershell +$params = @{ + Type = 'Custom' + Subject = 'E=patti.fuller@contoso.com,CN=Patti Fuller' + TextExtension = @( + '2.5.29.37={text}1.3.6.1.5.5.7.3.4', + '2.5.29.17={text}email=patti.fuller@contoso.com&email=pattifuller@contoso.com' ) + KeyAlgorithm = 'RSA' + KeyLength = 2048 + SmimeCapabilities = $true + CertStoreLocation = 'Cert:\CurrentUser\My' +} +New-SelfSignedCertificate @params ``` -This example creates a self-signed S/MIME certificate in the user MY store. -The certificate uses the default provider, which is the Microsoft Software Key Storage Provider. -The certificate uses an RSA asymmetric key with a key size of 2048 bits. -This certificate has the subject alternative names of patti.fuller@contoso.com and pattifuller@contoso.com both as RFC822. +This example creates a self-signed S/MIME certificate in the user MY store. The certificate uses the +default provider, which is the `Microsoft Software Key Storage Provider`. The certificate uses an +`RSA` asymmetric key with a key size of `2048` bits. This certificate has the subject alternative +names of `patti.fuller@contoso.com` and `pattifuller@contoso.com` both as RFC822. -This command does not specify the **NotAfter** parameter. -Therefore, the certificate expires in one year. +This command does not specify the **NotAfter** parameter. Therefore, the certificate expires in one +year. ### EXAMPLE 9 -``` -PS C:\> New-SelfSignedCertificate -Subject "localhost" -TextExtension @("2.5.29.17={text}DNS=localhost&IPAddress=127.0.0.1&IPAddress=::1") + +```powershell +$params = @{ + Subject = 'localhost' + TextExtension = @('2.5.29.17={text}DNS=localhost&IPAddress=127.0.0.1&IPAddress=::1') +} +New-SelfSignedCertificate @params ``` -This example creates a self-signed SSL server certificate with Subject and Issuer name set to `localhost` and with subject alternative name set to IPAddress `127.0.0.1` and `::1` via TextExtension. +This example creates a self-signed SSL server certificate with Subject and Issuer name set to +`localhost` and with subject alternative name set to IPAddress `127.0.0.1` and `::1` via +**TextExtension**. ## PARAMETERS ### -AlternateSignatureAlgorithm -Indicates that this cmdlet uses RSA-PSS (PKCSv2.1) or an elliptic curve cryptography (ECC) equivalent. -If you do not specify this parameter, the cmdlet uses the default, RSA-PSS (PKCSv1.5) or an ECC equivalent. + +Indicates that this cmdlet uses RSA-PSS (PKCSv2.1) or an elliptic curve cryptography (ECC) +equivalent. If you do not specify this parameter, the cmdlet uses the default, RSA-PSS (PKCSv1.5) or +an ECC equivalent. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -155,14 +253,16 @@ Accept wildcard characters: False ``` ### -CertStoreLocation -Specifies the certificate store in which to store the new certificate. -If the current path is Cert:\CurrentUser or Cert:\CurrentUser\My, the default store is Cert:\CurrentUser\My. -If the current path is Cert:\LocalMachine or Cert:\LocalMachine\My, the default store is Cert:\LocalMachine\My. -Otherwise, you must specify Cert:\CurrentUser\My or Cert:\LocalMachine\My for this parameter. -This parameter does not support other certificate stores. + +Specifies the certificate store in which to store the new certificate. If the current path is +`Cert:\CurrentUser` or `Cert:\CurrentUser\My`, the default store is `Cert:\CurrentUser\My`. If the +current path is `Cert:\LocalMachine` or `Cert:\LocalMachine\My`, the default store is +`Cert:\LocalMachine\My`. Otherwise, you must specify `Cert:\CurrentUser\My` or +`Cert:\LocalMachine\My` for this parameter. This parameter does not support other certificate +stores. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -174,13 +274,16 @@ Accept wildcard characters: False ``` ### -CloneCert -Identifies the certificate to copy when creating a new certificate. -The certificate being cloned can be identified by an X509 certificate or the file path in the certificate provider. -When this parameter is used, all fields and extensions of the certificate will be inherited except the public key, a new key of the same algorithm and length will be created, and the **NotAfter** and **NotBefore** fields. -The default validity period will be the same as the certificate to copy, except that the **NotBefore** field will be set to ten minutes in the past. + +Identifies the certificate to copy when creating a new certificate. The certificate being cloned can +be identified by an X509 certificate or the file path in the certificate provider. When this +parameter is used, all fields and extensions of the certificate will be inherited except the +**NotAfter** and **NotBefore** fields and the public key. A new key of the same algorithm and length +will be created. The default validity period will be the same as the certificate to copy, except +that the **NotBefore** field will be set to ten minutes in the past. ```yaml -Type: Certificate +Type: Microsoft.CertificateServices.Commands.Certificate Parameter Sets: (All) Aliases: @@ -192,10 +295,11 @@ Accept wildcard characters: False ``` ### -Confirm + Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf @@ -207,16 +311,17 @@ Accept wildcard characters: False ``` ### -Container + Specifies the name of the container in which this cmdlet stores the key for the new certificate. -When you create a key, a trailing asterisk (*) indicates that the rest of the container name string is a prefix. -An appended GUID string makes the container name unique. +When you create a key, a trailing asterisk (`*`) indicates that the rest of the container name +string is a prefix. An appended GUID string makes the container name unique. When you use an existing key, the container name must identify an existing key. You may also have to specify the provider. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -228,18 +333,20 @@ Accept wildcard characters: False ``` ### -CurveExport -Specifies how the public key parameters for an elliptic curve key are represented in the new certificate. -The acceptable values for this parameter are: -- CurveParameters -- CurveName -- None (default) +Specifies how the public key parameters for an elliptic curve key are represented in the new +certificate. The acceptable values for this parameter are: -The default value, None, indicates that this cmdlet uses the default value from the underlying key storage provider (KSP). -This parameter is not supported with the RSA algorithm or with cryptographic service providers (CSPs). +- `CurveParameters` +- `CurveName` +- `None` + +The default value, `None`, indicates that this cmdlet uses the default value from the underlying key +storage provider (KSP). This parameter is not supported with the RSA algorithm or with cryptographic +service providers (CSPs). ```yaml -Type: CurveParametersExportType +Type: Microsoft.CertificateServices.Commands.CurveParametersExportType Parameter Sets: (All) Aliases: Accepted values: None, CurveParameters, CurveName @@ -252,12 +359,14 @@ Accept wildcard characters: False ``` ### -DnsName -Specifies one or more DNS names to put into the subject alternative name extension of the certificate when a certificate to be copied is not specified via the **CloneCert** parameter. -The first DNS name is also saved as the Subject Name. -If no signing certificate is specified, the first DNS name is also saved as the Issuer Name. + +Specifies one or more DNS names to put into the subject alternative name extension of the +certificate when a certificate to be copied is not specified via the **CloneCert** parameter. The +first DNS name is also saved as the Subject Name. If no signing certificate is specified, the first +DNS name is also saved as the Issuer Name. ```yaml -Type: String[] +Type: System.String[] Parameter Sets: (All) Aliases: @@ -269,16 +378,17 @@ Accept wildcard characters: False ``` ### -ExistingKey -Indicates that this cmdlet uses an existing key. -If you do not specify this parameter, this cmdlet creates a new key. -Creating a certificate from an existing key creates a new key with a new container. -When you use an existing key, specify values for the **Container** parameter, the **Provider** parameter, and the **CertStoreLocation** parameter. -**CertStoreLocation** determines the context. +Indicates that this cmdlet uses an existing key. If you do not specify this parameter, this cmdlet +creates a new key. Creating a certificate from an existing key creates a new key with a new +container. + +When you use an existing key, specify values for the **Container** parameter, the **Provider** +parameter, and the **CertStoreLocation** parameter. **CertStoreLocation** determines the context. The context is user or computer. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -290,10 +400,12 @@ Accept wildcard characters: False ``` ### -Extension -Specifies an array of certificate extensions, as **X509Extension** objects, that this cmdlet includes in the new certificate. + +Specifies an array of certificate extensions, as **X509Extension** objects, that this cmdlet +includes in the new certificate. ```yaml -Type: X509Extension[] +Type: System.Security.Cryptography.X509Certificates.X509Extension[] Parameter Sets: (All) Aliases: @@ -305,10 +417,11 @@ Accept wildcard characters: False ``` ### -FriendlyName + Specifies a friendly name for the new certificate. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -320,21 +433,23 @@ Accept wildcard characters: False ``` ### -HardwareKeyUsage -Specifies how a hardware key associated with the new certificate may be used. -This parameter applies only when you specify the Microsoft Platform Crypto Provider. -The acceptable values for this parameter are: -- None (default) -- SignatureKey -- EncryptionKey -- GenericKey -- StorageKey -- IdentityKey +Specifies how a hardware key associated with the new certificate may be used. This parameter applies +only when you specify the Microsoft Platform Crypto Provider. The acceptable values for this +parameter are: + +- `None` +- `SignatureKey` +- `EncryptionKey` +- `GenericKey` +- `StorageKey` +- `IdentityKey` -The default value, None, indicates that this cmdlet uses the default value from the underlying KSP. +The default value, `None`, indicates that this cmdlet uses the default value from the underlying +KSP. ```yaml -Type: HardwareKeyUsage[] +Type: Microsoft.CertificateServices.Commands.HardwareKeyUsage[] Parameter Sets: (All) Aliases: Accepted values: None, SignatureKey, EncryptionKey, GenericKey, StorageKey, IdentityKey @@ -347,11 +462,12 @@ Accept wildcard characters: False ``` ### -HashAlgorithm -Specifies the name of the hash algorithm to use to sign the new certificate. -The default hash algorithm depends on the provider that stores the private key used to sign the new certificate. + +Specifies the name of the hash algorithm to use to sign the new certificate. The default hash +algorithm depends on the provider that stores the private key used to sign the new certificate. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -363,8 +479,10 @@ Accept wildcard characters: False ``` ### -KeyAlgorithm -Specifies the name of the algorithm that creates the asymmetric keys that are associated with the new certificate. -Available asymmetric key algorithms are RSA and Elliptic Curve Digital Signature Algorithms (ECDSA). + +Specifies the name of the algorithm that creates the asymmetric keys that are associated with the +new certificate. Available asymmetric key algorithms are RSA and Elliptic Curve Digital Signature +Algorithms (ECDSA). The elliptic curve algorithm syntax is the following: @@ -372,10 +490,11 @@ The elliptic curve algorithm syntax is the following: To obtain a value for curvename, use the `certutil -displayEccCurve` command. -Valid curve names contain a value in the **Curve OID** column in the output of the `certutil -displayEccCurve` command. +Valid curve names contain a value in the **Curve OID** column in the output of the +`certutil -displayEccCurve` command. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -387,10 +506,11 @@ Accept wildcard characters: False ``` ### -KeyDescription + Specifies a description for the private key that is associated with the new certificate. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -402,14 +522,16 @@ Accept wildcard characters: False ``` ### -KeyExportPolicy -Specifies the policy that governs the export of the private key that is associated with the certificate. -The default value of ExportableEncrypted is not compatible with KSP and CSPs that do not allow key export. -These include the Microsoft Smart Card Key Storage Provider and the Microsoft Platform Crypto Key Storage Provider. -Specify NonExportable for providers that do not allow key export. +Specifies the policy that governs the export of the private key that is associated with the +certificate. + +The default value of `ExportableEncrypted` is not compatible with KSP and CSPs that do not allow key +export. These include the Microsoft Smart Card Key Storage Provider and the Microsoft Platform +Crypto Key Storage Provider. Specify `NonExportable` for providers that do not allow key export. ```yaml -Type: KeyExportPolicy[] +Type: Microsoft.CertificateServices.Commands.KeyExportPolicy[] Parameter Sets: (All) Aliases: Accepted values: NonExportable, ExportableEncrypted, Exportable @@ -422,10 +544,11 @@ Accept wildcard characters: False ``` ### -KeyFriendlyName + Specifies a friendly name for the private key that is associated with the new certificate. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -437,10 +560,11 @@ Accept wildcard characters: False ``` ### -KeyLength + Specifies the length, in bits, of the key that is associated with the new certificate. ```yaml -Type: Int32 +Type: System.Int32 Parameter Sets: (All) Aliases: @@ -452,11 +576,12 @@ Accept wildcard characters: False ``` ### -KeyLocation -Specifies the file system location where this cmdlet stores the private keys associated with the new certificate. -Specify this parameter only when you specify the Microsoft Platform Crypto Provider. + +Specifies the file system location where this cmdlet stores the private keys associated with the new +certificate. Specify this parameter only when you specify the Microsoft Platform Crypto Provider. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -468,20 +593,22 @@ Accept wildcard characters: False ``` ### -KeyProtection -Specifies the level of protection required to access the private key that is associated with the certificate. -The acceptable values for this parameter are: -- Protect -- ProtectHigh -- ProtectFingerPrint -- None (default) +Specifies the level of protection required to access the private key that is associated with the +certificate. The acceptable values for this parameter are: + +- `Protect` +- `ProtectHigh` +- `ProtectFingerPrint` +- `None` -The default value, None, indicates that this cmdlet uses the default value from the underlying KSP or CSP. -For most KSPs and CSPs, the default means that no user interface is required to create and use the private key. -A user interface is required if the provider always requires a user interface, such as a smart card, or if the default configuration of the provider has been changed. +The default value, `None`, indicates that this cmdlet uses the default value from the underlying KSP +or CSP. For most KSPs and CSPs, the default means that no user interface is required to create and +use the private key. A user interface is required if the provider always requires a user interface, +such as a smart card, or if the default configuration of the provider has been changed. ```yaml -Type: KeyProtection[] +Type: Microsoft.CertificateServices.Commands.KeyProtection[] Parameter Sets: (All) Aliases: Accepted values: None, Protect, ProtectHigh, ProtectFingerPrint @@ -494,20 +621,22 @@ Accept wildcard characters: False ``` ### -KeySpec -Specifies whether the private key associated with the new certificate can be used for signing, encryption, or both. -The acceptable values for this parameter are: -- KeyExchange -- Signature -- None (default) +Specifies whether the private key associated with the new certificate can be used for signing, +encryption, or both. The acceptable values for this parameter are: -The default value, None, indicates that this cmdlet uses the default value from the underlying CSP. +- `KeyExchange` +- `Signature` +- `None` -If the private key is managed by a legacy CSP, the value is KeyExchange or Signature. -If the key is managed by a Cryptography Next Generation (CNG) KSP, the value is None. +The default value, `None`, indicates that this cmdlet uses the default value from the underlying +CSP. + +If the private key is managed by a legacy CSP, the value is `KeyExchange` or `Signature`. If the key +is managed by a Cryptography Next Generation (CNG) KSP, the value is `None`. ```yaml -Type: KeySpec +Type: Microsoft.CertificateServices.Commands.KeySpec Parameter Sets: (All) Aliases: Accepted values: None, KeyExchange, Signature @@ -520,24 +649,26 @@ Accept wildcard characters: False ``` ### -KeyUsage -Specifies the key usages set in the key usage extension of the certificate. -The acceptable values for this parameter are: -- CertSign -- CRLSign -- DataEncipherment -- DecipherOnly -- DigitalSignature -- EncipherOnly -- KeyAgreement -- KeyEncipherment -- None (default) -- NonRepudiation +Specifies the key usages set in the key usage extension of the certificate. The acceptable values +for this parameter are: + +- `CertSign` +- `CRLSign` +- `DataEncipherment` +- `DecipherOnly` +- `DigitalSignature` +- `EncipherOnly` +- `KeyAgreement` +- `KeyEncipherment` +- `None` +- `NonRepudiation` -The value, **None**, indicates that this cmdlet does not include the **KeyUsage** extension in the new certificate. +The value, `None`, indicates that this cmdlet does not include the **KeyUsage** extension in the new +certificate. ```yaml -Type: KeyUsage[] +Type: Microsoft.CertificateServices.Commands.KeyUsage[] Parameter Sets: (All) Aliases: Accepted values: None, EncipherOnly, CRLSign, CertSign, KeyAgreement, DataEncipherment, KeyEncipherment, NonRepudiation, DigitalSignature, DecipherOnly @@ -550,19 +681,21 @@ Accept wildcard characters: False ``` ### -KeyUsageProperty -Specifies the key usages for the key usages property of the private key. -The acceptable values for this parameter are: -- All -- Decrypt -- KeyAgreement -- None (default) -- Sign +Specifies the key usages for the key usages property of the private key. The acceptable values for +this parameter are: -The default value, **None**, indicates that this cmdlet uses the default value from the underlying KSP. +- `All` +- `Decrypt` +- `KeyAgreement` +- `None` +- `Sign` + +The default value, `None`, indicates that this cmdlet uses the default value from the underlying +KSP. ```yaml -Type: KeyUsageProperty[] +Type: Microsoft.CertificateServices.Commands.KeyUsageProperty[] Parameter Sets: (All) Aliases: Accepted values: None, Decrypt, Sign, KeyAgreement, All @@ -575,12 +708,13 @@ Accept wildcard characters: False ``` ### -NotAfter -Specifies the date and time, as a **DateTime** object, that the certificate expires. -To obtain a **DateTime** object, use the Get-Date cmdlet. -The default value for this parameter is one year after the certificate was created. + +Specifies the date and time, as a **DateTime** object, that the certificate expires. To obtain a +**DateTime** object, use the Get-Date cmdlet. The default value for this parameter is one year after +the certificate was created. ```yaml -Type: DateTime +Type: System.DateTime Parameter Sets: (All) Aliases: @@ -592,11 +726,12 @@ Accept wildcard characters: False ``` ### -NotBefore -Specifies the date and time, as a **DateTime** object, when the certificate becomes valid. -The default value for this parameter is 10 minutes before the certificate was created. + +Specifies the date and time, as a **DateTime** object, when the certificate becomes valid. The +default value for this parameter is 10 minutes before the certificate was created. ```yaml -Type: DateTime +Type: System.DateTime Parameter Sets: (All) Aliases: @@ -608,10 +743,12 @@ Accept wildcard characters: False ``` ### -Pin -Specifies the personal identification number (PIN) used to access the private key of the new certificate. + +Specifies the personal identification number (PIN) used to access the private key of the new +certificate. ```yaml -Type: SecureString +Type: System.SecureString Parameter Sets: (All) Aliases: @@ -623,20 +760,22 @@ Accept wildcard characters: False ``` ### -Provider -Specifies the name of the KSP or CSP that this cmdlet uses to create the certificate. See [Cryptographic Providers](/windows/desktop/SecCertEnroll/understanding-cryptographic-providers) for more information. -Some acceptable values include: - -- Microsoft Software Key Storage Provider -- Microsoft Smart Card Key Storage Provider -- Microsoft Platform Crypto Provider -- Microsoft Strong Cryptographic Provider -- Microsoft Enhanced Cryptographic Provider v1.0 -- Microsoft Enhanced RSA and AES Cryptographic Provider -- Microsoft Base Cryptographic Provider v1.0 + +Specifies the name of the KSP or CSP that this cmdlet uses to create the certificate. See +[Cryptographic Providers](/windows/desktop/SecCertEnroll/understanding-cryptographic-providers) for +more information. Some acceptable values include: + +- `Microsoft Software Key Storage Provider` +- `Microsoft Smart Card Key Storage Provider` +- `Microsoft Platform Crypto Provider` +- `Microsoft Strong Cryptographic Provider` +- `Microsoft Enhanced Cryptographic Provider v1.0` +- `Microsoft Enhanced RSA and AES Cryptographic Provider` +- `Microsoft Base Cryptographic Provider v1.0` - The name of a third party KSP or CSP ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -648,10 +787,12 @@ Accept wildcard characters: False ``` ### -Reader -Specifies the name of the smart card reader on which to store the private key for the new certificate. + +Specifies the name of the smart card reader on which to store the private key for the new +certificate. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -663,12 +804,13 @@ Accept wildcard characters: False ``` ### -SecurityDescriptor -Specifies the private key security descriptor as a **FileSecurity** object. -Read access is required to use the private key. -This parameter does not apply to providers that do not support security descriptors on private keys, including the smart card CSP and smart card KSP. + +Specifies the private key security descriptor as a **FileSecurity** object. Read access is required +to use the private key. This parameter does not apply to providers that do not support security +descriptors on private keys, including the smart card CSP and smart card KSP. ```yaml -Type: FileSecurity +Type: System.Security.AccessControl.FileSecurity Parameter Sets: (All) Aliases: @@ -680,11 +822,12 @@ Accept wildcard characters: False ``` ### -SerialNumber -Specifies a serial number, as a hexadecimal string, that is associated with the new certificate. -If you do not specify this parameter, this cmdlet assigns a pseudo-randomly generated 16 byte value. + +Specifies a serial number, as a hexadecimal string, that is associated with the new certificate. If +you do not specify this parameter, this cmdlet assigns a pseudo-randomly generated 16-byte value. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -696,12 +839,13 @@ Accept wildcard characters: False ``` ### -Signer -Specifies a **Certificate** object with which this cmdlet signs the new certificate. -This value must be in the Personal certificate store of the user or device. -This cmdlet must have read access to the private key of the certificate. + +Specifies a **Certificate** object with which this cmdlet signs the new certificate. This value must +be in the Personal certificate store of the user or device. This cmdlet must have read access to the +private key of the certificate. ```yaml -Type: Certificate +Type: Microsoft.CertificateServices.Commands.Certificate Parameter Sets: (All) Aliases: @@ -713,10 +857,12 @@ Accept wildcard characters: False ``` ### -SignerPin -Specifies the PIN that is required to access the private key of the certificate that is used to sign the new certificate. + +Specifies the PIN that is required to access the private key of the certificate that is used to sign +the new certificate. ```yaml -Type: SecureString +Type: System.SecureString Parameter Sets: (All) Aliases: @@ -728,10 +874,11 @@ Accept wildcard characters: False ``` ### -SignerReader + Specifies the name of the smart card reader that is used to sign the new certificate. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -743,10 +890,12 @@ Accept wildcard characters: False ``` ### -SmimeCapabilities -Indicates that the new certificate includes available encryption algorithms to a Secure/Multipurpose Internet Mail Extensions (S/MIME) capabilities extension. + +Indicates that the new certificate includes available encryption algorithms to a Secure/Multipurpose +Internet Mail Extensions (S/MIME) capabilities extension. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -758,13 +907,15 @@ Accept wildcard characters: False ``` ### -Subject -Specifies the string that appears in the subject of the new certificate. -This cmdlet prefixes `CN=` to any value that does not contain an equal sign. -For multiple subject relative distinguished names (also known as RDNs), separate each subject relative distinguished name with a comma (,). -If the value of the relative distinguished name contains commas, separate each subject relative distinguished name with a semicolon (;). + +Specifies the string that appears in the subject of the new certificate. This cmdlet prefixes `CN=` +to any value that does not contain an equal sign. For multiple subject relative distinguished names +(also known as RDNs), separate each subject relative distinguished name with a comma (`,`). If the +value of the relative distinguished name contains commas, separate each subject relative +distinguished name with a semicolon (`;`). ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -776,10 +927,12 @@ Accept wildcard characters: False ``` ### -SuppressOid -Specifies an array of object identifier (also known as OID) strings that identify default extensions to be removed from the new certificate. + +Specifies an array of object identifier (also known as OID) strings that identify default extensions +to be removed from the new certificate. ```yaml -Type: String[] +Type: System.String[] Parameter Sets: (All) Aliases: @@ -791,14 +944,16 @@ Accept wildcard characters: False ``` ### -TestRoot -Indicates that this cmdlet signs the new certificate by using a built-in test certificate. -This cmdlet adds the built-in test certificate to the intermediate certification authority (CA) certificate store of the device. -This parameter is for test purposes only. -The private key of the test root certificate is essentially public. +Indicates that this cmdlet signs the new certificate by using a built-in test certificate. This +cmdlet adds the built-in test certificate to the intermediate certification authority (CA) +certificate store of the device. + +This parameter is for test purposes only. The private key of the test root certificate is +essentially public. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -810,147 +965,153 @@ Accept wildcard characters: False ``` ### -TextExtension -Specifies an array of certificate extensions, as strings, which this cmdlet includes in the new certificate. -Each string must employ one of the following formats: -oid`=`base64String, where oid is the object identifier of the extension and base64String is a value that you provide. -After decoding base64String, the value must be valid Abstract Syntax Notation One (ASN.1). -For more information, see [Abstract Syntax Notation One (ASN.1): Specification of basic notation](http://www.itu.int/ITU-T/studygroups/com17/languages/X.680-0207.pdf). +Specifies an array of certificate extensions, as strings, which this cmdlet includes in the new +certificate. Each string must employ one of the following formats: + +oid`=`base64String, where oid is the object identifier of the extension and base64String is a value +that you provide. After decoding base64String, the value must be valid Abstract Syntax Notation One +(ASN.1). For more information, see +[Abstract Syntax Notation One (ASN.1): Specification of basic notation](http://www.itu.int/ITU-T/studygroups/com17/languages/X.680-0207.pdf). -oid`={hex}`hexidecimalString, where oid is the object identifier of the extension and hexidecimalString is a value that you provide. -After decoding hexidecimalString, the value must be valid ASN.1. +oid`={hex}`hexidecimalString, where oid is the object identifier of the extension and +hexidecimalString is a value that you provide. After decoding hexidecimalString, the value must be +valid ASN.1. -oid`={text}`String, where oid is the object identifier of the extension and String is a value that you provide. -String must contain a textual representation of the extension value in a format specific to each object ID. -When String is processed, it will be encoded into an ASN.1 extension value before being placed into the new certificate as an extension. +oid`={text}`String, where oid is the object identifier of the extension and String is a value that +you provide. String must contain a textual representation of the extension value in a format +specific to each object ID. When String is processed, it will be encoded into an ASN.1 extension +value before being placed into the new certificate as an extension. -To specify that an extension is critical, insert {critical} immediately following `oid=` in any of the previous cases. +To specify that an extension is critical, insert `{critical}` immediately following `oid=` in any of +the previous cases. -The object identifiers of some common extensions are as follows: +The object identifiers of some common extensions are as follows: - Application Policy. -1.3.6.1.4.1.311.21.10 +`1.3.6.1.4.1.311.21.10` - Application Policy Mappings. -1.3.6.1.4.1.311.21.11 +`1.3.6.1.4.1.311.21.11` - Basic Constraints. -2.5.29.19 +`2.5.29.19` - Certificate Policies. -2.5.29.32 +`2.5.29.32` - Enhanced Key Usage. -2.5.29.37 +`2.5.29.37` - Name Constraints. -2.5.29.30 +`2.5.29.30` - Policy Mappings. -2.5.29.33 +`2.5.29.33` - Subject Alternative Name. -2.5.29.17 +`2.5.29.17` Application Policy -1.3.6.1.4.1.311.21.10={text}token=value&token=value… -The tokens have the following possible values: +`1.3.6.1.4.1.311.21.10={text}token=value&token=value…` +The tokens have the following possible values: - Flags. 0xhexidecimalNumber - GUID. -A globally unique ID, such as this example: f7c3ac41-b8ce-4fb4-aa58-3d1dc0e36b39 +A globally unique ID, such as this example: `f7c3ac41-b8ce-4fb4-aa58-3d1dc0e36b39` - Notice. Text notice - OID. -Object identifier in dotted decimal notation, such as this example: 1.2.3.4.5 +Object identifier in dotted decimal notation, such as this example: `1.2.3.4.5` - URL. -The URL of a host, such as this example: http://computer07.contoso.com +The URL of a host, such as this example: `http://computer07.contoso.com` -To specify an Application Policy extension, specify the first object identifier, followed by zero or more other **token=value** entries. -These entries are subordinate to the preceding object identifier. -Specify subsequent object identifiers, each followed by its subordinate **token=value** entries. +To specify an Application Policy extension, specify the first object identifier, followed by zero or +more other **token=value** entries. These entries are subordinate to the preceding object +identifier. Specify subsequent object identifiers, each followed by its subordinate **token=value** +entries. Application Policy Mappings -1.3.6.1.4.1.311.21.11={text}oid=oid&oid=oid… +`1.3.6.1.4.1.311.21.11={text}oid=oid&oid=oid…` Certificate Policies -2.5.29.32={text}token=value&token=value… -The tokens have the following possible values: +`2.5.29.32={text}token=value&token=value…` +The tokens have the following possible values: - Flags. 0xhexidecimalNumber - GUID. -A globally unique ID, such as this example: f7c3ac41-b8ce-4fb4-aa58-3d1dc0e36b39 +A globally unique ID, such as this example: `f7c3ac41-b8ce-4fb4-aa58-3d1dc0e36b39` - Notice. Text notice - OID. -Object ID in dotted decimal notation, such as this example: 1.2.3.4.5 +Object ID in dotted decimal notation, such as this example: `1.2.3.4.5` - URL. -The URL of a host, such as this example: http://computer07.contoso.com +The URL of a host, such as this example: `http://computer07.contoso.com` -To specify a Certificate Policies extension, follow the same syntax as an Application Policy extension. +To specify a Certificate Policies extension, follow the same syntax as an Application Policy +extension. Enhanced Key Usage Object Identifiers -2.5.29.37={text}oid,oid… -These key usages have the following object identifiers: +`2.5.29.37={text}oid,oid…` +These key usages have the following object identifiers: - Client Authentication. -1.3.6.1.5.5.7.3.2 +`1.3.6.1.5.5.7.3.2` - Server Authentication. -1.3.6.1.5.5.7.3.1 +`1.3.6.1.5.5.7.3.1` - Secure Email. -1.3.6.1.5.5.7.3.4 +`1.3.6.1.5.5.7.3.4` - Code Signing. -1.3.6.1.5.5.7.3.3 +`1.3.6.1.5.5.7.3.3` - Timestamp Signing. -1.3.6.1.5.5.7.3.8 +`1.3.6.1.5.5.7.3.8` -Name Constraints -2.5.29.30={text}subtree=subtreeValue&token=value&token=value& …&subtree=subtreeValue&token=value&token=value… -The subtreeValue can have the following values: +Name Constraints `2.5.29.30={text}subtree=subtreeValue&token=value&token=value&` +`…&subtree=subtreeValue&token=value&token=value…` The subtreeValue can have the following values: -- Include. +- `Include`. Permitted names -- Exclude. +- `Exclude`. Excluded names -The tokens have the following possible values: +The tokens have the following possible values: - DirectoryName. -CN=Name,DC=Domain,DC=com +`CN=Name,DC=Domain,DC=com` - DNS. -A computer name in the following format: computer.contoso.com +A computer name in the following format: `computer.contoso.com` - Email. -An email address, such as this example: admin@contoso.com +An email address, such as this example: `admin@contoso.com` - IPAddress. IPV4 address,IPV4 subnet mask or IPV6 address,IPV6 subnet mask - RegisteredID. -ID in dotted decimal notation, such as this example: 1.2.3.4.5 +ID in dotted decimal notation, such as this example: `1.2.3.4.5` - UPN. -A user principal name in the following format: admin@contoso.com +A user principal name in the following format: `admin@contoso.com` - URL. -The URL of a host, such as this example: http://computer07.contoso.com/index.html +The URL of a host, such as this example: `http://computer07.contoso.com/index.html` Policy Mapping -2.5.29.33={text}oid=oid&oid=oid… +`2.5.29.33={text}oid=oid&oid=oid…` Subject Alternative Name Syntax -2.5.29.17={text}token=value&token=value… -The tokens have the following possible values: +`2.5.29.17={text}token=value&token=value…` +The tokens have the following possible values: - UPN. -A user principal name in the following format: admin@contoso.com +A user principal name in the following format: `admin@contoso.com` - Email. -An email address, such as this example: admin@contoso.com +An email address, such as this example: `admin@contoso.com` - DNS. -A computer name in the following format: computer.contoso.com +A computer name in the following format: `computer.contoso.com` - DirectoryName. -CN=Name,DC=Domain,DC=com +`CN=Name,DC=Domain,DC=com` - URL. -The URL of a host, such as this example: http://computer07.contoso.com/index.html +The URL of a host, such as this example: `http://computer07.contoso.com/index.html` - IPAddress. An IP address - RegisteredID. -ID in dotted decimal notation, such as this example: 1.2.3.4.5 +ID in dotted decimal notation, such as this example: `1.2.3.4.5` - GUID. -A globally unique ID, such as this example: f7c3ac41-b8ce-4fb4-aa58-3d1dc0e36b39 +A globally unique ID, such as this example: `f7c3ac41-b8ce-4fb4-aa58-3d1dc0e36b39` ```yaml -Type: String[] +Type: System.String[] Parameter Sets: (All) Aliases: @@ -962,10 +1123,11 @@ Accept wildcard characters: False ``` ### -Type + Specifies the type of certificate that this cmdlet creates. ```yaml -Type: CertificateType +Type: Microsoft.CertificateServices.Commands.CertificateType Parameter Sets: (All) Aliases: Accepted values: Custom, CodeSigningCert, DocumentEncryptionCert, SSLServerAuthentication, DocumentEncryptionCertLegacyCsp @@ -978,11 +1140,11 @@ Accept wildcard characters: False ``` ### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. + +Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi @@ -994,16 +1156,23 @@ Accept wildcard characters: False ``` ### CommonParameters -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). + +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). ## INPUTS ### Microsoft.CertificateServices.Commands.Certificate -The **Certificate** object can either be provided as a Path object to a certificate or an **X509Certificate2** object. + +The **Certificate** object can either be provided as a Path object to a certificate or an +**X509Certificate2** object. ## OUTPUTS ### System.Security.Cryptography.X509Certificates.X509Certificate2 + An **X509Certificate2** object for the certificate that has been created. ## NOTES From 0eb523a230a3e4a18555e849ba8598535d332286 Mon Sep 17 00:00:00 2001 From: Phil Bossman Date: Sun, 30 Apr 2023 19:55:33 -0700 Subject: [PATCH 221/650] Sync --- .../grouppolicy/Get-GPInheritance.md | 2 +- .../winserver2022-ps/grouppolicy/Get-GPO.md | 4 +- .../grouppolicy/Get-GPOReport.md | 149 ++++++++++------- .../grouppolicy/Get-GPPermission.md | 37 +++-- .../grouppolicy/Get-GPPrefRegistryValue.md | 25 +-- .../grouppolicy/Get-GPRegistryValue.md | 28 ++-- .../grouppolicy/Get-GPResultantSetOfPolicy.md | 21 +-- .../grouppolicy/Get-GPStarterGPO.md | 29 ++-- .../grouppolicy/Import-GPO.md | 153 +++++++++++------- .../grouppolicy/Invoke-GPUpdate.md | 25 +-- .../grouppolicy/New-GPLink.md | 31 ++-- .../winserver2022-ps/grouppolicy/New-GPO.md | 30 ++-- .../grouppolicy/New-GPStarterGPO.md | 16 +- .../grouppolicy/Remove-GPLink.md | 30 ++-- .../grouppolicy/Remove-GPO.md | 25 +-- .../grouppolicy/Remove-GPPrefRegistryValue.md | 25 +-- .../grouppolicy/Remove-GPRegistryValue.md | 23 +-- .../grouppolicy/Rename-GPO.md | 19 ++- .../grouppolicy/Restore-GPO.md | 39 +++-- .../grouppolicy/Set-GPInheritance.md | 22 +-- .../grouppolicy/Set-GPLink.md | 27 ++-- .../grouppolicy/Set-GPPermission.md | 27 ++-- .../grouppolicy/Set-GPPrefRegistryValue.md | 41 ++--- .../grouppolicy/Set-GPRegistryValue.md | 35 ++-- 24 files changed, 514 insertions(+), 349 deletions(-) diff --git a/docset/winserver2022-ps/grouppolicy/Get-GPInheritance.md b/docset/winserver2022-ps/grouppolicy/Get-GPInheritance.md index d2d2b1413c..20da4a4d34 100644 --- a/docset/winserver2022-ps/grouppolicy/Get-GPInheritance.md +++ b/docset/winserver2022-ps/grouppolicy/Get-GPInheritance.md @@ -250,7 +250,7 @@ by using the **Set-GPInheritance** cmdlet. ## NOTES -* You can use the *Domain* parameter to explicitly specify the domain for this cmdlet. +* You can use the **Domain** parameter to explicitly specify the domain for this cmdlet. If you do not explicitly specify the domain, the cmdlet uses a default domain. The default domain is the domain that is used to access network resources by the security context under which the diff --git a/docset/winserver2022-ps/grouppolicy/Get-GPO.md b/docset/winserver2022-ps/grouppolicy/Get-GPO.md index 8b298a097c..b58e26e7a3 100644 --- a/docset/winserver2022-ps/grouppolicy/Get-GPO.md +++ b/docset/winserver2022-ps/grouppolicy/Get-GPO.md @@ -235,7 +235,7 @@ This cmdlet returns an object that represents the requested GPO. ## NOTES -* You can use the *Domain* parameter to explicitly specify the domain for this cmdlet. +* You can use the **Domain** parameter to explicitly specify the domain for this cmdlet. If you do not explicitly specify the domain, the cmdlet uses a default domain. The default domain is the domain that is used to access network resources by the security context under which the current session is running. @@ -247,7 +247,7 @@ Therefore, when this cmdlet is run from a startup or shutdown script, the defaul Only one domain can be used by an instance of this cmdlet. If you pipe a collection of GPO (Microsoft.GroupPolicy.Gpo) objects to this cmdlet, the DomainName property of the first GPO object in the collection specifies the domain for the cmdlet. -This is because domainname is a built-in alias for the *Domain* parameter, and the *Domain* parameter can take its value by property name from the pipeline. +This is because domainname is a built-in alias for the **Domain** parameter, and the **Domain** parameter can take its value by property name from the pipeline. A non-terminating error occurs for any GPOs in the collection that are not in this domain. If this domain is different from the domain of the user account (for startup or shutdown scripts, the computer account), a trust must exist between the two domains. diff --git a/docset/winserver2022-ps/grouppolicy/Get-GPOReport.md b/docset/winserver2022-ps/grouppolicy/Get-GPOReport.md index 21269fcb82..b82d36521a 100644 --- a/docset/winserver2022-ps/grouppolicy/Get-GPOReport.md +++ b/docset/winserver2022-ps/grouppolicy/Get-GPOReport.md @@ -11,66 +11,81 @@ title: Get-GPOReport # Get-GPOReport ## SYNOPSIS + Generates a report either in XML or HTML format for a specified GPO or for all GPOs in a domain. ## SYNTAX ### ByGUID (Default) + ``` Get-GPOReport [-Guid] [-ReportType] [[-Path] ] [[-Domain] ] [[-Server] ] [] ``` ### ByName + ``` Get-GPOReport [-Name] [-ReportType] [[-Path] ] [[-Domain] ] [[-Server] ] [] ``` ### ReportAll + ``` -Get-GPOReport [-ReportType] [[-Path] ] [[-Domain] ] [[-Server] ] [-All] - [] +Get-GPOReport [-ReportType] [[-Path] ] [[-Domain] ] + [[-Server] ] [-All] [] ``` ## DESCRIPTION -The **Get-GPOReport** cmdlet generates a report in either XML or HTML format that describes properties and policy settings for a specified Group Policy Object (GPO) or for all GPOs in a domain. -The information that is reported for each GPO includes: details, links, security filtering, Windows Management Instrumentation (WMI) filtering, delegation, and computer and user configurations. -You can specify the *All* parameter to generate a report for every GPO in the domain, or you can specify either the *Name* or *Guid* parameter to generate a report for a single GPO. -You can also pipe GPO objects into this cmdlet. -If you specify a file through the *Path* parameter, the report is written to a file; otherwise, it is printed to the display. +The **Get-GPOReport** cmdlet generates a report in either XML or HTML format that describes +properties and policy settings for a specified Group Policy Object (GPO) or for all GPOs in a +domain. The information that is reported for each GPO includes: details, links, security filtering, +Windows Management Instrumentation (WMI) filtering, delegation, and computer and user +configurations. + +You can specify the **All** parameter to generate a report for every GPO in the domain, or you can +specify either the **Name** or **Guid** parameter to generate a report for a single GPO. You can +also pipe GPO objects into this cmdlet. If you specify a file through the **Path** parameter, the +report is written to a file; otherwise, it is printed to the display. ## EXAMPLES ### Example 1: Generate an HTML report for the specified GPO -``` -PS C:\> Get-GPOReport -Name "TestGPO1" -ReportType HTML -Path "C:\GPOReports\GPOReport1.html" + +```powershell +Get-GPOReport -Name "TestGPO1" -ReportType HTML -Path "C:\GPOReports\GPOReport1.html" ``` -This command generates a report in HTML format for the GPO TestGPO1 and writes it to the file C:\GPOReports\GPOReport1.html +This command generates a report in HTML format for the GPO `TestGPO1` and writes it to the file `C:\GPOReports\GPOReport1.html` ### Example 2: Generate an XML report for each GPO in the specified domain -``` -PS C:\> Get-GPOReport -All -Domain "sales.contoso.com" -Server "DC1" -ReportType XML -Path "C:\GPOReports\GPOReportsAll.xml" + +```powershell +Get-GPOReport -All -Domain "sales.contoso.com" -Server "DC1" -ReportType XML -Path "C:\GPOReports\GPOReportsAll.xml" ``` -This command generates a report in XML format for each GPO in the sales.contoso.com domain and writes it to the file C:\GPOReports\GPOReportsAll.xml. -The DC1.sales.contoso.com domain controller is contacted to complete the operation. +This command generates a report in XML format for each GPO in the `sales.contoso.com` domain and +writes it to the file `C:\GPOReports\GPOReportsAll.xml`. The `DC1` domain controller is contacted to +complete the operation. -If the domain of the user account (or, for startup and shutdown scripts, the computer account) is different from sales.contoso2.com, a trust must exist between the two domains. +If the domain of the user account (or, for startup and shutdown scripts, the computer account) is +different from `sales.contoso2.com`, a trust must exist between the two domains. ### Example 3: Generate an XML report for a GPO with the specified GUID -``` -PS C:\> Get-GPOReport -GUID 73624cc9-e8f2-4f05-8802-193fae8773ce -ReportType XML + +```powershell +Get-GPOReport -GUID 73624cc9-e8f2-4f05-8802-193fae8773ce -ReportType XML ``` -This command generates a report in XML format for the GPO with the specified GUID. -Because no *Path* parameter is supplied, the report is written to the display. +This command generates a report in XML format for the GPO with the specified `GUID`. +Because no **Path** parameter is supplied, the report is written to the display. ## PARAMETERS ### -All + Indicates that the cmdlet generates a report for all GPOs in the domain. ```yaml @@ -86,23 +101,26 @@ Accept wildcard characters: False ``` ### -Domain -Specifies the domain for this cmdlet. -You must specify the fully qualified domain name (FQDN) of the domain. + +Specifies the domain for this cmdlet. You must specify the fully qualified domain name (FQDN) of the +domain. For the **Get-GPOReport** cmdlet: - If a single GPO is specified, it must exist in this domain. -- If the *All* parameter is specified, a report is generated for each GPO in this domain. +- If the **All** parameter is specified, a report is generated for each GPO in this domain. -If you do not specify the *Domain* parameter, the domain of the user that is running the current session is used. -If the cmdlet is being run from a computer startup or shutdown script, the domain of the computer is used. -For more information, see the Notes section in the full Help. +If you do not specify the **Domain** parameter, the domain of the user that is running the current +session is used. If the cmdlet is being run from a computer startup or shutdown script, the domain +of the computer is used. For more information, see the Notes section in the full Help. -If you specify a domain that is different from the domain of the user that is running the current session or, (for a startup or shutdown script, the computer), a trust must exist between that domain and the domain of the user or the computer. +If you specify a domain that is different from the domain of the user that is running the current +session or, (for a startup or shutdown script, the computer), a trust must exist between that domain +and the domain of the user or the computer. -You can also refer to Domain by its built-in alias, **DomainName**. -For more information, see [about_Aliases](????????????). +You can also refer to Domain by its built-in alias, **DomainName**. For more information, see +[about_Aliases](????????????). ```yaml Type: System.String @@ -117,11 +135,12 @@ Accept wildcard characters: False ``` ### -Guid -Specifies the GPO for which to generate the report by its globally unique identifier (GUID). -The GUID uniquely identifies the GPO. -You can also refer to the *Guid* parameter by its built-in alias, **Id**. -For more information, see **about_Aliases**. +Specifies the GPO for which to generate the report by its globally unique identifier (GUID). The +GUID uniquely identifies the GPO. + +You can also refer to the **Guid** parameter by its built-in alias, **Id**. +For more information, see [about_Aliases](????????). ```yaml Type: Guid @@ -136,14 +155,15 @@ Accept wildcard characters: False ``` ### -Name + Specifies the GPO for which to generate the report by its display name. -The display name is not guaranteed to be unique in the domain. -If another GPO with the same display name exists in the domain an error occurs. -You can use the *Guid* parameter to uniquely identify a GPO. +The display name is not guaranteed to be unique in the domain. If another GPO with the same display +name exists in the domain an error occurs. You can use the **Guid** parameter to uniquely identify a +GPO. You can also refer to the **Name** parameter by its built-in alias, **DisplayName**. -For more information, see **about_Aliases**. +For more information, see [about_Aliases](????????). ```yaml Type: System.String @@ -158,7 +178,8 @@ Accept wildcard characters: False ``` ### -Path -Specifies the path to the report file; for instance, c:\Reports\GpoReport.xml. + +Specifies the path to the report file; for instance, `c:\Reports\GpoReport.xml`. If no path is specified, the report is printed to the display. ```yaml @@ -174,6 +195,7 @@ Accept wildcard characters: False ``` ### -ReportType + Specifies the format of the report. You must specify either Html (for HTML format) or Xml (for XML format). These values are not case sensitive. @@ -194,13 +216,15 @@ Accept wildcard characters: False ``` ### -Server -Specifies the name of the domain controller that this cmdlet contacts to complete the operation. -You can specify either the fully qualified domain name (FQDN) or the host name. -If you do not specify the name by using the *Server* parameter, the primary domain controller (PDC) emulator is contacted. +Specifies the name of the domain controller that this cmdlet contacts to complete the operation. You +can specify either the fully qualified domain name (FQDN) or the host name. + +If you do not specify the name by using the **Server** parameter, the primary domain controller +(PDC) emulator is contacted. -You can refer to this parameter by its built-in alias, **DC**. -For more information, see **about_Aliases**. +You can refer to this parameter by its built-in alias, **DC**. For more information, see +[about_Aliases](????????). ```yaml Type: System.String @@ -216,36 +240,45 @@ Accept wildcard characters: False ### CommonParameters -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). +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). ## INPUTS ### Microsoft.GroupPolicy.Gpo + An object that represents a GPO. Collections that contain GPOs from different domains are not supported. ## OUTPUTS ### None + This cmdlet does not generate any output. ## NOTES -* You can use the *Domain* parameter to explicitly specify the domain for this cmdlet. - - If you do not explicitly specify the domain, the cmdlet uses a default domain. -The default domain is the domain that is used to access network resources by the security context under which the current session is running. -This domain is typically the domain of the user that is running the session. -For instance, the domain of the user who started the session by opening Windows PowerShell from the Program Files menu, or the domain of a user that is specified in a runas command. -However, computer startup and shutdown scripts run under the context of the LocalSystem account. -The LocalSystem account is a built-in local account, and it accesses network resources under the context of the computer account. -Therefore, when this cmdlet is run from a startup or shutdown script, the default domain is the domain to which the computer is joined. - - Only one domain can be used by an instance of this cmdlet. -If you pipe a collection of GPO (Microsoft.GroupPolicy.Gpo) objects to this cmdlet, the **DomainName** property of the first GPO object in the collection specifies the domain for the cmdlet. -This is because domainname is a built-in alias for the *Domain* parameter, and the *Domain* parameter can take its value by property name from the pipeline. -A non-terminating error occurs for any GPOs in the collection that are not in this domain. -If this domain is different from the domain of the user account, for startup or shutdown scripts, the computer account, a trust must exist between the two domains. +* You can use the **Domain** parameter to explicitly specify the domain for this cmdlet. + + If you do not explicitly specify the domain, the cmdlet uses a default domain. The default domain + is the domain that is used to access network resources by the security context under which the + current session is running. This domain is typically the domain of the user that is running the + session. For instance, the domain of the user who started the session by opening Windows + PowerShell from the Program Files menu, or the domain of a user that is specified in a runas + command. However, computer startup and shutdown scripts run under the context of the LocalSystem + account. The LocalSystem account is a built-in local account, and it accesses network resources + under the context of the computer account. Therefore, when this cmdlet is run from a startup or + shutdown script, the default domain is the domain to which the computer is joined. + + Only one domain can be used by an instance of this cmdlet. If you pipe a collection of GPO + (Microsoft.GroupPolicy.Gpo) objects to this cmdlet, the **DomainName** property of the first GPO + object in the collection specifies the domain for the cmdlet. This is because domainname is a + built-in alias for the **Domain** parameter, and the **Domain** parameter can take its value by + property name from the pipeline. A non-terminating error occurs for any GPOs in the collection + that are not in this domain. If this domain is different from the domain of the user account, for + startup or shutdown scripts, the computer account, a trust must exist between the two domains. ## RELATED LINKS diff --git a/docset/winserver2022-ps/grouppolicy/Get-GPPermission.md b/docset/winserver2022-ps/grouppolicy/Get-GPPermission.md index 994af42cbb..2d04002ead 100644 --- a/docset/winserver2022-ps/grouppolicy/Get-GPPermission.md +++ b/docset/winserver2022-ps/grouppolicy/Get-GPPermission.md @@ -29,16 +29,16 @@ Get-GPPermission [-Name] [-TargetName ] [-TargetType Get-GPPermission -Name "TestGpo" -TargetName "Domain Users" -TargetType Group +```powershell +Get-GPPermission -Name "TestGpo" -TargetName "Domain Users" -TargetType Group Trustee : Domain Users TrusteeType : Group @@ -51,8 +51,8 @@ Inherited : False This command gets the permission level for the Domain Users group on the GPO named TestGpo. ### Example 2: Get the permission level for group on the specified GPO with the specified GUID -``` -PS C:\> Get-GPPermission -Domain "Sales.Contoso.com" -Server "DC1" -GUID fa4a9473-6e2a-4b87-ab78-175e68d97bde -TargetName "Domain Admins" -TargetType Group +```powershell +Get-GPPermission -Domain "Sales.Contoso.com" -Server "DC1" -GUID fa4a9473-6e2a-4b87-ab78-175e68d97bde -TargetName "Domain Admins" -TargetType Group ``` This command gets the permission level for the Domain Admins group on the GPO with the GUID fa4a9473-6e2a-4b78-175e68d97bde in the Sales.Contoso.com domain. @@ -61,8 +61,8 @@ The DC1.sales.contoso.com domain controller is contacted to complete the operati If the domain of the user that is running the session (or, for startup and shutdown scripts, the computer) is different from the sales.contoso.com domain, a trust must exist between the two domains, or the command fails. ### Example 3: Get the permission level for all security principals on the specified GPO -``` -PS C:\> Get-GPPermission -Name "TestGPO" -All +```powershell +Get-GPPermission -Name "TestGPO" -All Trustee : Authenticated Users TrusteeType : WellKnownGroup @@ -93,8 +93,8 @@ Inherited : False This command gets the permission level for each security principal that has permissions on the GPO named TestGPO. ### Example 4: Get the display name of each GPO for a specific permissions -``` -PS C:\> Get-GPO -All | foreach-object { if($_ | Get-GPPermission -TargetName "contoso\Domain Admins" -TargetType Group -ErrorAction SilentlyContinue) {$_.DisplayName}} +```powershell +Get-GPO -All | foreach-object { if($_ | Get-GPPermission -TargetName "contoso\Domain Admins" -TargetType Group -ErrorAction SilentlyContinue) {$_.DisplayName}} Default Domain Policy TestGPO-1 @@ -118,6 +118,7 @@ For more information about the ErrorAction parameter, see about_CommonParameters ## PARAMETERS ### -All + Indicates that the cmdlet gets the permission level for each user, group, or computer that has permissions on the GPO. ```yaml @@ -138,7 +139,7 @@ You must specify the fully qualified domain name (FQDN) of the domain. For the **Get-GPPermission** cmdlet, the GPO for which to get the permission level must exist in this domain. -If you do not specify the *Domain* parameter, the domain of the user that is running the current session is used. +If you do not specify the **Domain** parameter, the domain of the user that is running the current session is used. If the cmdlet is being run from a computer startup or shutdown script, the domain of the computer is used. For more information, see the Notes section in the full Help. @@ -160,11 +161,12 @@ Accept wildcard characters: False ``` ### -Guid + Specifies the GPO from which to retrieve the permission level by its globally unique identifier (GUID). The GUID uniquely identifies the GPO. -You can also refer to the *Guid* parameter by its built-in alias, **Id**. -For more information, see **about_Aliases**. +You can also refer to the **Guid** parameter by its built-in alias, **Id**. +For more information, see [about_Aliases](????????). ```yaml Type: Guid @@ -183,10 +185,10 @@ Specifies the GPO from which to retrieve the permission level by its display nam The display name is not guaranteed to be unique in the domain. If another GPO with the same display name exists in the domain an error occurs. -You can use the *Guid* parameter to uniquely identify a GPO. +You can use the **Guid** parameter to uniquely identify a GPO. You can also refer to the **Name** parameter by its built-in alias, **DisplayName**. -For more information, see **about_Aliases**. +For more information, see [about_Aliases](????????). ```yaml Type: System.String @@ -201,13 +203,14 @@ Accept wildcard characters: False ``` ### -Server + Specifies the name of the domain controller that this cmdlet contacts to complete the operation. You can specify either the fully qualified domain name (FQDN) or the host name. -If you do not specify the name by using the *Server* parameter, the PDC emulator is contacted. +If you do not specify the name by using the **Server** parameter, the PDC emulator is contacted. You can also refer to the *Server* parameter by its built-in alias, **DC**. -For more information, see **about_Aliases**. +For more information, see [about_Aliases](????????). ```yaml Type: System.String diff --git a/docset/winserver2022-ps/grouppolicy/Get-GPPrefRegistryValue.md b/docset/winserver2022-ps/grouppolicy/Get-GPPrefRegistryValue.md index 6f28fa2543..083b9cc04d 100644 --- a/docset/winserver2022-ps/grouppolicy/Get-GPPrefRegistryValue.md +++ b/docset/winserver2022-ps/grouppolicy/Get-GPPrefRegistryValue.md @@ -44,8 +44,8 @@ You can use this information to browse for Registry preference items. ## EXAMPLES ### Example 1: Get the Registry preference item value -``` -PS C:\> Get-GPPrefRegistryValue -Name "TestGPO" -Context User -Key "HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\ExampleKey" -ValueName "ValueOne" +```powershell +Get-GPPrefRegistryValue -Name "TestGPO" -Context User -Key "HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\ExampleKey" -ValueName "ValueOne" KeyPath : SOFTWARE\Microsoft\ExampleKey FullKeyPath : HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\ExampleKey Hive : LocalMachine @@ -62,8 +62,8 @@ HasValue : True This command gets the Registry preference item that is configured for the registry value HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\ExampleKey with value name ValueOne from User Configuration in the GPO named TestGPO. ### Example 2: Get all Registry preference items -``` -PS C:\> Get-GPPrefRegistryValue -Name "TestGPO" -Context User -Key "HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\ExampleKey" +```powershell +Get-GPPrefRegistryValue -Name "TestGPO" -Context User -Key "HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\ExampleKey" KeyPath : SOFTWARE\Microsoft\ExampleKey FullKeyPath : HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\ExampleKey Hive : LocalMachine @@ -126,12 +126,13 @@ Accept wildcard characters: False ``` ### -Domain + Specifies the domain for this cmdlet. You must specify the fully qualified domain name (FQDN) of the domain. For the **Get-GPPrefRegistryValue** cmdlet, the GPO for which to get the Registry preference item must exist in this domain. -If you do not specify the *Domain* parameter, the domain of the user that is running the current session is used. +If you do not specify the **Domain** parameter, the domain of the user that is running the current session is used. If the cmdlet is being run from a computer startup or shutdown script, the domain of the computer is used. For more information, see the Notes section in the full Help. @@ -153,11 +154,12 @@ Accept wildcard characters: False ``` ### -Guid + Specifies the GPO from which this cmdlet gets the Registry preference item by its globally unique identifier (GUID). The GUID uniquely identifies the GPO. -You can also refer to the *Guid* parameter by its built-in alias, **Id**. -For more information, see **about_Aliases**. +You can also refer to the **Guid** parameter by its built-in alias, **Id**. +For more information, see [about_Aliases](????????). ```yaml Type: Guid @@ -191,7 +193,7 @@ The *Key* parameter can be specified with or without the *ValueName* parameter: - If the *ValueName* parameter is not specified, all Registry preference items that configure the registry key and any of its first-level values are retrieved. You can also refer to the Key parameter by its built-in alias, FullKeyPath. -For more information, see **about_Aliases**. +For more information, see [about_Aliases](????????). ```yaml Type: System.String @@ -210,7 +212,7 @@ Specifies the GPO from which this cmdlet gets the Registry preference item by it The display name is not guaranteed to be unique in the domain. If another GPO with the same display name exists in the domain an error occurs. -You can use the *Guid* parameter to uniquely identify a GPO. +You can use the **Guid** parameter to uniquely identify a GPO. You can also refer to the **Name** parameter by its built-in alias, **DisplayName**. For more information, **see about_Aliases**. @@ -243,13 +245,14 @@ Accept wildcard characters: False ``` ### -Server + Specifies the name of the domain controller that this cmdlet contacts to complete the operation. You can specify either the fully qualified domain name (FQDN) or the host name. If you do not specify the name through the *Server* parameter, the primary domain controller (PDC) emulator is contacted. You can also refer to the *Server* parameter by its built-in alias, **DC**. -For more information, see **about_Aliases**. +For more information, see [about_Aliases](????????). ```yaml Type: System.String @@ -307,7 +310,7 @@ You can pipe these objects to the following cmdlets: * If a Registry preference item for the specified registry key or value is not found, a non-terminating error occurs. - You can use the *Domain* parameter to explicitly specify the domain for this cmdlet. + You can use the **Domain** parameter to explicitly specify the domain for this cmdlet. If you do not explicitly specify the domain, the cmdlet uses a default domain. The default domain is the domain that is used to access network resources by the security context under which the current session is running. diff --git a/docset/winserver2022-ps/grouppolicy/Get-GPRegistryValue.md b/docset/winserver2022-ps/grouppolicy/Get-GPRegistryValue.md index 9995255eca..edbe15752c 100644 --- a/docset/winserver2022-ps/grouppolicy/Get-GPRegistryValue.md +++ b/docset/winserver2022-ps/grouppolicy/Get-GPRegistryValue.md @@ -11,6 +11,7 @@ title: Get-GPRegistryValue # Get-GPRegistryValue ## SYNOPSIS + Gets one or more registry-based policy settings under either Computer Configuration or User Configuration in a GPO. ## SYNTAX @@ -47,8 +48,8 @@ You can use this information to browse for registry-based policy settings. ## EXAMPLES ### Example 1: Get the group policy registry value from the specified key -``` -PS C:\> Get-GPRegistryValue -Name TestGPO -Key "HKEY_CURRENT_USER\Software\Policies\Microsoft\ExampleKey" -ValueName "ValueOne" +```powershell +Get-GPRegistryValue -Name TestGPO -Key "HKEY_CURRENT_USER\Software\Policies\Microsoft\ExampleKey" -ValueName "ValueOne" KeyPath : Software\Policies\Microsoft\ExampleKey FullKeyPath : HKEY_CURRENT_USER\Software\Policies\Microsoft\ExampleKey Hive : CurrentUser @@ -62,8 +63,8 @@ HasValue : True This command gets the registry-based policy setting that configures the registry value HKEY_CURRENT_USER\Software\Policies\Microsoft\ExampleKey:ValueOne from User Configuration in the GPO named TestGPO. ### Example 2: Get all group policy registry values from the specified key -``` -PS C:\> Get-GPRegistryValue -Name "TestGPO" -Key "HKCU\Software\Policies\Microsoft\ExampleKey" +```powershell +Get-GPRegistryValue -Name "TestGPO" -Key "HKCU\Software\Policies\Microsoft\ExampleKey" KeyPath : Software\Policies\Microsoft\ExampleKey FullKeyPath : HKEY_CURRENT_USER\Software\Policies\Microsoft\ExampleKey Hive : CurrentUser @@ -99,12 +100,13 @@ The second registry-based policy setting (ValueTwo) is disabled (its **PolicySta ## PARAMETERS ### -Domain + Specifies the domain for this cmdlet. You must specify the fully qualified domain name (FQDN) of the domain (for instance: sales.contoso.com). For the **Get-GPRegistryValue** cmdlet, the GPO for which to get registry-based policy settings must exist in this domain. -If you do not specify the *Domain* parameter, the domain of the user that is running the current session is used. +If you do not specify the **Domain** parameter, the domain of the user that is running the current session is used. If the cmdlet is being run from a computer startup or shutdown script, the domain of the computer is used. For more information, see the Notes section in the full Help. @@ -126,11 +128,12 @@ Accept wildcard characters: False ``` ### -Guid + Specifies the GPO from which to retrieve the registry-based policy setting by its globally unique identifier (GUID). The GUID uniquely identifies the GPO. -You can also refer to the *Guid* parameter by its built-in alias, **Id**. -For more information, see **about_Aliases**. +You can also refer to the **Guid** parameter by its built-in alias, **Id**. +For more information, see [about_Aliases](????????). ```yaml Type: Guid @@ -161,7 +164,7 @@ You can specify: - The Key parameter together with the *ValueName* parameter to get the registry-based policy setting that configures a specific registry value. You can also refer to the *Key* parameter by its built-in alias FullKeyPath. -For more information, see **about_Aliases**. +For more information, see [about_Aliases](????????). ```yaml Type: System.String @@ -180,10 +183,10 @@ Specifies the GPO from which this cmdlet gets the registry-based policy setting The display name is not guaranteed to be unique in the domain. If another GPO with the same display name exists in the domain an error occurs. -You can use the *Guid* parameter to uniquely identify a GPO. +You can use the **Guid** parameter to uniquely identify a GPO. You can also refer to the **Name** parameter by its built-in alias, **DisplayName**. -For more information, see **about_Aliases**. +For more information, see [about_Aliases](????????). ```yaml Type: System.String @@ -198,10 +201,11 @@ Accept wildcard characters: False ``` ### -Server + Specifies the name of the domain controller that this cmdlet contacts to complete the operation. You can specify either the fully qualified domain name (FQDN) or the host name. -If you do not specify the name by using the *Server* parameter, the primary domain controller (PDC) emulator is contacted. +If you do not specify the name by using the **Server** parameter, the primary domain controller (PDC) emulator is contacted. ```yaml Type: System.String @@ -260,7 +264,7 @@ These objects can be piped into the following cmdlets: If the specified registry key cannot be located in policy (the registry key is not configured), a corresponding error message is displayed. - You can use the *Domain* parameter to explicitly specify the domain for this cmdlet. + You can use the **Domain** parameter to explicitly specify the domain for this cmdlet. If you do not explicitly specify the domain, the cmdlet uses a default domain. The default domain is the domain that is used to access network resources by the security context under which the current session is running. diff --git a/docset/winserver2022-ps/grouppolicy/Get-GPResultantSetOfPolicy.md b/docset/winserver2022-ps/grouppolicy/Get-GPResultantSetOfPolicy.md index c21e039b05..62d8618523 100644 --- a/docset/winserver2022-ps/grouppolicy/Get-GPResultantSetOfPolicy.md +++ b/docset/winserver2022-ps/grouppolicy/Get-GPResultantSetOfPolicy.md @@ -11,6 +11,7 @@ title: Get-GPResultantSetOfPolicy # Get-GPResultantSetOfPolicy ## SYNOPSIS + Gets and writes the RSoP information for a user, a computer, or both to a file. ## SYNTAX @@ -26,8 +27,8 @@ The **Get-GPResultantSetOfPolicy** cmdlet gets and writes the Resultant Set of P ## EXAMPLES ### Example 1: Generate a report for the default user that is running on the current session -``` -PS C:\> Get-GPResultantSetOfPolicy -ReportType Xml -Path "c:\reports\LocalUserAndComputerReport.xml" +```powershell +Get-GPResultantSetOfPolicy -ReportType Xml -Path "c:\reports\LocalUserAndComputerReport.xml" RsopMode : Logging Namespace : \\COMPUTER-02-PC\Root\Rsop\NS2BBE3F29_794F_4EAE_B9DB_0A2310622534 LoggingComputer : COMPUTER-02 @@ -39,8 +40,8 @@ This command generates a report for the default user that is running on the curr The report is generated in XML format, and is written to the specified file. ### Example 2: Generate a report for the specified computer -``` -PS C:\> Get-GPResultantSetOfPolicy -ReportType Xml -Computer "computer-08.contso.com" -Path "c:\reports\computer-08.xml" +```powershell +Get-GPResultantSetOfPolicy -ReportType Xml -Computer "computer-08.contso.com" -Path "c:\reports\computer-08.xml" RsopMode : Logging Namespace : \\computer-08.contoso.com\Root\Rsop\NS643B2E66_8F54_4407_A813_7D47173B0922 LoggingComputer : computer-08.contoso.com @@ -53,8 +54,8 @@ The computer is specified by its fully qualified domain name (FQDN), computer-08 The report is generated in XML format, and is written to the specified file. ### Example 3: Generate a report for the specified user in HTML format and save it to the specified file -``` -PS C:\> Get-GPResultantSetOfPolicy -User "Contoso\PattiFul" -ReportType Html -Path "c:\reports\UserReport.html" +```powershell +Get-GPResultantSetOfPolicy -User "Contoso\PattiFul" -ReportType Html -Path "c:\reports\UserReport.html" RsopMode : Logging Namespace : \\COMPUTER-02\Root\Rsop\NS78355E76_C754_41B5_8F5E_B61551837A62 LoggingComputer : COMPUTER-02 @@ -65,8 +66,8 @@ LoggingMode : User This command generates a report for the specified user (contoso\someuser) in HTML format and saves it to the specified file. ### Example 4: Generate a report for the specified computer and user in HTML format and save it to the specified file -``` -PS C:\> Get-GPResultantSetOfPolicy -user someuser -computer contoso.com\computer-08 -reporttype html -path c:\reports\UserAndComputerReport.html +```powershell +Get-GPResultantSetOfPolicy -user someuser -computer contoso.com\computer-08 -reporttype html -path c:\reports\UserAndComputerReport.html RsopMode : Logging Namespace : \\computer-08\Root\Rsop\NS72116C25_6570_4586_9B79_FC4F71372E57 LoggingComputer : contoso.com\computer-08 @@ -103,9 +104,10 @@ Accept wildcard characters: False ``` ### -Path + Specifies the path to the report file; for instance, c:\Reports\GpRsopReport.xml. -You can also refer to the *Path* parameter by its built-in alias, filepath. +You can also refer to the **Path** parameter by its built-in alias, filepath. For more information, see [about_Aliases](????????????). ```yaml @@ -121,6 +123,7 @@ Accept wildcard characters: False ``` ### -ReportType + Specifies the format of the RSoP report. You must specify either Html (for HTML format) or Xml (for XML format). These values are not case sensitive. diff --git a/docset/winserver2022-ps/grouppolicy/Get-GPStarterGPO.md b/docset/winserver2022-ps/grouppolicy/Get-GPStarterGPO.md index ca2c81a4fc..b0810a906d 100644 --- a/docset/winserver2022-ps/grouppolicy/Get-GPStarterGPO.md +++ b/docset/winserver2022-ps/grouppolicy/Get-GPStarterGPO.md @@ -11,6 +11,7 @@ title: Get-GPStarterGPO # Get-GPStarterGPO ## SYNOPSIS + Gets one Starter GPO or all Starter GPOs in a domain. ## SYNTAX @@ -32,15 +33,15 @@ Get-GPStarterGPO [-Domain ] [-Server ] [-All] [ Get-GPStarterGPO -Name "Windows Vista EC User" +```powershell +Get-GPStarterGPO -Name "Windows Vista EC User" DisplayName : Windows Vista EC User Id : 8780588e-ef91-442b-bd5f-2d50de7abf76 Owner : BUILTIN\Administrators @@ -59,8 +60,8 @@ For more information about each of these settings, see the [Windows Vista Securi This command gets the Starter GPO named Windows Vista EC User. ### Example 2: Get a Starter GPO by name using the pipeline operator -``` -PS C:\> Get-GPStarterGPO -Name "Windows Vista EC User" | New-GPO -Name "TestGPO" -Comment "Create a GPO by using a Starter GPO" +```powershell +Get-GPStarterGPO -Name "Windows Vista EC User" | New-GPO -Name "TestGPO" -Comment "Create a GPO by using a Starter GPO" DisplayName : TestGPO DomainName : contoso.com Owner : CONTOSO\Domain Admins @@ -95,12 +96,13 @@ Accept wildcard characters: False ``` ### -Domain + Specifies the domain for this cmdlet. You must specify the fully qualified domain name (FQDN) of the domain. For the **Get-GPStarterGPO** cmdlet, the Starter GPO must exist in this domain. -If you do not specify the *Domain* parameter, the domain of the user that is running the current session is used. +If you do not specify the **Domain** parameter, the domain of the user that is running the current session is used. If the cmdlet is being run from a computer startup or shutdown script, the domain of the computer is used. For more information, see the Notes section in the full Help. @@ -125,8 +127,8 @@ Accept wildcard characters: False Specifies the Starter GPO that this cmdlet gets by its globally unique identifier (GUID). The GUID uniquely identifies the Starter GPO. -You can also refer to the *Guid* parameter by its built-in alias, **Id**. -For more information, see **about_Aliases**. +You can also refer to the **Guid** parameter by its built-in alias, **Id**. +For more information, see [about_Aliases](????????). ```yaml Type: Guid @@ -145,10 +147,10 @@ Specifies the display name of the Starter GPO that this cmdlet. The display name is not guaranteed to be unique in the domain. If another Starter GPO with the same display name exists in the domain an error occurs. -You can use the *Guid* parameter to uniquely identify a Starter GPO. +You can use the **Guid** parameter to uniquely identify a Starter GPO. You can also refer to the **Name** parameter by its built-in alias, **DisplayName**. -For more information, see **about_Aliases**. +For more information, see [about_Aliases](????????). ```yaml Type: System.String @@ -163,13 +165,14 @@ Accept wildcard characters: False ``` ### -Server + Specifies the name of the domain controller that this cmdlet contacts to complete the operation. You can specify either the fully qualified domain name (FQDN) or the host name. -If you do not specify the name by using the *Server* parameter, the primary domain controller (PDC) emulator is contacted. +If you do not specify the name by using the **Server** parameter, the primary domain controller (PDC) emulator is contacted. You can also refer to the *Server* parameter by its built-in alias, **DC**. -For more information, see **about_Aliases**. +For more information, see [about_Aliases](????????). ```yaml Type: System.String @@ -200,7 +203,7 @@ This cmdlet returns a Starter GPO object. ## NOTES -* You can use the *Domain* parameter to explicitly specify the domain for this cmdlet. +* You can use the **Domain** parameter to explicitly specify the domain for this cmdlet. If you do not explicitly specify the domain, the cmdlet uses a default domain. The default domain is the domain that is used to access network resources by the security context under which the current session is running. diff --git a/docset/winserver2022-ps/grouppolicy/Import-GPO.md b/docset/winserver2022-ps/grouppolicy/Import-GPO.md index 773d8dc279..f3cdc72ba3 100644 --- a/docset/winserver2022-ps/grouppolicy/Import-GPO.md +++ b/docset/winserver2022-ps/grouppolicy/Import-GPO.md @@ -11,44 +11,51 @@ title: Import-GPO # Import-GPO ## SYNOPSIS + Imports the Group Policy settings from a backed-up GPO into a specified GPO. ## SYNTAX ### ImportGUID (Default) + ``` Import-GPO -BackupId -Path [-TargetGuid ] [-TargetName ] - [-MigrationTable ] [-CreateIfNeeded] [-Domain ] [-Server ] [-WhatIf] [-Confirm] - [] + [-MigrationTable ] [-CreateIfNeeded] [-Domain ] [-Server ] [-WhatIf] + [-Confirm] [] ``` ### ImportName + ``` Import-GPO -BackupGpoName -Path [-TargetGuid ] [-TargetName ] - [-MigrationTable ] [-CreateIfNeeded] [-Domain ] [-Server ] [-WhatIf] [-Confirm] - [] + [-MigrationTable ] [-CreateIfNeeded] [-Domain ] [-Server ] [-WhatIf] + [-Confirm] [] ``` ## DESCRIPTION + The **Import-GPO** cmdlet imports the settings from a Group Policy Object (GPO) backup into a specified target GPO. The target GPO can be in a different domain or forest than the backup that was made and it does not have to exist prior to the operation. -Use the *Path* parameter to specify the location of the backup and then use the *BackupGpoName* parameter to specify the GPO name of the backup to use, or the *BackupId* parameter to specify the backup ID (GUID) of the backup to use. +Use the **Path** parameter to specify the location of the backup and then use the **BackupGpoName** parameter to specify the GPO name of the backup to use, or the **BackupId** parameter to specify the backup ID (GUID) of the backup to use. If you specify a GPO name, the cmdlet imports the most recent backup. To import an earlier version of a GPO backup, you must use the *BackupID* parameter to specify the unique backup ID for the particular version. This is the GUID that uniquely identifies the backup within its backup directory. -Use the *TargetName* parameter or the *TargetGuid* parameter to specify the target GPO into which the settings should be imported. -Use the optional *MigrationTable* parameter to map security principals and Universal Naming Convention (UNC) paths across domains. +Use the **TargetName** parameter or the **TargetGuid** parameter to specify the target GPO into which the settings should be imported. +Use the optional **MigrationTable** parameter to map security principals and Universal Naming Convention (UNC) paths across domains. Use the *CreateIfNeeded* parameter to create a new GPO if the specified target GPO does not exist. ## EXAMPLES ### Example 1: Import the settings from the latest backup to another directory in the same domain + +```powershell +import-gpo -BackupGpoName TestGPO -TargetName TestGPO -path c:\backups ``` -PS C:\> import-gpo -BackupGpoName TestGPO -TargetName TestGPO -path c:\backups +```Output DisplayName : TestGPO DomainName : contoso.com Owner : CONTOSO\Domain Admins @@ -62,13 +69,18 @@ ComputerVersion : AD Version: 5, SysVol Version: 5 WmiFilter : ``` -This command imports the settings from the most recent backup of the GPO named TestGPO in the c:\backups directory into a GPO of the same name in the current domain. -If a GPO named TestGPO does not exist in the current domain, the command fails because the CreateIfNeeded parameter is not specified. +This command imports the settings from the most recent backup of the GPO named `TestGPO` in the +`c:\backups` directory into a GPO of the same name in the current domain. If a GPO named TestGPO +does not exist in the current domain, the command fails because the CreateIfNeeded parameter is not +specified. ### Example 2: Import the settings from specified backup in the same directory in the same domain + +```powershell +import-gpo -BackupId A491D730-F3ED-464C-B8C9-F50562C536AA -TargetName TestGPO -path c:\backups -CreateIfNeeded ``` -PS C:\> import-gpo -BackupId A491D730-F3ED-464C-B8C9-F50562C536AA -TargetName TestGPO -path c:\backups -CreateIfNeeded +```Output DisplayName : TestGPO DomainName : contoso.com Owner : CONTOSO\Domain Admins @@ -82,14 +94,18 @@ ComputerVersion : AD Version: 6, SysVol Version: 6 WmiFilter : ``` -This command imports the settings from the specified backup in the c:\backups directory into a GPO that is named TestGPO in the current domain. -The BackupId parameter is used to specify the GUID of the GPO backup to use. -Because the CreateIfNeeded parameter is specified, if a GPO named TestGPO does not exist in the current domain, one is created before the settings are imported. +This command imports the settings from the specified backup in the c:\backups directory into a GPO +that is named TestGPO in the current domain. The BackupId parameter is used to specify the GUID of +the GPO backup to use. Because the CreateIfNeeded parameter is specified, if a GPO named TestGPO +does not exist in the current domain, one is created before the settings are imported. ### Example 3: Import the settings from the latest backup to another directory to the current domain + +```powershell +Import-GPO -BackupGpoName TestGPO -Path D:\Backups -TargetName NewTestGPO -MigrationTable D:\Tables\Migtable1.migtable -CreateIfNeeded ``` -PS C:\> Import-GPO -BackupGpoName TestGPO -Path D:\Backups -TargetName NewTestGPO -MigrationTable D:\Tables\Migtable1.migtable -CreateIfNeeded +```Output DisplayName : NewTestGPO DomainName : contoso.com Owner : CONTOSO\Domain Admins @@ -103,19 +119,21 @@ ComputerVersion : AD Version: 1, SysVol Version: 1 WmiFilter : ``` -This command imports the settings from the most recent backup of the GPO named TestGPO from the d:\backups directory to a GPO named NewTestGPO in the current domain. -The specified migration table is used to migrate security principals and UNC paths to the new GPO. -Because the CreateIfNeeded parameter is specified, the GPO is created if it does not already exist. +This command imports the settings from the most recent backup of the GPO named TestGPO from the +d:\backups directory to a GPO named NewTestGPO in the current domain. The specified migration table +is used to migrate security principals and UNC paths to the new GPO. Because the CreateIfNeeded +parameter is specified, the GPO is created if it does not already exist. ## PARAMETERS ### -BackupGpoName -Specifies the display name of the backed-up GPO from which this cmdlet imports the settings. -The most recent backup of the GPO is used. -You can use the *BackupId* parameter to specify a particular version to use when multiple backups of the same GPO exist in the backup directory. -You can also refer to the *BackupGpoName* parameter by its built-in alias, **DisplayName**. -For more information, see [about_Aliases](????????????). +Specifies the display name of the backed-up GPO from which this cmdlet imports the settings. The +most recent backup of the GPO is used. You can use the *BackupId* parameter to specify a particular +version to use when multiple backups of the same GPO exist in the backup directory. + +You can also refer to the **BackupGpoName** parameter by its built-in alias, **DisplayName**. For +more information, see [about_Aliases](????????????). ```yaml Type: System.String @@ -130,14 +148,15 @@ Accept wildcard characters: False ``` ### -BackupId -Specifies the backup ID of a GPO backup. -The backup ID is a globally unique identifier (GUID) that uniquely identifies the backup. -You can use this parameter to specify a particular version of a backed-up GPO in the backup directory. + +Specifies the backup ID of a GPO backup. The backup ID is a globally unique identifier (GUID) that +uniquely identifies the backup. You can use this parameter to specify a particular version of a +backed-up GPO in the backup directory. The backup ID is different from the ID of the GPO that was backed up. -You can also refer to the *BackupId* parameter by its built-in alias, **Id**. -For more information, see **about_Aliases**. +You can also refer to the *BackupId* parameter by its built-in alias, **Id**. For more information, +see [about_Aliases](????????). ```yaml Type: Guid @@ -152,6 +171,7 @@ Accept wildcard characters: False ``` ### -Confirm + Prompts you for confirmation before running the cmdlet. ```yaml @@ -167,6 +187,7 @@ Accept wildcard characters: False ``` ### -CreateIfNeeded + Indicates that the cmdlet creates a GPO from the backup if the specified target GPO does not exist. ```yaml @@ -182,19 +203,22 @@ Accept wildcard characters: False ``` ### -Domain -Specifies the domain for this cmdlet. -You must specify the fully qualified domain name (FQDN) of the domain. + +Specifies the domain for this cmdlet. You must specify the fully qualified domain name (FQDN) of the +domain. For the **Import-GPO** cmdlet, this is the domain into which you want to import the GPO. -If you do not specify the *Domain* parameter, the domain of the user that is running the current session is used. -If the cmdlet is being run from a computer startup or shutdown script, the domain of the computer is used. -For more information, see the Notes section in the full Help. +If you do not specify the **Domain** parameter, the domain of the user that is running the current +session is used. If the cmdlet is being run from a computer startup or shutdown script, the domain +of the computer is used. For more information, see the Notes section in the full Help. -If you specify a domain that is different from the domain of the user that is running the current session (or, for a startup or shutdown script, the computer), a trust must exist between that domain and the domain of the user, or the computer. +If you specify a domain that is different from the domain of the user that is running the current +session (or, for a startup or shutdown script, the computer), a trust must exist between that domain +and the domain of the user, or the computer. -You can also refer to the **Domain** parameter by its built-in alias, **DomainName**. -For more information, see **about_Aliases**. +You can also refer to the **Domain** parameter by its built-in alias, **DomainName**. For more +information, see [about_Aliases](????????). ```yaml Type: System.String @@ -209,8 +233,9 @@ Accept wildcard characters: False ``` ### -MigrationTable -Specifies the path to a migration table file. -You can use a migration table to map security principals and UNC paths across domains. + +Specifies the path to a migration table file. You can use a migration table to map security +principals and UNC paths across domains. ```yaml Type: System.String @@ -225,9 +250,11 @@ Accept wildcard characters: False ``` ### -Path + Specifies the path to the backup directory. -You can also refer to the *Path* parameter by its built-in aliases: backuplocation or backupdirectory. +You can also refer to the **Path** parameter by its built-in aliases: backuplocation or +backupdirectory. ```yaml Type: System.String @@ -242,10 +269,11 @@ Accept wildcard characters: False ``` ### -Server -Specifies the name of the domain controller that this cmdlet contacts to complete the operation. -You can specify either the fully qualified domain name (FQDN) or the host name -If you do not specify the name by using the *Server* parameter, the primary domain controller (PDC) emulator is contacted. +Specifies the name of the domain controller that this cmdlet contacts to complete the operation. You +can specify either the fully qualified domain name (FQDN) or the host name + +If you do not specify the name by using the **Server** parameter, the primary domain controller (PDC) emulator is contacted. You can also refer to the *Server* parameter by its built-in alias, **DC**. @@ -262,10 +290,11 @@ Accept wildcard characters: False ``` ### -TargetGuid -Specifies the GUID of the GPO into which this cmdlet imports the settings. -Use the *CreateIfNeeded* parameter to force the GPO to be created if it does not already exist in the domain. -You must specify either the *TargetGuid* parameter or the *TargetName* parameter. +Specifies the GUID of the GPO into which this cmdlet imports the settings. Use the *CreateIfNeeded* +parameter to force the GPO to be created if it does not already exist in the domain. + +You must specify either the **TargetGuid** parameter or the **TargetName** parameter. ```yaml Type: Guid @@ -280,10 +309,12 @@ Accept wildcard characters: False ``` ### -TargetName -Specifies the display name of the GPO into which the settings are to be imported. -Use the *CreateIfNeeded* parameter to force the GPO to be created if it does not already exist in the domain. -You must specify either the *TargetGuid* parameter or the *TargetName* parameter. +Specifies the display name of the GPO into which the settings are to be imported. Use the +*CreateIfNeeded* parameter to force the GPO to be created if it does not already exist in the +domain. + +You must specify either the **TargetGuid** parameter or the **TargetName** parameter. ```yaml Type: System.String @@ -316,11 +347,15 @@ Accept wildcard characters: False ### CommonParameters -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). +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). ## INPUTS ### Microsoft.GroupPolicy.GpoBackup + You can pipe an object that represents a GPO backup on the file system to this cmdlet. ## OUTPUTS @@ -331,16 +366,20 @@ This cmdlet returns an object that represents the GPO after the settings have be ## NOTES -* You can use the **Import-GPO** to copy settings from a GPO backup in one domain to the same domain or another domain in the same or different forest. +* You can use the **Import-GPO** to copy settings from a GPO backup in one domain to the same domain + or another domain in the same or different forest. - You can use the *Domain* parameter to explicitly specify the domain for this cmdlet. + You can use the **Domain** parameter to explicitly specify the domain for this cmdlet. - If you do not explicitly specify the domain, the cmdlet uses a default domain. -The default domain is the domain that is used to access network resources by the security context under which the current session is running. -This domain is typically the domain of the user that is running the session for example, the domain of the user who started the session by opening Windows PowerShell or the domain of a user that is specified in a runas command. -However, computer startup and shutdown scripts run under the context of the LocalSystem account. -The LocalSystem account is a built-in local account, and it accesses network resources under the context of the computer account. -Therefore, when this cmdlet is run from a startup or shutdown script, the default domain is the domain to which the computer is joined. + If you do not explicitly specify the domain, the cmdlet uses a default domain. The default domain + is the domain that is used to access network resources by the security context under which the + current session is running. This domain is typically the domain of the user that is running the + session for example, the domain of the user who started the session by opening Windows PowerShell + or the domain of a user that is specified in a runas command. However, computer startup and + shutdown scripts run under the context of the LocalSystem account. The LocalSystem account is a + built-in local account, and it accesses network resources under the context of the computer + account. Therefore, when this cmdlet is run from a startup or shutdown script, the default domain + is the domain to which the computer is joined. ## RELATED LINKS diff --git a/docset/winserver2022-ps/grouppolicy/Invoke-GPUpdate.md b/docset/winserver2022-ps/grouppolicy/Invoke-GPUpdate.md index bdd8f98387..ea710c80e1 100644 --- a/docset/winserver2022-ps/grouppolicy/Invoke-GPUpdate.md +++ b/docset/winserver2022-ps/grouppolicy/Invoke-GPUpdate.md @@ -11,25 +11,31 @@ title: Invoke-GPUpdate # Invoke-GPUpdate ## SYNOPSIS + Schedules a remote Group Policy refresh on the specified computer. ## SYNTAX ### NonSyncSet (Default) + ``` -Invoke-GPUpdate [-AsJob] [-Boot] [[-Computer] ] [[-RandomDelayInMinutes] ] [-Force] [-LogOff] - [-Target ] [] +Invoke-GPUpdate [-AsJob] [-Boot] [[-Computer] ] [[-RandomDelayInMinutes] ] [-Force] +[-LogOff] [-Target ] [] ``` ### SyncSet + ``` Invoke-GPUpdate [-AsJob] [-Boot] [[-Computer] ] [[-RandomDelayInMinutes] ] [-LogOff] - [-Target ] [-Sync] [] +[-Target ] [-Sync] [] ``` ## DESCRIPTION -The **Invoke-GPUpdate** cmdlet refreshes Group Policy settings, including security settings that are set on remote computers by scheduling the running of the Gpupdate command on a remote computer. -You can combine this cmdlet in a scripted fashion to schedule the Gpupdate command on a group of computers. + +The **Invoke-GPUpdate** cmdlet refreshes Group Policy settings, including security settings that are +set on remote computers by scheduling the running of the Gpupdate command on a remote computer. You +can combine this cmdlet in a scripted fashion to schedule the Gpupdate command on a group of +computers. The refresh can be scheduled to immediately start a refresh of policy settings or wait for a specified period of time, up to a maximum of 31 days. To avoid putting a load on the network, the refresh times will be offset by a random delay. @@ -37,15 +43,15 @@ To avoid putting a load on the network, the refresh times will be offset by a ra ## EXAMPLES ### Example 1: Schedule a Group Policy refresh on the current computer -``` -PS C:\> Invoke-GPUpdate +```powershell +Invoke-GPUpdate ``` This command schedules a Group Policy refresh on the computer on which you are running the **Invoke-GPUpdate** cmdlet. ### Example 2: Schedule a Group Policy refresh on a remote computer -``` -PS C:\> Invoke-GPUpdate -Computer "CONTOSO\COMPUTER-02" -Target "User" +```powershell +Invoke-GPUpdate -Computer "CONTOSO\COMPUTER-02" -Target "User" ``` This command schedules a Group Policy refresh on a remote computer named CONTOSO\COMPUTER-02 that only schedule to update the user policy settings in synchronous mode. @@ -228,6 +234,7 @@ This cmdlet does not take any object as input. ## OUTPUTS ### None + This cmdlet does not generate any output. ## NOTES diff --git a/docset/winserver2022-ps/grouppolicy/New-GPLink.md b/docset/winserver2022-ps/grouppolicy/New-GPLink.md index 334cced92d..a39da391ff 100644 --- a/docset/winserver2022-ps/grouppolicy/New-GPLink.md +++ b/docset/winserver2022-ps/grouppolicy/New-GPLink.md @@ -11,6 +11,7 @@ title: New-GPLink # New-GPLink ## SYNOPSIS + Links a GPO to a site, domain, or OU. ## SYNTAX @@ -38,8 +39,8 @@ You can use other parameters to specify whether the link is enabled, whether the ## EXAMPLES ### Example 1: Create and link a GPO to a domain -``` -PS C:\> New-GPO -Name "MyGPO" | New-GPLink -Target "ou=MyOU,dc=contoso,dc=com" -LinkEnabled Yes +```powershell +New-GPO -Name "MyGPO" | New-GPLink -Target "ou=MyOU,dc=contoso,dc=com" -LinkEnabled Yes GpoId : c25daa3e-5d05-43b3-87ca-0a237882fd63 DisplayName : MyGPO Enabled : True @@ -55,8 +56,8 @@ Because this command can take a GPO as input, you can insert any command that re For instance, you can insert **Set-GPPermissions** commands to set permissions on the GPO, Set-GPRegistryValue cmdlet to configure one or more registry-based policy settings for the GPO, or the **Set-GPPrefRegistryValue** cmdlet to configure one or more Registry preference items for the GPO. ### Example 2: Link a GPO in the domain of the user -``` -PS C:\> New-GPLink -Name "TestGPO" -Target "dc=contoso,dc=com" +```powershell +New-GPLink -Name "TestGPO" -Target "dc=contoso,dc=com" GpoId : d5a3b4e7-e37a-4070-846c-568689eaa838 DisplayName : TestGPO Enabled : True @@ -69,8 +70,8 @@ This command links the TestGPO GPO in the domain of the user (or, for a startup If the domain of the user, or the computer, is different than contoso.com, a trust relationship must exist between the two domains. ### Example 3: Link a GPO to a site and enforce the link -``` -PS C:\> New-GPLink -name "TestGPO" -Target "Test-Site" -Enforced Yes +```powershell +New-GPLink -name "TestGPO" -Target "Test-Site" -Enforced Yes GpoId : d5a3b4e7-e37a-4070-846c-568689eaa838 DisplayName : TestGPO Enabled : True @@ -84,6 +85,7 @@ This command links the TestGPO GPO to the site named Test-Site and sets the link ## PARAMETERS ### -Confirm + Prompts you for confirmation before running the cmdlet. ```yaml @@ -99,6 +101,7 @@ Accept wildcard characters: False ``` ### -Domain + Specifies the domain for this cmdlet. You must specify the fully qualified domain name (FQDN) of the domain. @@ -110,7 +113,7 @@ For the **New-GPLink** cmdlet: To specify a domain to link to, use the *Target* parameter. -If you do not specify the *Domain* parameter, the domain of the user that is running the current session is used. +If you do not specify the **Domain** parameter, the domain of the user that is running the current session is used. If the cmdlet is being run from a computer startup or shutdown script, the domain of the computer is used. For more information, see the Notes section in the full Help. @@ -158,11 +161,12 @@ Accept wildcard characters: False ``` ### -Guid + Specifies the GPO to link by its globally unique identifier (GUID). The GUID uniquely identifies the GPO in the domain. You can also refer to the Guid parameter by its built-in alias, **Id**. -For more information, see **about_Aliases**. +For more information, see [about_Aliases](????????). ```yaml Type: Guid @@ -204,10 +208,10 @@ Specifies the GPO to link by its display name. The display name is not guaranteed to be unique in the domain. If another GPO with the same display name exists in the domain, an error occurs. -You can use the *Guid* parameter to uniquely identify a GPO. +You can use the **Guid** parameter to uniquely identify a GPO. You can also refer to the **Name** parameter by its built-in alias, **DisplayName**. -For more information, see **about_Aliases**. +For more information, see [about_Aliases](????????). ```yaml Type: System.String @@ -247,13 +251,14 @@ Accept wildcard characters: False ``` ### -Server + Specifies the name of the domain controller that this cmdlet contacts to complete the operation. You can specify either the FQDN or the host name. -If you do not specify the name by using the *Server* parameter, the primary domain controller (PDC) emulator is contacted. +If you do not specify the name by using the **Server** parameter, the primary domain controller (PDC) emulator is contacted. You can also refer to the *Server* parameter by its built-in alias, **DC**. -For more information, see **about_Aliases**. +For more information, see [about_Aliases](????????). ```yaml Type: System.String @@ -319,7 +324,7 @@ This cmdlet returns an object that represents the link between the GPO and the s * To link a GPO to a site, domain, or OU, you must have Link GPOs permission on that site, domain, or OU. By default, only domain administrators and enterprise administrators have this privilege for domains and OUs. Enterprise administrators and domain administrators of the forest root domain have this privilege for sites. - You can use the *Domain* parameter to explicitly specify the domain for this cmdlet. + You can use the **Domain** parameter to explicitly specify the domain for this cmdlet. If you do not explicitly specify the domain, the cmdlet uses a default domain. The default domain is the domain that is used to access network resources by the security context under which the current session is running. diff --git a/docset/winserver2022-ps/grouppolicy/New-GPO.md b/docset/winserver2022-ps/grouppolicy/New-GPO.md index 5594bf6127..64399c4b2f 100644 --- a/docset/winserver2022-ps/grouppolicy/New-GPO.md +++ b/docset/winserver2022-ps/grouppolicy/New-GPO.md @@ -11,6 +11,7 @@ title: New-GPO # New-GPO ## SYNOPSIS + Creates a GPO. ## SYNTAX @@ -44,8 +45,8 @@ The cmdlet returns a **GPO** object, which represents the created GPO that you c ## EXAMPLES ### Example 1: Create a GPO in the domain of the user -``` -PS C:\> New-GPO -Name TestGPO -Comment "This is a test GPO." +```powershell +New-GPO -Name TestGPO -Comment "This is a test GPO." DisplayName : TestGPO DomainName : contoso.com Owner : CONTOSO\Domain Admins @@ -63,16 +64,16 @@ This command creates a GPO in the domain of the user. The GPO is created with the specified comment. ### Example 2: Create a GPO in the domain of the user that is pre-populated with the settings of the Starter GPO -``` -PS C:\> New-GPO -Name "FromStarterGPO" -StarterGPOName "Windows Vista EC Computer Starter GPO" +```powershell +New-GPO -Name "FromStarterGPO" -StarterGPOName "Windows Vista EC Computer Starter GPO" ``` This command creates a GPO named FromStarterGPO in the domain of the user. The GPO is pre-populated with the settings of the Starter GPO. ### Example 3: Create a GPO in the domain of the user and link it to an OU -``` -PS C:\> new-gpo -name TestGPO | new-gplink -target "ou=marketing,dc=contoso,dc=com" | set-gppermissions -permissionlevel gpoedit -targetname "Marketing Admins" -targettype group +```powershell +new-gpo -name TestGPO | new-gplink -target "ou=marketing,dc=contoso,dc=com" | set-gppermissions -permissionlevel gpoedit -targetname "Marketing Admins" -targettype group DisplayName : TestGPO DomainName : contoso.com @@ -114,6 +115,7 @@ Accept wildcard characters: False ``` ### -Confirm + Prompts you for confirmation before running the cmdlet. ```yaml @@ -129,6 +131,7 @@ Accept wildcard characters: False ``` ### -Domain + Specifies the domain for this cmdlet. You must specify the fully qualified domain name (FQDN) of the domain. @@ -138,7 +141,7 @@ For the **New-GPO** cmdlet: - If a Starter GPO is specified, it must exist in this domain. -If you do not specify the *Domain* parameter, then the domain of the user running the current session is used. +If you do not specify the **Domain** parameter, then the domain of the user running the current session is used. If the cmdlet is being run from a computer startup or shutdown script, the domain of the computer is used. For more information, see the Notes section in the full help. @@ -165,7 +168,7 @@ Specifies a display name for the new GPO. If another GPO with the same display name exists in the domain an error occurs. You can also refer to the **Name** parameter by its built-in alias, **DisplayName**. -For more information, see **about_Aliases**. +For more information, see [about_Aliases](????????). ```yaml Type: System.String @@ -180,13 +183,14 @@ Accept wildcard characters: False ``` ### -Server + Specifies the name of the domain controller that this cmdlet contacts to complete the operation. You can specify either the fully qualified domain name (FQDN) or the host name. -If you do not specify the name by using the *Server* parameter, the primary domain controller (PDC) emulator is contacted. +If you do not specify the name by using the **Server** parameter, the primary domain controller (PDC) emulator is contacted. You can also refer to the *Server* parameter by its built-in alias, **DC**. -For more information, see **about_Aliases**. +For more information, see [about_Aliases](????????). ```yaml Type: System.String @@ -206,7 +210,7 @@ The GUID uniquely identifies the Starter GPO. If a Starter GPO is specified, the GPO is created with its settings. You can also refer to the **StarterGpoGuid* *parameter by its built-in alias, **Id**. -For more information, see **about_Aliases**. +For more information, see [about_Aliases](????????). ```yaml Type: Guid @@ -231,7 +235,7 @@ If another Starter GPO with the same display name exists in the domain, an error You can use the **StarterGpoGuid* *parameter to uniquely identify a Starter GPO. You can also refer to the **Name** parameter by its built-in alias, **DisplayName**. -For more information, see **about_Aliases**. +For more information, see [about_Aliases](????????). ```yaml Type: System.String @@ -283,7 +287,7 @@ This cmdlet returns the GPO that was created. * Only domain administrators, enterprise administrators, and members of the Group Policy creator owners group can create GPOs. These users must run Windows PowerShell in an elevated state. - You can use the *Domain* parameter to explicitly specify the domain for this cmdlet. + You can use the **Domain** parameter to explicitly specify the domain for this cmdlet. If you do not explicitly specify the domain, the cmdlet uses a default domain. The default domain is the domain that is used to access network resources by the security context under which the diff --git a/docset/winserver2022-ps/grouppolicy/New-GPStarterGPO.md b/docset/winserver2022-ps/grouppolicy/New-GPStarterGPO.md index fc9e8ec80a..d9777e8a7d 100644 --- a/docset/winserver2022-ps/grouppolicy/New-GPStarterGPO.md +++ b/docset/winserver2022-ps/grouppolicy/New-GPStarterGPO.md @@ -11,6 +11,7 @@ title: New-GPStarterGPO # New-GPStarterGPO ## SYNOPSIS + Creates a Starter GPO. ## SYNTAX @@ -27,8 +28,8 @@ If the Starter GPOs folder does not exist in the SYSVOL when the **New-GPStarter ## EXAMPLES ### Example 1: Create a Starter GPO -``` -PS C:\> New-GPStarterGPO -Name StarterSecurity -Comment "Security Template" +```powershell +New-GPStarterGPO -Name StarterSecurity -Comment "Security Template" ``` This command creates a Starter GPO with the display name StarterSecurity. @@ -53,6 +54,7 @@ Accept wildcard characters: False ``` ### -Confirm + Prompts you for confirmation before running the cmdlet. ```yaml @@ -68,13 +70,14 @@ Accept wildcard characters: False ``` ### -Domain + Specifies the domain for this cmdlet. You must specify the fully qualified domain name (FQDN) of the domain. Cross-domain creation of Starter GPOs is not supported. If you specify a domain that is different from the domain of the user that is running the current session, an error occurs. -If you do not specify the *Domain* parameter, the domain of the user that is running the current session is used. +If you do not specify the **Domain** parameter, the domain of the user that is running the current session is used. You can also refer to the **Domain** parameter by its built-in alias, **DomainName**. For more information, see [about_Aliases](????????????). @@ -97,7 +100,7 @@ Specifies the display name for the new Starter GPO. If another Starter GPO with the same display name exists in the domain, an error occurs. You can also refer to the **Name** parameter by its built-in alias, **DisplayName**. -For more information, see **about_Aliases**. +For more information, see [about_Aliases](????????). ```yaml Type: System.String @@ -112,13 +115,14 @@ Accept wildcard characters: False ``` ### -Server + Specifies the name of the domain controller that this cmdlet contacts to complete the operation. You can specify either the fully qualified domain name (FQDN) or the host name. -If you do not specify the name by using the *Server* parameter, the primary domain controller (PDC) emulator is contacted. +If you do not specify the name by using the **Server** parameter, the primary domain controller (PDC) emulator is contacted. You can also refer to the *Server* parameter by its built-in alias, **DC**. -For more information, see **about_Aliases**. +For more information, see [about_Aliases](????????). ```yaml Type: System.String diff --git a/docset/winserver2022-ps/grouppolicy/Remove-GPLink.md b/docset/winserver2022-ps/grouppolicy/Remove-GPLink.md index a71aded868..9d80f52e96 100644 --- a/docset/winserver2022-ps/grouppolicy/Remove-GPLink.md +++ b/docset/winserver2022-ps/grouppolicy/Remove-GPLink.md @@ -11,6 +11,7 @@ title: Remove-GPLink # Remove-GPLink ## SYNOPSIS + Removes a GPO link from a site, domain or OU. ## SYNTAX @@ -34,8 +35,8 @@ This cmdlet does not delete the actual GPO or any other links between the specif ## EXAMPLES ### Example 1: Remove the specified GPO link -``` -PS C:\> Remove-GPLink -Name "MyGPO" -Target "OU=MyOU,dc=contoso,dc=com" +```powershell +Remove-GPLink -Name "MyGPO" -Target "OU=MyOU,dc=contoso,dc=com" DisplayName : MyGPO DomainName : contoso.com Owner : CONTOSO\Domain Admins @@ -52,15 +53,15 @@ WmiFilter : This command removes the link between the GPO named MyGPO and the MyOU organizational unit in the contoso.com domain. ### Example 2: Remove the link between the specified GPO and the default site -``` -PS C:\> Remove-GPLink -Name "MyGPO" -Target "Default-First-Site-Name" +```powershell +Remove-GPLink -Name "MyGPO" -Target "Default-First-Site-Name" ``` This command removes the link between the GPO named MyGPO and the default site. ### Example 3: Remove the links for all GPOs that are linked to the specified organizational unit -``` -PS C:\> (Get-GPInheritance -Target "ou=myou,dc=contoso,dc=com").GpoLinks | Remove-GPLink +```powershell +(Get-GPInheritance -Target "ou=myou,dc=contoso,dc=com").GpoLinks | Remove-GPLink DisplayName : TestGPO-3 DomainName : contoso.com Owner : CONTOSO\Domain Admins @@ -97,6 +98,7 @@ The GPOs for which links have been removed are returned. ## PARAMETERS ### -Confirm + Prompts you for confirmation before running the cmdlet. ```yaml @@ -112,6 +114,7 @@ Accept wildcard characters: False ``` ### -Domain + Specifies the domain for this cmdlet. You must specify the fully qualified domain name (FQDN) of the domain. @@ -145,11 +148,12 @@ Accept wildcard characters: False ``` ### -Guid + Specifies the GPO for which to remove the link by its globally unique identifier (GUID). The GUID uniquely identifies the GPO. -You can also refer to the *Guid* parameter by its built-in aliases, id and gpoid. -For more information, see **about_Aliases**. +You can also refer to the **Guid** parameter by its built-in aliases, id and gpoid. +For more information, see [about_Aliases](????????). ```yaml Type: Guid @@ -164,14 +168,15 @@ Accept wildcard characters: False ``` ### -Name + Specifies the GPO for which to remove the link by its display name. The display name is not guaranteed to be unique in the domain. If another GPO with the same display name exists in the domain an error occurs. -You can use the *Guid* parameter to uniquely identify a GPO. +You can use the **Guid** parameter to uniquely identify a GPO. You can also refer to the **Name** parameter by its built-in alias, **DisplayName**. -For more information, see **about_Aliases**. +For more information, see [about_Aliases](????????). ```yaml Type: System.String @@ -186,13 +191,14 @@ Accept wildcard characters: False ``` ### -Server + Specifies the name of the domain controller that this cmdlet contacts to complete the operation. You can specify either the fully qualified domain name (FQDN) or the host name. -If you do not specify the name by using the *Server* parameter, the primary domain controller (PDC) emulator is contacted. +If you do not specify the name by using the **Server** parameter, the primary domain controller (PDC) emulator is contacted. You can also refer to the *Server* parameter by its built-in alias, **DC**. -For more information, see **about_Aliases**. +For more information, see [about_Aliases](????????). ```yaml Type: System.String diff --git a/docset/winserver2022-ps/grouppolicy/Remove-GPO.md b/docset/winserver2022-ps/grouppolicy/Remove-GPO.md index f7bf2c7d83..c7d1136072 100644 --- a/docset/winserver2022-ps/grouppolicy/Remove-GPO.md +++ b/docset/winserver2022-ps/grouppolicy/Remove-GPO.md @@ -11,6 +11,7 @@ title: Remove-GPO # Remove-GPO ## SYNOPSIS + Removes a GPO. ## SYNTAX @@ -33,16 +34,16 @@ The **Remove-GPO** cmdlet removes the Group Policy Object (GPO) container and da ## EXAMPLES ### Example 1: Remove a GPO by GUID -``` -PS C:\> Remove-GPO -Guid 50cc3e45-0b14-46dd-8b4d-afa012bc331c -Domain "contoso.com" -KeepLinks +```powershell +Remove-GPO -Guid 50cc3e45-0b14-46dd-8b4d-afa012bc331c -Domain "contoso.com" -KeepLinks ``` This command removes the GPO that has the GUID 50cc3e45-0b14-46dd-8b4d-afa012bc331c from the contoso.com domain. Because the *KeepLinks* parameter is specified, links between the GPO and all sites, and links between the GPO and all containers in the domain are preserved. ### Example 2: Remove a GPO by name -``` -PS C:\> Remove-GPO -Name "TestGPO" +```powershell +Remove-GPO -Name "TestGPO" ``` This command removes the GPO named TestGPO from the domain of the user that is running the session. @@ -51,6 +52,7 @@ Because the *KeepLinks* parameter is not specified, links between the GPO and al ## PARAMETERS ### -Confirm + Prompts you for confirmation before running the cmdlet. ```yaml @@ -69,7 +71,7 @@ Accept wildcard characters: False Specifies the domain in which you want to remove a GPO. You must specify the fully qualified domain name (FQDN) of the domain. -If you do not specify the *Domain* parameter, the domain of the computer that you are logged on to is used. +If you do not specify the **Domain** parameter, the domain of the computer that you are logged on to is used. If you specify a domain that differs from the domain of your user object, a trust must exist between the domain from which you want to remove the GPO and the domain of your user object. @@ -86,10 +88,11 @@ Accept wildcard characters: False ``` ### -Guid + Specifies the GPO to remove by its globally unique identifier (GUID). The GUID uniquely identifies the GPO. -You can also refer to the *Guid* parameter by its built-in alias, **Id**. +You can also refer to the **Guid** parameter by its built-in alias, **Id**. For more information, see [about_Aliases](????????????). ```yaml @@ -124,10 +127,10 @@ Specifies the GPO that this cmdlet removes by its display name. The display name is not guaranteed to be unique in the domain. If another GPO with the same display name exists in the domain an error occurs. -You can use the *Guid* parameter to uniquely identify a GPO. +You can use the **Guid** parameter to uniquely identify a GPO. You can also refer to the **Name** parameter by its built-in alias, **DisplayName**. -For more information, see **about_Aliases**. +For more information, see [about_Aliases](????????). ```yaml Type: System.String @@ -142,13 +145,14 @@ Accept wildcard characters: False ``` ### -Server + Specifies the name of the domain controller that this cmdlet contacts to complete the operation. You can specify either the fully qualified domain name (FQDN) or the host name. -If you do not specify the name by using the *Server* parameter, the primary domain controller (PDC) emulator is contacted. +If you do not specify the name by using the **Server** parameter, the primary domain controller (PDC) emulator is contacted. You can also refer to the *Server* parameter by its built-in alias, **DC**. -For more information, see **about_Aliases**. +For more information, see [about_Aliases](????????). ```yaml Type: System.String @@ -192,6 +196,7 @@ Collections that contain GPOs from different domains are not supported. ## OUTPUTS ### None + This cmdlet does not generate any output. ## NOTES diff --git a/docset/winserver2022-ps/grouppolicy/Remove-GPPrefRegistryValue.md b/docset/winserver2022-ps/grouppolicy/Remove-GPPrefRegistryValue.md index 74b6db5286..f1c13c2a76 100644 --- a/docset/winserver2022-ps/grouppolicy/Remove-GPPrefRegistryValue.md +++ b/docset/winserver2022-ps/grouppolicy/Remove-GPPrefRegistryValue.md @@ -11,6 +11,7 @@ title: Remove-GPPrefRegistryValue # Remove-GPPrefRegistryValue ## SYNOPSIS + Removes one or more Registry preference items from either Computer Configuration or User Configuration in a GPO. ## SYNTAX @@ -50,8 +51,8 @@ This cmdlet can take input from the pipeline: ## EXAMPLES ### Example 1: Remove all registry preference item under the specified registry -``` -PS C:\> Remove-GPPrefRegistryValue -Name "TestGPO" -Context User -Key "HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\ExampleKey" -ValueName "ValueOne" +```powershell +Remove-GPPrefRegistryValue -Name "TestGPO" -Context User -Key "HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\ExampleKey" -ValueName "ValueOne" DisplayName : TestGPO DomainName : contoso.com Owner : CONTOSO\Domain Admins @@ -68,8 +69,8 @@ WmiFilter : This command removes all Registry preference items that configure the registry value HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\ExampleKey ValueOne from User Configuration in the GPO named TestGPO. ### Example 2: Remove registry preference items that configure first-level values -``` -PS C:\> Remove-GPPrefRegistryValue -Name "TestGPO" -Context "Computer" -Key "HKLM\SOFTWARE\Microsoft\ExampleKey" +```powershell +Remove-GPPrefRegistryValue -Name "TestGPO" -Context "Computer" -Key "HKLM\SOFTWARE\Microsoft\ExampleKey" DisplayName : TestGPO DomainName : contoso.com Owner : CONTOSO\Domain Admins @@ -86,8 +87,8 @@ WmiFilter : This command removes Registry preference items that configure any first-level values under the registry key HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\ExampleKey or the key itself from Computer Configuration in the GPO named TestGPO. ### Example 3: Remove any registry preference items for all GPOs -``` -PS C:\> Get-GPO -All | Remove-GPPrefRegistryValue -Context "User" -Key "HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\ExampleKey" -ValueName "ValueOne" -ErrorAction SilentlyContinue +```powershell +Get-GPO -All | Remove-GPPrefRegistryValue -Context "User" -Key "HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\ExampleKey" -ValueName "ValueOne" -ErrorAction SilentlyContinue DisplayName : TestGPO DomainName : contoso.com Owner : CONTOSO\Domain Admins @@ -124,6 +125,7 @@ For more information about the *ErrorAction* parameter, see about_CommonParamete ## PARAMETERS ### -Confirm + Prompts you for confirmation before running the cmdlet. ```yaml @@ -156,12 +158,13 @@ Accept wildcard characters: False ``` ### -Domain + Specifies the domain for which this cmdlet runs the operation. You must specify the fully qualified domain name (FQDN) of the domain. For the **Remove-GPPrefRegistryValue** cmdlet, the GPO from which to remove the Registry preference item or items must exist in this domain. -If you do not specify the *Domain* parameter, the domain of the user that is running the current session is used. +If you do not specify the **Domain** parameter, the domain of the user that is running the current session is used. (If the cmdlet is being run from a computer startup or shutdown script, the domain of the computer is used.) For more information, see the Notes section in the full Help. If you specify a domain that is different from the domain of the user that is running the current session, a trust must exist between that domain and the domain of the user or the computer. @@ -182,10 +185,11 @@ Accept wildcard characters: False ``` ### -Guid + Specifies the GPO from which to remove the Registry preference item by its globally unique identifier (GUID). The GUID uniquely identifies the GPO. -You can also refer to the *Guid* parameter by its built-in alias, **Id**. +You can also refer to the **Guid** parameter by its built-in alias, **Id**. ```yaml Type: Guid @@ -262,10 +266,11 @@ Accept wildcard characters: False ``` ### -Server + Specifies the name of the domain controller that this cmdlet contacts to complete the operation. You can specify either the fully qualified domain name (FQDN) or the host name. -If you do not specify the name by using the *Server* parameter, the primary domain controller (PDC) emulator is contacted. +If you do not specify the name by using the **Server** parameter, the primary domain controller (PDC) emulator is contacted. You can also refer to the *Server* parameter by its built-in alias, **DC**. @@ -334,7 +339,7 @@ This cmdlet returns the GPO from which the Registry preference item or items tha ## NOTES -* You can use the *Domain* parameter to explicitly specify the domain for this cmdlet. +* You can use the **Domain** parameter to explicitly specify the domain for this cmdlet. If you do not explicitly specify the domain, the cmdlet uses a default domain. The default domain is the domain that is used to access network resources by the security context under which the current session is running. diff --git a/docset/winserver2022-ps/grouppolicy/Remove-GPRegistryValue.md b/docset/winserver2022-ps/grouppolicy/Remove-GPRegistryValue.md index 02ae68e1c6..d966a4afb1 100644 --- a/docset/winserver2022-ps/grouppolicy/Remove-GPRegistryValue.md +++ b/docset/winserver2022-ps/grouppolicy/Remove-GPRegistryValue.md @@ -11,6 +11,7 @@ title: Remove-GPRegistryValue # Remove-GPRegistryValue ## SYNOPSIS + Removes one or more registry-based policy settings from either Computer Configuration or User Configuration in a GPO. ## SYNTAX @@ -49,8 +50,8 @@ This cmdlet can take input from the pipeline: ## EXAMPLES ### Example 1: Remove a registry-based policy setting under the specified registry key -``` -PS C:\> Remove-GPRegistryValue -Name "TestGPO" -Key "HKCU\Software\Policies\Microsoft\Windows\Control Panel\Desktop" -ValueName "ScreenSaveTimeOut" +```powershell +Remove-GPRegistryValue -Name "TestGPO" -Key "HKCU\Software\Policies\Microsoft\Windows\Control Panel\Desktop" -ValueName "ScreenSaveTimeOut" DisplayName : TestGPO DomainName : contoso.com Owner : CONTOSO\Domain Admins @@ -70,8 +71,8 @@ Removing a policy setting does not delete the registry value on a client. To delete the registry value when the GPO is applied on a client, you must disable the policy setting by using the **Set-GPRegistryValue** cmdlet. ### Example 2: Remove all the registry-based policy settings under the specified registry key -``` -PS C:\> Remove-GPRegistryValue -Name "TestGPO" -Key "HKCU\Software\Policies\Microsoft\ExampleKey" +```powershell +Remove-GPRegistryValue -Name "TestGPO" -Key "HKCU\Software\Policies\Microsoft\ExampleKey" ``` This command removes all the registry-based policy settings that configure first-level registry values under the key HKEY_CURRENT_USER\Software\Policies\Microsoft\ExampleKey from User Configuration in the GPO named TestGPO. @@ -80,6 +81,7 @@ If there are registry-based policy settings in User Configuration that configure ## PARAMETERS ### -Confirm + Prompts you for confirmation before running the cmdlet. ```yaml @@ -95,12 +97,13 @@ Accept wildcard characters: False ``` ### -Domain + Specifies the domain for this cmdlet. You must specify the fully qualified domain name (FQDN) of the domain. For the **Remove-GPRegistryValue** cmdlet, the GPO from which to remove the registry-based policy setting must exist in this domain. -If you do not specify the *Domain* parameter, the domain of the user that is running the current session is used. +If you do not specify the **Domain** parameter, the domain of the user that is running the current session is used. If the cmdlet is being run from a computer startup or shutdown script, the domain of the computer is used. For more information, see the Notes section in the full Help. @@ -122,10 +125,11 @@ Accept wildcard characters: False ``` ### -Guid + Specifies the GPO from which to remove the registry-based policy setting by its globally unique identifier (GUID). The GUID uniquely identifies the GPO. -You can also refer to the *Guid* parameter by its built-in alias, **Id**. +You can also refer to the **Guid** parameter by its built-in alias, **Id**. ```yaml Type: Guid @@ -174,7 +178,7 @@ Specifies the GPO from which to remove the registry-based policy setting by its The display name is not guaranteed to be unique in the domain. If another GPO with the same display name exists in the domain an error occurs. -You can use the *Guid* parameter to uniquely identify a GPO. +You can use the **Guid** parameter to uniquely identify a GPO. You can also refer to the **Name** parameter by its built-in alias, **DisplayName**. @@ -191,10 +195,11 @@ Accept wildcard characters: False ``` ### -Server + Specifies the name of the domain controller that this cmdlet contacts to complete the operation. You can specify either the fully qualified domain name (FQDN) or the host name. -If you do not specify the name by using the *Server* parameter, the primary domain controller (PDC) emulator is contacted. +If you do not specify the name by using the **Server** parameter, the primary domain controller (PDC) emulator is contacted. You can also refer to the *Server* parameter by its built-in alias, **DC**. @@ -265,7 +270,7 @@ This cmdlet returns the GPO from which the registry-based policy setting (or set If a value for the registry key cannot be located (the registry key is not configured) or if subkeys are present, an error occurs and a corresponding error message is displayed. - You can use the *Domain* parameter to explicitly specify the domain for this cmdlet. + You can use the **Domain** parameter to explicitly specify the domain for this cmdlet. If you do not explicitly specify the domain, the cmdlet uses a default domain. The default domain is the domain that is used to access network resources by the security context under which the current session is running. diff --git a/docset/winserver2022-ps/grouppolicy/Rename-GPO.md b/docset/winserver2022-ps/grouppolicy/Rename-GPO.md index 091e8aa30c..bcb37ea9b8 100644 --- a/docset/winserver2022-ps/grouppolicy/Rename-GPO.md +++ b/docset/winserver2022-ps/grouppolicy/Rename-GPO.md @@ -11,6 +11,7 @@ title: Rename-GPO # Rename-GPO ## SYNOPSIS + Assigns a new display name to a GPO. ## SYNTAX @@ -34,8 +35,8 @@ This cmdlet has no effect on the GUID of the GPO. ## EXAMPLES ### Example 1: Rename a GPO -``` -PS C:\> Rename-GPO -Name "SampleGPO" -TargetName "SecurityGPO" +```powershell +Rename-GPO -Name "SampleGPO" -TargetName "SecurityGPO" DisplayName : securityGPO DomainName : contoso.com Owner : CONTOSO\Domain Admins @@ -54,6 +55,7 @@ This command renames the GPO named SampleGPO to SecurityGPO. ## PARAMETERS ### -Confirm + Prompts you for confirmation before running the cmdlet. ```yaml @@ -69,12 +71,13 @@ Accept wildcard characters: False ``` ### -Domain + Specifies the domain for this cmdlet. You must specify the fully qualified domain name (FQDN) of the domain. For the **Rename-GPO** cmdlet, this is the domain of the GPO that you want to rename. -If you do not specify the *Domain* parameter, the domain of the user that is running the current session is used. +If you do not specify the **Domain** parameter, the domain of the user that is running the current session is used. If the cmdlet is being run from a computer startup or shutdown script, the domain of the computer is used. For more information, see the Notes section in the full Help. @@ -96,10 +99,11 @@ Accept wildcard characters: False ``` ### -Guid + Specifies the GPO to rename by its globally unique identifier (GUID). The GUID uniquely identifies the GPO. -You can also refer to the *Guid* parameter by its built-in alias, **Id**. +You can also refer to the **Guid** parameter by its built-in alias, **Id**. ```yaml Type: Guid @@ -118,7 +122,7 @@ Specifies the GPO to rename by its current display name. The display name is not guaranteed to be unique in the domain. If another GPO with the same display name exists in the domain, an error occurs. -You can use the *Guid* parameter to uniquely identify a GPO. +You can use the **Guid** parameter to uniquely identify a GPO. You can also refer to the Name parameter by its built-in alias, **DisplayName**. @@ -135,10 +139,11 @@ Accept wildcard characters: False ``` ### -Server + Specifies the name of the domain controller that this cmdlet contacts to complete the operation. You can specify either the fully qualified domain name (FQDN) or the host name. -If you do not specify the name by using the *Server* parameter, the primary domain controller (PDC) emulator is contacted. +If you do not specify the name by using the **Server** parameter, the primary domain controller (PDC) emulator is contacted. You can also refer to the *Server* parameter by its built-in alias, **DC**. @@ -205,7 +210,7 @@ This cmdlet returns the GPO with the new display name. ## NOTES -* You can use the *Domain* parameter to explicitly specify the domain for this cmdlet. +* You can use the **Domain** parameter to explicitly specify the domain for this cmdlet. If you do not explicitly specify the domain, the cmdlet uses a default domain. The default domain is the domain that is used to access network resources by the security context under which the current session is running. diff --git a/docset/winserver2022-ps/grouppolicy/Restore-GPO.md b/docset/winserver2022-ps/grouppolicy/Restore-GPO.md index bb9ae259ee..486d1eb163 100644 --- a/docset/winserver2022-ps/grouppolicy/Restore-GPO.md +++ b/docset/winserver2022-ps/grouppolicy/Restore-GPO.md @@ -11,6 +11,7 @@ title: Restore-GPO # Restore-GPO ## SYNOPSIS + Restores one GPO or all GPOs in a domain from one or more GPO backup files. ## SYNTAX @@ -45,9 +46,9 @@ If the original domain is not available, or if the GPO no longer exists in the d You can: -- Use the *Guid* parameter or the *Name* parameter to restore a GPO from its most recent backup. +- Use the **Guid** parameter or the *Name* parameter to restore a GPO from its most recent backup. -- Use the *All* parameter to restore all GPOs in the domain from their most recent backups. +- Use the **All** parameter to restore all GPOs in the domain from their most recent backups. - Use the *BackupId* parameter to restore a GPO from a specific backup. This parameter enables you to restore a GPO from a backup prior to the most recent one. @@ -55,24 +56,24 @@ This parameter enables you to restore a GPO from a backup prior to the most rece ## EXAMPLES ### Example 1: Restore a GPO from a directory -``` -PS C:\> Restore-GPO -Name "TestGPO" -Path "\\Server1\Backups" +```powershell +Restore-GPO -Name "TestGPO" -Path "\\Server1\Backups" ``` This command restores the GPO named TestGPO from the \\\\Server1\Backups directory. The most recent backup is restored. ### Example 2: Restore a GPO from a directory using the GPOs GUID -``` -PS C:\> Restore-GPO -GUID fa4a9473-6e2a-4b87-ab78-175e68d97bde -Path "\\Server1\Backups" +```powershell +Restore-GPO -GUID fa4a9473-6e2a-4b87-ab78-175e68d97bde -Path "\\Server1\Backups" ``` This command restores the GPO with the GUID fa4a9473-6e2a-4b87-ab78-175e68d97bde from the \\\\Server1\Backups directory. The most recent backup is restored. ### Example 3: Restore all GPOs in a domain that were previously backed up to a directory -``` -PS C:\> Restore-GPO -All -Domain "contoso.com" -Path "\\Server1\Backups" +```powershell +Restore-GPO -All -Domain "contoso.com" -Path "\\Server1\Backups" ``` This command restores all of the GPOs in the contoso.com domain previously backed up to \\\\Server1\Backup. @@ -81,8 +82,8 @@ Each GPO is restored using its most recent backup. If the domain of user that is running the session (or, for a startup or shutdown script, the domain of the computer) is different from the contoso.com domain, a trust must exist between the two domains or the command fails. ### Example 4: Restore a GPO using its backup ID -``` -PS C:\> Restore-GPO -BackupId 0fc29b3c-fb83-4076-babb-6194c1b4fc26 -Path "\\Server1\Backups" +```powershell +Restore-GPO -BackupId 0fc29b3c-fb83-4076-babb-6194c1b4fc26 -Path "\\Server1\Backups" ``` This command restores a GPO from the backup specified by the *BackupId* parameter. @@ -91,6 +92,7 @@ The *BackupId* parameter can be used to restore a GPO from a backup prior to the ## PARAMETERS ### -All + Indicates that the cmdlet restores all GPOs in the domain that have backups in the backup directory. Each GPO is restored from its most recent backup in the directory. @@ -126,6 +128,7 @@ Accept wildcard characters: False ``` ### -Confirm + Prompts you for confirmation before running the cmdlet. ```yaml @@ -141,13 +144,14 @@ Accept wildcard characters: False ``` ### -Domain + Specifies the domain for this cmdlet. You must specify the fully qualified domain name (FQDN) of the domain. For the **Restore-GPO** cmdlet, this is the domain in which you want to restore the GPO. This must be the domain from which the GPO was backed up. -If you do not specify the *Domain* parameter, the domain of the user that is running the current session is used. +If you do not specify the **Domain** parameter, the domain of the user that is running the current session is used. If the cmdlet is being run from a computer startup or shutdown script, the domain of the computer is used. For more information, see the Notes section in the full Help. @@ -169,13 +173,14 @@ Accept wildcard characters: False ``` ### -Guid + Specifies the GPO to restore by its globally unique identifier (GUID). The GUID uniquely identifies the GPO. The GPO is restored from its most recent backup in the backup directory. To specify a different backup than the most recent backup, use the *BackupId* parameter. -You can also refer to the *Guid* parameter by its built-in alias, **Id**. +You can also refer to the **Guid** parameter by its built-in alias, **Id**. ```yaml Type: Guid @@ -196,7 +201,7 @@ To specify a different backup than the most recent backup, use the BackupId para The display name is not guaranteed to be unique in the domain. If another GPO with the same display name exists in the domain an error occurs. -You can use the *Guid* parameter to uniquely identify a GPO. +You can use the **Guid** parameter to uniquely identify a GPO. You can also refer to the Name parameter by its built-in alias, **DisplayName**. @@ -213,9 +218,10 @@ Accept wildcard characters: False ``` ### -Path + Specifies the path to the backup directory. -You can also refer to the *Path* parameter by its built-in alias, backuplocation. +You can also refer to the **Path** parameter by its built-in alias, backuplocation. ```yaml Type: System.String @@ -230,10 +236,11 @@ Accept wildcard characters: False ``` ### -Server + Specifies the name of the domain controller that this cmdlet contacts to complete the operation. You can specify either the fully qualified domain name (FQDN) or the host name. -If you do not specify the name by using the *Server* parameter, the primary domain controller (PDC) emulator is contacted. +If you do not specify the name by using the **Server** parameter, the primary domain controller (PDC) emulator is contacted. You can also refer to the *Server* parameter by its built-in alias, **DC**. @@ -283,7 +290,7 @@ This cmdlet returns the restored GPO. ## NOTES -* You can use the *Domain* parameter to explicitly specify the domain for this cmdlet. +* You can use the **Domain** parameter to explicitly specify the domain for this cmdlet. If you do not explicitly specify the domain, the cmdlet uses a default domain. The default domain is the domain that is used to access network resources by the security context under which the current session is running. diff --git a/docset/winserver2022-ps/grouppolicy/Set-GPInheritance.md b/docset/winserver2022-ps/grouppolicy/Set-GPInheritance.md index 1f9bb13edc..d2c9969a10 100644 --- a/docset/winserver2022-ps/grouppolicy/Set-GPInheritance.md +++ b/docset/winserver2022-ps/grouppolicy/Set-GPInheritance.md @@ -11,6 +11,7 @@ title: Set-GPInheritance # Set-GPInheritance ## SYNOPSIS + Blocks or unblocks inheritance for a specified domain or organizational unit. ## SYNTAX @@ -32,8 +33,8 @@ You use the *Target* parameter to specify the Lightweight Directory Access Proto ## EXAMPLES ### Example 1: Block inheritance for a OU in a domain -``` -PS C:\> Set-GPInheritance -Target "ou=MyOU,dc=contoso,dc=com" -IsBlocked Yes +```powershell +Set-GPInheritance -Target "ou=MyOU,dc=contoso,dc=com" -IsBlocked Yes Name : myou ContainerType : OU Path : ou=myou,dc=contoso,dc=com @@ -48,16 +49,16 @@ GPOs that are linked to higher-level sites or domains, or to OUs that are parent Because inheritance is blocked, only GPOs that are linked directly to the MyOU, and those that are enforced at higher-level containers, appear in the InheritedGpoLinks list. ### Example 2: Unblock inheritance for a domain -``` -PS C:\> Set-GPInheritance -Target "dc=northwest, dc=contoso, dc=com" -IsBlocked No +```powershell +Set-GPInheritance -Target "dc=northwest, dc=contoso, dc=com" -IsBlocked No ``` This command unblocks inheritance for the northwest.contoso.com domain. GPOs linked to higher-level sites or domains are applied to this domain when Group Policy is processed on the client. ### Example 3: Unblock inheritance for an OU in a domain -``` -PS C:\> Set-GPInheritance -Target "ou=MyOU,dc=contoso,dc=com" -IsBlocked No +```powershell +Set-GPInheritance -Target "ou=MyOU,dc=contoso,dc=com" -IsBlocked No Name : myou ContainerType : OU @@ -76,6 +77,7 @@ For instance, the Default Domain Policy GPO is linked at the domain level. ## PARAMETERS ### -Confirm + Prompts you for confirmation before running the cmdlet. ```yaml @@ -91,13 +93,14 @@ Accept wildcard characters: False ``` ### -Domain + Specifies the domain for this cmdlet. You must specify the fully qualified domain name (FQDN) of the domain. For the **Set-GPInheritance** cmdlet, this is typically the domain of the Active Directory container (domain or OU) for which you want to block or unblock inheritance. If the domain for the cmdlet is different than the domain of the container, a trust must exist between the two domains. -If you do not specify the *Domain* parameter, the domain of the user that is running the current session is used. +If you do not specify the **Domain** parameter, the domain of the user that is running the current session is used. If the cmdlet is being run from a computer startup or shutdown script, the domain of the computer is used. For more information, see the Notes section in the full Help. @@ -138,10 +141,11 @@ Accept wildcard characters: False ``` ### -Server + Specifies the name of the domain controller that this cmdlet contacts to complete the operation. You can specify either the fully qualified domain name (FQDN) or the host name. -If you do not specify the name by using the *Server* parameter, the primary domain controller (PDC) emulator is contacted. +If you do not specify the name by using the **Server** parameter, the primary domain controller (PDC) emulator is contacted. You can also refer to the **Server** parameter by its built-in alias, **DC**. @@ -212,7 +216,7 @@ The **GpoInheritanceBlocked** property indicates whether inheritance is blocked. * GPO links that are enforced cannot be blocked. This cmdlet should be used sparingly. Casual use of this cmdlet can complicate troubleshooting. - You can use the *Domain* parameter to explicitly specify the domain for this cmdlet. + You can use the **Domain** parameter to explicitly specify the domain for this cmdlet. If you do not explicitly specify the domain, the cmdlet uses a default domain. The default domain is the domain that is used to access network resources by the security context under which the current session is running. diff --git a/docset/winserver2022-ps/grouppolicy/Set-GPLink.md b/docset/winserver2022-ps/grouppolicy/Set-GPLink.md index b8836d0ff0..cdf768eedb 100644 --- a/docset/winserver2022-ps/grouppolicy/Set-GPLink.md +++ b/docset/winserver2022-ps/grouppolicy/Set-GPLink.md @@ -11,6 +11,7 @@ title: Set-GPLink # Set-GPLink ## SYNOPSIS + Sets the properties of the specified GPO link. ## SYNTAX @@ -44,8 +45,8 @@ The order specifies the precedence that the settings of the GPO take over confli ## EXAMPLES ### Example 1: Enable the link between a GPO and OU -``` -PS C:\> Set-GPLink -Name TestGPO -Target "ou=MyOU,dc=contoso,dc=com" -LinkEnabled Yes +```powershell +Set-GPLink -Name TestGPO -Target "ou=MyOU,dc=contoso,dc=com" -LinkEnabled Yes GpoId : c25daa3e-5d05-43b3-87ca-0a237882fd63 DisplayName : Test2GPO Enabled : True @@ -58,8 +59,8 @@ This command enables the link between the GPO named TestGPO and the MyOU organiz The Enforced and Order properties are not changed. ### Example 2: Enable the link between a GPO and two domains -``` -PS C:\> Set-GPLink -Name TestGPO -Domain north.contoso.com -Target "dc=south, dc=contoso, dc=com" -LinkEnabled Yes -Enforced Yes -Order 1 +```powershell +Set-GPLink -Name TestGPO -Domain north.contoso.com -Target "dc=south, dc=contoso, dc=com" -LinkEnabled Yes -Enforced Yes -Order 1 ``` This command enables the link between the GPO named TestGPO in the north.contoso.com domain and the south.contoso.com domain. @@ -67,8 +68,8 @@ The link is set to enforced, so it cannot be blocked at lower-level containers ( Because the order is set to 1, the settings of TestGPO is applied with the highest precedence (except for enforced links) when Group policy is processed for the south.contoso.com domain container. ### Example 3: Set the enforced property of a link between a GPO and a test site -``` -PS C:\> Set-GPLink -Guid 77c5285d-952e-4559-94ef-a02f5c107799 -Target "Test-Site" -Enforced Yes +```powershell +Set-GPLink -Guid 77c5285d-952e-4559-94ef-a02f5c107799 -Target "Test-Site" -Enforced Yes GpoId : 77c5285d-952e-4559-94ef-a02f5c107799 DisplayName : TestGPO Enabled : True @@ -83,6 +84,7 @@ Inheritance cannot be blocked for this link at containers that are at lower-leve ## PARAMETERS ### -Confirm + Prompts you for confirmation before running the cmdlet. ```yaml @@ -98,6 +100,7 @@ Accept wildcard characters: False ``` ### -Domain + Specifies the domain for this cmdlet. You must specify the fully qualified domain name (FQDN) of the domain. @@ -109,7 +112,7 @@ For the **Set-GPLink** cmdlet: To specify a domain to link to, use the *Target* parameter. -If you do not specify the *Domain* parameter, the domain of the user that is running the current session is used. +If you do not specify the **Domain** parameter, the domain of the user that is running the current session is used. If the cmdlet is being run from a computer startup or shutdown script, the domain of the computer is used. For more information, see the Notes section in the full Help. @@ -160,10 +163,11 @@ Accept wildcard characters: False ``` ### -Guid + Specifies the GPO of the link by its globally unique identifier (GUID). The GUID uniquely identifies the GPO. -You can also refer to the *Guid* parameter by its built-in alias, **Id**. +You can also refer to the **Guid** parameter by its built-in alias, **Id**. ```yaml Type: Guid @@ -204,7 +208,7 @@ Specifies the GPO of the link by its display name. The display name is not guaranteed to be unique in the domain. If another GPO with the same display name exists in the domain, an error occurs. -You can use the *Guid* parameter to uniquely identify a GPO. +You can use the **Guid** parameter to uniquely identify a GPO. You can also refer to the **Name** parameter by its built-in alias, **DisplayName**. @@ -245,10 +249,11 @@ Accept wildcard characters: False ``` ### -Server + Specifies the name of the domain controller that this cmdlet contacts to complete the operation. You can specify either the fully qualified domain name (FQDN) or the host name. -If you do not specify the name by using the *Server* parameter, the primary domain controller (PDC) emulator is contacted. +If you do not specify the name by using the **Server** parameter, the primary domain controller (PDC) emulator is contacted. You can also refer to the *Server* parameter by its built-in alias, **DC**. @@ -313,7 +318,7 @@ This cmdlet returns the GPO link after the change has been applied. ## NOTES -* You can use the *Domain* parameter to explicitly specify the domain for this cmdlet. +* You can use the **Domain** parameter to explicitly specify the domain for this cmdlet. If you do not explicitly specify the domain, the cmdlet uses a default domain. The default domain is the domain that is used to access network resources by the security context under which the current session is running. diff --git a/docset/winserver2022-ps/grouppolicy/Set-GPPermission.md b/docset/winserver2022-ps/grouppolicy/Set-GPPermission.md index 4946bfbde8..19dc0adbbf 100644 --- a/docset/winserver2022-ps/grouppolicy/Set-GPPermission.md +++ b/docset/winserver2022-ps/grouppolicy/Set-GPPermission.md @@ -11,6 +11,7 @@ title: Set-GPPermission # Set-GPPermission ## SYNOPSIS + Grants a level of permissions to a security principal for one GPO or all the GPOs in a domain. ## SYNTAX @@ -37,8 +38,8 @@ Set-GPPermission -PermissionLevel -TargetName -Targe ## DESCRIPTION The **Set-GPPermission** cmdlet grants a level of permissions to a security principal (user, security group, or computer) for one Group Policy Object (GPO) or all the GPOs in a domain. -You use the *TargetName* and *TargetType* parameters to specify a user, security group, or computer for which to set the permission level. -You can use the *Name* or the *Guid* parameter to set the permission level for the security principal on a single GPO, or you can use the *All* parameter to set the permission level for the security principal on all GPOs in the domain. +You use the **TargetName** and *TargetType* parameters to specify a user, security group, or computer for which to set the permission level. +You can use the *Name* or the **Guid** parameter to set the permission level for the security principal on a single GPO, or you can use the **All** parameter to set the permission level for the security principal on all GPOs in the domain. By default, if the security principal already has a higher permission level than the specified permission level, the change is not applied. You can specify the *Replace* parameter, to remove the existing permission level from the GPO before the new permission level is set. @@ -47,16 +48,16 @@ This ensures that the existing permission level is replaced by the new permissio ## EXAMPLES ### Example 1: Set the permission level for a security group belonging to a GPO -``` -PS C:\> Set-GPPermission -Name TestGpo -TargetName "Domain Users" -TargetType Group -PermissionLevel GpoRead +```powershell +Set-GPPermission -Name TestGpo -TargetName "Domain Users" -TargetType Group -PermissionLevel GpoRead ``` This command sets the permission level for the Domain Users security group to GpoRead for the GPO named TestGpo. Because the *Replace* parameter is not specified, if the group already has a permission level higher than GpoRead, such as GpoEdit, no action is taken. ### Example 2: Set the permission level for a security group that belongs to all GPOs -``` -PS C:\> Set-GPPermission -All -TargetName "Marketing Admins" -TargetType Group -PermissionLevel GpoEdit -Replace +```powershell +Set-GPPermission -All -TargetName "Marketing Admins" -TargetType Group -PermissionLevel GpoEdit -Replace ``` This command sets the permission level for the Marketing Admins security group to GpoEdit on all GPOs in the domain. @@ -64,8 +65,8 @@ This includes GPOs that are not linked to any site, domain, or OU. Because the *Replace* parameter is specified, the new permission level overwrites the existing permissions set for the group. ### Example 3: Replace the permission level of a security group for all GPOs on which the group has permissions -``` -PS C:\> Get-GPO -All | ForEach-Object { if($_ | Get-GPPermission -TargetName "Marketing Admins" -TargetType Group -ErrorAction SilentlyContinue) {$_ | Set-GPPermission -Replace -PermissionLevel GpoApply -TargetName "Marketing Admins" -TargetType Group }} +```powershell +Get-GPO -All | ForEach-Object { if($_ | Get-GPPermission -TargetName "Marketing Admins" -TargetType Group -ErrorAction SilentlyContinue) {$_ | Set-GPPermission -Replace -PermissionLevel GpoApply -TargetName "Marketing Admins" -TargetType Group }} DisplayName : TestGPO DomainName : contoso.com Owner : CONTOSO\Domain Admins @@ -124,6 +125,7 @@ Accept wildcard characters: False ``` ### -Confirm + Prompts you for confirmation before running the cmdlet. ```yaml @@ -166,10 +168,11 @@ Accept wildcard characters: False ``` ### -Guid + Specifies the GPO for which to set the permission level by its globally unique identifier (GUID). The GUID uniquely identifies the GPO. -You can also refer to the *Guid* parameter by its built-in alias, **Id**. +You can also refer to the **Guid** parameter by its built-in alias, **Id**. ```yaml Type: Guid @@ -184,11 +187,12 @@ Accept wildcard characters: False ``` ### -Name + Specifies the GPO for which to set the permission level by its display name. The display name is not guaranteed to be unique in the domain. If another GPO with the same display name exists in the domain, an error occurs. -You can use the *Guid* parameter to uniquely identify a GPO. +You can use the **Guid** parameter to uniquely identify a GPO. You can also refer to the Name parameter by its built-in alias, **DisplayName**. @@ -245,10 +249,11 @@ Accept wildcard characters: False ``` ### -Server + Specifies the name of the domain controller that this cmdlet contacts to complete the operation. You can specify either the fully qualified domain name (FQDN) or the host name. -If you do not specify the name by using the *Server* parameter, the primary domain controller (PDC) emulator is contacted. +If you do not specify the name by using the **Server** parameter, the primary domain controller (PDC) emulator is contacted. You can also refer to the *Server* parameter by its built-in alias, **DC**. diff --git a/docset/winserver2022-ps/grouppolicy/Set-GPPrefRegistryValue.md b/docset/winserver2022-ps/grouppolicy/Set-GPPrefRegistryValue.md index c5613937a2..fc3cbc8f02 100644 --- a/docset/winserver2022-ps/grouppolicy/Set-GPPrefRegistryValue.md +++ b/docset/winserver2022-ps/grouppolicy/Set-GPPrefRegistryValue.md @@ -11,6 +11,7 @@ title: Set-GPPrefRegistryValue # Set-GPPrefRegistryValue ## SYNOPSIS + Configures a Registry preference item under either Computer Configuration or User Configuration in a GPO. ## SYNTAX @@ -55,8 +56,8 @@ This cmdlet can take input from the pipeline: ## EXAMPLES ### Example 1: Configure a Registry preference item for a registry value for a GPO -``` -PS C:\> Set-GPPrefRegistryValue -Name "TestGPO" -Context User -Key "HKCU\Software\Policies\Microsoft\Windows\Control Panel" -ValueName "ScreenSaveIsSecure" -Value "1" -Type String -Action Update +```powershell +Set-GPPrefRegistryValue -Name "TestGPO" -Context User -Key "HKCU\Software\Policies\Microsoft\Windows\Control Panel" -ValueName "ScreenSaveIsSecure" -Value "1" -Type String -Action Update DisplayName : TestGPO DomainName : contoso.com Owner : CONTOSO\Domain Admins @@ -74,24 +75,24 @@ This command configures a Registry preference item for the registry value HKCU\S When the GPO is applied on a client, the registry value is updated with a data type of String (REG_SZ) and value data 1. ### Example 2: Configure a Registry preference item for a registry value for a GPO -``` -PS C:\> Set-GPPrefRegistryValue -Name "TestGPO" -Context User -Action Create -Key "HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\ExampleKey" -ValueName "ValueOne" -Value "NewData" -Type String +```powershell +Set-GPPrefRegistryValue -Name "TestGPO" -Context User -Action Create -Key "HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\ExampleKey" -ValueName "ValueOne" -Value "NewData" -Type String ``` This command configures a Registry preference item for the registry value HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\ExampleKey ValueOne in User Configuration for the GPO named TestGPO. When the GPO is applied on a client, the registry value is created with a data type of String (REG_SZ) and value data "NewData". ### Example 3: Configure a Registry preference item for a registry value for a GPO specified by GUID -``` -PS C:\> Set-GPPrefRegistryValue -Guid 35c12ab3-956c-45d5-973b-46b17d225f47 -Context Computer -Action Create -Key "HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\ExampleKey\ExampleKey2" +```powershell +Set-GPPrefRegistryValue -Guid 35c12ab3-956c-45d5-973b-46b17d225f47 -Context Computer -Action Create -Key "HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\ExampleKey\ExampleKey2" ``` This command configures a Registry preference item for the registry key HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\ExampleKey\ExampleKey2 in Computer Configuration in the GPO that has ID 35c12ab3-956c-45d5-973b-46b17d225f47. When the GPO is applied on a client, the registry key is created. ### Example 4: Create a disabled Registry preference item for a registry value for a GPO -``` -PS C:\> Remove-GPPrefRegistryValue -Name "TestGPO" -Context User -Key "HKLM\SOFTWARE\Microsoft\ExampleKey" -ValueName "ValueOne" | Set-GPPrefRegistryValue -Context User -Action Create -Disable -Key "HKLM\SOFTWARE\Microsoft\ExampleKey" -ValueName "ValueOne" -Value "SomeData" -Type String +```powershell +Remove-GPPrefRegistryValue -Name "TestGPO" -Context User -Key "HKLM\SOFTWARE\Microsoft\ExampleKey" -ValueName "ValueOne" | Set-GPPrefRegistryValue -Context User -Action Create -Disable -Key "HKLM\SOFTWARE\Microsoft\ExampleKey" -ValueName "ValueOne" -Value "SomeData" -Type String ``` This command creates a disabled Registry preference item for the registry value HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\ExampleKey ValueOne in User Configuration in the GPO named TestGPO. @@ -104,13 +105,13 @@ You can suppress the error message by supplying the *ErrorAction* parameter to * For more information about the ErrorAction parameter, see about_CommonParameters. ### Example 5: Configure a Registry preference item for a registry value for all GPOs -``` -PS C:\> Get-GPO -All | Remove-GPPrefRegistryValue -Context User -Key "HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\ExampleKey" -ValueName "ValueOne" -ErrorAction SilentlyContinue | Set-GPPrefRegistryValue -Context User -Action Update -Key "HKLM\SOFTWARE\Microsoft\ExampleKey" -ValueName "ValueOne" -Value "SomeData" -Type String +```powershell +Get-GPO -All | Remove-GPPrefRegistryValue -Context User -Key "HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\ExampleKey" -ValueName "ValueOne" -ErrorAction SilentlyContinue | Set-GPPrefRegistryValue -Context User -Action Update -Key "HKLM\SOFTWARE\Microsoft\ExampleKey" -ValueName "ValueOne" -Value "SomeData" -Type String ``` This command configures a Registry preference item to update the registry value HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\ExampleKey ValueOne for every GPO in the domain that previously had a Registry preference item configured for that value in User Configuration. -The command is invoked with the *All* parameter to get all the GPOs in the domain. +The command is invoked with the **All** parameter to get all the GPOs in the domain. These GPOs are piped into the **Remove-GPPrefRegistryValue** cmdlet. If the GPO contains any Registry preference items configured for the specified key, they are removed. **Remove-GPPrefRegistryValue** only outputs a GPO to the pipeline if it removes a Registry preference item from a GPO. @@ -120,8 +121,8 @@ If a GPO passed to **Remove-GPPrefRegistryValue** does not have a Registry prefe The *ErrorAction* parameter is set to SilentlyContinue to suppress the error message. ### Example 6: Copy all Registry preference items for a registry value for a GPO -``` -PS C:\> Get-GPPrefRegistryValue -Name "TestGPO" -Context User -Key "HKLM\Software\Microsoft\ExampleKey" | Set-GPPrefRegistryValue -Name "TestGPO-1" -Context Computer -Order 1 -ErrorAction SilentlyContinue +```powershell +Get-GPPrefRegistryValue -Name "TestGPO" -Context User -Key "HKLM\Software\Microsoft\ExampleKey" | Set-GPPrefRegistryValue -Name "TestGPO-1" -Context Computer -Order 1 -ErrorAction SilentlyContinue DisplayName : TestGPO-1 DomainName : contoso.com Owner : CONTOSO\Domain Admins @@ -193,6 +194,7 @@ Accept wildcard characters: False ``` ### -Confirm + Prompts you for confirmation before running the cmdlet. ```yaml @@ -248,12 +250,13 @@ Accept wildcard characters: False ``` ### -Domain + Specifies the domain for this cmdlet. You must specify the fully qualified domain name (FQDN) of the domain. For the **Set-GPPrefRegistryValue** cmdlet, the GPO for which to configure the Registry preference item must exist in this domain. -If you do not specify the *Domain* parameter, the domain of the user that is running the current session is used. +If you do not specify the **Domain** parameter, the domain of the user that is running the current session is used. If the cmdlet is being run from a computer startup or shutdown script, the domain of the computer is used. For more information, see the Notes section in the full Help. @@ -275,10 +278,11 @@ Accept wildcard characters: False ``` ### -Guid + Specifies the GPO in which to configure the Registry preference item by its globally unique identifier (GUID). The GUID uniquely identifies the GPO. -You can also refer to the *Guid* parameter by its built-in alias, **Id**. +You can also refer to the **Guid** parameter by its built-in alias, **Id**. ```yaml Type: Guid @@ -321,7 +325,7 @@ Specifies the GPO in which to configure the Registry preference item by its disp The display name is not guaranteed to be unique in the domain. If another GPO with the same display name exists in the domain, an error occurs. -You can use the *Guid* parameter to uniquely identify a GPO. +You can use the **Guid** parameter to uniquely identify a GPO. You can also refer to the **Name** parameter by its built-in alias, **DisplayName**. @@ -361,10 +365,11 @@ Accept wildcard characters: False ``` ### -Server + Specifies the name of the domain controller that this cmdlet contacts to complete the operation. You can specify either the fully qualified domain name (FQDN) or the host name. -If you do not specify the name by using the *Server* parameter, the primary domain controller (PDC) emulator is contacted. +If you do not specify the name by using the **Server** parameter, the primary domain controller (PDC) emulator is contacted. You can also refer to the *Server* parameter by its built-in alias, **DC**. @@ -485,7 +490,7 @@ This cmdlet returns the GPO in which the Registry preference item was configured ## NOTES -* You can use the *Domain* parameter to explicitly specify the domain for this cmdlet. +* You can use the **Domain** parameter to explicitly specify the domain for this cmdlet. If you do not explicitly specify the domain, the cmdlet uses a default domain. The default domain is the domain that is used to access network resources by the security context under which the current session is running. diff --git a/docset/winserver2022-ps/grouppolicy/Set-GPRegistryValue.md b/docset/winserver2022-ps/grouppolicy/Set-GPRegistryValue.md index cd278aa380..fee4390176 100644 --- a/docset/winserver2022-ps/grouppolicy/Set-GPRegistryValue.md +++ b/docset/winserver2022-ps/grouppolicy/Set-GPRegistryValue.md @@ -11,6 +11,7 @@ title: Set-GPRegistryValue # Set-GPRegistryValue ## SYNOPSIS + Configures one or more registry-based policy settings under either Computer Configuration or User Configuration in a GPO. ## SYNTAX @@ -61,8 +62,8 @@ No subkeys, or their values, are deleted on the client. ## EXAMPLES ### Example 1: Configure a registry-based policy setting for a registry value -``` -PS C:\> Set-GPRegistryValue -Name "TestGPO" -Key "HKCU\Software\Policies\Microsoft\Windows\Control Panel\Desktop" -ValueName "ScreenSaveTimeOut" -Type DWORD -Value 900 +```powershell +Set-GPRegistryValue -Name "TestGPO" -Key "HKCU\Software\Policies\Microsoft\Windows\Control Panel\Desktop" -ValueName "ScreenSaveTimeOut" -Type DWORD -Value 900 DisplayName : TestGPO DomainName : contoso.com Owner : CONTOSO\Domain Admins @@ -80,8 +81,8 @@ This command configures a registry-based policy setting for the registry value " This policy setting sets the Screen Saver timeout to 900 seconds (15 minutes) when Group Policy is applied on the client. ### Example 1: Configure a registry-based policy settings for multiple registry values -``` -PS C:\> Set-GPRegistryValue -Name "TestGPO" -Key "HKCU\Software\Policies\Microsoft\ExampleKey" -ValueName "ValueOne", "ValueTwo", "ValueThree" -Type String -Value "String 1", "String 2", "String 3" +```powershell +Set-GPRegistryValue -Name "TestGPO" -Key "HKCU\Software\Policies\Microsoft\ExampleKey" -ValueName "ValueOne", "ValueTwo", "ValueThree" -Type String -Value "String 1", "String 2", "String 3" ``` This command configures registry-based policy settings to set three registry values. @@ -95,8 +96,8 @@ When the GPO is applied on the client, the following registry values are set: "HKCU\Software\Policies\Microsoft\ExampleKey ValueThree" "String 3" ### Example 3: Configure a registry-based policy setting to set a list of registry values -``` -PS C:\> Set-GPRegistryValue -Name "TestGPO" -Key "HKCU\Software\Policies\Microsoft\ExampleKey" -ValuePrefix "MyValue" -Type String -Value "String 1", "String 2", "String 3" +```powershell +Set-GPRegistryValue -Name "TestGPO" -Key "HKCU\Software\Policies\Microsoft\ExampleKey" -ValuePrefix "MyValue" -Type String -Value "String 1", "String 2", "String 3" ``` This command configures a registry-based policy setting to set a list of three registry values. @@ -113,16 +114,16 @@ If you specify the *Additive* parameter, the list values are added to the existi The actual value names assigned to the list values depends on the number of existing list values on the client. ### Example 4: Disable registry-based policy settings for specific registry values -``` -PS C:\> Set-GPRegistryValue -Disable -Name "TestGPO" -Key "HKCU\Software\Policies\Microsoft\ExampleKey" -ValueName "ValueOne", "ValueTwo", "ValueThree" +```powershell +Set-GPRegistryValue -Disable -Name "TestGPO" -Key "HKCU\Software\Policies\Microsoft\ExampleKey" -ValueName "ValueOne", "ValueTwo", "ValueThree" ``` This command disables the registry-based policy settings, in the User Configuration section, for the specified registry values. When the GPO is applied on the client, the registry values are deleted from the registry on the client. ### Example 5: Disable registry-based policy settings for a specific registry key -``` -PS C:\> Set-GPRegistryValue -Disable -Name "TestGPO" -Key "HKCU\Software\Policies\Microsoft\ExampleKey" +```powershell +Set-GPRegistryValue -Disable -Name "TestGPO" -Key "HKCU\Software\Policies\Microsoft\ExampleKey" ``` This command disables the registry-based policy setting, in the User Configuration section, for the specified registry key. @@ -152,6 +153,7 @@ Accept wildcard characters: False ``` ### -Confirm + Prompts you for confirmation before running the cmdlet. ```yaml @@ -195,12 +197,13 @@ Accept wildcard characters: False ``` ### -Domain + Specifies the domain for this cmdlet. You must specify the fully qualified domain name (FQDN) of the domain. For the **Set-GPRegistryValue** cmdlet, the GPO in which to configure the registry-based policy setting must exist in this domain. -If you do not specify the *Domain* parameter, the domain of the user that is running the current session is used. +If you do not specify the **Domain** parameter, the domain of the user that is running the current session is used. If the cmdlet is being run from a computer startup or shutdown script, the domain of the computer is used. For more information, see the Notes section in the full Help. @@ -222,10 +225,11 @@ Accept wildcard characters: False ``` ### -Guid + Specifies the GPO in which to configure the registry-based policy setting by its globally unique identifier (GUID). The GUID uniquely identifies the GPO. -You can also refer to the *Guid* parameter by its built-in alias, **Id**. +You can also refer to the **Guid** parameter by its built-in alias, **Id**. ```yaml Type: Guid @@ -267,7 +271,7 @@ Specifies the GPO in which to configure the registry-based policy setting by its The display name is not guaranteed to be unique in the domain. If another GPO with the same display name exists in the domain, an error occurs. -You can use the *Guid* parameter to uniquely identify a GPO. +You can use the **Guid** parameter to uniquely identify a GPO. You can also refer to the **Name** parameter by its built-in alias, **DisplayName**. @@ -284,10 +288,11 @@ Accept wildcard characters: False ``` ### -Server + Specifies the name of the domain controller that this cmdlet contacts to complete the operation. You can specify either the fully qualified domain name (FQDN) or the host name. -If you do not specify the name by using the *Server* parameter, the primary domain controller (PDC) emulator is contacted. +If you do not specify the name by using the **Server** parameter, the primary domain controller (PDC) emulator is contacted. You can also refer to the *Server* parameter by its built-in alias, **DC**. @@ -442,7 +447,7 @@ This cmdlet returns the GPO in which the registry-based policy setting has been * The hive of the registry key that you specify, HKEY_LOCAL_MACHINE (HKLM) or HKEY_CURRENT_USER (HKCU), determines whether the registry-based policy setting is in Computer Configuration or User Configuration. - You can use the *Domain* parameter to explicitly specify the domain for this cmdlet. + You can use the **Domain** parameter to explicitly specify the domain for this cmdlet. If you do not explicitly specify the domain, the cmdlet uses a default domain. The default domain is the domain that is used to access network resources by the security context under which the current session is running. From cfcbce775d5b40d8451bece935e89af562b26d1d Mon Sep 17 00:00:00 2001 From: "Mikey Lombardi (He/Him)" Date: Mon, 1 May 2023 10:40:55 -0500 Subject: [PATCH 222/650] Apply suggestions from code review --- .../adcsdeployment/Uninstall-AdcsCertificationAuthority.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/adcsdeployment/Uninstall-AdcsCertificationAuthority.md b/docset/winserver2022-ps/adcsdeployment/Uninstall-AdcsCertificationAuthority.md index e9eeb9fb6c..1b874b58ba 100644 --- a/docset/winserver2022-ps/adcsdeployment/Uninstall-AdcsCertificationAuthority.md +++ b/docset/winserver2022-ps/adcsdeployment/Uninstall-AdcsCertificationAuthority.md @@ -105,7 +105,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES - To uninstall the CA role service, ensure you run Windows PowerShell as an administrator. You can - run the command with the *Force* parameter to bypass the prompt for confirmation. + run the command with the **Force** parameter to bypass the prompt for confirmation. ## RELATED LINKS From 50d0ffe8dc2f34c95e7c219f6af47e40dd18765d Mon Sep 17 00:00:00 2001 From: Michael Date: Mon, 1 May 2023 09:55:48 -0700 Subject: [PATCH 223/650] Update docset/winserver2022-ps/adcsdeployment/Install-AdcsWebEnrollment.md Co-authored-by: Mikey Lombardi (He/Him) --- .../adcsdeployment/Install-AdcsWebEnrollment.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/adcsdeployment/Install-AdcsWebEnrollment.md b/docset/winserver2022-ps/adcsdeployment/Install-AdcsWebEnrollment.md index c0be238bf9..cd9a0a5731 100644 --- a/docset/winserver2022-ps/adcsdeployment/Install-AdcsWebEnrollment.md +++ b/docset/winserver2022-ps/adcsdeployment/Install-AdcsWebEnrollment.md @@ -91,7 +91,7 @@ Accept wildcard characters: False ### -Credential -Specifies a `PSCredential` object for the CA Web Enrollment. To obtain a credential object, use the +Specifies a **PSCredential** object for the CA Web Enrollment. To obtain a credential object, use the `Get-Credential` cmdlet. For more information, type `Get-Help Get-Credential`. If the Web Enrollment service is configured to use Standalone CA, then an account that is a member of the local Administrators on the CA is required. If the Web Enrollment service is configured to use an From b5f5f87873c0f3702f1255da81b02968961332c4 Mon Sep 17 00:00:00 2001 From: Michael Date: Mon, 1 May 2023 09:56:55 -0700 Subject: [PATCH 224/650] Update docset/winserver2022-ps/adcsdeployment/Install-AdcsNetworkDeviceEnrollmentService.md Co-authored-by: Mikey Lombardi (He/Him) --- .../Install-AdcsNetworkDeviceEnrollmentService.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/adcsdeployment/Install-AdcsNetworkDeviceEnrollmentService.md b/docset/winserver2022-ps/adcsdeployment/Install-AdcsNetworkDeviceEnrollmentService.md index e97b1ee959..0142170021 100644 --- a/docset/winserver2022-ps/adcsdeployment/Install-AdcsNetworkDeviceEnrollmentService.md +++ b/docset/winserver2022-ps/adcsdeployment/Install-AdcsNetworkDeviceEnrollmentService.md @@ -76,7 +76,7 @@ Install-AdcsNetworkDeviceEnrollmentService @params ``` This command displays the default settings when NDES is using a service account without making any -changes to the configuration. This command uses the service account named `"CONTOSO\svcNDES"` that +changes to the configuration. This command uses the service account named `CONTOSO\svcNDES` that is a member of the local computer's `IIS_USRS` group. ### Example 3: Install NDES using the application pool identity From 25e48064d044ba4c6e5f05dfc5eb539a45523c85 Mon Sep 17 00:00:00 2001 From: Michael Date: Mon, 1 May 2023 09:57:03 -0700 Subject: [PATCH 225/650] Update docset/winserver2022-ps/adcsdeployment/Install-AdcsNetworkDeviceEnrollmentService.md Co-authored-by: Mikey Lombardi (He/Him) --- .../Install-AdcsNetworkDeviceEnrollmentService.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/adcsdeployment/Install-AdcsNetworkDeviceEnrollmentService.md b/docset/winserver2022-ps/adcsdeployment/Install-AdcsNetworkDeviceEnrollmentService.md index 0142170021..eb31a852d7 100644 --- a/docset/winserver2022-ps/adcsdeployment/Install-AdcsNetworkDeviceEnrollmentService.md +++ b/docset/winserver2022-ps/adcsdeployment/Install-AdcsNetworkDeviceEnrollmentService.md @@ -111,7 +111,7 @@ $params = @{ Install-AdcsNetworkDeviceEnrollmentService @params ``` -This command installs the NDES using a service account named `"CONTOSO\svcNDES"` that is a member of +This command installs the NDES using a service account named `CONTOSO\svcNDES` that is a member of the local computer's `IIS_USRS` group. The command also specifies several non-default parameters. ## PARAMETERS From 31a95091219888219d6ad53bb55b20c788340a88 Mon Sep 17 00:00:00 2001 From: Michael Date: Mon, 1 May 2023 09:57:37 -0700 Subject: [PATCH 226/650] Update docset/winserver2022-ps/adcsdeployment/Install-AdcsCertificationAuthority.md Co-authored-by: Mikey Lombardi (He/Him) --- .../adcsdeployment/Install-AdcsCertificationAuthority.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/adcsdeployment/Install-AdcsCertificationAuthority.md b/docset/winserver2022-ps/adcsdeployment/Install-AdcsCertificationAuthority.md index 696c3d9bf8..7ecd1a02a3 100644 --- a/docset/winserver2022-ps/adcsdeployment/Install-AdcsCertificationAuthority.md +++ b/docset/winserver2022-ps/adcsdeployment/Install-AdcsCertificationAuthority.md @@ -70,7 +70,7 @@ To include the Certification Authority and Certificate Templates consoles in a C must use the **IncludeManagementTools** parameter at the end of the `Install-WindowsFeature Adcs-Cert-Authority` command. -Int is equivalent to Int32 in the +**Int** is equivalent to **Int32** in the [.NET Framework](/dotnet/csharp/language-reference/builtin-types/built-in-types). ## EXAMPLES From 46245e4d1159986fd5bd9c9a65bc68a0d2d87e08 Mon Sep 17 00:00:00 2001 From: Robert Biddle Date: Mon, 1 May 2023 13:37:58 -0400 Subject: [PATCH 227/650] Update docset/winserver2022-ps/addsdeployment/Install-ADDSDomain.md Co-authored-by: Mikey Lombardi (He/Him) --- docset/winserver2022-ps/addsdeployment/Install-ADDSDomain.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/addsdeployment/Install-ADDSDomain.md b/docset/winserver2022-ps/addsdeployment/Install-ADDSDomain.md index 8a10d3d524..5fc9fcb335 100644 --- a/docset/winserver2022-ps/addsdeployment/Install-ADDSDomain.md +++ b/docset/winserver2022-ps/addsdeployment/Install-ADDSDomain.md @@ -36,7 +36,7 @@ The `Install-ADDSDomain` cmdlet installs an Active Directory domain configuratio ### Example 1: Install a new child domain ```powershell -$HashArguments = @{ +$params = @{ Credential = (Get-Credential CORP\EnterpriseAdmin1) NewDomainName = "child" ParentDomainName = "corp.contoso.com" From 1213797fb0e25e554ad84aaae1136efcc0f476fb Mon Sep 17 00:00:00 2001 From: Robert Biddle Date: Mon, 1 May 2023 13:39:04 -0400 Subject: [PATCH 228/650] Update docset/winserver2022-ps/addsdeployment/Install-ADDSDomain.md Co-authored-by: Mikey Lombardi (He/Him) --- .../addsdeployment/Install-ADDSDomain.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/docset/winserver2022-ps/addsdeployment/Install-ADDSDomain.md b/docset/winserver2022-ps/addsdeployment/Install-ADDSDomain.md index 5fc9fcb335..bf2ba49a2a 100644 --- a/docset/winserver2022-ps/addsdeployment/Install-ADDSDomain.md +++ b/docset/winserver2022-ps/addsdeployment/Install-ADDSDomain.md @@ -53,15 +53,15 @@ $params = @{ Install-ADDSDomain @HashArguments ``` -This command installs a new child domain named child.corp.contoso.com using credentials of -CORP\EnterpriseAdmin1. This command also installs a DNS server, creates a DNS delegation in the -corp.contoso.com domain, sets the domain functional level to Windows Server 2003, makes the domain -controller a global catalog server in a site named Houston, uses DC1.corp.contoso.com as the -replication source domain controller, installs the Active Directory database and SYSVOL on the `D:\` -drive. Additionally this command also installs the log files on the `E:\` drive, has the server not -automatically restart after the domain installation is complete and causes the user to be prompted -to provide and confirm the Directory Services Restore Mode (DSRM) password to complete and commit -the installation of the domain in Active Directory. +This command installs a new child domain named `child.corp.contoso.com` using credentials of +`CORP\EnterpriseAdmin1`. This command also installs a DNS server, creates a DNS delegation in the +`corp.contoso.com` domain, sets the domain functional level to Windows Server 2003, makes the +domain controller a global catalog server in a site named Houston, uses `DC1.corp.contoso.com` as +the replication source domain controller, installs the Active Directory database and SYSVOL on the +`D:\` drive. Additionally this command also installs the log files on the `E:\` drive, has the +server not automatically restart after the domain installation is complete and causes the user to +be prompted to provide and confirm the Directory Services Restore Mode (DSRM) password to complete +and commit the installation of the domain in Active Directory. ## PARAMETERS From fe0b8d640b7a1e4f3eb4c13ddf9ddbfe204d75b0 Mon Sep 17 00:00:00 2001 From: Robert Biddle Date: Mon, 1 May 2023 13:39:21 -0400 Subject: [PATCH 229/650] Update docset/winserver2022-ps/addsdeployment/Install-ADDSDomain.md Co-authored-by: Mikey Lombardi (He/Him) --- docset/winserver2022-ps/addsdeployment/Install-ADDSDomain.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docset/winserver2022-ps/addsdeployment/Install-ADDSDomain.md b/docset/winserver2022-ps/addsdeployment/Install-ADDSDomain.md index bf2ba49a2a..c800f0a35a 100644 --- a/docset/winserver2022-ps/addsdeployment/Install-ADDSDomain.md +++ b/docset/winserver2022-ps/addsdeployment/Install-ADDSDomain.md @@ -171,8 +171,8 @@ Accept wildcard characters: False ### -DnsDelegationCredential Specifies the user name and password (account credentials) for creating the DNS delegation. This -parameter is skipped if the value for the _CreateDnsDelegation_ parameter is either specified or -computed to be $false. +parameter is skipped if the value for the **CreateDnsDelegation** parameter is either specified or +computed to be `$false`. ```yaml Type: System.Management.Automation.PSCredential From 687622449dc7bca0460f37ce528746e4b30ded5d Mon Sep 17 00:00:00 2001 From: Robert Biddle Date: Mon, 1 May 2023 13:39:34 -0400 Subject: [PATCH 230/650] Update docset/winserver2022-ps/addsdeployment/Install-ADDSDomain.md Co-authored-by: Mikey Lombardi (He/Him) --- docset/winserver2022-ps/addsdeployment/Install-ADDSDomain.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/addsdeployment/Install-ADDSDomain.md b/docset/winserver2022-ps/addsdeployment/Install-ADDSDomain.md index c800f0a35a..f7dd4b7f8d 100644 --- a/docset/winserver2022-ps/addsdeployment/Install-ADDSDomain.md +++ b/docset/winserver2022-ps/addsdeployment/Install-ADDSDomain.md @@ -191,7 +191,7 @@ Accept wildcard characters: False Specifies the domain functional level of the first domain in the creation of a new forest. Supported values for this parameter can be either a valid integer or a corresponding enumerated string value. For instance, to set the domain mode level to Windows Server 2008 R2, you can specify either a value -of 4 or Win2008R2. +of `4` or `Win2008R2`. The acceptable values for this parameter are: From 79e599b57eab96c2f0478871f7319ab52521b11e Mon Sep 17 00:00:00 2001 From: Robert Biddle Date: Mon, 1 May 2023 13:39:57 -0400 Subject: [PATCH 231/650] Update docset/winserver2022-ps/addsdeployment/Install-ADDSDomain.md Co-authored-by: Mikey Lombardi (He/Him) --- docset/winserver2022-ps/addsdeployment/Install-ADDSDomain.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docset/winserver2022-ps/addsdeployment/Install-ADDSDomain.md b/docset/winserver2022-ps/addsdeployment/Install-ADDSDomain.md index f7dd4b7f8d..e3069afda0 100644 --- a/docset/winserver2022-ps/addsdeployment/Install-ADDSDomain.md +++ b/docset/winserver2022-ps/addsdeployment/Install-ADDSDomain.md @@ -221,8 +221,8 @@ Accept wildcard characters: False ### -DomainType Specifies the type of domain that this cmdlet creates. You can create a new domain tree in an -existing forest (supported values are TreeDomain or tree) or a child of an existing domain -(supported values are ChildDomain or child). The default is ChildDomain. +existing forest (supported values are `TreeDomain` or `tree`) or a child of an existing domain +(supported values are `ChildDomain` or `child`). The default is `ChildDomain`. ```yaml Type: DomainType From 74b64369cc85c4c18700f1b91df4782b9e96f964 Mon Sep 17 00:00:00 2001 From: Robert Biddle Date: Mon, 1 May 2023 13:40:13 -0400 Subject: [PATCH 232/650] Update docset/winserver2022-ps/addsdeployment/Install-ADDSDomain.md Co-authored-by: Mikey Lombardi (He/Him) --- .../addsdeployment/Install-ADDSDomain.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docset/winserver2022-ps/addsdeployment/Install-ADDSDomain.md b/docset/winserver2022-ps/addsdeployment/Install-ADDSDomain.md index e3069afda0..10818b6354 100644 --- a/docset/winserver2022-ps/addsdeployment/Install-ADDSDomain.md +++ b/docset/winserver2022-ps/addsdeployment/Install-ADDSDomain.md @@ -258,14 +258,14 @@ Accept wildcard characters: False Indicates that the cmdlet installs and configures the DNS Server service for the domain or domain tree. For domain installation, if this parameter is left unspecified and the parent domain (or in the case of a domain tree, the forest root domain) already hosts and stores the DNS names for the -domain, then the default for this parameter is $true and the DNS server is installed. Otherwise, if -DNS domain names are hosted outside of Active Directory, the default is $false and no DNS server is -installed. +domain, then the default for this parameter is `$true` and the DNS server is installed. Otherwise, +if DNS domain names are hosted outside of Active Directory, the default is `$false` and no DNS +server is installed. To test if DNS domain names are hosted outside of Active Directory, this cmdlet uses a start of -authority (SOA) type DNS query. For instance, if the value of _NewDomainName_ parameter is -corp.contoso.com, Active Directory performs an SOA query for corp.contoso.com and ensures that the -zone name in the response is corp.contoso.com. +authority (SOA) type DNS query. For instance, if the value of **NewDomainName** parameter is +`corp.contoso.com`, Active Directory performs an SOA query for `corp.contoso.com` and ensures that +the zone name in the response is `corp.contoso.com`. ```yaml Type: System.Management.Automation.SwitchParameter From 9035453a2af537ac45c34e129d0df1593f2ae8d4 Mon Sep 17 00:00:00 2001 From: Robert Biddle Date: Mon, 1 May 2023 13:40:27 -0400 Subject: [PATCH 233/650] Update docset/winserver2022-ps/addsdeployment/Install-ADDSDomain.md Co-authored-by: Mikey Lombardi (He/Him) --- .../addsdeployment/Install-ADDSDomain.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/docset/winserver2022-ps/addsdeployment/Install-ADDSDomain.md b/docset/winserver2022-ps/addsdeployment/Install-ADDSDomain.md index 10818b6354..2cadf5bfdb 100644 --- a/docset/winserver2022-ps/addsdeployment/Install-ADDSDomain.md +++ b/docset/winserver2022-ps/addsdeployment/Install-ADDSDomain.md @@ -299,10 +299,11 @@ Accept wildcard characters: False ### -NewDomainName -Specifies the new domain name that this cmdlet installs. If the value set for the _DomainType_ -parameter is set to TreeDomain, this parameter can be used to specify the fully qualified domain -name (FQDN) for the new domain tree. If the value set for the _DomainType_ parameter is set to -ChildDomain, this parameter can be used to specify a single label domain name for the child domain. +Specifies the new domain name that this cmdlet installs. If the value set for the **DomainType** +parameter is set to `TreeDomain`, this parameter can be used to specify the fully qualified domain +name (FQDN) for the new domain tree. If the value for the **DomainType** parameter is set to +`ChildDomain`, this parameter can be used to specify a single label domain name for the child +domain. ```yaml Type: System.String From a4adc231dfc10534703cd073a0d37d96ab071667 Mon Sep 17 00:00:00 2001 From: Robert Biddle Date: Mon, 1 May 2023 13:40:34 -0400 Subject: [PATCH 234/650] Update docset/winserver2022-ps/addsdeployment/Install-ADDSDomain.md Co-authored-by: Mikey Lombardi (He/Him) --- docset/winserver2022-ps/addsdeployment/Install-ADDSDomain.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/addsdeployment/Install-ADDSDomain.md b/docset/winserver2022-ps/addsdeployment/Install-ADDSDomain.md index 2cadf5bfdb..8f5ccdeeb9 100644 --- a/docset/winserver2022-ps/addsdeployment/Install-ADDSDomain.md +++ b/docset/winserver2022-ps/addsdeployment/Install-ADDSDomain.md @@ -324,7 +324,7 @@ parameter they must be single label names of 15 characters or less. If this parameter is set with a valid NetBIOS name value, then promotion continues with the name specified. If this parameter is not set, then the default is automatically computed from the value -of the _NewDomainName_ parameter. +of the **NewDomainName** parameter. For instance, if this parameter is not specified and a single-label prefix domain name of 15 characters or less is specified within the value of the _NewDomainName_ parameter, then promotion From 57fa5c4c8ba3441445079fc5dfae7ff1ffe1f088 Mon Sep 17 00:00:00 2001 From: Robert Biddle Date: Mon, 1 May 2023 13:40:43 -0400 Subject: [PATCH 235/650] Update docset/winserver2022-ps/addsdeployment/Install-ADDSDomain.md Co-authored-by: Mikey Lombardi (He/Him) --- .../winserver2022-ps/addsdeployment/Install-ADDSDomain.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docset/winserver2022-ps/addsdeployment/Install-ADDSDomain.md b/docset/winserver2022-ps/addsdeployment/Install-ADDSDomain.md index 8f5ccdeeb9..7146c385ca 100644 --- a/docset/winserver2022-ps/addsdeployment/Install-ADDSDomain.md +++ b/docset/winserver2022-ps/addsdeployment/Install-ADDSDomain.md @@ -327,9 +327,9 @@ specified. If this parameter is not set, then the default is automatically compu of the **NewDomainName** parameter. For instance, if this parameter is not specified and a single-label prefix domain name of 15 -characters or less is specified within the value of the _NewDomainName_ parameter, then promotion -continues with an automatically generated NetBIOS domain name. For example, the prefix label corp -within a full domain name value of corp.contoso.com would be a successful name choice. +characters or less is specified within the value of the **NewDomainName** parameter, then promotion +continues with an automatically generated NetBIOS domain name. For example, the prefix label `corp` +within a full domain name value of `corp.contoso.com` would be a successful name choice. Note that if the name value given for this parameter is a name of 16 characters or more, then the domain installation will fail. From 01bf3045630640a187b483d3ce7f6488f12458db Mon Sep 17 00:00:00 2001 From: Robert Biddle Date: Mon, 1 May 2023 13:40:53 -0400 Subject: [PATCH 236/650] Update docset/winserver2022-ps/addsdeployment/Install-ADDSDomain.md Co-authored-by: Mikey Lombardi (He/Him) --- .../addsdeployment/Install-ADDSDomain.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docset/winserver2022-ps/addsdeployment/Install-ADDSDomain.md b/docset/winserver2022-ps/addsdeployment/Install-ADDSDomain.md index 7146c385ca..1131f05397 100644 --- a/docset/winserver2022-ps/addsdeployment/Install-ADDSDomain.md +++ b/docset/winserver2022-ps/addsdeployment/Install-ADDSDomain.md @@ -507,11 +507,11 @@ Accept wildcard characters: False ### -SkipPreChecks Indicates that the cmdlet performs only a base set of validations. This behavior is equivalent to -the validations that were performed when using Dcpromo.exe in earlier versions of Windows Server to -add a new domain. When this switch parameter is set, it specifies that additional preliminary checks -should be bypassed. For more information on the scope of these additional preliminary checks that -the ADDSDeployment module performs by default when using Windows Server 2012, refer to the table in -the section ADPrep and Prerequisite Checking Architecture in +the validations that were performed when using `Dcpromo.exe` in earlier versions of Windows Server +to add a new domain. When this switch parameter is set, it specifies that additional preliminary +checks should be bypassed. For more information on the scope of these additional preliminary checks +that the **ADDSDeployment** module performs by default when using Windows Server 2012, refer to the +table in the section ADPrep and Prerequisite Checking Architecture in [AD DS Simplified Administration](https://go.microsoft.com/fwlink/?LinkID=237244). ```yaml From 1cf698b3a4c7e22a41a2deda27a919bb081ff981 Mon Sep 17 00:00:00 2001 From: Robert Biddle Date: Sat, 29 Apr 2023 17:10:40 -0400 Subject: [PATCH 237/650] Spelling dictionary additions --- .vscode/cspell/winmodules/dictionaries/winps.txt | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.vscode/cspell/winmodules/dictionaries/winps.txt b/.vscode/cspell/winmodules/dictionaries/winps.txt index d664bd7483..d042a7f9a0 100644 --- a/.vscode/cspell/winmodules/dictionaries/winps.txt +++ b/.vscode/cspell/winmodules/dictionaries/winps.txt @@ -1,3 +1,6 @@ ADCS +Dcpromo +DSRM NTDS RODC +Sysvol From 75710d5d6b2fc7755602b6bb747762aab33608d2 Mon Sep 17 00:00:00 2001 From: Robert Biddle Date: Sat, 29 Apr 2023 17:11:20 -0400 Subject: [PATCH 238/650] Style guidline fixes --- .../addsdeployment/Install-ADDSForest.md | 228 +++++++++++------- 1 file changed, 146 insertions(+), 82 deletions(-) diff --git a/docset/winserver2022-ps/addsdeployment/Install-ADDSForest.md b/docset/winserver2022-ps/addsdeployment/Install-ADDSForest.md index 8459cae94a..e38fb1e65b 100644 --- a/docset/winserver2022-ps/addsdeployment/Install-ADDSForest.md +++ b/docset/winserver2022-ps/addsdeployment/Install-ADDSForest.md @@ -11,44 +11,65 @@ title: Install-ADDSForest # Install-ADDSForest ## SYNOPSIS + Creates a new Active Directory forest. ## SYNTAX ``` -Install-ADDSForest [-SkipPreChecks] -DomainName [-SafeModeAdministratorPassword ] - [-CreateDnsDelegation] [-DatabasePath ] [-DnsDelegationCredential ] [-NoDnsOnNetwork] - [-DomainMode ] [-DomainNetbiosName ] [-ForestMode ] [-InstallDns] - [-LogPath ] [-NoRebootOnCompletion] [-SkipAutoConfigureDns] [-SysvolPath ] [-Force] [-WhatIf] - [-Confirm] [] +Install-ADDSForest [-SkipPreChecks] -DomainName + [-SafeModeAdministratorPassword ] [-CreateDnsDelegation] + [-DatabasePath ] [-DnsDelegationCredential ] [-NoDnsOnNetwork] + [-DomainMode ] [-DomainNetbiosName ] [-ForestMode ] + [-InstallDns] [-LogPath ] [-NoRebootOnCompletion] [-SkipAutoConfigureDns] + [-SysvolPath ] [-Force] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION -The **Install-ADDSForest** cmdlet installs an Active Directory forest configuration. + +The `Install-ADDSForest` cmdlet installs an Active Directory forest configuration. ## EXAMPLES ### Example 1: Install a new forest + ``` -PS C:\> Install-ADDSForest -DomainName "corp.contoso.com" -InstallDNS +Install-ADDSForest -DomainName "corp.contoso.com" -InstallDNS ``` -This command installs a new forest named corp.contoso.com, causes the user to be prompted to provide and confirm the Directory Services Restore Mode (DSRM) password and specifies a DNS server should also be installed during the forest installation process. +This command installs a new forest named corp.contoso.com, causes the user to be prompted to provide +and confirm the Directory Services Restore Mode (DSRM) password and specifies a DNS server should +also be installed during the forest installation process. ### Example 2: Install a new forest and a DNS delegation + ``` -PS C:\> Install-ADDSForest -DomainName "corp.contoso.com" -CreateDNSDelegation -DomainMode Win2008R2 -ForestMode Win2008R2 -DatabasePath "d:\NTDS" -SysvolPath "d:\SYSVOL" -LogPath "e:\Logs" +$HashArguments = @{ + CreateDNSDelegation = $true + DatabasePath = "d:\NTDS" + DomainMode = Win2008R2 + DomainName = "corp.contoso.com" + ForestMode = Win2008R2 + LogPath = "e:\Logs" + SysvolPath = "d:\SYSVOL" +} +Install-ADDSForest @HashArguments ``` -This command installs a new forest named corp.contoso.com, creates a DNS delegation in the contoso.com domain, sets domain functional level to Windows Server 2008 R2 and sets forest functional level to Windows Server 2008, installs the Active Directory database and SYSVOL on the D:\ drive, installs the log files on the E:\ drive and has the server automatically restart after AD DS installation is complete and prompts the user to provide and confirm the DSRM password. +This command installs a new forest named corp.contoso.com, creates a DNS delegation in the +contoso.com domain, sets domain functional level to Windows Server 2008 R2 and sets forest +functional level to Windows Server 2008, installs the Active Directory database and SYSVOL on the +`D:\` drive, installs the log files on the `E:\` drive and has the server automatically restart +after AD DS installation is complete and prompts the user to provide and confirm the DSRM password. ## PARAMETERS ### -Confirm + Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf @@ -60,12 +81,13 @@ Accept wildcard characters: False ``` ### -CreateDnsDelegation -Indicates that this cmdlet creates a DNS delegation that references the new DNS server that you install along with the domain controller. -Valid for Active Directory-integrated DNS only. -The default is computed automatically based on the environment. + +Indicates that this cmdlet creates a DNS delegation that references the new DNS server that you +install along with the domain controller. Valid for Active Directory-integrated DNS only. The +default is computed automatically based on the environment. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -77,11 +99,13 @@ Accept wildcard characters: False ``` ### -DatabasePath -Specifies the fully qualified, non-Universal Naming Convention (UNC) path to a directory on a fixed disk of the local computer that contains the domain database, for instance, C:\Databases\NTDS. -The default is %SYSTEMROOT%\NTDS. + +Specifies the fully qualified, non-Universal Naming Convention (UNC) path to a directory on a fixed +disk of the local computer that contains the domain database, for instance, `C:\Databases\NTDS`. The +default is `%SYSTEMROOT%\NTDS`. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -93,11 +117,12 @@ Accept wildcard characters: False ``` ### -DnsDelegationCredential -Specifies the user name and password for creating DNS delegation. -This parameter is skipped if the value for the *CreateDnsDelegation* parameter is either specified or computed to be $False. + +Specifies the user name and password for creating DNS delegation. This parameter is skipped if the +value for the `-CreateDnsDelegation` parameter is either specified or computed to be $False. ```yaml -Type: PSCredential +Type: System.Management.Automation.PSCredential Parameter Sets: (All) Aliases: @@ -109,9 +134,11 @@ Accept wildcard characters: False ``` ### -DomainMode -Specifies the domain functional level of the first domain in the creation of a new forest. -Supported values for this parameter can be either a valid integer or a corresponding enumerated string value. -For instance, to set the domain mode level to Windows Server 2008 R2, you can specify either a value of 4 or Win2008R2. + +Specifies the domain functional level of the first domain in the creation of a new forest. Supported +values for this parameter can be either a valid integer or a corresponding enumerated string value. +For instance, to set the domain mode level to Windows Server 2008 R2, you can specify either a value +of 4 or Win2008R2. The acceptable values for this parameter are: @@ -126,7 +153,7 @@ The domain functional level cannot be lower than the forest functional level, bu The default is automatically computed and set. ```yaml -Type: DomainMode +Type: System.DirectoryServices.ActiveDirectory.DomainMode Parameter Sets: (All) Aliases: Accepted values: Win2008, Win2008R2, Win2012, Win2012R2, WinThreshold, Default @@ -139,10 +166,11 @@ Accept wildcard characters: False ``` ### -DomainName + Specifies the fully qualified domain name (FQDN) for the root domain in the forest. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -154,19 +182,24 @@ Accept wildcard characters: False ``` ### -DomainNetbiosName -Specifies the NetBIOS name for the root domain in the new forest. -For NetBIOS names to be valid for use with this parameter they must be single label names of 15 characters or less. -If this parameter is set with a valid NetBIOS name value, then forest installation continues with the name specified. -If this parameter is not set, then the default is automatically computed from the value of the *DomainName* parameter. +Specifies the NetBIOS name for the root domain in the new forest. For NetBIOS names to be valid for +use with this parameter they must be single label names of 15 characters or less. -For example, if this parameter is not specified and a single-label prefix domain name of 15 characters or less is specified within the value of the *DomainName* parameter, then promotion continues with an automatically generated NetBIOS domain name. -For example, the prefix label corp within a full domain name value of corp.contoso.com would be a successful name choice. +If this parameter is set with a valid NetBIOS name value, then forest installation continues with +the name specified. If this parameter is not set, then the default is automatically computed from +the value of the `-DomainName` parameter. -Note that if the name value given for this parameter is a name of 16 characters or more, then the forest installation fails. +For example, if this parameter is not specified and a single-label prefix domain name of 15 +characters or less is specified within the value of the `-DomainName` parameter, then promotion +continues with an automatically generated NetBIOS domain name. For example, the prefix label corp +within a full domain name value of corp.contoso.com would be a successful name choice. + +Note that if the name value given for this parameter is a name of 16 characters or more, then the +forest installation fails. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -178,10 +211,11 @@ Accept wildcard characters: False ``` ### -Force + Forces the command to run without asking for user confirmation. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -193,9 +227,10 @@ Accept wildcard characters: False ``` ### -ForestMode -Specifies the forest functional level for the new forest. -Supported values for this parameter can be either a valid integer or a corresponding enumerated string value. -For example, to set the forest mode level to Windows Server 2008 R2, you can specify either a value of 4 or Win2008R2. + +Specifies the forest functional level for the new forest. Supported values for this parameter can be +either a valid integer or a corresponding enumerated string value. For example, to set the forest +mode level to Windows Server 2008 R2, you can specify either a value of 4 or Win2008R2. The acceptable values for this parameter are: @@ -206,11 +241,12 @@ The acceptable values for this parameter are: - Windows Server 2012 R2: 6 or Win2012R2 - Windows Server 2016: 7 or WinThreshold -The default forest functional level in Windows Server is typically the same as the version you are running. -However, the default forest functional level in Windows Server 2008 R2 when you create a new forest is Windows Server 2003 or 2. +The default forest functional level in Windows Server is typically the same as the version you are +running. However, the default forest functional level in Windows Server 2008 R2 when you create a +new forest is Windows Server 2003 or 2. ```yaml -Type: ForestMode +Type: System.DirectoryServices.ActiveDirectory.ForestMode Parameter Sets: (All) Aliases: Accepted values: Win2008, Win2008R2, Win2012, Win2012R2, WinThreshold, Default @@ -223,11 +259,12 @@ Accept wildcard characters: False ``` ### -InstallDns + Indicates that this cmdlet installs and configures the DNS Server service for the new forest. For forest installation, the default is $True. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -239,12 +276,13 @@ Accept wildcard characters: False ``` ### -LogPath -Specifies the fully qualified, non-UNC path to a directory on a fixed disk of the local computer where the log file for this operation is written. -For instance, C:\Logs. -The default log file path if no other path is specified with this parameter is %SYSTEMROOT%\NTDS. + +Specifies the fully qualified, non-UNC path to a directory on a fixed disk of the local computer +where the log file for this operation is written. For instance, `C:\Logs`. The default log file path +if no other path is specified with this parameter is `%SYSTEMROOT%\NTDS`. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -256,16 +294,19 @@ Accept wildcard characters: False ``` ### -NoDnsOnNetwork -Indicates that the DNS service is not available on the network. -This parameter is used only when the IP setting of the network adapter for this computer is not configured with the name of a DNS server for name resolution. -It indicates that a DNS server is installed on this computer for name resolution. -Otherwise, the IP settings of the network adapter must first be configured with the address of a DNS server. -Omitting this parameter indicates that the TCP/IP client settings of the network adapter on this server computer is used to contact a DNS server. -Therefore, if you do not specify this parameter, ensure that TCP/IP client settings are first configured with a preferred DNS server address. +Indicates that the DNS service is not available on the network. This parameter is used only when the +IP setting of the network adapter for this computer is not configured with the name of a DNS server +for name resolution. It indicates that a DNS server is installed on this computer for name +resolution. Otherwise, the IP settings of the network adapter must first be configured with the +address of a DNS server. + +Omitting this parameter indicates that the TCP/IP client settings of the network adapter on this +server computer is used to contact a DNS server. Therefore, if you do not specify this parameter, +ensure that TCP/IP client settings are first configured with a preferred DNS server address. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -277,12 +318,15 @@ Accept wildcard characters: False ``` ### -NoRebootOnCompletion -Indicates that the cmdlet does not reboot the computer upon completion of this command. -Omitting this parameter indicates the computer is rebooted upon completion of the command, regardless of success or failure. -As a general rule, Microsoft support recommends that you do not use this parameter except for testing or troubleshooting purposes because once configuration has completed the server will not function correctly as either a member server or a DC until it is rebooted. + +Indicates that the cmdlet does not reboot the computer upon completion of this command. Omitting +this parameter indicates the computer is rebooted upon completion of the command, regardless of +success or failure. As a general rule, Microsoft support recommends that you do not use this +parameter except for testing or troubleshooting purposes because once configuration has completed +the server will not function correctly as either a member server or a DC until it is rebooted. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -294,15 +338,19 @@ Accept wildcard characters: False ``` ### -SafeModeAdministratorPassword -Supplies the password for the administrator account when the computer is started in Safe Mode or a variant of Safe Mode, such as Directory Services Restore Mode. -You must supply a password that meets the password complexity rules of the domain and the password cannot be blank. -If specified with a value, the value must be a secure string. + +Supplies the password for the administrator account when the computer is started in Safe Mode or a +variant of Safe Mode, such as Directory Services Restore Mode. You must supply a password that meets +the password complexity rules of the domain and the password cannot be blank. If specified with a +value, the value must be a secure string. If this parameter is not specified, the cmdlet prompts you to enter and confirm a masked password. -This is the preferred usage when running the cmdlet interactively. -If additionally there are no other arguments specified with the cmdlet, you are prompted to enter a masked password for this parameter but no confirmation of the password entered is made. -This is not recommended as it could allow a mistyped password to be configured. -Another available advanced option is to use the **ConvertTo-SecureString** cmdlet and specify the password string inline as unmasked console input, which is also not a recommended security best practice in production deployments. +This is the preferred usage when running the cmdlet interactively. If additionally there are no +other arguments specified with the cmdlet, you are prompted to enter a masked password for this +parameter but no confirmation of the password entered is made. This is not recommended as it could +allow a mistyped password to be configured. Another available advanced option is to use the +`ConvertTo-SecureString` cmdlet and specify the password string inline as unmasked console input, +which is also not a recommended security best practice in production deployments. ```yaml Type: SecureString @@ -317,11 +365,12 @@ Accept wildcard characters: False ``` ### -SkipAutoConfigureDns -Indicates that the cmdlet skips automatic configuration of DNS client settings, forwarders, and root hints. -This parameter is in effect only if the DNS Server service is already installed. + +Indicates that the cmdlet skips automatic configuration of DNS client settings, forwarders, and root +hints. This parameter is in effect only if the DNS Server service is already installed. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -333,13 +382,17 @@ Accept wildcard characters: False ``` ### -SkipPreChecks -Indicates that the cmdlet performs only a base set of validations. -This behavior is equivalent to the validations that were performed when using Dcpromo.exe in earlier versions of Windows Server to add a new forest. -When this switch parameter is set, it specifies that additional preliminary checks should be bypassed. -For more information on the scope of these additional preliminary checks that the ADDSDeployment module performs by default when using Windows Server 2012, refer to the table in the section ADPrep and Prerequisite Checking Architecture in [AD DS Simplified Administration](https://go.microsoft.com/fwlink/?LinkID=237244). + +Indicates that the cmdlet performs only a base set of validations. This behavior is equivalent to +the validations that were performed when using `Dcpromo.exe` in earlier versions of Windows Server +to add a new forest. When this switch parameter is set, it specifies that additional preliminary +checks should be bypassed. For more information on the scope of these additional preliminary checks +that the ADDSDeployment module performs by default when using Windows Server 2012, refer to the +table in the section ADPrep and Prerequisite Checking Architecture in +[AD DS Simplified Administration](https://go.microsoft.com/fwlink/?LinkID=237244). ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -351,12 +404,13 @@ Accept wildcard characters: False ``` ### -SysvolPath -Specifies the fully qualified, non-UNC path to a directory on a fixed disk of the local computer where the Sysvol file is written. -For example, C:\Logs\SYSVOL. -The default path if no other path is specified with this parameter is %SYSTEMROOT%\SYSVOL. + +Specifies the fully qualified, non-UNC path to a directory on a fixed disk of the local computer +where the Sysvol file is written. For example, `C:\Logs\SYSVOL`. The default path if no other path +is specified with this parameter is `%SYSTEMROOT%\SYSVOL`. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -368,11 +422,12 @@ Accept wildcard characters: False ``` ### -WhatIf + Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi @@ -384,17 +439,27 @@ Accept wildcard characters: False ``` ### CommonParameters -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). + +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). ## INPUTS ## OUTPUTS ## NOTES -* By default, the DNS Server service is installed when you create a new forest. It is strongly recommended that you install and use the Windows DNS Server to support the needs for DNS name resolution in your Active Directory deployment. You do not need to specifically include the *InstallDNS* to install it. -* If you are using Active Directory-integrated DNS, the IP address for the preferred DNS server for the first domain controller in the forest is automatically set to the loopback address of 127.0.0.1. -This helps assure that the IP address of the first domain controller is resolved in DNS even if the address is changed. +- By default, the DNS Server service is installed when you create a new forest. It is strongly + recommended that you install and use the Windows DNS Server to support the needs for DNS name + resolution in your Active Directory deployment. You do not need to specifically include the + `-InstallDNS` to install it. + +- If you are using Active Directory-integrated DNS, the IP address for the preferred DNS server for + the first domain controller in the forest is automatically set to the loopback address of + `127.0.0.1`. This helps assure that the IP address of the first domain controller is resolved in + DNS even if the address is changed. ## RELATED LINKS @@ -405,4 +470,3 @@ This helps assure that the IP address of the first domain controller is resolved [Test-ADDSForestInstallation](./Test-ADDSForestInstallation.md) [ConvertTo-SecureString](https://go.microsoft.com/fwlink/p/?LinkId=113291) - From 0a7e2e333b43ba764dfac7eaffbf34cf3ac45351 Mon Sep 17 00:00:00 2001 From: Robert Biddle Date: Sat, 29 Apr 2023 17:55:27 -0400 Subject: [PATCH 239/650] Update Install-ADDSForest.md Adding powershell to code blocks --- docset/winserver2022-ps/addsdeployment/Install-ADDSForest.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docset/winserver2022-ps/addsdeployment/Install-ADDSForest.md b/docset/winserver2022-ps/addsdeployment/Install-ADDSForest.md index e38fb1e65b..6fe65710c3 100644 --- a/docset/winserver2022-ps/addsdeployment/Install-ADDSForest.md +++ b/docset/winserver2022-ps/addsdeployment/Install-ADDSForest.md @@ -33,7 +33,7 @@ The `Install-ADDSForest` cmdlet installs an Active Directory forest configuratio ### Example 1: Install a new forest -``` +```powershell Install-ADDSForest -DomainName "corp.contoso.com" -InstallDNS ``` @@ -43,7 +43,7 @@ also be installed during the forest installation process. ### Example 2: Install a new forest and a DNS delegation -``` +```powershell $HashArguments = @{ CreateDNSDelegation = $true DatabasePath = "d:\NTDS" From 29a677b2bc22d3e3e4f5cd86dbf525909d57c478 Mon Sep 17 00:00:00 2001 From: Robert Biddle Date: Mon, 1 May 2023 13:42:47 -0400 Subject: [PATCH 240/650] Update docset/winserver2022-ps/addsdeployment/Install-ADDSForest.md Co-authored-by: Mikey Lombardi (He/Him) --- docset/winserver2022-ps/addsdeployment/Install-ADDSForest.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/addsdeployment/Install-ADDSForest.md b/docset/winserver2022-ps/addsdeployment/Install-ADDSForest.md index 6fe65710c3..3e2f4a9772 100644 --- a/docset/winserver2022-ps/addsdeployment/Install-ADDSForest.md +++ b/docset/winserver2022-ps/addsdeployment/Install-ADDSForest.md @@ -37,7 +37,7 @@ The `Install-ADDSForest` cmdlet installs an Active Directory forest configuratio Install-ADDSForest -DomainName "corp.contoso.com" -InstallDNS ``` -This command installs a new forest named corp.contoso.com, causes the user to be prompted to provide +This command installs a new forest named `corp.contoso.com`, causes the user to be prompted to provide and confirm the Directory Services Restore Mode (DSRM) password and specifies a DNS server should also be installed during the forest installation process. From a40b3443fc72b33b58aeeb3840c53e42865dff75 Mon Sep 17 00:00:00 2001 From: Robert Biddle Date: Mon, 1 May 2023 13:48:05 -0400 Subject: [PATCH 241/650] Update docset/winserver2022-ps/addsdeployment/Install-ADDSForest.md Co-authored-by: Mikey Lombardi (He/Him) --- docset/winserver2022-ps/addsdeployment/Install-ADDSForest.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docset/winserver2022-ps/addsdeployment/Install-ADDSForest.md b/docset/winserver2022-ps/addsdeployment/Install-ADDSForest.md index 3e2f4a9772..61f55a72a6 100644 --- a/docset/winserver2022-ps/addsdeployment/Install-ADDSForest.md +++ b/docset/winserver2022-ps/addsdeployment/Install-ADDSForest.md @@ -56,8 +56,8 @@ $HashArguments = @{ Install-ADDSForest @HashArguments ``` -This command installs a new forest named corp.contoso.com, creates a DNS delegation in the -contoso.com domain, sets domain functional level to Windows Server 2008 R2 and sets forest +This command installs a new forest named `corp.contoso.com`, creates a DNS delegation in the +`contoso.com` domain, sets domain functional level to Windows Server 2008 R2 and sets forest functional level to Windows Server 2008, installs the Active Directory database and SYSVOL on the `D:\` drive, installs the log files on the `E:\` drive and has the server automatically restart after AD DS installation is complete and prompts the user to provide and confirm the DSRM password. From b5da57d9667601e9610ac80c83483f5a9e94df01 Mon Sep 17 00:00:00 2001 From: Robert Biddle Date: Mon, 1 May 2023 13:48:15 -0400 Subject: [PATCH 242/650] Update docset/winserver2022-ps/addsdeployment/Install-ADDSForest.md Co-authored-by: Mikey Lombardi (He/Him) --- docset/winserver2022-ps/addsdeployment/Install-ADDSForest.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/addsdeployment/Install-ADDSForest.md b/docset/winserver2022-ps/addsdeployment/Install-ADDSForest.md index 61f55a72a6..3eb0430a19 100644 --- a/docset/winserver2022-ps/addsdeployment/Install-ADDSForest.md +++ b/docset/winserver2022-ps/addsdeployment/Install-ADDSForest.md @@ -119,7 +119,7 @@ Accept wildcard characters: False ### -DnsDelegationCredential Specifies the user name and password for creating DNS delegation. This parameter is skipped if the -value for the `-CreateDnsDelegation` parameter is either specified or computed to be $False. +value for the **CreateDnsDelegation** parameter is either specified or computed to be `$false`. ```yaml Type: System.Management.Automation.PSCredential From df37ca19facce2ddf5eed3d317980470e5dacf71 Mon Sep 17 00:00:00 2001 From: Robert Biddle Date: Mon, 1 May 2023 13:48:20 -0400 Subject: [PATCH 243/650] Update docset/winserver2022-ps/addsdeployment/Install-ADDSForest.md Co-authored-by: Mikey Lombardi (He/Him) --- .../winserver2022-ps/addsdeployment/Install-ADDSForest.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docset/winserver2022-ps/addsdeployment/Install-ADDSForest.md b/docset/winserver2022-ps/addsdeployment/Install-ADDSForest.md index 3eb0430a19..555274bab9 100644 --- a/docset/winserver2022-ps/addsdeployment/Install-ADDSForest.md +++ b/docset/winserver2022-ps/addsdeployment/Install-ADDSForest.md @@ -135,10 +135,10 @@ Accept wildcard characters: False ### -DomainMode -Specifies the domain functional level of the first domain in the creation of a new forest. Supported -values for this parameter can be either a valid integer or a corresponding enumerated string value. -For instance, to set the domain mode level to Windows Server 2008 R2, you can specify either a value -of 4 or Win2008R2. +Specifies the domain functional level of the first domain in the creation of a new forest. +Supported values for this parameter can be either a valid integer or a corresponding enumerated +string value. For instance, to set the domain mode level to Windows Server 2008 R2, you can specify +either a value of `4` or `Win2008R2`. The acceptable values for this parameter are: From 521926f5ad83f2d9fea132358f42a640e9ad507d Mon Sep 17 00:00:00 2001 From: Robert Biddle Date: Mon, 1 May 2023 13:48:26 -0400 Subject: [PATCH 244/650] Update docset/winserver2022-ps/addsdeployment/Install-ADDSForest.md Co-authored-by: Mikey Lombardi (He/Him) --- docset/winserver2022-ps/addsdeployment/Install-ADDSForest.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/addsdeployment/Install-ADDSForest.md b/docset/winserver2022-ps/addsdeployment/Install-ADDSForest.md index 555274bab9..72ff8e3a69 100644 --- a/docset/winserver2022-ps/addsdeployment/Install-ADDSForest.md +++ b/docset/winserver2022-ps/addsdeployment/Install-ADDSForest.md @@ -188,7 +188,7 @@ use with this parameter they must be single label names of 15 characters or less If this parameter is set with a valid NetBIOS name value, then forest installation continues with the name specified. If this parameter is not set, then the default is automatically computed from -the value of the `-DomainName` parameter. +the value of the **DomainName** parameter. For example, if this parameter is not specified and a single-label prefix domain name of 15 characters or less is specified within the value of the `-DomainName` parameter, then promotion From 8022dc4a6b09f57f4c89795bc349103f1471dbf9 Mon Sep 17 00:00:00 2001 From: Robert Biddle Date: Mon, 1 May 2023 13:48:33 -0400 Subject: [PATCH 245/650] Update docset/winserver2022-ps/addsdeployment/Install-ADDSForest.md Co-authored-by: Mikey Lombardi (He/Him) --- .../winserver2022-ps/addsdeployment/Install-ADDSForest.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docset/winserver2022-ps/addsdeployment/Install-ADDSForest.md b/docset/winserver2022-ps/addsdeployment/Install-ADDSForest.md index 72ff8e3a69..9adfeae5ee 100644 --- a/docset/winserver2022-ps/addsdeployment/Install-ADDSForest.md +++ b/docset/winserver2022-ps/addsdeployment/Install-ADDSForest.md @@ -228,9 +228,9 @@ Accept wildcard characters: False ### -ForestMode -Specifies the forest functional level for the new forest. Supported values for this parameter can be -either a valid integer or a corresponding enumerated string value. For example, to set the forest -mode level to Windows Server 2008 R2, you can specify either a value of 4 or Win2008R2. +Specifies the forest functional level for the new forest. Supported values for this parameter can +be either a valid integer or a corresponding enumerated string value. For example, to set the +forest mode level to Windows Server 2008 R2, you can specify either a value of `4` or `Win2008R2`. The acceptable values for this parameter are: From 996ad8594e6e19ef1b03c48bccbe349652e57261 Mon Sep 17 00:00:00 2001 From: Robert Biddle Date: Mon, 1 May 2023 13:48:44 -0400 Subject: [PATCH 246/650] Update docset/winserver2022-ps/addsdeployment/Install-ADDSForest.md Co-authored-by: Mikey Lombardi (He/Him) --- docset/winserver2022-ps/addsdeployment/Install-ADDSForest.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docset/winserver2022-ps/addsdeployment/Install-ADDSForest.md b/docset/winserver2022-ps/addsdeployment/Install-ADDSForest.md index 9adfeae5ee..54524e1ddd 100644 --- a/docset/winserver2022-ps/addsdeployment/Install-ADDSForest.md +++ b/docset/winserver2022-ps/addsdeployment/Install-ADDSForest.md @@ -238,8 +238,8 @@ The acceptable values for this parameter are: - Windows Server 2008: 3 or Win2008 - Windows Server 2008 R2: 4 or Win2008R2 - Windows Server 2012: 5 or Win2012 -- Windows Server 2012 R2: 6 or Win2012R2 -- Windows Server 2016: 7 or WinThreshold +- Windows Server 2012 R2: `6` or `Win2012R2` +- Windows Server 2016: `7` or `WinThreshold` The default forest functional level in Windows Server is typically the same as the version you are running. However, the default forest functional level in Windows Server 2008 R2 when you create a From cb57d668def613f85474e7472c467b78c1c6c8c8 Mon Sep 17 00:00:00 2001 From: Robert Biddle Date: Mon, 1 May 2023 13:50:07 -0400 Subject: [PATCH 247/650] Update docset/winserver2022-ps/addsdeployment/Install-ADDSForest.md Co-authored-by: Mikey Lombardi (He/Him) --- docset/winserver2022-ps/addsdeployment/Install-ADDSForest.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/addsdeployment/Install-ADDSForest.md b/docset/winserver2022-ps/addsdeployment/Install-ADDSForest.md index 54524e1ddd..64650d055c 100644 --- a/docset/winserver2022-ps/addsdeployment/Install-ADDSForest.md +++ b/docset/winserver2022-ps/addsdeployment/Install-ADDSForest.md @@ -243,7 +243,7 @@ The acceptable values for this parameter are: The default forest functional level in Windows Server is typically the same as the version you are running. However, the default forest functional level in Windows Server 2008 R2 when you create a -new forest is Windows Server 2003 or 2. +new forest is Windows Server 2003 or `2`. ```yaml Type: System.DirectoryServices.ActiveDirectory.ForestMode From 23ee9a1b4c391c7a8a1de73d1a06d1415acbe979 Mon Sep 17 00:00:00 2001 From: Robert Biddle Date: Mon, 1 May 2023 13:50:17 -0400 Subject: [PATCH 248/650] Update docset/winserver2022-ps/addsdeployment/Install-ADDSForest.md Co-authored-by: Mikey Lombardi (He/Him) --- docset/winserver2022-ps/addsdeployment/Install-ADDSForest.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/addsdeployment/Install-ADDSForest.md b/docset/winserver2022-ps/addsdeployment/Install-ADDSForest.md index 64650d055c..355434fc4d 100644 --- a/docset/winserver2022-ps/addsdeployment/Install-ADDSForest.md +++ b/docset/winserver2022-ps/addsdeployment/Install-ADDSForest.md @@ -261,7 +261,7 @@ Accept wildcard characters: False ### -InstallDns Indicates that this cmdlet installs and configures the DNS Server service for the new forest. -For forest installation, the default is $True. +For forest installation, the default is `$true`. ```yaml Type: System.Management.Automation.SwitchParameter From 5ad5f160f22d708995582f49d68ad523ebcaba1a Mon Sep 17 00:00:00 2001 From: Robert Biddle Date: Mon, 1 May 2023 13:50:24 -0400 Subject: [PATCH 249/650] Update docset/winserver2022-ps/addsdeployment/Install-ADDSForest.md Co-authored-by: Mikey Lombardi (He/Him) --- docset/winserver2022-ps/addsdeployment/Install-ADDSForest.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/addsdeployment/Install-ADDSForest.md b/docset/winserver2022-ps/addsdeployment/Install-ADDSForest.md index 355434fc4d..72435d90c1 100644 --- a/docset/winserver2022-ps/addsdeployment/Install-ADDSForest.md +++ b/docset/winserver2022-ps/addsdeployment/Install-ADDSForest.md @@ -387,7 +387,7 @@ Indicates that the cmdlet performs only a base set of validations. This behavior the validations that were performed when using `Dcpromo.exe` in earlier versions of Windows Server to add a new forest. When this switch parameter is set, it specifies that additional preliminary checks should be bypassed. For more information on the scope of these additional preliminary checks -that the ADDSDeployment module performs by default when using Windows Server 2012, refer to the +that the **ADDSDeployment** module performs by default when using Windows Server 2012, refer to the table in the section ADPrep and Prerequisite Checking Architecture in [AD DS Simplified Administration](https://go.microsoft.com/fwlink/?LinkID=237244). From 27b2dc22316090c824053d1c282c6da6c563fd90 Mon Sep 17 00:00:00 2001 From: Robert Biddle Date: Mon, 1 May 2023 13:54:08 -0400 Subject: [PATCH 250/650] Update docset/winserver2022-ps/addsdeployment/Install-ADDSForest.md Co-authored-by: Mikey Lombardi (He/Him) --- .../winserver2022-ps/addsdeployment/Install-ADDSForest.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docset/winserver2022-ps/addsdeployment/Install-ADDSForest.md b/docset/winserver2022-ps/addsdeployment/Install-ADDSForest.md index 72435d90c1..b382061ae9 100644 --- a/docset/winserver2022-ps/addsdeployment/Install-ADDSForest.md +++ b/docset/winserver2022-ps/addsdeployment/Install-ADDSForest.md @@ -191,9 +191,9 @@ the name specified. If this parameter is not set, then the default is automatica the value of the **DomainName** parameter. For example, if this parameter is not specified and a single-label prefix domain name of 15 -characters or less is specified within the value of the `-DomainName` parameter, then promotion -continues with an automatically generated NetBIOS domain name. For example, the prefix label corp -within a full domain name value of corp.contoso.com would be a successful name choice. +characters or less is specified within the value of the **DomainName** parameter, then promotion +continues with an automatically generated NetBIOS domain name. For example, the prefix label `corp` +within a full domain name value of `corp.contoso.com` would be a successful name choice. Note that if the name value given for this parameter is a name of 16 characters or more, then the forest installation fails. From 2b3f899df9904c014645a48835576d8e634844f7 Mon Sep 17 00:00:00 2001 From: Vanda Paladino Date: Mon, 1 May 2023 15:04:59 -0400 Subject: [PATCH 251/650] Update docset/winserver2022-ps/ServerManager/Install-WindowsFeature.md Co-authored-by: Sean Wheeler --- docset/winserver2022-ps/ServerManager/Install-WindowsFeature.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/ServerManager/Install-WindowsFeature.md b/docset/winserver2022-ps/ServerManager/Install-WindowsFeature.md index 68a5e2a1a5..5fbf870efc 100644 --- a/docset/winserver2022-ps/ServerManager/Install-WindowsFeature.md +++ b/docset/winserver2022-ps/ServerManager/Install-WindowsFeature.md @@ -349,7 +349,7 @@ the computer account of the computer that you are using to mount the VHD must ha permissions (Read/Write permissions in the File Sharing dialog box or Full Control on the Security tab of the folder Properties dialog box) on the shared folder or the VHD will not be accessible. Local loopback UNC paths are not supported. Use either of the following formats for the computer -account: DOMAIN\SERVERNAME$ or SERVERNAME$. +account: `DOMAIN\SERVERNAME$` or `SERVERNAME$`. Add the **ComputerName** parameter to specify the target computer you want to use to mount the VHD. If the **ComputerName** parameter is not specified, then the local computer is used. The computer that From 1adf2ac1e4253b155df5d2110c78bd0e80ecf8fb Mon Sep 17 00:00:00 2001 From: Vanda Paladino Date: Mon, 1 May 2023 15:05:17 -0400 Subject: [PATCH 252/650] Update docset/winserver2022-ps/ServerManager/Uninstall-WindowsFeature.md Co-authored-by: Sean Wheeler --- .../winserver2022-ps/ServerManager/Uninstall-WindowsFeature.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/ServerManager/Uninstall-WindowsFeature.md b/docset/winserver2022-ps/ServerManager/Uninstall-WindowsFeature.md index 945e109d70..f801a5d753 100644 --- a/docset/winserver2022-ps/ServerManager/Uninstall-WindowsFeature.md +++ b/docset/winserver2022-ps/ServerManager/Uninstall-WindowsFeature.md @@ -41,7 +41,7 @@ services, and features from a computer that is running Windows Server or from an hard disk (VHD) on which Windows Server is installed. This cmdlet works similarly to the uninstallation of roles and features in Server Manager with an important exception: by default, management tools are not uninstalled when you run the `Uninstall-WindowsFeature` cmdlet; you must -add the `IncludeManagementTools` parameter to uninstall associated management tools. +add the **IncludeManagementTools** parameter to uninstall associated management tools. This cmdlet requires elevation; you must be running a Windows PowerShell session as an administrator to use this cmdlet. From 66392d64024cfb09c74bad2fd5c01ede0108bc47 Mon Sep 17 00:00:00 2001 From: Robert Biddle Date: Sat, 29 Apr 2023 16:05:37 -0400 Subject: [PATCH 253/650] Style guidline fixes --- .../Install-ADDSDomainController.md | 362 +++++++++++------- 1 file changed, 230 insertions(+), 132 deletions(-) diff --git a/docset/winserver2022-ps/addsdeployment/Install-ADDSDomainController.md b/docset/winserver2022-ps/addsdeployment/Install-ADDSDomainController.md index 3d859faf15..1cf1886b53 100644 --- a/docset/winserver2022-ps/addsdeployment/Install-ADDSDomainController.md +++ b/docset/winserver2022-ps/addsdeployment/Install-ADDSDomainController.md @@ -11,81 +11,112 @@ title: Install-ADDSDomainController # Install-ADDSDomainController ## SYNOPSIS + Installs a new domain controller in an Active Directory domain. ## SYNTAX ### ADDSDomainController (Default) + ``` Install-ADDSDomainController [-SkipPreChecks] -DomainName - [-SafeModeAdministratorPassword ] [-SiteName ] [-ADPrepCredential ] - [-AllowDomainControllerReinstall] [-ApplicationPartitionsToReplicate ] [-CreateDnsDelegation] - [-Credential ] [-CriticalReplicationOnly] [-DatabasePath ] - [-DnsDelegationCredential ] [-NoDnsOnNetwork] [-NoGlobalCatalog] - [-InstallationMediaPath ] [-InstallDns] [-LogPath ] - [-MoveInfrastructureOperationMasterRoleIfNecessary] [-NoRebootOnCompletion] [-ReplicationSourceDC ] - [-SkipAutoConfigureDns] [-SystemKey ] [-SysvolPath ] [-Force] [-WhatIf] [-Confirm] - [] +[-SafeModeAdministratorPassword ] [-SiteName ] +[-ADPrepCredential ] [-AllowDomainControllerReinstall] +[-ApplicationPartitionsToReplicate ] [-CreateDnsDelegation] +[-Credential ] [-CriticalReplicationOnly] [-DatabasePath ] +[-DnsDelegationCredential ] [-NoDnsOnNetwork] [-NoGlobalCatalog] +[-InstallationMediaPath ] [-InstallDns] [-LogPath ] +[-MoveInfrastructureOperationMasterRoleIfNecessary] [-NoRebootOnCompletion] +[-ReplicationSourceDC ] [-SkipAutoConfigureDns] [-SystemKey ] +[-SysvolPath ] [-Force] [-WhatIf] [-Confirm] [] ``` ### ADDSDomainControllerReadOnly + ``` Install-ADDSDomainController [-SkipPreChecks] -DomainName - [-SafeModeAdministratorPassword ] -SiteName [-ADPrepCredential ] - [-AllowDomainControllerReinstall] [-AllowPasswordReplicationAccountName ] - [-ApplicationPartitionsToReplicate ] [-Credential ] [-CriticalReplicationOnly] - [-DatabasePath ] [-DelegatedAdministratorAccountName ] + [-SafeModeAdministratorPassword ] -SiteName + [-ADPrepCredential ] [-AllowDomainControllerReinstall] + [-AllowPasswordReplicationAccountName ] + [-ApplicationPartitionsToReplicate ] [-Credential ] + [-CriticalReplicationOnly] [-DatabasePath ] + [-DelegatedAdministratorAccountName ] [-DenyPasswordReplicationAccountName ] [-NoDnsOnNetwork] [-NoGlobalCatalog] [-InstallationMediaPath ] [-InstallDns] [-LogPath ] - [-MoveInfrastructureOperationMasterRoleIfNecessary] [-ReadOnlyReplica] [-NoRebootOnCompletion] - [-ReplicationSourceDC ] [-SkipAutoConfigureDns] [-SystemKey ] [-SysvolPath ] - [-Force] [-WhatIf] [-Confirm] [] + [-MoveInfrastructureOperationMasterRoleIfNecessary] [-ReadOnlyReplica] + [-NoRebootOnCompletion] [-ReplicationSourceDC ] [-SkipAutoConfigureDns] + [-SystemKey ] [-SysvolPath ] [-Force] [-WhatIf] [-Confirm] + [] ``` ### ADDSDomainControllerUseExistingAccount + ``` Install-ADDSDomainController [-SkipPreChecks] -DomainName [-SafeModeAdministratorPassword ] [-ADPrepCredential ] - [-ApplicationPartitionsToReplicate ] [-Credential ] [-CriticalReplicationOnly] - [-DatabasePath ] [-NoDnsOnNetwork] [-InstallationMediaPath ] [-LogPath ] - [-NoRebootOnCompletion] [-ReplicationSourceDC ] [-SkipAutoConfigureDns] [-SystemKey ] - [-SysvolPath ] [-UseExistingAccount] [-Force] [-WhatIf] [-Confirm] [] + [-ApplicationPartitionsToReplicate ] [-Credential ] + [-CriticalReplicationOnly] [-DatabasePath ] [-NoDnsOnNetwork] + [-InstallationMediaPath ] [-LogPath ] [-NoRebootOnCompletion] + [-ReplicationSourceDC ] [-SkipAutoConfigureDns] [-SystemKey ] + [-SysvolPath ] [-UseExistingAccount] [-Force] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION -The **Install-ADDSDomainController** cmdlet installs a domain controller in Active Directory. + +The `Install-ADDSDomainController` cmdlet installs a domain controller in Active Directory. ## EXAMPLES ### Example 1: Install a domain controller and DNS server + ```powershell -PS C:\> Install-ADDSDomainController -InstallDns -DomainName "corp.contoso.com" +Install-ADDSDomainController -InstallDns -DomainName "corp.contoso.com" ``` -This command installs a domain controller and DNS server in the corp.contoso.com domain using CORP\Administrator credentials and prompts the user to provide and confirm the Directory Services Restore Mode (DSRM) password. +This command installs a domain controller and DNS server in the corp.contoso.com domain using +CORP\Administrator credentials and prompts the user to provide and confirm the Directory Services +Restore Mode (DSRM) password. ### Example 2: Install a domain controller and DNS server using administrator credentials + ```powershell -PS C:\> Install-ADDSDomainController -InstallDns -Credential (Get-Credential "CORP\Administrator") -DomainName "corp.contoso.com" +$HashArguments = @{ + Credential = (Get-Credential "CORP\Administrator") + DomainName = "corp.contoso.com" + InstallDns = $true +} +Install-ADDSDomainController @HashArguments ``` -This command installs a domain controller and DNS server in the corp.contoso.com domain using Administrator credentials and prompts the user to provide and confirm the DSRM password. +This command installs a domain controller and DNS server in the corp.contoso.com domain using +Administrator credentials and prompts the user to provide and confirm the DSRM password. ### Example 3: Install a domain controller and DNS server that uses domain promotion + ```powershell -PS C:\> Install-ADDSDomainController -InstallDns -Credential (Get-Credential) -DomainName (Read-Host "Domain to promote into") +$HashArguments = @{ + Credential = (Get-Credential) + DomainName = (Read-Host "Domain to promote into") + InstallDns = $true +} +Install-ADDSDomainController @HashArguments ``` -Installs a domain controller and DNS server and prompts for credentials, the name of the domain to use when installing and promoting the domain controller and to provide and confirm the DSRM password. +Installs a domain controller and DNS server and prompts for credentials, the name of the domain to +use when installing and promoting the domain controller and to provide and confirm the DSRM +password. ## PARAMETERS ### -ADPrepCredential -Specifies the user name and password that corresponds to the account to be used for running the Adprep utility, if it is required, to prepare the directory prior to the installation of this domain controller. -Use the **Get-Credential** cmdlet to prompt the user to supply a password. + +Specifies the user name and password that corresponds to the account to be used for running the +Adprep utility, if it is required, to prepare the directory prior to the installation of this domain +controller. Use the `Get-Credential` cmdlet to prompt the user to supply a password. ```yaml -Type: PSCredential +Type: System.Management.Automation.PSCredential Parameter Sets: (All) Aliases: @@ -97,11 +128,14 @@ Accept wildcard characters: False ``` ### -AllowDomainControllerReinstall -Indicates that the cmdlet continues to install this domain controller, despite the fact that another domain controller account with the same name is detected. -By default, the **Install-ADDSDomainController** cmdlet does not continue the installation if another domain controller with the same name is found. + +Indicates that the cmdlet continues to install this domain controller, despite the fact that another +domain controller account with the same name is detected. By default, the +`Install-ADDSDomainController` cmdlet does not continue the installation if another domain +controller with the same name is found. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: ADDSDomainController, ADDSDomainControllerReadOnly Aliases: @@ -113,12 +147,13 @@ Accept wildcard characters: False ``` ### -AllowPasswordReplicationAccountName -Specifies an array of names of user accounts, group accounts, and computer accounts whose passwords can be replicated to this RODC. -Use an empty string ("") if you want to keep the value empty. -By default, only the Allowed read-only domain controller (RODC) Password Replication Group is allowed. + +Specifies an array of names of user accounts, group accounts, and computer accounts whose passwords +can be replicated to this RODC. Use an empty string ("") if you want to keep the value empty. By +default, only the Allowed read-only domain controller (RODC) Password Replication Group is allowed. ```yaml -Type: String[] +Type: System.String[] Parameter Sets: ADDSDomainControllerReadOnly Aliases: @@ -130,12 +165,13 @@ Accept wildcard characters: False ``` ### -ApplicationPartitionsToReplicate + Specifies an array of application directory partitions that DCPromo will replicate. Use the following format: "partition1" "partition2" "partitionN". Use * to replicate all application directory partitions. ```yaml -Type: String[] +Type: System.String[] Parameter Sets: (All) Aliases: @@ -147,10 +183,11 @@ Accept wildcard characters: False ``` ### -Confirm + Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf @@ -162,14 +199,15 @@ Accept wildcard characters: False ``` ### -CreateDnsDelegation -Indicates that the cmdlet creates a DNS delegation that references the new DNS server that this cmdlet installs along with the domain controller. -Valid for Active Directory-integrated DNS only. -If this parameter is specified then the DNS delegation is created. -If the value of $False is specified then no DNS delegation is created. -By default, the value for this parameter is computed automatically based on the environment. + +Indicates that the cmdlet creates a DNS delegation that references the new DNS server that this +cmdlet installs along with the domain controller. Valid for Active Directory-integrated DNS only. If +this parameter is specified then the DNS delegation is created. If the value of $False is specified +then no DNS delegation is created. By default, the value for this parameter is computed +automatically based on the environment. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: ADDSDomainController Aliases: @@ -181,11 +219,12 @@ Accept wildcard characters: False ``` ### -Credential -Specifies the user name and password that corresponds to the account used to install the domain controller. -Use the **Get-Credential** to prompt the user to supply a password. + +Specifies the user name and password that corresponds to the account used to install the domain +controller. Use the `Get-Credential` to prompt the user to supply a password. ```yaml -Type: PSCredential +Type: System.Management.Automation.PSCredential Parameter Sets: (All) Aliases: @@ -197,13 +236,15 @@ Accept wildcard characters: False ``` ### -CriticalReplicationOnly -Indicates that the cmdlet performs only critical replication before reboot and then continues during the AD DS installation operation. -This parameter skips the noncritical and potentially lengthy portion of replication. -The noncritical replication happens after the installation finishes and the computer reboots. -By default, the cmdlet performs both critical and noncritical portions of the replication. + +Indicates that the cmdlet performs only critical replication before reboot and then continues during +the AD DS installation operation. This parameter skips the noncritical and potentially lengthy +portion of replication. The noncritical replication happens after the installation finishes and the +computer reboots. By default, the cmdlet performs both critical and noncritical portions of the +replication. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -215,11 +256,13 @@ Accept wildcard characters: False ``` ### -DatabasePath -Specifies the fully qualified, non-Universal Naming Convention (UNC) path to a directory on a fixed disk of the local computer that will contain the domain database, for instance, `C:\Windows\NTDS`. + +Specifies the fully qualified, non-Universal Naming Convention (UNC) path to a directory on a fixed +disk of the local computer that will contain the domain database, for instance, `C:\Windows\NTDS`. The default is `%SYSTEMROOT%\NTDS`. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -231,10 +274,12 @@ Accept wildcard characters: False ``` ### -DelegatedAdministratorAccountName -Specifies the name of the user or group that is the delegated administrator of this domain controller. + +Specifies the name of the user or group that is the delegated administrator of this domain +controller. ```yaml -Type: String +Type: System.String Parameter Sets: ADDSDomainControllerReadOnly Aliases: @@ -246,13 +291,17 @@ Accept wildcard characters: False ``` ### -DenyPasswordReplicationAccountName -Specifies the names of user accounts, group accounts, and computer accounts whose passwords are not to be replicated to this RODC. -Use an empty string ("") if you do not want to deny the replication of credentials of any users or computers. -By default, Administrators, Server Operators, Backup Operators, Account Operators, and the Denied RODC Password Replication Group are denied. -By default, the Denied RODC Password Replication Group includes Cert Publishers, Domain Admins, Enterprise Admins, Enterprise Domain Controllers, Enterprise Read-Only Domain Controllers, Group Policy Creator Owners, the krbtgt account, and Schema Admins. + +Specifies the names of user accounts, group accounts, and computer accounts whose passwords are not +to be replicated to this RODC. Use an empty string ("") if you do not want to deny the replication +of credentials of any users or computers. By default, Administrators, Server Operators, Backup +Operators, Account Operators, and the Denied RODC Password Replication Group are denied. By default, +the Denied RODC Password Replication Group includes Cert Publishers, Domain Admins, Enterprise +Admins, Enterprise Domain Controllers, Enterprise Read-Only Domain Controllers, Group Policy Creator +Owners, the krbtgt account, and Schema Admins. ```yaml -Type: String[] +Type: System.String[] Parameter Sets: ADDSDomainControllerReadOnly Aliases: @@ -264,11 +313,12 @@ Accept wildcard characters: False ``` ### -DnsDelegationCredential -Specifies the user name and password for creating DNS delegation. -This parameter is skipped if the value for the **CreateDnsDelegation** parameter is either specified or computed to be $False. + +Specifies the user name and password for creating DNS delegation. This parameter is skipped if the +value for the _CreateDnsDelegation_ parameter is either specified or computed to be $False. ```yaml -Type: PSCredential +Type: System.Management.Automation.PSCredential Parameter Sets: ADDSDomainController Aliases: @@ -280,10 +330,12 @@ Accept wildcard characters: False ``` ### -DomainName -Specifies the fully qualified domain name (FQDN) for the domain where the domain controller is installed or added. + +Specifies the fully qualified domain name (FQDN) for the domain where the domain controller is +installed or added. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -295,10 +347,11 @@ Accept wildcard characters: False ``` ### -Force + Forces the command to run without asking for user confirmation. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -310,15 +363,20 @@ Accept wildcard characters: False ``` ### -InstallDns -Indicates the cmdlet installs and configures the DNS Server service on the domain controller. -For domain controller installation, if this parameter is left unspecified and the current domain already hosts and stores the DNS names for the domain, then the default for this parameter is $True and the DNS server is installed. -Otherwise, if DNS domain names are hosted outside of Active Directory, the default is `$False` and no DNS server is installed. -To test if DNS domain names are hosted outside of Active Directory, this cmdlet uses a start of authority (SOA) type DNS query. -For instance, if the value of **DomainName** is corp.contoso.com, Active Directory performs an SOA query for corp.contoso.com and ensures that the zone name in the response is corp.contoso.com. +Indicates the cmdlet installs and configures the DNS Server service on the domain controller. For +domain controller installation, if this parameter is left unspecified and the current domain already +hosts and stores the DNS names for the domain, then the default for this parameter is $True and the +DNS server is installed. Otherwise, if DNS domain names are hosted outside of Active Directory, the +default is `$False` and no DNS server is installed. + +To test if DNS domain names are hosted outside of Active Directory, this cmdlet uses a start of +authority (SOA) type DNS query. For instance, if the value of _DomainName_ is corp.contoso.com, +Active Directory performs an SOA query for corp.contoso.com and ensures that the zone name in the +response is corp.contoso.com. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: ADDSDomainController, ADDSDomainControllerReadOnly Aliases: @@ -330,10 +388,11 @@ Accept wildcard characters: False ``` ### -InstallationMediaPath + Indicates the location of the installation media that is used to install a new domain controller. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -345,11 +404,13 @@ Accept wildcard characters: False ``` ### -LogPath -Specifies the fully qualified, non-UNC path to a directory on a fixed disk of the local computer that will contain the domain log files, for example, `C:\Windows\Logs`. -The default is `%SYSTEMROOT%\NTDS`. + +Specifies the fully qualified, non-UNC path to a directory on a fixed disk of the local computer +that will contain the domain log files, for example, `C:\Windows\Logs`. The default is +`%SYSTEMROOT%\NTDS`. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -361,12 +422,14 @@ Accept wildcard characters: False ``` ### -MoveInfrastructureOperationMasterRoleIfNecessary -Indicates that the cmdlet transfers the infrastructure master role to the domain controller being installed. -To successfully complete the transfer, the **NoGlobalCatalog** parameter must be included as well. -Do not specify this parameter if you want the infrastructure master role to remain where it currently is. + +Indicates that the cmdlet transfers the infrastructure master role to the domain controller being +installed. To successfully complete the transfer, the _NoGlobalCatalog_ parameter must be included +as well. Do not specify this parameter if you want the infrastructure master role to remain where it +currently is. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: ADDSDomainController, ADDSDomainControllerReadOnly Aliases: @@ -378,16 +441,20 @@ Accept wildcard characters: False ``` ### -NoDnsOnNetwork -Indicates that the DNS service is not available on the network. -This parameter is used only when the IP setting of the network adapter for this computer is not configured with the name of a DNS server for name resolution. -It indicates that a DNS server is installed on this computer for name resolution. -Otherwise, the IP settings of the network adapter must first be configured with the address of a DNS server. -Omitting this parameter (the default) indicates that the TCP/IP client settings of the network adapter on this server computer is used to contact a DNS server. -Therefore, if you are not specifying this parameter, ensure that TCP/IP client settings are first configured with a preferred DNS server address. +Indicates that the DNS service is not available on the network. This parameter is used only when the +IP setting of the network adapter for this computer is not configured with the name of a DNS server +for name resolution. It indicates that a DNS server is installed on this computer for name +resolution. Otherwise, the IP settings of the network adapter must first be configured with the +address of a DNS server. + +Omitting this parameter (the default) indicates that the TCP/IP client settings of the network +adapter on this server computer is used to contact a DNS server. Therefore, if you are not +specifying this parameter, ensure that TCP/IP client settings are first configured with a preferred +DNS server address. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -399,11 +466,12 @@ Accept wildcard characters: False ``` ### -NoGlobalCatalog + Indicates that the RODC will not be a global catalog server. By default, the domain controller that you are installing is a global catalog server. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: ADDSDomainController, ADDSDomainControllerReadOnly Aliases: @@ -415,12 +483,16 @@ Accept wildcard characters: False ``` ### -NoRebootOnCompletion -Indicates that the cmdlet does not restart the computer upon the completion of the operation to install the domain controller. -By default, if this parameter is omitted the computer will restart upon the completion of the install operation. -As a general rule, Microsoft support recommends that you not use this parameter except for testing or troubleshooting purposes because once configuration has completed the server will not function correctly as either a member server or a DC until it is rebooted. + +Indicates that the cmdlet does not restart the computer upon the completion of the operation to +install the domain controller. By default, if this parameter is omitted the computer will restart +upon the completion of the install operation. As a general rule, Microsoft support recommends that +you not use this parameter except for testing or troubleshooting purposes because once configuration +has completed the server will not function correctly as either a member server or a DC until it is +rebooted. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -432,10 +504,11 @@ Accept wildcard characters: False ``` ### -ReadOnlyReplica + Indicates that the cmdlet installs the domain controller as an RODC for an existing domain. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: ADDSDomainControllerReadOnly Aliases: @@ -447,10 +520,12 @@ Accept wildcard characters: False ``` ### -ReplicationSourceDC -Specifies the name of the domain controller to be used as the source for replicating to this domain controller. + +Specifies the name of the domain controller to be used as the source for replicating to this domain +controller. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -462,22 +537,27 @@ Accept wildcard characters: False ``` ### -SafeModeAdministratorPassword -Supplies the password for the administrator account when the computer is started in Safe Mode or a variant of Safe Mode, such as Directory Services Restore Mode. -If no value is specified for this parameter, the cmdlet prompts you to enter and confirm a masked password. -If specified with a value, the value must be a secure string. -Supplies the password for the administrator account when the computer is started in Safe Mode or a variant of Safe Mode, such as Directory Services Restore Mode. -You must supply a password that meets the password complexity rules of the domain and the password cannot be blank. -If specified with a value, the value must be a secure string. +Supplies the password for the administrator account when the computer is started in Safe Mode or a +variant of Safe Mode, such as Directory Services Restore Mode. If no value is specified for this +parameter, the cmdlet prompts you to enter and confirm a masked password. If specified with a value, +the value must be a secure string. + +Supplies the password for the administrator account when the computer is started in Safe Mode or a +variant of Safe Mode, such as Directory Services Restore Mode. You must supply a password that meets +the password complexity rules of the domain and the password cannot be blank. If specified with a +value, the value must be a secure string. If this parameter is not specified, the cmdlet prompts you to enter and confirm a masked password. -This is the preferred usage when running the cmdlet interactively. -If additionally there are no other arguments specified with the cmdlet, you is prompted to enter a masked password for this parameter but no confirmation of the password entered is made. -This is not recommended as it could allow a mistyped password to be configured. -Another available advanced option is to use the **ConvertTo-SecureString** cmdlet and specify the password string inline as unmasked console input, which is also not a recommended security best practice in production deployments. +This is the preferred usage when running the cmdlet interactively. If additionally there are no +other arguments specified with the cmdlet, you is prompted to enter a masked password for this +parameter but no confirmation of the password entered is made. This is not recommended as it could +allow a mistyped password to be configured. Another available advanced option is to use the +`ConvertTo-SecureString` cmdlet and specify the password string inline as unmasked console input, +which is also not a recommended security best practice in production deployments. ```yaml -Type: SecureString +Type: System.Security.SecureString Parameter Sets: (All) Aliases: @@ -489,14 +569,15 @@ Accept wildcard characters: False ``` ### -SiteName -Specifies the name of an existing site where you can place the new domain controller. -The default value depends on the type of installation. -For a new forest, the default is Default-First-Site-Name. -For all other installations, the default is the site that is associated with the subnet that includes the IP address of this server. -If no such site exists, the default is the site of the replication source domain controller. + +Specifies the name of an existing site where you can place the new domain controller. The default +value depends on the type of installation. For a new forest, the default is Default-First-Site-Name. +For all other installations, the default is the site that is associated with the subnet that +includes the IP address of this server. If no such site exists, the default is the site of the +replication source domain controller. ```yaml -Type: String +Type: System.String Parameter Sets: ADDSDomainController Aliases: @@ -508,7 +589,7 @@ Accept wildcard characters: False ``` ```yaml -Type: String +Type: System.String Parameter Sets: ADDSDomainControllerReadOnly Aliases: @@ -520,11 +601,12 @@ Accept wildcard characters: False ``` ### -SkipAutoConfigureDns -Indicates that the cmdlet skips automatic configuration of the DNS client settings, forwarders, and root hints. -This parameter is in effect only if the DNS Server service is already installed. + +Indicates that the cmdlet skips automatic configuration of the DNS client settings, forwarders, and +root hints. This parameter is in effect only if the DNS Server service is already installed. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -536,13 +618,17 @@ Accept wildcard characters: False ``` ### -SkipPreChecks -Indicates that the cmdlet performs only a base set of validations. -This behavior is equivalent to the validations that were performed when using `Dcpromo.exe` in earlier versions of Windows Server to add a new domain controller. -When this switch parameter is set, it specifies that additional preliminary checks should be bypassed. -For more information on the scope of these additional preliminary checks that the ADDSDeployment module performs by default when using Windows Server 2016, refer to the table in the section "ADPrep and Prerequisite Checking Architecture" in [AD DS Simplified Administration](https://go.microsoft.com/fwlink/?LinkID=237244). + +Indicates that the cmdlet performs only a base set of validations. This behavior is equivalent to +the validations that were performed when using `Dcpromo.exe` in earlier versions of Windows Server +to add a new domain controller. When this switch parameter is set, it specifies that additional +preliminary checks should be bypassed. For more information on the scope of these additional +preliminary checks that the ADDSDeployment module performs by default when using Windows Server +2016, refer to the table in the section "ADPrep and Prerequisite Checking Architecture" in +[AD DS Simplified Administration](https://go.microsoft.com/fwlink/?LinkID=237244). ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -554,11 +640,12 @@ Accept wildcard characters: False ``` ### -SystemKey + Specifies the system key for the media from which you replicate the data. The default is none. ```yaml -Type: SecureString +Type: System.Security.SecureString Parameter Sets: (All) Aliases: @@ -570,11 +657,13 @@ Accept wildcard characters: False ``` ### -SysvolPath -Specifies the fully qualified, non-UNC path to a directory on a fixed disk of the local computer that will contain the Sysvol data, for example, `C:\Windows\SYSVOL`. -The default is `%SYSTEMROOT%\SYSVOL`. + +Specifies the fully qualified, non-UNC path to a directory on a fixed disk of the local computer +that will contain the Sysvol data, for example, `C:\Windows\SYSVOL`. The default is +`%SYSTEMROOT%\SYSVOL`. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -586,11 +675,12 @@ Accept wildcard characters: False ``` ### -UseExistingAccount + Indicates that the cmdlet attaches a server to an existing RODC account. If specified, a member of the Domain Admins group or a delegated user can run this cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: ADDSDomainControllerUseExistingAccount Aliases: @@ -602,11 +692,12 @@ Accept wildcard characters: False ``` ### -WhatIf + Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi @@ -618,7 +709,11 @@ Accept wildcard characters: False ``` ### CommonParameters -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). + +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). ## INPUTS @@ -627,8 +722,12 @@ This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVar ### Microsoft.DirectoryServices.Deployment.Types.Result ## NOTES -* By default, this cmdlet always prompts for confirmation. To bypass confirmation, you need to include the **Confirm** parameter and specify a value of `$false`. For example, `-Confirm:$false`. -* By default, this cmdlet is always run when executed. To see what will happen if the cmdlet runs without executing or committing installation changes, first run the cmdlet using the ***WhatIf** parameter to show what would happen. + +- By default, this cmdlet always prompts for confirmation. To bypass confirmation, you need to + include the _Confirm_ parameter and specify a value of `$false`. For example, `-Confirm:$false`. +- By default, this cmdlet is always run when executed. To see what will happen if the cmdlet runs + without executing or committing installation changes, first run the cmdlet using the _WhatIf_ + parameter to show what would happen. ## RELATED LINKS @@ -643,4 +742,3 @@ This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVar [Get-Credential](https://go.microsoft.com/fwlink/?LinkID=293936) [ConvertTo-SecureString](https://go.microsoft.com/fwlink/p/?LinkId=113291) - From 51202fed5d449650062f7f16310e890b055aaa68 Mon Sep 17 00:00:00 2001 From: Robert Biddle Date: Mon, 1 May 2023 13:25:33 -0400 Subject: [PATCH 254/650] Update docset/winserver2022-ps/addsdeployment/Install-ADDSDomainController.md Co-authored-by: Mikey Lombardi (He/Him) --- .../addsdeployment/Install-ADDSDomainController.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docset/winserver2022-ps/addsdeployment/Install-ADDSDomainController.md b/docset/winserver2022-ps/addsdeployment/Install-ADDSDomainController.md index 1cf1886b53..6b0c3ff091 100644 --- a/docset/winserver2022-ps/addsdeployment/Install-ADDSDomainController.md +++ b/docset/winserver2022-ps/addsdeployment/Install-ADDSDomainController.md @@ -424,9 +424,9 @@ Accept wildcard characters: False ### -MoveInfrastructureOperationMasterRoleIfNecessary Indicates that the cmdlet transfers the infrastructure master role to the domain controller being -installed. To successfully complete the transfer, the _NoGlobalCatalog_ parameter must be included -as well. Do not specify this parameter if you want the infrastructure master role to remain where it -currently is. +installed. To successfully complete the transfer, the **NoGlobalCatalog** parameter must be +included as well. Do not specify this parameter if you want the infrastructure master role to +remain where it currently is. ```yaml Type: System.Management.Automation.SwitchParameter From 9000814a630fdcf36a1c32bee51cc62e228c5622 Mon Sep 17 00:00:00 2001 From: Robert Biddle Date: Mon, 1 May 2023 13:26:37 -0400 Subject: [PATCH 255/650] Update docset/winserver2022-ps/addsdeployment/Install-ADDSDomainController.md Co-authored-by: Mikey Lombardi (He/Him) --- .../addsdeployment/Install-ADDSDomainController.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docset/winserver2022-ps/addsdeployment/Install-ADDSDomainController.md b/docset/winserver2022-ps/addsdeployment/Install-ADDSDomainController.md index 6b0c3ff091..d2e9743123 100644 --- a/docset/winserver2022-ps/addsdeployment/Install-ADDSDomainController.md +++ b/docset/winserver2022-ps/addsdeployment/Install-ADDSDomainController.md @@ -571,10 +571,10 @@ Accept wildcard characters: False ### -SiteName Specifies the name of an existing site where you can place the new domain controller. The default -value depends on the type of installation. For a new forest, the default is Default-First-Site-Name. -For all other installations, the default is the site that is associated with the subnet that -includes the IP address of this server. If no such site exists, the default is the site of the -replication source domain controller. +value depends on the type of installation. For a new forest, the default is +`Default-First-Site-Name`. For all other installations, the default is the site that is associated +with the subnet that includes the IP address of this server. If no such site exists, the default is +the site of the replication source domain controller. ```yaml Type: System.String From 5f2af2b883976570acdef5eb432a355d0d2284a6 Mon Sep 17 00:00:00 2001 From: Robert Biddle Date: Mon, 1 May 2023 13:26:49 -0400 Subject: [PATCH 256/650] Update docset/winserver2022-ps/addsdeployment/Install-ADDSDomainController.md Co-authored-by: Mikey Lombardi (He/Him) --- .../addsdeployment/Install-ADDSDomainController.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/addsdeployment/Install-ADDSDomainController.md b/docset/winserver2022-ps/addsdeployment/Install-ADDSDomainController.md index d2e9743123..86cb7b4c6b 100644 --- a/docset/winserver2022-ps/addsdeployment/Install-ADDSDomainController.md +++ b/docset/winserver2022-ps/addsdeployment/Install-ADDSDomainController.md @@ -623,7 +623,7 @@ Indicates that the cmdlet performs only a base set of validations. This behavior the validations that were performed when using `Dcpromo.exe` in earlier versions of Windows Server to add a new domain controller. When this switch parameter is set, it specifies that additional preliminary checks should be bypassed. For more information on the scope of these additional -preliminary checks that the ADDSDeployment module performs by default when using Windows Server +preliminary checks that the **ADDSDeployment** module performs by default when using Windows Server 2016, refer to the table in the section "ADPrep and Prerequisite Checking Architecture" in [AD DS Simplified Administration](https://go.microsoft.com/fwlink/?LinkID=237244). From 32a34a7c5120e038d6c8ee48175dba4fe7479b9b Mon Sep 17 00:00:00 2001 From: Robert Biddle Date: Mon, 1 May 2023 13:34:14 -0400 Subject: [PATCH 257/650] Update docset/winserver2022-ps/addsdeployment/Install-ADDSDomainController.md Co-authored-by: Mikey Lombardi (He/Him) --- .../addsdeployment/Install-ADDSDomainController.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docset/winserver2022-ps/addsdeployment/Install-ADDSDomainController.md b/docset/winserver2022-ps/addsdeployment/Install-ADDSDomainController.md index 86cb7b4c6b..3fcef44fe8 100644 --- a/docset/winserver2022-ps/addsdeployment/Install-ADDSDomainController.md +++ b/docset/winserver2022-ps/addsdeployment/Install-ADDSDomainController.md @@ -724,9 +724,10 @@ This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVar ## NOTES - By default, this cmdlet always prompts for confirmation. To bypass confirmation, you need to - include the _Confirm_ parameter and specify a value of `$false`. For example, `-Confirm:$false`. + include the **Confirm** parameter and specify a value of `$false`. For example, + `-Confirm:$false`. - By default, this cmdlet is always run when executed. To see what will happen if the cmdlet runs - without executing or committing installation changes, first run the cmdlet using the _WhatIf_ + without executing or committing installation changes, first run the cmdlet using the **WhatIf** parameter to show what would happen. ## RELATED LINKS From 0663c9b3e89291e82a82ce48f8cd532da5d36cf7 Mon Sep 17 00:00:00 2001 From: Robert Biddle Date: Mon, 1 May 2023 13:34:30 -0400 Subject: [PATCH 258/650] Update docset/winserver2022-ps/addsdeployment/Install-ADDSDomainController.md Co-authored-by: Mikey Lombardi (He/Him) --- .../addsdeployment/Install-ADDSDomainController.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docset/winserver2022-ps/addsdeployment/Install-ADDSDomainController.md b/docset/winserver2022-ps/addsdeployment/Install-ADDSDomainController.md index 3fcef44fe8..16eaf3f6e1 100644 --- a/docset/winserver2022-ps/addsdeployment/Install-ADDSDomainController.md +++ b/docset/winserver2022-ps/addsdeployment/Install-ADDSDomainController.md @@ -371,9 +371,9 @@ DNS server is installed. Otherwise, if DNS domain names are hosted outside of Ac default is `$False` and no DNS server is installed. To test if DNS domain names are hosted outside of Active Directory, this cmdlet uses a start of -authority (SOA) type DNS query. For instance, if the value of _DomainName_ is corp.contoso.com, -Active Directory performs an SOA query for corp.contoso.com and ensures that the zone name in the -response is corp.contoso.com. +authority (SOA) type DNS query. For instance, if the value of **DomainName** is `corp.contoso.com`, +Active Directory performs an SOA query for `corp.contoso.com` and ensures that the zone name in the +response is `corp.contoso.com`. ```yaml Type: System.Management.Automation.SwitchParameter From 5691cfaf53d42be8c45e61c7343e021895fc7edc Mon Sep 17 00:00:00 2001 From: Robert Biddle Date: Mon, 1 May 2023 13:34:48 -0400 Subject: [PATCH 259/650] Update docset/winserver2022-ps/addsdeployment/Install-ADDSDomainController.md Co-authored-by: Mikey Lombardi (He/Him) --- .../addsdeployment/Install-ADDSDomainController.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/addsdeployment/Install-ADDSDomainController.md b/docset/winserver2022-ps/addsdeployment/Install-ADDSDomainController.md index 16eaf3f6e1..a927da1c4a 100644 --- a/docset/winserver2022-ps/addsdeployment/Install-ADDSDomainController.md +++ b/docset/winserver2022-ps/addsdeployment/Install-ADDSDomainController.md @@ -315,7 +315,7 @@ Accept wildcard characters: False ### -DnsDelegationCredential Specifies the user name and password for creating DNS delegation. This parameter is skipped if the -value for the _CreateDnsDelegation_ parameter is either specified or computed to be $False. +value for the **CreateDnsDelegation** parameter is either specified or computed to be `$false`. ```yaml Type: System.Management.Automation.PSCredential From 08257276a3cc94c53b69533390ec51fc2cab34e6 Mon Sep 17 00:00:00 2001 From: Robert Biddle Date: Mon, 1 May 2023 13:34:59 -0400 Subject: [PATCH 260/650] Update docset/winserver2022-ps/addsdeployment/Install-ADDSDomainController.md Co-authored-by: Mikey Lombardi (He/Him) --- .../addsdeployment/Install-ADDSDomainController.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docset/winserver2022-ps/addsdeployment/Install-ADDSDomainController.md b/docset/winserver2022-ps/addsdeployment/Install-ADDSDomainController.md index a927da1c4a..af55607765 100644 --- a/docset/winserver2022-ps/addsdeployment/Install-ADDSDomainController.md +++ b/docset/winserver2022-ps/addsdeployment/Install-ADDSDomainController.md @@ -201,9 +201,9 @@ Accept wildcard characters: False ### -CreateDnsDelegation Indicates that the cmdlet creates a DNS delegation that references the new DNS server that this -cmdlet installs along with the domain controller. Valid for Active Directory-integrated DNS only. If -this parameter is specified then the DNS delegation is created. If the value of $False is specified -then no DNS delegation is created. By default, the value for this parameter is computed +cmdlet installs along with the domain controller. Valid for Active Directory-integrated DNS only. +If this parameter is specified then the DNS delegation is created. If the value of `$False` is +specified then no DNS delegation is created. By default, the value for this parameter is computed automatically based on the environment. ```yaml From 9bfe008c082134b6d24217a6f0c3e41e620b9218 Mon Sep 17 00:00:00 2001 From: Robert Biddle Date: Mon, 1 May 2023 13:35:16 -0400 Subject: [PATCH 261/650] Update docset/winserver2022-ps/addsdeployment/Install-ADDSDomainController.md Co-authored-by: Mikey Lombardi (He/Him) --- .../addsdeployment/Install-ADDSDomainController.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/addsdeployment/Install-ADDSDomainController.md b/docset/winserver2022-ps/addsdeployment/Install-ADDSDomainController.md index af55607765..f02653b7d3 100644 --- a/docset/winserver2022-ps/addsdeployment/Install-ADDSDomainController.md +++ b/docset/winserver2022-ps/addsdeployment/Install-ADDSDomainController.md @@ -293,7 +293,7 @@ Accept wildcard characters: False ### -DenyPasswordReplicationAccountName Specifies the names of user accounts, group accounts, and computer accounts whose passwords are not -to be replicated to this RODC. Use an empty string ("") if you do not want to deny the replication +to be replicated to this RODC. Use an empty string (`""`) if you do not want to deny the replication of credentials of any users or computers. By default, Administrators, Server Operators, Backup Operators, Account Operators, and the Denied RODC Password Replication Group are denied. By default, the Denied RODC Password Replication Group includes Cert Publishers, Domain Admins, Enterprise From 26b41523ef5c70822d45d3439530deb53d9609d8 Mon Sep 17 00:00:00 2001 From: Robert Biddle Date: Mon, 1 May 2023 13:35:31 -0400 Subject: [PATCH 262/650] Update docset/winserver2022-ps/addsdeployment/Install-ADDSDomainController.md Co-authored-by: Mikey Lombardi (He/Him) --- .../addsdeployment/Install-ADDSDomainController.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docset/winserver2022-ps/addsdeployment/Install-ADDSDomainController.md b/docset/winserver2022-ps/addsdeployment/Install-ADDSDomainController.md index f02653b7d3..258fbefbd2 100644 --- a/docset/winserver2022-ps/addsdeployment/Install-ADDSDomainController.md +++ b/docset/winserver2022-ps/addsdeployment/Install-ADDSDomainController.md @@ -365,10 +365,10 @@ Accept wildcard characters: False ### -InstallDns Indicates the cmdlet installs and configures the DNS Server service on the domain controller. For -domain controller installation, if this parameter is left unspecified and the current domain already -hosts and stores the DNS names for the domain, then the default for this parameter is $True and the -DNS server is installed. Otherwise, if DNS domain names are hosted outside of Active Directory, the -default is `$False` and no DNS server is installed. +domain controller installation, if this parameter is left unspecified and the current domain +already hosts and stores the DNS names for the domain, then the default for this parameter is +`$true` and the DNS server is installed. Otherwise, if DNS domain names are hosted outside of +Active Directory, the default is `$false` and no DNS server is installed. To test if DNS domain names are hosted outside of Active Directory, this cmdlet uses a start of authority (SOA) type DNS query. For instance, if the value of **DomainName** is `corp.contoso.com`, From 3bb3b4da85f694dab74e5218af5199f5af4293b2 Mon Sep 17 00:00:00 2001 From: Robert Biddle Date: Mon, 1 May 2023 13:36:29 -0400 Subject: [PATCH 263/650] Update docset/winserver2022-ps/addsdeployment/Install-ADDSDomainController.md Co-authored-by: Mikey Lombardi (He/Him) --- .../addsdeployment/Install-ADDSDomainController.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docset/winserver2022-ps/addsdeployment/Install-ADDSDomainController.md b/docset/winserver2022-ps/addsdeployment/Install-ADDSDomainController.md index 258fbefbd2..d4e1ae873d 100644 --- a/docset/winserver2022-ps/addsdeployment/Install-ADDSDomainController.md +++ b/docset/winserver2022-ps/addsdeployment/Install-ADDSDomainController.md @@ -74,8 +74,8 @@ The `Install-ADDSDomainController` cmdlet installs a domain controller in Active Install-ADDSDomainController -InstallDns -DomainName "corp.contoso.com" ``` -This command installs a domain controller and DNS server in the corp.contoso.com domain using -CORP\Administrator credentials and prompts the user to provide and confirm the Directory Services +This command installs a domain controller and DNS server in the `corp.contoso.com` domain using +`CORP\Administrator` credentials and prompts the user to provide and confirm the Directory Services Restore Mode (DSRM) password. ### Example 2: Install a domain controller and DNS server using administrator credentials From 37c92911bf1a7fbada887b05915fa080a1afb670 Mon Sep 17 00:00:00 2001 From: Robert Biddle Date: Mon, 1 May 2023 13:36:40 -0400 Subject: [PATCH 264/650] Update docset/winserver2022-ps/addsdeployment/Install-ADDSDomainController.md Co-authored-by: Mikey Lombardi (He/Him) --- .../addsdeployment/Install-ADDSDomainController.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docset/winserver2022-ps/addsdeployment/Install-ADDSDomainController.md b/docset/winserver2022-ps/addsdeployment/Install-ADDSDomainController.md index d4e1ae873d..13dd113404 100644 --- a/docset/winserver2022-ps/addsdeployment/Install-ADDSDomainController.md +++ b/docset/winserver2022-ps/addsdeployment/Install-ADDSDomainController.md @@ -149,8 +149,9 @@ Accept wildcard characters: False ### -AllowPasswordReplicationAccountName Specifies an array of names of user accounts, group accounts, and computer accounts whose passwords -can be replicated to this RODC. Use an empty string ("") if you want to keep the value empty. By -default, only the Allowed read-only domain controller (RODC) Password Replication Group is allowed. +can be replicated to this RODC. Use an empty string (`""`) if you want to keep the value empty. By +default, only the `Allowed` read-only domain controller (RODC) Password Replication Group is +allowed. ```yaml Type: System.String[] From f6d515891932dc1fdd602cd080852a7e6ccf6204 Mon Sep 17 00:00:00 2001 From: Robert Biddle Date: Mon, 1 May 2023 13:36:48 -0400 Subject: [PATCH 265/650] Update docset/winserver2022-ps/addsdeployment/Install-ADDSDomainController.md Co-authored-by: Mikey Lombardi (He/Him) --- .../addsdeployment/Install-ADDSDomainController.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/addsdeployment/Install-ADDSDomainController.md b/docset/winserver2022-ps/addsdeployment/Install-ADDSDomainController.md index 13dd113404..5edb22b3ba 100644 --- a/docset/winserver2022-ps/addsdeployment/Install-ADDSDomainController.md +++ b/docset/winserver2022-ps/addsdeployment/Install-ADDSDomainController.md @@ -89,7 +89,7 @@ $HashArguments = @{ Install-ADDSDomainController @HashArguments ``` -This command installs a domain controller and DNS server in the corp.contoso.com domain using +This command installs a domain controller and DNS server in the `corp.contoso.com` domain using Administrator credentials and prompts the user to provide and confirm the DSRM password. ### Example 3: Install a domain controller and DNS server that uses domain promotion From e9776a713d6da751ae3fde6835b72e8434c38c10 Mon Sep 17 00:00:00 2001 From: "Mikey Lombardi (He/Him)" Date: Tue, 2 May 2023 09:08:40 -0500 Subject: [PATCH 266/650] Remove extra newline after synopsis --- .../addsdeployment/Install-ADDSDomainController.md | 1 - 1 file changed, 1 deletion(-) diff --git a/docset/winserver2022-ps/addsdeployment/Install-ADDSDomainController.md b/docset/winserver2022-ps/addsdeployment/Install-ADDSDomainController.md index 5edb22b3ba..3a66bfb2e0 100644 --- a/docset/winserver2022-ps/addsdeployment/Install-ADDSDomainController.md +++ b/docset/winserver2022-ps/addsdeployment/Install-ADDSDomainController.md @@ -11,7 +11,6 @@ title: Install-ADDSDomainController # Install-ADDSDomainController ## SYNOPSIS - Installs a new domain controller in an Active Directory domain. ## SYNTAX From 2ee49dd35cdfa0548aa2493e3b147d287deb7e1d Mon Sep 17 00:00:00 2001 From: Michael Lombardi Date: Tue, 2 May 2023 09:10:46 -0500 Subject: [PATCH 267/650] (MAINT) Remove extra newline after synopsis header The extra newline breaks PlatyPS, I missed this during review of #3392. --- docset/winserver2022-ps/addsdeployment/Install-ADDSForest.md | 1 - 1 file changed, 1 deletion(-) diff --git a/docset/winserver2022-ps/addsdeployment/Install-ADDSForest.md b/docset/winserver2022-ps/addsdeployment/Install-ADDSForest.md index b382061ae9..96130d4aff 100644 --- a/docset/winserver2022-ps/addsdeployment/Install-ADDSForest.md +++ b/docset/winserver2022-ps/addsdeployment/Install-ADDSForest.md @@ -11,7 +11,6 @@ title: Install-ADDSForest # Install-ADDSForest ## SYNOPSIS - Creates a new Active Directory forest. ## SYNTAX From f92ca44e3c5e3b012927e5e019cccd0b46e36786 Mon Sep 17 00:00:00 2001 From: Robert Biddle Date: Sat, 29 Apr 2023 17:32:39 -0400 Subject: [PATCH 268/650] Spelling dictionary additions --- .vscode/cspell/winmodules/dictionaries/winps.txt | 1 + 1 file changed, 1 insertion(+) diff --git a/.vscode/cspell/winmodules/dictionaries/winps.txt b/.vscode/cspell/winmodules/dictionaries/winps.txt index d042a7f9a0..08b242b231 100644 --- a/.vscode/cspell/winmodules/dictionaries/winps.txt +++ b/.vscode/cspell/winmodules/dictionaries/winps.txt @@ -1,6 +1,7 @@ ADCS Dcpromo DSRM +krbtgt NTDS RODC Sysvol From 78b7129d238a7505b55a03047296b0277c2772d5 Mon Sep 17 00:00:00 2001 From: Robert Biddle Date: Sat, 29 Apr 2023 17:33:01 -0400 Subject: [PATCH 269/650] Stle guidline fixes --- ...Add-ADDSReadOnlyDomainControllerAccount.md | 126 ++++++++++++------ 1 file changed, 85 insertions(+), 41 deletions(-) diff --git a/docset/winserver2022-ps/addsdeployment/Add-ADDSReadOnlyDomainControllerAccount.md b/docset/winserver2022-ps/addsdeployment/Add-ADDSReadOnlyDomainControllerAccount.md index c098c40090..bc2430173c 100644 --- a/docset/winserver2022-ps/addsdeployment/Add-ADDSReadOnlyDomainControllerAccount.md +++ b/docset/winserver2022-ps/addsdeployment/Add-ADDSReadOnlyDomainControllerAccount.md @@ -11,39 +11,51 @@ title: Add-ADDSReadOnlyDomainControllerAccount # Add-ADDSReadOnlyDomainControllerAccount ## SYNOPSIS + Creates a RODC account that can be used to install an RODC in Active Directory. ## SYNTAX ``` -Add-ADDSReadOnlyDomainControllerAccount [-SkipPreChecks] -DomainControllerAccountName - -DomainName -SiteName [-AllowPasswordReplicationAccountName ] +Add-ADDSReadOnlyDomainControllerAccount [-SkipPreChecks] + -DomainControllerAccountName -DomainName + -SiteName [-AllowPasswordReplicationAccountName ] [-Credential ] [-DelegatedAdministratorAccountName ] [-DenyPasswordReplicationAccountName ] [-NoGlobalCatalog] [-InstallDns] [-ReplicationSourceDC ] [-Force] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION -The **Add-ADDSReadOnlyDomainControllerAccount** cmdlet creates a read-only domain controller (RODC) account that can be used to install an RODC in Active Directory. + +The `Add-ADDSReadOnlyDomainControllerAccount` cmdlet creates a read-only domain controller (RODC) +account that can be used to install an RODC in Active Directory. ## EXAMPLES ### Example 1: Add a RODC account + ``` -PS C:\> Add-ADDSReadOnlyDomainControllerAccount -DomainControllerAccountName "RODC1" -DomainName "corp.contoso.com" -SiteName "NorthAmerica" +$HashArguments = @{ + DomainControllerAccountName = "RODC1" + DomainName = "corp.contoso.com" + SiteName = "NorthAmerica" +} +Add-ADDSReadOnlyDomainControllerAccount @HashArguments ``` -This command adds a RODC account to the corp.contoso.com domain using the North America site as the source site for the replication source domain controller. +This command adds a RODC account to the corp.contoso.com domain using the North America site as the +source site for the replication source domain controller. ## PARAMETERS ### -AllowPasswordReplicationAccountName -Specifies an array of user accounts, group accounts, and computer accounts whose passwords can be replicated to this RODC. -Use None if you want to keep the value empty. -By default, only the Allowed RODC Password Replication Group is allowed, and it is originally created empty. + +Specifies an array of user accounts, group accounts, and computer accounts whose passwords can be +replicated to this RODC. Use None if you want to keep the value empty. By default, only the Allowed +RODC Password Replication Group is allowed, and it is originally created empty. ```yaml -Type: String[] +Type: System.String[] Parameter Sets: (All) Aliases: @@ -55,10 +67,11 @@ Accept wildcard characters: False ``` ### -Confirm + Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf @@ -70,11 +83,13 @@ Accept wildcard characters: False ``` ### -Credential -Specifies the user name and password that corresponds to the account used to install the domain controller. -Specify the **Get-Credential** cmdlet when using this parameter to prompt the user to supply a password. + +Specifies the user name and password that corresponds to the account used to install the domain +controller. Specify the `Get-Credential` cmdlet when using this parameter to prompt the user to +supply a password. ```yaml -Type: PSCredential +Type: System.Management.Automation.PSCredential Parameter Sets: (All) Aliases: @@ -86,10 +101,11 @@ Accept wildcard characters: False ``` ### -DelegatedAdministratorAccountName + Specifies the name of the user or group that installs and administers the RODC. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -101,13 +117,17 @@ Accept wildcard characters: False ``` ### -DenyPasswordReplicationAccountName -Specifies the names of user accounts, group accounts, and computer accounts whose passwords are not to be replicated to this RODC. -Use None if you do not want to deny the replication of credentials of any users or computers. -By default, Administrators, Server Operators, Backup Operators, Account Operators, and the Denied RODC Password Replication Group are denied. -By default, the Denied RODC Password Replication Group includes Cert Publishers, Domain Admins, Enterprise Admins, Enterprise Domain Controllers, Enterprise Read-Only Domain Controllers, Group Policy Creator Owners, the krbtgt account, and Schema Admins. + +Specifies the names of user accounts, group accounts, and computer accounts whose passwords are not +to be replicated to this RODC. Use None if you do not want to deny the replication of credentials of +any users or computers. By default, Administrators, Server Operators, Backup Operators, Account +Operators, and the Denied RODC Password Replication Group are denied. By default, the Denied RODC +Password Replication Group includes Cert Publishers, Domain Admins, Enterprise Admins, Enterprise +Domain Controllers, Enterprise Read-Only Domain Controllers, Group Policy Creator Owners, the krbtgt +account, and Schema Admins. ```yaml -Type: String[] +Type: System.String[] Parameter Sets: (All) Aliases: @@ -119,10 +139,11 @@ Accept wildcard characters: False ``` ### -DomainControllerAccountName + Specifies the name of the RODC account that this cmdlet creates. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -134,12 +155,13 @@ Accept wildcard characters: False ``` ### -DomainName -Specifies the domain name for the user name for the operation. -This parameter is required. -It also helps to specify the forest where you plan to install the domain controller or create an RODC account. + +Specifies the domain name for the user name for the operation. This parameter is required. It also +helps to specify the forest where you plan to install the domain controller or create an RODC +account. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -151,10 +173,11 @@ Accept wildcard characters: False ``` ### -Force + Forces the command to run without asking for user confirmation. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -166,11 +189,12 @@ Accept wildcard characters: False ``` ### -InstallDns -Indicates that the cmdlet installs the DNS Server service. -If no value is provided, the default behavior is to automatically compute DNS configuration behavior based upon the existing environment. + +Indicates that the cmdlet installs the DNS Server service. If no value is provided, the default +behavior is to automatically compute DNS configuration behavior based upon the existing environment. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -182,10 +206,11 @@ Accept wildcard characters: False ``` ### -NoGlobalCatalog + Indicates that the cmdlet does not set the RODC as a global catalog server. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -197,10 +222,11 @@ Accept wildcard characters: False ``` ### -ReplicationSourceDC + Specifies the name of the domain controller to be used as the source for replicating to this RODC. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -212,10 +238,11 @@ Accept wildcard characters: False ``` ### -SiteName + Specifies the name of an existing site where you can place the new domain controller. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -227,13 +254,17 @@ Accept wildcard characters: False ``` ### -SkipPreChecks -Indicates that the cmdlet executes only a base set of validations. -This behavior is equivalent to the validations that were performed when using Dcpromo.exe in earlier versions of Windows Server to add a domain controller. -When this switch parameter is set, it specifies that additional preliminary checks should be bypassed. -For more information on the scope of these additional preliminary checks that the ADDSDeployment module performs by default when using Windows Server 2012, refer to the table in the section ADPrep and Prerequisite Checking Architecture in [AD DS Simplified Administration](https://go.microsoft.com/fwlink/?LinkID=237244). + +Indicates that the cmdlet executes only a base set of validations. This behavior is equivalent to +the validations that were performed when using `Dcpromo.exe` in earlier versions of Windows Server +to add a domain controller. When this switch parameter is set, it specifies that additional +preliminary checks should be bypassed. For more information on the scope of these additional +preliminary checks that the ADDSDeployment module performs by default when using Windows Server +2012, refer to the table in the section ADPrep and Prerequisite Checking Architecture in +[AD DS Simplified Administration](https://go.microsoft.com/fwlink/?LinkID=237244). ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -245,11 +276,12 @@ Accept wildcard characters: False ``` ### -WhatIf + Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi @@ -261,15 +293,28 @@ Accept wildcard characters: False ``` ### CommonParameters -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). + +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). ## INPUTS ## OUTPUTS ## NOTES -* Once you have added the RODC account, you can add an RODC to a server computer by using the **Install-ADDSDomainController** cmdlet with the *ReadOnlyReplica* switch parameter. -* You can also delegate the ability to attach the server to a non-administrative group or user. If you are deploying RODCs in delegated administration scenarios where the machine accounts are pre-provisioned, creating the RODC account is the first stage of the RODC installation process and needs to be done by a member of the Domain Admins group. In these scenarios, once an administrator uses this cmdlet to add the RODC account in Active Directory Domain Services (AD DS), the second stage of the installation can occur. This involves attaching an actual server computer in a remote location (such as a branch office) that will operate as the RODC for the specified account created using this cmdlet. + +- Once you have added the RODC account, you can add an RODC to a server computer by using the + `Install-ADDSDomainController` cmdlet with the `-ReadOnlyReplica` switch parameter. +- You can also delegate the ability to attach the server to a non-administrative group or user. If + you are deploying RODCs in delegated administration scenarios where the machine accounts are + pre-provisioned, creating the RODC account is the first stage of the RODC installation process and + needs to be done by a member of the Domain Admins group. In these scenarios, once an administrator + uses this cmdlet to add the RODC account in Active Directory Domain Services (AD DS), the second + stage of the installation can occur. This involves attaching an actual server computer in a remote + location (such as a branch office) that will operate as the RODC for the specified account created + using this cmdlet. ## RELATED LINKS @@ -278,4 +323,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Install-ADDSDomainController](./Install-ADDSDomainController.md) [Get-Credential](https://go.microsoft.com/fwlink/?LinkID=293936) - From ee88d54450d137a50a28f0a39e659cd99406a179 Mon Sep 17 00:00:00 2001 From: Robert Biddle Date: Sat, 29 Apr 2023 17:56:49 -0400 Subject: [PATCH 270/650] Update Add-ADDSReadOnlyDomainControllerAccount.md Add powershell to code block --- .../addsdeployment/Add-ADDSReadOnlyDomainControllerAccount.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/addsdeployment/Add-ADDSReadOnlyDomainControllerAccount.md b/docset/winserver2022-ps/addsdeployment/Add-ADDSReadOnlyDomainControllerAccount.md index bc2430173c..dae481132f 100644 --- a/docset/winserver2022-ps/addsdeployment/Add-ADDSReadOnlyDomainControllerAccount.md +++ b/docset/winserver2022-ps/addsdeployment/Add-ADDSReadOnlyDomainControllerAccount.md @@ -34,7 +34,7 @@ account that can be used to install an RODC in Active Directory. ### Example 1: Add a RODC account -``` +```powershell $HashArguments = @{ DomainControllerAccountName = "RODC1" DomainName = "corp.contoso.com" From 116a08ff1ee221e8c903268fdf5932bb85076072 Mon Sep 17 00:00:00 2001 From: Robert Biddle Date: Mon, 1 May 2023 13:50:47 -0400 Subject: [PATCH 271/650] Update docset/winserver2022-ps/addsdeployment/Add-ADDSReadOnlyDomainControllerAccount.md Co-authored-by: Mikey Lombardi (He/Him) --- .../addsdeployment/Add-ADDSReadOnlyDomainControllerAccount.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/addsdeployment/Add-ADDSReadOnlyDomainControllerAccount.md b/docset/winserver2022-ps/addsdeployment/Add-ADDSReadOnlyDomainControllerAccount.md index dae481132f..2bc3663883 100644 --- a/docset/winserver2022-ps/addsdeployment/Add-ADDSReadOnlyDomainControllerAccount.md +++ b/docset/winserver2022-ps/addsdeployment/Add-ADDSReadOnlyDomainControllerAccount.md @@ -43,7 +43,7 @@ $HashArguments = @{ Add-ADDSReadOnlyDomainControllerAccount @HashArguments ``` -This command adds a RODC account to the corp.contoso.com domain using the North America site as the +This command adds a RODC account to the `corp.contoso.com` domain using the North America site as the source site for the replication source domain controller. ## PARAMETERS From 5dfd01feb99e213154727c0483b063feb3476ee9 Mon Sep 17 00:00:00 2001 From: Robert Biddle Date: Mon, 1 May 2023 13:50:56 -0400 Subject: [PATCH 272/650] Update docset/winserver2022-ps/addsdeployment/Add-ADDSReadOnlyDomainControllerAccount.md Co-authored-by: Mikey Lombardi (He/Him) --- .../addsdeployment/Add-ADDSReadOnlyDomainControllerAccount.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/addsdeployment/Add-ADDSReadOnlyDomainControllerAccount.md b/docset/winserver2022-ps/addsdeployment/Add-ADDSReadOnlyDomainControllerAccount.md index 2bc3663883..2359ddaa2b 100644 --- a/docset/winserver2022-ps/addsdeployment/Add-ADDSReadOnlyDomainControllerAccount.md +++ b/docset/winserver2022-ps/addsdeployment/Add-ADDSReadOnlyDomainControllerAccount.md @@ -259,7 +259,7 @@ Indicates that the cmdlet executes only a base set of validations. This behavior the validations that were performed when using `Dcpromo.exe` in earlier versions of Windows Server to add a domain controller. When this switch parameter is set, it specifies that additional preliminary checks should be bypassed. For more information on the scope of these additional -preliminary checks that the ADDSDeployment module performs by default when using Windows Server +preliminary checks that the **ADDSDeployment** module performs by default when using Windows Server 2012, refer to the table in the section ADPrep and Prerequisite Checking Architecture in [AD DS Simplified Administration](https://go.microsoft.com/fwlink/?LinkID=237244). From 5457c7b02acac8478f8aa402227b839b64bd4630 Mon Sep 17 00:00:00 2001 From: "Mikey Lombardi (He/Him)" Date: Tue, 2 May 2023 09:02:00 -0500 Subject: [PATCH 273/650] Remove blank line after synopsis. --- .../addsdeployment/Add-ADDSReadOnlyDomainControllerAccount.md | 1 - 1 file changed, 1 deletion(-) diff --git a/docset/winserver2022-ps/addsdeployment/Add-ADDSReadOnlyDomainControllerAccount.md b/docset/winserver2022-ps/addsdeployment/Add-ADDSReadOnlyDomainControllerAccount.md index 2359ddaa2b..eadb4ec3ca 100644 --- a/docset/winserver2022-ps/addsdeployment/Add-ADDSReadOnlyDomainControllerAccount.md +++ b/docset/winserver2022-ps/addsdeployment/Add-ADDSReadOnlyDomainControllerAccount.md @@ -11,7 +11,6 @@ title: Add-ADDSReadOnlyDomainControllerAccount # Add-ADDSReadOnlyDomainControllerAccount ## SYNOPSIS - Creates a RODC account that can be used to install an RODC in Active Directory. ## SYNTAX From 61eccb713b95d56a316872f8333ba795bee8606a Mon Sep 17 00:00:00 2001 From: Robert Biddle Date: Sat, 29 Apr 2023 18:16:14 -0400 Subject: [PATCH 274/650] Style guide fixes --- .../Test-ADDSDomainControllerInstallation.md | 380 +++++++++++------- 1 file changed, 238 insertions(+), 142 deletions(-) diff --git a/docset/winserver2022-ps/addsdeployment/Test-ADDSDomainControllerInstallation.md b/docset/winserver2022-ps/addsdeployment/Test-ADDSDomainControllerInstallation.md index 0a64bebc17..d83801b005 100644 --- a/docset/winserver2022-ps/addsdeployment/Test-ADDSDomainControllerInstallation.md +++ b/docset/winserver2022-ps/addsdeployment/Test-ADDSDomainControllerInstallation.md @@ -11,82 +11,121 @@ title: Test-ADDSDomainControllerInstallation # Test-ADDSDomainControllerInstallation ## SYNOPSIS + Runs the prerequisites (only) for installing a domain controller in Active Directory. ## SYNTAX ### ADDSDomainController (Default) + ``` -Test-ADDSDomainControllerInstallation -DomainName [-SafeModeAdministratorPassword ] - [-SiteName ] [-ADPrepCredential ] [-AllowDomainControllerReinstall] - [-ApplicationPartitionsToReplicate ] [-CreateDnsDelegation] [-Credential ] - [-CriticalReplicationOnly] [-DatabasePath ] [-DnsDelegationCredential ] - [-NoDnsOnNetwork] [-NoGlobalCatalog] [-InstallationMediaPath ] [-InstallDns] [-LogPath ] - [-MoveInfrastructureOperationMasterRoleIfNecessary] [-NoRebootOnCompletion] [-ReplicationSourceDC ] - [-SkipAutoConfigureDns] [-SystemKey ] [-SysvolPath ] [-Force] [] +Test-ADDSDomainControllerInstallation -DomainName + [-SafeModeAdministratorPassword ] [-SiteName ] + [-ADPrepCredential ] [-AllowDomainControllerReinstall] + [-ApplicationPartitionsToReplicate ] [-CreateDnsDelegation] + [-Credential ] [-CriticalReplicationOnly] [-DatabasePath ] + [-DnsDelegationCredential ] [-NoDnsOnNetwork] [-NoGlobalCatalog] + [-InstallationMediaPath ] [-InstallDns] [-LogPath ] + [-MoveInfrastructureOperationMasterRoleIfNecessary] [-NoRebootOnCompletion] + [-ReplicationSourceDC ] [-SkipAutoConfigureDns] [-SystemKey ] + [-SysvolPath ] [-Force] [] ``` ### ADDSDomainControllerReadOnly + ``` -Test-ADDSDomainControllerInstallation -DomainName [-SafeModeAdministratorPassword ] - -SiteName [-ADPrepCredential ] [-AllowDomainControllerReinstall] - [-AllowPasswordReplicationAccountName ] [-ApplicationPartitionsToReplicate ] - [-Credential ] [-CriticalReplicationOnly] [-DatabasePath ] - [-DelegatedAdministratorAccountName ] [-DenyPasswordReplicationAccountName ] - [-NoDnsOnNetwork] [-NoGlobalCatalog] [-InstallationMediaPath ] [-InstallDns] [-LogPath ] - [-MoveInfrastructureOperationMasterRoleIfNecessary] [-ReadOnlyReplica] [-NoRebootOnCompletion] - [-ReplicationSourceDC ] [-SkipAutoConfigureDns] [-SystemKey ] [-SysvolPath ] - [-Force] [] +Test-ADDSDomainControllerInstallation -DomainName + [-SafeModeAdministratorPassword ] -SiteName + [-ADPrepCredential ] [-AllowDomainControllerReinstall] + [-AllowPasswordReplicationAccountName ] + [-ApplicationPartitionsToReplicate ] [-Credential ] + [-CriticalReplicationOnly] [-DatabasePath ] + [-DelegatedAdministratorAccountName ] + [-DenyPasswordReplicationAccountName ] [-NoDnsOnNetwork] [-NoGlobalCatalog] + [-InstallationMediaPath ] [-InstallDns] [-LogPath ] + [-MoveInfrastructureOperationMasterRoleIfNecessary] [-ReadOnlyReplica] + [-NoRebootOnCompletion] [-ReplicationSourceDC ] [-SkipAutoConfigureDns] + [-SystemKey ] [-SysvolPath ] [-Force] [] ``` ### ADDSDomainControllerUseExistingAccount + ``` -Test-ADDSDomainControllerInstallation -DomainName [-SafeModeAdministratorPassword ] - [-ADPrepCredential ] [-ApplicationPartitionsToReplicate ] [-Credential ] - [-CriticalReplicationOnly] [-DatabasePath ] [-NoDnsOnNetwork] [-InstallationMediaPath ] - [-LogPath ] [-NoRebootOnCompletion] [-ReplicationSourceDC ] [-SkipAutoConfigureDns] - [-SystemKey ] [-SysvolPath ] [-UseExistingAccount] [-Force] [] +Test-ADDSDomainControllerInstallation -DomainName + [-SafeModeAdministratorPassword ] [-ADPrepCredential ] + [-ApplicationPartitionsToReplicate ] [-Credential ] + [-CriticalReplicationOnly] [-DatabasePath ] [-NoDnsOnNetwork] + [-InstallationMediaPath ] [-LogPath ] [-NoRebootOnCompletion] + [-ReplicationSourceDC ] [-SkipAutoConfigureDns] [-SystemKey ] + [-SysvolPath ] [-UseExistingAccount] [-Force] [] ``` ## DESCRIPTION -The **Test-ADDSDomainControllerInstallation** cmdlet runs those prerequisite checks (only) which would be performed if you were to use the **Install-ADDSDomainController** cmdlet to install a domain controller in Active Directory. -It differs from using the *WhatIf* parameter with the **Install-ADDSDomainController** cmdlet in that instead of summarizing the changes that would occur during the installation process, this cmdlet actually tests whether those changes are possible given the current environment. -For more information on the scope of these prerequisite checks that the ADDSDeployment module performs when using this cmdlet see the section ADPrep and Prerequisite Checking Architecture in [AD DS Simplified Administration](https://go.microsoft.com/fwlink/?LinkID=237244). +The `Test-ADDSDomainControllerInstallation` cmdlet runs those prerequisite checks (only) which would +be performed if you were to use the `Install-ADDSDomainController` cmdlet to install a domain +controller in Active Directory. It differs from using the `-WhatIf` parameter with the +`Install-ADDSDomainController` cmdlet in that instead of summarizing the changes that would occur +during the installation process, this cmdlet actually tests whether those changes are possible given +the current environment. + +For more information on the scope of these prerequisite checks that the ADDSDeployment module +performs when using this cmdlet see the section ADPrep and Prerequisite Checking Architecture in +[AD DS Simplified Administration](https://go.microsoft.com/fwlink/?LinkID=237244). ## EXAMPLES ### Example 1: Test if the installation of domain controller is possible -``` -PS C:\> Test-ADDSDomainControllerInstallation -InstallDns -Credential (Get-Credential CORP\Administrator) -DomainName "corp.contoso.com" + +```powershell +$HashArguments = @{ + Credential = (Get-Credential CORP\Administrator) + DomainName = "corp.contoso.com" + InstallDns = $true +} +Test-ADDSDomainControllerInstallation @HashArguments ``` -This command runs the prerequisites to determine if installing a domain controller is possible that includes a DNS server for the corp.contoso.com domain using domain administrator credentials. -The command also prompts the user to enter and confirm the Directory Services Restore Mode (DSRM) password. +This command runs the prerequisites to determine if installing a domain controller is possible that +includes a DNS server for the corp.contoso.com domain using domain administrator credentials. The +command also prompts the user to enter and confirm the Directory Services Restore Mode (DSRM) +password. ### Example 2: Test if the installation of domain controller and DNS server is possible -``` -PS C:\> Test-ADDSDomainControllerInstallation -InstallDns -DomainName "corp.contoso.com " + +```powershell +Test-ADDSDomainControllerInstallation -InstallDns -DomainName "corp.contoso.com" ``` -This command runs the prerequisites to determine if installing a domain controller along with the DNS server in the corp.contoso.com domain. -The command also prompts the user to enter and confirm the DSRM password. +This command runs the prerequisites to determine if installing a domain controller along with the +DNS server in the corp.contoso.com domain. The command also prompts the user to enter and confirm +the DSRM password. -### Example 3: Test if the installation of domain controller is possible using Administrator credentials -``` -PS C:\> Test-ADDSDomainControllerInstallation -InstallDns -Credential (Get-Credential) -DomainName (Read-Host "Domain to promote into") +### Example 3: Test if installation of domain controller is possible using Administrator credentials + +```powershell +$HashArguments = @{ + Credential = (Get-Credential) + DomainName = (Read-Host "Domain to promote into") + InstallDns = $true +} +Test-ADDSDomainControllerInstallation @HashArguments ``` -This command runs the prerequisites to determine if installing a domain controller along with a DNS server and that will cause the user to be prompted for Administrator credentials as well as whether the domain name is possible and if the user is prompted to enter and confirm the DSRM password. +This command runs the prerequisites to determine if installing a domain controller along with a DNS +server and that will cause the user to be prompted for Administrator credentials as well as whether +the domain name is possible and if the user is prompted to enter and confirm the DSRM password. ## PARAMETERS ### -ADPrepCredential -Specifies the user name and password that corresponds to the account to be used for running operations (if they are required) to prepare Active Directory prior to the installation of this domain. -Use the **Get-Credential** cmdlet to prompt the user to supply a password. + +Specifies the user name and password that corresponds to the account to be used for running +operations (if they are required) to prepare Active Directory prior to the installation of this +domain. Use the `Get-Credential` cmdlet to prompt the user to supply a password. ```yaml -Type: PSCredential +Type: System.Management.Automation.PSCredential Parameter Sets: (All) Aliases: @@ -98,11 +137,14 @@ Accept wildcard characters: False ``` ### -AllowDomainControllerReinstall -Indicates that the cmdlet continues to install this domain controller, despite the fact that another domain controller account with the same name is detected. -By default, the **Install-ADDSDomainController** cmdlet does not continue to install if another domain controller with the same name is found. + +Indicates that the cmdlet continues to install this domain controller, despite the fact that another +domain controller account with the same name is detected. By default, the +`Install-ADDSDomainController` cmdlet does not continue to install if another domain controller with +the same name is found. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: ADDSDomainController, ADDSDomainControllerReadOnly Aliases: @@ -114,12 +156,13 @@ Accept wildcard characters: False ``` ### -AllowPasswordReplicationAccountName -Specifies an array of names of user accounts, group accounts, and computer accounts whose passwords can be replicated to this RODC. -Use an empty string ("") if you want to keep the value empty. -By default, only the Allowed read-only domain controller (RODC) Password Replication Group is allowed. + +Specifies an array of names of user accounts, group accounts, and computer accounts whose passwords +can be replicated to this RODC. Use an empty string ("") if you want to keep the value empty. By +default, only the Allowed read-only domain controller (RODC) Password Replication Group is allowed. ```yaml -Type: String[] +Type: System.String[] Parameter Sets: ADDSDomainControllerReadOnly Aliases: @@ -131,12 +174,13 @@ Accept wildcard characters: False ``` ### -ApplicationPartitionsToReplicate -Specifies an array of application directory partitions that DCPromo replicates. -Use the following format: "partition1" "partition2" "partitionN". -Use * to replicate all application directory partitions. + +Specifies an array of application directory partitions that DCPromo replicates. Use the following +format: "partition1" "partition2" "partitionN". Use * to replicate all application directory +partitions. ```yaml -Type: String[] +Type: System.String[] Parameter Sets: (All) Aliases: @@ -148,14 +192,15 @@ Accept wildcard characters: False ``` ### -CreateDnsDelegation -Indicates that the cmdlet creates a DNS delegation that references the new DNS server that you are installing along with the domain controller. -Valid for Active Directory-integrated DNS only. -If this parameter is specified then the DNS delegation is created. -If the value of $False is specified then no DNS delegation is created. -By default, the value for this parameter is computed automatically based on the environment. + +Indicates that the cmdlet creates a DNS delegation that references the new DNS server that you are +installing along with the domain controller. Valid for Active Directory-integrated DNS only. If this +parameter is specified then the DNS delegation is created. If the value of $False is specified then +no DNS delegation is created. By default, the value for this parameter is computed automatically +based on the environment. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: ADDSDomainController Aliases: @@ -167,11 +212,12 @@ Accept wildcard characters: False ``` ### -Credential -Specifies the user name and password that corresponds to the account used to install the domain controller. -Use the **Get-Credential** cmdlet to prompt the user to supply a password. + +Specifies the user name and password that corresponds to the account used to install the domain +controller. Use the `Get-Credential` cmdlet to prompt the user to supply a password. ```yaml -Type: PSCredential +Type: System.Management.Automation.PSCredential Parameter Sets: (All) Aliases: @@ -183,13 +229,15 @@ Accept wildcard characters: False ``` ### -CriticalReplicationOnly -Indicates that the cmdlet performs only critical replication before reboot and then continues during the AD DS installation operation. -This parameter will skip the noncritical and potentially lengthy portion of replication. -The noncritical replication happens after the installation finishes and the computer reboots. -By default, the cmdlet performs both critical and noncritical portions of the replication. + +Indicates that the cmdlet performs only critical replication before reboot and then continues during +the AD DS installation operation. This parameter will skip the noncritical and potentially lengthy +portion of replication. The noncritical replication happens after the installation finishes and the +computer reboots. By default, the cmdlet performs both critical and noncritical portions of the +replication. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -201,11 +249,13 @@ Accept wildcard characters: False ``` ### -DatabasePath -Specifies the fully qualified, non-Universal Naming Convention (UNC) path to a directory on a fixed disk of the local computer that will contain the domain database, for instance, C:\Windows\NTDS. -The default is %SYSTEMROOT%\NTDS. + +Specifies the fully qualified, non-Universal Naming Convention (UNC) path to a directory on a fixed +disk of the local computer that will contain the domain database, for instance, `C:\Windows\NTDS`. +The default is `%SYSTEMROOT%\NTDS`. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -217,10 +267,12 @@ Accept wildcard characters: False ``` ### -DelegatedAdministratorAccountName -Specifies the name of the user or group that is the delegated administrator of this domain controller. + +Specifies the name of the user or group that is the delegated administrator of this domain +controller. ```yaml -Type: String +Type: System.String Parameter Sets: ADDSDomainControllerReadOnly Aliases: @@ -232,13 +284,17 @@ Accept wildcard characters: False ``` ### -DenyPasswordReplicationAccountName -Specifies an array of names of user accounts, group accounts, and computer accounts whose passwords are not to be replicated to this RODC. -Use an empty string ("") if you do not want to deny the replication of credentials of any users or computers. -By default, Administrators, Server Operators, Backup Operators, Account Operators, and the Denied RODC Password Replication Group are denied. -By default, the Denied RODC Password Replication Group includes Cert Publishers, Domain Admins, Enterprise Admins, Enterprise Domain Controllers, Enterprise Read-Only Domain Controllers, Group Policy Creator Owners, the krbtgt account, and Schema Admins. + +Specifies an array of names of user accounts, group accounts, and computer accounts whose passwords +are not to be replicated to this RODC. Use an empty string ("") if you do not want to deny the +replication of credentials of any users or computers. By default, Administrators, Server Operators, +Backup Operators, Account Operators, and the Denied RODC Password Replication Group are denied. By +default, the Denied RODC Password Replication Group includes Cert Publishers, Domain Admins, +Enterprise Admins, Enterprise Domain Controllers, Enterprise Read-Only Domain Controllers, Group +Policy Creator Owners, the krbtgt account, and Schema Admins. ```yaml -Type: String[] +Type: System.String[] Parameter Sets: ADDSDomainControllerReadOnly Aliases: @@ -250,11 +306,13 @@ Accept wildcard characters: False ``` ### -DnsDelegationCredential -Specifies the user name and password for creating DNS delegation. -The cmdlet will skip the parameter if the value for the *CreateDnsDelegation* parameter is either specified or computed to be $False. + +Specifies the user name and password for creating DNS delegation. The cmdlet will skip the parameter +if the value for the `-CreateDnsDelegation` parameter is either specified or computed to be +`$False`. ```yaml -Type: PSCredential +Type: System.Management.Automation.PSCredential Parameter Sets: ADDSDomainController Aliases: @@ -266,10 +324,12 @@ Accept wildcard characters: False ``` ### -DomainName -Specifies the fully qualified domain name (FQDN) for the domain where the domain controller is installed or added. + +Specifies the fully qualified domain name (FQDN) for the domain where the domain controller is +installed or added. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -281,10 +341,11 @@ Accept wildcard characters: False ``` ### -Force + Forces the command to run without asking for user confirmation. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -296,15 +357,20 @@ Accept wildcard characters: False ``` ### -InstallDns + Indicates that the cmdlet installs and configures the DNS Server service on the domain controller. -For domain controller installation, if this parameter is left unspecified and the current domain already hosts and stores the DNS names for the domain, then the default for this parameter is $True and the DNS server is installed. -Otherwise, if DNS domain names are hosted outside of Active Directory, the default is $False and no DNS server is installed. +For domain controller installation, if this parameter is left unspecified and the current domain +already hosts and stores the DNS names for the domain, then the default for this parameter is $True +and the DNS server is installed. Otherwise, if DNS domain names are hosted outside of Active +Directory, the default is $False and no DNS server is installed. -To test if DNS domain names are hosted outside of Active Directory, this cmdlet uses a start of authority (SOA) type DNS query. -For example, if the value of the *DomainName* parameter is corp.contoso.com, Active Directory performs an SOA query for corp.contoso.com and ensures that the zone name in the response is corp.contoso.com. +To test if DNS domain names are hosted outside of Active Directory, this cmdlet uses a start of +authority (SOA) type DNS query. For example, if the value of the `-DomainName` parameter is +corp.contoso.com, Active Directory performs an SOA query for corp.contoso.com and ensures that the +zone name in the response is corp.contoso.com. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: ADDSDomainController, ADDSDomainControllerReadOnly Aliases: @@ -316,10 +382,11 @@ Accept wildcard characters: False ``` ### -InstallationMediaPath + Specifies the location of the installation media that is used to install a new domain controller. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -331,11 +398,13 @@ Accept wildcard characters: False ``` ### -LogPath -Specifies the fully qualified, non-UNC path to a directory on a fixed disk of the local computer that will contain the domain log files, for instance, C:\Windows\Logs. -The default is %SYSTEMROOT%\NTDS. + +Specifies the fully qualified, non-UNC path to a directory on a fixed disk of the local computer +that will contain the domain log files, for instance, `C:\Windows\Logs`. The default is +`%SYSTEMROOT%\NTDS`. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -347,12 +416,14 @@ Accept wildcard characters: False ``` ### -MoveInfrastructureOperationMasterRoleIfNecessary -Indicates that the cmdlet transfers the infrastructure master role to the domain controller that you create in case the transfer is needed. -You cannot use the *NoGlobalCatalog* parameter when specifying this parameter. -Do not specify this parameter if you want the infrastructure master role to remain where it currently is. + +Indicates that the cmdlet transfers the infrastructure master role to the domain controller that you +create in case the transfer is needed. You cannot use the `-NoGlobalCatalog` parameter when +specifying this parameter. Do not specify this parameter if you want the infrastructure master role +to remain where it currently is. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: ADDSDomainController, ADDSDomainControllerReadOnly Aliases: @@ -364,16 +435,20 @@ Accept wildcard characters: False ``` ### -NoDnsOnNetwork -Indicates that the DNS service is not available on the network. -This parameter is used only when the IP setting of the network adapter for this computer is not configured with the name of a DNS server for name resolution. -It indicates that a DNS server is installed on this computer for name resolution. -Otherwise, the IP settings of the network adapter must first be configured with the address of a DNS server. -Omitting this parameter (the default) indicates that the TCP/IP client settings of the network adapter on this server computer is used to contact a DNS server. -Therefore, if you do not specify this parameter, ensure that TCP/IP client settings are first configured with a preferred DNS server address. +Indicates that the DNS service is not available on the network. This parameter is used only when the +IP setting of the network adapter for this computer is not configured with the name of a DNS server +for name resolution. It indicates that a DNS server is installed on this computer for name +resolution. Otherwise, the IP settings of the network adapter must first be configured with the +address of a DNS server. + +Omitting this parameter (the default) indicates that the TCP/IP client settings of the network +adapter on this server computer is used to contact a DNS server. Therefore, if you do not specify +this parameter, ensure that TCP/IP client settings are first configured with a preferred DNS server +address. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -385,11 +460,12 @@ Accept wildcard characters: False ``` ### -NoGlobalCatalog -Indicates that the read-only domain controller (RODC) is not a global catalog server. -By default, the domain controller that you are installing is a global catalog server. + +Indicates that the read-only domain controller (RODC) is not a global catalog server. By default, +the domain controller that you are installing is a global catalog server. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: ADDSDomainController, ADDSDomainControllerReadOnly Aliases: @@ -401,12 +477,16 @@ Accept wildcard characters: False ``` ### -NoRebootOnCompletion -Indicates that the cmdlet does not restart the computer upon the completion of the operation to install the domain controller. -By default, if this parameter is omitted the computer restarts upon the completion of the install operation. -As a general rule, Microsoft support recommends that you not use this parameter except for testing or troubleshooting purposes because once configuration has completed the server will not function correctly as either a member server or a domain controller until it is rebooted. + +Indicates that the cmdlet does not restart the computer upon the completion of the operation to +install the domain controller. By default, if this parameter is omitted the computer restarts upon +the completion of the install operation. As a general rule, Microsoft support recommends that you +not use this parameter except for testing or troubleshooting purposes because once configuration has +completed the server will not function correctly as either a member server or a domain controller +until it is rebooted. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -418,10 +498,11 @@ Accept wildcard characters: False ``` ### -ReadOnlyReplica + Indicates that this cmdlet installs the domain controller as an RODC for an existing domain. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: ADDSDomainControllerReadOnly Aliases: @@ -433,10 +514,12 @@ Accept wildcard characters: False ``` ### -ReplicationSourceDC -Specifies the name of the domain controller to be used as the source for replicating to this domain controller. + +Specifies the name of the domain controller to be used as the source for replicating to this domain +controller. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -448,22 +531,27 @@ Accept wildcard characters: False ``` ### -SafeModeAdministratorPassword -Supplies the password for the administrator account when the computer is started in Safe Mode or a variant of Safe Mode, such as Directory Services Restore Mode. -If no value is specified for this parameter, the cmdlet prompts you to enter and confirm a masked password. -If specified with a value, the value must be a secure string. -Supplies the password for the administrator account when the computer is started in Safe Mode or a variant of Safe Mode, such as Directory Services Restore Mode. -You must supply a password that meets the password complexity rules of the domain and the password cannot be blank. -If specified with a value, the value must be a secure string. +Supplies the password for the administrator account when the computer is started in Safe Mode or a +variant of Safe Mode, such as Directory Services Restore Mode. If no value is specified for this +parameter, the cmdlet prompts you to enter and confirm a masked password. If specified with a value, +the value must be a secure string. + +Supplies the password for the administrator account when the computer is started in Safe Mode or a +variant of Safe Mode, such as Directory Services Restore Mode. You must supply a password that meets +the password complexity rules of the domain and the password cannot be blank. If specified with a +value, the value must be a secure string. If this parameter is not specified, the cmdlet prompts you to enter and confirm a masked password. -This is the preferred usage when running the cmdlet interactively. -If additionally there are no other arguments specified with the cmdlet, you are prompted to enter a masked password for this parameter but no confirmation of the password entered is made. -This is not recommended as it could allow a mistyped password to be configured. -Another available advanced option is to use the **ConvertTo-SecureString** cmdlet and specify the password string inline as unmasked console input, which is also not a recommended security best practice in production deployments. +This is the preferred usage when running the cmdlet interactively. If additionally there are no +other arguments specified with the cmdlet, you are prompted to enter a masked password for this +parameter but no confirmation of the password entered is made. This is not recommended as it could +allow a mistyped password to be configured. Another available advanced option is to use the +`ConvertTo-SecureString` cmdlet and specify the password string inline as unmasked console input, +which is also not a recommended security best practice in production deployments. ```yaml -Type: SecureString +Type: System.Security.SecureString Parameter Sets: (All) Aliases: @@ -475,14 +563,15 @@ Accept wildcard characters: False ``` ### -SiteName -Specifies the name of an existing site where you can place the new domain controller. -The default value depends on the type of installation. -For a new forest, the default is Default-First-Site-Name. -For all other installations, the default is the site that is associated with the subnet that includes the IP address of this server. -If no such site exists, the default is the site of the replication source domain controller. + +Specifies the name of an existing site where you can place the new domain controller. The default +value depends on the type of installation. For a new forest, the default is Default-First-Site-Name. +For all other installations, the default is the site that is associated with the subnet that +includes the IP address of this server. If no such site exists, the default is the site of the +replication source domain controller. ```yaml -Type: String +Type: System.String Parameter Sets: ADDSDomainController Aliases: @@ -494,7 +583,7 @@ Accept wildcard characters: False ``` ```yaml -Type: String +Type: System.String Parameter Sets: ADDSDomainControllerReadOnly Aliases: @@ -506,11 +595,12 @@ Accept wildcard characters: False ``` ### -SkipAutoConfigureDns -Indicates that the cmdlet skips automatic configuration of DNS client settings, forwarders, and root hints. -This parameter is in effect only if the DNS Server service is already installed. + +Indicates that the cmdlet skips automatic configuration of DNS client settings, forwarders, and root +hints. This parameter is in effect only if the DNS Server service is already installed. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -522,11 +612,11 @@ Accept wildcard characters: False ``` ### -SystemKey -Specifies the system key for the media from which you replicate the data. -The default is none. + +Specifies the system key for the media from which you replicate the data. The default is none. ```yaml -Type: SecureString +Type: System.Security.SecureString Parameter Sets: (All) Aliases: @@ -538,11 +628,13 @@ Accept wildcard characters: False ``` ### -SysvolPath -Specifies the fully qualified, non-UNC path to a directory on a fixed disk of the local computer that will contain the Sysvol data, for example, C:\Windows\SYSVOL. -The default is %SYSTEMROOT%\SYSVOL. + +Specifies the fully qualified, non-UNC path to a directory on a fixed disk of the local computer +that will contain the Sysvol data, for example, `C:\Windows\SYSVOL`. The default is +`%SYSTEMROOT%\SYSVOL`. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -554,11 +646,12 @@ Accept wildcard characters: False ``` ### -UseExistingAccount -Indicates that the cmdlet attaches a server to an existing RODC account. -If specified, a member of the Domain Admins group or a delegated user can run this cmdlet. + +Indicates that the cmdlet attaches a server to an existing RODC account. If specified, a member of +the Domain Admins group or a delegated user can run this cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: ADDSDomainControllerUseExistingAccount Aliases: @@ -570,7 +663,11 @@ Accept wildcard characters: False ``` ### CommonParameters -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). + +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). ## INPUTS @@ -593,4 +690,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Get-Credential](https://go.microsoft.com/fwlink/?LinkID=293936) [ConvertTo-SecureString](https://go.microsoft.com/fwlink/p/?LinkId=113291) - From 71119fa382614b8969306f7460c563fbc1da8740 Mon Sep 17 00:00:00 2001 From: Robert Biddle Date: Mon, 1 May 2023 15:13:43 -0400 Subject: [PATCH 275/650] Update docset/winserver2022-ps/addsdeployment/Test-ADDSDomainControllerInstallation.md Co-authored-by: Mikey Lombardi (He/Him) --- .../addsdeployment/Test-ADDSDomainControllerInstallation.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docset/winserver2022-ps/addsdeployment/Test-ADDSDomainControllerInstallation.md b/docset/winserver2022-ps/addsdeployment/Test-ADDSDomainControllerInstallation.md index d83801b005..cb4f88f5d1 100644 --- a/docset/winserver2022-ps/addsdeployment/Test-ADDSDomainControllerInstallation.md +++ b/docset/winserver2022-ps/addsdeployment/Test-ADDSDomainControllerInstallation.md @@ -64,12 +64,12 @@ Test-ADDSDomainControllerInstallation -DomainName The `Test-ADDSDomainControllerInstallation` cmdlet runs those prerequisite checks (only) which would be performed if you were to use the `Install-ADDSDomainController` cmdlet to install a domain -controller in Active Directory. It differs from using the `-WhatIf` parameter with the +controller in Active Directory. It differs from using the **WhatIf** parameter with the `Install-ADDSDomainController` cmdlet in that instead of summarizing the changes that would occur during the installation process, this cmdlet actually tests whether those changes are possible given the current environment. -For more information on the scope of these prerequisite checks that the ADDSDeployment module +For more information on the scope of these prerequisite checks that the **ADDSDeployment** module performs when using this cmdlet see the section ADPrep and Prerequisite Checking Architecture in [AD DS Simplified Administration](https://go.microsoft.com/fwlink/?LinkID=237244). From 48af907a6df8843a58dc7557cfec73f31a2ef02f Mon Sep 17 00:00:00 2001 From: Robert Biddle Date: Mon, 1 May 2023 15:13:49 -0400 Subject: [PATCH 276/650] Update docset/winserver2022-ps/addsdeployment/Test-ADDSDomainControllerInstallation.md Co-authored-by: Mikey Lombardi (He/Him) --- .../addsdeployment/Test-ADDSDomainControllerInstallation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/addsdeployment/Test-ADDSDomainControllerInstallation.md b/docset/winserver2022-ps/addsdeployment/Test-ADDSDomainControllerInstallation.md index cb4f88f5d1..7b93c39245 100644 --- a/docset/winserver2022-ps/addsdeployment/Test-ADDSDomainControllerInstallation.md +++ b/docset/winserver2022-ps/addsdeployment/Test-ADDSDomainControllerInstallation.md @@ -87,7 +87,7 @@ Test-ADDSDomainControllerInstallation @HashArguments ``` This command runs the prerequisites to determine if installing a domain controller is possible that -includes a DNS server for the corp.contoso.com domain using domain administrator credentials. The +includes a DNS server for the `corp.contoso.com` domain using domain administrator credentials. The command also prompts the user to enter and confirm the Directory Services Restore Mode (DSRM) password. From 24a6291924fc5bd046160df9941a8fac45ac0204 Mon Sep 17 00:00:00 2001 From: Robert Biddle Date: Mon, 1 May 2023 15:13:55 -0400 Subject: [PATCH 277/650] Update docset/winserver2022-ps/addsdeployment/Test-ADDSDomainControllerInstallation.md Co-authored-by: Mikey Lombardi (He/Him) --- .../addsdeployment/Test-ADDSDomainControllerInstallation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/addsdeployment/Test-ADDSDomainControllerInstallation.md b/docset/winserver2022-ps/addsdeployment/Test-ADDSDomainControllerInstallation.md index 7b93c39245..a331c4779b 100644 --- a/docset/winserver2022-ps/addsdeployment/Test-ADDSDomainControllerInstallation.md +++ b/docset/winserver2022-ps/addsdeployment/Test-ADDSDomainControllerInstallation.md @@ -98,7 +98,7 @@ Test-ADDSDomainControllerInstallation -InstallDns -DomainName "corp.contoso.com" ``` This command runs the prerequisites to determine if installing a domain controller along with the -DNS server in the corp.contoso.com domain. The command also prompts the user to enter and confirm +DNS server in the `corp.contoso.com` domain. The command also prompts the user to enter and confirm the DSRM password. ### Example 3: Test if installation of domain controller is possible using Administrator credentials From 17f4c4b1e287664d7844abbd7a48f3ecf88e8269 Mon Sep 17 00:00:00 2001 From: Robert Biddle Date: Mon, 1 May 2023 15:14:01 -0400 Subject: [PATCH 278/650] Update docset/winserver2022-ps/addsdeployment/Test-ADDSDomainControllerInstallation.md Co-authored-by: Mikey Lombardi (He/Him) --- .../addsdeployment/Test-ADDSDomainControllerInstallation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/addsdeployment/Test-ADDSDomainControllerInstallation.md b/docset/winserver2022-ps/addsdeployment/Test-ADDSDomainControllerInstallation.md index a331c4779b..7fb3929473 100644 --- a/docset/winserver2022-ps/addsdeployment/Test-ADDSDomainControllerInstallation.md +++ b/docset/winserver2022-ps/addsdeployment/Test-ADDSDomainControllerInstallation.md @@ -158,7 +158,7 @@ Accept wildcard characters: False ### -AllowPasswordReplicationAccountName Specifies an array of names of user accounts, group accounts, and computer accounts whose passwords -can be replicated to this RODC. Use an empty string ("") if you want to keep the value empty. By +can be replicated to this RODC. Use an empty string (`""`) if you want to keep the value empty. By default, only the Allowed read-only domain controller (RODC) Password Replication Group is allowed. ```yaml From 5eba25995c33f1860b541c237d53c081615390d4 Mon Sep 17 00:00:00 2001 From: Robert Biddle Date: Mon, 1 May 2023 15:14:07 -0400 Subject: [PATCH 279/650] Update docset/winserver2022-ps/addsdeployment/Test-ADDSDomainControllerInstallation.md Co-authored-by: Mikey Lombardi (He/Him) --- .../addsdeployment/Test-ADDSDomainControllerInstallation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/addsdeployment/Test-ADDSDomainControllerInstallation.md b/docset/winserver2022-ps/addsdeployment/Test-ADDSDomainControllerInstallation.md index 7fb3929473..47b5087f53 100644 --- a/docset/winserver2022-ps/addsdeployment/Test-ADDSDomainControllerInstallation.md +++ b/docset/winserver2022-ps/addsdeployment/Test-ADDSDomainControllerInstallation.md @@ -176,7 +176,7 @@ Accept wildcard characters: False ### -ApplicationPartitionsToReplicate Specifies an array of application directory partitions that DCPromo replicates. Use the following -format: "partition1" "partition2" "partitionN". Use * to replicate all application directory +format: `"partition1" "partition2" "partitionN"`. Use `*` to replicate all application directory partitions. ```yaml From 7f32b1ad44ba54d7f2719ec8da70b2188c0267bc Mon Sep 17 00:00:00 2001 From: Robert Biddle Date: Mon, 1 May 2023 15:14:18 -0400 Subject: [PATCH 280/650] Update docset/winserver2022-ps/addsdeployment/Test-ADDSDomainControllerInstallation.md Co-authored-by: Mikey Lombardi (He/Him) --- .../addsdeployment/Test-ADDSDomainControllerInstallation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/addsdeployment/Test-ADDSDomainControllerInstallation.md b/docset/winserver2022-ps/addsdeployment/Test-ADDSDomainControllerInstallation.md index 47b5087f53..17d9457d41 100644 --- a/docset/winserver2022-ps/addsdeployment/Test-ADDSDomainControllerInstallation.md +++ b/docset/winserver2022-ps/addsdeployment/Test-ADDSDomainControllerInstallation.md @@ -309,7 +309,7 @@ Accept wildcard characters: False Specifies the user name and password for creating DNS delegation. The cmdlet will skip the parameter if the value for the `-CreateDnsDelegation` parameter is either specified or computed to be -`$False`. +`$false`. ```yaml Type: System.Management.Automation.PSCredential From 6e4ffb976f8edcd575ef031b5f4337d855f01185 Mon Sep 17 00:00:00 2001 From: Robert Biddle Date: Mon, 1 May 2023 15:14:24 -0400 Subject: [PATCH 281/650] Update docset/winserver2022-ps/addsdeployment/Test-ADDSDomainControllerInstallation.md Co-authored-by: Mikey Lombardi (He/Him) --- .../addsdeployment/Test-ADDSDomainControllerInstallation.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docset/winserver2022-ps/addsdeployment/Test-ADDSDomainControllerInstallation.md b/docset/winserver2022-ps/addsdeployment/Test-ADDSDomainControllerInstallation.md index 17d9457d41..ac187eacde 100644 --- a/docset/winserver2022-ps/addsdeployment/Test-ADDSDomainControllerInstallation.md +++ b/docset/winserver2022-ps/addsdeployment/Test-ADDSDomainControllerInstallation.md @@ -360,9 +360,9 @@ Accept wildcard characters: False Indicates that the cmdlet installs and configures the DNS Server service on the domain controller. For domain controller installation, if this parameter is left unspecified and the current domain -already hosts and stores the DNS names for the domain, then the default for this parameter is $True -and the DNS server is installed. Otherwise, if DNS domain names are hosted outside of Active -Directory, the default is $False and no DNS server is installed. +already hosts and stores the DNS names for the domain, then the default for this parameter is +`$true` and the DNS server is installed. Otherwise, if DNS domain names are hosted outside of +Active Directory, the default is `$false` and no DNS server is installed. To test if DNS domain names are hosted outside of Active Directory, this cmdlet uses a start of authority (SOA) type DNS query. For example, if the value of the `-DomainName` parameter is From 8ce549ca7d6c066b9eb247cc35752a269a9f1ad3 Mon Sep 17 00:00:00 2001 From: Robert Biddle Date: Mon, 1 May 2023 15:14:30 -0400 Subject: [PATCH 282/650] Update docset/winserver2022-ps/addsdeployment/Test-ADDSDomainControllerInstallation.md Co-authored-by: Mikey Lombardi (He/Him) --- .../addsdeployment/Test-ADDSDomainControllerInstallation.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docset/winserver2022-ps/addsdeployment/Test-ADDSDomainControllerInstallation.md b/docset/winserver2022-ps/addsdeployment/Test-ADDSDomainControllerInstallation.md index ac187eacde..4b67c57ed9 100644 --- a/docset/winserver2022-ps/addsdeployment/Test-ADDSDomainControllerInstallation.md +++ b/docset/winserver2022-ps/addsdeployment/Test-ADDSDomainControllerInstallation.md @@ -365,9 +365,9 @@ already hosts and stores the DNS names for the domain, then the default for this Active Directory, the default is `$false` and no DNS server is installed. To test if DNS domain names are hosted outside of Active Directory, this cmdlet uses a start of -authority (SOA) type DNS query. For example, if the value of the `-DomainName` parameter is -corp.contoso.com, Active Directory performs an SOA query for corp.contoso.com and ensures that the -zone name in the response is corp.contoso.com. +authority (SOA) type DNS query. For example, if the value of the **DomainName** parameter is +`corp.contoso.com`, Active Directory performs an SOA query for `corp.contoso.com` and ensures that +the zone name in the response is `corp.contoso.com`. ```yaml Type: System.Management.Automation.SwitchParameter From 2b8e04a3c076e8fdb509504fdbdacce12110f69b Mon Sep 17 00:00:00 2001 From: Robert Biddle Date: Mon, 1 May 2023 15:14:36 -0400 Subject: [PATCH 283/650] Update docset/winserver2022-ps/addsdeployment/Test-ADDSDomainControllerInstallation.md Co-authored-by: Mikey Lombardi (He/Him) --- .../addsdeployment/Test-ADDSDomainControllerInstallation.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docset/winserver2022-ps/addsdeployment/Test-ADDSDomainControllerInstallation.md b/docset/winserver2022-ps/addsdeployment/Test-ADDSDomainControllerInstallation.md index 4b67c57ed9..be0eda3621 100644 --- a/docset/winserver2022-ps/addsdeployment/Test-ADDSDomainControllerInstallation.md +++ b/docset/winserver2022-ps/addsdeployment/Test-ADDSDomainControllerInstallation.md @@ -417,8 +417,8 @@ Accept wildcard characters: False ### -MoveInfrastructureOperationMasterRoleIfNecessary -Indicates that the cmdlet transfers the infrastructure master role to the domain controller that you -create in case the transfer is needed. You cannot use the `-NoGlobalCatalog` parameter when +Indicates that the cmdlet transfers the infrastructure master role to the domain controller that +you create in case the transfer is needed. You cannot use the **NoGlobalCatalog** parameter when specifying this parameter. Do not specify this parameter if you want the infrastructure master role to remain where it currently is. From 63a54964d3aadf9ee99ec4af8358ae1a8a6db675 Mon Sep 17 00:00:00 2001 From: Robert Biddle Date: Mon, 1 May 2023 15:14:42 -0400 Subject: [PATCH 284/650] Update docset/winserver2022-ps/addsdeployment/Test-ADDSDomainControllerInstallation.md Co-authored-by: Mikey Lombardi (He/Him) --- .../Test-ADDSDomainControllerInstallation.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docset/winserver2022-ps/addsdeployment/Test-ADDSDomainControllerInstallation.md b/docset/winserver2022-ps/addsdeployment/Test-ADDSDomainControllerInstallation.md index be0eda3621..40bcc33a3b 100644 --- a/docset/winserver2022-ps/addsdeployment/Test-ADDSDomainControllerInstallation.md +++ b/docset/winserver2022-ps/addsdeployment/Test-ADDSDomainControllerInstallation.md @@ -565,10 +565,10 @@ Accept wildcard characters: False ### -SiteName Specifies the name of an existing site where you can place the new domain controller. The default -value depends on the type of installation. For a new forest, the default is Default-First-Site-Name. -For all other installations, the default is the site that is associated with the subnet that -includes the IP address of this server. If no such site exists, the default is the site of the -replication source domain controller. +value depends on the type of installation. For a new forest, the default is +`Default-First-Site-Name`. For all other installations, the default is the site that is associated +with the subnet that includes the IP address of this server. If no such site exists, the default is +the site of the replication source domain controller. ```yaml Type: System.String From 6e9b798ae8590f09b97df8a2d38203ebd9d46483 Mon Sep 17 00:00:00 2001 From: Robert Biddle Date: Mon, 1 May 2023 15:14:57 -0400 Subject: [PATCH 285/650] Update docset/winserver2022-ps/addsdeployment/Test-ADDSDomainControllerInstallation.md Co-authored-by: Mikey Lombardi (He/Him) --- .../addsdeployment/Test-ADDSDomainControllerInstallation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/addsdeployment/Test-ADDSDomainControllerInstallation.md b/docset/winserver2022-ps/addsdeployment/Test-ADDSDomainControllerInstallation.md index 40bcc33a3b..2d0276d68a 100644 --- a/docset/winserver2022-ps/addsdeployment/Test-ADDSDomainControllerInstallation.md +++ b/docset/winserver2022-ps/addsdeployment/Test-ADDSDomainControllerInstallation.md @@ -286,7 +286,7 @@ Accept wildcard characters: False ### -DenyPasswordReplicationAccountName Specifies an array of names of user accounts, group accounts, and computer accounts whose passwords -are not to be replicated to this RODC. Use an empty string ("") if you do not want to deny the +are not to be replicated to this RODC. Use an empty string (`""`) if you do not want to deny the replication of credentials of any users or computers. By default, Administrators, Server Operators, Backup Operators, Account Operators, and the Denied RODC Password Replication Group are denied. By default, the Denied RODC Password Replication Group includes Cert Publishers, Domain Admins, From 05e9116591b549b82c811fa711b0c68a99833887 Mon Sep 17 00:00:00 2001 From: "Mikey Lombardi (He/Him)" Date: Tue, 2 May 2023 09:02:53 -0500 Subject: [PATCH 286/650] Remove blank line after synopsis --- .../addsdeployment/Test-ADDSDomainControllerInstallation.md | 1 - 1 file changed, 1 deletion(-) diff --git a/docset/winserver2022-ps/addsdeployment/Test-ADDSDomainControllerInstallation.md b/docset/winserver2022-ps/addsdeployment/Test-ADDSDomainControllerInstallation.md index 2d0276d68a..4e4a2e37f6 100644 --- a/docset/winserver2022-ps/addsdeployment/Test-ADDSDomainControllerInstallation.md +++ b/docset/winserver2022-ps/addsdeployment/Test-ADDSDomainControllerInstallation.md @@ -11,7 +11,6 @@ title: Test-ADDSDomainControllerInstallation # Test-ADDSDomainControllerInstallation ## SYNOPSIS - Runs the prerequisites (only) for installing a domain controller in Active Directory. ## SYNTAX From d4766a7af3d5b023938b15557f76d01ec2de2ea6 Mon Sep 17 00:00:00 2001 From: Robert Biddle Date: Sat, 29 Apr 2023 18:28:58 -0400 Subject: [PATCH 287/650] Style guide fixes --- ...Test-ADDSDomainControllerUninstallation.md | 160 ++++++++++++------ 1 file changed, 104 insertions(+), 56 deletions(-) diff --git a/docset/winserver2022-ps/addsdeployment/Test-ADDSDomainControllerUninstallation.md b/docset/winserver2022-ps/addsdeployment/Test-ADDSDomainControllerUninstallation.md index 322c2dc461..3e62fbb309 100644 --- a/docset/winserver2022-ps/addsdeployment/Test-ADDSDomainControllerUninstallation.md +++ b/docset/winserver2022-ps/addsdeployment/Test-ADDSDomainControllerUninstallation.md @@ -11,52 +11,69 @@ title: Test-ADDSDomainControllerUninstallation # Test-ADDSDomainControllerUninstallation ## SYNOPSIS + Runs the prerequisites for uninstalling a domain controller in Active Directory. ## SYNTAX ### ADDSDomainControllerUninstall (Default) + ``` Test-ADDSDomainControllerUninstallation [-LocalAdministratorPassword ] - [-Credential ] [-DemoteOperationMasterRole] [-DnsDelegationRemovalCredential ] - [-IgnoreLastDCInDomainMismatch] [-IgnoreLastDnsServerForZone] [-LastDomainControllerInDomain] - [-NoRebootOnCompletion] [-RemoveApplicationPartitions] [-RemoveDnsDelegation] [-RetainDCMetadata] [-Force] + [-Credential ] [-DemoteOperationMasterRole] + [-DnsDelegationRemovalCredential ] [-IgnoreLastDCInDomainMismatch] + [-IgnoreLastDnsServerForZone] [-LastDomainControllerInDomain] [-NoRebootOnCompletion] + [-RemoveApplicationPartitions] [-RemoveDnsDelegation] [-RetainDCMetadata] [-Force] [] ``` ### ADDSDomainControllerUninstallForceRemoval + ``` Test-ADDSDomainControllerUninstallation [-LocalAdministratorPassword ] - [-Credential ] [-DemoteOperationMasterRole] [-ForceRemoval] [-NoRebootOnCompletion] [-Force] - [] + [-Credential ] [-DemoteOperationMasterRole] [-ForceRemoval] + [-NoRebootOnCompletion] [-Force] [] ``` ## DESCRIPTION -The **Test-ADDSDomainControllerUninstallation** cmdlet runs those prerequisite checks which would be performed if you were to use the Uninstall-ADDSDomainController cmdlet to uninstall a domain controller in Active Directory. -It differs from using the *WhatIf* parameter with the **Uninstall-ADDSDomainController** cmdlet in that instead of summarizing the changes that would occur during the uninstallation process, this cmdlet actually tests whether those changes are possible given the current environment. -For more information on the scope of these prerequisite checks that the ADDSDeployment module performs when using this cmdlet see the section ADPrep and Prerequisite Checking Architecture in [AD DS Simplified Administration](https://go.microsoft.com/fwlink/?LinkID=237244). +The `Test-ADDSDomainControllerUninstallation` cmdlet runs those prerequisite checks which would be +performed if you were to use the Uninstall-ADDSDomainController cmdlet to uninstall a domain +controller in Active Directory. It differs from using the `-WhatIf` parameter with the +`Uninstall-ADDSDomainController` cmdlet in that instead of summarizing the changes that would occur +during the uninstallation process, this cmdlet actually tests whether those changes are possible +given the current environment. + +For more information on the scope of these prerequisite checks that the ADDSDeployment module +performs when using this cmdlet see the section ADPrep and Prerequisite Checking Architecture in +[AD DS Simplified Administration](https://go.microsoft.com/fwlink/?LinkID=237244). ## EXAMPLES ### Example 1: Test if uninstalling a domain controller is possible -``` -PS C:\> Test-ADDSDomainControllerUninstallation + +```powershell +Test-ADDSDomainControllerUninstallation ``` -This command runs the prerequisites to determine if the uninstall of an additional domain controller in a domain is possible. -The command also prompts the user to set and confirm the local Administrator password prior to completing the uninstallation process. +This command runs the prerequisites to determine if the uninstall of an additional domain controller +in a domain is possible. The command also prompts the user to set and confirm the local +Administrator password prior to completing the uninstallation process. ## PARAMETERS ### -Credential -Specifies the user name and password that corresponds to the account used to install the domain controller. -To prompt the user to supply a password, use Runs the prerequisites (only) to determine if installing a domain controller is possible that includes a DNS server for the corp.contoso.com domain, using domain administrator credentials, and then prompts the user to correctly specify the Directory Services Restore Mode (DSRM) password. -Use the **Get-Credential** cmdlet in place of an existing *PSCredential* type. -This parameter will cause Windows PowerShell to prompt the user to enter credentials using the Windows security login UI. + +Specifies the user name and password that corresponds to the account used to install the domain +controller. To prompt the user to supply a password, use Runs the prerequisites (only) to determine +if installing a domain controller is possible that includes a DNS server for the corp.contoso.com +domain, using domain administrator credentials, and then prompts the user to correctly specify the +Directory Services Restore Mode (DSRM) password. Use the `Get-Credential` cmdlet in place of an +existing _PSCredential_ type. This parameter will cause Windows PowerShell to prompt the user to +enter credentials using the Windows security login UI. ```yaml -Type: PSCredential +Type: System.Management.Automation.PSCredential Parameter Sets: (All) Aliases: @@ -68,10 +85,12 @@ Accept wildcard characters: False ``` ### -DemoteOperationMasterRole -Indicates that forced demotion should continue even if an operations master role is discovered on domain controller from which AD DS is being removed. + +Indicates that forced demotion should continue even if an operations master role is discovered on +domain controller from which AD DS is being removed. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -83,12 +102,14 @@ Accept wildcard characters: False ``` ### -DnsDelegationRemovalCredential -Specifies the account credentials to use when you create or remove the DNS delegation. -If you do not specify a value, the account credentials that you specify for the AD DS installation or removal are used to remove the DNS delegation. -As an alternative, you can specify the asterisk (*) to prompt the user to enter credentials. + +Specifies the account credentials to use when you create or remove the DNS delegation. If you do not +specify a value, the account credentials that you specify for the AD DS installation or removal are +used to remove the DNS delegation. As an alternative, you can specify the asterisk (*) to prompt the +user to enter credentials. ```yaml -Type: PSCredential +Type: System.Management.Automation.PSCredential Parameter Sets: ADDSDomainControllerUninstall Aliases: @@ -100,10 +121,11 @@ Accept wildcard characters: False ``` ### -Force + Forces the command to run without asking for user confirmation. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -115,11 +137,13 @@ Accept wildcard characters: False ``` ### -ForceRemoval -Indicates that the cmdlet forces the removal of a domain controller. -Use this parameter to force the uninstall of AD DS if you need to remove the domain controller and do not have connectivity to other domain controllers within the domain topology. + +Indicates that the cmdlet forces the removal of a domain controller. Use this parameter to force the +uninstall of AD DS if you need to remove the domain controller and do not have connectivity to other +domain controllers within the domain topology. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: ADDSDomainControllerUninstallForceRemoval Aliases: @@ -131,12 +155,19 @@ Accept wildcard characters: False ``` ### -IgnoreLastDCInDomainMismatch -Indicates that Windows PowerShell ignores any inconsistency that it detects with the value that you specify for the *LastDomainControllerInDomain* parameter. -For instance, if you specify *LastDomainControllerInDomain* but Windows PowerShell detects that there is actually another active domain controller in the domain, you can specify the *IgnoreLastDCInDomainMismatch* parameter to have Windows PowerShell continue the removal of AD DS from the domain controller despite the inconsistency that it has detected. -Similarly, if you do not specify *LastDomainControllerInDomain* but Windows PowerShell is unable to detect that another domain controller is in the domain, you can specify *IgnoreLastDCInDomainMismatch* to have Windows PowerShell continue to remove AD DS from the domain controller. + +Indicates that Windows PowerShell ignores any inconsistency that it detects with the value that you +specify for the `-LastDomainControllerInDomain` parameter. For instance, if you specify +`-LastDomainControllerInDomain` but Windows PowerShell detects that there is actually another active +domain controller in the domain, you can specify the `-IgnoreLastDCInDomainMismatch` parameter to +have Windows PowerShell continue the removal of AD DS from the domain controller despite the +inconsistency that it has detected. Similarly, if you do not specify `-LastDomainControllerInDomain` +but Windows PowerShell is unable to detect that another domain controller is in the domain, you can +specify `-IgnoreLastDCInDomainMismatch` to have Windows PowerShell continue to remove AD DS from the +domain controller. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: ADDSDomainControllerUninstall Aliases: @@ -148,10 +179,12 @@ Accept wildcard characters: False ``` ### -IgnoreLastDnsServerForZone -Indicates that the cmdlet continues the removal of AD DS despite the fact that the domain controller is the last DNS server for one or more of the Active Directory-integrated DNS zones that it hosts. + +Indicates that the cmdlet continues the removal of AD DS despite the fact that the domain controller +is the last DNS server for one or more of the Active Directory-integrated DNS zones that it hosts. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: ADDSDomainControllerUninstall Aliases: @@ -163,10 +196,11 @@ Accept wildcard characters: False ``` ### -LastDomainControllerInDomain + Indicates that the cmdlet removes AD DS from the last controller in the domain. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: ADDSDomainControllerUninstall Aliases: @@ -178,20 +212,24 @@ Accept wildcard characters: False ``` ### -LocalAdministratorPassword -Specifies a local administrator account password when AD DS is removed from a domain controller. -In earlier releases, where uninstall of AD DS was done using Dcpromo.exe for demotion, the default was to allow an empty password for this setting. -In Windows PowerShell, the ADDS Deployment module requires that a non-empty password string value be assigned. -If a value is not provided for this parameter, you are prompted to enter a value for the password at the Windows PowerShell prompt. -The password value must be a secure string. + +Specifies a local administrator account password when AD DS is removed from a domain controller. In +earlier releases, where uninstall of AD DS was done using `Dcpromo.exe` for demotion, the default +was to allow an empty password for this setting. In Windows PowerShell, the ADDS Deployment module +requires that a non-empty password string value be assigned. If a value is not provided for this +parameter, you are prompted to enter a value for the password at the Windows PowerShell prompt. The +password value must be a secure string. If this parameter is not specified, the cmdlet prompts you to enter and confirm a masked password. -This is the preferred usage when running the cmdlet interactively. -If additionally there are no other arguments specified with the cmdlet, you are prompted to enter a masked password for this parameter but no confirmation of the password entered is made. -This is not recommended as it could allow a mistyped password to be configured. -Another available advanced option is to use the **ConvertTo-SecureString** cmdlet and specify the password string inline as unmasked console input, which is also not a recommended security best practice in production deployments. +This is the preferred usage when running the cmdlet interactively. If additionally there are no +other arguments specified with the cmdlet, you are prompted to enter a masked password for this +parameter but no confirmation of the password entered is made. This is not recommended as it could +allow a mistyped password to be configured. Another available advanced option is to use the +`ConvertTo-SecureString` cmdlet and specify the password string inline as unmasked console input, +which is also not a recommended security best practice in production deployments. ```yaml -Type: SecureString +Type: System.Security.SecureString Parameter Sets: (All) Aliases: @@ -203,11 +241,12 @@ Accept wildcard characters: False ``` ### -NoRebootOnCompletion -Indicates that the cmdlet does not restart the computer upon completion, regardless of success. -By default, reboot upon completion occurs when this cmdlet is used and this parameter is omitted. + +Indicates that the cmdlet does not restart the computer upon completion, regardless of success. By +default, reboot upon completion occurs when this cmdlet is used and this parameter is omitted. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -219,10 +258,12 @@ Accept wildcard characters: False ``` ### -RemoveApplicationPartitions -Indicates that the cmdlet removes application partitions during the removal of AD DS from a domain controller. + +Indicates that the cmdlet removes application partitions during the removal of AD DS from a domain +controller. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: ADDSDomainControllerUninstall Aliases: @@ -234,13 +275,16 @@ Accept wildcard characters: False ``` ### -RemoveDnsDelegation -Indicates that the cmdlet preserves DNS delegations that point to this DNS server from the parent DNS zone. -By default, this parameter is set to false, which means DNS delegations that point to this server from the parent DNS zone will not be retained after uninstallation of the domain controller. -This setting corresponds to the earlier Dcpromo.exe parameter default of /RemoveDNSDelegation:Yes. +Indicates that the cmdlet preserves DNS delegations that point to this DNS server from the parent +DNS zone. + +By default, this parameter is set to false, which means DNS delegations that point to this server +from the parent DNS zone will not be retained after uninstallation of the domain controller. This +setting corresponds to the earlier `Dcpromo.exe` parameter default of `/RemoveDNSDelegation:Yes`. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: ADDSDomainControllerUninstall Aliases: @@ -252,10 +296,11 @@ Accept wildcard characters: False ``` ### -RetainDCMetadata + Indicates that the domain controller should retain metadata for the domain after removal of AD DS. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: ADDSDomainControllerUninstall Aliases: @@ -267,7 +312,11 @@ Accept wildcard characters: False ``` ### CommonParameters -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). + +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). ## INPUTS @@ -284,4 +333,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Get-Credential](https://go.microsoft.com/fwlink/?LinkID=293936) [ConvertTo-SecureString](https://go.microsoft.com/fwlink/p/?LinkId=113291) - From c420690eb81ff618b9d03b730b2a384b16e1cdb1 Mon Sep 17 00:00:00 2001 From: Robert Biddle Date: Mon, 1 May 2023 15:15:25 -0400 Subject: [PATCH 288/650] Update docset/winserver2022-ps/addsdeployment/Test-ADDSDomainControllerUninstallation.md Co-authored-by: Mikey Lombardi (He/Him) --- .../Test-ADDSDomainControllerUninstallation.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docset/winserver2022-ps/addsdeployment/Test-ADDSDomainControllerUninstallation.md b/docset/winserver2022-ps/addsdeployment/Test-ADDSDomainControllerUninstallation.md index 3e62fbb309..08d4decd7d 100644 --- a/docset/winserver2022-ps/addsdeployment/Test-ADDSDomainControllerUninstallation.md +++ b/docset/winserver2022-ps/addsdeployment/Test-ADDSDomainControllerUninstallation.md @@ -38,13 +38,13 @@ Test-ADDSDomainControllerUninstallation [-LocalAdministratorPassword Date: Mon, 1 May 2023 15:15:32 -0400 Subject: [PATCH 289/650] Update docset/winserver2022-ps/addsdeployment/Test-ADDSDomainControllerUninstallation.md Co-authored-by: Mikey Lombardi (He/Him) --- .../addsdeployment/Test-ADDSDomainControllerUninstallation.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docset/winserver2022-ps/addsdeployment/Test-ADDSDomainControllerUninstallation.md b/docset/winserver2022-ps/addsdeployment/Test-ADDSDomainControllerUninstallation.md index 08d4decd7d..882e6bdde1 100644 --- a/docset/winserver2022-ps/addsdeployment/Test-ADDSDomainControllerUninstallation.md +++ b/docset/winserver2022-ps/addsdeployment/Test-ADDSDomainControllerUninstallation.md @@ -66,10 +66,10 @@ Administrator password prior to completing the uninstallation process. Specifies the user name and password that corresponds to the account used to install the domain controller. To prompt the user to supply a password, use Runs the prerequisites (only) to determine -if installing a domain controller is possible that includes a DNS server for the corp.contoso.com +if installing a domain controller is possible that includes a DNS server for the `corp.contoso.com` domain, using domain administrator credentials, and then prompts the user to correctly specify the Directory Services Restore Mode (DSRM) password. Use the `Get-Credential` cmdlet in place of an -existing _PSCredential_ type. This parameter will cause Windows PowerShell to prompt the user to +existing **PSCredential** type. This parameter will cause Windows PowerShell to prompt the user to enter credentials using the Windows security login UI. ```yaml From 7d49ba67ce133ec07ebffc6f1d3e721921af69fa Mon Sep 17 00:00:00 2001 From: Robert Biddle Date: Mon, 1 May 2023 15:15:51 -0400 Subject: [PATCH 290/650] Update docset/winserver2022-ps/addsdeployment/Test-ADDSDomainControllerUninstallation.md Co-authored-by: Mikey Lombardi (He/Him) --- .../Test-ADDSDomainControllerUninstallation.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docset/winserver2022-ps/addsdeployment/Test-ADDSDomainControllerUninstallation.md b/docset/winserver2022-ps/addsdeployment/Test-ADDSDomainControllerUninstallation.md index 882e6bdde1..2f05b7ea12 100644 --- a/docset/winserver2022-ps/addsdeployment/Test-ADDSDomainControllerUninstallation.md +++ b/docset/winserver2022-ps/addsdeployment/Test-ADDSDomainControllerUninstallation.md @@ -103,10 +103,10 @@ Accept wildcard characters: False ### -DnsDelegationRemovalCredential -Specifies the account credentials to use when you create or remove the DNS delegation. If you do not -specify a value, the account credentials that you specify for the AD DS installation or removal are -used to remove the DNS delegation. As an alternative, you can specify the asterisk (*) to prompt the -user to enter credentials. +Specifies the account credentials to use when you create or remove the DNS delegation. If you do +not specify a value, the account credentials that you specify for the AD DS installation or removal +are used to remove the DNS delegation. As an alternative, you can specify the asterisk (`*`) to +prompt the user to enter credentials. ```yaml Type: System.Management.Automation.PSCredential From debab65ac9791c4378d848b8f14d9c12d4a270e6 Mon Sep 17 00:00:00 2001 From: Robert Biddle Date: Mon, 1 May 2023 15:15:57 -0400 Subject: [PATCH 291/650] Update docset/winserver2022-ps/addsdeployment/Test-ADDSDomainControllerUninstallation.md Co-authored-by: Mikey Lombardi (He/Him) --- .../Test-ADDSDomainControllerUninstallation.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/docset/winserver2022-ps/addsdeployment/Test-ADDSDomainControllerUninstallation.md b/docset/winserver2022-ps/addsdeployment/Test-ADDSDomainControllerUninstallation.md index 2f05b7ea12..ef57b19fd6 100644 --- a/docset/winserver2022-ps/addsdeployment/Test-ADDSDomainControllerUninstallation.md +++ b/docset/winserver2022-ps/addsdeployment/Test-ADDSDomainControllerUninstallation.md @@ -157,14 +157,14 @@ Accept wildcard characters: False ### -IgnoreLastDCInDomainMismatch Indicates that Windows PowerShell ignores any inconsistency that it detects with the value that you -specify for the `-LastDomainControllerInDomain` parameter. For instance, if you specify -`-LastDomainControllerInDomain` but Windows PowerShell detects that there is actually another active -domain controller in the domain, you can specify the `-IgnoreLastDCInDomainMismatch` parameter to -have Windows PowerShell continue the removal of AD DS from the domain controller despite the -inconsistency that it has detected. Similarly, if you do not specify `-LastDomainControllerInDomain` -but Windows PowerShell is unable to detect that another domain controller is in the domain, you can -specify `-IgnoreLastDCInDomainMismatch` to have Windows PowerShell continue to remove AD DS from the -domain controller. +specify for the **LastDomainControllerInDomain** parameter. For instance, if you specify +**LastDomainControllerInDomain** but Windows PowerShell detects that there is actually another +active domain controller in the domain, you can specify the **IgnoreLastDCInDomainMismatch** +parameter to have Windows PowerShell continue the removal of AD DS from the domain controller +despite the inconsistency that it has detected. Similarly, if you do not specify +**LastDomainControllerInDomain** but Windows PowerShell is unable to detect that another domain +controller is in the domain, you can specify **IgnoreLastDCInDomainMismatch** to have Windows +PowerShell continue to remove AD DS from the domain controller. ```yaml Type: System.Management.Automation.SwitchParameter From b06c8408f83623752e5f18ddccf155344370753b Mon Sep 17 00:00:00 2001 From: Robert Biddle Date: Mon, 1 May 2023 15:16:02 -0400 Subject: [PATCH 292/650] Update docset/winserver2022-ps/addsdeployment/Test-ADDSDomainControllerUninstallation.md Co-authored-by: Mikey Lombardi (He/Him) --- .../Test-ADDSDomainControllerUninstallation.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/docset/winserver2022-ps/addsdeployment/Test-ADDSDomainControllerUninstallation.md b/docset/winserver2022-ps/addsdeployment/Test-ADDSDomainControllerUninstallation.md index ef57b19fd6..aef98b641c 100644 --- a/docset/winserver2022-ps/addsdeployment/Test-ADDSDomainControllerUninstallation.md +++ b/docset/winserver2022-ps/addsdeployment/Test-ADDSDomainControllerUninstallation.md @@ -279,9 +279,10 @@ Accept wildcard characters: False Indicates that the cmdlet preserves DNS delegations that point to this DNS server from the parent DNS zone. -By default, this parameter is set to false, which means DNS delegations that point to this server -from the parent DNS zone will not be retained after uninstallation of the domain controller. This -setting corresponds to the earlier `Dcpromo.exe` parameter default of `/RemoveDNSDelegation:Yes`. +By default, this parameter is set to `$false`, which means DNS delegations that point to this +server from the parent DNS zone will not be retained after uninstallation of the domain controller. +This setting corresponds to the earlier `Dcpromo.exe` parameter default of +`/RemoveDNSDelegation:Yes`. ```yaml Type: System.Management.Automation.SwitchParameter From 872156e4c2b881db3a91b38c0f2a49cc0e3af3a4 Mon Sep 17 00:00:00 2001 From: "Mikey Lombardi (He/Him)" Date: Tue, 2 May 2023 09:04:45 -0500 Subject: [PATCH 293/650] Remove extra newline after synopsis --- .../addsdeployment/Test-ADDSDomainControllerUninstallation.md | 1 - 1 file changed, 1 deletion(-) diff --git a/docset/winserver2022-ps/addsdeployment/Test-ADDSDomainControllerUninstallation.md b/docset/winserver2022-ps/addsdeployment/Test-ADDSDomainControllerUninstallation.md index aef98b641c..6b5e439f3d 100644 --- a/docset/winserver2022-ps/addsdeployment/Test-ADDSDomainControllerUninstallation.md +++ b/docset/winserver2022-ps/addsdeployment/Test-ADDSDomainControllerUninstallation.md @@ -11,7 +11,6 @@ title: Test-ADDSDomainControllerUninstallation # Test-ADDSDomainControllerUninstallation ## SYNOPSIS - Runs the prerequisites for uninstalling a domain controller in Active Directory. ## SYNTAX From b5f5558f7b79b40375a6bf4a061d409769ffb8ad Mon Sep 17 00:00:00 2001 From: Robert Biddle Date: Sat, 29 Apr 2023 18:52:36 -0400 Subject: [PATCH 294/650] Style guide fixes --- .../Test-ADDSDomainInstallation.md | 273 +++++++++++------- 1 file changed, 176 insertions(+), 97 deletions(-) diff --git a/docset/winserver2022-ps/addsdeployment/Test-ADDSDomainInstallation.md b/docset/winserver2022-ps/addsdeployment/Test-ADDSDomainInstallation.md index e2d0562c05..fb587ff57b 100644 --- a/docset/winserver2022-ps/addsdeployment/Test-ADDSDomainInstallation.md +++ b/docset/winserver2022-ps/addsdeployment/Test-ADDSDomainInstallation.md @@ -11,45 +11,76 @@ title: Test-ADDSDomainInstallation # Test-ADDSDomainInstallation ## SYNOPSIS + Runs the prerequisites for installing a new Active Directory domain configuration. ## SYNTAX ``` Test-ADDSDomainInstallation -NewDomainName -ParentDomainName - [-SafeModeAdministratorPassword ] [-ADPrepCredential ] [-AllowDomainReinstall] - [-CreateDnsDelegation] [-Credential ] [-DatabasePath ] - [-DnsDelegationCredential ] [-NoDnsOnNetwork] [-DomainMode ] - [-DomainType ] [-NoGlobalCatalog] [-InstallDns] [-LogPath ] - [-NewDomainNetbiosName ] [-NoRebootOnCompletion] [-ReplicationSourceDC ] [-SiteName ] - [-SkipAutoConfigureDns] [-SysvolPath ] [-Force] [] + [-SafeModeAdministratorPassword ] [-ADPrepCredential ] + [-AllowDomainReinstall] [-CreateDnsDelegation] [-Credential ] + [-DatabasePath ] [-DnsDelegationCredential ] [-NoDnsOnNetwork] + [-DomainMode ] [-DomainType ] [-NoGlobalCatalog] [-InstallDns] + [-LogPath ] [-NewDomainNetbiosName ] [-NoRebootOnCompletion] + [-ReplicationSourceDC ] [-SiteName ] [-SkipAutoConfigureDns] + [-SysvolPath ] [-Force] [] ``` ## DESCRIPTION -The **Test-ADDSDomainInstallation** cmdlet runs those prerequisite checks which would be performed if you were to use the **Install-ADDSDomainController** cmdlet to install a new Active Directory domain configuration. -It differs from using the *WhatIf* parameter with the **Install-ADDSDomainController** cmdlet in that instead of summarizing the changes that would occur during the installation process, this cmdlet actually tests whether those changes are possible given the current environment. -For more information on the scope of these prerequisite checks that the ADDSDeployment module performs when using this cmdlet see the section ADPrep and Prerequisite Checking Architecture in [AD DS Simplified Administration](https://go.microsoft.com/fwlink/?LinkID=237244). +The `Test-ADDSDomainInstallation` cmdlet runs those prerequisite checks which would be performed if +you were to use the `Install-ADDSDomainController` cmdlet to install a new Active Directory domain +configuration. It differs from using the `-WhatIf` parameter with the `Install-ADDSDomainController` +cmdlet in that instead of summarizing the changes that would occur during the installation process, +this cmdlet actually tests whether those changes are possible given the current environment. + +For more information on the scope of these prerequisite checks that the ADDSDeployment module +performs when using this cmdlet see the section ADPrep and Prerequisite Checking Architecture in +[AD DS Simplified Administration](https://go.microsoft.com/fwlink/?LinkID=237244). ## EXAMPLES ### Example 1: Test if installing a child domain is possible -``` -PS C:\> Test-ADDSDomainInstallation -Credential (Get-Credential CORP\EnterpriseAdmin1) -NewDomainName child -ParentDomainName "corp.contoso.com" -InstallDNS -CreateDNSDelegation -DomainMode Win2003 -ReplicationSourceDC "DC1.corp.contoso.com" -SiteName "Houston" -DatabasePath "D:\NTDS" -SYSVOLPath "D:\SYSVOL" -LogPath "E:\Logs" -NoRebootOnCompletion + +```powershell +@HashArguments = { + CreateDNSDelegation = $true + Credential = (Get-Credential CORP\EnterpriseAdmin1) + DatabasePath = "D:\NTDS" + DomainMode = Win2003 + InstallDNS = $true + NewDomainName = "child" + NoRebootOnCompletion = $true + ParentDomainName = "corp.contoso.com" + ReplicationSourceDC = "DC1.corp.contoso.com" + LogPath = "E:\Logs" + SiteName = "Houston" + SYSVOLPath = "D:\SYSVOL" +} +Test-ADDSDomainInstallation @HashArguments ``` -This command runs the prerequisites to determine if installing a new child domain named child.corp.contoso.com using credentials of CORP\EnterpriseAdmin1 is possible. -This command also installs a DNS server, creates a DNS delegation in the corp.contoso.com domain, sets the domain functional level to Windows Server 2003, makes the domain controller a global catalog server in a site named Houston, and uses DC1.corp.contoso.com as the replication source domain controller. -The command also installs the Active Directory database and SYSVOL on the D:\ drive, installs the log files on the E:\ drive, has the server not automatically restart after the domain installation is complete and prompts the user to provide and confirm the Directory Services Restore Mode (DSRM) password to complete and commit the installation of the domain in Active Directory. +This command runs the prerequisites to determine if installing a new child domain named +child.corp.contoso.com using credentials of CORP\EnterpriseAdmin1 is possible. This command also +installs a DNS server, creates a DNS delegation in the corp.contoso.com domain, sets the domain +functional level to Windows Server 2003, makes the domain controller a global catalog server in a +site named Houston, and uses DC1.corp.contoso.com as the replication source domain controller. The +command also installs the Active Directory database and SYSVOL on the `D:\` drive, installs the log +files on the `E:\` drive, has the server not automatically restart after the domain installation is +complete and prompts the user to provide and confirm the Directory Services Restore Mode (DSRM) +password to complete and commit the installation of the domain in Active Directory. ## PARAMETERS ### -ADPrepCredential -Specifies the user name and password that corresponds to the account to be used for running operations, if required, to prepare Active Directory prior to the installation of this domain. -Use the **Get-Credential** cmdlet to prompt the user to supply a password. + +Specifies the user name and password that corresponds to the account to be used for running +operations, if required, to prepare Active Directory prior to the installation of this domain. Use +the `Get-Credential` cmdlet to prompt the user to supply a password. ```yaml -Type: PSCredential +Type: System.Management.Automation.PSCredential Parameter Sets: (All) Aliases: @@ -61,10 +92,11 @@ Accept wildcard characters: False ``` ### -AllowDomainReinstall + Indicates that the cmdlet recreates an existing domain is to be recreated. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -76,12 +108,13 @@ Accept wildcard characters: False ``` ### -CreateDnsDelegation -Indicates whether to create a DNS delegation that references the new DNS server that you are installing along with the domain controller. -Valid for Active Directory-integrated DNS only. -The default is computed automatically based on the environment. + +Indicates whether to create a DNS delegation that references the new DNS server that you are +installing along with the domain controller. Valid for Active Directory-integrated DNS only. The +default is computed automatically based on the environment. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -93,11 +126,12 @@ Accept wildcard characters: False ``` ### -Credential -Specifies the user name and password that corresponds to the account used to install the domain controller. -Use the **Get-Credential** cmdlet to prompt the user to supply a password. + +Specifies the user name and password that corresponds to the account used to install the domain +controller. Use the `Get-Credential` cmdlet to prompt the user to supply a password. ```yaml -Type: PSCredential +Type: System.Management.Automation.PSCredential Parameter Sets: (All) Aliases: @@ -109,11 +143,13 @@ Accept wildcard characters: False ``` ### -DatabasePath -Specifies the fully qualified, non-Universal Naming Convention (UNC) path to a directory on a fixed disk of the local computer that contains the domain database, for example, C:\Windows\NTDS. -The default is %SYSTEMROOT%\NTDS. + +Specifies the fully qualified, non-Universal Naming Convention (UNC) path to a directory on a fixed +disk of the local computer that contains the domain database, for example, `C:\Windows\NTDS`. The +default is `%SYSTEMROOT%\NTDS`. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -125,11 +161,13 @@ Accept wildcard characters: False ``` ### -DnsDelegationCredential -Specifies the user name and password for the user that creates the DNS delegation. -This parameter is skipped if the value for the *CreateDnsDelegation* parameter is either specified or computed to be $False. + +Specifies the user name and password for the user that creates the DNS delegation. This parameter is +skipped if the value for the `-CreateDnsDelegation` parameter is either specified or computed to be +`$False`. ```yaml -Type: PSCredential +Type: System.Management.Automation.PSCredential Parameter Sets: (All) Aliases: @@ -141,9 +179,11 @@ Accept wildcard characters: False ``` ### -DomainMode -Specifies the domain functional level of the first domain in the creation of a new forest. -Supported values for this parameter can be either a valid integer or a corresponding enumerated string value. -For instance, to set the domain mode level to Windows Server 2008 R2, you can specify either a value of 4 or Win2008R2. + +Specifies the domain functional level of the first domain in the creation of a new forest. Supported +values for this parameter can be either a valid integer or a corresponding enumerated string value. +For instance, to set the domain mode level to Windows Server 2008 R2, you can specify either a value +of 4 or Win2008R2. The acceptable values for this parameter are: @@ -157,7 +197,7 @@ The domain functional level cannot be lower than the forest functional level, bu The default is automatically computed and set. ```yaml -Type: DomainMode +Type: System.DirectoryServices.ActiveDirectory.DomainMode Parameter Sets: (All) Aliases: Accepted values: Win2008, Win2008R2, Win2012, Win2012R2, WinThreshold, Default @@ -170,8 +210,10 @@ Accept wildcard characters: False ``` ### -DomainType -Specifies the type of domain that this cmdlet creates: a new domain tree in an existing forest (supported values are TreeDomain or tree), a child of an existing domain (supported values are ChildDomain or child). -The default is ChildDomain. + +Specifies the type of domain that this cmdlet creates: a new domain tree in an existing forest +(supported values are TreeDomain or tree), a child of an existing domain (supported values are +ChildDomain or child). The default is ChildDomain. ```yaml Type: DomainType @@ -187,10 +229,11 @@ Accept wildcard characters: False ``` ### -Force + Forces the command to run without asking for user confirmation. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -202,15 +245,21 @@ Accept wildcard characters: False ``` ### -InstallDns -Indicates that this cmdlet installs and configures the DNS Server service for the domain or domain tree. -For domain installation, if this parameter is left unspecified and the parent domain (or in the case of a domain tree, the forest root domain) already hosts and stores the DNS names for the domain, then the default for this parameter is $True and the DNS server is installed. -Otherwise, if DNS domain names are hosted outside of Active Directory, the default is $False and no DNS server is installed. -To test if DNS domain names are hosted outside of Active Directory, this cmdlet uses a start of authority (SOA) type DNS. -For instance, if the value of *NewDomainName* is corp.contoso.com, Active Directory performs an SOA query for corp.contoso.com and ensures that the zone name in the response is corp.contoso.com. +Indicates that this cmdlet installs and configures the DNS Server service for the domain or domain +tree. For domain installation, if this parameter is left unspecified and the parent domain (or in +the case of a domain tree, the forest root domain) already hosts and stores the DNS names for the +domain, then the default for this parameter is $True and the DNS server is installed. Otherwise, if +DNS domain names are hosted outside of Active Directory, the default is $False and no DNS server is +installed. + +To test if DNS domain names are hosted outside of Active Directory, this cmdlet uses a start of +authority (SOA) type DNS. For instance, if the value of `-NewDomainName` is corp.contoso.com, Active +Directory performs an SOA query for corp.contoso.com and ensures that the zone name in the response +is corp.contoso.com. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -222,11 +271,13 @@ Accept wildcard characters: False ``` ### -LogPath -Specifies the fully qualified, non-UNC path to a directory on a fixed disk of the local computer that will contain the domain log files, for example, C:\Windows\Logs. -The default is %SYSTEMROOT%\NTDS. + +Specifies the fully qualified, non-UNC path to a directory on a fixed disk of the local computer +that will contain the domain log files, for example, `C:\Windows\Logs`. The default is +`%SYSTEMROOT%\NTDS`. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -238,12 +289,15 @@ Accept wildcard characters: False ``` ### -NewDomainName -Specifies the new name of the domain. -If the value set for *DomainType* is set to TreeDomain, this parameter can be used to specify the fully qualified domain name (FQDN) for the new domain tree (for example, contoso.com). -If the value set for *DomainType* is set to ChildDomain, this parameter can be used to specify a single label domain name for the child domain (for example, specify corp to make a new domain corp.contoso.com if the new domain is in the contoso.com domain tree). + +Specifies the new name of the domain. If the value set for `-DomainType` is set to TreeDomain, this +parameter can be used to specify the fully qualified domain name (FQDN) for the new domain tree (for +example, contoso.com). If the value set for `-DomainType` is set to ChildDomain, this parameter can +be used to specify a single label domain name for the child domain (for example, specify corp to +make a new domain corp.contoso.com if the new domain is in the contoso.com domain tree). ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -255,18 +309,22 @@ Accept wildcard characters: False ``` ### -NewDomainNetbiosName -Specifies the NetBIOS name for the new domain. -For NetBIOS names to be valid for use with this parameter they must be single label names of 15 characters or less. -If this parameter is set with a valid NetBIOS name value, then promotion continues with the name specified. -If this parameter is not set, then the default is automatically computed from the value of the *NewDomainName* parameter. +Specifies the NetBIOS name for the new domain. For NetBIOS names to be valid for use with this +parameter they must be single label names of 15 characters or less. -For instance, if this parameter is not specified and a single-label prefix domain name of 15 characters or less is specified within the value of the *NewDomainName* parameter, then promotion continues with an automatically generated NetBIOS domain name. -For example, the prefix label corp within a full domain name value of corp.contoso.com would be a successful name choice. -If the label is more than 16 characters, the operation will fail. +If this parameter is set with a valid NetBIOS name value, then promotion continues with the name +specified. If this parameter is not set, then the default is automatically computed from the value +of the `-NewDomainName` parameter. + +For instance, if this parameter is not specified and a single-label prefix domain name of 15 +characters or less is specified within the value of the `-NewDomainName` parameter, then promotion +continues with an automatically generated NetBIOS domain name. For example, the prefix label corp +within a full domain name value of corp.contoso.com would be a successful name choice. If the label +is more than 16 characters, the operation will fail. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -278,16 +336,20 @@ Accept wildcard characters: False ``` ### -NoDnsOnNetwork -Indicates that the DNS service is not available on the network. -This parameter is used only when the IP setting of the network adapter for this computer is not configured with the name of a DNS server for name resolution. -It indicates that a DNS server is installed on this computer for name resolution. -Otherwise, the IP settings of the network adapter must first be configured with the address of a DNS server. -Omitting this parameter, the default value, indicates that the TCP/IP client settings of the network adapter on this server computer is used to contact a DNS server. -Therefore, if you are not specifying this parameter, ensure that TCP/IP client settings are first configured with a preferred DNS server address. +Indicates that the DNS service is not available on the network. This parameter is used only when the +IP setting of the network adapter for this computer is not configured with the name of a DNS server +for name resolution. It indicates that a DNS server is installed on this computer for name +resolution. Otherwise, the IP settings of the network adapter must first be configured with the +address of a DNS server. + +Omitting this parameter, the default value, indicates that the TCP/IP client settings of the network +adapter on this server computer is used to contact a DNS server. Therefore, if you are not +specifying this parameter, ensure that TCP/IP client settings are first configured with a preferred +DNS server address. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -299,11 +361,12 @@ Accept wildcard characters: False ``` ### -NoGlobalCatalog -Indicates that the read-only domain controller (RODC) will not be a global catalog server. -By default, the domain controller that you are installing is a global catalog server. + +Indicates that the read-only domain controller (RODC) will not be a global catalog server. By +default, the domain controller that you are installing is a global catalog server. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -315,12 +378,15 @@ Accept wildcard characters: False ``` ### -NoRebootOnCompletion -Indicates that the cmdlet restarts the computer upon completion, regardless of success. -By default, reboot upon completion occurs when this cmdlet is used and this parameter is omitted. -As a general rule, Microsoft support recommends that you not use this parameter except for testing or troubleshooting purposes because once configuration has completed the server will not function correctly as either a member server or a DC until it is rebooted. + +Indicates that the cmdlet restarts the computer upon completion, regardless of success. By default, +reboot upon completion occurs when this cmdlet is used and this parameter is omitted. As a general +rule, Microsoft support recommends that you not use this parameter except for testing or +troubleshooting purposes because once configuration has completed the server will not function +correctly as either a member server or a DC until it is rebooted. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -332,10 +398,11 @@ Accept wildcard characters: False ``` ### -ParentDomainName + Specifies the fully qualified domain name (FQDN) of an existing parent domain. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -347,11 +414,13 @@ Accept wildcard characters: False ``` ### -ReplicationSourceDC -Specifies the fully qualified domain name (FQDN) of the domain controller to be used as the source for replicating to this domain. -The default value for this parameter is automatically computed from the environment. + +Specifies the fully qualified domain name (FQDN) of the domain controller to be used as the source +for replicating to this domain. The default value for this parameter is automatically computed from +the environment. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -363,18 +432,22 @@ Accept wildcard characters: False ``` ### -SafeModeAdministratorPassword -Supplies the password for the administrator account when the computer is started in Safe Mode or a variant of Safe Mode, such as Directory Services Restore Mode. -You must supply a password that meets the password complexity rules of the domain and the password cannot be blank. -If specified with a value, the value must be a secure string. + +Supplies the password for the administrator account when the computer is started in Safe Mode or a +variant of Safe Mode, such as Directory Services Restore Mode. You must supply a password that meets +the password complexity rules of the domain and the password cannot be blank. If specified with a +value, the value must be a secure string. If this parameter is not specified, the cmdlet prompts you to enter and confirm a masked password. -This is the preferred usage when running the cmdlet interactively. -If additionally there are no other arguments specified with the cmdlet, you are prompted to enter a masked password for this parameter but no confirmation of the password entered is made. -This is not recommended as it could allow a mistyped password to be configured. -Another available advanced option is to use the **ConvertTo-SecureString** cmdlet and specify the password string inline as unmasked console input, which is also not a recommended security best practice in production deployments. +This is the preferred usage when running the cmdlet interactively. If additionally there are no +other arguments specified with the cmdlet, you are prompted to enter a masked password for this +parameter but no confirmation of the password entered is made. This is not recommended as it could +allow a mistyped password to be configured. Another available advanced option is to use the +`ConvertTo-SecureString` cmdlet and specify the password string inline as unmasked console input, +which is also not a recommended security best practice in production deployments. ```yaml -Type: SecureString +Type: System.Security.SecureString Parameter Sets: (All) Aliases: @@ -386,12 +459,13 @@ Accept wildcard characters: False ``` ### -SiteName -Specifies the name of an existing site where you can place the new domain controller. -The default value is the site that is associated with the subnet that includes the IP address of this server. -If no such site exists, the default is the site of the replication source domain controller. + +Specifies the name of an existing site where you can place the new domain controller. The default +value is the site that is associated with the subnet that includes the IP address of this server. If +no such site exists, the default is the site of the replication source domain controller. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -403,11 +477,12 @@ Accept wildcard characters: False ``` ### -SkipAutoConfigureDns -Indicates that this cmdlet skips automatic configuration of DNS client settings, forwarders, and root hints. -This parameter is in effect only if the DNS Server service is already installed. + +Indicates that this cmdlet skips automatic configuration of DNS client settings, forwarders, and +root hints. This parameter is in effect only if the DNS Server service is already installed. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -419,11 +494,12 @@ Accept wildcard characters: False ``` ### -SysvolPath -Specifies the fully qualified, non-UNC path to a directory on a fixed disk of the local computer, for example, C:\Windows\SYSVOL. -The default is %SYSTEMROOT%\SYSVOL. + +Specifies the fully qualified, non-UNC path to a directory on a fixed disk of the local computer, +for example, `C:\Windows\SYSVOL`. The default is `%SYSTEMROOT%\SYSVOL`. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -435,7 +511,11 @@ Accept wildcard characters: False ``` ### CommonParameters -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). + +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). ## INPUTS @@ -452,4 +532,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Get-Credential](https://go.microsoft.com/fwlink/?LinkID=293936) [ConvertTo-SecureString](https://go.microsoft.com/fwlink/p/?LinkId=113291) - From b73b5ffd291b6d726162cee3472293a485865d0d Mon Sep 17 00:00:00 2001 From: Robert Biddle Date: Mon, 1 May 2023 15:16:26 -0400 Subject: [PATCH 295/650] Update docset/winserver2022-ps/addsdeployment/Test-ADDSDomainInstallation.md Co-authored-by: Mikey Lombardi (He/Him) --- .../addsdeployment/Test-ADDSDomainInstallation.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/docset/winserver2022-ps/addsdeployment/Test-ADDSDomainInstallation.md b/docset/winserver2022-ps/addsdeployment/Test-ADDSDomainInstallation.md index fb587ff57b..e78305564c 100644 --- a/docset/winserver2022-ps/addsdeployment/Test-ADDSDomainInstallation.md +++ b/docset/winserver2022-ps/addsdeployment/Test-ADDSDomainInstallation.md @@ -31,11 +31,12 @@ Test-ADDSDomainInstallation -NewDomainName -ParentDomainName The `Test-ADDSDomainInstallation` cmdlet runs those prerequisite checks which would be performed if you were to use the `Install-ADDSDomainController` cmdlet to install a new Active Directory domain -configuration. It differs from using the `-WhatIf` parameter with the `Install-ADDSDomainController` -cmdlet in that instead of summarizing the changes that would occur during the installation process, -this cmdlet actually tests whether those changes are possible given the current environment. +configuration. It differs from using the **WhatIf** parameter with the +`Install-ADDSDomainController` cmdlet in that instead of summarizing the changes that would occur +during the installation process, this cmdlet actually tests whether those changes are possible +given the current environment. -For more information on the scope of these prerequisite checks that the ADDSDeployment module +For more information on the scope of these prerequisite checks that the **ADDSDeployment** module performs when using this cmdlet see the section ADPrep and Prerequisite Checking Architecture in [AD DS Simplified Administration](https://go.microsoft.com/fwlink/?LinkID=237244). From 7833ba469cb576cc26835fd52db4100827f332e3 Mon Sep 17 00:00:00 2001 From: Robert Biddle Date: Mon, 1 May 2023 15:16:36 -0400 Subject: [PATCH 296/650] Update docset/winserver2022-ps/addsdeployment/Test-ADDSDomainInstallation.md Co-authored-by: Mikey Lombardi (He/Him) --- .../Test-ADDSDomainInstallation.md | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/docset/winserver2022-ps/addsdeployment/Test-ADDSDomainInstallation.md b/docset/winserver2022-ps/addsdeployment/Test-ADDSDomainInstallation.md index e78305564c..101cb99012 100644 --- a/docset/winserver2022-ps/addsdeployment/Test-ADDSDomainInstallation.md +++ b/docset/winserver2022-ps/addsdeployment/Test-ADDSDomainInstallation.md @@ -63,14 +63,15 @@ Test-ADDSDomainInstallation @HashArguments ``` This command runs the prerequisites to determine if installing a new child domain named -child.corp.contoso.com using credentials of CORP\EnterpriseAdmin1 is possible. This command also -installs a DNS server, creates a DNS delegation in the corp.contoso.com domain, sets the domain -functional level to Windows Server 2003, makes the domain controller a global catalog server in a -site named Houston, and uses DC1.corp.contoso.com as the replication source domain controller. The -command also installs the Active Directory database and SYSVOL on the `D:\` drive, installs the log -files on the `E:\` drive, has the server not automatically restart after the domain installation is -complete and prompts the user to provide and confirm the Directory Services Restore Mode (DSRM) -password to complete and commit the installation of the domain in Active Directory. +`child.corp.contoso.com` using credentials of `CORP\EnterpriseAdmin1` is possible. This command +also installs a DNS server, creates a DNS delegation in the `corp.contoso.com` domain, sets the +domain functional level to Windows Server 2003, makes the domain controller a global catalog server +in a site named `Houston`, and uses `DC1.corp.contoso.com` as the replication source domain +controller. The command also installs the Active Directory database and SYSVOL on the `D:\` drive, +installs the log files on the `E:\` drive, has the server not automatically restart after the +domain installation is complete and prompts the user to provide and confirm the Directory Services +Restore Mode (DSRM) password to complete and commit the installation of the domain in Active +Directory. ## PARAMETERS From 7d6fb7dd334925d67c0c9f8a8cdbda07d62374e3 Mon Sep 17 00:00:00 2001 From: Robert Biddle Date: Mon, 1 May 2023 15:16:42 -0400 Subject: [PATCH 297/650] Update docset/winserver2022-ps/addsdeployment/Test-ADDSDomainInstallation.md Co-authored-by: Mikey Lombardi (He/Him) --- .../addsdeployment/Test-ADDSDomainInstallation.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docset/winserver2022-ps/addsdeployment/Test-ADDSDomainInstallation.md b/docset/winserver2022-ps/addsdeployment/Test-ADDSDomainInstallation.md index 101cb99012..27de182303 100644 --- a/docset/winserver2022-ps/addsdeployment/Test-ADDSDomainInstallation.md +++ b/docset/winserver2022-ps/addsdeployment/Test-ADDSDomainInstallation.md @@ -182,10 +182,10 @@ Accept wildcard characters: False ### -DomainMode -Specifies the domain functional level of the first domain in the creation of a new forest. Supported -values for this parameter can be either a valid integer or a corresponding enumerated string value. -For instance, to set the domain mode level to Windows Server 2008 R2, you can specify either a value -of 4 or Win2008R2. +Specifies the domain functional level of the first domain in the creation of a new forest. +Supported values for this parameter can be either a valid integer or a corresponding enumerated +string value. For instance, to set the domain mode level to Windows Server 2008 R2, you can specify +either a value of `4` or `Win2008R2`. The acceptable values for this parameter are: From 2cdb02022ebcc71ffa5577c5317d27a2571a255b Mon Sep 17 00:00:00 2001 From: Robert Biddle Date: Mon, 1 May 2023 15:16:47 -0400 Subject: [PATCH 298/650] Update docset/winserver2022-ps/addsdeployment/Test-ADDSDomainInstallation.md Co-authored-by: Mikey Lombardi (He/Him) --- .../addsdeployment/Test-ADDSDomainInstallation.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docset/winserver2022-ps/addsdeployment/Test-ADDSDomainInstallation.md b/docset/winserver2022-ps/addsdeployment/Test-ADDSDomainInstallation.md index 27de182303..5ab5a6f160 100644 --- a/docset/winserver2022-ps/addsdeployment/Test-ADDSDomainInstallation.md +++ b/docset/winserver2022-ps/addsdeployment/Test-ADDSDomainInstallation.md @@ -214,8 +214,8 @@ Accept wildcard characters: False ### -DomainType Specifies the type of domain that this cmdlet creates: a new domain tree in an existing forest -(supported values are TreeDomain or tree), a child of an existing domain (supported values are -ChildDomain or child). The default is ChildDomain. +(supported values are `TreeDomain` or `tree`), a child of an existing domain (supported values are +`ChildDomain` or `child`). The default is `ChildDomain`. ```yaml Type: DomainType From abaeb0ae064740a6a3b7f46bea496afa00d54358 Mon Sep 17 00:00:00 2001 From: Robert Biddle Date: Mon, 1 May 2023 15:16:54 -0400 Subject: [PATCH 299/650] Update docset/winserver2022-ps/addsdeployment/Test-ADDSDomainInstallation.md Co-authored-by: Mikey Lombardi (He/Him) --- .../addsdeployment/Test-ADDSDomainInstallation.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docset/winserver2022-ps/addsdeployment/Test-ADDSDomainInstallation.md b/docset/winserver2022-ps/addsdeployment/Test-ADDSDomainInstallation.md index 5ab5a6f160..17c553e16b 100644 --- a/docset/winserver2022-ps/addsdeployment/Test-ADDSDomainInstallation.md +++ b/docset/winserver2022-ps/addsdeployment/Test-ADDSDomainInstallation.md @@ -251,14 +251,14 @@ Accept wildcard characters: False Indicates that this cmdlet installs and configures the DNS Server service for the domain or domain tree. For domain installation, if this parameter is left unspecified and the parent domain (or in the case of a domain tree, the forest root domain) already hosts and stores the DNS names for the -domain, then the default for this parameter is $True and the DNS server is installed. Otherwise, if -DNS domain names are hosted outside of Active Directory, the default is $False and no DNS server is -installed. +domain, then the default for this parameter is `$true` and the DNS server is installed. Otherwise, +if DNS domain names are hosted outside of Active Directory, the default is `$false` and no DNS +server is installed. To test if DNS domain names are hosted outside of Active Directory, this cmdlet uses a start of -authority (SOA) type DNS. For instance, if the value of `-NewDomainName` is corp.contoso.com, Active -Directory performs an SOA query for corp.contoso.com and ensures that the zone name in the response -is corp.contoso.com. +authority (SOA) type DNS. For instance, if the value of **NewDomainName** is `corp.contoso.com`, +Active Directory performs an SOA query for `corp.contoso.com` and ensures that the zone name in the +response is `corp.contoso.com`. ```yaml Type: System.Management.Automation.SwitchParameter From c31b3043b1c53619d2a8cb61708c8763cf84bb98 Mon Sep 17 00:00:00 2001 From: Robert Biddle Date: Mon, 1 May 2023 15:17:01 -0400 Subject: [PATCH 300/650] Update docset/winserver2022-ps/addsdeployment/Test-ADDSDomainInstallation.md Co-authored-by: Mikey Lombardi (He/Him) --- .../addsdeployment/Test-ADDSDomainInstallation.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/docset/winserver2022-ps/addsdeployment/Test-ADDSDomainInstallation.md b/docset/winserver2022-ps/addsdeployment/Test-ADDSDomainInstallation.md index 17c553e16b..1c4d087943 100644 --- a/docset/winserver2022-ps/addsdeployment/Test-ADDSDomainInstallation.md +++ b/docset/winserver2022-ps/addsdeployment/Test-ADDSDomainInstallation.md @@ -292,11 +292,12 @@ Accept wildcard characters: False ### -NewDomainName -Specifies the new name of the domain. If the value set for `-DomainType` is set to TreeDomain, this -parameter can be used to specify the fully qualified domain name (FQDN) for the new domain tree (for -example, contoso.com). If the value set for `-DomainType` is set to ChildDomain, this parameter can -be used to specify a single label domain name for the child domain (for example, specify corp to -make a new domain corp.contoso.com if the new domain is in the contoso.com domain tree). +Specifies the new name of the domain. If the value set for **DomainType** is set to `TreeDomain`, +this parameter can be used to specify the fully qualified domain name (FQDN) for the new domain +tree (for example, `contoso.com`). If the value set for **DomainType** is set to `ChildDomain`, +this parameter can be used to specify a single label domain name for the child domain (for example, +specify corp to make a new domain `corp.contoso.com` if the new domain is in the `contoso.com` +domain tree). ```yaml Type: System.String From 2325b2a0efacbca6e05bb0e0c0ef41673a9e86de Mon Sep 17 00:00:00 2001 From: Robert Biddle Date: Mon, 1 May 2023 15:17:08 -0400 Subject: [PATCH 301/650] Update docset/winserver2022-ps/addsdeployment/Test-ADDSDomainInstallation.md Co-authored-by: Mikey Lombardi (He/Him) --- .../addsdeployment/Test-ADDSDomainInstallation.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docset/winserver2022-ps/addsdeployment/Test-ADDSDomainInstallation.md b/docset/winserver2022-ps/addsdeployment/Test-ADDSDomainInstallation.md index 1c4d087943..03a3a9ddba 100644 --- a/docset/winserver2022-ps/addsdeployment/Test-ADDSDomainInstallation.md +++ b/docset/winserver2022-ps/addsdeployment/Test-ADDSDomainInstallation.md @@ -318,13 +318,13 @@ parameter they must be single label names of 15 characters or less. If this parameter is set with a valid NetBIOS name value, then promotion continues with the name specified. If this parameter is not set, then the default is automatically computed from the value -of the `-NewDomainName` parameter. +of the **NewDomainName** parameter. For instance, if this parameter is not specified and a single-label prefix domain name of 15 -characters or less is specified within the value of the `-NewDomainName` parameter, then promotion +characters or less is specified within the value of the **NewDomainName** parameter, then promotion continues with an automatically generated NetBIOS domain name. For example, the prefix label corp -within a full domain name value of corp.contoso.com would be a successful name choice. If the label -is more than 16 characters, the operation will fail. +within a full domain name value of `corp.contoso.com` would be a successful name choice. If the +label is more than 16 characters, the operation will fail. ```yaml Type: System.String From 4a131a6b3c2769d46e452141d0d52a36f3b5b381 Mon Sep 17 00:00:00 2001 From: Robert Biddle Date: Mon, 1 May 2023 15:17:18 -0400 Subject: [PATCH 302/650] Update docset/winserver2022-ps/addsdeployment/Test-ADDSDomainInstallation.md Co-authored-by: Mikey Lombardi (He/Him) --- .../addsdeployment/Test-ADDSDomainInstallation.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docset/winserver2022-ps/addsdeployment/Test-ADDSDomainInstallation.md b/docset/winserver2022-ps/addsdeployment/Test-ADDSDomainInstallation.md index 03a3a9ddba..dd3c207e3f 100644 --- a/docset/winserver2022-ps/addsdeployment/Test-ADDSDomainInstallation.md +++ b/docset/winserver2022-ps/addsdeployment/Test-ADDSDomainInstallation.md @@ -164,9 +164,9 @@ Accept wildcard characters: False ### -DnsDelegationCredential -Specifies the user name and password for the user that creates the DNS delegation. This parameter is -skipped if the value for the `-CreateDnsDelegation` parameter is either specified or computed to be -`$False`. +Specifies the user name and password for the user that creates the DNS delegation. This parameter +is skipped if the value for the **CreateDnsDelegation** parameter is either specified or computed +to be `$false`. ```yaml Type: System.Management.Automation.PSCredential From c85b20c50d0e111da85471485689d3e613c91806 Mon Sep 17 00:00:00 2001 From: "Mikey Lombardi (He/Him)" Date: Tue, 2 May 2023 09:05:05 -0500 Subject: [PATCH 303/650] Remove extra newline after synopsis --- .../addsdeployment/Test-ADDSDomainInstallation.md | 1 - 1 file changed, 1 deletion(-) diff --git a/docset/winserver2022-ps/addsdeployment/Test-ADDSDomainInstallation.md b/docset/winserver2022-ps/addsdeployment/Test-ADDSDomainInstallation.md index dd3c207e3f..734d0b462a 100644 --- a/docset/winserver2022-ps/addsdeployment/Test-ADDSDomainInstallation.md +++ b/docset/winserver2022-ps/addsdeployment/Test-ADDSDomainInstallation.md @@ -11,7 +11,6 @@ title: Test-ADDSDomainInstallation # Test-ADDSDomainInstallation ## SYNOPSIS - Runs the prerequisites for installing a new Active Directory domain configuration. ## SYNTAX From 922d9b5e4181e013a0ca82fb4e8e544f7472439c Mon Sep 17 00:00:00 2001 From: Robert Biddle Date: Sat, 29 Apr 2023 19:12:02 -0400 Subject: [PATCH 304/650] Style guide fixes --- .../Test-ADDSForestInstallation.md | 219 +++++++++++------- 1 file changed, 138 insertions(+), 81 deletions(-) diff --git a/docset/winserver2022-ps/addsdeployment/Test-ADDSForestInstallation.md b/docset/winserver2022-ps/addsdeployment/Test-ADDSForestInstallation.md index 9680c6ae05..3a306ea6a4 100644 --- a/docset/winserver2022-ps/addsdeployment/Test-ADDSForestInstallation.md +++ b/docset/winserver2022-ps/addsdeployment/Test-ADDSForestInstallation.md @@ -11,52 +11,75 @@ title: Test-ADDSForestInstallation # Test-ADDSForestInstallation ## SYNOPSIS + Runs the prerequisites for installing a new forest in Active Directory. ## SYNTAX ``` -Test-ADDSForestInstallation -DomainName [-SafeModeAdministratorPassword ] - [-CreateDnsDelegation] [-DatabasePath ] [-DnsDelegationCredential ] [-NoDnsOnNetwork] - [-DomainMode ] [-DomainNetbiosName ] [-ForestMode ] [-InstallDns] - [-LogPath ] [-NoRebootOnCompletion] [-SkipAutoConfigureDns] [-SysvolPath ] [-Force] - [] +Test-ADDSForestInstallation -DomainName + [-SafeModeAdministratorPassword ] [-CreateDnsDelegation] + [-DatabasePath ] [-DnsDelegationCredential ] [-NoDnsOnNetwork] + [-DomainMode ] [-DomainNetbiosName ] [-ForestMode ] + [-InstallDns] [-LogPath ] [-NoRebootOnCompletion] [-SkipAutoConfigureDns] + [-SysvolPath ] [-Force] [] ``` ## DESCRIPTION -The **Test-ADDSForestInstallation** cmdlet runs those prerequisite checks which would be performed if you were to use the Install-ADDSForest cmdlet to install a new forest in Active Directory. -It differs from using the *WhatIf* parameter with the **Install-ADDSForest** cmdlet in that instead of summarizing the changes that would occur during the installation process, this cmdlet actually tests whether those changes are possible given the current environment. -For more information on the scope of these prerequisite checks that the ADDSDeployment module performs when using this cmdlet see the section ADPrep and Prerequisite Checking Architecture in [AD DS Simplified Administration](https://go.microsoft.com/fwlink/?LinkID=237244). +The `Test-ADDSForestInstallation` cmdlet runs those prerequisite checks which would be performed if +you were to use the Install-ADDSForest cmdlet to install a new forest in Active Directory. It +differs from using the `-WhatIf` parameter with the `Install-ADDSForest` cmdlet in that instead of +summarizing the changes that would occur during the installation process, this cmdlet actually tests +whether those changes are possible given the current environment. + +For more information on the scope of these prerequisite checks that the ADDSDeployment module +performs when using this cmdlet see the section ADPrep and Prerequisite Checking Architecture in +[AD DS Simplified Administration](https://go.microsoft.com/fwlink/?LinkID=237244). ## EXAMPLES ### Example 1: Test the install of a forest to confirm if it is possible -``` -PS C:\> Test-ADDSForestInstallation -DomainName "corp.contoso.com" -NoRebootOnCompletion + +```powershell +Test-ADDSForestInstallation -DomainName "corp.contoso.com" -NoRebootOnCompletion ``` -This command runs the prerequisites for installing a new forest named corp.contoso.com and specifies not to reboot after the new forest is created. -The user is prompted to provide and confirm the Directory Services Restore Mode (DSRM) password. +This command runs the prerequisites for installing a new forest named corp.contoso.com and specifies +not to reboot after the new forest is created. The user is prompted to provide and confirm the +Directory Services Restore Mode (DSRM) password. ### Example 2: Test the install of a forest to confirm if it is possible -``` -PS C:\> Test-ADDSForestInstallation -DomainName "corp.contoso.com" -CreateDNSDelegation -DomainMode Win2008 -ForestMode Win2008R2 -DatabasePath "D:\NTDS" -SysvolPath "D:\SYSVOL" -LogPath "E:\Logs" + +```powershell +$HashArguments = @{ + CreateDNSDelegation = $true + DatabasePath = "D:\NTDS" + DomainMode = Win2008 + DomainName = "corp.contoso.com" + ForestMode = Win2008R2 + LogPath = "E:\Logs" + SysvolPath = "D:\SYSVOL" +} +Test-ADDSForestInstallation @HashArguments ``` -This command runs the prerequisites for installing a new forest that will create a DNS delegation in the contoso.com domain, set the domain functional level to Windows Server 2008 R2 and sets forest functional level to Windows Server 2008 R2. -The command also installs the Active Directory database and SYSVOL on the D: drive, installs the log files on the E: drive and has the server automatically restart after AD DS installation. -The user is prompted to provide and confirm the DSRM password. +This command runs the prerequisites for installing a new forest that will create a DNS delegation in +the contoso.com domain, set the domain functional level to Windows Server 2008 R2 and sets forest +functional level to Windows Server 2008 R2. The command also installs the Active Directory database +and SYSVOL on the D: drive, installs the log files on the E: drive and has the server automatically +restart after AD DS installation. The user is prompted to provide and confirm the DSRM password. ## PARAMETERS ### -CreateDnsDelegation -Indicates that the cmdlet creates a DNS delegation that references the new DNS server that you install along with the domain controller. -Valid for Active Directory-integrated DNS only. -The default is computed automatically based on the environment. + +Indicates that the cmdlet creates a DNS delegation that references the new DNS server that you +install along with the domain controller. Valid for Active Directory-integrated DNS only. The +default is computed automatically based on the environment. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -68,11 +91,13 @@ Accept wildcard characters: False ``` ### -DatabasePath -Specifies the fully qualified, non-Universal Naming Convention (UNC) path to a directory on a fixed disk of the local computer that contains the domain database, for example, C:\Windows\NTDS. -The default is %SYSTEMROOT%\NTDS. + +Specifies the fully qualified, non-Universal Naming Convention (UNC) path to a directory on a fixed +disk of the local computer that contains the domain database, for example, `C:\Windows\NTDS`. The +default is `%SYSTEMROOT%\NTDS`. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -84,11 +109,13 @@ Accept wildcard characters: False ``` ### -DnsDelegationCredential -Specifies the user name and password (account credentials) for creating DNS delegation. -The cmdlet will skip this parameter if the value for the *CreateDnsDelegation* parameter is either specified or computed to be $False. + +Specifies the user name and password (account credentials) for creating DNS delegation. The cmdlet +will skip this parameter if the value for the `-CreateDnsDelegation` parameter is either specified +or computed to be `$False`. ```yaml -Type: PSCredential +Type: System.Management.Automation.PSCredential Parameter Sets: (All) Aliases: @@ -100,9 +127,11 @@ Accept wildcard characters: False ``` ### -DomainMode -Specifies the domain functional level of the first domain in the creation of a new forest. -Supported values for this parameter can be either a valid integer or a corresponding enumerated string value. -For instance, to set the domain mode level to Windows Server 2008 R2, you can specify either a value of 4 or Win2008R2. + +Specifies the domain functional level of the first domain in the creation of a new forest. Supported +values for this parameter can be either a valid integer or a corresponding enumerated string value. +For instance, to set the domain mode level to Windows Server 2008 R2, you can specify either a value +of 4 or Win2008R2. The acceptable values for this parameter are: @@ -116,7 +145,7 @@ The domain functional level cannot be lower than the forest functional level, bu The default is automatically computed and set. ```yaml -Type: DomainMode +Type: System.DirectoryServices.ActiveDirectory.DomainMode Parameter Sets: (All) Aliases: Accepted values: Win2008, Win2008R2, Win2012, Win2012R2, WinThreshold, Default @@ -129,10 +158,11 @@ Accept wildcard characters: False ``` ### -DomainName + Specifies the fully qualified domain name (FQDN) for the root domain in the forest. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -144,19 +174,24 @@ Accept wildcard characters: False ``` ### -DomainNetbiosName -Specifies the NetBIOS name for the root domain in the new forest. -For NetBIOS names to be valid for use with this parameter they must be single label names of 15 characters or less. -If this parameter is set with a valid NetBIOS name value, then forest installation continues with the name specified. -If this parameter is not set, then the default is automatically computed from the value of the *DomainName* parameter. +Specifies the NetBIOS name for the root domain in the new forest. For NetBIOS names to be valid for +use with this parameter they must be single label names of 15 characters or less. + +If this parameter is set with a valid NetBIOS name value, then forest installation continues with +the name specified. If this parameter is not set, then the default is automatically computed from +the value of the `-DomainName` parameter. -For instance, if this parameter is not specified and a single-label prefix domain name of 15 characters or less is specified within the value of the *DomainName* parameter, then promotion continues with an automatically generated NetBIOS domain name. -For example, the prefix label corp within a full domain name value of corp.contoso.com would be a successful name choice. +For instance, if this parameter is not specified and a single-label prefix domain name of 15 +characters or less is specified within the value of the `-DomainName` parameter, then promotion +continues with an automatically generated NetBIOS domain name. For example, the prefix label corp +within a full domain name value of corp.contoso.com would be a successful name choice. -Note that if the name value given for this parameter is a name of 16 characters or more, then the forest installation fails. +Note that if the name value given for this parameter is a name of 16 characters or more, then the +forest installation fails. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -168,10 +203,11 @@ Accept wildcard characters: False ``` ### -Force + Forces the command to run without asking for user confirmation. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -183,9 +219,10 @@ Accept wildcard characters: False ``` ### -ForestMode -Specifies the forest functional level for the new forest. -Supported values for this parameter can be either a valid integer or a corresponding enumerated string value. -For example, to set the forest mode level to Windows Server 2008 R2, you can specify either a value of 4 or Win2008R2. + +Specifies the forest functional level for the new forest. Supported values for this parameter can be +either a valid integer or a corresponding enumerated string value. For example, to set the forest +mode level to Windows Server 2008 R2, you can specify either a value of 4 or Win2008R2. The acceptable values for this parameter are: @@ -195,11 +232,12 @@ The acceptable values for this parameter are: - Windows Server 2012: 5 or Win2012 - Windows Server 2012 R2: 6 or Win2012R2 -The default forest functional level in Windows Server is typically the same as the version you are running. -However, the default forest functional level in Windows Server 2008 R2 when you create a new forest is Windows Server 2003 or 2. +The default forest functional level in Windows Server is typically the same as the version you are +running. However, the default forest functional level in Windows Server 2008 R2 when you create a +new forest is Windows Server 2003 or 2. ```yaml -Type: ForestMode +Type: System.DirectoryServices.ActiveDirectory.ForestMode Parameter Sets: (All) Aliases: Accepted values: Win2008, Win2008R2, Win2012, Win2012R2, WinThreshold, Default @@ -212,11 +250,12 @@ Accept wildcard characters: False ``` ### -InstallDns -Indicates that the cmdlet installs and configures the DNS Server service for the new forest. -For forest installation, the default is $True. + +Indicates that the cmdlet installs and configures the DNS Server service for the new forest. For +forest installation, the default is $True. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -228,12 +267,13 @@ Accept wildcard characters: False ``` ### -LogPath -Specifies the fully qualified, non-UNC path to a directory on a fixed disk of the local computer where the log file for this operation is written. -For instance, C:\Logs. -The default log file path if no other path is specified with this parameter is %SYSTEMROOT%\NTDS. + +Specifies the fully qualified, non-UNC path to a directory on a fixed disk of the local computer +where the log file for this operation is written. For instance, `C:\Logs`. The default log file path +if no other path is specified with this parameter is `%SYSTEMROOT%\NTDS`. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -245,16 +285,20 @@ Accept wildcard characters: False ``` ### -NoDnsOnNetwork -Indicates that the DNS service is not available on the network. -This parameter is used only when the IP setting of the network adapter for this computer is not configured with the name of a DNS server for name resolution. -It indicates that a DNS server is installed on this computer for name resolution. -Otherwise, the IP settings of the network adapter must first be configured with the address of a DNS server. -Omitting this parameter indicates that the TCP/IP client settings of the network adapter on this server computer is used to contact a DNS server. -Therefore, if you are not specifying this parameter, ensure that TCP/IP client settings are first configured with a preferred DNS server address. +Indicates that the DNS service is not available on the network. This parameter is used only when the +IP setting of the network adapter for this computer is not configured with the name of a DNS server +for name resolution. It indicates that a DNS server is installed on this computer for name +resolution. Otherwise, the IP settings of the network adapter must first be configured with the +address of a DNS server. + +Omitting this parameter indicates that the TCP/IP client settings of the network adapter on this +server computer is used to contact a DNS server. Therefore, if you are not specifying this +parameter, ensure that TCP/IP client settings are first configured with a preferred DNS server +address. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -266,13 +310,17 @@ Accept wildcard characters: False ``` ### -NoRebootOnCompletion + Indicates that the cmdlet does not reboot the computer upon completion of the command. -Omitting this parameter indicates the computer is rebooted upon completion of the command, regardless of success or failure. -As a general rule, Microsoft support recommends that you not use this parameter except for testing or troubleshooting purposes because once configuration has completed the server will not function correctly as either a member server or a DC until it is rebooted. +Omitting this parameter indicates the computer is rebooted upon completion of the command, +regardless of success or failure. As a general rule, Microsoft support recommends that you not use +this parameter except for testing or troubleshooting purposes because once configuration has +completed the server will not function correctly as either a member server or a DC until it is +rebooted. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -284,18 +332,22 @@ Accept wildcard characters: False ``` ### -SafeModeAdministratorPassword -Specifies the password for the administrator account when the computer is started in Safe Mode or a variant of Safe Mode, such as Directory Services Restore Mode. -You must supply a password that meets the password complexity rules of the domain and the password cannot be blank. -If specified with a value, the value must be a secure string. + +Specifies the password for the administrator account when the computer is started in Safe Mode or a +variant of Safe Mode, such as Directory Services Restore Mode. You must supply a password that meets +the password complexity rules of the domain and the password cannot be blank. If specified with a +value, the value must be a secure string. If this parameter is not specified, the cmdlet prompts you to enter and confirm a masked password. -This is the preferred usage when running the cmdlet interactively. -If there are no other arguments specified with the cmdlet, you is prompted to enter a masked password for this parameter but no confirmation of the password entered is made. -This is not recommended as it could allow a mistyped password to be configured. -Another available advanced option is to use the **ConvertTo-SecureString** cmdlet and specify the password string inline as unmasked console input, which is also not a recommended security best practice in production deployments. +This is the preferred usage when running the cmdlet interactively. If there are no other arguments +specified with the cmdlet, you is prompted to enter a masked password for this parameter but no +confirmation of the password entered is made. This is not recommended as it could allow a mistyped +password to be configured. Another available advanced option is to use the +`ConvertTo-SecureString` cmdlet and specify the password string inline as unmasked console input, +which is also not a recommended security best practice in production deployments. ```yaml -Type: SecureString +Type: System.Security.SecureString Parameter Sets: (All) Aliases: @@ -307,11 +359,12 @@ Accept wildcard characters: False ``` ### -SkipAutoConfigureDns -Indicates that the cmdlet skips automatic configuration of DNS client settings, forwarders, and root hints. -This parameter is in effect only if the DNS Server service is already installed. + +Indicates that the cmdlet skips automatic configuration of DNS client settings, forwarders, and root +hints. This parameter is in effect only if the DNS Server service is already installed. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -323,12 +376,13 @@ Accept wildcard characters: False ``` ### -SysvolPath -Specifies the fully qualified, non-UNC path to a directory on a fixed disk of the local computer where the Sysvol file is written. -For example, C:\Logs\SYSVOL. -The default path if no other path is specified with this parameter is %SYSTEMROOT%\SYSVOL. + +Specifies the fully qualified, non-UNC path to a directory on a fixed disk of the local computer +where the Sysvol file is written. For example, `C:\Logs\SYSVOL`. The default path if no other path +is specified with this parameter is `%SYSTEMROOT%\SYSVOL`. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -340,7 +394,11 @@ Accept wildcard characters: False ``` ### CommonParameters -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). + +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). ## INPUTS @@ -361,4 +419,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Install-ADDSDomainController](./Install-ADDSDomainController.md) [ConvertTo-SecureString](https://go.microsoft.com/fwlink/p/?LinkId=113291) - From 40021890f92c5273cfac2ee4e442aa9bcb35ddf7 Mon Sep 17 00:00:00 2001 From: Robert Biddle Date: Mon, 1 May 2023 15:17:36 -0400 Subject: [PATCH 305/650] Update docset/winserver2022-ps/addsdeployment/Test-ADDSForestInstallation.md Co-authored-by: Mikey Lombardi (He/Him) --- .../addsdeployment/Test-ADDSForestInstallation.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docset/winserver2022-ps/addsdeployment/Test-ADDSForestInstallation.md b/docset/winserver2022-ps/addsdeployment/Test-ADDSForestInstallation.md index 3a306ea6a4..6193a57dcb 100644 --- a/docset/winserver2022-ps/addsdeployment/Test-ADDSForestInstallation.md +++ b/docset/winserver2022-ps/addsdeployment/Test-ADDSForestInstallation.md @@ -28,12 +28,12 @@ Test-ADDSForestInstallation -DomainName ## DESCRIPTION The `Test-ADDSForestInstallation` cmdlet runs those prerequisite checks which would be performed if -you were to use the Install-ADDSForest cmdlet to install a new forest in Active Directory. It -differs from using the `-WhatIf` parameter with the `Install-ADDSForest` cmdlet in that instead of -summarizing the changes that would occur during the installation process, this cmdlet actually tests -whether those changes are possible given the current environment. +you were to use the `Install-ADDSForest` cmdlet to install a new forest in Active Directory. It +differs from using the **WhatIf** parameter with the `Install-ADDSForest` cmdlet in that instead of +summarizing the changes that would occur during the installation process, this cmdlet actually +tests whether those changes are possible given the current environment. -For more information on the scope of these prerequisite checks that the ADDSDeployment module +For more information on the scope of these prerequisite checks that the **ADDSDeployment** module performs when using this cmdlet see the section ADPrep and Prerequisite Checking Architecture in [AD DS Simplified Administration](https://go.microsoft.com/fwlink/?LinkID=237244). From 6ce1aab9d463300ffe3a660cac5a3e357a0e99fb Mon Sep 17 00:00:00 2001 From: Robert Biddle Date: Mon, 1 May 2023 15:17:48 -0400 Subject: [PATCH 306/650] Update docset/winserver2022-ps/addsdeployment/Test-ADDSForestInstallation.md Co-authored-by: Mikey Lombardi (He/Him) --- .../addsdeployment/Test-ADDSForestInstallation.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docset/winserver2022-ps/addsdeployment/Test-ADDSForestInstallation.md b/docset/winserver2022-ps/addsdeployment/Test-ADDSForestInstallation.md index 6193a57dcb..d5e869fd72 100644 --- a/docset/winserver2022-ps/addsdeployment/Test-ADDSForestInstallation.md +++ b/docset/winserver2022-ps/addsdeployment/Test-ADDSForestInstallation.md @@ -45,9 +45,9 @@ performs when using this cmdlet see the section ADPrep and Prerequisite Checking Test-ADDSForestInstallation -DomainName "corp.contoso.com" -NoRebootOnCompletion ``` -This command runs the prerequisites for installing a new forest named corp.contoso.com and specifies -not to reboot after the new forest is created. The user is prompted to provide and confirm the -Directory Services Restore Mode (DSRM) password. +This command runs the prerequisites for installing a new forest named `corp.contoso.com` and +specifies not to reboot after the new forest is created. The user is prompted to provide and +confirm the Directory Services Restore Mode (DSRM) password. ### Example 2: Test the install of a forest to confirm if it is possible From d00c77e93b367217ba5571e596b2060646ad5f41 Mon Sep 17 00:00:00 2001 From: Robert Biddle Date: Mon, 1 May 2023 15:18:02 -0400 Subject: [PATCH 307/650] Update docset/winserver2022-ps/addsdeployment/Test-ADDSForestInstallation.md Co-authored-by: Mikey Lombardi (He/Him) --- .../addsdeployment/Test-ADDSForestInstallation.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/docset/winserver2022-ps/addsdeployment/Test-ADDSForestInstallation.md b/docset/winserver2022-ps/addsdeployment/Test-ADDSForestInstallation.md index d5e869fd72..c28e1d8fac 100644 --- a/docset/winserver2022-ps/addsdeployment/Test-ADDSForestInstallation.md +++ b/docset/winserver2022-ps/addsdeployment/Test-ADDSForestInstallation.md @@ -64,11 +64,12 @@ $HashArguments = @{ Test-ADDSForestInstallation @HashArguments ``` -This command runs the prerequisites for installing a new forest that will create a DNS delegation in -the contoso.com domain, set the domain functional level to Windows Server 2008 R2 and sets forest -functional level to Windows Server 2008 R2. The command also installs the Active Directory database -and SYSVOL on the D: drive, installs the log files on the E: drive and has the server automatically -restart after AD DS installation. The user is prompted to provide and confirm the DSRM password. +This command runs the prerequisites for installing a new forest that will create a DNS delegation +in the `contoso.com` domain, set the domain functional level to Windows Server 2008 R2 and sets +forest functional level to Windows Server 2008 R2. The command also installs the Active Directory +database and SYSVOL on the `D:` drive, installs the log files on the `E:` drive and has the server +automatically restart after AD DS installation. The user is prompted to provide and confirm the +DSRM password. ## PARAMETERS From 0e3efbb1eef648c7a3cbe0dac32da53a20f61f27 Mon Sep 17 00:00:00 2001 From: Robert Biddle Date: Mon, 1 May 2023 15:18:12 -0400 Subject: [PATCH 308/650] Update docset/winserver2022-ps/addsdeployment/Test-ADDSForestInstallation.md Co-authored-by: Mikey Lombardi (He/Him) --- .../addsdeployment/Test-ADDSForestInstallation.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docset/winserver2022-ps/addsdeployment/Test-ADDSForestInstallation.md b/docset/winserver2022-ps/addsdeployment/Test-ADDSForestInstallation.md index c28e1d8fac..0f136b8e72 100644 --- a/docset/winserver2022-ps/addsdeployment/Test-ADDSForestInstallation.md +++ b/docset/winserver2022-ps/addsdeployment/Test-ADDSForestInstallation.md @@ -112,8 +112,8 @@ Accept wildcard characters: False ### -DnsDelegationCredential Specifies the user name and password (account credentials) for creating DNS delegation. The cmdlet -will skip this parameter if the value for the `-CreateDnsDelegation` parameter is either specified -or computed to be `$False`. +will skip this parameter if the value for the **CreateDnsDelegation** parameter is either specified +or computed to be `$false`. ```yaml Type: System.Management.Automation.PSCredential From ca7cfa8c3be19a33f1c8470445a2b229d8e1d2f6 Mon Sep 17 00:00:00 2001 From: Robert Biddle Date: Mon, 1 May 2023 15:18:18 -0400 Subject: [PATCH 309/650] Update docset/winserver2022-ps/addsdeployment/Test-ADDSForestInstallation.md Co-authored-by: Mikey Lombardi (He/Him) --- .../addsdeployment/Test-ADDSForestInstallation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/addsdeployment/Test-ADDSForestInstallation.md b/docset/winserver2022-ps/addsdeployment/Test-ADDSForestInstallation.md index 0f136b8e72..4b2ba1d970 100644 --- a/docset/winserver2022-ps/addsdeployment/Test-ADDSForestInstallation.md +++ b/docset/winserver2022-ps/addsdeployment/Test-ADDSForestInstallation.md @@ -132,7 +132,7 @@ Accept wildcard characters: False Specifies the domain functional level of the first domain in the creation of a new forest. Supported values for this parameter can be either a valid integer or a corresponding enumerated string value. For instance, to set the domain mode level to Windows Server 2008 R2, you can specify either a value -of 4 or Win2008R2. +of `4` or `Win2008R2`. The acceptable values for this parameter are: From 504d2e7be2fbd302ac107568a420109280902e8b Mon Sep 17 00:00:00 2001 From: Robert Biddle Date: Mon, 1 May 2023 15:18:26 -0400 Subject: [PATCH 310/650] Update docset/winserver2022-ps/addsdeployment/Test-ADDSForestInstallation.md Co-authored-by: Mikey Lombardi (He/Him) --- .../addsdeployment/Test-ADDSForestInstallation.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docset/winserver2022-ps/addsdeployment/Test-ADDSForestInstallation.md b/docset/winserver2022-ps/addsdeployment/Test-ADDSForestInstallation.md index 4b2ba1d970..2ea8cf363a 100644 --- a/docset/winserver2022-ps/addsdeployment/Test-ADDSForestInstallation.md +++ b/docset/winserver2022-ps/addsdeployment/Test-ADDSForestInstallation.md @@ -184,9 +184,9 @@ the name specified. If this parameter is not set, then the default is automatica the value of the `-DomainName` parameter. For instance, if this parameter is not specified and a single-label prefix domain name of 15 -characters or less is specified within the value of the `-DomainName` parameter, then promotion -continues with an automatically generated NetBIOS domain name. For example, the prefix label corp -within a full domain name value of corp.contoso.com would be a successful name choice. +characters or less is specified within the value of the **DomainName** parameter, then promotion +continues with an automatically generated NetBIOS domain name. For example, the prefix label `corp` +within a full domain name value of `corp.contoso.com` would be a successful name choice. Note that if the name value given for this parameter is a name of 16 characters or more, then the forest installation fails. From c808f83403d0837fd76e07afef77d65cc633dd01 Mon Sep 17 00:00:00 2001 From: Robert Biddle Date: Mon, 1 May 2023 15:18:31 -0400 Subject: [PATCH 311/650] Update docset/winserver2022-ps/addsdeployment/Test-ADDSForestInstallation.md Co-authored-by: Mikey Lombardi (He/Him) --- .../addsdeployment/Test-ADDSForestInstallation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/addsdeployment/Test-ADDSForestInstallation.md b/docset/winserver2022-ps/addsdeployment/Test-ADDSForestInstallation.md index 2ea8cf363a..56478c76a6 100644 --- a/docset/winserver2022-ps/addsdeployment/Test-ADDSForestInstallation.md +++ b/docset/winserver2022-ps/addsdeployment/Test-ADDSForestInstallation.md @@ -223,7 +223,7 @@ Accept wildcard characters: False Specifies the forest functional level for the new forest. Supported values for this parameter can be either a valid integer or a corresponding enumerated string value. For example, to set the forest -mode level to Windows Server 2008 R2, you can specify either a value of 4 or Win2008R2. +mode level to Windows Server 2008 R2, you can specify either a value of `4` or `Win2008R2`. The acceptable values for this parameter are: From 7a2134dfe5ff5f3eed229ae2076b615c14552145 Mon Sep 17 00:00:00 2001 From: Robert Biddle Date: Mon, 1 May 2023 15:18:37 -0400 Subject: [PATCH 312/650] Update docset/winserver2022-ps/addsdeployment/Test-ADDSForestInstallation.md Co-authored-by: Mikey Lombardi (He/Him) --- .../addsdeployment/Test-ADDSForestInstallation.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docset/winserver2022-ps/addsdeployment/Test-ADDSForestInstallation.md b/docset/winserver2022-ps/addsdeployment/Test-ADDSForestInstallation.md index 56478c76a6..ca18358847 100644 --- a/docset/winserver2022-ps/addsdeployment/Test-ADDSForestInstallation.md +++ b/docset/winserver2022-ps/addsdeployment/Test-ADDSForestInstallation.md @@ -230,8 +230,8 @@ The acceptable values for this parameter are: - Windows Server 2003: 2 or Win2003 - Windows Server 2008: 3 or Win2008 - Windows Server 2008 R2: 4 or Win2008R2 -- Windows Server 2012: 5 or Win2012 -- Windows Server 2012 R2: 6 or Win2012R2 +- Windows Server 2012: `5` or `Win2012` +- Windows Server 2012 R2: `6` or `Win2012R2` The default forest functional level in Windows Server is typically the same as the version you are running. However, the default forest functional level in Windows Server 2008 R2 when you create a From 57590236164aeb82a0946649b8b7526446c40aa6 Mon Sep 17 00:00:00 2001 From: Robert Biddle Date: Mon, 1 May 2023 15:18:42 -0400 Subject: [PATCH 313/650] Update docset/winserver2022-ps/addsdeployment/Test-ADDSForestInstallation.md Co-authored-by: Mikey Lombardi (He/Him) --- .../addsdeployment/Test-ADDSForestInstallation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/addsdeployment/Test-ADDSForestInstallation.md b/docset/winserver2022-ps/addsdeployment/Test-ADDSForestInstallation.md index ca18358847..29faf45079 100644 --- a/docset/winserver2022-ps/addsdeployment/Test-ADDSForestInstallation.md +++ b/docset/winserver2022-ps/addsdeployment/Test-ADDSForestInstallation.md @@ -235,7 +235,7 @@ The acceptable values for this parameter are: The default forest functional level in Windows Server is typically the same as the version you are running. However, the default forest functional level in Windows Server 2008 R2 when you create a -new forest is Windows Server 2003 or 2. +new forest is Windows Server 2003 or `2`. ```yaml Type: System.DirectoryServices.ActiveDirectory.ForestMode From a2c0661f8d81a582d55a9529e341fe69159e165f Mon Sep 17 00:00:00 2001 From: Robert Biddle Date: Mon, 1 May 2023 15:18:47 -0400 Subject: [PATCH 314/650] Update docset/winserver2022-ps/addsdeployment/Test-ADDSForestInstallation.md Co-authored-by: Mikey Lombardi (He/Him) --- .../addsdeployment/Test-ADDSForestInstallation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/addsdeployment/Test-ADDSForestInstallation.md b/docset/winserver2022-ps/addsdeployment/Test-ADDSForestInstallation.md index 29faf45079..e25efc88c2 100644 --- a/docset/winserver2022-ps/addsdeployment/Test-ADDSForestInstallation.md +++ b/docset/winserver2022-ps/addsdeployment/Test-ADDSForestInstallation.md @@ -253,7 +253,7 @@ Accept wildcard characters: False ### -InstallDns Indicates that the cmdlet installs and configures the DNS Server service for the new forest. For -forest installation, the default is $True. +forest installation, the default is `$true`. ```yaml Type: System.Management.Automation.SwitchParameter From 9d2cd09fc4a887dffc02d2ea62508091531e7167 Mon Sep 17 00:00:00 2001 From: Robert Biddle Date: Mon, 1 May 2023 15:18:58 -0400 Subject: [PATCH 315/650] Update docset/winserver2022-ps/addsdeployment/Test-ADDSForestInstallation.md Co-authored-by: Mikey Lombardi (He/Him) --- .../addsdeployment/Test-ADDSForestInstallation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/addsdeployment/Test-ADDSForestInstallation.md b/docset/winserver2022-ps/addsdeployment/Test-ADDSForestInstallation.md index e25efc88c2..1fdf891cc9 100644 --- a/docset/winserver2022-ps/addsdeployment/Test-ADDSForestInstallation.md +++ b/docset/winserver2022-ps/addsdeployment/Test-ADDSForestInstallation.md @@ -181,7 +181,7 @@ use with this parameter they must be single label names of 15 characters or less If this parameter is set with a valid NetBIOS name value, then forest installation continues with the name specified. If this parameter is not set, then the default is automatically computed from -the value of the `-DomainName` parameter. +the value of the **DomainName** parameter. For instance, if this parameter is not specified and a single-label prefix domain name of 15 characters or less is specified within the value of the **DomainName** parameter, then promotion From b0f0e68960e232e52e1a34afe883a05291a4c356 Mon Sep 17 00:00:00 2001 From: "Mikey Lombardi (He/Him)" Date: Tue, 2 May 2023 09:05:26 -0500 Subject: [PATCH 316/650] Remove extra newline after synopsis --- .../addsdeployment/Test-ADDSForestInstallation.md | 1 - 1 file changed, 1 deletion(-) diff --git a/docset/winserver2022-ps/addsdeployment/Test-ADDSForestInstallation.md b/docset/winserver2022-ps/addsdeployment/Test-ADDSForestInstallation.md index 1fdf891cc9..49be4db6df 100644 --- a/docset/winserver2022-ps/addsdeployment/Test-ADDSForestInstallation.md +++ b/docset/winserver2022-ps/addsdeployment/Test-ADDSForestInstallation.md @@ -11,7 +11,6 @@ title: Test-ADDSForestInstallation # Test-ADDSForestInstallation ## SYNOPSIS - Runs the prerequisites for installing a new forest in Active Directory. ## SYNTAX From e7c0dc20b826f8fab6e41d8f32b9b121edd10d7b Mon Sep 17 00:00:00 2001 From: Robert Biddle Date: Sat, 29 Apr 2023 19:24:43 -0400 Subject: [PATCH 317/650] Style guide fixes --- ...ReadOnlyDomainControllerAccountCreation.md | 115 +++++++++++------- 1 file changed, 72 insertions(+), 43 deletions(-) diff --git a/docset/winserver2022-ps/addsdeployment/Test-ADDSReadOnlyDomainControllerAccountCreation.md b/docset/winserver2022-ps/addsdeployment/Test-ADDSReadOnlyDomainControllerAccountCreation.md index 3a8c7df17a..a66518c68b 100644 --- a/docset/winserver2022-ps/addsdeployment/Test-ADDSReadOnlyDomainControllerAccountCreation.md +++ b/docset/winserver2022-ps/addsdeployment/Test-ADDSReadOnlyDomainControllerAccountCreation.md @@ -10,40 +10,53 @@ title: Test-ADDSReadOnlyDomainControllerAccountCreation # Test-ADDSReadOnlyDomainControllerAccountCreation -## SYNOPSIS Runs the prerequisites for adding a RODC account. ## SYNTAX ``` -Test-ADDSReadOnlyDomainControllerAccountCreation -DomainControllerAccountName -DomainName - -SiteName [-AllowPasswordReplicationAccountName ] [-Credential ] - [-DelegatedAdministratorAccountName ] [-DenyPasswordReplicationAccountName ] - [-NoGlobalCatalog] [-InstallDns] [-ReplicationSourceDC ] [-Force] [] +Test-ADDSReadOnlyDomainControllerAccountCreation -DomainControllerAccountName + -DomainName -SiteName [-AllowPasswordReplicationAccountName ] + [-Credential ] [-DelegatedAdministratorAccountName ] + [-DenyPasswordReplicationAccountName ] [-NoGlobalCatalog] [-InstallDns] + [-ReplicationSourceDC ] [-Force] [] ``` ## DESCRIPTION -The **Test-ADDSReadOnlyDomainControllerAccountCreation** cmdlet runs the prerequisite checks which would be performed if you were to add a read-only domain controller (RODC) account in Active Directory using the Add-ADDSReadOnlyDomainControllerAccount cmdlet. -It differs from using the *WhatIf* parameter with the **Add-ADDSReadOnlyDomainControllerAccount** cmdlet in that instead of summarizing the changes that would occur during the account creation process, this cmdlet actually tests whether those changes are possible given the current environment. + +The `Test-ADDSReadOnlyDomainControllerAccountCreation` cmdlet runs the prerequisite checks which +would be performed if you were to add a read-only domain controller (RODC) account in Active +Directory using the Add-ADDSReadOnlyDomainControllerAccount cmdlet. It differs from using the +`-WhatIf` parameter with the `Add-ADDSReadOnlyDomainControllerAccount` cmdlet in that instead of +summarizing the changes that would occur during the account creation process, this cmdlet actually +tests whether those changes are possible given the current environment. ## EXAMPLES ### Example 1: Test adding an RODC account to confirm it is possible -``` -PS C:\> Test-ADDSReadOnlyDomainControllerAccountCreation -DomainControllerAccountName RODC1 -DomainName "corp.contoso.com" -SiteName "NorthAmerica" + +```powershell +$HashArguments = @{ + DomainControllerAccountName = RODC1 + DomainName = "corp.contoso.com" + SiteName = "NorthAmerica" +} +Test-ADDSReadOnlyDomainControllerAccountCreation @HashArguments ``` -This command runs the prerequisites for adding an RODC account to the corp.contoso.com domain that would use the North America site as the source site for the replication source domain controller. +This command runs the prerequisites for adding an RODC account to the corp.contoso.com domain that +would use the North America site as the source site for the replication source domain controller. ## PARAMETERS ### -AllowPasswordReplicationAccountName -Specifies the names of user accounts, group accounts, and computer accounts whose passwords can be replicated to this RODC. -Use None if you want to keep the value empty. -By default, only the Allowed RODC Password Replication Group is allowed, and it is originally created empty. + +Specifies the names of user accounts, group accounts, and computer accounts whose passwords can be +replicated to this RODC. Use None if you want to keep the value empty. By default, only the Allowed +RODC Password Replication Group is allowed, and it is originally created empty. ```yaml -Type: String[] +Type: System.String[] Parameter Sets: (All) Aliases: @@ -55,11 +68,12 @@ Accept wildcard characters: False ``` ### -Credential -Specifies the user name and password that corresponds to the account used to install the domain controller. -Use the **Get-Credential** cmdlet to prompt the user to supply a password. + +Specifies the user name and password that corresponds to the account used to install the domain +controller. Use the `Get-Credential` cmdlet to prompt the user to supply a password. ```yaml -Type: PSCredential +Type: System.Management.Automation.PSCredential Parameter Sets: (All) Aliases: @@ -71,10 +85,11 @@ Accept wildcard characters: False ``` ### -DelegatedAdministratorAccountName + Specifies the name of the user or group that installs and administer the RODC. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -86,13 +101,17 @@ Accept wildcard characters: False ``` ### -DenyPasswordReplicationAccountName -Specifies the names of user accounts, group accounts, and computer accounts whose passwords are not to be replicated to this RODC. -Use None if you do not want to deny the replication of credentials of any users or computers. -By default, Administrators, Server Operators, Backup Operators, Account Operators, and the Denied RODC Password Replication Group are denied. -By default, the Denied RODC Password Replication Group includes Cert Publishers, Domain Admins, Enterprise Admins, Enterprise Domain Controllers, Enterprise Read-Only Domain Controllers, Group Policy Creator Owners, the krbtgt account, and Schema Admins. + +Specifies the names of user accounts, group accounts, and computer accounts whose passwords are not +to be replicated to this RODC. Use None if you do not want to deny the replication of credentials of +any users or computers. By default, Administrators, Server Operators, Backup Operators, Account +Operators, and the Denied RODC Password Replication Group are denied. By default, the Denied RODC +Password Replication Group includes Cert Publishers, Domain Admins, Enterprise Admins, Enterprise +Domain Controllers, Enterprise Read-Only Domain Controllers, Group Policy Creator Owners, the krbtgt +account, and Schema Admins. ```yaml -Type: String[] +Type: System.String[] Parameter Sets: (All) Aliases: @@ -104,10 +123,11 @@ Accept wildcard characters: False ``` ### -DomainControllerAccountName + Specifies the name of the RODC account that this cmdlet creates. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -119,12 +139,12 @@ Accept wildcard characters: False ``` ### -DomainName -Specifies the domain name for the user name for the operation. -This parameter is required. -You should specify the forest where you plan to install the domain controller or create an RODC account. + +Specifies the domain name for the user name for the operation. This parameter is required. You +should specify the forest where you plan to install the domain controller or create an RODC account. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -136,10 +156,11 @@ Accept wildcard characters: False ``` ### -Force + Forces the command to run without asking for user confirmation. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -151,11 +172,12 @@ Accept wildcard characters: False ``` ### -InstallDns -Indicates that the cmdlet installs the DNS Server service. -The default is automatically computed based on the environment. + +Indicates that the cmdlet installs the DNS Server service. The default is automatically computed +based on the environment. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -167,10 +189,11 @@ Accept wildcard characters: False ``` ### -NoGlobalCatalog + Indicates that the RODC is not a global catalog server. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -182,10 +205,12 @@ Accept wildcard characters: False ``` ### -ReplicationSourceDC -Specifies the name of the fully writable domain controller to use in the creation of the RODC account in Active Directory. + +Specifies the name of the fully writable domain controller to use in the creation of the RODC +account in Active Directory. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -197,14 +222,15 @@ Accept wildcard characters: False ``` ### -SiteName -Specifies the name of an existing site where you can place the new domain controller. -The default value depends on the type of installation. -For a new forest, the default is Default-First-Site-Name. -For all other installations, the default is the site that is associated with the subnet that includes the IP address of this server. -If no such site exists, the default is the site of the replication source domain controller. + +Specifies the name of an existing site where you can place the new domain controller. The default +value depends on the type of installation. For a new forest, the default is Default-First-Site-Name. +For all other installations, the default is the site that is associated with the subnet that +includes the IP address of this server. If no such site exists, the default is the site of the +replication source domain controller. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -216,7 +242,11 @@ Accept wildcard characters: False ``` ### CommonParameters -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). + +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). ## INPUTS @@ -229,4 +259,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Add-ADDSReadOnlyDomainControllerAccount](./Add-ADDSReadOnlyDomainControllerAccount.md) [Get-Credential](https://go.microsoft.com/fwlink/?LinkID=293936) - From 644613b416c8eb85e4598d4c8783b8236a16c222 Mon Sep 17 00:00:00 2001 From: Sean Wheeler Date: Mon, 1 May 2023 10:39:09 -0500 Subject: [PATCH 318/650] Update Test-ADDSReadOnlyDomainControllerAccountCreation.md --- .../Test-ADDSReadOnlyDomainControllerAccountCreation.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docset/winserver2022-ps/addsdeployment/Test-ADDSReadOnlyDomainControllerAccountCreation.md b/docset/winserver2022-ps/addsdeployment/Test-ADDSReadOnlyDomainControllerAccountCreation.md index a66518c68b..f9f4c349e3 100644 --- a/docset/winserver2022-ps/addsdeployment/Test-ADDSReadOnlyDomainControllerAccountCreation.md +++ b/docset/winserver2022-ps/addsdeployment/Test-ADDSReadOnlyDomainControllerAccountCreation.md @@ -10,6 +10,7 @@ title: Test-ADDSReadOnlyDomainControllerAccountCreation # Test-ADDSReadOnlyDomainControllerAccountCreation +## SYNOPSIS Runs the prerequisites for adding a RODC account. ## SYNTAX From 69bb6f13b83f566473410bf79096997850fd9592 Mon Sep 17 00:00:00 2001 From: Robert Biddle Date: Mon, 1 May 2023 15:20:26 -0400 Subject: [PATCH 319/650] Update docset/winserver2022-ps/addsdeployment/Test-ADDSReadOnlyDomainControllerAccountCreation.md Co-authored-by: Mikey Lombardi (He/Him) --- .../Test-ADDSReadOnlyDomainControllerAccountCreation.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docset/winserver2022-ps/addsdeployment/Test-ADDSReadOnlyDomainControllerAccountCreation.md b/docset/winserver2022-ps/addsdeployment/Test-ADDSReadOnlyDomainControllerAccountCreation.md index f9f4c349e3..75fe171464 100644 --- a/docset/winserver2022-ps/addsdeployment/Test-ADDSReadOnlyDomainControllerAccountCreation.md +++ b/docset/winserver2022-ps/addsdeployment/Test-ADDSReadOnlyDomainControllerAccountCreation.md @@ -27,8 +27,8 @@ Test-ADDSReadOnlyDomainControllerAccountCreation -DomainControllerAccountName Date: Mon, 1 May 2023 15:20:32 -0400 Subject: [PATCH 320/650] Update docset/winserver2022-ps/addsdeployment/Test-ADDSReadOnlyDomainControllerAccountCreation.md Co-authored-by: Mikey Lombardi (He/Him) --- .../Test-ADDSReadOnlyDomainControllerAccountCreation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/addsdeployment/Test-ADDSReadOnlyDomainControllerAccountCreation.md b/docset/winserver2022-ps/addsdeployment/Test-ADDSReadOnlyDomainControllerAccountCreation.md index 75fe171464..c35bf56416 100644 --- a/docset/winserver2022-ps/addsdeployment/Test-ADDSReadOnlyDomainControllerAccountCreation.md +++ b/docset/winserver2022-ps/addsdeployment/Test-ADDSReadOnlyDomainControllerAccountCreation.md @@ -45,7 +45,7 @@ $HashArguments = @{ Test-ADDSReadOnlyDomainControllerAccountCreation @HashArguments ``` -This command runs the prerequisites for adding an RODC account to the corp.contoso.com domain that +This command runs the prerequisites for adding an RODC account to the `corp.contoso.com` domain that would use the North America site as the source site for the replication source domain controller. ## PARAMETERS From ca8f6ce1d354f790ab57e597ddf227c436d11aab Mon Sep 17 00:00:00 2001 From: Robert Biddle Date: Mon, 1 May 2023 15:20:37 -0400 Subject: [PATCH 321/650] Update docset/winserver2022-ps/addsdeployment/Test-ADDSReadOnlyDomainControllerAccountCreation.md Co-authored-by: Mikey Lombardi (He/Him) --- .../Test-ADDSReadOnlyDomainControllerAccountCreation.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docset/winserver2022-ps/addsdeployment/Test-ADDSReadOnlyDomainControllerAccountCreation.md b/docset/winserver2022-ps/addsdeployment/Test-ADDSReadOnlyDomainControllerAccountCreation.md index c35bf56416..8adb92d1d2 100644 --- a/docset/winserver2022-ps/addsdeployment/Test-ADDSReadOnlyDomainControllerAccountCreation.md +++ b/docset/winserver2022-ps/addsdeployment/Test-ADDSReadOnlyDomainControllerAccountCreation.md @@ -53,8 +53,8 @@ would use the North America site as the source site for the replication source d ### -AllowPasswordReplicationAccountName Specifies the names of user accounts, group accounts, and computer accounts whose passwords can be -replicated to this RODC. Use None if you want to keep the value empty. By default, only the Allowed -RODC Password Replication Group is allowed, and it is originally created empty. +replicated to this RODC. Use `None` if you want to keep the value empty. By default, only the +Allowed RODC Password Replication Group is allowed, and it is originally created empty. ```yaml Type: System.String[] From 2761f36880af39caa9ad71a88fd867e5aec0b12b Mon Sep 17 00:00:00 2001 From: Robert Biddle Date: Mon, 1 May 2023 15:20:43 -0400 Subject: [PATCH 322/650] Update docset/winserver2022-ps/addsdeployment/Test-ADDSReadOnlyDomainControllerAccountCreation.md Co-authored-by: Mikey Lombardi (He/Him) --- .../Test-ADDSReadOnlyDomainControllerAccountCreation.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docset/winserver2022-ps/addsdeployment/Test-ADDSReadOnlyDomainControllerAccountCreation.md b/docset/winserver2022-ps/addsdeployment/Test-ADDSReadOnlyDomainControllerAccountCreation.md index 8adb92d1d2..c7a2154ff4 100644 --- a/docset/winserver2022-ps/addsdeployment/Test-ADDSReadOnlyDomainControllerAccountCreation.md +++ b/docset/winserver2022-ps/addsdeployment/Test-ADDSReadOnlyDomainControllerAccountCreation.md @@ -104,12 +104,12 @@ Accept wildcard characters: False ### -DenyPasswordReplicationAccountName Specifies the names of user accounts, group accounts, and computer accounts whose passwords are not -to be replicated to this RODC. Use None if you do not want to deny the replication of credentials of -any users or computers. By default, Administrators, Server Operators, Backup Operators, Account +to be replicated to this RODC. Use `None` if you do not want to deny the replication of credentials +of any users or computers. By default, Administrators, Server Operators, Backup Operators, Account Operators, and the Denied RODC Password Replication Group are denied. By default, the Denied RODC Password Replication Group includes Cert Publishers, Domain Admins, Enterprise Admins, Enterprise -Domain Controllers, Enterprise Read-Only Domain Controllers, Group Policy Creator Owners, the krbtgt -account, and Schema Admins. +Domain Controllers, Enterprise Read-Only Domain Controllers, Group Policy Creator Owners, the +krbtgt account, and Schema Admins. ```yaml Type: System.String[] From 2eb06afff2bf9532e0f6de33132802dbea1fe9d7 Mon Sep 17 00:00:00 2001 From: Robert Biddle Date: Mon, 1 May 2023 15:20:48 -0400 Subject: [PATCH 323/650] Update docset/winserver2022-ps/addsdeployment/Test-ADDSReadOnlyDomainControllerAccountCreation.md Co-authored-by: Mikey Lombardi (He/Him) --- .../Test-ADDSReadOnlyDomainControllerAccountCreation.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docset/winserver2022-ps/addsdeployment/Test-ADDSReadOnlyDomainControllerAccountCreation.md b/docset/winserver2022-ps/addsdeployment/Test-ADDSReadOnlyDomainControllerAccountCreation.md index c7a2154ff4..52adeead0d 100644 --- a/docset/winserver2022-ps/addsdeployment/Test-ADDSReadOnlyDomainControllerAccountCreation.md +++ b/docset/winserver2022-ps/addsdeployment/Test-ADDSReadOnlyDomainControllerAccountCreation.md @@ -225,10 +225,10 @@ Accept wildcard characters: False ### -SiteName Specifies the name of an existing site where you can place the new domain controller. The default -value depends on the type of installation. For a new forest, the default is Default-First-Site-Name. -For all other installations, the default is the site that is associated with the subnet that -includes the IP address of this server. If no such site exists, the default is the site of the -replication source domain controller. +value depends on the type of installation. For a new forest, the default is +`Default-First-Site-Name`. For all other installations, the default is the site that is associated +with the subnet that includes the IP address of this server. If no such site exists, the default is +the site of the replication source domain controller. ```yaml Type: System.String From 8269dfb5e990c66313037f2d2dc642d224bdbb6d Mon Sep 17 00:00:00 2001 From: Robert Biddle Date: Sat, 29 Apr 2023 19:36:02 -0400 Subject: [PATCH 324/650] Style guide fixes --- .../Uninstall-ADDSDomainController.md | 183 +++++++++++------- 1 file changed, 116 insertions(+), 67 deletions(-) diff --git a/docset/winserver2022-ps/addsdeployment/Uninstall-ADDSDomainController.md b/docset/winserver2022-ps/addsdeployment/Uninstall-ADDSDomainController.md index ae4074f990..4ef7f2a707 100644 --- a/docset/winserver2022-ps/addsdeployment/Uninstall-ADDSDomainController.md +++ b/docset/winserver2022-ps/addsdeployment/Uninstall-ADDSDomainController.md @@ -11,46 +11,55 @@ title: Uninstall-ADDSDomainController # Uninstall-ADDSDomainController ## SYNOPSIS + Uninstalls a domain controller in Active Directory. ## SYNTAX ### ADDSDomainControllerUninstall (Default) + ``` -Uninstall-ADDSDomainController [-SkipPreChecks] [-LocalAdministratorPassword ] - [-Credential ] [-DemoteOperationMasterRole] [-DnsDelegationRemovalCredential ] - [-IgnoreLastDCInDomainMismatch] [-IgnoreLastDnsServerForZone] [-LastDomainControllerInDomain] - [-NoRebootOnCompletion] [-RemoveApplicationPartitions] [-RemoveDnsDelegation] [-RetainDCMetadata] [-Force] - [-WhatIf] [-Confirm] [] +Uninstall-ADDSDomainController [-SkipPreChecks] + [-LocalAdministratorPassword ] [-Credential ] + [-DemoteOperationMasterRole] [-DnsDelegationRemovalCredential ] + [-IgnoreLastDCInDomainMismatch] [-IgnoreLastDnsServerForZone] + [-LastDomainControllerInDomain] [-NoRebootOnCompletion] [-RemoveApplicationPartitions] + [-RemoveDnsDelegation] [-RetainDCMetadata] [-Force] [-WhatIf] [-Confirm] + [] ``` ### ADDSDomainControllerUninstallForceRemoval + ``` -Uninstall-ADDSDomainController [-SkipPreChecks] [-LocalAdministratorPassword ] - [-Credential ] [-DemoteOperationMasterRole] [-ForceRemoval] [-NoRebootOnCompletion] [-Force] - [-WhatIf] [-Confirm] [] +Uninstall-ADDSDomainController [-SkipPreChecks] + [-LocalAdministratorPassword ] + [-Credential ] [-DemoteOperationMasterRole] [-ForceRemoval] + [-NoRebootOnCompletion] [-Force] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION -The **Uninstall-ADDSDomainController** cmdlet uninstalls a domain controller in Active Directory. + +The `Uninstall-ADDSDomainController` cmdlet uninstalls a domain controller in Active Directory. ## EXAMPLES ### Example 1: Remove AD DS from a domain controller -``` -PS C:\> Uninstall-ADDSDomainController + +```powershell +Uninstall-ADDSDomainController ``` -This command removes AD DS from an additional domain controller in a domain. -The user is prompted to set and confirm the local Administrator password prior to completing the removal process. +This command removes AD DS from an additional domain controller in a domain. The user is prompted to +set and confirm the local Administrator password prior to completing the removal process. ## PARAMETERS ### -Confirm + Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf @@ -62,12 +71,14 @@ Accept wildcard characters: False ``` ### -Credential -Specifies the user name and password that corresponds to the account used to install the domain controller. -Use the **Get-Credential** cmdlet to prompt the user to supply a password in place of an existing *PSCredential* type. -This causes Windows PowerShell to prompt the user to enter credentials using the Windows security login UI. + +Specifies the user name and password that corresponds to the account used to install the domain +controller. Use the `Get-Credential` cmdlet to prompt the user to supply a password in place of an +existing _System.Management.Automation.PSCredential_ type. This causes Windows PowerShell to prompt +the user to enter credentials using the Windows security login UI. ```yaml -Type: PSCredential +Type: System.Management.Automation.PSCredential Parameter Sets: (All) Aliases: @@ -79,10 +90,12 @@ Accept wildcard characters: False ``` ### -DemoteOperationMasterRole -Indicates that forced demotion should continue even if an operations master role is discovered on domain controller from which AD DS is being removed. + +Indicates that forced demotion should continue even if an operations master role is discovered on +domain controller from which AD DS is being removed. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -94,12 +107,14 @@ Accept wildcard characters: False ``` ### -DnsDelegationRemovalCredential -Specifies the account credentials to use when you create or remove the DNS delegation. -If you do not specify a value, the account credentials that you specify for the AD DS installation or removal are used to remove the DNS delegation. -As an alternative, you can specify the asterisk (*) to prompt the user to enter credentials. + +Specifies the account credentials to use when you create or remove the DNS delegation. If you do not +specify a value, the account credentials that you specify for the AD DS installation or removal are +used to remove the DNS delegation. As an alternative, you can specify the asterisk (*) to prompt the +user to enter credentials. ```yaml -Type: PSCredential +Type: System.Management.Automation.PSCredential Parameter Sets: ADDSDomainControllerUninstall Aliases: @@ -111,10 +126,11 @@ Accept wildcard characters: False ``` ### -Force + Forces the command to run without asking for user confirmation. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -126,11 +142,13 @@ Accept wildcard characters: False ``` ### -ForceRemoval -Indicates that the cmdlet forces the removal of a domain controller. -Use this parameter to force the uninstall of AD DS if you need to remove the domain controller and do not have connectivity to other domain controllers within the domain topology. + +Indicates that the cmdlet forces the removal of a domain controller. Use this parameter to force the +uninstall of AD DS if you need to remove the domain controller and do not have connectivity to other +domain controllers within the domain topology. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: ADDSDomainControllerUninstallForceRemoval Aliases: @@ -142,12 +160,19 @@ Accept wildcard characters: False ``` ### -IgnoreLastDCInDomainMismatch -Indicates that Windows PowerShell ignores any inconsistency that it detects with the value that you specify for the *LastDomainControllerInDomain* parameter. -For instance, if you specify *LastDomainControllerInDomain* but Windows PowerShell detects that there is actually another active domain controller in the domain, you can specify the *IgnoreLastDCInDomainMismatch* parameter to have Windows PowerShell continue the removal of AD DS from the domain controller despite the inconsistency that it has detected. -Similarly, if you do not specify *LastDomainControllerInDomain* but Windows PowerShell cannot detect that another domain controller is in the domain, you can specify *IgnoreLastDCInDomainMismatch* to have Windows PowerShell continue to remove AD DS from the domain controller. + +Indicates that Windows PowerShell ignores any inconsistency that it detects with the value that you +specify for the `-LastDomainControllerInDomain` parameter. For instance, if you specify +`-LastDomainControllerInDomain` but Windows PowerShell detects that there is actually another active +domain controller in the domain, you can specify the `-IgnoreLastDCInDomainMismatch` parameter to +have Windows PowerShell continue the removal of AD DS from the domain controller despite the +inconsistency that it has detected. Similarly, if you do not specify `-LastDomainControllerInDomain` +but Windows PowerShell cannot detect that another domain controller is in the domain, you can +specify `-IgnoreLastDCInDomainMismatch` to have Windows PowerShell continue to remove AD DS from the +domain controller. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: ADDSDomainControllerUninstall Aliases: @@ -159,10 +184,12 @@ Accept wildcard characters: False ``` ### -IgnoreLastDnsServerForZone -Indicates that the cmdlet continues the removal of AD DS despite the fact that the domain controller is the last DNS server for one or more of the Active Directory-integrated DNS zones that it hosts. + +Indicates that the cmdlet continues the removal of AD DS despite the fact that the domain controller +is the last DNS server for one or more of the Active Directory-integrated DNS zones that it hosts. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: ADDSDomainControllerUninstall Aliases: @@ -174,10 +201,12 @@ Accept wildcard characters: False ``` ### -LastDomainControllerInDomain -Indicates that the computer from which AD DS is being removed is the last domain controller in the domain. + +Indicates that the computer from which AD DS is being removed is the last domain controller in the +domain. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: ADDSDomainControllerUninstall Aliases: @@ -189,20 +218,24 @@ Accept wildcard characters: False ``` ### -LocalAdministratorPassword -Specifies a local administrator account password when AD DS is removed from a domain controller. -In earlier releases, where uninstall of AD DS was done using Dcpromo.exe for demotion, the default was to allow an empty password for this setting. -In Windows PowerShell, the ADDS Deployment module requires that a non-empty password string value be assigned. -If a value is not provided for this parameter, you are prompted to enter a value for the password at the Windows PowerShell prompt. -The password value must be a secure string. + +Specifies a local administrator account password when AD DS is removed from a domain controller. In +earlier releases, where uninstall of AD DS was done using `Dcpromo.exe` for demotion, the default +was to allow an empty password for this setting. In Windows PowerShell, the ADDS Deployment module +requires that a non-empty password string value be assigned. If a value is not provided for this +parameter, you are prompted to enter a value for the password at the Windows PowerShell prompt. The +password value must be a secure string. If this parameter is not specified, the cmdlet prompts you to enter and confirm a masked password. -This is the preferred usage when running the cmdlet interactively. -If additionally there are no other arguments specified with the cmdlet, you are prompted to enter a masked password for this parameter but no confirmation of the password entered is made. -This is not recommended as it could allow a mistyped password to be configured. -Another available advanced option is to use the **ConvertTo-SecureString** cmdlet and specify the password string inline as unmasked console input, which is also not a recommended security best practice in production deployments. +This is the preferred usage when running the cmdlet interactively. If additionally there are no +other arguments specified with the cmdlet, you are prompted to enter a masked password for this +parameter but no confirmation of the password entered is made. This is not recommended as it could +allow a mistyped password to be configured. Another available advanced option is to use the +`ConvertTo-SecureString` cmdlet and specify the password string inline as unmasked console input, +which is also not a recommended security best practice in production deployments. ```yaml -Type: SecureString +Type: System.Security.SecureString Parameter Sets: (All) Aliases: @@ -214,12 +247,15 @@ Accept wildcard characters: False ``` ### -NoRebootOnCompletion -Indicates that the cmdlet restarts the computer upon completion, regardless of success. -By default, reboot upon completion occurs when this cmdlet is used and this parameter is omitted. -As a general rule, Microsoft support recommends that you not use this parameter except for testing or troubleshooting purposes because once configuration has completed the server will not function correctly as either a member server or a DC until it is rebooted. + +Indicates that the cmdlet restarts the computer upon completion, regardless of success. By default, +reboot upon completion occurs when this cmdlet is used and this parameter is omitted. As a general +rule, Microsoft support recommends that you not use this parameter except for testing or +troubleshooting purposes because once configuration has completed the server will not function +correctly as either a member server or a DC until it is rebooted. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -231,10 +267,12 @@ Accept wildcard characters: False ``` ### -RemoveApplicationPartitions -Indicates that this cmdlet removes application partitions during the removal of AD DS from a domain controller. + +Indicates that this cmdlet removes application partitions during the removal of AD DS from a domain +controller. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: ADDSDomainControllerUninstall Aliases: @@ -247,11 +285,13 @@ Accept wildcard characters: False ### -RemoveDnsDelegation -Specifies whether to preserve DNS delegation that point to this DNS server from the parent DNS Zone. If you use this parameter, DNS delegations that point to this server from the parent DNS zone will not be retained after uninstallation of the domain controller. -This setting corresponds to the earlier Dcpromo.exe parameter default of /RemoveDNSDelegation:Yes. +Specifies whether to preserve DNS delegation that point to this DNS server from the parent DNS Zone. +If you use this parameter, DNS delegations that point to this server from the parent DNS zone will +not be retained after uninstallation of the domain controller. This setting corresponds to the +earlier `Dcpromo.exe` parameter default of `/RemoveDNSDelegation:Yes`. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: ADDSDomainControllerUninstall Aliases: @@ -263,10 +303,12 @@ Accept wildcard characters: False ``` ### -RetainDCMetadata -Indicates that metadata from the domain controller should be preserved after uninstallation is completed. + +Indicates that metadata from the domain controller should be preserved after uninstallation is +completed. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: ADDSDomainControllerUninstall Aliases: @@ -278,13 +320,17 @@ Accept wildcard characters: False ``` ### -SkipPreChecks -Indicates that only a base set of validations is performed. -This behavior is equivalent to the validations that were performed when using Dcpromo.exe in earlier versions of Windows Server to add a new domain controller. -When this switch parameter is set, it specifies that additional preliminary checks should be bypassed. -For more information on the scope of these additional preliminary checks that the ADDSDeployment module performs by default when using Windows Server 2012, refer to the table in the section ADPrep and Prerequisite Checking Architecture in [AD DS Simplified Administration](https://go.microsoft.com/fwlink/?LinkID=237244). + +Indicates that only a base set of validations is performed. This behavior is equivalent to the +validations that were performed when using `Dcpromo.exe` in earlier versions of Windows Server to +add a new domain controller. When this switch parameter is set, it specifies that additional +preliminary checks should be bypassed. For more information on the scope of these additional +preliminary checks that the ADDSDeployment module performs by default when using Windows Server +2012, refer to the table in the section ADPrep and Prerequisite Checking Architecture in +[AD DS Simplified Administration](https://go.microsoft.com/fwlink/?LinkID=237244). ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -296,11 +342,11 @@ Accept wildcard characters: False ``` ### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. + +Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi @@ -312,7 +358,11 @@ Accept wildcard characters: False ``` ### CommonParameters -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). + +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). ## INPUTS @@ -329,4 +379,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Get-Credential](https://go.microsoft.com/fwlink/?LinkID=293936) [ConvertTo-SecureString](https://go.microsoft.com/fwlink/p/?LinkId=113291) - From 3642bfca140c33da9ee8cc2f281186fa5d7fddbf Mon Sep 17 00:00:00 2001 From: Robert Biddle Date: Mon, 1 May 2023 15:21:02 -0400 Subject: [PATCH 325/650] Update docset/winserver2022-ps/addsdeployment/Uninstall-ADDSDomainController.md Co-authored-by: Mikey Lombardi (He/Him) --- .../addsdeployment/Uninstall-ADDSDomainController.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docset/winserver2022-ps/addsdeployment/Uninstall-ADDSDomainController.md b/docset/winserver2022-ps/addsdeployment/Uninstall-ADDSDomainController.md index 4ef7f2a707..a03a879872 100644 --- a/docset/winserver2022-ps/addsdeployment/Uninstall-ADDSDomainController.md +++ b/docset/winserver2022-ps/addsdeployment/Uninstall-ADDSDomainController.md @@ -74,8 +74,8 @@ Accept wildcard characters: False Specifies the user name and password that corresponds to the account used to install the domain controller. Use the `Get-Credential` cmdlet to prompt the user to supply a password in place of an -existing _System.Management.Automation.PSCredential_ type. This causes Windows PowerShell to prompt -the user to enter credentials using the Windows security login UI. +existing **System.Management.Automation.PSCredential** type. This causes Windows PowerShell to +prompt the user to enter credentials using the Windows security login UI. ```yaml Type: System.Management.Automation.PSCredential From 6de738dca6373cc437191cb0d0ca0b1f25d0d90e Mon Sep 17 00:00:00 2001 From: Robert Biddle Date: Mon, 1 May 2023 15:21:19 -0400 Subject: [PATCH 326/650] Update docset/winserver2022-ps/addsdeployment/Uninstall-ADDSDomainController.md Co-authored-by: Mikey Lombardi (He/Him) --- .../addsdeployment/Uninstall-ADDSDomainController.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docset/winserver2022-ps/addsdeployment/Uninstall-ADDSDomainController.md b/docset/winserver2022-ps/addsdeployment/Uninstall-ADDSDomainController.md index a03a879872..c944259a0a 100644 --- a/docset/winserver2022-ps/addsdeployment/Uninstall-ADDSDomainController.md +++ b/docset/winserver2022-ps/addsdeployment/Uninstall-ADDSDomainController.md @@ -108,10 +108,10 @@ Accept wildcard characters: False ### -DnsDelegationRemovalCredential -Specifies the account credentials to use when you create or remove the DNS delegation. If you do not -specify a value, the account credentials that you specify for the AD DS installation or removal are -used to remove the DNS delegation. As an alternative, you can specify the asterisk (*) to prompt the -user to enter credentials. +Specifies the account credentials to use when you create or remove the DNS delegation. If you do +not specify a value, the account credentials that you specify for the AD DS installation or removal +are used to remove the DNS delegation. As an alternative, you can specify the asterisk (`*`) to +prompt the user to enter credentials. ```yaml Type: System.Management.Automation.PSCredential From 498bd0b8b62d62c7a241bca792d1bb88b1f6d9c4 Mon Sep 17 00:00:00 2001 From: Robert Biddle Date: Mon, 1 May 2023 15:21:54 -0400 Subject: [PATCH 327/650] Update docset/winserver2022-ps/addsdeployment/Uninstall-ADDSDomainController.md Co-authored-by: Mikey Lombardi (He/Him) --- .../addsdeployment/Uninstall-ADDSDomainController.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/addsdeployment/Uninstall-ADDSDomainController.md b/docset/winserver2022-ps/addsdeployment/Uninstall-ADDSDomainController.md index c944259a0a..2c0ab3a464 100644 --- a/docset/winserver2022-ps/addsdeployment/Uninstall-ADDSDomainController.md +++ b/docset/winserver2022-ps/addsdeployment/Uninstall-ADDSDomainController.md @@ -325,7 +325,7 @@ Indicates that only a base set of validations is performed. This behavior is equ validations that were performed when using `Dcpromo.exe` in earlier versions of Windows Server to add a new domain controller. When this switch parameter is set, it specifies that additional preliminary checks should be bypassed. For more information on the scope of these additional -preliminary checks that the ADDSDeployment module performs by default when using Windows Server +preliminary checks that the **ADDSDeployment** module performs by default when using Windows Server 2012, refer to the table in the section ADPrep and Prerequisite Checking Architecture in [AD DS Simplified Administration](https://go.microsoft.com/fwlink/?LinkID=237244). From 13e035345a4ad1e4478dc265bda9906a54a59e06 Mon Sep 17 00:00:00 2001 From: Robert Biddle Date: Mon, 1 May 2023 15:22:44 -0400 Subject: [PATCH 328/650] Update docset/winserver2022-ps/addsdeployment/Uninstall-ADDSDomainController.md Co-authored-by: Mikey Lombardi (He/Him) --- .../Uninstall-ADDSDomainController.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/docset/winserver2022-ps/addsdeployment/Uninstall-ADDSDomainController.md b/docset/winserver2022-ps/addsdeployment/Uninstall-ADDSDomainController.md index 2c0ab3a464..7364e7fe14 100644 --- a/docset/winserver2022-ps/addsdeployment/Uninstall-ADDSDomainController.md +++ b/docset/winserver2022-ps/addsdeployment/Uninstall-ADDSDomainController.md @@ -162,14 +162,14 @@ Accept wildcard characters: False ### -IgnoreLastDCInDomainMismatch Indicates that Windows PowerShell ignores any inconsistency that it detects with the value that you -specify for the `-LastDomainControllerInDomain` parameter. For instance, if you specify -`-LastDomainControllerInDomain` but Windows PowerShell detects that there is actually another active -domain controller in the domain, you can specify the `-IgnoreLastDCInDomainMismatch` parameter to -have Windows PowerShell continue the removal of AD DS from the domain controller despite the -inconsistency that it has detected. Similarly, if you do not specify `-LastDomainControllerInDomain` -but Windows PowerShell cannot detect that another domain controller is in the domain, you can -specify `-IgnoreLastDCInDomainMismatch` to have Windows PowerShell continue to remove AD DS from the -domain controller. +specify for the **LastDomainControllerInDomain** parameter. For instance, if you specify +**LastDomainControllerInDomain** but Windows PowerShell detects that there is actually another +active domain controller in the domain, you can specify the **IgnoreLastDCInDomainMismatch** +parameter to have Windows PowerShell continue the removal of AD DS from the domain controller +despite the inconsistency that it has detected. Similarly, if you do not specify +**LastDomainControllerInDomain** but Windows PowerShell cannot detect that another domain +controller is in the domain, you can specify **IgnoreLastDCInDomainMismatch** to have Windows +PowerShell continue to remove AD DS from the domain controller. ```yaml Type: System.Management.Automation.SwitchParameter From 498101af427cd46b22b0773456d3d3b801abf4e4 Mon Sep 17 00:00:00 2001 From: "Mikey Lombardi (He/Him)" Date: Tue, 2 May 2023 09:05:57 -0500 Subject: [PATCH 329/650] Remove extra newline after synopsis --- .../addsdeployment/Uninstall-ADDSDomainController.md | 1 - 1 file changed, 1 deletion(-) diff --git a/docset/winserver2022-ps/addsdeployment/Uninstall-ADDSDomainController.md b/docset/winserver2022-ps/addsdeployment/Uninstall-ADDSDomainController.md index 7364e7fe14..59b27ff9dc 100644 --- a/docset/winserver2022-ps/addsdeployment/Uninstall-ADDSDomainController.md +++ b/docset/winserver2022-ps/addsdeployment/Uninstall-ADDSDomainController.md @@ -11,7 +11,6 @@ title: Uninstall-ADDSDomainController # Uninstall-ADDSDomainController ## SYNOPSIS - Uninstalls a domain controller in Active Directory. ## SYNTAX From 9dd364b86fcc4c79ffae91544d0cde6cc1772fb1 Mon Sep 17 00:00:00 2001 From: Rob Derickson Date: Sat, 29 Apr 2023 18:57:31 -0400 Subject: [PATCH 330/650] Fix formatting for Export-Certificate. --- .../pki/Export-Certificate.md | 110 +++++++++++------- 1 file changed, 68 insertions(+), 42 deletions(-) diff --git a/docset/winserver2022-ps/pki/Export-Certificate.md b/docset/winserver2022-ps/pki/Export-Certificate.md index c7ecaa7087..dc9e2b3a0b 100644 --- a/docset/winserver2022-ps/pki/Export-Certificate.md +++ b/docset/winserver2022-ps/pki/Export-Certificate.md @@ -11,66 +11,78 @@ title: Export-Certificate # Export-Certificate ## SYNOPSIS + Exports a certificate from a certificate store into a file. ## SYNTAX ``` -Export-Certificate [-Type ] [-NoClobber] [-Force] -FilePath -Cert [-WhatIf] - [-Confirm] [] +Export-Certificate [-Type ] [-NoClobber] [-Force] -FilePath + -Cert [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION -The **Export-Certificate** cmdlet exports a certificate from a certificate store to a file. -The private key is not included in the export. -If more than one certificate is being exported, then the default file format is SST. -Otherwise, the default format is CERT. -Use the **Type** parameter to change the file format. + +The `Export-Certificate` cmdlet exports a certificate from a certificate store to a file. The +private key is not included in the export. If more than one certificate is being exported, then the +default file format is `SST`. Otherwise, the default format is `CERT`. Use the **Type** parameter to +change the file format. ## EXAMPLES ### EXAMPLE 1 -``` -PS C:\>$cert = Get-ChildItem -Path cert:\CurrentUser\My\EEDEF61D4FF6EDBAAD538BB08CCAADDC3EE28FF -PS C:\>Export-Certificate -Cert $cert -FilePath c:\certs\user.sst -Type SST +```powershell +$cert = Get-ChildItem -Path Cert:\CurrentUser\My\EEDEF61D4FF6EDBAAD538BB08CCAADDC3EE28FF + +Export-Certificate -Cert $cert -FilePath C:\Certs\user.sst -Type SST ``` -This example exports a certificate to the file system as a Microsoft serialized certificate store without its private key. +This example exports a certificate to the file system as a Microsoft serialized certificate store +without its private key. ### EXAMPLE 2 -``` -PS C:\>$cert = Get-ChildItem -Path cert:\CurrentUser\My\EEDEF61D4FF6EDBAAD538BB08CCAADDC3EE28FF -PS C:\>Export-Certificate -Cert $cert -FilePath c:\certs\user.cer +```powershell +$cert = Get-ChildItem -Path Cert:\CurrentUser\My\EEDEF61D4FF6EDBAAD538BB08CCAADDC3EE28FF + +Export-Certificate -Cert $cert -FilePath C:\Certs\user.cer ``` -This example exports a certificate to the file system as a DER-encoded `.cer` file without its private key. +This example exports a certificate to the file system as a DER-encoded `.cer` file without its +private key. ### EXAMPLE 3 -``` -PS C:\>$cert = Get-ChildItem -Path cert:\CurrentUser\My\EEDEF61D4FF6EDBAAD538BB08CCAADDC3EE28FF -PS C:\>Export-Certificate -Cert $cert -FilePath c:\certs\user.p7b -Type p7b +```powershell +$cert = Get-ChildItem -Path Cert:\CurrentUser\My\EEDEF61D4FF6EDBAAD538BB08CCAADDC3EE28FF + +Export-Certificate -Cert $cert -FilePath C:\Certs\user.p7b -Type p7b ``` -This example exports a certificate to the file system as a PKCS#7-formatted .p7b file without its private key. +This example exports a certificate to the file system as a PKCS#7-formatted `.p7b` file without its +private key. ### EXAMPLE 4 -``` -PS C:\>Get-ChildItem -Path cert:\CurrentUser\my | Export-Certificate -FilePath c:\certs\allcerts.sst -Type SST + +```powershell +Get-ChildItem -Path Cert:\CurrentUser\My | + Export-Certificate -FilePath C:\Certs\allcerts.sst -Type SST ``` -This example exports all certificates under CurrentUser\my store into a Microsoft serialized certificate store allcerts.sst. +This example exports all certificates under the `Cert:\CurrentUser\My` store into a Microsoft +serialized certificate store `allcerts.sst`. ## PARAMETERS ### -Cert -Specifies one or more certificates to be exported to a file. -A single certificate object, an array of certificate objects, or a path to one or more certificates in a certificate store can be specified. + +Specifies one or more certificates to be exported to a file. A single certificate object, an array +of certificate objects, or a path to one or more certificates in a certificate store can be +specified. ```yaml -Type: Certificate +Type: Microsoft.CertificateServices.Commands.Certificate Parameter Sets: (All) Aliases: @@ -82,10 +94,11 @@ Accept wildcard characters: False ``` ### -Confirm + Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf @@ -97,10 +110,11 @@ Accept wildcard characters: False ``` ### -FilePath + Specifies the location where the exported certificate will be stored. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: FullName @@ -112,11 +126,13 @@ Accept wildcard characters: False ``` ### -Force -Specifies that the exported certificate file will overwrite an existing certificate file, even if it has the Read-only attribute set. -The **NoClobber** parameter takes precedence over this parameter when both are used. + +Specifies that the exported certificate file will overwrite an existing certificate file, even if it +has the Read-only attribute set. The **NoClobber** parameter takes precedence over this parameter +when both are used. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -128,11 +144,13 @@ Accept wildcard characters: False ``` ### -NoClobber -Prevents an exported certificate file from overwriting an existing certificate file. -This parameter takes precedence over the **Force** parameter, which permits this cmdlet to overwrite an existing certificate file, even if it has the Read-only attribute set. + +Prevents an exported certificate file from overwriting an existing certificate file. This parameter +takes precedence over the **Force** parameter, which permits this cmdlet to overwrite an existing +certificate file, even if it has the Read-only attribute set. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -144,18 +162,19 @@ Accept wildcard characters: False ``` ### -Type -Specifies the type of output file for the certificate export as follows. - -- SST: A Microsoft serialized certificate store (.sst) file format which can contain one or more certificates. -This is the default value for multiple certificates. +Specifies the type of output file for the certificate export as follows. - -- CERT: A .cer file format which contains a single DER-encoded certificate. -This is the default value for one certificate. + -- `SST`: A Microsoft serialized certificate store (`.sst`) file format which can contain one or + more certificates. This is the default value for multiple certificates. - -- P7B: A PKCS#7 file format which can contain one or more certificates. + -- `CERT`: A `.cer` file format which contains a single DER-encoded certificate. This is the + default value for one certificate. + + -- `P7B`: A PKCS#7 file format which can contain one or more certificates. ```yaml -Type: CertType +Type: Microsoft.CertificateServices.Commands.CertType Parameter Sets: (All) Aliases: Accepted values: SST, CERT, P7B @@ -168,11 +187,12 @@ Accept wildcard characters: False ``` ### -WhatIf + Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi @@ -184,16 +204,22 @@ Accept wildcard characters: False ``` ### CommonParameters -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). + +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). ## INPUTS ### System.Security.Cryptography.X509Certificates.X509Certificate2 + A Certificate object can be piped into to this cmdlet. ## OUTPUTS ### System.IO.FileInfo + The **FileInfo** object contains the information about the certificate file. ## NOTES From c6dcdf3546dd6df41ccbac14616fb6f94e259bb1 Mon Sep 17 00:00:00 2001 From: Rob Derickson Date: Sat, 29 Apr 2023 19:51:02 -0400 Subject: [PATCH 331/650] Fix formatting for Export-PfxCertificate. --- .../pki/Export-PfxCertificate.md | 202 +++++++++++------- 1 file changed, 127 insertions(+), 75 deletions(-) diff --git a/docset/winserver2022-ps/pki/Export-PfxCertificate.md b/docset/winserver2022-ps/pki/Export-PfxCertificate.md index f4281e689e..28ea17d163 100644 --- a/docset/winserver2022-ps/pki/Export-PfxCertificate.md +++ b/docset/winserver2022-ps/pki/Export-PfxCertificate.md @@ -11,103 +11,138 @@ title: Export-PfxCertificate # Export-PfxCertificate ## SYNOPSIS + Exports a certificate or a PFXData object to a Personal Information Exchange (PFX) file. ## SYNTAX ### PfxCert + ``` -Export-PfxCertificate [-NoProperties] [-NoClobber] [-Force] [-CryptoAlgorithmOption ] - [-ChainOption ] [-ProtectTo ] [-Password ] [-FilePath] +Export-PfxCertificate [-NoProperties] [-NoClobber] [-Force] + [-CryptoAlgorithmOption ] [-ChainOption ] + [-ProtectTo ] [-Password ] [-FilePath] [-PFXData] [-WhatIf] [-Confirm] [] ``` ### NormalCert + ``` -Export-PfxCertificate [-NoProperties] [-NoClobber] [-Force] [-CryptoAlgorithmOption ] - [-ChainOption ] [-ProtectTo ] [-Password ] [-FilePath] +Export-PfxCertificate [-NoProperties] [-NoClobber] [-Force] + [-CryptoAlgorithmOption ] [-ChainOption ] + [-ProtectTo ] [-Password ] [-FilePath] [-Cert] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION -The **Export-PfxCertificate** cmdlet exports a certificate or a **PFXData** object to a Personal Information Exchange (PFX) file. -By default, extended properties and the entire chain are exported. -Delegation may be required when using this cmdlet with Windows PowerShell® remoting and changing user configuration. +The `Export-PfxCertificate`` cmdlet exports a certificate or a **PFXData** object to a Personal +Information Exchange (PFX) file. By default, extended properties and the entire chain are exported. + +Delegation may be required when using this cmdlet with Windows PowerShell remoting and changing +user configuration. ## EXAMPLES ### EXAMPLE 1 -``` -PS C:\>$mypwd = ConvertTo-SecureString -String "1234" -Force -AsPlainText -PS C:\>Get-ChildItem -Path cert:\localMachine\my\5F98EBBFE735CDDAE00E33E0FD69050EF9220254 | Export-PfxCertificate -FilePath C:\mypfx.pfx -Password $mypwd +```powershell +$mypwd = ConvertTo-SecureString -String "1234" -Force -AsPlainText + +Get-ChildItem -Path Cert:\LocalMachine\My\5F98EBBFE735CDDAE00E33E0FD69050EF9220254 | + Export-PfxCertificate -FilePath C:\mypfx.pfx -Password $mypwd ``` -This example exports a certificate from the local machine store to a PFX file which includes the entire chain and all external properties. +This example exports a certificate from the local machine store to a PFX file which includes the +entire chain and all external properties. ### EXAMPLE 2 -``` -PS C:\>$mypwd = ConvertTo-SecureString -String "1234" -Force -AsPlainText -PS C:\>Get-ChildItem -Path cert:\LocalMachine\my | Export-PfxCertificate -FilePath C:\mypfx.pfx -Password $mypwd +```powershell +$mypwd = ConvertTo-SecureString -String "1234" -Force -AsPlainText + +Get-ChildItem -Path Cert:\LocalMachine\My | + Export-PfxCertificate -FilePath C:\mypfx.pfx -Password $mypwd ``` -This example exports all certificates under the My store for the machine account into one file named mypfx.pfx. -In order for this cmdlet to succeed, all keys need to be exportable. +This example exports all certificates under the My store for the machine account into one file named +`mypfx.pfx`. In order for this cmdlet to succeed, all keys need to be exportable. ### EXAMPLE 3 -``` -PS C:\>$mypwd = ConvertTo-SecureString -String "1234" -Force -AsPlainText -PS C:\>Export-PfxCertificate -Cert cert:\currentuser\my\5F98EBBFE735CDDAE00E33E0FD69050EF9220254 -FilePath c:\myexport.pfx -ChainOption EndEntityCertOnly -NoProperties -Password $mypwd +``` powershell +$mypwd = ConvertTo-SecureString -String "1234" -Force -AsPlainText + +$params = @{ + Cert = 'Cert:\CurrentUser\My\5F98EBBFE735CDDAE00E33E0FD69050EF9220254' + FilePath = 'C:\myexport.pfx' + ChainOption = 'EndEntityCertOnly' + NoProperties = $true + Password = $mypwd +} +Export-PfxCertificate @params ``` -This example exports a certificate from the current user store with no chain and no external properties +This example exports a certificate from the current user store with no chain and no external +properties ### EXAMPLE 4 -``` -PS C:\>$a = Get-ChildItem -Path cert:\localMachine\my -PS C:\>Export-PfxCertificate -Cert $a[1] -FilePath C:\myexport.pfx -ProtectTo "contoso\billb99", "contoso\johnj99" +```powershell +$a = Get-ChildItem -Path Cert:\LocalMachine\My + +$params = @{ + Cert = $a[1] + FilePath = 'C:\myexport.pfx' + ProtectTo = 'billb99', 'johnj99' +} +Export-PfxCertificate @params ``` -This example exports a certificate from the current machine store. -Both user accounts, contos\billb99 and contos\johnj99, can access this PFX with no password. -A Windows® 8 DC for key distribution is required. +This example exports a certificate from the local machine store. Both user accounts, `billb99` and +`johnj99`, can access this PFX with no password. A Windows Server 2012 or later domain controller is +required for key distribution. ### EXAMPLE 5 -``` -PS C:\>$a = Get-ChildItem -Path cert:\localMachine\my -PS C:\>$mypwd = ConvertTo-SecureString -String "1234" -Force -AsPlainText +```powershell +$a = Get-ChildItem -Path Cert:\LocalMachine\My -PS C:\>Export-PfxCertificate -Cert $a[1] -FilePath C:\myexport.pfx -ProtectTo "contoso\billb99", "contoso\johnj99" -Password $mypwd +$mypwd = ConvertTo-SecureString -String "1234" -Force -AsPlainText + +$params = @{ + Cert = $a[1] + FilePath = 'C:\myexport.pfx' + ProtectTo = 'billb99', '\johnj99' + Password = $mypwd +} +Export-PfxCertificate @params ``` -This example exports a certificate from the current machine store. -Both user accounts, johnj99 and billb99, can access this PFX file with no password. -For everyone else, they need to use 1234 as a password. -A Windows 8 DC for key distribution is required. +This example exports a certificate from the local machine store. Both user accounts, `johnj99` and +`billb99`, can access this PFX file with no password. For everyone else, they need to use 1234 as a +password. A Windows Server 2012 or later domain controller is required for key distribution. ### EXAMPLE 6 -``` -PS C:\>$NewPwd = ConvertTo-SecureString -String "abcd" -Force -AsPlainText -PS C:\>$mypfx = Get-PfxData -FilePath C:\mypfx.pfx -Password $Oldpwd +```powershell +$NewPwd = ConvertTo-SecureString -String "abcd" -Force -AsPlainText + +$mypfx = Get-PfxData -FilePath C:\mypfx.pfx -Password $Oldpwd -PS C:\>Export-PfxCertificate -PFXData $mypfx -FilePath C:\mypfx2.pfx -Password $NewPwd +Export-PfxCertificate -PFXData $mypfx -FilePath C:\mypfx2.pfx -Password $NewPwd ``` -This example changes an existing password for a PFX file from $OldPwd to $NewPwd. +This example changes an existing password for a PFX file from `$OldPwd` to `$NewPwd`. ## PARAMETERS ### -Cert + Specifies the path to the certificate to be exported. ```yaml -Type: Certificate +Type: Microsoft.CertificateServices.Commands.Certificate Parameter Sets: NormalCert Aliases: PsPath @@ -119,21 +154,22 @@ Accept wildcard characters: False ``` ### -ChainOption + Specifies the options for building a chain when exporting certificates. The acceptable values for this parameter are: - -- BuildChain: Certificate chain for all end entity certificates will be built and included in the export. -This option is valid for both **PfxData** and **Cert** parameters. -In the case of **PfxData** parameter, the collection of all PFX certificates will be used as an additional store. + -- `BuildChain`: Certificate chain for all end entity certificates will be built and included in + the export. This option is valid for both **PfxData** and **Cert** parameters. In the case of + **PfxData** parameter, the collection of all PFX certificates will be used as an additional store. - -- EndEntityCertOnly: Only end entity certificates are exported without any chain. -This option is valid for both the **PfxData** and the **Cert** parameters. + -- `EndEntityCertOnly`: Only end entity certificates are exported without any chain. This option is + valid for both the **PfxData** and the **Cert** parameters. - -- PfxDataOnly: Certificates contained in **PFXData** objects will be exported with no chain building. -This option is only valid when the **PfxData** parameter is used. + -- `PfxDataOnly`: Certificates contained in **PFXData** objects will be exported with no chain + building. This option is only valid when the **PfxData** parameter is used. ```yaml -Type: ExportChainOption +Type: Microsoft.CertificateServices.Commands.ExportChainOption Parameter Sets: (All) Aliases: Accepted values: BuildChain, EndEntityCertOnly, PfxDataOnly @@ -146,10 +182,11 @@ Accept wildcard characters: False ``` ### -Confirm + Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf @@ -161,14 +198,16 @@ Accept wildcard characters: False ``` ### -CryptoAlgorithmOption -Specifies the algorithm for encrypting private keys within the PFX file. If this parameter is not specified, the default is TripleDES_SHA1. The acceptable values for this parameter are: --- TripleDES_SHA1: Private keys will be encrypted in the PFX file using Triple DES encryption. +Specifies the algorithm for encrypting private keys within the PFX file. If this parameter is not +specified, the default is `TripleDES_SHA1`. The acceptable values for this parameter are: + +-- `TripleDES_SHA1`: Private keys will be encrypted in the PFX file using Triple DES encryption. --- AES256_SHA256: Private keys will be encrypted in the PFX file using AES-256 encryption. +-- `AES256_SHA256`: Private keys will be encrypted in the PFX file using AES-256 encryption. ```yaml -Type: CryptoAlgorithmOptions +Type: Microsoft.CertificateServices.Commands.CryptoAlgorithmOptions Parameter Sets: (All) Aliases: Accepted values: TripleDES_SHA1, AES256_SHA256 @@ -181,10 +220,11 @@ Accept wildcard characters: False ``` ### -FilePath + Specifies the path for the PFX file to be exported. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -196,11 +236,13 @@ Accept wildcard characters: False ``` ### -Force -Specifies that the provided PFX file should be overwritten, even if the Read-only attribute is set on the file. -By default, this cmdlet overwrites existing PFX files without warning, unless the Read-only or hidden attribute is set or the **NoClobber** parameter is used in the cmdlet. + +Specifies that the provided PFX file should be overwritten, even if the Read-only attribute is set +on the file. By default, this cmdlet overwrites existing PFX files without warning, unless the +Read-only or hidden attribute is set or the **NoClobber** parameter is used in the cmdlet. ```yaml -Type: SwitchParameter +Type: Microsoft.CertificateServices.Commands.CryptoAlgorithmOptions Parameter Sets: (All) Aliases: @@ -212,11 +254,12 @@ Accept wildcard characters: False ``` ### -NoClobber -Specifies that if the PFX file already exists, it should not be over written. -This parameter takes precedence over the **Force** parameter, which permits this cmdlet to overwrite a PFX file even if it has the Read-only attribute set. +Specifies that if the PFX file already exists, it should not be over written. This parameter takes +precedence over the **Force** parameter, which permits this cmdlet to overwrite a PFX file even if +it has the Read-only attribute set. ```yaml -Type: SwitchParameter +Type: Microsoft.CertificateServices.Commands.CryptoAlgorithmOptions Parameter Sets: (All) Aliases: @@ -228,12 +271,13 @@ Accept wildcard characters: False ``` ### -NoProperties -Specifies whether the extended properties for a certificate are exported. -If this parameter is specified, then extended properties are not included with the export. -By default, all extended properties are included in the exported file. + +Specifies whether the extended properties for a certificate are exported. If this parameter is +specified, then extended properties are not included with the export. By default, all extended +properties are included in the exported file. ```yaml -Type: SwitchParameter +Type: Microsoft.CertificateServices.Commands.CryptoAlgorithmOptions Parameter Sets: (All) Aliases: @@ -245,6 +289,7 @@ Accept wildcard characters: False ``` ### -PFXData + Specifies a **PFXData** object that contains one or more certificates from a PFX file. ```yaml @@ -260,12 +305,13 @@ Accept wildcard characters: False ``` ### -Password -Specifies the password used to protect the exported PFX file. -The password should be in the form of secure string. -Either the **ProtectTo** or this parameter must be specified, or an error will be displayed. + +Specifies the password used to protect the exported PFX file. The password should be in the form of +secure string. Either the **ProtectTo** or this parameter must be specified, or an error will be +displayed. ```yaml -Type: SecureString +Type: System.SecureString Parameter Sets: (All) Aliases: @@ -277,12 +323,12 @@ Accept wildcard characters: False ``` ### -ProtectTo -Specifies an array of strings for the username or group name that can access the private key of PFX file without any password. -This requires a Windows Server® 2012 domain controller. -Either the **Password** or this parameter must be specified, or an error will be displayed. +Specifies an array of strings for the username or group name that can access the private key of PFX +file without any password. This requires a Windows Server 2012 or later domain controller. Either +the **Password** or this parameter must be specified, or an error will be displayed. ```yaml -Type: String[] +Type: System.String[] Parameter Sets: (All) Aliases: @@ -294,11 +340,12 @@ Accept wildcard characters: False ``` ### -WhatIf + Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: Microsoft.CertificateServices.Commands.CryptoAlgorithmOptions Parameter Sets: (All) Aliases: wi @@ -310,16 +357,22 @@ Accept wildcard characters: False ``` ### CommonParameters -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). + +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). ## INPUTS ### System.Security.Cryptography.X509Certificates.X509Certificate2[] + The **X509Certificate2\[\]** object is an array of certificate objects. ## OUTPUTS ### System.IO.FileInfo + The **FileInfo** object contains the information about the PFX file. ## NOTES @@ -333,4 +386,3 @@ The **FileInfo** object contains the information about the PFX file. [Get-PfxData](./Get-PfxData.md) [Import-PfxCertificate](./Import-PfxCertificate.md) - From 3d1e1d150b51ecb59b2e2e8a5495ad5845882540 Mon Sep 17 00:00:00 2001 From: Rob Derickson Date: Sat, 29 Apr 2023 19:51:26 -0400 Subject: [PATCH 332/650] Fix formatting for Get-Certificate. --- .../winserver2022-ps/pki/Get-Certificate.md | 195 ++++++++++++------ 1 file changed, 130 insertions(+), 65 deletions(-) diff --git a/docset/winserver2022-ps/pki/Get-Certificate.md b/docset/winserver2022-ps/pki/Get-Certificate.md index e96cb452ff..749b04a33e 100644 --- a/docset/winserver2022-ps/pki/Get-Certificate.md +++ b/docset/winserver2022-ps/pki/Get-Certificate.md @@ -11,108 +11,154 @@ title: Get-Certificate # Get-Certificate ## SYNOPSIS -Submits a certificate request to an enrollment server and installs the response or retrieves a certificate for a previously submitted request. + +Submits a certificate request to an enrollment server and installs the response or retrieves a +certificate for a previously submitted request. ## SYNTAX ### SubmitRequest + ``` -Get-Certificate [-Url ] -Template [-SubjectName ] [-DnsName ] - [-Credential ] [-CertStoreLocation ] [-WhatIf] [-Confirm] [] +Get-Certificate [-Url ] -Template [-SubjectName ] + [-DnsName ] [-Credential ] [-CertStoreLocation ] + [-WhatIf] [-Confirm] [] ``` ### PendingRetrieval + ``` -Get-Certificate -Request [-Credential ] [-WhatIf] [-Confirm] [] +Get-Certificate -Request [-Credential ] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION -The **Get-Certificate** cmdlet can be used to submit a certificate request and install the resulting certificate, install a certificate from a pending certificate request, and enroll for ldap. -If the request is issued, then the returned certificate is installed in the store determined by the **CertStoreLocation** parameter and return the certificate in the EnrollmentResult structure with status Issued. -If the request is made pending, then the request is installed in the machine REQUEST store and a request is returned in the EnrollmentResult structure with status Pending. -This cmdlet can be used in a Stateless mode where this cmdlet does not look up anything in the vault or in a Stateful mode where it looks at registered certificate enrollment policy servers by identifier (ID) and credential. -When used with a request object and no credential, this cmdlet will look up credentials in the vault based on the URL for the enrollment policy server. +The `Get-Certificate` cmdlet can be used to submit a certificate request and install the resulting +certificate, install a certificate from a pending certificate request, and enroll for LDAP. If the +request is issued, then the returned certificate is installed in the store determined by the +**CertStoreLocation** parameter and return the certificate in the **EnrollmentResult** structure +with status Issued. If the request is made pending, then the request is installed in the machine +REQUEST store and a request is returned in the **EnrollmentResult** structure with status Pending. + +This cmdlet can be used in a Stateless mode where this cmdlet does not look up anything in the vault +or in a Stateful mode where it looks at registered certificate enrollment policy servers by +identifier (ID) and credential. When used with a request object and no credential, this cmdlet will +look up credentials in the vault based on the URL for the enrollment policy server. -This cmdlet will not accept a policy server identifier (ID). -If a URL is not specified, then only the default certificate enrollment policy ID is used and the cmdlet will attempt to obtain policy information from any of its URLs. +This cmdlet will not accept a policy server identifier (ID). If a URL is not specified, then only +the default certificate enrollment policy ID is used and the cmdlet will attempt to obtain policy +information from any of its URLs. -Delegation may be required when using this cmdlet with Windows PowerShell® remoting and changing user configuration. +Delegation may be required when using this cmdlet with Windows PowerShell remoting and changing user +configuration. ## EXAMPLES ### EXAMPLE 1 -``` -PS C:\>$up = Get-Credential -PS C:\>Get-Certificate -Template SslWebServer -DnsName www.contoso.com,www.fabrikam.com -Url https://www.contoso.com/Policy/service.svc -Credential $up -CertStoreLocation cert:\LocalMachine\My +```powershell +$cred = Get-Credential + +$params = @{ + Template = 'SslWebServer' + DnsName = 'www.contoso.com', 'www.fabrikam.com' + Url = 'https://www.contoso.com/Policy/service.svc' + Credential = $cred + CertStoreLocation = 'Cert:\LocalMachine\My' +} +Get-Certificate @params ``` -This example submits a certificate request for the SslWebServer template to the specific URL using the user name and password credentials. -The request will have two DNS names in it. -This is for a certificate in the machine store. -If the request is issued, then the returned certificate is installed in the machine MY store and the certificate in the EnrollmentResult structure is returned with the status Issued. -If the request is made pending, then the request is installed in the machine REQUEST store and the request in the EnrollmentResult structure is returned with the status Pending. +This example submits a certificate request for the `SslWebServer` template to the specific URL using +the user name and password credentials. The request will have two DNS names in it. This is for a +certificate in the machine store. If the request is issued, then the returned certificate is +installed in the machine My store and the certificate in the **EnrollmentResult** structure is +returned with the status Issued. If the request is made pending, then the request is installed in +the machine REQUEST store and the request in the **EnrollmentResult** structure is returned with the +status Pending. ### EXAMPLE 2 -``` -PS C:\>$cert = Get-ChildItem -Path cert:\LocalMachine\My\EEDEF61D4FF6EDBAAD538BB08CCAADDC3EE28FF -PS C:\>$enrollResult = Get-Certificate -Template SslWebServer -DnsName www.contoso.com -Url https://www.contoso.com/policy/service.svc -Credential $cert -CertStoreLocation cert:\LocalMachine\My +```powershell +$cert = Get-ChildItem -Path cert:\LocalMachine\My\EEDEF61D4FF6EDBAAD538BB08CCAADDC3EE28FF + +$params = @{ + Template = 'SslWebServer' + DnsName = 'www.contoso.com' + Url = 'https://www.contoso.com/policy/service.svc' + Credential = $cert + CertStoreLocation = 'Cert:\LocalMachine\My' +} +$enrollResult = Get-Certificate @params ``` -This example submits a certificate request to a specific URL using the certificate credential for authentication. +This example submits a certificate request to a specific URL using the certificate credential for +authentication. ### EXAMPLE 3 -``` -PS C:\>Set-Location -Path cert:\LocalMachine\My -PS cert:\LocalMachine\My>$enrollResult = Get-Certificate -Template WorkstationTemplate -Url https://www.contoso.com/service.svc +```powershell +$params = @{ + Template = 'WorkstationTemplate' + Url = 'https://www.contoso.com/service.svc' +} + +Set-Location -Path Cert:\LocalMachine\My + +PS Cert:\LocalMachine\My>$enrollResult = Get-Certificate @params ``` -This example authenticates the URL using the machine account and Windows integrated authentication and submits a request for a machine certificate of template named WorkstationTemplate. +This example authenticates the URL using the machine account and Windows integrated authentication +and submits a request for a machine certificate of template named `WorkstationTemplate`. ### EXAMPLE 4 -``` -PS C:\>Set-Location -Path cert:\CurrentUser\My -PS cert:\CurrentUser\My>Get-Certificate -Template User -Url ldap: +```powershell +Set-Location -Path Cert:\CurrentUser\My + +PS Cert:\CurrentUser\My> Get-Certificate -Template User -Url ldap: ``` -This example uses Windows integrated authentication to enroll for a certificate of template User using direct DCOM calls to the CA. +This example uses Windows integrated authentication to enroll for a certificate of template `User` +using direct DCOM calls to the Certificate Authority. ### EXAMPLE 5 -``` -PS C:\>$request = Get-ChildItem -Path cert:\LocalMachine\Request\EEDEF61D4FF6EDBAAD538BB08CCAADDC3EE28FF -PS C:\>$up = Get-Credential +```powershell +$request = Get-ChildItem -Path cert:\LocalMachine\Request\EEDEF61D4FF6EDBAAD538BB08CCAADDC3EE28FF + +$cred = Get-Credential -PS C:\>Get-Certificate -Request $request -Credential $up +Get-Certificate -Request $request -Credential $cred ``` This example retrieves and submits a pending request using a user name and password as credentials. ### EXAMPLE 6 -``` -PS C:\>$request = Get-ChildItem -Path cert:\LocalMachine\Request\EEDEF61D4FF6EDBAAD538BB08CCAADDC3EE28FF -PS C:\>Get-Certificate -Request $request +```powershell +$request = Get-ChildItem -Path cert:\LocalMachine\Request\EEDEF61D4FF6EDBAAD538BB08CCAADDC3EE28FF + +Get-Certificate -Request $request ``` -This example retrieves the certificate identified by $request. -If the authentication type for $request.EnrollmentServer.AuthType is not Kerberos, then look in the credential store to see if there is a credential for $request.EnrollmentServer.Url. -If there is a credential, then use it. -If there is no credential, then Windows PowerShell® will request it (if Windows PowerShell is in Interactive mode). +This example retrieves the certificate identified by `$request`. If the authentication type for +`$request.EnrollmentServer.AuthType` is not Kerberos, then look in the credential store to see if +there is a credential for `$request.EnrollmentServer.Url`. If there is a credential, then use it. If +there is no credential, then Windows PowerShell will request it (if Windows PowerShell is in +Interactive mode). ## PARAMETERS ### -CertStoreLocation + Specifies the path to the certificate store for the received certificate. If the request is made pending, then the request object is saved in the corresponding request store. -Note: Only My store is supported. +Note: Only `My` store is supported. ```yaml -Type: String +Type: System.String Parameter Sets: SubmitRequest Aliases: @@ -124,10 +170,11 @@ Accept wildcard characters: False ``` ### -Confirm + Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf @@ -139,12 +186,13 @@ Accept wildcard characters: False ``` ### -Credential -Specifies the credential to use for certificate enrollment. -The credential can be a user name and password (a credential object), an X509 certificate, or the path to a certificate. -If a credential is not specified, then Kerberos authentication is used. + +Specifies the credential to use for certificate enrollment. The credential can be a user name and +password (a credential object), an X509 certificate, or the path to a certificate. If a credential +is not specified, then Kerberos authentication is used. ```yaml -Type: PkiCredential +Type: Microsoft.CertificateServices.Commands.PkiCredential Parameter Sets: (All) Aliases: @@ -156,10 +204,12 @@ Accept wildcard characters: False ``` ### -DnsName -Specifies one or more DNS names to be included in the certificate request as subject alternative name extension. + +Specifies one or more DNS names to be included in the certificate request as subject alternative +name extension. ```yaml -Type: String[] +Type: System.String[] Parameter Sets: SubmitRequest Aliases: @@ -171,10 +221,11 @@ Accept wildcard characters: False ``` ### -Request + Specifies the X509 certificate or the path to a requested certificate located in the request store. ```yaml -Type: Certificate +Type: Microsoft.CertificateServices.Commands.Certificate Parameter Sets: PendingRetrieval Aliases: @@ -186,10 +237,11 @@ Accept wildcard characters: False ``` ### -SubjectName + Specifies the subject name to be included in the certificate request. ```yaml -Type: String +Type: System.String Parameter Sets: SubmitRequest Aliases: @@ -201,10 +253,12 @@ Accept wildcard characters: False ``` ### -Template -Specifies the object identifier or name of a certificate template to use with the certificate request. + +Specifies the object identifier or name of a certificate template to use with the certificate +request. ```yaml -Type: String +Type: System.String Parameter Sets: SubmitRequest Aliases: @@ -216,12 +270,14 @@ Accept wildcard characters: False ``` ### -Url -Specifies the policy server URL to use for certificate enrollment. -Credentials are required if the endpoint requires a user name and password or certificate authentication from the client. -If credentials are not found and Windows PowerShell® is in interactive mode, then a prompt for credentials will appear. + +Specifies the policy server URL to use for certificate enrollment. Credentials are required if the +endpoint requires a user name and password or certificate authentication from the client. If +credentials are not found and Windows PowerShell is in interactive mode, then a prompt for +credentials will appear. ```yaml -Type: Uri +Type: System.Uri Parameter Sets: SubmitRequest Aliases: @@ -233,11 +289,12 @@ Accept wildcard characters: False ``` ### -WhatIf + Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi @@ -249,20 +306,28 @@ Accept wildcard characters: False ``` ### CommonParameters -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). + +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). ## INPUTS ### System.Security.Cryptography.X509Certificates.X509Certificate2 -The Certificate object can either be provided as a Path object to a certificate or an **X509Certificate2** object. + +The Certificate object can either be provided as a Path object to a certificate or an +**X509Certificate2** object. ### System.Uri -The **Uri** object can also be pipelined by the Url property name. + +The **Uri** object can also be pipelined by the **Url** property name. ## OUTPUTS ### Microsoft.CertificateServices.Commands.EnrollmentResult -The EnrollmentResult object contains the results of enrollment. + +The **EnrollmentResult** object contains the results of enrollment. ## NOTES From e01efe48b471e2187318548e934f2baeba3bab53 Mon Sep 17 00:00:00 2001 From: Rob Derickson Date: Sat, 29 Apr 2023 20:01:18 -0400 Subject: [PATCH 333/650] Fix formatting for Get-CertificateAutoEnrollmentPolicy. --- .../Get-CertificateAutoEnrollmentPolicy.md | 59 ++++++++++++------- 1 file changed, 39 insertions(+), 20 deletions(-) diff --git a/docset/winserver2022-ps/pki/Get-CertificateAutoEnrollmentPolicy.md b/docset/winserver2022-ps/pki/Get-CertificateAutoEnrollmentPolicy.md index 7dbeb548b9..8c3265710b 100644 --- a/docset/winserver2022-ps/pki/Get-CertificateAutoEnrollmentPolicy.md +++ b/docset/winserver2022-ps/pki/Get-CertificateAutoEnrollmentPolicy.md @@ -11,25 +11,34 @@ title: Get-CertificateAutoEnrollmentPolicy # Get-CertificateAutoEnrollmentPolicy ## SYNOPSIS + Retrieves certificate auto-enrollment policy settings. ## SYNTAX ``` -Get-CertificateAutoEnrollmentPolicy -Scope -context [] +Get-CertificateAutoEnrollmentPolicy -Scope -Context + [] ``` ## DESCRIPTION -The **Get-CertificateAutoEnrollmentPolicy** cmdlet gets certificate auto-enrollment policy settings for the user or computer. -This cmdlet can return the settings configured in local policy or that are being applied from either local or domain policy. -Delegation may be required when using this cmdlet with Windows PowerShell® remoting and changing user configuration. +The **Get-CertificateAutoEnrollmentPolicy** cmdlet gets certificate auto-enrollment policy settings +for the user or computer. This cmdlet can return the settings configured in local policy or that are +being applied from either local or domain policy. + +Delegation may be required when using this cmdlet with Windows PowerShell remoting and changing user +configuration. ## EXAMPLES ### EXAMPLE 1 + +```powershell +Get-CertificateAutoEnrollmentPolicy -Scope Local -Context User ``` -PS C:\>Get-CertificateAutoEnrollmentPolicy -Scope Local -Context User + +```Output PolicyState : Enabled EnableMyStoreManagement : True EnableTemplateCheck : True @@ -38,20 +47,22 @@ StoreName : {MY} EnableBalloonNotifications : False ``` -This example gets the locally configured certificate auto-enrollment user policy. -In this example, the Renew expired certificates, update pending certificates, and remove revoked certificates and Update certificates that use certificates templates options are enabled. -Also, the Expiration notifications option is enabled and set to 10 percent of the certificate lifetime which are stored in the MY store. -Finally, Balloon notifications are disabled. +This example gets the locally configured certificate auto-enrollment user policy. In this example, +the renew expired certificates, update pending certificates, remove revoked certificates, and update +certificates that use certificates templates options are enabled. Also, the expiration notifications +option is enabled and set to 10 percent of the certificate lifetime which are stored in the MY +store. Finally, balloon notifications are disabled. ## PARAMETERS ### -Scope -Specifies the scope of the enrollment policy to return. -If Local scope is specified, then the locally configured policy is returned. -If Applied scope is specified, then the currently applied policy which can be either the local policy or a domain policy, is returned. + +Specifies the scope of the enrollment policy to return. If `Local` scope is specified, then the +locally configured policy is returned. If `Applied` scope is specified, then the currently applied +policy which can be either the local policy or a domain policy, is returned. ```yaml -Type: AutoEnrollmentPolicyScope +Type: Microsoft.CertificateServices.Commands.AutoEnrollmentPolicyScope Parameter Sets: (All) Aliases: Accepted values: Applied, Local @@ -63,11 +74,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -context +### -Context + Specifies the context of the enrollment policy to return. ```yaml -Type: Context +Type: Microsoft.CertificateServices.Commands.Context Parameter Sets: (All) Aliases: Accepted values: Machine, User @@ -80,22 +92,29 @@ Accept wildcard characters: False ``` ### CommonParameters -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). + +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). ## INPUTS ### Microsoft.CertificateServices.Commands.AutoEnrollmentPolicy -The **AutoEnrollmentPolicy** object combines certificate auto-enrollment policy settings and exposes them as properties. + +The **AutoEnrollmentPolicy** object combines certificate auto-enrollment policy settings and exposes +them as properties. ## OUTPUTS ### Microsoft.CertificateServices.Commands.AutoEnrollmentPolicy -The **AutoEnrollmentPolicy** object combines certificate auto-enrollment policy settings and exposes them as properties. -Each property can be modified and piped into the Set-CertificateAutoEnrollmentPolicy cmdlet to be applied. + +The **AutoEnrollmentPolicy** object combines certificate auto-enrollment policy settings and exposes +them as properties. Each property can be modified and piped into the +`Set-CertificateAutoEnrollmentPolicy` cmdlet to be applied. ## NOTES ## RELATED LINKS [Set-CertificateAutoEnrollmentPolicy](./Set-CertificateAutoEnrollmentPolicy.md) - From 37696b8192c0169e5038b843f2a94a1cfd277d29 Mon Sep 17 00:00:00 2001 From: Rob Derickson Date: Sat, 29 Apr 2023 21:39:17 -0400 Subject: [PATCH 334/650] Fix formatting for Get-CertificateEnrollmentPolicyServer. --- .../Get-CertificateEnrollmentPolicyServer.md | 57 ++++++++++++------- 1 file changed, 38 insertions(+), 19 deletions(-) diff --git a/docset/winserver2022-ps/pki/Get-CertificateEnrollmentPolicyServer.md b/docset/winserver2022-ps/pki/Get-CertificateEnrollmentPolicyServer.md index 7440353cc8..c8815acc90 100644 --- a/docset/winserver2022-ps/pki/Get-CertificateEnrollmentPolicyServer.md +++ b/docset/winserver2022-ps/pki/Get-CertificateEnrollmentPolicyServer.md @@ -11,49 +11,60 @@ title: Get-CertificateEnrollmentPolicyServer # Get-CertificateEnrollmentPolicyServer ## SYNOPSIS + Returns all of the certificate enrollment policy server URL configurations. ## SYNTAX ``` -Get-CertificateEnrollmentPolicyServer [-Url ] -Scope -context - [] +Get-CertificateEnrollmentPolicyServer [-Url ] -Scope + -Context [] ``` ## DESCRIPTION -The **Get-CertificateEnrollmentPolicyServer** cmdlet retrieves information required for connecting to one or more certificate enrollment policy servers configured for this user or computer. -The returned information can be filtered by providing a specific URL, a specific scope, or requesting only user or computer (machine) context. + +The `Get-CertificateEnrollmentPolicyServer` cmdlet retrieves information required for connecting to +one or more certificate enrollment policy servers configured for this user or computer. The returned +information can be filtered by providing a specific URL, a specific scope, or requesting only user +or computer (machine) context. ## EXAMPLES ### EXAMPLE 1 -``` -PS C:\>Get-CertificateEnrollmentPolicyServer -Scope All -Context User + +```powershell +Get-CertificateEnrollmentPolicyServer -Scope All -Context User ``` -This example returns all of the enrollment policy URL configurations that are included with the user configuration, Group Policy, and local policy for the User context. +This example returns all of the enrollment policy URL configurations that are included with the user +configuration, Group Policy, and local policy for the user context. ### EXAMPLE 2 -``` -PS C:\>Get-CertificateEnrollmentPolicyServer -Url http://www.contoso.com/Policy/service.svc -Scope All -Context Machine + +```powershell +Get-CertificateEnrollmentPolicyServer -Url http://www.contoso.com/Policy/service.svc -Scope All -Context Machine ``` -This example returns all of the enrollment policy URL configurations that have the given URL for the machine context. +This example returns all of the enrollment policy URL configurations that have the given URL for the +machine context. ### EXAMPLE 3 -``` -PS C:\>Get-CertificateEnrollmentPolicyServer -Scope ConfiguredByYou -Context User + +```powershell +Get-CertificateEnrollmentPolicyServer -Scope ConfiguredByYou -Context User ``` -This example returns all of the enrollment policy server URL configurations that are configured for the User context. +This example returns all of the enrollment policy server URL configurations that are configured for +the user context. ## PARAMETERS ### -Scope + Specifies where the cmdlet will find the enrollment policy server configuration. ```yaml -Type: EnrollmentPolicyServerScope +Type: Microsoft.CertificateServices.Commands.EnrollmentPolicyServerScope Parameter Sets: (All) Aliases: Accepted values: Applied, ConfiguredByYou, All @@ -66,10 +77,11 @@ Accept wildcard characters: False ``` ### -Url + Limits the returned enrollment policy servers to the servers that contain the provided URL. ```yaml -Type: Uri +Type: System.Uri Parameter Sets: (All) Aliases: @@ -80,11 +92,13 @@ Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` -### -context -Retrieves information about the enrollment policy server for the local computer (machine) or Current User context. +### -Context + +Retrieves information about the enrollment policy server for the local computer (machine) or current +user context. ```yaml -Type: Context +Type: Microsoft.CertificateServices.Commands.Context Parameter Sets: (All) Aliases: Accepted values: Machine, User @@ -97,7 +111,11 @@ Accept wildcard characters: False ``` ### CommonParameters -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). + +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). ## INPUTS @@ -106,6 +124,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### Microsoft.CertificateServices.Commands.EnrollmentPolicyUrlDescription[] + Describes the enrollment policy obtained from the specified URL. ## NOTES From 86c6a832dcafaf5f2df1d6b8c6ebd3c8d6914efe Mon Sep 17 00:00:00 2001 From: Rob Derickson Date: Sat, 29 Apr 2023 21:40:46 -0400 Subject: [PATCH 335/650] Fix formatting for Get-CertificateEnrollmentPolicyServer. --- .../pki/Get-CertificateEnrollmentPolicyServer.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/docset/winserver2022-ps/pki/Get-CertificateEnrollmentPolicyServer.md b/docset/winserver2022-ps/pki/Get-CertificateEnrollmentPolicyServer.md index c8815acc90..f3f011ccb1 100644 --- a/docset/winserver2022-ps/pki/Get-CertificateEnrollmentPolicyServer.md +++ b/docset/winserver2022-ps/pki/Get-CertificateEnrollmentPolicyServer.md @@ -42,7 +42,12 @@ configuration, Group Policy, and local policy for the user context. ### EXAMPLE 2 ```powershell -Get-CertificateEnrollmentPolicyServer -Url http://www.contoso.com/Policy/service.svc -Scope All -Context Machine +$params = @{ + Url = 'http://www.contoso.com/Policy/service.svc' + Scope = 'All' + Context = 'Machine' +} +Get-CertificateEnrollmentPolicyServer @params ``` This example returns all of the enrollment policy URL configurations that have the given URL for the @@ -134,4 +139,3 @@ Describes the enrollment policy obtained from the specified URL. [Add-CertificateEnrollmentPolicyServer](./Add-CertificateEnrollmentPolicyServer.md) [Remove-CertificateNotificationTask](./Remove-CertificateNotificationTask.md) - From 1a63720a91006363fa1dc6086fc9ac866176f7c7 Mon Sep 17 00:00:00 2001 From: Rob Derickson Date: Sat, 29 Apr 2023 21:42:30 -0400 Subject: [PATCH 336/650] Fix formatting for Get-CertificateNotificationTask. --- .../pki/Get-CertificateNotificationTask.md | 25 +++++++++++++------ 1 file changed, 18 insertions(+), 7 deletions(-) diff --git a/docset/winserver2022-ps/pki/Get-CertificateNotificationTask.md b/docset/winserver2022-ps/pki/Get-CertificateNotificationTask.md index d48b789be6..0b65483f34 100644 --- a/docset/winserver2022-ps/pki/Get-CertificateNotificationTask.md +++ b/docset/winserver2022-ps/pki/Get-CertificateNotificationTask.md @@ -11,6 +11,7 @@ title: Get-CertificateNotificationTask # Get-CertificateNotificationTask ## SYNOPSIS + Returns all registered certificate notification tasks. ## SYNTAX @@ -20,31 +21,42 @@ Get-CertificateNotificationTask [] ``` ## DESCRIPTION -The **Get-CertificateNotificationTask** cmdlet returns all certificate notification tasks currently registered by the New-CertificateNotificationTask cmdlet. + +The `Get-CertificateNotificationTask` cmdlet returns all certificate notification tasks currently +registered by the `New-CertificateNotificationTask` cmdlet. ## EXAMPLES ### EXAMPLE 1 -``` -PS C:\>Get-CertificateNotificationTask + +```powershell +Get-CertificateNotificationTask ``` -This example gets all certificate notification tasks currently registered by the New-CertificateNotificationTask cmdlet. +This example gets all certificate notification tasks currently registered by the +`New-CertificateNotificationTask` cmdlet. ## PARAMETERS ### CommonParameters -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). + +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). ## INPUTS ### None + None ## OUTPUTS ### Microsoft.CertificateServices.Command.CertificateNotificationTask -This cmdlet returns a **CertificateNotificationTask** object for each certificate notification task that is currently registered by the New-CertificateNotificationTask cmdlet. + +This cmdlet returns a **CertificateNotificationTask** object for each certificate notification task +that is currently registered by the `New-CertificateNotificationTask` cmdlet. ## NOTES @@ -55,4 +67,3 @@ This cmdlet returns a **CertificateNotificationTask** object for each certificat [Remove-CertificateNotificationTask](./Remove-CertificateNotificationTask.md) [Switch-Certificate](./Switch-Certificate.md) - From 6220a08167cc6af5fa72948d3f67e3dcdc6a140f Mon Sep 17 00:00:00 2001 From: Rob Derickson Date: Sat, 29 Apr 2023 21:47:04 -0400 Subject: [PATCH 337/650] Fix formatting for Get-PfxData. --- docset/winserver2022-ps/pki/Get-PfxData.md | 45 ++++++++++++++-------- 1 file changed, 30 insertions(+), 15 deletions(-) diff --git a/docset/winserver2022-ps/pki/Get-PfxData.md b/docset/winserver2022-ps/pki/Get-PfxData.md index 0c1367f369..3d57144897 100644 --- a/docset/winserver2022-ps/pki/Get-PfxData.md +++ b/docset/winserver2022-ps/pki/Get-PfxData.md @@ -11,7 +11,9 @@ title: Get-PfxData # Get-PfxData ## SYNOPSIS -Extracts the content of a Personal Information Exchange (PFX) file into a structure without importing it to certificate store. + +Extracts the content of a Personal Information Exchange (PFX) file into a structure without +importing it to certificate store. ## SYNTAX @@ -20,37 +22,44 @@ Get-PfxData [-Password ] [-FilePath] [] ``` ## DESCRIPTION -The **Get-PfxData** cmdlet extracts the content of a Personal Information Exchange (PFX) file into a structure that contains the end entity certificate, any intermediate and root certificates. + +The `Get-PfxData` cmdlet extracts the content of a Personal Information Exchange (PFX) file into a +structure that contains the end entity certificate, and any intermediate and root certificates. ## EXAMPLES ### EXAMPLE 1 -``` -PS C:\>$mypwd = ConvertTo-SecureString -String "1234" -Force -AsPlainText -PS C:\>$mypfx = Get-PfxData -FilePath C:\mypfx.pfx -Password $mypwd +```powershell +$mypwd = ConvertTo-SecureString -String '1234' -Force -AsPlainText + +$mypfx = Get-PfxData -FilePath C:\mypfx.pfx -Password $mypwd ``` -This example returns certificate information for the file mypfx.pfx located on the C: drive that is secured with the specified password. +This example returns certificate information for the file `C:\mypfx.pfx` that is secured with the +specified password. ### EXAMPLE 2 -``` -PS C:\>$NewPwd = ConvertTo-SecureString -String "abcd" -Force -AsPlainText -PS C:\>$mypfx = Get-PfxData -FilePath C:\mypfx.pfx -Password $OldPwd +```powershell +$NewPwd = ConvertTo-SecureString -String 'abcd' -Force -AsPlainText + +$mypfx = Get-PfxData -FilePath C:\mypfx.pfx -Password $OldPwd -PS C:\>Export-PfxCertificate -PfxData $mypfx -FilePath C:\mypfx.pfx -Password $NewPwd -Force +Export-PfxCertificate -PfxData $mypfx -FilePath C:\mypfx.pfx -Password $NewPwd -Force ``` -This example shows how one can change an existing password for mypfx.pfx file from $OldPwd to $NewPwd. +This example shows how one can change an existing password for `mypfx.pfx` file from `$OldPwd` to +`$NewPwd`. ## PARAMETERS ### -FilePath + Specifies the path to the PFX file. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: FullName @@ -62,10 +71,11 @@ Accept wildcard characters: False ``` ### -Password + Specifies the password for the imported PFX file. ```yaml -Type: SecureString +Type: System.SecureString Parameter Sets: (All) Aliases: @@ -77,16 +87,22 @@ Accept wildcard characters: False ``` ### CommonParameters -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). + +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). ## INPUTS ### System.String + A string containing the path to PFX file. ## OUTPUTS ### Microsoft.CertificateServices.Commands.PFXData + A **PFXData** object. ## NOTES @@ -96,4 +112,3 @@ A **PFXData** object. [ConvertTo-SecureString](https://go.microsoft.com/fwlink/p/?LinkID=293933) [Export-PfxCertificate](./Export-PfxCertificate.md) - From 323fc63e2f26f34b16eb48f5c88f423cb95b25a5 Mon Sep 17 00:00:00 2001 From: Rob Derickson Date: Sat, 29 Apr 2023 21:59:12 -0400 Subject: [PATCH 338/650] Because PowerShell-Docs style does not specify inline file extension style, removed backticks to comply with Microsoft style shown here: https://learn.microsoft.com/en-us/style-guide/text-formatting/formatting-common-text-elements --- docset/winserver2022-ps/pki/Export-Certificate.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docset/winserver2022-ps/pki/Export-Certificate.md b/docset/winserver2022-ps/pki/Export-Certificate.md index dc9e2b3a0b..20fc54804e 100644 --- a/docset/winserver2022-ps/pki/Export-Certificate.md +++ b/docset/winserver2022-ps/pki/Export-Certificate.md @@ -49,7 +49,7 @@ $cert = Get-ChildItem -Path Cert:\CurrentUser\My\EEDEF61D4FF6EDBAAD538BB08CCAADD Export-Certificate -Cert $cert -FilePath C:\Certs\user.cer ``` -This example exports a certificate to the file system as a DER-encoded `.cer` file without its +This example exports a certificate to the file system as a DER-encoded .cer file without its private key. ### EXAMPLE 3 @@ -60,7 +60,7 @@ $cert = Get-ChildItem -Path Cert:\CurrentUser\My\EEDEF61D4FF6EDBAAD538BB08CCAADD Export-Certificate -Cert $cert -FilePath C:\Certs\user.p7b -Type p7b ``` -This example exports a certificate to the file system as a PKCS#7-formatted `.p7b` file without its +This example exports a certificate to the file system as a PKCS#7-formatted .p7b file without its private key. ### EXAMPLE 4 @@ -165,10 +165,10 @@ Accept wildcard characters: False Specifies the type of output file for the certificate export as follows. - -- `SST`: A Microsoft serialized certificate store (`.sst`) file format which can contain one or + -- `SST`: A Microsoft serialized certificate store (.sst) file format which can contain one or more certificates. This is the default value for multiple certificates. - -- `CERT`: A `.cer` file format which contains a single DER-encoded certificate. This is the + -- `CERT`: A .cer file format which contains a single DER-encoded certificate. This is the default value for one certificate. -- `P7B`: A PKCS#7 file format which can contain one or more certificates. From 2a016e24afad07129115569ae3e32e70fae7ab90 Mon Sep 17 00:00:00 2001 From: Rob Derickson Date: Sat, 29 Apr 2023 21:59:37 -0400 Subject: [PATCH 339/650] Fix formatting for Export-PfxCertificate. --- docset/winserver2022-ps/pki/Export-PfxCertificate.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/docset/winserver2022-ps/pki/Export-PfxCertificate.md b/docset/winserver2022-ps/pki/Export-PfxCertificate.md index 28ea17d163..759130382e 100644 --- a/docset/winserver2022-ps/pki/Export-PfxCertificate.md +++ b/docset/winserver2022-ps/pki/Export-PfxCertificate.md @@ -47,7 +47,7 @@ user configuration. ### EXAMPLE 1 ```powershell -$mypwd = ConvertTo-SecureString -String "1234" -Force -AsPlainText +$mypwd = ConvertTo-SecureString -String '1234' -Force -AsPlainText Get-ChildItem -Path Cert:\LocalMachine\My\5F98EBBFE735CDDAE00E33E0FD69050EF9220254 | Export-PfxCertificate -FilePath C:\mypfx.pfx -Password $mypwd @@ -59,7 +59,7 @@ entire chain and all external properties. ### EXAMPLE 2 ```powershell -$mypwd = ConvertTo-SecureString -String "1234" -Force -AsPlainText +$mypwd = ConvertTo-SecureString -String '1234' -Force -AsPlainText Get-ChildItem -Path Cert:\LocalMachine\My | Export-PfxCertificate -FilePath C:\mypfx.pfx -Password $mypwd @@ -71,7 +71,7 @@ This example exports all certificates under the My store for the machine account ### EXAMPLE 3 ``` powershell -$mypwd = ConvertTo-SecureString -String "1234" -Force -AsPlainText +$mypwd = ConvertTo-SecureString -String '1234' -Force -AsPlainText $params = @{ Cert = 'Cert:\CurrentUser\My\5F98EBBFE735CDDAE00E33E0FD69050EF9220254' @@ -108,7 +108,7 @@ required for key distribution. ```powershell $a = Get-ChildItem -Path Cert:\LocalMachine\My -$mypwd = ConvertTo-SecureString -String "1234" -Force -AsPlainText +$mypwd = ConvertTo-SecureString -String '1234' -Force -AsPlainText $params = @{ Cert = $a[1] @@ -126,7 +126,7 @@ password. A Windows Server 2012 or later domain controller is required for key d ### EXAMPLE 6 ```powershell -$NewPwd = ConvertTo-SecureString -String "abcd" -Force -AsPlainText +$NewPwd = ConvertTo-SecureString -String 'abcd' -Force -AsPlainText $mypfx = Get-PfxData -FilePath C:\mypfx.pfx -Password $Oldpwd @@ -254,6 +254,7 @@ Accept wildcard characters: False ``` ### -NoClobber + Specifies that if the PFX file already exists, it should not be over written. This parameter takes precedence over the **Force** parameter, which permits this cmdlet to overwrite a PFX file even if it has the Read-only attribute set. @@ -323,6 +324,7 @@ Accept wildcard characters: False ``` ### -ProtectTo + Specifies an array of strings for the username or group name that can access the private key of PFX file without any password. This requires a Windows Server 2012 or later domain controller. Either the **Password** or this parameter must be specified, or an error will be displayed. From 5c83c640952826a84f606da979b7fe332e8d8eed Mon Sep 17 00:00:00 2001 From: Rob Derickson Date: Sat, 29 Apr 2023 22:05:35 -0400 Subject: [PATCH 340/650] Fix formatting for Import-Certificate. --- .../pki/Import-Certificate.md | 66 +++++++++++++------ 1 file changed, 45 insertions(+), 21 deletions(-) diff --git a/docset/winserver2022-ps/pki/Import-Certificate.md b/docset/winserver2022-ps/pki/Import-Certificate.md index 8e2d6d11d5..962d72fe70 100644 --- a/docset/winserver2022-ps/pki/Import-Certificate.md +++ b/docset/winserver2022-ps/pki/Import-Certificate.md @@ -11,51 +11,66 @@ title: Import-Certificate # Import-Certificate ## SYNOPSIS + Imports one or more certificates into a certificate store. ## SYNTAX ``` -Import-Certificate [-FilePath] [-CertStoreLocation ] [-WhatIf] [-Confirm] [] +Import-Certificate [-FilePath] [-CertStoreLocation ] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION -The **Import-Certificate** cmdlet imports one or more certificates into a certificate store. + +The `Import-Certificate` cmdlet imports one or more certificates into a certificate store. ## EXAMPLES ### EXAMPLE 1 -``` -Import-Certificate -FilePath "C:\Users\xyz\Desktop\BackupCert.Cer" -CertStoreLocation cert:\CurrentUser\Root + +```powershell +$params = @{ + FilePath = 'C:\Users\Xyz\Desktop\BackupCert.cer' + CertStoreLocations = 'Cert:\CurrentUser\Root' +} +Import-Certificate @params ``` This example imports the certificate from the file into the root store of the current user. ### EXAMPLE 2 -``` -PS C:\>Set-Location -Path cert:\CurrentUser\My -PS cert:\CurrentUser\My>Import-Certificate -Filepath "C:\files\intermediate.cert" +```powershell +Set-Location -Path cert:\CurrentUser\My + +PS Cert:\CurrentUser\My> Import-Certificate -Filepath 'C:\files\intermediate.cert' ``` This example imports the certificate from the file into the current store. ### EXAMPLE 3 -``` -Import-Certificate -FilePath "C:\Users\Xyz\Desktop\BackupCert.Cer" -CertStoreLocation Cert:\LocalMachine\Root + +```powershell +$params = @{ + FilePath = 'C:\Users\Xyz\Desktop\BackupCert.cer' + CertStoreLocation = 'Cert:\LocalMachine\Root' +} +Import-Certificate @params ``` -This example imports the certificate from the file into the root store of the Local Machine. +This example imports the certificate from the file into the root store of the local machine. ## PARAMETERS ### -CertStoreLocation -Specifies the path to the certificate store where the certificates will be imported. -If the path to the certificate store is not specified, then the current store is used. -In order to get a list of valid CertStoreLocation values, open Powershell and run "cd cert:". Afterwards type "dir". + +Specifies the path to the certificate store where the certificates will be imported. If the path to +the certificate store is not specified, then the current store is used. In order to get a list of +valid **CertStoreLocation** values, open PowerShell and run `Get-ChildItem Cert:\`. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -67,10 +82,11 @@ Accept wildcard characters: False ``` ### -Confirm + Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf @@ -82,12 +98,13 @@ Accept wildcard characters: False ``` ### -FilePath -Specifies the path to a certificate file to be imported. -Acceptable formats include .sst, .p7b, and .cert files. -If the file contains multiple certificates, then each certificate will be imported to the destination store. + +Specifies the path to a certificate file to be imported. Acceptable formats include .sst, .p7b, and +.cert files. If the file contains multiple certificates, then each certificate will be imported to +the destination store. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: FullName @@ -99,11 +116,12 @@ Accept wildcard characters: False ``` ### -WhatIf + Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi @@ -115,16 +133,22 @@ Accept wildcard characters: False ``` ### CommonParameters -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). + +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). ## INPUTS ### System.String + A **String** containing the file path. ## OUTPUTS ### System.Security.Cryptography.X509Certificates.X509Certificate2[] + The output is an array of **X509Certificate2\[\]** objects. ## NOTES From 7dda92c12a86f8f7833347f32a4a0a701f544f7f Mon Sep 17 00:00:00 2001 From: Rob Derickson Date: Sat, 29 Apr 2023 22:13:04 -0400 Subject: [PATCH 341/650] Fix formatting for Import-PfxCertificate. --- .../pki/Import-PfxCertificate.md | 94 ++++++++++++------- 1 file changed, 62 insertions(+), 32 deletions(-) diff --git a/docset/winserver2022-ps/pki/Import-PfxCertificate.md b/docset/winserver2022-ps/pki/Import-PfxCertificate.md index 2dc4e20eda..d2c909bd53 100644 --- a/docset/winserver2022-ps/pki/Import-PfxCertificate.md +++ b/docset/winserver2022-ps/pki/Import-PfxCertificate.md @@ -11,59 +11,77 @@ title: Import-PfxCertificate # Import-PfxCertificate ## SYNOPSIS -Imports certificates and private keys from a Personal Information Exchange (PFX) file to the destination store. + +Imports certificates and private keys from a Personal Information Exchange (PFX) file to the +destination store. ## SYNTAX ``` -Import-PfxCertificate [-Exportable] [-Password ] [[-CertStoreLocation] ] - [-FilePath] [-WhatIf] [-Confirm] [] +Import-PfxCertificate [-Exportable] [-Password ] + [[-CertStoreLocation] ] [-FilePath] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION -The **Import-PfxCertificate** cmdlet imports certificates and private keys from a PFX file to the destination store. -Certificates with and without private keys in the PFX file are imported, along with any external properties that are present. -Delegation may be required when using this cmdlet with Windows PowerShell® remoting and changing user configuration. +The `Import-PfxCertificate` cmdlet imports certificates and private keys from a PFX file to the +destination store. Certificates with and without private keys in the PFX file are imported, along +with any external properties that are present. + +Delegation may be required when using this cmdlet with Windows PowerShell remoting and changing user +configuration. ## EXAMPLES ### EXAMPLE 1 -``` -PS C:\>$mypwd = Get-Credential -UserName 'Enter password below' -Message 'Enter password below' -PS C:\>Import-PfxCertificate -FilePath C:\mypfx.pfx -CertStoreLocation Cert:\LocalMachine\My -Password $mypwd.Password +```powershell +$mypwd = Get-Credential -UserName 'Enter password below' -Message 'Enter password below' + +$params = @{ + FilePath = 'C:\mypfx.pfx' + CertStoreLocation = 'Cert:\LocalMachine\My' + Password = $mypwd.Password +} +Import-PfxCertificate @params ``` -This example imports the PFX file my.pfx with a private non-exportable key into the My store for the machine account. +This example imports the PFX file `mypfx.pfx` with a private, non-exportable key into the My store +for the machine account. ### EXAMPLE 2 -``` -PS C:\>Get-ChildItem -Path c:\mypfx\my.pfx | Import-PfxCertificate -CertStoreLocation Cert:\CurrentUser\My -Exportable + +```powershell +Get-ChildItem -Path C:\mypfx.pfx | + Import-PfxCertificate -CertStoreLocation Cert:\CurrentUser\My -Exportable ``` -This example imports the PFX file my.pfx with a private non-exportable key into the My store for the current user with private key exportable. -The **Password** parameter is not required since this PFX file is not password protected. +This example imports the PFX file `mypfx.pfx` with a private, exportable key into the My store for +the current user. The **Password** parameter is not required since this PFX file is not password +protected. ### EXAMPLE 3 -``` -PS C:\>Set-Location -Path cert:\localMachine\my -PS Cert:\localMachine\my>Import-PfxCertificate -FilePath c:\mypfx.pfx +```powershell +Set-Location -Path Cert:\LocalMachine\My + +PS Cert:\LocalMachine\My> Import-PfxCertificate -FilePath C:\mypfx.pfx ``` -This example imports the PFX file mypfx.pfx into the My store for the machine account. -The **Password** parameter is not required since this PFX file is protected using the domain account of this machine. -This requires a Windows Server® 2012 domain controller. +This example imports the PFX file `mypfx.pfx` into the My store for the machine account. The +**Password** parameter is not required since this PFX file is protected using the domain account of +this machine. This requires a Windows Server 2012 or later domain controller. ## PARAMETERS ### -CertStoreLocation -Specifies the path of the store to which certificates will be imported. -If this parameter is not specified, then the current path is used as the destination store. + +Specifies the path of the store to which certificates will be imported. If this parameter is not +specified, then the current path is used as the destination store. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -75,10 +93,11 @@ Accept wildcard characters: False ``` ### -Confirm + Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf @@ -90,11 +109,12 @@ Accept wildcard characters: False ``` ### -Exportable -Specifies whether the imported private key can be exported. -If this parameter is not specified, then the private key cannot be exported. + +Specifies whether the imported private key can be exported. If this parameter is not specified, then +the private key cannot be exported. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -106,10 +126,11 @@ Accept wildcard characters: False ``` ### -FilePath + Specifies the path for the PFX file. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: FullName @@ -121,10 +142,11 @@ Accept wildcard characters: False ``` ### -Password + Specifies the password for the imported PFX file in the form of a secure string. ```yaml -Type: SecureString +Type: System.SecureString Parameter Sets: (All) Aliases: @@ -136,11 +158,12 @@ Accept wildcard characters: False ``` ### -WhatIf + Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi @@ -152,17 +175,24 @@ Accept wildcard characters: False ``` ### CommonParameters -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). + +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). ## INPUTS ### System.String + A **String** containing the path to the PFX file. ## OUTPUTS ### System.Security.Cryptography.X509Certificates.X509Certificate2 -The imported **X509Certificate2** object contained in the PFX file that is associated with private keys. + +The imported **X509Certificate2** object contained in the PFX file that is associated with private +keys. ## NOTES From 85bd04ac61ca93e391e77f13472f623c62a5d211 Mon Sep 17 00:00:00 2001 From: Rob Derickson Date: Sat, 29 Apr 2023 22:30:30 -0400 Subject: [PATCH 342/650] Update docset/winserver2022-ps/pki/Get-CertificateAutoEnrollmentPolicy.md --- .../winserver2022-ps/pki/Get-CertificateAutoEnrollmentPolicy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/pki/Get-CertificateAutoEnrollmentPolicy.md b/docset/winserver2022-ps/pki/Get-CertificateAutoEnrollmentPolicy.md index 8c3265710b..de9653e7f0 100644 --- a/docset/winserver2022-ps/pki/Get-CertificateAutoEnrollmentPolicy.md +++ b/docset/winserver2022-ps/pki/Get-CertificateAutoEnrollmentPolicy.md @@ -23,7 +23,7 @@ Get-CertificateAutoEnrollmentPolicy -Scope -Context ## DESCRIPTION -The **Get-CertificateAutoEnrollmentPolicy** cmdlet gets certificate auto-enrollment policy settings +The `Get-CertificateAutoEnrollmentPolicy` cmdlet gets certificate auto-enrollment policy settings for the user or computer. This cmdlet can return the settings configured in local policy or that are being applied from either local or domain policy. From e4812008327b3d6de0c3118379606f28b89d19a0 Mon Sep 17 00:00:00 2001 From: Rob Derickson Date: Mon, 1 May 2023 22:57:42 -0400 Subject: [PATCH 343/650] Update docset/winserver2022-ps/pki/Export-Certificate.md Co-authored-by: Mikey Lombardi (He/Him) --- docset/winserver2022-ps/pki/Export-Certificate.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/pki/Export-Certificate.md b/docset/winserver2022-ps/pki/Export-Certificate.md index 20fc54804e..21420acbcc 100644 --- a/docset/winserver2022-ps/pki/Export-Certificate.md +++ b/docset/winserver2022-ps/pki/Export-Certificate.md @@ -60,7 +60,7 @@ $cert = Get-ChildItem -Path Cert:\CurrentUser\My\EEDEF61D4FF6EDBAAD538BB08CCAADD Export-Certificate -Cert $cert -FilePath C:\Certs\user.p7b -Type p7b ``` -This example exports a certificate to the file system as a PKCS#7-formatted .p7b file without its +This example exports a certificate to the file system as a PKCS#7-formatted `.p7b` file without its private key. ### EXAMPLE 4 From e5fdef0a9546895a1061a50dc196f20a11ab847c Mon Sep 17 00:00:00 2001 From: Rob Derickson Date: Mon, 1 May 2023 22:57:53 -0400 Subject: [PATCH 344/650] Update docset/winserver2022-ps/pki/Export-Certificate.md Co-authored-by: Mikey Lombardi (He/Him) --- docset/winserver2022-ps/pki/Export-Certificate.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/docset/winserver2022-ps/pki/Export-Certificate.md b/docset/winserver2022-ps/pki/Export-Certificate.md index 21420acbcc..ba64eb6c76 100644 --- a/docset/winserver2022-ps/pki/Export-Certificate.md +++ b/docset/winserver2022-ps/pki/Export-Certificate.md @@ -165,9 +165,8 @@ Accept wildcard characters: False Specifies the type of output file for the certificate export as follows. - -- `SST`: A Microsoft serialized certificate store (.sst) file format which can contain one or - more certificates. This is the default value for multiple certificates. - +- `SST`: A Microsoft serialized certificate store (`.sst`) file format which can contain one or + more certificates. This is the default value for multiple certificates. -- `CERT`: A .cer file format which contains a single DER-encoded certificate. This is the default value for one certificate. From e16b1c9206b2d0464053ee937fcd5dc698564cc1 Mon Sep 17 00:00:00 2001 From: Rob Derickson Date: Mon, 1 May 2023 22:58:32 -0400 Subject: [PATCH 345/650] Update docset/winserver2022-ps/pki/Export-PfxCertificate.md Co-authored-by: Mikey Lombardi (He/Him) --- docset/winserver2022-ps/pki/Export-PfxCertificate.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/pki/Export-PfxCertificate.md b/docset/winserver2022-ps/pki/Export-PfxCertificate.md index 759130382e..47dc4faf63 100644 --- a/docset/winserver2022-ps/pki/Export-PfxCertificate.md +++ b/docset/winserver2022-ps/pki/Export-PfxCertificate.md @@ -36,7 +36,7 @@ Export-PfxCertificate [-NoProperties] [-NoClobber] [-Force] ## DESCRIPTION -The `Export-PfxCertificate`` cmdlet exports a certificate or a **PFXData** object to a Personal +The `Export-PfxCertificate` cmdlet exports a certificate or a **PFXData** object to a Personal Information Exchange (PFX) file. By default, extended properties and the entire chain are exported. Delegation may be required when using this cmdlet with Windows PowerShell remoting and changing From 80d22d7d8c149715da8ff0217c2f1a3ad8564d4f Mon Sep 17 00:00:00 2001 From: Rob Derickson Date: Mon, 1 May 2023 22:58:40 -0400 Subject: [PATCH 346/650] Update docset/winserver2022-ps/pki/Export-PfxCertificate.md Co-authored-by: Mikey Lombardi (He/Him) --- docset/winserver2022-ps/pki/Export-PfxCertificate.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/docset/winserver2022-ps/pki/Export-PfxCertificate.md b/docset/winserver2022-ps/pki/Export-PfxCertificate.md index 47dc4faf63..2b5038ed05 100644 --- a/docset/winserver2022-ps/pki/Export-PfxCertificate.md +++ b/docset/winserver2022-ps/pki/Export-PfxCertificate.md @@ -162,9 +162,8 @@ The acceptable values for this parameter are: the export. This option is valid for both **PfxData** and **Cert** parameters. In the case of **PfxData** parameter, the collection of all PFX certificates will be used as an additional store. - -- `EndEntityCertOnly`: Only end entity certificates are exported without any chain. This option is - valid for both the **PfxData** and the **Cert** parameters. - +- `EndEntityCertOnly`: Only end entity certificates are exported without any chain. This option is + valid for both the **PfxData** and the **Cert** parameters. -- `PfxDataOnly`: Certificates contained in **PFXData** objects will be exported with no chain building. This option is only valid when the **PfxData** parameter is used. From 7d0767d7219672e5e447d354913ca8ead0b9f35b Mon Sep 17 00:00:00 2001 From: Rob Derickson Date: Mon, 1 May 2023 22:59:04 -0400 Subject: [PATCH 347/650] Update docset/winserver2022-ps/pki/Export-PfxCertificate.md Co-authored-by: Mikey Lombardi (He/Him) --- docset/winserver2022-ps/pki/Export-PfxCertificate.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docset/winserver2022-ps/pki/Export-PfxCertificate.md b/docset/winserver2022-ps/pki/Export-PfxCertificate.md index 2b5038ed05..2bca53dede 100644 --- a/docset/winserver2022-ps/pki/Export-PfxCertificate.md +++ b/docset/winserver2022-ps/pki/Export-PfxCertificate.md @@ -158,10 +158,10 @@ Accept wildcard characters: False Specifies the options for building a chain when exporting certificates. The acceptable values for this parameter are: - -- `BuildChain`: Certificate chain for all end entity certificates will be built and included in - the export. This option is valid for both **PfxData** and **Cert** parameters. In the case of - **PfxData** parameter, the collection of all PFX certificates will be used as an additional store. - +- `BuildChain`: Certificate chain for all end entity certificates will be built and included in the + export. This option is valid for both **PfxData** and **Cert** parameters. In the case of + **PfxData** parameter, the collection of all PFX certificates will be used as an additional + store. - `EndEntityCertOnly`: Only end entity certificates are exported without any chain. This option is valid for both the **PfxData** and the **Cert** parameters. -- `PfxDataOnly`: Certificates contained in **PFXData** objects will be exported with no chain From da8bbb710cdd728bf2cc05d6fce58abf994971b1 Mon Sep 17 00:00:00 2001 From: Rob Derickson Date: Mon, 1 May 2023 22:59:22 -0400 Subject: [PATCH 348/650] Update docset/winserver2022-ps/pki/Export-PfxCertificate.md Co-authored-by: Mikey Lombardi (He/Him) --- docset/winserver2022-ps/pki/Export-PfxCertificate.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docset/winserver2022-ps/pki/Export-PfxCertificate.md b/docset/winserver2022-ps/pki/Export-PfxCertificate.md index 2bca53dede..ba2e88dece 100644 --- a/docset/winserver2022-ps/pki/Export-PfxCertificate.md +++ b/docset/winserver2022-ps/pki/Export-PfxCertificate.md @@ -164,8 +164,8 @@ The acceptable values for this parameter are: store. - `EndEntityCertOnly`: Only end entity certificates are exported without any chain. This option is valid for both the **PfxData** and the **Cert** parameters. - -- `PfxDataOnly`: Certificates contained in **PFXData** objects will be exported with no chain - building. This option is only valid when the **PfxData** parameter is used. +- `PfxDataOnly`: Certificates contained in **PFXData** objects will be exported with no chain + building. This option is only valid when the **PfxData** parameter is used. ```yaml Type: Microsoft.CertificateServices.Commands.ExportChainOption From 8601c797173869c21acc6c15ac11af3334d56d05 Mon Sep 17 00:00:00 2001 From: Rob Derickson Date: Mon, 1 May 2023 22:59:35 -0400 Subject: [PATCH 349/650] Update docset/winserver2022-ps/pki/Get-Certificate.md Co-authored-by: Mikey Lombardi (He/Him) --- docset/winserver2022-ps/pki/Get-Certificate.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/pki/Get-Certificate.md b/docset/winserver2022-ps/pki/Get-Certificate.md index 749b04a33e..ae029a76b8 100644 --- a/docset/winserver2022-ps/pki/Get-Certificate.md +++ b/docset/winserver2022-ps/pki/Get-Certificate.md @@ -155,7 +155,9 @@ Interactive mode). Specifies the path to the certificate store for the received certificate. If the request is made pending, then the request object is saved in the corresponding request store. -Note: Only `My` store is supported. + +> [!NOTE] +> Only `My` store is supported. ```yaml Type: System.String From 8aab11e7c1015ecf031802a54f31b8e191c50fc4 Mon Sep 17 00:00:00 2001 From: Rob Derickson Date: Mon, 1 May 2023 22:59:54 -0400 Subject: [PATCH 350/650] Update docset/winserver2022-ps/pki/Import-Certificate.md Co-authored-by: Mikey Lombardi (He/Him) --- docset/winserver2022-ps/pki/Import-Certificate.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docset/winserver2022-ps/pki/Import-Certificate.md b/docset/winserver2022-ps/pki/Import-Certificate.md index 962d72fe70..0ceb31dd7a 100644 --- a/docset/winserver2022-ps/pki/Import-Certificate.md +++ b/docset/winserver2022-ps/pki/Import-Certificate.md @@ -99,9 +99,9 @@ Accept wildcard characters: False ### -FilePath -Specifies the path to a certificate file to be imported. Acceptable formats include .sst, .p7b, and -.cert files. If the file contains multiple certificates, then each certificate will be imported to -the destination store. +Specifies the path to a certificate file to be imported. Acceptable formats include `.sst`, `.p7b`, +and `.cert` files. If the file contains multiple certificates, then each certificate will be +imported to the destination store. ```yaml Type: System.String From 5deff81ebeacbb39f96ceefb53084d1eef8f6200 Mon Sep 17 00:00:00 2001 From: Rob Derickson Date: Mon, 1 May 2023 23:38:58 -0400 Subject: [PATCH 351/650] Added backticks around file extensions. Removed extra line break after Synopsis. Removed PowerShell prompts from examples where Set-Location is used to change the location to a cert store. --- docset/winserver2022-ps/pki/Export-Certificate.md | 7 +++---- docset/winserver2022-ps/pki/Export-PfxCertificate.md | 6 ++---- docset/winserver2022-ps/pki/Get-Certificate.md | 6 ++---- .../pki/Get-CertificateAutoEnrollmentPolicy.md | 1 - .../pki/Get-CertificateEnrollmentPolicyServer.md | 1 - .../pki/Get-CertificateNotificationTask.md | 1 - docset/winserver2022-ps/pki/Get-PfxData.md | 1 - docset/winserver2022-ps/pki/Import-Certificate.md | 3 +-- docset/winserver2022-ps/pki/Import-PfxCertificate.md | 3 +-- 9 files changed, 9 insertions(+), 20 deletions(-) diff --git a/docset/winserver2022-ps/pki/Export-Certificate.md b/docset/winserver2022-ps/pki/Export-Certificate.md index ba64eb6c76..ebd70056c4 100644 --- a/docset/winserver2022-ps/pki/Export-Certificate.md +++ b/docset/winserver2022-ps/pki/Export-Certificate.md @@ -11,7 +11,6 @@ title: Export-Certificate # Export-Certificate ## SYNOPSIS - Exports a certificate from a certificate store into a file. ## SYNTAX @@ -49,7 +48,7 @@ $cert = Get-ChildItem -Path Cert:\CurrentUser\My\EEDEF61D4FF6EDBAAD538BB08CCAADD Export-Certificate -Cert $cert -FilePath C:\Certs\user.cer ``` -This example exports a certificate to the file system as a DER-encoded .cer file without its +This example exports a certificate to the file system as a DER-encoded `.cer` file without its private key. ### EXAMPLE 3 @@ -167,10 +166,10 @@ Specifies the type of output file for the certificate export as follows. - `SST`: A Microsoft serialized certificate store (`.sst`) file format which can contain one or more certificates. This is the default value for multiple certificates. - -- `CERT`: A .cer file format which contains a single DER-encoded certificate. This is the +- `CERT`: A `.cer` file format which contains a single DER-encoded certificate. This is the default value for one certificate. - -- `P7B`: A PKCS#7 file format which can contain one or more certificates. +- `P7B`: A PKCS#7 file format which can contain one or more certificates. ```yaml Type: Microsoft.CertificateServices.Commands.CertType diff --git a/docset/winserver2022-ps/pki/Export-PfxCertificate.md b/docset/winserver2022-ps/pki/Export-PfxCertificate.md index ba2e88dece..66bcf66b4b 100644 --- a/docset/winserver2022-ps/pki/Export-PfxCertificate.md +++ b/docset/winserver2022-ps/pki/Export-PfxCertificate.md @@ -11,7 +11,6 @@ title: Export-PfxCertificate # Export-PfxCertificate ## SYNOPSIS - Exports a certificate or a PFXData object to a Personal Information Exchange (PFX) file. ## SYNTAX @@ -201,9 +200,8 @@ Accept wildcard characters: False Specifies the algorithm for encrypting private keys within the PFX file. If this parameter is not specified, the default is `TripleDES_SHA1`. The acceptable values for this parameter are: --- `TripleDES_SHA1`: Private keys will be encrypted in the PFX file using Triple DES encryption. - --- `AES256_SHA256`: Private keys will be encrypted in the PFX file using AES-256 encryption. +- `TripleDES_SHA1`: Private keys will be encrypted in the PFX file using Triple DES encryption. +- `AES256_SHA256`: Private keys will be encrypted in the PFX file using AES-256 encryption. ```yaml Type: Microsoft.CertificateServices.Commands.CryptoAlgorithmOptions diff --git a/docset/winserver2022-ps/pki/Get-Certificate.md b/docset/winserver2022-ps/pki/Get-Certificate.md index ae029a76b8..6131dcdcf3 100644 --- a/docset/winserver2022-ps/pki/Get-Certificate.md +++ b/docset/winserver2022-ps/pki/Get-Certificate.md @@ -11,7 +11,6 @@ title: Get-Certificate # Get-Certificate ## SYNOPSIS - Submits a certificate request to an enrollment server and installs the response or retrieves a certificate for a previously submitted request. @@ -103,10 +102,9 @@ $params = @{ Template = 'WorkstationTemplate' Url = 'https://www.contoso.com/service.svc' } - Set-Location -Path Cert:\LocalMachine\My -PS Cert:\LocalMachine\My>$enrollResult = Get-Certificate @params +$enrollResult = Get-Certificate @params ``` This example authenticates the URL using the machine account and Windows integrated authentication @@ -117,7 +115,7 @@ and submits a request for a machine certificate of template named `WorkstationTe ```powershell Set-Location -Path Cert:\CurrentUser\My -PS Cert:\CurrentUser\My> Get-Certificate -Template User -Url ldap: +Get-Certificate -Template User -Url ldap: ``` This example uses Windows integrated authentication to enroll for a certificate of template `User` diff --git a/docset/winserver2022-ps/pki/Get-CertificateAutoEnrollmentPolicy.md b/docset/winserver2022-ps/pki/Get-CertificateAutoEnrollmentPolicy.md index de9653e7f0..34880d1b4b 100644 --- a/docset/winserver2022-ps/pki/Get-CertificateAutoEnrollmentPolicy.md +++ b/docset/winserver2022-ps/pki/Get-CertificateAutoEnrollmentPolicy.md @@ -11,7 +11,6 @@ title: Get-CertificateAutoEnrollmentPolicy # Get-CertificateAutoEnrollmentPolicy ## SYNOPSIS - Retrieves certificate auto-enrollment policy settings. ## SYNTAX diff --git a/docset/winserver2022-ps/pki/Get-CertificateEnrollmentPolicyServer.md b/docset/winserver2022-ps/pki/Get-CertificateEnrollmentPolicyServer.md index f3f011ccb1..3ca961a686 100644 --- a/docset/winserver2022-ps/pki/Get-CertificateEnrollmentPolicyServer.md +++ b/docset/winserver2022-ps/pki/Get-CertificateEnrollmentPolicyServer.md @@ -11,7 +11,6 @@ title: Get-CertificateEnrollmentPolicyServer # Get-CertificateEnrollmentPolicyServer ## SYNOPSIS - Returns all of the certificate enrollment policy server URL configurations. ## SYNTAX diff --git a/docset/winserver2022-ps/pki/Get-CertificateNotificationTask.md b/docset/winserver2022-ps/pki/Get-CertificateNotificationTask.md index 0b65483f34..63fb5f7b3d 100644 --- a/docset/winserver2022-ps/pki/Get-CertificateNotificationTask.md +++ b/docset/winserver2022-ps/pki/Get-CertificateNotificationTask.md @@ -11,7 +11,6 @@ title: Get-CertificateNotificationTask # Get-CertificateNotificationTask ## SYNOPSIS - Returns all registered certificate notification tasks. ## SYNTAX diff --git a/docset/winserver2022-ps/pki/Get-PfxData.md b/docset/winserver2022-ps/pki/Get-PfxData.md index 3d57144897..0708633fa0 100644 --- a/docset/winserver2022-ps/pki/Get-PfxData.md +++ b/docset/winserver2022-ps/pki/Get-PfxData.md @@ -11,7 +11,6 @@ title: Get-PfxData # Get-PfxData ## SYNOPSIS - Extracts the content of a Personal Information Exchange (PFX) file into a structure without importing it to certificate store. diff --git a/docset/winserver2022-ps/pki/Import-Certificate.md b/docset/winserver2022-ps/pki/Import-Certificate.md index 0ceb31dd7a..9f1f8e53e4 100644 --- a/docset/winserver2022-ps/pki/Import-Certificate.md +++ b/docset/winserver2022-ps/pki/Import-Certificate.md @@ -11,7 +11,6 @@ title: Import-Certificate # Import-Certificate ## SYNOPSIS - Imports one or more certificates into a certificate store. ## SYNTAX @@ -44,7 +43,7 @@ This example imports the certificate from the file into the root store of the cu ```powershell Set-Location -Path cert:\CurrentUser\My -PS Cert:\CurrentUser\My> Import-Certificate -Filepath 'C:\files\intermediate.cert' +Import-Certificate -Filepath 'C:\files\intermediate.cert' ``` This example imports the certificate from the file into the current store. diff --git a/docset/winserver2022-ps/pki/Import-PfxCertificate.md b/docset/winserver2022-ps/pki/Import-PfxCertificate.md index d2c909bd53..fda69491c9 100644 --- a/docset/winserver2022-ps/pki/Import-PfxCertificate.md +++ b/docset/winserver2022-ps/pki/Import-PfxCertificate.md @@ -11,7 +11,6 @@ title: Import-PfxCertificate # Import-PfxCertificate ## SYNOPSIS - Imports certificates and private keys from a Personal Information Exchange (PFX) file to the destination store. @@ -66,7 +65,7 @@ protected. ```powershell Set-Location -Path Cert:\LocalMachine\My -PS Cert:\LocalMachine\My> Import-PfxCertificate -FilePath C:\mypfx.pfx +Import-PfxCertificate -FilePath C:\mypfx.pfx ``` This example imports the PFX file `mypfx.pfx` into the My store for the machine account. The From 4d5f2ba3a5826f46fadd36dd8a103fda028bf965 Mon Sep 17 00:00:00 2001 From: Rob Derickson Date: Tue, 2 May 2023 08:50:32 -0400 Subject: [PATCH 352/650] Update docset/winserver2022-ps/pki/Export-PfxCertificate.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- docset/winserver2022-ps/pki/Export-PfxCertificate.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/pki/Export-PfxCertificate.md b/docset/winserver2022-ps/pki/Export-PfxCertificate.md index 66bcf66b4b..b48b7c939c 100644 --- a/docset/winserver2022-ps/pki/Export-PfxCertificate.md +++ b/docset/winserver2022-ps/pki/Export-PfxCertificate.md @@ -252,7 +252,7 @@ Accept wildcard characters: False ### -NoClobber -Specifies that if the PFX file already exists, it should not be over written. This parameter takes +Specifies that if the PFX file already exists, it should not be overwritten. This parameter takes precedence over the **Force** parameter, which permits this cmdlet to overwrite a PFX file even if it has the Read-only attribute set. From ceabe4f5a81a7a637147b7d8b4754529ee8704c8 Mon Sep 17 00:00:00 2001 From: Rob Derickson Date: Sun, 30 Apr 2023 01:16:45 -0400 Subject: [PATCH 353/650] Fix formatting for New-CertificateNotificationTask. --- .../pki/New-CertificateNotificationTask.md | 131 ++++++++++++------ 1 file changed, 86 insertions(+), 45 deletions(-) diff --git a/docset/winserver2022-ps/pki/New-CertificateNotificationTask.md b/docset/winserver2022-ps/pki/New-CertificateNotificationTask.md index abca7edaca..5594149120 100644 --- a/docset/winserver2022-ps/pki/New-CertificateNotificationTask.md +++ b/docset/winserver2022-ps/pki/New-CertificateNotificationTask.md @@ -11,57 +11,82 @@ title: New-CertificateNotificationTask # New-CertificateNotificationTask ## SYNOPSIS -Creates a new task in the Task Scheduler that will be triggered when a certificate is replaced, expired, or about to expired. + +Creates a new task in the Task Scheduler that will be triggered when a certificate is replaced, +expired, or about to expired. ## SYNTAX ``` -New-CertificateNotificationTask -Type [-RunTaskForExistingCertificates] - -PSScript -Name -Channel [-WhatIf] [-Confirm] [] +New-CertificateNotificationTask -Type + [-RunTaskForExistingCertificates] -PSScript -Name + -Channel [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION -The **New-CertificateNotificationTask** cmdlet creates a new task in the Task Scheduler that will be triggered when a certificate is replaced or expires. -The task will launch the script specified by the **PSScript** parameter. -If the **RunTaskForExistingCertificates** parameter is specified, then after this cmdlet is registered, the cmdlet will go through all certificates (including archived certificates) in the My store and initiate Replace events for all certificates with a Renewal property. -The NewCertHash value will always be the one at the end of the renewal chain. -For example; if certificate A was renewed to certificate B, which was then renewed to certificate C, then the cmdlet fires two events: certificate A to certificate C and certificate B to certificate C. -This will ensure that applications that are still using old certificates are properly updated to the newest certificates. +The `New-CertificateNotificationTask` cmdlet creates a new task in the Task Scheduler that will be +triggered when a certificate is replaced or expires. The task will launch the script specified by +the **PSScript** parameter. + +If the **RunTaskForExistingCertificates** parameter is specified, then after this cmdlet is +registered, the cmdlet will go through all certificates (including archived certificates) in the My +store and initiate `Replace` events for all certificates with a Renewal property. The `NewCertHash` +value will always be the one at the end of the renewal chain. For example; if certificate A was +renewed to certificate B, which was then renewed to certificate C, then the cmdlet fires two events: +certificate A to certificate C and certificate B to certificate C. This will ensure that +applications that are still using old certificates are properly updated to the newest certificates. If any certificate has a renewal chain longer than 20, then the certificate is not logged. ## EXAMPLES ### EXAMPLE 1 -``` -PS C:\>New-CertificateNotificationTask -PSScript C:\myscript.ps1 -Channel System -Type Replace -Name "My System Certificate Task" + +```powershell +$params = @{ + PSScript = 'C:\myscript.ps1' + Channel = 'System' + Type = 'Replace' + Name = 'My System Certificate Task' +} +New-CertificateNotificationTask @params ``` -This example creates a system notification task for certificate replacement events with the name My System Certificate Task that will launch the myscript.ps1 script located on the C: drive. -The cmdlet will run on the local system. +This example creates a system notification task for certificate replacement events with the name +`My System Certificate Task` that will launch the `C:\myscript.ps1` script. The cmdlet will run on +the local system. ### EXAMPLE 2 -``` -PS C:\>New-CertificateNotificationTask -PSScript C:\myscript.ps1 -Channel User -Type Expire -Name "My User Certificate Task" + +```powershell +$params = @{ + PSScript = 'C:\myscript.ps1' + Channel = 'User' + Type = 'Expire' + Name = 'My User Certificate Task' +} +New-CertificateNotificationTask @params ``` -This example creates a system notification task for the expiration and close-to-expiration certificate events with the name My User Certificate Task that will launch the myscript.ps1 script located on the C: drive. +This example creates a system notification task for the expiration and close-to-expiration +certificate events with the name `My User Certificate Task` that will launch the `C:\myscript.ps1`. The cmdlet will run for all currently logged on users in the user contexts. ## PARAMETERS ### -Channel -Sets the channel of the CertificateServicesClient-Notifications log that will be monitored for certificate lifecycle events. -The acceptable values for this parameter are: - -- System: The Operation-System channel will be used. -This channel should be used to modify system certificate bindings that use computer certificates. +Sets the channel of the **CertificateServicesClient-Notifications** log that will be monitored for +certificate lifecycle events. The acceptable values for this parameter are: + + -- `System`: The **Operation-System** channel will be used. This channel should be used to modify + system certificate bindings that use computer certificates. - -- User: The Operational-User channel will be used. -This channel should be used to modify user certificate bindings. + -- `User`: The **Operational-User** channel will be used. This channel should be used to modify + user certificate bindings. ```yaml -Type: NotificationChannel +Type: Microsoft.CertificateServices.Commands.NotificationChannel Parameter Sets: (All) Aliases: Accepted values: System, User @@ -74,10 +99,11 @@ Accept wildcard characters: False ``` ### -Confirm + Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf @@ -89,11 +115,12 @@ Accept wildcard characters: False ``` ### -Name -Specifies the unique name for the certificate notification task. -If a certificate notification task with the same name already exists, then an error is generated. + +Specifies the unique name for the certificate notification task. If a certificate notification task +with the same name already exists, then an error is generated. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -105,11 +132,12 @@ Accept wildcard characters: False ``` ### -PSScript -Identifies the Windows PowerShell® script that will be triggered by the certificate notification task. -The script will be launched with the **NonInteractive** parameter. + +Identifies the Windows PowerShell script that will be triggered by the certificate notification +task. The script will be launched with the **NonInteractive** parameter. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -121,16 +149,21 @@ Accept wildcard characters: False ``` ### -RunTaskForExistingCertificates -Generates a replacement notification for any certificate in the My store that has been replaced in the past. -For the notification to be generated both certificates must be present in the store. -This parameter can only be used with the Replace type. -Note: The following warning will be displayed when this cmdlet is run with this parameter set to False and there are some certificates in MY store that would have resulted in a notification. - -- `There are certificates in My store that have been replaced in the past. -You can use the New-CertificateNotification cmdlet with the RunTaskForExistingCerts parameter to generate notifications for those certificates to correct any configuration problems that you may already have on this machine.` +Generates a replacement notification for any certificate in the My store that has been replaced in +the past. For the notification to be generated both certificates must be present in the store. This +parameter can only be used with the `Replace` type. + +Note: The following warning will be displayed when this this parameter set to `False` and there are +some certificates in MY store that would have resulted in a notification. + + -- `There are certificates in My store that have been replaced in the past. You can use the + New-CertificateNotification cmdlet with the RunTaskForExistingCerts parameter to generate + notifications for those certificates to correct any configuration problems that you may already + have on this machine.` ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -142,15 +175,18 @@ Accept wildcard characters: False ``` ### -Type -Specifies the type of events that will trigger certificate notifications. -The acceptable values for this parameter are: - -- Replace: Certificate replacement events will trigger this notification, including certificates that are renewed by auto-enrollment, using the Certificates snap-in, or by using the Switch-Certificate cmdlet. +Specifies the type of events that will trigger certificate notifications. The acceptable values for +this parameter are: + + -- `Replace`: Certificate replacement events will trigger this notification, including certificates + that are renewed by auto-enrollment, using the Certificates snap-in, or by using the + `Switch-Certificate` cmdlet. - -- Expire: Certificate expiration and close-to-expire events will trigger this notification. + -- `Expire`: Certificate expiration and close-to-expire events will trigger this notification. ```yaml -Type: CertificateNotificationType +Type: Microsoft.CertificateServices.Commands.CertificateNotificationType Parameter Sets: (All) Aliases: Accepted values: Replace, Expire @@ -163,11 +199,12 @@ Accept wildcard characters: False ``` ### -WhatIf + Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi @@ -179,7 +216,11 @@ Accept wildcard characters: False ``` ### CommonParameters -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). + +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). ## INPUTS @@ -188,6 +229,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### Microsoft.CertificateServices.Command.CertificateNotificationTask + A **CertificateNotificationTask** object that contains details about a newly created task. ## NOTES @@ -199,4 +241,3 @@ A **CertificateNotificationTask** object that contains details about a newly cre [Remove-CertificateNotificationTask](./Remove-CertificateNotificationTask.md) [Switch-Certificate](./Switch-Certificate.md) - From d9032fb5e93dc0353e7da0fe854ce1faf51f8abf Mon Sep 17 00:00:00 2001 From: Rob Derickson Date: Sun, 30 Apr 2023 21:28:34 -0400 Subject: [PATCH 354/650] Fix formatting for Remove-CertificateEnrollmentPolicyServer. --- ...emove-CertificateEnrollmentPolicyServer.md | 72 +++++++++++++------ 1 file changed, 50 insertions(+), 22 deletions(-) diff --git a/docset/winserver2022-ps/pki/Remove-CertificateEnrollmentPolicyServer.md b/docset/winserver2022-ps/pki/Remove-CertificateEnrollmentPolicyServer.md index 8233aea195..d4cf0cdd07 100644 --- a/docset/winserver2022-ps/pki/Remove-CertificateEnrollmentPolicyServer.md +++ b/docset/winserver2022-ps/pki/Remove-CertificateEnrollmentPolicyServer.md @@ -11,52 +11,72 @@ title: Remove-CertificateEnrollmentPolicyServer # Remove-CertificateEnrollmentPolicyServer ## SYNOPSIS -Removes an enrollment policy server and the URL of the enrollment policy server from the current user or local computer configuration. + +Removes an enrollment policy server and the URL of the enrollment policy server from the current +user or local computer configuration. ## SYNTAX ``` -Remove-CertificateEnrollmentPolicyServer [-Url] -context [-WhatIf] [-Confirm] - [] +Remove-CertificateEnrollmentPolicyServer [-Url] -context [-WhatIf] + [-Confirm] [] ``` ## DESCRIPTION -The **Remove-CertificateEnrollmentPolicyServer** cmdlet removes an enrollment policy server from the current user or local computer configuration. -This cmdlet also removes any policy cache file and credentials from the vault. -Only one enrollment policy server configuration is removed from the user configured location at a time. +The `Remove-CertificateEnrollmentPolicyServer` cmdlet removes an enrollment policy server from the +current user or local computer configuration. This cmdlet also removes any policy cache file and +credentials from the vault. + +Only one enrollment policy server configuration is removed from the user configured location at a +time. -If a scope of All is specified and the same URL exists in the local computer (machine) and User contexts, then this cmdlet will fail. +If a scope of `All` is specified and the same URL exists in the local computer (machine) and User +contexts, then this cmdlet will fail. -An error is generated if the specified URL does not exist in the given scope. +An error is generated if the specified URL does not exist in the given scope. Any policy cache file and credentials are also removed from the vault. ## EXAMPLES ### EXAMPLE 1 -``` -PS C:\>Remove-CertificateEnrollmentPolicyServer -Url https://www.contoso.com/policy/service.svc -Context User + +```powershell +$params = @{ + Url = 'https://www.contoso.com/policy/service.svc' + Context = 'User' +} +Remove-CertificateEnrollmentPolicyServer @params ``` -This example removes the enrollment policy server configuration from the local user configuration with the given URL. +This example removes the enrollment policy server configuration from the local user configuration +with the given URL. ### EXAMPLE 2 -``` -PS C:\>$userPolicy = Get-CertificateEnrollmentPolicyServer -Scope All -Context User -Url https://www.contoso.com/policy/service.svc -PS C:\>Remove-CertificateEnrollmentPolicyServer -Url $userPolicy.url -Context User +```powershell +$params = @{ + Scope = 'All' + Context = 'User' + Url = 'https://www.contoso.com/policy/service.svc' +} +$userPolicy = Get-CertificateEnrollmentPolicyServer @params + +Remove-CertificateEnrollmentPolicyServer -Url $userPolicy.Url -Context User ``` -This example removes the enrollment policy server that is configured from the current user configuration. +This example removes the enrollment policy server that is configured from the current user +configuration. ## PARAMETERS ### -Confirm + Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf @@ -68,10 +88,11 @@ Accept wildcard characters: False ``` ### -Url + Specifies the URL of the enrollment policy server to remove from the local configuration. ```yaml -Type: Uri +Type: System.Uri Parameter Sets: (All) Aliases: @@ -83,11 +104,12 @@ Accept wildcard characters: False ``` ### -WhatIf + Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi @@ -98,8 +120,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -context -Specifies that information about the location of an enrollment policy server should be removed from either the User or computer (machine) context. +### -Context + +Specifies that information about the location of an enrollment policy server should be removed from +either the `User` or computer (`Machine`) context. ```yaml Type: Context @@ -115,11 +139,16 @@ Accept wildcard characters: False ``` ### CommonParameters -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). + +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). ## INPUTS ### Microsoft.CertificateServices.Commands.EnrollmentPolicyServer + Contains information about the certificate enrollment policy. ## OUTPUTS @@ -133,4 +162,3 @@ Contains information about the certificate enrollment policy. [Add-CertificateEnrollmentPolicyServer](./Add-CertificateEnrollmentPolicyServer.md) [Get-CertificateEnrollmentPolicyServer](./Get-CertificateEnrollmentPolicyServer.md) - From 7fe98d29483ea53696b28d9aa9866947a0acae96 Mon Sep 17 00:00:00 2001 From: Rob Derickson Date: Sun, 30 Apr 2023 21:30:35 -0400 Subject: [PATCH 355/650] Fix formatting for Remove-CertificateNotificationTask. --- .../pki/Remove-CertificateNotificationTask.md | 30 +++++++++++++------ 1 file changed, 21 insertions(+), 9 deletions(-) diff --git a/docset/winserver2022-ps/pki/Remove-CertificateNotificationTask.md b/docset/winserver2022-ps/pki/Remove-CertificateNotificationTask.md index 4cacc595f4..e6b1578796 100644 --- a/docset/winserver2022-ps/pki/Remove-CertificateNotificationTask.md +++ b/docset/winserver2022-ps/pki/Remove-CertificateNotificationTask.md @@ -11,22 +11,27 @@ title: Remove-CertificateNotificationTask # Remove-CertificateNotificationTask ## SYNOPSIS + Removes a certificate notification task from Task Scheduler. ## SYNTAX ``` -Remove-CertificateNotificationTask [-Name] [-WhatIf] [-Confirm] [] +Remove-CertificateNotificationTask [-Name] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION -The **Remove-CertificateNotificationTask** cmdlet removes from Task Scheduler a certificate notification task that was registered with the New-CertificateNotificationTask cmdlet. + +The `Remove-CertificateNotificationTask` cmdlet removes from Task Scheduler a certificate +notification task that was registered with the `New-CertificateNotificationTask` cmdlet. ## EXAMPLES ### EXAMPLE 1 -``` -PS C:\>Remove-CertificateNotificationTask -Name "My Task" + +```powershell +Remove-CertificateNotificationTask -Name "My Task" ``` This example removes the task named My Task. @@ -34,10 +39,11 @@ This example removes the task named My Task. ## PARAMETERS ### -Confirm + Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf @@ -49,10 +55,11 @@ Accept wildcard characters: False ``` ### -Name + Identifies the notification task to be deleted. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -64,11 +71,12 @@ Accept wildcard characters: False ``` ### -WhatIf + Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi @@ -80,11 +88,16 @@ Accept wildcard characters: False ``` ### CommonParameters -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). + +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). ## INPUTS ### System.String + A **String** containing the name of the task to be removed. ## OUTPUTS @@ -100,4 +113,3 @@ A **String** containing the name of the task to be removed. [New-CertificateNotificationTask](./New-CertificateNotificationTask.md) [Switch-Certificate](./Switch-Certificate.md) - From f8b26f72c9901123d6c8f23308a363e3ea717090 Mon Sep 17 00:00:00 2001 From: Rob Derickson Date: Sun, 30 Apr 2023 21:44:22 -0400 Subject: [PATCH 356/650] Fix formatting for Set-CertificateAutoEnrollmentPolicy. --- .../Set-CertificateAutoEnrollmentPolicy.md | 133 ++++++++++++------ 1 file changed, 89 insertions(+), 44 deletions(-) diff --git a/docset/winserver2022-ps/pki/Set-CertificateAutoEnrollmentPolicy.md b/docset/winserver2022-ps/pki/Set-CertificateAutoEnrollmentPolicy.md index e4d0727133..29c82e4b11 100644 --- a/docset/winserver2022-ps/pki/Set-CertificateAutoEnrollmentPolicy.md +++ b/docset/winserver2022-ps/pki/Set-CertificateAutoEnrollmentPolicy.md @@ -11,11 +11,13 @@ title: Set-CertificateAutoEnrollmentPolicy # Set-CertificateAutoEnrollmentPolicy ## SYNOPSIS + Sets local certificate auto-enrollment policy. ## SYNTAX ### EnableSeparately + ``` Set-CertificateAutoEnrollmentPolicy [-StoreName ] -PolicyState [-ExpirationPercentage ] [-EnableTemplateCheck] [-EnableMyStoreManagement] @@ -23,62 +25,86 @@ Set-CertificateAutoEnrollmentPolicy [-StoreName ] -PolicyState [-WhatIf] [-Confirm] [] +Set-CertificateAutoEnrollmentPolicy [-EnableAll] -context [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION -The **Set-CertificateAutoEnrollmentPolicy** cmdlet configures local certificate auto-enrollment policy for a user or computer. -The auto-enrollment policy can also be configured by using the Local Security Policy console. -These settings can be found in the following location. + +The `Set-CertificateAutoEnrollmentPolicy` cmdlet configures local certificate auto-enrollment policy +for a user or computer. The auto-enrollment policy can also be configured by using the Local +Security Policy console. These settings can be found in the following location. -- `\Security Settings\Public Key Policies\Certificate Services Client - Auto-Enrollment`. -Delegation may be required when using this cmdlet with Windows PowerShell® remoting and changing user configuration. +Delegation may be required when using this cmdlet with Windows PowerShell remoting and changing user +configuration. ## EXAMPLES ### EXAMPLE 1 -``` -PS C:\>Set-CertificateAutoEnrollmentPolicy -PolicyState Enabled -EnableMyStoreManagement -EnableTemplateCheck -Context User + +```powershell +$params = @{ + PolicyState = 'Enabled' + EnableMyStoreManagement = $true + EnableTemplateCheck = $true + Context = 'User' +} +Set-CertificateAutoEnrollmentPolicy @params ``` -This example enables local user certificate auto-enrollment policy with the Renew expired certificates, update pending certificates, and remove revoked certificates and Update certificates that use certificates templates options enabled. +This example enables local user certificate auto-enrollment policy with the Renew expired +certificates, update pending certificates, and remove revoked certificates and Update certificates +that use certificates templates options enabled. ### EXAMPLE 2 -``` -PS C:\>Set-CertificateAutoEnrollmentPolicy -PolicyState NotConfigured -Context Machine + +```powershell +Set-CertificateAutoEnrollmentPolicy -PolicyState NotConfigured -Context Machine ``` This example sets local computer certificate auto-enrollment policy to Not Configured. ### EXAMPLE 3 -``` -PS C:\>Set-CertificateAutoEnrollmentPolicy -ExpirationPercentage 15 -PolicyState Enabled -EnableExpirationNotification -Context Machine -StoreName "Remote Desktop" + +```powershell +$params = @{ + ExpirationPercentage = 15 + PolicyState = 'Enabled' + EnableExpirationNotification = $true + Context = 'Machine' + StoreName = 'Remote Desktop' +} +Set-CertificateAutoEnrollmentPolicy @params ``` -This example enables local computer certificate auto-enrollment policy with the Expiration notifications option enabled and set to 15 percent of the certificate lifetime. -This cmdlet also configures the Remote Desktop certificate store as an additional store to be monitored for certificate expiration. +This example enables local computer certificate auto-enrollment policy with the Expiration +notifications option enabled and set to `15` percent of the certificate lifetime. This cmdlet also +configures the `Remote Desktop` certificate store as an additional store to be monitored for +certificate expiration. ### EXAMPLE 4 -``` -The example in detail. -PS C:\>Set-CertificateAutoEnrollmentPolicy -PolicyState Enabled -EnableMyStoreManagement -EnableTemplateCheck -EnableExpirationNotification -ExpirationPercentage 10 -Context User - -The concise version of the same example. -PS C:\>Set-CertificateAutoEnrollmentPolicy -EnableAll -Context User +```powershell +Set-CertificateAutoEnrollmentPolicy -EnableAll -Context User ``` -This example performs the same task in two ways. +This example enables local user certificate auto-enrollment policy with the Renew expired +certificates, update pending certificates, and remove revoked certificates and Update certificates +that use certificates templates options enabled. It also enables Expiration notifications with an +expiration percentage of 10 percent of the certificate lifetime. ## PARAMETERS ### -Confirm + Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf @@ -90,11 +116,13 @@ Accept wildcard characters: False ``` ### -EnableAll -Enables all of the auto-enrollment policy settings and sets the value for the expiration percentage to 10 percent. -If this parameter is enabled, then only the **Context** parameter is required and all other parameters are optional. + +Enables all of the auto-enrollment policy settings and sets the value for the expiration percentage +to 10 percent. If this parameter is enabled, then only the **Context** parameter is required and all +other parameters are optional. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: EnableAll Aliases: @@ -106,10 +134,11 @@ Accept wildcard characters: False ``` ### -EnableBalloonNotifications + Enables the Expiration balloon notifications option for the certificate auto-enrollment policy. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: EnableSeparately Aliases: @@ -121,10 +150,12 @@ Accept wildcard characters: False ``` ### -EnableMyStoreManagement -Enables the Renew expired certificates, update pending certificates, and remove revoked certificates option for the certificate auto-enrollment policy. + +Enables the Renew expired certificates, update pending certificates, and remove revoked certificates +option for the certificate auto-enrollment policy. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: EnableSeparately Aliases: @@ -136,10 +167,12 @@ Accept wildcard characters: False ``` ### -EnableTemplateCheck -Verifies that existing certificates are based on the most recent version of a certificate template and updates them if they are not. + +Verifies that existing certificates are based on the most recent version of a certificate template +and updates them if they are not. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: EnableSeparately Aliases: @@ -151,10 +184,12 @@ Accept wildcard characters: False ``` ### -ExpirationPercentage -Sets the percentage of the certificate lifetime at which close-to-expiration events are logged and auto-enrollment notifications start to appear. + +Sets the percentage of the certificate lifetime at which close-to-expiration events are logged and +auto-enrollment notifications start to appear. ```yaml -Type: Int32 +Type: System.Int32 Parameter Sets: EnableSeparately Aliases: @@ -166,10 +201,11 @@ Accept wildcard characters: False ``` ### -PolicyState + Specifies the state of the certificate auto-enrollment policy configuration. ```yaml -Type: PolicySetting +Type: Microsoft.CertificateServices.Commands.PolicySetting Parameter Sets: EnableSeparately Aliases: Accepted values: NotConfigured, Enabled, Disabled @@ -182,11 +218,12 @@ Accept wildcard characters: False ``` ### -StoreName -Specifies additional comma separated certificate stores to monitor for certificates that have expired or are expiring. -The MY store is always monitored. + +Specifies additional comma separated certificate stores to monitor for certificates that have +expired or are expiring. The MY store is always monitored. ```yaml -Type: String[] +Type: System.String[] Parameter Sets: EnableSeparately Aliases: @@ -198,11 +235,12 @@ Accept wildcard characters: False ``` ### -WhatIf + Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi @@ -213,11 +251,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -context +### -Context + Specifies whether to set certificate auto-enrollment policy for the user or computer context. ```yaml -Type: Context +Type: Microsoft.CertificateServices.Commands.Context Parameter Sets: (All) Aliases: Accepted values: Machine, User @@ -230,22 +269,28 @@ Accept wildcard characters: False ``` ### CommonParameters -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). + +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). ## INPUTS ### Microsoft.CertificateServices.Commands.AutoEnrollmentPolicy -The **AutoEnrollmentPolicy** object combines certificate auto-enrollment policy settings and exposes them as properties. + +The **AutoEnrollmentPolicy** object combines certificate auto-enrollment policy settings and exposes +them as properties. ## OUTPUTS ### Microsoft.CertificateServices.Commands.AutoEnrollmentPolicy -The **AutoEnrollmentPolicy** object combines certificate auto-enrollment policy settings and exposes them as properties. -Each property can be modified and piped into this cmdlet to be applied. + +The **AutoEnrollmentPolicy** object combines certificate auto-enrollment policy settings and exposes +them as properties. Each property can be modified and piped into this cmdlet to be applied. ## NOTES ## RELATED LINKS [Get-CertificateAutoEnrollmentPolicy](./Get-CertificateAutoEnrollmentPolicy.md) - From 60fe387d980dff7eee64812061bbeebc6f37eacb Mon Sep 17 00:00:00 2001 From: Rob Derickson Date: Sun, 30 Apr 2023 21:51:26 -0400 Subject: [PATCH 357/650] Fix formatting for Switch-Certificate. --- .../pki/Switch-Certificate.md | 71 +++++++++++++------ 1 file changed, 48 insertions(+), 23 deletions(-) diff --git a/docset/winserver2022-ps/pki/Switch-Certificate.md b/docset/winserver2022-ps/pki/Switch-Certificate.md index 254afd3915..d1249af8bf 100644 --- a/docset/winserver2022-ps/pki/Switch-Certificate.md +++ b/docset/winserver2022-ps/pki/Switch-Certificate.md @@ -11,31 +11,42 @@ title: Switch-Certificate # Switch-Certificate ## SYNOPSIS + Marks one certificate as having been replaced by another certificate. ## SYNTAX ``` -Switch-Certificate [-NotifyOnly] [-NewCert] [-OldCert] [-WhatIf] [-Confirm] - [] +Switch-Certificate [-NotifyOnly] [-NewCert] [-OldCert] [-WhatIf] + [-Confirm] [] ``` ## DESCRIPTION -The **Switch-Certificate** cmdlet marks one certificate as having been replaced by another certificate. -This cmdlet triggers a replace certificate notification and optionally sets the renewal property on the certificate being replaced. + +The `Switch-Certificate` cmdlet marks one certificate as having been replaced by another +certificate. This cmdlet triggers a replace certificate notification and optionally sets the renewal +property on the certificate being replaced. ## EXAMPLES ### EXAMPLE 1 -``` -PS C:\>Switch-Certificate -OldCert cert:\LocalMachine\My\E42DBC3B3F2771990A9B3E35D0C3C422779DACD7 -NewCert cert:\LocalMachine\My\4A346B4385F139CA843912D358D765AB8DEE9FD4 + +```powershell +$params = @{ + OldCert = 'Cert:\LocalMachine\My\E42DBC3B3F2771990A9B3E35D0C3C422779DACD7' + NewCert = 'Cert:\LocalMachine\My\4A346B4385F139CA843912D358D765AB8DEE9FD4' +} +Switch-Certificate @params ``` -This example sets the renewal property of the certificate with the thumbprint E42DBC3B3F2771990A9B3E35D0C3C422779DACD7 as renewed by the certificate with the thumbprint 4A346B4385F139CA843912D358D765AB8DEE9FD4 and generates a replace certificate notification. +This example sets the renewal property of the certificate with the thumbprint +E42DBC3B3F2771990A9B3E35D0C3C422779DACD7 as renewed by the certificate with the thumbprint +4A346B4385F139CA843912D358D765AB8DEE9FD4 and generates a replace certificate notification. ### EXAMPLE 2 -``` -PS C:\>Set-Location -Path cert:\LocalMachine\My + +```powershell +Set-Location -Path cert:\LocalMachine\My PS cert:\LocalMachine\My>$oldCert = Get-ChildItem -Path E42DBC3B3F2771990A9B3E35D0C3C422779DACD7 @@ -44,16 +55,18 @@ PS cert:\LocalMachine\My>$newCert = Get-ChildItem -Path 4A346B4385F139CA843912D3 PS cert:\LocalMachine\My>Switch-Certificate -OldCert $oldCert -NewCert $newCert -NotifyOnly ``` -This example locates two certificates in the machine MY store and assigns them the variables $oldCert and $newCert. -This cmdlet then generates a replacement notification without changing a renewal property of the old certificate. +This example locates two certificates in the machine MY store and assigns them the variables +`$oldCert` and `$newCert`. This cmdlet then generates a replacement notification without changing a +renewal property of the old certificate. ## PARAMETERS ### -Confirm + Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf @@ -65,10 +78,12 @@ Accept wildcard characters: False ``` ### -NewCert -Specifies an X509 certificate or a certificate path for the certificate that replaces the certificate specified with the **OldCert** parameter. + +Specifies an X509 certificate or a certificate path for the certificate that replaces the +certificate specified with the **OldCert** parameter. ```yaml -Type: Certificate +Type: Microsoft.CertificateServices.Commands.Certificate Parameter Sets: (All) Aliases: @@ -80,11 +95,13 @@ Accept wildcard characters: False ``` ### -NotifyOnly -Creates a replacement certificate notification without replacing the **NewCert** parameter with the **OldCert** parameter. -This mode is useful when testing a script that was registered with the New-CertificateNotificationTask cmdlet. + +Creates a replacement certificate notification without replacing the **NewCert** parameter with the +**OldCert** parameter. This mode is useful when testing a script that was registered with the +`New-CertificateNotificationTask` cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -96,10 +113,12 @@ Accept wildcard characters: False ``` ### -OldCert -Specifies an X509 certificate or a certificate path in the certificate provider for the certificate to be replaced. + +Specifies an X509 certificate or a certificate path in the certificate provider for the certificate +to be replaced. ```yaml -Type: Certificate +Type: Microsoft.CertificateServices.Commands.Certificate Parameter Sets: (All) Aliases: @@ -111,11 +130,12 @@ Accept wildcard characters: False ``` ### -WhatIf + Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi @@ -127,12 +147,18 @@ Accept wildcard characters: False ``` ### CommonParameters -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). + +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). ## INPUTS ### Microsoft.CertificateServices.Commands.Certificate -The **Certificate** object can either be provided as a Path object to a certificate or an **X509Certificate2** object. + +The **Certificate** object can either be provided as a Path object to a certificate or an +**X509Certificate2** object. ## OUTPUTS @@ -151,4 +177,3 @@ The **Certificate** object can either be provided as a Path object to a certific [New-CertificateNotificationTask](./New-CertificateNotificationTask.md) [Remove-CertificateNotificationTask](./Remove-CertificateNotificationTask.md) - From 79d21b210f634abc5378718c47044d9b90283dc8 Mon Sep 17 00:00:00 2001 From: Rob Derickson Date: Sun, 30 Apr 2023 22:01:18 -0400 Subject: [PATCH 358/650] Fix formatting for Test-Certificate. --- .../winserver2022-ps/pki/Test-Certificate.md | 105 +++++++++++------- 1 file changed, 66 insertions(+), 39 deletions(-) diff --git a/docset/winserver2022-ps/pki/Test-Certificate.md b/docset/winserver2022-ps/pki/Test-Certificate.md index af82868ee5..dc038373f5 100644 --- a/docset/winserver2022-ps/pki/Test-Certificate.md +++ b/docset/winserver2022-ps/pki/Test-Certificate.md @@ -11,38 +11,51 @@ title: Test-Certificate # Test-Certificate ## SYNOPSIS + Verifies a certificate according to the input parameters. ## SYNTAX ``` -Test-Certificate [-Policy ] [-User] [-EKU ] [-DNSName ] - [-AllowUntrustedRoot] [-Cert] [] +Test-Certificate [-Policy ] [-User] [-EKU ] + [-DNSName ] [-AllowUntrustedRoot] [-Cert] [] ``` ## DESCRIPTION -The **Test-Certificate** cmdlet verifies a certificate according to input parameters. -The revocation status of the certificate is verified by default. -If the **AllowUntrustedRoot** parameter is specified, then a certificate chain is built but an untrusted root is allowed. -Other errors are still verified against in this case, such as expired. -If the **DNSName** parameter is used, then the DNS subject alternative name is used to verify SSL policy. -If the **EKU** parameter is used, then the specified application policy object identifiers are used to verify the chain. -If the **User** parameter is used, then the specified user context is used is to build and verify the chain. -Delegation may be required when using this cmdlet with Windows PowerShell® remoting and changing user configuration. +The `Test-Certificate` cmdlet verifies a certificate according to input parameters. The revocation +status of the certificate is verified by default. If the **AllowUntrustedRoot** parameter is +specified, then a certificate chain is built but an untrusted root is allowed. Other errors are +still verified against in this case, such as expired. If the **DNSName** parameter is used, then the +DNS subject alternative name is used to verify SSL policy. If the **EKU** parameter is used, then +the specified application policy object identifiers are used to verify the chain. If the **User** +parameter is used, then the specified user context is used is to build and verify the chain. + +Delegation may be required when using this cmdlet with Windows PowerShell remoting and changing user +configuration. ## EXAMPLES ### EXAMPLE 1 -``` -PS C:\>Get-ChildItem -Path Cert:\localMachine\My | Test-Certificate -Policy SSL -DNSName "dns=contoso.com" + +```powershell +Get-ChildItem -Path Cert:\LocalMachine\My | + Test-Certificate -Policy SSL -DNSName 'dns=contoso.com' ``` -This example verifies each certificate in the MY store of the local machine and verifies that it is valid for SSL with the DNS name specified. +This example verifies each certificate in the MY store of the local machine and verifies that it is +valid for SSL with the DNS name specified. ### EXAMPLE 2 -``` -PS C:\>Test-Certificate -Cert cert:\currentuser\my\191c46f680f08a9e6ef3f6783140f60a979c7d3b -AllowUntrustedRoot -EKU "1.3.6.1.5.5.7.3.1" -User + +```powershell +$params = @{ + Cert = 'Cert:\CurrentUser\My\191C46F680F08A9E6EF3F6783140F60A979C7D3B' + AllowUntrustedRoot = $true + EKU = '1.3.6.1.5.5.7.3.1' + User = $true +} +Test-Certificate @params ``` This example verifies that the provided EKU is valid for the specified certificate and its chain. @@ -51,13 +64,14 @@ Revocation checking is not performed. ## PARAMETERS ### -AllowUntrustedRoot -Specifies whether the root certificate is required to be trusted in chain building. -When this parameter is used, the certificate chain is built but an untrusted root is allowed. -Other errors are still verified against in this case, such as expired. -If this parameter is not specified, then revocation status is checked by default. + +Specifies whether the root certificate is required to be trusted in chain building. When this +parameter is used, the certificate chain is built but an untrusted root is allowed. Other errors are +still verified against in this case, such as expired. If this parameter is not specified, then +revocation status is checked by default. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -69,11 +83,12 @@ Accept wildcard characters: False ``` ### -Cert -Specifies the certificate to test. -Either the certificate object or a path to the certificate in a certificate store can be specified. + +Specifies the certificate to test. Either the certificate object or a path to the certificate in a +certificate store can be specified. ```yaml -Type: Certificate +Type: Microsoft.CertificateServices.Commands.Certificate Parameter Sets: (All) Aliases: PsPath @@ -85,15 +100,18 @@ Accept wildcard characters: False ``` ### -DNSName -Specifies the DNS name to verify as valid for the certificate. + +Specifies the DNS name to verify as valid for the certificate. -If this parameter is specified but not the **Policy** parameter, then the CERT_CHAIN_POLICY_SSL policy is applied and the DNS name is validated for the certificate. -If a CERT_CHAIN_POLICY_SSL policy does not exist, then the cmdlet will fail. +If this parameter is specified but not the **Policy** parameter, then the `CERT_CHAIN_POLICY_SSL` +policy is applied and the DNS name is validated for the certificate. If a `CERT_CHAIN_POLICY_SSL` +policy does not exist, then the cmdlet will fail. -If this parameter is not used and the **Policy** parameter is not specified, the default CERT_CHAIN_POLICY_BASE policy is applied. +If this parameter is not used and the **Policy** parameter is not specified, the default +`CERT_CHAIN_POLICY_BASE` policy is applied. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -105,10 +123,11 @@ Accept wildcard characters: False ``` ### -EKU + Specifies a list of enhanced key usage (EKU) object identifiers to verify for the certificate chain. ```yaml -Type: String[] +Type: System.String[] Parameter Sets: (All) Aliases: @@ -120,12 +139,13 @@ Accept wildcard characters: False ``` ### -Policy -Specifies the policies that will be applied to verify the certificate. -The acceptable values for this parameter are: AUTHENTICODE, BASE, NTAUTH, and SSL. -If this parameter is not specified, then the BASE policy is used. + +Specifies the policies that will be applied to verify the certificate. The acceptable values for +this parameter are: `AUTHENTICODE`, `BASE`, `NTAUTH`, and `SSL`. If this parameter is not specified, +then the BASE policy is used. ```yaml -Type: TestCertificatePolicy +Type: Microsoft.CertificateServices.Commands.TestCertificatePolicy Parameter Sets: (All) Aliases: Accepted values: BASE, SSL, AUTHENTICODE, NTAUTH @@ -138,11 +158,12 @@ Accept wildcard characters: False ``` ### -User -Specifies whether the user or machine context is used to test the certificate. -If this parameter is not specified, then the machine context is used. + +Specifies whether the user or machine context is used to test the certificate. If this parameter is +not specified, then the machine context is used. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -154,16 +175,23 @@ Accept wildcard characters: False ``` ### CommonParameters -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). + +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). ## INPUTS ### Microsoft.CertificateServices.Commands.Certificate -The **Certificate** object can either be provided as a Path object to a certificate or an **X509Certificate2** object. + +The **Certificate** object can either be provided as a Path object to a certificate or an +**X509Certificate2** object. ## OUTPUTS ### System.Boolean + If the verification succeeds, then the return value is True; otherwise the return value is False. ## NOTES @@ -171,4 +199,3 @@ If the verification succeeds, then the return value is True; otherwise the retur ## RELATED LINKS [Get-ChildItem](https://go.microsoft.com/fwlink/p/?LinkId=290488) - From eaed9010044425b7eb4ecebe01dbd7f47068da1d Mon Sep 17 00:00:00 2001 From: Rob Derickson Date: Mon, 1 May 2023 22:01:33 -0400 Subject: [PATCH 359/650] Update docset/winserver2022-ps/pki/New-CertificateNotificationTask.md Co-authored-by: Sean Wheeler --- .../winserver2022-ps/pki/New-CertificateNotificationTask.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docset/winserver2022-ps/pki/New-CertificateNotificationTask.md b/docset/winserver2022-ps/pki/New-CertificateNotificationTask.md index 5594149120..83c14af6b4 100644 --- a/docset/winserver2022-ps/pki/New-CertificateNotificationTask.md +++ b/docset/winserver2022-ps/pki/New-CertificateNotificationTask.md @@ -79,8 +79,8 @@ The cmdlet will run for all currently logged on users in the user contexts. Sets the channel of the **CertificateServicesClient-Notifications** log that will be monitored for certificate lifecycle events. The acceptable values for this parameter are: - -- `System`: The **Operation-System** channel will be used. This channel should be used to modify - system certificate bindings that use computer certificates. +- `System`: The **Operation-System** channel will be used. This channel should be used to modify + system certificate bindings that use computer certificates. -- `User`: The **Operational-User** channel will be used. This channel should be used to modify user certificate bindings. From 87ca347cc4ac598b161ce4f85551322afba500cb Mon Sep 17 00:00:00 2001 From: Rob Derickson Date: Mon, 1 May 2023 22:01:41 -0400 Subject: [PATCH 360/650] Update docset/winserver2022-ps/pki/New-CertificateNotificationTask.md Co-authored-by: Sean Wheeler --- docset/winserver2022-ps/pki/New-CertificateNotificationTask.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/pki/New-CertificateNotificationTask.md b/docset/winserver2022-ps/pki/New-CertificateNotificationTask.md index 83c14af6b4..3c3a98a22f 100644 --- a/docset/winserver2022-ps/pki/New-CertificateNotificationTask.md +++ b/docset/winserver2022-ps/pki/New-CertificateNotificationTask.md @@ -82,7 +82,7 @@ certificate lifecycle events. The acceptable values for this parameter are: - `System`: The **Operation-System** channel will be used. This channel should be used to modify system certificate bindings that use computer certificates. - -- `User`: The **Operational-User** channel will be used. This channel should be used to modify +- `User`: The **Operational-User** channel will be used. This channel should be used to modify user certificate bindings. ```yaml From 531bb4651dc2b81811002c1998d43b0fc3403160 Mon Sep 17 00:00:00 2001 From: Rob Derickson Date: Mon, 1 May 2023 22:01:58 -0400 Subject: [PATCH 361/650] Update docset/winserver2022-ps/pki/New-CertificateNotificationTask.md Co-authored-by: Sean Wheeler --- .../pki/New-CertificateNotificationTask.md | 17 ++++++++++------- 1 file changed, 10 insertions(+), 7 deletions(-) diff --git a/docset/winserver2022-ps/pki/New-CertificateNotificationTask.md b/docset/winserver2022-ps/pki/New-CertificateNotificationTask.md index 3c3a98a22f..6272cf8d2d 100644 --- a/docset/winserver2022-ps/pki/New-CertificateNotificationTask.md +++ b/docset/winserver2022-ps/pki/New-CertificateNotificationTask.md @@ -154,13 +154,16 @@ Generates a replacement notification for any certificate in the My store that ha the past. For the notification to be generated both certificates must be present in the store. This parameter can only be used with the `Replace` type. -Note: The following warning will be displayed when this this parameter set to `False` and there are -some certificates in MY store that would have resulted in a notification. - - -- `There are certificates in My store that have been replaced in the past. You can use the - New-CertificateNotification cmdlet with the RunTaskForExistingCerts parameter to generate - notifications for those certificates to correct any configuration problems that you may already - have on this machine.` +> [!NOTE] +> The following warning is displayed when this parameter set to `False` and there are some +> certificates in MY store that would have resulted in a notification. +> +> ```Output +> There are certificates in My store that have been replaced in the past. You can use the +> New-CertificateNotification cmdlet with the RunTaskForExistingCerts parameter to generate +> notifications for those certificates to correct any configuration problems that you may already +> have on this machine. +> ``` ```yaml Type: System.Management.Automation.SwitchParameter From 478d5bcc1c5430b9eaf3ae7525e456ccb3f2956e Mon Sep 17 00:00:00 2001 From: Rob Derickson Date: Mon, 1 May 2023 22:02:12 -0400 Subject: [PATCH 362/650] Update docset/winserver2022-ps/pki/New-CertificateNotificationTask.md Co-authored-by: Sean Wheeler --- .../winserver2022-ps/pki/New-CertificateNotificationTask.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docset/winserver2022-ps/pki/New-CertificateNotificationTask.md b/docset/winserver2022-ps/pki/New-CertificateNotificationTask.md index 6272cf8d2d..e0600da8db 100644 --- a/docset/winserver2022-ps/pki/New-CertificateNotificationTask.md +++ b/docset/winserver2022-ps/pki/New-CertificateNotificationTask.md @@ -182,9 +182,9 @@ Accept wildcard characters: False Specifies the type of events that will trigger certificate notifications. The acceptable values for this parameter are: - -- `Replace`: Certificate replacement events will trigger this notification, including certificates - that are renewed by auto-enrollment, using the Certificates snap-in, or by using the - `Switch-Certificate` cmdlet. +- `Replace`: Certificate replacement events will trigger this notification, including certificates + that are renewed by auto-enrollment, using the Certificates snap-in, or by using the + `Switch-Certificate` cmdlet. -- `Expire`: Certificate expiration and close-to-expire events will trigger this notification. From e4b1f8f2a12e6b696c1e4f534a1f6a35c4bec7ad Mon Sep 17 00:00:00 2001 From: Rob Derickson Date: Mon, 1 May 2023 22:02:39 -0400 Subject: [PATCH 363/650] Update docset/winserver2022-ps/pki/New-CertificateNotificationTask.md Co-authored-by: Sean Wheeler --- docset/winserver2022-ps/pki/New-CertificateNotificationTask.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/pki/New-CertificateNotificationTask.md b/docset/winserver2022-ps/pki/New-CertificateNotificationTask.md index e0600da8db..7e4d95c491 100644 --- a/docset/winserver2022-ps/pki/New-CertificateNotificationTask.md +++ b/docset/winserver2022-ps/pki/New-CertificateNotificationTask.md @@ -186,7 +186,7 @@ this parameter are: that are renewed by auto-enrollment, using the Certificates snap-in, or by using the `Switch-Certificate` cmdlet. - -- `Expire`: Certificate expiration and close-to-expire events will trigger this notification. +- `Expire`: Certificate expiration and close-to-expire events will trigger this notification. ```yaml Type: Microsoft.CertificateServices.Commands.CertificateNotificationType From 9981172eb7ea649d521af55d03650737e8532821 Mon Sep 17 00:00:00 2001 From: Rob Derickson Date: Mon, 1 May 2023 22:02:56 -0400 Subject: [PATCH 364/650] Update docset/winserver2022-ps/pki/New-CertificateNotificationTask.md Co-authored-by: Mikey Lombardi (He/Him) --- docset/winserver2022-ps/pki/New-CertificateNotificationTask.md | 1 - 1 file changed, 1 deletion(-) diff --git a/docset/winserver2022-ps/pki/New-CertificateNotificationTask.md b/docset/winserver2022-ps/pki/New-CertificateNotificationTask.md index 7e4d95c491..ab4a959b02 100644 --- a/docset/winserver2022-ps/pki/New-CertificateNotificationTask.md +++ b/docset/winserver2022-ps/pki/New-CertificateNotificationTask.md @@ -11,7 +11,6 @@ title: New-CertificateNotificationTask # New-CertificateNotificationTask ## SYNOPSIS - Creates a new task in the Task Scheduler that will be triggered when a certificate is replaced, expired, or about to expired. From 59872d5f165f4f0d33e1887be88214e11ace3db8 Mon Sep 17 00:00:00 2001 From: Rob Derickson Date: Mon, 1 May 2023 22:04:52 -0400 Subject: [PATCH 365/650] Update docset/winserver2022-ps/pki/Test-Certificate.md Co-authored-by: Mikey Lombardi (He/Him) --- docset/winserver2022-ps/pki/Test-Certificate.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/pki/Test-Certificate.md b/docset/winserver2022-ps/pki/Test-Certificate.md index dc038373f5..ceef3a1d48 100644 --- a/docset/winserver2022-ps/pki/Test-Certificate.md +++ b/docset/winserver2022-ps/pki/Test-Certificate.md @@ -142,7 +142,7 @@ Accept wildcard characters: False Specifies the policies that will be applied to verify the certificate. The acceptable values for this parameter are: `AUTHENTICODE`, `BASE`, `NTAUTH`, and `SSL`. If this parameter is not specified, -then the BASE policy is used. +then the `BASE` policy is used. ```yaml Type: Microsoft.CertificateServices.Commands.TestCertificatePolicy From ba5ab7ed8b9e167698be0b5f16c00f786eefa8c4 Mon Sep 17 00:00:00 2001 From: Rob Derickson Date: Mon, 1 May 2023 22:33:05 -0400 Subject: [PATCH 366/650] Removed extra line break after Synopsis. Removed prompt from examples using cert:\ paths. Edited unusual formatting for a policy path. --- .../pki/New-CertificateNotificationTask.md | 4 ++-- .../pki/Remove-CertificateEnrollmentPolicyServer.md | 1 - .../pki/Remove-CertificateNotificationTask.md | 1 - .../pki/Set-CertificateAutoEnrollmentPolicy.md | 6 ++---- docset/winserver2022-ps/pki/Switch-Certificate.md | 10 +++------- docset/winserver2022-ps/pki/Test-Certificate.md | 3 +-- 6 files changed, 8 insertions(+), 17 deletions(-) diff --git a/docset/winserver2022-ps/pki/New-CertificateNotificationTask.md b/docset/winserver2022-ps/pki/New-CertificateNotificationTask.md index ab4a959b02..107135a5a5 100644 --- a/docset/winserver2022-ps/pki/New-CertificateNotificationTask.md +++ b/docset/winserver2022-ps/pki/New-CertificateNotificationTask.md @@ -81,8 +81,8 @@ certificate lifecycle events. The acceptable values for this parameter are: - `System`: The **Operation-System** channel will be used. This channel should be used to modify system certificate bindings that use computer certificates. -- `User`: The **Operational-User** channel will be used. This channel should be used to modify - user certificate bindings. +- `User`: The **Operational-User** channel will be used. This channel should be used to modify user + certificate bindings. ```yaml Type: Microsoft.CertificateServices.Commands.NotificationChannel diff --git a/docset/winserver2022-ps/pki/Remove-CertificateEnrollmentPolicyServer.md b/docset/winserver2022-ps/pki/Remove-CertificateEnrollmentPolicyServer.md index d4cf0cdd07..618be8b092 100644 --- a/docset/winserver2022-ps/pki/Remove-CertificateEnrollmentPolicyServer.md +++ b/docset/winserver2022-ps/pki/Remove-CertificateEnrollmentPolicyServer.md @@ -11,7 +11,6 @@ title: Remove-CertificateEnrollmentPolicyServer # Remove-CertificateEnrollmentPolicyServer ## SYNOPSIS - Removes an enrollment policy server and the URL of the enrollment policy server from the current user or local computer configuration. diff --git a/docset/winserver2022-ps/pki/Remove-CertificateNotificationTask.md b/docset/winserver2022-ps/pki/Remove-CertificateNotificationTask.md index e6b1578796..37cb2ee98b 100644 --- a/docset/winserver2022-ps/pki/Remove-CertificateNotificationTask.md +++ b/docset/winserver2022-ps/pki/Remove-CertificateNotificationTask.md @@ -11,7 +11,6 @@ title: Remove-CertificateNotificationTask # Remove-CertificateNotificationTask ## SYNOPSIS - Removes a certificate notification task from Task Scheduler. ## SYNTAX diff --git a/docset/winserver2022-ps/pki/Set-CertificateAutoEnrollmentPolicy.md b/docset/winserver2022-ps/pki/Set-CertificateAutoEnrollmentPolicy.md index 29c82e4b11..8dff9cd34a 100644 --- a/docset/winserver2022-ps/pki/Set-CertificateAutoEnrollmentPolicy.md +++ b/docset/winserver2022-ps/pki/Set-CertificateAutoEnrollmentPolicy.md @@ -11,7 +11,6 @@ title: Set-CertificateAutoEnrollmentPolicy # Set-CertificateAutoEnrollmentPolicy ## SYNOPSIS - Sets local certificate auto-enrollment policy. ## SYNTAX @@ -35,9 +34,8 @@ Set-CertificateAutoEnrollmentPolicy [-EnableAll] -context [-WhatIf] [- The `Set-CertificateAutoEnrollmentPolicy` cmdlet configures local certificate auto-enrollment policy for a user or computer. The auto-enrollment policy can also be configured by using the Local -Security Policy console. These settings can be found in the following location. - - -- `\Security Settings\Public Key Policies\Certificate Services Client - Auto-Enrollment`. +Security Policy console. These settings can be found in the following location: +`\Security Settings\Public Key Policies\Certificate Services Client - Auto-Enrollment` Delegation may be required when using this cmdlet with Windows PowerShell remoting and changing user configuration. diff --git a/docset/winserver2022-ps/pki/Switch-Certificate.md b/docset/winserver2022-ps/pki/Switch-Certificate.md index d1249af8bf..6fdb56e3a6 100644 --- a/docset/winserver2022-ps/pki/Switch-Certificate.md +++ b/docset/winserver2022-ps/pki/Switch-Certificate.md @@ -11,7 +11,6 @@ title: Switch-Certificate # Switch-Certificate ## SYNOPSIS - Marks one certificate as having been replaced by another certificate. ## SYNTAX @@ -47,12 +46,9 @@ E42DBC3B3F2771990A9B3E35D0C3C422779DACD7 as renewed by the certificate with the ```powershell Set-Location -Path cert:\LocalMachine\My - -PS cert:\LocalMachine\My>$oldCert = Get-ChildItem -Path E42DBC3B3F2771990A9B3E35D0C3C422779DACD7 - -PS cert:\LocalMachine\My>$newCert = Get-ChildItem -Path 4A346B4385F139CA843912D358D765AB8DEE9FD4 - -PS cert:\LocalMachine\My>Switch-Certificate -OldCert $oldCert -NewCert $newCert -NotifyOnly +$oldCert = Get-ChildItem -Path E42DBC3B3F2771990A9B3E35D0C3C422779DACD7 +$newCert = Get-ChildItem -Path 4A346B4385F139CA843912D358D765AB8DEE9FD4 +Switch-Certificate -OldCert $oldCert -NewCert $newCert -NotifyOnly ``` This example locates two certificates in the machine MY store and assigns them the variables diff --git a/docset/winserver2022-ps/pki/Test-Certificate.md b/docset/winserver2022-ps/pki/Test-Certificate.md index ceef3a1d48..1b41de54d5 100644 --- a/docset/winserver2022-ps/pki/Test-Certificate.md +++ b/docset/winserver2022-ps/pki/Test-Certificate.md @@ -11,7 +11,6 @@ title: Test-Certificate # Test-Certificate ## SYNOPSIS - Verifies a certificate according to the input parameters. ## SYNTAX @@ -102,7 +101,7 @@ Accept wildcard characters: False ### -DNSName Specifies the DNS name to verify as valid for the certificate. - + If this parameter is specified but not the **Policy** parameter, then the `CERT_CHAIN_POLICY_SSL` policy is applied and the DNS name is validated for the certificate. If a `CERT_CHAIN_POLICY_SSL` policy does not exist, then the cmdlet will fail. From 19e1555b76534ad94bbb7cae5abf18c4b76fc913 Mon Sep 17 00:00:00 2001 From: Robert Biddle Date: Tue, 2 May 2023 12:39:46 -0400 Subject: [PATCH 367/650] Update docset/winserver2022-ps/addsdeployment/Test-ADDSDomainControllerUninstallation.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- .../addsdeployment/Test-ADDSDomainControllerUninstallation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/addsdeployment/Test-ADDSDomainControllerUninstallation.md b/docset/winserver2022-ps/addsdeployment/Test-ADDSDomainControllerUninstallation.md index 6b5e439f3d..4f9cb8f294 100644 --- a/docset/winserver2022-ps/addsdeployment/Test-ADDSDomainControllerUninstallation.md +++ b/docset/winserver2022-ps/addsdeployment/Test-ADDSDomainControllerUninstallation.md @@ -86,7 +86,7 @@ Accept wildcard characters: False ### -DemoteOperationMasterRole Indicates that forced demotion should continue even if an operations master role is discovered on -domain controller from which AD DS is being removed. +the domain controller from which AD DS is being removed. ```yaml Type: System.Management.Automation.SwitchParameter From 8eb42710e1a227e238e579f135eda8546d18e168 Mon Sep 17 00:00:00 2001 From: Robert Biddle Date: Tue, 2 May 2023 12:40:20 -0400 Subject: [PATCH 368/650] Update docset/winserver2022-ps/addsdeployment/Test-ADDSForestInstallation.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- .../addsdeployment/Test-ADDSForestInstallation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/addsdeployment/Test-ADDSForestInstallation.md b/docset/winserver2022-ps/addsdeployment/Test-ADDSForestInstallation.md index 49be4db6df..452dbd27d1 100644 --- a/docset/winserver2022-ps/addsdeployment/Test-ADDSForestInstallation.md +++ b/docset/winserver2022-ps/addsdeployment/Test-ADDSForestInstallation.md @@ -340,7 +340,7 @@ value, the value must be a secure string. If this parameter is not specified, the cmdlet prompts you to enter and confirm a masked password. This is the preferred usage when running the cmdlet interactively. If there are no other arguments -specified with the cmdlet, you is prompted to enter a masked password for this parameter but no +specified with the cmdlet, you are prompted to enter a masked password for this parameter but no confirmation of the password entered is made. This is not recommended as it could allow a mistyped password to be configured. Another available advanced option is to use the `ConvertTo-SecureString` cmdlet and specify the password string inline as unmasked console input, From 4878dc8288cc232bd8a758d0fc1eea019149e178 Mon Sep 17 00:00:00 2001 From: Robert Biddle Date: Tue, 2 May 2023 12:40:52 -0400 Subject: [PATCH 369/650] Update docset/winserver2022-ps/addsdeployment/Uninstall-ADDSDomainController.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- .../addsdeployment/Uninstall-ADDSDomainController.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/addsdeployment/Uninstall-ADDSDomainController.md b/docset/winserver2022-ps/addsdeployment/Uninstall-ADDSDomainController.md index 59b27ff9dc..acb8c0ce99 100644 --- a/docset/winserver2022-ps/addsdeployment/Uninstall-ADDSDomainController.md +++ b/docset/winserver2022-ps/addsdeployment/Uninstall-ADDSDomainController.md @@ -91,7 +91,7 @@ Accept wildcard characters: False ### -DemoteOperationMasterRole Indicates that forced demotion should continue even if an operations master role is discovered on -domain controller from which AD DS is being removed. +the domain controller from which AD DS is being removed. ```yaml Type: System.Management.Automation.SwitchParameter From 15e990725b201341208e08b92a6e97993b9864eb Mon Sep 17 00:00:00 2001 From: Michael Date: Tue, 2 May 2023 10:28:34 -0700 Subject: [PATCH 370/650] Update docset/winserver2022-ps/adcsdeployment/Install-AdcsCertificationAuthority.md Love oxford commas Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- .../adcsdeployment/Install-AdcsCertificationAuthority.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/adcsdeployment/Install-AdcsCertificationAuthority.md b/docset/winserver2022-ps/adcsdeployment/Install-AdcsCertificationAuthority.md index 7ecd1a02a3..81990c9af7 100644 --- a/docset/winserver2022-ps/adcsdeployment/Install-AdcsCertificationAuthority.md +++ b/docset/winserver2022-ps/adcsdeployment/Install-AdcsCertificationAuthority.md @@ -517,7 +517,7 @@ Accept wildcard characters: False ### -ValidityPeriod Specifies the validity period of the certification authority (CA) certificate in hours, days, weeks, -months or years. If this is a subordinate CA, do not use this parameter, because the validity period +months, or years. If this is a subordinate CA, do not use this parameter, because the validity period is determined by the parent CA. ```yaml From 555224920a4824978b67f0443b9fe79d30c9b999 Mon Sep 17 00:00:00 2001 From: Michael Date: Tue, 2 May 2023 10:28:49 -0700 Subject: [PATCH 371/650] Update docset/winserver2022-ps/adcsdeployment/Install-AdcsCertificationAuthority.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- .../adcsdeployment/Install-AdcsCertificationAuthority.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/adcsdeployment/Install-AdcsCertificationAuthority.md b/docset/winserver2022-ps/adcsdeployment/Install-AdcsCertificationAuthority.md index 81990c9af7..5c919d99de 100644 --- a/docset/winserver2022-ps/adcsdeployment/Install-AdcsCertificationAuthority.md +++ b/docset/winserver2022-ps/adcsdeployment/Install-AdcsCertificationAuthority.md @@ -597,7 +597,8 @@ This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVar - Ensure you run Windows PowerShell as an administrator. You can use the **force** parameter to bypass the prompt for confirmation. To see parameters, run the following command: - `Install-AdcsCertificationAuthority -?` + + `Install-AdcsCertificationAuthority -?` - If you have installation issues, try using the **verbose** parameter to get verbose output and review the information in the %windir%\cerocm.log file. From d4b88060723a59838909518b3bb7510248f93eaf Mon Sep 17 00:00:00 2001 From: "Mikey Lombardi (He/Him)" Date: Tue, 2 May 2023 13:34:26 -0500 Subject: [PATCH 372/650] Apply suggestions from review Co-authored-by: Sean Wheeler --- docset/winserver2022-ps/tls/Enable-TlsCipherSuite.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/tls/Enable-TlsCipherSuite.md b/docset/winserver2022-ps/tls/Enable-TlsCipherSuite.md index fc1e26723c..54086a8da1 100644 --- a/docset/winserver2022-ps/tls/Enable-TlsCipherSuite.md +++ b/docset/winserver2022-ps/tls/Enable-TlsCipherSuite.md @@ -66,7 +66,7 @@ CRYPT_PRIORITY_BOTTOM. Enable-TlsCipherSuite -Name TLS_DHE_DSS_WITH_AES_256_CBC_SHA -Position 0 ``` -This command enables cipher suite named TLS_DHE_DSS_WITH_AES_256_CBC_SHA. This command adds the +This command enables cipher suite named `TLS_DHE_DSS_WITH_AES_256_CBC_SHA`. This command adds the cipher suite the TLS cipher suite list at position 0, which is the highest priority. ## PARAMETERS From 5d9ec220d913dad77401c67ca1081313b3469229 Mon Sep 17 00:00:00 2001 From: Drew <93335570+XXLMandalorian013@users.noreply.github.com> Date: Thu, 27 Apr 2023 15:58:00 -0700 Subject: [PATCH 373/650] DrewDocUpdates Add PS to code blocks and added out blocks that where tied into code blocks. --- .../Get-RemoteAccessRoutingDomain.md | 5 ++++- .../Get-RemoteAccessUserActivity.md | 20 ++++++++++++------- .../Get-RoutingProtocolPreference.md | 5 ++++- .../remoteaccess/Get-VpnAuthProtocol.md | 5 ++++- 4 files changed, 25 insertions(+), 10 deletions(-) diff --git a/docset/winserver2022-ps/remoteaccess/Get-RemoteAccessRoutingDomain.md b/docset/winserver2022-ps/remoteaccess/Get-RemoteAccessRoutingDomain.md index 8b64792867..dd2dfb8ca9 100644 --- a/docset/winserver2022-ps/remoteaccess/Get-RemoteAccessRoutingDomain.md +++ b/docset/winserver2022-ps/remoteaccess/Get-RemoteAccessRoutingDomain.md @@ -26,8 +26,11 @@ The **Get-RemoteAccessRoutingDomain** cmdlet retrieves routing domain configurat ## EXAMPLES ### Example 1: Retrieve configuration for a specific routing domain +```powershell +Get-RemoteAccessRoutingDomain -Name Rd_01 ``` -PS C:\> Get-RemoteAccessRoutingDomain -Name Rd_01 + +```output RoutingDomain : Rd_01 RoutingDomainID : {11111111-1111-1111-1111-111111111001} diff --git a/docset/winserver2022-ps/remoteaccess/Get-RemoteAccessUserActivity.md b/docset/winserver2022-ps/remoteaccess/Get-RemoteAccessUserActivity.md index d67beb6036..2b197c0e9b 100644 --- a/docset/winserver2022-ps/remoteaccess/Get-RemoteAccessUserActivity.md +++ b/docset/winserver2022-ps/remoteaccess/Get-RemoteAccessUserActivity.md @@ -52,24 +52,27 @@ However, only one of these filters can be used at a time. ## EXAMPLES ### EXAMPLE 1 -``` -PS C:\>$startdate = Get-Date -Date "12/16/2011" +```powershell +$startdate = Get-Date -Date "12/16/2011" -PS C:\>$startdate +$startdate 16 December 2011 00:00:00 -PS C:\>$enddate = Get-Date -Date "12/23/2011" +$enddate = Get-Date -Date "12/23/2011" + +$enddate -PS C:\>$enddate +Get-RemoteAccessUserActivity -StartDateTime $startdate -EndDateTime $enddate -UserName "corp.contoso.com\User1" +``` -PS C:\>Get-RemoteAccessUserActivity -StartDateTime $startdate -EndDateTime $enddate -UserName "corp.contoso.com\User1" +```output ServerIpAddress ProtocolID ServerPort --------------- ---------- ---------- 2001:4898:0:fff:0:5efe:10.57.36.131 6 443 @@ -80,8 +83,11 @@ This example shows historic access details for a particular user. Query the accounting store for user activity details for User1 between the start date and end date. ### EXAMPLE 2 +```powershell +Get-RemoteAccessUserActivity -UserName "contoso\User1" -ComputerName edge1.corp.contoso.com ``` -PS C:\>Get-RemoteAccessUserActivity -UserName "contoso\User1" -ComputerName edge1.corp.contoso.com + +```output ServerIpAddress ProtocolID ServerPort --------------- ---------- ---------- 2001:4898:0:fff:0:5efe:10.166.20.136 6 80 diff --git a/docset/winserver2022-ps/remoteaccess/Get-RoutingProtocolPreference.md b/docset/winserver2022-ps/remoteaccess/Get-RoutingProtocolPreference.md index 58e113c457..5944d71823 100644 --- a/docset/winserver2022-ps/remoteaccess/Get-RoutingProtocolPreference.md +++ b/docset/winserver2022-ps/remoteaccess/Get-RoutingProtocolPreference.md @@ -29,8 +29,11 @@ Use the Set-RoutingProtocolPreference cmdlet to modify preferences. ## EXAMPLES ### Example 1: Display preferences +```powershell +Get-RoutingProtocolPreference ``` -PS C:\> Get-RoutingProtocolPreference + +```output Protocol Priority (Lower value = higher priority) ----------------------------- ----------------------------------------------- local 1 diff --git a/docset/winserver2022-ps/remoteaccess/Get-VpnAuthProtocol.md b/docset/winserver2022-ps/remoteaccess/Get-VpnAuthProtocol.md index 327aadad04..9a19aca072 100644 --- a/docset/winserver2022-ps/remoteaccess/Get-VpnAuthProtocol.md +++ b/docset/winserver2022-ps/remoteaccess/Get-VpnAuthProtocol.md @@ -25,8 +25,11 @@ The **Get-VpnAuthProtocol** cmdlet retrieves VPN authentication parameters for i ## EXAMPLES ### EXAMPLE 1 +```powershell +Get-VpnAuthProtocol ``` -PS C:\>Get-VpnAuthProtocol + +```output UserAuthProtocolAccepted : {EAP, MsChapv2} TunnelAuthProtocolsAdvertised : Certificates RootCertificateNameToAccept : From 458605ac8a7297755bd88ddd55ce5d80e76d2a3b Mon Sep 17 00:00:00 2001 From: "Mikey Lombardi (He/Him)" Date: Tue, 2 May 2023 16:17:34 -0500 Subject: [PATCH 374/650] Apply suggestions from review --- .../remoteaccess/Get-RemoteAccessRoutingDomain.md | 2 +- .../remoteaccess/Get-RemoteAccessUserActivity.md | 2 ++ .../remoteaccess/Get-RoutingProtocolPreference.md | 1 + docset/winserver2022-ps/remoteaccess/Get-VpnAuthProtocol.md | 1 + 4 files changed, 5 insertions(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/remoteaccess/Get-RemoteAccessRoutingDomain.md b/docset/winserver2022-ps/remoteaccess/Get-RemoteAccessRoutingDomain.md index dd2dfb8ca9..33bf4d2173 100644 --- a/docset/winserver2022-ps/remoteaccess/Get-RemoteAccessRoutingDomain.md +++ b/docset/winserver2022-ps/remoteaccess/Get-RemoteAccessRoutingDomain.md @@ -30,7 +30,7 @@ The **Get-RemoteAccessRoutingDomain** cmdlet retrieves routing domain configurat Get-RemoteAccessRoutingDomain -Name Rd_01 ``` -```output +```Output RoutingDomain : Rd_01 RoutingDomainID : {11111111-1111-1111-1111-111111111001} diff --git a/docset/winserver2022-ps/remoteaccess/Get-RemoteAccessUserActivity.md b/docset/winserver2022-ps/remoteaccess/Get-RemoteAccessUserActivity.md index 2b197c0e9b..1c7702f93b 100644 --- a/docset/winserver2022-ps/remoteaccess/Get-RemoteAccessUserActivity.md +++ b/docset/winserver2022-ps/remoteaccess/Get-RemoteAccessUserActivity.md @@ -52,6 +52,7 @@ However, only one of these filters can be used at a time. ## EXAMPLES ### EXAMPLE 1 + ```powershell $startdate = Get-Date -Date "12/16/2011" @@ -83,6 +84,7 @@ This example shows historic access details for a particular user. Query the accounting store for user activity details for User1 between the start date and end date. ### EXAMPLE 2 + ```powershell Get-RemoteAccessUserActivity -UserName "contoso\User1" -ComputerName edge1.corp.contoso.com ``` diff --git a/docset/winserver2022-ps/remoteaccess/Get-RoutingProtocolPreference.md b/docset/winserver2022-ps/remoteaccess/Get-RoutingProtocolPreference.md index 5944d71823..3cb95b7940 100644 --- a/docset/winserver2022-ps/remoteaccess/Get-RoutingProtocolPreference.md +++ b/docset/winserver2022-ps/remoteaccess/Get-RoutingProtocolPreference.md @@ -29,6 +29,7 @@ Use the Set-RoutingProtocolPreference cmdlet to modify preferences. ## EXAMPLES ### Example 1: Display preferences + ```powershell Get-RoutingProtocolPreference ``` diff --git a/docset/winserver2022-ps/remoteaccess/Get-VpnAuthProtocol.md b/docset/winserver2022-ps/remoteaccess/Get-VpnAuthProtocol.md index 9a19aca072..2cf3b76451 100644 --- a/docset/winserver2022-ps/remoteaccess/Get-VpnAuthProtocol.md +++ b/docset/winserver2022-ps/remoteaccess/Get-VpnAuthProtocol.md @@ -25,6 +25,7 @@ The **Get-VpnAuthProtocol** cmdlet retrieves VPN authentication parameters for i ## EXAMPLES ### EXAMPLE 1 + ```powershell Get-VpnAuthProtocol ``` From 3f19ee12c73b814722029c9b67d2d8bba63f629c Mon Sep 17 00:00:00 2001 From: Paula Kingsley Date: Tue, 2 May 2023 14:27:09 -0700 Subject: [PATCH 375/650] Update docset/winserver2022-ps/grouppolicy/Get-GPO.md Backticks around cmdlet Co-authored-by: Mikey Lombardi (He/Him) --- docset/winserver2022-ps/grouppolicy/Get-GPO.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/grouppolicy/Get-GPO.md b/docset/winserver2022-ps/grouppolicy/Get-GPO.md index 29dd4f43ce..947c96821e 100644 --- a/docset/winserver2022-ps/grouppolicy/Get-GPO.md +++ b/docset/winserver2022-ps/grouppolicy/Get-GPO.md @@ -35,7 +35,7 @@ Get-GPO [[-Domain] ] [[-Server] ] [-All] [] ## DESCRIPTION -The **Get-GPO** cmdlet gets one Group Policy Object (GPO) or all the GPOs in a domain. +The `Get-GPO` cmdlet gets one Group Policy Object (GPO) or all the GPOs in a domain. You can specify a GPO by its display name or by its globally unique identifier (GUID) to get a single GPO, or you can get all the GPOs in the domain through the **All** parameter. From 236fa35b65b5b0e3bd2a7bdd9e83fa519acaad12 Mon Sep 17 00:00:00 2001 From: Paula Kingsley Date: Tue, 2 May 2023 14:27:24 -0700 Subject: [PATCH 376/650] Update docset/winserver2022-ps/grouppolicy/Get-GPO.md Co-authored-by: Mikey Lombardi (He/Him) --- docset/winserver2022-ps/grouppolicy/Get-GPO.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/grouppolicy/Get-GPO.md b/docset/winserver2022-ps/grouppolicy/Get-GPO.md index 947c96821e..279cb68bcc 100644 --- a/docset/winserver2022-ps/grouppolicy/Get-GPO.md +++ b/docset/winserver2022-ps/grouppolicy/Get-GPO.md @@ -41,7 +41,7 @@ single GPO, or you can get all the GPOs in the domain through the **All** parame This cmdlet returns one or more objects that represent the requested GPOs. By default, properties of the requested GPOs are printed to the display; however, you can also pipe -the output of the **Get-GPO** cmdlet to other Group Policy cmdlets. +the output of the `Get-GPO` cmdlet to other Group Policy cmdlets. ## EXAMPLES From e6f5e8ba6549b76ec82f31fa04a0ae54700d8da7 Mon Sep 17 00:00:00 2001 From: Paula Kingsley Date: Tue, 2 May 2023 14:28:06 -0700 Subject: [PATCH 377/650] Update docset/winserver2022-ps/grouppolicy/Get-GPO.md backticks around values also Co-authored-by: Mikey Lombardi (He/Him) --- docset/winserver2022-ps/grouppolicy/Get-GPO.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docset/winserver2022-ps/grouppolicy/Get-GPO.md b/docset/winserver2022-ps/grouppolicy/Get-GPO.md index 279cb68bcc..32ff518c10 100644 --- a/docset/winserver2022-ps/grouppolicy/Get-GPO.md +++ b/docset/winserver2022-ps/grouppolicy/Get-GPO.md @@ -110,8 +110,8 @@ ComputerVersion : AD Version: 0, SysVol Version: 0 WmiFilter : ``` -This command gets the GPO that has the ID (GUID) 331a09564-cd4a-4520-98fa-446a2af23b4b in the -sales.contoso.com domain. +This command gets the GPO that has the ID (GUID) `331a09564-cd4a-4520-98fa-446a2af23b4b` in the +`sales.contoso.com` domain. If the domain of the user that is running the session (or, for startup and shutdown scripts, the computer) is different that sales.contoso.com, a trust must exist between the two domains. The command retrieves the GPO information by contacting the PDC (in the sales.contoso.com domain). From 1b01f2f6fd77817877742e4dc17543132b5d83fe Mon Sep 17 00:00:00 2001 From: Paula Kingsley Date: Tue, 2 May 2023 14:28:31 -0700 Subject: [PATCH 378/650] Update docset/winserver2022-ps/grouppolicy/Get-GPO.md Co-authored-by: Mikey Lombardi (He/Him) --- docset/winserver2022-ps/grouppolicy/Get-GPO.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/grouppolicy/Get-GPO.md b/docset/winserver2022-ps/grouppolicy/Get-GPO.md index 32ff518c10..e115edf823 100644 --- a/docset/winserver2022-ps/grouppolicy/Get-GPO.md +++ b/docset/winserver2022-ps/grouppolicy/Get-GPO.md @@ -114,7 +114,7 @@ This command gets the GPO that has the ID (GUID) `331a09564-cd4a-4520-98fa-446a2 `sales.contoso.com` domain. If the domain of the user that is running the session (or, for startup and shutdown scripts, the computer) is different that sales.contoso.com, a trust must exist between the two domains. -The command retrieves the GPO information by contacting the PDC (in the sales.contoso.com domain). +The command retrieves the GPO information by contacting the PDC (in the `sales.contoso.com` domain). ### Example 3: Get all GPOs from a domain From 9f7882b32bd00f77be9b9cb3113ea05db31d2beb Mon Sep 17 00:00:00 2001 From: Paula Kingsley Date: Tue, 2 May 2023 14:29:01 -0700 Subject: [PATCH 379/650] Update docset/winserver2022-ps/grouppolicy/Get-GPO.md Co-authored-by: Mikey Lombardi (He/Him) --- docset/winserver2022-ps/grouppolicy/Get-GPO.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/grouppolicy/Get-GPO.md b/docset/winserver2022-ps/grouppolicy/Get-GPO.md index e115edf823..78363ff186 100644 --- a/docset/winserver2022-ps/grouppolicy/Get-GPO.md +++ b/docset/winserver2022-ps/grouppolicy/Get-GPO.md @@ -147,7 +147,7 @@ Accept wildcard characters: False Specifies the domain for this cmdlet. You must specify the fully qualified domain name (FQDN) of the domain. -For the **Get-GPO** cmdlet, the GPO (or GPOs) to that this cmdlet gets must exist in this domain. +For the `Get-GPO` cmdlet, the GPO (or GPOs) to that this cmdlet gets must exist in this domain. If you do not specify the **Domain** parameter, the domain of the user that is running the current session is used. From a489b20fe6759b6ea487b0af5dad19f15d1ad3e8 Mon Sep 17 00:00:00 2001 From: Paula Kingsley Date: Tue, 2 May 2023 14:31:09 -0700 Subject: [PATCH 380/650] Update docset/winserver2022-ps/grouppolicy/Get-GPO.md corrected bold, added relative link to about_aliases Co-authored-by: Mikey Lombardi (He/Him) --- docset/winserver2022-ps/grouppolicy/Get-GPO.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/grouppolicy/Get-GPO.md b/docset/winserver2022-ps/grouppolicy/Get-GPO.md index 78363ff186..05fb9747c8 100644 --- a/docset/winserver2022-ps/grouppolicy/Get-GPO.md +++ b/docset/winserver2022-ps/grouppolicy/Get-GPO.md @@ -160,7 +160,7 @@ session (or, for a startup or shutdown script, the computer), a trust must exist domain and the domain of the user or the computer. You can also refer to the **Domain** parameter by its built-in alias, **domainname.** -For more information, see **about_Aliases.** +For more information, see [about_Aliases](/powershell/module/microsoft.powershell.core/about/about_aliases). ```yaml Type: String From 43adbdc208390044e0932bf7a19618e235e4f940 Mon Sep 17 00:00:00 2001 From: Paula Kingsley Date: Tue, 2 May 2023 14:33:20 -0700 Subject: [PATCH 381/650] Update docset/winserver2022-ps/grouppolicy/Get-GPO.md Co-authored-by: Mikey Lombardi (He/Him) --- docset/winserver2022-ps/grouppolicy/Get-GPO.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docset/winserver2022-ps/grouppolicy/Get-GPO.md b/docset/winserver2022-ps/grouppolicy/Get-GPO.md index 05fb9747c8..6f46dcc04f 100644 --- a/docset/winserver2022-ps/grouppolicy/Get-GPO.md +++ b/docset/winserver2022-ps/grouppolicy/Get-GPO.md @@ -273,10 +273,10 @@ This cmdlet returns an object that represents the requested GPO. script, the default domain is the domain to which the computer is joined. Only one domain can be used by an instance of this cmdlet. If you pipe a collection of GPO - (Microsoft.GroupPolicy.Gpo) objects to this cmdlet, the DomainName property of the first GPO - object in the collection specifies the domain for the cmdlet. This is because **domainname** is a - built-in alias for the **Domain** parameter, and the **Domain** parameter can take its value by - property name from the pipeline. A non-terminating error occurs for any GPOs in the collection + (**Microsoft.GroupPolicy.Gpo**) objects to this cmdlet, the **DomainName** property of the first + GPO object in the collection specifies the domain for the cmdlet. This is because **domainname** + is a built-in alias for the **Domain** parameter, and the **Domain** parameter can take its value + by property name from the pipeline. A non-terminating error occurs for any GPOs in the collection that are not in this domain. If this domain is different from the domain of the user account (for startup or shutdown scripts, the computer account), a trust must exist between the two domains. From 969a7334d8ed5354d64ba57524fb2a59db28f44f Mon Sep 17 00:00:00 2001 From: Robert Biddle Date: Tue, 2 May 2023 22:13:31 -0400 Subject: [PATCH 382/650] Spelling dictionary additions --- .vscode/cspell/winmodules/dictionaries/winps.txt | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.vscode/cspell/winmodules/dictionaries/winps.txt b/.vscode/cspell/winmodules/dictionaries/winps.txt index 08b242b231..90698b8fc4 100644 --- a/.vscode/cspell/winmodules/dictionaries/winps.txt +++ b/.vscode/cspell/winmodules/dictionaries/winps.txt @@ -1,7 +1,10 @@ ADCS +Cmdletization Dcpromo +Dedup DSRM krbtgt NTDS RODC Sysvol +Unoptimization From 6eaf34077df1024dd49ced3a8972160e8b292f90 Mon Sep 17 00:00:00 2001 From: Robert Biddle Date: Tue, 2 May 2023 22:13:47 -0400 Subject: [PATCH 383/650] Style guide fixes --- .../deduplication/Stop-DedupJob.md | 128 +++++++++++------- 1 file changed, 77 insertions(+), 51 deletions(-) diff --git a/docset/winserver2022-ps/deduplication/Stop-DedupJob.md b/docset/winserver2022-ps/deduplication/Stop-DedupJob.md index bf1a8635e5..2b85f3669a 100644 --- a/docset/winserver2022-ps/deduplication/Stop-DedupJob.md +++ b/docset/winserver2022-ps/deduplication/Stop-DedupJob.md @@ -16,51 +16,59 @@ Cancels one or more specified data deduplication jobs. ## SYNTAX ### ByVolume (Default) + ``` -Stop-DedupJob [-Volume] [[-Type] ] [-CimSession ] [-ThrottleLimit ] - [-AsJob] [-PassThru] [] +Stop-DedupJob [-Volume] [[-Type] ] [-CimSession ] + [-ThrottleLimit ] [-AsJob] [-PassThru] [] ``` ### ById + ``` -Stop-DedupJob [-Id ] [-CimSession ] [-ThrottleLimit ] [-AsJob] [-PassThru] - [] +Stop-DedupJob [-Id ] [-CimSession ] [-ThrottleLimit ] + [-AsJob] [-PassThru] [] ``` ### InputObject (cdxml) + ``` -Stop-DedupJob -InputObject [-CimSession ] [-ThrottleLimit ] [-AsJob] - [-PassThru] [] +Stop-DedupJob -InputObject [-CimSession ] + [-ThrottleLimit ] [-AsJob] [-PassThru] [] ``` ## DESCRIPTION -The **Stop-DedupJob** cmdlet cancels one or more specified data deduplication jobs. + +The `Stop-DedupJob` cmdlet cancels one or more specified data deduplication jobs. To run this cmdlet, you must start Windows PowerShell® with the **Run as administrator** option. ## EXAMPLES ### Example 1: Stop jobs on a specified volume -``` -PS C:\> Stop-DedupJob -Volume "D:" + +```powershell +Stop-DedupJob -Volume "D:" ``` -This command stops the deduplication jobs on the D: volume. +This command stops the deduplication jobs on the `D:` volume. ## PARAMETERS ### -AsJob -Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. -The cmdlet immediately returns an object that represents the job and then displays the command prompt. -You can continue to work in the session while the job completes. -To manage the job, use the `*-Job` cmdlets. -To get the job results, use the [Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. +Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to +complete. -For more information about Windows PowerShell background jobs, see [about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). +The cmdlet immediately returns an object that represents the job and then displays the command +prompt. You can continue to work in the session while the job completes. To manage the job, use the +`*-Job` cmdlets. To get the job results, use the +[Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. + +For more information about Windows PowerShell background jobs, see +[about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -72,12 +80,14 @@ Accept wildcard characters: False ``` ### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a [New-CimSession](/powershell/module/cimcmdlets/new-cimsession) or [Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet. -The default is the current session on the local computer. + +Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session +object, such as the output of a [New-CimSession](/powershell/module/cimcmdlets/new-cimsession) or +[Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet. The default is the +current session on the local computer. ```yaml -Type: CimSession[] +Type: Microsoft.Management.Infrastructure.CimSession[] Parameter Sets: (All) Aliases: Session @@ -89,11 +99,11 @@ Accept wildcard characters: False ``` ### -Id -Identifies the job to cancel. -To obtain this ID, run the **Get-DedupJob** cmdlet. + +Identifies the job to cancel. To obtain this ID, run the `Get-DedupJob` cmdlet. ```yaml -Type: String[] +Type: System.String[] Parameter Sets: ById Aliases: @@ -105,11 +115,12 @@ Accept wildcard characters: False ``` ### -InputObject -Specifies the input to this cmdlet. -You can use this parameter, or you can pipe the input to this cmdlet. + +Specifies the input to this cmdlet. You can use this parameter, or you can pipe the input to this +cmdlet. ```yaml -Type: CimInstance[] +Type: Microsoft.Management.Infrastructure.CimInstance[] Parameter Sets: InputObject (cdxml) Aliases: @@ -121,10 +132,11 @@ Accept wildcard characters: False ``` ### -PassThru + Returns an object representing data deduplication settings to stop. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -136,12 +148,15 @@ Accept wildcard characters: False ``` ### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -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. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. + +Specifies the maximum number of concurrent operations that can be established to run the cmdlet. 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. The throttle limit applies only to the current cmdlet, not to the session or to the +computer. ```yaml -Type: Int32 +Type: System.Int32 Parameter Sets: (All) Aliases: @@ -153,13 +168,14 @@ Accept wildcard characters: False ``` ### -Type -Specifies an array of types of data deduplication jobs schedules for which to return **DeduplicationJobSchedule** objects. -The acceptable values for this parameter are: -- Optimization -- GarbageCollection -- Scrubbing -- Unoptimization +Specifies an array of types of data deduplication jobs schedules for which to return +**DeduplicationJobSchedule** objects. The acceptable values for this parameter are: + +- `Optimization` +- `GarbageCollection` +- `Scrubbing` +- `Unoptimization` ```yaml Type: Type[] @@ -175,14 +191,14 @@ Accept wildcard characters: False ``` ### -Volume -Specifies one or more file system volumes on which to cancel one or more named data deduplication jobs. -Enter one or more volume IDs, drive letters, or volume GUID paths. -For drive letters, use the format D:. -For volume GUID paths, use the format \\\\?\Volume{{GUID}}\. -Separate multiple volumes with a comma. + +Specifies one or more file system volumes on which to cancel one or more named data deduplication +jobs. Enter one or more volume IDs, drive letters, or volume GUID paths. For drive letters, use the +format `D:`. For volume GUID paths, use the format `\\\\?\Volume{{GUID}}\`. Separate multiple +volumes with a comma. ```yaml -Type: String[] +Type: System.String[] Parameter Sets: ByVolume Aliases: Path, Name, DeviceId @@ -194,27 +210,37 @@ Accept wildcard characters: False ``` ### CommonParameters -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). + +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). ## INPUTS ### System.String[] ### Microsoft.Management.Infrastructure.CimInstance -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. + +The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays +Windows Management Instrumentation (WMI) objects. The path after the pound sign (`#`) provides the +namespace and class name for the underlying WMI object. ### Microsoft.PowerShell.Cmdletization.GeneratedTypes.DedupJob.Type[] ## OUTPUTS ### Microsoft.Management.Infrastructure.CimInstance -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. + +The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays +Windows Management Instrumentation (WMI) objects. The path after the pound sign (`#`) provides the +namespace and class name for the underlying WMI object. ### Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Deduplication/MSFT_DedupJob -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. + +The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays +Windows Management Instrumentation (WMI) objects. The path after the pound sign (`#`) provides the +namespace and class name for the underlying WMI object. ## NOTES From 045973668c462d970d5e5c71d0d98aba8c8abace Mon Sep 17 00:00:00 2001 From: Rob Derickson Date: Tue, 2 May 2023 23:33:17 -0400 Subject: [PATCH 384/650] Added backticks around references to the MY certificate stores and various provider values that can be passed to the Provider parameter. Took a crack at formatting help for the TextExtension parameter. --- .../pki/New-SelfSignedCertificate.md | 254 ++++++++---------- 1 file changed, 106 insertions(+), 148 deletions(-) diff --git a/docset/winserver2022-ps/pki/New-SelfSignedCertificate.md b/docset/winserver2022-ps/pki/New-SelfSignedCertificate.md index d5f3cc4a7f..55c20a11bd 100644 --- a/docset/winserver2022-ps/pki/New-SelfSignedCertificate.md +++ b/docset/winserver2022-ps/pki/New-SelfSignedCertificate.md @@ -11,7 +11,6 @@ title: New-SelfSignedCertificate # New-SelfSignedCertificate ## SYNOPSIS - Creates a new self-signed certificate for testing purposes. ## SYNTAX @@ -55,7 +54,7 @@ $params = @{ New-SelfSignedCertificate @params ``` -This example creates a self-signed SSL server certificate in the computer MY store with the subject +This example creates a self-signed SSL server certificate in the computer `MY` store with the subject alternative names `www.fabrikam.com` and `www.contoso.com` and the Subject and Issuer name set to `www.fabrikam.com`. @@ -68,7 +67,7 @@ PS Cert:\LocalMachine\My> New-SelfSignedCertificate -CloneCert $OldCert ``` This example creates a copy of the certificate specified by the **CloneCert** parameter and puts it -in the computer MY store. +in the computer `MY` store. ### EXAMPLE 3 @@ -87,9 +86,9 @@ $params = @{ New-SelfSignedCertificate @params ``` -This example creates a self-signed S/MIME certificate in the user MY store. The certificate uses the -default provider, which is the `Microsoft Software Key Storage Provider`. The certificate uses an -`RSA` asymmetric key with a key size of `2048` bits. This certificate has the subject alternative +This example creates a self-signed S/MIME certificate in the user `MY` store. The certificate uses +the default provider, which is the `Microsoft Software Key Storage Provider`. The certificate uses +an `RSA` asymmetric key with a key size of `2048` bits. This certificate has the subject alternative names of `patti.fuller@contoso.com` as RFC822 and `pattifuller@contoso.com` as Principal Name. This command does not specify the **NotAfter** parameter. Therefore, the certificate expires in one @@ -112,7 +111,7 @@ $params = @{ New-SelfSignedCertificate @params ``` -This example creates a self-signed client authentication certificate in the user MY store. The +This example creates a self-signed client authentication certificate in the user `MY` store. The certificate uses the default provider, which is the `Microsoft Software Key Storage Provider`. The certificate uses an `RSA` asymmetric key with a key size of `2048` bits. The certificate has a subject alternative name of `pattifuller@contoso.com`. @@ -136,10 +135,10 @@ $params = @{ New-SelfSignedCertificate @params ``` -This example creates a self-signed client authentication certificate in the user MY store. The +This example creates a self-signed client authentication certificate in the user `MY` store. The certificate uses the default provider, which is the `Microsoft Software Key Storage Provider`. The -certificate uses an elliptic curve asymmetric key and the curve parameters nist256, which creates a -256-bit key. The subject alternative name is `pattifuller@contoso.com`. +certificate uses an elliptic curve asymmetric key and the curve parameters `nist256`, which creates +a 256-bit key. The subject alternative name is `pattifuller@contoso.com`. The certificate expires in one year. @@ -162,7 +161,7 @@ $params = @{ New-SelfSignedCertificate @params ``` -This example creates a self-signed client authentication certificate in the user MY store. The +This example creates a self-signed client authentication certificate in the user `MY` store. The certificate uses the `Microsoft Platform Crypto Provider`. This provider uses the Trusted Platform Module (TPM) of the device to create the asymmetric key. The certificate uses an `RSA` asymmetric key with a key size of `2048` bits. The key is not exportable. The subject alternative name is @@ -210,9 +209,9 @@ $params = @{ New-SelfSignedCertificate @params ``` -This example creates a self-signed S/MIME certificate in the user MY store. The certificate uses the -default provider, which is the `Microsoft Software Key Storage Provider`. The certificate uses an -`RSA` asymmetric key with a key size of `2048` bits. This certificate has the subject alternative +This example creates a self-signed S/MIME certificate in the user `MY` store. The certificate uses +the default provider, which is the `Microsoft Software Key Storage Provider`. The certificate uses +an `RSA` asymmetric key with a key size of `2048` bits. This certificate has the subject alternative names of `patti.fuller@contoso.com` and `pattifuller@contoso.com` both as RFC822. This command does not specify the **NotAfter** parameter. Therefore, the certificate expires in one @@ -229,7 +228,7 @@ New-SelfSignedCertificate @params ``` This example creates a self-signed SSL server certificate with Subject and Issuer name set to -`localhost` and with subject alternative name set to IPAddress `127.0.0.1` and `::1` via +`localhost` and with subject alternative name set to **IPAddress** `127.0.0.1` and `::1` via **TextExtension**. ## PARAMETERS @@ -435,7 +434,7 @@ Accept wildcard characters: False ### -HardwareKeyUsage Specifies how a hardware key associated with the new certificate may be used. This parameter applies -only when you specify the Microsoft Platform Crypto Provider. The acceptable values for this +only when you specify the `Microsoft Platform Crypto Provider`. The acceptable values for this parameter are: - `None` @@ -486,9 +485,9 @@ Algorithms (ECDSA). The elliptic curve algorithm syntax is the following: -`ECDSA_`curvename +`ECDSA_{curvename}` -To obtain a value for curvename, use the `certutil -displayEccCurve` command. +To obtain a value for `{curvename}`, use the `certutil -displayEccCurve` command. Valid curve names contain a value in the **Curve OID** column in the output of the `certutil -displayEccCurve` command. @@ -527,8 +526,9 @@ Specifies the policy that governs the export of the private key that is associat certificate. The default value of `ExportableEncrypted` is not compatible with KSP and CSPs that do not allow key -export. These include the Microsoft Smart Card Key Storage Provider and the Microsoft Platform -Crypto Key Storage Provider. Specify `NonExportable` for providers that do not allow key export. +export. These include the `Microsoft Smart Card Key Storage Provider` and the +`Microsoft Platform Crypto Key Storage Provider`. Specify `NonExportable` for providers that do not +allow key export. ```yaml Type: Microsoft.CertificateServices.Commands.KeyExportPolicy[] @@ -578,7 +578,7 @@ Accept wildcard characters: False ### -KeyLocation Specifies the file system location where this cmdlet stores the private keys associated with the new -certificate. Specify this parameter only when you specify the Microsoft Platform Crypto Provider. +certificate. Specify this parameter only when you specify the `Microsoft Platform Crypto Provider`. ```yaml Type: System.String @@ -710,8 +710,8 @@ Accept wildcard characters: False ### -NotAfter Specifies the date and time, as a **DateTime** object, that the certificate expires. To obtain a -**DateTime** object, use the Get-Date cmdlet. The default value for this parameter is one year after -the certificate was created. +**DateTime** object, use the `Get-Date` cmdlet. The default value for this parameter is one year +after the certificate was created. ```yaml Type: System.DateTime @@ -969,146 +969,104 @@ Accept wildcard characters: False Specifies an array of certificate extensions, as strings, which this cmdlet includes in the new certificate. Each string must employ one of the following formats: -oid`=`base64String, where oid is the object identifier of the extension and base64String is a value -that you provide. After decoding base64String, the value must be valid Abstract Syntax Notation One -(ASN.1). For more information, see +`{oid}={base64String}`, where `{oid}` is the object identifier of the extension and `{base64String}` +is a value that you provide. After decoding `{base64String}`, the value must be valid Abstract +Syntax Notation One (ASN.1). For more information, see [Abstract Syntax Notation One (ASN.1): Specification of basic notation](http://www.itu.int/ITU-T/studygroups/com17/languages/X.680-0207.pdf). -oid`={hex}`hexidecimalString, where oid is the object identifier of the extension and -hexidecimalString is a value that you provide. After decoding hexidecimalString, the value must be -valid ASN.1. +`{oid}={hex}{hexadecimalString}`, where `{oid}` is the object identifier of the extension and +`{hexadecimalString}` is a value that you provide. After decoding `{hexadecimalString}`, the value +must be valid ASN.1. -oid`={text}`String, where oid is the object identifier of the extension and String is a value that -you provide. String must contain a textual representation of the extension value in a format -specific to each object ID. When String is processed, it will be encoded into an ASN.1 extension -value before being placed into the new certificate as an extension. +`{oid}={text}{String}`, where `{oid}` is the object identifier of the extension and `{String}` is a +value that you provide. `{String}` must contain a textual representation of the extension value in a +format specific to each object ID. When `{String}` is processed, it will be encoded into an ASN.1 +extension value before being placed into the new certificate as an extension. -To specify that an extension is critical, insert `{critical}` immediately following `oid=` in any of -the previous cases. +To specify that an extension is critical, insert `{critical}` immediately following `{oid}=` in any +of the previous cases. The object identifiers of some common extensions are as follows: -- Application Policy. -`1.3.6.1.4.1.311.21.10` -- Application Policy Mappings. -`1.3.6.1.4.1.311.21.11` -- Basic Constraints. -`2.5.29.19` -- Certificate Policies. -`2.5.29.32` -- Enhanced Key Usage. -`2.5.29.37` -- Name Constraints. -`2.5.29.30` -- Policy Mappings. -`2.5.29.33` -- Subject Alternative Name. -`2.5.29.17` - -Application Policy -`1.3.6.1.4.1.311.21.10={text}token=value&token=value…` -The tokens have the following possible values: - -- Flags. -0xhexidecimalNumber -- GUID. -A globally unique ID, such as this example: `f7c3ac41-b8ce-4fb4-aa58-3d1dc0e36b39` -- Notice. -Text notice -- OID. -Object identifier in dotted decimal notation, such as this example: `1.2.3.4.5` -- URL. -The URL of a host, such as this example: `http://computer07.contoso.com` +- Application Policy: `1.3.6.1.4.1.311.21.10` +- Application Policy Mappings: `1.3.6.1.4.1.311.21.11` +- Basic Constraints: `2.5.29.19` +- Certificate Policies: `2.5.29.32` +- Enhanced Key Usage: `2.5.29.37` +- Name Constraints: `2.5.29.30` +- Policy Mappings: `2.5.29.33` +- Subject Alternative Name: `2.5.29.17` + +Application Policy extension example: `1.3.6.1.4.1.311.21.10={text}{token}={value}&{token}={value}...` + +You can specify the following tokens in an Application Policy extension: + +- **Flags**: Bitwise flags in hexadecimal notation: `0x{hexadecimalNumber}` +- **GUID**: A globally unique ID, such as this example: `f7c3ac41-b8ce-4fb4-aa58-3d1dc0e36b39` +- **Notice**: Text notice +- **OID**: Object identifier in dotted decimal notation, such as this example: `1.2.3.4.5` +- **URL**: The URL of a host, such as this example: `http://computer07.contoso.com` To specify an Application Policy extension, specify the first object identifier, followed by zero or -more other **token=value** entries. These entries are subordinate to the preceding object -identifier. Specify subsequent object identifiers, each followed by its subordinate **token=value** -entries. - -Application Policy Mappings -`1.3.6.1.4.1.311.21.11={text}oid=oid&oid=oid…` - -Certificate Policies -`2.5.29.32={text}token=value&token=value…` -The tokens have the following possible values: - -- Flags. -0xhexidecimalNumber -- GUID. -A globally unique ID, such as this example: `f7c3ac41-b8ce-4fb4-aa58-3d1dc0e36b39` -- Notice. -Text notice -- OID. -Object ID in dotted decimal notation, such as this example: `1.2.3.4.5` -- URL. -The URL of a host, such as this example: `http://computer07.contoso.com` +more other `{token}={value}` entries. These entries are subordinate to the preceding object +identifier. Specify subsequent object identifiers, each followed by its subordinate +`{token}={value}` entries. + +Application Policy Mappings extension example: `1.3.6.1.4.1.311.21.11={text}oid={oid}&oid={oid}...` + +Certificate Policies extension example: `2.5.29.32={text}{token}={value}&{token}={value}...` + +You can specify the following tokens in a Certificate Policies extension: + +- **Flags**: Bitwise flags in hexadecimal notation: `0x{hexadecimalNumber}` +- **GUID**: A globally unique ID, such as this example: `f7c3ac41-b8ce-4fb4-aa58-3d1dc0e36b39` +- **Notice**: Text notice +- **OID**: Object identifier in dotted decimal notation, such as this example: `1.2.3.4.5` +- **URL**: The URL of a host, such as this example: `http://computer07.contoso.com` To specify a Certificate Policies extension, follow the same syntax as an Application Policy extension. -Enhanced Key Usage Object Identifiers -`2.5.29.37={text}oid,oid…` +Enhanced Key Usage Object Identifiers extension example: `2.5.29.37={text}{oid},{oid}...` + These key usages have the following object identifiers: -- Client Authentication. -`1.3.6.1.5.5.7.3.2` -- Server Authentication. -`1.3.6.1.5.5.7.3.1` -- Secure Email. -`1.3.6.1.5.5.7.3.4` -- Code Signing. -`1.3.6.1.5.5.7.3.3` -- Timestamp Signing. -`1.3.6.1.5.5.7.3.8` - -Name Constraints `2.5.29.30={text}subtree=subtreeValue&token=value&token=value&` -`…&subtree=subtreeValue&token=value&token=value…` The subtreeValue can have the following values: - -- `Include`. -Permitted names -- `Exclude`. -Excluded names - -The tokens have the following possible values: - -- DirectoryName. -`CN=Name,DC=Domain,DC=com` -- DNS. -A computer name in the following format: `computer.contoso.com` -- Email. -An email address, such as this example: `admin@contoso.com` -- IPAddress. -IPV4 address,IPV4 subnet mask or IPV6 address,IPV6 subnet mask -- RegisteredID. -ID in dotted decimal notation, such as this example: `1.2.3.4.5` -- UPN. -A user principal name in the following format: `admin@contoso.com` -- URL. -The URL of a host, such as this example: `http://computer07.contoso.com/index.html` - -Policy Mapping -`2.5.29.33={text}oid=oid&oid=oid…` - -Subject Alternative Name Syntax -`2.5.29.17={text}token=value&token=value…` -The tokens have the following possible values: - -- UPN. -A user principal name in the following format: `admin@contoso.com` -- Email. -An email address, such as this example: `admin@contoso.com` -- DNS. -A computer name in the following format: `computer.contoso.com` -- DirectoryName. -`CN=Name,DC=Domain,DC=com` -- URL. -The URL of a host, such as this example: `http://computer07.contoso.com/index.html` -- IPAddress. -An IP address -- RegisteredID. -ID in dotted decimal notation, such as this example: `1.2.3.4.5` -- GUID. -A globally unique ID, such as this example: `f7c3ac41-b8ce-4fb4-aa58-3d1dc0e36b39` +- Client Authentication: `1.3.6.1.5.5.7.3.2` +- Server Authentication: `1.3.6.1.5.5.7.3.1` +- Secure Email: `1.3.6.1.5.5.7.3.4` +- Code Signing: `1.3.6.1.5.5.7.3.3` +- Timestamp Signing: `1.3.6.1.5.5.7.3.8` + +Name Constraints extension example: +`2.5.29.30={text}subtree=include&{token}={value}&{token}={value}&subtree=exclude&{token}={value}...` + +A Name Constraints extension can have **Subtree** values of `Include` and `Exclude` to specify +included and excluded names. + +You can specify the following tokens in a Name Constraints extension: + +- **DirectoryName**: A distinguished name such as: `CN=Name,DC=Domain,DC=com` +- **DNS**: A computer name in the following format: `computer.contoso.com` +- **Email**: An email address, such as this example: `admin@contoso.com` +- **IPAddress**: `{IPV4 address},{IPV4 subnet mask}` or `{IPV6 address},{IPV6 subnet mask}` +- **RegisteredID**: ID in dotted decimal notation, such as this example: `1.2.3.4.5` +- **UPN**: A user principal name in the following format: `admin@contoso.com` +- **URL**: The URL of a host, such as this example: `http://computer07.contoso.com/index.html` + +Policy Mapping extension example: `2.5.29.33={text}oid={oid}&oid={oid}...` + +Subject Alternative Name extension example: `2.5.29.17={text}token=value&token=value...` + +You can specify the following tokens in a Subject Alternative Name extension: + +- **DirectoryName**: A distinguished name such as: `CN=Name,DC=Domain,DC=com` +- **DNS**: A computer name in the following format: `computer.contoso.com` +- **Email**: An email address, such as this example: `admin@contoso.com` +- **GUID**: A globally unique ID, such as this example: `f7c3ac41-b8ce-4fb4-aa58-3d1dc0e36b39` +- **IPAddress**: `{IPV4 address},{IPV4 subnet mask}` or `{IPV6 address},{IPV6 subnet mask}` +- **RegisteredID**: ID in dotted decimal notation, such as this example: `1.2.3.4.5` +- **UPN**: A user principal name in the following format: `admin@contoso.com` +- **URL**: The URL of a host, such as this example: `http://computer07.contoso.com/index.html` ```yaml Type: System.String[] From f7111201998a08e28fd3e2af729c315e385f95d6 Mon Sep 17 00:00:00 2001 From: Phil Bossman Date: Wed, 3 May 2023 00:07:22 -0400 Subject: [PATCH 385/650] GroupPolicy module Formating updates --- .../grouppolicy/Backup-GPO.md | 20 +- .../winserver2022-ps/grouppolicy/Copy-GPO.md | 27 +- .../grouppolicy/Get-GPInheritance.md | 13 +- .../winserver2022-ps/grouppolicy/Get-GPO.md | 55 +-- .../grouppolicy/Get-GPOReport.md | 22 +- .../grouppolicy/Get-GPPermission.md | 180 +++++--- .../grouppolicy/Get-GPPrefRegistryValue.md | 200 ++++++--- .../grouppolicy/Get-GPRegistryValue.md | 164 +++++--- .../grouppolicy/Get-GPResultantSetOfPolicy.md | 101 +++-- .../grouppolicy/Get-GPStarterGPO.md | 113 +++-- .../grouppolicy/GroupPolicy.md | 51 ++- .../grouppolicy/Import-GPO.md | 91 ++-- .../grouppolicy/Invoke-GPUpdate.md | 105 +++-- .../grouppolicy/New-GPLink.md | 197 +++++---- .../winserver2022-ps/grouppolicy/New-GPO.md | 133 +++--- .../grouppolicy/New-GPStarterGPO.md | 58 ++- .../grouppolicy/Remove-GPLink.md | 105 +++-- .../grouppolicy/Remove-GPO.md | 80 ++-- .../grouppolicy/Remove-GPPrefRegistryValue.md | 204 ++++++--- .../grouppolicy/Remove-GPRegistryValue.md | 153 ++++--- .../grouppolicy/Rename-GPO.md | 89 ++-- .../grouppolicy/Restore-GPO.md | 138 +++--- .../grouppolicy/Set-GPInheritance.md | 145 ++++--- .../grouppolicy/Set-GPLink.md | 183 +++++--- .../grouppolicy/Set-GPPermission.md | 204 +++++---- .../grouppolicy/Set-GPPrefRegistryValue.md | 398 ++++++++++++------ .../grouppolicy/Set-GPRegistryValue.md | 296 ++++++++----- 27 files changed, 2258 insertions(+), 1267 deletions(-) diff --git a/docset/winserver2022-ps/grouppolicy/Backup-GPO.md b/docset/winserver2022-ps/grouppolicy/Backup-GPO.md index 15e39f23f1..01b69895ff 100644 --- a/docset/winserver2022-ps/grouppolicy/Backup-GPO.md +++ b/docset/winserver2022-ps/grouppolicy/Backup-GPO.md @@ -80,12 +80,12 @@ This command backs up the GPO with the specified **GUID** in the `contoso.com` d the operation. If the domain of the user running the session (or, for startup and shutdown scripts, the computer) -is different from the `contoso.com` domain, a trust must exist between the two domains or the command -fails. +is different from the `contoso.com` domain, a trust must exist between the two domains or the +command fails. ### Example 3: Backup all GPOs in the domain of the user that is running the session -``` +```powershell Backup-Gpo -All -Path "\\Server1\GpoBackups" ``` @@ -158,8 +158,8 @@ If you specify a domain that is different from the domain of the user that is ru session (or, for a startup or shutdown script, the computer), a trust must exist between that domain and the domain of the user (or the computer). -You can also refer to Domain by its built-in alias, domain name. -For more information, see [about_Aliases](????????). +You can also refer to Domain by its built-in alias, domain name. For more information, see +[about_Aliases](/powershell/module/microsoft.powershell.core/about/about_aliases) ```yaml Type: System.String @@ -178,11 +178,11 @@ Accept wildcard characters: False Specifies the GPO to backup by its globally unique identifier (GUID). The `GUID` uniquely identifies the GPO. -You can also refer to the **Guid** parameter by its built-in alias, **Id**. -For more information, see [about_Aliases](????????????). +You can also refer to the **Guid** parameter by its built-in alias, **Id**. For more information, +see [about_Aliases](/powershell/module/microsoft.powershell.core/about/about_aliases). ```yaml -Type: Guid ???????????? +Type: Guid Parameter Sets: BackupOne(GUID) Aliases: Id @@ -201,8 +201,8 @@ The display name is not guaranteed to be unique in the domain. If another GPO with the same display name exists in the domain an error occurs. You can use the **Guid** parameter to uniquely identify a GPO. -You can also refer to the Name parameter by its built-in alias, **DisplayName**. -For more information, see [about_Aliases](??????????????). +You can also refer to the Name parameter by its built-in alias, **DisplayName**. For more +information, see [about_Aliases](/powershell/module/microsoft.powershell.core/about/about_aliases). ```yaml Type: System.String diff --git a/docset/winserver2022-ps/grouppolicy/Copy-GPO.md b/docset/winserver2022-ps/grouppolicy/Copy-GPO.md index 7dfa83cf2e..42d3a98e82 100644 --- a/docset/winserver2022-ps/grouppolicy/Copy-GPO.md +++ b/docset/winserver2022-ps/grouppolicy/Copy-GPO.md @@ -92,23 +92,24 @@ that is running the session.a trust must exist between that domain and the domai ```powershell Get-GPO -All -Domain "sales1.contoso.com" | ForEach-Object { $params = @{ - 'TargetName' = $_.DisplayName + 'TargetName' = $_.DisplayName + 'TargetDomain' = "sales2.contoso.com" + 'CopyACL' = $true + 'MigrationTable' = 'c:\tables\MigrationTable.migtable' } - -?????????????????????? - - $_ | Copy-GPO -TargetName ($_.DisplayName) -TargetDomain "sales2.contoso.com" -CopyAcl -MigrationTable 'c:\tables\MigrationTable.migtable' } + $_ | Copy-GPO @params } ``` -This command copies all the GPOs in the sales1.contoso.com domain to the sales2.contoso.com domain. +This command copies all the GPOs in the `sales1.contoso.com` domain to the `sales2.contoso.com` +domain. All the GPOs in the source domain are retrieved by using the **Get-GPO** cmdlet using the **All** parameter. The output of **Get-GPO** is piped into the ForEach-Object command. When each GPO is evaluated, it is piped into **Copy-GPO** and its display name is specified for the **TargetName** -parameter `-TargetName ($_.DisplayName)`. The **CopyACL** parameter is specified to copy the ACLs for -each GPO to the destination domain. The **MigrationTable** parameter specifies a migration table to -use to migrate Security principals and UNC paths to the destination domain. Both the **CopyACL** and -the **MigrationTable** parameters are optional. +parameter `-TargetName ($_.DisplayName)`. The **CopyACL** parameter is specified to copy the ACLs +for each GPO to the destination domain. The **MigrationTable** parameter specifies a migration table +to use to migrate Security principals and UNC paths to the destination domain. Both the **CopyACL** +and the **MigrationTable** parameters are optional. If a GPO with the same display name as a source GPO already exists in the destination domain, an error occurs when this command attempts to copy the source GPO. Because this command copies all GPOs @@ -116,7 +117,7 @@ in the source domain, errors occur for default GPOs; for instance, the Default D the Default Domain Controllers Policy GPO. These GPOs are not copied. You can suppress these error messages by supplying the **ErrorAction** parameter with a value of SilentlyContinue to **Copy-GPO**. For more information about the **ErrorAction** parameter, see -[about_CommonParameters](?????????). +[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). The destination GPOs that were successfully copied are returned by this command. By default, they are printed to the display, but you can add commands to the end of the pipeline to further configure @@ -232,8 +233,8 @@ Accept wildcard characters: False ### -SourceGuid -Specifies the source GPO by its globally unique identifier `GUID`. The `GUID` uniquely identifies the -GPO. +Specifies the source GPO by its globally unique identifier `GUID`. The `GUID` uniquely identifies +the GPO. You can also refer to the **SourceGuid** parameter by its built-in alias, `Id`. diff --git a/docset/winserver2022-ps/grouppolicy/Get-GPInheritance.md b/docset/winserver2022-ps/grouppolicy/Get-GPInheritance.md index 20da4a4d34..db3742168a 100644 --- a/docset/winserver2022-ps/grouppolicy/Get-GPInheritance.md +++ b/docset/winserver2022-ps/grouppolicy/Get-GPInheritance.md @@ -91,13 +91,12 @@ InheritedGpoLinks : {Default Domain Policy} This command gets Group Policy inheritance information for the `contoso.com` domain. The domain controller with the host name `DomainController1` is contacted to complete the operation. -The domain does not have to be explicitly specified using the **Domain** parameter in this example. If -the domain of the user that is running the session (or, for startup and shutdown scripts, the +The domain does not have to be explicitly specified using the **Domain** parameter in this example. +If the domain of the user that is running the session (or, for startup and shutdown scripts, the computer) is the same as the target domain, or a trust exists between it and the target domain, you do not have to specify the **Domain** parameter. -### Example 3: Get GPOs that are linked to a specific organizational unit by evaluating the SOM - object +### Example 3: Get GPOs that are linked to a specific organizational unit by evaluating the SOM object ```powershell (Get-GPInheritance -Target "ou=myou,dc=contoso,dc=com").GpoLinks | @@ -132,7 +131,7 @@ WmiFilter : ``` This command evaluates the SOM object `Microsoft.GroupPolicy.SOM` returned by **Get-GPInheritance** -and returns the GPOs that are linked to the MyOU organizational unit. You can use this command to +and returns the GPOs that are linked to the `MyOU` organizational unit. You can use this command to set properties of the GPOs by piping its output into other cmdlets. For instance, you can pipe the output to the **Set-GPPermissions** cmdlet to delegate permissions to administrators of the OU for each of the GPOs linked to the OU. @@ -141,12 +140,14 @@ The **GpoLinks** property of the SOM object contains a list of all the GPO links Each object in this list is of type `Microsoft.GroupPolicy.GpoLink`. The following shows one such object: +```Output GpoId : d02126d4-82e8-4e87-b4a0-2d44b6891411 DisplayName : TestGPO-3 Enabled : True Enforced : False Target : ou=myou,dc=contoso,dc=com Order : 1 +``` The collection is piped into a foreach-object command, which retrieves each GPO by using the DisplayName property of the GpoLink object. @@ -171,7 +172,7 @@ session (or, for a startup or shutdown script, the computer), a trust must exist and the domain of the user or the computer. You can also refer to the **Domain** parameter by its built-in alias, `DomainName`. For more -information, see [about_Aliases](???????). +information, see [about_Aliases](/powershell/module/microsoft.powershell.core/about/about_aliases). ```yaml Type: System.String diff --git a/docset/winserver2022-ps/grouppolicy/Get-GPO.md b/docset/winserver2022-ps/grouppolicy/Get-GPO.md index b58e26e7a3..a3b4ff0732 100644 --- a/docset/winserver2022-ps/grouppolicy/Get-GPO.md +++ b/docset/winserver2022-ps/grouppolicy/Get-GPO.md @@ -40,8 +40,9 @@ The **Get-GPO** cmdlet gets one Group Policy Object (GPO) or all the GPOs in a d specify a GPO by its display name or by its globally unique identifier (GUID) to get a single GPO, or you can get all the GPOs in the domain through the **All** parameter. -This cmdlet returns one or more objects that represent the requested GPOs. -By default, properties of the requested GPOs are printed to the display; however, you can also pipe the output of the **Get-GPO** cmdlet to other Group Policy cmdlets. +This cmdlet returns one or more objects that represent the requested GPOs. By default, properties of +the requested GPOs are printed to the display; however, you can also pipe the output of the +**Get-GPO** cmdlet to other Group Policy cmdlets. ## EXAMPLES @@ -65,9 +66,9 @@ ComputerVersion : AD Version: 0, SysVol Version: 0 WmiFilter : ``` -This command gets the GPO named `Group Policy Test`. The GPO must exist in the domain of the user that -is running the session (or, for startup and shutdown scripts, the computer). The command gets the -GPO information by contacting the primary domain controller (PDC). +This command gets the GPO named `Group Policy Test`. The GPO must exist in the domain of the user +that is running the session (or, for startup and shutdown scripts, the computer). The command gets +the GPO information by contacting the primary domain controller (PDC). ### Example 2: Get a single GPO by GUID @@ -90,9 +91,9 @@ WmiFilter : ``` This command gets the GPO that has the ID (GUID) `331a09564-cd4a-4520-98fa-446a2af23b4b` in the -`sales.contoso.com` domain. If the domain of the user that is running the session (or, for startup and -shutdown scripts, the computer) is different that `sales.contoso.com`, a trust must exist between the -two domains. The command retrieves the GPO information by contacting the PDC (in the +`sales.contoso.com` domain. If the domain of the user that is running the session (or, for startup +and shutdown scripts, the computer) is different that `sales.contoso.com`, a trust must exist +between the two domains. The command retrieves the GPO information by contacting the PDC (in the `sales.contoso.com` domain). ### Example 3: Get all GPOs from a domain @@ -132,10 +133,12 @@ If you do not specify the **Domain** parameter, the domain of the user that is r session is used. If the cmdlet is being run from a computer startup or shutdown script, the domain of the computer is used. For more information, see the Notes section in the full Help. -If you specify a domain that is different from the domain of the user that is running the current session (or, for a startup or shutdown script, the computer), a trust must exist between that domain and the domain of the user or the computer. +If you specify a domain that is different from the domain of the user that is running the current +session (or, for a startup or shutdown script, the computer), a trust must exist between that domain +and the domain of the user or the computer. -You can also refer to the **Domain** parameter by its built-in alias, **DomainName**. -For more information, see [about_Aliases](????????????). +You can also refer to the **Domain** parameter by its built-in alias, **DomainName**. For more +information, see [about_Aliases](/powershell/module/microsoft.powershell.core/about/about_aliases). ```yaml Type: System.String @@ -237,19 +240,23 @@ This cmdlet returns an object that represents the requested GPO. * You can use the **Domain** parameter to explicitly specify the domain for this cmdlet. - If you do not explicitly specify the domain, the cmdlet uses a default domain. -The default domain is the domain that is used to access network resources by the security context under which the current session is running. -This domain is typically the domain of the user that is running the session. -For example, the domain of the user who started the session by opening Windows PowerShell from the Program Files menu, or the domain of a user that is specified in a runas command. -However, computer startup and shutdown scripts run under the context of the LocalSystem account. -The LocalSystem account is a built-in local account, and it accesses network resources under the context of the computer account. -Therefore, when this cmdlet is run from a startup or shutdown script, the default domain is the domain to which the computer is joined. - - Only one domain can be used by an instance of this cmdlet. -If you pipe a collection of GPO (Microsoft.GroupPolicy.Gpo) objects to this cmdlet, the DomainName property of the first GPO object in the collection specifies the domain for the cmdlet. -This is because domainname is a built-in alias for the **Domain** parameter, and the **Domain** parameter can take its value by property name from the pipeline. -A non-terminating error occurs for any GPOs in the collection that are not in this domain. -If this domain is different from the domain of the user account (for startup or shutdown scripts, the computer account), a trust must exist between the two domains. + If you do not explicitly specify the domain, the cmdlet uses a default domain. The default domain + is the domain that is used to access network resources by the security context under which the + current session is running. This domain is typically the domain of the user that is running the + session. For example, the domain of the user who started the session by opening Windows PowerShell + from the Program Files menu, or the domain of a user that is specified in a runas command. + However, computer startup and shutdown scripts run under the context of the LocalSystem account. + The LocalSystem account is a built-in local account, and it accesses network resources under the + context of the computer account. Therefore, when this cmdlet is run from a startup or shutdown + script, the default domain is the domain to which the computer is joined. + + Only one domain can be used by an instance of this cmdlet. If you pipe a collection of GPO + (Microsoft.GroupPolicy.Gpo) objects to this cmdlet, the DomainName property of the first GPO + object in the collection specifies the domain for the cmdlet. This is because domainname is a + built-in alias for the **Domain** parameter, and the **Domain** parameter can take its value by + property name from the pipeline. A non-terminating error occurs for any GPOs in the collection + that are not in this domain. If this domain is different from the domain of the user account (for + startup or shutdown scripts, the computer account), a trust must exist between the two domains. ## RELATED LINKS diff --git a/docset/winserver2022-ps/grouppolicy/Get-GPOReport.md b/docset/winserver2022-ps/grouppolicy/Get-GPOReport.md index b82d36521a..ffa04373b1 100644 --- a/docset/winserver2022-ps/grouppolicy/Get-GPOReport.md +++ b/docset/winserver2022-ps/grouppolicy/Get-GPOReport.md @@ -63,7 +63,14 @@ This command generates a report in HTML format for the GPO `TestGPO1` and writes ### Example 2: Generate an XML report for each GPO in the specified domain ```powershell -Get-GPOReport -All -Domain "sales.contoso.com" -Server "DC1" -ReportType XML -Path "C:\GPOReports\GPOReportsAll.xml" +$params = @{ + All = $true + Domain = 'sales.contoso.com' + Server = 'DC1' + ReportType = 'XML' + Path = 'C:\GPOReports\GPOReportsAll.xml' +} +Get-GPOReport @params ``` This command generates a report in XML format for each GPO in the `sales.contoso.com` domain and @@ -120,7 +127,7 @@ session or, (for a startup or shutdown script, the computer), a trust must exist and the domain of the user or the computer. You can also refer to Domain by its built-in alias, **DomainName**. For more information, see -[about_Aliases](????????????). +[about_Aliases](/powershell/module/microsoft.powershell.core/about/about_aliases). ```yaml Type: System.String @@ -139,8 +146,8 @@ Accept wildcard characters: False Specifies the GPO for which to generate the report by its globally unique identifier (GUID). The GUID uniquely identifies the GPO. -You can also refer to the **Guid** parameter by its built-in alias, **Id**. -For more information, see [about_Aliases](????????). +You can also refer to the **Guid** parameter by its built-in alias, **Id**. For more information, +see [about_Aliases](/powershell/module/microsoft.powershell.core/about/about_aliases) ```yaml Type: Guid @@ -162,8 +169,8 @@ The display name is not guaranteed to be unique in the domain. If another GPO wi name exists in the domain an error occurs. You can use the **Guid** parameter to uniquely identify a GPO. -You can also refer to the **Name** parameter by its built-in alias, **DisplayName**. -For more information, see [about_Aliases](????????). +You can also refer to the **Name** parameter by its built-in alias, **DisplayName**. For more +information, see [about_Aliases](/powershell/module/microsoft.powershell.core/about/about_aliases). ```yaml Type: System.String @@ -224,7 +231,7 @@ If you do not specify the name by using the **Server** parameter, the primary do (PDC) emulator is contacted. You can refer to this parameter by its built-in alias, **DC**. For more information, see -[about_Aliases](????????). +[about_Aliases](/powershell/module/microsoft.powershell.core/about/about_aliases). ```yaml Type: System.String @@ -281,4 +288,3 @@ This cmdlet does not generate any output. startup or shutdown scripts, the computer account, a trust must exist between the two domains. ## RELATED LINKS - diff --git a/docset/winserver2022-ps/grouppolicy/Get-GPPermission.md b/docset/winserver2022-ps/grouppolicy/Get-GPPermission.md index 2d04002ead..06ce250dd9 100644 --- a/docset/winserver2022-ps/grouppolicy/Get-GPPermission.md +++ b/docset/winserver2022-ps/grouppolicy/Get-GPPermission.md @@ -11,59 +11,79 @@ title: Get-GPPermission # Get-GPPermission ## SYNOPSIS + Gets the permission level for one or more security principals on a specified GPO. ## SYNTAX ### SourcebyGUID (Default) + ``` Get-GPPermission -Guid [-TargetName ] [-TargetType ] [-DomainName ] [-Server ] [-All] [] ``` ### SourcebyName + ``` Get-GPPermission [-Name] [-TargetName ] [-TargetType ] [-DomainName ] [-Server ] [-All] [] ``` ## DESCRIPTION -The **Get-GPPermission** cmdlet gets the permission level for one or more security principals on the specified Group Policy Object (GPO). -You can use the **TargetName** and *TargetType* parameters to specify a user, security group, or computer for which to get the permission level. -You can use the **All** parameter to get the permission level for each security principal that includes: user, security group, or computer. -This only works for a user, security group, or computer that has permissions on the GPO. -You can specify the GPO by its display name or by its GUID. + +The **Get-GPPermission** cmdlet gets the permission level for one or more security principals on the +specified Group Policy Object (GPO). You can use the **TargetName** and **TargetType** parameters to +specify a user, security group, or computer for which to get the permission level. You can use the +**All** parameter to get the permission level for each security principal that includes: user, +security group, or computer. This only works for a user, security group, or computer that has +permissions on the GPO. You can specify the GPO by its display name or by its GUID. ## EXAMPLES ### Example 1: Get the permission level for group on the specified GPO + ```powershell -Get-GPPermission -Name "TestGpo" -TargetName "Domain Users" -TargetType Group -Trustee : Domain Users +Get-GPPermission -Name "TestGpo" -TargetName "Domain Users" -TargetType Group +``` +```Output +Trustee : Domain Users TrusteeType : Group - PermissionLevel : GpoRead - Inherited : False ``` This command gets the permission level for the Domain Users group on the GPO named TestGpo. ### Example 2: Get the permission level for group on the specified GPO with the specified GUID + ```powershell -Get-GPPermission -Domain "Sales.Contoso.com" -Server "DC1" -GUID fa4a9473-6e2a-4b87-ab78-175e68d97bde -TargetName "Domain Admins" -TargetType Group +$params = @{ + Domain = 'Sales.Contoso.com' + Server = 'DC1' + GUID = 'fa4a9473-6e2a-4b87-ab78-175e68d97bde' + TargetName = 'Domain Admins' + TargetType = 'Group' +} +Get-GPPermission @params ``` -This command gets the permission level for the Domain Admins group on the GPO with the GUID fa4a9473-6e2a-4b78-175e68d97bde in the Sales.Contoso.com domain. -The DC1.sales.contoso.com domain controller is contacted to complete the operation. +This command gets the permission level for the Domain Admins group on the GPO with the GUID +`fa4a9473-6e2a-4b78-175e68d97bde` in the `Sales.Contoso.com` domain. The `DC1.sales.contoso.com` +domain controller is contacted to complete the operation. -If the domain of the user that is running the session (or, for startup and shutdown scripts, the computer) is different from the sales.contoso.com domain, a trust must exist between the two domains, or the command fails. +If the domain of the user that is running the session (or, for startup and shutdown scripts, the +computer) is different from the sales.contoso.com domain, a trust must exist between the two +domains, or the command fails. ### Example 3: Get the permission level for all security principals on the specified GPO + ```powershell Get-GPPermission -Name "TestGPO" -All +``` +```Output Trustee : Authenticated Users TrusteeType : WellKnownGroup Permission : GpoApply @@ -90,12 +110,26 @@ Permission : GpoEditDeleteModifySecurity Inherited : False ``` -This command gets the permission level for each security principal that has permissions on the GPO named TestGPO. +This command gets the permission level for each security principal that has permissions on the GPO +named TestGPO. ### Example 4: Get the display name of each GPO for a specific permissions + ```powershell -Get-GPO -All | foreach-object { if($_ | Get-GPPermission -TargetName "contoso\Domain Admins" -TargetType Group -ErrorAction SilentlyContinue) {$_.DisplayName}} +Get-GPO -All | ForEach-Object { + if ( $_ | + $params = @{ + TargetName = 'contoso\Domain Admins' + TargetType = 'Group' + ErrorAction = 'SilentlyContinue' + } + Get-GPPermission @params) { + $_.DisplayName + } + } +``` +```Output Default Domain Policy TestGPO-1 TestGPO-2 Default Domain Controllers Policy @@ -103,23 +137,26 @@ Internet Security TestGPO ``` -This command lists the display name of each GPO (in the domain) on which the specified security principal has permissions. +This command lists the display name of each GPO (in the domain) on which the specified security +principal has permissions. -First, Get-GPO is used to retrieve all the GPOs in the domain (Get-GPO -All). -Then, the collection is piped into the foreach-object command. -As each GPO is evaluated, it is piped into Get-GPPermissions. -If a permission level is returned, the DisplayName property of the GPO is printed ($_.DisplayName). +First, **Get-GPO** is used to retrieve all the GPOs in the domain (**Get-GPO -All**). Then, the +collection is piped into the foreach-object command. As each GPO is evaluated, it is piped into +**Get-GPPermissions**. If a permission level is returned, the DisplayName property of the GPO is +printed ($_.DisplayName). -Note: The ErrorAction parameter is set to SilentlyContinue for Get-GPPermissions. -This is because a non-terminating error occurs if the specified security principal does not have permissions on the GPO. -Specifying the ErrorAction as SilentlyContinue prevents the error messages from being printed for GPOS on which the security principal does not have permissions. -For more information about the ErrorAction parameter, see about_CommonParameters. +Note: The ErrorAction parameter is set to SilentlyContinue for Get-GPPermissions. This is because a +non-terminating error occurs if the specified security principal does not have permissions on the +GPO. Specifying the ErrorAction as SilentlyContinue prevents the error messages from being printed +for GPOS on which the security principal does not have permissions. For more information about the +ErrorAction parameter, see about_CommonParameters. ## PARAMETERS ### -All -Indicates that the cmdlet gets the permission level for each user, group, or computer that has permissions on the GPO. +Indicates that the cmdlet gets the permission level for each user, group, or computer that has +permissions on the GPO. ```yaml Type: System.Management.Automation.SwitchParameter @@ -134,19 +171,23 @@ Accept wildcard characters: False ``` ### -DomainName + Specifies the domain for this cmdlet. You must specify the fully qualified domain name (FQDN) of the domain. -For the **Get-GPPermission** cmdlet, the GPO for which to get the permission level must exist in this domain. +For the **Get-GPPermission** cmdlet, the GPO for which to get the permission level must exist in +this domain. -If you do not specify the **Domain** parameter, the domain of the user that is running the current session is used. -If the cmdlet is being run from a computer startup or shutdown script, the domain of the computer is used. -For more information, see the Notes section in the full Help. +If you do not specify the **Domain** parameter, the domain of the user that is running the current +session is used. If the cmdlet is being run from a computer startup or shutdown script, the domain +of the computer is used. For more information, see the Notes section in the full Help. -If you specify a domain that is different from the domain of the user that is running the current session (or, for a startup or shutdown script, the computer), a trust must exist between that domain and the domain of the user or the computer. +If you specify a domain that is different from the domain of the user that is running the current +session (or, for a startup or shutdown script, the computer), a trust must exist between that domain +and the domain of the user or the computer. -You can also refer to the *Server* parameter by its built-in alias, domain. -For more information, see [about_Aliases](????????????). +You can also refer to the **Server** parameter by its built-in alias, domain. For more information, +see [about_Aliases](/powershell/module/microsoft.powershell.core/about/about_aliases). ```yaml Type: System.String @@ -162,11 +203,11 @@ Accept wildcard characters: False ### -Guid -Specifies the GPO from which to retrieve the permission level by its globally unique identifier (GUID). -The GUID uniquely identifies the GPO. +Specifies the GPO from which to retrieve the permission level by its globally unique identifier +(GUID). The GUID uniquely identifies the GPO. -You can also refer to the **Guid** parameter by its built-in alias, **Id**. -For more information, see [about_Aliases](????????). +You can also refer to the **Guid** parameter by its built-in alias, **Id**. For more information, +see [about_Aliases](/powershell/module/microsoft.powershell.core/about/about_aliases). ```yaml Type: Guid @@ -181,14 +222,15 @@ Accept wildcard characters: False ``` ### -Name + Specifies the GPO from which to retrieve the permission level by its display name. -The display name is not guaranteed to be unique in the domain. -If another GPO with the same display name exists in the domain an error occurs. -You can use the **Guid** parameter to uniquely identify a GPO. +The display name is not guaranteed to be unique in the domain. If another GPO with the same display +name exists in the domain an error occurs. You can use the **Guid** parameter to uniquely identify a +GPO. -You can also refer to the **Name** parameter by its built-in alias, **DisplayName**. -For more information, see [about_Aliases](????????). +You can also refer to the **Name** parameter by its built-in alias, **DisplayName**. For more +information, see [about_Aliases](/powershell/module/microsoft.powershell.core/about/about_aliases). ```yaml Type: System.String @@ -204,13 +246,13 @@ Accept wildcard characters: False ### -Server -Specifies the name of the domain controller that this cmdlet contacts to complete the operation. -You can specify either the fully qualified domain name (FQDN) or the host name. +Specifies the name of the domain controller that this cmdlet contacts to complete the operation. You +can specify either the fully qualified domain name (FQDN) or the host name. If you do not specify the name by using the **Server** parameter, the PDC emulator is contacted. -You can also refer to the *Server* parameter by its built-in alias, **DC**. -For more information, see [about_Aliases](????????). +You can also refer to the **Server** parameter by its built-in alias, **DC**. For more information, +see [about_Aliases](/powershell/module/microsoft.powershell.core/about/about_aliases). ```yaml Type: System.String @@ -225,17 +267,18 @@ Accept wildcard characters: False ``` ### -TargetName -Specifies the name of the security principal for which to get the permission level. -You can specify a user, a security group, or a computer. -You can use either the domain-qualified name of the security principal (domain\account) or just its name. -For instance, in the contoso.com domain, to specify: +Specifies the name of the security principal for which to get the permission level. You can specify +a user, a security group, or a computer. You can use either the domain-qualified name of the +security principal (domain\account) or just its name. + +For instance, in the `contoso.com` domain, to specify: -- The user "someuser", use "contoso\someuser" or "someuser". +- The user `someuser`, use `contoso\someuser` or `someuser`. -- The Domain Admins security group, use "contoso\Domain Admins" or "Domain Admins". +- The Domain Admins security group, use `contoso\Domain Admins` or `Domain Admins`. -- The computer "computer-01", use "contoso\computer-01" or "computer-01". +- The computer `computer-01`, use `contoso\computer-01` or `computer-01`. ```yaml Type: System.String @@ -250,6 +293,7 @@ Accept wildcard characters: False ``` ### -TargetType + The type of security principal for which to get the permission level. The acceptable values for this parameter are: @@ -275,30 +319,38 @@ Accept wildcard characters: False ### CommonParameters -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). +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). ## INPUTS ### Microsoft.GroupPolicy.Gpo -You can pipe a GPO to this cmdlet for which to get the permission level. -Collections that contain GPOs from different domains are not supported. + +You can pipe a GPO to this cmdlet for which to get the permission level. Collections that contain +GPOs from different domains are not supported. ## OUTPUTS -### -This cmdlet returns an object that represents permissions for the specified security principal (user, group, or computer) on the GPO. +### + +This cmdlet returns an object that represents permissions for the specified security principal +(user, group, or computer) on the GPO. ## NOTES * You can use the *DomainName* parameter to explicitly specify the domain for this cmdlet. - If you do not explicitly specify the domain, the cmdlet uses the default domain. -The default domain is the domain that is used to access network resources by the security context under which the current session is running. -This domain is typically the domain of the user that is running the session. -For example, the domain of the user who started the session by opening Windows PowerShell or the domain of a user that is specified in a runas command. -However, computer startup and shutdown scripts run under the context of the LocalSystem account. -The LocalSystem account is a built-in local account, and it accesses network resources under the context of the computer account. -Therefore, when this cmdlet is run from a startup or shutdown script, the default domain is the domain to which the computer is joined. + If you do not explicitly specify the domain, the cmdlet uses the default domain. The default + domain is the domain that is used to access network resources by the security context under which + the current session is running. This domain is typically the domain of the user that is running + the session. For example, the domain of the user who started the session by opening Windows + PowerShell or the domain of a user that is specified in a runas command. However, computer startup + and shutdown scripts run under the context of the LocalSystem account. The LocalSystem account is + a built-in local account, and it accesses network resources under the context of the computer + account. Therefore, when this cmdlet is run from a startup or shutdown script, the default domain + is the domain to which the computer is joined. ## RELATED LINKS diff --git a/docset/winserver2022-ps/grouppolicy/Get-GPPrefRegistryValue.md b/docset/winserver2022-ps/grouppolicy/Get-GPPrefRegistryValue.md index 083b9cc04d..1bc3495d84 100644 --- a/docset/winserver2022-ps/grouppolicy/Get-GPPrefRegistryValue.md +++ b/docset/winserver2022-ps/grouppolicy/Get-GPPrefRegistryValue.md @@ -11,41 +11,63 @@ title: Get-GPPrefRegistryValue # Get-GPPrefRegistryValue ## SYNOPSIS -Gets one or more Registry preference items under either Computer Configuration or User Configuration in a GPO. + +Gets one or more Registry preference items under either Computer Configuration or User Configuration +in a GPO. ## SYNTAX ### GetByGUID (Default) + ``` -Get-GPPrefRegistryValue -Guid -Context -Key [-ValueName ] - [-Order ] [-Domain ] [-Server ] [] +Get-GPPrefRegistryValue -Guid -Context -Key + [-ValueName ] [-Order ] [-Domain ] [-Server ] [] ``` ### GetByName + ``` -Get-GPPrefRegistryValue [-Name] -Context -Key [-ValueName ] - [-Order ] [-Domain ] [-Server ] [] +Get-GPPrefRegistryValue [-Name] -Context -Key + [-ValueName ] [-Order ] [-Domain ] [-Server ] [] ``` ## DESCRIPTION -The **Get-GPPrefRegistryValue** cmdlet gets one or more Registry preference items under either Computer Configuration or User Configuration in a Group Policy Object (GPO). -You must specify the *Context* parameter, for the user or computer, to indicate whether to get the Registry preference item from Computer Configuration or User Configuration. -You can specify the GPO by its display name or by its GUID. -You can get Registry preference items for a specific registry value, or for a key and any of its first-level registry values: +The **Get-GPPrefRegistryValue** cmdlet gets one or more Registry preference items under either +Computer Configuration or User Configuration in a Group Policy Object (GPO). You must specify the +*Context* parameter, for the user or computer, to indicate whether to get the Registry preference +item from Computer Configuration or User Configuration. You can specify the GPO by its display name +or by its GUID. -- To get any Registry preference items that configure a specific registry value, specify both the *Key* and the *ValueName* parameters. +You can get Registry preference items for a specific registry value, or for a key and any of its +first-level registry values: -- To get all the Registry preference items that configure a registry key and any first-level registry values directly under the key, specify the *Key* parameter without the *ValueName* parameter. +- To get any Registry preference items that configure a specific registry value, specify both the + **Key** and the *ValueName* parameters. -If you specify only a key, the cmdlet also returns its first-level subkeys for which there are Registry preference items that configure the subkey, its values, or any of its subkeys or their values. -You can use this information to browse for Registry preference items. +- To get all the Registry preference items that configure a registry key and any first-level + registry values directly under the key, specify the **Key** parameter without the *ValueName* + parameter. + +If you specify only a key, the cmdlet also returns its first-level subkeys for which there are +Registry preference items that configure the subkey, its values, or any of its subkeys or their +values. You can use this information to browse for Registry preference items. ## EXAMPLES ### Example 1: Get the Registry preference item value + ```powershell -Get-GPPrefRegistryValue -Name "TestGPO" -Context User -Key "HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\ExampleKey" -ValueName "ValueOne" +$params = @{ + ValueName = 'ValueOne' + Context = 'User' + Key = 'HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\ExampleKey' + Name = 'TestGPO' +} +Get-GPPrefRegistryValue @params +``` + +```Output KeyPath : SOFTWARE\Microsoft\ExampleKey FullKeyPath : HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\ExampleKey Hive : LocalMachine @@ -59,11 +81,22 @@ ValueName : ValueOne HasValue : True ``` -This command gets the Registry preference item that is configured for the registry value HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\ExampleKey with value name ValueOne from User Configuration in the GPO named TestGPO. +This command gets the Registry preference item that is configured for the registry value +`HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\ExampleKey` with value name ValueOne from User Configuration +in the GPO named `TestGPO`. ### Example 2: Get all Registry preference items + ```powershell -Get-GPPrefRegistryValue -Name "TestGPO" -Context User -Key "HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\ExampleKey" +$params = @{ + Context = 'User' + Key = 'HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\ExampleKey' + Name = 'TestGPO' +} +Get-GPPrefRegistryValue @params +``` + +```Output KeyPath : SOFTWARE\Microsoft\ExampleKey FullKeyPath : HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\ExampleKey Hive : LocalMachine @@ -99,16 +132,20 @@ FullKeyPath : HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\ExampleKey\SubKey2 Hive : LocalMachine ``` -This command gets all the Registry preference items that are configured for the registry key HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\ExampleKey and any of its first-level values from User Configuration in the GPO named TestGPO. +This command gets all the Registry preference items that are configured for the registry key +HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\ExampleKey and any of its first-level values from User +Configuration in the GPO named TestGPO. -In this example, Registry preference items that configure the following two first-level values of the registry key are returned: ValueOne and ValueTwo. -Two subkeys of the key are also returned. -This is because there are Registry preference items in User Configuration associated with each subkey. +In this example, Registry preference items that configure the following two first-level values of +the registry key are returned: ValueOne and ValueTwo. Two subkeys of the key are also returned. This +is because there are Registry preference items in User Configuration associated with each subkey. ## PARAMETERS ### -Context -Specifies whether the cmdlet gets the Registry preference item from User Configuration or Computer Configuration in the GPO. + +Specifies whether the cmdlet gets the Registry preference item from User Configuration or Computer +Configuration in the GPO. The acceptable values for this parameter are: User or Computer. @@ -127,19 +164,22 @@ Accept wildcard characters: False ### -Domain -Specifies the domain for this cmdlet. -You must specify the fully qualified domain name (FQDN) of the domain. +Specifies the domain for this cmdlet. You must specify the fully qualified domain name (FQDN) of the +domain. -For the **Get-GPPrefRegistryValue** cmdlet, the GPO for which to get the Registry preference item must exist in this domain. +For the **Get-GPPrefRegistryValue** cmdlet, the GPO for which to get the Registry preference item +must exist in this domain. -If you do not specify the **Domain** parameter, the domain of the user that is running the current session is used. -If the cmdlet is being run from a computer startup or shutdown script, the domain of the computer is used. -For more information, see the Notes section in the full Help. +If you do not specify the **Domain** parameter, the domain of the user that is running the current +session is used. If the cmdlet is being run from a computer startup or shutdown script, the domain +of the computer is used. For more information, see the Notes section in the full Help. -If you specify a domain that is different from the domain of the user that is running the current session (or, for a startup or shutdown script, the computer), a trust must exist between that domain and the domain of the user or the computer. +If you specify a domain that is different from the domain of the user that is running the current +session (or, for a startup or shutdown script, the computer), a trust must exist between that domain +and the domain of the user or the computer. -You can also refer to the **Domain** parameter by its built-in alias, **DomainName**. -For more information, see [about_Aliases](????????????)s](????????????). +You can also refer to the **Domain** parameter by its built-in alias, **DomainName**. For more +information, see [about_Aliases](/powershell/module/microsoft.powershell.core/about/about_aliases). ```yaml Type: System.String @@ -155,11 +195,11 @@ Accept wildcard characters: False ### -Guid -Specifies the GPO from which this cmdlet gets the Registry preference item by its globally unique identifier (GUID). -The GUID uniquely identifies the GPO. +Specifies the GPO from which this cmdlet gets the Registry preference item by its globally unique +identifier (GUID). The GUID uniquely identifies the GPO. -You can also refer to the **Guid** parameter by its built-in alias, **Id**. -For more information, see [about_Aliases](????????). +You can also refer to the **Guid** parameter by its built-in alias, **Id**. For more information, +see [about_Aliases](/powershell/module/microsoft.powershell.core/about/about_aliases). ```yaml Type: Guid @@ -174,7 +214,9 @@ Accept wildcard characters: False ``` ### -Key -Specifies the registry key for the Registry preference item that this cmdlet gets; for instance: HKEY_CURRENT_USER\Control Panel\Colors. + +Specifies the registry key for the Registry preference item that this cmdlet gets; for instance: +`HKEY_CURRENT_USER\Control Panel\Colors`. The acceptable values for this parameter are: @@ -184,16 +226,19 @@ The acceptable values for this parameter are: - HKEY_USERS (HKU) - HKEY_CURRENT_CONFIG (HKCC) -Any of these hives can be specified for Registry preference items in both Computer Configuration and User Configuration. +Any of these hives can be specified for Registry preference items in both Computer Configuration and +User Configuration. -The *Key* parameter can be specified with or without the *ValueName* parameter: +The **Key** parameter can be specified with or without the *ValueName* parameter: -- If the *ValueName* parameter is specified, all Registry preference items that configure the registry value are retrieved. +- If the **ValueName** parameter is specified, all Registry preference items that configure the + registry value are retrieved. -- If the *ValueName* parameter is not specified, all Registry preference items that configure the registry key and any of its first-level values are retrieved. +- If the **ValueName** parameter is not specified, all Registry preference items that configure the + registry key and any of its first-level values are retrieved. -You can also refer to the Key parameter by its built-in alias, FullKeyPath. -For more information, see [about_Aliases](????????). +You can also refer to the Key parameter by its built-in alias, FullKeyPath. For more information, +see [about_Aliases](/powershell/module/microsoft.powershell.core/about/about_aliases). ```yaml Type: System.String @@ -208,14 +253,15 @@ Accept wildcard characters: False ``` ### -Name + Specifies the GPO from which this cmdlet gets the Registry preference item by its display name. -The display name is not guaranteed to be unique in the domain. -If another GPO with the same display name exists in the domain an error occurs. -You can use the **Guid** parameter to uniquely identify a GPO. +The display name is not guaranteed to be unique in the domain. If another GPO with the same display +name exists in the domain an error occurs. You can use the **Guid** parameter to uniquely identify a +GPO. -You can also refer to the **Name** parameter by its built-in alias, **DisplayName**. -For more information, **see about_Aliases**. +You can also refer to the **Name** parameter by its built-in alias, **DisplayName**. For more +information, see [about_Aliases](/powershell/module/microsoft.powershell.core/about/about_aliases). ```yaml Type: System.String @@ -230,7 +276,9 @@ Accept wildcard characters: False ``` ### -Order -Specifies the order in which the Registry preference item is applied, relative to the other Registry preference items in the GPO, on a client. + +Specifies the order in which the Registry preference item is applied, relative to the other Registry +preference items in the GPO, on a client. ```yaml Type: Int32 @@ -246,13 +294,14 @@ Accept wildcard characters: False ### -Server -Specifies the name of the domain controller that this cmdlet contacts to complete the operation. -You can specify either the fully qualified domain name (FQDN) or the host name. +Specifies the name of the domain controller that this cmdlet contacts to complete the operation. You +can specify either the fully qualified domain name (FQDN) or the host name. -If you do not specify the name through the *Server* parameter, the primary domain controller (PDC) emulator is contacted. +If you do not specify the name through the **Server** parameter, the primary domain controller (PDC) +emulator is contacted. -You can also refer to the *Server* parameter by its built-in alias, **DC**. -For more information, see [about_Aliases](????????). +You can also refer to the **Server** parameter by its built-in alias, **DC**. For more information, +see [about_Aliases](/powershell/module/microsoft.powershell.core/about/about_aliases). ```yaml Type: System.String @@ -267,12 +316,15 @@ Accept wildcard characters: False ``` ### -ValueName -Specifies the name of a registry value for which this cmdlet gets all Registry preference items. -For instance, the registry key HKEY_CURRENT_USER\Control Panel\Colors can have a value with the following name: ActiveTitle. -For the default value of a registry key, specify either "(default)" or an empty string (""). -When you want to gets Registry preference items for a registry key and all its first-level values, do not specify this parameter. -When you want to get Registry preference items only for a specific registry value, specify this parameter together with the *Key* parameter. +Specifies the name of a registry value for which this cmdlet gets all Registry preference items. For +instance, the registry key `HKEY_CURRENT_USER\Control Panel\Colors` can have a value with the +following name: ActiveTitle. For the default value of a registry key, specify either "(default)" or +an empty string (""). + +When you want to gets Registry preference items for a registry key and all its first-level values, +do not specify this parameter. When you want to get Registry preference items only for a specific +registry value, specify this parameter together with the **Key** parameter. ```yaml Type: System.String @@ -288,19 +340,24 @@ Accept wildcard characters: False ### CommonParameters -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). +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). ## INPUTS ### Microsoft.GroupPolicy.Gpo -This cmdlet takes a GPO as input. -Collections that contain GPOs from different domains are not supported. + +This cmdlet takes a GPO as input. Collections that contain GPOs from different domains are not +supported. ## OUTPUTS ### Microsoft.GroupPolicy.PreferenceRegistrySetting -This cmdlet returns **PreferenceRegistrySetting** objects. -You can pipe these objects to the following cmdlets: + +This cmdlet returns **PreferenceRegistrySetting** objects. You can pipe these objects to the +following cmdlets: - Set-GPPrefRegistryValue @@ -308,17 +365,20 @@ You can pipe these objects to the following cmdlets: ## NOTES -* If a Registry preference item for the specified registry key or value is not found, a non-terminating error occurs. +* If a Registry preference item for the specified registry key or value is not found, a + non-terminating error occurs. You can use the **Domain** parameter to explicitly specify the domain for this cmdlet. - If you do not explicitly specify the domain, the cmdlet uses a default domain. -The default domain is the domain that is used to access network resources by the security context under which the current session is running. -This domain is typically the domain of the user that is running the session. -For instance, the domain of the user who started the session by opening Windows PowerShell or the domain of a user that is specified in a runas command. -However, computer startup and shutdown scripts run under the context of the LocalSystem account. -The LocalSystem account is a built-in local account, and it accesses network resources under the context of the computer account. -Therefore, when this cmdlet is run from a startup or shutdown script, the default domain is the domain to which the computer is joined. + If you do not explicitly specify the domain, the cmdlet uses a default domain. The default domain + is the domain that is used to access network resources by the security context under which the + current session is running. This domain is typically the domain of the user that is running the + session. For instance, the domain of the user who started the session by opening Windows + PowerShell or the domain of a user that is specified in a runas command. However, computer startup + and shutdown scripts run under the context of the LocalSystem account. The LocalSystem account is + a built-in local account, and it accesses network resources under the context of the computer + account. Therefore, when this cmdlet is run from a startup or shutdown script, the default domain + is the domain to which the computer is joined. ## RELATED LINKS diff --git a/docset/winserver2022-ps/grouppolicy/Get-GPRegistryValue.md b/docset/winserver2022-ps/grouppolicy/Get-GPRegistryValue.md index edbe15752c..500fdf23c7 100644 --- a/docset/winserver2022-ps/grouppolicy/Get-GPRegistryValue.md +++ b/docset/winserver2022-ps/grouppolicy/Get-GPRegistryValue.md @@ -12,44 +12,63 @@ title: Get-GPRegistryValue ## SYNOPSIS -Gets one or more registry-based policy settings under either Computer Configuration or User Configuration in a GPO. +Gets one or more registry-based policy settings under either Computer Configuration or User +Configuration in a GPO. ## SYNTAX ### GetByGUID (Default) + ``` -Get-GPRegistryValue -Guid -Key [-ValueName ] [-Domain ] [-Server ] - [] +Get-GPRegistryValue -Guid -Key [-ValueName ] [-Domain ] + [-Server ] [] ``` ### GetByName + ``` -Get-GPRegistryValue [-Name] -Key [-ValueName ] [-Domain ] [-Server ] - [] +Get-GPRegistryValue [-Name] -Key [-ValueName ] [-Domain ] + [-Server ] [] ``` ## DESCRIPTION -The **Get-GPRegistryValue** cmdlet retrieves one or more registry-based policy settings under either Computer Configuration or User Configuration in a Group Policy Object (GPO). -You can get registry-based policy settings for a specific registry value, or for all the registry values under a key: +The **Get-GPRegistryValue** cmdlet retrieves one or more registry-based policy settings under either +Computer Configuration or User Configuration in a Group Policy Object (GPO). -- To get the registry-based policy setting that configures a specific registry value, specify both the *Key* and the *ValueName* parameters. +You can get registry-based policy settings for a specific registry value, or for all the registry +values under a key: -- To get all the registry-based policy settings that configure values directly under a registry key, specify the *Key* parameter without the *ValueName* parameter. +- To get the registry-based policy setting that configures a specific registry value, specify both + the **Key** and the **ValueName** parameters. -If you specify only a key, in addition to the policy settings that configure values under the key, the following first-level subkeys of the key are returned: +- To get all the registry-based policy settings that configure values directly under a registry key, + specify the **Key** parameter without the **ValueName** parameter. + +If you specify only a key, in addition to the policy settings that configure values under the key, +the following first-level subkeys of the key are returned: - first-level subkeys that have a policy setting that configures a value. -- first-level subkeys that have a subkey, at any level, with a policy setting that configures a value. +- first-level subkeys that have a subkey, at any level, with a policy setting that configures a + value. You can use this information to browse for registry-based policy settings. ## EXAMPLES ### Example 1: Get the group policy registry value from the specified key + ```powershell -Get-GPRegistryValue -Name TestGPO -Key "HKEY_CURRENT_USER\Software\Policies\Microsoft\ExampleKey" -ValueName "ValueOne" +$params = @{ + ValueName = 'ValueOne' + Key = 'HKEY_CURRENT_USER\Software\Policies\Microsoft\ExampleKey' + Name = 'TestGPO' +} +Get-GPRegistryValue @params +``` + +```Output KeyPath : Software\Policies\Microsoft\ExampleKey FullKeyPath : HKEY_CURRENT_USER\Software\Policies\Microsoft\ExampleKey Hive : CurrentUser @@ -60,11 +79,17 @@ ValueName : ValueOne HasValue : True ``` -This command gets the registry-based policy setting that configures the registry value HKEY_CURRENT_USER\Software\Policies\Microsoft\ExampleKey:ValueOne from User Configuration in the GPO named TestGPO. +This command gets the registry-based policy setting that configures the registry value +`HKEY_CURRENT_USER\Software\Policies\Microsoft\ExampleKey:ValueOne` from User Configuration in the +GPO named TestGPO. ### Example 2: Get all group policy registry values from the specified key + ```powershell -Get-GPRegistryValue -Name "TestGPO" -Key "HKCU\Software\Policies\Microsoft\ExampleKey" +Get-GPRegistryValue -Name "TestGPO" -Key "HKCU\Software\Policies\Microsoft\ExampleKey" +``` + +```Output KeyPath : Software\Policies\Microsoft\ExampleKey FullKeyPath : HKEY_CURRENT_USER\Software\Policies\Microsoft\ExampleKey Hive : CurrentUser @@ -93,27 +118,32 @@ FullKeyPath : HKEY_CURRENT_USER\Software\Policies\Microsoft\ExampleKey\SubKey2 Hive : CurrentUser ``` -This command gets all the registry-based policy settings that configure registry values under the key HKEY_CURRENT_USER\Software\Policies\Microsoft\ExampleKey from User Configuration in the GPO named TestGPO. -Subkeys of this key that have registry-based policy settings, are also returned. -The second registry-based policy setting (ValueTwo) is disabled (its **PolicyState** property is set to Delete). +This command gets all the registry-based policy settings that configure registry values under the +key `HKEY_CURRENT_USER\Software\Policies\Microsoft\ExampleKey` from User Configuration in the GPO +named `TestGPO`. Subkeys of this key that have registry-based policy settings, are also returned. +The second registry-based policy setting (ValueTwo) is disabled (its **PolicyState** property is set +to Delete). ## PARAMETERS ### -Domain -Specifies the domain for this cmdlet. -You must specify the fully qualified domain name (FQDN) of the domain (for instance: sales.contoso.com). +Specifies the domain for this cmdlet. You must specify the fully qualified domain name (FQDN) of the +domain (for instance: sales.contoso.com). -For the **Get-GPRegistryValue** cmdlet, the GPO for which to get registry-based policy settings must exist in this domain. +For the **Get-GPRegistryValue** cmdlet, the GPO for which to get registry-based policy settings must +exist in this domain. -If you do not specify the **Domain** parameter, the domain of the user that is running the current session is used. -If the cmdlet is being run from a computer startup or shutdown script, the domain of the computer is used. -For more information, see the Notes section in the full Help. +If you do not specify the **Domain** parameter, the domain of the user that is running the current +session is used. If the cmdlet is being run from a computer startup or shutdown script, the domain +of the computer is used. For more information, see the Notes section in the full Help. -If you specify a domain that is different from the domain of the user that is running the current session (or, for a startup or shutdown script, the computer), a trust must exist between that domain and the domain of the user or the computer. +If you specify a domain that is different from the domain of the user that is running the current +session (or, for a startup or shutdown script, the computer), a trust must exist between that domain +and the domain of the user or the computer. -You can also refer to Domain by its built-in alias, **DomainName**. -For more information, see [about_Aliases](????????????). +You can also refer to Domain by its built-in alias, **DomainName**. For more information, see +[about_Aliases](/powershell/module/microsoft.powershell.core/about/about_aliases). ```yaml Type: System.String @@ -129,11 +159,11 @@ Accept wildcard characters: False ### -Guid -Specifies the GPO from which to retrieve the registry-based policy setting by its globally unique identifier (GUID). -The GUID uniquely identifies the GPO. +Specifies the GPO from which to retrieve the registry-based policy setting by its globally unique +identifier (GUID). The GUID uniquely identifies the GPO. -You can also refer to the **Guid** parameter by its built-in alias, **Id**. -For more information, see [about_Aliases](????????). +You can also refer to the **Guid** parameter by its built-in alias, **Id**. For more information, +see [about_Aliases](/powershell/module/microsoft.powershell.core/about/about_aliases). ```yaml Type: Guid @@ -148,8 +178,9 @@ Accept wildcard characters: False ``` ### -Key -Specifies the registry key for which this cmdlet gets the registry-based policy setting. -For instance: HKLM\Software\Policies\Microsoft\Windows NT\DNSClient. + +Specifies the registry key for which this cmdlet gets the registry-based policy setting. For +instance: `HKLM\Software\Policies\Microsoft\Windows NT\DNSClient`. The key must be in one of the two following registry hives: @@ -159,12 +190,14 @@ The key must be in one of the two following registry hives: You can specify: -- The *Key* parameter without the *ValueName* parameter to get all the registry-based policy settings that configure values directly under that key. +- The **Key** parameter without the **ValueName** parameter to get all the registry-based policy + settings that configure values directly under that key. -- The Key parameter together with the *ValueName* parameter to get the registry-based policy setting that configures a specific registry value. +- The Key parameter together with the **ValueName** parameter to get the registry-based policy + setting that configures a specific registry value. -You can also refer to the *Key* parameter by its built-in alias FullKeyPath. -For more information, see [about_Aliases](????????). +You can also refer to the **Key** parameter by its built-in alias FullKeyPath. For more information, +see [about_Aliases](/powershell/module/microsoft.powershell.core/about/about_aliases). ```yaml Type: System.String @@ -179,14 +212,15 @@ Accept wildcard characters: False ``` ### -Name + Specifies the GPO from which this cmdlet gets the registry-based policy setting by its display name. -The display name is not guaranteed to be unique in the domain. -If another GPO with the same display name exists in the domain an error occurs. -You can use the **Guid** parameter to uniquely identify a GPO. +The display name is not guaranteed to be unique in the domain. If another GPO with the same display +name exists in the domain an error occurs. You can use the **Guid** parameter to uniquely identify a +GPO. -You can also refer to the **Name** parameter by its built-in alias, **DisplayName**. -For more information, see [about_Aliases](????????). +You can also refer to the **Name** parameter by its built-in alias, **DisplayName**. For more +information, see [about_Aliases](/powershell/module/microsoft.powershell.core/about/about_aliases). ```yaml Type: System.String @@ -202,10 +236,11 @@ Accept wildcard characters: False ### -Server -Specifies the name of the domain controller that this cmdlet contacts to complete the operation. -You can specify either the fully qualified domain name (FQDN) or the host name. +Specifies the name of the domain controller that this cmdlet contacts to complete the operation. You +can specify either the fully qualified domain name (FQDN) or the host name. -If you do not specify the name by using the **Server** parameter, the primary domain controller (PDC) emulator is contacted. +If you do not specify the name by using the **Server** parameter, the primary domain controller +(PDC) emulator is contacted. ```yaml Type: System.String @@ -220,11 +255,13 @@ Accept wildcard characters: False ``` ### -ValueName + Specifies the name of a registry value for which this cmdlet gets the registry-based policy setting. -For instance, the registry key HKLM\Software\Policies\Microsoft\Windows NT\DNSClient can have a value with the following name: UseDomainNameDevolution. -For the default value of a registry key, specify "(default)" or an empty string (""). +For instance, the registry key `HKLM\Software\Policies\Microsoft\Windows NT\DNSClient` can have a +value with the following name: UseDomainNameDevolution. For the default value of a registry key, +specify "(default)" or an empty string (""). -You must also specify the *Key* parameter with this parameter. +You must also specify the **Key** parameter with this parameter. ```yaml Type: System.String @@ -240,17 +277,22 @@ Accept wildcard characters: False ### CommonParameters -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). +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). ## INPUTS ### Microsoft.GroupPolicy.Gpo -You can pipe a GPO for which this cmdlet gets registry-based policy settings. -Collections that contain GPOs from different domains are not supported. + +You can pipe a GPO for which this cmdlet gets registry-based policy settings. Collections that +contain GPOs from different domains are not supported. ## OUTPUTS ### Microsoft.GroupPolicy.PolicyRegistrySetting + This cmdlet returns **PolicyRegistrySetting** objects that represent registry-based policy settings. These objects can be piped into the following cmdlets: @@ -260,19 +302,23 @@ These objects can be piped into the following cmdlets: ## NOTES -* The hive of the registry key that you specify (HKLM or HKCU) indicates whether the registry-based policy setting is retrieved from Computer Configuration or User Configuration. +* The hive of the registry key that you specify (HKLM or HKCU) indicates whether the registry-based + policy setting is retrieved from Computer Configuration or User Configuration. - If the specified registry key cannot be located in policy (the registry key is not configured), a corresponding error message is displayed. + If the specified registry key cannot be located in policy (the registry key is not configured), a + corresponding error message is displayed. You can use the **Domain** parameter to explicitly specify the domain for this cmdlet. - If you do not explicitly specify the domain, the cmdlet uses a default domain. -The default domain is the domain that is used to access network resources by the security context under which the current session is running. -This domain is typically the domain of the user that is running the session. -For instance, the domain of the user who started the session by opening Windows PowerShell or the domain of a user that is specified in a runas command. -However, computer startup and shutdown scripts run under the context of the LocalSystem account. -The LocalSystem account is a built-in local account, and it accesses network resources under the context of the computer account. -Therefore, when this cmdlet is run from a startup or shutdown script, the default domain is the domain to which the computer is joined. + If you do not explicitly specify the domain, the cmdlet uses a default domain. The default domain + is the domain that is used to access network resources by the security context under which the + current session is running. This domain is typically the domain of the user that is running the + session. For instance, the domain of the user who started the session by opening Windows + PowerShell or the domain of a user that is specified in a runas command. However, computer startup + and shutdown scripts run under the context of the LocalSystem account. The LocalSystem account is + a built-in local account, and it accesses network resources under the context of the computer + account. Therefore, when this cmdlet is run from a startup or shutdown script, the default domain + is the domain to which the computer is joined. ## RELATED LINKS diff --git a/docset/winserver2022-ps/grouppolicy/Get-GPResultantSetOfPolicy.md b/docset/winserver2022-ps/grouppolicy/Get-GPResultantSetOfPolicy.md index 62d8618523..ef249a6efb 100644 --- a/docset/winserver2022-ps/grouppolicy/Get-GPResultantSetOfPolicy.md +++ b/docset/winserver2022-ps/grouppolicy/Get-GPResultantSetOfPolicy.md @@ -17,18 +17,24 @@ Gets and writes the RSoP information for a user, a computer, or both to a file. ## SYNTAX ``` -Get-GPResultantSetOfPolicy [-Computer ] [-User ] -ReportType -Path - [] +Get-GPResultantSetOfPolicy [-Computer ] [-User ] -ReportType + -Path [] ``` ## DESCRIPTION -The **Get-GPResultantSetOfPolicy** cmdlet gets and writes the Resultant Set of Policy (RSoP) information for a user, a computer, or both to a file. + +The **Get-GPResultantSetOfPolicy** cmdlet gets and writes the Resultant Set of Policy (RSoP) +information for a user, a computer, or both to a file. ## EXAMPLES ### Example 1: Generate a report for the default user that is running on the current session + ```powershell Get-GPResultantSetOfPolicy -ReportType Xml -Path "c:\reports\LocalUserAndComputerReport.xml" +``` + +```Output RsopMode : Logging Namespace : \\COMPUTER-02-PC\Root\Rsop\NS2BBE3F29_794F_4EAE_B9DB_0A2310622534 LoggingComputer : COMPUTER-02 @@ -36,12 +42,21 @@ LoggingUser : CONTOSO\someuser LoggingMode : UserAndComputer ``` -This command generates a report for the default user that is running on the current session. -The report is generated in XML format, and is written to the specified file. +This command generates a report for the default user that is running on the current session. The +report is generated in XML format, and is written to the specified file. ### Example 2: Generate a report for the specified computer + ```powershell -Get-GPResultantSetOfPolicy -ReportType Xml -Computer "computer-08.contso.com" -Path "c:\reports\computer-08.xml" +@params = @{ + ReportType = 'Xml' + Path = 'c:\reports\computer-08.xml' + Computer = 'computer-08.contso.com' +} +Get-GPResultantSetOfPolicy @params +``` + +```Output RsopMode : Logging Namespace : \\computer-08.contoso.com\Root\Rsop\NS643B2E66_8F54_4407_A813_7D47173B0922 LoggingComputer : computer-08.contoso.com @@ -49,13 +64,22 @@ LoggingUser : CONTOSO\Administrator LoggingMode : Computer ``` -This command generates a report for the specified computer. -The computer is specified by its fully qualified domain name (FQDN), computer-08.contoso.com. -The report is generated in XML format, and is written to the specified file. +This command generates a report for the specified computer. The computer is specified by its fully +qualified domain name (FQDN), `computer-08.contoso.com`. The report is generated in `XML` format, +and is written to the specified file. ### Example 3: Generate a report for the specified user in HTML format and save it to the specified file + ```powershell -Get-GPResultantSetOfPolicy -User "Contoso\PattiFul" -ReportType Html -Path "c:\reports\UserReport.html" +@params = @{ + ReportType = 'HTML' + Path = 'c:\reports\UserReport.xml' + User = 'Contoso\PattiFul' +} +Get-GPResultantSetOfPolicy @params +``` + +```Output RsopMode : Logging Namespace : \\COMPUTER-02\Root\Rsop\NS78355E76_C754_41B5_8F5E_B61551837A62 LoggingComputer : COMPUTER-02 @@ -63,11 +87,22 @@ LoggingUser : contoso\someuser LoggingMode : User ``` -This command generates a report for the specified user (contoso\someuser) in HTML format and saves it to the specified file. +This command generates a report for the specified user `Contoso\PattiFul` in `HTML` format and saves +it to the specified file. ### Example 4: Generate a report for the specified computer and user in HTML format and save it to the specified file + ```powershell -Get-GPResultantSetOfPolicy -user someuser -computer contoso.com\computer-08 -reporttype html -path c:\reports\UserAndComputerReport.html +@params = @{ + ReportType = 'HTML' + Path = 'c:\reports\UserAndComputerReport.xml' + User = 'SomeUser' + Computer = 'contoso.com\computer-08' +} +Get-GPResultantSetOfPolicy @params +``` + +```Output RsopMode : Logging Namespace : \\computer-08\Root\Rsop\NS72116C25_6570_4586_9B79_FC4F71372E57 LoggingComputer : contoso.com\computer-08 @@ -75,13 +110,15 @@ LoggingUser : someuser LoggingMode : UserAndComputer ``` -This command generates a report for the specified computer (contoso.com\computer-08) and user (someuser) in HTML format and saves it to the specified file. +This command generates a report for the specified computer `contoso.com\computer-08` and user +`SomeUser` in `HTML` format and saves it to the specified file. ## PARAMETERS ### -Computer -Specifies the name of the computer for which to generate the report. -You can specify the computer name in one of the following formats: + +Specifies the name of the computer for which to generate the report. You can specify the computer +name in one of the following formats: - Full computer name (FQDN computer name); for example, computer-01.sales.contoso.com. @@ -105,10 +142,10 @@ Accept wildcard characters: False ### -Path -Specifies the path to the report file; for instance, c:\Reports\GpRsopReport.xml. +Specifies the path to the report file; for instance, `c:\Reports\GpRsopReport.xml`. -You can also refer to the **Path** parameter by its built-in alias, filepath. -For more information, see [about_Aliases](????????????). +You can also refer to the **Path** parameter by its built-in alias, **FilePath**. For more information, +see [about_Aliases](/powershell/module/microsoft.powershell.core/about/about_aliases). ```yaml Type: System.String @@ -124,11 +161,10 @@ Accept wildcard characters: False ### -ReportType -Specifies the format of the RSoP report. -You must specify either Html (for HTML format) or Xml (for XML format). -These values are not case sensitive. +Specifies the format of the RSoP report. You must specify either `Html` (for HTML format) or `Xml` +(for XML format). These values are not case sensitive. -The acceptable values for this parameter are: Html or Xml. +The acceptable values for this parameter are: `Html` or `Xml`. ```yaml Type: ReportType @@ -144,14 +180,15 @@ Accept wildcard characters: False ``` ### -User -Specifies the user name of the user for which to generate the report. -You can specify the user name in one of the following formats: -- Fully qualified domain name (FQDN)\user name; for instance, sales.contoso.com\someuser. +Specifies the user name of the user for which to generate the report. You can specify the user name +in one of the following formats: + +- Fully qualified domain name (FQDN)\user name; for instance, `sales.contoso.com\SomeUser`. -- NetBIOS domain name\user name; for example, sales\someuser. +- NetBIOS domain name\user name; for example, `sales\SomeUser`. -- User name: for example, someuser. +- User name: for example, `SomeUser`. ```yaml Type: System.String @@ -167,21 +204,27 @@ Accept wildcard characters: False ### CommonParameters -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). +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). ## INPUTS ### None + This cmdlet does not take any object as input. ## OUTPUTS ### Microsoft.GroupPolicy.GPRsop + This cmdlet returns an RSoP object. ## NOTES -* This cmdlet provides only the logging results for a specified computer and user. You must use the GPMC to generate RSoP modeling information. +* This cmdlet provides only the logging results for a specified computer and user. You must use the + GPMC to generate RSoP modeling information. ## RELATED LINKS diff --git a/docset/winserver2022-ps/grouppolicy/Get-GPStarterGPO.md b/docset/winserver2022-ps/grouppolicy/Get-GPStarterGPO.md index b0810a906d..f4841d8ac6 100644 --- a/docset/winserver2022-ps/grouppolicy/Get-GPStarterGPO.md +++ b/docset/winserver2022-ps/grouppolicy/Get-GPStarterGPO.md @@ -17,31 +17,41 @@ Gets one Starter GPO or all Starter GPOs in a domain. ## SYNTAX ### ByGUID (Default) + ``` Get-GPStarterGPO -Guid [-Domain ] [-Server ] [-All] [] ``` ### ByName + ``` Get-GPStarterGPO [-Name] [-Domain ] [-Server ] [-All] [] ``` ### GetAll + ``` Get-GPStarterGPO [-Domain ] [-Server ] [-All] [] ``` ## DESCRIPTION -The **Get-GPStarterGPO** cmdlet gets one Starter Group Policy Object (GPO) or all Starter GPOs in a domain. -You can specify the Starter GPO to get either by display name or by GUID, or you can specify the **All** parameter to get all the Starter GPOs in the domain. -You can use this cmdlet to get information about a StarterGPO, or you can create a new GPO from a specified Starter GPO by piping the output of this cmdlet into the **New-GPO** cmdlet. +The **Get-GPStarterGPO** cmdlet gets one Starter Group Policy Object (GPO) or all Starter GPOs in a +domain. You can specify the Starter GPO to get either by display name or by GUID, or you can specify +the **All** parameter to get all the Starter GPOs in the domain. + +You can use this cmdlet to get information about a StarterGPO, or you can create a new GPO from a +specified Starter GPO by piping the output of this cmdlet into the **New-GPO** cmdlet. ## EXAMPLES ### Example 1: Get a Starter GPO by name + ```powershell -Get-GPStarterGPO -Name "Windows Vista EC User" +Get-GPStarterGPO -Name "Windows Vista EC User" +``` + +```Output DisplayName : Windows Vista EC User Id : 8780588e-ef91-442b-bd5f-2d50de7abf76 Owner : BUILTIN\Administrators @@ -51,17 +61,26 @@ UserVersion : ComputerVersion : StarterGpoVersion : 0 StarterGpoType : System -Author : Microsoft -Description : This Starter GPO contains the user Group Policy settings recommended for the Enterprise Client (EC) environment described in the Windows Vista security guide. +Author : Microsoft + -For more information about each of these settings, see the [Windows Vista Security Guide](http://go. microsoft.com/fwlink/?LinkID=121852). +Description : This Starter GPO contains the user Group Policy settings recommended for the + Enterprise Client (EC) environment described in the Windows Vista security guide. + + For more information about each of these settings, see the + [Windows Vista Security Guide](http://go.microsoft.com/fwlink/?LinkID=121852). ``` -This command gets the Starter GPO named Windows Vista EC User. +This command gets the Starter GPO named `Windows Vista EC User`. ### Example 2: Get a Starter GPO by name using the pipeline operator + ```powershell -Get-GPStarterGPO -Name "Windows Vista EC User" | New-GPO -Name "TestGPO" -Comment "Create a GPO by using a Starter GPO" +Get-GPStarterGPO -Name "Windows Vista EC User" | + New-GPO -Name "TestGPO" -Comment "Create a GPO by using a Starter GPO" +``` + +```Output DisplayName : TestGPO DomainName : contoso.com Owner : CONTOSO\Domain Admins @@ -75,12 +94,14 @@ ComputerVersion : AD Version: 1, SysVol Version: 1 WmiFilter : ``` -This command creates a GPO named TestGPO from the GPO named Windows Vista EC User Starter. -The command uses the **Get-SPStarterGPO** cmdlet to get the Starter GPO and is then piped into the **New-GPO** cmdlet to create the GPO. +This command creates a GPO named `TestGPO` from the GPO named `Windows Vista EC User` Starter. The +command uses the **Get-SPStarterGPO** cmdlet to get the Starter GPO and is then piped into the +**New-GPO** cmdlet to create the GPO. ## PARAMETERS ### -All + Returns all the Starter GPOs in the domain. ```yaml @@ -97,19 +118,21 @@ Accept wildcard characters: False ### -Domain -Specifies the domain for this cmdlet. -You must specify the fully qualified domain name (FQDN) of the domain. +Specifies the domain for this cmdlet. You must specify the fully qualified domain name (FQDN) of the +domain. For the **Get-GPStarterGPO** cmdlet, the Starter GPO must exist in this domain. -If you do not specify the **Domain** parameter, the domain of the user that is running the current session is used. -If the cmdlet is being run from a computer startup or shutdown script, the domain of the computer is used. -For more information, see the Notes section in the full Help. +If you do not specify the **Domain** parameter, the domain of the user that is running the current +session is used. If the cmdlet is being run from a computer startup or shutdown script, the domain +of the computer is used. For more information, see the Notes section in the full Help. -If you specify a domain that is different from the domain of the user that is running the current session (or, for a startup or shutdown script, the computer), a trust must exist between that domain and the domain of the user, or the computer. +If you specify a domain that is different from the domain of the user that is running the current +session (or, for a startup or shutdown script, the computer), a trust must exist between that domain +and the domain of the user, or the computer. -You can also refer to the **Domain** parameter by its built-in alias, **DomainName**. -For more information, see [about_Aliases](????????????). +You can also refer to the **Domain** parameter by its built-in alias, **DomainName**. For more +information, see [about_Aliases](/powershell/module/microsoft.powershell.core/about/about_aliases). ```yaml Type: System.String @@ -124,11 +147,12 @@ Accept wildcard characters: False ``` ### -Guid -Specifies the Starter GPO that this cmdlet gets by its globally unique identifier (GUID). -The GUID uniquely identifies the Starter GPO. -You can also refer to the **Guid** parameter by its built-in alias, **Id**. -For more information, see [about_Aliases](????????). +Specifies the Starter GPO that this cmdlet gets by its globally unique identifier (GUID). The GUID +uniquely identifies the Starter GPO. + +You can also refer to the **Guid** parameter by its built-in alias, **Id**. For more information, +see [about_Aliases](/powershell/module/microsoft.powershell.core/about/about_aliases). ```yaml Type: Guid @@ -143,14 +167,15 @@ Accept wildcard characters: False ``` ### -Name + Specifies the display name of the Starter GPO that this cmdlet. -The display name is not guaranteed to be unique in the domain. -If another Starter GPO with the same display name exists in the domain an error occurs. -You can use the **Guid** parameter to uniquely identify a Starter GPO. +The display name is not guaranteed to be unique in the domain. If another Starter GPO with the same +display name exists in the domain an error occurs. You can use the **Guid** parameter to uniquely +identify a Starter GPO. -You can also refer to the **Name** parameter by its built-in alias, **DisplayName**. -For more information, see [about_Aliases](????????). +You can also refer to the **Name** parameter by its built-in alias, **DisplayName**. For more +information, see [about_Aliases](/powershell/module/microsoft.powershell.core/about/about_aliases). ```yaml Type: System.String @@ -166,13 +191,14 @@ Accept wildcard characters: False ### -Server -Specifies the name of the domain controller that this cmdlet contacts to complete the operation. -You can specify either the fully qualified domain name (FQDN) or the host name. +Specifies the name of the domain controller that this cmdlet contacts to complete the operation. You +can specify either the fully qualified domain name (FQDN) or the host name. -If you do not specify the name by using the **Server** parameter, the primary domain controller (PDC) emulator is contacted. +If you do not specify the name by using the **Server** parameter, the primary domain controller +(PDC) emulator is contacted. -You can also refer to the *Server* parameter by its built-in alias, **DC**. -For more information, see [about_Aliases](????????). +You can also refer to the **Server** parameter by its built-in alias, **DC**. For more information, +see [about_Aliases](/powershell/module/microsoft.powershell.core/about/about_aliases). ```yaml Type: System.String @@ -188,7 +214,10 @@ Accept wildcard characters: False ### CommonParameters -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). +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). ## INPUTS @@ -199,18 +228,22 @@ You can pipe a Starter GPO to this cmdlet. ## OUTPUTS ### Microsoft.GroupPolicy.StarterGpo object + This cmdlet returns a Starter GPO object. ## NOTES * You can use the **Domain** parameter to explicitly specify the domain for this cmdlet. - If you do not explicitly specify the domain, the cmdlet uses a default domain. -The default domain is the domain that is used to access network resources by the security context under which the current session is running. -This domain is typically the domain of the user that is running the session, for instance, the domain of the user who started the session by opening Windows PowerShell or the domain of a user that is specified in a runas command. -However, computer startup and shutdown scripts run under the context of the LocalSystem account. -The LocalSystem account is a built-in local account, and it accesses network resources under the context of the computer account. -Therefore, when this cmdlet is run from a startup or shutdown script, the default domain is the domain to which the computer is joined. + If you do not explicitly specify the domain, the cmdlet uses a default domain. The default domain + is the domain that is used to access network resources by the security context under which the + current session is running. This domain is typically the domain of the user that is running the + session, for instance, the domain of the user who started the session by opening Windows + PowerShell or the domain of a user that is specified in a runas command. However, computer startup + and shutdown scripts run under the context of the LocalSystem account. The LocalSystem account is + a built-in local account, and it accesses network resources under the context of the computer + account. Therefore, when this cmdlet is run from a startup or shutdown script, the default domain + is the domain to which the computer is joined. ## RELATED LINKS diff --git a/docset/winserver2022-ps/grouppolicy/GroupPolicy.md b/docset/winserver2022-ps/grouppolicy/GroupPolicy.md index 92f43682fc..0301015dcd 100644 --- a/docset/winserver2022-ps/grouppolicy/GroupPolicy.md +++ b/docset/winserver2022-ps/grouppolicy/GroupPolicy.md @@ -10,89 +10,126 @@ title: GroupPolicy --- # GroupPolicy Module + ## Description -This topic contains the brief descriptions of the Windows PowerShell cmdlets that are for use in administering Group Policy in Windows Server and Windows client with Remote Server Administration Tools (RSAT) installed. (RSAT includes the GPMC and the Group Policy cmdlets.) + +This topic contains the brief descriptions of the Windows PowerShell cmdlets that are for use in +administering Group Policy in Windows Server and Windows client with Remote Server Administration +Tools (RSAT) installed. (RSAT includes the GPMC and the Group Policy cmdlets.) Each cmdlet in the table is linked to additional information about that cmdlet. ## GroupPolicy Cmdlets + ### [Backup-GPO](./Backup-GPO.md) + Backs up one GPO or all the GPOs in a domain. ### [Copy-GPO](./Copy-GPO.md) + Copies a GPO. ### [Get-GPInheritance](./Get-GPInheritance.md) + Gets Group Policy inheritance information for a specified domain or OU. ### [Get-GPO](./Get-GPO.md) + Gets one GPO or all the GPOs in a domain. ### [Get-GPOReport](./Get-GPOReport.md) + Generates a report either in XML or HTML format for a specified GPO or for all GPOs in a domain. ### [Get-GPPermission](./Get-GPPermission.md) + Gets the permission level for one or more security principals on a specified GPO. ### [Get-GPPrefRegistryValue](./Get-GPPrefRegistryValue.md) -Gets one or more Registry preference items under either Computer Configuration or User Configuration in a GPO. + +Gets one or more Registry preference items under either Computer Configuration or User Configuration +in a GPO. ### [Get-GPRegistryValue](./Get-GPRegistryValue.md) -Gets one or more registry-based policy settings under either Computer Configuration or User Configuration in a GPO. + +Gets one or more registry-based policy settings under either Computer Configuration or User +Configuration in a GPO. ### [Get-GPResultantSetOfPolicy](./Get-GPResultantSetOfPolicy.md) + Gets and writes the RSoP information for a user, a computer, or both to a file. ### [Get-GPStarterGPO](./Get-GPStarterGPO.md) + Gets one Starter GPO or all Starter GPOs in a domain. ### [Import-GPO](./Import-GPO.md) + Imports the Group Policy settings from a backed-up GPO into a specified GPO. ### [Invoke-GPUpdate](./Invoke-GPUpdate.md) + Schedules a remote Group Policy refresh on the specified computer. ### [New-GPLink](./New-GPLink.md) + Links a GPO to a site, domain, or OU. ### [New-GPO](./New-GPO.md) + Creates a GPO. ### [New-GPStarterGPO](./New-GPStarterGPO.md) + Creates a Starter GPO. ### [Remove-GPLink](./Remove-GPLink.md) + Removes a GPO link from a site, domain or OU. ### [Remove-GPO](./Remove-GPO.md) + Removes a GPO. ### [Remove-GPPrefRegistryValue](./Remove-GPPrefRegistryValue.md) -Removes one or more Registry preference items from either Computer Configuration or User Configuration in a GPO. + +Removes one or more Registry preference items from either Computer Configuration or User +Configuration in a GPO. ### [Remove-GPRegistryValue](./Remove-GPRegistryValue.md) -Removes one or more registry-based policy settings from either Computer Configuration or User Configuration in a GPO. + +Removes one or more registry-based policy settings from either Computer Configuration or User +Configuration in a GPO. ### [Rename-GPO](./Rename-GPO.md) + Assigns a new display name to a GPO. ### [Restore-GPO](./Restore-GPO.md) + Restores one GPO or all GPOs in a domain from one or more GPO backup files. ### [Set-GPInheritance](./Set-GPInheritance.md) + Blocks or unblocks inheritance for a specified domain or organizational unit. ### [Set-GPLink](./Set-GPLink.md) + Sets the properties of the specified GPO link. ### [Set-GPPermission](./Set-GPPermission.md) + Grants a level of permissions to a security principal for one GPO or all the GPOs in a domain. ### [Set-GPPrefRegistryValue](./Set-GPPrefRegistryValue.md) -Configures a Registry preference item under either Computer Configuration or User Configuration in a GPO. + +Configures a Registry preference item under either Computer Configuration or User Configuration in a +GPO. ### [Set-GPRegistryValue](./Set-GPRegistryValue.md) -Configures one or more registry-based policy settings under either Computer Configuration or User Configuration in a GPO. + +Configures one or more registry-based policy settings under either Computer Configuration or User +Configuration in a GPO. diff --git a/docset/winserver2022-ps/grouppolicy/Import-GPO.md b/docset/winserver2022-ps/grouppolicy/Import-GPO.md index f3cdc72ba3..a570227b12 100644 --- a/docset/winserver2022-ps/grouppolicy/Import-GPO.md +++ b/docset/winserver2022-ps/grouppolicy/Import-GPO.md @@ -34,25 +34,30 @@ Import-GPO -BackupGpoName -Path [-TargetGuid ] [-TargetN ## DESCRIPTION -The **Import-GPO** cmdlet imports the settings from a Group Policy Object (GPO) backup into a specified target GPO. -The target GPO can be in a different domain or forest than the backup that was made and it does not have to exist prior to the operation. +The **Import-GPO** cmdlet imports the settings from a Group Policy Object (GPO) backup into a +specified target GPO. The target GPO can be in a different domain or forest than the backup that was +made and it does not have to exist prior to the operation. -Use the **Path** parameter to specify the location of the backup and then use the **BackupGpoName** parameter to specify the GPO name of the backup to use, or the **BackupId** parameter to specify the backup ID (GUID) of the backup to use. +Use the **Path** parameter to specify the location of the backup and then use the **BackupGpoName** +parameter to specify the GPO name of the backup to use, or the **BackupId** parameter to specify the +backup ID (GUID) of the backup to use. -If you specify a GPO name, the cmdlet imports the most recent backup. -To import an earlier version of a GPO backup, you must use the *BackupID* parameter to specify the unique backup ID for the particular version. -This is the GUID that uniquely identifies the backup within its backup directory. +If you specify a GPO name, the cmdlet imports the most recent backup. To import an earlier version +of a GPO backup, you must use the **BackupID** parameter to specify the unique backup ID for the +particular version. This is the GUID that uniquely identifies the backup within its backup +directory. -Use the **TargetName** parameter or the **TargetGuid** parameter to specify the target GPO into which the settings should be imported. -Use the optional **MigrationTable** parameter to map security principals and Universal Naming Convention (UNC) paths across domains. -Use the *CreateIfNeeded* parameter to create a new GPO if the specified target GPO does not exist. +Use the **TargetName** parameter or the **TargetGuid** parameter to specify the target GPO into +which the settings should be imported. Use the optional **MigrationTable** parameter to map security +principals and Universal Naming Convention (UNC) paths across domains. Use the **CreateIfNeeded** +parameter to create a new GPO if the specified target GPO does not exist. ## EXAMPLES ### Example 1: Import the settings from the latest backup to another directory in the same domain ```powershell -import-gpo -BackupGpoName TestGPO -TargetName TestGPO -path c:\backups +Import-GPO -BackupGpoName 'TestGPO' -TargetName 'TestGPO' -path 'C:\backups' ``` ```Output @@ -70,14 +75,20 @@ WmiFilter : ``` This command imports the settings from the most recent backup of the GPO named `TestGPO` in the -`c:\backups` directory into a GPO of the same name in the current domain. If a GPO named TestGPO -does not exist in the current domain, the command fails because the CreateIfNeeded parameter is not -specified. +`c:\backups` directory into a GPO of the same name in the current domain. If a GPO named `TestGPO` +does not exist in the current domain, the command fails because the **CreateIfNeeded** parameter is +not specified. ### Example 2: Import the settings from specified backup in the same directory in the same domain ```powershell -import-gpo -BackupId A491D730-F3ED-464C-B8C9-F50562C536AA -TargetName TestGPO -path c:\backups -CreateIfNeeded +$params = @{ + BackupId = 'A491D730-F3ED-464C-B8C9-F50562C536AA' + TargetName = 'TestGPO' + path = 'C:\Backups' + CreateIfNeeded = $true +} +Import-GPO @params ``` ```Output @@ -94,15 +105,22 @@ ComputerVersion : AD Version: 6, SysVol Version: 6 WmiFilter : ``` -This command imports the settings from the specified backup in the c:\backups directory into a GPO -that is named TestGPO in the current domain. The BackupId parameter is used to specify the GUID of -the GPO backup to use. Because the CreateIfNeeded parameter is specified, if a GPO named TestGPO -does not exist in the current domain, one is created before the settings are imported. +This command imports the settings from the specified backup in the `C:\Backups` directory into a GPO +that is named `TestGPO` in the current domain. The **BackupId** parameter is used to specify the +GUID of the GPO backup to use. Because the **CreateIfNeeded** parameter is specified, if a GPO named +`TestGPO` does not exist in the current domain, one is created before the settings are imported. ### Example 3: Import the settings from the latest backup to another directory to the current domain ```powershell -Import-GPO -BackupGpoName TestGPO -Path D:\Backups -TargetName NewTestGPO -MigrationTable D:\Tables\Migtable1.migtable -CreateIfNeeded +$params = @{ + BackupGpoName = 'TestGPO' + Path = 'D:\Backups' + TargetName = 'NewTestGPO' + MigrationTable = 'D:\Tables\Migtable1.migtable' + CreateIfNeeded = $true +} +Import-GPO @params ``` ```Output @@ -119,21 +137,22 @@ ComputerVersion : AD Version: 1, SysVol Version: 1 WmiFilter : ``` -This command imports the settings from the most recent backup of the GPO named TestGPO from the -d:\backups directory to a GPO named NewTestGPO in the current domain. The specified migration table -is used to migrate security principals and UNC paths to the new GPO. Because the CreateIfNeeded -parameter is specified, the GPO is created if it does not already exist. +This command imports the settings from the most recent backup of the GPO named `TestGPO` from the +`D:\Backups` directory to a GPO named `NewTestGPO` in the current domain. The specified migration +table is used to migrate security principals and UNC paths to the new GPO. Because the +**CreateIfNeeded** parameter is specified, the GPO is created if it does not already exist. ## PARAMETERS ### -BackupGpoName Specifies the display name of the backed-up GPO from which this cmdlet imports the settings. The -most recent backup of the GPO is used. You can use the *BackupId* parameter to specify a particular +most recent backup of the GPO is used. You can use the **BackupID** parameter to specify a particular version to use when multiple backups of the same GPO exist in the backup directory. You can also refer to the **BackupGpoName** parameter by its built-in alias, **DisplayName**. For -more information, see [about_Aliases](????????????). +more information, see +[about_Aliases](/powershell/module/microsoft.powershell.core/about/about_aliases). ```yaml Type: System.String @@ -155,8 +174,8 @@ backed-up GPO in the backup directory. The backup ID is different from the ID of the GPO that was backed up. -You can also refer to the *BackupId* parameter by its built-in alias, **Id**. For more information, -see [about_Aliases](????????). +You can also refer to the **BackupID** parameter by its built-in alias, **Id**. For more +information, see [about_Aliases](/powershell/module/microsoft.powershell.core/about/about_aliases). ```yaml Type: Guid @@ -218,7 +237,7 @@ session (or, for a startup or shutdown script, the computer), a trust must exist and the domain of the user, or the computer. You can also refer to the **Domain** parameter by its built-in alias, **DomainName**. For more -information, see [about_Aliases](????????). +information, see [about_Aliases](/powershell/module/microsoft.powershell.core/about/about_aliases). ```yaml Type: System.String @@ -253,13 +272,13 @@ Accept wildcard characters: False Specifies the path to the backup directory. -You can also refer to the **Path** parameter by its built-in aliases: backuplocation or -backupdirectory. +You can also refer to the **Path** parameter by its built-in aliases: **BackupLocation** or +**BackupDirectory**. ```yaml Type: System.String Parameter Sets: (All) -Aliases: backupLocation, BackupDirectory +Aliases: BackupLocation, BackupDirectory Required: True Position: Named @@ -273,9 +292,10 @@ Accept wildcard characters: False Specifies the name of the domain controller that this cmdlet contacts to complete the operation. You can specify either the fully qualified domain name (FQDN) or the host name -If you do not specify the name by using the **Server** parameter, the primary domain controller (PDC) emulator is contacted. +If you do not specify the name by using the **Server** parameter, the primary domain controller +(PDC) emulator is contacted. -You can also refer to the *Server* parameter by its built-in alias, **DC**. +You can also refer to the **Server** parameter by its built-in alias, **DC**. ```yaml Type: System.String @@ -311,7 +331,7 @@ Accept wildcard characters: False ### -TargetName Specifies the display name of the GPO into which the settings are to be imported. Use the -*CreateIfNeeded* parameter to force the GPO to be created if it does not already exist in the +**CreateIfNeeded** parameter to force the GPO to be created if it does not already exist in the domain. You must specify either the **TargetGuid** parameter or the **TargetName** parameter. @@ -330,8 +350,7 @@ Accept wildcard characters: False ### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml Type: System.Management.Automation.SwitchParameter diff --git a/docset/winserver2022-ps/grouppolicy/Invoke-GPUpdate.md b/docset/winserver2022-ps/grouppolicy/Invoke-GPUpdate.md index ea710c80e1..0feff10fa2 100644 --- a/docset/winserver2022-ps/grouppolicy/Invoke-GPUpdate.md +++ b/docset/winserver2022-ps/grouppolicy/Invoke-GPUpdate.md @@ -20,14 +20,14 @@ Schedules a remote Group Policy refresh on the specified computer. ``` Invoke-GPUpdate [-AsJob] [-Boot] [[-Computer] ] [[-RandomDelayInMinutes] ] [-Force] -[-LogOff] [-Target ] [] + [-LogOff] [-Target ] [] ``` ### SyncSet ``` Invoke-GPUpdate [-AsJob] [-Boot] [[-Computer] ] [[-RandomDelayInMinutes] ] [-LogOff] -[-Target ] [-Sync] [] + [-Target ] [-Sync] [] ``` ## DESCRIPTION @@ -37,35 +37,42 @@ set on remote computers by scheduling the running of the Gpupdate command on a r can combine this cmdlet in a scripted fashion to schedule the Gpupdate command on a group of computers. -The refresh can be scheduled to immediately start a refresh of policy settings or wait for a specified period of time, up to a maximum of 31 days. -To avoid putting a load on the network, the refresh times will be offset by a random delay. +The refresh can be scheduled to immediately start a refresh of policy settings or wait for a +specified period of time, up to a maximum of 31 days. To avoid putting a load on the network, the +refresh times will be offset by a random delay. ## EXAMPLES ### Example 1: Schedule a Group Policy refresh on the current computer + ```powershell Invoke-GPUpdate ``` -This command schedules a Group Policy refresh on the computer on which you are running the **Invoke-GPUpdate** cmdlet. +This command schedules a Group Policy refresh on the computer on which you are running the +**Invoke-GPUpdate** cmdlet. ### Example 2: Schedule a Group Policy refresh on a remote computer + ```powershell Invoke-GPUpdate -Computer "CONTOSO\COMPUTER-02" -Target "User" ``` -This command schedules a Group Policy refresh on a remote computer named CONTOSO\COMPUTER-02 that only schedule to update the user policy settings in synchronous mode. +This command schedules a Group Policy refresh on a remote computer named `CONTOSO\COMPUTER-02` that +only schedule to update the user policy settings in synchronous mode. ## PARAMETERS ### -AsJob -Runs the cmdlet as a background job. -Use this parameter to run commands that take a long time to complete. - The cmdlet immediately returns an object that represents the job and then displays the command prompt. -You can continue to work in the session while the job completes. -To manage the job, use the `*-Job` cmdlets. -To get the job results, use the [Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. - For more information about Windows PowerShell® background jobs, see [about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). + +Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to +complete. The cmdlet immediately returns an object that represents the job and then displays the +command prompt. You can continue to work in the session while the job completes. To manage the job, +use the `*-Job` cmdlets. + +To get the job results, use the [Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) +cmdlet. For more information about Windows PowerShell® background jobs, see +[about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). ```yaml Type: System.Management.Automation.SwitchParameter @@ -80,8 +87,11 @@ Accept wildcard characters: False ``` ### -Boot -Indicates that the cmdlet restarts the computer after the Group Policy settings are applied. -This is required for those Group Policy client side extensions (CSEs) that do not process Group Policy on a background update cycle, but do process Group Policy at computer startup, for instance, per-computer Software Installation policy settings. + +Indicates that the cmdlet restarts the computer after the Group Policy settings are applied. This is +required for those Group Policy client side extensions (CSEs) that do not process Group Policy on a +background update cycle, but do process Group Policy at computer startup, for instance, per-computer +Software Installation policy settings. This parameter has no effect if there are no CSEs called that require a restart. @@ -98,18 +108,20 @@ Accept wildcard characters: False ``` ### -Computer -Specifies the name of the computer for which this cmdlet schedules a Group Policy refresh. -You can specify the computer name in one of the following formats: -- Full computer name (FQDN computer name); for example, computer-01.sales.contoso.com. +Specifies the name of the computer for which this cmdlet schedules a Group Policy refresh. You can +specify the computer name in one of the following formats: + +- Full computer name (FQDN computer name); for example, `computer-01.sales.contoso.com`. -- Fully qualified domain name (FQDN)\computer name; for example, sales.contoso.com\computer-01. +- Fully qualified domain name (FQDN)\computer name; for example, `sales.contoso.com\computer-01`. -- NetBIOS domain name\computer name; for example, sales\computer-01. +- NetBIOS domain name\computer name; for example, `sales\computer-01`. -- Computer name (host name): for example, computer-01. +- Computer name (host name): for example, `computer-01`. -If the computer name is not specified, the computer in which this cmdlet is run will have its Group Policy settings refreshed. +If the computer name is not specified, the computer in which this cmdlet is run will have its Group +Policy settings refreshed. ```yaml Type: System.String @@ -124,6 +136,7 @@ Accept wildcard characters: False ``` ### -Force + Forces the command to run without asking for user confirmation. ```yaml @@ -139,9 +152,11 @@ Accept wildcard characters: False ``` ### -LogOff + Indicates that the cmdlet logs off the current user after the policy settings have been updated. -This is required for those Group Policy client-side extensions (CSEs) that do not process Group Policy on a background update cycle but do process Group Policy when a user logs on. -Examples include per-user Software Installation policy settings and the Folder Redirection extension. +This is required for those Group Policy client-side extensions (CSEs) that do not process Group +Policy on a background update cycle but do process Group Policy when a user logs on. Examples +include per-user Software Installation policy settings and the Folder Redirection extension. This parameter has no effect if there are no CSEs called that require a logoff. @@ -158,13 +173,18 @@ Accept wildcard characters: False ``` ### -RandomDelayInMinutes -Specifies the delay, in minutes, that Task Scheduler waits, with a random factor added to lower the network load, before running a scheduled Group Policy refresh. -You can specify a delay in from 0 minutes to a maximum of 44640 minutes (31 days): +Specifies the delay, in minutes, that Task Scheduler waits, with a random factor added to lower the +network load, before running a scheduled Group Policy refresh. + +You can specify a delay in from 0 minutes to a maximum of 44640 minutes (31 days): -- A value of 0 causes the Group Policy refresh to run as soon as the gpupdate task has been scheduled. +- A value of 0 causes the Group Policy refresh to run as soon as the gpupdate task has been + scheduled. --A value in the range of 1 minute to the maximum value of 44640 minutes cause the Group Policy refresh to delay the specified number of minutes plus a random offset before starting the Group Policy refresh. +- A value in the range of 1 minute to the maximum value of 44640 minutes cause the Group Policy +refresh to delay the specified number of minutes plus a random offset before starting the Group +Policy refresh. ```yaml Type: Int32 @@ -179,11 +199,13 @@ Accept wildcard characters: False ``` ### -Sync -Indicates that the cmdlet processes the next foreground Group Policy application to be done synchronously. -Foreground Group Policy applications occur at computer startup and user logon. -You can specify this for the user, computer or both using the *Target* parameter. -On a client computer, by default, Group Policy processes synchronously at computer startup and asynchronously at user logon. +Indicates that the cmdlet processes the next foreground Group Policy application to be done +synchronously. Foreground Group Policy applications occur at computer startup and user logon. You +can specify this for the user, computer or both using the **Target** parameter. + +On a client computer, by default, Group Policy processes synchronously at computer startup and +asynchronously at user logon. On a server, by default, Group Policy processes synchronously at computer startup and at user logon. @@ -200,15 +222,16 @@ Accept wildcard characters: False ``` ### -Target -Specifies that only the user or computer policy settings are refreshed. -By default, both user and computer policy settings are refreshed. + +Specifies that only the user or computer policy settings are refreshed. By default, both user and +computer policy settings are refreshed. The acceptable values for this parameter are: - User - Computer -If the *Target* parameter is not specified both user and computer policy settings are refreshed. +If the **Target** parameter is not specified both user and computer policy settings are refreshed. ```yaml Type: System.String @@ -224,11 +247,15 @@ Accept wildcard characters: False ### CommonParameters -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). +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). ## INPUTS ### None + This cmdlet does not take any object as input. ## OUTPUTS @@ -239,8 +266,10 @@ This cmdlet does not generate any output. ## NOTES -* This cmdlet does not support scheduling a Group Policy refresh for computers running Windows XP or earlier. -* In order to successfully schedule a Group Policy refresh for computers using this cmdlet, the following Firewall rules must be set on each client computer to allow the following connections: +* This cmdlet does not support scheduling a Group Policy refresh for computers running Windows XP or + earlier. +* In order to successfully schedule a Group Policy refresh for computers using this cmdlet, the + following Firewall rules must be set on each client computer to allow the following connections: - Remote Scheduled Tasks Management (RPC) - Remote Scheduled Tasks Management (RPC-ERMAP) diff --git a/docset/winserver2022-ps/grouppolicy/New-GPLink.md b/docset/winserver2022-ps/grouppolicy/New-GPLink.md index a39da391ff..d754244bee 100644 --- a/docset/winserver2022-ps/grouppolicy/New-GPLink.md +++ b/docset/winserver2022-ps/grouppolicy/New-GPLink.md @@ -17,30 +17,43 @@ Links a GPO to a site, domain, or OU. ## SYNTAX ### LinkbyGUID (Default) + ``` -New-GPLink -Guid -Target [-LinkEnabled ] [-Order ] [-Domain ] - [-Server ] [-Enforced ] [-WhatIf] [-Confirm] [] +New-GPLink -Guid -Target [-LinkEnabled ] [-Order ] + [-Domain ] [-Server ] [-Enforced ] [-WhatIf] [-Confirm] + [] ``` ### LinkbyName + ``` -New-GPLink [-Name] -Target [-LinkEnabled ] [-Order ] [-Domain ] - [-Server ] [-Enforced ] [-WhatIf] [-Confirm] [] +New-GPLink [-Name] -Target [-LinkEnabled ] [-Order ] + [-Domain ] [-Server ] [-Enforced ] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION -The **New-GPLink** cmdlet links a GPO to a site, domain, or organizational unit (OU). -By default, the link is enabled, which means that the settings of the GPO are applied at the level of the target Active Directory container according to the rules of inheritance and precedence when Group Policy is processed. -You can specify the GPO by either its display name or its GUID; or the GPO can be piped into the cmdlet. -You specify the site, domain, or organizational unit (OU) to link to by its Lightweight Directory Access Protocol (LDAP) distinguished name. -You can use other parameters to specify whether the link is enabled, whether the link is enforced, and the order in which it is applied at the site, domain, or OU. +The **New-GPLink** cmdlet links a GPO to a site, domain, or organizational unit (OU). By default, +the link is enabled, which means that the settings of the GPO are applied at the level of the target +Active Directory container according to the rules of inheritance and precedence when Group Policy is +processed. + +You can specify the GPO by either its display name or its GUID; or the GPO can be piped into the +cmdlet. You specify the site, domain, or organizational unit (OU) to link to by its Lightweight +Directory Access Protocol (LDAP) distinguished name. You can use other parameters to specify whether +the link is enabled, whether the link is enforced, and the order in which it is applied at the site, +domain, or OU. ## EXAMPLES ### Example 1: Create and link a GPO to a domain + ```powershell -New-GPO -Name "MyGPO" | New-GPLink -Target "ou=MyOU,dc=contoso,dc=com" -LinkEnabled Yes +New-GPO -Name "MyGPO" | New-GPLink -Target "ou=MyOU,dc=contoso,dc=com" -LinkEnabled Yes +``` + +```Output GpoId : c25daa3e-5d05-43b3-87ca-0a237882fd63 DisplayName : MyGPO Enabled : True @@ -49,15 +62,24 @@ Target : OU=MyOU,DC=contoso,DC=com Order : 1 ``` -This command creates the GPO named MyGPO in the domain of the user (or, for a startup or shutdown script, the computer) and links it to the MyOU organizational unit in the contoso.com domain. -If the domain of the user, or the computer, is different than contoso.com, a trust relationship must exist between the two domains. +This command creates the GPO named MyGPO in the domain of the user (or, for a startup or shutdown +script, the computer) and links it to the `MyOU` organizational unit in the `contoso.com` domain. If +the domain of the user, or the computer, is different than `contoso.com`, a trust relationship must +exist between the two domains. -Because this command can take a GPO as input, you can insert any command that returns a GPO between New-GPO and **New-GPLink** to configure the GPO. -For instance, you can insert **Set-GPPermissions** commands to set permissions on the GPO, Set-GPRegistryValue cmdlet to configure one or more registry-based policy settings for the GPO, or the **Set-GPPrefRegistryValue** cmdlet to configure one or more Registry preference items for the GPO. +Because this command can take a GPO as input, you can insert any command that returns a GPO between +New-GPO and **New-GPLink** to configure the GPO. For instance, you can insert **Set-GPPermissions** +commands to set permissions on the GPO, Set-GPRegistryValue cmdlet to configure one or more +registry-based policy settings for the GPO, or the **Set-GPPrefRegistryValue** cmdlet to configure +one or more Registry preference items for the GPO. ### Example 2: Link a GPO in the domain of the user + ```powershell -New-GPLink -Name "TestGPO" -Target "dc=contoso,dc=com" +New-GPLink -Name "TestGPO" -Target "dc=contoso,dc=com" +``` + +```Output GpoId : d5a3b4e7-e37a-4070-846c-568689eaa838 DisplayName : TestGPO Enabled : True @@ -66,12 +88,17 @@ Target : DC=contoso,DC=com Order : 2 ``` -This command links the TestGPO GPO in the domain of the user (or, for a startup or shutdown script, the computer) to the contoso.com domain. -If the domain of the user, or the computer, is different than contoso.com, a trust relationship must exist between the two domains. +This command links the `TestGPO` GPO in the domain of the user (or, for a startup or shutdown +script, the computer) to the `contoso.com` domain. If the domain of the user, or the computer, is +different than `contoso.com`, a trust relationship must exist between the two domains. ### Example 3: Link a GPO to a site and enforce the link + ```powershell New-GPLink -name "TestGPO" -Target "Test-Site" -Enforced Yes +``` + +```Output GpoId : d5a3b4e7-e37a-4070-846c-568689eaa838 DisplayName : TestGPO Enabled : True @@ -80,7 +107,7 @@ Target : CN=test-site,cn=Sites,CN=Configuration,DC=contoso,DC=com Order : 1 ``` -This command links the TestGPO GPO to the site named Test-Site and sets the link to enforced. +This command links the `TestGPO` GPO to the site named `Test-Site` and sets the link to enforced. ## PARAMETERS @@ -102,25 +129,28 @@ Accept wildcard characters: False ### -Domain -Specifies the domain for this cmdlet. -You must specify the fully qualified domain name (FQDN) of the domain. +Specifies the domain for this cmdlet. You must specify the fully qualified domain name (FQDN) of the +domain. For the **New-GPLink** cmdlet: - The GPO to link from must exist in this domain. -- The Active Directory container to link to must exist in a domain that has a trust relationship with this domain. +- The Active Directory container to link to must exist in a domain that has a trust relationship + with this domain. To specify a domain to link to, use the *Target* parameter. -If you do not specify the **Domain** parameter, the domain of the user that is running the current session is used. -If the cmdlet is being run from a computer startup or shutdown script, the domain of the computer is used. -For more information, see the Notes section in the full Help. +If you do not specify the **Domain** parameter, the domain of the user that is running the current +session is used. If the cmdlet is being run from a computer startup or shutdown script, the domain +of the computer is used. For more information, see the Notes section in the full Help. -If you specify a domain that is different from the domain of the user that is running the current session (or, for a startup or shutdown script, the computer), a trust must exist between that domain and the domain of the user, or the computer. +If you specify a domain that is different from the domain of the user that is running the current +session (or, for a startup or shutdown script, the computer), a trust must exist between that domain +and the domain of the user, or the computer. -You can also refer to *Domain* by its built-in alias, **DomainName**. -For more information, see [about_Aliases](????????????). +You can also refer to **Domain** by its built-in alias, **DomainName**. For more information, see +[about_Aliases](/powershell/module/microsoft.powershell.core/about/about_aliases). ```yaml Type: System.String @@ -135,17 +165,18 @@ Accept wildcard characters: False ``` ### -Enforced -Specifies whether the GPO link is enforced. -You can specify Yes or No. -By default, GPO links are not enforced. + +Specifies whether the GPO link is enforced. You can specify Yes or No. By default, GPO links are not +enforced. By setting the GPO link to enforced, you ensure the following: -- That the settings of the GPO cannot be blocked (by blocking inheritance) at a lower-level Active Directory container. -- That the settings of the GPO always take precedence over conflicting settings in GPOs that are linked to lower-level containers. +- That the settings of the GPO cannot be blocked (by blocking inheritance) at a lower-level Active + Directory container. +- That the settings of the GPO always take precedence over conflicting settings in GPOs that are + linked to lower-level containers. -This option should be used sparingly. -Casual use of this option complicates troubleshooting. +This option should be used sparingly. Casual use of this option complicates troubleshooting. ```yaml Type: EnforceLink @@ -162,11 +193,11 @@ Accept wildcard characters: False ### -Guid -Specifies the GPO to link by its globally unique identifier (GUID). -The GUID uniquely identifies the GPO in the domain. +Specifies the GPO to link by its globally unique identifier (GUID). The GUID uniquely identifies the +GPO in the domain. -You can also refer to the Guid parameter by its built-in alias, **Id**. -For more information, see [about_Aliases](????????). +You can also refer to the **Guid** parameter by its built-in alias, **Id**. For more information, see +[about_Aliases](/powershell/module/microsoft.powershell.core/about/about_aliases). ```yaml Type: Guid @@ -181,14 +212,15 @@ Accept wildcard characters: False ``` ### -LinkEnabled + Specifies whether the GPO link is enabled. The acceptable values for this parameter are: Yes or No. -By default, Group Policy processing is enabled for all GPO links. -You can completely block the application of a GPO for a specific site, domain, or OU by disabling the GPO link for that site, domain, or OU. -Disabling a GPO link does not disable the GPO itself. -If the GPO is linked to other sites, domains, or OUs, Group Policy continues to process the GPO for each link that is enabled. +By default, Group Policy processing is enabled for all GPO links. You can completely block the +application of a GPO for a specific site, domain, or OU by disabling the GPO link for that site, +domain, or OU. Disabling a GPO link does not disable the GPO itself. If the GPO is linked to other +sites, domains, or OUs, Group Policy continues to process the GPO for each link that is enabled. ```yaml Type: EnableLink @@ -204,14 +236,15 @@ Accept wildcard characters: False ``` ### -Name + Specifies the GPO to link by its display name. -The display name is not guaranteed to be unique in the domain. -If another GPO with the same display name exists in the domain, an error occurs. -You can use the **Guid** parameter to uniquely identify a GPO. +The display name is not guaranteed to be unique in the domain. If another GPO with the same display +name exists in the domain, an error occurs. You can use the **Guid** parameter to uniquely identify +a GPO. -You can also refer to the **Name** parameter by its built-in alias, **DisplayName**. -For more information, see [about_Aliases](????????). +You can also refer to the **Name** parameter by its built-in alias, **DisplayName**. For more +information, see [about_Aliases](/powershell/module/microsoft.powershell.core/about/about_aliases). ```yaml Type: System.String @@ -226,17 +259,21 @@ Accept wildcard characters: False ``` ### -Order -Specifies the link order for the GPO link. -You can specify a number that is between one and the current number of GPO links to the target site, domain, or OU, plus one. -The link order specifies the order of precedence with which GPOs linked to the same Active Directory container are applied. -When Group Policy is processed, GPOs with a higher link order number are processed before GPOs with a lower link order number. -Therefore, when two GPOs contain conflicting settings, the settings in the GPO with the lower link order number, because it is processed last, overwrites those of the GPO with the higher link order number. -A lower number indicates higher precedence. +Specifies the link order for the GPO link. You can specify a number that is between one and the +current number of GPO links to the target site, domain, or OU, plus one. -By default, the GPO link is added at the lowest precedence with a link order equal to the number of GPO links to the container, plus one. -Link order is a dynamic value because the value may change as GPO links are added and deleted from the container. -You can change the link order of a GPO link with the **Set-GPLink** cmdlet. +The link order specifies the order of precedence with which GPOs linked to the same Active Directory +container are applied. When Group Policy is processed, GPOs with a higher link order number are +processed before GPOs with a lower link order number. Therefore, when two GPOs contain conflicting +settings, the settings in the GPO with the lower link order number, because it is processed last, +overwrites those of the GPO with the higher link order number. A lower number indicates higher +precedence. + +By default, the GPO link is added at the lowest precedence with a link order equal to the number of +GPO links to the container, plus one. Link order is a dynamic value because the value may change as +GPO links are added and deleted from the container. You can change the link order of a GPO link with +the **Set-GPLink** cmdlet. ```yaml Type: Int32 @@ -252,13 +289,14 @@ Accept wildcard characters: False ### -Server -Specifies the name of the domain controller that this cmdlet contacts to complete the operation. -You can specify either the FQDN or the host name. +Specifies the name of the domain controller that this cmdlet contacts to complete the operation. You +can specify either the FQDN or the host name. -If you do not specify the name by using the **Server** parameter, the primary domain controller (PDC) emulator is contacted. +If you do not specify the name by using the **Server** parameter, the primary domain controller +(PDC) emulator is contacted. -You can also refer to the *Server* parameter by its built-in alias, **DC**. -For more information, see [about_Aliases](????????). +You can also refer to the **Server** parameter by its built-in alias, **DC**. For more information, +see [about_Aliases](/powershell/module/microsoft.powershell.core/about/about_aliases). ```yaml Type: System.String @@ -273,8 +311,10 @@ Accept wildcard characters: False ``` ### -Target -Specifies the LDAP distinguished name of the site, domain, or OU to which to link the GPO. -For example, for the MyOU organizational unit in the contoso.com domain, the LDAP distinguished name is ou=MyOU,dc=contoso,dc=com. + +Specifies the LDAP distinguished name of the site, domain, or OU to which to link the GPO. For +example, for the `MyOU` organizational unit in the `contoso.com` domain, the LDAP distinguished name +is `ou=MyOU,dc=contoso,dc=com`. ```yaml Type: System.String @@ -290,8 +330,7 @@ Accept wildcard characters: False ### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml Type: System.Management.Automation.SwitchParameter @@ -307,32 +346,42 @@ Accept wildcard characters: False ### CommonParameters -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). +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). ## INPUTS ### Microsoft.GroupPolicy.Gpo + You can pipe a GPO object to be linked to an Active Directory container. Collections that contain GPOs from different domains are not supported. ## OUTPUTS ### Microsoft.GroupPolicy.GpoLink + This cmdlet returns an object that represents the link between the GPO and the site, domain, or OU. ## NOTES -* To link a GPO to a site, domain, or OU, you must have Link GPOs permission on that site, domain, or OU. By default, only domain administrators and enterprise administrators have this privilege for domains and OUs. Enterprise administrators and domain administrators of the forest root domain have this privilege for sites. +* To link a GPO to a site, domain, or OU, you must have Link GPOs permission on that site, domain, + or OU. By default, only domain administrators and enterprise administrators have this privilege + for domains and OUs. Enterprise administrators and domain administrators of the forest root domain + have this privilege for sites. You can use the **Domain** parameter to explicitly specify the domain for this cmdlet. - If you do not explicitly specify the domain, the cmdlet uses a default domain. -The default domain is the domain that is used to access network resources by the security context under which the current session is running. -This domain is typically the domain of the user that is running the session. -For instance, the domain of the user who started the session by opening Windows PowerShell from the Program Files menu, or the domain of a user that is specified in a runas command. -However, computer startup and shutdown scripts run under the context of the LocalSystem account. -The LocalSystem account is a built-in local account, and it accesses network resources under the context of the computer account. -Therefore, when this cmdlet is run from a startup or shutdown script, the default domain is the domain to which the computer is joined. + If you do not explicitly specify the domain, the cmdlet uses a default domain. The default domain + is the domain that is used to access network resources by the security context under which the + current session is running. This domain is typically the domain of the user that is running the + session. For instance, the domain of the user who started the session by opening Windows + PowerShell from the Program Files menu, or the domain of a user that is specified in a runas + command. However, computer startup and shutdown scripts run under the context of the LocalSystem + account. The LocalSystem account is a built-in local account, and it accesses network resources + under the context of the computer account. Therefore, when this cmdlet is run from a startup or + shutdown script, the default domain is the domain to which the computer is joined. ## RELATED LINKS diff --git a/docset/winserver2022-ps/grouppolicy/New-GPO.md b/docset/winserver2022-ps/grouppolicy/New-GPO.md index 64399c4b2f..ac2a6b7df8 100644 --- a/docset/winserver2022-ps/grouppolicy/New-GPO.md +++ b/docset/winserver2022-ps/grouppolicy/New-GPO.md @@ -17,36 +17,46 @@ Creates a GPO. ## SYNTAX ### New (Default) + ``` -New-GPO [-Name] [-Comment ] [-Domain ] [-Server ] [-WhatIf] [-Confirm] - [] +New-GPO [-Name] [-Comment ] [-Domain ] [-Server ] [-WhatIf] + [-Confirm] [] ``` ### NewStarterGUID + ``` -New-GPO [-Name] -StarterGpoGuid [-Comment ] [-Domain ] [-Server ] - [-WhatIf] [-Confirm] [] +New-GPO [-Name] -StarterGpoGuid [-Comment ] [-Domain ] + [-Server ] [-WhatIf] [-Confirm] [] ``` ### NewStarterName + ``` -New-GPO [-Name] -StarterGpoName [-Comment ] [-Domain ] [-Server ] - [-WhatIf] [-Confirm] [] +New-GPO [-Name] -StarterGpoName [-Comment ] [-Domain ] + [-Server ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION -The **New-GPO** cmdlet creates a GPO with a specified name. -By default, the newly created GPO is not linked to a site, domain, or organizational unit (OU). -You can use this cmdlet to create a GPO that is based on a starter GPO by specifying the GUID or the display name of the Starter GPO, or by piping a **StarterGpo** object into the cmdlet. +The **New-GPO** cmdlet creates a GPO with a specified name. By default, the newly created GPO is not +linked to a site, domain, or organizational unit (OU). + +You can use this cmdlet to create a GPO that is based on a starter GPO by specifying the GUID or the +display name of the Starter GPO, or by piping a **StarterGpo** object into the cmdlet. -The cmdlet returns a **GPO** object, which represents the created GPO that you can pipe to other Group Policy cmdlets. +The cmdlet returns a **GPO** object, which represents the created GPO that you can pipe to other +Group Policy cmdlets. ## EXAMPLES ### Example 1: Create a GPO in the domain of the user + ```powershell -New-GPO -Name TestGPO -Comment "This is a test GPO." +New-GPO -Name TestGPO -Comment "This is a test GPO." +``` + +```Output DisplayName : TestGPO DomainName : contoso.com Owner : CONTOSO\Domain Admins @@ -60,21 +70,25 @@ ComputerVersion : AD Version: 0, SysVol Version: 0 WmiFilter : ``` -This command creates a GPO in the domain of the user. -The GPO is created with the specified comment. +This command creates a GPO in the domain of the user. The GPO is created with the specified comment. ### Example 2: Create a GPO in the domain of the user that is pre-populated with the settings of the Starter GPO + ```powershell New-GPO -Name "FromStarterGPO" -StarterGPOName "Windows Vista EC Computer Starter GPO" ``` -This command creates a GPO named FromStarterGPO in the domain of the user. -The GPO is pre-populated with the settings of the Starter GPO. +This command creates a GPO named FromStarterGPO in the domain of the user. The GPO is pre-populated +with the settings of the Starter GPO. ### Example 3: Create a GPO in the domain of the user and link it to an OU + ```powershell -new-gpo -name TestGPO | new-gplink -target "ou=marketing,dc=contoso,dc=com" | set-gppermissions -permissionlevel gpoedit -targetname "Marketing Admins" -targettype group +New-GPO -Name TestGPO | New-GPLink -Target "ou=Marketing,dc=contoso,dc=com" | + Set-GPPermissions -PermissionLevel gpoedit -TargetName "Marketing Admins" -TargetType Group +``` +```Output DisplayName : TestGPO DomainName : contoso.com Owner : CONTOSO\Domain Admins @@ -88,19 +102,22 @@ ComputerVersion : AD Version: 0, SysVol Version: 0 WmiFilter : ``` -This command creates a GPO named TestGPO, links it to the Marketing OU in the contoso.com domain, and grants the Marketing Admins security group permissions to edit the GPO. +This command creates a GPO named `TestGPO`, links it to the `Marketing` OU in the `contoso.com` +domain, and grants the `Marketing Admins` security group permissions to edit the GPO. -A GPO object is returned by the command, so you could continue to configure the new GPO by piping the output to other cmdlets. -For example, you could set Registry preference items or registry-based policy settings by piping the output to Set-GPPrefRegistryValue or to Set-GPRegistryValue. +A GPO object is returned by the command, so you could continue to configure the new GPO by piping +the output to other cmdlets. For example, you could set Registry preference items or registry-based +policy settings by piping the output to **Set-GPPrefRegistryValue** or to **Set-GPRegistryValue**. ## PARAMETERS ### -Comment -Includes a comment for the new GPO. -The comment string must be enclosed in double- or single-quotation marks and can contain 2,047 characters. -Use the comment to document the GPO and its implementation in your environment. -Or, if you insert keywords in the comment, you can use the keyword filter to find GPOs that have matching keywords. +Includes a comment for the new GPO. The comment string must be enclosed in double- or +single-quotation marks and can contain 2,047 characters. + +Use the comment to document the GPO and its implementation in your environment. Or, if you insert +keywords in the comment, you can use the keyword filter to find GPOs that have matching keywords. ```yaml Type: System.String @@ -132,8 +149,8 @@ Accept wildcard characters: False ### -Domain -Specifies the domain for this cmdlet. -You must specify the fully qualified domain name (FQDN) of the domain. +Specifies the domain for this cmdlet. You must specify the fully qualified domain name (FQDN) of the +domain. For the **New-GPO** cmdlet: @@ -141,14 +158,16 @@ For the **New-GPO** cmdlet: - If a Starter GPO is specified, it must exist in this domain. -If you do not specify the **Domain** parameter, then the domain of the user running the current session is used. -If the cmdlet is being run from a computer startup or shutdown script, the domain of the computer is used. -For more information, see the Notes section in the full help. +If you do not specify the **Domain** parameter, then the domain of the user running the current +session is used. If the cmdlet is being run from a computer startup or shutdown script, the domain +of the computer is used. For more information, see the Notes section in the full help. -If you specify a domain that is different from the domain of the user running the current session (or the computer for a startup or shutdown script), then a trust must exist between that domain and the domain of the user, or computer. +If you specify a domain that is different from the domain of the user running the current session +(or the computer for a startup or shutdown script), then a trust must exist between that domain and +the domain of the user, or computer. -You can also refer to the *Domain* by its built-in alias, **DomainName**. -For more information, see [about_Aliases](????????????). +You can also refer to the **Domain** by its built-in alias, **DomainName**. For more information, +see [about_Aliases](/powershell/module/microsoft.powershell.core/about/about_aliases). ```yaml Type: System.String @@ -163,12 +182,13 @@ Accept wildcard characters: False ``` ### -Name + Specifies a display name for the new GPO. If another GPO with the same display name exists in the domain an error occurs. -You can also refer to the **Name** parameter by its built-in alias, **DisplayName**. -For more information, see [about_Aliases](????????). +You can also refer to the **Name** parameter by its built-in alias, **DisplayName**. For more +information, see [about_Aliases](/powershell/module/microsoft.powershell.core/about/about_aliases). ```yaml Type: System.String @@ -184,13 +204,14 @@ Accept wildcard characters: False ### -Server -Specifies the name of the domain controller that this cmdlet contacts to complete the operation. -You can specify either the fully qualified domain name (FQDN) or the host name. +Specifies the name of the domain controller that this cmdlet contacts to complete the operation. You +can specify either the fully qualified domain name (FQDN) or the host name. -If you do not specify the name by using the **Server** parameter, the primary domain controller (PDC) emulator is contacted. +If you do not specify the name by using the **Server** parameter, the primary domain controller +(PDC) emulator is contacted. -You can also refer to the *Server* parameter by its built-in alias, **DC**. -For more information, see [about_Aliases](????????). +You can also refer to the **Server** parameter by its built-in alias, **DC**. For more information, +see [about_Aliases](/powershell/module/microsoft.powershell.core/about/about_aliases). ```yaml Type: System.String @@ -205,12 +226,12 @@ Accept wildcard characters: False ``` ### -StarterGpoGuid -Specifies a Starter GPO by its globally unique identifier (GUID). -The GUID uniquely identifies the Starter GPO. -If a Starter GPO is specified, the GPO is created with its settings. -You can also refer to the **StarterGpoGuid* *parameter by its built-in alias, **Id**. -For more information, see [about_Aliases](????????). +Specifies a Starter GPO by its globally unique identifier (GUID). The GUID uniquely identifies the +Starter GPO. If a Starter GPO is specified, the GPO is created with its settings. + +You can also refer to the **StarterGpoGuid** parameter by its built-in alias, **Id**. For more +information, see [about_Aliases](/powershell/module/microsoft.powershell.core/about/about_aliases). ```yaml Type: Guid @@ -225,17 +246,17 @@ Accept wildcard characters: False ``` ### -StarterGpoName -Specifies a Starter GPO by its display name. -The name can contain 255 characters. -If the name includes blank characters, enclose the name in double-quotation marks or single-quotation marks. -If a Starter GPO is specified, the GPO is created with its settings. -The display name is not guaranteed to be unique in the domain. -If another Starter GPO with the same display name exists in the domain, an error occurs. -You can use the **StarterGpoGuid* *parameter to uniquely identify a Starter GPO. +Specifies a Starter GPO by its display name. The name can contain 255 characters. If the name +includes blank characters, enclose the name in double-quotation marks or single-quotation marks. If +a Starter GPO is specified, the GPO is created with its settings. + +The display name is not guaranteed to be unique in the domain. If another Starter GPO with the same +display name exists in the domain, an error occurs. You can use the **StarterGpoGuid** parameter to +uniquely identify a Starter GPO. -You can also refer to the **Name** parameter by its built-in alias, **DisplayName**. -For more information, see [about_Aliases](????????). +You can also refer to the **Name** parameter by its built-in alias, **DisplayName**. For more +information, see [about_Aliases](/powershell/module/microsoft.powershell.core/about/about_aliases). ```yaml Type: System.String @@ -251,8 +272,7 @@ Accept wildcard characters: False ### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml Type: System.Management.Automation.SwitchParameter @@ -268,7 +288,10 @@ Accept wildcard characters: False ### CommonParameters -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). +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). ## INPUTS diff --git a/docset/winserver2022-ps/grouppolicy/New-GPStarterGPO.md b/docset/winserver2022-ps/grouppolicy/New-GPStarterGPO.md index d9777e8a7d..deef30533a 100644 --- a/docset/winserver2022-ps/grouppolicy/New-GPStarterGPO.md +++ b/docset/winserver2022-ps/grouppolicy/New-GPStarterGPO.md @@ -17,29 +17,33 @@ Creates a Starter GPO. ## SYNTAX ``` -New-GPStarterGPO [-Name] [-Comment ] [-Domain ] [-Server ] [-WhatIf] - [-Confirm] [] +New-GPStarterGPO [-Name] [-Comment ] [-Domain ] [-Server ] + [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION -The **New-GPStarterGPO** cmdlet creates a Starter GPO with the specified name. -If the Starter GPOs folder does not exist in the SYSVOL when the **New-GPStarterGPO** cmdlet is called, it is created and populated with the eight Starter GPOs that ship with Group Policy. + +The **New-GPStarterGPO** cmdlet creates a Starter GPO with the specified name. If the Starter GPOs +folder does not exist in the SYSVOL when the **New-GPStarterGPO** cmdlet is called, it is created +and populated with the eight Starter GPOs that ship with Group Policy. ## EXAMPLES ### Example 1: Create a Starter GPO + ```powershell New-GPStarterGPO -Name StarterSecurity -Comment "Security Template" ``` -This command creates a Starter GPO with the display name StarterSecurity. -The Starter GPO is annotated with the specified comment. +This command creates a Starter GPO with the display name StarterSecurity. The Starter GPO is +annotated with the specified comment. ## PARAMETERS ### -Comment -Specifies a comment for the new Starter GPO. -The comment string must be enclosed in double-quotation marks or single-quotation marks and can contain a maximum of 2,047 characters. + +Specifies a comment for the new Starter GPO. The comment string must be enclosed in double-quotation +marks or single-quotation marks and can contain a maximum of 2,047 characters. ```yaml Type: System.String @@ -71,16 +75,17 @@ Accept wildcard characters: False ### -Domain -Specifies the domain for this cmdlet. -You must specify the fully qualified domain name (FQDN) of the domain. +Specifies the domain for this cmdlet. You must specify the fully qualified domain name (FQDN) of the +domain. -Cross-domain creation of Starter GPOs is not supported. -If you specify a domain that is different from the domain of the user that is running the current session, an error occurs. +Cross-domain creation of Starter GPOs is not supported. If you specify a domain that is different +from the domain of the user that is running the current session, an error occurs. -If you do not specify the **Domain** parameter, the domain of the user that is running the current session is used. +If you do not specify the **Domain** parameter, the domain of the user that is running the current +session is used. -You can also refer to the **Domain** parameter by its built-in alias, **DomainName**. -For more information, see [about_Aliases](????????????). +You can also refer to the **Domain** parameter by its built-in alias, **DomainName**. For more +information, see [about_Aliases](/powershell/module/microsoft.powershell.core/about/about_aliases). ```yaml Type: System.String @@ -95,12 +100,13 @@ Accept wildcard characters: False ``` ### -Name + Specifies the display name for the new Starter GPO. If another Starter GPO with the same display name exists in the domain, an error occurs. -You can also refer to the **Name** parameter by its built-in alias, **DisplayName**. -For more information, see [about_Aliases](????????). +You can also refer to the **Name** parameter by its built-in alias, **DisplayName**. For more +information, see [about_Aliases](/powershell/module/microsoft.powershell.core/about/about_aliases). ```yaml Type: System.String @@ -116,13 +122,14 @@ Accept wildcard characters: False ### -Server -Specifies the name of the domain controller that this cmdlet contacts to complete the operation. -You can specify either the fully qualified domain name (FQDN) or the host name. +Specifies the name of the domain controller that this cmdlet contacts to complete the operation. You +can specify either the fully qualified domain name (FQDN) or the host name. -If you do not specify the name by using the **Server** parameter, the primary domain controller (PDC) emulator is contacted. +If you do not specify the name by using the **Server** parameter, the primary domain controller +(PDC) emulator is contacted. -You can also refer to the *Server* parameter by its built-in alias, **DC**. -For more information, see [about_Aliases](????????). +You can also refer to the **Server** parameter by its built-in alias, **DC**. For more information, +see [about_Aliases](/powershell/module/microsoft.powershell.core/about/about_aliases). ```yaml Type: System.String @@ -155,16 +162,21 @@ Accept wildcard characters: False ### CommonParameters -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). +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). ## INPUTS ### None + This cmdlet does not accept any input. ## OUTPUTS ### Microsoft.GroupPolicy.StarterGpo + This cmdlet returns the Starter GPO that was created. ## NOTES diff --git a/docset/winserver2022-ps/grouppolicy/Remove-GPLink.md b/docset/winserver2022-ps/grouppolicy/Remove-GPLink.md index 9d80f52e96..5b382d1361 100644 --- a/docset/winserver2022-ps/grouppolicy/Remove-GPLink.md +++ b/docset/winserver2022-ps/grouppolicy/Remove-GPLink.md @@ -17,26 +17,34 @@ Removes a GPO link from a site, domain or OU. ## SYNTAX ### LinkbyGUID (Default) + ``` -Remove-GPLink -Guid -Target [-Domain ] [-Server ] [-WhatIf] [-Confirm] - [] +Remove-GPLink -Guid -Target [-Domain ] [-Server ] [-WhatIf] + [-Confirm] [] ``` ### LinkbyName + ``` -Remove-GPLink [-Name] -Target [-Domain ] [-Server ] [-WhatIf] [-Confirm] - [] +Remove-GPLink [-Name] -Target [-Domain ] [-Server ] [-WhatIf] + [-Confirm] [] ``` ## DESCRIPTION -The **Remove-GPLink** cmdlet removes the link between a Group Policy Object (GPO) and a specified site, domain, or OU. -This cmdlet does not delete the actual GPO or any other links between the specified GPO and other sites, domains, or OUs. + +The **Remove-GPLink** cmdlet removes the link between a Group Policy Object (GPO) and a specified +site, domain, or OU. This cmdlet does not delete the actual GPO or any other links between the +specified GPO and other sites, domains, or OUs. ## EXAMPLES ### Example 1: Remove the specified GPO link + ```powershell -Remove-GPLink -Name "MyGPO" -Target "OU=MyOU,dc=contoso,dc=com" +Remove-GPLink -Name "MyGPO" -Target "OU=MyOU,dc=contoso,dc=com" +``` + +```Output DisplayName : MyGPO DomainName : contoso.com Owner : CONTOSO\Domain Admins @@ -50,9 +58,11 @@ ComputerVersion : AD Version: 1, SysVol Version: 1 WmiFilter : ``` -This command removes the link between the GPO named MyGPO and the MyOU organizational unit in the contoso.com domain. +This command removes the link between the GPO named `MyGPO` and the `MyOU` organizational unit in +the `contoso.com` domain. ### Example 2: Remove the link between the specified GPO and the default site + ```powershell Remove-GPLink -Name "MyGPO" -Target "Default-First-Site-Name" ``` @@ -60,8 +70,12 @@ Remove-GPLink -Name "MyGPO" -Target "Default-First-Site-Name" This command removes the link between the GPO named MyGPO and the default site. ### Example 3: Remove the links for all GPOs that are linked to the specified organizational unit + ```powershell -(Get-GPInheritance -Target "ou=myou,dc=contoso,dc=com").GpoLinks | Remove-GPLink +(Get-GPInheritance -Target "ou=MyOU,dc=contoso,dc=com").GpoLinks | Remove-GPLink +``` + +```Output DisplayName : TestGPO-3 DomainName : contoso.com Owner : CONTOSO\Domain Admins @@ -87,13 +101,13 @@ ComputerVersion : AD Version: 1, SysVol Version: 1 WmiFilter : ``` -This command removes the links for all the GPOs that are linked to the MyOU organizational unit in the contoso.com domain. +This command removes the links for all the GPOs that are linked to the `MyOU` organizational unit in +the `contoso.com` domain. -This cmdlet is used to get a **Microsoft.GroupPolicy.Som** object for the OU. -The GpoLinks property of the SOM object contains all the GPO links for GPOs that are linked to the OU. -Links that are inherited from higher-level containers are not included. -This collection is piped into **Remove-GPLink**. -The GPOs for which links have been removed are returned. +This cmdlet is used to get a **Microsoft.GroupPolicy.Som** object for the OU. The GpoLinks property +of the SOM object contains all the GPO links for GPOs that are linked to the OU. Links that are +inherited from higher-level containers are not included. This collection is piped into +**Remove-GPLink**. The GPOs for which links have been removed are returned. ## PARAMETERS @@ -115,25 +129,28 @@ Accept wildcard characters: False ### -Domain -Specifies the domain for this cmdlet. -You must specify the fully qualified domain name (FQDN) of the domain. +Specifies the domain for this cmdlet. You must specify the fully qualified domain name (FQDN) of the +domain. For the **Remove-GPLink** cmdlet: - The GPO that is linked must exist in this domain. -- The Active Directory container (site, domain, or OU) that is linked must exist in a domain that has a trust relationship with this domain. +- The Active Directory container (site, domain, or OU) that is linked must exist in a domain that + has a trust relationship with this domain. Note: To specify a domain to link to, use the Target parameter. -If you do not specify the Domain parameter, the domain of the user that is running the current session is used. -If the cmdlet is being run from a computer startup or shutdown script, the domain of the computer is used. -For more information, see the Notes section in the full Help. +If you do not specify the Domain parameter, the domain of the user that is running the current +session is used. If the cmdlet is being run from a computer startup or shutdown script, the domain +of the computer is used. For more information, see the Notes section in the full Help. -If you specify a domain that is different from the domain of the user that is running the current session (or, for a startup or shutdown script, the computer), a trust must exist between that domain and the domain of the user, or the computer. +If you specify a domain that is different from the domain of the user that is running the current +session (or, for a startup or shutdown script, the computer), a trust must exist between that domain +and the domain of the user, or the computer. -You can also refer to the **Domain** parameter by its built-in alias, **DomainName**. -For more information, see [about_Aliases](????????????). +You can also refer to the **Domain** parameter by its built-in alias, **DomainName**. For more +information, see [about_Aliases](/powershell/module/microsoft.powershell.core/about/about_aliases). ```yaml Type: System.String @@ -152,8 +169,8 @@ Accept wildcard characters: False Specifies the GPO for which to remove the link by its globally unique identifier (GUID). The GUID uniquely identifies the GPO. -You can also refer to the **Guid** parameter by its built-in aliases, id and gpoid. -For more information, see [about_Aliases](????????). +You can also refer to the **Guid** parameter by its built-in aliases, **id** and **gpoid**. For more +information, see [about_Aliases](/powershell/module/microsoft.powershell.core/about/about_aliases). ```yaml Type: Guid @@ -171,12 +188,12 @@ Accept wildcard characters: False Specifies the GPO for which to remove the link by its display name. -The display name is not guaranteed to be unique in the domain. -If another GPO with the same display name exists in the domain an error occurs. -You can use the **Guid** parameter to uniquely identify a GPO. +The display name is not guaranteed to be unique in the domain. If another GPO with the same display +name exists in the domain an error occurs. You can use the **Guid** parameter to uniquely identify a +GPO. -You can also refer to the **Name** parameter by its built-in alias, **DisplayName**. -For more information, see [about_Aliases](????????). +You can also refer to the **Name** parameter by its built-in alias, **DisplayName**. For more +information, see [about_Aliases](/powershell/module/microsoft.powershell.core/about/about_aliases). ```yaml Type: System.String @@ -192,13 +209,14 @@ Accept wildcard characters: False ### -Server -Specifies the name of the domain controller that this cmdlet contacts to complete the operation. -You can specify either the fully qualified domain name (FQDN) or the host name. +Specifies the name of the domain controller that this cmdlet contacts to complete the operation. You +can specify either the fully qualified domain name (FQDN) or the host name. -If you do not specify the name by using the **Server** parameter, the primary domain controller (PDC) emulator is contacted. +If you do not specify the name by using the **Server** parameter, the primary domain controller +(PDC) emulator is contacted. -You can also refer to the *Server* parameter by its built-in alias, **DC**. -For more information, see [about_Aliases](????????). +You can also refer to the **Server** parameter by its built-in alias, **DC**. For more information, +see [about_Aliases](/powershell/module/microsoft.powershell.core/about/about_aliases). ```yaml Type: System.String @@ -213,8 +231,10 @@ Accept wildcard characters: False ``` ### -Target -Specifies the Lightweight Directory Access Protocol (LDAP) distinguished name of the site, domain, or OU from which to remove the link. -For instance, for the MyOU organizational unit in the contoso.com domain, the LDAP distinguished name is ou=MyOU,dc=contoso,dc=com. + +Specifies the Lightweight Directory Access Protocol (LDAP) distinguished name of the site, domain, +or OU from which to remove the link. For instance, for the `MyOU` organizational unit in the +`contoso.com` domain, the LDAP distinguished name is `ou=MyOU,dc=contoso,dc=com`. ```yaml Type: System.String @@ -230,8 +250,7 @@ Accept wildcard characters: False ### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml Type: System.Management.Automation.SwitchParameter @@ -249,11 +268,15 @@ Accept wildcard characters: False ### CommonParameters -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). +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). ## INPUTS ### Microsoft.GroupPolicy.GpoLink +~~~~ This cmdlet accepts an object that represents the link between a GPO and a site, domain, or OU. ## OUTPUTS diff --git a/docset/winserver2022-ps/grouppolicy/Remove-GPO.md b/docset/winserver2022-ps/grouppolicy/Remove-GPO.md index c7d1136072..cc2eea037a 100644 --- a/docset/winserver2022-ps/grouppolicy/Remove-GPO.md +++ b/docset/winserver2022-ps/grouppolicy/Remove-GPO.md @@ -17,37 +17,45 @@ Removes a GPO. ## SYNTAX ### ByGUID (Default) + ``` Remove-GPO -Guid [-Domain ] [-Server ] [-KeepLinks] [-WhatIf] [-Confirm] [] ``` ### ByName + ``` Remove-GPO [-Name] [-Domain ] [-Server ] [-KeepLinks] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION -The **Remove-GPO** cmdlet removes the Group Policy Object (GPO) container and data from the directory service and the system volume folder (SysVol). + +The **Remove-GPO** cmdlet removes the Group Policy Object (GPO) container and data from the +directory service and the system volume folder (SysVol). ## EXAMPLES ### Example 1: Remove a GPO by GUID + ```powershell Remove-GPO -Guid 50cc3e45-0b14-46dd-8b4d-afa012bc331c -Domain "contoso.com" -KeepLinks ``` -This command removes the GPO that has the GUID 50cc3e45-0b14-46dd-8b4d-afa012bc331c from the contoso.com domain. -Because the *KeepLinks* parameter is specified, links between the GPO and all sites, and links between the GPO and all containers in the domain are preserved. +This command removes the GPO that has the GUID `50cc3e45-0b14-46dd-8b4d-afa012bc331c` from the +`contoso.com` domain. Because the **KeepLinks** parameter is specified, links between the GPO and +all sites, and links between the GPO and all containers in the domain are preserved. ### Example 2: Remove a GPO by name + ```powershell Remove-GPO -Name "TestGPO" ``` -This command removes the GPO named TestGPO from the domain of the user that is running the session. -Because the *KeepLinks* parameter is not specified, links between the GPO and all sites, and links between the GPO and all containers in the domain are removed. +This command removes the GPO named `TestGPO` from the domain of the user that is running the session. +Because the **KeepLinks** parameter is not specified, links between the GPO and all sites, and links +between the GPO and all containers in the domain are removed. ## PARAMETERS @@ -68,12 +76,15 @@ Accept wildcard characters: False ``` ### -Domain -Specifies the domain in which you want to remove a GPO. -You must specify the fully qualified domain name (FQDN) of the domain. -If you do not specify the **Domain** parameter, the domain of the computer that you are logged on to is used. +Specifies the domain in which you want to remove a GPO. You must specify the fully qualified domain +name (FQDN) of the domain. -If you specify a domain that differs from the domain of your user object, a trust must exist between the domain from which you want to remove the GPO and the domain of your user object. +If you do not specify the **Domain** parameter, the domain of the computer that you are logged on to +is used. + +If you specify a domain that differs from the domain of your user object, a trust must exist between +the domain from which you want to remove the GPO and the domain of your user object. ```yaml Type: System.String @@ -89,11 +100,11 @@ Accept wildcard characters: False ### -Guid -Specifies the GPO to remove by its globally unique identifier (GUID). -The GUID uniquely identifies the GPO. +Specifies the GPO to remove by its globally unique identifier (GUID). The GUID uniquely identifies +the GPO. -You can also refer to the **Guid** parameter by its built-in alias, **Id**. -For more information, see [about_Aliases](????????????). +You can also refer to the **Guid** parameter by its built-in alias, **Id**. For more information, +see [about_Aliases](/powershell/module/microsoft.powershell.core/about/about_aliases). ```yaml Type: Guid @@ -108,7 +119,9 @@ Accept wildcard characters: False ``` ### -KeepLinks -Indicates that the cmdlet preserves the links to the GPO in the specified domain, including OUs, and all sites when the GPO is removed. + +Indicates that the cmdlet preserves the links to the GPO in the specified domain, including OUs, and +all sites when the GPO is removed. ```yaml Type: System.Management.Automation.SwitchParameter @@ -123,14 +136,15 @@ Accept wildcard characters: False ``` ### -Name + Specifies the GPO that this cmdlet removes by its display name. -The display name is not guaranteed to be unique in the domain. -If another GPO with the same display name exists in the domain an error occurs. -You can use the **Guid** parameter to uniquely identify a GPO. +The display name is not guaranteed to be unique in the domain. If another GPO with the same display +name exists in the domain an error occurs. You can use the **Guid** parameter to uniquely identify a +GPO. -You can also refer to the **Name** parameter by its built-in alias, **DisplayName**. -For more information, see [about_Aliases](????????). +You can also refer to the **Name** parameter by its built-in alias, **DisplayName**. For more +information, see [about_Aliases](/powershell/module/microsoft.powershell.core/about/about_aliases). ```yaml Type: System.String @@ -146,13 +160,14 @@ Accept wildcard characters: False ### -Server -Specifies the name of the domain controller that this cmdlet contacts to complete the operation. -You can specify either the fully qualified domain name (FQDN) or the host name. +Specifies the name of the domain controller that this cmdlet contacts to complete the operation. You +can specify either the fully qualified domain name (FQDN) or the host name. -If you do not specify the name by using the **Server** parameter, the primary domain controller (PDC) emulator is contacted. +If you do not specify the name by using the **Server** parameter, the primary domain controller +(PDC) emulator is contacted. -You can also refer to the *Server* parameter by its built-in alias, **DC**. -For more information, see [about_Aliases](????????). +You can also refer to the **Server** parameter by its built-in alias, **DC**. For more information, +see [about_Aliases](/powershell/module/microsoft.powershell.core/about/about_aliases). ```yaml Type: System.String @@ -168,8 +183,7 @@ Accept wildcard characters: False ### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml Type: System.Management.Automation.SwitchParameter @@ -185,11 +199,15 @@ Accept wildcard characters: False ### CommonParameters -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). +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). ## INPUTS ### Microsoft.GroupPolicy.Gpo + This cmdlet pipes the GPO to be removed. Collections that contain GPOs from different domains are not supported. @@ -201,7 +219,13 @@ This cmdlet does not generate any output. ## NOTES -* When you remove a GPO, by default, all links to that GPO in the domain of the GPO are deleted. To remove a link to a GPO, you must have permission to link Group Policy Objects for the organizational unit or domain. If you do not have rights to delete a link, the GPO is deleted, but the link remains. Links from other domains and sites are not removed. The link to a deleted GPO appears in the GPMC as Not Found. To remove Not Found links, you must either have permission on the site, domain, or organizational unit containing the link, or ask someone with sufficient rights to delete it. +* When you remove a GPO, by default, all links to that GPO in the domain of the GPO are deleted. To + remove a link to a GPO, you must have permission to link Group Policy Objects for the + organizational unit or domain. If you do not have rights to delete a link, the GPO is deleted, but + the link remains. Links from other domains and sites are not removed. The link to a deleted GPO + appears in the GPMC as Not Found. To remove Not Found links, you must either have permission on + the site, domain, or organizational unit containing the link, or ask someone with sufficient + rights to delete it. ## RELATED LINKS diff --git a/docset/winserver2022-ps/grouppolicy/Remove-GPPrefRegistryValue.md b/docset/winserver2022-ps/grouppolicy/Remove-GPPrefRegistryValue.md index f1c13c2a76..c183f6d5bb 100644 --- a/docset/winserver2022-ps/grouppolicy/Remove-GPPrefRegistryValue.md +++ b/docset/winserver2022-ps/grouppolicy/Remove-GPPrefRegistryValue.md @@ -12,47 +12,68 @@ title: Remove-GPPrefRegistryValue ## SYNOPSIS -Removes one or more Registry preference items from either Computer Configuration or User Configuration in a GPO. +Removes one or more Registry preference items from either Computer Configuration or User +Configuration in a GPO. ## SYNTAX ### GetByGUID (Default) + ``` -Remove-GPPrefRegistryValue -Guid -Context -Key [-ValueName ] - [-Order ] [-Domain ] [[-Server] ] [-WhatIf] [-Confirm] [] +Remove-GPPrefRegistryValue -Guid -Context -Key + [-ValueName ] [-Order ] [-Domain ] [[-Server] ] [-WhatIf] [-Confirm] + [] ``` ### GetByName + ``` -Remove-GPPrefRegistryValue [-Name] -Context -Key [-ValueName ] - [-Order ] [-Domain ] [[-Server] ] [-WhatIf] [-Confirm] [] +Remove-GPPrefRegistryValue [-Name] -Context -Key + [-ValueName ] [-Order ] [-Domain ] [[-Server] ] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION -The **Remove-GPPrefRegistryValue** cmdlet removes one or more Registry preference items from either Computer Configuration or User Configuration in a GPO. -You must specify the *Context* parameter for the User or Computer to indicate whether to remove the Registry preference item from Computer Configuration or User Configuration. -You can specify the GPO by its display name or by its GUID. + +The **Remove-GPPrefRegistryValue** cmdlet removes one or more Registry preference items from either +Computer Configuration or User Configuration in a GPO. You must specify the **Context** parameter +for the User or Computer to indicate whether to remove the Registry preference item from Computer +Configuration or User Configuration. You can specify the GPO by its display name or by its GUID. You can specify either a key or a value: -- If you specify a key, all Registry preference items that configure that registry key or any of its first-level values are removed from the specified configuration in the GPO. -Registry preference items that configure subkeys of that key or their values are not affected. -For a key, specify the *Key* parameter without the *ValueName* parameter. +- If you specify a key, all Registry preference items that configure that registry key or any of its + first-level values are removed from the specified configuration in the GPO. Registry preference + items that configure subkeys of that key or their values are not affected. For a key, specify the + **Key** parameter without the *ValueName* parameter. -- If you specify a value, all Registry preference items that configure that registry value are removed from the specified configuration in the GPO. -For a value, specify the *Key* parameter without the *ValueName* parameter. +- If you specify a value, all Registry preference items that configure that registry value are + removed from the specified configuration in the GPO. For a value, specify the **Key** parameter + without the **ValueName** parameter. This cmdlet can take input from the pipeline: -- You can pipe GPO objects to this cmdlet to remove a specified Registry preference item from one or more GPOs. +- You can pipe GPO objects to this cmdlet to remove a specified Registry preference item from one or + more GPOs. -- You can pipe **PreferencRegistrySetting** objects to this cmdlet to remove one or more Registry preference items from a specified GPO. +- You can pipe **PreferencRegistrySetting** objects to this cmdlet to remove one or more Registry + preference items from a specified GPO. ## EXAMPLES ### Example 1: Remove all registry preference item under the specified registry + ```powershell -Remove-GPPrefRegistryValue -Name "TestGPO" -Context User -Key "HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\ExampleKey" -ValueName "ValueOne" +$params = @{ + Name = 'TestGPO' + Context = 'User' + Key = 'HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\ExampleKey' + ValueName = 'ValueOne' +} +Remove-GPPrefRegistryValue @params +``` + +```Output DisplayName : TestGPO DomainName : contoso.com Owner : CONTOSO\Domain Admins @@ -66,11 +87,23 @@ ComputerVersion : AD Version: 0, SysVol Version: 0 WmiFilter : ``` -This command removes all Registry preference items that configure the registry value HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\ExampleKey ValueOne from User Configuration in the GPO named TestGPO. +This command removes all Registry preference items that configure the registry value +`HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\ExampleKey ValueOne` from User Configuration in the GPO named +`TestGPO`. ### Example 2: Remove registry preference items that configure first-level values + ```powershell -Remove-GPPrefRegistryValue -Name "TestGPO" -Context "Computer" -Key "HKLM\SOFTWARE\Microsoft\ExampleKey" +$params = @{ + Name = "TestGPO" + Context = "Computer" + Key = "HKLM\SOFTWARE\Microsoft\ExampleKey" + +} +Remove-GPPrefRegistryValue @params +``` + +```Output DisplayName : TestGPO DomainName : contoso.com Owner : CONTOSO\Domain Admins @@ -84,11 +117,23 @@ ComputerVersion : AD Version: 0, SysVol Version: 0 WmiFilter : ``` -This command removes Registry preference items that configure any first-level values under the registry key HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\ExampleKey or the key itself from Computer Configuration in the GPO named TestGPO. +This command removes Registry preference items that configure any first-level values under the +registry key `HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\ExampleKey` or the key itself from `Computer` +Configuration in the GPO named `TestGPO`. ### Example 3: Remove any registry preference items for all GPOs + ```powershell -Get-GPO -All | Remove-GPPrefRegistryValue -Context "User" -Key "HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\ExampleKey" -ValueName "ValueOne" -ErrorAction SilentlyContinue +$params = @{ + Context = 'User' + Key = 'HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\ExampleKey' + ValueName = 'ValueOne' + ErrorAction = 'SilentlyContinue' +} +Get-GPO -All | Remove-GPPrefRegistryValue @params +``` + +```Output DisplayName : TestGPO DomainName : contoso.com Owner : CONTOSO\Domain Admins @@ -115,12 +160,15 @@ ComputerVersion : AD Version: 0, SysVol Version: 0 WmiFilter : ``` -This command removes any Registry preference items that configure the registry value "HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\ExampleKey ValueOne" from User Configuration for all GPOs in the domain. -It returns each GPO from which at least one Registry preference item is removed. +This command removes any Registry preference items that configure the registry value +`HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\ExampleKey ValueOne` from `User` Configuration for all GPOs +in the domain. It returns each GPO from which at least one Registry preference item is removed. -This cmdlet returns a non-terminating error for each GPO that does not have a Registry preference item associated with the specified registry value. -In this command, these error messages are suppressed by setting the *ErrorAction* parameter to SilentlyContinue. -For more information about the *ErrorAction* parameter, see about_CommonParameters. +This cmdlet returns a non-terminating error for each GPO that does not have a Registry preference +item associated with the specified registry value. In this command, these error messages are +suppressed by setting the **ErrorAction** parameter to `SilentlyContinue`. For more information +about the **ErrorAction** parameter, see +[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## PARAMETERS @@ -141,8 +189,9 @@ Accept wildcard characters: False ``` ### -Context -Specifies whether the Registry preference item (or items) are removed from Computer Configuration or User Configuration in the specified GPO. -You must specify either User or Computer. + +Specifies whether the Registry preference item (or items) are removed from Computer Configuration or +User Configuration in the specified GPO. You must specify either User or Computer. ```yaml Type: GpoConfiguration @@ -159,18 +208,21 @@ Accept wildcard characters: False ### -Domain -Specifies the domain for which this cmdlet runs the operation. -You must specify the fully qualified domain name (FQDN) of the domain. +Specifies the domain for which this cmdlet runs the operation. You must specify the fully qualified +domain name (FQDN) of the domain. -For the **Remove-GPPrefRegistryValue** cmdlet, the GPO from which to remove the Registry preference item or items must exist in this domain. +For the **Remove-GPPrefRegistryValue** cmdlet, the GPO from which to remove the Registry preference +item or items must exist in this domain. -If you do not specify the **Domain** parameter, the domain of the user that is running the current session is used. -(If the cmdlet is being run from a computer startup or shutdown script, the domain of the computer is used.) For more information, see the Notes section in the full Help. +If you do not specify the **Domain** parameter, the domain of the user that is running the current +session is used. (If the cmdlet is being run from a computer startup or shutdown script, the domain +of the computer is used.) For more information, see the Notes section in the full Help. -If you specify a domain that is different from the domain of the user that is running the current session, a trust must exist between that domain and the domain of the user or the computer. +If you specify a domain that is different from the domain of the user that is running the current +session, a trust must exist between that domain and the domain of the user or the computer. -You can also refer to the Domain parameter by its built-in alias, **DomainName**. -For more information, see [about_Aliases](????????????). +You can also refer to the Domain parameter by its built-in alias, **DomainName**. For more +information, see [about_Aliases](/powershell/module/microsoft.powershell.core/about/about_aliases). ```yaml Type: System.String @@ -186,8 +238,8 @@ Accept wildcard characters: False ### -Guid -Specifies the GPO from which to remove the Registry preference item by its globally unique identifier (GUID). -The GUID uniquely identifies the GPO. +Specifies the GPO from which to remove the Registry preference item by its globally unique +identifier (GUID). The GUID uniquely identifies the GPO. You can also refer to the **Guid** parameter by its built-in alias, **Id**. @@ -204,18 +256,23 @@ Accept wildcard characters: False ``` ### -Key -Specifies a registry key for which to remove one or more Registry preference items; for instance, HKCU\Control Panel\Colors. +Specifies a registry key for which to remove one or more Registry preference items; for instance, +HKCU\Control Panel\Colors. -You can specify any of the following registry hives: HKEY_CLASSES_ROOT (HKCR), HKEY_CURRENT_USER (HKCU), HKEY_LOCAL_MACHINE (HKLM), HKEY_USERS (HKU), and HKEY_CURRENT_CONFIG (HKCC). -Any of these hives can be specified for Registry preference items in both Computer Configuration and User Configuration. +You can specify any of the following registry hives: `HKEY_CLASSES_ROOT` (HKCR), `HKEY_CURRENT_USER` +(HKCU), `HKEY_LOCAL_MACHINE` (HKLM), `HKEY_USERS` (HKU), and `HKEY_CURRENT_CONFIG` (HKCC). Any of +these hives can be specified for Registry preference items in both Computer Configuration and User +Configuration. -The *Key* parameter can be specified with or without the *ValueName* parameter: +The **Key** parameter can be specified with or without the **ValueName** parameter: -- If the *ValueName* parameter is specified, all Registry preference items that configure the registry value are removed. +- If the **ValueName** parameter is specified, all Registry preference items that configure the + registry value are removed. -- If the *ValueName* parameter is not specified, all Registry preference items that configure the registry key and any of its first-level values are removed. +- If the **ValueName** parameter is not specified, all Registry preference items that configure the + registry key and any of its first-level values are removed. -You can also refer to the *Key* parameter by its built-in alias, FullKeyPath. +You can also refer to the **Key** parameter by its built-in alias, FullKeyPath. ```yaml Type: System.String @@ -230,11 +287,12 @@ Accept wildcard characters: False ``` ### -Name + Specifies the GPO from which to remove the Registry preference item by its display name. -The display name is not guaranteed to be unique in the domain. -If another GPO with the same display name exists in the domain an error occurs. -You can use the Guid parameter to uniquely identify a GPO. +The display name is not guaranteed to be unique in the domain. If another GPO with the same display +name exists in the domain an error occurs. You can use the Guid parameter to uniquely identify a +GPO. You can also refer to the **Name** parameter by its built-in alias, **DisplayName**. @@ -251,7 +309,9 @@ Accept wildcard characters: False ``` ### -Order -Specifies the order in which a Registry preference item is processed relative to other Registry preference items in the GPO when the GPO is applied on a client computer. + +Specifies the order in which a Registry preference item is processed relative to other Registry +preference items in the GPO when the GPO is applied on a client computer. ```yaml Type: Int32 @@ -267,12 +327,13 @@ Accept wildcard characters: False ### -Server -Specifies the name of the domain controller that this cmdlet contacts to complete the operation. -You can specify either the fully qualified domain name (FQDN) or the host name. +Specifies the name of the domain controller that this cmdlet contacts to complete the operation. You +can specify either the fully qualified domain name (FQDN) or the host name. -If you do not specify the name by using the **Server** parameter, the primary domain controller (PDC) emulator is contacted. +If you do not specify the name by using the **Server** parameter, the primary domain controller +(PDC) emulator is contacted. -You can also refer to the *Server* parameter by its built-in alias, **DC**. +You can also refer to the **Server** parameter by its built-in alias, **DC**. ```yaml Type: System.String @@ -287,8 +348,9 @@ Accept wildcard characters: False ``` ### -ValueName -Specifies the name of a registry value for which to remove all Registry preference items. -If you specify the *ValueName* parameter, you must also specify the *Key* parameter. + +Specifies the name of a registry value for which to remove all Registry preference items. If you +specify the **ValueName** parameter, you must also specify the **Key** parameter. ```yaml Type: System.String @@ -304,8 +366,7 @@ Accept wildcard characters: False ### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml Type: System.Management.Automation.SwitchParameter @@ -321,15 +382,20 @@ Accept wildcard characters: False ### CommonParameters -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). +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). ## INPUTS ### Microsoft.GroupPolicy.Gpo, Microsoft.GroupPolicy.PreferenceRegistrySetting -This cmdlet takes a GPO or a **PreferenceRegistrySetting** object as input. -You can pipe in one or more **PreferenceRegistrySetting** objects to remove one or more Registry preference items from a specified GPO. -You can pipe in one or more GPO objects, such as Get-GPO, to remove a specified Registry preference item from each GPO. -Collections that contain GPOs from different domains are not supported. + +This cmdlet takes a GPO or a **PreferenceRegistrySetting** object as input. You can pipe in one or +more **PreferenceRegistrySetting** objects to remove one or more Registry preference items from a +specified GPO. You can pipe in one or more GPO objects, such as Get-GPO, to remove a specified +Registry preference item from each GPO. Collections that contain GPOs from different domains are not +supported. ## OUTPUTS @@ -341,13 +407,15 @@ This cmdlet returns the GPO from which the Registry preference item or items tha * You can use the **Domain** parameter to explicitly specify the domain for this cmdlet. - If you do not explicitly specify the domain, the cmdlet uses a default domain. -The default domain is the domain that is used to access network resources by the security context under which the current session is running. -This domain is typically the domain of the user that is running the session. -For instance, the domain of the user who started the session by opening Windows PowerShell from the Program Files menu, or the domain of a user that is specified in a runas command. -However, computer startup and shutdown scripts run under the context of the LocalSystem account. -The LocalSystem account is a built-in local account, and it accesses network resources under the context of the computer account. -Therefore, when this cmdlet is run from a startup or shutdown script, the default domain is the domain to which the computer is joined. + If you do not explicitly specify the domain, the cmdlet uses a default domain. The default domain + is the domain that is used to access network resources by the security context under which the + current session is running. This domain is typically the domain of the user that is running the + session. For instance, the domain of the user who started the session by opening Windows + PowerShell from the Program Files menu, or the domain of a user that is specified in a runas + command. However, computer startup and shutdown scripts run under the context of the LocalSystem + account. The LocalSystem account is a built-in local account, and it accesses network resources + under the context of the computer account. Therefore, when this cmdlet is run from a startup or + shutdown script, the default domain is the domain to which the computer is joined. ## RELATED LINKS diff --git a/docset/winserver2022-ps/grouppolicy/Remove-GPRegistryValue.md b/docset/winserver2022-ps/grouppolicy/Remove-GPRegistryValue.md index d966a4afb1..d32677cafe 100644 --- a/docset/winserver2022-ps/grouppolicy/Remove-GPRegistryValue.md +++ b/docset/winserver2022-ps/grouppolicy/Remove-GPRegistryValue.md @@ -17,41 +17,57 @@ Removes one or more registry-based policy settings from either Computer Configur ## SYNTAX ### GetByGUID (Default) + ``` Remove-GPRegistryValue [-Guid] [-Key] [[-ValueName] ] [[-Domain] ] [[-Server] ] [-WhatIf] [-Confirm] [] ``` ### GetByName + ``` Remove-GPRegistryValue [-Name] [-Key] [[-ValueName] ] [[-Domain] ] [[-Server] ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION -The **Remove-GPRegistryValue** cmdlet removes one or more registry-based policy settings from either Computer Configuration or User Configuration in a Group Policy Object (GPO). -You can specify the GPO by its display name or by its GUID. + +The **Remove-GPRegistryValue** cmdlet removes one or more registry-based policy settings from either +Computer Configuration or User Configuration in a Group Policy Object (GPO). You can specify the GPO +by its display name or by its GUID. You can specify either a key or a value: -- If you specify a key, registry-based policy settings that configure any of its first-level values are removed. -However, if there are registry-based policy settings that configure any subkeys or their values, an error occurs and no policy settings are removed, including those for first-level values of the key. -For a key, specify the *Key* parameter without the *ValueName* parameter. +- If you specify a key, registry-based policy settings that configure any of its first-level values + are removed. However, if there are registry-based policy settings that configure any subkeys or + their values, an error occurs and no policy settings are removed, including those for first-level + values of the key. For a key, specify the **Key** parameter without the *ValueName* parameter. -- If you specify a value, the registry-based policy setting that configures that registry value is removed. -For a value, specify the *Key* parameter without the *ValueName* parameter. +- If you specify a value, the registry-based policy setting that configures that registry value is + removed. For a value, specify the **Key** parameter without the *ValueName* parameter. This cmdlet can take input from the pipeline: -- You can pipe GPO objects to this cmdlet to remove a specified registry-based policy setting from one or more GPOs. +- You can pipe GPO objects to this cmdlet to remove a specified registry-based policy setting from + one or more GPOs. -- You can pipe **PolicyRegistrySetting** objects to this cmdlet to remove one or more registry-based policy settings from a specified GPO. +- You can pipe **PolicyRegistrySetting** objects to this cmdlet to remove one or more registry-based + policy settings from a specified GPO. ## EXAMPLES ### Example 1: Remove a registry-based policy setting under the specified registry key + ```powershell -Remove-GPRegistryValue -Name "TestGPO" -Key "HKCU\Software\Policies\Microsoft\Windows\Control Panel\Desktop" -ValueName "ScreenSaveTimeOut" +$params = @{ + Name = 'TestGPO' + Key = 'HKCU\Software\Policies\Microsoft\Windows\Control Panel\Desktop' + ValueName = 'ScreenSaveTimeOut' +} +Remove-GPRegistryValue @params +``` + +```Output DisplayName : TestGPO DomainName : contoso.com Owner : CONTOSO\Domain Admins @@ -65,18 +81,24 @@ ComputerVersion : AD Version: 34, SysVol Version: 34 WmiFilter : ``` -This command removes the registry-based policy setting for the registry value HKEY_CURRENT_USER\Software\Policies\Microsoft\Windows\Control Panel\Desktop ScreenSaveTimeout from the GPO named TestGPO. -The registry value is no longer modified when the GPO is applied on a client. -Removing a policy setting does not delete the registry value on a client. -To delete the registry value when the GPO is applied on a client, you must disable the policy setting by using the **Set-GPRegistryValue** cmdlet. +This command removes the registry-based policy setting for the registry value +`HKEY_CURRENT_USER\Software\Policies\Microsoft\Windows\Control Panel\Desktop ScreenSaveTimeout` from +the GPO named `TestGPO`. The registry value is no longer modified when the GPO is applied on a +client. Removing a policy setting does not delete the registry value on a client. To delete the +registry value when the GPO is applied on a client, you must disable the policy setting by using the +**Set-GPRegistryValue** cmdlet. ### Example 2: Remove all the registry-based policy settings under the specified registry key + ```powershell Remove-GPRegistryValue -Name "TestGPO" -Key "HKCU\Software\Policies\Microsoft\ExampleKey" ``` -This command removes all the registry-based policy settings that configure first-level registry values under the key HKEY_CURRENT_USER\Software\Policies\Microsoft\ExampleKey from User Configuration in the GPO named TestGPO. -If there are registry-based policy settings in User Configuration that configure registry values for any subkeys of this key, an error occurs and no first-level policy settings are removed. +This command removes all the registry-based policy settings that configure first-level registry +values under the key `HKEY_CURRENT_USER\Software\Policies\Microsoft\ExampleKey` from `User` +Configuration in the GPO named `TestGPO`. If there are registry-based policy settings in `User` +Configuration that configure registry values for any subkeys of this key, an error occurs and no +first-level policy settings are removed. ## PARAMETERS @@ -98,19 +120,21 @@ Accept wildcard characters: False ### -Domain -Specifies the domain for this cmdlet. -You must specify the fully qualified domain name (FQDN) of the domain. +Specifies the domain for this cmdlet. You must specify the fully qualified domain name (FQDN) of the +domain. For the **Remove-GPRegistryValue** cmdlet, the GPO from which to remove the registry-based policy setting must exist in this domain. -If you do not specify the **Domain** parameter, the domain of the user that is running the current session is used. -If the cmdlet is being run from a computer startup or shutdown script, the domain of the computer is used. -For more information, see the Notes section in the full Help. +If you do not specify the **Domain** parameter, the domain of the user that is running the current +session is used. If the cmdlet is being run from a computer startup or shutdown script, the domain +of the computer is used. For more information, see the Notes section in the full Help. -If you specify a domain that is different from the domain of the user that is running the current session (or, for a startup or shutdown script, the computer), a trust must exist between that domain and the domain of the user or the computer. +If you specify a domain that is different from the domain of the user that is running the current +session (or, for a startup or shutdown script, the computer), a trust must exist between that domain +and the domain of the user or the computer. -You can also refer to the **Domain** parameter by its built-in alias, **DomainName**. -For more information, see [about_Aliases](????????????). +You can also refer to the **Domain** parameter by its built-in alias, **DomainName**. For more +information, see [about_Aliases](/powershell/module/microsoft.powershell.core/about/about_aliases). ```yaml Type: System.String @@ -126,8 +150,8 @@ Accept wildcard characters: False ### -Guid -Specifies the GPO from which to remove the registry-based policy setting by its globally unique identifier (GUID). -The GUID uniquely identifies the GPO. +Specifies the GPO from which to remove the registry-based policy setting by its globally unique +identifier (GUID). The GUID uniquely identifies the GPO. You can also refer to the **Guid** parameter by its built-in alias, **Id**. @@ -144,20 +168,24 @@ Accept wildcard characters: False ``` ### -Key -Specifies a registry key for which to remove one or more registry-based policy settings (for instance: HKLM\Software\Policies\Microsoft\WindowsNT\DNSClient\UseDomainNameDevolution). + +Specifies a registry key for which to remove one or more registry-based policy settings (for +instance: `HKLM\Software\Policies\Microsoft\WindowsNT\DNSClient\UseDomainNameDevolution`). The key must be in one of the two following registry hives: -- HKEY_LOCAL_MACHINE (HKLM) for a registry-based policy setting in Computer Configuration. +- `HKEY_LOCAL_MACHINE` (HKLM) for a registry-based policy setting in Computer Configuration. -- HKEY_CURRENT_USER (HKCU) for a registry-based policy setting in User Configuration. +- `HKEY_CURRENT_USER` (HKCU) for a registry-based policy setting in User Configuration. The Key parameter can be specified with or without the ValueName parameter: -- If the *ValueName* parameter is specified, the registry-based policy setting that configures that registry value is removed. +- If the **ValueName** parameter is specified, the registry-based policy setting that configures + that registry value is removed. -- If the *ValueName* parameter is not specified, all registry-based policy settings that configure any of the first-level values of the registry key are removed. -If there are registry-based policy settings that configure any subkeys or their values, an error occurs. +- If the **ValueName** parameter is not specified, all registry-based policy settings that configure + any of the first-level values of the registry key are removed. If there are registry-based policy + settings that configure any subkeys or their values, an error occurs. You can also refer to the Key parameter by its built-in alias, FullKeyPath. @@ -174,11 +202,12 @@ Accept wildcard characters: False ``` ### -Name + Specifies the GPO from which to remove the registry-based policy setting by its display name. -The display name is not guaranteed to be unique in the domain. -If another GPO with the same display name exists in the domain an error occurs. -You can use the **Guid** parameter to uniquely identify a GPO. +The display name is not guaranteed to be unique in the domain. If another GPO with the same display +name exists in the domain an error occurs. You can use the **Guid** parameter to uniquely identify a +GPO. You can also refer to the **Name** parameter by its built-in alias, **DisplayName**. @@ -196,12 +225,13 @@ Accept wildcard characters: False ### -Server -Specifies the name of the domain controller that this cmdlet contacts to complete the operation. -You can specify either the fully qualified domain name (FQDN) or the host name. +Specifies the name of the domain controller that this cmdlet contacts to complete the operation. You +can specify either the fully qualified domain name (FQDN) or the host name. -If you do not specify the name by using the **Server** parameter, the primary domain controller (PDC) emulator is contacted. +If you do not specify the name by using the **Server** parameter, the primary domain controller +(PDC) emulator is contacted. -You can also refer to the *Server* parameter by its built-in alias, **DC**. +You can also refer to the **Server** parameter by its built-in alias, **DC**. ```yaml Type: System.String @@ -216,8 +246,9 @@ Accept wildcard characters: False ``` ### -ValueName -Specifies the name of the registry value for which to remove the registry-based policy setting. -If you specify the *ValueName* parameter, you must also specify the *Key* parameter. + +Specifies the name of the registry value for which to remove the registry-based policy setting. If +you specify the **ValueName** parameter, you must also specify the **Key** parameter. ```yaml Type: System.String @@ -233,8 +264,7 @@ Accept wildcard characters: False ### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml Type: System.Management.Automation.SwitchParameter @@ -250,35 +280,46 @@ Accept wildcard characters: False ### CommonParameters -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). +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). ## INPUTS ### Microsoft.GroupPolicy.Gpo, Microsoft.GroupPolicy.PolicyRegistrySetting -You can pipe a GPO from which to remove a registry-based policy setting, or a **PolicyRegistrySetting** object that represents a registry-based policy setting. -Collections that contain GPOs from different domains are not supported. + +You can pipe a GPO from which to remove a registry-based policy setting, or a +**PolicyRegistrySetting** object that represents a registry-based policy setting. Collections that +contain GPOs from different domains are not supported. ## OUTPUTS ### Microsoft.GroupPolicy.Gpo -This cmdlet returns the GPO from which the registry-based policy setting (or settings) has been removed. +This cmdlet returns the GPO from which the registry-based policy setting (or settings) has been +removed. ## NOTES -* The hive of the registry key that you specify -- HKEY_LOCAL_MACHINE (HKLM) or HKEY_CURRENT_USER (HKCU) indicates whether the registry-based policy setting is removed from Computer Configuration or User Configuration. +* The hive of the registry key that you specify -- `HKEY_LOCAL_MACHINE` (HKLM) or + `HKEY_CURRENT_USER` (HKCU) indicates whether the registry-based policy setting is removed from + Computer Configuration or User Configuration. - If a value for the registry key cannot be located (the registry key is not configured) or if subkeys are present, an error occurs and a corresponding error message is displayed. + If a value for the registry key cannot be located (the registry key is not configured) or if + subkeys are present, an error occurs and a corresponding error message is displayed. You can use the **Domain** parameter to explicitly specify the domain for this cmdlet. - If you do not explicitly specify the domain, the cmdlet uses a default domain. -The default domain is the domain that is used to access network resources by the security context under which the current session is running. -This domain is typically the domain of the user that is running the session. -For instance, the domain of the user who started the session by opening Windows PowerShell from the Program Files menu, or the domain of a user that is specified in a runas command. -However, computer startup and shutdown scripts run under the context of the LocalSystem account. -The LocalSystem account is a built-in local account, and it accesses network resources under the context of the computer account. -Therefore, when this cmdlet is run from a startup or shutdown script, the default domain is the domain to which the computer is joined. + If you do not explicitly specify the domain, the cmdlet uses a default domain. The default domain + is the domain that is used to access network resources by the security context under which the + current session is running. This domain is typically the domain of the user that is running the + session. For instance, the domain of the user who started the session by opening Windows + PowerShell from the Program Files menu, or the domain of a user that is specified in a runas + command. However, computer startup and shutdown scripts run under the context of the LocalSystem + account. The LocalSystem account is a built-in local account, and it accesses network resources + under the context of the computer account. Therefore, when this cmdlet is run from a startup or + shutdown script, the default domain is the domain to which the computer is joined. ## RELATED LINKS diff --git a/docset/winserver2022-ps/grouppolicy/Rename-GPO.md b/docset/winserver2022-ps/grouppolicy/Rename-GPO.md index bcb37ea9b8..5f5e1c7103 100644 --- a/docset/winserver2022-ps/grouppolicy/Rename-GPO.md +++ b/docset/winserver2022-ps/grouppolicy/Rename-GPO.md @@ -17,26 +17,33 @@ Assigns a new display name to a GPO. ## SYNTAX ### RenameByGUID (Default) + ``` -Rename-GPO -Guid -TargetName [-Domain ] [-Server ] [-WhatIf] [-Confirm] - [] +Rename-GPO -Guid -TargetName [-Domain ] [-Server ] [-WhatIf] + [-Confirm] [] ``` ### RenameByName + ``` -Rename-GPO [-Name] -TargetName [-Domain ] [-Server ] [-WhatIf] [-Confirm] - [] +Rename-GPO [-Name] -TargetName [-Domain ] [-Server ] [-WhatIf] + [-Confirm] [] ``` ## DESCRIPTION + The **Rename-GPO** cmdlet assigns a different, non-null display name to a Group Policy Object (GPO). This cmdlet has no effect on the GUID of the GPO. ## EXAMPLES ### Example 1: Rename a GPO + ```powershell Rename-GPO -Name "SampleGPO" -TargetName "SecurityGPO" +``` + +```Output DisplayName : securityGPO DomainName : contoso.com Owner : CONTOSO\Domain Admins @@ -50,7 +57,7 @@ ComputerVersion : AD Version: 0, SysVol Version: 0 WmiFilter : ``` -This command renames the GPO named SampleGPO to SecurityGPO. +This command renames the GPO named `SampleGPO` to `SecurityGPO`. ## PARAMETERS @@ -72,19 +79,21 @@ Accept wildcard characters: False ### -Domain -Specifies the domain for this cmdlet. -You must specify the fully qualified domain name (FQDN) of the domain. +Specifies the domain for this cmdlet. You must specify the fully qualified domain name (FQDN) of the +domain. For the **Rename-GPO** cmdlet, this is the domain of the GPO that you want to rename. -If you do not specify the **Domain** parameter, the domain of the user that is running the current session is used. -If the cmdlet is being run from a computer startup or shutdown script, the domain of the computer is used. -For more information, see the Notes section in the full Help. +If you do not specify the **Domain** parameter, the domain of the user that is running the current +session is used. If the cmdlet is being run from a computer startup or shutdown script, the domain +of the computer is used. For more information, see the Notes section in the full Help. -If you specify a domain that is different from the domain of the user that is running the current session (or, for a startup or shutdown script, the computer), a trust must exist between that domain and the domain of the user or the computer. +If you specify a domain that is different from the domain of the user that is running the current +session (or, for a startup or shutdown script, the computer), a trust must exist between that domain +and the domain of the user or the computer. -You can also refer to the **Domain** parameter by its built-in alias, **DomainName**. -For more information, see [about_Aliases](????????????). +You can also refer to the **Domain** parameter by its built-in alias, **DomainName**. For more +information, see [about_Aliases](/powershell/module/microsoft.powershell.core/about/about_aliases). ```yaml Type: System.String @@ -100,8 +109,8 @@ Accept wildcard characters: False ### -Guid -Specifies the GPO to rename by its globally unique identifier (GUID). -The GUID uniquely identifies the GPO. +Specifies the GPO to rename by its globally unique identifier (GUID). The GUID uniquely identifies +the GPO. You can also refer to the **Guid** parameter by its built-in alias, **Id**. @@ -118,11 +127,12 @@ Accept wildcard characters: False ``` ### -Name + Specifies the GPO to rename by its current display name. -The display name is not guaranteed to be unique in the domain. -If another GPO with the same display name exists in the domain, an error occurs. -You can use the **Guid** parameter to uniquely identify a GPO. +The display name is not guaranteed to be unique in the domain. If another GPO with the same display +name exists in the domain, an error occurs. You can use the **Guid** parameter to uniquely identify +a GPO. You can also refer to the Name parameter by its built-in alias, **DisplayName**. @@ -140,12 +150,13 @@ Accept wildcard characters: False ### -Server -Specifies the name of the domain controller that this cmdlet contacts to complete the operation. -You can specify either the fully qualified domain name (FQDN) or the host name. +Specifies the name of the domain controller that this cmdlet contacts to complete the operation. You +can specify either the fully qualified domain name (FQDN) or the host name. -If you do not specify the name by using the **Server** parameter, the primary domain controller (PDC) emulator is contacted. +If you do not specify the name by using the **Server** parameter, the primary domain controller +(PDC) emulator is contacted. -You can also refer to the *Server* parameter by its built-in alias, **DC**. +You can also refer to the **Server** parameter by its built-in alias, **DC**. ```yaml Type: System.String @@ -160,8 +171,9 @@ Accept wildcard characters: False ``` ### -TargetName -Specifies the new display name of the GPO. -Because the display name may not be unique, an error is returned if another GPO in the domain has the same display name. + +Specifies the new display name of the GPO. Because the display name may not be unique, an error is +returned if another GPO in the domain has the same display name. ```yaml Type: System.String @@ -177,8 +189,7 @@ Accept wildcard characters: False ### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml Type: System.Management.Automation.SwitchParameter @@ -194,13 +205,17 @@ Accept wildcard characters: False ### CommonParameters -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). +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). ## INPUTS ### Microsoft.GroupPolicy.Gpo -You can pipe a **GPO** object to the GPO to rename. -Collections that contain GPOs from different domains are not supported. + +You can pipe a **GPO** object to the GPO to rename. Collections that contain GPOs from different +domains are not supported. ## OUTPUTS @@ -212,13 +227,15 @@ This cmdlet returns the GPO with the new display name. * You can use the **Domain** parameter to explicitly specify the domain for this cmdlet. - If you do not explicitly specify the domain, the cmdlet uses a default domain. -The default domain is the domain that is used to access network resources by the security context under which the current session is running. -This domain is typically the domain of the user that is running the session. -For example, the domain of the user who started the session by opening Windows PowerShell from the Program Files menu, or the domain of a user that is specified in a runas command. -However, computer startup and shutdown scripts run under the context of the LocalSystem account. -The LocalSystem account is a built-in local account, and it accesses network resources under the context of the computer account. -Therefore, when this cmdlet is run from a startup or shutdown script, the default domain is the domain to which the computer is joined. + If you do not explicitly specify the domain, the cmdlet uses a default domain. The default domain + is the domain that is used to access network resources by the security context under which the + current session is running. This domain is typically the domain of the user that is running the + session. For example, the domain of the user who started the session by opening Windows PowerShell + from the Program Files menu, or the domain of a user that is specified in a runas command. + However, computer startup and shutdown scripts run under the context of the LocalSystem account. + The LocalSystem account is a built-in local account, and it accesses network resources under the + context of the computer account. Therefore, when this cmdlet is run from a startup or shutdown + script, the default domain is the domain to which the computer is joined. ## RELATED LINKS diff --git a/docset/winserver2022-ps/grouppolicy/Restore-GPO.md b/docset/winserver2022-ps/grouppolicy/Restore-GPO.md index 486d1eb163..ef9288550f 100644 --- a/docset/winserver2022-ps/grouppolicy/Restore-GPO.md +++ b/docset/winserver2022-ps/grouppolicy/Restore-GPO.md @@ -17,32 +17,38 @@ Restores one GPO or all GPOs in a domain from one or more GPO backup files. ## SYNTAX ### RestoreFromBackupId (Default) + ``` -Restore-GPO -BackupId -Path [-Domain ] [-Server ] [-WhatIf] [-Confirm] - [] +Restore-GPO -BackupId -Path [-Domain ] [-Server ] [-WhatIf] + [-Confirm] [] ``` ### RestoreFromGpo(GUID) + ``` Restore-GPO -Guid -Path [-Domain ] [-Server ] [-WhatIf] [-Confirm] [] ``` ### RestoreFromGpo(Name) + ``` -Restore-GPO [-Name] -Path [-Domain ] [-Server ] [-WhatIf] [-Confirm] - [] +Restore-GPO [-Name] -Path [-Domain ] [-Server ] [-WhatIf] + [-Confirm] [] ``` ### RestoreAll + ``` Restore-GPO -Path [-Domain ] [-Server ] [-All] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION -The **Restore-GPO** cmdlet restores a Group Policy Object (GPO) backup to the original domain from which it was saved. -If the original domain is not available, or if the GPO no longer exists in the domain, the cmdlet fails. + +The **Restore-GPO** cmdlet restores a Group Policy Object (GPO) backup to the original domain from +which it was saved. If the original domain is not available, or if the GPO no longer exists in the +domain, the cmdlet fails. You can: @@ -50,44 +56,50 @@ You can: - Use the **All** parameter to restore all GPOs in the domain from their most recent backups. -- Use the *BackupId* parameter to restore a GPO from a specific backup. +- Use the **BackupID** parameter to restore a GPO from a specific backup. This parameter enables you to restore a GPO from a backup prior to the most recent one. ## EXAMPLES ### Example 1: Restore a GPO from a directory + ```powershell Restore-GPO -Name "TestGPO" -Path "\\Server1\Backups" ``` -This command restores the GPO named TestGPO from the \\\\Server1\Backups directory. -The most recent backup is restored. +This command restores the GPO named `TestGPO` from the `\\Server1\Backups` directory. The most recent +backup is restored. ### Example 2: Restore a GPO from a directory using the GPOs GUID + ```powershell Restore-GPO -GUID fa4a9473-6e2a-4b87-ab78-175e68d97bde -Path "\\Server1\Backups" ``` -This command restores the GPO with the GUID fa4a9473-6e2a-4b87-ab78-175e68d97bde from the \\\\Server1\Backups directory. -The most recent backup is restored. +This command restores the GPO with the GUID `fa4a9473-6e2a-4b87-ab78-175e68d97bde` from the +`\\Server1\Backups` directory. The most recent backup is restored. ### Example 3: Restore all GPOs in a domain that were previously backed up to a directory + ```powershell Restore-GPO -All -Domain "contoso.com" -Path "\\Server1\Backups" ``` -This command restores all of the GPOs in the contoso.com domain previously backed up to \\\\Server1\Backup. -Each GPO is restored using its most recent backup. +This command restores all of the GPOs in the `contoso.com` domain previously backed up to +`\\Server1\Backup`. Each GPO is restored using its most recent backup. -If the domain of user that is running the session (or, for a startup or shutdown script, the domain of the computer) is different from the contoso.com domain, a trust must exist between the two domains or the command fails. +If the domain of user that is running the session (or, for a startup or shutdown script, the domain +of the computer) is different from the `contoso.com` domain, a trust must exist between the two +domains or the command fails. ### Example 4: Restore a GPO using its backup ID + ```powershell Restore-GPO -BackupId 0fc29b3c-fb83-4076-babb-6194c1b4fc26 -Path "\\Server1\Backups" ``` -This command restores a GPO from the backup specified by the *BackupId* parameter. -The *BackupId* parameter can be used to restore a GPO from a backup prior to the most recent backup. +This command restores a GPO from the backup specified by the **BackupID** parameter. The +**BackupID** parameter can be used to restore a GPO from a backup prior to the most recent backup. ## PARAMETERS @@ -109,11 +121,13 @@ Accept wildcard characters: False ``` ### -BackupId -Specifies the backup ID of a GPO backup. -The backup ID is a globally unique identifier (GUID) that uniquely identifies the backup. -You can use this parameter to specify a particular version of a backed-up GPO in the backup directory. -The backup ID is different from the ID of the GPO that was backed up (specified by the *Guid* parameter), you can find the backup ID in the backup directory. +Specifies the backup ID of a GPO backup. The backup ID is a globally unique identifier (GUID) that +uniquely identifies the backup. You can use this parameter to specify a particular version of a +backed-up GPO in the backup directory. + +The backup ID is different from the ID of the GPO that was backed up (specified by the **Guid** +parameter), you can find the backup ID in the backup directory. ```yaml Type: Guid @@ -145,20 +159,22 @@ Accept wildcard characters: False ### -Domain -Specifies the domain for this cmdlet. -You must specify the fully qualified domain name (FQDN) of the domain. +Specifies the domain for this cmdlet. You must specify the fully qualified domain name (FQDN) of the +domain. -For the **Restore-GPO** cmdlet, this is the domain in which you want to restore the GPO. -This must be the domain from which the GPO was backed up. +For the **Restore-GPO** cmdlet, this is the domain in which you want to restore the GPO. This must +be the domain from which the GPO was backed up. -If you do not specify the **Domain** parameter, the domain of the user that is running the current session is used. -If the cmdlet is being run from a computer startup or shutdown script, the domain of the computer is used. -For more information, see the Notes section in the full Help. +If you do not specify the **Domain** parameter, the domain of the user that is running the current +session is used. If the cmdlet is being run from a computer startup or shutdown script, the domain +of the computer is used. For more information, see the Notes section in the full Help. -If you specify a domain that is different from the domain of the user that is running the current session (or, for a startup or shutdown script, the computer), a trust must exist between that domain and the domain of the user or the computer. +If you specify a domain that is different from the domain of the user that is running the current +session (or, for a startup or shutdown script, the computer), a trust must exist between that domain +and the domain of the user or the computer. -You can also refer to the **Domain** parameter by its built-in alias, **DomainName**. -For more information, see [about_Aliases](????????????). +You can also refer to the **Domain** parameter by its built-in alias, **DomainName**. For more +information, see [about_Aliases](/powershell/module/microsoft.powershell.core/about/about_aliases). ```yaml Type: System.String @@ -174,11 +190,11 @@ Accept wildcard characters: False ### -Guid -Specifies the GPO to restore by its globally unique identifier (GUID). -The GUID uniquely identifies the GPO. +Specifies the GPO to restore by its globally unique identifier (GUID). The GUID uniquely identifies +the GPO. -The GPO is restored from its most recent backup in the backup directory. -To specify a different backup than the most recent backup, use the *BackupId* parameter. +The GPO is restored from its most recent backup in the backup directory. To specify a different +backup than the most recent backup, use the **BackupID** parameter. You can also refer to the **Guid** parameter by its built-in alias, **Id**. @@ -195,13 +211,14 @@ Accept wildcard characters: False ``` ### -Name -Specifies the GPO to restore by its display name. -The GPO is restored from its most recent backup in the backup directory. -To specify a different backup than the most recent backup, use the BackupId parameter. -The display name is not guaranteed to be unique in the domain. -If another GPO with the same display name exists in the domain an error occurs. -You can use the **Guid** parameter to uniquely identify a GPO. +Specifies the GPO to restore by its display name. The GPO is restored from its most recent backup in +the backup directory. To specify a different backup than the most recent backup, use the BackupId +parameter. + +The display name is not guaranteed to be unique in the domain. If another GPO with the same display +name exists in the domain an error occurs. You can use the **Guid** parameter to uniquely identify a +GPO. You can also refer to the Name parameter by its built-in alias, **DisplayName**. @@ -221,12 +238,12 @@ Accept wildcard characters: False Specifies the path to the backup directory. -You can also refer to the **Path** parameter by its built-in alias, backuplocation. +You can also refer to the **Path** parameter by its built-in alias, **BackupLocation**. ```yaml Type: System.String Parameter Sets: (All) -Aliases: backupLocation, BackupDirectory +Aliases: BackupLocation, BackupDirectory Required: True Position: Named @@ -237,12 +254,13 @@ Accept wildcard characters: False ### -Server -Specifies the name of the domain controller that this cmdlet contacts to complete the operation. -You can specify either the fully qualified domain name (FQDN) or the host name. +Specifies the name of the domain controller that this cmdlet contacts to complete the operation. You +can specify either the fully qualified domain name (FQDN) or the host name. -If you do not specify the name by using the **Server** parameter, the primary domain controller (PDC) emulator is contacted. +If you do not specify the name by using the **Server** parameter, the primary domain controller +(PDC) emulator is contacted. -You can also refer to the *Server* parameter by its built-in alias, **DC**. +You can also refer to the **Server** parameter by its built-in alias, **DC**. ```yaml Type: System.String @@ -258,8 +276,7 @@ Accept wildcard characters: False ### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml Type: System.Management.Automation.SwitchParameter @@ -275,12 +292,17 @@ Accept wildcard characters: False ### CommonParameters -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). +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). ## INPUTS ### Microsoft.GroupPolicy.BackupGpo -You can pipe a GPO backup, a separate file that holds the settings of a GPO that can be imported elsewhere to recreate the GPO to this cmdlet. + +You can pipe a GPO backup, a separate file that holds the settings of a GPO that can be imported +elsewhere to recreate the GPO to this cmdlet. ## OUTPUTS @@ -292,13 +314,15 @@ This cmdlet returns the restored GPO. * You can use the **Domain** parameter to explicitly specify the domain for this cmdlet. - If you do not explicitly specify the domain, the cmdlet uses a default domain. -The default domain is the domain that is used to access network resources by the security context under which the current session is running. -This domain is typically the domain of the user that is running the session. -For instance, the domain of the user who started the session by opening Windows PowerShell from the Program Files menu, or the domain of a user that is specified in a runas command. -However, computer startup and shutdown scripts run under the context of the LocalSystem account. -The LocalSystem account is a built-in local account, and it accesses network resources under the context of the computer account. -Therefore, when this cmdlet is run from a startup or shutdown script, the default domain is the domain to which the computer is joined. + If you do not explicitly specify the domain, the cmdlet uses a default domain. The default domain + is the domain that is used to access network resources by the security context under which the + current session is running. This domain is typically the domain of the user that is running the + session. For instance, the domain of the user who started the session by opening Windows + PowerShell from the Program Files menu, or the domain of a user that is specified in a runas + command. However, computer startup and shutdown scripts run under the context of the LocalSystem + account. The LocalSystem account is a built-in local account, and it accesses network resources + under the context of the computer account. Therefore, when this cmdlet is run from a startup or + shutdown script, the default domain is the domain to which the computer is joined. ## RELATED LINKS diff --git a/docset/winserver2022-ps/grouppolicy/Set-GPInheritance.md b/docset/winserver2022-ps/grouppolicy/Set-GPInheritance.md index d2c9969a10..71b6efa52d 100644 --- a/docset/winserver2022-ps/grouppolicy/Set-GPInheritance.md +++ b/docset/winserver2022-ps/grouppolicy/Set-GPInheritance.md @@ -17,62 +17,83 @@ Blocks or unblocks inheritance for a specified domain or organizational unit. ## SYNTAX ``` -Set-GPInheritance [-Target] -IsBlocked [-Domain ] [-Server ] - [-WhatIf] [-Confirm] [] +Set-GPInheritance [-Target] -IsBlocked [-Domain ] + [-Server ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION -The **Set-GPInheritance** cmdlet blocks or unblocks inheritance for a specified domain or organizational unit (OU). -GPOs are applied according to the Group Policy hierarchy in the following order: local GPO, GPOs linked to the site, GPOs linked to the domain, GPOs linked to OUs. -By default, an Active Directory container inherits settings from GPOs that are applied at the next higher level in the hierarchy. -Blocking inheritance prevents the settings in GPOs that are linked to higher-level sites, domains, or organizational units from being automatically inherited by the specified domain or OU, unless the link for a GPO is enforced. +The **Set-GPInheritance** cmdlet blocks or unblocks inheritance for a specified domain or +organizational unit (OU). -You use the *Target* parameter to specify the Lightweight Directory Access Protocol (LDAP) distinguished name of the domain or OU, and use the *IsBlocked* parameter to specify whether to block or unblock inheritance. +GPOs are applied according to the Group Policy hierarchy in the following order: local GPO, GPOs +linked to the site, GPOs linked to the domain, GPOs linked to OUs. By default, an Active Directory +container inherits settings from GPOs that are applied at the next higher level in the hierarchy. +Blocking inheritance prevents the settings in GPOs that are linked to higher-level sites, domains, +or organizational units from being automatically inherited by the specified domain or OU, unless the +link for a GPO is enforced. + +You use the **Target** parameter to specify the Lightweight Directory Access Protocol (LDAP) +distinguished name of the domain or OU, and use the **IsBlocked** parameter to specify whether to +block or unblock inheritance. ## EXAMPLES ### Example 1: Block inheritance for a OU in a domain + ```powershell -Set-GPInheritance -Target "ou=MyOU,dc=contoso,dc=com" -IsBlocked Yes -Name : myou +Set-GPInheritance -Target "ou=MyOU,dc=contoso,dc=com" -IsBlocked Yes +``` + +```Output +Name : MyOU ContainerType : OU -Path : ou=myou,dc=contoso,dc=com +Path : ou=MyOU,dc=contoso,dc=com GpoInheritanceBlocked : Yes GpoLinks : {TestGPO-1, TestGPO-2} InheritedGpoLinks : {TestGPO-1, TestGPO-2} ``` -This command blocks inheritance for the OU named MyOU in the contoso.com domain. -GPOs that are linked to higher-level sites or domains, or to OUs that are parent OUs of the OU named MyOU are not applied, unless their links are enforced, when Group Policy is processed for the OU on the client. +This command blocks inheritance for the OU named MyOU in the `contoso.com` domain. GPOs that are +linked to higher-level sites or domains, or to OUs that are parent OUs of the OU named `MyOU` are +not applied, unless their links are enforced, when Group Policy is processed for the OU on the +client. -Because inheritance is blocked, only GPOs that are linked directly to the MyOU, and those that are enforced at higher-level containers, appear in the InheritedGpoLinks list. +Because inheritance is blocked, only GPOs that are linked directly to the `MyOU`, and those that are +enforced at higher-level containers, appear in the InheritedGpoLinks list. ### Example 2: Unblock inheritance for a domain + ```powershell -Set-GPInheritance -Target "dc=northwest, dc=contoso, dc=com" -IsBlocked No +Set-GPInheritance -Target "dc=northwest,dc=contoso,dc=com" -IsBlocked No ``` -This command unblocks inheritance for the northwest.contoso.com domain. -GPOs linked to higher-level sites or domains are applied to this domain when Group Policy is processed on the client. +This command unblocks inheritance for the `northwest.contoso.com` domain. GPOs linked to +higher-level sites or domains are applied to this domain when Group Policy is processed on the +client. ### Example 3: Unblock inheritance for an OU in a domain + ```powershell Set-GPInheritance -Target "ou=MyOU,dc=contoso,dc=com" -IsBlocked No +``` -Name : myou +```Output +Name : MyOU ContainerType : OU -Path : ou=myou,dc=contoso,dc=com +Path : ou=MyOU,dc=contoso,dc=com GpoInheritanceBlocked : No GpoLinks : {TestGPO-1, TestGPO-2} InheritedGpoLinks : {TestGPO-1, TestGPO-2, Default Domain Policy} ``` -This command unblocks inheritance for the OU named MyOU in the contoso.com domain. -GPOs that are linked to higher-level sites or domains, or to OUs that are parent OUs of the OU named MyOU, are applied when Group Policy is processed for the OU on the client. +This command unblocks inheritance for the OU named `MyOU` in the `contoso.com` domain. GPOs that are +linked to higher-level sites or domains, or to OUs that are parent OUs of the OU named `MyOU`, are +applied when Group Policy is processed for the OU on the client. -Because inheritance is not blocked, GPOs that are inherited from higher-level containers appear in the InheritedGpoLinks list (together with GPOs that are linked directly to the OU). -For instance, the Default Domain Policy GPO is linked at the domain level. +Because inheritance is not blocked, GPOs that are inherited from higher-level containers appear in +the InheritedGpoLinks list (together with GPOs that are linked directly to the OU). For instance, +the Default Domain Policy GPO is linked at the domain level. ## PARAMETERS @@ -94,20 +115,23 @@ Accept wildcard characters: False ### -Domain -Specifies the domain for this cmdlet. -You must specify the fully qualified domain name (FQDN) of the domain. +Specifies the domain for this cmdlet. You must specify the fully qualified domain name (FQDN) of the +domain. -For the **Set-GPInheritance** cmdlet, this is typically the domain of the Active Directory container (domain or OU) for which you want to block or unblock inheritance. -If the domain for the cmdlet is different than the domain of the container, a trust must exist between the two domains. +For the **Set-GPInheritance** cmdlet, this is typically the domain of the Active Directory container +(domain or OU) for which you want to block or unblock inheritance. If the domain for the cmdlet is +different than the domain of the container, a trust must exist between the two domains. -If you do not specify the **Domain** parameter, the domain of the user that is running the current session is used. -If the cmdlet is being run from a computer startup or shutdown script, the domain of the computer is used. -For more information, see the Notes section in the full Help. +If you do not specify the **Domain** parameter, the domain of the user that is running the current +session is used. If the cmdlet is being run from a computer startup or shutdown script, the domain +of the computer is used. For more information, see the Notes section in the full Help. -If you specify a domain that is different from the domain of the user that is running the current session (or, for a startup or shutdown script, the computer), a trust must exist between that domain and the domain of the user or the computer. +If you specify a domain that is different from the domain of the user that is running the current +session (or, for a startup or shutdown script, the computer), a trust must exist between that domain +and the domain of the user or the computer. -You can also refer to the **Domain** parameter by its built-in alias, **DomainName**. -For more information, see [about_Aliases](????????????). +You can also refer to the **Domain** parameter by its built-in alias, **DomainName**. For more +information, see [about_Aliases](/powershell/module/microsoft.powershell.core/about/about_aliases). ```yaml Type: System.String @@ -122,8 +146,8 @@ Accept wildcard characters: False ``` ### -IsBlocked -Indicates whether to block inheritance for the domain or OU. -You must specify Yes or No. + +Indicates whether to block inheritance for the domain or OU. You must specify `Yes` or `No`. The following values are permitted for this object type. @@ -142,10 +166,11 @@ Accept wildcard characters: False ### -Server -Specifies the name of the domain controller that this cmdlet contacts to complete the operation. -You can specify either the fully qualified domain name (FQDN) or the host name. +Specifies the name of the domain controller that this cmdlet contacts to complete the operation. You +can specify either the fully qualified domain name (FQDN) or the host name. -If you do not specify the name by using the **Server** parameter, the primary domain controller (PDC) emulator is contacted. +If you do not specify the name by using the **Server** parameter, the primary domain controller +(PDC) emulator is contacted. You can also refer to the **Server** parameter by its built-in alias, **DC**. @@ -162,15 +187,17 @@ Accept wildcard characters: False ``` ### -Target -Specifies the domain or the OU for which to block or unblock inheritance by its LDAP distinguished name. -For instance, the MyOU organizational unit in the contoso.com domain is specified as "ou=MyOU,dc=contoso,dc=com". -You can also refer to the *Target* parameter by its built-in alias, path. +Specifies the domain or the OU for which to block or unblock inheritance by its LDAP distinguished +name. For instance, the `MyOU` organizational unit in the `contoso.com` domain is specified as +`ou=MyOU,dc=contoso,dc=com`. + +You can also refer to the **Target** parameter by its built-in alias, **Path**. ```yaml Type: System.String Parameter Sets: (All) -Aliases: path +Aliases: Path Required: True Position: 0 @@ -181,8 +208,7 @@ Accept wildcard characters: False ### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml Type: System.Management.Automation.SwitchParameter @@ -198,33 +224,42 @@ Accept wildcard characters: False ### CommonParameters -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). +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). ## INPUTS ### Microsoft.GroupPolicy.Som + This cmdlet takes an object that represents a domain or an OU as input. ## OUTPUTS ### Microsoft.GroupPolicy.Som -This cmdlet returns an object that represents the domain or OU after the operation is applied. -The properties of this object that are displayed by default describe the Group Policy inheritance information for the domain or OU. -The **GpoInheritanceBlocked** property indicates whether inheritance is blocked. + +This cmdlet returns an object that represents the domain or OU after the operation is applied. The +properties of this object that are displayed by default describe the Group Policy inheritance +information for the domain or OU. The **GpoInheritanceBlocked** property indicates whether +inheritance is blocked. ## NOTES -* GPO links that are enforced cannot be blocked. This cmdlet should be used sparingly. Casual use of this cmdlet can complicate troubleshooting. +* GPO links that are enforced cannot be blocked. This cmdlet should be used sparingly. Casual use of + this cmdlet can complicate troubleshooting. You can use the **Domain** parameter to explicitly specify the domain for this cmdlet. - If you do not explicitly specify the domain, the cmdlet uses a default domain. -The default domain is the domain that is used to access network resources by the security context under which the current session is running. -This domain is typically the domain of the user that is running the session. -For instance, the domain of the user who started the session by opening Windows PowerShell from the Program Files menu, or the domain of a user that is specified in a runas command. -However, computer startup and shutdown scripts run under the context of the LocalSystem account. -The LocalSystem account is a built-in local account, and it accesses network resources under the context of the computer account. -Therefore, when this cmdlet is run from a startup or shutdown script, the default domain is the domain to which the computer is joined. + If you do not explicitly specify the domain, the cmdlet uses a default domain. The default domain + is the domain that is used to access network resources by the security context under which the + current session is running. This domain is typically the domain of the user that is running the + session. For instance, the domain of the user who started the session by opening Windows + PowerShell from the Program Files menu, or the domain of a user that is specified in a runas + command. However, computer startup and shutdown scripts run under the context of the LocalSystem + account. The LocalSystem account is a built-in local account, and it accesses network resources + under the context of the computer account. Therefore, when this cmdlet is run from a startup or + shutdown script, the default domain is the domain to which the computer is joined. ## RELATED LINKS diff --git a/docset/winserver2022-ps/grouppolicy/Set-GPLink.md b/docset/winserver2022-ps/grouppolicy/Set-GPLink.md index cdf768eedb..9880043caa 100644 --- a/docset/winserver2022-ps/grouppolicy/Set-GPLink.md +++ b/docset/winserver2022-ps/grouppolicy/Set-GPLink.md @@ -17,36 +17,47 @@ Sets the properties of the specified GPO link. ## SYNTAX ### LinkGUID (Default) + ``` -Set-GPLink -Guid -Target [-LinkEnabled ] [-Order ] [-Domain ] - [-Server ] [-Enforced ] [-WhatIf] [-Confirm] [] +Set-GPLink -Guid -Target [-LinkEnabled ] [-Order ] + [-Domain ] [-Server ] [-Enforced ] [-WhatIf] [-Confirm] + [] ``` ### LinkName + ``` -Set-GPLink [-Name] -Target [-LinkEnabled ] [-Order ] [-Domain ] - [-Server ] [-Enforced ] [-WhatIf] [-Confirm] [] +Set-GPLink [-Name] -Target [-LinkEnabled ] [-Order ] + [-Domain ] [-Server ] [-Enforced ] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION + The **Set-GPLink** cmdlet sets the properties of a Group Policy Object (GPO) link. You can set the following properties: -- Enabled. -If the GPO link is enabled, the settings of the GPO are applied when Group Policy is processed for the site, domain or OU. +- Enabled. If the GPO link is enabled, the settings of the GPO are applied when Group Policy is + processed for the site, domain or OU. -- Enforced. -If the GPO link is enforced, it cannot be blocked at a lower-level (in the Group Policy processing hierarchy) container. +- Enforced. + If the GPO link is enforced, it cannot be blocked at a lower-level (in the Group Policy + processing hierarchy) container. -- Order. -The order specifies the precedence that the settings of the GPO take over conflicting settings in other GPOs that are linked, and enabled, to the same site, domain, or OU. +- Order. + The order specifies the precedence that the settings of the GPO take over conflicting + settings in other GPOs that are linked, and enabled, to the same site, domain, or OU. ## EXAMPLES ### Example 1: Enable the link between a GPO and OU + ```powershell Set-GPLink -Name TestGPO -Target "ou=MyOU,dc=contoso,dc=com" -LinkEnabled Yes +``` + +```Output GpoId : c25daa3e-5d05-43b3-87ca-0a237882fd63 DisplayName : Test2GPO Enabled : True @@ -55,21 +66,36 @@ Target : OU=MyOU,DC=contoso,DC=com Order : 1 ``` -This command enables the link between the GPO named TestGPO and the MyOU organizational unit in the contoso.com domain. -The Enforced and Order properties are not changed. +This command enables the link between the GPO named **TestGPO** and the `MyOU` organizational unit +in the `contoso.com` domain. The **Enforced** and **Order** properties are not changed. ### Example 2: Enable the link between a GPO and two domains + ```powershell -Set-GPLink -Name TestGPO -Domain north.contoso.com -Target "dc=south, dc=contoso, dc=com" -LinkEnabled Yes -Enforced Yes -Order 1 +$params = @{ + Name = 'TestGPO' + Domain = "north.contoso.com" + Target = "dc=south,dc=contoso,dc=com" + LinkEnabled = $true + Enforced = $true + Order = 1 +} +Set-GPLink @params ``` -This command enables the link between the GPO named TestGPO in the north.contoso.com domain and the south.contoso.com domain. -The link is set to enforced, so it cannot be blocked at lower-level containers (for example OUs in the south.contoso.com domain). -Because the order is set to 1, the settings of TestGPO is applied with the highest precedence (except for enforced links) when Group policy is processed for the south.contoso.com domain container. +This command enables the link between the GPO named `TestGPO` in the `north.contoso.com` domain and +the `south.contoso.com` domain. The link is set to enforced, so it cannot be blocked at lower-level +containers (for example OUs in the `south.contoso.com` domain). Because the order is set to `1`, the +settings of `TestGPO` is applied with the highest precedence (except for enforced links) when Group +policy is processed for the `south.contoso.com` domain container. ### Example 3: Set the enforced property of a link between a GPO and a test site + ```powershell -Set-GPLink -Guid 77c5285d-952e-4559-94ef-a02f5c107799 -Target "Test-Site" -Enforced Yes +Set-GPLink -Guid 77c5285d-952e-4559-94ef-a02f5c107799 -Target "Test-Site" -Enforced Yes +``` + +```Output GpoId : 77c5285d-952e-4559-94ef-a02f5c107799 DisplayName : TestGPO Enabled : True @@ -78,8 +104,9 @@ Target : CN=test-site,cn=Sites,CN=Configuration,DC=contoso,DC=com Order : 1 ``` -This command sets the enforced property of the link between the GPO that has ID 77c5285d-952e-4559-94ef-a02f5c107799 and the test site. -Inheritance cannot be blocked for this link at containers that are at lower-levels of the Group Policy hierarchy. +This command sets the enforced property of the link between the GPO that has ID +`77c5285d-952e-4559-94ef-a02f5c107799` and the `Test-Site`. Inheritance cannot be blocked for this +link at containers that are at lower-levels of the Group Policy hierarchy. ## PARAMETERS @@ -108,18 +135,21 @@ For the **Set-GPLink** cmdlet: - The GPO that is linked from must exist in this domain. -- The Active Directory container that is linked to must exist in a domain that has a trust relationship with this domain. +- The Active Directory container that is linked to must exist in a domain that has a trust + relationship with this domain. -To specify a domain to link to, use the *Target* parameter. +To specify a domain to link to, use the **Target** parameter. -If you do not specify the **Domain** parameter, the domain of the user that is running the current session is used. -If the cmdlet is being run from a computer startup or shutdown script, the domain of the computer is used. -For more information, see the Notes section in the full Help. +If you do not specify the **Domain** parameter, the domain of the user that is running the current +session is used. If the cmdlet is being run from a computer startup or shutdown script, the domain +of the computer is used. For more information, see the Notes section in the full Help. -If you specify a domain that is different from the domain of the user that is running the current session (or, for a startup or shutdown script, the computer), a trust must exist between that domain and the domain of the user or the computer. +If you specify a domain that is different from the domain of the user that is running the current +session (or, for a startup or shutdown script, the computer), a trust must exist between that domain +and the domain of the user or the computer. -You can also refer to the **Domain** parameter by its built-in alias, **DomainName**. -For more information, see [about_Aliases](????????????). +You can also refer to the **Domain** parameter by its built-in alias, **DomainName**. For more +information, see [about_Aliases](/powershell/module/microsoft.powershell.core/about/about_aliases). ```yaml Type: System.String @@ -134,18 +164,19 @@ Accept wildcard characters: False ``` ### -Enforced -Specifies whether the GPO link is enforced. -You can specify Yes or No. -By default, GPO links are not enforced. + +Specifies whether the GPO link is enforced. You can specify Yes or No. By default, GPO links are not +enforced. By setting the GPO link to enforced, you ensure the following: -- That the settings of the GPO cannot be blocked (by blocking inheritance) at a lower-level Active Directory container. +- That the settings of the GPO cannot be blocked (by blocking inheritance) at a lower-level Active + Directory container. -- That the settings of the GPO always take precedence over conflicting settings in GPOs that are linked to lower-level containers. +- That the settings of the GPO always take precedence over conflicting settings in GPOs that are + linked to lower-level containers. -This option should be used sparingly. -Casual use of this option complicates troubleshooting. +This option should be used sparingly. Casual use of this option complicates troubleshooting. The following values are permitted for this object type. @@ -164,8 +195,8 @@ Accept wildcard characters: False ### -Guid -Specifies the GPO of the link by its globally unique identifier (GUID). -The GUID uniquely identifies the GPO. +Specifies the GPO of the link by its globally unique identifier (GUID). The GUID uniquely identifies +the GPO. You can also refer to the **Guid** parameter by its built-in alias, **Id**. @@ -182,13 +213,13 @@ Accept wildcard characters: False ``` ### -LinkEnabled -Specifies whether the GPO link is enabled. -You can specify Yes or No. -By default, Group Policy processing is enabled for all GPO links. -You can completely block the application of a GPO for a specific site, domain, or OU by disabling the GPO link for that site, domain, or OU. -Disabling a GPO link does not disable the GPO itself. -If the GPO is linked to other sites, domains, or OUs, Group Policy continues to process the GPO for each link that is enabled. +Specifies whether the GPO link is enabled. You can specify Yes or No. + +By default, Group Policy processing is enabled for all GPO links. You can completely block the +application of a GPO for a specific site, domain, or OU by disabling the GPO link for that site, +domain, or OU. Disabling a GPO link does not disable the GPO itself. If the GPO is linked to other +sites, domains, or OUs, Group Policy continues to process the GPO for each link that is enabled. ```yaml Type: EnableLink @@ -204,11 +235,12 @@ Accept wildcard characters: False ``` ### -Name + Specifies the GPO of the link by its display name. -The display name is not guaranteed to be unique in the domain. -If another GPO with the same display name exists in the domain, an error occurs. -You can use the **Guid** parameter to uniquely identify a GPO. +The display name is not guaranteed to be unique in the domain. If another GPO with the same display +name exists in the domain, an error occurs. You can use the **Guid** parameter to uniquely identify +a GPO. You can also refer to the **Name** parameter by its built-in alias, **DisplayName**. @@ -225,16 +257,20 @@ Accept wildcard characters: False ``` ### -Order -Specifies the link order for the GPO link. -You can specify a number that is between one and the current number of GPO links to the target site, domain, or OU, plus one. -The link order specifies the order of precedence with which GPOs linked to the same Active Directory container are applied. -When Group Policy is processed, GPOs with a higher link order number are processed before GPOs with a lower link order number. -Therefore, when two GPOs contain conflicting settings, the settings in the GPO with the lower link order number, because it is processed last, overwrites those of the GPO with the higher link order number. -A lower number indicates higher precedence. +Specifies the link order for the GPO link. You can specify a number that is between one and the +current number of GPO links to the target site, domain, or OU, plus one. -By default, the GPO link is added at the lowest precedence (with a link order equal to the number of GPO links to the container, plus one). -Link order is a dynamic value because the value may change as GPO links are added and deleted from the container. +The link order specifies the order of precedence with which GPOs linked to the same Active Directory +container are applied. When Group Policy is processed, GPOs with a higher link order number are +processed before GPOs with a lower link order number. Therefore, when two GPOs contain conflicting +settings, the settings in the GPO with the lower link order number, because it is processed last, +overwrites those of the GPO with the higher link order number. A lower number indicates higher +precedence. + +By default, the GPO link is added at the lowest precedence (with a link order equal to the number of +GPO links to the container, plus one). Link order is a dynamic value because the value may change as +GPO links are added and deleted from the container. ```yaml Type: Int32 @@ -250,12 +286,13 @@ Accept wildcard characters: False ### -Server -Specifies the name of the domain controller that this cmdlet contacts to complete the operation. -You can specify either the fully qualified domain name (FQDN) or the host name. +Specifies the name of the domain controller that this cmdlet contacts to complete the operation. You +can specify either the fully qualified domain name (FQDN) or the host name. -If you do not specify the name by using the **Server** parameter, the primary domain controller (PDC) emulator is contacted. +If you do not specify the name by using the **Server** parameter, the primary domain controller +(PDC) emulator is contacted. -You can also refer to the *Server* parameter by its built-in alias, **DC**. +You can also refer to the **Server** parameter by its built-in alias, **DC**. ```yaml Type: System.String @@ -270,8 +307,10 @@ Accept wildcard characters: False ``` ### -Target -Specifies the Lightweight Directory Access Protocol (LDAP) distinguished name of the site, domain, or OU of the link. -For instance, for the MyOU organizational unit in the contoso.com domain, the LDAP distinguished name is "ou=MyOU,dc=contoso,dc=com". + +Specifies the Lightweight Directory Access Protocol (LDAP) distinguished name of the site, domain, +or OU of the link. For instance, for the `MyOU` organizational unit in the `contoso.com` domain, the +LDAP distinguished name is `ou=MyOU,dc=contoso,dc=com`. ```yaml Type: System.String @@ -287,8 +326,7 @@ Accept wildcard characters: False ### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml Type: System.Management.Automation.SwitchParameter @@ -304,29 +342,36 @@ Accept wildcard characters: False ### CommonParameters -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). +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). ## INPUTS ### Microsoft.GroupPolicy.GpoLink + A GPO link between a GPO and a site, domain, or OU. ## OUTPUTS ### Microsoft.GroupPolicy.GpoLink + This cmdlet returns the GPO link after the change has been applied. ## NOTES * You can use the **Domain** parameter to explicitly specify the domain for this cmdlet. - If you do not explicitly specify the domain, the cmdlet uses a default domain. -The default domain is the domain that is used to access network resources by the security context under which the current session is running. -This domain is typically the domain of the user that is running the session. -For instance, the domain of the user who started the session by opening Windows PowerShell from the Program Files menu, or the domain of a user that is specified in a runas command. -However, computer startup and shutdown scripts run under the context of the LocalSystem account. -The LocalSystem account is a built-in local account, and it accesses network resources under the context of the computer account. -Therefore, when this cmdlet is run from a startup or shutdown script, the default domain is the domain to which the computer is joined. + If you do not explicitly specify the domain, the cmdlet uses a default domain. The default domain + is the domain that is used to access network resources by the security context under which the + current session is running. This domain is typically the domain of the user that is running the + session. For instance, the domain of the user who started the session by opening Windows + PowerShell from the Program Files menu, or the domain of a user that is specified in a runas + command. However, computer startup and shutdown scripts run under the context of the LocalSystem + account. The LocalSystem account is a built-in local account, and it accesses network resources + under the context of the computer account. Therefore, when this cmdlet is run from a startup or + shutdown script, the default domain is the domain to which the computer is joined. ## RELATED LINKS diff --git a/docset/winserver2022-ps/grouppolicy/Set-GPPermission.md b/docset/winserver2022-ps/grouppolicy/Set-GPPermission.md index 19dc0adbbf..f09f27f886 100644 --- a/docset/winserver2022-ps/grouppolicy/Set-GPPermission.md +++ b/docset/winserver2022-ps/grouppolicy/Set-GPPermission.md @@ -17,56 +17,96 @@ Grants a level of permissions to a security principal for one GPO or all the GPO ## SYNTAX ### PermissionOne(GUID) (Default) + ``` Set-GPPermission -Guid -PermissionLevel -TargetName - -TargetType [-DomainName ] [-Server ] [-Replace] [-WhatIf] [-Confirm] - [] + -TargetType [-DomainName ] [-Server ] [-Replace] [-WhatIf] + [-Confirm] [] ``` ### PermissionOne(Name) + ``` Set-GPPermission [-Name] -PermissionLevel -TargetName - -TargetType [-DomainName ] [-Server ] [-Replace] [-WhatIf] [-Confirm] - [] + -TargetType [-DomainName ] [-Server ] [-Replace] [-WhatIf] + [-Confirm] [] ``` ### PermissionAll + ``` -Set-GPPermission -PermissionLevel -TargetName -TargetType - [-DomainName ] [-Server ] [-All] [-Replace] [-WhatIf] [-Confirm] [] +Set-GPPermission -PermissionLevel -TargetName + -TargetType [-DomainName ] [-Server ] [-All] [-Replace] + [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION -The **Set-GPPermission** cmdlet grants a level of permissions to a security principal (user, security group, or computer) for one Group Policy Object (GPO) or all the GPOs in a domain. -You use the **TargetName** and *TargetType* parameters to specify a user, security group, or computer for which to set the permission level. -You can use the *Name* or the **Guid** parameter to set the permission level for the security principal on a single GPO, or you can use the **All** parameter to set the permission level for the security principal on all GPOs in the domain. -By default, if the security principal already has a higher permission level than the specified permission level, the change is not applied. -You can specify the *Replace* parameter, to remove the existing permission level from the GPO before the new permission level is set. -This ensures that the existing permission level is replaced by the new permission level. +The **Set-GPPermission** cmdlet grants a level of permissions to a security principal (user, +security group, or computer) for one Group Policy Object (GPO) or all the GPOs in a domain. You use +the **TargetName** and **TargetType** parameters to specify a user, security group, or computer for +which to set the permission level. You can use the *Name* or the **Guid** parameter to set the +permission level for the security principal on a single GPO, or you can use the **All** parameter to +set the permission level for the security principal on all GPOs in the domain. + +By default, if the security principal already has a higher permission level than the specified +permission level, the change is not applied. You can specify the **Replace** parameter, to remove +the existing permission level from the GPO before the new permission level is set. This ensures that +the existing permission level is replaced by the new permission level. ## EXAMPLES ### Example 1: Set the permission level for a security group belonging to a GPO + ```powershell Set-GPPermission -Name TestGpo -TargetName "Domain Users" -TargetType Group -PermissionLevel GpoRead ``` -This command sets the permission level for the Domain Users security group to GpoRead for the GPO named TestGpo. -Because the *Replace* parameter is not specified, if the group already has a permission level higher than GpoRead, such as GpoEdit, no action is taken. +This command sets the permission level for the Domain Users security group to `GpoRead` for the GPO +named `TestGpo`. Because the **Replace** parameter is not specified, if the group already has a +permission level higher than `GpoRead`, such as `GpoEdit`, no action is taken. ### Example 2: Set the permission level for a security group that belongs to all GPOs + ```powershell -Set-GPPermission -All -TargetName "Marketing Admins" -TargetType Group -PermissionLevel GpoEdit -Replace +$params = @{ + All = $true + TargetName = "Marketing Admins" + TargetType = 'Group' + PermissionLevel = 'GpoEdit' + Replace = $true +} +Set-GPPermission @params ``` -This command sets the permission level for the Marketing Admins security group to GpoEdit on all GPOs in the domain. -This includes GPOs that are not linked to any site, domain, or OU. -Because the *Replace* parameter is specified, the new permission level overwrites the existing permissions set for the group. +This command sets the permission level for the `Marketing Admins` security group to `GpoEdit` on all +GPOs in the domain. This includes GPOs that are not linked to any site, domain, or OU. Because the +**Replace** parameter is specified, the new permission level overwrites the existing permissions set +for the group. ### Example 3: Replace the permission level of a security group for all GPOs on which the group has permissions + ```powershell -Get-GPO -All | ForEach-Object { if($_ | Get-GPPermission -TargetName "Marketing Admins" -TargetType Group -ErrorAction SilentlyContinue) {$_ | Set-GPPermission -Replace -PermissionLevel GpoApply -TargetName "Marketing Admins" -TargetType Group }} +Get-GPO -All | + ForEach-Object { + $getParams = @{ + TargetName = "Marketing Admins" + TargetType = 'Group' + ErrorAction = 'SilentlyContinue' + } + if ( $_ | Get-GPPermission @getParams) { + $setParams = @{ + Replace = $true + PermissionLevel = 'GpoApply' + TargetName = "Marketing Admins" + TargetType = 'Group' + } + $_ | Set-GPPermission @setParams + } + } +``` + +```Output DisplayName : TestGPO DomainName : contoso.com Owner : CONTOSO\Domain Admins @@ -93,24 +133,29 @@ ComputerVersion : AD Version: 0, SysVol Version: 0 WmiFilter : ``` -This command replaces the current permission level of the Marketing Admins security group with GpoApply for all GPOs on which the group has permissions. -The command returns each GPO for which the new permission level is set. +This command replaces the current permission level of the `Marketing Admins` security group with +GpoApply for all GPOs on which the `Group` has permissions. The command returns each GPO for which +the new permission level is set. -The cmdlet is used to get all the GPOs in the domain. -Then, the collection is piped into the **ForEach-Object** command. -As each GPO is evaluated, it is piped into **Get-GPPermission**. -If a permission level for the Marketing Admins group is returned, the GPO is piped into **Set-GPPermission** to set the permission level for the group. -The *Replace* parameter is specified to make sure that the previous permission level is overwritten. +The cmdlet is used to get all the GPOs in the domain. Then, the collection is piped into the +**ForEach-Object** command. As each GPO is evaluated, it is piped into **Get-GPPermission**. If a +permission level for the Marketing Admins group is returned, the GPO is piped into +**Set-GPPermission** to set the permission level for the group. The **Replace** parameter is +specified to make sure that the previous permission level is overwritten. -The *ErrorAction* parameter is set to SilentlyContinue for **Get-GPPermissions**. -This is because a non-terminating error occurs if the specified security principal does not have permissions on the GPO. -Specifying *ErrorAction* as SilentlyContinue prevents the error messages from being printed for GPOs on which the security principal does not have permissions. -For more information about the *ErrorAction* parameter, see about_CommonParameters. +The **ErrorAction** parameter is set to `SilentlyContinue` for **Get-GPPermissions**. This is +because a non-terminating error occurs if the specified security principal does not have permissions +on the GPO. Specifying **ErrorAction** as `SilentlyContinue` prevents the error messages from being +printed for GPOs on which the security principal does not have permissions. For more information +about the **ErrorAction** parameter, see +[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## PARAMETERS ### -All -Specifies that the permission level is set for the specified security principal for all GPOs in the domain. + +Specifies that the permission level is set for the specified security principal for all GPOs in the +domain. ```yaml Type: System.Management.Automation.SwitchParameter @@ -141,19 +186,22 @@ Accept wildcard characters: False ``` ### -DomainName -Specifies the domain for this cmdlet. -You must specify the fully qualified domain name (FQDN) of the domain. +Specifies the domain for this cmdlet. You must specify the fully qualified domain name (FQDN) of the +domain. -For the **Set-GPPermission** cmdlet, the GPO for which to get the permission level must exist in this domain. +For the **Set-GPPermission** cmdlet, the GPO for which to get the permission level must exist in +this domain. -If you do not specify the *DomainName* parameter, the domain of the user that is running the current session is used. -If the cmdlet is being run from a computer startup or shutdown script, the domain of the computer is used. -For more information, see the Notes section in the full Help. +If you do not specify the **DomainName** parameter, the domain of the user that is running the +current session is used. If the cmdlet is being run from a computer startup or shutdown script, the +domain of the computer is used. For more information, see the Notes section in the full Help. -If you specify a domain that is different from the domain of the user that is running the current session (or, for a startup or shutdown script, the computer), a trust must exist between that domain and the domain of the user or the computer. +If you specify a domain that is different from the domain of the user that is running the current +session (or, for a startup or shutdown script, the computer), a trust must exist between that domain +and the domain of the user or the computer. -You can also refer to the *DomainName* parameter by its built-in alias, domain. -For more information, see [about_Aliases](????????????). +You can also refer to the **DomainName** parameter by its built-in alias, domain. For more +information, see [about_Aliases](/powershell/module/microsoft.powershell.core/about/about_aliases). ```yaml Type: System.String @@ -190,9 +238,9 @@ Accept wildcard characters: False Specifies the GPO for which to set the permission level by its display name. -The display name is not guaranteed to be unique in the domain. -If another GPO with the same display name exists in the domain, an error occurs. -You can use the **Guid** parameter to uniquely identify a GPO. +The display name is not guaranteed to be unique in the domain. If another GPO with the same display +name exists in the domain, an error occurs. You can use the **Guid** parameter to uniquely identify +a GPO. You can also refer to the Name parameter by its built-in alias, **DisplayName**. @@ -209,6 +257,7 @@ Accept wildcard characters: False ``` ### -PermissionLevel + Specifies the permission level to set for the security principal. The acceptable values for this parameter are: @@ -233,8 +282,11 @@ Accept wildcard characters: False ``` ### -Replace -Specifies that the existing permission level for the group or user is removed before the new permission level is set. -If a security principal is already granted a permission level that is higher than the specified permission level and you do not use the *Replace* parameter, no change is made. + +Specifies that the existing permission level for the group or user is removed before the new +permission level is set. If a security principal is already granted a permission level that is +higher than the specified permission level and you do not use the *Replace* parameter, no change is +made. ```yaml Type: System.Management.Automation.SwitchParameter @@ -250,12 +302,13 @@ Accept wildcard characters: False ### -Server -Specifies the name of the domain controller that this cmdlet contacts to complete the operation. -You can specify either the fully qualified domain name (FQDN) or the host name. +Specifies the name of the domain controller that this cmdlet contacts to complete the operation. You +can specify either the fully qualified domain name (FQDN) or the host name. -If you do not specify the name by using the **Server** parameter, the primary domain controller (PDC) emulator is contacted. +If you do not specify the name by using the **Server** parameter, the primary domain controller +(PDC) emulator is contacted. -You can also refer to the *Server* parameter by its built-in alias, **DC**. +You can also refer to the **Server** parameter by its built-in alias, **DC**. ```yaml Type: System.String @@ -270,17 +323,18 @@ Accept wildcard characters: False ``` ### -TargetName -The name of the security principal for which to set the permission level. -You can specify a user, a security group, or a computer. -You can use either the domain-qualified name of the security principal (domain\account) or just its name. -For instance, in the contoso.com domain, to specify: +The name of the security principal for which to set the permission level. You can specify a user, a +security group, or a computer. You can use either the domain-qualified name of the security +principal (domain\account) or just its name. -- The user "someuser", use "contoso\someuser" or "someuser". +For instance, in the `contoso.com` domain, to specify: -- The Domain Admins security group, use "contoso\Domain Admins" or "Domain Admins". +- The user `SomeUser`, use `contoso\SomeUser` or `SomeUser`. -- The computer "computer-01", use "contoso\computer-01" or "computer-01". +- The Domain Admins security group, use `contoso\Domain Admins` or `Domain Admins`. + +- The computer `computer-01`, use `contoso\computer-01` or `computer-01`. ```yaml Type: System.String @@ -295,8 +349,9 @@ Accept wildcard characters: False ``` ### -TargetType -The type of security principal for which to set the permission level. -You must specify User, Group, or Computer. + +The type of security principal for which to set the permission level. You must specify User, Group, +or Computer. The acceptable values for this parameter are: @@ -319,8 +374,7 @@ Accept wildcard characters: False ### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml Type: System.Management.Automation.SwitchParameter @@ -336,13 +390,17 @@ Accept wildcard characters: False ### CommonParameters -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). +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). ## INPUTS ### Microsoft.GroupPolicy.Gpo -You can pipe an object that represents a GPO to this cmdlet. -Collections that contain GPOs from different domains are not supported. + +You can pipe an object that represents a GPO to this cmdlet. Collections that contain GPOs from +different domains are not supported. ## OUTPUTS @@ -352,15 +410,17 @@ This cmdlet returns an object that represents the GPO for which the permission l ## NOTES -* You can use the *DomainName* parameter to explicitly specify the domain for this cmdlet. - - If you do not explicitly specify the domain, the cmdlet uses a default domain. -The default domain is the domain that is used to access network resources by the security context under which the current session is running. -This domain is typically the domain of the user that is running the session. -For example, the domain of the user who started the session by opening Windows PowerShell from the Program Files menu, or the domain of a user that is specified in a runas command. -However, computer startup and shutdown scripts run under the context of the LocalSystem account. -The LocalSystem account is a built-in local account, and it accesses network resources under the context of the computer account. -Therefore, when this cmdlet is run from a startup or shutdown script, the default domain is the domain to which the computer is joined. +* You can use the **DomainName** parameter to explicitly specify the domain for this cmdlet. + + If you do not explicitly specify the domain, the cmdlet uses a default domain. The default domain + is the domain that is used to access network resources by the security context under which the + current session is running. This domain is typically the domain of the user that is running the + session. For example, the domain of the user who started the session by opening Windows PowerShell + from the Program Files menu, or the domain of a user that is specified in a runas command. + However, computer startup and shutdown scripts run under the context of the LocalSystem account. + The LocalSystem account is a built-in local account, and it accesses network resources under the + context of the computer account. Therefore, when this cmdlet is run from a startup or shutdown + script, the default domain is the domain to which the computer is joined. ## RELATED LINKS diff --git a/docset/winserver2022-ps/grouppolicy/Set-GPPrefRegistryValue.md b/docset/winserver2022-ps/grouppolicy/Set-GPPrefRegistryValue.md index fc3cbc8f02..33bc36bf35 100644 --- a/docset/winserver2022-ps/grouppolicy/Set-GPPrefRegistryValue.md +++ b/docset/winserver2022-ps/grouppolicy/Set-GPPrefRegistryValue.md @@ -12,52 +12,77 @@ title: Set-GPPrefRegistryValue ## SYNOPSIS -Configures a Registry preference item under either Computer Configuration or User Configuration in a GPO. +Configures a Registry preference item under either Computer Configuration or User Configuration in a +GPO. ## SYNTAX ### ByGUID (Default) + ``` -Set-GPPrefRegistryValue -Guid -Context -Key [-ValueName ] - [-Value ] [-Type ] -Action [-Order ] [-Domain ] - [-Server ] [-Disable] [-WhatIf] [-Confirm] [] +Set-GPPrefRegistryValue -Guid -Context -Key + [-ValueName ] [-Value ] [-Type ] -Action + [-Order ] [-Domain ] [-Server ] [-Disable] [-WhatIf] [-Confirm] + [] ``` ### ByName + ``` -Set-GPPrefRegistryValue [-Name] -Context -Key [-ValueName ] - [-Value ] [-Type ] -Action [-Order ] [-Domain ] - [-Server ] [-Disable] [-WhatIf] [-Confirm] [] +Set-GPPrefRegistryValue [-Name] -Context -Key + [-ValueName ] [-Value ] [-Type ] -Action + [-Order ] [-Domain ] [-Server ] [-Disable] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION -Configures a Registry preference item under either Computer Configuration or User Configuration in a Group Policy Object (GPO). + +Configures a Registry preference item under either Computer Configuration or User Configuration in a +Group Policy Object (GPO). You can configure the Registry preference item for either a registry key or a registry value: -- For a registry key, specify the *Key* parameter, but do not specify the *ValueName*, *Type*, or *Value* parameters. +- For a registry key, specify the **Key** parameter, but do not specify the **ValueName**, **Type**, + or **Value** parameters. -- For a registry value, specify the *Key* parameter together with the *ValueName*, *Type*, and *Value* parameters. +- For a registry value, specify the **Key** parameter together with the **ValueName**, **Type**, and + **Value** parameters. -You must specify the *Context* parameter (User or Computer) to indicate whether to configure the Registry preference item in Computer Configuration or User Configuration. -You must also specify the *Action* parameter to set the action that should be applied on the client. -You can specify the GPO by its display name or GUID. -You can specify the *Disable* parameter to create a Registry preference item that is disabled. +You must specify the **Context** parameter (User or Computer) to indicate whether to configure the +Registry preference item in Computer Configuration or User Configuration. You must also specify the +**Action** parameter to set the action that should be applied on the client. You can specify the GPO +by its display name or GUID. You can specify the **Disable** parameter to create a Registry +preference item that is disabled. -This cmdlet configures new Registry preference items. -It does not modify existing Registry preference items. +This cmdlet configures new Registry preference items. It does not modify existing Registry +preference items. This cmdlet can take input from the pipeline: -- You can pipe GPO objects to this cmdlet to set a specified Registry preference item on one or more GPOs. +- You can pipe GPO objects to this cmdlet to set a specified Registry preference item on one or more + GPOs. -- You can pipe **PreferenceRegistrySetting** objects to this cmdlet to set one or more Registry preference items on a specified GPO. +- You can pipe **PreferenceRegistrySetting** objects to this cmdlet to set one or more Registry + preference items on a specified GPO. ## EXAMPLES ### Example 1: Configure a Registry preference item for a registry value for a GPO + ```powershell -Set-GPPrefRegistryValue -Name "TestGPO" -Context User -Key "HKCU\Software\Policies\Microsoft\Windows\Control Panel" -ValueName "ScreenSaveIsSecure" -Value "1" -Type String -Action Update +$params = @{ + Name = 'TestGPO' + Context = 'User' + Key = 'HKCU\Software\Policies\Microsoft\Windows\Control Panel' + ValueName = 'ScreenSaveIsSecure' + Value = '1' + Type = 'String' + Action = 'Update' +} +Set-GPPrefRegistryValue @params +``` + +```Output DisplayName : TestGPO DomainName : contoso.com Owner : CONTOSO\Domain Admins @@ -71,58 +96,138 @@ ComputerVersion : AD Version: 34, SysVol Version: 34 WmiFilter : ``` -This command configures a Registry preference item for the registry value HKCU\Software\Policies\Microsoft\Windows\Control Panel\ ScreenSaveIsSecure in User Configuration for the GPO named TestGPO. -When the GPO is applied on a client, the registry value is updated with a data type of String (REG_SZ) and value data 1. +This command configures a Registry preference item for the registry value +`HKCU\Software\Policies\Microsoft\Windows\Control Panel\ ScreenSaveIsSecure` in `User` Configuration +for the GPO named `TestGPO`. When the GPO is applied on a client, the registry value is updated with +a data type of `String` (REG_SZ) and value data `1`. ### Example 2: Configure a Registry preference item for a registry value for a GPO + ```powershell -Set-GPPrefRegistryValue -Name "TestGPO" -Context User -Action Create -Key "HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\ExampleKey" -ValueName "ValueOne" -Value "NewData" -Type String +$params = @{ + Name = 'TestGPO' + Context = 'User' + Action = 'Create' + Key = 'HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\ExampleKey' + ValueName = 'ValueOne' + Value = 'NewData' + Type = 'String' +} +Set-GPPrefRegistryValue @params ``` -This command configures a Registry preference item for the registry value HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\ExampleKey ValueOne in User Configuration for the GPO named TestGPO. -When the GPO is applied on a client, the registry value is created with a data type of String (REG_SZ) and value data "NewData". +This command configures a Registry preference item for the registry value +`HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\ExampleKey ValueOne` in `User` Configuration for the GPO +named `TestGPO`. When the GPO is applied on a client, the registry value is created with a data type +of `String` (REG_SZ) and value data `NewData`. ### Example 3: Configure a Registry preference item for a registry value for a GPO specified by GUID + ```powershell -Set-GPPrefRegistryValue -Guid 35c12ab3-956c-45d5-973b-46b17d225f47 -Context Computer -Action Create -Key "HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\ExampleKey\ExampleKey2" +$params = @{ + Guid = '35c12ab3-956c-45d5-973b-46b17d225f47' + Context = 'Computer' + Action = 'Create' + Key = 'HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\ExampleKey\ExampleKey2' +} +Set-GPPrefRegistryValue @params ``` -This command configures a Registry preference item for the registry key HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\ExampleKey\ExampleKey2 in Computer Configuration in the GPO that has ID 35c12ab3-956c-45d5-973b-46b17d225f47. -When the GPO is applied on a client, the registry key is created. +This command configures a Registry preference item for the registry key +`HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\ExampleKey\ExampleKey2` in `Computer` Configuration in the +GPO that has ID `35c12ab3-956c-45d5-973b-46b17d225f47`. When the GPO is applied on a client, the +registry key is created. ### Example 4: Create a disabled Registry preference item for a registry value for a GPO + ```powershell -Remove-GPPrefRegistryValue -Name "TestGPO" -Context User -Key "HKLM\SOFTWARE\Microsoft\ExampleKey" -ValueName "ValueOne" | Set-GPPrefRegistryValue -Context User -Action Create -Disable -Key "HKLM\SOFTWARE\Microsoft\ExampleKey" -ValueName "ValueOne" -Value "SomeData" -Type String +$removeGPPrefParams = @{ + Name = 'TestGPO' + Context = 'User' + Key = 'HKLM\SOFTWARE\Microsoft\ExampleKey' + ValueName = 'ValueOne' +} +$setGPPrefParams = @{ + Context = 'User' + Action = 'Create' + Disable = $true + Key = 'HKLM\SOFTWARE\Microsoft\ExampleKey' + ValueName = 'ValueOne' + Value = 'SomeData' + Type = 'String' +} +Remove-GPPrefRegistryValue @removeGPPrefParams | + Set-GPPrefRegistryValue @setGPPrefParams ``` -This command creates a disabled Registry preference item for the registry value HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\ExampleKey ValueOne in User Configuration in the GPO named TestGPO. -The **Remove-GPPrefRegistryValue** command removes any Registry preference items that configure the value from User Configuration. -Then, the GPO named TestGPO returned by the **Remove-GPPrefRegistryValue** is piped into **Set-GPPrefRegistryValue** to configure the disabled Registry preference item. -After this command completes, the disabled Registry preference item is the only Registry preference item associated with the registry value in User Configuration. +This command creates a disabled Registry preference item for the registry value +`HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\ExampleKey ValueOne` in `User` Configuration in the GPO named +`TestGPO`. The **Remove-GPPrefRegistryValue** command removes any Registry preference items that +configure the value from User Configuration. Then, the GPO named `TestGPO` returned by the +**Remove-GPPrefRegistryValue** is piped into **Set-GPPrefRegistryValue** to configure the `disabled` +Registry preference item. After this command completes, the `disabled` Registry preference item is +the only Registry preference item associated with the registry value in User Configuration. -If TestGPO does not initially have a Registry preference item configured for the specified registry value, a non-terminating error occurs. -You can suppress the error message by supplying the *ErrorAction* parameter to **Remove-GPPrefRegistryValue** and setting its value to SilentlyContinue. -For more information about the ErrorAction parameter, see about_CommonParameters. +If `TestGPO` does not initially have a Registry preference item configured for the specified +registry value, a non-terminating error occurs. You can suppress the error message by supplying the +**ErrorAction** parameter to **Remove-GPPrefRegistryValue** and setting its value to +SilentlyContinue. For more information about the **ErrorAction** parameter, see +[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ### Example 5: Configure a Registry preference item for a registry value for all GPOs + ```powershell -Get-GPO -All | Remove-GPPrefRegistryValue -Context User -Key "HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\ExampleKey" -ValueName "ValueOne" -ErrorAction SilentlyContinue | Set-GPPrefRegistryValue -Context User -Action Update -Key "HKLM\SOFTWARE\Microsoft\ExampleKey" -ValueName "ValueOne" -Value "SomeData" -Type String +$removeGPPrefParams = @{ + Context = 'User' + Key = 'HKLM\SOFTWARE\Microsoft\ExampleKey' + ValueName = 'ValueOne' + ErrorAction = 'SilentlyContinue' +} +$setGPPrefParams = @{ + Context = 'User' + Action = 'Update' + Key = 'HKLM\SOFTWARE\Microsoft\ExampleKey' + ValueName = 'ValueOne' + Value = 'SomeData' + Type = 'String' +} +Get-GPO -All | Remove-GPPrefRegistryValue @removeGPPrefParams | + Set-GPPrefRegistryValue @setGPPrefParams ``` -This command configures a Registry preference item to update the registry value HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\ExampleKey ValueOne for every GPO in the domain that previously had a Registry preference item configured for that value in User Configuration. +This command configures a Registry preference item to update the registry value +`HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\ExampleKey ValueOne` for every GPO in the domain that +previously had a Registry preference item configured for that value in User Configuration. -The command is invoked with the **All** parameter to get all the GPOs in the domain. -These GPOs are piped into the **Remove-GPPrefRegistryValue** cmdlet. -If the GPO contains any Registry preference items configured for the specified key, they are removed. -**Remove-GPPrefRegistryValue** only outputs a GPO to the pipeline if it removes a Registry preference item from a GPO. -Finally, these GPOs are piped to the **Set-GPPrefRegistryValue** to configure the Registry preference item to update the registry value. +The command is invoked with the **All** parameter to get all the GPOs in the domain. These GPOs are +piped into the **Remove-GPPrefRegistryValue** cmdlet. If the GPO contains any Registry preference +items configured for the specified key, they are removed. **Remove-GPPrefRegistryValue** only +outputs a GPO to the pipeline if it removes a Registry preference item from a GPO. Finally, these +GPOs are piped to the **Set-GPPrefRegistryValue** to configure the Registry preference item to +update the registry value. -If a GPO passed to **Remove-GPPrefRegistryValue** does not have a Registry preference item configured for the specified value, a non-terminating error occurs. -The *ErrorAction* parameter is set to SilentlyContinue to suppress the error message. +If a GPO passed to **Remove-GPPrefRegistryValue** does not have a Registry preference item +configured for the specified value, a non-terminating error occurs. The **ErrorAction** parameter is +set to `SilentlyContinue` to suppress the error message. ### Example 6: Copy all Registry preference items for a registry value for a GPO + ```powershell -Get-GPPrefRegistryValue -Name "TestGPO" -Context User -Key "HKLM\Software\Microsoft\ExampleKey" | Set-GPPrefRegistryValue -Name "TestGPO-1" -Context Computer -Order 1 -ErrorAction SilentlyContinue +$getGPPrefParams = @{ + Name = 'TestGPO' + Context = 'User' + Key = 'HKLM\Software\Microsoft\ExampleKey' +} +$setGPPrefParams = @{ + Name = 'TestGPO-1' + Context = 'Computer' + Order = 1 + ErrorAction = 'SilentlyContinue' +} +Get-GPPrefRegistryValue @getGPPrefParams | Set-GPPrefRegistryValue @setGPPrefParams +``` + +```Output DisplayName : TestGPO-1 DomainName : contoso.com Owner : CONTOSO\Domain Admins @@ -149,26 +254,37 @@ ComputerVersion : AD Version: 2, SysVol Version: 2 WmiFilter : ``` -This command copies all Registry preference items that configure first-level values under the registry key HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\ExampleKey from User Configuration in a source GPO named TestGPO to Computer Configuration in destination GPO named TestGPO-1. -A copy of the destination GPO (TestGPO-1) is returned for each Registration preference item set. - -The **Get-GPPrefRegistryValue** command gets all the Registry preference items that configure values under User Configuration in the source GPO. -This command also returns all first level subkeys that have values configured (though not the Registry preference items for the values themselves). -These Registry preference items and the subkeys are then piped into the **Set-GPPrefRegistryValue** cmdlet. - -The **Set-GPPrefRegistryValue** command configures the Registry preference items for the registry values in the destination GPO. - -- The subkeys returned by **Get-GPPrefRegistryValue** do not have an **Action** property, and so a non-terminating error occurs for each subkey. -The *ErrorAction* parameter is specified to suppress these error messages. - -- It is a good practice to specify an order of one (-Order 1) in **Set-GPPrefRegistryValue** when it accepts input from the pipeline. -This is because Registry preference items passed on the pipeline have an **Order** property. -If the **Order** property of a Registry preference item passed on the pipeline is greater than the number of Registry preference items currently configured in the destination GPO, an out of range error occurs and the Registry preference item is not configured in the destination GPO. -By specifying the order as one in the **Set-GPPrefRegistryValue** command, you override the **Order** property of the source Registry preference item, and prevent such errors from occurring. +This command copies all Registry preference items that configure first-level values under the +registry key `HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\ExampleKey` from `User` Configuration in a +source GPO named `TestGPO` to Computer Configuration in destination GPO named `TestGPO-1`. A copy of +the destination GPO `TestGPO-1` is returned for each Registration preference item set. + +The **Get-GPPrefRegistryValue** command gets all the Registry preference items that configure values +under User Configuration in the source GPO. This command also returns all first level subkeys that +have values configured (though not the Registry preference items for the values themselves). These +Registry preference items and the subkeys are then piped into the **Set-GPPrefRegistryValue** +cmdlet. + +The **Set-GPPrefRegistryValue** command configures the Registry preference items for the registry +values in the destination GPO. + +- The subkeys returned by **Get-GPPrefRegistryValue** do not have an **Action** property, and so a + non-terminating error occurs for each subkey. The **ErrorAction** parameter is specified to + suppress these error messages. + +- It is a good practice to specify an order of one `-Order 1` in **Set-GPPrefRegistryValue** when it + accepts input from the pipeline. This is because Registry preference items passed on the pipeline + have an **Order** property. If the **Order** property of a Registry preference item passed on the + pipeline is greater than the number of Registry preference items currently configured in the + destination GPO, an out of range error occurs and the Registry preference item is not configured + in the destination GPO. By specifying the order as one in the **Set-GPPrefRegistryValue** command, + you override the **Order** property of the source Registry preference item, and prevent such + errors from occurring. ## PARAMETERS ### -Action + Specifies the action for the Registry preference item. The acceptable values for this parameter are: @@ -178,7 +294,8 @@ The acceptable values for this parameter are: - Replace - Delete -The action specifies how the Registry preference item is applied to the registry key or registry value on the client when Group Policy is processed. +The action specifies how the Registry preference item is applied to the registry key or registry +value on the client when Group Policy is processed. ```yaml Type: PreferenceAction @@ -210,8 +327,9 @@ Accept wildcard characters: False ``` ### -Context -Specifies whether the Registry preference item is configured under User Configuration or Computer Configuration in the GPO. -The acceptable values for this parameter are: User or Computer. + +Specifies whether the Registry preference item is configured under User Configuration or Computer +Configuration in the GPO. The acceptable values for this parameter are: `User` or `Computer`. ```yaml Type: GpoConfiguration @@ -227,15 +345,21 @@ Accept wildcard characters: False ``` ### -Disable -Indicates that the cmdlet configures the Registry preference item as disabled. -A disabled Registry preference item is not applied when Group Policy is processed on the client, and, therefore, does not modify any existing registry keys or values on the client. -This parameter does not disable an existing Registry preference item in the GPO, rather, it creates a new Registry preference item that is disabled. -Any existing Registry preference items that configure the same key or value will still be applied when the GPO is processed on a client. -This behavior is different than disabling an existing Registry preference item using the GPMC. +Indicates that the cmdlet configures the Registry preference item as disabled. A disabled Registry +preference item is not applied when Group Policy is processed on the client, and, therefore, does +not modify any existing registry keys or values on the client. + +This parameter does not disable an existing Registry preference item in the GPO, rather, it creates +a new Registry preference item that is disabled. Any existing Registry preference items that +configure the same key or value will still be applied when the GPO is processed on a client. This +behavior is different than disabling an existing Registry preference item using the GPMC. -You can use the **Remove-GPPrefRegistryValue** cmdlet to remove any existing Registry preference items associated with the specified key or value from the appropriate configuration (User or Computer) in the GPO before you create the new disabled Registry preference item. -This ensures that after you create the disabled Registry preference item, it will be the only Registry preference item associated with the key or value in the specified configuration in the GPO. +You can use the **Remove-GPPrefRegistryValue** cmdlet to remove any existing Registry preference +items associated with the specified key or value from the appropriate configuration (User or +Computer) in the GPO before you create the new disabled Registry preference item. This ensures that +after you create the disabled Registry preference item, it will be the only Registry preference item +associated with the key or value in the specified configuration in the GPO. ```yaml Type: System.Management.Automation.SwitchParameter @@ -251,19 +375,22 @@ Accept wildcard characters: False ### -Domain -Specifies the domain for this cmdlet. -You must specify the fully qualified domain name (FQDN) of the domain. +Specifies the domain for this cmdlet. You must specify the fully qualified domain name (FQDN) of the +domain. -For the **Set-GPPrefRegistryValue** cmdlet, the GPO for which to configure the Registry preference item must exist in this domain. +For the **Set-GPPrefRegistryValue** cmdlet, the GPO for which to configure the Registry preference +item must exist in this domain. -If you do not specify the **Domain** parameter, the domain of the user that is running the current session is used. -If the cmdlet is being run from a computer startup or shutdown script, the domain of the computer is used. -For more information, see the Notes section in the full Help. +If you do not specify the **Domain** parameter, the domain of the user that is running the current +session is used. If the cmdlet is being run from a computer startup or shutdown script, the domain +of the computer is used. For more information, see the Notes section in the full Help. -If you specify a domain that is different from the domain of the user that is running the current session (or, for a startup or shutdown script, the computer), a trust must exist between that domain and the domain of the user or the computer. +If you specify a domain that is different from the domain of the user that is running the current +session (or, for a startup or shutdown script, the computer), a trust must exist between that domain +and the domain of the user or the computer. -You can also refer to the **Domain** parameter by its built-in alias, **DomainName**. -For more information, see [about_Aliases](????????????). +You can also refer to the **Domain** parameter by its built-in alias, **DomainName**. For more +information, see [about_Aliases](/powershell/module/microsoft.powershell.core/about/about_aliases). ```yaml Type: System.String @@ -279,8 +406,8 @@ Accept wildcard characters: False ### -Guid -Specifies the GPO in which to configure the Registry preference item by its globally unique identifier (GUID). -The GUID uniquely identifies the GPO. +Specifies the GPO in which to configure the Registry preference item by its globally unique +identifier (GUID). The GUID uniquely identifies the GPO. You can also refer to the **Guid** parameter by its built-in alias, **Id**. @@ -297,16 +424,22 @@ Accept wildcard characters: False ``` ### -Key -Specifies the registry key for the Registry preference item; for instance: HKEY_CURRENT_USER\Control Panel\Colors. -You can specify any of the following registry hives: HKEY_CLASSES_ROOT (HKCR), HKEY_CURRENT_USER (HKCU), HKEY_LOCAL_MACHINE (HKLM), HKEY_USERS (HKU), and HKEY_CURRENT_CONFIG (HKCC). -Any of these hives can be specified for Registry preference items in both Computer Configuration and User Configuration. +Specifies the registry key for the Registry preference item; for instance: +`HKEY_CURRENT_USER\Control Panel\Colors`. + +You can specify any of the following registry hives: `HKEY_CLASSES_ROOT` (HKCR), `HKEY_CURRENT_USER` +(HKCU), `HKEY_LOCAL_MACHINE` (HKLM), `HKEY_USERS` (HKU), and `HKEY_CURRENT_CONFIG` (HKCC). Any of +these hives can be specified for Registry preference items in both Computer Configuration and User +Configuration. You can configure a preference registry setting for a registry key or a registry value. -- To configure a setting for a registry key, specify the *Key* parameter without the *ValueName*, *Value*, or *Type* parameters. +- To configure a setting for a registry key, specify the **Key** parameter without the *ValueName*, + **Value**, or **Type** parameters. -- To configure a setting for a registry value, specify the *Key* parameter together with the *ValueName*, *Value*, and *Type* parameters. +- To configure a setting for a registry value, specify the **Key** parameter together with the + **ValueName**, **Value**, and **Type** parameters. ```yaml Type: System.String @@ -321,11 +454,12 @@ Accept wildcard characters: False ``` ### -Name + Specifies the GPO in which to configure the Registry preference item by its display name. -The display name is not guaranteed to be unique in the domain. -If another GPO with the same display name exists in the domain, an error occurs. -You can use the **Guid** parameter to uniquely identify a GPO. +The display name is not guaranteed to be unique in the domain. If another GPO with the same display +name exists in the domain, an error occurs. You can use the **Guid** parameter to uniquely identify +a GPO. You can also refer to the **Name** parameter by its built-in alias, **DisplayName**. @@ -342,15 +476,20 @@ Accept wildcard characters: False ``` ### -Order -Specifies the order in which the Registry preference item is processed relative to other Registry preference items in the GPO when the GPO is applied on a client computer. -If two Registry preference items in the GPO change the same registry value, the one that has the highest order is the last to modify the value on the client. -By default, if the *Order* parameter is not specified, the order is set to one plus the current number of Registry preference items in the GPO. -You can specify any value greater than zero. -If you specify a value larger than the default value, the order is set to the default. +Specifies the order in which the Registry preference item is processed relative to other Registry +preference items in the GPO when the GPO is applied on a client computer. If two Registry preference +items in the GPO change the same registry value, the one that has the highest order is the last to +modify the value on the client. + +By default, if the **Order** parameter is not specified, the order is set to one plus the current +number of Registry preference items in the GPO. You can specify any value greater than zero. If you +specify a value larger than the default value, the order is set to the default. The order of a setting can change as Registry preference items are added or removed from the GPO. -For instance, if the GPO has five Registry preference items, and you add another one and specify an order of 4, the Registry preference items that previously were at order 4 and 5, are at order 5 and 6 after the change. +For instance, if the GPO has five Registry preference items, and you add another one and specify an +order of `4`, the Registry preference items that previously were at order `4` and `5`, are at order +`5` and `6` after the change. ```yaml Type: Int32 @@ -366,12 +505,13 @@ Accept wildcard characters: False ### -Server -Specifies the name of the domain controller that this cmdlet contacts to complete the operation. -You can specify either the fully qualified domain name (FQDN) or the host name. +Specifies the name of the domain controller that this cmdlet contacts to complete the operation. You +can specify either the fully qualified domain name (FQDN) or the host name. -If you do not specify the name by using the **Server** parameter, the primary domain controller (PDC) emulator is contacted. +If you do not specify the name by using the **Server** parameter, the primary domain controller +(PDC) emulator is contacted. -You can also refer to the *Server* parameter by its built-in alias, **DC**. +You can also refer to the **Server** parameter by its built-in alias, **DC**. ```yaml Type: System.String @@ -386,6 +526,7 @@ Accept wildcard characters: False ``` ### -Type + Specifies the data type of the registry value for the Registry preference item. The acceptable values for this parameter are: @@ -398,10 +539,13 @@ The acceptable values for this parameter are: - ExpandString - Qword -For more information about these data types, see [Microsoft.Win32.RegistryValueKind Enumeration](https://go.microsoft.com/fwlink/?LinkID=143266) in the MSDN library. +For more information about these data types, see +[Microsoft.Win32.RegistryValueKind Enumeration](https://go.microsoft.com/fwlink/?LinkID=143266) in +the MSDN library. When you configure a Registry preference item for a registry key, do not specify this parameter. -When you configure a Registry preference item for a registry value, specify this parameter together with the *Key*, *ValueName*, and *Value* parameters. +When you configure a Registry preference item for a registry value, specify this parameter together +with the **Key**, **ValueName**, and **Value** parameters. ```yaml Type: RegistryValueKind @@ -417,11 +561,14 @@ Accept wildcard characters: False ``` ### -Value -Specifies the value data of the registry value for the Registry preference item. -For instance, the registry value "HKEY_CURRENT_USER\Control Panel\Colors ActiveTitle" can have the following (value) data: 10 36 106. + +Specifies the value data of the registry value for the Registry preference item. For instance, the +registry value `HKEY_CURRENT_USER\Control Panel\Colors ActiveTitle` can have the following (value) +`data: 10 36 106`. When you configure a Registry preference item for a registry key, do not specify this parameter. -When you configure a Registry preference item for a registry value, specify this parameter together with the *Key*, *ValueName*, and *Type* parameters. +When you configure a Registry preference item for a registry value, specify this parameter together +with the **Key**, **ValueName**, and **Type** parameters. ```yaml Type: PSObject @@ -436,12 +583,15 @@ Accept wildcard characters: False ``` ### -ValueName -Specifies the value name of the registry value for the Registry preference item. -For instance, the registry key "HKEY_CURRENT_USER\Control Panel\Colors" can have a value with the following name: ActiveTitle. -For the default value of a registry key, specify either "(default)" or an empty string (""). + +Specifies the value name of the registry value for the Registry preference item. For instance, the +registry key `HKEY_CURRENT_USER\Control Panel\Colors` can have a value with the following name: +`ActiveTitle`. For the default value of a registry key, specify either `(default)` or an empty string +`""`. When you configure a Registry preference item for a registry key, do not specify this parameter. -When you configure a Registry preference item for a registry value, specify this parameter together with the *Key*, *Value*, and *Type* parameters. +When you configure a Registry preference item for a registry value, specify this parameter together +with the **Key**, **Value**, and **Type** parameters. ```yaml Type: System.String @@ -457,8 +607,7 @@ Accept wildcard characters: False ### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml Type: System.Management.Automation.SwitchParameter @@ -474,13 +623,18 @@ Accept wildcard characters: False ### CommonParameters -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). +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). ## INPUTS ### Microsoft.GroupPolicy.Gpo, Microsoft.GroupPolicy.PreferenceRegistrySetting -You can pipe a GPO object (in which to configure a specified preference registry setting) to this cmdlet, or a **PreferenceRegistrySetting** object (to configure in a specified GPO). -Collections that contain GPOs from different domains are not supported. + +You can pipe a GPO object (in which to configure a specified preference registry setting) to this +cmdlet, or a **PreferenceRegistrySetting** object (to configure in a specified GPO). Collections +that contain GPOs from different domains are not supported. ## OUTPUTS @@ -492,13 +646,15 @@ This cmdlet returns the GPO in which the Registry preference item was configured * You can use the **Domain** parameter to explicitly specify the domain for this cmdlet. - If you do not explicitly specify the domain, the cmdlet uses a default domain. -The default domain is the domain that is used to access network resources by the security context under which the current session is running. -This domain is typically the domain of the user that is running the session. -For instance, the domain of the user who started the session by opening Windows PowerShell from the Program Files menu, or the domain of a user that is specified in a runas command. -However, computer startup and shutdown scripts run under the context of the LocalSystem account. -The LocalSystem account is a built-in local account, and it accesses network resources under the context of the computer account. -Therefore, when this cmdlet is run from a startup or shutdown script, the default domain is the domain to which the computer is joined. + If you do not explicitly specify the domain, the cmdlet uses a default domain. The default domain + is the domain that is used to access network resources by the security context under which the + current session is running. This domain is typically the domain of the user that is running the + session. For instance, the domain of the user who started the session by opening Windows + PowerShell from the Program Files menu, or the domain of a user that is specified in a runas + command. However, computer startup and shutdown scripts run under the context of the LocalSystem + account. The LocalSystem account is a built-in local account, and it accesses network resources + under the context of the computer account. Therefore, when this cmdlet is run from a startup or + shutdown script, the default domain is the domain to which the computer is joined. ## RELATED LINKS diff --git a/docset/winserver2022-ps/grouppolicy/Set-GPRegistryValue.md b/docset/winserver2022-ps/grouppolicy/Set-GPRegistryValue.md index fee4390176..2eaacfbd21 100644 --- a/docset/winserver2022-ps/grouppolicy/Set-GPRegistryValue.md +++ b/docset/winserver2022-ps/grouppolicy/Set-GPRegistryValue.md @@ -17,6 +17,7 @@ Configures one or more registry-based policy settings under either Computer Conf ## SYNTAX ### ByGUID (Default) + ``` Set-GPRegistryValue -Guid -Key [-ValueName ] [-Value ] [-Type ] [-Domain ] [-Server ] [-Additive] [-Disable] @@ -24,6 +25,7 @@ Set-GPRegistryValue -Guid -Key [-ValueName ] [-Value < ``` ### ByName + ``` Set-GPRegistryValue [-Name] -Key [-ValueName ] [-Value ] [-Type ] [-Domain ] [-Server ] [-Additive] [-Disable] @@ -31,39 +33,56 @@ Set-GPRegistryValue [-Name] -Key [-ValueName ] [-Val ``` ## DESCRIPTION -The **Set-GPRegistryValue** cmdlet configures a registry-based policy setting under either Computer Configuration or User Configuration in a Group Policy Object (GPO). -The policy setting configures keys or values in the registry on the client computer when the GPO is applied. -You can specify the GPO by name or by its GUID, or you can pipe a GPO object to the cmdlet. -You can also pipe a PolicyRegistrySetting object to the cmdlet. +The **Set-GPRegistryValue** cmdlet configures a registry-based policy setting under either Computer +Configuration or User Configuration in a Group Policy Object (GPO). The policy setting configures +keys or values in the registry on the client computer when the GPO is applied. + +You can specify the GPO by name or by its GUID, or you can pipe a GPO object to the cmdlet. You can +also pipe a PolicyRegistrySetting object to the cmdlet. You can configure registry-based policy settings for: -- One or more registry values by passing the *Key*, *ValueName*, *Value*, and *Type* parameters. -For multiple registry values, pass a comma-separated list for both the *ValueName* and *Value* parameters. -When you specify multiple registry values, only the String and ExpandString data types are supported. +- One or more registry values by passing the **Key**, **ValueName**, **Value**, and **Type** + parameters. For multiple registry values, pass a comma-separated list for both the **ValueName** + and **Value** parameters. When you specify multiple registry values, only the `String` and + `ExpandString` data types are supported. -- A list of one or more registry values that share the same name prefix by passing the *Key* and *Type* parameters, and a single value or a comma-separated list for the *Value* parameter. -You can optionally specify the value name prefix by using the *ValuePrefix* parameter. -Only the String and ExpandString data types are supported for lists. +- A list of one or more registry values that share the same name prefix by passing the **Key** and + **Type** parameters, and a single value or a comma-separated list for the **Value** parameter. You + can optionally specify the value name prefix by using the **ValuePrefix** parameter. Only the + `String` and `ExpandString` data types are supported for lists. -You can use the *Additive* parameter to ensure that existing registry values for the key are not overwritten by the new policy setting when the GPO is applied. +You can use the **Additive** parameter to ensure that existing registry values for the key are not +overwritten by the new policy setting when the GPO is applied. -You can also delete registry values on a client when the GPO is applied by disabling a policy setting with the *Disable* parameter. -You can disable: +You can also delete registry values on a client when the GPO is applied by disabling a policy +setting with the **Disable** parameter. You can disable: -- All the registry values under a specified registry key by passing the *Key* parameter. -No subkeys, or their values, are deleted on the client. +- All the registry values under a specified registry key by passing the **Key** parameter. No + subkeys, or their values, are deleted on the client. -- A single registry value by passing the *Key* parameter and the *ValueName* parameter. +- A single registry value by passing the **Key** parameter and the **ValueName** parameter. -- Multiple registry values by passing the *Key* parameter and a comma-separated list for the *ValueName* parameter. +- Multiple registry values by passing the **Key** parameter and a comma-separated list for the + **ValueName** parameter. ## EXAMPLES ### Example 1: Configure a registry-based policy setting for a registry value + ```powershell -Set-GPRegistryValue -Name "TestGPO" -Key "HKCU\Software\Policies\Microsoft\Windows\Control Panel\Desktop" -ValueName "ScreenSaveTimeOut" -Type DWORD -Value 900 +$params = @{ + Name = 'TestGPO' + Key = 'HKCU\Software\Policies\Microsoft\Windows\Control Panel\Desktop' + ValueName = 'ScreenSaveTimeOut' + Value = 900 + Type = 'DWORD' +} +Set-GPRegistryValue @params +``` + +```Output DisplayName : TestGPO DomainName : contoso.com Owner : CONTOSO\Domain Admins @@ -77,68 +96,101 @@ ComputerVersion : AD Version: 34, SysVol Version: 34 WmiFilter : ``` -This command configures a registry-based policy setting for the registry value "HKCU\Software\Policies\Microsoft\Windows\Control ScreenSaverTimeOut" with a value of 900 and a data type of DWord. -This policy setting sets the Screen Saver timeout to 900 seconds (15 minutes) when Group Policy is applied on the client. +This command configures a registry-based policy setting for the registry value +`HKCU\Software\Policies\Microsoft\Windows\Control ScreenSaverTimeOut` with a value of `900` and a +data type of `DWord`. This policy setting sets the Screen Saver timeout to 900 seconds (15 minutes) +when Group Policy is applied on the client. ### Example 1: Configure a registry-based policy settings for multiple registry values + ```powershell -Set-GPRegistryValue -Name "TestGPO" -Key "HKCU\Software\Policies\Microsoft\ExampleKey" -ValueName "ValueOne", "ValueTwo", "ValueThree" -Type String -Value "String 1", "String 2", "String 3" +$params = @{ + Name = 'TestGPO' + Key = 'HKCU\Software\Policies\Microsoft\ExampleKey' + ValueName = 'ValueOne', 'ValueTwo', 'ValueThree' + Value = 'String 1', 'String 2', 'String 3' + Type = 'String' +} +Set-GPRegistryValue @params ``` -This command configures registry-based policy settings to set three registry values. -The policy settings are configured in the User Configuration section of the GPO. -When the GPO is applied on the client, the following registry values are set: +This command configures registry-based policy settings to set three registry values. The policy +settings are configured in the `User` Configuration section of the GPO. When the GPO is applied on +the client, the following registry values are set: -"HKCU\Software\Policies\Microsoft\ExampleKey ValueOne" "String 1" +`HKCU\Software\Policies\Microsoft\ExampleKey ValueOne` `String 1` -"HKCU\Software\Policies\Microsoft\ExampleKey ValueTwo" "String 2" +`HKCU\Software\Policies\Microsoft\ExampleKey ValueTwo` `String 2` -"HKCU\Software\Policies\Microsoft\ExampleKey ValueThree" "String 3" +`HKCU\Software\Policies\Microsoft\ExampleKey ValueThree` `String 3` ### Example 3: Configure a registry-based policy setting to set a list of registry values + ```powershell -Set-GPRegistryValue -Name "TestGPO" -Key "HKCU\Software\Policies\Microsoft\ExampleKey" -ValuePrefix "MyValue" -Type String -Value "String 1", "String 2", "String 3" +$params = @{ + Name = 'TestGPO' + Key = 'HKCU\Software\Policies\Microsoft\ExampleKey' + ValuePrefix = 'MyValue' + Type = 'String' + Value = 'String 1', 'String 2', 'String 3' +} +Set-GPRegistryValue @params ``` -This command configures a registry-based policy setting to set a list of three registry values. -The policy settings are configured in the Computer Configuration section of the GPO. -Because the *Additive* parameter is not specified, when the GPO is applied on the client any list values under the key are deleted -- then, the following registry values are set: +This command configures a registry-based policy setting to set a list of three registry values. The +policy settings are configured in the `User` Configuration section of the GPO. Because the +**Additive** parameter is not specified, when the GPO is applied on the client any list values under +the key are deleted -- then, the following registry values are set: -"HKCU\Software\Policies\Microsoft\ExampleKey MyValue1" "String 1" +`HKCU\Software\Policies\Microsoft\ExampleKey MyValue1` `String 1` -"HKCU\Software\Policies\Microsoft\ExampleKey MyValue2" "String 2" +`HKCU\Software\Policies\Microsoft\ExampleKey MyValue2` `String 2` -"HKCU\Software\Policies\Microsoft\ExampleKey MyValue3" "String 3" +`HKCU\Software\Policies\Microsoft\ExampleKey MyValue3` `String 3` -If you specify the *Additive* parameter, the list values are added to the existing list values on the client when the GPO is applied. -The actual value names assigned to the list values depends on the number of existing list values on the client. +If you specify the **Additive** parameter, the list values are added to the existing list values on +the client when the GPO is applied. The actual value names assigned to the list values depends on +the number of existing list values on the client. ### Example 4: Disable registry-based policy settings for specific registry values + ```powershell -Set-GPRegistryValue -Disable -Name "TestGPO" -Key "HKCU\Software\Policies\Microsoft\ExampleKey" -ValueName "ValueOne", "ValueTwo", "ValueThree" +$params = @{ + Disable = $true + Name = 'TestGPO' + Key = 'HKCU\Software\Policies\Microsoft\ExampleKey' + ValueName = 'ValueOne', 'ValueTwo', 'ValueThree' +} +Set-GPRegistryValue @params ``` -This command disables the registry-based policy settings, in the User Configuration section, for the specified registry values. -When the GPO is applied on the client, the registry values are deleted from the registry on the client. +This command `disables` the registry-based policy settings, in the `User` Configuration section, for +the specified registry values. When the GPO is applied on the client, the registry values are +deleted from the registry on the client. ### Example 5: Disable registry-based policy settings for a specific registry key + ```powershell -Set-GPRegistryValue -Disable -Name "TestGPO" -Key "HKCU\Software\Policies\Microsoft\ExampleKey" +Set-GPRegistryValue -Disable -Name 'TestGPO' -Key 'HKCU\Software\Policies\Microsoft\ExampleKey' ``` -This command disables the registry-based policy setting, in the User Configuration section, for the specified registry key. -When the GPO is applied on the client, all first level values will be deleted from the registry key. -Subkeys and their values are not modified. +This command `disables` the registry-based policy setting, in the `User` Configuration section, for +the specified registry key. When the GPO is applied on the client, all first level values will be +deleted from the registry key. Subkeys and their values are not modified. ## PARAMETERS ### -Additive -Indicates that registry values should be appended to existing values under the key when the GPO is applied on a client. -By default, when Group Policy is processed on a client, existing values under a registry key are deleted before any new values are written to the registry. -By using the *Additive* parameter for a registry-based policy setting, you can specify that the new value should be added to the registry key without deleting the existing values. +Indicates that registry values should be appended to existing values under the key when the GPO is +applied on a client. -You cannot specify the *Disable* parameter with this parameter. +By default, when Group Policy is processed on a client, existing values under a registry key are +deleted before any new values are written to the registry. By using the **Additive** parameter for a +registry-based policy setting, you can specify that the new value should be added to the registry +key without deleting the existing values. + +You cannot specify the **Disable** parameter with this parameter. ```yaml Type: System.Management.Automation.SwitchParameter @@ -169,20 +221,24 @@ Accept wildcard characters: False ``` ### -Disable + Indicates that the cmdlet disables the registry-based policy setting. You can disable a policy setting for a registry key or value: -- For a registry key, specify the *Key* parameter without the *ValueName* parameter. -When the GPO is applied on the client, all of the values directly under the key are removed from the registry. -The key itself is not removed from the registry, nor are any of its subkeys, or their values, removed. +- For a registry key, specify the **Key** parameter without the **ValueName** parameter. When the GPO + is applied on the client, all of the values directly under the key are removed from the registry. + The key itself is not removed from the registry, nor are any of its subkeys, or their values, + removed. -- For a registry value, specify the *Key* parameter together with the *ValueName* parameter. -When the GPO is applied on the client, only the specified value is removed from the registry. +- For a registry value, specify the **Key** parameter together with the **ValueName** parameter. + When the GPO is applied on the client, only the specified value is removed from the registry. -To remove a policy setting from a GPO without affecting existing registry keys or values on a client when Group Policy is processed, use the **Remove-GPRegistryValue** cmdlet. +To remove a policy setting from a GPO without affecting existing registry keys or values on a client +when Group Policy is processed, use the **Remove-GPRegistryValue** cmdlet. -You cannot specify the *Additive*, *Type*, *Value*, or *ValuePrefix* parameters with the *Disable* parameter. +You cannot specify the **Additive**, **Type**, **Value**, or **ValuePrefix** parameters with the +**Disable** parameter. ```yaml Type: System.Management.Automation.SwitchParameter @@ -198,19 +254,22 @@ Accept wildcard characters: False ### -Domain -Specifies the domain for this cmdlet. -You must specify the fully qualified domain name (FQDN) of the domain. +Specifies the domain for this cmdlet. You must specify the fully qualified domain name (FQDN) of the +domain. -For the **Set-GPRegistryValue** cmdlet, the GPO in which to configure the registry-based policy setting must exist in this domain. +For the **Set-GPRegistryValue** cmdlet, the GPO in which to configure the registry-based policy +setting must exist in this domain. -If you do not specify the **Domain** parameter, the domain of the user that is running the current session is used. -If the cmdlet is being run from a computer startup or shutdown script, the domain of the computer is used. -For more information, see the Notes section in the full Help. +If you do not specify the **Domain** parameter, the domain of the user that is running the current +session is used. If the cmdlet is being run from a computer startup or shutdown script, the domain +of the computer is used. For more information, see the Notes section in the full Help. -If you specify a domain that is different from the domain of the user that is running the current session (or, for a startup or shutdown script, the computer), a trust must exist between that domain and the domain of the user or the computer. +If you specify a domain that is different from the domain of the user that is running the current +session (or, for a startup or shutdown script, the computer), a trust must exist between that domain +and the domain of the user or the computer. -You can also refer to the **Domain** parameter by its built-in alias, **DomainName**. -For more information, see [about_Aliases](????????????). +You can also refer to the **Domain** parameter by its built-in alias, **DomainName**. For more +information, see [about_Aliases](/powershell/module/microsoft.powershell.core/about/about_aliases). ```yaml Type: System.String @@ -226,8 +285,8 @@ Accept wildcard characters: False ### -Guid -Specifies the GPO in which to configure the registry-based policy setting by its globally unique identifier (GUID). -The GUID uniquely identifies the GPO. +Specifies the GPO in which to configure the registry-based policy setting by its globally unique +identifier (GUID). The GUID uniquely identifies the GPO. You can also refer to the **Guid** parameter by its built-in alias, **Id**. @@ -244,13 +303,15 @@ Accept wildcard characters: False ``` ### -Key -Specifies the registry key for the registry-based policy setting; for instance, HKLM\Software\Policies\Microsoft\Windows NT\DNSClient. + +Specifies the registry key for the registry-based policy setting; for instance, +`HKLM\Software\Policies\Microsoft\Windows NT\DNSClient`. The key must be in one of the two following registry hives: -- HKEY_LOCAL_MACHINE (HKLM) for a registry-based policy setting in Computer Configuration. +- `HKEY_LOCAL_MACHINE` (HKLM) for a registry-based policy setting in Computer Configuration. -- HKEY_CURRENT_USER (HKCU) for a registry-based policy setting in User Configuration. +- `HKEY_CURRENT_USER` (HKCU) for a registry-based policy setting in User Configuration. You can also refer to the Key parameter by its built-in alias, FullKeyPath. @@ -267,11 +328,12 @@ Accept wildcard characters: False ``` ### -Name + Specifies the GPO in which to configure the registry-based policy setting by its display name. -The display name is not guaranteed to be unique in the domain. -If another GPO with the same display name exists in the domain, an error occurs. -You can use the **Guid** parameter to uniquely identify a GPO. +The display name is not guaranteed to be unique in the domain. If another GPO with the same display +name exists in the domain, an error occurs. You can use the **Guid** parameter to uniquely identify +a GPO. You can also refer to the **Name** parameter by its built-in alias, **DisplayName**. @@ -289,12 +351,13 @@ Accept wildcard characters: False ### -Server -Specifies the name of the domain controller that this cmdlet contacts to complete the operation. -You can specify either the fully qualified domain name (FQDN) or the host name. +Specifies the name of the domain controller that this cmdlet contacts to complete the operation. You +can specify either the fully qualified domain name (FQDN) or the host name. -If you do not specify the name by using the **Server** parameter, the primary domain controller (PDC) emulator is contacted. +If you do not specify the name by using the **Server** parameter, the primary domain controller +(PDC) emulator is contacted. -You can also refer to the *Server* parameter by its built-in alias, **DC**. +You can also refer to the **Server** parameter by its built-in alias, **DC**. ```yaml Type: System.String @@ -309,6 +372,7 @@ Accept wildcard characters: False ``` ### -Type + Specifies the data type for the registry-based policy setting. The acceptable values for this parameter are: @@ -320,12 +384,14 @@ The acceptable values for this parameter are: - MultiString - QWord -For more information about these data types, see [Microsoft.Win32.RegistryValueKind Enumeration](https://go.microsoft.com/fwlink/?LinkID=143266) in the MSDN library. +For more information about these data types, see +[Microsoft.Win32.RegistryValueKind Enumeration](https://go.microsoft.com/fwlink/?LinkID=143266) in +the MSDN library. -Only the following data types are supported for list values: String and ExpandString. +Only the following data types are supported for list values: `String` and `ExpandString`. You must specify this parameter when you configure a policy setting to set a registry value. -You cannot specify this parameter with the *Disable* parameter. +You cannot specify this parameter with the **Disable** parameter. The following values are permitted for this object type. @@ -343,13 +409,14 @@ Accept wildcard characters: False ``` ### -Value -Specifies the value data for the registry-based policy setting. -You can specify a single value or an array of values. -Use a comma-separated list to specify more than one value. -Only the String and ExpandString data types are supported for an array of values. -At a minimum, you must specify this parameter together with the *Type* and *Key* parameters to configure a policy setting to set a registry value. -You cannot specify this parameter with the *Disable* parameter. +Specifies the value data for the registry-based policy setting. You can specify a single value or an +array of values. Use a comma-separated list to specify more than one value. Only the `String` and +`ExpandString` data types are supported for an array of values. + +At a minimum, you must specify this parameter together with the *Type* and **Key** parameters to +configure a policy setting to set a registry value. You cannot specify this parameter with the +**Disable** parameter. ```yaml Type: PSObject @@ -364,12 +431,14 @@ Accept wildcard characters: False ``` ### -ValueName -Specifies a value name or an array of value names for the registry-based policy setting. -For instance, the registry key HKLM\Software\Policies\Microsoft\Windows NT\DNSClient can have a registry value with the following value name: UseDomainNameDevolution. -Use a comma-separated list to specify more than one value name. -Only the String and ExpandString data types are supported for an array of values. -You cannot specify this parameter with the *ValuePrefix* parameter. +Specifies a value name or an array of value names for the registry-based policy setting. For +instance, the registry key `HKLM\Software\Policies\Microsoft\Windows NT\DNSClient` can have a +registry value with the following value name: `UseDomainNameDevolution`. Use a comma-separated list +to specify more than one value name. Only the `String` and `ExpandString` data types are supported +for an array of values. + +You cannot specify this parameter with the **ValuePrefix** parameter. ```yaml Type: System.String[] @@ -384,19 +453,21 @@ Accept wildcard characters: False ``` ### -ValuePrefix + Specifies a value name prefix for a registry-based policy setting for a list of registry values. -Configures a policy setting that creates the following registry values when Group Policy is applied on the client: +Configures a policy setting that creates the following registry values when Group Policy is applied +on the client: -"HKLM\SOFTWARE\Policies\ExampleKey ExValue1" 100 +`HKLM\SOFTWARE\Policies\ExampleKey ExValue1` `100` -"HKLM\SOFTWARE\Policies\ExampleKey ExValue2" 200 +`HKLM\SOFTWARE\Policies\ExampleKey ExValue2` `200` -"HKLM\SOFTWARE\Policies\ExampleKey ExValue3" 300 +`HKLM\SOFTWARE\Policies\ExampleKey ExValue3` `300` -Only the String and ExpandString data types are supported with the *ValuePrefix* parameter. +Only the `String` and `ExpandString` data types are supported with the **ValuePrefix** parameter. -You cannot specify this parameter with the *ValueName* parameter or the *Disable* parameter. +You cannot specify this parameter with the **ValueName** parameter or the **Disable** parameter. ```yaml Type: System.String @@ -412,8 +483,7 @@ Accept wildcard characters: False ### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml Type: System.Management.Automation.SwitchParameter @@ -429,13 +499,19 @@ Accept wildcard characters: False ### CommonParameters -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). +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). ## INPUTS ### Microsoft.GroupPolicy.Gpo or Microsoft.GroupPolicy.PolicyRegistrySetting -You can pipe a GPO (in which to configure a registry-based policy setting), or a **PolicyRegistrySetting** object that represents a registry-based policy setting (to configure in a specified GPO) to this cmdlet. -Collections that contain GPOs from different domains are not supported. + +You can pipe a GPO (in which to configure a registry-based policy setting), or a +**PolicyRegistrySetting** object that represents a registry-based policy setting (to configure in a +specified GPO) to this cmdlet. Collections that contain GPOs from different domains are not +supported. ## OUTPUTS @@ -445,17 +521,21 @@ This cmdlet returns the GPO in which the registry-based policy setting has been ## NOTES -* The hive of the registry key that you specify, HKEY_LOCAL_MACHINE (HKLM) or HKEY_CURRENT_USER (HKCU), determines whether the registry-based policy setting is in Computer Configuration or User Configuration. +* The hive of the registry key that you specify, `HKEY_LOCAL_MACHINE` (HKLM) or `HKEY_CURRENT_USER` + (HKCU), determines whether the registry-based policy setting is in Computer Configuration or User + Configuration. You can use the **Domain** parameter to explicitly specify the domain for this cmdlet. - If you do not explicitly specify the domain, the cmdlet uses a default domain. -The default domain is the domain that is used to access network resources by the security context under which the current session is running. -This domain is typically the domain of the user that is running the session. -For instance, the domain of the user who started the session by opening Windows PowerShell from the Program Files menu, or the domain of a user that is specified in a runas command. -However, computer startup and shutdown scripts run under the context of the LocalSystem account. -The LocalSystem account is a built-in local account, and it accesses network resources under the context of the computer account. -Therefore, when this cmdlet is run from a startup or shutdown script, the default domain is the domain to which the computer is joined. + If you do not explicitly specify the domain, the cmdlet uses a default domain. The default domain + is the domain that is used to access network resources by the security context under which the + current session is running. This domain is typically the domain of the user that is running the + session. For instance, the domain of the user who started the session by opening Windows + PowerShell from the Program Files menu, or the domain of a user that is specified in a runas + command. However, computer startup and shutdown scripts run under the context of the LocalSystem + account. The LocalSystem account is a built-in local account, and it accesses network resources + under the context of the computer account. Therefore, when this cmdlet is run from a startup or + shutdown script, the default domain is the domain to which the computer is joined. ## RELATED LINKS From 2e478aa047d0b7bc79582b3cedbe2b6d8ce557af Mon Sep 17 00:00:00 2001 From: "Mikey Lombardi (He/Him)" Date: Wed, 3 May 2023 09:51:13 -0500 Subject: [PATCH 386/650] Apply suggestions from review --- docset/winserver2022-ps/deduplication/Stop-DedupJob.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docset/winserver2022-ps/deduplication/Stop-DedupJob.md b/docset/winserver2022-ps/deduplication/Stop-DedupJob.md index 2b85f3669a..95164a48e5 100644 --- a/docset/winserver2022-ps/deduplication/Stop-DedupJob.md +++ b/docset/winserver2022-ps/deduplication/Stop-DedupJob.md @@ -194,7 +194,7 @@ Accept wildcard characters: False Specifies one or more file system volumes on which to cancel one or more named data deduplication jobs. Enter one or more volume IDs, drive letters, or volume GUID paths. For drive letters, use the -format `D:`. For volume GUID paths, use the format `\\\\?\Volume{{GUID}}\`. Separate multiple +format `D:`. For volume GUID paths, use the format `\\?\Volume{{GUID}}\`. Separate multiple volumes with a comma. ```yaml @@ -222,7 +222,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ### Microsoft.Management.Infrastructure.CimInstance -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays +The **Microsoft.Management.Infrastructure.CimInstance** object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. @@ -232,13 +232,13 @@ namespace and class name for the underlying WMI object. ### Microsoft.Management.Infrastructure.CimInstance -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays +The **Microsoft.Management.Infrastructure.CimInstance** object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. ### Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Deduplication/MSFT_DedupJob -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays +The **Microsoft.Management.Infrastructure.CimInstance** object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. From ffc07f927ade866950a1ce447ea1791e6c3bcf92 Mon Sep 17 00:00:00 2001 From: Robert Biddle Date: Tue, 2 May 2023 22:08:19 -0400 Subject: [PATCH 387/650] Spelling dictionary additions --- .vscode/cspell/winmodules/dictionaries/winps.txt | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.vscode/cspell/winmodules/dictionaries/winps.txt b/.vscode/cspell/winmodules/dictionaries/winps.txt index 90698b8fc4..12c6406141 100644 --- a/.vscode/cspell/winmodules/dictionaries/winps.txt +++ b/.vscode/cspell/winmodules/dictionaries/winps.txt @@ -5,6 +5,9 @@ Dedup DSRM krbtgt NTDS +reoptimized RODC Sysvol Unoptimization +unoptimization +unoptimizes From 8aff46db7ddef237b2e28fd083bd2b5d5eed09b1 Mon Sep 17 00:00:00 2001 From: Robert Biddle Date: Tue, 2 May 2023 22:08:39 -0400 Subject: [PATCH 388/650] Style guide fixes --- .../deduplication/Start-DedupJob.md | 208 +++++++++++------- 1 file changed, 126 insertions(+), 82 deletions(-) diff --git a/docset/winserver2022-ps/deduplication/Start-DedupJob.md b/docset/winserver2022-ps/deduplication/Start-DedupJob.md index 82d4f4b3ff..8e3d594ab6 100644 --- a/docset/winserver2022-ps/deduplication/Start-DedupJob.md +++ b/docset/winserver2022-ps/deduplication/Start-DedupJob.md @@ -16,43 +16,52 @@ Starts a data deduplication job. ## SYNTAX ``` -Start-DedupJob [-Type] [[-Volume] ] [-StopWhenSystemBusy] [-Memory ] [-Cores ] - [-Priority ] [-InputOutputThrottle ] [-InputOutputThrottleLevel ] - [-Preempt] [-Wait] [-Full] [-ReadOnly] [-Timestamp ] [-CimSession ] - [-ThrottleLimit ] [-AsJob] [] +Start-DedupJob [-Type] [[-Volume] ] [-StopWhenSystemBusy] + [-Memory ] [-Cores ] [-Priority ] + [-InputOutputThrottle ] [-InputOutputThrottleLevel ] + [-Preempt] [-Wait] [-Full] [-ReadOnly] [-Timestamp ] + [-CimSession ] [-ThrottleLimit ] [-AsJob] [] ``` ## DESCRIPTION -The **Start-DedupJob** starts a new data deduplication job for one or more volumes. -The data deduplication job can queue if the server is running another job on the same volume or if the computer does not have sufficient resources to run the job. -The server marks the queued jobs that you start with this cmdlet as manual jobs and gives the manual jobs priority over scheduled jobs. + +The `Start-DedupJob` starts a new data deduplication job for one or more volumes. The data +deduplication job can queue if the server is running another job on the same volume or if the +computer does not have sufficient resources to run the job. The server marks the queued jobs that +you start with this cmdlet as manual jobs and gives the manual jobs priority over scheduled jobs. The server returns a **DeduplicationJob** object for each job that you start with this cmdlet. -For multi-volume data deduplication jobs, you can use the **Preempt** parameter to move a job to the top of the job queue and cancel the current job. +For multi-volume data deduplication jobs, you can use the **Preempt** parameter to move a job to the +top of the job queue and cancel the current job. ## EXAMPLES ### Example 1: Start an optimization job -``` -PS C:\> Start-DedupJob -Volume "D:" -Type Optimization -Memory 50 + +```powershell +Start-DedupJob -Volume "D:" -Type Optimization -Memory 50 ``` -This command starts a deduplication optimization job on drive D: and consume up to a maximum of 50 percent of RAM. +This command starts a deduplication optimization job on drive `D:` and consume up to a maximum of +`50` percent of RAM. ## PARAMETERS ### -AsJob -Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. -The cmdlet immediately returns an object that represents the job and then displays the command prompt. -You can continue to work in the session while the job completes. -To manage the job, use the `*-Job` cmdlets. -To get the job results, use the [Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. +Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to +complete. -For more information about Windows PowerShell background jobs, see [about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). +The cmdlet immediately returns an object that represents the job and then displays the command +prompt. You can continue to work in the session while the job completes. To manage the job, use the +`*-Job` cmdlets. To get the job results, use the +[Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. + +For more information about Windows PowerShell background jobs, see +[about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -64,12 +73,14 @@ Accept wildcard characters: False ``` ### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a [New-CimSession](/powershell/module/cimcmdlets/new-cimsession) or [Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet. -The default is the current session on the local computer. + +Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session +object, such as the output of a [New-CimSession](/powershell/module/cimcmdlets/new-cimsession) or +[Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet. The default is the +current session on the local computer. ```yaml -Type: CimSession[] +Type: Microsoft.Management.Infrastructure.CimSession[] Parameter Sets: (All) Aliases: Session @@ -81,10 +92,11 @@ Accept wildcard characters: False ``` ### -Cores + Specifies the maximum percentage of physical cores that a job uses. ```yaml -Type: UInt32 +Type: System.UInt32 Parameter Sets: (All) Aliases: MaximumCoresPercentage @@ -96,16 +108,21 @@ Accept wildcard characters: False ``` ### -Full -Indicates that garbage collection jobs free up all deleted or unreferenced data on the volume, if you specify the value GarbageCollection for the **Type** parameter. -If you do not specify this parameter, garbage collection jobs free up space after a system threshold of delete data is exceeded. -We recommend that you run garbage collection regularly without specifying this parameter, and then once a month specify this parameter and run garbage collection again. -If you specify the value Scrubbing for the **Type** parameter, this parameter indicates that scrubbing jobs validate the integrity of all data on the volume. -If you do not specify this parameter, the scrubbing job validates only critical metadata and data integrity issues that data deduplication previously encountered. -We recommend that you run scrubbing regularly without specifying this parameter, and then once a month specify this parameter and run scrubbing again. +Indicates that garbage collection jobs free up all deleted or unreferenced data on the volume, if +you specify the value `GarbageCollection` for the **Type** parameter. If you do not specify this +parameter, garbage collection jobs free up space after a system threshold of delete data is +exceeded. We recommend that you run garbage collection regularly without specifying this parameter, +and then once a month specify this parameter and run garbage collection again. + +If you specify the value `Scrubbing` for the **Type** parameter, this parameter indicates that +scrubbing jobs validate the integrity of all data on the volume. If you do not specify this +parameter, the scrubbing job validates only critical metadata and data integrity issues that data +deduplication previously encountered. We recommend that you run scrubbing regularly without +specifying this parameter, and then once a month specify this parameter and run scrubbing again. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -117,13 +134,14 @@ Accept wildcard characters: False ``` ### -InputOutputThrottle -Specifies the amount of input/output throttling applied to the deduplication job. -Throttling ensures that deduplication does not interfere with other I/O intensive processes. -The acceptable values for this parameter are: integers from 0 to 100. -If you specify this parameter and the **InputOutputThrottleLevel** parameter, **InputOutputThrottle** takes precedence. + +Specifies the amount of input/output throttling applied to the deduplication job. Throttling ensures +that deduplication does not interfere with other I/O intensive processes. The acceptable values for +this parameter are: integers from `0` to `100`. If you specify this parameter and the +**InputOutputThrottleLevel** parameter, **InputOutputThrottle** takes precedence. ```yaml -Type: UInt32 +Type: System.UInt32 Parameter Sets: (All) Aliases: @@ -135,15 +153,17 @@ Accept wildcard characters: False ``` ### -InputOutputThrottleLevel -Specifies the amount of I/O throttling that the job provides to ensure that the job does not interfere with other I/O intensive processes. -The acceptable values for this parameter are: -- None -- Low -- Medium -- High +Specifies the amount of I/O throttling that the job provides to ensure that the job does not +interfere with other I/O intensive processes. The acceptable values for this parameter are: + +- `None` +- `Low` +- `Medium` +- `High` -If you specify this parameter and the **InputOutputThrottle** parameter, **InputOutputThrottle** takes precedence. +If you specify this parameter and the **InputOutputThrottle** parameter, **InputOutputThrottle** +takes precedence. ```yaml Type: InputOutputThrottleLevel @@ -159,13 +179,17 @@ Accept wildcard characters: False ``` ### -Memory -Specifies the maximum percentage of physical computer memory that the data deduplication job can use. -For optimization jobs, we recommend that you set a range from 15 to 50, and a higher memory consumption for jobs that you schedule to run when you specify the **StopWhenSystemBusy** parameter. -For garbage collection and scrubbing jobs, which you typically schedule to run in off hours, you can set a higher memory consumption, such as 50. +Specifies the maximum percentage of physical computer memory that the data deduplication job can +use. + +For optimization jobs, we recommend that you set a range from `15` to `50`, and a higher memory +consumption for jobs that you schedule to run when you specify the **StopWhenSystemBusy** parameter. +For garbage collection and scrubbing jobs, which you typically schedule to run in off hours, you can +set a higher memory consumption, such as `50`. ```yaml -Type: UInt32 +Type: System.UInt32 Parameter Sets: (All) Aliases: MaximumMemoryPercentage @@ -177,14 +201,16 @@ Accept wildcard characters: False ``` ### -Preempt -Indicates that the deduplication engine moves the job to the top of the job queue and cancels the current job. -After the server cancels the current job, the deduplication engine cannot run the preempting job if the server does not have enough memory to run the job. -This parameter applies to manual data deduplication jobs only and is ignored for scheduled jobs. -You can preempt only deduplication jobs on multiple volumes. +Indicates that the deduplication engine moves the job to the top of the job queue and cancels the +current job. After the server cancels the current job, the deduplication engine cannot run the +preempting job if the server does not have enough memory to run the job. + +This parameter applies to manual data deduplication jobs only and is ignored for scheduled jobs. You +can preempt only deduplication jobs on multiple volumes. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -196,9 +222,11 @@ Accept wildcard characters: False ``` ### -Priority -Sets the CPU and I/O priority for the optimization job run that you run by using this cmdlet. -For jobs that you run when you specify the **StopWhenSystemBusy** parameter, we recommend that you set this parameter to Low. -For typical optimization jobs, we recommend that you set this parameter to Normal. + +Sets the CPU and I/O priority for the optimization job run that you run by using this cmdlet. For +jobs that you run when you specify the **StopWhenSystemBusy** parameter, we recommend that you set +this parameter to `Low`. For typical optimization jobs, we recommend that you set this parameter to +`Normal`. ```yaml Type: Priority @@ -214,10 +242,12 @@ Accept wildcard characters: False ``` ### -ReadOnly -Indicates that the scrubbing job process and report on corruptions that it finds but does not run any repair actions. + +Indicates that the scrubbing job process and report on corruptions that it finds but does not run +any repair actions. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -229,11 +259,12 @@ Accept wildcard characters: False ``` ### -StopWhenSystemBusy -Indicates that the server stops the job when the system is busy and retries later. -We recommend that you specify this parameter when you set a low priority for the job. + +Indicates that the server stops the job when the system is busy and retries later. We recommend that +you specify this parameter when you set a low priority for the job. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -245,12 +276,15 @@ Accept wildcard characters: False ``` ### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -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. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. + +Specifies the maximum number of concurrent operations that can be established to run the cmdlet. 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. The throttle limit applies only to the current cmdlet, not to the session or to the +computer. ```yaml -Type: Int32 +Type: System.Int32 Parameter Sets: (All) Aliases: @@ -262,12 +296,13 @@ Accept wildcard characters: False ``` ### -Timestamp -Specifies a date and time. -This parameter applies only to unoptimization jobs. -The deduplication engine unoptimizes only files that it optimized or reoptimized since the **DateTime** value that you specify. + +Specifies a date and time. This parameter applies only to unoptimization jobs. The deduplication +engine unoptimizes only files that it optimized or reoptimized since the **System.DateTime** value +that you specify. ```yaml -Type: DateTime +Type: System.DateTime Parameter Sets: (All) Aliases: @@ -279,12 +314,13 @@ Accept wildcard characters: False ``` ### -Type -Specifies the type of data deduplication job. -The acceptable values for this parameter are: -- Optimization -- GarbageCollection -- Scrubbing -- Unoptimization + +Specifies the type of data deduplication job. The acceptable values for this parameter are: + +- `Optimization` +- `GarbageCollection` +- `Scrubbing` +- `Unoptimization` ```yaml Type: Type @@ -300,11 +336,11 @@ Accept wildcard characters: False ``` ### -Volume + Specifies an array of system volumes for which you want to manually queue data deduplication jobs. -Enter one or more volume IDs, drive letters, or volume GUID paths. -For drive letters, use the format D:. -For volume GUID paths, use the format \\\\?\Volume{{GUID}}\. -Separate multiple volumes with a comma. +Enter one or more volume IDs, drive letters, or volume GUID paths. For drive letters, use the format +`D:`. For volume GUID paths, use the format `\\\\?\Volume{{GUID}}\`. Separate multiple volumes with +a comma. ```yaml Type: String[] @@ -319,10 +355,12 @@ Accept wildcard characters: False ``` ### -Wait -Indicates that the cmdlet waits for the job to complete and provides progress information to the client. + +Indicates that the cmdlet waits for the job to complete and provides progress information to the +client. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -334,7 +372,11 @@ Accept wildcard characters: False ``` ### CommonParameters -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). + +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). ## INPUTS @@ -351,8 +393,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### Microsoft.Management.Infrastructure.CimInstance -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. + +The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays +Windows Management Instrumentation (WMI) objects. The path after the pound sign (`#`) provides the +namespace and class name for the underlying WMI object. ## NOTES From 4f2499cb3e54f3552d0cabc88fb4a80a09206ab9 Mon Sep 17 00:00:00 2001 From: "Mikey Lombardi (He/Him)" Date: Wed, 3 May 2023 10:11:26 -0500 Subject: [PATCH 389/650] Apply suggestions from review --- docset/winserver2022-ps/deduplication/Start-DedupJob.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docset/winserver2022-ps/deduplication/Start-DedupJob.md b/docset/winserver2022-ps/deduplication/Start-DedupJob.md index 8e3d594ab6..a9526533ff 100644 --- a/docset/winserver2022-ps/deduplication/Start-DedupJob.md +++ b/docset/winserver2022-ps/deduplication/Start-DedupJob.md @@ -339,8 +339,8 @@ Accept wildcard characters: False Specifies an array of system volumes for which you want to manually queue data deduplication jobs. Enter one or more volume IDs, drive letters, or volume GUID paths. For drive letters, use the format -`D:`. For volume GUID paths, use the format `\\\\?\Volume{{GUID}}\`. Separate multiple volumes with -a comma. +`D:`. For volume GUID paths, use the format `\\?\Volume{{GUID}}\`. Separate multiple volumes with a +comma. ```yaml Type: String[] @@ -394,7 +394,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ### Microsoft.Management.Infrastructure.CimInstance -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays +The **Microsoft.Management.Infrastructure.CimInstance** object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. From c1076c264060fc2a9b9248b704feffa8300a0537 Mon Sep 17 00:00:00 2001 From: Robert Biddle Date: Tue, 2 May 2023 21:59:41 -0400 Subject: [PATCH 390/650] Spelling dictionary additions --- .vscode/cspell/winmodules/dictionaries/winps.txt | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.vscode/cspell/winmodules/dictionaries/winps.txt b/.vscode/cspell/winmodules/dictionaries/winps.txt index 12c6406141..2b45b6e023 100644 --- a/.vscode/cspell/winmodules/dictionaries/winps.txt +++ b/.vscode/cspell/winmodules/dictionaries/winps.txt @@ -11,3 +11,5 @@ Sysvol Unoptimization unoptimization unoptimizes +unoptimize +unoptimized From 5441bdd41a448bf382a0bed0693d4384535697de Mon Sep 17 00:00:00 2001 From: Robert Biddle Date: Tue, 2 May 2023 21:59:56 -0400 Subject: [PATCH 391/650] Style guide fixes --- .../deduplication/Set-DedupVolume.md | 291 +++++++++++------- 1 file changed, 176 insertions(+), 115 deletions(-) diff --git a/docset/winserver2022-ps/deduplication/Set-DedupVolume.md b/docset/winserver2022-ps/deduplication/Set-DedupVolume.md index d0b5c96acb..e3b5622bfa 100644 --- a/docset/winserver2022-ps/deduplication/Set-DedupVolume.md +++ b/docset/winserver2022-ps/deduplication/Set-DedupVolume.md @@ -16,81 +16,104 @@ Changes data deduplication settings on one or more volumes. ## SYNTAX ### ByVolumeId (Default) -```powershell -Set-DedupVolume [-VolumeId ] [-OptimizeInUseFiles] [-OptimizePartialFiles] [-NoCompress ] - [-Verify ] [-MinimumFileAgeDays ] [-MinimumFileSize ] - [-ChunkRedundancyThreshold ] [-ExcludeFolder ] [-ExcludeFileType ] - [-ExcludeFileTypeDefault ] [-NoCompressionFileType ] [-InputOutputScale ] - [-CimSession ] [-ThrottleLimit ] [-AsJob] [-PassThru] [] + +``` +Set-DedupVolume [-VolumeId ] [-OptimizeInUseFiles] [-OptimizePartialFiles] + [-NoCompress ] [-Verify ] [-MinimumFileAgeDays ] + [-MinimumFileSize ] [-ChunkRedundancyThreshold ] + [-ExcludeFolder ] [-ExcludeFileType ] + [-ExcludeFileTypeDefault ] [-NoCompressionFileType ] + [-InputOutputScale ] [-CimSession ] [-ThrottleLimit ] + [-AsJob] [-PassThru] [] ``` ### ByVolume -```powershell -Set-DedupVolume [-Volume] [-OptimizeInUseFiles] [-OptimizePartialFiles] [-NoCompress ] - [-Verify ] [-MinimumFileAgeDays ] [-MinimumFileSize ] - [-ChunkRedundancyThreshold ] [-ExcludeFolder ] [-ExcludeFileType ] - [-ExcludeFileTypeDefault ] [-NoCompressionFileType ] [-InputOutputScale ] - [-CimSession ] [-ThrottleLimit ] [-AsJob] [-PassThru] [] + +``` +Set-DedupVolume [-Volume] [-OptimizeInUseFiles] [-OptimizePartialFiles] + [-NoCompress ] [-Verify ] [-MinimumFileAgeDays ] + [-MinimumFileSize ] [-ChunkRedundancyThreshold ] + [-ExcludeFolder ] [-ExcludeFileType ] + [-ExcludeFileTypeDefault ] [-NoCompressionFileType ] + [-InputOutputScale ] [-CimSession ] [-ThrottleLimit ] + [-AsJob] [-PassThru] [] ``` ### InputObject (cdxml) -```powershell + +``` Set-DedupVolume -InputObject [-OptimizeInUseFiles] [-OptimizePartialFiles] - [-NoCompress ] [-Verify ] [-MinimumFileAgeDays ] [-MinimumFileSize ] - [-ChunkRedundancyThreshold ] [-ExcludeFolder ] [-ExcludeFileType ] - [-ExcludeFileTypeDefault ] [-NoCompressionFileType ] [-InputOutputScale ] - [-CimSession ] [-ThrottleLimit ] [-AsJob] [-PassThru] [] + [-NoCompress ] [-Verify ] [-MinimumFileAgeDays ] + [-MinimumFileSize ] [-ChunkRedundancyThreshold ] + [-ExcludeFolder ] [-ExcludeFileType ] + [-ExcludeFileTypeDefault ] [-NoCompressionFileType ] + [-InputOutputScale ] [-CimSession ] [-ThrottleLimit ] + [-AsJob] [-PassThru] [] ``` ## DESCRIPTION -The **Set-DedupVolume** cmdlet changes data deduplication settings on one or more volumes. + +The `Set-DedupVolume` cmdlet changes data deduplication settings on one or more volumes. ## EXAMPLES ### Example 1: Set the exclude folders on a volume + ```powershell -PS C:\> Set-DedupVolume -Volume "F:" -ExcludeFolder "F:\temp","F:\SQL" +Set-DedupVolume -Volume "F:" -ExcludeFolder "F:\temp","F:\SQL" ``` -This command sets the root folders under which all files are skipped during data deduplication. -The *ExcludeFolder* parameter specifies that the data deduplication engine processes the files in all of the folders on volume F: except for files in the Temp folder and the SQL folder. -If you exclude folders that contain previously optimized files, this command does not unoptimize those files. -You have to manually unoptimze any previously optimized files specified by *ExcludeFolder*. +This command sets the root folders under which all files are skipped during data deduplication. The +**ExcludeFolder** parameter specifies that the data deduplication engine processes the files in all +of the folders on volume `F:` except for files in the Temp folder and the SQL folder. If you exclude +folders that contain previously optimized files, this command does not unoptimize those files. You +have to manually unoptimize any previously optimized files specified by **ExcludeFolder**. -Note if the ExcludeFolder already contains optimized files, those optimized files are not automatically unoptimized by this command. -Any previously optimized files under the ExcludeFolder will need to be manually unoptimized. +Note if the ExcludeFolder already contains optimized files, those optimized files are not +automatically unoptimized by this command. Any previously optimized files under the ExcludeFolder +will need to be manually unoptimized. ### Example 2: Set the minimum file age on a volume + ```powershell -PS C:\> Set-DedupVolume -Volume "E:" -MinimumFileAgeDays 10 +Set-DedupVolume -Volume "E:" -MinimumFileAgeDays 10 ``` -This command sets the number of days since the file was created before the deduplication engine optimizes the file. -The *MinimumFileAgeDays* parameter specifies that the data deduplication engine processes the files in all of the folders on volume E: that were created at least 10 days ago. +This command sets the number of days since the file was created before the deduplication engine +optimizes the file. The **MinimumFileAgeDays** parameter specifies that the data deduplication +engine processes the files in all of the folders on volume `E:` that were created at least `10` days +ago. ### Example 3: Set the chunk redundancy threshold on a volume + ```powershell -PS C:\> Set-DedupVolume -Volume "D:" -MinimumFileAgeDays 15 -ChunkRedundancyThreshold 50 +Set-DedupVolume -Volume "D:" -MinimumFileAgeDays 15 -ChunkRedundancyThreshold 50 ``` -This command sets the number of identical chunks of data that the deduplication engine encounters during deduplication before the server creates a redundant copy of the data chunk. -The *MinimumFileAgeDays* parameter specifies that the data deduplication engine processes the files in all of the folders on volume D: that were created at least 15 days ago. -The *ChunkRedundancyThreshold* parameter specifies that if the data deduplication engine discovers 50 chunks of identical data, it makes one redundant copy as a safeguard. +This command sets the number of identical chunks of data that the deduplication engine encounters +during deduplication before the server creates a redundant copy of the data chunk. The +**MinimumFileAgeDays** parameter specifies that the data deduplication engine processes the files in +all of the folders on volume `D:` that were created at least `15` days ago. The +**ChunkRedundancyThreshold** parameter specifies that if the data deduplication engine discovers +`50` chunks of identical data, it makes one redundant copy as a safeguard. ## PARAMETERS ### -AsJob -Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. -The cmdlet immediately returns an object that represents the job and then displays the command prompt. -You can continue to work in the session while the job completes. -To manage the job, use the `*-Job` cmdlets. -To get the job results, use the [Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. +Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to +complete. + +The cmdlet immediately returns an object that represents the job and then displays the command +prompt. You can continue to work in the session while the job completes. To manage the job, use the +`*-Job` cmdlets. To get the job results, use the +[Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. -For more information about Windows PowerShell background jobs, see [about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). +For more information about Windows PowerShell background jobs, see +[about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -102,16 +125,19 @@ Accept wildcard characters: False ``` ### -ChunkRedundancyThreshold -Specifies the number of identical chunks of data that the deduplication engine encounters before the server creates a redundant copy of the data chunk. -This increases the reliability of the server by adding redundancy to the most referenced chunks of data. -Deduplication detects corruptions and the deduplication scrubbing job restores the corrupted chunks from a redundant copy, if it is available. -The default value is 100. -The minimum value that you can set is 20. -A low value for the *ChunkRedundancyThreshold* parameter reduces the effectiveness of data deduplication by creating more redundant copies of a chunk, and consumes more memory and disk space. +Specifies the number of identical chunks of data that the deduplication engine encounters before the +server creates a redundant copy of the data chunk. This increases the reliability of the server by +adding redundancy to the most referenced chunks of data. + +Deduplication detects corruptions and the deduplication scrubbing job restores the corrupted chunks +from a redundant copy, if it is available. The default value is `100`. The minimum value that you +can set is `20`. A low value for the **ChunkRedundancyThreshold** parameter reduces the +effectiveness of data deduplication by creating more redundant copies of a chunk, and consumes more +memory and disk space. ```yaml -Type: UInt32 +Type: System.UInt32 Parameter Sets: (All) Aliases: @@ -123,12 +149,14 @@ Accept wildcard characters: False ``` ### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a [New-CimSession](/powershell/module/cimcmdlets/new-cimsession) or [Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet. -The default is the current session on the local computer. + +Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session +object, such as the output of a [New-CimSession](/powershell/module/cimcmdlets/new-cimsession) or +[Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet. The default is the +current session on the local computer. ```yaml -Type: CimSession[] +Type: Microsoft.Management.Infrastructure.CimSession[] Parameter Sets: (All) Aliases: Session @@ -140,12 +168,13 @@ Accept wildcard characters: False ``` ### -ExcludeFileType -Specifies an array of extension types that the deduplication engine excludes from data deduplication and optimization. -Specify comma-separated values that are not preceded with a period (.). -When you change this setting, you override the existing values. + +Specifies an array of extension types that the deduplication engine excludes from data deduplication +and optimization. Specify comma-separated values that are not preceded with a period (`.`). When you +change this setting, you override the existing values. ```yaml -Type: String[] +Type: System.String[] Parameter Sets: (All) Aliases: @@ -157,13 +186,15 @@ Accept wildcard characters: False ``` ### -ExcludeFileTypeDefault + Specifies an array of extension types, as strings, that the server does not optimize. -The **Enable-DedupVolume** cmdlet modifies this behavior, depending on the value of the *UsageType* parameter. -If you use the current parameter to modify this behavior, and then run Enable-DedupVolume again, that cmdlet overrides your changes. +The `Enable-DedupVolume` cmdlet modifies this behavior, depending on the value of the **UsageType** +parameter. If you use the current parameter to modify this behavior, and then run +`Enable-DedupVolume` again, that cmdlet overrides your changes. ```yaml -Type: String[] +Type: System.String[] Parameter Sets: (All) Aliases: @@ -175,12 +206,13 @@ Accept wildcard characters: False ``` ### -ExcludeFolder -Specifies an array of names of root folders under which all files are skipped during data deduplication. -Full paths are accepted, however mount points are ignored since the mount point can change after configuration. -When you change this setting, you override the existing values. + +Specifies an array of names of root folders under which all files are skipped during data +deduplication. Full paths are accepted, however mount points are ignored since the mount point can +change after configuration. When you change this setting, you override the existing values. ```yaml -Type: String[] +Type: System.String[] Parameter Sets: (All) Aliases: @@ -192,11 +224,12 @@ Accept wildcard characters: False ``` ### -InputObject -Specifies the input to this cmdlet. -You can use this parameter, or you can pipe the input to this cmdlet. + +Specifies the input to this cmdlet. You can use this parameter, or you can pipe the input to this +cmdlet. ```yaml -Type: CimInstance[] +Type: Microsoft.Management.Infrastructure.CimInstance[] Parameter Sets: InputObject (cdxml) Aliases: @@ -208,12 +241,14 @@ Accept wildcard characters: False ``` ### -InputOutputScale -Specifies the level of input/output parallelization during optimization for this volume. -The acceptable values for this parameter are: integers from 0 to 36. -The default value of 0 sets the system to automatically select an **InputOutputScale** value based on the size of the volume to deduplicate. + +Specifies the level of input/output parallelization during optimization for this volume. The +acceptable values for this parameter are: integers from `0` to `36`. The default value of `0` sets +the system to automatically select an **InputOutputScale** value based on the size of the volume to +deduplicate. ```yaml -Type: UInt32 +Type: System.UInt32 Parameter Sets: (All) Aliases: @@ -225,12 +260,16 @@ Accept wildcard characters: False ``` ### -MinimumFileAgeDays -Number of days after the file is created before the file is considered to be in-policy for optimization. -The **Default** and **HyperV** usage types set this value to 3 to maximize performance on hot or recently created files. You may want to modify this if you want Data Deduplication to be more aggressive or if you do not care about the extra latency associated with deduplication. +Number of days after the file is created before the file is considered to be in-policy for +optimization. + +The `Default` and `HyperV` **UsageType** set this value to `3` to maximize performance on hot or +recently created files. You may want to modify this if you want Data Deduplication to be more +aggressive or if you do not care about the extra latency associated with deduplication. ```yaml -Type: UInt32 +Type: System.UInt32 Parameter Sets: (All) Aliases: MinimumFileAge @@ -242,11 +281,12 @@ Accept wildcard characters: False ``` ### -MinimumFileSize -Specifies the minimum size threshold, in bytes, for files that are optimized. -The deduplication engine does not optimize files that do not meet the minimum threshold. + +Specifies the minimum size threshold, in bytes, for files that are optimized. The deduplication +engine does not optimize files that do not meet the minimum threshold. ```yaml -Type: UInt32 +Type: System.UInt32 Parameter Sets: (All) Aliases: @@ -258,11 +298,12 @@ Accept wildcard characters: False ``` ### -NoCompress -Indicates whether or not the server compresses data after deduplication. -Compression uses more processor cycles but provides additional space savings. + +Indicates whether or not the server compresses data after deduplication. Compression uses more +processor cycles but provides additional space savings. ```yaml -Type: Boolean +Type: System.Boolean Parameter Sets: (All) Aliases: @@ -274,13 +315,14 @@ Accept wildcard characters: False ``` ### -NoCompressionFileType -Specifies an array of file types that the deduplication engine excludes from compression. -These file types are deduplicated but not compressed, typically because the file format is already compressed. -Specify comma-separated values that are not preceded with a period (.). -When you change this setting, you override the existing values. + +Specifies an array of file types that the deduplication engine excludes from compression. These file +types are deduplicated but not compressed, typically because the file format is already compressed. +Specify comma-separated values that are not preceded with a period (`.`). When you change this +setting, you override the existing values. ```yaml -Type: String[] +Type: System.String[] Parameter Sets: (All) Aliases: @@ -292,14 +334,16 @@ Accept wildcard characters: False ``` ### -OptimizeInUseFiles -Indicates that the server attempts to optimize currently open files. -After specifying this parameter, the server may wait up to 15 minutes before it attempts to optimize open files. -**Enable-DedupVolume** modifies this behavior, depending on the value of the *UsageType* parameter. -If you use the current parameter to modify this behavior, and then run **Enable-DedupVolume** again, that cmdlet overrides your changes. +Indicates that the server attempts to optimize currently open files. After specifying this +parameter, the server may wait up to 15 minutes before it attempts to optimize open files. + +`Enable-DedupVolume` modifies this behavior, depending on the value of the **UsageType** parameter. +If you use the current parameter to modify this behavior, and then run `Enable-DedupVolume` again, +that cmdlet overrides your changes. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -311,13 +355,16 @@ Accept wildcard characters: False ``` ### -OptimizePartialFiles -Indicates that the server optimizes all files, including portions of files that are old enough, according to the value of the *MinimumFileAgeDays* parameter. -**Enable-DedupVolume** modifies this behavior, depending on the value of the *UsageType* parameter. -If you use the current parameter to modify this behavior, and then run **Enable-DedupVolume** again, that cmdlet overrides your changes. +Indicates that the server optimizes all files, including portions of files that are old enough, +according to the value of the **MinimumFileAgeDays** parameter. + +`Enable-DedupVolume` modifies this behavior, depending on the value of the **UsageType** parameter. +If you use the current parameter to modify this behavior, and then run `Enable-DedupVolume` again, +that cmdlet overrides your changes. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -329,11 +376,12 @@ Accept wildcard characters: False ``` ### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. + +Returns an object representing the item with which you are working. By default, this cmdlet does not +generate any output. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -345,12 +393,15 @@ Accept wildcard characters: False ``` ### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -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. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. + +Specifies the maximum number of concurrent operations that can be established to run the cmdlet. 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. The throttle limit applies only to the current cmdlet, not to the session or to the +computer. ```yaml -Type: Int32 +Type: System.Int32 Parameter Sets: (All) Aliases: @@ -362,12 +413,14 @@ Accept wildcard characters: False ``` ### -Verify -Indicates whether the deduplication engine performs a byte-for-byte verification for each duplicate chunk that optimization creates, rather than relying on a cryptographically strong hash. -We do not recommend that you use this parameter. -Setting this parameter to $True can degrade optimization performance. + +Indicates whether the deduplication engine performs a byte-for-byte verification for each duplicate +chunk that optimization creates, rather than relying on a cryptographically strong hash. We do not +recommend that you use this parameter. Setting this parameter to $True can degrade optimization +performance. ```yaml -Type: Boolean +Type: System.Boolean Parameter Sets: (All) Aliases: @@ -379,14 +432,13 @@ Accept wildcard characters: False ``` ### -Volume -Specifies an array of system volumes. -Specify one or more volume IDs, drive letters, or volume GUID paths. -For drive letters, use the format D:. -For volume GUID paths, use the format \\\\?\Volume{{GUID}}\. -Separate multiple volumes with a comma. + +Specifies an array of system volumes. Specify one or more volume IDs, drive letters, or volume GUID +paths. For drive letters, use the format `D:`. For volume GUID paths, use the format +`\\\\?\Volume{{GUID}}\`. Separate multiple volumes with a comma. ```yaml -Type: String[] +Type: System.String[] Parameter Sets: ByVolume Aliases: @@ -398,10 +450,11 @@ Accept wildcard characters: False ``` ### -VolumeId -Specifies an array of volume IDs. + +Specifies an array of volume IDs. ```yaml -Type: String[] +Type: System.String[] Parameter Sets: ByVolumeId Aliases: DeviceId, Path, Id @@ -413,21 +466,29 @@ Accept wildcard characters: False ``` ### CommonParameters -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). + +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). ## INPUTS ### System.String[] ### Microsoft.Management.Infrastructure.CimInstance -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. + +The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays +Windows Management Instrumentation (WMI) objects. The path after the pound sign (`#`) provides the +namespace and class name for the underlying WMI object. ## OUTPUTS ### Microsoft.Management.Infrastructure.CimInstance -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. + +The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays +Windows Management Instrumentation (WMI) objects. The path after the pound sign (`#`) provides the +namespace and class name for the underlying WMI object. ### Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Deduplication/MSFT_DedupVolume From cc724935b382345fb250b1613af27fdf9506c28e Mon Sep 17 00:00:00 2001 From: "Mikey Lombardi (He/Him)" Date: Wed, 3 May 2023 10:40:39 -0500 Subject: [PATCH 392/650] Apply suggestions from review --- docset/winserver2022-ps/deduplication/Set-DedupVolume.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docset/winserver2022-ps/deduplication/Set-DedupVolume.md b/docset/winserver2022-ps/deduplication/Set-DedupVolume.md index e3b5622bfa..1a7ee2256d 100644 --- a/docset/winserver2022-ps/deduplication/Set-DedupVolume.md +++ b/docset/winserver2022-ps/deduplication/Set-DedupVolume.md @@ -435,7 +435,7 @@ Accept wildcard characters: False Specifies an array of system volumes. Specify one or more volume IDs, drive letters, or volume GUID paths. For drive letters, use the format `D:`. For volume GUID paths, use the format -`\\\\?\Volume{{GUID}}\`. Separate multiple volumes with a comma. +`\\?\Volume{{GUID}}\`. Separate multiple volumes with a comma. ```yaml Type: System.String[] @@ -478,7 +478,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ### Microsoft.Management.Infrastructure.CimInstance -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays +The **Microsoft.Management.Infrastructure.CimInstance** object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. @@ -486,7 +486,7 @@ namespace and class name for the underlying WMI object. ### Microsoft.Management.Infrastructure.CimInstance -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays +The **Microsoft.Management.Infrastructure.CimInstance** object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. From 47313edd327c5772fbdfd0fd3e9335b4ea608f0f Mon Sep 17 00:00:00 2001 From: Robert Biddle Date: Tue, 2 May 2023 21:42:31 -0400 Subject: [PATCH 393/650] Style guide fixes --- .../deduplication/Set-DedupSchedule.md | 297 +++++++++++------- 1 file changed, 188 insertions(+), 109 deletions(-) diff --git a/docset/winserver2022-ps/deduplication/Set-DedupSchedule.md b/docset/winserver2022-ps/deduplication/Set-DedupSchedule.md index 2d59f0d640..fbf1a5071a 100644 --- a/docset/winserver2022-ps/deduplication/Set-DedupSchedule.md +++ b/docset/winserver2022-ps/deduplication/Set-DedupSchedule.md @@ -16,70 +16,111 @@ Changes configuration settings for data deduplication schedules. ## SYNTAX ### Query (cdxml) (Default) + ``` -Set-DedupSchedule [-Name] [-Type ] [-DurationHours ] [-Enabled ] - [-StopWhenSystemBusy ] [-Memory ] [-Cores ] [-Priority ] - [-InputOutputThrottle ] [-InputOutputThrottleLevel ] [-Start ] - [-Days ] [-Full ] [-ReadOnly ] [-CimSession ] - [-ThrottleLimit ] [-AsJob] [-PassThru] [] +Set-DedupSchedule [-Name] [-Type ] [-DurationHours ] + [-Enabled ] [-StopWhenSystemBusy ] [-Memory ] [-Cores ] + [-Priority ] [-InputOutputThrottle ] + [-InputOutputThrottleLevel ] [-Start ] + [-Days ] [-Full ] [-ReadOnly ] + [-CimSession ] [-ThrottleLimit ] [-AsJob] [-PassThru] + [] ``` ### InputObject (cdxml) + ``` -Set-DedupSchedule -InputObject [-DurationHours ] [-Enabled ] - [-StopWhenSystemBusy ] [-Memory ] [-Cores ] [-Priority ] - [-InputOutputThrottle ] [-InputOutputThrottleLevel ] [-Start ] - [-Days ] [-Full ] [-ReadOnly ] [-CimSession ] - [-ThrottleLimit ] [-AsJob] [-PassThru] [] +Set-DedupSchedule -InputObject [-DurationHours ] + [-Enabled ] [-StopWhenSystemBusy ] [-Memory ] [-Cores ] + [-Priority ] [-InputOutputThrottle ] + [-InputOutputThrottleLevel ] [-Start ] + [-Days ] [-Full ] [-ReadOnly ] + [-CimSession ] [-ThrottleLimit ] [-AsJob] [-PassThru] + [] ``` ## DESCRIPTION -The **Set-DedupSchedule** cmdlet changes configuration settings for one or more data deduplication schedules. + +The `Set-DedupSchedule` cmdlet changes configuration settings for one or more data deduplication +schedules. ## EXAMPLES ### Example 1: Change settings of a data deduplication schedule for a garbage collection job -``` -PS C:\> Set-DedupSchedule -Name "OffHoursGC" -Type GarbageCollection -Start 08:00 -DurationHours 5 -Days Sunday -Priority Normal + +```powershell +$params = @{ + Days = Sunday + DurationHours = 5 + Name = "OffHoursGC" + Priority = Normal + Start = 08:00 + Type = GarbageCollection +} +Set-DedupSchedule @params ``` -This command changes the settings of a data deduplication schedule for a garbage collection job named OffHoursGC. -The job is scheduled to run on Sundays at 8:00 at normal priority. -The command specifies that the server cancels the job after 5 hours if the process has not ended. +This command changes the settings of a data deduplication schedule for a garbage collection job +named `OffHoursGC`. The job is scheduled to run every `Sunday` at `08:00` with `Normal` +**Priority**. The command specifies that the server cancels the job after `5` hours if the process +has not ended. ### Example 2: Change settings of a data deduplication schedule for a scrubbing job -``` -PS C:\> Set-DedupSchedule -Name "OffHoursScrub" -Type Scrubbing -Start 23:00 -StopWhenSystemBusy -DurationHours 6 -Days Monday,Tuesday,Wednesday,Thursday,Friday -Priority Normal + +```powershell +$params = @{ + Days = Monday,Tuesday,Wednesday,Thursday,Friday + DurationHours = 6 + Name = "OffHoursScrub" + Priority = Normal + Start = 23:00 + StopWhenSystemBusy = $true + Type = Scrubbing +} +Set-DedupSchedule @params ``` -This command changes the settings of a data deduplication schedule for a scrubbing job named OffHoursScrub. -The command starts the scrubbing job at 23:00 on Monday through Friday at normal priority. -The **StopWhenSystemBusy** parameter specifies that the server stops the job when the system is busy and retries later. -The **DurationHours** parameter specifies that the server cancels the job after 6 hours if the process has not ended. +This command changes the settings of a data deduplication schedule for a `Scrubbing` **Type** job +with a **Name** of `OffHoursScrub`. The command starts the scrubbing job at `23:00` every day Monday +through Friday at normal priority. The **StopWhenSystemBusy** parameter specifies that the server +stops the job when the system is busy and retries later. The **DurationHours** parameter specifies +that the server cancels the job after `6` hours if the process has not ended. ### Example 3: Change settings of a data deduplication schedule for an optimization job -``` -PS C:\> Set-DedupSchedule -Name "MyWeekendOptimization" -Type Optimization -Days Monday,Tuesday,Wednesday,Thursday,Friday -Start 08:00 -DurationHours 9 + +```powershell +$params = @{ + Days = Monday,Tuesday,Wednesday,Thursday,Friday + DurationHours = 9 + Name = "MyWeekendOptimization" + Start = 08:00 + Type = Optimization +} +Set-DedupSchedule @params ``` -This command changes the settings of a data deduplication schedule for an optimization job named MyWeekdayOptimization. -The optimization job runs at a normal priority every weekday evening at 8:00. -**DurationHours** specifies that the server cancels the job after 9 hours if the process has not ended. +This command changes the settings of a data deduplication schedule for an optimization job named +`MyWeekdayOptimization`. The optimization job runs at a `Normal` **Priority** every weekday evening +at `08:00`. **DurationHours** specifies that the server cancels the job after `9` hours if the +process has not ended. ## PARAMETERS ### -AsJob -Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. -The cmdlet immediately returns an object that represents the job and then displays the command prompt. -You can continue to work in the session while the job completes. -To manage the job, use the `*-Job` cmdlets. -To get the job results, use the [Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. +Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to +complete. + +The cmdlet immediately returns an object that represents the job and then displays the command +prompt. You can continue to work in the session while the job completes. To manage the job, use the +`*-Job` cmdlets. To get the job results, use the +[Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. -For more information about Windows PowerShell background jobs, see [about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). +For more information about Windows PowerShell background jobs, see +[about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -91,12 +132,14 @@ Accept wildcard characters: False ``` ### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a [New-CimSession](/powershell/module/cimcmdlets/new-cimsession) or [Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet. -The default is the current session on the local computer. + +Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session +object, such as the output of a [New-CimSession](/powershell/module/cimcmdlets/new-cimsession) or +[Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet. The default is the +current session on the local computer. ```yaml -Type: CimSession[] +Type: Microsoft.Management.Infrastructure.CimSession[] Parameter Sets: (All) Aliases: Session @@ -108,10 +151,11 @@ Accept wildcard characters: False ``` ### -Cores + Specifies the maximum percentage of physical cores that a job uses. ```yaml -Type: UInt32 +Type: System.UInt32 Parameter Sets: (All) Aliases: MaximumCoresPercentage @@ -123,19 +167,20 @@ Accept wildcard characters: False ``` ### -Days -Specifies an array of days of the week on which the server runs the data deduplication job. -The acceptable values for this parameter are: -- Monday -- Tuesday -- Wednesday -- Thursday -- Friday -- Saturday -- Sunday +Specifies an array of days of the week on which the server runs the data deduplication job. The +acceptable values for this parameter are: + +- `Monday` +- `Tuesday` +- `Wednesday` +- `Thursday` +- `Friday` +- `Saturday` +- `Sunday` ```yaml -Type: DayOfWeek[] +Type: System.DayOfWeek[] Parameter Sets: (All) Aliases: Accepted values: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday @@ -148,12 +193,13 @@ Accept wildcard characters: False ``` ### -DurationHours -Specifies the number of hours that the server runs the task before canceling it. -The value 0 indicates that the server runs the job to completion. -This cmdlet safely stops a data deduplication job and does not affect the files that the server is processing when it cancels the job. + +Specifies the number of hours that the server runs the task before canceling it. The value 0 +indicates that the server runs the job to completion. This cmdlet safely stops a data deduplication +job and does not affect the files that the server is processing when it cancels the job. ```yaml -Type: UInt32 +Type: System.UInt32 Parameter Sets: (All) Aliases: @@ -165,10 +211,11 @@ Accept wildcard characters: False ``` ### -Enabled + Indicates whether a data deduplication schedule is enabled. ```yaml -Type: Boolean +Type: System.Boolean Parameter Sets: (All) Aliases: @@ -180,16 +227,21 @@ Accept wildcard characters: False ``` ### -Full -Indicates that garbage collection jobs free up all deleted or unreferenced data on the volume, if you specify the value GarbageCollection for the **Type** parameter. -If you do not specify this parameter, garbage collection jobs free up space after a system threshold of delete data is exceeded. -We recommend that you run garbage collection regularly without specifying this parameter, and then once a month specify this parameter and run garbage collection again. -If you specify the value Scrubbing for the **Type** parameter, this parameter indicates that scrubbing jobs validate the integrity of all data on the volume. -If you do not specify this parameter, the scrubbing job validates only critical metadata and data integrity issues that data deduplication previously encountered. -We recommend that you run scrubbing regularly without specifying this parameter, and then once a month specify this parameter and run scrubbing again. +Indicates that garbage collection jobs free up all deleted or unreferenced data on the volume, if +you specify the value `GarbageCollection` for the **Type** parameter. If you do not specify this +parameter, garbage collection jobs free up space after a system threshold of delete data is +exceeded. We recommend that you run garbage collection regularly without specifying this parameter, +and then once a month specify this parameter and run garbage collection again. + +If you specify the value `Scrubbing` for the **Type** parameter, this parameter indicates that +scrubbing jobs validate the integrity of all data on the volume. If you do not specify this +parameter, the scrubbing job validates only critical metadata and data integrity issues that data +deduplication previously encountered. We recommend that you run scrubbing regularly without +specifying this parameter, and then once a month specify this parameter and run scrubbing again. ```yaml -Type: Boolean +Type: System.Boolean Parameter Sets: (All) Aliases: @@ -201,11 +253,12 @@ Accept wildcard characters: False ``` ### -InputObject -Specifies the input to this cmdlet. -You can use this parameter, or you can pipe the input to this cmdlet. + +Specifies the input to this cmdlet. You can use this parameter, or you can pipe the input to this +cmdlet. ```yaml -Type: CimInstance[] +Type: Microsoft.Management.Infrastructure.CimInstance[] Parameter Sets: InputObject (cdxml) Aliases: @@ -217,13 +270,14 @@ Accept wildcard characters: False ``` ### -InputOutputThrottle -Specifies the amount of input/output throttling applied to the deduplication job. -Throttling ensures that deduplication does not interfere with other I/O intensive processes. -The acceptable values for this parameter are: integers from 0 to 100. -If you specify this parameter and the **InputOutputThrottleLevel** parameter, **InputOutputThrottle** takes precedence. + +Specifies the amount of input/output throttling applied to the deduplication job. Throttling ensures +that deduplication does not interfere with other I/O intensive processes. The acceptable values for +this parameter are: integers from `0` to `100`. If you specify this parameter and the +**InputOutputThrottleLevel** parameter, **InputOutputThrottle** takes precedence. ```yaml -Type: UInt32 +Type: System.UInt32 Parameter Sets: (All) Aliases: @@ -235,13 +289,14 @@ Accept wildcard characters: False ``` ### -InputOutputThrottleLevel -Specifies the amount of I/O throttling that the job provides to ensure that the job does not interfere with other I/O intensive processes. -The acceptable values for this parameter are: -- None -- Low -- Medium -- High +Specifies the amount of I/O throttling that the job provides to ensure that the job does not +interfere with other I/O intensive processes. The acceptable values for this parameter are: + +- `None` +- `Low` +- `Medium` +- `High` ```yaml Type: InputOutputThrottleLevel @@ -257,13 +312,17 @@ Accept wildcard characters: False ``` ### -Memory -Specifies the maximum percentage of physical computer memory that the data deduplication job can use. -For optimization jobs, we recommend that you set a range from 15 to 50, and a higher memory consumption for jobs that you schedule to run when you specify the **StopWhenSystemBusy** parameter. -For garbage collection and scrubbing jobs, which you typically schedule to run in off hours, you can set higher memory consumption, such as 50. +Specifies the maximum percentage of physical computer memory that the data deduplication job can +use. + +For optimization jobs, we recommend that you set a range from `15` to `50`, and a higher memory +consumption for jobs that you schedule to run when you specify the **StopWhenSystemBusy** parameter. +For garbage collection and scrubbing jobs, which you typically schedule to run in off hours, you can +set higher memory consumption, such as `50`. ```yaml -Type: UInt32 +Type: System.UInt32 Parameter Sets: (All) Aliases: MaximumMemoryPercentage @@ -275,10 +334,11 @@ Accept wildcard characters: False ``` ### -Name + Specifies the name of a data deduplication job schedule. ```yaml -Type: String[] +Type: System.String[] Parameter Sets: Query (cdxml) Aliases: @@ -290,11 +350,12 @@ Accept wildcard characters: False ``` ### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. + +Returns an object representing the item with which you are working. By default, this cmdlet does not +generate any output. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -306,9 +367,11 @@ Accept wildcard characters: False ``` ### -Priority -Sets the CPU and I/O priority for the optimization job that you run by using this cmdlet. -For jobs that you run when you specify the **StopWhenSystemBusy** parameter, we recommend that you set this parameter to Low. -For typical optimization jobs, we recommend that you set this parameter to Normal. + +Sets the CPU and I/O priority for the optimization job that you run by using this cmdlet. For jobs +that you run when you specify the **StopWhenSystemBusy** parameter, we recommend that you set this +parameter to `Low`. For typical optimization jobs, we recommend that you set this parameter to +`Normal`. ```yaml Type: Priority @@ -324,10 +387,12 @@ Accept wildcard characters: False ``` ### -ReadOnly -Indicates whether the scrubbing job processes and reports on corruptions that it finds but does not run any repair actions. + +Indicates whether the scrubbing job processes and reports on corruptions that it finds but does not +run any repair actions. ```yaml -Type: Boolean +Type: System.Boolean Parameter Sets: (All) Aliases: @@ -339,13 +404,14 @@ Accept wildcard characters: False ``` ### -Start -Specifies a time to start this job. -The default value is 1:45am. -Type the date in a format that is standard for the system locale, such as dd-MM-yyyy (German \[Germany\]) or MM/dd/yyyy (English \[United States\]). +Specifies a time to start this job. The default value is 1:45am. + +Type the date in a format that is standard for the system locale, such as dd-MM-yyyy (German +\[Germany\]) or MM/dd/yyyy (English \[United States\]). ```yaml -Type: DateTime +Type: System.DateTime Parameter Sets: (All) Aliases: @@ -357,11 +423,12 @@ Accept wildcard characters: False ``` ### -StopWhenSystemBusy -Indicates whether the server stops the job when the system is busy and retries later. -We recommend that you specify this parameter when you set a low priority for the job. + +Indicates whether the server stops the job when the system is busy and retries later. We recommend +that you specify this parameter when you set a low priority for the job. ```yaml -Type: Boolean +Type: System.Boolean Parameter Sets: (All) Aliases: @@ -373,9 +440,12 @@ Accept wildcard characters: False ``` ### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -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. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. + +Specifies the maximum number of concurrent operations that can be established to run the cmdlet. 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. The throttle limit applies only to the current cmdlet, not to the session or to the +computer. ```yaml Type: Int32 @@ -390,13 +460,14 @@ Accept wildcard characters: False ``` ### -Type -Specifies an array of types of data deduplication jobs. -The acceptable values for this parameter are: -- Optimization -- GarbageCollection -- Scrubbing -- Unoptimization +Specifies an array of types of data deduplication jobs. The acceptable values for this parameter +are: + +- `Optimization` +- `GarbageCollection` +- `Scrubbing` +- `Unoptimization` ```yaml Type: Type[] @@ -412,7 +483,11 @@ Accept wildcard characters: False ``` ### CommonParameters -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). + +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). ## INPUTS @@ -425,12 +500,16 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### Microsoft.Management.Infrastructure.CimInstance -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. + +The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays +Windows Management Instrumentation (WMI) objects. The path after the pound sign (`#`) provides the +namespace and class name for the underlying WMI object. ### Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Deduplication/MSFT_DedupJobSchedule -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. + +The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays +Windows Management Instrumentation (WMI) objects. The path after the pound sign (`#`) provides the +namespace and class name for the underlying WMI object. ## NOTES From affd9111db51aa28ee63bb74f64ca556ec854d5d Mon Sep 17 00:00:00 2001 From: Robert Biddle Date: Tue, 2 May 2023 22:30:49 -0400 Subject: [PATCH 394/650] Spelling dictionary additions --- .vscode/cspell/winmodules/dictionaries/winps.txt | 1 + 1 file changed, 1 insertion(+) diff --git a/.vscode/cspell/winmodules/dictionaries/winps.txt b/.vscode/cspell/winmodules/dictionaries/winps.txt index 2b45b6e023..361551b269 100644 --- a/.vscode/cspell/winmodules/dictionaries/winps.txt +++ b/.vscode/cspell/winmodules/dictionaries/winps.txt @@ -6,6 +6,7 @@ DSRM krbtgt NTDS reoptimized +rescan RODC Sysvol Unoptimization From 0dfd8887ad09e1df85747b6b31bca00597e04634 Mon Sep 17 00:00:00 2001 From: Robert Biddle Date: Tue, 2 May 2023 22:31:14 -0400 Subject: [PATCH 395/650] Style guide fixes --- .../deduplication/Update-DedupStatus.md | 152 ++++++++++-------- 1 file changed, 86 insertions(+), 66 deletions(-) diff --git a/docset/winserver2022-ps/deduplication/Update-DedupStatus.md b/docset/winserver2022-ps/deduplication/Update-DedupStatus.md index eb197898da..085c9ca5eb 100644 --- a/docset/winserver2022-ps/deduplication/Update-DedupStatus.md +++ b/docset/winserver2022-ps/deduplication/Update-DedupStatus.md @@ -16,77 +16,86 @@ Scans volumes for fresh data deduplication savings. ## SYNTAX ``` -Update-DedupStatus [[-Volume] ] [-CimSession ] [-ThrottleLimit ] [-AsJob] - [] +Update-DedupStatus [[-Volume] ] [-CimSession ] + [-ThrottleLimit ] [-AsJob] [] ``` ## DESCRIPTION -The **Update-DedupStatus** cmdlet scans one or more specified volumes to compute fresh data deduplication savings information. -This cmdlet returns a **DeduplicationStatus** object. -For quick access to cached metadata use **Get-DedupStatus**. -When this cmdlet is run on multiple volumes with one cmdlet call, the analysis for each volume is done serially. -Note: On large volumes this cmdlet can run for several minutes and will always perform a rescan after the initial scan. -The default behavior is to wait for completion, regardless of the length of time required to run the scan and rescan. +The `Update-DedupStatus` cmdlet scans one or more specified volumes to compute fresh data +deduplication savings information. This cmdlet returns a **DeduplicationStatus** object. For quick +access to cached metadata use `Get-DedupStatus`. When this cmdlet is run on multiple volumes with +one cmdlet call, the analysis for each volume is done serially. + +Note: On large volumes this cmdlet can run for several minutes and will always perform a rescan +after the initial scan. The default behavior is to wait for completion, regardless of the length of +time required to run the scan and rescan. To run this cmdlet, you must start Windows PowerShell® with the **Run as administrator** option. -This cmdlet returns the following metadata: - -- DedupSavedSpace. -Saved space is the difference between the logical size of the optimized files and the logical size of the store. -This is the deduplicated user data plus data deduplication metadata. -This number changes continually. -- DedupRate. -Data deduplication rate is the ratio of data deduplication saved space to the logical size of all of the files on the volume and is expressed in percentage. -This number will change continually. -- OptimizedFilesCount. -Optimized files count is the number of optimized files on the specified volume. -This number remains steady, instead of decreasing, as users delete files from, or add files to, the volume, until a garbage collection job is run. -This count is most accurate after a garbage collection job runs. -- OptimizedFilesSize. -Optimized files size is the aggregate size of all optimized files on the specified volume. -This number remains steady, instead of decreasing, as users delete files from, or add new files to, the volume, until a garbage collection job is run. -This number is most accurate after a garbage collection job runs. -- InPolicyFilesCount. -In policy files count is the number of files that currently qualify for optimization. -This number stays relatively constant between optimization jobs. -- InPolicyFilesSize. -In policy files size is the aggregate size of all files that currently qualify for optimization. -This number stays relatively constant between optimization jobs. -- LastOptimizationTime. -Last optimization time specifies the data and time when an optimization job was run last on the specified volume. -This date and time stays constant between optimization jobs. -- LastGarbageCollectionTime. -Last garbage collection time specifies the data and time when a garbage collection job was run last on the specified volume. -This date and time stays constant between optimization jobs. -- LastScrubbingTime. -Last scrubbing time specifies the data and time when a scrubbing job was run last on the specified volume. -This date and time stays constant between optimization jobs. +This cmdlet returns the following metadata: + +- `DedupSavedSpace` + - Saved space is the difference between the logical size of the optimized files + and the logical size of the store. This is the deduplicated user data plus data deduplication + metadata. This number changes continually. +- `DedupRate` + - Data deduplication rate is the ratio of data deduplication saved space to the logical + size of all of the files on the volume and is expressed in percentage. This number will change + continually. +- `OptimizedFilesCount` + - Optimized files count is the number of optimized files on the specified volume. This number + remains steady, instead of decreasing, as users delete files from, or add files to, the volume, + until a garbage collection job is run. This count is most accurate after a garbage collection + job runs. +- `OptimizedFilesSize` + - Optimized files size is the aggregate size of all optimized files on the specified volume. This + number remains steady, instead of decreasing, as users delete files from, or add new files to, + the volume, until a garbage collection job is run. This number is most accurate after a garbage + collection job runs. +- `InPolicyFilesCount` + - In policy files count is the number of files that currently qualify for optimization. This + number stays relatively constant between optimization jobs. +- `InPolicyFilesSize` + - In policy files size is the aggregate size of all files that currently qualify for optimization. + This number stays relatively constant between optimization jobs. +- `LastOptimizationTime` + - Last optimization time specifies the data and time when an optimization job was run last on the + specified volume. This date and time stays constant between optimization jobs. +- `LastGarbageCollectionTime` + - Last garbage collection time specifies the data and time when a garbage collection job was run + last on the specified volume. This date and time stays constant between optimization jobs. +- `LastScrubbingTime` + - Last scrubbing time specifies the data and time when a scrubbing job was run last on the + specified volume. This date and time stays constant between optimization jobs. ## EXAMPLES ### Example 1: Scan a volume for savings information -``` -PS C:\> Update-DedupStatus -Volume "D:" + +```powershell +Update-DedupStatus -Volume "D:" ``` -This command scans the D: volume to compute data deduplication savings. +This command scans the `D:` volume to compute data deduplication savings. ## PARAMETERS ### -AsJob -Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. -The cmdlet immediately returns an object that represents the job and then displays the command prompt. -You can continue to work in the session while the job completes. -To manage the job, use the `*-Job` cmdlets. -To get the job results, use the [Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. +Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to +complete. -For more information about Windows PowerShell background jobs, see [about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). +The cmdlet immediately returns an object that represents the job and then displays the command +prompt. You can continue to work in the session while the job completes. To manage the job, use the +`*-Job` cmdlets. To get the job results, use the +[Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. + +For more information about Windows PowerShell background jobs, see +[about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -98,12 +107,14 @@ Accept wildcard characters: False ``` ### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a [New-CimSession](/powershell/module/cimcmdlets/new-cimsession) or [Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet. -The default is the current session on the local computer. + +Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session +object, such as the output of a [New-CimSession](/powershell/module/cimcmdlets/new-cimsession) or +[Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet. The default is the +current session on the local computer. ```yaml -Type: CimSession[] +Type: Microsoft.Management.Infrastructure.CimSession[] Parameter Sets: (All) Aliases: Session @@ -115,12 +126,15 @@ Accept wildcard characters: False ``` ### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -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. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. + +Specifies the maximum number of concurrent operations that can be established to run the cmdlet. 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. The throttle limit applies only to the current cmdlet, not to the session or to the +computer. ```yaml -Type: Int32 +Type: System.Int32 Parameter Sets: (All) Aliases: @@ -132,14 +146,14 @@ Accept wildcard characters: False ``` ### -Volume -Specifies one or more file system volumes for which to scan and compute fresh data deduplication savings information. -Enter one or more volume IDs, drive letters, or volume GUID paths. -For drive letters, use the format D:. -For volume GUID paths, use the format \\\\?\Volume{{GUID}}\. + +Specifies one or more file system volumes for which to scan and compute fresh data deduplication +savings information. Enter one or more volume IDs, drive letters, or volume GUID paths. For drive +letters, use the format `D:`. For volume GUID paths, use the format `\\\\?\Volume{{GUID}}\`. Separate multiple volumes with a comma. ```yaml -Type: String[] +Type: System.String[] Parameter Sets: (All) Aliases: Path, Name, DeviceId @@ -151,7 +165,11 @@ Accept wildcard characters: False ``` ### CommonParameters -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). + +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). ## INPUTS @@ -160,8 +178,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### Microsoft.Management.Infrastructure.CimInstance -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. + +The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays +Windows Management Instrumentation (WMI) objects. The path after the pound sign (`#`) provides the +namespace and class name for the underlying WMI object. ## NOTES From a2f2463d7e57e872fa3aebf1da5b015bd02a74b8 Mon Sep 17 00:00:00 2001 From: "Mikey Lombardi (He/Him)" Date: Wed, 3 May 2023 11:20:31 -0500 Subject: [PATCH 396/650] Apply suggestions from review --- .../deduplication/Set-DedupSchedule.md | 36 +++++++++++-------- 1 file changed, 21 insertions(+), 15 deletions(-) diff --git a/docset/winserver2022-ps/deduplication/Set-DedupSchedule.md b/docset/winserver2022-ps/deduplication/Set-DedupSchedule.md index fbf1a5071a..3e1c5e7d80 100644 --- a/docset/winserver2022-ps/deduplication/Set-DedupSchedule.md +++ b/docset/winserver2022-ps/deduplication/Set-DedupSchedule.md @@ -50,12 +50,12 @@ schedules. ```powershell $params = @{ - Days = Sunday + Days = 'Sunday' DurationHours = 5 - Name = "OffHoursGC" - Priority = Normal - Start = 08:00 - Type = GarbageCollection + Name = 'OffHoursGC' + Priority = 'Normal' + Start = '08:00' + Type = 'GarbageCollection' } Set-DedupSchedule @params ``` @@ -90,11 +90,17 @@ that the server cancels the job after `6` hours if the process has not ended. ```powershell $params = @{ - Days = Monday,Tuesday,Wednesday,Thursday,Friday + Days = @( + 'Monday' + 'Tuesday' + 'Wednesday' + 'Thursday' + 'Friday' + ) DurationHours = 9 - Name = "MyWeekendOptimization" - Start = 08:00 - Type = Optimization + Name = 'MyWeekendOptimization' + Start = '08:00' + Type = 'Optimization' } Set-DedupSchedule @params ``` @@ -194,7 +200,7 @@ Accept wildcard characters: False ### -DurationHours -Specifies the number of hours that the server runs the task before canceling it. The value 0 +Specifies the number of hours that the server runs the task before canceling it. The value `0` indicates that the server runs the job to completion. This cmdlet safely stops a data deduplication job and does not affect the files that the server is processing when it cancels the job. @@ -405,10 +411,10 @@ Accept wildcard characters: False ### -Start -Specifies a time to start this job. The default value is 1:45am. +Specifies a time to start this job. The default value is `1:45am`. -Type the date in a format that is standard for the system locale, such as dd-MM-yyyy (German -\[Germany\]) or MM/dd/yyyy (English \[United States\]). +Type the date in a format that is standard for the system locale, such as `dd-MM-yyyy` (German +\[Germany\]) or `MM/dd/yyyy` (English \[United States\]). ```yaml Type: System.DateTime @@ -501,13 +507,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ### Microsoft.Management.Infrastructure.CimInstance -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays +The **Microsoft.Management.Infrastructure.CimInstance** object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. ### Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Deduplication/MSFT_DedupJobSchedule -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays +The **Microsoft.Management.Infrastructure.CimInstance** object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. From 2b4d35eb2fafc04c9a320203bc5e54e01e1ca685 Mon Sep 17 00:00:00 2001 From: "Mikey Lombardi (He/Him)" Date: Wed, 3 May 2023 11:23:40 -0500 Subject: [PATCH 397/650] Apply suggestions from review --- .../deduplication/Update-DedupStatus.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/docset/winserver2022-ps/deduplication/Update-DedupStatus.md b/docset/winserver2022-ps/deduplication/Update-DedupStatus.md index 085c9ca5eb..a380c6d59a 100644 --- a/docset/winserver2022-ps/deduplication/Update-DedupStatus.md +++ b/docset/winserver2022-ps/deduplication/Update-DedupStatus.md @@ -27,9 +27,10 @@ deduplication savings information. This cmdlet returns a **DeduplicationStatus** access to cached metadata use `Get-DedupStatus`. When this cmdlet is run on multiple volumes with one cmdlet call, the analysis for each volume is done serially. -Note: On large volumes this cmdlet can run for several minutes and will always perform a rescan -after the initial scan. The default behavior is to wait for completion, regardless of the length of -time required to run the scan and rescan. +> [!NOTE] +> On large volumes this cmdlet can run for several minutes and will always perform a rescan after +> the initial scan. The default behavior is to wait for completion, regardless of the length of +> time required to run the scan and rescan. To run this cmdlet, you must start Windows PowerShell® with the **Run as administrator** option. @@ -149,7 +150,7 @@ Accept wildcard characters: False Specifies one or more file system volumes for which to scan and compute fresh data deduplication savings information. Enter one or more volume IDs, drive letters, or volume GUID paths. For drive -letters, use the format `D:`. For volume GUID paths, use the format `\\\\?\Volume{{GUID}}\`. +letters, use the format `D:`. For volume GUID paths, use the format `\\?\Volume{{GUID}}\`. Separate multiple volumes with a comma. ```yaml @@ -179,7 +180,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ### Microsoft.Management.Infrastructure.CimInstance -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays +The **Microsoft.Management.Infrastructure.CimInstance** object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. From 460e9a344477f70a54b18fc8ecc1856c004ca8ba Mon Sep 17 00:00:00 2001 From: Robert Biddle Date: Tue, 2 May 2023 20:12:10 -0400 Subject: [PATCH 398/650] Spelling dictionary additions --- .vscode/cspell/winmodules/dictionaries/winps.txt | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.vscode/cspell/winmodules/dictionaries/winps.txt b/.vscode/cspell/winmodules/dictionaries/winps.txt index 361551b269..2fda18e8f5 100644 --- a/.vscode/cspell/winmodules/dictionaries/winps.txt +++ b/.vscode/cspell/winmodules/dictionaries/winps.txt @@ -3,6 +3,8 @@ Cmdletization Dcpromo Dedup DSRM +Hotspot +hotspots krbtgt NTDS reoptimized From f4fdfc9932f94e2ea78dcbb873502453c31584fb Mon Sep 17 00:00:00 2001 From: Robert Biddle Date: Tue, 2 May 2023 20:12:29 -0400 Subject: [PATCH 399/650] Style guide fixes --- .../deduplication/Get-DedupMetadata.md | 111 +++++++++++------- 1 file changed, 66 insertions(+), 45 deletions(-) diff --git a/docset/winserver2022-ps/deduplication/Get-DedupMetadata.md b/docset/winserver2022-ps/deduplication/Get-DedupMetadata.md index b09fd7a536..dd2e556804 100644 --- a/docset/winserver2022-ps/deduplication/Get-DedupMetadata.md +++ b/docset/winserver2022-ps/deduplication/Get-DedupMetadata.md @@ -16,68 +16,74 @@ Returns metadata for volumes that have data deduplication metadata. ## SYNTAX ``` -Get-DedupMetadata [[-Volume] ] [-CimSession ] [-ThrottleLimit ] [-AsJob] - [] +Get-DedupMetadata [[-Volume] ] [-CimSession ] + [-ThrottleLimit ] [-AsJob] [] ``` ## DESCRIPTION -The **Get-DedupMetadata** cmdlet returns a **DeduplicationMetadata** object for every volume that has optimization metadata. -A **DeduplicationMetadata** object includes read-only properties describing the nature of the deduplication data store, such as chunk counts, container counts, average chunk size, and other statistics. -Because this cmdlet must scan the entire file system. -this cmdlet requires some time to run. +The `Get-DedupMetadata` cmdlet returns a **DeduplicationMetadata** object for every volume that has +optimization metadata. A **DeduplicationMetadata** object includes read-only properties describing +the nature of the deduplication data store, such as chunk counts, container counts, average chunk +size, and other statistics. -This cmdlet cannot be part of a schedule; it must be run manually. -If another optimization job is running on the specified volume when you start this cmdlet, then this cmdlet fails. -It also fails if there is not enough memory for the file system scan and cmdlet processing. -If the cmdlet fails, then review the events and log files for more information. +Because this cmdlet must scan the entire file system. this cmdlet requires some time to run. + +This cmdlet cannot be part of a schedule; it must be run manually. If another optimization job is +running on the specified volume when you start this cmdlet, then this cmdlet fails. It also fails if +there is not enough memory for the file system scan and cmdlet processing. If the cmdlet fails, then +review the events and log files for more information. To run this cmdlet, you must start Windows PowerShell® with the **Run as administrator** option. -This cmdlet returns the following properties: +This cmdlet returns the following properties: - **DataChunkCount**. -Indicates the number of data chunks in a container. +Indicates the number of data chunks in a container. - **DataContainerCount**. -Indicates the number of containers in the data store. -- **DataChunkAverageSize**. -Indicates the data store size, not including chunk metadata, divided by the total number of data chunks in the data store. +Indicates the number of containers in the data store. +- **DataChunkAverageSize**. Indicates the data store size, not including chunk metadata, divided by + the total number of data chunks in the data store. - **StreamMapCount**. -Indicates the number of data streams in a container. +Indicates the number of data streams in a container. - **StreamMapContainerCount**. -Indicates the number of containers in the stream map store. +Indicates the number of containers in the stream map store. - **StreamMapAverageChunkCount**. -Indicates the stream map store size divided by the total number of streams in the store. +Indicates the stream map store size divided by the total number of streams in the store. - **HotspotCount**. -Indicates the number of hotspots in a container. +Indicates the number of hotspots in a container. - **HotspotContainerCount**. -Indicates the number of hotspots in the stream map store. +Indicates the number of hotspots in the stream map store. - **CorruptionCount**. Indicates the number of corruptions found on the volume. ## EXAMPLES ### Example 1: Get metadata for a volume -``` -PS C:\> Get-DedupMetadata -Volume "D:" + +```powershell +Get-DedupMetadata -Volume "D:" ``` -This command gets metadata for the D: volume. +This command gets metadata for the `D:` volume. ## PARAMETERS ### -AsJob -Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. -The cmdlet immediately returns an object that represents the job and then displays the command prompt. -You can continue to work in the session while the job completes. -To manage the job, use the `*-Job` cmdlets. -To get the job results, use the [Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. +Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to +complete. -For more information about Windows PowerShell background jobs, see [about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). +The cmdlet immediately returns an object that represents the job and then displays the command +prompt. You can continue to work in the session while the job completes. To manage the job, use the +`*-Job` cmdlets. To get the job results, use the +[Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. + +For more information about Windows PowerShell background jobs, see +[about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -89,12 +95,14 @@ Accept wildcard characters: False ``` ### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a [New-CimSession](/powershell/module/cimcmdlets/new-cimsession) or [Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet. -The default is the current session on the local computer. + +Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session +object, such as the output of a [New-CimSession](/powershell/module/cimcmdlets/new-cimsession) or +[Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet. The default is the +current session on the local computer. ```yaml -Type: CimSession[] +Type: Microsoft.Management.Infrastructure.CimSession[] Parameter Sets: (All) Aliases: Session @@ -106,12 +114,15 @@ Accept wildcard characters: False ``` ### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -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. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. + +Specifies the maximum number of concurrent operations that can be established to run the cmdlet. 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. The throttle limit applies only to the current cmdlet, not to the session or to the +computer. ```yaml -Type: Int32 +Type: System.Int32 Parameter Sets: (All) Aliases: @@ -123,10 +134,12 @@ Accept wildcard characters: False ``` ### -Volume -Specifies one or more file system volumes for which to return a **DeduplicationVolumeMetadata** object. + +Specifies one or more file system volumes for which to return a **DeduplicationVolumeMetadata** +object. ```yaml -Type: String[] +Type: System.String[] Parameter Sets: (All) Aliases: Path, Name, DeviceId @@ -138,7 +151,11 @@ Accept wildcard characters: False ``` ### CommonParameters -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). + +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). ## INPUTS @@ -147,12 +164,16 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### Microsoft.Management.Infrastructure.CimInstance -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. + +The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays +Windows Management Instrumentation (WMI) objects. The path after the pound sign (`#`) provides the +namespace and class name for the underlying WMI object. ### Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Deduplication/MSFT_DedupVolumeMetadata -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. + +The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays +Windows Management Instrumentation (WMI) objects. The path after the pound sign (`#`) provides the +namespace and class name for the underlying WMI object. ## NOTES From a3a0f1238ef100b79e4f84547e9b1789cf72e4e1 Mon Sep 17 00:00:00 2001 From: Robert Biddle Date: Tue, 2 May 2023 20:14:44 -0400 Subject: [PATCH 400/650] Alphabetically sorting property list --- .../deduplication/Get-DedupMetadata.md | 24 +++++++++---------- 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/docset/winserver2022-ps/deduplication/Get-DedupMetadata.md b/docset/winserver2022-ps/deduplication/Get-DedupMetadata.md index dd2e556804..ee6290002e 100644 --- a/docset/winserver2022-ps/deduplication/Get-DedupMetadata.md +++ b/docset/winserver2022-ps/deduplication/Get-DedupMetadata.md @@ -38,24 +38,24 @@ To run this cmdlet, you must start Windows PowerShell® with the **Run as admini This cmdlet returns the following properties: +- **CorruptionCount**. +Indicates the number of corruptions found on the volume. +- **DataChunkAverageSize**. Indicates the data store size, not including chunk metadata, divided by + the total number of data chunks in the data store. - **DataChunkCount**. Indicates the number of data chunks in a container. - **DataContainerCount**. Indicates the number of containers in the data store. -- **DataChunkAverageSize**. Indicates the data store size, not including chunk metadata, divided by - the total number of data chunks in the data store. -- **StreamMapCount**. -Indicates the number of data streams in a container. -- **StreamMapContainerCount**. -Indicates the number of containers in the stream map store. -- **StreamMapAverageChunkCount**. -Indicates the stream map store size divided by the total number of streams in the store. -- **HotspotCount**. -Indicates the number of hotspots in a container. - **HotspotContainerCount**. Indicates the number of hotspots in the stream map store. -- **CorruptionCount**. -Indicates the number of corruptions found on the volume. +- **HotspotCount**. +Indicates the number of hotspots in a container. +- **StreamMapAverageChunkCount**. +Indicates the stream map store size divided by the total number of streams in the store. +- **StreamMapContainerCount**. +Indicates the number of containers in the stream map store. +- **StreamMapCount**. +Indicates the number of data streams in a container. ## EXAMPLES From fd6258e3639dae26381706382431620abf345c7a Mon Sep 17 00:00:00 2001 From: Robert Biddle Date: Tue, 2 May 2023 22:34:25 -0400 Subject: [PATCH 401/650] Style guide fixes --- .../deduplication/Get-DedupMetadata.md | 37 ++++++++++--------- 1 file changed, 19 insertions(+), 18 deletions(-) diff --git a/docset/winserver2022-ps/deduplication/Get-DedupMetadata.md b/docset/winserver2022-ps/deduplication/Get-DedupMetadata.md index ee6290002e..ac788ce2ef 100644 --- a/docset/winserver2022-ps/deduplication/Get-DedupMetadata.md +++ b/docset/winserver2022-ps/deduplication/Get-DedupMetadata.md @@ -38,24 +38,25 @@ To run this cmdlet, you must start Windows PowerShell® with the **Run as admini This cmdlet returns the following properties: -- **CorruptionCount**. -Indicates the number of corruptions found on the volume. -- **DataChunkAverageSize**. Indicates the data store size, not including chunk metadata, divided by - the total number of data chunks in the data store. -- **DataChunkCount**. -Indicates the number of data chunks in a container. -- **DataContainerCount**. -Indicates the number of containers in the data store. -- **HotspotContainerCount**. -Indicates the number of hotspots in the stream map store. -- **HotspotCount**. -Indicates the number of hotspots in a container. -- **StreamMapAverageChunkCount**. -Indicates the stream map store size divided by the total number of streams in the store. -- **StreamMapContainerCount**. -Indicates the number of containers in the stream map store. -- **StreamMapCount**. -Indicates the number of data streams in a container. +- `CorruptionCount` + - Indicates the number of corruptions found on the volume. +- `DataChunkAverageSize` + - Indicates the data store size, not including chunk metadata, divided by the total number of data + chunks in the data store. +- `DataChunkCount` + - Indicates the number of data chunks in a container. +- `DataContainerCount` + - Indicates the number of containers in the data store. +- `HotspotContainerCount` + - Indicates the number of hotspots in the stream map store. +- `HotspotCount` + - Indicates the number of hotspots in a container. +- `StreamMapAverageChunkCount` + - Indicates the stream map store size divided by the total number of streams in the store. +- `StreamMapContainerCount` + - Indicates the number of containers in the stream map store. +- `StreamMapCount` + - Indicates the number of data streams in a container. ## EXAMPLES From eb6920af4e0762adc8dbdafb6c8c04ac1da8c331 Mon Sep 17 00:00:00 2001 From: Robert Biddle Date: Tue, 2 May 2023 19:23:43 -0400 Subject: [PATCH 402/650] Style guide fixes --- .../deduplication/Deduplication.md | 26 ++++++++++++++++--- 1 file changed, 22 insertions(+), 4 deletions(-) diff --git a/docset/winserver2022-ps/deduplication/Deduplication.md b/docset/winserver2022-ps/deduplication/Deduplication.md index ae1e08bd78..f06be8022a 100644 --- a/docset/winserver2022-ps/deduplication/Deduplication.md +++ b/docset/winserver2022-ps/deduplication/Deduplication.md @@ -10,57 +10,75 @@ title: Deduplication --- # Deduplication Module + ## Description -This reference provides cmdlet descriptions and syntax for all Windows Server Data Deduplication-specific cmdlets. -It lists the cmdlets in alphabetical order based on the verb at the beginning of the cmdlet. + +This reference provides cmdlet descriptions and syntax for all Windows Server Data +Deduplication-specific cmdlets. It lists the cmdlets in alphabetical order based on the verb at the +beginning of the cmdlet. ## Deduplication Cmdlets + ### [Disable-DedupVolume](./Disable-DedupVolume.md) + Disables data deduplication activity on one or more volumes. ### [Enable-DedupVolume](./Enable-DedupVolume.md) + Enables data deduplication on one or more volumes. ### [Expand-DedupFile](./Expand-DedupFile.md) + Expands an optimized file into its original location. ### [Get-DedupJob](./Get-DedupJob.md) + Returns status and information for currently running or queued deduplication jobs. ### [Get-DedupMetadata](./Get-DedupMetadata.md) + Returns metadata for volumes that have data deduplication metadata. ### [Get-DedupSchedule](./Get-DedupSchedule.md) + Returns the deduplication job schedule defined on the computer. ### [Get-DedupStatus](./Get-DedupStatus.md) + Returns deduplication status for volumes that have data deduplication metadata. ### [Get-DedupVolume](./Get-DedupVolume.md) + Returns deduplication volumes that have data deduplication metadata. ### [Measure-DedupFileMetadata](./Measure-DedupFileMetadata.md) + Measures potential disk space on a volume. ### [New-DedupSchedule](./New-DedupSchedule.md) + Creates a data deduplication schedule. ### [Remove-DedupSchedule](./Remove-DedupSchedule.md) + Deletes a deduplication schedule. ### [Set-DedupSchedule](./Set-DedupSchedule.md) + Changes configuration settings for data deduplication schedules. ### [Set-DedupVolume](./Set-DedupVolume.md) + Changes data deduplication settings on one or more volumes. ### [Start-DedupJob](./Start-DedupJob.md) + Starts a data deduplication job. ### [Stop-DedupJob](./Stop-DedupJob.md) + Cancels one or more specified data deduplication jobs. ### [Update-DedupStatus](./Update-DedupStatus.md) -Scans volumes for fresh data deduplication savings. - +Scans volumes for fresh data deduplication savings. From f6c6d57668da983dc454b7fc85160c758c7e28fc Mon Sep 17 00:00:00 2001 From: Robert Biddle Date: Tue, 2 May 2023 19:43:48 -0400 Subject: [PATCH 403/650] Style guide fixes --- .../deduplication/Disable-DedupVolume.md | 113 +++++++++++------- 1 file changed, 68 insertions(+), 45 deletions(-) diff --git a/docset/winserver2022-ps/deduplication/Disable-DedupVolume.md b/docset/winserver2022-ps/deduplication/Disable-DedupVolume.md index 2405fa410d..672b28cece 100644 --- a/docset/winserver2022-ps/deduplication/Disable-DedupVolume.md +++ b/docset/winserver2022-ps/deduplication/Disable-DedupVolume.md @@ -16,60 +16,72 @@ Disables data deduplication activity on one or more volumes. ## SYNTAX ``` -Disable-DedupVolume [-Volume] [-DataAccess] [-CimSession ] [-ThrottleLimit ] - [-AsJob] [] +Disable-DedupVolume [-Volume] [-DataAccess] [-CimSession ] + [-ThrottleLimit ] [-AsJob] [] ``` ## DESCRIPTION -The **Disable-DedupVolume** cmdlet disables further data deduplication activity on one or more volumes. -After you disable data deduplication, the volume remains in a deduplicated state and the existing deduplicated data is accessible. -The server stops running data deduplication jobs for the volume and new data is not deduplicated. -To undo data deduplication on a volume, use the **Start-DedupJob** cmdlet and specify Unoptimization for the *Type* parameter. -After you disable data deduplication on a volume, you can perform all read-only deduplication cmdlet operations on the volume. -For example, you can use the **Get-DedupStatus** cmdlet to get deduplication status for a volume that has data deduplication metadata. -After you disable data deduplication on a volume, you cannot use the data deduplication job-related cmdlets and the **Update-DedupStatus** cmdlet to perform operations on the volume. -For example, you cannot use **Start-DedupJob** to start a data deduplication job for a volume on which you have disabled data deduplication. +The `Disable-DedupVolume` cmdlet disables further data deduplication activity on one or more +volumes. After you disable data deduplication, the volume remains in a deduplicated state and the +existing deduplicated data is accessible. The server stops running data deduplication jobs for the +volume and new data is not deduplicated. To undo data deduplication on a volume, use the +`Start-DedupJob` cmdlet and specify `Unoptimization` for the **Type** parameter. + +After you disable data deduplication on a volume, you can perform all read-only deduplication cmdlet +operations on the volume. For example, you can use the `Get-DedupStatus` cmdlet to get deduplication +status for a volume that has data deduplication metadata. After you disable data deduplication on a +volume, you cannot use the data deduplication job-related cmdlets and the `Update-DedupStatus` +cmdlet to perform operations on the volume. For example, you cannot use `Start-DedupJob` to start a +data deduplication job for a volume on which you have disabled data deduplication. ## EXAMPLES ### Example 1: Disable data deduplication on volumes -``` -PS C:\> Disable-DedupVolume -Volume "D:","E:","F:","G:" + +```powershell +Disable-DedupVolume -Volume "D:","E:","F:","G:" ``` This command disables data deduplication for volumes D:, E:, F:, and G:. ### Example 2: Disable data deduplication on a volume by using a GUID -``` -PS C:\> Disable-DedupVolume -Volume "\\?\Volume{26a21bda-a627-11d7-9931-806e6f6e6963}\" + +```powershell +Disable-DedupVolume -Volume "\\?\Volume{26a21bda-a627-11d7-9931-806e6f6e6963}\" ``` -This command disables data deduplication for the volume that has the GUID 26a21bda-a627-11d7-9931-806e6f6e6963. +This command disables data deduplication for the volume that has the GUID +26a21bda-a627-11d7-9931-806e6f6e6963. ### Example 3: Suspend I/O activity for a specified volume -``` -PS C:\> Disable-DedupVolume -Volume "X:" -DataAccess + +```powershell +Disable-DedupVolume -Volume "X:" -DataAccess ``` -This command suspends I/O activity for data deduplication on the specified volume. -Effectively, this command causes the data deduplication file system mini-filter to detach from the specified volume. -After this command completes, I/O to data deduplication files fails with an ERROR_INVALID_FUNCTION error until either the `Enable-DedupVolume -DataAccess` command runs, or the server restarts. +This command suspends I/O activity for data deduplication on the specified volume. Effectively, this +command causes the data deduplication file system mini-filter to detach from the specified volume. +After this command completes, I/O to data deduplication files fails with an ERROR_INVALID_FUNCTION +error until either the `Enable-DedupVolume -DataAccess` command runs, or the server restarts. ## PARAMETERS ### -AsJob -Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. -The cmdlet immediately returns an object that represents the job and then displays the command prompt. -You can continue to work in the session while the job completes. -To manage the job, use the `*-Job` cmdlets. -To get the job results, use the [Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. +Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to +complete. -For more information about Windows PowerShell background jobs, see [about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). +The cmdlet immediately returns an object that represents the job and then displays the command +prompt. You can continue to work in the session while the job completes. To manage the job, use the +`*-Job` cmdlets. To get the job results, use the +[Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. + +For more information about Windows PowerShell background jobs, see +[about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -81,12 +93,14 @@ Accept wildcard characters: False ``` ### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a [New-CimSession](/powershell/module/cimcmdlets/new-cimsession) or [Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet. -The default is the current session on the local computer. + +Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session +object, such as the output of a [New-CimSession](/powershell/module/cimcmdlets/new-cimsession) or +[Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet. The default is the +current session on the local computer. ```yaml -Type: CimSession[] +Type: Microsoft.Management.Infrastructure.CimSession[] Parameter Sets: (All) Aliases: Session @@ -98,10 +112,11 @@ Accept wildcard characters: False ``` ### -DataAccess + Indicates that data access to deduplicated files on the volume is disabled. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -113,12 +128,15 @@ Accept wildcard characters: False ``` ### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -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. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. + +Specifies the maximum number of concurrent operations that can be established to run the cmdlet. 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. The throttle limit applies only to the current cmdlet, not to the session or to the +computer. ```yaml -Type: Int32 +Type: System.Int32 Parameter Sets: (All) Aliases: @@ -130,14 +148,13 @@ Accept wildcard characters: False ``` ### -Volume -Specifies an array of system volumes for which to disable data deduplication. -Specify one or more volume IDs, drive letters, or volume GUID paths. -For drive letters, use the format D:. -For volume GUID paths, use the format `\\\\?\Volume{{GUID}}\`. -Separate multiple volumes with a comma. + +Specifies an array of system volumes for which to disable data deduplication. Specify one or more +volume IDs, drive letters, or volume GUID paths. For drive letters, use the format D:. For volume +GUID paths, use the format `\\\\?\Volume{{GUID}}\`. Separate multiple volumes with a comma. ```yaml -Type: String[] +Type: System.String[] Parameter Sets: (All) Aliases: DeviceId, Path, Name @@ -149,7 +166,11 @@ Accept wildcard characters: False ``` ### CommonParameters -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). + +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). ## INPUTS @@ -158,8 +179,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### Microsoft.Management.Infrastructure.CimInstance -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. + +The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays +Windows Management Instrumentation (WMI) objects. The path after the pound sign (`#`) provides the +namespace and class name for the underlying WMI object. ## NOTES From 7118cabccf2819c4a6613c32309d96b447e1bd19 Mon Sep 17 00:00:00 2001 From: Robert Biddle Date: Tue, 2 May 2023 19:55:52 -0400 Subject: [PATCH 404/650] Style guide fixes --- .../winserver2022-ps/deduplication/Disable-DedupVolume.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docset/winserver2022-ps/deduplication/Disable-DedupVolume.md b/docset/winserver2022-ps/deduplication/Disable-DedupVolume.md index 672b28cece..61700fcb88 100644 --- a/docset/winserver2022-ps/deduplication/Disable-DedupVolume.md +++ b/docset/winserver2022-ps/deduplication/Disable-DedupVolume.md @@ -43,7 +43,7 @@ data deduplication job for a volume on which you have disabled data deduplicatio Disable-DedupVolume -Volume "D:","E:","F:","G:" ``` -This command disables data deduplication for volumes D:, E:, F:, and G:. +This command disables data deduplication for volumes `D:`, `E:`, `F:`, and `G:`. ### Example 2: Disable data deduplication on a volume by using a GUID @@ -52,7 +52,7 @@ Disable-DedupVolume -Volume "\\?\Volume{26a21bda-a627-11d7-9931-806e6f6e6963}\" ``` This command disables data deduplication for the volume that has the GUID -26a21bda-a627-11d7-9931-806e6f6e6963. +`26a21bda-a627-11d7-9931-806e6f6e6963`. ### Example 3: Suspend I/O activity for a specified volume @@ -62,7 +62,7 @@ Disable-DedupVolume -Volume "X:" -DataAccess This command suspends I/O activity for data deduplication on the specified volume. Effectively, this command causes the data deduplication file system mini-filter to detach from the specified volume. -After this command completes, I/O to data deduplication files fails with an ERROR_INVALID_FUNCTION +After this command completes, I/O to data deduplication files fails with an `ERROR_INVALID_FUNCTION` error until either the `Enable-DedupVolume -DataAccess` command runs, or the server restarts. ## PARAMETERS @@ -150,7 +150,7 @@ Accept wildcard characters: False ### -Volume Specifies an array of system volumes for which to disable data deduplication. Specify one or more -volume IDs, drive letters, or volume GUID paths. For drive letters, use the format D:. For volume +volume IDs, drive letters, or volume GUID paths. For drive letters, use the format `D:`. For volume GUID paths, use the format `\\\\?\Volume{{GUID}}\`. Separate multiple volumes with a comma. ```yaml From ee7378c538d676d4f6657aa267f94ddf913e23b7 Mon Sep 17 00:00:00 2001 From: Robert Biddle Date: Tue, 2 May 2023 19:53:42 -0400 Subject: [PATCH 405/650] Style guide fixes --- .../deduplication/Enable-DedupVolume.md | 138 ++++++++++-------- 1 file changed, 79 insertions(+), 59 deletions(-) diff --git a/docset/winserver2022-ps/deduplication/Enable-DedupVolume.md b/docset/winserver2022-ps/deduplication/Enable-DedupVolume.md index 920b43fade..12246640c2 100644 --- a/docset/winserver2022-ps/deduplication/Enable-DedupVolume.md +++ b/docset/winserver2022-ps/deduplication/Enable-DedupVolume.md @@ -16,63 +16,73 @@ Enables data deduplication on one or more volumes. ## SYNTAX ``` -Enable-DedupVolume [-Volume] [-DataAccess] [-UsageType ] [-CimSession ] - [-ThrottleLimit ] [-AsJob] [] +Enable-DedupVolume [-Volume] [-DataAccess] [-UsageType ] + [-CimSession ] [-ThrottleLimit ] [-AsJob] [] ``` ## DESCRIPTION -The **Enable-DedupVolume** cmdlet enables data deduplication on one or more volumes. -You can use the **Set-DedupVolume** cmdlet to customize the data deduplication settings. -Data deduplication is disabled by default. -Data deduplication is not supported for certain volumes, such as any volume that is not a NTFS file system or any volume that is smaller than 2 GB. + +The `Enable-DedupVolume` cmdlet enables data deduplication on one or more volumes. You can use the +`Set-DedupVolume` cmdlet to customize the data deduplication settings. Data deduplication is +disabled by default. Data deduplication is not supported for certain volumes, such as any volume +that is not a NTFS file system or any volume that is smaller than 2 GB. ## EXAMPLES ### Example 1: Enable data deduplication on volumes -``` -PS C:\> Enable-DedupVolume -Volume "D:","E:","F:" + +```powershell +Enable-DedupVolume -Volume "D:","E:","F:" ``` -This command enables data deduplication on volumes D:, E:, and F:. -This command does not specify a value for the **UsageType** parameter, and, therefore, the cmdlet uses defaults for general purpose file server operations. +This command enables data deduplication on volumes `D:`, `E:`, and `F:`. This command does not +specify a value for the **UsageType** parameter, and, therefore, the cmdlet uses defaults for +general purpose file server operations. ### Example 2: Enable data deduplication on a volume for Hyper-V storage -``` -PS C:\> Enable-DedupVolume -Volume "D:" -UsageType HyperV + +```powershell +Enable-DedupVolume -Volume "D:" -UsageType HyperV ``` -This command enables data duplication on the D: volume. -The command specifies Hyper-V storage as the usage type for this volume. +This command enables data duplication on the D: volume. The command specifies Hyper-V storage as the +usage type for this volume. ### Example 3: Enable data deduplication on a volume by using a GUID -``` -PS C:\> Enable-DedupVolume -Volume "\\?\Volume{26a21bda-a627-11d7-9931-806e6f6e6963}\" + +```powershell +Enable-DedupVolume -Volume "\\?\Volume{26a21bda-a627-11d7-9931-806e6f6e6963}\" ``` -This command enables data deduplication for the volume that has the GUID 26a21bda-a627-11d7-9931-806e6f6e6963. +This command enables data deduplication for the volume that has the GUID +26a21bda-a627-11d7-9931-806e6f6e6963. ### Example 4: Resume I/O activity on a specified volume/ -``` -PS C:\> Enable-DedupVolume -Volume "X:" -DataAccess + +```powershell +Enable-DedupVolume -Volume "X:" -DataAccess ``` -This command resumes I/O activity for data deduplication on the specified volume. -Effectively, this command causes the data deduplication file system mini-filter to attach to the specified volume +This command resumes I/O activity for data deduplication on the specified volume. Effectively, this +command causes the data deduplication file system mini-filter to attach to the specified volume ## PARAMETERS ### -AsJob -Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. -The cmdlet immediately returns an object that represents the job and then displays the command prompt. -You can continue to work in the session while the job completes. -To manage the job, use the `*-Job` cmdlets. -To get the job results, use the [Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. +Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to +complete. -For more information about Windows PowerShell background jobs, see [about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). +The cmdlet immediately returns an object that represents the job and then displays the command +prompt. You can continue to work in the session while the job completes. To manage the job, use the +`*-Job` cmdlets. To get the job results, use the +[Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. + +For more information about Windows PowerShell background jobs, see +[about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -84,12 +94,14 @@ Accept wildcard characters: False ``` ### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a [New-CimSession](/powershell/module/cimcmdlets/new-cimsession) or [Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet. -The default is the current session on the local computer. + +Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session +object, such as the output of a [New-CimSession](/powershell/module/cimcmdlets/new-cimsession) or +[Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet. The default is the +current session on the local computer. ```yaml -Type: CimSession[] +Type: Microsoft.Management.Infrastructure.CimSession[] Parameter Sets: (All) Aliases: Session @@ -101,10 +113,11 @@ Accept wildcard characters: False ``` ### -DataAccess + Indicates that data access to deduplicated files on the volume is enabled. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -116,12 +129,15 @@ Accept wildcard characters: False ``` ### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -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. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. + +Specifies the maximum number of concurrent operations that can be established to run the cmdlet. 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. The throttle limit applies only to the current cmdlet, not to the session or to the +computer. ```yaml -Type: Int32 +Type: System.Int32 Parameter Sets: (All) Aliases: @@ -133,22 +149,21 @@ Accept wildcard characters: False ``` ### -UsageType -Specifies the expected type of workload for the volume. -This cmdlet sets several low-level settings to default values that are appropriate to the usage type that you specify. -If you specify this parameter for a volume that already has data deduplication enabled, the cmdlet modifies the settings to the appropriate default values. -If you run this cmdlet on a volume that already has data deduplication enabled but do not specify this parameter, the cmdlet does not change the usage type. + +Specifies the expected type of workload for the volume. This cmdlet sets several low-level settings +to default values that are appropriate to the usage type that you specify. If you specify this +parameter for a volume that already has data deduplication enabled, the cmdlet modifies the settings +to the appropriate default values. If you run this cmdlet on a volume that already has data +deduplication enabled but do not specify this parameter, the cmdlet does not change the usage type. The acceptable values for this parameter are: -- HyperV. -A volume for Hyper-V storage. -- Backup. -A volume that is optimized for virtualized backup servers. -- Default. -A general purpose volume. -If you do not specify a value for this parameter, the cmdlet uses a value of Default. +- `HyperV` A volume for Hyper-V storage. +- `Backup` A volume that is optimized for virtualized backup servers. +- `Default` A general purpose volume. If you do not specify a value for this parameter, the cmdlet + uses a value of Default. -If you specify a value of HyperV, the computer that has data deduplication enabled cannot be the same computer that runs Hyper-V. -The two computers must communicate remotely. +If you specify a value of HyperV, the computer that has data deduplication enabled cannot be the +same computer that runs Hyper-V. The two computers must communicate remotely. ```yaml Type: UsageType @@ -164,14 +179,13 @@ Accept wildcard characters: False ``` ### -Volume -Specifies an array of system volumes. -Specify one or more volume IDs, drive letters, or volume GUID paths. -For drive letters, use the format D:. -For volume GUID paths, use the format \\\\?\Volume{{GUID}}\. -Separate multiple volumes with a comma. + +Specifies an array of system volumes. Specify one or more volume IDs, drive letters, or volume GUID +paths. For drive letters, use the format D:. For volume GUID paths, use the format +`\\\\?\Volume{{GUID}}\`. Separate multiple volumes with a comma. ```yaml -Type: String[] +Type: System.String[] Parameter Sets: (All) Aliases: DeviceId, Path, Name @@ -183,7 +197,11 @@ Accept wildcard characters: False ``` ### CommonParameters -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). + +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). ## INPUTS @@ -192,8 +210,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### Microsoft.Management.Infrastructure.CimInstance -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. + +The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays +Windows Management Instrumentation (WMI) objects. The path after the pound sign (`#`) provides the +namespace and class name for the underlying WMI object. ## NOTES From dbefd91c56299e117b5eadaf89c9d145c507ea67 Mon Sep 17 00:00:00 2001 From: Robert Biddle Date: Tue, 2 May 2023 19:59:28 -0400 Subject: [PATCH 406/650] Style guide fixes --- .../deduplication/Expand-DedupFile.md | 81 +++++++++++-------- 1 file changed, 49 insertions(+), 32 deletions(-) diff --git a/docset/winserver2022-ps/deduplication/Expand-DedupFile.md b/docset/winserver2022-ps/deduplication/Expand-DedupFile.md index 6d8c9aaebc..9519cb1530 100644 --- a/docset/winserver2022-ps/deduplication/Expand-DedupFile.md +++ b/docset/winserver2022-ps/deduplication/Expand-DedupFile.md @@ -16,42 +16,48 @@ Expands an optimized file into its original location. ## SYNTAX ``` -Expand-DedupFile [-Path] [-CimSession ] [-ThrottleLimit ] [-AsJob] - [] +Expand-DedupFile [-Path] [-CimSession ] [-ThrottleLimit ] + [-AsJob] [] ``` ## DESCRIPTION -The **Expand-DedupFile** cmdlet expands an optimized file into its original location. -You may need to expand optimized files because of compatibility with applications or other requirements. -Ensure that there is enough space on the volume to store the expanded file. -If you do not have enough disk space, the cmdlet attempts to expand the file, and then informs you when it is unable to finish the operation. -If you attempt to restore a file that is not optimized, the cmdlet notifies you of the error. +The `Expand-DedupFile` cmdlet expands an optimized file into its original location. You may need to +expand optimized files because of compatibility with applications or other requirements. + +Ensure that there is enough space on the volume to store the expanded file. If you do not have +enough disk space, the cmdlet attempts to expand the file, and then informs you when it is unable to +finish the operation. If you attempt to restore a file that is not optimized, the cmdlet notifies +you of the error. ## EXAMPLES ### Example 1: Expand a file -``` -PS C:\> Expand-DedupFile -Path "D:\Share\File07.doc" + +```powershell +Expand-DedupFile -Path "D:\Share\File07.doc" ``` -This command expands a file to its original location, D:\Share\File07.doc. -If the file is not optimized, the cmdlet informs you of the problem. +This command expands a file to its original location, `D:\Share\File07.doc`. If the file is not +optimized, the cmdlet informs you of the problem. ## PARAMETERS ### -AsJob -Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. -The cmdlet immediately returns an object that represents the job and then displays the command prompt. -You can continue to work in the session while the job completes. -To manage the job, use the `*-Job` cmdlets. -To get the job results, use the [Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. +Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to +complete. -For more information about Windows PowerShell background jobs, see [about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). +The cmdlet immediately returns an object that represents the job and then displays the command +prompt. You can continue to work in the session while the job completes. To manage the job, use the +`*-Job` cmdlets. To get the job results, use the +[Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. + +For more information about Windows PowerShell background jobs, see +[about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -63,12 +69,14 @@ Accept wildcard characters: False ``` ### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a [New-CimSession](/powershell/module/cimcmdlets/new-cimsession) or [Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet. -The default is the current session on the local computer. + +Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session +object, such as the output of a [New-CimSession](/powershell/module/cimcmdlets/new-cimsession) or +[Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet. The default is the +current session on the local computer. ```yaml -Type: CimSession[] +Type: Microsoft.Management.Infrastructure.CimSession[] Parameter Sets: (All) Aliases: Session @@ -80,11 +88,12 @@ Accept wildcard characters: False ``` ### -Path -Specifies an array of file paths. -The cmdlet expands files to the file paths specified by this parameter. + +Specifies an array of file paths. The cmdlet expands files to the file paths specified by this +parameter. ```yaml -Type: String[] +Type: System.String[] Parameter Sets: (All) Aliases: FullName @@ -96,12 +105,15 @@ Accept wildcard characters: False ``` ### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -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. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. + +Specifies the maximum number of concurrent operations that can be established to run the cmdlet. 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. The throttle limit applies only to the current cmdlet, not to the session or to the +computer. ```yaml -Type: Int32 +Type: System.Int32 Parameter Sets: (All) Aliases: @@ -113,15 +125,20 @@ Accept wildcard characters: False ``` ### CommonParameters -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). + +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). ## INPUTS ## OUTPUTS ### Uint32 -This cmdlet generates an integer that indicates success or failure of the operation. -A value of zero indicates success. + +This cmdlet generates an integer that indicates success or failure of the operation. A value of zero +indicates success. ## NOTES From 4c3453e47cbbf07ec58cda7b3735f0a77fb92eb4 Mon Sep 17 00:00:00 2001 From: Robert Biddle Date: Tue, 2 May 2023 20:05:30 -0400 Subject: [PATCH 407/650] Style guide fixes --- .../deduplication/Get-DedupJob.md | 97 +++++++++++-------- 1 file changed, 59 insertions(+), 38 deletions(-) diff --git a/docset/winserver2022-ps/deduplication/Get-DedupJob.md b/docset/winserver2022-ps/deduplication/Get-DedupJob.md index dc152bfce1..b06d0f57c5 100644 --- a/docset/winserver2022-ps/deduplication/Get-DedupJob.md +++ b/docset/winserver2022-ps/deduplication/Get-DedupJob.md @@ -16,38 +16,45 @@ Returns status and information for currently running or queued deduplication job ## SYNTAX ``` -Get-DedupJob [[-Type] ] [[-Volume] ] [-CimSession ] [-ThrottleLimit ] - [-AsJob] [] +Get-DedupJob [[-Type] ] [[-Volume] ] [-CimSession ] + [-ThrottleLimit ] [-AsJob] [] ``` ## DESCRIPTION -The **Get-DedupJob** returns status and information for currently running or queued deduplication jobs. + +The `Get-DedupJob` returns status and information for currently running or queued deduplication +jobs. To run this cmdlet, you must start Windows PowerShell® with the **Run as administrator** option. ## EXAMPLES ### Example 1: Get information for jobs for specified volumes -``` -PS C:\> Get-DedupJob -Volume "D:","F:" + +```powershell +Get-DedupJob -Volume "D:","F:" ``` -This command gets status and information for currently running or queued deduplication jobs for the D: and F: volumes. +This command gets status and information for currently running or queued deduplication jobs for the +`D:` and `F:` volumes. ## PARAMETERS ### -AsJob -Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. -The cmdlet immediately returns an object that represents the job and then displays the command prompt. -You can continue to work in the session while the job completes. -To manage the job, use the `*-Job` cmdlets. -To get the job results, use the [Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. +Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to +complete. -For more information about Windows PowerShell background jobs, see [about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). +The cmdlet immediately returns an object that represents the job and then displays the command +prompt. You can continue to work in the session while the job completes. To manage the job, use the +`*-Job` cmdlets. To get the job results, use the +[Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. + +For more information about Windows PowerShell background jobs, see +[about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -59,12 +66,14 @@ Accept wildcard characters: False ``` ### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a [New-CimSession](/powershell/module/cimcmdlets/new-cimsession) or [Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet. -The default is the current session on the local computer. + +Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session +object, such as the output of a [New-CimSession](/powershell/module/cimcmdlets/new-cimsession) or +[Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet. The default is the +current session on the local computer. ```yaml -Type: CimSession[] +Type: Microsoft.Management.Infrastructure.CimSession[] Parameter Sets: (All) Aliases: Session @@ -76,12 +85,15 @@ Accept wildcard characters: False ``` ### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -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. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. + +Specifies the maximum number of concurrent operations that can be established to run the cmdlet. 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. The throttle limit applies only to the current cmdlet, not to the session or to the +computer. ```yaml -Type: Int32 +Type: System.Int32 Parameter Sets: (All) Aliases: @@ -93,13 +105,14 @@ Accept wildcard characters: False ``` ### -Type -Specifies an array of types of data deduplication jobs for which to return the job state. -The acceptable values for this parameter are: -- Optimization -- GarbageCollection -- Scrubbing -- Unoptimization +Specifies an array of types of data deduplication jobs for which to return the job state. The +acceptable values for this parameter are: + +- `Optimization` +- `GarbageCollection` +- `Scrubbing` +- `Unoptimization` ```yaml Type: Type[] @@ -115,14 +128,14 @@ Accept wildcard characters: False ``` ### -Volume -Specifies one or more file system volumes for which to return **DeduplicationJob** objects. -Enter one or more volume IDs, drive letters, or volume GUID paths. -For drive letters, use the format D:. -For volume GUID paths, use the format \\\\?\Volume{{GUID}}\. -Separate multiple volumes with a comma. + +Specifies one or more file system volumes for which to return **DeduplicationJob** objects. Enter +one or more volume IDs, drive letters, or volume GUID paths. For drive letters, use the format `D:`. +For volume GUID paths, use the format `\\\\?\Volume{{GUID}}\`. Separate multiple volumes with a +comma. ```yaml -Type: String[] +Type: System.String[] Parameter Sets: (All) Aliases: Path, Name @@ -134,7 +147,11 @@ Accept wildcard characters: False ``` ### CommonParameters -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). + +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). ## INPUTS @@ -145,12 +162,16 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### Microsoft.Management.Infrastructure.CimInstance -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. + +The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays +Windows Management Instrumentation (WMI) objects. The path after the pound sign (`#`) provides the +namespace and class name for the underlying WMI object. ### Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Deduplication/MSFT_DedupJob -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. + +The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays +Windows Management Instrumentation (WMI) objects. The path after the pound sign (`#`) provides the +namespace and class name for the underlying WMI object. ## NOTES From 62a54db99568efcb845c611855235bd2d0c54b3c Mon Sep 17 00:00:00 2001 From: Robert Biddle Date: Tue, 2 May 2023 20:20:07 -0400 Subject: [PATCH 408/650] Style guide fixes --- .../deduplication/Get-DedupSchedule.md | 101 +++++++++++------- 1 file changed, 63 insertions(+), 38 deletions(-) diff --git a/docset/winserver2022-ps/deduplication/Get-DedupSchedule.md b/docset/winserver2022-ps/deduplication/Get-DedupSchedule.md index 393fe64e10..78348f9771 100644 --- a/docset/winserver2022-ps/deduplication/Get-DedupSchedule.md +++ b/docset/winserver2022-ps/deduplication/Get-DedupSchedule.md @@ -16,34 +16,40 @@ Returns the deduplication job schedule defined on the computer. ## SYNTAX ``` -Get-DedupSchedule [[-Name] ] [-Type ] [-CimSession ] [-ThrottleLimit ] - [-AsJob] [] +Get-DedupSchedule [[-Name] ] [-Type ] [-CimSession ] + [-ThrottleLimit ] [-AsJob] [] ``` ## DESCRIPTION -The **Get-DedupSchedule** cmdlet returns the **DeduplicationJobSchedule** objects defined on the computer. + +The `Get-DedupSchedule` cmdlet returns the **DeduplicationJobSchedule** objects defined on the +computer. To run this cmdlet, you must start Windows PowerShell® with the **Run as administrator** option. ## EXAMPLES ### Example 1: Get active schedules -``` -PS C:\> Get-DedupSchedule + +```powershell +Get-DedupSchedule ``` -This command returns the currently active data deduplication schedule objects created using the **New-DedupSchedule** cmdlet. +This command returns the currently active data deduplication schedule objects created using the +`New-DedupSchedule` cmdlet. ### Example 2: Get schedules for optimization jobs -``` -PS C:\> Get-DedupSchedule -Type Optimization + +```powershell +Get-DedupSchedule -Type Optimization ``` This command returns all data deduplication schedules for optimization jobs. ### Example 3: Get a named schedule -``` -PS C:\> Get-DedupSchedule -Name MySchedule + +```powershell +Get-DedupSchedule -Name MySchedule ``` This command returns the data deduplication schedule named MySchedule. @@ -51,17 +57,20 @@ This command returns the data deduplication schedule named MySchedule. ## PARAMETERS ### -AsJob -Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. -The cmdlet immediately returns an object that represents the job and then displays the command prompt. -You can continue to work in the session while the job completes. -To manage the job, use the `*-Job` cmdlets. -To get the job results, use the [Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. +Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to +complete. + +The cmdlet immediately returns an object that represents the job and then displays the command +prompt. You can continue to work in the session while the job completes. To manage the job, use the +`*-Job` cmdlets. To get the job results, use the +[Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. -For more information about Windows PowerShell background jobs, see [about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). +For more information about Windows PowerShell background jobs, see +[about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -73,12 +82,14 @@ Accept wildcard characters: False ``` ### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a [New-CimSession](/powershell/module/cimcmdlets/new-cimsession) or [Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet. -The default is the current session on the local computer. + +Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session +object, such as the output of a [New-CimSession](/powershell/module/cimcmdlets/new-cimsession) or +[Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet. The default is the +current session on the local computer. ```yaml -Type: CimSession[] +Type: Microsoft.Management.Infrastructure.CimSession[] Parameter Sets: (All) Aliases: Session @@ -90,10 +101,12 @@ Accept wildcard characters: False ``` ### -Name -Specifies the friendly name of one or more data deduplication job schedules for which to return **DeduplicationJobSchedule** objects. + +Specifies the friendly name of one or more data deduplication job schedules for which to return +**DeduplicationJobSchedule** objects. ```yaml -Type: String[] +Type: System.String[] Parameter Sets: (All) Aliases: @@ -105,12 +118,15 @@ Accept wildcard characters: False ``` ### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -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. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. + +Specifies the maximum number of concurrent operations that can be established to run the cmdlet. 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. The throttle limit applies only to the current cmdlet, not to the session or to the +computer. ```yaml -Type: Int32 +Type: System.Int32 Parameter Sets: (All) Aliases: @@ -122,13 +138,14 @@ Accept wildcard characters: False ``` ### -Type -Specifies an array of types of data deduplication job schedules for which to return **DeduplicationJobSchedule** objects. -The acceptable values for this parameter are: -- Optimization -- GarbageCollection -- Scrubbing -- Unoptimization +Specifies an array of types of data deduplication job schedules for which to return +**DeduplicationJobSchedule** objects. The acceptable values for this parameter are: + +- `Optimization` +- `GarbageCollection` +- `Scrubbing` +- `Unoptimization` ```yaml Type: Type[] @@ -144,7 +161,11 @@ Accept wildcard characters: False ``` ### CommonParameters -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). + +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). ## INPUTS @@ -155,12 +176,16 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### Microsoft.Management.Infrastructure.CimInstance -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. + +The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays +Windows Management Instrumentation (WMI) objects. The path after the pound sign (`#`) provides the +namespace and class name for the underlying WMI object. ### Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Deduplication/MSFT_DedupJobSchedule -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. + +The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays +Windows Management Instrumentation (WMI) objects. The path after the pound sign (`#`) provides the +namespace and class name for the underlying WMI object. ## NOTES From 3fb52a1a838f7ddce47fb10d8c1d521d850d5d82 Mon Sep 17 00:00:00 2001 From: Robert Biddle Date: Tue, 2 May 2023 20:23:32 -0400 Subject: [PATCH 409/650] Style guide fixes --- .../deduplication/Get-DedupStatus.md | 88 ++++++++++++------- 1 file changed, 54 insertions(+), 34 deletions(-) diff --git a/docset/winserver2022-ps/deduplication/Get-DedupStatus.md b/docset/winserver2022-ps/deduplication/Get-DedupStatus.md index 1e7a53e841..0de4c9c771 100644 --- a/docset/winserver2022-ps/deduplication/Get-DedupStatus.md +++ b/docset/winserver2022-ps/deduplication/Get-DedupStatus.md @@ -16,39 +16,46 @@ Returns deduplication status for volumes that have data deduplication metadata. ## SYNTAX ``` -Get-DedupStatus [[-Volume] ] [-CimSession ] [-ThrottleLimit ] [-AsJob] - [] +Get-DedupStatus [[-Volume] ] [-CimSession ] + [-ThrottleLimit ] [-AsJob] [] ``` ## DESCRIPTION -The **Get-DedupStatus** cmdlet returns a deduplication status object for every volume that has data deduplication metadata. -A **DeduplicationStatus** object includes read-only properties that describe capacity, free or used space and optimization savings and status on the volume, times, and completion status for the last jobs on the volume. + +The `Get-DedupStatus` cmdlet returns a deduplication status object for every volume that has data +deduplication metadata. A **DeduplicationStatus** object includes read-only properties that describe +capacity, free or used space and optimization savings and status on the volume, times, and +completion status for the last jobs on the volume. To run this cmdlet, you must start Windows PowerShell® with the **Run as administrator** option. ## EXAMPLES ### Example 1: Get status for specified volumes -``` -PS C:\> Get-DedupStatus -Volume "D:","F:" + +```powershell +Get-DedupStatus -Volume "D:","F:" ``` -This command gets deduplication status for the D: and F: volumes. +This command gets deduplication status for the `D:` and `F:` volumes. ## PARAMETERS -### -AsJob -Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. +### -AsJob\ -The cmdlet immediately returns an object that represents the job and then displays the command prompt. -You can continue to work in the session while the job completes. -To manage the job, use the `*-Job` cmdlets. -To get the job results, use the [Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. +Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to +complete. -For more information about Windows PowerShell background jobs, see [about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). +The cmdlet immediately returns an object that represents the job and then displays the command +prompt. You can continue to work in the session while the job completes. To manage the job, use the +`*-Job` cmdlets. To get the job results, use the +[Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. + +For more information about Windows PowerShell background jobs, see +[about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -60,12 +67,14 @@ Accept wildcard characters: False ``` ### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a [New-CimSession](/powershell/module/cimcmdlets/new-cimsession) or [Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet. -The default is the current session on the local computer. + +Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session +object, such as the output of a [New-CimSession](/powershell/module/cimcmdlets/new-cimsession) or +[Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet. The default is the +current session on the local computer. ```yaml -Type: CimSession[] +Type: Microsoft.Management.Infrastructure.CimSession[] Parameter Sets: (All) Aliases: Session @@ -77,12 +86,15 @@ Accept wildcard characters: False ``` ### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -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. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. + +Specifies the maximum number of concurrent operations that can be established to run the cmdlet. 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. The throttle limit applies only to the current cmdlet, not to the session or to the +computer. ```yaml -Type: Int32 +Type: System.Int32 Parameter Sets: (All) Aliases: @@ -94,14 +106,14 @@ Accept wildcard characters: False ``` ### -Volume -Specifies one or more file system volumes for which to return a DeduplicationStatus object. -Enter one or more volume IDs, drive letters, or volume GUID paths. -For drive letters, use the format D:. -For volume GUID paths, use the format \\\\?\Volume{{GUID}}\. -Separate multiple volumes with a comma. + +Specifies one or more file system volumes for which to return a DeduplicationStatus object. Enter +one or more volume IDs, drive letters, or volume GUID paths. For drive letters, use the format `D:`. +For volume GUID paths, use the format `\\\\?\Volume{{GUID}}\`. Separate multiple volumes with a +comma. ```yaml -Type: String[] +Type: System.String[] Parameter Sets: (All) Aliases: Path, Name, DeviceId @@ -113,7 +125,11 @@ Accept wildcard characters: False ``` ### CommonParameters -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). + +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). ## INPUTS @@ -122,12 +138,16 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### Microsoft.Management.Infrastructure.CimInstance -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. + +The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays +Windows Management Instrumentation (WMI) objects. The path after the pound sign (`#`) provides the +namespace and class name for the underlying WMI object. ### Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Deduplication/MSFT_DedupVolumeStatus -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. + +The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays +Windows Management Instrumentation (WMI) objects. The path after the pound sign (`#`) provides the +namespace and class name for the underlying WMI object. ## NOTES From 11c5fd109a0b803316ac44287be589f627812612 Mon Sep 17 00:00:00 2001 From: Robert Biddle Date: Tue, 2 May 2023 20:28:36 -0400 Subject: [PATCH 410/650] Style guide fixes --- .../deduplication/Get-DedupVolume.md | 102 +++++++++++------- 1 file changed, 64 insertions(+), 38 deletions(-) diff --git a/docset/winserver2022-ps/deduplication/Get-DedupVolume.md b/docset/winserver2022-ps/deduplication/Get-DedupVolume.md index 792daf39b8..bd5664fa99 100644 --- a/docset/winserver2022-ps/deduplication/Get-DedupVolume.md +++ b/docset/winserver2022-ps/deduplication/Get-DedupVolume.md @@ -16,35 +16,42 @@ Returns deduplication volumes that have data deduplication metadata. ## SYNTAX ### ByVolumeId (Default) + ``` -Get-DedupVolume [-VolumeId ] [-CimSession ] [-ThrottleLimit ] [-AsJob] - [] +Get-DedupVolume [-VolumeId ] [-CimSession ] + [-ThrottleLimit ] [-AsJob] [] ``` ### ByVolume + ``` -Get-DedupVolume [[-Volume] ] [-CimSession ] [-ThrottleLimit ] [-AsJob] - [] +Get-DedupVolume [[-Volume] ] [-CimSession ] + [-ThrottleLimit ] [-AsJob] [] ``` ## DESCRIPTION -The **Get-DedupVolume** cmdlet returns a **DeduplicationVolume** object for each volume that has data deduplication metadata, in either the enabled or disabled state. -In a cluster, this cmdlet returns a **DeduplicationVolume** object only for volumes currently mounted by the managed node, whether the volumes are local or clustered volumes. + +The `Get-DedupVolume` cmdlet returns a **DeduplicationVolume** object for each volume that has data +deduplication metadata, in either the enabled or disabled state. In a cluster, this cmdlet returns a +**DeduplicationVolume** object only for volumes currently mounted by the managed node, whether the +volumes are local or clustered volumes. To run this cmdlet, you must start Windows PowerShell® with the **Run as administrator** option. ## EXAMPLES ### Example 1: Get settings for a volume identified by letter -``` -PS C:\> Get-DedupVolume -Volume "E:" + +```powershell +Get-DedupVolume -Volume "E:" ``` -This command returns the data deduplication settings for volume E:. +This command returns the data deduplication settings for volume `E:`. ### Example 2: Get settings for a volume specified by ID -``` -PS C:\> Get-DedupVolume -Volume "\\?\Volume{26a21bda-a627-11d7-9931-806e6f6e6963}\" + +```powershell +Get-DedupVolume -Volume "\\?\Volume{26a21bda-a627-11d7-9931-806e6f6e6963}\" ``` This command returns the data deduplication settings for the volume that has the specified GUID. @@ -52,17 +59,20 @@ This command returns the data deduplication settings for the volume that has the ## PARAMETERS ### -AsJob -Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. -The cmdlet immediately returns an object that represents the job and then displays the command prompt. -You can continue to work in the session while the job completes. -To manage the job, use the `*-Job` cmdlets. -To get the job results, use the [Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. +Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to +complete. + +The cmdlet immediately returns an object that represents the job and then displays the command +prompt. You can continue to work in the session while the job completes. To manage the job, use the +`*-Job` cmdlets. To get the job results, use the +[Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. -For more information about Windows PowerShell background jobs, see [about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). +For more information about Windows PowerShell background jobs, see +[about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -74,12 +84,14 @@ Accept wildcard characters: False ``` ### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a [New-CimSession](/powershell/module/cimcmdlets/new-cimsession) or [Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet. -The default is the current session on the local computer. + +Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session +object, such as the output of a [New-CimSession](/powershell/module/cimcmdlets/new-cimsession) or +[Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet. The default is the +current session on the local computer. ```yaml -Type: CimSession[] +Type: Microsoft.Management.Infrastructure.CimSession[] Parameter Sets: (All) Aliases: Session @@ -91,9 +103,12 @@ Accept wildcard characters: False ``` ### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -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. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. + +Specifies the maximum number of concurrent operations that can be established to run the cmdlet. 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. The throttle limit applies only to the current cmdlet, not to the session or to the +computer. ```yaml Type: Int32 @@ -108,14 +123,15 @@ Accept wildcard characters: False ``` ### -Volume -Specifies one or more file system volumes for which to return data deduplication metadata, or in the case of a cluster, volumes with data deduplication metadata currently mounted by the managed node. -Enter one or more volume IDs, drive letters, or volume GUID paths. -For drive letters, use the format D:. -For volume GUID paths, use the format \\\\?\Volume{{GUID}}\. -Separate multiple volumes with a comma. + +Specifies one or more file system volumes for which to return data deduplication metadata, or in the +case of a cluster, volumes with data deduplication metadata currently mounted by the managed node. +Enter one or more volume IDs, drive letters, or volume GUID paths. For drive letters, use the format +`D:`. For volume GUID paths, use the format `\\\\?\Volume{{GUID}}\`. Separate multiple volumes with +a comma. ```yaml -Type: String[] +Type: System.String[] Parameter Sets: ByVolume Aliases: @@ -127,10 +143,12 @@ Accept wildcard characters: False ``` ### -VolumeId -Specifies a string that uniquely identifies the volume on which to return data deduplication metadata. + +Specifies a string that uniquely identifies the volume on which to return data deduplication +metadata. ```yaml -Type: String[] +Type: System.String[] Parameter Sets: ByVolumeId Aliases: DeviceId, Path, Id @@ -142,7 +160,11 @@ Accept wildcard characters: False ``` ### CommonParameters -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). + +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). ## INPUTS @@ -151,12 +173,16 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### Microsoft.Management.Infrastructure.CimInstance -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. + +The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays +Windows Management Instrumentation (WMI) objects. The path after the pound sign (`#`) provides the +namespace and class name for the underlying WMI object. ### Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Deduplication/MSFT_DedupVolume -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. + +The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays +Windows Management Instrumentation (WMI) objects. The path after the pound sign (`#`) provides the +namespace and class name for the underlying WMI object. ## NOTES From b74bfe9f92a48a10a2602cf8657f4e001c9bebce Mon Sep 17 00:00:00 2001 From: Robert Biddle Date: Tue, 2 May 2023 20:32:09 -0400 Subject: [PATCH 411/650] Style guide fixes --- .../Measure-DedupFileMetadata.md | 69 ++++++++++++------- 1 file changed, 43 insertions(+), 26 deletions(-) diff --git a/docset/winserver2022-ps/deduplication/Measure-DedupFileMetadata.md b/docset/winserver2022-ps/deduplication/Measure-DedupFileMetadata.md index b16cd29fb8..da1c6bbee2 100644 --- a/docset/winserver2022-ps/deduplication/Measure-DedupFileMetadata.md +++ b/docset/winserver2022-ps/deduplication/Measure-DedupFileMetadata.md @@ -16,40 +16,47 @@ Measures potential disk space on a volume. ## SYNTAX ``` -Measure-DedupFileMetadata [-Path] [-CimSession ] [-ThrottleLimit ] [-AsJob] - [] +Measure-DedupFileMetadata [-Path] [-CimSession ] + [-ThrottleLimit ] [-AsJob] [] ``` ## DESCRIPTION -The **Measure-DedupFileMetadata** cmdlet measures potential disk space on a volume. -The **DedupDistinctSize** value that this cmdlet returns indicates how much disk space you can reclaim on a volume if you delete a group of folders and then run a garbage collection job. -Files often have chunks that are shared across other folders. -The deduplication engine calculates which chunks are unique and would be deleted after the garbage collection job. +The `Measure-DedupFileMetadata` cmdlet measures potential disk space on a volume. The +**DedupDistinctSize** value that this cmdlet returns indicates how much disk space you can reclaim +on a volume if you delete a group of folders and then run a garbage collection job. + +Files often have chunks that are shared across other folders. The deduplication engine calculates +which chunks are unique and would be deleted after the garbage collection job. ## EXAMPLES ### Example 1: Measure potential disk space on a volume -``` -PS C:\> Measure-DedupFileMetadata -Path "X:\A_Data","X:\Archive1" + +```powershell +Measure-DedupFileMetadata -Path "X:\A_Data","X:\Archive1" ``` -This command measures potential disk space that you can reclaim on all folders in the paths X:\A_Data and X:\Archive1. +This command measures potential disk space that you can reclaim on all folders in the paths +`X:\A_Data` and `X:\Archive1`. ## PARAMETERS ### -AsJob -Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. -The cmdlet immediately returns an object that represents the job and then displays the command prompt. -You can continue to work in the session while the job completes. -To manage the job, use the `*-Job` cmdlets. -To get the job results, use the [Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. +Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to +complete. + +The cmdlet immediately returns an object that represents the job and then displays the command +prompt. You can continue to work in the session while the job completes. To manage the job, use the +`*-Job` cmdlets. To get the job results, use the +[Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. -For more information about Windows PowerShell background jobs, see [about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). +For more information about Windows PowerShell background jobs, see +[about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -61,12 +68,14 @@ Accept wildcard characters: False ``` ### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a [New-CimSession](/powershell/module/cimcmdlets/new-cimsession) or [Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet. -The default is the current session on the local computer. + +Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session +object, such as the output of a [New-CimSession](/powershell/module/cimcmdlets/new-cimsession) or +[Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet. The default is the +current session on the local computer. ```yaml -Type: CimSession[] +Type: Microsoft.Management.Infrastructure.CimSession[] Parameter Sets: (All) Aliases: Session @@ -78,10 +87,11 @@ Accept wildcard characters: False ``` ### -Path + Specifies an array of paths of folders. ```yaml -Type: String[] +Type: System.String[] Parameter Sets: (All) Aliases: @@ -93,12 +103,15 @@ Accept wildcard characters: False ``` ### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -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. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. + +Specifies the maximum number of concurrent operations that can be established to run the cmdlet. 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. The throttle limit applies only to the current cmdlet, not to the session or to the +computer. ```yaml -Type: Int32 +Type: System.Int32 Parameter Sets: (All) Aliases: @@ -110,7 +123,11 @@ Accept wildcard characters: False ``` ### CommonParameters -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). + +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). ## INPUTS From f2c5f93e0141eccc830c0f24df149860775b9698 Mon Sep 17 00:00:00 2001 From: Robert Biddle Date: Tue, 2 May 2023 21:18:34 -0400 Subject: [PATCH 412/650] Style guide fixes --- .../deduplication/New-DedupSchedule.md | 303 +++++++++++------- 1 file changed, 189 insertions(+), 114 deletions(-) diff --git a/docset/winserver2022-ps/deduplication/New-DedupSchedule.md b/docset/winserver2022-ps/deduplication/New-DedupSchedule.md index a00cc1d085..e40aceecd0 100644 --- a/docset/winserver2022-ps/deduplication/New-DedupSchedule.md +++ b/docset/winserver2022-ps/deduplication/New-DedupSchedule.md @@ -16,79 +16,121 @@ Creates a data deduplication schedule. ## SYNTAX ``` -New-DedupSchedule [-Name] [-Type] [-DurationHours ] [-Disable] [-StopWhenSystemBusy] - [-Memory ] [-Cores ] [-Priority ] [-InputOutputThrottle ] - [-InputOutputThrottleLevel ] [-Start ] [-Days ] [-Full] - [-ReadOnly] [-CimSession ] [-ThrottleLimit ] [-AsJob] [] +New-DedupSchedule [-Name] [-Type] [-DurationHours ] [-Disable] + [-StopWhenSystemBusy] [-Memory ] [-Cores ] [-Priority ] + [-InputOutputThrottle ] [-InputOutputThrottleLevel ] + [-Start ] [-Days ] [-Full] [-ReadOnly] + [-CimSession ] [-ThrottleLimit ] [-AsJob] [] ``` ## DESCRIPTION -The **New-DedupSchedule** cmdlet creates a data deduplication schedule. -This cmdlet returns a **DeduplicationSchedule** object that you can use to customize the data deduplication schedule. -This cmdlet uses default settings to create a data deduplication schedule for the parameters that you do not specify. + +The `New-DedupSchedule` cmdlet creates a data deduplication schedule. This cmdlet returns a +**DeduplicationSchedule** object that you can use to customize the data deduplication schedule. This +cmdlet uses default settings to create a data deduplication schedule for the parameters that you do +not specify. You can create a schedule to run the following types data deduplication jobs: -- Optimization. -This job performs both deduplication and compression of files according data deduplication policy for the volume. -After initial optimization of a file, if that file is then modified and again meets the data deduplication policy threshold for optimization, the file is optimized again. -- GarbageCollection. -This job processes deleted or modified data on the volume so that any data chunks that are no longer referenced are cleaned up. -Garbage collection jobs process previously deleted or logically overwritten optimized content to create usable volume free space. -When an optimized file is deleted or overwritten by new data, the old data in the chunk store is not immediately deleted. -Garbage collection is scheduled to run weekly by default. Garbage collection is a processing-intensive operation, so you should allow the deletion load to reach a threshold and then manually run this job type, or schedule it for off hours. -- Scrubbing. -This job processes data corruptions it finds during data integrity validation, performs possible corruption repair, and generates a scrubbing report. -- Unoptimization. -This job undoes data deduplication on all of the optimized files on the volume. -At the end of a successful unoptimization job, the server deletes all of the data deduplication metadata from the volume. - -For more information, see [Install and Configure Data Deduplication](https://technet.microsoft.com/library/hh831434.aspx) on TechNet. +- `Optimization` This job performs both deduplication and compression of files according data + deduplication policy for the volume. After initial optimization of a file, if that file is then + modified and again meets the data deduplication policy threshold for optimization, the file is + optimized again. +- `GarbageCollection` This job processes deleted or modified data on the volume so that any data + chunks that are no longer referenced are cleaned up. Garbage collection jobs process previously + deleted or logically overwritten optimized content to create usable volume free space. When an + optimized file is deleted or overwritten by new data, the old data in the chunk store is not + immediately deleted. Garbage collection is scheduled to run weekly by default. Garbage collection + is a processing-intensive operation, so you should allow the deletion load to reach a threshold + and then manually run this job type, or schedule it for off hours. +- `Scrubbing` This job processes data corruptions it finds during data integrity validation, + performs possible corruption repair, and generates a scrubbing report. +- `Unoptimization` This job undoes data deduplication on all of the optimized files on the volume. + At the end of a successful unoptimization job, the server deletes all of the data deduplication + metadata from the volume. + +For more information, see +[Install and Configure Data Deduplication](https://technet.microsoft.com/library/hh831434.aspx) on +TechNet. ## EXAMPLES ### Example 1: Create a data deduplication schedule for a garbage collection job -``` -PS C:\> New-DedupSchedule -Name "OffHoursGC" -Type GarbageCollection -Start 08:00 -DurationHours 5 -Days Sunday -Priority Normal + +```powershell +$params = @{ + Days = Sunday + DurationHours = 5 + Name = "OffHoursGC" + Priority = Normal + Start = 08:00 + Type = GarbageCollection +} +New-DedupSchedule @params ``` -This command creates a data deduplication schedule for a garbage collection job named OffHoursGC. -The job is scheduled to run on Sundays at 8:00 at normal priority. -The command specifies that the server cancels the job after 5 hours if the process has not ended. +This command creates a data deduplication schedule with a **Name** of `OffHoursGC`. The +deduplication job **Type** is `GarbageCollection`. The job is scheduled to run every `Sunday` via +the **Days** Parameter. The job will **Start** at `08:00` and run at `Normal` **Priority**. The +command specifies **DurationHours** of `5` causing the server to cancel the job after 5 hours if the +process has not ended. ### Example 2: Create a data deduplication schedule for a scrubbing job -``` -PS C:\> New-DedupSchedule -Name "OffHoursScrub" -Type Scrubbing -Start 23:00 -StopWhenSystemBusy -DurationHours 6 -Days Monday,Tuesday,Wednesday,Thursday,Friday -Priority Normal + +```powershell +$params = @{ + Days = Monday,Tuesday,Wednesday,Thursday,Friday + DurationHours = 6 + Name = "OffHoursScrub" + Priority = Normal + Start = 23:00 + StopWhenSystemBusy = $true + Type = Scrubbing +} +New-DedupSchedule @params ``` -This command creates a data deduplication schedule for a scrubbing job named OffHoursScrub. -The command starts the scrubbing job at 23:00 on Monday through Friday at normal priority. -The **StopWhenSystemBusy** parameter specifies that the server stops the job when the system is busy and retries later. -The **DurationHours** parameter specifies that the server cancels the job after 6 hours if the process has not ended. +This command creates a data deduplication schedule for a `Scrubbing` **Type** job named +`OffHoursScrub`. The command starts the scrubbing job at `23:00` on each day Monday through Friday. +The **StopWhenSystemBusy** parameter specifies that the server stops the job when the system is busy +and retries later. The **DurationHours** parameter specifies that the server cancels the job after +`6` hours if the process has not ended. The job will run at `Normal` **Priority** ### Example 3: Create a data deduplication schedule for an optimization job -``` -PS C:\> New-DedupSchedule -Name "MyWeekdayOptimization" -Type Optimization -Days Mon,Tues,Wed,Thurs,Fri -Start 08:00 -DurationHours 9 + +```powershell +$params = @{ + Days = Mon,Tues,Wed,Thurs,Fri + DurationHours = 9 + Name = "MyWeekdayOptimization" + Start = 08:00 + Type = Optimization +} +New-DedupSchedule @params ``` -This command creates a data deduplication schedule for an optimization job named MyWeekdayOptimization. -The optimization job runs at a normal priority every weekday evening at 8:00. -The **DurationHours** parameter specifies that the server cancels the job after 9 hours if the process has not ended. +This command creates a data deduplication schedule for an `Optimization` **Type** job named +`MyWeekdayOptimization`. The optimization job runs at a normal **Priority** every weekday evening at +`08:00`. The **DurationHours** parameter specifies that the server cancels the job after `9` hours +if the process has not ended. ## PARAMETERS ### -AsJob -Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. -The cmdlet immediately returns an object that represents the job and then displays the command prompt. -You can continue to work in the session while the job completes. -To manage the job, use the `*-Job` cmdlets. -To get the job results, use the [Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. +Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to +complete. -For more information about Windows PowerShell background jobs, see [about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). +The cmdlet immediately returns an object that represents the job and then displays the command +prompt. You can continue to work in the session while the job completes. To manage the job, use the +`*-Job` cmdlets. To get the job results, use the +[Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. + +For more information about Windows PowerShell background jobs, see +[about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -100,12 +142,14 @@ Accept wildcard characters: False ``` ### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a [New-CimSession](/powershell/module/cimcmdlets/new-cimsession) or [Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet. -The default is the current session on the local computer. + +Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session +object, such as the output of a [New-CimSession](/powershell/module/cimcmdlets/new-cimsession) or +[Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet. The default is the +current session on the local computer. ```yaml -Type: CimSession[] +Type: Microsoft.Management.Infrastructure.CimSession[] Parameter Sets: (All) Aliases: Session @@ -117,10 +161,11 @@ Accept wildcard characters: False ``` ### -Cores + Specifies an array of maximum percentages of physical cores that a job uses. ```yaml -Type: UInt32 +Type: System.UInt32 Parameter Sets: (All) Aliases: MaximumCoresPercentage @@ -132,19 +177,20 @@ Accept wildcard characters: False ``` ### -Days -Specifies an array of days of the week on which the server runs the data deduplication job. -The acceptable values for this parameter are: -- Monday -- Tuesday -- Wednesday -- Thursday -- Friday -- Saturday -- Sunday +Specifies an array of days of the week on which the server runs the data deduplication job. The +acceptable values for this parameter are: + +- `Monday` +- `Tuesday` +- `Wednesday` +- `Thursday` +- `Friday` +- `Saturday` +- `Sunday` ```yaml -Type: DayOfWeek[] +Type: System.DayOfWeek[] Parameter Sets: (All) Aliases: Accepted values: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday @@ -157,12 +203,14 @@ Accept wildcard characters: False ``` ### -Disable + Indicates that the server disables the data deduplication schedule immediately after you create it. -The server does not run the data deduplication schedule at the time that you specify in the **Start** parameter. -After you disable a data deduplication schedule, you can use the **Set-DedupSchedule** cmdlet to enable the schedule. +The server does not run the data deduplication schedule at the time that you specify in the +**Start** parameter. After you disable a data deduplication schedule, you can use the +**Set-DedupSchedule** cmdlet to enable the schedule. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -174,12 +222,13 @@ Accept wildcard characters: False ``` ### -DurationHours -Specifies the number of hours that the server runs the task before canceling it. -The value 0 indicates that the server runs the job to completion. -This cmdlet safely stops a data deduplication job and does not affect the files that the server is processing when it cancels the job. + +Specifies the number of hours that the server runs the task before canceling it. The value 0 +indicates that the server runs the job to completion. This cmdlet safely stops a data deduplication +job and does not affect the files that the server is processing when it cancels the job. ```yaml -Type: UInt32 +Type: System.UInt32 Parameter Sets: (All) Aliases: @@ -191,16 +240,21 @@ Accept wildcard characters: False ``` ### -Full -Indicates that garbage collection jobs free up all deleted or unreferenced data on the volume, if you specify the value GarbageCollection for the **Type** parameter. -If you do not specify this parameter, garbage collection jobs free up space after a system threshold of delete data is exceeded. -We recommend that you run garbage collection regularly without specifying this parameter, and then once a month specify this parameter and run garbage collection again. -If you specify the value Scrubbing for the **Type** parameter, this parameter indicates that scrubbing jobs validate the integrity of all data on the volume. -If you do not specify this parameter, the scrubbing job validates only critical metadata and data integrity issues that data deduplication previously encountered. -We recommend that you run scrubbing regularly without specifying this parameter, and then once a month specify this parameter and run scrubbing again. +Indicates that garbage collection jobs free up all deleted or unreferenced data on the volume, if +you specify the value `GarbageCollection` for the **Type** parameter. If you do not specify this +parameter, garbage collection jobs free up space after a system threshold of delete data is +exceeded. We recommend that you run garbage collection regularly without specifying this parameter, +and then once a month specify this parameter and run garbage collection again. + +If you specify the value `Scrubbing` for the **Type** parameter, this parameter indicates that +scrubbing jobs validate the integrity of all data on the volume. If you do not specify this +parameter, the scrubbing job validates only critical metadata and data integrity issues that data +deduplication previously encountered. We recommend that you run scrubbing regularly without +specifying this parameter, and then once a month specify this parameter and run scrubbing again. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -212,13 +266,14 @@ Accept wildcard characters: False ``` ### -InputOutputThrottle -Specifies the amount of input/output throttling applied to the deduplication job. -Throttling ensures that deduplication does not interfere with other I/O intensive processes. -The acceptable values for this parameter are: integers from 0 to 100. -If you specify this parameter and the **InputOutputThrottleLevel** parameter, **InputOutputThrottle** takes precedence. + +Specifies the amount of input/output throttling applied to the deduplication job. Throttling ensures +that deduplication does not interfere with other I/O intensive processes. The acceptable values for +this parameter are: integers from 0 to 100. If you specify this parameter and the +**InputOutputThrottleLevel** parameter, **InputOutputThrottle** takes precedence. ```yaml -Type: UInt32 +Type: System.UInt32 Parameter Sets: (All) Aliases: @@ -230,13 +285,14 @@ Accept wildcard characters: False ``` ### -InputOutputThrottleLevel -Specifies the amount of I/O throttling that the job provides to ensure that the job does not interfere with other I/O intensive processes. -The acceptable values for this parameter are: -- None -- Low -- Medium -- High +Specifies the amount of I/O throttling that the job provides to ensure that the job does not +interfere with other I/O intensive processes. The acceptable values for this parameter are: + +- `None` +- `Low` +- `Medium` +- `High` ```yaml Type: InputOutputThrottleLevel @@ -252,13 +308,17 @@ Accept wildcard characters: False ``` ### -Memory -Specifies the maximum percentage of physical computer memory that the data deduplication job can use. -For optimization jobs, we recommend that you set a range from 15 to 50, and a higher memory consumption for jobs that you schedule to run when you specify the **StopWhenSystemBusy** parameter. -For garbage collection and scrubbing jobs, which you typically schedule to run in off hours, you can set a higher memory consumption, such as 50. +Specifies the maximum percentage of physical computer memory that the data deduplication job can +use. + +For optimization jobs, we recommend that you set a range from `15` to `50`, and a higher memory +consumption for jobs that you schedule to run when you specify the **StopWhenSystemBusy** parameter. +For garbage collection and scrubbing jobs, which you typically schedule to run in off hours, you can +set a higher memory consumption, such as `50`. ```yaml -Type: UInt32 +Type: System.UInt32 Parameter Sets: (All) Aliases: MaximumMemoryPercentage @@ -270,10 +330,11 @@ Accept wildcard characters: False ``` ### -Name + Specifies a name for the data deduplication job schedule. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -285,9 +346,11 @@ Accept wildcard characters: False ``` ### -Priority -Sets the CPU and I/O priority for the optimization job that you run by using this cmdlet. -For jobs that you run when you specify the **StopWhenSystemBusy** parameter, we recommend that you set this parameter to Low. -For typical optimization jobs, we recommend that you set this parameter to Normal. + +Sets the CPU and I/O priority for the optimization job that you run by using this cmdlet. For jobs +that you run when you specify the **StopWhenSystemBusy** parameter, we recommend that you set this +parameter to `Low`. For typical optimization jobs, we recommend that you set this parameter to +`Normal`. ```yaml Type: Priority @@ -303,10 +366,12 @@ Accept wildcard characters: False ``` ### -ReadOnly -Indicates that the scrubbing job processes and reports on corruptions that it finds but does not run any repair actions. + +Indicates that the scrubbing job processes and reports on corruptions that it finds but does not run +any repair actions. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -318,13 +383,13 @@ Accept wildcard characters: False ``` ### -Start -Specifies a time to start this job. -The default value is 1:45am. -Type the date in a format that is standard for the system locale, such as dd-MM-yyyy (German \[Germany\]) or MM/dd/yyyy (English \[United States\]). +Specifies a time to start this job. The default value is 1:45am. +Type the date in a format that is standard for the system locale, such as dd-MM-yyyy (German +\[Germany\]) or MM/dd/yyyy (English \[United States\]). ```yaml -Type: DateTime +Type: System.DateTime Parameter Sets: (All) Aliases: @@ -336,11 +401,12 @@ Accept wildcard characters: False ``` ### -StopWhenSystemBusy -Indicates that the server stops the job when the system is busy and retries later. -We recommend that you specify this parameter when you set a low priority for the job. + +Indicates that the server stops the job when the system is busy and retries later. We recommend that +you specify this parameter when you set a low priority for the job. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -352,9 +418,12 @@ Accept wildcard characters: False ``` ### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -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. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. + +Specifies the maximum number of concurrent operations that can be established to run the cmdlet. 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. The throttle limit applies only to the current cmdlet, not to the session or to the +computer. ```yaml Type: Int32 @@ -369,13 +438,13 @@ Accept wildcard characters: False ``` ### -Type -Specifies the type of data deduplication job. -The acceptable values for this parameter are: -- Optimization -- GarbageCollection -- Scrubbing -- Unoptimization +Specifies the type of data deduplication job. The acceptable values for this parameter are: + +- `Optimization` +- `GarbageCollection` +- `Scrubbing` +- `Unoptimization` ```yaml Type: Type @@ -391,7 +460,11 @@ Accept wildcard characters: False ``` ### CommonParameters -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). + +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). ## INPUTS @@ -410,8 +483,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### Microsoft.Management.Infrastructure.CimInstance -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. + +The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays +Windows Management Instrumentation (WMI) objects. The path after the pound sign (`#`) provides the +namespace and class name for the underlying WMI object. ## NOTES From a6320c29f348bf5f2c89dd5c2433ec0e1694e84a Mon Sep 17 00:00:00 2001 From: Robert Biddle Date: Tue, 2 May 2023 21:23:53 -0400 Subject: [PATCH 413/650] Style guide fixes --- .../deduplication/Remove-DedupSchedule.md | 95 ++++++++++++------- 1 file changed, 60 insertions(+), 35 deletions(-) diff --git a/docset/winserver2022-ps/deduplication/Remove-DedupSchedule.md b/docset/winserver2022-ps/deduplication/Remove-DedupSchedule.md index 0933223865..018941b5d6 100644 --- a/docset/winserver2022-ps/deduplication/Remove-DedupSchedule.md +++ b/docset/winserver2022-ps/deduplication/Remove-DedupSchedule.md @@ -16,45 +16,52 @@ Deletes a deduplication schedule. ## SYNTAX ### Query (cdxml) (Default) + ``` -Remove-DedupSchedule [-Name] [-CimSession ] [-ThrottleLimit ] [-AsJob] - [-PassThru] [] +Remove-DedupSchedule [-Name] [-CimSession ] + [-ThrottleLimit ] [-AsJob] [-PassThru] [] ``` ### InputObject (cdxml) + ``` -Remove-DedupSchedule -InputObject [-CimSession ] [-ThrottleLimit ] - [-AsJob] [-PassThru] [] +Remove-DedupSchedule -InputObject [-CimSession ] + [-ThrottleLimit ] [-AsJob] [-PassThru] [] ``` ## DESCRIPTION -The **Remove-DedupSchedule** cmdlet deletes the specified **DeduplicationSchedule** object. + +The `Remove-DedupSchedule` cmdlet deletes the specified **DeduplicationSchedule** object. To run this cmdlet, you must start Windows PowerShell® with the **Run as administrator** option. ## EXAMPLES ### Example 1: Delete a schedule -``` -PS C:\> Remove-DedupSchedule -Name "MyDailyOptimization" + +```powershell +Remove-DedupSchedule -Name "MyDailyOptimization" ``` -This command deletes the **DeduplicationJobSchedule** object named MyDailyOptimization. +This command deletes the **DeduplicationJobSchedule** object named `MyDailyOptimization`. ## PARAMETERS ### -AsJob -Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. -The cmdlet immediately returns an object that represents the job and then displays the command prompt. -You can continue to work in the session while the job completes. -To manage the job, use the `*-Job` cmdlets. -To get the job results, use the [Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. +Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to +complete. + +The cmdlet immediately returns an object that represents the job and then displays the command +prompt. You can continue to work in the session while the job completes. To manage the job, use the +`*-Job` cmdlets. To get the job results, use the +[Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. -For more information about Windows PowerShell background jobs, see [about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). +For more information about Windows PowerShell background jobs, see +[about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -66,12 +73,14 @@ Accept wildcard characters: False ``` ### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a [New-CimSession](/powershell/module/cimcmdlets/new-cimsession) or [Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet. -The default is the current session on the local computer. + +Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session +object, such as the output of a [New-CimSession](/powershell/module/cimcmdlets/new-cimsession) or +[Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet. The default is the +current session on the local computer. ```yaml -Type: CimSession[] +Type: Microsoft.Management.Infrastructure.CimSession[] Parameter Sets: (All) Aliases: Session @@ -83,11 +92,12 @@ Accept wildcard characters: False ``` ### -InputObject -Specifies the input to this cmdlet. -You can use this parameter, or you can pipe the input to this cmdlet. + +Specifies the input to this cmdlet. You can use this parameter, or you can pipe the input to this +cmdlet. ```yaml -Type: CimInstance[] +Type: Microsoft.Management.Infrastructure.CimInstance[] Parameter Sets: InputObject (cdxml) Aliases: @@ -99,10 +109,11 @@ Accept wildcard characters: False ``` ### -Name + Specifies the friendly name of one or more data deduplication job schedules to remove. ```yaml -Type: String[] +Type: System.String[] Parameter Sets: Query (cdxml) Aliases: @@ -114,10 +125,11 @@ Accept wildcard characters: False ``` ### -PassThru + Returns an object representing data deduplication settings to remove. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -129,12 +141,15 @@ Accept wildcard characters: False ``` ### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -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. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. + +Specifies the maximum number of concurrent operations that can be established to run the cmdlet. 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. The throttle limit applies only to the current cmdlet, not to the session or to the +computer. ```yaml -Type: Int32 +Type: System.Int32 Parameter Sets: (All) Aliases: @@ -146,25 +161,35 @@ Accept wildcard characters: False ``` ### CommonParameters -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). + +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). ## INPUTS ### System.String[] ### Microsoft.Management.Infrastructure.CimInstance -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. + +The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays +Windows Management Instrumentation (WMI) objects. The path after the pound sign (`#`) provides the +namespace and class name for the underlying WMI object. ## OUTPUTS ### Microsoft.Management.Infrastructure.CimInstance -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. + +The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays +Windows Management Instrumentation (WMI) objects. The path after the pound sign (`#`) provides the +namespace and class name for the underlying WMI object. ### Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Deduplication/MSFT_DedupJobSchedule -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. + +The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays +Windows Management Instrumentation (WMI) objects. The path after the pound sign (`#`) provides the +namespace and class name for the underlying WMI object. ## NOTES From 86ae6c37cc2b27c872f89cbc2eadc5ba99f95b4b Mon Sep 17 00:00:00 2001 From: "Mikey Lombardi (He/Him)" Date: Wed, 3 May 2023 11:48:25 -0500 Subject: [PATCH 414/650] Apply suggestions from review --- docset/winserver2022-ps/deduplication/Get-DedupMetadata.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docset/winserver2022-ps/deduplication/Get-DedupMetadata.md b/docset/winserver2022-ps/deduplication/Get-DedupMetadata.md index ac788ce2ef..0431005226 100644 --- a/docset/winserver2022-ps/deduplication/Get-DedupMetadata.md +++ b/docset/winserver2022-ps/deduplication/Get-DedupMetadata.md @@ -166,13 +166,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ### Microsoft.Management.Infrastructure.CimInstance -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays +The **Microsoft.Management.Infrastructure.CimInstance** object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. ### Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Deduplication/MSFT_DedupVolumeMetadata -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays +The **Microsoft.Management.Infrastructure.CimInstance** object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. From 98d3bfdced0688a133146f5d522a4acf6f0701dc Mon Sep 17 00:00:00 2001 From: "Mikey Lombardi (He/Him)" Date: Wed, 3 May 2023 11:50:06 -0500 Subject: [PATCH 415/650] Apply suggestions from review --- docset/winserver2022-ps/deduplication/Disable-DedupVolume.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docset/winserver2022-ps/deduplication/Disable-DedupVolume.md b/docset/winserver2022-ps/deduplication/Disable-DedupVolume.md index 61700fcb88..0dd2e543c2 100644 --- a/docset/winserver2022-ps/deduplication/Disable-DedupVolume.md +++ b/docset/winserver2022-ps/deduplication/Disable-DedupVolume.md @@ -151,7 +151,7 @@ Accept wildcard characters: False Specifies an array of system volumes for which to disable data deduplication. Specify one or more volume IDs, drive letters, or volume GUID paths. For drive letters, use the format `D:`. For volume -GUID paths, use the format `\\\\?\Volume{{GUID}}\`. Separate multiple volumes with a comma. +GUID paths, use the format `\\?\Volume{{GUID}}\`. Separate multiple volumes with a comma. ```yaml Type: System.String[] @@ -180,7 +180,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ### Microsoft.Management.Infrastructure.CimInstance -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays +The **Microsoft.Management.Infrastructure.CimInstance** object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. From 294a78e303626d3c865c8f8981cc2321c257fe27 Mon Sep 17 00:00:00 2001 From: "Mikey Lombardi (He/Him)" Date: Wed, 3 May 2023 11:51:23 -0500 Subject: [PATCH 416/650] Apply suggestions from review --- docset/winserver2022-ps/deduplication/Enable-DedupVolume.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docset/winserver2022-ps/deduplication/Enable-DedupVolume.md b/docset/winserver2022-ps/deduplication/Enable-DedupVolume.md index 12246640c2..cd0e307f99 100644 --- a/docset/winserver2022-ps/deduplication/Enable-DedupVolume.md +++ b/docset/winserver2022-ps/deduplication/Enable-DedupVolume.md @@ -55,7 +55,7 @@ Enable-DedupVolume -Volume "\\?\Volume{26a21bda-a627-11d7-9931-806e6f6e6963}\" ``` This command enables data deduplication for the volume that has the GUID -26a21bda-a627-11d7-9931-806e6f6e6963. +`26a21bda-a627-11d7-9931-806e6f6e6963`. ### Example 4: Resume I/O activity on a specified volume/ @@ -182,7 +182,7 @@ Accept wildcard characters: False Specifies an array of system volumes. Specify one or more volume IDs, drive letters, or volume GUID paths. For drive letters, use the format D:. For volume GUID paths, use the format -`\\\\?\Volume{{GUID}}\`. Separate multiple volumes with a comma. +`\\?\Volume{{GUID}}\`. Separate multiple volumes with a comma. ```yaml Type: System.String[] @@ -211,7 +211,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ### Microsoft.Management.Infrastructure.CimInstance -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays +The **Microsoft.Management.Infrastructure.CimInstance** object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. From aa6dfd8fb26f3bab37fd880709dd50d7a8bef2fe Mon Sep 17 00:00:00 2001 From: "Mikey Lombardi (He/Him)" Date: Wed, 3 May 2023 11:55:26 -0500 Subject: [PATCH 417/650] Apply suggestions from review --- docset/winserver2022-ps/deduplication/Get-DedupJob.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docset/winserver2022-ps/deduplication/Get-DedupJob.md b/docset/winserver2022-ps/deduplication/Get-DedupJob.md index b06d0f57c5..423bc6dd38 100644 --- a/docset/winserver2022-ps/deduplication/Get-DedupJob.md +++ b/docset/winserver2022-ps/deduplication/Get-DedupJob.md @@ -131,7 +131,7 @@ Accept wildcard characters: False Specifies one or more file system volumes for which to return **DeduplicationJob** objects. Enter one or more volume IDs, drive letters, or volume GUID paths. For drive letters, use the format `D:`. -For volume GUID paths, use the format `\\\\?\Volume{{GUID}}\`. Separate multiple volumes with a +For volume GUID paths, use the format `\\?\Volume{{GUID}}\`. Separate multiple volumes with a comma. ```yaml @@ -163,13 +163,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ### Microsoft.Management.Infrastructure.CimInstance -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays +The **Microsoft.Management.Infrastructure.CimInstance** object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. ### Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Deduplication/MSFT_DedupJob -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays +The **Microsoft.Management.Infrastructure.CimInstance** object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. From 1fd402269968f4b81afc13862c99d4a7b51f3779 Mon Sep 17 00:00:00 2001 From: "Mikey Lombardi (He/Him)" Date: Wed, 3 May 2023 11:57:10 -0500 Subject: [PATCH 418/650] Apply suggestions from review --- docset/winserver2022-ps/deduplication/Get-DedupSchedule.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docset/winserver2022-ps/deduplication/Get-DedupSchedule.md b/docset/winserver2022-ps/deduplication/Get-DedupSchedule.md index 78348f9771..ff4627705c 100644 --- a/docset/winserver2022-ps/deduplication/Get-DedupSchedule.md +++ b/docset/winserver2022-ps/deduplication/Get-DedupSchedule.md @@ -177,13 +177,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ### Microsoft.Management.Infrastructure.CimInstance -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays +The **Microsoft.Management.Infrastructure.CimInstance** object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. ### Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Deduplication/MSFT_DedupJobSchedule -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays +The **Microsoft.Management.Infrastructure.CimInstance** object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. From b9e9bcd224225c3995633c8d43d8afc2186e293e Mon Sep 17 00:00:00 2001 From: "Mikey Lombardi (He/Him)" Date: Wed, 3 May 2023 11:59:36 -0500 Subject: [PATCH 419/650] Apply suggestions from review --- docset/winserver2022-ps/deduplication/Get-DedupStatus.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docset/winserver2022-ps/deduplication/Get-DedupStatus.md b/docset/winserver2022-ps/deduplication/Get-DedupStatus.md index 0de4c9c771..50101f82cd 100644 --- a/docset/winserver2022-ps/deduplication/Get-DedupStatus.md +++ b/docset/winserver2022-ps/deduplication/Get-DedupStatus.md @@ -109,7 +109,7 @@ Accept wildcard characters: False Specifies one or more file system volumes for which to return a DeduplicationStatus object. Enter one or more volume IDs, drive letters, or volume GUID paths. For drive letters, use the format `D:`. -For volume GUID paths, use the format `\\\\?\Volume{{GUID}}\`. Separate multiple volumes with a +For volume GUID paths, use the format `\\?\Volume{{GUID}}\`. Separate multiple volumes with a comma. ```yaml @@ -139,13 +139,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ### Microsoft.Management.Infrastructure.CimInstance -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays +The **Microsoft.Management.Infrastructure.CimInstance** object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. ### Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Deduplication/MSFT_DedupVolumeStatus -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays +The **Microsoft.Management.Infrastructure.CimInstance** object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. From 3e11a96fc3631cbf956d56bcc37b41c281160e1c Mon Sep 17 00:00:00 2001 From: Robert Biddle Date: Wed, 3 May 2023 13:01:11 -0400 Subject: [PATCH 420/650] Update docset/winserver2022-ps/deduplication/Get-DedupVolume.md Co-authored-by: Mikey Lombardi (He/Him) --- docset/winserver2022-ps/deduplication/Get-DedupVolume.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/deduplication/Get-DedupVolume.md b/docset/winserver2022-ps/deduplication/Get-DedupVolume.md index bd5664fa99..b303b25171 100644 --- a/docset/winserver2022-ps/deduplication/Get-DedupVolume.md +++ b/docset/winserver2022-ps/deduplication/Get-DedupVolume.md @@ -174,7 +174,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ### Microsoft.Management.Infrastructure.CimInstance -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays +The **Microsoft.Management.Infrastructure.CimInstance** object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. From c9d8eebb58f4e48f2624ca873c347c240b205638 Mon Sep 17 00:00:00 2001 From: Robert Biddle Date: Wed, 3 May 2023 13:01:17 -0400 Subject: [PATCH 421/650] Update docset/winserver2022-ps/deduplication/Get-DedupVolume.md Co-authored-by: Mikey Lombardi (He/Him) --- docset/winserver2022-ps/deduplication/Get-DedupVolume.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/deduplication/Get-DedupVolume.md b/docset/winserver2022-ps/deduplication/Get-DedupVolume.md index b303b25171..8648f5c40a 100644 --- a/docset/winserver2022-ps/deduplication/Get-DedupVolume.md +++ b/docset/winserver2022-ps/deduplication/Get-DedupVolume.md @@ -180,7 +180,7 @@ namespace and class name for the underlying WMI object. ### Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Deduplication/MSFT_DedupVolume -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays +The **Microsoft.Management.Infrastructure.CimInstance** object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. From abc0a4f2fbc020565fc5c5939aa89a62b4c8de9f Mon Sep 17 00:00:00 2001 From: Robert Biddle Date: Wed, 3 May 2023 13:01:23 -0400 Subject: [PATCH 422/650] Update docset/winserver2022-ps/deduplication/Get-DedupVolume.md Co-authored-by: Mikey Lombardi (He/Him) --- docset/winserver2022-ps/deduplication/Get-DedupVolume.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/deduplication/Get-DedupVolume.md b/docset/winserver2022-ps/deduplication/Get-DedupVolume.md index 8648f5c40a..a598c202d5 100644 --- a/docset/winserver2022-ps/deduplication/Get-DedupVolume.md +++ b/docset/winserver2022-ps/deduplication/Get-DedupVolume.md @@ -127,7 +127,7 @@ Accept wildcard characters: False Specifies one or more file system volumes for which to return data deduplication metadata, or in the case of a cluster, volumes with data deduplication metadata currently mounted by the managed node. Enter one or more volume IDs, drive letters, or volume GUID paths. For drive letters, use the format -`D:`. For volume GUID paths, use the format `\\\\?\Volume{{GUID}}\`. Separate multiple volumes with +`D:`. For volume GUID paths, use the format `\\?\Volume{{GUID}}\`. Separate multiple volumes with a comma. ```yaml From a767c28c954151a481b5ab31c7a13912cf726013 Mon Sep 17 00:00:00 2001 From: "Mikey Lombardi (He/Him)" Date: Wed, 3 May 2023 12:15:10 -0500 Subject: [PATCH 423/650] Apply suggestions from review --- .../deduplication/New-DedupSchedule.md | 50 ++++++++++++------- 1 file changed, 31 insertions(+), 19 deletions(-) diff --git a/docset/winserver2022-ps/deduplication/New-DedupSchedule.md b/docset/winserver2022-ps/deduplication/New-DedupSchedule.md index e40aceecd0..9139c952aa 100644 --- a/docset/winserver2022-ps/deduplication/New-DedupSchedule.md +++ b/docset/winserver2022-ps/deduplication/New-DedupSchedule.md @@ -59,12 +59,12 @@ TechNet. ```powershell $params = @{ - Days = Sunday + Days = 'Sunday' DurationHours = 5 - Name = "OffHoursGC" - Priority = Normal - Start = 08:00 - Type = GarbageCollection + Name = 'OffHoursGC' + Priority = 'Normal' + Start = '08:00' + Type = 'GarbageCollection' } New-DedupSchedule @params ``` @@ -79,13 +79,19 @@ process has not ended. ```powershell $params = @{ - Days = Monday,Tuesday,Wednesday,Thursday,Friday - DurationHours = 6 - Name = "OffHoursScrub" - Priority = Normal - Start = 23:00 + Days = @( + 'Monday' + 'Tuesday' + 'Wednesday' + 'Thursday' + 'Friday' + ) + DurationHours = 6 + Name = 'OffHoursScrub' + Priority = 'Normal' + Start = '23:00' StopWhenSystemBusy = $true - Type = Scrubbing + Type = 'Scrubbing' } New-DedupSchedule @params ``` @@ -100,11 +106,17 @@ and retries later. The **DurationHours** parameter specifies that the server can ```powershell $params = @{ - Days = Mon,Tues,Wed,Thurs,Fri + Days = @( + 'Mon' + 'Tues' + 'Wed' + 'Thurs' + 'Fri' + ) DurationHours = 9 - Name = "MyWeekdayOptimization" - Start = 08:00 - Type = Optimization + Name = 'MyWeekdayOptimization' + Start = '08:00' + Type = 'Optimization' } New-DedupSchedule @params ``` @@ -223,7 +235,7 @@ Accept wildcard characters: False ### -DurationHours -Specifies the number of hours that the server runs the task before canceling it. The value 0 +Specifies the number of hours that the server runs the task before canceling it. The value `0` indicates that the server runs the job to completion. This cmdlet safely stops a data deduplication job and does not affect the files that the server is processing when it cancels the job. @@ -385,8 +397,8 @@ Accept wildcard characters: False ### -Start Specifies a time to start this job. The default value is 1:45am. -Type the date in a format that is standard for the system locale, such as dd-MM-yyyy (German -\[Germany\]) or MM/dd/yyyy (English \[United States\]). +Type the date in a format that is standard for the system locale, such as `dd-MM-yyyy` (German +\[Germany\]) or `MM/dd/yyyy` (English \[United States\]). ```yaml Type: System.DateTime @@ -484,7 +496,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ### Microsoft.Management.Infrastructure.CimInstance -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays +The **Microsoft.Management.Infrastructure.CimInstance** object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. From 12e1ce75e75bb0b0856e8cc047d15bf1f754c89c Mon Sep 17 00:00:00 2001 From: "Mikey Lombardi (He/Him)" Date: Wed, 3 May 2023 12:16:18 -0500 Subject: [PATCH 424/650] Apply suggestions from review --- .../winserver2022-ps/deduplication/Remove-DedupSchedule.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docset/winserver2022-ps/deduplication/Remove-DedupSchedule.md b/docset/winserver2022-ps/deduplication/Remove-DedupSchedule.md index 018941b5d6..149113feb5 100644 --- a/docset/winserver2022-ps/deduplication/Remove-DedupSchedule.md +++ b/docset/winserver2022-ps/deduplication/Remove-DedupSchedule.md @@ -173,7 +173,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ### Microsoft.Management.Infrastructure.CimInstance -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays +The **Microsoft.Management.Infrastructure.CimInstance** object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. @@ -181,13 +181,13 @@ namespace and class name for the underlying WMI object. ### Microsoft.Management.Infrastructure.CimInstance -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays +The **Microsoft.Management.Infrastructure.CimInstance** object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. ### Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Deduplication/MSFT_DedupJobSchedule -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays +The **Microsoft.Management.Infrastructure.CimInstance** object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. From 67b33ee7f96f3bcb3739bff02072473be9b4ea55 Mon Sep 17 00:00:00 2001 From: "Mikey Lombardi (He/Him)" Date: Wed, 3 May 2023 14:18:45 -0500 Subject: [PATCH 425/650] Apply suggestions from review --- .../Install-AdcsNetworkDeviceEnrollmentService.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docset/winserver2022-ps/adcsdeployment/Install-AdcsNetworkDeviceEnrollmentService.md b/docset/winserver2022-ps/adcsdeployment/Install-AdcsNetworkDeviceEnrollmentService.md index eb31a852d7..221e415954 100644 --- a/docset/winserver2022-ps/adcsdeployment/Install-AdcsNetworkDeviceEnrollmentService.md +++ b/docset/winserver2022-ps/adcsdeployment/Install-AdcsNetworkDeviceEnrollmentService.md @@ -69,7 +69,7 @@ This command displays the default NDES settings that will be configured if it is ```powershell $params = @{ ServiceAccountName = "CONTOSO\svcNDES" - ServiceAccountPassword = (read-host "Set user password" -assecurestring) + ServiceAccountPassword = (Read-Host "Set user password" -AsSecureString) WhatIf = $true } Install-AdcsNetworkDeviceEnrollmentService @params @@ -98,7 +98,7 @@ common name for `` and ``. ```powershell $params = @{ ServiceAccountName = "CONTOSO\svcNDES" - ServiceAccountPassword = (read-host "Set user password" -assecurestring) + ServiceAccountPassword = (Read-Host "Set user password" -AsSecureString) CAConfig = "CAComputerName\CAName" RAName = "Contoso-NDES-RA" RACountry = "US" From c37e71d34765d717a9debe26c23319ea9703c66d Mon Sep 17 00:00:00 2001 From: Phil Bossman Date: Wed, 3 May 2023 20:23:33 -0400 Subject: [PATCH 426/650] Apply suggestions from code review From Sean Co-authored-by: Sean Wheeler --- docset/winserver2022-ps/grouppolicy/Backup-GPO.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/grouppolicy/Backup-GPO.md b/docset/winserver2022-ps/grouppolicy/Backup-GPO.md index 01b69895ff..d49f190c9e 100644 --- a/docset/winserver2022-ps/grouppolicy/Backup-GPO.md +++ b/docset/winserver2022-ps/grouppolicy/Backup-GPO.md @@ -39,7 +39,7 @@ Backup-GPO -Path [-Comment ] [-Domain ] [-Server Date: Thu, 4 May 2023 08:28:13 -0500 Subject: [PATCH 427/650] Update docset/winserver2022-ps/grouppolicy/Get-GPO.md --- docset/winserver2022-ps/grouppolicy/Get-GPO.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/grouppolicy/Get-GPO.md b/docset/winserver2022-ps/grouppolicy/Get-GPO.md index 6f46dcc04f..e3a7750884 100644 --- a/docset/winserver2022-ps/grouppolicy/Get-GPO.md +++ b/docset/winserver2022-ps/grouppolicy/Get-GPO.md @@ -113,7 +113,7 @@ WmiFilter : This command gets the GPO that has the ID (GUID) `331a09564-cd4a-4520-98fa-446a2af23b4b` in the `sales.contoso.com` domain. If the domain of the user that is running the session (or, for startup and shutdown scripts, the -computer) is different that sales.contoso.com, a trust must exist between the two domains. +computer) is different than `sales.contoso.com`, a trust must exist between the two domains. The command retrieves the GPO information by contacting the PDC (in the `sales.contoso.com` domain). ### Example 3: Get all GPOs from a domain From 78e1f35819a0932cd4de9a0e70b66c08b507e823 Mon Sep 17 00:00:00 2001 From: Phil Bossman Date: Thu, 4 May 2023 22:42:07 -0400 Subject: [PATCH 428/650] Fixed formatting in multiple files - per feedback --- .../grouppolicy/Backup-GPO.md | 2 +- .../winserver2022-ps/grouppolicy/Copy-GPO.md | 20 ++++++------ .../grouppolicy/Get-GPInheritance.md | 31 ++++++------------- .../winserver2022-ps/grouppolicy/Get-GPO.md | 6 ++-- .../grouppolicy/Get-GPOReport.md | 6 ++-- .../grouppolicy/Get-GPPermission.md | 14 ++++----- .../grouppolicy/Get-GPPrefRegistryValue.md | 8 ++--- .../grouppolicy/Get-GPRegistryValue.md | 8 ++--- .../grouppolicy/Get-GPResultantSetOfPolicy.md | 2 +- .../grouppolicy/Get-GPStarterGPO.md | 10 +++--- .../grouppolicy/Import-GPO.md | 6 ++-- .../grouppolicy/Invoke-GPUpdate.md | 4 +-- .../grouppolicy/New-GPLink.md | 14 ++++----- .../winserver2022-ps/grouppolicy/New-GPO.md | 6 ++-- .../grouppolicy/New-GPStarterGPO.md | 4 +-- .../grouppolicy/Remove-GPLink.md | 6 ++-- .../grouppolicy/Remove-GPO.md | 2 +- .../grouppolicy/Remove-GPPrefRegistryValue.md | 6 ++-- .../grouppolicy/Remove-GPRegistryValue.md | 6 ++-- .../grouppolicy/Rename-GPO.md | 4 +-- .../grouppolicy/Restore-GPO.md | 4 +-- .../grouppolicy/Set-GPInheritance.md | 4 +-- .../grouppolicy/Set-GPLink.md | 2 +- .../grouppolicy/Set-GPPermission.md | 14 ++++----- .../grouppolicy/Set-GPPrefRegistryValue.md | 30 +++++++++--------- .../grouppolicy/Set-GPRegistryValue.md | 6 ++-- 26 files changed, 107 insertions(+), 118 deletions(-) diff --git a/docset/winserver2022-ps/grouppolicy/Backup-GPO.md b/docset/winserver2022-ps/grouppolicy/Backup-GPO.md index d49f190c9e..49755f4971 100644 --- a/docset/winserver2022-ps/grouppolicy/Backup-GPO.md +++ b/docset/winserver2022-ps/grouppolicy/Backup-GPO.md @@ -176,7 +176,7 @@ Accept wildcard characters: False ### -Guid Specifies the GPO to backup by its globally unique identifier (GUID). -The `GUID` uniquely identifies the GPO. +The GUID uniquely identifies the GPO. You can also refer to the **Guid** parameter by its built-in alias, **Id**. For more information, see [about_Aliases](/powershell/module/microsoft.powershell.core/about/about_aliases). diff --git a/docset/winserver2022-ps/grouppolicy/Copy-GPO.md b/docset/winserver2022-ps/grouppolicy/Copy-GPO.md index 42d3a98e82..b0d18ffe84 100644 --- a/docset/winserver2022-ps/grouppolicy/Copy-GPO.md +++ b/docset/winserver2022-ps/grouppolicy/Copy-GPO.md @@ -5,7 +5,7 @@ Module Name: GroupPolicy ms.date: 12/20/2016 online version: https://learn.microsoft.com/powershell/module/grouppolicy/copy-gpo?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 -title: Copy-GPO +title: `Copy-GPO` --- # Copy-GPO @@ -34,7 +34,7 @@ Copy-GPO [-SourceName] -TargetName [-SourceDomain ] ## DESCRIPTION -The **Copy-GPO** cmdlet creates a destination Group Policy Object (GPO) and copies the settings from +The `Copy-GPO` cmdlet creates a destination Group Policy Object (GPO) and copies the settings from the source GPO to the new GPO. The cmdlet can be used to copy a GPO from one domain to another domain within the same forest. You can specify a migration table to map security principals and paths when copying across domains. You can also specify whether to copy the access control list @@ -103,9 +103,9 @@ Get-GPO -All -Domain "sales1.contoso.com" | ForEach-Object { This command copies all the GPOs in the `sales1.contoso.com` domain to the `sales2.contoso.com` domain. -All the GPOs in the source domain are retrieved by using the **Get-GPO** cmdlet using the **All** -parameter. The output of **Get-GPO** is piped into the ForEach-Object command. When each GPO is -evaluated, it is piped into **Copy-GPO** and its display name is specified for the **TargetName** +All the GPOs in the source domain are retrieved by using the `Get-GPO` cmdlet using the **All** +parameter. The output of `Get-GPO` is piped into the `ForEach-Object` command. When each GPO is +evaluated, it is piped into `Copy-GPO` and its display name is specified for the **TargetName** parameter `-TargetName ($_.DisplayName)`. The **CopyACL** parameter is specified to copy the ACLs for each GPO to the destination domain. The **MigrationTable** parameter specifies a migration table to use to migrate Security principals and UNC paths to the destination domain. Both the **CopyACL** @@ -116,12 +116,12 @@ error occurs when this command attempts to copy the source GPO. Because this com in the source domain, errors occur for default GPOs; for instance, the Default Domain Policy GPO and the Default Domain Controllers Policy GPO. These GPOs are not copied. You can suppress these error messages by supplying the **ErrorAction** parameter with a value of SilentlyContinue to -**Copy-GPO**. For more information about the **ErrorAction** parameter, see +`Copy-GPO`. For more information about the **ErrorAction** parameter, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). The destination GPOs that were successfully copied are returned by this command. By default, they are printed to the display, but you can add commands to the end of the pipeline to further configure -these GPOs. For example you can add a Set-GPLink cmdlet to the end of the pipeline to link all the +these GPOs. For example you can add a `Set-GPLink` cmdlet to the end of the pipeline to link all the destination GPOs to a site, domain, or organizational unit. A trust relationship must exist between the source domain and the destination domain. In addition, @@ -233,10 +233,10 @@ Accept wildcard characters: False ### -SourceGuid -Specifies the source GPO by its globally unique identifier `GUID`. The `GUID` uniquely identifies +Specifies the source GPO by its globally unique identifier GUID. The GUID uniquely identifies the GPO. -You can also refer to the **SourceGuid** parameter by its built-in alias, `Id`. +You can also refer to the **SourceGuid** parameter by its built-in alias, **Id**. ```yaml Type: System.Management.Automation.Guid @@ -374,7 +374,7 @@ This cmdlet outputs a copy of the specified GPO. ## NOTES -* You can use the **Copy-GPO** cmdlet to copy a GPO within a domain or from one domain to another +* You can use the `Copy-GPO` cmdlet to copy a GPO within a domain or from one domain to another within the same forest. You can use the **SourceDomain** and **TargetDomain** parameters to explicitly specify the source diff --git a/docset/winserver2022-ps/grouppolicy/Get-GPInheritance.md b/docset/winserver2022-ps/grouppolicy/Get-GPInheritance.md index db3742168a..456d72a7ab 100644 --- a/docset/winserver2022-ps/grouppolicy/Get-GPInheritance.md +++ b/docset/winserver2022-ps/grouppolicy/Get-GPInheritance.md @@ -22,12 +22,12 @@ Get-GPInheritance [-Target] [-Domain ] [-Server ] [] [[-Server] ] [-All] [] ## DESCRIPTION -The **Get-GPO** cmdlet gets one Group Policy Object (GPO) or all the GPOs in a domain. You can +The `Get-GPO` cmdlet gets one Group Policy Object (GPO) or all the GPOs in a domain. You can specify a GPO by its display name or by its globally unique identifier (GUID) to get a single GPO, or you can get all the GPOs in the domain through the **All** parameter. This cmdlet returns one or more objects that represent the requested GPOs. By default, properties of the requested GPOs are printed to the display; however, you can also pipe the output of the -**Get-GPO** cmdlet to other Group Policy cmdlets. +`Get-GPO` cmdlet to other Group Policy cmdlets. ## EXAMPLES @@ -127,7 +127,7 @@ Accept wildcard characters: False Specifies the domain for this cmdlet. You must specify the fully qualified domain name (FQDN) of the domain. -For the **Get-GPO** cmdlet, the GPO (or GPOs) to that this cmdlet gets must exist in this domain. +For the `Get-GPO` cmdlet, the GPO (or GPOs) to that this cmdlet gets must exist in this domain. If you do not specify the **Domain** parameter, the domain of the user that is running the current session is used. If the cmdlet is being run from a computer startup or shutdown script, the domain diff --git a/docset/winserver2022-ps/grouppolicy/Get-GPOReport.md b/docset/winserver2022-ps/grouppolicy/Get-GPOReport.md index ffa04373b1..de92d3de4e 100644 --- a/docset/winserver2022-ps/grouppolicy/Get-GPOReport.md +++ b/docset/winserver2022-ps/grouppolicy/Get-GPOReport.md @@ -39,7 +39,7 @@ Get-GPOReport [-ReportType] [[-Path] ] [[-Domain] ] ## DESCRIPTION -The **Get-GPOReport** cmdlet generates a report in either XML or HTML format that describes +The `Get-GPOReport` cmdlet generates a report in either XML or HTML format that describes properties and policy settings for a specified Group Policy Object (GPO) or for all GPOs in a domain. The information that is reported for each GPO includes: details, links, security filtering, Windows Management Instrumentation (WMI) filtering, delegation, and computer and user @@ -86,7 +86,7 @@ different from `sales.contoso2.com`, a trust must exist between the two domains. Get-GPOReport -GUID 73624cc9-e8f2-4f05-8802-193fae8773ce -ReportType XML ``` -This command generates a report in XML format for the GPO with the specified `GUID`. +This command generates a report in XML format for the GPO with the specified GUID. Because no **Path** parameter is supplied, the report is written to the display. ## PARAMETERS @@ -112,7 +112,7 @@ Accept wildcard characters: False Specifies the domain for this cmdlet. You must specify the fully qualified domain name (FQDN) of the domain. -For the **Get-GPOReport** cmdlet: +For the `Get-GPOReport` cmdlet: - If a single GPO is specified, it must exist in this domain. diff --git a/docset/winserver2022-ps/grouppolicy/Get-GPPermission.md b/docset/winserver2022-ps/grouppolicy/Get-GPPermission.md index 06ce250dd9..d09cc198ea 100644 --- a/docset/winserver2022-ps/grouppolicy/Get-GPPermission.md +++ b/docset/winserver2022-ps/grouppolicy/Get-GPPermission.md @@ -32,7 +32,7 @@ Get-GPPermission [-Name] [-TargetName ] [-TargetType -Context -Key -Key [-ValueName ] [-Domai ## DESCRIPTION -The **Get-GPRegistryValue** cmdlet retrieves one or more registry-based policy settings under either +The `Get-GPRegistryValue` cmdlet retrieves one or more registry-based policy settings under either Computer Configuration or User Configuration in a Group Policy Object (GPO). You can get registry-based policy settings for a specific registry value, or for all the registry @@ -131,7 +131,7 @@ to Delete). Specifies the domain for this cmdlet. You must specify the fully qualified domain name (FQDN) of the domain (for instance: sales.contoso.com). -For the **Get-GPRegistryValue** cmdlet, the GPO for which to get registry-based policy settings must +For the `Get-GPRegistryValue` cmdlet, the GPO for which to get registry-based policy settings must exist in this domain. If you do not specify the **Domain** parameter, the domain of the user that is running the current @@ -296,9 +296,9 @@ contain GPOs from different domains are not supported. This cmdlet returns **PolicyRegistrySetting** objects that represent registry-based policy settings. These objects can be piped into the following cmdlets: -- Set-GPRegistryValue +- `Set-GPRegistryValue` -- Remove-GPRegistryValue +- `Remove-GPRegistryValue` ## NOTES diff --git a/docset/winserver2022-ps/grouppolicy/Get-GPResultantSetOfPolicy.md b/docset/winserver2022-ps/grouppolicy/Get-GPResultantSetOfPolicy.md index ef249a6efb..a55135575c 100644 --- a/docset/winserver2022-ps/grouppolicy/Get-GPResultantSetOfPolicy.md +++ b/docset/winserver2022-ps/grouppolicy/Get-GPResultantSetOfPolicy.md @@ -23,7 +23,7 @@ Get-GPResultantSetOfPolicy [-Computer ] [-User ] -ReportType ] [-Server ] [-All] [ -Path [-TargetGuid ] [-TargetN ## DESCRIPTION -The **Import-GPO** cmdlet imports the settings from a Group Policy Object (GPO) backup into a +The `Import-GPO` cmdlet imports the settings from a Group Policy Object (GPO) backup into a specified target GPO. The target GPO can be in a different domain or forest than the backup that was made and it does not have to exist prior to the operation. @@ -226,7 +226,7 @@ Accept wildcard characters: False Specifies the domain for this cmdlet. You must specify the fully qualified domain name (FQDN) of the domain. -For the **Import-GPO** cmdlet, this is the domain into which you want to import the GPO. +For the `Import-GPO` cmdlet, this is the domain into which you want to import the GPO. If you do not specify the **Domain** parameter, the domain of the user that is running the current session is used. If the cmdlet is being run from a computer startup or shutdown script, the domain @@ -385,7 +385,7 @@ This cmdlet returns an object that represents the GPO after the settings have be ## NOTES -* You can use the **Import-GPO** to copy settings from a GPO backup in one domain to the same domain +* You can use the `Import-GPO` to copy settings from a GPO backup in one domain to the same domain or another domain in the same or different forest. You can use the **Domain** parameter to explicitly specify the domain for this cmdlet. diff --git a/docset/winserver2022-ps/grouppolicy/Invoke-GPUpdate.md b/docset/winserver2022-ps/grouppolicy/Invoke-GPUpdate.md index 0feff10fa2..cbc8dc9d6d 100644 --- a/docset/winserver2022-ps/grouppolicy/Invoke-GPUpdate.md +++ b/docset/winserver2022-ps/grouppolicy/Invoke-GPUpdate.md @@ -32,7 +32,7 @@ Invoke-GPUpdate [-AsJob] [-Boot] [[-Computer] ] [[-RandomDelayInMinutes] ## DESCRIPTION -The **Invoke-GPUpdate** cmdlet refreshes Group Policy settings, including security settings that are +The `Invoke-GPUpdate` cmdlet refreshes Group Policy settings, including security settings that are set on remote computers by scheduling the running of the Gpupdate command on a remote computer. You can combine this cmdlet in a scripted fashion to schedule the Gpupdate command on a group of computers. @@ -50,7 +50,7 @@ Invoke-GPUpdate ``` This command schedules a Group Policy refresh on the computer on which you are running the -**Invoke-GPUpdate** cmdlet. +`Invoke-GPUpdate` cmdlet. ### Example 2: Schedule a Group Policy refresh on a remote computer diff --git a/docset/winserver2022-ps/grouppolicy/New-GPLink.md b/docset/winserver2022-ps/grouppolicy/New-GPLink.md index d754244bee..007c9b5649 100644 --- a/docset/winserver2022-ps/grouppolicy/New-GPLink.md +++ b/docset/winserver2022-ps/grouppolicy/New-GPLink.md @@ -5,7 +5,7 @@ Module Name: GroupPolicy ms.date: 12/20/2016 online version: https://learn.microsoft.com/powershell/module/grouppolicy/new-gplink?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 -title: New-GPLink +title: `New-GPLink` --- # New-GPLink @@ -34,7 +34,7 @@ New-GPLink [-Name] -Target [-LinkEnabled ] [-Order ## DESCRIPTION -The **New-GPLink** cmdlet links a GPO to a site, domain, or organizational unit (OU). By default, +The `New-GPLink` cmdlet links a GPO to a site, domain, or organizational unit (OU). By default, the link is enabled, which means that the settings of the GPO are applied at the level of the target Active Directory container according to the rules of inheritance and precedence when Group Policy is processed. @@ -68,9 +68,9 @@ the domain of the user, or the computer, is different than `contoso.com`, a trus exist between the two domains. Because this command can take a GPO as input, you can insert any command that returns a GPO between -New-GPO and **New-GPLink** to configure the GPO. For instance, you can insert **Set-GPPermissions** -commands to set permissions on the GPO, Set-GPRegistryValue cmdlet to configure one or more -registry-based policy settings for the GPO, or the **Set-GPPrefRegistryValue** cmdlet to configure +`New-GPO` and `New-GPLink` to configure the GPO. For instance, you can insert `Set-GPPermissions` +commands to set permissions on the GPO, `Set-GPRegistryValue` cmdlet to configure one or more +registry-based policy settings for the GPO, or the `Set-GPPrefRegistryValue` cmdlet to configure one or more Registry preference items for the GPO. ### Example 2: Link a GPO in the domain of the user @@ -132,7 +132,7 @@ Accept wildcard characters: False Specifies the domain for this cmdlet. You must specify the fully qualified domain name (FQDN) of the domain. -For the **New-GPLink** cmdlet: +For the `New-GPLink` cmdlet: - The GPO to link from must exist in this domain. @@ -273,7 +273,7 @@ precedence. By default, the GPO link is added at the lowest precedence with a link order equal to the number of GPO links to the container, plus one. Link order is a dynamic value because the value may change as GPO links are added and deleted from the container. You can change the link order of a GPO link with -the **Set-GPLink** cmdlet. +the `Set-GPLink` cmdlet. ```yaml Type: Int32 diff --git a/docset/winserver2022-ps/grouppolicy/New-GPO.md b/docset/winserver2022-ps/grouppolicy/New-GPO.md index ac2a6b7df8..c638290bc2 100644 --- a/docset/winserver2022-ps/grouppolicy/New-GPO.md +++ b/docset/winserver2022-ps/grouppolicy/New-GPO.md @@ -39,7 +39,7 @@ New-GPO [-Name] -StarterGpoName [-Comment ] [-Domain < ## DESCRIPTION -The **New-GPO** cmdlet creates a GPO with a specified name. By default, the newly created GPO is not +The `New-GPO` cmdlet creates a GPO with a specified name. By default, the newly created GPO is not linked to a site, domain, or organizational unit (OU). You can use this cmdlet to create a GPO that is based on a starter GPO by specifying the GUID or the @@ -107,7 +107,7 @@ domain, and grants the `Marketing Admins` security group permissions to edit the A GPO object is returned by the command, so you could continue to configure the new GPO by piping the output to other cmdlets. For example, you could set Registry preference items or registry-based -policy settings by piping the output to **Set-GPPrefRegistryValue** or to **Set-GPRegistryValue**. +policy settings by piping the output to `Set-GPPrefRegistryValue` or to `Set-GPRegistryValue`. ## PARAMETERS @@ -152,7 +152,7 @@ Accept wildcard characters: False Specifies the domain for this cmdlet. You must specify the fully qualified domain name (FQDN) of the domain. -For the **New-GPO** cmdlet: +For the `New-GPO` cmdlet: - The new GPO is created in this domain. diff --git a/docset/winserver2022-ps/grouppolicy/New-GPStarterGPO.md b/docset/winserver2022-ps/grouppolicy/New-GPStarterGPO.md index deef30533a..e09bbaf359 100644 --- a/docset/winserver2022-ps/grouppolicy/New-GPStarterGPO.md +++ b/docset/winserver2022-ps/grouppolicy/New-GPStarterGPO.md @@ -23,8 +23,8 @@ New-GPStarterGPO [-Name] [-Comment ] [-Domain ] [-Serve ## DESCRIPTION -The **New-GPStarterGPO** cmdlet creates a Starter GPO with the specified name. If the Starter GPOs -folder does not exist in the SYSVOL when the **New-GPStarterGPO** cmdlet is called, it is created +The `New-GPStarterGPO` cmdlet creates a Starter GPO with the specified name. If the Starter GPOs +folder does not exist in the SYSVOL when the `New-GPStarterGPO` cmdlet is called, it is created and populated with the eight Starter GPOs that ship with Group Policy. ## EXAMPLES diff --git a/docset/winserver2022-ps/grouppolicy/Remove-GPLink.md b/docset/winserver2022-ps/grouppolicy/Remove-GPLink.md index 5b382d1361..d272a260e0 100644 --- a/docset/winserver2022-ps/grouppolicy/Remove-GPLink.md +++ b/docset/winserver2022-ps/grouppolicy/Remove-GPLink.md @@ -32,7 +32,7 @@ Remove-GPLink [-Name] -Target [-Domain ] [-Server [-Domain ] [-Server ] [-KeepLinks] [ ## DESCRIPTION -The **Remove-GPO** cmdlet removes the Group Policy Object (GPO) container and data from the +The `Remove-GPO` cmdlet removes the Group Policy Object (GPO) container and data from the directory service and the system volume folder (SysVol). ## EXAMPLES diff --git a/docset/winserver2022-ps/grouppolicy/Remove-GPPrefRegistryValue.md b/docset/winserver2022-ps/grouppolicy/Remove-GPPrefRegistryValue.md index c183f6d5bb..080eb47dd1 100644 --- a/docset/winserver2022-ps/grouppolicy/Remove-GPPrefRegistryValue.md +++ b/docset/winserver2022-ps/grouppolicy/Remove-GPPrefRegistryValue.md @@ -35,7 +35,7 @@ Remove-GPPrefRegistryValue [-Name] -Context -Key [-Key] [[-ValueName] ] ## DESCRIPTION -The **Remove-GPRegistryValue** cmdlet removes one or more registry-based policy settings from either +The `Remove-GPRegistryValue` cmdlet removes one or more registry-based policy settings from either Computer Configuration or User Configuration in a Group Policy Object (GPO). You can specify the GPO by its display name or by its GUID. @@ -86,7 +86,7 @@ This command removes the registry-based policy setting for the registry value the GPO named `TestGPO`. The registry value is no longer modified when the GPO is applied on a client. Removing a policy setting does not delete the registry value on a client. To delete the registry value when the GPO is applied on a client, you must disable the policy setting by using the -**Set-GPRegistryValue** cmdlet. +`Set-GPRegistryValue` cmdlet. ### Example 2: Remove all the registry-based policy settings under the specified registry key @@ -123,7 +123,7 @@ Accept wildcard characters: False Specifies the domain for this cmdlet. You must specify the fully qualified domain name (FQDN) of the domain. -For the **Remove-GPRegistryValue** cmdlet, the GPO from which to remove the registry-based policy setting must exist in this domain. +For the `Remove-GPRegistryValue` cmdlet, the GPO from which to remove the registry-based policy setting must exist in this domain. If you do not specify the **Domain** parameter, the domain of the user that is running the current session is used. If the cmdlet is being run from a computer startup or shutdown script, the domain diff --git a/docset/winserver2022-ps/grouppolicy/Rename-GPO.md b/docset/winserver2022-ps/grouppolicy/Rename-GPO.md index 5f5e1c7103..6483380d6e 100644 --- a/docset/winserver2022-ps/grouppolicy/Rename-GPO.md +++ b/docset/winserver2022-ps/grouppolicy/Rename-GPO.md @@ -32,7 +32,7 @@ Rename-GPO [-Name] -TargetName [-Domain ] [-Server [-Domain ] [-Server ] [-All] [-WhatIf ## DESCRIPTION -The **Restore-GPO** cmdlet restores a Group Policy Object (GPO) backup to the original domain from +The `Restore-GPO` cmdlet restores a Group Policy Object (GPO) backup to the original domain from which it was saved. If the original domain is not available, or if the GPO no longer exists in the domain, the cmdlet fails. @@ -162,7 +162,7 @@ Accept wildcard characters: False Specifies the domain for this cmdlet. You must specify the fully qualified domain name (FQDN) of the domain. -For the **Restore-GPO** cmdlet, this is the domain in which you want to restore the GPO. This must +For the `Restore-GPO` cmdlet, this is the domain in which you want to restore the GPO. This must be the domain from which the GPO was backed up. If you do not specify the **Domain** parameter, the domain of the user that is running the current diff --git a/docset/winserver2022-ps/grouppolicy/Set-GPInheritance.md b/docset/winserver2022-ps/grouppolicy/Set-GPInheritance.md index 71b6efa52d..10d8384b69 100644 --- a/docset/winserver2022-ps/grouppolicy/Set-GPInheritance.md +++ b/docset/winserver2022-ps/grouppolicy/Set-GPInheritance.md @@ -23,7 +23,7 @@ Set-GPInheritance [-Target] -IsBlocked [-Domain -TargetName ## DESCRIPTION -The **Set-GPPermission** cmdlet grants a level of permissions to a security principal (user, +The `Set-GPPermission` cmdlet grants a level of permissions to a security principal (user, security group, or computer) for one Group Policy Object (GPO) or all the GPOs in a domain. You use the **TargetName** and **TargetType** parameters to specify a user, security group, or computer for which to set the permission level. You can use the *Name* or the **Guid** parameter to set the @@ -138,12 +138,12 @@ GpoApply for all GPOs on which the `Group` has permissions. The command returns the new permission level is set. The cmdlet is used to get all the GPOs in the domain. Then, the collection is piped into the -**ForEach-Object** command. As each GPO is evaluated, it is piped into **Get-GPPermission**. If a +`ForEach-Object` command. As each GPO is evaluated, it is piped into `Get-GPPermission`. If a permission level for the Marketing Admins group is returned, the GPO is piped into -**Set-GPPermission** to set the permission level for the group. The **Replace** parameter is +`Set-GPPermission` to set the permission level for the group. The **Replace** parameter is specified to make sure that the previous permission level is overwritten. -The **ErrorAction** parameter is set to `SilentlyContinue` for **Get-GPPermissions**. This is +The **ErrorAction** parameter is set to `SilentlyContinue` for `Get-GPPermissions`. This is because a non-terminating error occurs if the specified security principal does not have permissions on the GPO. Specifying **ErrorAction** as `SilentlyContinue` prevents the error messages from being printed for GPOs on which the security principal does not have permissions. For more information @@ -189,7 +189,7 @@ Accept wildcard characters: False Specifies the domain for this cmdlet. You must specify the fully qualified domain name (FQDN) of the domain. -For the **Set-GPPermission** cmdlet, the GPO for which to get the permission level must exist in +For the `Set-GPPermission` cmdlet, the GPO for which to get the permission level must exist in this domain. If you do not specify the **DomainName** parameter, the domain of the user that is running the @@ -330,11 +330,11 @@ principal (domain\account) or just its name. For instance, in the `contoso.com` domain, to specify: -- The user `SomeUser`, use `contoso\SomeUser` or `SomeUser`. +- The user SomeUser, use `contoso\SomeUser` or `SomeUser`. - The Domain Admins security group, use `contoso\Domain Admins` or `Domain Admins`. -- The computer `computer-01`, use `contoso\computer-01` or `computer-01`. +- The computer computer-01, use `contoso\computer-01` or `computer-01`. ```yaml Type: System.String diff --git a/docset/winserver2022-ps/grouppolicy/Set-GPPrefRegistryValue.md b/docset/winserver2022-ps/grouppolicy/Set-GPPrefRegistryValue.md index 33bc36bf35..3506012a42 100644 --- a/docset/winserver2022-ps/grouppolicy/Set-GPPrefRegistryValue.md +++ b/docset/winserver2022-ps/grouppolicy/Set-GPPrefRegistryValue.md @@ -162,15 +162,15 @@ Remove-GPPrefRegistryValue @removeGPPrefParams | This command creates a disabled Registry preference item for the registry value `HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\ExampleKey ValueOne` in `User` Configuration in the GPO named -`TestGPO`. The **Remove-GPPrefRegistryValue** command removes any Registry preference items that +`TestGPO`. The `Remove-GPPrefRegistryValue` command removes any Registry preference items that configure the value from User Configuration. Then, the GPO named `TestGPO` returned by the -**Remove-GPPrefRegistryValue** is piped into **Set-GPPrefRegistryValue** to configure the `disabled` +`Remove-GPPrefRegistryValue` is piped into `Set-GPPrefRegistryValue` to configure the `disabled` Registry preference item. After this command completes, the `disabled` Registry preference item is the only Registry preference item associated with the registry value in User Configuration. If `TestGPO` does not initially have a Registry preference item configured for the specified registry value, a non-terminating error occurs. You can suppress the error message by supplying the -**ErrorAction** parameter to **Remove-GPPrefRegistryValue** and setting its value to +**ErrorAction** parameter to `Remove-GPPrefRegistryValue` and setting its value to SilentlyContinue. For more information about the **ErrorAction** parameter, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). @@ -200,13 +200,13 @@ This command configures a Registry preference item to update the registry value previously had a Registry preference item configured for that value in User Configuration. The command is invoked with the **All** parameter to get all the GPOs in the domain. These GPOs are -piped into the **Remove-GPPrefRegistryValue** cmdlet. If the GPO contains any Registry preference -items configured for the specified key, they are removed. **Remove-GPPrefRegistryValue** only +piped into the `Remove-GPPrefRegistryValue` cmdlet. If the GPO contains any Registry preference +items configured for the specified key, they are removed. `Remove-GPPrefRegistryValue` only outputs a GPO to the pipeline if it removes a Registry preference item from a GPO. Finally, these -GPOs are piped to the **Set-GPPrefRegistryValue** to configure the Registry preference item to +GPOs are piped to the `Set-GPPrefRegistryValue` to configure the Registry preference item to update the registry value. -If a GPO passed to **Remove-GPPrefRegistryValue** does not have a Registry preference item +If a GPO passed to `Remove-GPPrefRegistryValue` does not have a Registry preference item configured for the specified value, a non-terminating error occurs. The **ErrorAction** parameter is set to `SilentlyContinue` to suppress the error message. @@ -259,25 +259,25 @@ registry key `HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\ExampleKey` from `User` Conf source GPO named `TestGPO` to Computer Configuration in destination GPO named `TestGPO-1`. A copy of the destination GPO `TestGPO-1` is returned for each Registration preference item set. -The **Get-GPPrefRegistryValue** command gets all the Registry preference items that configure values +The `Get-GPPrefRegistryValue` command gets all the Registry preference items that configure values under User Configuration in the source GPO. This command also returns all first level subkeys that have values configured (though not the Registry preference items for the values themselves). These -Registry preference items and the subkeys are then piped into the **Set-GPPrefRegistryValue** +Registry preference items and the subkeys are then piped into the `Set-GPPrefRegistryValue` cmdlet. -The **Set-GPPrefRegistryValue** command configures the Registry preference items for the registry +The `Set-GPPrefRegistryValue` command configures the Registry preference items for the registry values in the destination GPO. -- The subkeys returned by **Get-GPPrefRegistryValue** do not have an **Action** property, and so a +- The subkeys returned by `Get-GPPrefRegistryValue` do not have an **Action** property, and so a non-terminating error occurs for each subkey. The **ErrorAction** parameter is specified to suppress these error messages. -- It is a good practice to specify an order of one `-Order 1` in **Set-GPPrefRegistryValue** when it +- It is a good practice to specify an order of one `-Order 1` in `Set-GPPrefRegistryValue` when it accepts input from the pipeline. This is because Registry preference items passed on the pipeline have an **Order** property. If the **Order** property of a Registry preference item passed on the pipeline is greater than the number of Registry preference items currently configured in the destination GPO, an out of range error occurs and the Registry preference item is not configured - in the destination GPO. By specifying the order as one in the **Set-GPPrefRegistryValue** command, + in the destination GPO. By specifying the order as one in the `Set-GPPrefRegistryValue` command, you override the **Order** property of the source Registry preference item, and prevent such errors from occurring. @@ -355,7 +355,7 @@ a new Registry preference item that is disabled. Any existing Registry preferenc configure the same key or value will still be applied when the GPO is processed on a client. This behavior is different than disabling an existing Registry preference item using the GPMC. -You can use the **Remove-GPPrefRegistryValue** cmdlet to remove any existing Registry preference +You can use the `Remove-GPPrefRegistryValue` cmdlet to remove any existing Registry preference items associated with the specified key or value from the appropriate configuration (User or Computer) in the GPO before you create the new disabled Registry preference item. This ensures that after you create the disabled Registry preference item, it will be the only Registry preference item @@ -378,7 +378,7 @@ Accept wildcard characters: False Specifies the domain for this cmdlet. You must specify the fully qualified domain name (FQDN) of the domain. -For the **Set-GPPrefRegistryValue** cmdlet, the GPO for which to configure the Registry preference +For the `Set-GPPrefRegistryValue` cmdlet, the GPO for which to configure the Registry preference item must exist in this domain. If you do not specify the **Domain** parameter, the domain of the user that is running the current diff --git a/docset/winserver2022-ps/grouppolicy/Set-GPRegistryValue.md b/docset/winserver2022-ps/grouppolicy/Set-GPRegistryValue.md index 2eaacfbd21..2bdd2db565 100644 --- a/docset/winserver2022-ps/grouppolicy/Set-GPRegistryValue.md +++ b/docset/winserver2022-ps/grouppolicy/Set-GPRegistryValue.md @@ -34,7 +34,7 @@ Set-GPRegistryValue [-Name] -Key [-ValueName ] [-Val ## DESCRIPTION -The **Set-GPRegistryValue** cmdlet configures a registry-based policy setting under either Computer +The `Set-GPRegistryValue` cmdlet configures a registry-based policy setting under either Computer Configuration or User Configuration in a Group Policy Object (GPO). The policy setting configures keys or values in the registry on the client computer when the GPO is applied. @@ -235,7 +235,7 @@ You can disable a policy setting for a registry key or value: When the GPO is applied on the client, only the specified value is removed from the registry. To remove a policy setting from a GPO without affecting existing registry keys or values on a client -when Group Policy is processed, use the **Remove-GPRegistryValue** cmdlet. +when Group Policy is processed, use the `Remove-GPRegistryValue` cmdlet. You cannot specify the **Additive**, **Type**, **Value**, or **ValuePrefix** parameters with the **Disable** parameter. @@ -257,7 +257,7 @@ Accept wildcard characters: False Specifies the domain for this cmdlet. You must specify the fully qualified domain name (FQDN) of the domain. -For the **Set-GPRegistryValue** cmdlet, the GPO in which to configure the registry-based policy +For the `Set-GPRegistryValue` cmdlet, the GPO in which to configure the registry-based policy setting must exist in this domain. If you do not specify the **Domain** parameter, the domain of the user that is running the current From b62c0fa6f8919d97447ca960c33faee914c403bd Mon Sep 17 00:00:00 2001 From: Phil Bossman Date: Thu, 4 May 2023 22:46:56 -0400 Subject: [PATCH 429/650] Fixed Copy-GPO.md title --- docset/winserver2022-ps/grouppolicy/Copy-GPO.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/grouppolicy/Copy-GPO.md b/docset/winserver2022-ps/grouppolicy/Copy-GPO.md index b0d18ffe84..6cf5569773 100644 --- a/docset/winserver2022-ps/grouppolicy/Copy-GPO.md +++ b/docset/winserver2022-ps/grouppolicy/Copy-GPO.md @@ -5,7 +5,7 @@ Module Name: GroupPolicy ms.date: 12/20/2016 online version: https://learn.microsoft.com/powershell/module/grouppolicy/copy-gpo?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 -title: `Copy-GPO` +title: Copy-GPO --- # Copy-GPO From 358b8a8409a9c7ccff9ef2e3db4daed003d1b9bc Mon Sep 17 00:00:00 2001 From: Sean Wheeler Date: Fri, 5 May 2023 08:25:12 -0500 Subject: [PATCH 430/650] Update docset/winserver2022-ps/grouppolicy/New-GPLink.md --- docset/winserver2022-ps/grouppolicy/New-GPLink.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/grouppolicy/New-GPLink.md b/docset/winserver2022-ps/grouppolicy/New-GPLink.md index 007c9b5649..75c24299cf 100644 --- a/docset/winserver2022-ps/grouppolicy/New-GPLink.md +++ b/docset/winserver2022-ps/grouppolicy/New-GPLink.md @@ -5,7 +5,7 @@ Module Name: GroupPolicy ms.date: 12/20/2016 online version: https://learn.microsoft.com/powershell/module/grouppolicy/new-gplink?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 -title: `New-GPLink` +title: New-GPLink --- # New-GPLink From b513304d562eb5f213ab0ffc96069179bbf8fd9d Mon Sep 17 00:00:00 2001 From: Sean Wheeler Date: Fri, 5 May 2023 09:28:23 -0500 Subject: [PATCH 431/650] Fix build error --- .../grouppolicy/Get-GPPermission.md | 151 +++++++++--------- 1 file changed, 72 insertions(+), 79 deletions(-) diff --git a/docset/winserver2022-ps/grouppolicy/Get-GPPermission.md b/docset/winserver2022-ps/grouppolicy/Get-GPPermission.md index d09cc198ea..376f47edf4 100644 --- a/docset/winserver2022-ps/grouppolicy/Get-GPPermission.md +++ b/docset/winserver2022-ps/grouppolicy/Get-GPPermission.md @@ -48,9 +48,9 @@ Get-GPPermission -Name "TestGpo" -TargetName "Domain Users" -TargetType Group ``` ```Output -Trustee : Domain Users -TrusteeType : Group -PermissionLevel : GpoRead +Trustee : Domain Users +TrusteeType : Group +PermissionLevel : GpoRead Inherited : False ``` @@ -73,50 +73,50 @@ This command gets the permission level for the Domain Admins group on the GPO wi `fa4a9473-6e2a-4b78-175e68d97bde` in the `Sales.Contoso.com` domain. The `DC1.sales.contoso.com` domain controller is contacted to complete the operation. -If the domain of the user that is running the session (or, for startup and shutdown scripts, the -computer) is different from the sales.contoso.com domain, a trust must exist between the two +If the domain of the user that's running the session (or, for startup and shutdown scripts, the +computer) is different from the `sales.contoso.com` domain, a trust must exist between the two domains, or the command fails. ### Example 3: Get the permission level for all security principals on the specified GPO ```powershell -Get-GPPermission -Name "TestGPO" -All +Get-GPPermission -Name "TestGPO" -All ``` ```Output -Trustee : Authenticated Users -TrusteeType : WellKnownGroup -Permission : GpoApply -Inherited : False - -Trustee : Domain Admins -TrusteeType : Group -Permission : GpoEditDeleteModifySecurity -Inherited : False - -Trustee : Enterprise Admins -TrusteeType : Group -Permission : GpoEditDeleteModifySecurity -Inherited : False - -Trustee : ENTERPRISE DOMAIN CONTROLLERS -TrusteeType : WellKnownGroup -Permission : GpoRead -Inherited : False - -Trustee : SYSTEM -TrusteeType : WellKnownGroup -Permission : GpoEditDeleteModifySecurity +Trustee : Authenticated Users +TrusteeType : WellKnownGroup +Permission : GpoApply +Inherited : False + +Trustee : Domain Admins +TrusteeType : Group +Permission : GpoEditDeleteModifySecurity +Inherited : False + +Trustee : Enterprise Admins +TrusteeType : Group +Permission : GpoEditDeleteModifySecurity +Inherited : False + +Trustee : ENTERPRISE DOMAIN CONTROLLERS +TrusteeType : WellKnownGroup +Permission : GpoRead +Inherited : False + +Trustee : SYSTEM +TrusteeType : WellKnownGroup +Permission : GpoEditDeleteModifySecurity Inherited : False ``` This command gets the permission level for each security principal that has permissions on the GPO -named TestGPO. +named `TestGPO`. ### Example 4: Get the display name of each GPO for a specific permissions ```powershell -Get-GPO -All | ForEach-Object { +Get-GPO -All | ForEach-Object { if ( $_ | $params = @{ TargetName = 'contoso\Domain Admins' @@ -130,26 +130,27 @@ Get-GPO -All | ForEach-Object { ``` ```Output -Default Domain Policy -TestGPO-1 -TestGPO-2 Default Domain Controllers Policy -Internet Security +Default Domain Policy +TestGPO-1 +TestGPO-2 Default Domain Controllers Policy +Internet Security TestGPO ``` This command lists the display name of each GPO (in the domain) on which the specified security principal has permissions. -First, `Get-GPO` is used to retrieve all the GPOs in the domain (**Get-GPO -All**). Then, the -collection is piped into the `Foreach-Object` command. As each GPO is evaluated, it is piped into -`Get-GPPermissions`. If a permission level is returned, the DisplayName property of the GPO is -printed ($_.DisplayName). +First, `Get-GPO` is used to retrieve all the GPOs in the domain (`Get-GPO -All`). Then, the +collection is piped into the `Foreach-Object` command. As each GPO is evaluated, it's piped into +`Get-GPPermissions`. If a permission level is returned, the **DisplayName** property of the GPO is +printed. -Note: The ErrorAction parameter is set to SilentlyContinue for Get-GPPermissions. This is because a -non-terminating error occurs if the specified security principal does not have permissions on the -GPO. Specifying the ErrorAction as SilentlyContinue prevents the error messages from being printed -for GPOS on which the security principal does not have permissions. For more information about the -ErrorAction parameter, see about_CommonParameters. +The **ErrorAction** parameter is set to `SilentlyContinue`. This is because a non-terminating error +occurs if the specified security principal doesn't have permissions on the GPO. Specifying the +**ErrorAction** as `SilentlyContinue` prevents the error messages from being printed for GPOS on +which the security principal doesn't have permissions. For more information about the +**ErrorAction** parameter, see +[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). ## PARAMETERS @@ -161,7 +162,7 @@ permissions on the GPO. ```yaml Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -172,17 +173,14 @@ Accept wildcard characters: False ### -DomainName -Specifies the domain for this cmdlet. -You must specify the fully qualified domain name (FQDN) of the domain. +Specifies the domain for this cmdlet. You must specify the fully qualified domain name (FQDN) of the +domain. The GPO specified must exist in this domain. -For the `Get-GPPermission` cmdlet, the GPO for which to get the permission level must exist in -this domain. - -If you do not specify the **Domain** parameter, the domain of the user that is running the current +If you don't specify the **Domain** parameter, the domain of the user that's running the current session is used. If the cmdlet is being run from a computer startup or shutdown script, the domain of the computer is used. For more information, see the Notes section in the full Help. -If you specify a domain that is different from the domain of the user that is running the current +If you specify a domain that's different from the domain of the user that's running the current session (or, for a startup or shutdown script, the computer), a trust must exist between that domain and the domain of the user or the computer. @@ -204,7 +202,7 @@ Accept wildcard characters: False ### -Guid Specifies the GPO from which to retrieve the permission level by its globally unique identifier -(GUID). The GUID uniquely identifies the GPO. +(GUID). The `GUID` uniquely identifies the GPO. You can also refer to the **Guid** parameter by its built-in alias, **Id**. For more information, see [about_Aliases](/powershell/module/microsoft.powershell.core/about/about_aliases). @@ -225,7 +223,7 @@ Accept wildcard characters: False Specifies the GPO from which to retrieve the permission level by its display name. -The display name is not guaranteed to be unique in the domain. If another GPO with the same display +The display name isn't guaranteed to be unique in the domain. If another GPO with the same display name exists in the domain an error occurs. You can use the **Guid** parameter to uniquely identify a GPO. @@ -249,7 +247,7 @@ Accept wildcard characters: False Specifies the name of the domain controller that this cmdlet contacts to complete the operation. You can specify either the fully qualified domain name (FQDN) or the host name. -If you do not specify the name by using the **Server** parameter, the PDC emulator is contacted. +If you don't specify the name using the **Server** parameter, the PDC emulator is contacted. You can also refer to the **Server** parameter by its built-in alias, **DC**. For more information, see [about_Aliases](/powershell/module/microsoft.powershell.core/about/about_aliases). @@ -274,16 +272,14 @@ security principal (domain\account) or just its name. For instance, in the `contoso.com` domain, to specify: -- The user someuser, use `contoso\someuser` or `someuser`. - +- The username, use `contoso\someuser` or `someuser`. - The Domain Admins security group, use `contoso\Domain Admins` or `Domain Admins`. - -- The computer computer-01, use `contoso\computer-01` or `computer-01`. +- The computer name, use `contoso\computer-01` or `computer-01`. ```yaml Type: System.String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -294,20 +290,17 @@ Accept wildcard characters: False ### -TargetType -The type of security principal for which to get the permission level. - -The acceptable values for this parameter are: +The type of security principal for which to get the permission level. The acceptable values for this +parameter are: - Computer - - User - - Group ```yaml Type: PermissionTrusteeType Parameter Sets: (All) -Aliases: +Aliases: Accepted values: Computer, User, Group Required: False @@ -333,26 +326,26 @@ GPOs from different domains are not supported. ## OUTPUTS -### +### Microsoft.GroupPolicy.GPPermissionCollection + +### Microsoft.GroupPolicy.GPPermission This cmdlet returns an object that represents permissions for the specified security principal (user, group, or computer) on the GPO. ## NOTES -* You can use the *DomainName* parameter to explicitly specify the domain for this cmdlet. - - If you do not explicitly specify the domain, the cmdlet uses the default domain. The default - domain is the domain that is used to access network resources by the security context under which - the current session is running. This domain is typically the domain of the user that is running - the session. For example, the domain of the user who started the session by opening Windows - PowerShell or the domain of a user that is specified in a runas command. However, computer startup - and shutdown scripts run under the context of the LocalSystem account. The LocalSystem account is - a built-in local account, and it accesses network resources under the context of the computer - account. Therefore, when this cmdlet is run from a startup or shutdown script, the default domain - is the domain to which the computer is joined. +You can use the **DomainName** parameter to explicitly specify the domain for this cmdlet. If you do +not explicitly specify the domain, the cmdlet uses the default domain. The default domain is the +domain that is used to access network resources by the security context under which the current +session is running. This domain is typically the domain of the user that is running the session. For +example, the domain of the user who started the session by opening Windows PowerShell or the domain +of a user that is specified in a runas command. However, computer startup and shutdown scripts run +under the context of the LocalSystem account. The LocalSystem account is a built-in local account, +and it accesses network resources under the context of the computer account. Therefore, when this +cmdlet is run from a startup or shutdown script, the default domain is the domain to which the +computer is joined. ## RELATED LINKS [Set-GPPermission](./Set-GPPermission.md) - From 45e84334665ed14a7e8baff593c5823b61f47fa3 Mon Sep 17 00:00:00 2001 From: Sean Wheeler Date: Fri, 5 May 2023 09:52:26 -0500 Subject: [PATCH 432/650] Fix typos --- .../grouppolicy/Get-GPPermission.md | 2 +- .../grouppolicy/Remove-GPLink.md | 111 +++++++++--------- 2 files changed, 56 insertions(+), 57 deletions(-) diff --git a/docset/winserver2022-ps/grouppolicy/Get-GPPermission.md b/docset/winserver2022-ps/grouppolicy/Get-GPPermission.md index 376f47edf4..e8e5bcf6ce 100644 --- a/docset/winserver2022-ps/grouppolicy/Get-GPPermission.md +++ b/docset/winserver2022-ps/grouppolicy/Get-GPPermission.md @@ -60,7 +60,7 @@ This command gets the permission level for the Domain Users group on the GPO nam ```powershell $params = @{ - Domain = 'Sales.Contoso.com' + Domain = 'sales.contoso.com' Server = 'DC1' GUID = 'fa4a9473-6e2a-4b87-ab78-175e68d97bde' TargetName = 'Domain Admins' diff --git a/docset/winserver2022-ps/grouppolicy/Remove-GPLink.md b/docset/winserver2022-ps/grouppolicy/Remove-GPLink.md index d272a260e0..b2499de13d 100644 --- a/docset/winserver2022-ps/grouppolicy/Remove-GPLink.md +++ b/docset/winserver2022-ps/grouppolicy/Remove-GPLink.md @@ -45,16 +45,16 @@ Remove-GPLink -Name "MyGPO" -Target "OU=MyOU,dc=contoso,dc=com" ``` ```Output -DisplayName : MyGPO -DomainName : contoso.com -Owner : CONTOSO\Domain Admins -Id : 375865b2-3b5f-480f-8f56-2a994ea6e725 -GpoStatus : AllSettingsEnabled -Description : -CreationTime : 2/26/2009 11:28:08 PM -ModificationTime : 3/5/2009 3:36:34 PM -UserVersion : AD Version: 0, SysVol Version: 0 -ComputerVersion : AD Version: 1, SysVol Version: 1 +DisplayName : MyGPO +DomainName : contoso.com +Owner : CONTOSO\Domain Admins +Id : 375865b2-3b5f-480f-8f56-2a994ea6e725 +GpoStatus : AllSettingsEnabled +Description : +CreationTime : 2/26/2009 11:28:08 PM +ModificationTime : 3/5/2009 3:36:34 PM +UserVersion : AD Version: 0, SysVol Version: 0 +ComputerVersion : AD Version: 1, SysVol Version: 1 WmiFilter : ``` @@ -76,28 +76,28 @@ This command removes the link between the GPO named MyGPO and the default site. ``` ```Output -DisplayName : TestGPO-3 -DomainName : contoso.com -Owner : CONTOSO\Domain Admins -Id : d02126d4-82e8-4e87-b4a0-2d44b6891411 -GpoStatus : AllSettingsEnabled -Description : -CreationTime : 2/27/2009 2:59:51 PM -ModificationTime : 3/5/2009 3:36:37 PM -UserVersion : AD Version: 13, SysVol Version: 13 -ComputerVersion : AD Version: 0, SysVol Version: 0 -WmiFilter : - -DisplayName : TestGPO-2 -DomainName : contoso.com -Owner : CONTOSO\Domain Admins -Id : 375865b2-3b5f-480f-8f56-2a994ea6e725 -GpoStatus : AllSettingsEnabled -Description : -CreationTime : 2/26/2009 11:28:08 PM -ModificationTime : 3/5/2009 3:36:34 PM -UserVersion : AD Version: 0, SysVol Version: 0 -ComputerVersion : AD Version: 1, SysVol Version: 1 +DisplayName : TestGPO-3 +DomainName : contoso.com +Owner : CONTOSO\Domain Admins +Id : d02126d4-82e8-4e87-b4a0-2d44b6891411 +GpoStatus : AllSettingsEnabled +Description : +CreationTime : 2/27/2009 2:59:51 PM +ModificationTime : 3/5/2009 3:36:37 PM +UserVersion : AD Version: 13, SysVol Version: 13 +ComputerVersion : AD Version: 0, SysVol Version: 0 +WmiFilter : + +DisplayName : TestGPO-2 +DomainName : contoso.com +Owner : CONTOSO\Domain Admins +Id : 375865b2-3b5f-480f-8f56-2a994ea6e725 +GpoStatus : AllSettingsEnabled +Description : +CreationTime : 2/26/2009 11:28:08 PM +ModificationTime : 3/5/2009 3:36:34 PM +UserVersion : AD Version: 0, SysVol Version: 0 +ComputerVersion : AD Version: 1, SysVol Version: 1 WmiFilter : ``` @@ -111,22 +111,6 @@ inherited from higher-level containers are not included. This collection is pipe ## PARAMETERS -### -Confirm - -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Domain Specifies the domain for this cmdlet. You must specify the fully qualified domain name (FQDN) of the @@ -139,9 +123,9 @@ For the `Remove-GPLink` cmdlet: - The Active Directory container (site, domain, or OU) that is linked must exist in a domain that has a trust relationship with this domain. -Note: To specify a domain to link to, use the Target parameter. +Note: To specify a domain to link to, use the **Target** parameter. -If you do not specify the Domain parameter, the domain of the user that is running the current +If you do not specify the **Domain** parameter, the domain of the user that is running the current session is used. If the cmdlet is being run from a computer startup or shutdown script, the domain of the computer is used. For more information, see the Notes section in the full Help. @@ -167,7 +151,7 @@ Accept wildcard characters: False ### -Guid Specifies the GPO for which to remove the link by its globally unique identifier (GUID). -The GUID uniquely identifies the GPO. +The `GUID` uniquely identifies the GPO. You can also refer to the **Guid** parameter by its built-in aliases, **id** and **gpoid**. For more information, see [about_Aliases](/powershell/module/microsoft.powershell.core/about/about_aliases). @@ -212,8 +196,8 @@ Accept wildcard characters: False Specifies the name of the domain controller that this cmdlet contacts to complete the operation. You can specify either the fully qualified domain name (FQDN) or the host name. -If you do not specify the name by using the **Server** parameter, the primary domain controller -(PDC) emulator is contacted. +If you do not specify the name using the **Server** parameter, the primary domain controller (PDC) +emulator is contacted. You can also refer to the **Server** parameter by its built-in alias, **DC**. For more information, see [about_Aliases](/powershell/module/microsoft.powershell.core/about/about_aliases). @@ -239,7 +223,7 @@ or OU from which to remove the link. For instance, for the `MyOU` organizational ```yaml Type: System.String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: Named @@ -248,6 +232,22 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -WhatIf Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -276,7 +276,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### Microsoft.GroupPolicy.GpoLink -~~~~ + This cmdlet accepts an object that represents the link between a GPO and a site, domain, or OU. ## OUTPUTS @@ -292,4 +292,3 @@ This cmdlet returns the GPO for which the link has been removed. [New-GPLink](./New-GPLink.md) [Set-GPLink](./Set-GPLink.md) - From 43192a85c968701bb01e48578ca456513aec47c2 Mon Sep 17 00:00:00 2001 From: Sean Wheeler Date: Fri, 5 May 2023 10:04:51 -0500 Subject: [PATCH 433/650] fix typo --- docset/winserver2022-ps/grouppolicy/Remove-GPLink.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/docset/winserver2022-ps/grouppolicy/Remove-GPLink.md b/docset/winserver2022-ps/grouppolicy/Remove-GPLink.md index b2499de13d..5d283566c9 100644 --- a/docset/winserver2022-ps/grouppolicy/Remove-GPLink.md +++ b/docset/winserver2022-ps/grouppolicy/Remove-GPLink.md @@ -254,8 +254,6 @@ Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml Type: System.Management.Automation.SwitchParameter -nt.Automation.SwitchParameter - Parameter Sets: (All) Aliases: wi From 586c335a6e2cc3299b69fd7e99a96ad4a1f44ea7 Mon Sep 17 00:00:00 2001 From: Kevin Cefalu Date: Mon, 1 May 2023 12:42:56 -0500 Subject: [PATCH 434/650] Resolves: windows-powershell-docs #3327 --- docset/winserver2022-ps/dfsn/DFSN.md | 32 ++- .../winserver2022-ps/dfsn/Get-DfsnAccess.md | 67 +++-- .../winserver2022-ps/dfsn/Get-DfsnFolder.md | 79 +++--- .../dfsn/Get-DfsnFolderTarget.md | 73 +++-- docset/winserver2022-ps/dfsn/Get-DfsnRoot.md | 100 ++++--- .../dfsn/Get-DfsnRootTarget.md | 80 ++++-- .../dfsn/Get-DfsnServerConfiguration.md | 64 +++-- .../winserver2022-ps/dfsn/Grant-DfsnAccess.md | 87 +++--- .../winserver2022-ps/dfsn/Move-DfsnFolder.md | 99 ++++--- .../winserver2022-ps/dfsn/New-DfsnFolder.md | 219 ++++++++------- .../dfsn/New-DfsnFolderTarget.md | 152 +++++----- docset/winserver2022-ps/dfsn/New-DfsnRoot.md | 261 ++++++++++-------- .../dfsn/New-DfsnRootTarget.md | 136 +++++---- .../dfsn/Remove-DfsnAccess.md | 82 +++--- .../dfsn/Remove-DfsnFolder.md | 94 ++++--- .../dfsn/Remove-DfsnFolderTarget.md | 103 ++++--- .../winserver2022-ps/dfsn/Remove-DfsnRoot.md | 94 ++++--- .../dfsn/Remove-DfsnRootTarget.md | 101 ++++--- .../dfsn/Revoke-DfsnAccess.md | 87 +++--- .../winserver2022-ps/dfsn/Set-DfsnFolder.md | 139 ++++++---- .../dfsn/Set-DfsnFolderTarget.md | 150 +++++----- docset/winserver2022-ps/dfsn/Set-DfsnRoot.md | 195 +++++++------ .../dfsn/Set-DfsnRootTarget.md | 148 +++++----- .../dfsn/Set-DfsnServerConfiguration.md | 150 +++++----- 24 files changed, 1647 insertions(+), 1145 deletions(-) diff --git a/docset/winserver2022-ps/dfsn/DFSN.md b/docset/winserver2022-ps/dfsn/DFSN.md index 4bbf0236a3..314863ddcf 100644 --- a/docset/winserver2022-ps/dfsn/DFSN.md +++ b/docset/winserver2022-ps/dfsn/DFSN.md @@ -10,78 +10,102 @@ title: DFSN --- # DFSN Module + ## Description -This reference provides cmdlet descriptions and syntax for all DFS Namespace cmdlets. -It lists the cmdlets in alphabetical order based on the verb at the beginning of the cmdlet. + +This reference provides cmdlet descriptions and syntax for all DFS Namespace cmdlets. It lists the +cmdlets in alphabetical order based on the verb at the beginning of the cmdlet. ## DFSN Cmdlets + ### [Get-DfsnAccess](./Get-DfsnAccess.md) + Gets permissions for a DFS namespace folder. ### [Get-DfsnFolder](./Get-DfsnFolder.md) + Gets settings for a DFS namespace folder. ### [Get-DfsnFolderTarget](./Get-DfsnFolderTarget.md) + Gets settings for targets of a DFS namespace folder. ### [Get-DfsnRoot](./Get-DfsnRoot.md) + Gets settings for DFS namespaces. ### [Get-DfsnRootTarget](./Get-DfsnRootTarget.md) + Gets settings for root targets of a DFS namespace. ### [Get-DfsnServerConfiguration](./Get-DfsnServerConfiguration.md) + Gets DFS namespace settings for a DFSN root server. ### [Grant-DfsnAccess](./Grant-DfsnAccess.md) + Grants permissions to users and groups to access a DFS namespace folder. ### [Move-DfsnFolder](./Move-DfsnFolder.md) + Moves or renames a DFS namespace folder. ### [New-DfsnFolder](./New-DfsnFolder.md) + Creates a folder in a DFS namespace. ### [New-DfsnFolderTarget](./New-DfsnFolderTarget.md) + Adds a target to a DFS namespace folder. ### [New-DfsnRoot](./New-DfsnRoot.md) + Creates a DFS namespace. ### [New-DfsnRootTarget](./New-DfsnRootTarget.md) + Adds a root target to a DFS namespace. ### [Remove-DfsnAccess](./Remove-DfsnAccess.md) + Removes users and groups from the ACL for a folder in a DFS namespace. ### [Remove-DfsnFolder](./Remove-DfsnFolder.md) + Removes a DFS namespace folder. ### [Remove-DfsnFolderTarget](./Remove-DfsnFolderTarget.md) + Removes a target for a DFS namespace folder. ### [Remove-DfsnRoot](./Remove-DfsnRoot.md) + Removes a DFS namespace. ### [Remove-DfsnRootTarget](./Remove-DfsnRootTarget.md) + Removes a target for a DFS namespace root. ### [Revoke-DfsnAccess](./Revoke-DfsnAccess.md) + Revokes permissions for users to access and enumerate the contents of a DFS namespace folder. ### [Set-DfsnFolder](./Set-DfsnFolder.md) + Changes settings for a DFS namespace folder. ### [Set-DfsnFolderTarget](./Set-DfsnFolderTarget.md) + Changes settings for a target of a DFS namespace folder. ### [Set-DfsnRoot](./Set-DfsnRoot.md) + Changes settings for a DFS namespace. ### [Set-DfsnRootTarget](./Set-DfsnRootTarget.md) + Changes settings for a root target of a DFS namespace. ### [Set-DfsnServerConfiguration](./Set-DfsnServerConfiguration.md) -Changes settings for a DFS namespace root server. - +Changes settings for a DFS namespace root server. diff --git a/docset/winserver2022-ps/dfsn/Get-DfsnAccess.md b/docset/winserver2022-ps/dfsn/Get-DfsnAccess.md index cecc0e7287..79bd6f6d4f 100644 --- a/docset/winserver2022-ps/dfsn/Get-DfsnAccess.md +++ b/docset/winserver2022-ps/dfsn/Get-DfsnAccess.md @@ -11,6 +11,7 @@ title: Get-DfsnAccess # Get-DfsnAccess ## SYNOPSIS + Gets permissions for a DFS namespace folder. ## SYNTAX @@ -21,34 +22,43 @@ Get-DfsnAccess [-Path] [-CimSession ] [-ThrottleLimit Get-DfsnAccess -Path "\\Contoso\Software\Projects" + +```powershell +Get-DfsnAccess -Path "\\Contoso\Software\Projects" ``` -This command gets permissions for a DFS namespace folder that has the path \\\\Contoso\Software\Projects. +This command gets permissions for a DFS namespace folder that has the path +`\\Contoso\Software\Projects`. ## PARAMETERS ### -AsJob -Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. -The cmdlet immediately returns an object that represents the job and then displays the command prompt. -You can continue to work in the session while the job completes. -To manage the job, use the `*-Job` cmdlets. -To get the job results, use the [Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. +Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to +complete. + +The cmdlet immediately returns an object that represents the job and then displays the command +prompt. You can continue to work in the session while the job completes. To manage the job, use the +`*-Job` cmdlets. To get the job results, use the +[Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. -For more information about Windows PowerShell background jobs, see [about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). +For more information about Windows PowerShell background jobs, see +[about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -60,12 +70,14 @@ Accept wildcard characters: False ``` ### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -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. -The default is the current session on the local computer. + +Runs the cmdlet in a remote session or on a remote computer. 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. The default is the +current session on the local computer. ```yaml -Type: CimSession[] +Type: Microsoft.Management.Infrastructure.CimSession[] Parameter Sets: (All) Aliases: Session @@ -77,12 +89,13 @@ Accept wildcard characters: False ``` ### -Path + Specifies a path for a DFS namespace folder. This cmdlet gets permissions for the folder specified. Provide a complete path for a folder, not a partial or relative path. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: DfsPath, FolderPath, NamespacePath @@ -94,12 +107,15 @@ Accept wildcard characters: False ``` ### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -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. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. + +Specifies the maximum number of concurrent operations that can be established to run the cmdlet. 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. The throttle limit applies only to the current cmdlet, not to the session or to the +computer. ```yaml -Type: Int32 +Type: System.Int32 Parameter Sets: (All) Aliases: @@ -111,7 +127,11 @@ Accept wildcard characters: False ``` ### CommonParameters -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). + +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). ## INPUTS @@ -130,4 +150,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-DfsnAccess](./Remove-DfsnAccess.md) [Revoke-DfsnAccess](./Revoke-DfsnAccess.md) - diff --git a/docset/winserver2022-ps/dfsn/Get-DfsnFolder.md b/docset/winserver2022-ps/dfsn/Get-DfsnFolder.md index 64de12cd53..88de205625 100644 --- a/docset/winserver2022-ps/dfsn/Get-DfsnFolder.md +++ b/docset/winserver2022-ps/dfsn/Get-DfsnFolder.md @@ -21,41 +21,49 @@ Get-DfsnFolder [-Path] [-CimSession ] [-ThrottleLimit Get-DfsnFolder -Path "\\Contoso\AccountingResources\LegacySoftware" + +```powershell +Get-DfsnFolder -Path '\\Contoso\AccountingResources\LegacySoftware' ``` -This command displays settings for the \\\\Contoso\AccountingResources\LegacySoftware folder. +This command displays settings for the `\\Contoso\AccountingResources\LegacySoftware` folder. ### Example 2: Get settings for all folders in a DFS namespace -``` -PS C:\> Get-DfsnFolder -Path "\\Contoso\AccountingResources\*" + +```powershell +Get-DfsnFolder -Path '\\Contoso\AccountingResources\*' ``` -The command uses the wildcard to get settings for all the folders in the \\\\Contoso\AccountingResources DFS namespace. +The command uses the wildcard to get settings for all the folders in the +`\\Contoso\AccountingResources` DFS namespace. ## PARAMETERS ### -AsJob -Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. -The cmdlet immediately returns an object that represents the job and then displays the command prompt. -You can continue to work in the session while the job completes. -To manage the job, use the `*-Job` cmdlets. -To get the job results, use the [Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. +Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to +complete. + +The cmdlet immediately returns an object that represents the job and then displays the command +prompt. You can continue to work in the session while the job completes. To manage the job, use the +`*-Job` cmdlets. To get the job results, use the +[Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. -For more information about Windows PowerShell background jobs, see [about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). +For more information about Windows PowerShell background jobs, see +[about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -67,12 +75,14 @@ Accept wildcard characters: False ``` ### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -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. -The default is the current session on the local computer. + +Runs the cmdlet in a remote session or on a remote computer. 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. The default is the +current session on the local computer. ```yaml -Type: CimSession[] +Type: Microsoft.Management.Infrastructure.CimSession[] Parameter Sets: (All) Aliases: Session @@ -84,14 +94,15 @@ Accept wildcard characters: False ``` ### -Path -Specifies a path for the folder. -This cmdlet gets configuration settings for the DFS namespace folder that has the path specified. -You can use DFS namespace with the wildcard character to get settings for all the folders in the namespace. -See the Examples section. +Specifies a path for the folder. This cmdlet gets configuration settings for the DFS namespace +folder that has the path specified. + +You can use DFS namespace with the wildcard character to get settings for all the folders in the +namespace. See the Examples section. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: DfsPath, FolderPath, NamespacePath @@ -103,12 +114,15 @@ Accept wildcard characters: True ``` ### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -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. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. + +Specifies the maximum number of concurrent operations that can be established to run the cmdlet. 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. The throttle limit applies only to the current cmdlet, not to the session or to the +computer. ```yaml -Type: Int32 +Type: System.Int32 Parameter Sets: (All) Aliases: @@ -120,7 +134,11 @@ Accept wildcard characters: False ``` ### CommonParameters -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). + +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). ## INPUTS @@ -141,4 +159,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-DfsnFolder](./Remove-DfsnFolder.md) [Set-DfsnFolder](./Set-DfsnFolder.md) - diff --git a/docset/winserver2022-ps/dfsn/Get-DfsnFolderTarget.md b/docset/winserver2022-ps/dfsn/Get-DfsnFolderTarget.md index 5dab3b971c..750e615cf6 100644 --- a/docset/winserver2022-ps/dfsn/Get-DfsnFolderTarget.md +++ b/docset/winserver2022-ps/dfsn/Get-DfsnFolderTarget.md @@ -15,23 +15,29 @@ Gets settings for targets of a DFS namespace folder. ## SYNTAX -```powershell +``` Get-DfsnFolderTarget [-Path] [[-TargetPath] ] [-CimSession ] [-ThrottleLimit ] [-AsJob] [] ``` ## DESCRIPTION -The **Get-DfsnFolderTarget** cmdlet gets settings for targets of a Distributed File System (DFS) namespace folder. -You can specify a DFS namespace folder path to see all the targets for that path. + +The **Get-DfsnFolderTarget** cmdlet gets settings for targets of a Distributed File System (DFS) +namespace folder. You can specify a DFS namespace folder path to see all the targets for that path. You can specify a namespace path and a target path to see settings for a particular target. -For more information about DFS namespaces, see [DFS Namespaces overview](/windows-server/storage/dfs-namespaces/dfs-overview). +For more information about DFS namespaces, see +[DFS Namespaces overview](/windows-server/storage/dfs-namespaces/dfs-overview). ## EXAMPLES ### Example 1: Get settings for a target + ```powershell -PS C:\> Get-DfsnFolderTarget -Path "\\Contoso\AccountingResources\LegacySoftware" -TargetPath "\\Contoso-FS\LegacySoftware" +Get-DfsnFolderTarget -Path '\\Contoso\AccountingResources\LegacySoftware' -TargetPath '\\Contoso-FS\LegacySoftware' +``` + +```Output NamespacePath : \\Contoso\AccountingResources\LegacySoftware ReferralPriorityClass : sitecost-normal ReferralPriorityRank : 0 @@ -40,22 +46,26 @@ TargetPath : \\Contoso-FS\LegacySoftware PSComputerName : ``` -This command gets settings for the target of the \\\\Contoso\AccountingResources\LegacySoftware folder with the folder target of \\\\Contoso-FS\LegacySoftware. +This command gets settings for the target of the `\\Contoso\AccountingResources\LegacySoftware` +folder with the folder target of `\\Contoso-FS\LegacySoftware`. ## PARAMETERS ### -AsJob -Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. -The cmdlet immediately returns an object that represents the job and then displays the command prompt. -You can continue to work in the session while the job completes. -To manage the job, use the `*-Job` cmdlets. -To get the job results, use the [Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. +Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to +complete. -For more information about Windows PowerShell background jobs, see [about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). +The cmdlet immediately returns an object that represents the job and then displays the command +prompt. You can continue to work in the session while the job completes. To manage the job, use the +`*-Job` cmdlets. To get the job results, use the +[Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. + +For more information about Windows PowerShell background jobs, see +[about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -67,12 +77,14 @@ Accept wildcard characters: False ``` ### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a [New-CimSession](/powershell/module/cimcmdlets/new-cimsession) or [Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet. -The default is the current session on the local computer. + +Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session +object, such as the output of a [New-CimSession](/powershell/module/cimcmdlets/new-cimsession) or +[Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet. The default is the +current session on the local computer. ```yaml -Type: CimSession[] +Type: Microsoft.Management.Infrastructure.CimSession[] Parameter Sets: (All) Aliases: Session @@ -84,10 +96,11 @@ Accept wildcard characters: False ``` ### -Path + Specifies a path for the root folder of a DFS namespace. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: DfsPath, FolderPath, NamespacePath @@ -99,11 +112,12 @@ Accept wildcard characters: False ``` ### -TargetPath -Specifies a path for the target of a DFS namespace folder. -This cmdlet gets settings for the target that has the path specified. + +Specifies a path for the target of a DFS namespace folder. This cmdlet gets settings for the target +that has the path specified. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: Target, DfsTarget, FolderTarget @@ -115,12 +129,15 @@ Accept wildcard characters: False ``` ### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -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. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. + +Specifies the maximum number of concurrent operations that can be established to run the cmdlet. 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. The throttle limit applies only to the current cmdlet, not to the session or to the +computer. ```yaml -Type: Int32 +Type: System.Int32 Parameter Sets: (All) Aliases: @@ -132,7 +149,11 @@ Accept wildcard characters: False ``` ### CommonParameters -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). + +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). ## INPUTS diff --git a/docset/winserver2022-ps/dfsn/Get-DfsnRoot.md b/docset/winserver2022-ps/dfsn/Get-DfsnRoot.md index 4b1553bf0a..4ea5b4ee1b 100644 --- a/docset/winserver2022-ps/dfsn/Get-DfsnRoot.md +++ b/docset/winserver2022-ps/dfsn/Get-DfsnRoot.md @@ -16,36 +16,45 @@ Gets settings for DFS namespaces. ## SYNTAX ### ByDomain (Default) + ``` Get-DfsnRoot [[-Domain] ] [-CimSession ] [-ThrottleLimit ] [-AsJob] [] ``` ### ByRoot + ``` Get-DfsnRoot [[-Path] ] [-CimSession ] [-ThrottleLimit ] [-AsJob] [] ``` ### ByServer + ``` -Get-DfsnRoot [[-ComputerName] ] [-CimSession ] [-ThrottleLimit ] [-AsJob] - [] +Get-DfsnRoot [[-ComputerName] ] [-CimSession ] [-ThrottleLimit ] + [-AsJob] [] ``` ## DESCRIPTION -The **Get-DfsnRoot** cmdlet gets configuration settings for Distributed File System (DFS) namespaces. -You can specify DFS namespaces by using a standalone or domain-based namespace path, by using a server, or by using a domain. -Use this cmdlet without parameters to see information on all DFS namespaces. -You can make changes to DFS settings by using the **Set-DfsnRoot** cmdlet. -For more information about DFS namespaces, see [Overview of DFS Namespaces](https://technet.microsoft.com/library/cc730736) on TechNet. +The **Get-DfsnRoot** cmdlet gets configuration settings for Distributed File System (DFS) +namespaces. You can specify DFS namespaces by using a standalone or domain-based namespace path, by +using a server, or by using a domain. Use this cmdlet without parameters to see information on all +DFS namespaces. You can make changes to DFS settings by using the **Set-DfsnRoot** cmdlet. + +For more information about DFS namespaces, see +[Overview of DFS Namespaces](https://technet.microsoft.com/library/cc730736) on TechNet. ## EXAMPLES ### Example 1: Get DFS namespace configuration settings + +```powershell +Get-DfsnRoot -Path '\\Contoso\AccountingResources' | Format-List ``` -PS C:\> Get-DfsnRoot -Path "\\Contoso\AccountingResources" | Format-List + +```Output Path : \\Contoso\AccountingResources Description : Type : Standalone @@ -54,13 +63,14 @@ Flags : Site Costing TimeToLiveSec : 300 ``` -This command gets configuration settings for the namespace that has the Path \\\\Contoso\AccountingResources. -The command uses the **Format-List** cmdlet to format the output. +This command gets configuration settings for the namespace that has the Path +`\\Contoso\AccountingResources`. The command uses the **Format-List** cmdlet to format the output. For more information about this cmdlet, type `Get-Help Format-List`. ### Example 2: Get all DFS namespaces for a domain -``` -PS C:\> Get-DfsnRoot -Domain "Contoso.com" + +```powershell +Get-DfsnRoot -Domain 'Contoso.com' ``` This command gets all the DFS namespaces hosted in the domain Contoso.com. @@ -68,17 +78,20 @@ This command gets all the DFS namespaces hosted in the domain Contoso.com. ## PARAMETERS ### -AsJob -Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. -The cmdlet immediately returns an object that represents the job and then displays the command prompt. -You can continue to work in the session while the job completes. -To manage the job, use the `*-Job` cmdlets. -To get the job results, use the [Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. +Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to +complete. -For more information about Windows PowerShell background jobs, see [about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). +The cmdlet immediately returns an object that represents the job and then displays the command +prompt. You can continue to work in the session while the job completes. To manage the job, use the +`*-Job` cmdlets. To get the job results, use the +[Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. + +For more information about Windows PowerShell background jobs, see +[about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -90,12 +103,14 @@ Accept wildcard characters: False ``` ### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -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. -The default is the current session on the local computer. + +Runs the cmdlet in a remote session or on a remote computer. 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. The default is the +current session on the local computer. ```yaml -Type: CimSession[] +Type: Microsoft.Management.Infrastructure.CimSession[] Parameter Sets: (All) Aliases: Session @@ -107,11 +122,12 @@ Accept wildcard characters: False ``` ### -ComputerName -Specifies the name of a server. -This cmdlet gets configuration settings for all DFS namespaces that the specified server hosts. + +Specifies the name of a server. This cmdlet gets configuration settings for all DFS namespaces that +the specified server hosts. ```yaml -Type: String +Type: System.String Parameter Sets: ByServer Aliases: Server @@ -123,11 +139,12 @@ Accept wildcard characters: False ``` ### -Domain -Specifies a domain name. -This cmdlet gets configuration settings for DFS namespaces in the domain specified. + +Specifies a domain name. This cmdlet gets configuration settings for DFS namespaces in the domain +specified. ```yaml -Type: String +Type: System.String Parameter Sets: ByDomain Aliases: @@ -139,11 +156,12 @@ Accept wildcard characters: False ``` ### -Path -Specifies a path for the root folder of a DFS namespace. -This cmdlet gets configuration settings for the DFS namespace that has the root path specified. + +Specifies a path for the root folder of a DFS namespace. This cmdlet gets configuration settings for +the DFS namespace that has the root path specified. ```yaml -Type: String +Type: System.String Parameter Sets: ByRoot Aliases: RootPath, root, namespace, NamespaceRoot @@ -155,12 +173,15 @@ Accept wildcard characters: False ``` ### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -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. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. + +Specifies the maximum number of concurrent operations that can be established to run the cmdlet. 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. The throttle limit applies only to the current cmdlet, not to the session or to the +computer. ```yaml -Type: Int32 +Type: System.Int32 Parameter Sets: (All) Aliases: @@ -172,7 +193,11 @@ Accept wildcard characters: False ``` ### CommonParameters -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). + +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). ## INPUTS @@ -191,4 +216,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-DfsnRoot](./Remove-DfsnRoot.md) [Set-DfsnRoot](./Set-DfsnRoot.md) - diff --git a/docset/winserver2022-ps/dfsn/Get-DfsnRootTarget.md b/docset/winserver2022-ps/dfsn/Get-DfsnRootTarget.md index 61972a1a6a..5cc417fd6b 100644 --- a/docset/winserver2022-ps/dfsn/Get-DfsnRootTarget.md +++ b/docset/winserver2022-ps/dfsn/Get-DfsnRootTarget.md @@ -21,42 +21,51 @@ Get-DfsnRootTarget [-Path] [[-TargetPath] ] [-CimSession Get-DfsnRootTarget -Path "\\Contoso\AccountingSoftware" + +```powershell +Get-DfsnRootTarget -Path '\\Contoso\AccountingSoftware' ``` -This command gets the DFS namespace root targets for the namespace that has the path \\\\Contoso\AccountingSoftware. +This command gets the DFS namespace root targets for the namespace that has the path +`\\Contoso\AccountingSoftware`. ### Example 2: Get a specified root target -``` -PS C:\> Get-DfsnRootTarget -Path "\\Contoso\AccountingSoftware" -TargetPath "\\Contoso-FS\Software" + +```powershell +Get-DfsnRootTarget -Path '\\Contoso\AccountingSoftware' -TargetPath '\\Contoso-FS\Software' ``` -This command gets a single root target, specified by using the path \\\\Contoso\AccountingSoftware and the target path \\\\Contoso-FS\Software. +This command gets a single root target, specified by using the path `\\Contoso\AccountingSoftware` +and the target path `\\Contoso-FS\Software`. ## PARAMETERS ### -AsJob -Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. -The cmdlet immediately returns an object that represents the job and then displays the command prompt. -You can continue to work in the session while the job completes. -To manage the job, use the `*-Job` cmdlets. -To get the job results, use the [Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. +Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to +complete. + +The cmdlet immediately returns an object that represents the job and then displays the command +prompt. You can continue to work in the session while the job completes. To manage the job, use the +`*-Job` cmdlets. To get the job results, use the +[Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. -For more information about Windows PowerShell background jobs, see [about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). +For more information about Windows PowerShell background jobs, see +[about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -68,12 +77,15 @@ Accept wildcard characters: False ``` ### -CimSession + Runs the cmdlet in a remote session or on a remote computer. -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. -The default is the current session on the local computer. +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. The default is the +current session on the local computer. ```yaml -Type: CimSession[] +Type: Microsoft.Management.Infrastructure.CimSession[] Parameter Sets: (All) Aliases: Session @@ -85,10 +97,11 @@ Accept wildcard characters: False ``` ### -Path + Specifies a path for the root folder of a DFS namespace. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: DfsPath, NamespaceRoot @@ -100,11 +113,12 @@ Accept wildcard characters: False ``` ### -TargetPath -Specifies a path for the root folder target of a DFS namespace. -This cmdlet gets settings for the root target that has the path specified. + +Specifies a path for the root folder target of a DFS namespace. This cmdlet gets settings for the +root target that has the path specified. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: Target, DfsTarget, RootTargetPath @@ -116,12 +130,15 @@ Accept wildcard characters: False ``` ### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -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. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. + +Specifies the maximum number of concurrent operations that can be established to run the cmdlet. 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. The throttle limit applies only to the current cmdlet, not to the session or to the +computer. ```yaml -Type: Int32 +Type: System.Int32 Parameter Sets: (All) Aliases: @@ -133,7 +150,11 @@ Accept wildcard characters: False ``` ### CommonParameters -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). + +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). ## INPUTS @@ -152,4 +173,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-DfsnRootTarget](./Remove-DfsnRootTarget.md) [Set-DfsnRootTarget](./Set-DfsnRootTarget.md) - diff --git a/docset/winserver2022-ps/dfsn/Get-DfsnServerConfiguration.md b/docset/winserver2022-ps/dfsn/Get-DfsnServerConfiguration.md index ec6607a6e1..99a1fcee80 100644 --- a/docset/winserver2022-ps/dfsn/Get-DfsnServerConfiguration.md +++ b/docset/winserver2022-ps/dfsn/Get-DfsnServerConfiguration.md @@ -16,21 +16,26 @@ Gets DFS namespace settings for a DFSN root server. ## SYNTAX ``` -Get-DfsnServerConfiguration [-ComputerName] [-CimSession ] [-ThrottleLimit ] - [-AsJob] [] +Get-DfsnServerConfiguration [-ComputerName] [-CimSession ] + [-ThrottleLimit ] [-AsJob] [] ``` ## DESCRIPTION -The **Get-DfsnServerConfiguration** cmdlet gets Distributed File System (DFS) namespace settings for a DFS namespace root server. -A DFS namespace root server hosts one or more namespace root targets. -You can use this cmdlet to see current settings for a server, and you can use the **Set-DfsnServerConfiguration** cmdlet to make changes to a server. + +The **Get-DfsnServerConfiguration** cmdlet gets Distributed File System (DFS) namespace settings for +a DFS namespace root server. A DFS namespace root server hosts one or more namespace root targets. +You can use this cmdlet to see current settings for a server, and you can use the +**Set-DfsnServerConfiguration** cmdlet to make changes to a server. ## EXAMPLES ### Example 1: Get settings for a server + +```powershell +Get-DfsnServerConfiguration -ComputerName "Contoso-FS" ``` -PS C:\> Get-DfsnServerConfiguration -ComputerName "Contoso-FS" +```Output ComputerName : Contoso-FS LdapTimeoutSec : PreferLogonDC : @@ -45,17 +50,20 @@ This command gets the Retrieves the configuration settings of the DFS namespace ## PARAMETERS ### -AsJob -Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. -The cmdlet immediately returns an object that represents the job and then displays the command prompt. -You can continue to work in the session while the job completes. -To manage the job, use the `*-Job` cmdlets. -To get the job results, use the [Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. +Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to +complete. -For more information about Windows PowerShell background jobs, see [about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). +The cmdlet immediately returns an object that represents the job and then displays the command +prompt. You can continue to work in the session while the job completes. To manage the job, use the +`*-Job` cmdlets. To get the job results, use the +[Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. + +For more information about Windows PowerShell background jobs, see +[about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -67,12 +75,15 @@ Accept wildcard characters: False ``` ### -CimSession + Runs the cmdlet in a remote session or on a remote computer. -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. -The default is the current session on the local computer. +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. The default is the +current session on the local computer. ```yaml -Type: CimSession[] +Type: Microsoft.Management.Infrastructure.CimSession[] Parameter Sets: (All) Aliases: Session @@ -84,10 +95,11 @@ Accept wildcard characters: False ``` ### -ComputerName + Specifies the host name or fully qualified domain name (FQDN) for a DFS namespace server. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: NamespaceServer @@ -99,12 +111,15 @@ Accept wildcard characters: False ``` ### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -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. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. + +Specifies the maximum number of concurrent operations that can be established to run the cmdlet. 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. The throttle limit applies only to the current cmdlet, not to the session or to the +computer. ```yaml -Type: Int32 +Type: System.Int32 Parameter Sets: (All) Aliases: @@ -116,7 +131,11 @@ Accept wildcard characters: False ``` ### CommonParameters -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). + +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). ## INPUTS @@ -131,4 +150,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS [Set-DfsnServerConfiguration](./Set-DfsnServerConfiguration.md) - diff --git a/docset/winserver2022-ps/dfsn/Grant-DfsnAccess.md b/docset/winserver2022-ps/dfsn/Grant-DfsnAccess.md index 18bba3095d..09133f6de6 100644 --- a/docset/winserver2022-ps/dfsn/Grant-DfsnAccess.md +++ b/docset/winserver2022-ps/dfsn/Grant-DfsnAccess.md @@ -21,36 +21,45 @@ Grant-DfsnAccess [-Path] [-AccountName] [-CimSession Grant-DfsnAccess -Path "\\Contoso\Software\Projects" -AccountName "TSQA\PattiFuller" +```Output AccessType : Enumerate AccountName : TSQA\PattiFuller NamespacePath : \\Contoso\Software\Projects PSComputerName : ``` -This command grants the user TSQA\PattiFuller permissions for the folder \\\\Contoso\Software\Projects. +This command grants the user TSQA\PattiFuller permissions for the folder +`\\Contoso\Software\Projects`. ## PARAMETERS ### -AccountName -Specifies an array of user and group accounts. -This cmdlet grants permissions to the accounts specified. + +Specifies an array of user and group accounts. This cmdlet grants permissions to the accounts +specified. ```yaml -Type: String[] +Type: System.String[] Parameter Sets: (All) Aliases: Account, user @@ -62,17 +71,20 @@ Accept wildcard characters: False ``` ### -AsJob -Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. -The cmdlet immediately returns an object that represents the job and then displays the command prompt. -You can continue to work in the session while the job completes. -To manage the job, use the `*-Job` cmdlets. -To get the job results, use the [Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. +Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to +complete. -For more information about Windows PowerShell background jobs, see [about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). +The cmdlet immediately returns an object that represents the job and then displays the command +prompt. You can continue to work in the session while the job completes. To manage the job, use the +`*-Job` cmdlets. To get the job results, use the +[Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. + +For more information about Windows PowerShell background jobs, see +[about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -84,12 +96,14 @@ Accept wildcard characters: False ``` ### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -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. -The default is the current session on the local computer. + +Runs the cmdlet in a remote session or on a remote computer. 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. The default is the +current session on the local computer. ```yaml -Type: CimSession[] +Type: Microsoft.Management.Infrastructure.CimSession[] Parameter Sets: (All) Aliases: Session @@ -101,10 +115,11 @@ Accept wildcard characters: False ``` ### -Confirm + Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf @@ -116,11 +131,12 @@ Accept wildcard characters: False ``` ### -Path -Specifies a path for a DFS namespace folder. -This cmdlet grants permissions to access the folder specified. + +Specifies a path for a DFS namespace folder. This cmdlet grants permissions to access the folder +specified. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: DfsPath, FolderPath, NamespacePath @@ -132,12 +148,15 @@ Accept wildcard characters: False ``` ### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -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. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. + +Specifies the maximum number of concurrent operations that can be established to run the cmdlet. 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. The throttle limit applies only to the current cmdlet, not to the session or to the +computer. ```yaml -Type: Int32 +Type: System.Int32 Parameter Sets: (All) Aliases: @@ -149,10 +168,11 @@ Accept wildcard characters: False ``` ### -WhatIf + Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi @@ -164,7 +184,11 @@ Accept wildcard characters: False ``` ### CommonParameters -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). + +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). ## INPUTS @@ -185,4 +209,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-DfsnAccess](./Remove-DfsnAccess.md) [Revoke-DfsnAccess](./Revoke-DfsnAccess.md) - diff --git a/docset/winserver2022-ps/dfsn/Move-DfsnFolder.md b/docset/winserver2022-ps/dfsn/Move-DfsnFolder.md index 06db0e719e..7c5392c120 100644 --- a/docset/winserver2022-ps/dfsn/Move-DfsnFolder.md +++ b/docset/winserver2022-ps/dfsn/Move-DfsnFolder.md @@ -21,42 +21,50 @@ Move-DfsnFolder [-Path] [-NewPath] [-Force] [-CimSession Move-DfsnFolder -Path "\\Contoso\Western\Development\DesignDocuments" -NewPath "\\Contoso\Western\HumanResources\DesignDocuments" + +```powershell +Move-DfsnFolder -Path '\\Contoso\Western\Development\DesignDocuments' -NewPath '\\Contoso\Western\HumanResources\DesignDocuments' ``` -This command moves the folder DesignDocuments to the location \\\\Contoso\Western\HumanResources. -After you run this command, the folder \\\\Contoso\Western\Development\DesignDocuments no longer exists. +This command moves the folder DesignDocuments to the location `\\Contoso\Western\HumanResources`. +After you run this command, the folder `\\Contoso\Western\Development\DesignDocuments` no longer +exists. ### Example 2: Rename a folder -``` -PS C:\> Move-DfsnFolder -Path "\\Contoso\AccountingSoftware\Software" -NewPath "\\Contoso\AccountingSoftware\LegacySoftware" + +```powershell +Move-DfsnFolder -Path '\\Contoso\AccountingSoftware\Software' -NewPath '\\Contoso\AccountingSoftware\LegacySoftware' ``` -This command renames the folder Software in the \\\\Contoso\AccountingSoftware folder. -The new name is \\\\Contoso\AccountingSoftware\LegacySoftware. +This command renames the folder Software in the `\\Contoso\AccountingSoftware` folder. The new name +is `\\Contoso\AccountingSoftware\LegacySoftware`. ## PARAMETERS ### -AsJob -Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. -The cmdlet immediately returns an object that represents the job and then displays the command prompt. -You can continue to work in the session while the job completes. -To manage the job, use the `*-Job` cmdlets. -To get the job results, use the [Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. +Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to +complete. + +The cmdlet immediately returns an object that represents the job and then displays the command +prompt. You can continue to work in the session while the job completes. To manage the job, use the +`*-Job` cmdlets. To get the job results, use the +[Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. -For more information about Windows PowerShell background jobs, see [about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). +For more information about Windows PowerShell background jobs, see +[about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -68,12 +76,14 @@ Accept wildcard characters: False ``` ### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -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. -The default is the current session on the local computer. + +Runs the cmdlet in a remote session or on a remote computer. 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. The default is the +current session on the local computer. ```yaml -Type: CimSession[] +Type: Microsoft.Management.Infrastructure.CimSession[] Parameter Sets: (All) Aliases: Session @@ -85,10 +95,11 @@ Accept wildcard characters: False ``` ### -Confirm + Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf @@ -100,11 +111,12 @@ Accept wildcard characters: False ``` ### -Force -Moves or renames a DFS namespace folder without prompting you for confirmation. -By default, the cmdlet prompts you for confirmation before it proceeds. + +Moves or renames a DFS namespace folder without prompting you for confirmation. By default, the +cmdlet prompts you for confirmation before it proceeds. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -116,12 +128,12 @@ Accept wildcard characters: False ``` ### -NewPath -Specifies a path for the DFS namespace folder. -This cmdlet moves or renames the folder to have the path specified. -Do not specify an existing DFS namespace folder. + +Specifies a path for the DFS namespace folder. This cmdlet moves or renames the folder to have the +path specified. Do not specify an existing DFS namespace folder. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: NewDfsPath, NewNamespacePath @@ -133,11 +145,12 @@ Accept wildcard characters: False ``` ### -Path -Specifies the path for a DFS namespace folder. -This cmdlet moves or renames the folder that has the path specified. + +Specifies the path for a DFS namespace folder. This cmdlet moves or renames the folder that has the +path specified. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: DfsPath, FolderPath, NamespacePath @@ -149,12 +162,15 @@ Accept wildcard characters: False ``` ### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -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. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. + +Specifies the maximum number of concurrent operations that can be established to run the cmdlet. 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. The throttle limit applies only to the current cmdlet, not to the session or to the +computer. ```yaml -Type: Int32 +Type: System.Int32 Parameter Sets: (All) Aliases: @@ -166,11 +182,11 @@ Accept wildcard characters: False ``` ### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. + +Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi @@ -182,7 +198,11 @@ Accept wildcard characters: False ``` ### CommonParameters -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). + +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). ## INPUTS @@ -203,4 +223,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-DfsnFolder](./Remove-DfsnFolder.md) [Set-DfsnFolder](./Set-DfsnFolder.md) - diff --git a/docset/winserver2022-ps/dfsn/New-DfsnFolder.md b/docset/winserver2022-ps/dfsn/New-DfsnFolder.md index 3afd766b12..f41f2719be 100644 --- a/docset/winserver2022-ps/dfsn/New-DfsnFolder.md +++ b/docset/winserver2022-ps/dfsn/New-DfsnFolder.md @@ -17,59 +17,68 @@ Creates a folder in a DFS namespace. ``` New-DfsnFolder [-Path] [-TargetPath] [[-EnableInsiteReferrals] ] - [[-EnableTargetFailback] ] [[-State] ] [[-TimeToLiveSec] ] [[-Description] ] - [[-TargetState] ] [[-ReferralPriorityClass] ] [[-ReferralPriorityRank] ] - [-CimSession ] [-ThrottleLimit ] [-AsJob] [-WhatIf] [-Confirm] [] + [[-EnableTargetFailback] ] [[-State] ] [[-TimeToLiveSec] ] + [[-Description] ] [[-TargetState] ] + [[-ReferralPriorityClass] ] [[-ReferralPriorityRank] ] + [-CimSession ] [-ThrottleLimit ] [-AsJob] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION -The **New-DfsnFolder** cmdlet creates a folder in a Distributed File System (DFS) namespace. -Specify the path and a path for a folder target for the new folder. -A DFS namespace folder has one or more folder targets that are shared folders on computers. -When a client attempts to connect to a folder, the DFS namespace server provides a list of folder targets, called referrals. -The server determines the order for referrals and clients attempt to connect to a folder target in the order that the server provides. +The **New-DfsnFolder** cmdlet creates a folder in a Distributed File System (DFS) namespace. Specify +the path and a path for a folder target for the new folder. -You can specify settings for the new folder. -You can use this cmdlet to enable or disable the following settings: +A DFS namespace folder has one or more folder targets that are shared folders on computers. When a +client attempts to connect to a folder, the DFS namespace server provides a list of folder targets, +called referrals. The server determines the order for referrals and clients attempt to connect to a +folder target in the order that the server provides. -- In-site referrals. -- Target failback. +You can specify settings for the new folder. You can use this cmdlet to enable or disable the +following settings: -You can also add a descriptive comment, select the state of the folder and folder target, and set the Time to Live (TTL) interval for referrals. +- **In-site referrals** +- **Target failback** + +You can also add a descriptive comment, select the state of the folder and folder target, and set +the Time to Live (TTL) interval for referrals. Finally, you can specify the priority class and priority rank for referrals. -For more information about DFS namespaces, see [Overview of DFS Namespaces](https://technet.microsoft.com/library/cc730736) on TechNet. +For more information about DFS namespaces, see +[Overview of DFS Namespaces](https://technet.microsoft.com/library/cc730736) on TechNet. ## EXAMPLES ### Example 1: Create a DFS namespace folder -``` -PS C:\> New-DfsnFolder -Path "\\Contoso\AccountingResources\LegacySoftware" -TargetPath "\\Contoso-FS\AccountingLegacy" -EnableTargetFailback $True -Description "Folder for legacy software." + +```powershell +PS C:\> New-DfsnFolder -Path '\\Contoso\AccountingResources\LegacySoftware' -TargetPath '\\Contoso-FS\AccountingLegacy' -EnableTargetFailback $true -Description 'Folder for legacy software.' ``` -This command creates a folder called LegacySoftware in the \\\\Contoso\AccountingResources namespace. -The folder target is \\\\Contoso-FS\AccountingLegacy. -The command enables target failback for the folder. -The command includes a description for the new folder. +This command creates a folder called LegacySoftware in the `\\Contoso\AccountingResources` +namespace. The folder target is `\\Contoso-FS\AccountingLegacy`. The command enables target failback +for the folder. The command includes a description for the new folder. ## PARAMETERS ### -AsJob -Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. -The cmdlet immediately returns an object that represents the job and then displays the command prompt. -You can continue to work in the session while the job completes. -To manage the job, use the `*-Job` cmdlets. -To get the job results, use the [Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. +Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to +complete. -For more information about Windows PowerShell background jobs, see [about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). +The cmdlet immediately returns an object that represents the job and then displays the command +prompt. You can continue to work in the session while the job completes. To manage the job, use the +`*-Job` cmdlets. To get the job results, use the +[Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. + +For more information about Windows PowerShell background jobs, see +[about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -79,12 +88,14 @@ Accept wildcard characters: False ``` ### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -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. -The default is the current session on the local computer. + +Runs the cmdlet in a remote session or on a remote computer. 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. The default is the +current session on the local computer. ```yaml -Type: CimSession[] +Type: Microsoft.Management.Infrastructure.CimSession[] Parameter Sets: (All) Aliases: Session @@ -96,10 +107,11 @@ Accept wildcard characters: False ``` ### -Confirm + Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf @@ -111,10 +123,11 @@ Accept wildcard characters: False ``` ### -Description + Specifies a description for a DFS namespace folder. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: desc @@ -126,12 +139,14 @@ Accept wildcard characters: False ``` ### -EnableInsiteReferrals -Indicates whether a DFS namespace server provides a client only with referrals that are in the same site as the client. -If this value is $True, the DFS namespace server provides only in-site referrals. -If this value is $False, the DFS namespace server provides in-site referrals first, then other referrals. + +Indicates whether a DFS namespace server provides a client only with referrals that are in the same +site as the client. If this value is `$true`, the DFS namespace server provides only in-site +referrals. If this value is `$false`, the DFS namespace server provides in-site referrals first, +then other referrals. ```yaml -Type: Boolean +Type: System.Boolean Parameter Sets: (All) Aliases: insite @@ -143,13 +158,15 @@ Accept wildcard characters: False ``` ### -EnableTargetFailback -Indicates whether a DFS namespace uses target failback. -If a client attempts to access a target on a server and that server is not available, the client fails over to another referral. -If this value is $True, once the first server becomes available again, the client fails back to the first server. -If this value is $False, the DFS namespace server does not require the client to fail back to the preferred server. + +Indicates whether a DFS namespace uses target failback. If a client attempts to access a target on a +server and that server is not available, the client fails over to another referral. If this value is +`$true`, once the first server becomes available again, the client fails back to the first server. +If this value is `$false`, the DFS namespace server does not require the client to fail back to the +preferred server. ```yaml -Type: Boolean +Type: System.Boolean Parameter Sets: (All) Aliases: failback, TargetFailback @@ -161,12 +178,12 @@ Accept wildcard characters: False ``` ### -Path -Specifies a path for the folder. -This path must be unique. -This path cannot be the name of an existing DFS namespace folder. + +Specifies a path for the folder. This path must be unique. This path cannot be the name of an +existing DFS namespace folder. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: DfsPath, FolderPath, NamespacePath @@ -178,31 +195,27 @@ Accept wildcard characters: False ``` ### -ReferralPriorityClass -Specifies the target priority class for a DFS namespace folder. -Target priority offers you the ability to classify and rank in-site targets. -You can specify targets to receive the highest or lowest preference, and you can divide the remaining targets based on their site cost for a DFS client to connect to them. -The acceptable values for this parameter are: - -- GlobalHigh. -The highest priority class for a DFS target. -Targets assigned this class receive global preference. -- SiteCostHigh. -The highest site cost priority class for a DFS target. -Targets assigned this class receive the most preference among targets of the same site cost for a given DFS client. -- SiteCostNormal. -The middle or normal site cost priority class for a DFS target. -- SiteCostLow. -The lowest site cost priority class for a DFS target. -Targets assigned this class receive the least preference among targets of the same site cost for a given DFS client. -- GlobalLow. -The lowest level of priority class for a DFS target. -Targets assigned this class receive the least preference globally. + +Specifies the target priority class for a DFS namespace folder. Target priority offers you the +ability to classify and rank in-site targets. You can specify targets to receive the highest or +lowest preference, and you can divide the remaining targets based on their site cost for a DFS +client to connect to them. The acceptable values for this parameter are: + +- `GlobalHigh` - The highest priority class for a DFS target. Targets assigned this class receive + global preference. +- `SiteCostHigh` - The highest site cost priority class for a DFS target. Targets assigned this + class receive the most preference among targets of the same site cost for a given DFS client. +- `SiteCostNormal` - The middle or normal site cost priority class for a DFS target. +- `SiteCostLow` - The lowest site cost priority class for a DFS target. Targets assigned this class + receive the least preference among targets of the same site cost for a given DFS client. +- `GlobalLow` - The lowest level of priority class for a DFS target. Targets assigned this class + receive the least preference globally. ```yaml -Type: ReferralPriorityClass +Type: Microsoft.PowerShell.Cmdletization.GeneratedTypes.DfsNamespaceRootTarget.ReferralPriorityClass Parameter Sets: (All) Aliases: PriorityClass, Class -Accepted values: sitecostnormal, globalhigh, sitecosthigh, sitecostlow, globallow +Accepted values: SiteCostNormal, GlobalHigh, SiteCostHigh, SiteCostLow, GlobalLow Required: False Position: 8 @@ -212,12 +225,12 @@ Accept wildcard characters: False ``` ### -ReferralPriorityRank -Specifies the priority rank, as an integer, for a target in the DFS namespace. -Lower values have greater preference. -A value of zero (0) is the greatest preference. + +Specifies the priority rank, as an integer, for a target in the DFS namespace. Lower values have +greater preference. A value of zero (0) is the greatest preference. ```yaml -Type: UInt32 +Type: System.UInt32 Parameter Sets: (All) Aliases: PriorityRank, Rank @@ -229,18 +242,18 @@ Accept wildcard characters: False ``` ### -State -Specifies the state of the DFS namespace folder. -The acceptable values for this parameter are: -- Online -- Offline +Specifies the state of the DFS namespace folder. The acceptable values for this parameter are: + +- `Online` +- `Offline` Clients do not receive referrals for a DFS namespace folder that is offline. ```yaml -Type: State +Type: Microsoft.PowerShell.Cmdletization.GeneratedTypes.DfsNamespaceRootTarget.State Parameter Sets: (All) -Aliases: +Aliases: Accepted values: Offline, Online Required: False @@ -251,10 +264,11 @@ Accept wildcard characters: False ``` ### -TargetPath + Specifies a path for a target for the DFS namespace folder. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: Target, DfsTarget, FolderTarget @@ -266,18 +280,19 @@ Accept wildcard characters: False ``` ### -TargetState -Specifies the state of the DFS namespace folder target. -The acceptable values for this parameter are: -- Online -- Offline +Specifies the state of the DFS namespace folder target. The acceptable values for this parameter +are: + +- `Online` +- `Offline` Clients do not receive referrals for a DFS namespace folder target that is offline. ```yaml -Type: State +Type: Microsoft.PowerShell.Cmdletization.GeneratedTypes.DfsNamespaceRootTarget.State Parameter Sets: (All) -Aliases: +Aliases: Accepted values: Offline, Online Required: False @@ -288,14 +303,17 @@ Accept wildcard characters: False ``` ### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -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. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. + +Specifies the maximum number of concurrent operations that can be established to run the cmdlet. 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. The throttle limit applies only to the current cmdlet, not to the session or to the +computer. ```yaml -Type: Int32 +Type: System.Int32 Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -305,12 +323,12 @@ Accept wildcard characters: False ``` ### -TimeToLiveSec -Specifies a TTL interval, in seconds, for referrals. -Clients store referrals to targets for this length of time. -The default TTL interval for folder referrals is 1800 seconds (30 minutes). + +Specifies a TTL interval, in seconds, for referrals. Clients store referrals to targets for this +length of time. The default TTL interval for folder referrals is 1800 seconds (30 minutes). ```yaml -Type: UInt32 +Type: System.UInt32 Parameter Sets: (All) Aliases: ttl, TimeToLive @@ -322,11 +340,11 @@ Accept wildcard characters: False ``` ### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. + +Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi @@ -338,7 +356,11 @@ Accept wildcard characters: False ``` ### CommonParameters -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). + +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). ## INPUTS @@ -369,4 +391,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-DfsnFolder](./Remove-DfsnFolder.md) [Set-DfsnFolder](./Set-DfsnFolder.md) - diff --git a/docset/winserver2022-ps/dfsn/New-DfsnFolderTarget.md b/docset/winserver2022-ps/dfsn/New-DfsnFolderTarget.md index 09e578faa6..420b06a87e 100644 --- a/docset/winserver2022-ps/dfsn/New-DfsnFolderTarget.md +++ b/docset/winserver2022-ps/dfsn/New-DfsnFolderTarget.md @@ -18,43 +18,52 @@ Adds a target to a DFS namespace folder. ``` New-DfsnFolderTarget [-Path] [-TargetPath] [[-State] ] [[-ReferralPriorityClass] ] [[-ReferralPriorityRank] ] - [-CimSession ] [-ThrottleLimit ] [-AsJob] [-WhatIf] [-Confirm] [] + [-CimSession ] [-ThrottleLimit ] [-AsJob] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION -The **New-DfsnFolderTarget** cmdlet adds a target to a Distributed File System (DFS) namespace folder. -Specify the DFS namespace folder and the folder target. -You can set the state of the DFS namespace target and configure priority class and priority rank for referrals. -A DFS namespace folder has one or more folder targets that are shared folders on computers. -When a client attempts to connect to a folder, the DFS namespace server provides a list of folder targets, called referrals. -The server determines the order for referrals and clients attempt to connect to a folder target in the order that the server provides. +The **New-DfsnFolderTarget** cmdlet adds a target to a Distributed File System (DFS) namespace +folder. Specify the DFS namespace folder and the folder target. You can set the state of the DFS +namespace target and configure priority class and priority rank for referrals. -For more information about DFS namespaces, see [Overview of DFS Namespaces](https://technet.microsoft.com/library/cc730736) on TechNet. +A DFS namespace folder has one or more folder targets that are shared folders on computers. When a +client attempts to connect to a folder, the DFS namespace server provides a list of folder targets, +called referrals. The server determines the order for referrals and clients attempt to connect to a +folder target in the order that the server provides. + +For more information about DFS namespaces, see +[Overview of DFS Namespaces](https://technet.microsoft.com/library/cc730736) on TechNet. ## EXAMPLES ### Example 1: Add a target -``` -PS C:\> New-DfsnFolderTarget -Path "\\Contoso\AccountingResources\LegacySoftware" -TargetPath "\\Contoso-FS\Software" -ReferralPriorityClass GlobalLow + +```powershell +New-DfsnFolderTarget -Path '\\Contoso\AccountingResources\LegacySoftware' -TargetPath '\\Contoso-FS\Software' -ReferralPriorityClass 'GlobalLow' ``` -This command adds \\\\Contoso-FS\Software as a target for the DFS namespace folder \\\\Contoso\AccountingResources\LegacySoftware with a referral priority of global low. +This command adds `\\Contoso-FS\Software` as a target for the DFS namespace folder +`\\Contoso\AccountingResources\LegacySoftware` with a referral priority of global low. ## PARAMETERS ### -AsJob -Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. -The cmdlet immediately returns an object that represents the job and then displays the command prompt. -You can continue to work in the session while the job completes. -To manage the job, use the `*-Job` cmdlets. -To get the job results, use the [Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. +Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to +complete. + +The cmdlet immediately returns an object that represents the job and then displays the command +prompt. You can continue to work in the session while the job completes. To manage the job, use the +`*-Job` cmdlets. To get the job results, use the +[Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. -For more information about Windows PowerShell background jobs, see [about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). +For more information about Windows PowerShell background jobs, see +[about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -66,12 +75,14 @@ Accept wildcard characters: False ``` ### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -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. -The default is the current session on the local computer. + +Runs the cmdlet in a remote session or on a remote computer. 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. The default is the +current session on the local computer. ```yaml -Type: CimSession[] +Type: Microsoft.Management.Infrastructure.CimSession[] Parameter Sets: (All) Aliases: Session @@ -83,10 +94,11 @@ Accept wildcard characters: False ``` ### -Confirm + Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf @@ -98,11 +110,12 @@ Accept wildcard characters: False ``` ### -Path -Specifies a path of the DFS namespace folder. -This cmdlet adds a target for the folder that has the path specified. + +Specifies a path of the DFS namespace folder. This cmdlet adds a target for the folder that has the +path specified. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: DfsPath, FolderPath, NamespacePath @@ -114,31 +127,27 @@ Accept wildcard characters: False ``` ### -ReferralPriorityClass -Specifies the priority class for a DFS namespace folder target. -Target priority offers you the ability to classify and rank in-site targets. -You can specify targets to receive the highest or lowest preference, and you can divide the remaining targets based on their site cost for a DFS client to connect to them. -The acceptable values for this parameter are: - -- GlobalHigh. -The highest priority class for a DFS target. -Targets assigned this class receive global preference. -- SiteCostHigh. -The highest site cost priority class for a DFS target. -Targets assigned this class receive the most preference among targets of the same site cost for a given DFS client. -- SiteCostNormal. -The middle or normal site cost priority class for a DFS target. -- SiteCostLow. -The lowest site cost priority class for a DFS target. -Targets assigned this class receive the least preference among targets of the same site cost for a given DFS client. -- GlobalLow. -The lowest level of priority class for a DFS target. -Targets assigned this class receive the least preference globally. + +Specifies the priority class for a DFS namespace folder target. Target priority offers you the +ability to classify and rank in-site targets. You can specify targets to receive the highest or +lowest preference, and you can divide the remaining targets based on their site cost for a DFS +client to connect to them. The acceptable values for this parameter are: + +- `GlobalHigh` - The highest priority class for a DFS target. Targets assigned this class receive + global preference. +- `SiteCostHigh` - The highest site cost priority class for a DFS target. Targets assigned this + class receive the most preference among targets of the same site cost for a given DFS client. +- `SiteCostNormal` - The middle or normal site cost priority class for a DFS target. +- `SiteCostLow` - The lowest site cost priority class for a DFS target. Targets assigned this class + receive the least preference among targets of the same site cost for a given DFS client. +- `GlobalLow` - The lowest level of priority class for a DFS target. Targets assigned this class + receive the least preference globally. ```yaml -Type: ReferralPriorityClass +Type: Microsoft.PowerShell.Cmdletization.GeneratedTypes.DfsNamespaceRootTarget.ReferralPriorityClass Parameter Sets: (All) Aliases: PriorityClass, Class -Accepted values: sitecostnormal, globalhigh, sitecosthigh, sitecostlow, globallow +Accepted values: SiteCostNormal, GlobalHigh, SiteCostHigh, SiteCostLow, GlobalLow Required: False Position: 3 @@ -148,12 +157,12 @@ Accept wildcard characters: False ``` ### -ReferralPriorityRank -Specifies the priority rank, as an integer, for a target of the DFS namespace folder. -Lower values have greater preference. -A value of zero (0) is the greatest preference. + +Specifies the priority rank, as an integer, for a target of the DFS namespace folder. Lower values +have greater preference. A value of zero (0) is the greatest preference. ```yaml -Type: UInt32 +Type: System.UInt32 Parameter Sets: (All) Aliases: PriorityRank, Rank @@ -165,16 +174,16 @@ Accept wildcard characters: False ``` ### -State -Specifies the state of the DFS namespace root target. -The acceptable values for this parameter are: -- Online -- Offline +Specifies the state of the DFS namespace root target. The acceptable values for this parameter are: + +- `Online` +- `Offline` Clients do not receive referrals for a DFS namespace folder target that is offline. ```yaml -Type: State +Type: Microsoft.PowerShell.Cmdletization.GeneratedTypes.DfsNamespaceRootTarget.State Parameter Sets: (All) Aliases: Accepted values: Offline, Online @@ -187,11 +196,12 @@ Accept wildcard characters: False ``` ### -TargetPath -Specifies a path for a target of the DFS namespace folder. -This cmdlet adds this path specified as the folder target. + +Specifies a path for a target of the DFS namespace folder. This cmdlet adds this path specified as +the folder target. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: Target, DfsTarget, FolderTarget @@ -203,12 +213,15 @@ Accept wildcard characters: False ``` ### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -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. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. + +Specifies the maximum number of concurrent operations that can be established to run the cmdlet. 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. The throttle limit applies only to the current cmdlet, not to the session or to the +computer. ```yaml -Type: Int32 +Type: System.Int32 Parameter Sets: (All) Aliases: @@ -220,11 +233,11 @@ Accept wildcard characters: False ``` ### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. + +Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi @@ -236,7 +249,11 @@ Accept wildcard characters: False ``` ### CommonParameters -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). + +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). ## INPUTS @@ -261,4 +278,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-DfsnFolderTarget](./Remove-DfsnFolderTarget.md) [Set-DfsnFolderTarget](./Set-DfsnFolderTarget.md) - diff --git a/docset/winserver2022-ps/dfsn/New-DfsnRoot.md b/docset/winserver2022-ps/dfsn/New-DfsnRoot.md index f4d4e99ce7..02b3684578 100644 --- a/docset/winserver2022-ps/dfsn/New-DfsnRoot.md +++ b/docset/winserver2022-ps/dfsn/New-DfsnRoot.md @@ -25,12 +25,13 @@ New-DfsnRoot [-Path ] [-TargetPath] [-Type] [[-EnableSit ``` ## DESCRIPTION -The **New-DfsnRoot** cmdlet creates a Distributed File System (DFS) namespace. -Specify the root path and the root target path for the new namespace. -You must also specify a type: stand-alone namespace, Windows 2000 Server mode (Domain v1) namespace, or Windows Server 2008 mode (Domain v2) namespace. -You can specify settings for the new namespace. -You can use this cmdlet to enable or disable the following settings: +The **New-DfsnRoot** cmdlet creates a Distributed File System (DFS) namespace. Specify the root path +and the root target path for the new namespace. You must also specify a type: stand-alone namespace, +Windows 2000 Server mode (Domain v1) namespace, or Windows Server 2008 mode (Domain v2) namespace. + +You can specify settings for the new namespace. You can use this cmdlet to enable or disable the +following settings: - Site costing. - In-site referrals. @@ -38,46 +39,54 @@ You can use this cmdlet to enable or disable the following settings: - Root scalability. - Target failback. -You can also add a descriptive comment, select the state of the DFS namespace and DFS root target, and set the Time to Live (TTL) interval for referrals. +You can also add a descriptive comment, select the state of the DFS namespace and DFS root target, +and set the Time to Live (TTL) interval for referrals. -To manage the DFS namespace, you can grant permissions to users or user groups. -Users who have these permissions can add, remove, and modify namespace folders and folder targets for the DFS namespace. +To manage the DFS namespace, you can grant permissions to users or user groups. Users who have these +permissions can add, remove, and modify namespace folders and folder targets for the DFS namespace. -For more information about DFS namespaces, see [Overview of DFS Namespaces](https://technet.microsoft.com/library/cc730736) on TechNet. +For more information about DFS namespaces, see +[Overview of DFS Namespaces](https://technet.microsoft.com/library/cc730736) on TechNet. ## EXAMPLES ### Example 1: Create a Windows Server 2008 mode domain DFS namespace -``` -PS C:\> New-DfsnRoot -TargetPath "\\Contoso-FS\AccountingResources" -Type DomainV2 -Path "\\Contoso\AccountingResources" + +```powershell +New-DfsnRoot -TargetPath '\\Contoso-FS\AccountingResources' -Type 'DomainV2' -Path '\\Contoso\AccountingResources' ``` -This command creates a DFS namespace that has a root at the path \\\\Contoso\AccountingResources. -The root target for the path is the shared folder \\\\Contoso-FS\AccountingResources. -The namespace type is Windows Server 2008 mode, specified as a type of DomainV2. +This command creates a DFS namespace that has a root at the path `\\Contoso\AccountingResources`. +The root target for the path is the shared folder `\\Contoso-FS\AccountingResources`. The namespace +type is Windows Server 2008 mode, specified as a type of `DomainV2`. ### Example 2: Create a stand-alone DFS namespace -``` -PS C:\> New-DfsnRoot -TargetPath "\\Contoso-FS\Software" -Type Standalone -EnableSiteCosting -Path "\\Contoso\Software" + +```powershell +New-DfsnRoot -TargetPath '\\Contoso-FS\Software' -Type 'Standalone' -EnableSiteCosting -Path '\\Contoso\Software' ``` -This command creates a stand-alone DFS namespace that has a root at path \\\\Contoso\Software that has a namespace root target pointing to \\\\Contoso-FS\Software. -This namespace uses cost-based site selection. +This command creates a stand-alone DFS namespace that has a root at path `\\Contoso\Software` that +has a namespace root target pointing to `\\Contoso-FS\Software`. This namespace uses cost-based site +selection. ## PARAMETERS ### -AsJob -Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. -The cmdlet immediately returns an object that represents the job and then displays the command prompt. -You can continue to work in the session while the job completes. -To manage the job, use the `*-Job` cmdlets. -To get the job results, use the [Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. +Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to +complete. + +The cmdlet immediately returns an object that represents the job and then displays the command +prompt. You can continue to work in the session while the job completes. To manage the job, use the +`*-Job` cmdlets. To get the job results, use the +[Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. -For more information about Windows PowerShell background jobs, see [about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). +For more information about Windows PowerShell background jobs, see +[about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -89,12 +98,14 @@ Accept wildcard characters: False ``` ### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -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. -The default is the current session on the local computer. + +Runs the cmdlet in a remote session or on a remote computer. 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. The default is the +current session on the local computer. ```yaml -Type: CimSession[] +Type: Microsoft.Management.Infrastructure.CimSession[] Parameter Sets: (All) Aliases: Session @@ -106,10 +117,11 @@ Accept wildcard characters: False ``` ### -Confirm + Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf @@ -121,10 +133,11 @@ Accept wildcard characters: False ``` ### -Description + Specifies a description for a DFS namespace. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: desc @@ -136,11 +149,12 @@ Accept wildcard characters: False ``` ### -EnableAccessBasedEnumeration -Indicates whether a DFS namespace uses access-based enumeration. -If this value is $True, a DFS namespace server shows a user only the files and folders that the user can access. + +Indicates whether a DFS namespace uses access-based enumeration. If this value is `$true`, a DFS +namespace server shows a user only the files and folders that the user can access. ```yaml -Type: Boolean +Type: System.Boolean Parameter Sets: (All) Aliases: abe, abde @@ -152,12 +166,14 @@ Accept wildcard characters: False ``` ### -EnableInsiteReferrals -Indicates whether a DFS namespace server provides a client only with referrals that are in the same site as the client. -If this value is $True, the DFS namespace server provides only in-site referrals. -If this value is $False, the DFS namespace server provides in-site referrals first, then other referrals. + +Indicates whether a DFS namespace server provides a client only with referrals that are in the same +site as the client. If this value is `$true`, the DFS namespace server provides only in-site +referrals. If this value is `$false`, the DFS namespace server provides in-site referrals first, +then other referrals. ```yaml -Type: Boolean +Type: System.Boolean Parameter Sets: (All) Aliases: insite @@ -169,12 +185,13 @@ Accept wildcard characters: False ``` ### -EnableRootScalability -Indicates whether a DFS namespace uses root scalability mode. -If this value is $True, DFS namespace servers connect to the nearest domain controllers for periodic namespace updates. -If this value is $False, the servers connect to the primary domain controller (PDC) emulator. + +Indicates whether a DFS namespace uses root scalability mode. If this value is `$true`, DFS +namespace servers connect to the nearest domain controllers for periodic namespace updates. If this +value is `$false`, the servers connect to the primary domain controller (PDC) emulator. ```yaml -Type: Boolean +Type: System.Boolean Parameter Sets: (All) Aliases: RootScalability, rootscale @@ -186,12 +203,14 @@ Accept wildcard characters: False ``` ### -EnableSiteCosting -Indicates whether a DFS namespace uses cost-based selection. -If a client cannot access a folder target in-site, a DFS namespace server selects the least resource intensive alternative. -If you provide a value of $True for this parameter, DFS namespace favors high-speed links over wide area network (WAN) links. + +Indicates whether a DFS namespace uses cost-based selection. If a client cannot access a folder +target in-site, a DFS namespace server selects the least resource intensive alternative. If you +provide a value of `$true` for this parameter, DFS namespace favors high-speed links over wide area +network (WAN) links. ```yaml -Type: Boolean +Type: System.Boolean Parameter Sets: (All) Aliases: SiteCosting, sitecost @@ -203,13 +222,15 @@ Accept wildcard characters: False ``` ### -EnableTargetFailback -Indicates whether a DFS namespace uses target failback. -If a client attempts to access a target on a server and that server is not available, the client fails over to another referral. -If this value is $True, once the first server becomes available again, the client fails back to the first server. -If this value is $False, the DFS namespace server does not require the client to fail back to the preferred server. + +Indicates whether a DFS namespace uses target failback. If a client attempts to access a target on a +server and that server is not available, the client fails over to another referral. If this value is +`$true`, once the first server becomes available again, the client fails back to the first server. If +this value is `$false`, the DFS namespace server does not require the client to fail back to the +preferred server. ```yaml -Type: Boolean +Type: System.Boolean Parameter Sets: (All) Aliases: failback, TargetFailback @@ -221,12 +242,13 @@ Accept wildcard characters: False ``` ### -GrantAdminAccounts -Specifies an array of accounts. -This cmdlet grants management permissions for the DFS namespace to the users and user groups specified. -Users can add, remove, and modify namespace folders and folder targets. + +Specifies an array of accounts. This cmdlet grants management permissions for the DFS namespace to +the users and user groups specified. Users can add, remove, and modify namespace folders and folder +targets. ```yaml -Type: String[] +Type: System.String[] Parameter Sets: (All) Aliases: GrantAdmin, GrantAdminAccess @@ -238,12 +260,12 @@ Accept wildcard characters: False ``` ### -Path -Specifies a path for the root of a DFS namespace. -This path must be unique. -This path cannot be the name of an existing DFS namespace. + +Specifies a path for the root of a DFS namespace. This path must be unique. This path cannot be the +name of an existing DFS namespace. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: RootPath, root, namespace, NamespaceRoot @@ -255,31 +277,27 @@ Accept wildcard characters: False ``` ### -ReferralPriorityClass -Specifies the target priority class for a DFS namespace root. -Target priority offers you the ability to classify and rank in-site targets. -You can specify targets to receive the highest or lowest preference, and you can divide the remaining targets based on their site cost for a DFS client to connect to them. -The acceptable values for this parameter are: - -- GlobalHigh. -The highest priority class for a DFS target. -Targets assigned this class receive global preference. -- SiteCostHigh. -The highest site cost priority class for a DFS target. -Targets assigned this class receive the most preference among targets of the same site cost for a given DFS client. -- SiteCostNormal. -The middle or normal site cost priority class for a DFS target. -- SiteCostLow. -The lowest site cost priority class for a DFS target. -Targets assigned this class receive the least preference among targets of the same site cost for a given DFS client. -- GlobalLow. -The lowest level of priority class for a DFS target. -Targets assigned this class receive the least preference globally. + +Specifies the target priority class for a DFS namespace root. Target priority offers you the ability +to classify and rank in-site targets. You can specify targets to receive the highest or lowest +preference, and you can divide the remaining targets based on their site cost for a DFS client to +connect to them. The acceptable values for this parameter are: + +- `GlobalHigh` - The highest priority class for a DFS target. Targets assigned this class receive + global preference. +- `SiteCostHigh` - The highest site cost priority class for a DFS target. Targets assigned this + class receive the most preference among targets of the same site cost for a given DFS client. +- `SiteCostNormal` - The middle or normal site cost priority class for a DFS target. +- `SiteCostLow` - The lowest site cost priority class for a DFS target. Targets assigned this class + receive the least preference among targets of the same site cost for a given DFS client. +- `GlobalLow` - The lowest level of priority class for a DFS target. Targets assigned this class + receive the least preference globally. ```yaml -Type: ReferralPriorityClass +Type: Microsoft.PowerShell.Cmdletization.GeneratedTypes.DfsNamespaceRootTarget.ReferralPriorityClass Parameter Sets: (All) Aliases: PriorityClass, Class -Accepted values: sitecostnormal, globalhigh, sitecosthigh, sitecostlow, globallow +Accepted values: SiteCostNormal, GlobalHigh, SiteCostHigh, SiteCostLow, GlobalLow Required: False Position: 12 @@ -289,12 +307,12 @@ Accept wildcard characters: False ``` ### -ReferralPriorityRank -Specifies the priority rank, as an integer, for a root target of the DFS namespace. -Lower values have greater preference. -A value of zero (0) is the greatest preference. + +Specifies the priority rank, as an integer, for a root target of the DFS namespace. Lower values +have greater preference. A value of zero (0) is the greatest preference. ```yaml -Type: UInt32 +Type: System.UInt32 Parameter Sets: (All) Aliases: PriorityRank, Rank @@ -306,17 +324,17 @@ Accept wildcard characters: False ``` ### -State -Specifies the state of the DFS namespace root. -The acceptable values for this parameter are: -- Online -- Offline +Specifies the state of the DFS namespace root. The acceptable values for this parameter are: -Clients do not receive referrals for a DFS namespace folder that is offline. -If you set a namespace root to a value of Offline, the entire namespace becomes inaccessible. +- `Online` +- `Offline` + +Clients do not receive referrals for a DFS namespace folder that is offline. If you set a namespace +root to a value of Offline, the entire namespace becomes inaccessible. ```yaml -Type: State +Type: Microsoft.PowerShell.Cmdletization.GeneratedTypes.DfsNamespaceRootTarget.State Parameter Sets: (All) Aliases: Accepted values: Offline, Online @@ -329,10 +347,11 @@ Accept wildcard characters: False ``` ### -TargetPath + Specifies a path for a root target of the DFS namespace. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: NamespaceRootTarget @@ -344,16 +363,16 @@ Accept wildcard characters: False ``` ### -TargetState -Specifies the state of the DFS namespace root target. -The acceptable values for this parameter are: -- Online -- Offline +Specifies the state of the DFS namespace root target. The acceptable values for this parameter are: + +- `Online` +- `Offline` Clients do not receive referrals for a DFS namespace folder target that is Offline. ```yaml -Type: State +Type: Microsoft.PowerShell.Cmdletization.GeneratedTypes.DfsNamespaceRootTarget.State Parameter Sets: (All) Aliases: Accepted values: Offline, Online @@ -366,12 +385,15 @@ Accept wildcard characters: False ``` ### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -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. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. + +Specifies the maximum number of concurrent operations that can be established to run the cmdlet. 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. The throttle limit applies only to the current cmdlet, not to the session or to the +computer. ```yaml -Type: Int32 +Type: System.Int32 Parameter Sets: (All) Aliases: @@ -383,12 +405,12 @@ Accept wildcard characters: False ``` ### -TimeToLiveSec -Specifies a TTL interval, in seconds, for referrals. -Clients store referrals to root targets for this length of time. -The default TTL interval for root referrals is 300 seconds. + +Specifies a TTL interval, in seconds, for referrals. Clients store referrals to root targets for +this length of time. The default TTL interval for root referrals is 300 seconds. ```yaml -Type: UInt32 +Type: System.UInt32 Parameter Sets: (All) Aliases: ttl, TimeToLive @@ -400,18 +422,16 @@ Accept wildcard characters: False ``` ### -Type -Specifies the type of a DFS namespace as a Type object. -The acceptable values for this parameter are: -- Standalone. -Specifies a stand-alone namespace. -- DomainV1. -Specifies a Windows 2000 Server mode domain namespace. -- DomainV2. -Specifies a Windows Server 2008 mode domain namespace. +Specifies the type of a DFS namespace as a Type object. The acceptable values for this parameter +are: + +- `Standalone` - Specifies a stand-alone namespace. +- `DomainV1` - Specifies a Windows 2000 Server mode domain namespace. +- `DomainV2` - Specifies a Windows Server 2008 mode domain namespace. ```yaml -Type: Type +Type: Microsoft.PowerShell.Cmdletization.GeneratedTypes.DfsNamespace.Type Parameter Sets: (All) Aliases: Accepted values: Standalone, DomainV1, DomainV2 @@ -424,11 +444,11 @@ Accept wildcard characters: False ``` ### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. + +Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi @@ -440,7 +460,11 @@ Accept wildcard characters: False ``` ### CommonParameters -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). + +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). ## INPUTS @@ -473,4 +497,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-DfsnRoot](./Remove-DfsnRoot.md) [Set-DfsnRoot](./Set-DfsnRoot.md) - diff --git a/docset/winserver2022-ps/dfsn/New-DfsnRootTarget.md b/docset/winserver2022-ps/dfsn/New-DfsnRootTarget.md index f9186adb3a..ec16fcdd77 100644 --- a/docset/winserver2022-ps/dfsn/New-DfsnRootTarget.md +++ b/docset/winserver2022-ps/dfsn/New-DfsnRootTarget.md @@ -22,35 +22,42 @@ New-DfsnRootTarget [-Path ] [-TargetPath] [[-State] ] ``` ## DESCRIPTION + The **New-DfsnRootTarget** cmdlet adds a root target to a Distributed File System (DFS) namespace. -Specify the DFS namespace root folder and the new root folder target. -You can set the state of the DFS namespace target and configure priority class and priority rank for referrals. +Specify the DFS namespace root folder and the new root folder target. You can set the state of the +DFS namespace target and configure priority class and priority rank for referrals. -For more information about DFS namespaces, see [Overview of DFS Namespaces](https://technet.microsoft.com/library/cc730736) on TechNet. +For more information about DFS namespaces, see +[Overview of DFS Namespaces](https://technet.microsoft.com/library/cc730736) on TechNet. ## EXAMPLES ### Example 1: Add a DFS namespace root target -``` -PS C:\> New-DfsnRootTarget -Path "\\Contoso\Software" -TargetPath "\\Contoso-FS04\Software" + +```powershell +New-DfsnRootTarget -Path '\\Contoso\Software' -TargetPath '\\Contoso-FS04\Software' ``` -This command adds a new DFS namespace root target, \\\\Contoso-FS04\Software, to the namespace that has the root path \\\\Contoso\Software. +This command adds a new DFS namespace root target, `\\Contoso-FS04\Software`, to the namespace that +has the root path `\\Contoso\Software`. ## PARAMETERS ### -AsJob -Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. -The cmdlet immediately returns an object that represents the job and then displays the command prompt. -You can continue to work in the session while the job completes. -To manage the job, use the `*-Job` cmdlets. -To get the job results, use the [Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. +Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to +complete. + +The cmdlet immediately returns an object that represents the job and then displays the command +prompt. You can continue to work in the session while the job completes. To manage the job, use the +`*-Job` cmdlets. To get the job results, use the +[Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. -For more information about Windows PowerShell background jobs, see [about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). +For more information about Windows PowerShell background jobs, see +[about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -62,12 +69,14 @@ Accept wildcard characters: False ``` ### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -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. -The default is the current session on the local computer. + +Runs the cmdlet in a remote session or on a remote computer. 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. The default is the +current session on the local computer. ```yaml -Type: CimSession[] +Type: Microsoft.Management.Infrastructure.CimSession[] Parameter Sets: (All) Aliases: Session @@ -79,10 +88,11 @@ Accept wildcard characters: False ``` ### -Confirm + Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf @@ -94,10 +104,11 @@ Accept wildcard characters: False ``` ### -Path + Specifies a path for the root of a DFS namespace. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: DfsPath, NamespaceRoot @@ -109,31 +120,27 @@ Accept wildcard characters: False ``` ### -ReferralPriorityClass -Specifies the target priority class for a DFS namespace root. -Target priority offers you the ability to classify and rank in-site targets. -You can specify targets to receive the highest or lowest preference, and you can divide the remaining targets based on their site cost for a DFS client to connect to them. -The acceptable values for this parameter are: - -- GlobalHigh. -The highest priority class for a DFS target. -Targets assigned this class receive global preference. -- SiteCostHigh. -The highest site cost priority class for a DFS target. -Targets assigned this class receive the most preference among targets of the same site cost for a given DFS client. -- SiteCostNormal. -The middle or normal site cost priority class for a DFS target. -- SiteCostLow. -The lowest site cost priority class for a DFS target. -Targets assigned this class receive the least preference among targets of the same site cost for a given DFS client. -- GlobalLow. -The lowest level of priority class for a DFS target. -Targets assigned this class receive the least preference globally. + +Specifies the target priority class for a DFS namespace root. Target priority offers you the ability +to classify and rank in-site targets. You can specify targets to receive the highest or lowest +preference, and you can divide the remaining targets based on their site cost for a DFS client to +connect to them. The acceptable values for this parameter are: + +- `GlobalHigh` - The highest priority class for a DFS target. Targets assigned this class receive + global preference. +- `SiteCostHigh` - The highest site cost priority class for a DFS target. Targets assigned this + class receive the most preference among targets of the same site cost for a given DFS client. +- `SiteCostNormal` - The middle or normal site cost priority class for a DFS target. +- `SiteCostLow` - The lowest site cost priority class for a DFS target. Targets assigned this class + receive the least preference among targets of the same site cost for a given DFS client. +- `GlobalLow` - The lowest level of priority class for a DFS target. Targets assigned this class + receive the least preference globally. ```yaml -Type: ReferralPriorityClass +Type: Microsoft.PowerShell.Cmdletization.GeneratedTypes.DfsNamespaceRootTarget.ReferralPriorityClass Parameter Sets: (All) Aliases: PriorityClass, Class -Accepted values: sitecostnormal, globalhigh, sitecosthigh, sitecostlow, globallow +Accepted values: SiteCostNormal, GlobalHigh, SiteCostHigh, SiteCostLow, GlobalLow Required: False Position: 2 @@ -143,12 +150,12 @@ Accept wildcard characters: False ``` ### -ReferralPriorityRank -Specifies the priority rank, as an integer, for a root target of the DFS namespace. -Lower values have greater preference. -A value of zero (0) is the greatest preference. + +Specifies the priority rank, as an integer, for a root target of the DFS namespace. Lower values +have greater preference. A value of zero (0) is the greatest preference. ```yaml -Type: UInt32 +Type: System.UInt32 Parameter Sets: (All) Aliases: PriorityRank, Rank @@ -160,16 +167,16 @@ Accept wildcard characters: False ``` ### -State -Specifies the state of the DFS namespace root target. -The acceptable values for this parameter are: -- Online -- Offline +Specifies the state of the DFS namespace root target. The acceptable values for this parameter are: + +- `Online` +- `Offline` Clients do not receive referrals for a DFS namespace folder target that is offline. ```yaml -Type: State +Type: Microsoft.PowerShell.Cmdletization.GeneratedTypes.DfsNamespaceRootTarget.State Parameter Sets: (All) Aliases: Accepted values: Offline, Online @@ -182,11 +189,12 @@ Accept wildcard characters: False ``` ### -TargetPath -Specifies a path for a root target of the DFS namespace. -This cmdlet adds the folder that the path specifies. + +Specifies a path for a root target of the DFS namespace. This cmdlet adds the folder that the path +specifies. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: Target, DfsTarget, RootTargetPath @@ -198,12 +206,15 @@ Accept wildcard characters: False ``` ### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -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. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. + +Specifies the maximum number of concurrent operations that can be established to run the cmdlet. 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. The throttle limit applies only to the current cmdlet, not to the session or to the +computer. ```yaml -Type: Int32 +Type: System.Int32 Parameter Sets: (All) Aliases: @@ -215,11 +226,11 @@ Accept wildcard characters: False ``` ### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. + +Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi @@ -231,7 +242,11 @@ Accept wildcard characters: False ``` ### CommonParameters -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). + +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). ## INPUTS @@ -256,4 +271,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-DfsnRootTarget](./Remove-DfsnRootTarget.md) [Set-DfsnRootTarget](./Set-DfsnRootTarget.md) - diff --git a/docset/winserver2022-ps/dfsn/Remove-DfsnAccess.md b/docset/winserver2022-ps/dfsn/Remove-DfsnAccess.md index 206b590ea8..1451cbed78 100644 --- a/docset/winserver2022-ps/dfsn/Remove-DfsnAccess.md +++ b/docset/winserver2022-ps/dfsn/Remove-DfsnAccess.md @@ -21,28 +21,34 @@ Remove-DfsnAccess [-Path] [-AccountName] [-CimSession Remove-DfsnAccess -Path "\\Contoso\Software\Projects" -AccountName "TSQA\PattiFuller" + +```powershell +Remove-DfsnAccess -Path '\\Contoso\Software\Projects' -AccountName 'TSQA\PattiFuller' ``` -This command removes the user TSQA\PattiFuller from the access control list of \\\\Contoso\Software\Projects. +This command removes the user TSQA\PattiFuller from the access control list of +`\\Contoso\Software\Projects`. ## PARAMETERS ### -AccountName -Specifies an array of user and group accounts. -This cmdlet removes the accounts specified from the ACL of a DFS namespace folder. + +Specifies an array of user and group accounts. This cmdlet removes the accounts specified from the +ACL of a DFS namespace folder. ```yaml -Type: String[] +Type: System.String[] Parameter Sets: (All) Aliases: Account, User @@ -54,17 +60,20 @@ Accept wildcard characters: False ``` ### -AsJob -Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. -The cmdlet immediately returns an object that represents the job and then displays the command prompt. -You can continue to work in the session while the job completes. -To manage the job, use the `*-Job` cmdlets. -To get the job results, use the [Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. +Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to +complete. + +The cmdlet immediately returns an object that represents the job and then displays the command +prompt. You can continue to work in the session while the job completes. To manage the job, use the +`*-Job` cmdlets. To get the job results, use the +[Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. -For more information about Windows PowerShell background jobs, see [about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). +For more information about Windows PowerShell background jobs, see +[about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -76,12 +85,14 @@ Accept wildcard characters: False ``` ### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -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. -The default is the current session on the local computer. + +Runs the cmdlet in a remote session or on a remote computer. 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. The default is the +current session on the local computer. ```yaml -Type: CimSession[] +Type: Microsoft.Management.Infrastructure.CimSession[] Parameter Sets: (All) Aliases: Session @@ -93,10 +104,11 @@ Accept wildcard characters: False ``` ### -Confirm + Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf @@ -108,11 +120,12 @@ Accept wildcard characters: False ``` ### -Path -Specifies a path for a DFS namespace folder. -This cmdlet removes user accounts or group accounts from the ACL of the folder specified. + +Specifies a path for a DFS namespace folder. This cmdlet removes user accounts or group accounts +from the ACL of the folder specified. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: DfsPath, FolderPath, NamespacePath @@ -124,12 +137,15 @@ Accept wildcard characters: False ``` ### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -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. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. + +Specifies the maximum number of concurrent operations that can be established to run the cmdlet. 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. The throttle limit applies only to the current cmdlet, not to the session or to the +computer. ```yaml -Type: Int32 +Type: System.Int32 Parameter Sets: (All) Aliases: @@ -141,10 +157,11 @@ Accept wildcard characters: False ``` ### -WhatIf + Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi @@ -156,7 +173,11 @@ Accept wildcard characters: False ``` ### CommonParameters -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). + +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). ## INPUTS @@ -177,4 +198,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Grant-DfsnAccess](./Grant-DfsnAccess.md) [Revoke-DfsnAccess](./Revoke-DfsnAccess.md) - diff --git a/docset/winserver2022-ps/dfsn/Remove-DfsnFolder.md b/docset/winserver2022-ps/dfsn/Remove-DfsnFolder.md index df39182c2c..22e0317d4a 100644 --- a/docset/winserver2022-ps/dfsn/Remove-DfsnFolder.md +++ b/docset/winserver2022-ps/dfsn/Remove-DfsnFolder.md @@ -16,43 +16,50 @@ Removes a DFS namespace folder. ## SYNTAX ``` -Remove-DfsnFolder [-Path] [-Force] [-CimSession ] [-ThrottleLimit ] [-AsJob] - [-WhatIf] [-Confirm] [] +Remove-DfsnFolder [-Path] [-Force] [-CimSession ] [-ThrottleLimit ] + [-AsJob] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION -The **Remove-DfsnFolder** cmdlet removes a Distributed File System (DFS) namespace folder. -When you remove a folder, this cmdlet deletes all the folder targets for the folder. -This cmdlet does not delete the folders specified by DFS namespace targets or the files in those folders. -If you remove the last folder within a parent directory, the cmdlet removes the parent folder as well, unless it is the DFS namespace root. -To remove a DFS namespace root, use the **Remove-DfsnRoot** cmdlet. +The **Remove-DfsnFolder** cmdlet removes a Distributed File System (DFS) namespace folder. When you +remove a folder, this cmdlet deletes all the folder targets for the folder. This cmdlet does not +delete the folders specified by DFS namespace targets or the files in those folders. -For more information about DFS namespaces, see [Overview of DFS Namespaces](https://technet.microsoft.com/library/cc730736) on TechNet. +If you remove the last folder within a parent directory, the cmdlet removes the parent folder as +well, unless it is the DFS namespace root. To remove a DFS namespace root, use the +**Remove-DfsnRoot** cmdlet. + +For more information about DFS namespaces, see +[Overview of DFS Namespaces](https://technet.microsoft.com/library/cc730736) on TechNet. ## EXAMPLES ### Example 1: Remove a DFS namespace folder -``` -PS C:\> Remove-DfsnFolder -Path "\\Contoso\AccountingResources\LegacySoftware" + +```powershell +Remove-DfsnFolder -Path '\\Contoso\AccountingResources\LegacySoftware' ``` -This command removes the DFS namespace folder \\\\Contoso\AccountingResources\LegacySoftware. +This command removes the DFS namespace folder `\\Contoso\AccountingResources\LegacySoftware`. ## PARAMETERS ### -AsJob -Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. -The cmdlet immediately returns an object that represents the job and then displays the command prompt. -You can continue to work in the session while the job completes. -To manage the job, use the `*-Job` cmdlets. -To get the job results, use the [Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. +Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to +complete. -For more information about Windows PowerShell background jobs, see [about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). +The cmdlet immediately returns an object that represents the job and then displays the command +prompt. You can continue to work in the session while the job completes. To manage the job, use the +`*-Job` cmdlets. To get the job results, use the +[Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. + +For more information about Windows PowerShell background jobs, see +[about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -64,12 +71,14 @@ Accept wildcard characters: False ``` ### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -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. -The default is the current session on the local computer. + +Runs the cmdlet in a remote session or on a remote computer. 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. The default is the +current session on the local computer. ```yaml -Type: CimSession[] +Type: Microsoft.Management.Infrastructure.CimSession[] Parameter Sets: (All) Aliases: Session @@ -81,10 +90,11 @@ Accept wildcard characters: False ``` ### -Confirm + Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf @@ -96,11 +106,12 @@ Accept wildcard characters: False ``` ### -Force -Removes a DFS namespace folder without prompting you for confirmation. -By default, the cmdlet prompts you for confirmation before it proceeds. + +Removes a DFS namespace folder without prompting you for confirmation. By default, the cmdlet +prompts you for confirmation before it proceeds. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -112,11 +123,12 @@ Accept wildcard characters: False ``` ### -Path -Specifies the path for a DFS namespace folder. -This cmdlet removes the folder that has the path specified. + +Specifies the path for a DFS namespace folder. This cmdlet removes the folder that has the path +specified. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: DfsPath, FolderPath, NamespacePath @@ -128,12 +140,15 @@ Accept wildcard characters: False ``` ### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -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. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. + +Specifies the maximum number of concurrent operations that can be established to run the cmdlet. 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. The throttle limit applies only to the current cmdlet, not to the session or to the +computer. ```yaml -Type: Int32 +Type: System.Int32 Parameter Sets: (All) Aliases: @@ -145,11 +160,11 @@ Accept wildcard characters: False ``` ### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. + +Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi @@ -161,7 +176,11 @@ Accept wildcard characters: False ``` ### CommonParameters -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). + +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). ## INPUTS @@ -184,4 +203,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Set-DfsnFolder](./Set-DfsnFolder.md) [Remove-DfsnRoot](./Remove-DfsnRoot.md) - diff --git a/docset/winserver2022-ps/dfsn/Remove-DfsnFolderTarget.md b/docset/winserver2022-ps/dfsn/Remove-DfsnFolderTarget.md index f6f6d33d66..e96690c913 100644 --- a/docset/winserver2022-ps/dfsn/Remove-DfsnFolderTarget.md +++ b/docset/winserver2022-ps/dfsn/Remove-DfsnFolderTarget.md @@ -16,45 +16,54 @@ Removes a target for a DFS namespace folder. ## SYNTAX ``` -Remove-DfsnFolderTarget [-Path] [-TargetPath] [-Force] [-CimSession ] - [-ThrottleLimit ] [-AsJob] [-WhatIf] [-Confirm] [] +Remove-DfsnFolderTarget [-Path] [-TargetPath] [-Force] + [-CimSession ] [-ThrottleLimit ] [-AsJob] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION -The **Remove-DfsnFolderTarget** cmdlet removes a target for a Distributed File System (DFS) namespace folder. -A folder target is the Universal Naming Convention (UNC) path of a shared folder or another namespace associated with a folder in a namespace. -The folder target is where data and content is stored. -This cmdlet deletes a target, but does not delete the contents of the folder target. -A DFS namespace folder can have more than one target. -If you remove the last target associated with a DFS namespace folder, this cmdlet deletes the namespace folder as well. -Users cannot use the DFS namespace folder after you delete it. +The **Remove-DfsnFolderTarget** cmdlet removes a target for a Distributed File System (DFS) +namespace folder. A folder target is the Universal Naming Convention (UNC) path of a shared folder +or another namespace associated with a folder in a namespace. The folder target is where data and +content is stored. This cmdlet deletes a target, but does not delete the contents of the folder +target. -For more information about DFS namespaces, see [Overview of DFS Namespaces](https://technet.microsoft.com/library/cc730736) on TechNet. +A DFS namespace folder can have more than one target. If you remove the last target associated with +a DFS namespace folder, this cmdlet deletes the namespace folder as well. Users cannot use the DFS +namespace folder after you delete it. + +For more information about DFS namespaces, see +[Overview of DFS Namespaces](https://technet.microsoft.com/library/cc730736) on TechNet. ## EXAMPLES ### Example 1: Remove a folder target -``` -PS C:\> Remove-DfsnFolderTarget -Path "\\Contoso\AccountingResources\LegacySoftware" -TargetPath "\\Contoso-FS\LegacySoftware" + +```powershell +Remove-DfsnFolderTarget -Path '\\Contoso\AccountingResources\LegacySoftware' -TargetPath '\\Contoso-FS\LegacySoftware' ``` -This command removes the target \\\\Contoso-FS\LegacySoftware for the DFS namespace folder \\\\Contoso\AccountingResources\LegacySoftware. +This command removes the target `\\Contoso-FS\LegacySoftware` for the DFS namespace folder +`\\Contoso\AccountingResources\LegacySoftware`. ## PARAMETERS ### -AsJob -Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. -The cmdlet immediately returns an object that represents the job and then displays the command prompt. -You can continue to work in the session while the job completes. -To manage the job, use the `*-Job` cmdlets. -To get the job results, use the [Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. +Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to +complete. + +The cmdlet immediately returns an object that represents the job and then displays the command +prompt. You can continue to work in the session while the job completes. To manage the job, use the +`*-Job` cmdlets. To get the job results, use the +[Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. -For more information about Windows PowerShell background jobs, see [about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). +For more information about Windows PowerShell background jobs, see +[about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -66,12 +75,14 @@ Accept wildcard characters: False ``` ### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -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. -The default is the current session on the local computer. + +Runs the cmdlet in a remote session or on a remote computer. 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. The default is the +current session on the local computer. ```yaml -Type: CimSession[] +Type: Microsoft.Management.Infrastructure.CimSession[] Parameter Sets: (All) Aliases: Session @@ -83,10 +94,11 @@ Accept wildcard characters: False ``` ### -Confirm + Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf @@ -98,11 +110,12 @@ Accept wildcard characters: False ``` ### -Force -Removes a DFS namespace without prompting you for confirmation. -By default, the cmdlet prompts you for confirmation before it proceeds. + +Removes a DFS namespace without prompting you for confirmation. By default, the cmdlet prompts you +for confirmation before it proceeds. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -114,10 +127,11 @@ Accept wildcard characters: False ``` ### -Path + Specifies the path for the DFS namespace folder. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: DfsPath, FolderPath, NamespacePath @@ -129,11 +143,12 @@ Accept wildcard characters: False ``` ### -TargetPath -Specifies a path for the folder target. -This cmdlet removes the folder target that has the path specified. + +Specifies a path for the folder target. This cmdlet removes the folder target that has the path +specified. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: Target, DfsTarget, FolderTarget @@ -145,12 +160,15 @@ Accept wildcard characters: False ``` ### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -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. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. + +Specifies the maximum number of concurrent operations that can be established to run the cmdlet. 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. The throttle limit applies only to the current cmdlet, not to the session or to the +computer. ```yaml -Type: Int32 +Type: System.Int32 Parameter Sets: (All) Aliases: @@ -162,11 +180,11 @@ Accept wildcard characters: False ``` ### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. + +Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi @@ -178,7 +196,11 @@ Accept wildcard characters: False ``` ### CommonParameters -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). + +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). ## INPUTS @@ -197,4 +219,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [New-DfsnFolderTarget](./New-DfsnFolderTarget.md) [Set-DfsnFolderTarget](./Set-DfsnFolderTarget.md) - diff --git a/docset/winserver2022-ps/dfsn/Remove-DfsnRoot.md b/docset/winserver2022-ps/dfsn/Remove-DfsnRoot.md index 33d686f055..c477325cee 100644 --- a/docset/winserver2022-ps/dfsn/Remove-DfsnRoot.md +++ b/docset/winserver2022-ps/dfsn/Remove-DfsnRoot.md @@ -16,45 +16,54 @@ Removes a DFS namespace. ## SYNTAX ``` -Remove-DfsnRoot [-Path] [-Force] [-CimSession ] [-ThrottleLimit ] [-AsJob] - [-WhatIf] [-Confirm] [] +Remove-DfsnRoot [-Path] [-Force] [-CimSession ] [-ThrottleLimit ] + [-AsJob] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION -The **Remove-DfsnRoot** cmdlet removes a Distributed File System (DFS) namespace. -When you remove a namespace, you remove all the folders in the namespace. -Users cannot use the DFS namespace folders after you remove the namespace. -This cmdlet does not delete the folders specified by DFS namespace targets or the files in those folders. -For more information about DFS namespaces, see [Overview of DFS Namespaces](https://technet.microsoft.com/library/cc730736) on TechNet. +The **Remove-DfsnRoot** cmdlet removes a Distributed File System (DFS) namespace. When you remove a +namespace, you remove all the folders in the namespace. Users cannot use the DFS namespace folders +after you remove the namespace. This cmdlet does not delete the folders specified by DFS namespace +targets or the files in those folders. + +For more information about DFS namespaces, see +[Overview of DFS Namespaces](https://technet.microsoft.com/library/cc730736) on TechNet. ## EXAMPLES ### Example 1: Remove a DFS namespace + +```powershell +Remove-DfsnRoot -Path '\\Contoso\AccountingResources' ``` -PS C:\> Remove-DfsnRoot -Path "\\Contoso\AccountingResources" + +```Output Confirm Performing operation "Delete DFS Namespace" on Target "\\Contoso\AccountingResources" [Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): ``` -This command removes the DFS namespace that has the path \\\\Contoso\AccountingResources. -The command does not include the **Force** parameter, so you must confirm the operation. +This command removes the DFS namespace that has the path `\\Contoso\AccountingResources`. The +command does not include the **Force** parameter, so you must confirm the operation. ## PARAMETERS ### -AsJob -Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. -The cmdlet immediately returns an object that represents the job and then displays the command prompt. -You can continue to work in the session while the job completes. -To manage the job, use the `*-Job` cmdlets. -To get the job results, use the [Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. +Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to +complete. -For more information about Windows PowerShell background jobs, see [about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). +The cmdlet immediately returns an object that represents the job and then displays the command +prompt. You can continue to work in the session while the job completes. To manage the job, use the +`*-Job` cmdlets. To get the job results, use the +[Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. + +For more information about Windows PowerShell background jobs, see +[about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -66,12 +75,14 @@ Accept wildcard characters: False ``` ### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -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. -The default is the current session on the local computer. + +Runs the cmdlet in a remote session or on a remote computer. 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. The default is the +current session on the local computer. ```yaml -Type: CimSession[] +Type: Microsoft.Management.Infrastructure.CimSession[] Parameter Sets: (All) Aliases: Session @@ -83,10 +94,11 @@ Accept wildcard characters: False ``` ### -Confirm + Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf @@ -98,11 +110,12 @@ Accept wildcard characters: False ``` ### -Force -Removes a DFS namespace without prompting you for confirmation. -By default, the cmdlet prompts you for confirmation before it proceeds. + +Removes a DFS namespace without prompting you for confirmation. By default, the cmdlet prompts you +for confirmation before it proceeds. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -114,11 +127,12 @@ Accept wildcard characters: False ``` ### -Path -Specifies the path for the root of a DFS namespace. -This cmdlet removes the namespace that has the path specified. + +Specifies the path for the root of a DFS namespace. This cmdlet removes the namespace that has the +path specified. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: RootPath, root, namespace, NamespaceRoot @@ -130,12 +144,15 @@ Accept wildcard characters: False ``` ### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -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. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. + +Specifies the maximum number of concurrent operations that can be established to run the cmdlet. 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. The throttle limit applies only to the current cmdlet, not to the session or to the +computer. ```yaml -Type: Int32 +Type: System.Int32 Parameter Sets: (All) Aliases: @@ -147,11 +164,11 @@ Accept wildcard characters: False ``` ### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. + +Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi @@ -163,7 +180,11 @@ Accept wildcard characters: False ``` ### CommonParameters -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). + +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). ## INPUTS @@ -182,4 +203,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [New-DfsnRoot](./New-DfsnRoot.md) [Set-DfsnRoot](./Set-DfsnRoot.md) - diff --git a/docset/winserver2022-ps/dfsn/Remove-DfsnRootTarget.md b/docset/winserver2022-ps/dfsn/Remove-DfsnRootTarget.md index a159b60d0c..0321be6a43 100644 --- a/docset/winserver2022-ps/dfsn/Remove-DfsnRootTarget.md +++ b/docset/winserver2022-ps/dfsn/Remove-DfsnRootTarget.md @@ -16,43 +16,51 @@ Removes a target for a DFS namespace root. ## SYNTAX ``` -Remove-DfsnRootTarget [-Path ] [-TargetPath] [-Cleanup] [-CimSession ] - [-ThrottleLimit ] [-AsJob] [-WhatIf] [-Confirm] [] +Remove-DfsnRootTarget [-Path ] [-TargetPath] [-Cleanup] + [-CimSession ] [-ThrottleLimit ] [-AsJob] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION -The **Remove-DfsnRootTarget** cmdlet removes a target for a Distributed File System (DFS) namespace root. -This cmdlet deletes a target, but does not delete the contents of the target. -A DFS namespace root can have more than one root target. -If you remove the last root target associated with a DFS namespace root, this cmdlet deletes the namespace as well. -Users cannot use the DFS namespace path after you delete the namespace. +The **Remove-DfsnRootTarget** cmdlet removes a target for a Distributed File System (DFS) namespace +root. This cmdlet deletes a target, but does not delete the contents of the target. -For more information about DFS namespaces, see [Overview of DFS Namespaces](https://technet.microsoft.com/library/cc730736) on TechNet. +A DFS namespace root can have more than one root target. If you remove the last root target +associated with a DFS namespace root, this cmdlet deletes the namespace as well. Users cannot use +the DFS namespace path after you delete the namespace. + +For more information about DFS namespaces, see +[Overview of DFS Namespaces](https://technet.microsoft.com/library/cc730736) on TechNet. ## EXAMPLES ### Example 1: Remove a root target -``` -PS C:\> Remove-DfsnRootTarget -TargetPath "\\Contoso-FS\AccountingSoftware" -Path "\\Contoso\AccountingSoftware" + +```powershell +Remove-DfsnRootTarget -TargetPath '\\Contoso-FS\AccountingSoftware' -Path '\\Contoso\AccountingSoftware' ``` -This command removes the DFS root target path \\\\Contoso-FS\AccountingSoftware from the DFS namespace that has the path \\\\Contoso\AccountingSoftware. +This command removes the DFS root target path `\\Contoso-FS\AccountingSoftware` from the DFS +namespace that has the path `\\Contoso\AccountingSoftware`. ## PARAMETERS ### -AsJob -Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. -The cmdlet immediately returns an object that represents the job and then displays the command prompt. -You can continue to work in the session while the job completes. -To manage the job, use the `*-Job` cmdlets. -To get the job results, use the [Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. +Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to +complete. -For more information about Windows PowerShell background jobs, see [about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). +The cmdlet immediately returns an object that represents the job and then displays the command +prompt. You can continue to work in the session while the job completes. To manage the job, use the +`*-Job` cmdlets. To get the job results, use the +[Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. + +For more information about Windows PowerShell background jobs, see +[about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -64,12 +72,14 @@ Accept wildcard characters: False ``` ### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -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. -The default is the current session on the local computer. + +Runs the cmdlet in a remote session or on a remote computer. 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. The default is the +current session on the local computer. ```yaml -Type: CimSession[] +Type: Microsoft.Management.Infrastructure.CimSession[] Parameter Sets: (All) Aliases: Session @@ -81,10 +91,12 @@ Accept wildcard characters: False ``` ### -Cleanup -Indicates that the cmdlet attempts to force a clean-up of the root target in Active Directory Domain Services (AD DS). + +Indicates that the cmdlet attempts to force a clean-up of the root target in Active Directory Domain +Services (AD DS). ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -96,12 +108,13 @@ Accept wildcard characters: False ``` ### -Confirm -Prompts you for confirmation before running the cmdlet. The default value is **True** and asks for confirmation. If you do not want to confirm the operation, you must use the switch with the **False** value, as shown in this example: -**-Confirm:$False** +Prompts you for confirmation before running the cmdlet. The default value is **True** and asks for +confirmation. If you do not want to confirm the operation, you must use the switch with the +**False** value, as shown in this example: `-Confirm:$false` ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf @@ -113,10 +126,11 @@ Accept wildcard characters: False ``` ### -Path + Specifies the path for the root of a DFS namespace. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: DfsPath, NamespaceRoot @@ -128,11 +142,12 @@ Accept wildcard characters: False ``` ### -TargetPath -Specifies a path for the root target. -This cmdlet removes the root target that has the path specified. + +Specifies a path for the root target. This cmdlet removes the root target that has the path +specified. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: Target, DfsTarget, RootTargetPath @@ -144,12 +159,15 @@ Accept wildcard characters: False ``` ### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -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. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. + +Specifies the maximum number of concurrent operations that can be established to run the cmdlet. 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. The throttle limit applies only to the current cmdlet, not to the session or to the +computer. ```yaml -Type: Int32 +Type: System.Int32 Parameter Sets: (All) Aliases: @@ -161,11 +179,11 @@ Accept wildcard characters: False ``` ### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. + +Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi @@ -177,7 +195,11 @@ Accept wildcard characters: False ``` ### CommonParameters -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). + +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). ## INPUTS @@ -196,4 +218,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [New-DfsnRootTarget](./New-DfsnRootTarget.md) [Set-DfsnRootTarget](./Set-DfsnRootTarget.md) - diff --git a/docset/winserver2022-ps/dfsn/Revoke-DfsnAccess.md b/docset/winserver2022-ps/dfsn/Revoke-DfsnAccess.md index 17e27152da..4114a0783a 100644 --- a/docset/winserver2022-ps/dfsn/Revoke-DfsnAccess.md +++ b/docset/winserver2022-ps/dfsn/Revoke-DfsnAccess.md @@ -21,34 +21,45 @@ Revoke-DfsnAccess [-Path] [-AccountName] [-CimSession Revoke-DfsnAccess -Path "\\Contoso\Software\Projects" -AccountName "TSQA\PattiFuller" + +```Output AccessType : none AccountName : TSQA\PattiFuller NamespacePath : "\\Contoso\Software\Projects PSComputerName : ``` -This command revokes permissions to access and view the contents of the DFS namespace folder \\\\Contoso\Software\Projects for a specified user. +This command revokes permissions to access and view the contents of the DFS namespace folder +`\\Contoso\Software\Projects` for a specified user. ## PARAMETERS ### -AccountName -Specifies an array of user and group accounts. -This cmdlet revokes permissions for the accounts specified. + +Specifies an array of user and group accounts. This cmdlet revokes permissions for the accounts +specified. ```yaml -Type: String[] +Type: System.String[] Parameter Sets: (All) Aliases: Account, User @@ -60,17 +71,20 @@ Accept wildcard characters: False ``` ### -AsJob -Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. -The cmdlet immediately returns an object that represents the job and then displays the command prompt. -You can continue to work in the session while the job completes. -To manage the job, use the `*-Job` cmdlets. -To get the job results, use the [Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. +Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to +complete. + +The cmdlet immediately returns an object that represents the job and then displays the command +prompt. You can continue to work in the session while the job completes. To manage the job, use the +`*-Job` cmdlets. To get the job results, use the +[Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. -For more information about Windows PowerShell background jobs, see [about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). +For more information about Windows PowerShell background jobs, see +[about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -82,12 +96,14 @@ Accept wildcard characters: False ``` ### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -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. -The default is the current session on the local computer. + +Runs the cmdlet in a remote session or on a remote computer. 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. The default is the +current session on the local computer. ```yaml -Type: CimSession[] +Type: Microsoft.Management.Infrastructure.CimSession[] Parameter Sets: (All) Aliases: Session @@ -99,10 +115,11 @@ Accept wildcard characters: False ``` ### -Confirm + Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf @@ -114,11 +131,12 @@ Accept wildcard characters: False ``` ### -Path -Specifies a path for a DFS namespace folder. -This cmdlet revokes permissions for the folder specified. + +Specifies a path for a DFS namespace folder. This cmdlet revokes permissions for the folder +specified. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: DfsPath, FolderPath, NamespacePath @@ -130,12 +148,15 @@ Accept wildcard characters: False ``` ### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -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. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. + +Specifies the maximum number of concurrent operations that can be established to run the cmdlet. 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. The throttle limit applies only to the current cmdlet, not to the session or to the +computer. ```yaml -Type: Int32 +Type: System.Int32 Parameter Sets: (All) Aliases: @@ -147,10 +168,11 @@ Accept wildcard characters: False ``` ### -WhatIf + Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi @@ -162,7 +184,11 @@ Accept wildcard characters: False ``` ### CommonParameters -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). + +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). ## INPUTS @@ -183,4 +209,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Grant-DfsnAccess](./Grant-DfsnAccess.md) [Remove-DfsnAccess](./Remove-DfsnAccess.md) - diff --git a/docset/winserver2022-ps/dfsn/Set-DfsnFolder.md b/docset/winserver2022-ps/dfsn/Set-DfsnFolder.md index a81308bb93..3895d29e47 100644 --- a/docset/winserver2022-ps/dfsn/Set-DfsnFolder.md +++ b/docset/winserver2022-ps/dfsn/Set-DfsnFolder.md @@ -16,50 +16,60 @@ Changes settings for a DFS namespace folder. ## SYNTAX ``` -Set-DfsnFolder [-Path] [[-EnableInsiteReferrals] ] [[-EnableTargetFailback] ] - [[-State] ] [[-TimeToLiveSec] ] [[-Description] ] [-CimSession ] - [-ThrottleLimit ] [-AsJob] [-WhatIf] [-Confirm] [] +Set-DfsnFolder [-Path] [[-EnableInsiteReferrals] ] + [[-EnableTargetFailback]] [[-State] ] [[-TimeToLiveSec] ] + [[-Description] ] [-CimSession ] [-ThrottleLimit ] [-AsJob] [-WhatIf] + [-Confirm] [] ``` ## DESCRIPTION + The **Set-DfsnFolder** cmdlet changes settings for a Distributed File System (DFS) namespace folder. -A DFS namespace folder has one or more folder targets that are shared folders on computers. -When a client attempts to connect to a folder, the DFS namespace server provides a list of folder targets, called referrals. -The server determines the order for referrals and clients attempt to connect to a folder target in the order that the server provides. +A DFS namespace folder has one or more folder targets that are shared folders on computers. When a +client attempts to connect to a folder, the DFS namespace server provides a list of folder targets, +called referrals. The server determines the order for referrals and clients attempt to connect to a +folder target in the order that the server provides. -You can use this cmdlet to enable or disable the following settings: +You can use this cmdlet to enable or disable the following settings: -- In-site referrals. -- Target failback. +- **In-site referrals** +- **Target failback** -You can also add or change a descriptive comment, change the state of the DFS namespace, or set the Time to Live (TTL) interval for referrals. +You can also add or change a descriptive comment, change the state of the DFS namespace, or set the +Time to Live (TTL) interval for referrals. -For more information about DFS namespaces, see [Overview of DFS Namespaces](https://technet.microsoft.com/library/cc730736) on TechNet. +For more information about DFS namespaces, see +[Overview of DFS Namespaces](https://technet.microsoft.com/library/cc730736) on TechNet. ## EXAMPLES ### Example 1: Enable settings for a DFS namespace folder -``` -PS C:\> Set-DfsnFolder -Path "\\Contoso\AccountingResources\LegacySoftware" -EnableInsiteReferrals $True -EnableTargetFailback $True + +```powershell +Set-DfsnFolder -Path '\\Contoso\AccountingResources\LegacySoftware' -EnableInsiteReferrals $true -EnableTargetFailback $true ``` -This command enables in-site referrals and target failback for the DFS namespace folder \\\\Contoso\AccountingResources\LegacySoftware. +This command enables in-site referrals and target failback for the DFS namespace folder +`\\Contoso\AccountingResources\LegacySoftware`. ## PARAMETERS ### -AsJob -Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. -The cmdlet immediately returns an object that represents the job and then displays the command prompt. -You can continue to work in the session while the job completes. -To manage the job, use the `*-Job` cmdlets. -To get the job results, use the [Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. +Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to +complete. + +The cmdlet immediately returns an object that represents the job and then displays the command +prompt. You can continue to work in the session while the job completes. To manage the job, use the +`*-Job` cmdlets. To get the job results, use the +[Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. -For more information about Windows PowerShell background jobs, see [about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). +For more information about Windows PowerShell background jobs, see +[about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -71,12 +81,14 @@ Accept wildcard characters: False ``` ### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -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. -The default is the current session on the local computer. + +Runs the cmdlet in a remote session or on a remote computer. 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. The default is the +current session on the local computer. ```yaml -Type: CimSession[] +Type: Microsoft.Management.Infrastructure.CimSession[] Parameter Sets: (All) Aliases: Session @@ -88,10 +100,11 @@ Accept wildcard characters: False ``` ### -Confirm + Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf @@ -103,10 +116,11 @@ Accept wildcard characters: False ``` ### -Description + Specifies a description for a DFS namespace folder. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: desc @@ -118,12 +132,14 @@ Accept wildcard characters: False ``` ### -EnableInsiteReferrals -Indicates whether a DFS namespace server provides a client only with referrals that are in the same site as the client. -If this value is $True, a DFS namespace server provides only in-site referrals. -If this value is $False, the DFS namespace server provides in-site referrals first, then other referrals. + +Indicates whether a DFS namespace server provides a client only with referrals that are in the same +site as the client. If this value is $true, a DFS namespace server provides only in-site referrals. +If this value is $false, the DFS namespace server provides in-site referrals first, then other +referrals. ```yaml -Type: Boolean +Type: System.Boolean Parameter Sets: (All) Aliases: insite @@ -135,13 +151,15 @@ Accept wildcard characters: False ``` ### -EnableTargetFailback -Indicates whether a DFS namespace uses target failback. -If a client attempts to access target link on a server and that server is not available, the client fails over to another referral. -If this value is $True, once the first server becomes available again, the client fails back to the first server. -If this value is $False, the DFS namespace server does not require the client to use the preferred server. + +Indicates whether a DFS namespace uses target failback. If a client attempts to access target link +on a server and that server is not available, the client fails over to another referral. If this +value is `$true`, once the first server becomes available again, the client fails back to the first +server. If this value is $false, the DFS namespace server does not require the client to use the +preferred server. ```yaml -Type: Boolean +Type: System.Boolean Parameter Sets: (All) Aliases: failback, TargetFailback @@ -153,11 +171,12 @@ Accept wildcard characters: False ``` ### -Path -Specifies a path for the DFS namespace folder. -This cmdlet modifies the folder that has the path specified. + +Specifies a path for the DFS namespace folder. This cmdlet modifies the folder that has the path +specified. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: DfsPath, FolderPath, NamespacePath @@ -169,16 +188,16 @@ Accept wildcard characters: False ``` ### -State -Specifies the state of the DFS namespace folder. -The acceptable values for this parameter are: -- Online -- Offline +Specifies the state of the DFS namespace folder. The acceptable values for this parameter are: + +- `Online` +- `Offline` Clients do not receive referrals for a DFS namespace folder that is offline. ```yaml -Type: State +Type: Microsoft.PowerShell.Cmdletization.GeneratedTypes.DfsNamespaceRootTarget.State Parameter Sets: (All) Aliases: Accepted values: Offline, Online @@ -191,12 +210,15 @@ Accept wildcard characters: False ``` ### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -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. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. + +Specifies the maximum number of concurrent operations that can be established to run the cmdlet. 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. The throttle limit applies only to the current cmdlet, not to the session or to the +computer. ```yaml -Type: Int32 +Type: System.Int32 Parameter Sets: (All) Aliases: @@ -208,12 +230,12 @@ Accept wildcard characters: False ``` ### -TimeToLiveSec -Specifies a TTL interval, in seconds, for referrals. -Clients store referrals to targets for this length of time. -The default TTL interval for folder referrals is 1800 seconds (30 minutes). + +Specifies a TTL interval, in seconds, for referrals. Clients store referrals to targets for this +length of time. The default TTL interval for folder referrals is 1800 seconds (30 minutes). ```yaml -Type: UInt32 +Type: System.UInt32 Parameter Sets: (All) Aliases: ttl, TimeToLive @@ -225,11 +247,11 @@ Accept wildcard characters: False ``` ### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. + +Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi @@ -241,7 +263,11 @@ Accept wildcard characters: False ``` ### CommonParameters -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). + +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). ## INPUTS @@ -268,4 +294,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [New-DfsnFolder](./New-DfsnFolder.md) [Remove-DfsnFolder](./Remove-DfsnFolder.md) - diff --git a/docset/winserver2022-ps/dfsn/Set-DfsnFolderTarget.md b/docset/winserver2022-ps/dfsn/Set-DfsnFolderTarget.md index b4300312c3..8c4a19ccaf 100644 --- a/docset/winserver2022-ps/dfsn/Set-DfsnFolderTarget.md +++ b/docset/winserver2022-ps/dfsn/Set-DfsnFolderTarget.md @@ -18,43 +18,53 @@ Changes settings for a target of a DFS namespace folder. ``` Set-DfsnFolderTarget [-Path] [-TargetPath] [[-State] ] [[-ReferralPriorityClass] ] [[-ReferralPriorityRank] ] - [-CimSession ] [-ThrottleLimit ] [-AsJob] [-WhatIf] [-Confirm] [] + [-CimSession ] [-ThrottleLimit ] [-AsJob] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION -The **Set-DfsnRootTarget** cmdlet changes settings for a target of a Distributed File System (DFS) namespace folder. -You can change the state of the DFS namespace target and configure priority class and priority rank for referrals. -A DFS namespace folder has one or more folder targets that are shared folders on computers. -When a client attempts to connect to a folder, the DFS namespace server provides a list of folder targets, called referrals. -The server determines the order for referrals and clients attempt to connect to a folder target in the order that the server provides. +The **Set-DfsnRootTarget** cmdlet changes settings for a target of a Distributed File System (DFS) +namespace folder. You can change the state of the DFS namespace target and configure priority class +and priority rank for referrals. -For more information about DFS namespaces, see [Overview of DFS Namespaces](https://technet.microsoft.com/library/cc730736) on TechNet. +A DFS namespace folder has one or more folder targets that are shared folders on computers. When a +client attempts to connect to a folder, the DFS namespace server provides a list of folder targets, +called referrals. The server determines the order for referrals and clients attempt to connect to a +folder target in the order that the server provides. + +For more information about DFS namespaces, see +[Overview of DFS Namespaces](https://technet.microsoft.com/library/cc730736) on TechNet. ## EXAMPLES ### Example 1: Change the state for a folder target -``` -PS C:\> Set-DfsnFolderTarget -Path "\\Contoso\AccountingResources\LegacySoftware" -TargetPath "\\Contoso-FS\LegacySoftware" -State Online + +```powershell +Set-DfsnFolderTarget -Path '\\Contoso\AccountingResources\LegacySoftware' -TargetPath '\\Contoso-FS\LegacySoftware' -State 'Online' ``` -This command changes the state for a target for the folder \\\\Contoso\AccountingResources\LegacySoftware to Online. -The folder target is \\\\Contoso-FS\LegacySoftware. +This command changes the state for a target for the folder +`\\Contoso\AccountingResources\LegacySoftware` to `Online`. The folder target is +`\\Contoso-FS\LegacySoftware`. ## PARAMETERS ### -AsJob -Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. -The cmdlet immediately returns an object that represents the job and then displays the command prompt. -You can continue to work in the session while the job completes. -To manage the job, use the `*-Job` cmdlets. -To get the job results, use the [Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. +Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to +complete. + +The cmdlet immediately returns an object that represents the job and then displays the command +prompt. You can continue to work in the session while the job completes. To manage the job, use the +`*-Job` cmdlets. To get the job results, use the +[Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. -For more information about Windows PowerShell background jobs, see [about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). +For more information about Windows PowerShell background jobs, see +[about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -66,12 +76,14 @@ Accept wildcard characters: False ``` ### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -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. -The default is the current session on the local computer. + +Runs the cmdlet in a remote session or on a remote computer. 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. The default is the +current session on the local computer. ```yaml -Type: CimSession[] +Type: Microsoft.Management.Infrastructure.CimSession[] Parameter Sets: (All) Aliases: Session @@ -83,10 +95,11 @@ Accept wildcard characters: False ``` ### -Confirm + Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf @@ -98,10 +111,11 @@ Accept wildcard characters: False ``` ### -Path + Specifies a path for the DFS namespace folder. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: DfsPath, FolderPath, NamespacePath @@ -113,31 +127,27 @@ Accept wildcard characters: False ``` ### -ReferralPriorityClass -Specifies the priority class for a DFS namespace folder target. -Target priority offers you the ability to classify and rank in-site targets. -You can specify targets to receive the highest or lowest preference, and you can divide the remaining targets based on their site cost for a DFS client to connect to them. -The acceptable values for this parameter are: - -- GlobalHigh. -The highest priority class for a DFS target. -Targets assigned this class receive global preference. -- SiteCostHigh. -The highest site cost priority class for a DFS target. -Targets assigned this class receive the most preference among targets of the same site cost for a given DFS client. -- SiteCostNormal. -The middle or normal site cost priority class for a DFS target. -- SiteCostLow. -The lowest site cost priority class for a DFS target. -Targets assigned this class receive the least preference among targets of the same site cost for a given DFS client. -- GlobalLow. -The lowest level of priority class for a DFS target. -Targets assigned this class receive the least preference globally. + +Specifies the priority class for a DFS namespace folder target. Target priority offers you the +ability to classify and rank in-site targets. You can specify targets to receive the highest or +lowest preference, and you can divide the remaining targets based on their site cost for a DFS +client to connect to them. The acceptable values for this parameter are: + +- `GlobalHigh` - The highest priority class for a DFS target. Targets assigned this class receive + global preference. +- `SiteCostHigh` - The highest site cost priority class for a DFS target. Targets assigned this + class receive the most preference among targets of the same site cost for a given DFS client. +- `SiteCostNormal` - The middle or normal site cost priority class for a DFS target. +- `SiteCostLow` - The lowest site cost priority class for a DFS target. Targets assigned this class + receive the least preference among targets of the same site cost for a given DFS client. +- `GlobalLow` - The lowest level of priority class for a DFS target. Targets assigned this class + receive the least preference globally. ```yaml -Type: ReferralPriorityClass +Type: Microsoft.PowerShell.Cmdletization.GeneratedTypes.DfsNamespaceRootTarget.ReferralPriorityClass Parameter Sets: (All) Aliases: PriorityClass, Class -Accepted values: sitecostnormal, globalhigh, sitecosthigh, sitecostlow, globallow +Accepted values: SiteCostNormal, GlobalHigh, SiteCostHigh, SiteCostLow, GlobalLow Required: False Position: 3 @@ -147,12 +157,12 @@ Accept wildcard characters: False ``` ### -ReferralPriorityRank -Specifies the priority rank, as an integer, for a target of the DFS namespace folder. -Lower values have greater preference. -A value of zero (0) is the greatest preference. + +Specifies the priority rank, as an integer, for a target of the DFS namespace folder. Lower values +have greater preference. A value of zero (0) is the greatest preference. ```yaml -Type: UInt32 +Type: System.UInt32 Parameter Sets: (All) Aliases: PriorityRank, Rank @@ -164,16 +174,17 @@ Accept wildcard characters: False ``` ### -State -Specifies the state of the DFS namespace folder target. -The acceptable values for this parameter are: -- Online -- Offline +Specifies the state of the DFS namespace folder target. The acceptable values for this parameter +are: + +- `Online` +- `Offline` Clients do not receive referrals for a DFS namespace target that is offline. ```yaml -Type: State +Type: Microsoft.PowerShell.Cmdletization.GeneratedTypes.DfsNamespaceRootTarget.State Parameter Sets: (All) Aliases: Accepted values: Offline, Online @@ -186,11 +197,12 @@ Accept wildcard characters: False ``` ### -TargetPath -Specifies a path for a target of the DFS namespace folder. -This cmdlet changes settings for the target that the path specifies. + +Specifies a path for a target of the DFS namespace folder. This cmdlet changes settings for the +target that the path specifies. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: Target, DfsTarget, FolderTarget @@ -202,12 +214,15 @@ Accept wildcard characters: False ``` ### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -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. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. + +Specifies the maximum number of concurrent operations that can be established to run the cmdlet. 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. The throttle limit applies only to the current cmdlet, not to the session or to the +computer. ```yaml -Type: Int32 +Type: System.Int32 Parameter Sets: (All) Aliases: @@ -219,11 +234,11 @@ Accept wildcard characters: False ``` ### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. + +Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi @@ -235,7 +250,11 @@ Accept wildcard characters: False ``` ### CommonParameters -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). + +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). ## INPUTS @@ -262,4 +281,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Remove-DfsnFolderTarget](./Remove-DfsnFolderTarget.md) [Set-DfsnFolderTarget](./Set-DfsnFolderTarget.md) - diff --git a/docset/winserver2022-ps/dfsn/Set-DfsnRoot.md b/docset/winserver2022-ps/dfsn/Set-DfsnRoot.md index 530190146c..b9bb3eaee2 100644 --- a/docset/winserver2022-ps/dfsn/Set-DfsnRoot.md +++ b/docset/winserver2022-ps/dfsn/Set-DfsnRoot.md @@ -18,56 +18,66 @@ Changes settings for a DFS namespace. ``` Set-DfsnRoot [-Path] [[-EnableSiteCosting] ] [[-EnableInsiteReferrals] ] [[-EnableAccessBasedEnumeration] ] [[-EnableRootScalability] ] - [[-EnableTargetFailback] ] [[-Description] ] [[-State] ] [[-TimeToLiveSec] ] - [[-GrantAdminAccounts] ] [[-RevokeAdminAccounts] ] [-CimSession ] - [-ThrottleLimit ] [-AsJob] [-WhatIf] [-Confirm] [] + [[-EnableTargetFailback] ] [[-Description] ] [[-State] ] + [[-TimeToLiveSec] ] [[-GrantAdminAccounts] ] [[-RevokeAdminAccounts] ] + [-CimSession ] [-ThrottleLimit ] [-AsJob] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION + The **Set-DfsnRoot** cmdlet changes settings for a Distributed File System (DFS) namespace. -You can use this cmdlet to enable or disable the following settings: +You can use this cmdlet to enable or disable the following settings: -- Site costing. -- In-site referrals. -- Access-based enumeration. -- Root scalability. -- Target failback. +- **Site costing** +- **In-site referrals** +- **Access-based enumeration** +- **Root scalability** +- **Target failback** -You can also add or change a descriptive comment, change the state of the DFS namespace, or set the Time to Live (TTL) interval for referrals. +You can also add or change a descriptive comment, change the state of the DFS namespace, or set the +Time to Live (TTL) interval for referrals. -To manage the DFS namespace, you can use this cmdlet to grant or revoke permissions to users or user groups. -Users who have these permissions can add, remove, and modify namespace folders and folder targets for the DFS namespace. +To manage the DFS namespace, you can use this cmdlet to grant or revoke permissions to users or user +groups. Users who have these permissions can add, remove, and modify namespace folders and folder +targets for the DFS namespace. -For more information about DFS namespaces, see [Overview of DFS Namespaces](https://technet.microsoft.com/library/cc730736) on TechNet. +For more information about DFS namespaces, see +[Overview of DFS Namespaces](https://technet.microsoft.com/library/cc730736) on TechNet. ## EXAMPLES ### Example 1: Change root scalability and TTL -``` -PS C:\> Set-DfsnRoot -Path "\\Contoso\AccountingResources" -EnableRootScalability $True -TimeToLiveSec 900 + +```powershell +Set-DfsnRoot -Path '\\Contoso\AccountingResources' -EnableRootScalability $true -TimeToLiveSec 900 ``` -This command modifies settings for the DFS namespace that has the path \\\\Contoso\AccountingResources. -The command enables root scalability, which allows the DFS namespace server to poll domain controllers for updates. -The command also sets the referral TTL interval to 900 seconds. +This command modifies settings for the DFS namespace that has the path +`\\Contoso\AccountingResources`. The command enables root scalability, which allows the DFS +namespace server to poll domain controllers for updates. The command also sets the referral TTL +interval to 900 seconds. ## PARAMETERS ### -AsJob -Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. -The cmdlet immediately returns an object that represents the job and then displays the command prompt. -You can continue to work in the session while the job completes. -To manage the job, use the `*-Job` cmdlets. -To get the job results, use the [Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. +Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to +complete. -For more information about Windows PowerShell background jobs, see [about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). +The cmdlet immediately returns an object that represents the job and then displays the command +prompt. You can continue to work in the session while the job completes. To manage the job, use the +`*-Job` cmdlets. To get the job results, use the +[Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. + +For more information about Windows PowerShell background jobs, see +[about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -77,12 +87,14 @@ Accept wildcard characters: False ``` ### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -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. -The default is the current session on the local computer. + +Runs the cmdlet in a remote session or on a remote computer. 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. The default is the +current session on the local computer. ```yaml -Type: CimSession[] +Type: Microsoft.Management.Infrastructure.CimSession[] Parameter Sets: (All) Aliases: Session @@ -94,10 +106,11 @@ Accept wildcard characters: False ``` ### -Confirm + Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf @@ -109,10 +122,11 @@ Accept wildcard characters: False ``` ### -Description + Specifies a description for a DFS namespace. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: desc @@ -124,11 +138,12 @@ Accept wildcard characters: False ``` ### -EnableAccessBasedEnumeration -Indicates whether a DFS namespace uses Access-based enumeration. -If this value is $True, a DFS namespace server shows a user only the files and folders that the user can access. + +Indicates whether a DFS namespace uses Access-based enumeration. If this value is `$true`, a DFS +namespace server shows a user only the files and folders that the user can access. ```yaml -Type: Boolean +Type: System.Boolean Parameter Sets: (All) Aliases: abe, abde @@ -140,12 +155,14 @@ Accept wildcard characters: False ``` ### -EnableInsiteReferrals -Indicates whether a DFS namespace server provides a client only with referrals that are in the same site as the client. -If this value is $True, a DFS namespace server provides only in-site referrals. -If this value is $False, the DFS namespace server provides in-site referrals first, then other referrals. + +Indicates whether a DFS namespace server provides a client only with referrals that are in the same +site as the client. If this value is `$true`, a DFS namespace server provides only in-site +referrals. If this value is `$false`, the DFS namespace server provides in-site referrals first, +then other referrals. ```yaml -Type: Boolean +Type: System.Boolean Parameter Sets: (All) Aliases: insite @@ -157,12 +174,13 @@ Accept wildcard characters: False ``` ### -EnableRootScalability -Indicates whether a DFS namespace uses root scalability mode. -If this value is $True, DFS namespace servers connect to the nearest domain controllers for periodic namespace updates. -If this value is $False, the servers connect to the primary domain controller (PDC) emulator. + +Indicates whether a DFS namespace uses root scalability mode. If this value is `$true`, DFS +namespace servers connect to the nearest domain controllers for periodic namespace updates. If this +value is `$false`, the servers connect to the primary domain controller (PDC) emulator. ```yaml -Type: Boolean +Type: System.Boolean Parameter Sets: (All) Aliases: RootScalability, rootscale @@ -174,12 +192,14 @@ Accept wildcard characters: False ``` ### -EnableSiteCosting -Indicates whether a DFS namespace uses cost-based selection. -If a client cannot access a folder target in-site, a DFS namespace server selects the least resource-intensive alternative. -If you provide a value of $True for this parameter, the DFS namespace favors high-speed links over wide area network (WAN) links. + +Indicates whether a DFS namespace uses cost-based selection. If a client cannot access a folder +target in-site, a DFS namespace server selects the least resource-intensive alternative. If you +provide a value of `$true` for this parameter, the DFS namespace favors high-speed links over wide +area network (WAN) links. ```yaml -Type: Boolean +Type: System.Boolean Parameter Sets: (All) Aliases: SiteCosting, sitecost @@ -191,13 +211,15 @@ Accept wildcard characters: False ``` ### -EnableTargetFailback -Indicates whether a DFS namespace uses target failback. -If a client attempts to access target link on a server and that server is not available, the client fails over to another referral. -If this value is $True, once the first server becomes available again, the client fails back to the first server. -If this value is $False, the DFS namespace server does not require the client to fail back to the preferred server. + +Indicates whether a DFS namespace uses target failback. If a client attempts to access target link +on a server and that server is not available, the client fails over to another referral. If this +value is `$true`, once the first server becomes available again, the client fails back to the first +server. If this value is `$false`, the DFS namespace server does not require the client to fail back +to the preferred server. ```yaml -Type: Boolean +Type: System.Boolean Parameter Sets: (All) Aliases: failback, TargetFailback @@ -209,12 +231,13 @@ Accept wildcard characters: False ``` ### -GrantAdminAccounts -Specifies an array of accounts. -This cmdlet grants management permissions the users and user groups specified for the DFS namespace. -Users can add, remove, and modify namespace folders and folder targets. + +Specifies an array of accounts. This cmdlet grants management permissions the users and user groups +specified for the DFS namespace. Users can add, remove, and modify namespace folders and folder +targets. ```yaml -Type: String[] +Type: System.String[] Parameter Sets: (All) Aliases: GrantAdmin, GrantAdminAccess @@ -226,10 +249,11 @@ Accept wildcard characters: False ``` ### -Path + Specifies a path for the root of a DFS namespace. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: RootPath, root, namespace, NamespaceRoot @@ -241,11 +265,12 @@ Accept wildcard characters: False ``` ### -RevokeAdminAccounts -Specifies an array of accounts. -This cmdlet removes management permissions for the users and user groups specified for the DFS namespace. + +Specifies an array of accounts. This cmdlet removes management permissions for the users and user +groups specified for the DFS namespace. ```yaml -Type: String[] +Type: System.String[] Parameter Sets: (All) Aliases: RevokeAdmin, RevokeAdminAccess @@ -257,19 +282,19 @@ Accept wildcard characters: False ``` ### -State -Specifies the state of the DFS namespace root. -The acceptable values for this parameter are: -- Online -- Offline +Specifies the state of the DFS namespace root. The acceptable values for this parameter are: + +- `Online` +- `Offline` -Clients do not receive referrals for a DFS namespace folder that is offline. -If you set a namespace root to a value of Offline, the entire namespace becomes inaccessible. +Clients do not receive referrals for a DFS namespace folder that is offline. If you set a namespace +root to a value of `Offline`, the entire namespace becomes inaccessible. ```yaml -Type: State +Type: Microsoft.PowerShell.Cmdletization.GeneratedTypes.DfsNamespaceRootTarget.State Parameter Sets: (All) -Aliases: +Aliases: Accepted values: Offline, Online Required: False @@ -280,14 +305,17 @@ Accept wildcard characters: False ``` ### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -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. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. + +Specifies the maximum number of concurrent operations that can be established to run the cmdlet. 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. The throttle limit applies only to the current cmdlet, not to the session or to the +computer. ```yaml -Type: Int32 +Type: System.Int32 Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -297,12 +325,12 @@ Accept wildcard characters: False ``` ### -TimeToLiveSec -Specifies a TTL interval, in seconds, for referrals. -Clients store referrals to root targets for this length of time. -The default TTL interval for root referrals is 300 seconds. + +Specifies a TTL interval, in seconds, for referrals. Clients store referrals to root targets for +this length of time. The default TTL interval for root referrals is 300 seconds. ```yaml -Type: UInt32 +Type: System.UInt32 Parameter Sets: (All) Aliases: ttl, TimeToLive @@ -314,11 +342,11 @@ Accept wildcard characters: False ``` ### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. + +Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi @@ -330,7 +358,11 @@ Accept wildcard characters: False ``` ### CommonParameters -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). + +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). ## INPUTS @@ -357,4 +389,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [New-DfsnRoot](./New-DfsnRoot.md) [Remove-DfsnRoot](./Remove-DfsnRoot.md) - diff --git a/docset/winserver2022-ps/dfsn/Set-DfsnRootTarget.md b/docset/winserver2022-ps/dfsn/Set-DfsnRootTarget.md index 7e8401fd43..fa83d3f2cf 100644 --- a/docset/winserver2022-ps/dfsn/Set-DfsnRootTarget.md +++ b/docset/winserver2022-ps/dfsn/Set-DfsnRootTarget.md @@ -18,42 +18,53 @@ Changes settings for a root target of a DFS namespace. ``` Set-DfsnRootTarget [-Path] [-TargetPath] [[-State] ] [[-ReferralPriorityClass] ] [[-ReferralPriorityRank] ] - [-CimSession ] [-ThrottleLimit ] [-AsJob] [-WhatIf] [-Confirm] [] + [-CimSession ] [-ThrottleLimit ] [-AsJob] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION -The **Set-DfsnRootTarget** cmdlet changes settings for a root target of a Distributed File System (DFS) namespace. -You can change the state of the DFS namespace target and configure priority class and priority rank for referrals. -A DFS namespace folder has one or more folder targets that are shared folders on computers. -When a client attempts to connect to a folder, the DFS namespace server provides a list of folder targets, called referrals. -The server determines the order for referrals and clients attempt to connect to a folder target in the order that the server provides. +The **Set-DfsnRootTarget** cmdlet changes settings for a root target of a Distributed File System +(DFS) namespace. You can change the state of the DFS namespace target and configure priority class +and priority rank for referrals. -For more information about DFS namespaces, see [Overview of DFS Namespaces](https://technet.microsoft.com/library/cc730736) on TechNet. +A DFS namespace folder has one or more folder targets that are shared folders on computers. When a +client attempts to connect to a folder, the DFS namespace server provides a list of folder targets, +called referrals. The server determines the order for referrals and clients attempt to connect to a +folder target in the order that the server provides. + +For more information about DFS namespaces, see +[Overview of DFS Namespaces](https://technet.microsoft.com/library/cc730736) on TechNet. ## EXAMPLES ### Example 1: Set a referral priority value -``` -PS C:\> Set-DfsnRootTarget -Path "\\contoso.com\dfsroot" -TargetPath "\\Contoso-fs\dfsroot" -ReferralPriorityClass GlobalLow + +```powershell +Set-DfsnRootTarget -Path '\\contoso.com\dfsroot' -TargetPath '\\Contoso-fs\dfsroot' -ReferralPriorityClass 'GlobalLow' ``` -This command sets the referral priority class to a value of GlobalLow for the DFS namespace root target that has the path \\\\Contoso\AccountingSoftware and the target path \\\\Contoso-FS\AccountingSoftware. +This command sets the referral priority class to a value of GlobalLow for the DFS namespace root +target that has the path `\\Contoso\AccountingSoftware` and the target path +`\\Contoso-FS\AccountingSoftware`. ## PARAMETERS ### -AsJob -Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. -The cmdlet immediately returns an object that represents the job and then displays the command prompt. -You can continue to work in the session while the job completes. -To manage the job, use the `*-Job` cmdlets. -To get the job results, use the [Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. +Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to +complete. + +The cmdlet immediately returns an object that represents the job and then displays the command +prompt. You can continue to work in the session while the job completes. To manage the job, use the +`*-Job` cmdlets. To get the job results, use the +[Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. -For more information about Windows PowerShell background jobs, see [about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). +For more information about Windows PowerShell background jobs, see +[about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -65,12 +76,14 @@ Accept wildcard characters: False ``` ### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -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. -The default is the current session on the local computer. + +Runs the cmdlet in a remote session or on a remote computer. 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. The default is the +current session on the local computer. ```yaml -Type: CimSession[] +Type: Microsoft.Management.Infrastructure.CimSession[] Parameter Sets: (All) Aliases: Session @@ -82,10 +95,11 @@ Accept wildcard characters: False ``` ### -Confirm + Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf @@ -97,10 +111,11 @@ Accept wildcard characters: False ``` ### -Path + Specifies a path for the root of a DFS namespace. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: DfsPath, NamespaceRoot @@ -112,31 +127,27 @@ Accept wildcard characters: False ``` ### -ReferralPriorityClass -Specifies the priority class for a DFS namespace root target. -Target priority offers you the ability to classify and rank in-site targets. -You can specify targets to receive the highest or lowest preference, and you can divide the remaining targets based on their site cost for a DFS client to connect to them. -The acceptable values for this parameter are: - -- GlobalHigh. -The highest priority class for a DFS target. -Targets assigned this class receive global preference. -- SiteCostHigh. -The highest site cost priority class for a DFS target. -Targets assigned this class receive the most preference among targets of the same site cost for a given DFS client. -- SiteCostNormal. -The middle or normal site cost priority class for a DFS target. -- SiteCostLow. -The lowest site cost priority class for a DFS target. -Targets assigned this class receive the least preference among targets of the same site cost for a given DFS client. -- GlobalLow. -The lowest level of priority class for a DFS target. -Targets assigned this class receive the least preference globally. + +Specifies the priority class for a DFS namespace root target. Target priority offers you the ability +to classify and rank in-site targets. You can specify targets to receive the highest or lowest +preference, and you can divide the remaining targets based on their site cost for a DFS client to +connect to them. The acceptable values for this parameter are: + +- `GlobalHigh` - The highest priority class for a DFS target. Targets assigned this class receive + global preference. +- `SiteCostHigh` - The highest site cost priority class for a DFS target. Targets assigned this + class receive the most preference among targets of the same site cost for a given DFS client. +- `SiteCostNormal` - The middle or normal site cost priority class for a DFS target. +- `SiteCostLow` - The lowest site cost priority class for a DFS target. Targets assigned this class + receive the least preference among targets of the same site cost for a given DFS client. +- `GlobalLow` - The lowest level of priority class for a DFS target. Targets assigned this class + receive the least preference globally. ```yaml -Type: ReferralPriorityClass +Type: Microsoft.PowerShell.Cmdletization.GeneratedTypes.DfsNamespaceRootTarget.ReferralPriorityClass Parameter Sets: (All) Aliases: PriorityClass, Class -Accepted values: sitecostnormal, globalhigh, sitecosthigh, sitecostlow, globallow +Accepted values: SiteCostNormal, GlobalHigh, SiteCostHigh, SiteCostLow, GlobalLow Required: False Position: 3 @@ -146,12 +157,12 @@ Accept wildcard characters: False ``` ### -ReferralPriorityRank -Specifies the priority rank, as an integer, for a root target of the DFS namespace. -Lower values have greater preference. -A value of zero (0) is the greatest preference. + +Specifies the priority rank, as an integer, for a root target of the DFS namespace. Lower values +have greater preference. A value of zero (0) is the greatest preference. ```yaml -Type: UInt32 +Type: System.UInt32 Parameter Sets: (All) Aliases: PriorityRank, Rank @@ -163,16 +174,16 @@ Accept wildcard characters: False ``` ### -State -Specifies the state of the DFS namespace root target. -The acceptable values for this parameter are: -- Online -- Offline +Specifies the state of the DFS namespace root target. The acceptable values for this parameter are: + +- `Online` +- `Offline` Clients do not receive referrals for a DFS namespace target that is offline. ```yaml -Type: State +Type: Microsoft.PowerShell.Cmdletization.GeneratedTypes.DfsNamespaceRootTarget.State Parameter Sets: (All) Aliases: Accepted values: Offline, Online @@ -185,11 +196,12 @@ Accept wildcard characters: False ``` ### -TargetPath -Specifies a path for a root target of the DFS namespace. -This cmdlet changes settings for the root target that the path specifies. + +Specifies a path for a root target of the DFS namespace. This cmdlet changes settings for the root +target that the path specifies. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: Target, DfsTarget, RootTargetPath @@ -201,12 +213,15 @@ Accept wildcard characters: False ``` ### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -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. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. + +Specifies the maximum number of concurrent operations that can be established to run the cmdlet. 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. The throttle limit applies only to the current cmdlet, not to the session or to the +computer. ```yaml -Type: Int32 +Type: System.Int32 Parameter Sets: (All) Aliases: @@ -218,11 +233,11 @@ Accept wildcard characters: False ``` ### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. + +Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi @@ -234,7 +249,11 @@ Accept wildcard characters: False ``` ### CommonParameters -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). + +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). ## INPUTS @@ -259,4 +278,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [New-DfsnRootTarget](./New-DfsnRootTarget.md) [Remove-DfsnRootTarget](./Remove-DfsnRootTarget.md) - diff --git a/docset/winserver2022-ps/dfsn/Set-DfsnServerConfiguration.md b/docset/winserver2022-ps/dfsn/Set-DfsnServerConfiguration.md index f54113bbcb..a1b9bfee1b 100644 --- a/docset/winserver2022-ps/dfsn/Set-DfsnServerConfiguration.md +++ b/docset/winserver2022-ps/dfsn/Set-DfsnServerConfiguration.md @@ -17,47 +17,55 @@ Changes settings for a DFS namespace root server. ``` Set-DfsnServerConfiguration [-ComputerName] [[-SyncIntervalSec] ] - [[-EnableSiteCostedReferrals] ] [[-EnableInsiteReferrals] ] [[-LdapTimeoutSec] ] - [[-PreferLogonDC] ] [[-UseFqdn] ] [-CimSession ] [-ThrottleLimit ] - [-AsJob] [-WhatIf] [-Confirm] [] + [[-EnableSiteCostedReferrals] ] [[-EnableInsiteReferrals] ] + [[-LdapTimeoutSec] ] [[-PreferLogonDC] ] [[-UseFqdn] ] + [-CimSession ] [-ThrottleLimit ] [-AsJob] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION -The **Set-DfsnServerConfiguration** cmdlet changes settings for a Distributed File System (DFS) namespace root server. -A DFS namespace root server hosts one or more namespace root targets. -You can use this cmdlet to enable in-site referrals or to use cost in organizing referrals for targets in a site. -You can also change the synchronization interval for servers that connect to a primary domain controller (PDC) emulator and change the Lightweight Directory Access Protocol (LDAP) time-out. -You can specify whether referrals prefer the logon domain controller. -You can also specify whether the server provides referrals as fully qualified domain names (FQDN) or NETBios names. +The **Set-DfsnServerConfiguration** cmdlet changes settings for a Distributed File System (DFS) +namespace root server. A DFS namespace root server hosts one or more namespace root targets. + +You can use this cmdlet to enable in-site referrals or to use cost in organizing referrals for +targets in a site. You can also change the synchronization interval for servers that connect to a +primary domain controller (PDC) emulator and change the Lightweight Directory Access Protocol (LDAP) +time-out. You can specify whether referrals prefer the logon domain controller. You can also specify +whether the server provides referrals as fully qualified domain names (FQDN) or NETBios names. To see current values for these settings, use the **Get-DfsnServerConfiguration** cmdlet. ## EXAMPLES ### Example 1: Set LDAP time-out for a DFS namespace server -``` -PS C:\> Set-DfsnServerConfiguration -ComputerName "localhost" -LdapTimeoutSec 60 + +```powershell +Set-DfsnServerConfiguration -ComputerName 'localhost' -LdapTimeoutSec 60 ``` -This command sets an LDAP time-out value of 60 seconds for the local computer, which is a DFS namespace server. +This command sets an LDAP time-out value of 60 seconds for the local computer, which is a DFS +namespace server. ## PARAMETERS ### -AsJob -Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. -The cmdlet immediately returns an object that represents the job and then displays the command prompt. -You can continue to work in the session while the job completes. -To manage the job, use the `*-Job` cmdlets. -To get the job results, use the [Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. +Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to +complete. -For more information about Windows PowerShell background jobs, see [about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). +The cmdlet immediately returns an object that represents the job and then displays the command +prompt. You can continue to work in the session while the job completes. To manage the job, use the +`*-Job` cmdlets. To get the job results, use the +[Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. + +For more information about Windows PowerShell background jobs, see +[about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -67,12 +75,14 @@ Accept wildcard characters: False ``` ### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -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. -The default is the current session on the local computer. + +Runs the cmdlet in a remote session or on a remote computer. 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. The default is the +current session on the local computer. ```yaml -Type: CimSession[] +Type: Microsoft.Management.Infrastructure.CimSession[] Parameter Sets: (All) Aliases: Session @@ -84,10 +94,11 @@ Accept wildcard characters: False ``` ### -ComputerName + Specifies the host name or FQDN for the DFS namespace server for which the cmdlet modifies settings. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: Server, name, NamespaceServer @@ -99,10 +110,11 @@ Accept wildcard characters: False ``` ### -Confirm + Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf @@ -114,12 +126,13 @@ Accept wildcard characters: False ``` ### -EnableInsiteReferrals -Indicates whether this server provides only in-site referrals. -If you assign a value of $True, the server returns only referrals for targets in the same site as the client. -If you assign a value of $False, the server returns in-site referrals and other referrals. + +Indicates whether this server provides only in-site referrals. If you assign a value of `$true`, the +server returns only referrals for targets in the same site as the client. If you assign a value of +`$false`, the server returns in-site referrals and other referrals. ```yaml -Type: Boolean +Type: System.Boolean Parameter Sets: (All) Aliases: insite @@ -131,21 +144,23 @@ Accept wildcard characters: False ``` ### -EnableSiteCostedReferrals -Indicates whether the server can use cost-based selection. -If you specify a value of $True, the DFS namespace server provides referrals for folder targets to clients in the following order: -- Folder targets in the same site as a client, in random order. -- Folder targets for which the DFS namespace server has information. -The referrals for the nearest site are first, in random order, followed by the next nearest site, in random order. +Indicates whether the server can use cost-based selection. If you specify a value of `$true`, the +DFS namespace server provides referrals for folder targets to clients in the following order: + +- Folder targets in the same site as a client, in random order. +- Folder targets for which the DFS namespace server has information. The referrals for the nearest + site are first, in random order, followed by the next nearest site, in random order. - Targets for which DFS namespace server has no site information, in random order. -If you specify a value of $False, the DFS namespace server provides referrals for folder targets to clients in the following order: +If you specify a value of `$false`, the DFS namespace server provides referrals for folder targets to +clients in the following order: -- Folder targets in the same site as the client, in random order. +- Folder targets in the same site as the client, in random order. - Other folder targets, in random order. ```yaml -Type: Boolean +Type: System.Boolean Parameter Sets: (All) Aliases: Sitecosted, SiteCostedReferrals @@ -157,10 +172,12 @@ Accept wildcard characters: False ``` ### -LdapTimeoutSec -Specifies a time-out value, in seconds, for Lightweight Directory Access Protocol (LDAP) requests for the DFS namespace server. + +Specifies a time-out value, in seconds, for Lightweight Directory Access Protocol (LDAP) requests +for the DFS namespace server. ```yaml -Type: UInt32 +Type: System.UInt32 Parameter Sets: (All) Aliases: LdapTimeout @@ -172,13 +189,15 @@ Accept wildcard characters: False ``` ### -PreferLogonDC -Indicates whether to prefer the logon domain controller in referrals. -If you specify a value of $True for this parameter, the DFS namespace server places referrals to the computer that hosts the logon domain controller at the top of the list of referrals. + +Indicates whether to prefer the logon domain controller in referrals. If you specify a value of +`$true` for this parameter, the DFS namespace server places referrals to the computer that hosts the +logon domain controller at the top of the list of referrals. ```yaml -Type: Boolean +Type: System.Boolean Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: 5 @@ -188,11 +207,12 @@ Accept wildcard characters: False ``` ### -SyncIntervalSec -Specifies an interval, in seconds. -This interval controls how often domain-based DFS namespace root servers and domain controllers connect to the PDC emulator to get updates of DFS namespace metadata. + +Specifies an interval, in seconds. This interval controls how often domain-based DFS namespace root +servers and domain controllers connect to the PDC emulator to get updates of DFS namespace metadata. ```yaml -Type: UInt32 +Type: System.UInt32 Parameter Sets: (All) Aliases: SyncInterval @@ -204,14 +224,17 @@ Accept wildcard characters: False ``` ### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -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. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. + +Specifies the maximum number of concurrent operations that can be established to run the cmdlet. 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. The throttle limit applies only to the current cmdlet, not to the session or to the +computer. ```yaml -Type: Int32 +Type: System.Int32 Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -221,13 +244,13 @@ Accept wildcard characters: False ``` ### -UseFqdn -Indicates whether a DFS namespace server uses FQDNs in referrals. -If this parameter has a value of $True, the server uses FQDNs in referrals. -If this parameter has a value of $False, the server uses NetBIOS names. -The default for DFS namespace servers is to use NetBIOS names in referrals. + +Indicates whether a DFS namespace server uses FQDNs in referrals. If this parameter has a value of +`$true`, the server uses FQDNs in referrals. If this parameter has a value of `$false`, the server +uses NetBIOS names. The default for DFS namespace servers is to use NetBIOS names in referrals. ```yaml -Type: Boolean +Type: System.Boolean Parameter Sets: (All) Aliases: Fqdn, dfsdnsconfig, UseFullyQualifiedDomainNames @@ -239,11 +262,11 @@ Accept wildcard characters: False ``` ### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. + +Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi @@ -255,7 +278,11 @@ Accept wildcard characters: False ``` ### CommonParameters -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). + +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). ## INPUTS @@ -274,4 +301,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS [Get-DfsnServerConfiguration](./Get-DfsnServerConfiguration.md) - From a9d4ae25949ee21792b81a1aca0e2df8ae88a07a Mon Sep 17 00:00:00 2001 From: Sean Wheeler Date: Mon, 8 May 2023 16:06:36 -0500 Subject: [PATCH 435/650] Apply suggestions from code review Co-authored-by: Mikey Lombardi (He/Him) --- .../activedirectory/Set-ADUser.md | 161 +++++++++--------- 1 file changed, 85 insertions(+), 76 deletions(-) diff --git a/docset/winserver2022-ps/activedirectory/Set-ADUser.md b/docset/winserver2022-ps/activedirectory/Set-ADUser.md index 3e75667534..2294e25451 100644 --- a/docset/winserver2022-ps/activedirectory/Set-ADUser.md +++ b/docset/winserver2022-ps/activedirectory/Set-ADUser.md @@ -48,9 +48,10 @@ Set-ADUser [-WhatIf] [-Confirm] [-AuthType ] [-Credential Set-ADUser -Identity ChewDavid -HomePage 'http://fabrikam.com/employees/ChewDavid' -LogonWorkstations 'ChewDavid-DSKTOP,ChewDavid-LPTOP' +$params = @{ + Identity = 'ChewDavid' + HomePage = 'http://fabrikam.com/employees/ChewDavid' + LogonWorkstations = 'ChewDavid-DSKTOP,ChewDavid-LPTOP' +} +Set-ADUser @params ``` This command sets the specified user's **homepage** property to http://fabrikam.com/employees/ChewDavid and the **LogonWorkstations** property to ChewDavid-DSKTOP,ChewDavid-LPTOP. @@ -444,8 +450,8 @@ specifying a comma-separated list. The format for this parameter is: `-Clear Attribute1LDAPDisplayName, Attribute2LDAPDisplayName` -When you use the *Add*, *Remove*, *Replace*, and *Clear* parameters together, the operations are -performed in the following order: +When you use the **Add**, **Remove**, **Replace**, and **Clear** parameters together, the +operations are performed in the following order: - **Remove** - **Add** @@ -491,10 +497,11 @@ for the user's device. This value sets the compound identity supported flag of t - $False or 0 - $True or 1 -Warning: Domain-joined Windows systems and services such as clustering manage their own -**msDS-SupportedEncryptionTypes** attribute. Therefore any changes to the flag on the -**msDS-SupportedEncryptionTypes** attribute are overwritten by the service or system that manages -the setting. +> [!WARNING] +> Domain-joined Windows systems and services such as clustering manage their own +> **msDS-SupportedEncryptionTypes** attribute. Therefore any changes to the flag on the +> **msDS-SupportedEncryptionTypes** attribute are overwritten by the service or system that manages +> the setting. ```yaml Type: Boolean @@ -553,8 +560,8 @@ with the drive is the default. To specify this parameter, you can type a user name, such as `User1` or `Domain01\User01` or you can specify a **PSCredential** object. If you specify a user name for this parameter, the cmdlet prompts for a password. -You can also create a **PSCredential** object by using a script or by using the Get-Credential -cmdlet. You can then set the _Credential_ parameter to the **PSCredential** object. +You can also create a **PSCredential** object by using a script or by using the `Get-Credential` +cmdlet. You can then set the **Credential** parameter to the **PSCredential** object. If the acting credentials do not have directory-level permission to perform the task, Active Directory PowerShell returns a terminating error. @@ -836,9 +843,9 @@ The identifier in parentheses is the LDAP display name for the attribute. The acceptable values for this parameter are: - A distinguished name -- A GUID (objectGUID) -- A security identifier (objectSid) -- A SAM account name (sAMAccountName) +- A GUID (**objectGUID**) +- A security identifier (**objectSid**) +- A SAM account name (**sAMAccountName**) The cmdlet searches the default naming context or partition to find the object. If two or more objects are found, the cmdlet returns a non-terminating error. @@ -884,9 +891,9 @@ modified and the set of changes that should be made to that object. When this pa specified, any modifications made to the **ADUser** object are also made to the corresponding Active Directory object. The cmdlet only updates the object properties that have changed. -The **ADUser** object specified as the value of the _Instance_ parameter must have been retrieved by -using the **Get-ADUser** cmdlet. When you specify the _Instance_ parameter, you cannot specify other -parameters that set individual properties on the object. +The **ADUser** object specified as the value of the **Instance** parameter must have been retrieved +by using the `Get-ADUser` cmdlet. When you specify the **Instance** parameter, you cannot specify +other parameters that set individual properties on the object. ```yaml Type: ADUser @@ -906,22 +913,23 @@ Specifies whether an account supports Kerberos encryption types which are used d service tickets. This value sets the encryption types supported flags of the Active Directory **msDS-SupportedEncryptionTypes** attribute. The acceptable values for this parameter are: -- None -- DES -- RC4 -- AES128 -- AES256 +- `None` +- `DES` +- `RC4` +- `AES128` +- `AES256` -None removes all encryption types from the account, resulting in the KDC being unable to issue +`None` removes all encryption types from the account, resulting in the KDC being unable to issue service tickets for services using the account. DES is a weak encryption type that is not supported by default since Windows 7 and Windows Server 2008 R2. -Warning: Domain-joined Windows systems and services such as clustering manage their own -**msDS-SupportedEncryptionTypes** attribute. Therefore any changes to the flag on the -**msDS-SupportedEncryptionTypes** attribute are overwritten by the service or system that manages -the setting. +> [!WARNING] +> Domain-joined Windows systems and services such as clustering manage their own +> **msDS-SupportedEncryptionTypes** attribute. Therefore any changes to the flag on the +> **msDS-SupportedEncryptionTypes** attribute are overwritten by the service or system that manages +> the setting. ```yaml Type: ADKerberosEncryptionType @@ -938,10 +946,10 @@ Accept wildcard characters: False ### -LogonWorkstations -Specifies the computers that the user can access. To specify more than one computer, create a single -comma-separated list. You can identify a computer by using the Security Account Manager (SAM) -account name (sAMAccountName) or the DNS host name of the computer. The SAM account name is the same -as the NetBIOS name of the computer. +Specifies the computers that the user can access. To specify more than one computer, create a +single comma-separated list. You can identify a computer by using the Security Account Manager +(SAM) account name (**sAMAccountName**) or the DNS host name of the computer. The SAM account name +is the same as the NetBIOS name of the computer. The LDAP display name (**ldapDisplayName**) for this property is userWorkStations. @@ -966,9 +974,9 @@ Note: The identifier in parentheses is the LDAP display name for the property. The acceptable values for this parameter are: - A distinguished name -- A GUID (objectGUID) -- A security identifier (objectSid) -- A SAM account name (sAMAccountName) +- A GUID (**objectGUID**) +- A security identifier (**objectSid**) +- A SAM account name (**sAMAccountName**) The LDAP display name (**ldapDisplayName**) of this property is manager. @@ -1078,32 +1086,32 @@ Accept wildcard characters: False Specifies the distinguished name of an Active Directory partition. The distinguished name must be one of the naming contexts on the current directory server. -The cmdlet searches this partition to find the object defined by the _Identity_ parameter. +The cmdlet searches this partition to find the object defined by the **Identity** parameter. -In many cases, a default value is used for the _Partition_ parameter if no value is specified. The -rules for determining the default value are given below. Note that rules listed first are evaluated -first and when a default value can be determined, no further rules are evaluated. +In many cases, a default value is used for the **Partition** parameter if no value is specified. +The rules for determining the default value are given below. Note that rules listed first are +evaluated first and when a default value can be determined, no further rules are evaluated. -In AD DS environments, a default value for _Partition_ are set in the following cases: +In AD DS environments, a default value for **Partition** are set in the following cases: -- If the _Identity_ parameter is set to a distinguished name, the default value of _Partition_ is - automatically generated from this distinguished name. -- If running cmdlets from an Active Directory provider drive, the default value of _Partition_ is +- If the **Identity** parameter is set to a distinguished name, the default value of **Partition** + is automatically generated from this distinguished name. +- If running cmdlets from an Active Directory provider drive, the default value of **Partition** is automatically generated from the current path in the drive. -- If none of the previous cases apply, the default value of_Partition_ is set to the default +- If none of the previous cases apply, the default value of **Partition** is set to the default partition or naming context of the target domain. -In AD LDS environments, a default value for _Partition_ will be set in the following cases: +In AD LDS environments, a default value for **Partition** will be set in the following cases: -- If the _Identity_ parameter is set to a distinguished name, the default value of _Partition_ is - automatically generated from this distinguished name. -- If running cmdlets from an Active Directory provider drive, the default value of _Partition_ is +- If the **Identity** parameter is set to a distinguished name, the default value of **Partition** + is automatically generated from this distinguished name. +- If running cmdlets from an Active Directory provider drive, the default value of **Partition** is automatically generated from the current path in the drive. -- If the target AD LDS instance has a default naming context, the default value of _Partition_ is +- If the target AD LDS instance has a default naming context, the default value of **Partition** is set to the default naming context. To specify a default naming context for an AD LDS environment, set the **msDS-defaultNamingContext** property of the Active Directory directory service agent object (**nTDSDSA**) for the AD LDS instance. -- If none of the previous cases apply, the _Partition_ parameter does not take any default value. +- If none of the previous cases apply, the **Partition** parameter does not take any default value. ```yaml Type: String @@ -1141,11 +1149,12 @@ Specifies whether the password of an account can expire. This parameter sets the **ADS_UF_DONT_EXPIRE_PASSWD** flag of the Active Directory User Account Control attribute. The acceptable values for this parameter are: -- $False or 0 -- $True or 1 +- `$False` or `0` +- `$True` or `1` -Note: This parameter cannot be set to $True or 1 for an account that also has the -**ChangePasswordAtLogon** property set to $True. +> [!NOTE] +> This parameter cannot be set to `$True` or `1` for an account that also has the +> **ChangePasswordAtLogon** property set to `$True`. ```yaml Type: Boolean @@ -1166,8 +1175,8 @@ property of an account, such as a user or computer account. This parameter also **ADS_UF_PASSWD_NOTREQD** flag of the Active Directory User Account Control attribute. The acceptable values for this parameter are: -- $False or 0 -- $True or 1 +- `$False` or `0` +- `$True` or `1` ```yaml Type: Boolean @@ -1201,9 +1210,8 @@ Accept wildcard characters: False ### -PostalCode -Specifies the postal code or zip code. -This parameter sets the **PostalCode** property of a user object. -The LDAP display name (**ldapDisplayName**) of this property is postalCode. +Specifies the postal code or zip code. This parameter sets the **PostalCode** property of a user +object. The LDAP display name (**ldapDisplayName**) of this property is `postalCode`. ```yaml Type: String @@ -1264,8 +1272,8 @@ format for this parameter is: `-Remove @{Attribute1LDAPDisplayName=value1, value2, ...; Attribute2LDAPDisplayName=value1, value2, ...; AttributeNLDAPDisplayName=value1, value2, ...}` -When you use the _Add_, _Remove_, _Replace_, and _Clear_ parameters together, the parameters are -applied in the following sequence: +When you use the **Add**, **Remove**, **Replace**, and **Clear** parameters together, the +parameters are applied in the following sequence: - **Remove** - **Add** @@ -1295,8 +1303,8 @@ an error. The format for this parameter is: `-Replace @{Attribute1LDAPDisplayName=value1, value2, ...; Attribute2LDAPDisplayName=value1, value2, ...; AttributeNLDAPDisplayName=value1, value2, ...}` -When you use the _Add_, _Remove_, _Replace_, and _Clear_ parameters together, the operations will be -performed in the following order: +When you use the **Add**, **Remove**, **Replace**, and **Clear** parameters together, the +operations will be performed in the following order: - **Remove** - **Add** @@ -1321,10 +1329,11 @@ Specifies the Security Account Manager (SAM) account name of the user, group, co account. The maximum length of the description is 256 characters. To be compatible with older operating systems, create a SAM account name that is 20 characters or less. This parameter sets the **SAMAccountName** for an account object. The LDAP display name (**ldapDisplayName**) for this -property is sAMAccountName. +property is `sAMAccountName`. -Note: If the string value provided is not terminated with a $ character, the system adds one if -needed. +> [!NOTE] +> If the string value provided is not terminated with a `$` character, the system adds one if +> needed. ```yaml Type: String @@ -1378,7 +1387,7 @@ Directory server values: The default value for this parameter is determined by one of the following methods in the order that they are listed: -- By using the _Server_ value from objects passed through the pipeline +- By using the **Server** value from objects passed through the pipeline - By using the server information associated with the AD DS Windows PowerShell provider drive, when the cmdlet runs in that drive - By using the domain of the computer running Windows PowerShell @@ -1397,10 +1406,10 @@ Accept wildcard characters: False ### -ServicePrincipalNames -Specifies the service principal names for the account. This parameter sets the ServicePrincipalNames -property of the account. The LDAP display name (ldapDisplayName) for this property is -servicePrincipalName. This parameter uses the following syntax to add, remove, replace or clear -service principal name values. +Specifies the service principal names for the account. This parameter sets the +**ServicePrincipalNames** property of the account. The LDAP display name (**ldapDisplayName**) for +this property is `servicePrincipalName`. This parameter uses the following syntax to add, remove, +replace or clear service principal name values. Syntax: @@ -1549,8 +1558,8 @@ service. This parameter sets the **TrustedForDelegation** property of an account also sets the **ADS_UF_TRUSTED_FOR_DELEGATION** flag of the Active Directory User Account Control attribute. The acceptable values for this parameter are: -- $False or 0 -- $True or 1 +- `$False` or `0` +- `$True` or `1` ```yaml Type: Boolean @@ -1612,10 +1621,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ### None or Microsoft.ActiveDirectory.Management.ADUser -A user object is received by the _Identity_ parameter. +A user object is received by the **Identity** parameter. -A user object that was retrieved by using the **Get-ADUser** cmdlet and then modified is received by -the _Instance_ parameter. +A user object that was retrieved by using the `Get-ADUser` cmdlet and then modified is received by +the **Instance** parameter. ## OUTPUTS From 9aba27c11ccda11a914684d105c4d7485bef61e4 Mon Sep 17 00:00:00 2001 From: Sean Wheeler Date: Mon, 8 May 2023 16:10:23 -0500 Subject: [PATCH 436/650] Apply suggestions from code review Co-authored-by: Mikey Lombardi (He/Him) --- .../ServerManager/Get-WindowsFeature.md | 17 ++++++++--------- 1 file changed, 8 insertions(+), 9 deletions(-) diff --git a/docset/winserver2022-ps/ServerManager/Get-WindowsFeature.md b/docset/winserver2022-ps/ServerManager/Get-WindowsFeature.md index 1a47056053..62015a6a4b 100644 --- a/docset/winserver2022-ps/ServerManager/Get-WindowsFeature.md +++ b/docset/winserver2022-ps/ServerManager/Get-WindowsFeature.md @@ -35,10 +35,9 @@ virtual hard disk (VHD) that is running Windows Server. Get-WindowsFeature -ComputerName Server1 -Credential contoso.com\user1 ``` -This example gets a list of features that is available and installed on the -target computer named Server1. -The credentials for user user1 in the Contoso.com domain, a user who has -Administrator rights on Server1, are provided. +This example gets a list of features that are available and installed on the target computer named +`Server1`. The credentials for `user1` in the `Contoso.com` domain, a user who has Administrator +rights on `Server1`, are provided. ### Example 2 @@ -47,7 +46,7 @@ Get-WindowsFeature -Vhd D:\ps-test\vhd1.vhd ``` This example returns a list of features that is available and installed on the specified offline VHD -located at D:\ps-test\vhd1.vhd. +located at `D:\ps-test\vhd1.vhd`. ### Example 3 @@ -72,7 +71,7 @@ This example returns a list of features installed on a specified server, Server0 Get-WindowsFeature -ComputerName Server01 | Where InstallState -Eq Removed ``` -This example returns a list of features on a specified server, Server01, that have installation +This example returns a list of features on a specified server, `Server01`, that have installation files removed from the local side-by-side store, and require an external file source for installation. @@ -89,7 +88,7 @@ Valid values for the parameter include a NetBIOS name, an IP address, or a fully name of a remote computer. To use a remote computer's IP address as the value of this parameter, your command must include the -`Credential` parameter. +**Credential** parameter. The computer must either be configured for HTTPS transport, or the IP address of the remote computer must be included in the WinRM TrustedHosts list on the local computer. For information about adding a computer name to the WinRM TrustedHosts list, see "How to Add a @@ -119,7 +118,7 @@ Quotation marks are optional. -- "UserName" -- "Domain\User" -- "User@Domain.com" --- A Credential object returned by the +- A **PSCredential** object returned by the [Get-Credential](https://go.microsoft.com/fwlink/p/?LinkID=113311) cmdlet. If a user name is entered, then a prompt for a password is displayed. @@ -187,7 +186,7 @@ Use either of the following formats for the computer account: DOMAIN\SERVERNAME$ Add the `ComputerName` parameter to specify the target computer you want to use to mount the VHD. If the `ComputerName` parameter is not specified, then the local computer is used. The computer that you are using to mount the VHD must be running Windows Server. -Any local path, such as D:\myFolder, that is specified by using this parameter is always relative to +Any local path, such as `D:\myFolder`, that is specified by using this parameter is always relative to the target computer. ```yaml From 15ed2ad030c75d638915b0e0cedfeb4259e24d90 Mon Sep 17 00:00:00 2001 From: Sean Wheeler Date: Mon, 8 May 2023 16:29:50 -0500 Subject: [PATCH 437/650] Apply suggestions from code review Co-authored-by: Mikey Lombardi (He/Him) --- .../hgsclient/ConvertTo-HgsKeyProtector.md | 18 +++++++++--------- .../hgsclient/Export-HgsGuardian.md | 8 +++++--- .../Get-HgsAttestationBaselinePolicy.md | 6 +++--- .../hgsclient/Get-HgsClientConfiguration.md | 6 +++--- .../hgsclient/Get-HgsGuardian.md | 8 ++++---- .../hgsclient/Grant-HgsKeyProtectorAccess.md | 10 +++++----- 6 files changed, 29 insertions(+), 27 deletions(-) diff --git a/docset/winserver2022-ps/hgsclient/ConvertTo-HgsKeyProtector.md b/docset/winserver2022-ps/hgsclient/ConvertTo-HgsKeyProtector.md index aec3e59df8..1ef145a3b5 100644 --- a/docset/winserver2022-ps/hgsclient/ConvertTo-HgsKeyProtector.md +++ b/docset/winserver2022-ps/hgsclient/ConvertTo-HgsKeyProtector.md @@ -23,9 +23,9 @@ ConvertTo-HgsKeyProtector [-Bytes] [-CimSession ] [-Throt ## DESCRIPTION -The **ConvertTo-HgsKeyProtector** cmdlet converts an existing key protector into a Host Guardian -Service key protector object. Specify the existing key protector as a byte array. You might use this -cmdlet to import a key protector from a virtual machine configuration file. +The `ConvertTo-HgsKeyProtector` cmdlet converts an existing key protector into a Host Guardian +Service key protector object. Specify the existing key protector as a byte array. You might use +this cmdlet to import a key protector from a virtual machine configuration file. ## EXAMPLES @@ -38,14 +38,14 @@ $KeyProtector = ConvertTo-HgsKeyProtector -Bytes $VirtualMachineKeyProtector ``` The first command gets the Trusted Platform Module (TPM) object for the virtual machine named -Shielded Virtual Machine 17. The command stores the object in the **$VirtualTPM** variable. +Shielded Virtual Machine 17. The command stores the object in the `$VirtualTPM` variable. -The second command stores the **KeyProtector** property of the object stored in **$VirtualTPM** in -the **$VirtualMachineKeyProtector** variable. +The second command stores the **KeyProtector** property of the object stored in `$VirtualTPM` in +the `$VirtualMachineKeyProtector` variable. The final command creates a Host Guardian Service key protector object from the byte array -representation stored in **$VirtualMachineKeyProtector**. The command stores the new key protector -in the **$KeyProtector** variable. +representation stored in `$VirtualMachineKeyProtector`. The command stores the new key protector +in the `$KeyProtector` variable. ## PARAMETERS @@ -145,7 +145,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable This cmdlet returns a key protector. -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays +The **Microsoft.Management.Infrastructure.CimInstance** object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. diff --git a/docset/winserver2022-ps/hgsclient/Export-HgsGuardian.md b/docset/winserver2022-ps/hgsclient/Export-HgsGuardian.md index 3524873d41..dcaaa80c99 100644 --- a/docset/winserver2022-ps/hgsclient/Export-HgsGuardian.md +++ b/docset/winserver2022-ps/hgsclient/Export-HgsGuardian.md @@ -21,17 +21,18 @@ Export-HgsGuardian [-InputObject] [-Path] [ Get-HgsAttestationBaselinePolicy -Path "C:\Logs\AttestationBaselinePolicy001" -Force +Get-HgsAttestationBaselinePolicy -Path 'C:\Logs\AttestationBaselinePolicy001' -Force ``` This command generates a byte array that represents the baseline policy in the file `C:\Logs\AttestationBaselinePolicy001`. diff --git a/docset/winserver2022-ps/hgsclient/Get-HgsClientConfiguration.md b/docset/winserver2022-ps/hgsclient/Get-HgsClientConfiguration.md index 3c5333ca11..d3a088eba2 100644 --- a/docset/winserver2022-ps/hgsclient/Get-HgsClientConfiguration.md +++ b/docset/winserver2022-ps/hgsclient/Get-HgsClientConfiguration.md @@ -22,7 +22,7 @@ Get-HgsClientConfiguration [-CimSession ] [-ThrottleLimit ] ## DESCRIPTION -The **Get-HgsClientConfiguration** cmdlet get the configuration of the local Host Guardian Service +The `Get-HgsClientConfiguration` cmdlet get the configuration of the local Host Guardian Service client. ## EXAMPLES @@ -30,7 +30,7 @@ client. ### Example 1: Get client configuration ```powershell -PS C:\> Get-HgsClientConfiguration +Get-HgsClientConfiguration ``` This command gets the configuration of the local Host Guardian Service client. @@ -115,7 +115,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ### CimInstance#MSFT_HgsClientConfiguration This cmdlet returns the configuration of a Host Guardian Service client as a **CimInstance** object. -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays +The **Microsoft.Management.Infrastructure.CimInstance** object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. diff --git a/docset/winserver2022-ps/hgsclient/Get-HgsGuardian.md b/docset/winserver2022-ps/hgsclient/Get-HgsGuardian.md index e936114040..efdbab331d 100644 --- a/docset/winserver2022-ps/hgsclient/Get-HgsGuardian.md +++ b/docset/winserver2022-ps/hgsclient/Get-HgsGuardian.md @@ -22,9 +22,9 @@ Get-HgsGuardian [[-Name] ] [-CimSession ] [-ThrottleLimi ## DESCRIPTION -The **Get-HgsGuardian** cmdlet gets Host Guardian Service guardian objects from persistent storage. -For a computer configured in **HostGuardianService** mode, this cmdlet returns no result. -The **New-HgsKeyProtector** cmdlet requires **HgsGuardian** objects. +The `Get-HgsGuardian` cmdlet gets Host Guardian Service guardian objects from persistent storage. +For a computer configured in `HostGuardianService` mode, this cmdlet returns no result. The +`New-HgsKeyProtector` cmdlet requires **HgsGuardian** objects. ## EXAMPLES @@ -39,7 +39,7 @@ This command gets all guardians configured for this computer. ### Example 2: Get a guardian by using its name ```powershell -PS C:\> Get-HgsGuardian -Name "Guardian11" +Get-HgsGuardian -Name 'Guardian11' ``` This command gets a guardian named Guardian11. diff --git a/docset/winserver2022-ps/hgsclient/Grant-HgsKeyProtectorAccess.md b/docset/winserver2022-ps/hgsclient/Grant-HgsKeyProtectorAccess.md index 48222ba9d5..46ae69b8fe 100644 --- a/docset/winserver2022-ps/hgsclient/Grant-HgsKeyProtectorAccess.md +++ b/docset/winserver2022-ps/hgsclient/Grant-HgsKeyProtectorAccess.md @@ -30,16 +30,16 @@ Grant-HgsKeyProtectorAccess -KeyProtector -GuardianFriendlyName Date: Mon, 8 May 2023 18:08:41 -0500 Subject: [PATCH 438/650] Update New-ADUser.md Format cleanup --- .../activedirectory/New-ADUser.md | 904 +++++++----------- 1 file changed, 361 insertions(+), 543 deletions(-) diff --git a/docset/winserver2022-ps/activedirectory/New-ADUser.md b/docset/winserver2022-ps/activedirectory/New-ADUser.md index 056f044860..1d824f5bc4 100644 --- a/docset/winserver2022-ps/activedirectory/New-ADUser.md +++ b/docset/winserver2022-ps/activedirectory/New-ADUser.md @@ -17,62 +17,65 @@ Creates an Active Directory user. ## SYNTAX ```powershell -New-ADUser [-WhatIf] [-Confirm] [-AccountExpirationDate ] [-AccountNotDelegated ] +New-ADUser [-AccountExpirationDate ] [-AccountNotDelegated ] [-AccountPassword ] [-AllowReversiblePasswordEncryption ] - [-AuthenticationPolicy ] [-AuthenticationPolicySilo ] - [-AuthType ] [-CannotChangePassword ] [-Certificates ] - [-ChangePasswordAtLogon ] [-City ] [-Company ] [-CompoundIdentitySupported ] - [-Country ] [-Credential ] [-Department ] [-Description ] - [-DisplayName ] [-Division ] [-EmailAddress ] [-EmployeeID ] - [-EmployeeNumber ] [-Enabled ] [-Fax ] [-GivenName ] - [-HomeDirectory ] [-HomeDrive ] [-HomePage ] [-HomePhone ] - [-Initials ] [-Instance ] [-KerberosEncryptionType ] - [-LogonWorkstations ] [-Manager ] [-MobilePhone ] [-Name] [-Office ] - [-OfficePhone ] [-Organization ] [-OtherAttributes ] [-OtherName ] - [-PassThru] [-PasswordNeverExpires ] [-PasswordNotRequired ] [-Path ] - [-POBox ] [-PostalCode ] [-PrincipalsAllowedToDelegateToAccount ] - [-ProfilePath ] [-SamAccountName ] [-ScriptPath ] [-Server ] + [-AuthenticationPolicy ] + [-AuthenticationPolicySilo ] [-AuthType ] + [-CannotChangePassword ] [-Certificates ] + [-ChangePasswordAtLogon ] [-City ] [-Company ] + [-CompoundIdentitySupported ] [-Country ] [-Credential ] + [-Department ] [-Description ] [-DisplayName ] [-Division ] + [-EmailAddress ] [-EmployeeID ] [-EmployeeNumber ] [-Enabled ] + [-Fax ] [-GivenName ] [-HomeDirectory ] [-HomeDrive ] + [-HomePage ] [-HomePhone ] [-Initials ] [-Instance ] + [-KerberosEncryptionType ] [-LogonWorkstations ] + [-Manager ] [-MobilePhone ] [-Name] [-Office ] + [-OfficePhone ] [-Organization ] [-OtherAttributes ] + [-OtherName ] [-PassThru] [-PasswordNeverExpires ] + [-PasswordNotRequired ] [-Path ] [-POBox ] [-PostalCode ] + [-PrincipalsAllowedToDelegateToAccount ] [-ProfilePath ] + [-SamAccountName ] [-ScriptPath ] [-Server ] [-ServicePrincipalNames ] [-SmartcardLogonRequired ] [-State ] [-StreetAddress ] [-Surname ] [-Title ] [-TrustedForDelegation ] - [-Type ] [-UserPrincipalName ] [] + [-Type ] [-UserPrincipalName ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION -The `New-ADUser` cmdlet creates an Active Directory user. -You can set commonly used user property values by using the cmdlet parameters. +The `New-ADUser` cmdlet creates an Active Directory user. You can set commonly used user property +values by using the cmdlet parameters. You can set property values that are not associated with cmdlet parameters by using the -_OtherAttributes_ parameter. When using this parameter, be sure to place single quotes around the +**OtherAttributes** parameter. When using this parameter, be sure to place single quotes around the attribute name. -You must specify the _SamAccountName_ parameter to create a user. +You must specify the **SamAccountName** parameter to create a user. You can use the `New-ADUser` cmdlet to create different types of user accounts such as iNetOrgPerson -accounts. To do this in Active Directory Domain Services (AD DS), set the _Type_ parameter to the +accounts. To do this in Active Directory Domain Services (AD DS), set the **Type** parameter to the Lightweight Directory Access Protocol (LDAP) display name for the type of account you want to create. This type can be any class in the Active Directory schema that is a subclass of user and that has an object category of person. -The _Path_ parameter specifies the container or organizational unit (OU) for the new user. When you -do not specify the _Path_ parameter, the cmdlet creates a user object in the default container for -user objects in the domain. +The **Path** parameter specifies the container or organizational unit (OU) for the new user. When +you do not specify the **Path** parameter, the cmdlet creates a user object in the default container +for user objects in the domain. The following methods explain different ways to create an object by using this cmdlet. -Method 1: Use the `New-ADUser` cmdlet, specify the required parameters, and set any additional -property values by using the cmdlet parameters. +- Method 1: Use the `New-ADUser` cmdlet, specify the required parameters, and set any additional + property values by using the cmdlet parameters. -Method 2: Use a template to create the new object. To do this, create a new user object or retrieve -a copy of an existing user object and set the _Instance_ parameter to this object. The object -provided to the _Instance_ parameter is used as a template for the new object. You can override -property values from the template by setting cmdlet parameters. For examples and more information, -see the _Instance_ parameter description for this cmdlet. +- Method 2: Use a template to create the new object. To do this, create a new user object or + retrieve a copy of an existing user object and set the **Instance** parameter to this object. The + object provided to the **Instance** parameter is used as a template for the new object. You can + override property values from the template by setting cmdlet parameters. For examples and more + information, see the **Instance** parameter description for this cmdlet. -Method 3: Use the Import-Csv cmdlet with the `New-ADUser` cmdlet to create multiple Active Directory -user objects. To do this, use the `Import-Csv` cmdlet to create the custom objects from a -comma-separated value (CSV) file that contains a list of object properties. Then pass these objects -through the pipeline to the `New-ADUser` cmdlet to create the user objects. +- Method 3: Use the `Import-Csv` cmdlet with the `New-ADUser` cmdlet to create multiple Active + Directory user objects. To do this, use the `Import-Csv` cmdlet to create the custom objects from + a comma-separated value (CSV) file that contains a list of object properties. Then pass these + objects through the pipeline to the `New-ADUser` cmdlet to create the user objects. ## EXAMPLES @@ -81,17 +84,20 @@ through the pipeline to the `New-ADUser` cmdlet to create the user objects. ```powershell $splat = @{ Name = 'ChewDavid' - Certificate = (New-Object System.Security.Cryptography.X509Certificates.X509Certificate -ArgumentList "Export.cer") + Certificate = (New-Object System.Security.Cryptography.X509Certificates.X509Certificate -ArgumentList 'Export.cer') } New-ADUser @splat ``` -This command creates a user named ChewDavid with a certificate imported from the file Export.cer. +This command creates a user named `ChewDavid` with a certificate imported from the file `Export.cer`. ### Example 2: Create a user and set properties ```powershell -New-ADUser -Name "ChewDavid" -OtherAttributes @{'title'="director";'mail'="chewdavid@fabrikam.com"} +New-ADUser -Name 'ChewDavid' -OtherAttributes @{ + 'title'='director' + 'mail'='chewdavid@fabrikam.com' +} ``` This command creates a new user named ChewDavid and sets the **title** and **mail** properties on @@ -100,7 +106,7 @@ the new object. ### Example 3: Create an inetOrgPerson user ```powershell -New-ADUser -Name "ChewDavid" -Type iNetOrgPerson -Path "DC=AppNC" -Server lds.Fabrikam.com:50000 +New-ADUser -Name 'ChewDavid' -Type iNetOrgPerson -Path 'DC=AppNC' -Server lds.Fabrikam.com:50000 ``` This command creates an **inetOrgPerson**-class user named ChewDavid on an AD LDS instance. @@ -109,8 +115,8 @@ This command creates an **inetOrgPerson**-class user named ChewDavid on an AD LD ```powershell $splat = @{ - Name = "ChewDavid" - AccountPassword = (Read-Host -AsSecureString "AccountPassword") + Name = 'ChewDavid' + AccountPassword = (Read-Host -AsSecureString 'AccountPassword') Enabled = $true } New-ADUser @splat @@ -122,24 +128,16 @@ This command creates a new user named ChewDavid and sets the account password. ### -AccountExpirationDate -Specifies the expiration date for an account. - -This parameter sets the **AccountExpirationDate** property of an account object. - -The LDAP display name (**ldapDisplayName**) for this property is accountExpires. - -Use the **DateTime** syntax when you specify this parameter. - -Time is assumed to be local time unless otherwise specified. - -When a time value is not specified, the time is assumed to 12:00:00 AM local time. - -When a date is not specified, the date is assumed to be the current date. +Specifies the expiration date for an account. This parameter sets the **AccountExpirationDate** +property of an account object. The LDAP display name (**ldapDisplayName**) for this property is +`accountExpires`. Use the **DateTime** syntax when you specify this parameter. Time is assumed to be +local time unless otherwise specified. When a time value is not specified, the time is assumed to +12:00:00 AM local time. When a date is not specified, the date is assumed to be the current date. ```yaml Type: DateTime Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -151,23 +149,20 @@ Accept wildcard characters: False ### -AccountNotDelegated Indicates whether the security context of the user is delegated to a service. When this parameter is -set to `$True`, the security context of the account is not delegated to a service even when the -service account is set as trusted for Kerberos delegation. - -This parameter sets the **AccountNotDelegated** property for an Active Directory account. - -This parameter also sets the **ADS_UF_NOT_DELEGATED** flag of the Active Directory User Account -Control (UAC) attribute. +set to `$true`, the security context of the account is not delegated to a service even when the +service account is set as trusted for Kerberos delegation. This parameter sets the +**AccountNotDelegated** property for an Active Directory account. This parameter also sets the +**ADS_UF_NOT_DELEGATED** flag of the Active Directory User Account Control (UAC) attribute. The acceptable values for this parameter are: -- `$False` or 0 -- `$True` or 1 +- `$false` or 0 +- `$true` or 1 ```yaml Type: System.Boolean Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -193,16 +188,16 @@ The following conditions apply based on the manner in which the password paramet User accounts, by default, are created without a password. If you provide a password, an attempt will be made to set that password however, this can fail due to password policy restrictions. The -user account will still be created and you may use Set-ADAccountPassword to set the password on that -account. In order to ensure that accounts remain secure, user accounts will never be enabled unless -a valid password is set or **PasswordNotRequired** is set to `$True`. +user account will still be created and you may use `Set-ADAccountPassword` to set the password on +that account. In order to ensure that accounts remain secure, user accounts will never be enabled +unless a valid password is set or **PasswordNotRequired** is set to `$true`. The account is created if the password fails for any reason. ```yaml Type: SecureString Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -213,22 +208,20 @@ Accept wildcard characters: False ### -AllowReversiblePasswordEncryption -Indicates whether reversible password encryption is allowed for the account. - -This parameter sets the **AllowReversiblePasswordEncryption** property of the account. - -This parameter also sets the **ADS_UF_ENCRYPTED_TEXT_PASSWORD_ALLOWED** flag of the Active Directory -User Account Control (UAC) attribute. +Indicates whether reversible password encryption is allowed for the account. This parameter sets the +**AllowReversiblePasswordEncryption** property of the account. This parameter also sets the +**ADS_UF_ENCRYPTED_TEXT_PASSWORD_ALLOWED** flag of the Active Directory User Account Control (UAC) +attribute. The acceptable values for this parameter are: -- `$False` or 0 -- `$True` or 1 +- `$false` or `0` +- `$true` or `1` ```yaml Type: System.Boolean Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -237,13 +230,10 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` - - ### -AuthenticationPolicy -Specifies an Active Directory Domain Services authentication policy object. - -Specify the authentication policy object in one of the following formats: +Specifies an Active Directory Domain Services authentication policy object. Specify the +authentication policy object in one of the following formats: - Distinguished name - GUID @@ -252,13 +242,13 @@ Specify the authentication policy object in one of the following formats: This parameter can also get this object through the pipeline or you can set this parameter to an object instance. -The cmdlet searches the default naming context or partition to find the object. -If the cmdlet finds two or more objects, the cmdlet returns a non-terminating error. +The cmdlet searches the default naming context or partition to find the object. If the cmdlet finds +two or more objects, the cmdlet returns a non-terminating error. ```yaml Type: ADAuthenticationPolicy Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -271,7 +261,7 @@ Accept wildcard characters: False Specifies an Active Directory Domain Services authentication policy silo object. -Specify the authentication policy silo object in one of the following formats: +Specify the authentication policy silo object in one of the following formats: - Distinguished name - GUID @@ -280,13 +270,13 @@ Specify the authentication policy silo object in one of the following formats: This parameter can also get this object through the pipeline or you can set this parameter to an object instance. -The cmdlet searches the default naming context or partition to find the object. -If the cmdlet finds two or more objects, the cmdlet returns a non-terminating error. +The cmdlet searches the default naming context or partition to find the object. If the cmdlet finds +two or more objects, the cmdlet returns a non-terminating error. ```yaml Type: ADAuthenticationPolicySilo Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -297,20 +287,18 @@ Accept wildcard characters: False ### -AuthType -Specifies the authentication method to use. -The acceptable values for this parameter are: - -- Negotiate or 0 -- Basic or 1 +Specifies the authentication method to use. The acceptable values for this parameter are: -The default authentication method is Negotiate. +- `Negotiate` or `0` +- `Basic` or `1` -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. +The default authentication method is Negotiate. A Secure Sockets Layer (SSL) connection is required +for the Basic authentication method. ```yaml Type: ADAuthType Parameter Sets: (All) -Aliases: +Aliases: Accepted values: Negotiate, Basic Required: False @@ -322,19 +310,18 @@ Accept wildcard characters: False ### -CannotChangePassword -Indicates whether the account password can be changed. - -This parameter sets the **CannotChangePassword** property of an account. +Indicates whether the account password can be changed. This parameter sets the +**CannotChangePassword** property of an account. The acceptable values for this parameter are: -- `$False` or 0 -- `$True` or 1 +- `$false` or `0` +- `$true` or `1` ```yaml Type: System.Boolean Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -347,13 +334,13 @@ Accept wildcard characters: False Specifies the DER-encoded X.509v3 certificates of the account. These certificates include the public key certificates issued to this account by the Microsoft Certificate Service. This parameter sets -the Certificates property of the account object. The LDAP display name (ldapDisplayName) for this -property is userCertificate. +the Certificates property of the account object. The LDAP display name (**ldapDisplayName**) for +this property is `userCertificate`. ```yaml Type: X509Certificate[] Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -368,16 +355,16 @@ Indicates whether a password must be changed during the next logon attempt. The acceptable values for this parameter are: -- `$False` or 0 -- `$True` or 1 +- `$false` or `0` +- `$true` or `1` -This parameter cannot be set to `$True` or 1 for an account that also has the -**PasswordNeverExpires** property set to `$True`. +This parameter cannot be set to `$true` or 1 for an account that also has the +**PasswordNeverExpires** property set to `$true`. ```yaml Type: System.Boolean Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -388,16 +375,13 @@ Accept wildcard characters: False ### -City -Specifies the user's town or city. - -This parameter sets the **City** property of a user object. - -The LDAP display name (**ldapDisplayName**) of this property is l. +Specifies the user's town or city. This parameter sets the **City** property of a user object. The +LDAP display name (**ldapDisplayName**) of this property is `l`. ```yaml Type: System.String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -408,16 +392,13 @@ Accept wildcard characters: False ### -Company -Specifies the user's company. - -This parameter sets the **Company** property of a user object. - -The LDAP display name (**ldapDisplayName**) of this property is company. +Specifies the user's company. This parameter sets the **Company** property of a user object. The +LDAP display name (**ldapDisplayName**) of this property is `company`. ```yaml Type: System.String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -429,25 +410,24 @@ Accept wildcard characters: False ### -CompoundIdentitySupported Specifies whether an account supports Kerberos service tickets which includes the authorization data -for the user's device. - -This value sets the compound identity supported flag of the Active Directory +for the user's device. This value sets the compound identity supported flag of the Active Directory `msDS-SupportedEncryptionTypes` attribute. The acceptable values for this parameter are: -- `$False` or 0 -- `$True` or 1 +- `$false` or `0` +- `$true` or `1` -Warning: Domain-joined Windows systems and services such as clustering manage their own -`msDS-SupportedEncryptionTypes` attribute. Therefore any changes to the flag on the -`msDS-SupportedEncryptionTypes` attribute are overwritten by the service or system that manages the -setting. +> [!WARNING] +> Domain-joined Windows systems and services such as clustering manage their own +> `msDS-SupportedEncryptionTypes` attribute. Therefore any changes to the flag on the +> `msDS-SupportedEncryptionTypes` attribute are overwritten by the service or system that manages +> the setting. ```yaml Type: System.Boolean Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -474,18 +454,16 @@ Accept wildcard characters: False ### -Country -Specifies the country or region code for the user's language of choice. - -This parameter sets the **Country** property of a user object. - -The LDAP display name (**ldapDisplayName**) of this property is c. +Specifies the country or region code for the user's language of choice. This parameter sets the +**Country** property of a user object. The LDAP display name (**ldapDisplayName**) of this property +is `c`. This value is not used by Windows 2000. ```yaml Type: System.String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -496,23 +474,16 @@ Accept wildcard characters: False ### -Credential -Specifies the user account credentials to use to perform this task. - -The default credentials are the credentials of the currently logged on user unless the cmdlet is run -from an Active Directory PowerShell provider drive. - -If the cmdlet is run from such a provider drive, the account associated with the drive is the -default. - -To specify this parameter, you can type a user name, such as User1 or Domain01\User01 or you can -specify a **PSCredential** object. +Specifies the user account credentials to use to perform this task. The default credentials are the +credentials of the currently logged on user unless the cmdlet is run from an Active Directory +PowerShell provider drive. If the cmdlet is run from such a provider drive, the account associated +with the drive is the default. To specify this parameter, you can type a user name, such as User1 or +Domain01\User01 or you can specify a **PSCredential** object. If you specify a user name for this parameter, the cmdlet prompts for a password. You can also create a **PSCredential** object by using a script or by using the `Get-Credential` -cmdlet. - -You can then set the _Credential_ parameter to the **PSCredential** object. +cmdlet. You can then set the **Credential** parameter to the **PSCredential** object. If the acting credentials do not have directory-level permission to perform the task, Active Directory PowerShell returns a terminating error. @@ -520,7 +491,7 @@ Directory PowerShell returns a terminating error. ```yaml Type: System.Management.Automation.PSCredential Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -531,16 +502,13 @@ Accept wildcard characters: False ### -Department -Specifies the user's department. - -This parameter sets the **Department** property of a user object. - -The LDAP display name (**ldapDisplayName**) of this property is department. +Specifies the user's department. This parameter sets the **Department** property of a user object. +The LDAP display name (**ldapDisplayName**) of this property is `department`. ```yaml Type: System.String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -551,16 +519,13 @@ Accept wildcard characters: False ### -Description -Specifies a description of the object. - -This parameter sets the value of the **Description** property for the user object. - -The LDAP display name (**ldapDisplayName**) for this property is description. +Specifies a description of the object. This parameter sets the value of the **Description** property +for the user object. The LDAP display name (**ldapDisplayName**) for this property is `description`. ```yaml Type: System.String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -571,16 +536,13 @@ Accept wildcard characters: False ### -DisplayName -Specifies the display name of the object. - -This parameter sets the **DisplayName** property of the user object. - -The LDAP display name (**ldapDisplayName**) for this property is displayName. +Specifies the display name of the object. This parameter sets the **DisplayName** property of the +user object. The LDAP display name (**ldapDisplayName**) for this property is `displayName`. ```yaml Type: System.String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -591,16 +553,13 @@ Accept wildcard characters: False ### -Division -Specifies the user's division. - -This parameter sets the **Division** property of a user object. - -The LDAP display name (**ldapDisplayName**) of this property is division. +Specifies the user's division. This parameter sets the **Division** property of a user object. The +LDAP display name (**ldapDisplayName**) of this property is `division`. ```yaml Type: System.String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -611,16 +570,13 @@ Accept wildcard characters: False ### -EmailAddress -Specifies the user's e-mail address. - -This parameter sets the **EmailAddress** property of a user object. - -The LDAP display name (**ldapDisplayName**) of this property is mail. +Specifies the user's e-mail address. This parameter sets the **EmailAddress** property of a user +object. The LDAP display name (**ldapDisplayName**) of this property is `mail`. ```yaml Type: System.String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -631,16 +587,13 @@ Accept wildcard characters: False ### -EmployeeID -Specifies the user's employee ID. - -This parameter sets the **EmployeeID** property of a user object. - -The LDAP display name (**ldapDisplayName**) of this property is employeeID. +Specifies the user's employee ID. This parameter sets the **EmployeeID** property of a user object. +The LDAP display name (**ldapDisplayName**) of this property is `employeeID`. ```yaml Type: System.String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -651,16 +604,13 @@ Accept wildcard characters: False ### -EmployeeNumber -Specifies the user's employee number. - -This parameter sets the **EmployeeNumber** property of a user object. - -The LDAP display name (**ldapDisplayName**) of this property is employeeNumber. +Specifies the user's employee number. This parameter sets the **EmployeeNumber** property of a user +object. The LDAP display name (**ldapDisplayName**) of this property is `employeeNumber`. ```yaml Type: System.String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -671,24 +621,19 @@ Accept wildcard characters: False ### -Enabled -Specifies if an account is enabled. - -An enabled account requires a password. - -This parameter sets the **Enabled** property for an account object. - -This parameter also sets the **ADS_UF_ACCOUNTDISABLE** flag of the Active Directory User Account -Control (UAC) attribute. +Specifies if an account is enabled. An enabled account requires a password. This parameter sets the +**Enabled** property for an account object. This parameter also sets the **ADS_UF_ACCOUNTDISABLE** +flag of the Active Directory User Account Control (UAC) attribute. The acceptable values for this parameter are: -- `$False` or 0 -- `$True` or 1 +- `$false` or `0` +- `$true` or `1` ```yaml Type: System.Boolean Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -699,16 +644,13 @@ Accept wildcard characters: False ### -Fax -Specifies the user's fax phone number. - -This parameter sets the **Fax** property of a user object. - -The LDAP display name (**ldapDisplayName**) of this property is facsimileTelephoneNumber. +Specifies the user's fax phone number. This parameter sets the **Fax** property of a user object. +The LDAP display name (**ldapDisplayName**) of this property is `facsimileTelephoneNumber`. ```yaml Type: System.String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -719,16 +661,13 @@ Accept wildcard characters: False ### -GivenName -Specifies the user's given name. - -This parameter sets the **GivenName** property of a user object. - -The LDAP display name (**ldapDisplayName**) of this property is givenName. +Specifies the user's given name. This parameter sets the **GivenName** property of a user object. +The LDAP display name (**ldapDisplayName**) of this property is `givenName`. ```yaml Type: System.String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -739,16 +678,13 @@ Accept wildcard characters: False ### -HomeDirectory -Specifies a user's home directory. - -This parameter sets the **HomeDirectory** property of a user object. - -The LDAP display name (**ldapDisplayName**) for this property is homeDirectory. +Specifies a user's home directory. This parameter sets the **HomeDirectory** property of a user +object. The LDAP display name (**ldapDisplayName**) for this property is `homeDirectory`. ```yaml Type: System.String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -760,20 +696,17 @@ Accept wildcard characters: False ### -HomeDrive Specifies a drive that is associated with the UNC path defined by the **HomeDirectory** property. +The drive letter is specified as `:` where `` indicates the letter of the +drive to associate. The `` must be a single, uppercase letter and the colon is +required. -The drive letter is specified as ``: where `` indicates the letter of the -drive to associate. - -The `` must be a single, uppercase letter and the colon is required. - -This parameter sets the **HomeDrive** property of the user object. - -The LDAP display name (**ldapDisplayName**) for this property is homeDrive. +This parameter sets the **HomeDrive** property of the user object. The LDAP display name +(**ldapDisplayName**) for this property is `homeDrive`. ```yaml Type: System.String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -784,16 +717,13 @@ Accept wildcard characters: False ### -HomePage -Specifies the URL of the home page of the object. - -This parameter sets the **homePage** property of a user object. - -The LDAP display name (**ldapDisplayName**) for this property is wWWHomePage. +Specifies the URL of the home page of the object. This parameter sets the **homePage** property of a +user object. The LDAP display name (**ldapDisplayName**) for this property is `wWWHomePage`. ```yaml Type: System.String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -804,16 +734,13 @@ Accept wildcard characters: False ### -HomePhone -Specifies the user's home telephone number. - -This parameter sets the **HomePhone** property of a user object. - -The LDAP display name (**ldapDisplayName**) of this property is homePhone. +Specifies the user's home telephone number. This parameter sets the **HomePhone** property of a user +object. The LDAP display name (**ldapDisplayName**) of this property is `homePhone`. ```yaml Type: System.String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -824,18 +751,14 @@ Accept wildcard characters: False ### -Initials -Specifies the initials that represent part of a user's name. - -You can use this value for the user's middle initial. - -This parameter sets the **Initials** property of a user object. - -The LDAP display name (**ldapDisplayName**) of this property is initials. +Specifies the initials that represent part of a user's name. You can use this value for the user's +middle initial. This parameter sets the **Initials** property of a user object. The LDAP display +name (**ldapDisplayName**) of this property is `initials`. ```yaml Type: System.String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -846,35 +769,27 @@ Accept wildcard characters: False ### -Instance -Specifies an instance of a user object to use as a template for a new user object. - -You can use an instance of an existing user object as a template or you can construct a new user -object for template use. - -You can construct a new user object using the Windows PowerShell command line or by using a script. - -Method 1: Use an existing user object as a template for a new object. - -To retrieve an instance of an existing user object, use a cmdlet such as `Get-ADUser`. - -Then provide this object to the _Instance_ parameter of the `New-ADUser` cmdlet to create a new user -object. - -You can override property values of the new object by setting the appropriate parameters. - -Method 2: Create a new **ADUser** object and set the property values by using the Windows PowerShell -command line interface. +Specifies an instance of a user object to use as a template for a new user object. You can use an +instance of an existing user object as a template or you can construct a new user object for +template use. You can construct a new user object using the Windows PowerShell command line or by +using a script. -Then pass this object to the _Instance_ parameter of the `New-ADUser` cmdlet to create the new -Active Directory user object. +- Method 1: Use an existing user object as a template for a new object. To retrieve an instance of + an existing user object, use a cmdlet such as `Get-ADUser`. Then provide this object to the + **Instance** parameter of the `New-ADUser` cmdlet to create a new user object. You can override + property values of the new object by setting the appropriate parameters. +- Method 2: Create a new **ADUser** object and set the property values by using the Windows + PowerShell command line interface. Then pass this object to the **Instance** parameter of the + `New-ADUser` cmdlet to create the new Active Directory user object. -Note: Specified attributes are not validated, so attempting to set attributes that do not exist or -cannot be set raises an error. +> [!NOTE] +> Specified attributes are not validated, so attempting to set attributes that do not exist or +> cannot be set raises an error. ```yaml Type: ADUser Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -886,35 +801,33 @@ Accept wildcard characters: False ### -KerberosEncryptionType Specifies whether an account supports Kerberos encryption types which are used during creation of -service tickets. - -This value sets the encryption types supported flags of the Active Directory +service tickets. This value sets the encryption types supported flags of the Active Directory `msDS-SupportedEncryptionTypes` attribute. Possible values for this parameter are: -- None -- DES -- RC4 -- AES128 -- AES256 +- `None` +- `DES` +- `RC4` +- `AES128` +- `AES256` -None removes all encryption types from the account, resulting in the KDC being unable to issue +`None` removes all encryption types from the account, resulting in the KDC being unable to issue service tickets for services using the account. -DES is a weak encryption type that is not supported by default since Windows 7 and Windows Server +`DES` is a weak encryption type that is not supported by default since Windows 7 and Windows Server 2008 R2. -Warning: Domain-joined Windows systems and services such as clustering manage their own -`msDS-SupportedEncryptionTypes` attribute. - -Therefore any changes to the flag on the `msDS-SupportedEncryptionTypes` attribute are overwritten -by the service or system that manages the setting. +> [!WARNING] +> Domain-joined Windows systems and services such as clustering manage their own +> `msDS-SupportedEncryptionTypes` attribute. Therefore any changes to the flag on the +> `msDS-SupportedEncryptionTypes` attribute are overwritten by the service or system that manages +> the setting. ```yaml Type: ADKerberosEncryptionType Parameter Sets: (All) -Aliases: +Aliases: Accepted values: None, DES, RC4, AES128, AES256 Required: False @@ -926,21 +839,16 @@ Accept wildcard characters: False ### -LogonWorkstations -Specifies the computers that the user can access. - -To specify more than one computer, create a single comma-separated list. - -You can identify a computer by using the Security Account Manager (SAM) account name -(sAMAccountName) or the DNS host name of the computer. - -The SAM account name is the same as the NetBIOS name of the computer. - -The LDAP display name (**ldapDisplayName**) for this property is userWorkStations. +Specifies the computers that the user can access. To specify more than one computer, create a single +comma-separated list. You can identify a computer by using the Security Account Manager (SAM) +account name (**sAMAccountName**) or the DNS host name of the computer. The SAM account name is the +same as the NetBIOS name of the computer. The LDAP display name (**ldapDisplayName**) for this +property is `userWorkStations`. ```yaml Type: System.String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -951,25 +859,21 @@ Accept wildcard characters: False ### -Manager -Specifies the user's manager. - -This parameter sets the **Manager** property of a user object. - -This parameter is set by providing one of the following property values. +Specifies the user's manager. This parameter sets the **Manager** property of a user object. This +parameter is set by providing one of the following property values. -Note: The identifier in parentheses is the LDAP display name for the property. - -The acceptable values for this parameter are: +The identifier in parentheses is the LDAP display name for the property. The acceptable values for +this parameter are: - A distinguished name -- A GUID (objectGUID) -- A security identifier (objectSid) -- A SAM account name (sAMAccountName) +- A GUID (`objectGUID`) +- A security identifier (`objectSid`) +- A SAM account name (`sAMAccountName`) ```yaml Type: ADUser Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -980,16 +884,13 @@ Accept wildcard characters: False ### -MobilePhone -Specifies the user's mobile phone number. - -This parameter sets the **MobilePhone** property of a user object. - -The LDAP display name (**ldapDisplayName**) of this property is mobile. +Specifies the user's mobile phone number. This parameter sets the **MobilePhone** property of a user +object. The LDAP display name (**ldapDisplayName**) of this property is `mobile`. ```yaml Type: System.String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -1000,16 +901,13 @@ Accept wildcard characters: False ### -Name -Specifies the name of the object. - -This parameter sets the **Name** property of a user object. - -The LDAP display name (**ldapDisplayName**) of this property is name. +Specifies the name of the object. This parameter sets the **Name** property of a user object. The +LDAP display name (**ldapDisplayName**) of this property is `name`. ```yaml Type: System.String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 1 @@ -1020,16 +918,14 @@ Accept wildcard characters: False ### -Office -Specifies the location of the user's office or place of business. - -This parameter sets the **Office** property of a user object. - -The LDAP display name (**ldapDisplayName**) of this property is physicalDeliveryOfficeName. +Specifies the location of the user's office or place of business. This parameter sets the **Office** +property of a user object. The LDAP display name (**ldapDisplayName**) of this property is +`physicalDeliveryOfficeName`. ```yaml Type: System.String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -1040,16 +936,13 @@ Accept wildcard characters: False ### -OfficePhone -Specifies the user's office telephone number. - -This parameter sets the **OfficePhone** property of a user object. - -The LDAP display name (**ldapDisplayName**) of this property is telephoneNumber. +Specifies the user's office telephone number. This parameter sets the **OfficePhone** property of a +user object. The LDAP display name (**ldapDisplayName**) of this property is `telephoneNumber`. ```yaml Type: System.String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -1060,16 +953,13 @@ Accept wildcard characters: False ### -Organization -Specifies the user's organization. - -This parameter sets the **Organization** property of a user object. - -The LDAP display name (**ldapDisplayName**) of this property is o. +Specifies the user's organization. This parameter sets the **Organization** property of a user +object. The LDAP display name (**ldapDisplayName**) of this property is `o`. ```yaml Type: System.String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -1080,37 +970,27 @@ Accept wildcard characters: False ### -OtherAttributes -Specifies object attribute values for attributes that are not represented by cmdlet parameters. - -You can set one or more parameters at the same time with this parameter. - -If an attribute takes more than one value, you can assign multiple values. - -To identify an attribute, specify the LDAP display name (**ldapDisplayName**) defined for it in the -Active Directory schema. +Specifies object attribute values for attributes that are not represented by cmdlet parameters. You +can set one or more parameters at the same time with this parameter. If an attribute takes more than +one value, you can assign multiple values. To identify an attribute, specify the LDAP display name +(**ldapDisplayName**) defined for it in the Active Directory schema. To specify a single value for an attribute: -```powershell --OtherAttributes @{'AttributeLDAPDisplayName'=value} -``` +`-OtherAttributes @{'AttributeLDAPDisplayName'=value}` To specify multiple values for an attribute: -```powershell --OtherAttributes @{'AttributeLDAPDisplayName'=value1,value2,...} -``` +`-OtherAttributes @{'AttributeLDAPDisplayName'=value1,value2,...}` To specify values for multiple attributes: -```powershell --OtherAttributes @{'Attribute1LDAPDisplayName'=value; 'Attribute2LDAPDisplayName'=value1,value2;...} -``` +`-OtherAttributes @{'Attribute1LDAPDisplayName'=value; 'Attribute2LDAPDisplayName'=value1,value2;...}` ```yaml Type: Hashtable Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -1122,15 +1002,13 @@ Accept wildcard characters: False ### -OtherName Specifies a name in addition to a user's given name and surname, such as the user's middle name. - -This parameter sets the **OtherName** property of a user object. - -The LDAP display name (**ldapDisplayName**) of this property is middleName. +This parameter sets the **OtherName** property of a user object. The LDAP display name +(**ldapDisplayName**) of this property is `middleName`. ```yaml Type: System.String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -1141,14 +1019,13 @@ Accept wildcard characters: False ### -PassThru -Returns an object representing the item with which you are working. - -By default, this cmdlet does not generate any output. +Returns an object representing the item with which you are working. By default, this cmdlet does not +generate any output. ```yaml Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -1159,25 +1036,22 @@ Accept wildcard characters: False ### -PasswordNeverExpires -Specifies whether the password of an account can expire. - -This parameter sets the **PasswordNeverExpires** property of an account object. - -This parameter also sets the **ADS_UF_DONT_EXPIRE_PASSWD** flag of the Active Directory User Account -Control attribute. +Specifies whether the password of an account can expire. This parameter sets the +**PasswordNeverExpires** property of an account object. This parameter also sets the +**ADS_UF_DONT_EXPIRE_PASSWD** flag of the Active Directory User Account Control attribute. The acceptable values for this parameter are: -- `$False` or 0 -- `$True` or 1 +- `$false` or `0` +- `$true` or `1` -Note: This parameter cannot be set to `$True` or 1 for an account that also has the -**ChangePasswordAtLogon** property set to `$True`. +This parameter cannot be set to `$true` or `1` for an account that also has the +**ChangePasswordAtLogon** property set to `$true`. ```yaml Type: System.Boolean Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -1188,16 +1062,13 @@ Accept wildcard characters: False ### -PasswordNotRequired -Specifies whether the account requires a password. - -A password is not required for a new account. - +Specifies whether the account requires a password. A password is not required for a new account. This parameter sets the **PasswordNotRequired** property of an account object. ```yaml Type: System.Boolean Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -1208,47 +1079,43 @@ Accept wildcard characters: False ### -Path -Specifies the X.500 path of the OU or container where the new object is created. - -In many cases, a default value is used for the _Path_ parameter if no value is specified. +Specifies the X.500 path of the OU or container where the new object is created. In many cases, a +default value is used for the **Path** parameter if no value is specified. The rules for determining +the default value are given below. The rules listed first are evaluated first and when a default +value can be determined, no further rules are evaluated. -The rules for determining the default value are given below. - -Note that rules listed first are evaluated first and when a default value can be determined, no -further rules are evaluated. - -In Active Directory Domain Services (AD DS) environments, a default value for _Path_ is set in the +In Active Directory Domain Services (AD DS) environments, a default value for **Path** is set in the following cases: - If the cmdlet is run from an Active Directory PowerShell provider drive, the parameter is set to the current path of the provider drive. -- If the cmdlet has a default path, this is used. For example: in New-ADUser, the _Path_ parameter +- If the cmdlet has a default path, this is used. For example: in New-ADUser, the **Path** parameter defaults to the Users container. -- If none of the previous cases apply, the default value of _Path_ is set to the default partition +- If none of the previous cases apply, the default value of **Path** is set to the default partition or naming context of the target domain. -In AD LDS environments, a default value for _Path_ is set in the following cases: +In AD LDS environments, a default value for **Path** is set in the following cases: - If the cmdlet is run from an Active Directory module for PowerShell provider drive, the parameter is set to the current path of the provider drive. -- If the cmdlet has a default path, this is used. For example: in `New-ADUser`, the _Path_ parameter - defaults to the Users container. +- If the cmdlet has a default path, this is used. For example: in `New-ADUser`, the **Path** + parameter defaults to the Users container. - If the target AD LDS instance has a default naming context, the default value of _Path_ is set to the default naming context. To specify a default naming context for an AD LDS environment, set the `msDS-defaultNamingContext` property of the Active Directory directory service agent object (**nTDSDSA**) for the AD LDS instance. -- If none of the previous cases apply, the _Path_ parameter does not take any default value. +- If none of the previous cases apply, the **Path** parameter does not take any default value. -Note: The Active Directory Provider cmdlets, such New-Item, Remove-Item, Remove-ItemProperty, -*Rename-Item*, and Set-ItemProperty also contain a _Path_ property. - -However, for the Active Directory Provider cmdlets, the _Path_ parameter identifies the path of the -actual object rather than the container. +> [!NOTE] +> The Active Directory Provider cmdlets, such as `New-Item`, `Remove-Item`, `Remove-ItemProperty`, +> `Rename-Item`, and `Set-ItemProperty` also contain a **Path** property. However, for the Active +> Directory Provider cmdlets, the **Path** parameter identifies the path of the actual object rather +> than the container. ```yaml Type: System.String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -1256,18 +1123,16 @@ Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -POBox -Specifies the user's post office box number. - -This parameter sets the **POBox** property of a user object. +### -POBox -The LDAP display name (**ldapDisplayName**) of this property is postOfficeBox. +Specifies the user's post office box number. This parameter sets the **POBox** property of a user +object. The LDAP display name (**ldapDisplayName**) of this property is `postOfficeBox`. ```yaml Type: System.String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -1275,18 +1140,16 @@ Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -PostalCode - -Specifies the user's postal code or zip code. -This parameter sets the **PostalCode** property of a user object. +### -PostalCode -The LDAP display name (**ldapDisplayName**) of this property is postalCode. +Specifies the user's postal code or zip code. This parameter sets the **PostalCode** property of a +user object. The LDAP display name (**ldapDisplayName**) of this property is `postalCode`. ```yaml Type: System.String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -1297,15 +1160,13 @@ Accept wildcard characters: False ### -PrincipalsAllowedToDelegateToAccount -Specifies an array of principal objects. - -This parameter sets the `msDS-AllowedToActOnBehalfOfOtherIdentity` attribute of a computer account -object. +Specifies an array of principal objects. This parameter sets the +`msDS-AllowedToActOnBehalfOfOtherIdentity` attribute of a computer account object. ```yaml Type: ADPrincipal[] Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -1316,18 +1177,14 @@ Accept wildcard characters: False ### -ProfilePath -Specifies a path to the user's profile. - -This value can be a local absolute path or a Universal Naming Convention (UNC) path. - -This parameter sets the **ProfilePath** property of the user object. - -The LDAP display name (**ldapDisplayName**) for this property is profilePath. +Specifies a path to the user's profile. This value can be a local absolute path or a Universal +Naming Convention (UNC) path. This parameter sets the **ProfilePath** property of the user object. +The LDAP display name (**ldapDisplayName**) for this property is `profilePath`. ```yaml Type: System.String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -1339,24 +1196,19 @@ Accept wildcard characters: False ### -SamAccountName Specifies the Security Account Manager (SAM) account name of the user, group, computer, or service -account. +account. The maximum length of the description is 256 characters. To be compatible with older +operating systems, create a SAM account name that is 20 characters or less. This parameter sets the +**SAMAccountName** for an account object. The LDAP display name (**ldapDisplayName**) for this +property is `sAMAccountName`. -The maximum length of the description is 256 characters. - -To be compatible with older operating systems, create a SAM account name that is 20 characters or -less. - -This parameter sets the **SAMAccountName** for an account object. - -The LDAP display name (**ldapDisplayName**) for this property is sAMAccountName. - -Note: If the string value provided is not terminated with a $ character, the system adds one if -needed. +> [!NOTE] +> Information the user should notice even if skimmingIf the string value provided is not terminated +> with a `$` character, the system adds one if needed. ```yaml Type: System.String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -1367,18 +1219,14 @@ Accept wildcard characters: False ### -ScriptPath -Specifies a path to the user's log on script. - -This value can be a local absolute path or a Universal Naming Convention (UNC) path. - -This parameter sets the **ScriptPath** property of the user object. - -The LDAP display name (**ldapDisplayName**) for this property is scriptPath. +Specifies a path to the user's log on script. This value can be a local absolute path or a Universal +Naming Convention (UNC) path. This parameter sets the **ScriptPath** property of the user object. +The LDAP display name (**ldapDisplayName**) for this property is `scriptPath`. ```yaml Type: System.String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -1390,18 +1238,17 @@ Accept wildcard characters: False ### -Server Specifies the AD DS instance to connect to, by providing one of the following values for a -corresponding domain name or directory server. - -The service may be any of the following: AD LDS, AD DS, or Active Directory snapshot instance. +corresponding domain name or directory server. The service may be any of the following: AD LDS, AD +DS, or Active Directory snapshot instance. -Specify the AD DS instance in one of the following ways: +Specify the AD DS instance in one of the following ways: Domain name values: - Fully qualified domain name - NetBIOS name -Directory server values: +Directory server values: - Fully qualified directory server name - NetBIOS name @@ -1410,7 +1257,7 @@ Directory server values: The default value for this parameter is determined by one of the following methods in the order that they are listed: -- By using the _Server_ value from objects passed through the pipeline +- By using the **Server** value from objects passed through the pipeline - By using the server information associated with the AD DS Windows PowerShell provider drive, when the cmdlet runs in that drive - By using the domain of the computer running Windows PowerShell @@ -1418,7 +1265,7 @@ they are listed: ```yaml Type: System.String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -1429,20 +1276,16 @@ Accept wildcard characters: False ### -ServicePrincipalNames -Specifies the service principal names for the account. - -This parameter sets the **ServicePrincipalNames** property of the account. - -The LDAP display name (**ldapDisplayName**) for this property is servicePrincipalName. - -To enter multiple values, use the following syntax: `,,...`. If the values -contain spaces or otherwise require quotation marks, use the following syntax: -`"","",...""`." +Specifies the service principal names for the account. This parameter sets the +**ServicePrincipalNames** property of the account. The LDAP display name (**ldapDisplayName**) for +this property is servicePrincipalName. To enter multiple values, use the following syntax: +`,,...`. If the values contain spaces or otherwise require quotation marks, +use the following syntax: `'','',...''`. ```yaml Type: System.String[] Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -1453,22 +1296,19 @@ Accept wildcard characters: False ### -SmartcardLogonRequired -Specifies whether a smart card is required to logon. - -This parameter sets the **SmartCardLoginRequired** property for a user object. - -This parameter also sets the **ADS_UF_SMARTCARD_REQUIRED** flag of the Active Directory User Account -Control attribute. +Specifies whether a smart card is required to logon. This parameter sets the +**SmartCardLoginRequired** property for a user object. This parameter also sets the +**ADS_UF_SMARTCARD_REQUIRED** flag of the Active Directory User Account Control attribute. The acceptable values for this parameter are: -- `$False` or 0 -- `$True` or 1 +- `$false` or `0` +- `$true` or `1` ```yaml Type: System.Boolean Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -1479,16 +1319,13 @@ Accept wildcard characters: False ### -State -Specifies the user's or Organizational Unit's state or province. - -This parameter sets the **State** property of a user object. - -The LDAP display name (**ldapDisplayName**) of this property is st. +Specifies the user's or Organizational Unit's state or province. This parameter sets the **State** +property of a user object. The LDAP display name (**ldapDisplayName**) of this property is `st`. ```yaml Type: System.String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -1501,14 +1338,13 @@ Accept wildcard characters: False Specifies the user's street address. -This parameter sets the **StreetAddress** property of a user object. - -The LDAP display name (**ldapDisplayName**) of this property is streetAddress. +This parameter sets the **StreetAddress** property of a user object. The LDAP display name +(**ldapDisplayName**) of this property is streetAddress. ```yaml Type: System.String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -1519,16 +1355,13 @@ Accept wildcard characters: False ### -Surname -Specifies the user's last name or surname. - -This parameter sets the **Surname** property of a user object. - -The LDAP display name (**ldapDisplayName**) of this property is sn. +Specifies the user's last name or surname. This parameter sets the **Surname** property of a user +object. The LDAP display name (**ldapDisplayName**) of this property is `sn`. ```yaml Type: System.String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -1541,14 +1374,13 @@ Accept wildcard characters: False Specifies the user's title. -This parameter sets the **Title** property of a user object. - -The LDAP display name (**ldapDisplayName**) of this property is title. +This parameter sets the **Title** property of a user object. The LDAP display name +(**ldapDisplayName**) of this property is `title`. ```yaml Type: System.String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -1559,25 +1391,21 @@ Accept wildcard characters: False ### -TrustedForDelegation -Indicates whether an account is trusted for Kerberos delegation. - -A service that runs under an account that is trusted for Kerberos delegation can assume the identity -of a client requesting the service. - -This parameter sets the **TrustedForDelegation** property of an account object. - -This value also sets the **ADS_UF_TRUSTED_FOR_DELEGATION** flag of the Active Directory User Account -Control attribute. +Indicates whether an account is trusted for Kerberos delegation. A service that runs under an +account that is trusted for Kerberos delegation can assume the identity of a client requesting the +service. This parameter sets the **TrustedForDelegation** property of an account object. This value +also sets the **ADS_UF_TRUSTED_FOR_DELEGATION** flag of the Active Directory User Account Control +attribute. The acceptable values for this parameter are: -- `$False` or 0 -- `$True` or 1 +- `$false` or `0` +- `$true` or `1` ```yaml Type: System.Boolean Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -1588,19 +1416,15 @@ Accept wildcard characters: False ### -Type -Specifies the type of object to create. - -Set the _Type_ parameter to the LDAP display name of the Active Directory schema class that -represents the type of object that you want to create. - -The selected type must be a subclass of the User schema class. - -If this parameter is not specified it defaults to User. +Specifies the type of object to create. Set the **Type** parameter to the LDAP display name of the +Active Directory schema class that represents the type of object that you want to create. The +selected type must be a subclass of the User schema class. If this parameter is not specified it +defaults to `User`. ```yaml Type: System.String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -1611,21 +1435,16 @@ Accept wildcard characters: False ### -UserPrincipalName -Specifies a user principal name (UPN) in the format `@`. - -A UPN is a friendly name assigned by an administrator that is shorter than the LDAP distinguished -name used by the system and easier to remember. - -The UPN is independent of the user object's distinguished name, so a user object can be moved or -renamed without affecting the user logon name. - -When logging on using a UPN, users no longer have to choose a domain from a list on the logon dialog -box. +Specifies a user principal name (UPN) in the format `@`. A UPN is a friendly +name assigned by an administrator that is shorter than the LDAP distinguished name used by the +system and easier to remember. The UPN is independent of the user object's distinguished name, so a +user object can be moved or renamed without affecting the user logon name. When signing on using a +UPN, users no longer have to choose a domain from a list on the logon dialog box. ```yaml Type: System.String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -1636,9 +1455,7 @@ Accept wildcard characters: False ### -WhatIf -Shows what would happen if the cmdlet runs. - -The cmdlet is not run. +Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml Type: System.Management.Automation.SwitchParameter @@ -1663,20 +1480,22 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ### None or Microsoft.ActiveDirectory.Management.ADUser -A user object that is a template for the new user object is received by the _Instance_ parameter. +A user object that is a template for the new user object is received by the **Instance** parameter. ## OUTPUTS -### None or Microsoft.ActiveDirectory.Management.ADUser - -Returns the new user object when the _PassThru_ parameter is specified. +### None By default, this cmdlet does not generate any output. +### Microsoft.ActiveDirectory.Management.ADUser + +Returns the new user object when the **PassThru** parameter is specified. + ## NOTES -* This cmdlet does not work with an Active Directory snapshot. -* This cmdlet does not work with a read-only domain controller. +- This cmdlet does not work with an Active Directory snapshot. +- This cmdlet does not work with a read-only domain controller. ## RELATED LINKS @@ -1687,4 +1506,3 @@ By default, this cmdlet does not generate any output. [Set-ADUser](./Set-ADUser.md) [Set-ADAccountPassword](./Set-ADAccountPassword.md) - From abdea359f4483c20700ebfaac446b78fa5240b54 Mon Sep 17 00:00:00 2001 From: Sean Wheeler Date: Mon, 8 May 2023 18:11:10 -0500 Subject: [PATCH 439/650] Apply suggestions from code review Co-authored-by: Mikey Lombardi (He/Him) --- .../activedirectory/Get-ADComputer.md | 148 +++++++++--------- 1 file changed, 71 insertions(+), 77 deletions(-) diff --git a/docset/winserver2022-ps/activedirectory/Get-ADComputer.md b/docset/winserver2022-ps/activedirectory/Get-ADComputer.md index eab19f43cb..a727b6c216 100644 --- a/docset/winserver2022-ps/activedirectory/Get-ADComputer.md +++ b/docset/winserver2022-ps/activedirectory/Get-ADComputer.md @@ -44,28 +44,26 @@ Get-ADComputer [-AuthType ] [-Credential ] -LDAPFilter ## DESCRIPTION -The **Get-ADComputer** cmdlet gets a computer or performs a search to retrieve multiple computers. +The `Get-ADComputer` cmdlet gets a computer or performs a search to retrieve multiple computers. -The _Identity_ parameter specifies the Active Directory computer to retrieve. +The **Identity** parameter specifies the Active Directory computer to retrieve. You can identify a computer by its distinguished name, GUID, security identifier (SID) or Security Accounts Manager (SAM) account name. You can also set the parameter to a computer object variable, such as `$` or -pass a computer object through the pipeline to the _Identity_ parameter. +pass a computer object through the pipeline to the **Identity** parameter. -To search for and retrieve more than one computer, use the _Filter_ or -_LDAPFilter_ parameters. The _Filter_ parameter uses the PowerShell Expression -Language to write query strings for Active Directory. PowerShell Expression -Language syntax provides rich type conversion support for value types received -by the _Filter_ parameter. For more information about the _Filter_ parameter +To search for and retrieve more than one computer, use the **Filter** or **LDAPFilter** parameters. +The **Filter** parameter uses the PowerShell Expression Language to write query strings for Active +Directory. PowerShell Expression Language syntax provides rich type conversion support for value +types received by the **Filter** parameter. For more information about the **Filter** parameter syntax, type `Get-Help` -[about_ActiveDirectory_Filter](/previous-versions/windows/server/hh531527(v=ws.10)). -If you have existing Lightweight Directory Access Protocol (LDAP) query strings, -you can use the _LDAPFilter_ parameter. +[about_ActiveDirectory_Filter](/previous-versions/windows/server/hh531527(v=ws.10)). If you have +existing Lightweight Directory Access Protocol (LDAP) query strings, you can use the **LDAPFilter** +parameter. -This cmdlet retrieves a default set of computer object properties. To retrieve -additional properties use the _Properties_ parameter. For more information about -the how to determine the properties for computer objects, see the _Properties_ -parameter description. +This cmdlet retrieves a default set of computer object properties. To retrieve additional +properties use the **Properties** parameter. For more information about the how to determine the +properties for computer objects, see the **Properties** parameter description. ## EXAMPLES @@ -162,7 +160,7 @@ This command gets a specific computer showing all the properties. ```powershell Get-ADComputer -Filter 'Name -like "User01*"' -Properties IPv4Address | - Format-Table Name,DNSHostName,IPv4Address -AutoSize + Format-Table Name, DNSHostName, IPv4Address -AutoSize ``` ```Output @@ -173,14 +171,14 @@ User01-SRV2 User01-SRV2.User01.com 10.194.100.3 ``` This command gets all the computers with a name starting with a particular -string and shows the name, dns hostname, and IPv4 address. +string and shows the name, DNS hostname, and IPv4 address. ### Example 3: Gets all computers that have changed their password in specific time frame ```powershell $Date = [DateTime]::Today.AddDays(-90) Get-ADComputer -Filter 'PasswordLastSet -ge $Date' -Properties PasswordLastSet | - Format-Table Name,PasswordLastSet + Format-Table Name, PasswordLastSet ``` ```Output @@ -206,8 +204,8 @@ davidche-laptop ``` This command gets the computer accounts in the location -CN=Computers,DC=User01,DC=com that are listed as laptops by using an -_LDAPFilter_. +`CN=Computers,DC=User01,DC=com` that are listed as laptops by using an +**LDAPFilter**. ### Example 5: Get all computer accounts using a filter @@ -221,7 +219,7 @@ This command gets all computer accounts. ```powershell Get-ADComputer -Filter 'Name -like "Computer01*" -or Name -like "Computer02*"' -Properties IPv4Address | - Format-Table Name,DNSHostName,IPv4Address -AutoSize + Format-Table Name, DNSHostName, IPv4Address -AutoSize ``` ```Output @@ -236,7 +234,7 @@ Computer02-SRV2 Computer02-SRV2.Computer02.com 10.194.100.3 ```powershell $Date = [DateTime]::Today.AddDays(-30) Get-ADComputer -Filter 'Name -like "Computer01*" -and PasswordLastSet -ge $Date' -Properties IPv4Address | - Format-Table Name,DNSHostName,IPv4Address -AutoSize + Format-Table Name, DNSHostName, IPv4Address -AutoSize ``` ```Output @@ -282,17 +280,16 @@ cmdlet is run from an Active Directory module for Windows PowerShell provider drive. If the cmdlet is run from such a provider drive, the account associated with the drive is the default. -To specify this parameter, you can type a user name, such as User1 or -Domain01\User01 or you can specify a **PSCredential** object. If you specify a -user name for this parameter, the cmdlet prompts for a password. +To specify this parameter, you can type a user name, such as `User1` or `Domain01\User01` or you +can specify a **PSCredential** object. If you specify a user name for this parameter, the cmdlet +prompts for a password. You can also create a **PSCredential** object by using a script or by using the -**Get-Credential** cmdlet. You can then set the _Credential_ parameter to the +`Get-Credential` cmdlet. You can then set the **Credential** parameter to the **PSCredential** object. -If the acting credentials do not have directory-level permission to perform the -task, Active Directory module for Windows PowerShell returns a terminating -error. +If the acting credentials do not have directory-level permission to perform the task, the cmdlet +returns a terminating error. ```yaml Type: PSCredential @@ -310,11 +307,10 @@ Accept wildcard characters: False Specifies a query string that retrieves Active Directory objects. This string uses the Windows PowerShell Expression Language syntax. The Windows PowerShell -Expression Language syntax provides rich type-conversion support for value types -received by the _Filter_ parameter. The syntax uses an in-order representation, -which means that the operator is placed between the operand and the value. For -more information about the _Filter_ parameter, type `Get-Help` -[about_ActiveDirectory_Filter](/previous-versions/windows/server/hh531527(v=ws.10)). +Expression Language syntax provides rich type-conversion support for value types received by the +**Filter** parameter. The syntax uses an in-order representation, which means that the operator is +placed between the operand and the value. For more information about the **Filter** parameter, type +`Get-Help` [about_ActiveDirectory_Filter](/previous-versions/windows/server/hh531527(v=ws.10)). Syntax: @@ -339,10 +335,11 @@ PowerShell Expression Language for this parameter. For a list of supported types for \, type `Get-Help about_ActiveDirectory_ObjectModel`. -Note: Windows PowerShell wildcards other than \*, such as ?, are not supported -by the _Filter_ syntax. +> [!NOTE] +> Wildcards other than `*`, such as `?`, are not supported by the **Filter** syntax. -Note: To query using LDAP query strings, use the _LDAPFilter_ parameter. +> [!NOTE] +> To query using LDAP query strings, use the **LDAPFilter** parameter. ```yaml Type: String @@ -363,9 +360,9 @@ The identifier in parentheses is the LDAP display name for the attribute. The acceptable values for this parameter are: - A distinguished name -- A GUID (objectGUID) -- A security identifier (objectSid) -- A Security Accounts Manager account name (sAMAccountName) +- A GUID (`objectGUID`) +- A security identifier (`objectSid`) +- A Security Accounts Manager account name (`sAMAccountName`) The cmdlet searches the default naming context or partition to find the object. If the identifier given is a distinguished name, the partition to search is @@ -390,9 +387,9 @@ Accept wildcard characters: False ### -LDAPFilter Specifies an LDAP query string that is used to filter Active Directory objects. -You can use this parameter to run your existing LDAP queries. The _Filter_ +You can use this parameter to run your existing LDAP queries. The **Filter** parameter syntax supports the same functionality as the LDAP syntax. For more -information, see the _Filter_ parameter description or type `Get-Help` +information, see the **Filter** parameter description or type `Get-Help` [about_ActiveDirectory_Filter](/previous-versions/windows/server/hh531527(v=ws.10)). ```yaml @@ -411,36 +408,35 @@ Accept wildcard characters: False Specifies the distinguished name of an Active Directory partition. The distinguished name must be one of the naming contexts on the current directory server. -The cmdlet searches this partition to find the object defined by the _Identity_ parameter. +The cmdlet searches this partition to find the object defined by the **Identity** parameter. -In many cases, a default value is used for the _Partition_ parameter if no value +In many cases, a default value is used for the **Partition** parameter if no value is specified. The rules for determining the default value are given below. Note that rules listed first are evaluated first and once a default value can be determined, no further rules are evaluated. In Active Directory Domain Services environments, a default value for -_Partition_ is set in the following cases: +**Partition** is set in the following cases: -- If the _Identity_ parameter is set to a distinguished name, the default value - of _Partition_ is automatically generated from this distinguished name. -- If running cmdlets from an Active Directory provider drive, the default value - of _Partition_ is automatically generated from the current path in the drive. -- If none of the previous cases apply, the default value of _Partition_ is set - to the default partition or naming context of the target domain. +- If the **Identity** parameter is set to a distinguished name, the default value of **Partition** + is automatically generated from this distinguished name. +- If running cmdlets from an Active Directory provider drive, the default value of **Partition** is + automatically generated from the current path in the drive. +- If none of the previous cases apply, the default value of **Partition** is set to the default + partition or naming context of the target domain. In Active Directory Lightweight Directory Services (AD LDS) environments, a -default value for _Partition_ is set in the following cases: - -- If the _Identity_ parameter is set to a distinguished name, the default value - of _Partition_ is automatically generated from this distinguished name. -- If running cmdlets from an Active Directory provider drive, the default value - of _Partition_ is automatically generated from the current path in the drive. -- If the target AD LDS instance has a default naming context, the default value - of _Partition_ is set to the default naming context. To specify a default - naming context for an AD LDS environment, set the - **msDS-defaultNamingContext** property of the Active Directory directory - service agent (DSA) object (**nTDSDSA**) for the AD LDS instance. -- If none of the previous cases apply, the _Partition_ parameter will not take any default value. +default value for **Partition** is set in the following cases: + +- If the **Identity** parameter is set to a distinguished name, the default value of **Partition** + is automatically generated from this distinguished name. +- If running cmdlets from an Active Directory provider drive, the default value of **Partition** is + automatically generated from the current path in the drive. +- If the target AD LDS instance has a default naming context, the default value of **Partition** is + set to the default naming context. To specify a default naming context for an AD LDS environment, + set the **msDS-defaultNamingContext** property of the Active Directory directory service agent + (DSA) object (**nTDSDSA**) for the AD LDS instance. +- If none of the previous cases apply, the **Partition** parameter will not take any default value. ```yaml Type: String @@ -466,9 +462,8 @@ To specify an individual extended property, use the name of the property. For properties that are not default or extended properties, you must specify the LDAP display name of the attribute. -To retrieve properties and display them for an object, you can use the Get-* -cmdlet associated with the object and pass the output to the **Get-Member** -cmdlet. +To retrieve properties and display them for an object, you can use the `Get-*` cmdlet associated +with the object and pass the output to the `Get-Member` cmdlet. ```yaml Type: String[] @@ -540,10 +535,9 @@ agent object (**nTDSDSA**) for the AD LDS instance. If no default naming context has been specified for the target AD LDS instance, then this parameter has no default value. -When the value of the _SearchBase_ parameter is set to an empty string and you -are connected to a global catalog port, all partitions are searched. If the -value of the _SearchBase_ parameter is set to an empty string and you are not -connected to a global catalog port, an error is thrown. +When the value of the **SearchBase** parameter is set to an empty string and you are connected to a +global catalog port, all partitions are searched. If the value of the **SearchBase** parameter is +set to an empty string and you are not connected to a global catalog port, an error is thrown. ```yaml Type: String @@ -607,7 +601,7 @@ Directory server values: The default value for this parameter is determined by one of the following methods in the order that they are listed: -- By using the _Server_ value from objects passed through the pipeline +- By using the **Server** value from objects passed through the pipeline - By using the server information associated with the Active Directory Domain Services Windows PowerShell provider drive, when the cmdlet runs in that drive - By using the domain of the computer running Windows PowerShell @@ -636,7 +630,7 @@ For more information, see ### None or Microsoft.ActiveDirectory.Management.ADComputer -A computer object is received by the _Identity_ parameter. +A computer object is received by the **Identity** parameter. ## OUTPUTS @@ -645,10 +639,10 @@ A computer object is received by the _Identity_ parameter. Returns one or more computer objects. This Get-ADComputer cmdlet returns a default set of **ADComputer** property values. -To retrieve additional **ADComputer** properties, use the _Properties_ parameter of this cmdlet. +To retrieve additional **ADComputer** properties, use the **Properties** parameter of this cmdlet. To view the properties for an **ADComputer** object, see the following examples. -To run these examples, replace \ with a computer identifier such as +To run these examples, replace `` with a computer identifier such as the SAM account name of your local computer. To get a list of the default set of properties of an ADComputer object, use the following command: @@ -661,9 +655,9 @@ To get a list of all the properties of an ADComputer object, use the following c ## NOTES -- This cmdlet does not work with AD LDS with its default schema. By default AD - LDS schema does not have a computer class, but if the schema is extended to - include it, this cmdlet will work with LDS. +- This cmdlet doesn't work with AD LDS with its default schema. By default the AD LDS schema + doesn't have a computer class, but if the schema is extended to include it, this cmdlet will work + with LDS. ## RELATED LINKS From 0665642736c7242c7f03e8336383025aa3aa061f Mon Sep 17 00:00:00 2001 From: Dimitriy Ryazantcev Date: Sun, 14 May 2023 03:18:20 +0300 Subject: [PATCH 440/650] Update Set-WinUserLanguageList.md Add link --- .../winserver2022-ps/international/Set-WinUserLanguageList.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/international/Set-WinUserLanguageList.md b/docset/winserver2022-ps/international/Set-WinUserLanguageList.md index 4a823b406c..67f418f570 100644 --- a/docset/winserver2022-ps/international/Set-WinUserLanguageList.md +++ b/docset/winserver2022-ps/international/Set-WinUserLanguageList.md @@ -144,7 +144,7 @@ The name of the language in the current Windows display language. The writing system of the language. - **Input methods** (READ/WRITE). A list of input method Tablet Input Panel (TIP) strings that are enabled for this language. -The enabled input methods are listed in the format `Language ID: Keyboard layout ID`. +The enabled input methods are listed in the format `Language ID:Keyboard layout ID`. See [Default input profiles (input locales) in Windows](/windows-hardware/manufacture/desktop/default-input-locales-for-windows-language-packs). - **Handwriting recognition input mode** (READ/WRITE). This value is either 0 (freehand) or 1 (write each character separately). From f02b1bf82adea0a670fe76221d4d708648a6f950 Mon Sep 17 00:00:00 2001 From: Thomas Nieto <38873752+ThomasNieto@users.noreply.github.com> Date: Thu, 27 Apr 2023 17:50:40 -0500 Subject: [PATCH 441/650] Fix style guide Appx module --- .../appx/Add-AppSharedPackageContainer.md | 42 ++- .../winserver2022-ps/appx/Add-AppxPackage.md | 276 ++++++++++++------ .../winserver2022-ps/appx/Add-AppxVolume.md | 39 ++- docset/winserver2022-ps/appx/Appx.md | 40 ++- .../appx/Dismount-AppxVolume.md | 35 ++- .../appx/Get-AppSharedPackageContainer.md | 34 ++- .../appx/Get-AppxDefaultVolume.md | 21 +- .../appx/Get-AppxLastError.md | 20 +- docset/winserver2022-ps/appx/Get-AppxLog.md | 53 ++-- .../winserver2022-ps/appx/Get-AppxPackage.md | 92 +++--- .../appx/Get-AppxPackageAutoUpdateSettings.md | 54 ++-- .../appx/Get-AppxPackageManifest.md | 67 +++-- .../winserver2022-ps/appx/Get-AppxVolume.md | 46 ++- .../appx/Invoke-CommandInDesktopPackage.md | 91 ++++-- .../winserver2022-ps/appx/Mount-AppxVolume.md | 35 ++- .../winserver2022-ps/appx/Move-AppxPackage.md | 61 ++-- .../appx/Remove-AppSharedPackageContainer.md | 29 +- .../appx/Remove-AppxPackage.md | 68 +++-- .../appx/Remove-AppxVolume.md | 37 ++- .../appx/Reset-AppSharedPackageContainer.md | 36 ++- .../appx/Reset-AppxPackage.md | 33 ++- .../appx/Set-AppxDefaultVolume.md | 41 ++- .../appx/Set-AppxPackageAutoUpdateSettings.md | 134 ++++++--- 23 files changed, 892 insertions(+), 492 deletions(-) diff --git a/docset/winserver2022-ps/appx/Add-AppSharedPackageContainer.md b/docset/winserver2022-ps/appx/Add-AppSharedPackageContainer.md index 008d4131e7..0480c58965 100644 --- a/docset/winserver2022-ps/appx/Add-AppSharedPackageContainer.md +++ b/docset/winserver2022-ps/appx/Add-AppSharedPackageContainer.md @@ -1,30 +1,35 @@ --- external help file: Microsoft.Windows.Appx.PackageManager.Commands.dll-Help.xml -Module Name: appx +Module Name: Appx +ms.date: 05/15/2023 online version: https://learn.microsoft.com/powershell/module/appx/add-appsharedpackagecontainer?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 +title: Add-AppSharedPackageContainer --- # Add-AppSharedPackageContainer ## SYNOPSIS -Deploys the shared package container definiton. +Deploys the shared package container definition. ## SYNTAX ``` -Add-AppSharedPackageContainer [-Path] [-ForceApplicationShutdown] [-Merge] [-Force] - [] +Add-AppSharedPackageContainer [-Path] [-ForceApplicationShutdown] [-Merge] + [-Force] [] ``` ## DESCRIPTION -The Add-AppSharedPackageContainer cmdlet deploys the shared package container definiton for the particular user. + +The `Add-AppSharedPackageContainer` cmdlet deploys the shared package container definition for the +particular user. ## EXAMPLES ### Example 1 + ```powershell -PS C:\> Add-AppSharedPackageContainer -Path C:\MyFolder\ContosoTestContainer.xml +Add-AppSharedPackageContainer -Path C:\MyFolder\ContosoTestContainer.xml ``` This command deploys the definition described in the ContosoTestContainer file. @@ -32,12 +37,12 @@ This command deploys the definition described in the ContosoTestContainer file. ## PARAMETERS ### -Force -Replaces an existing container of the same name with the newly created -container's definition for the target user(s). +Replaces an existing container of the same name with the newly created container's definition for +the target users. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -49,10 +54,11 @@ Accept wildcard characters: False ``` ### -ForceApplicationShutdown + Closes all packages currently running in the Shared Package Container. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -64,12 +70,12 @@ Accept wildcard characters: False ``` ### -Merge -Merges a new container's definition into an existing container -definition of the same name for target user(s). +Merges a new container's definition into an existing container definition of the same name for +target users. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -81,10 +87,11 @@ Accept wildcard characters: False ``` ### -Path + Path to the XML definition file. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: PSPath @@ -96,7 +103,11 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, +-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, +-WarningAction, and -WarningVariable. For more information, see +[about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -105,6 +116,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### System.Object + ## NOTES ## RELATED LINKS diff --git a/docset/winserver2022-ps/appx/Add-AppxPackage.md b/docset/winserver2022-ps/appx/Add-AppxPackage.md index ddf5efa53c..6a31b475b0 100644 --- a/docset/winserver2022-ps/appx/Add-AppxPackage.md +++ b/docset/winserver2022-ps/appx/Add-AppxPackage.md @@ -2,7 +2,7 @@ description: Adds a signed app package to a user account. external help file: Microsoft.Windows.Appx.PackageManager.Commands.dll-help.xml Module Name: Appx -ms.date: 01/31/2022 +ms.date: 05/15/2023 online version: https://learn.microsoft.com/powershell/module/appx/add-appxpackage?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Add-AppxPackage @@ -16,23 +16,26 @@ Adds a signed app package to a user account. ## SYNTAX ### AddSet (Default) + ``` Add-AppxPackage [-Path] [-DependencyPath ] [-RequiredContentGroupOnly] [-ForceApplicationShutdown] [-ForceTargetApplicationShutdown] [-ForceUpdateFromAnyVersion] - [-RetainFilesOnFailure] [-InstallAllResources] [-Volume ] [-ExternalPackages ] - [-OptionalPackages ] [-RelatedPackages ] [-ExternalLocation ] - [-DeferRegistrationWhenPackagesAreInUse] [-StubPackageOption ] [-AllowUnsigned] [-WhatIf] - [-Confirm] [] + [-RetainFilesOnFailure] [-InstallAllResources] [-Volume ] + [-ExternalPackages ] [-OptionalPackages ] [-RelatedPackages ] + [-ExternalLocation ] [-DeferRegistrationWhenPackagesAreInUse] + [-StubPackageOption ] [-AllowUnsigned] [-WhatIf] [-Confirm] [] ``` ### AddByAppInstallerSet + ``` Add-AppxPackage [-Path] [-RequiredContentGroupOnly] [-AppInstallerFile] - [-ForceTargetApplicationShutdown] [-InstallAllResources] [-LimitToExistingPackages] [-Volume ] - [-WhatIf] [-Confirm] [] + [-ForceTargetApplicationShutdown] [-InstallAllResources] [-LimitToExistingPackages] + [-Volume ] [-WhatIf] [-Confirm] [] ``` ### RegisterSet + ``` Add-AppxPackage [-Path] [-DependencyPath ] [-Register] [-DisableDevelopmentMode] [-ForceApplicationShutdown] [-ForceTargetApplicationShutdown] [-ForceUpdateFromAnyVersion] @@ -40,6 +43,7 @@ Add-AppxPackage [-Path] [-DependencyPath ] [-Register] [-Disa ``` ### UpdateSet + ``` Add-AppxPackage [-Path] [-DependencyPath ] [-RequiredContentGroupOnly] [-ForceApplicationShutdown] [-ForceTargetApplicationShutdown] [-ForceUpdateFromAnyVersion] @@ -47,6 +51,7 @@ Add-AppxPackage [-Path] [-DependencyPath ] [-RequiredContentG ``` ### StageSet + ``` Add-AppxPackage [-Path] [-DependencyPath ] [-RequiredContentGroupOnly] [-Stage] [-ForceUpdateFromAnyVersion] [-Volume ] [-ExternalPackages ] @@ -55,13 +60,15 @@ Add-AppxPackage [-Path] [-DependencyPath ] [-RequiredContentG ``` ### RegisterByPackageFullNameSet + ``` -Add-AppxPackage [-Register] -MainPackage [-DependencyPackages ] [-ForceApplicationShutdown] - [-ForceTargetApplicationShutdown] [-ForceUpdateFromAnyVersion] [-InstallAllResources] [-WhatIf] [-Confirm] - [] +Add-AppxPackage [-Register] -MainPackage [-DependencyPackages ] + [-ForceApplicationShutdown] [-ForceTargetApplicationShutdown] [-ForceUpdateFromAnyVersion] + [-InstallAllResources] [-WhatIf] [-Confirm] [] ``` ### RegisterByPackageFamilyNameSet + ``` Add-AppxPackage [-RegisterByFamilyName] -MainPackage [-DependencyPackages ] [-ForceApplicationShutdown] [-ForceTargetApplicationShutdown] [-InstallAllResources] @@ -69,19 +76,22 @@ Add-AppxPackage [-RegisterByFamilyName] -MainPackage [-DependencyPackag ``` ## DESCRIPTION -The **Add-AppxPackage** cmdlet adds a signed app package to a user account. -An app package has an .msix or .appx file name extension. -Use the *DependencyPath* parameter to add all other packages that are required for the installation of the app package. -You can use the *Register* parameter to install from a folder of unpackaged files during development of Windows® Store apps. +The `Add-AppxPackage` cmdlet adds a signed app package to a user account. An app package has an +`.msix` or `.appx` filename extension. Use the **DependencyPath** parameter to add all other +packages required for the installation of the app package. + +You can use the **Register** parameter to install from a folder of unpackaged files during +development of Windows Store apps. To update an already installed package, the new package must have the same package family name. ## EXAMPLES ### Example 1: Add an app package + ```powershell -PS C:\> Add-AppxPackage -Path "C:\Users\user1\Desktop\MyApp.msix" -DependencyPath "C:\Users\user1\Desktop\winjs.msix" +Add-AppxPackage -Path '.\MyApp.msix' -DependencyPath '.\winjs.msix' ``` This command adds an app package that the package contains. @@ -89,42 +99,64 @@ This command adds an app package that the package contains. ### Example 2: Update an app, but defer registration until the app has closed ```powershell -Add-AppxPackage -Path "C:\Users\user1\Desktop\MyApp.msix" -DependencyPath "C:\Users\user1\Desktop\winjs.msix" -DeferRegistrationWhenPackagesAreInUse +$params = @{ + Path = '.\MyApp.msix' + DependencyPath = '.\winjs.msix' + DeferRegistrationWhenPackagesAreInUse = $true +} +Add-AppxPackage @params ``` -This command will register an update to an existing app, but will not do so until the next launch of the app. +This command will register an update to an existing app, but won't do so until the next launch of +the app. ### Example 3: Add a disabled app package in development mode + ```powershell -$ManifestPath = (Get-AppxPackage -Name "*WindowsCalculator*").InstallLocation + "\Appxmanifest.xml" +$InstallLocation = Get-AppxPackage -Name '*WindowsCalculator*' | + Select-Object -ExpandProperty InstallLocation +$ManifestPath = $InstallLocation + '\Appxmanifest.xml' Add-AppxPackage -Path $ManifestPath -Register -DisableDevelopmentMode ``` -This command gets the full path of the package manifest file of an installed Windows Store app, and then registers that package. -You can use *DisableDevelopmentMode* to register an application that is staged by the **StagePackageAsync** API, has been disabled, or has become corrupted during testing. +This command gets the full path of the package manifest file of an installed Windows Store app, and +then registers that package. You can use **DisableDevelopmentMode** to register an application +that's staged by the **StagePackageAsync** API, has been disabled, or has become corrupted during +testing. ### Example 4: Add an app along with its optional packages + ```powershell -Add-AppxPackage -Path "C:\Users\user1\Desktop\MyApp.msixbundle" -ExternalPackages "C:\Users\user1\Desktop\optionalpackage1.msix","C:\Users\user1\Desktop\optionalpackage2.msixbundle" +Add-AppxPackage -Path '.\MyApp.msixbundle' -ExternalPackages @( + '.\optionalpackage1.msix' + '.\optionalpackage2.msixbundle' +) -Add-AppxPackage -Path "C:\Users\user1\Desktop\MyApp.msixbundle" -OptionalPackages "29270sandstorm.OptionalPackage1_gah1vdar1nn7a" +Add-AppxPackage -Path '.\MyApp.msixbundle' -OptionalPackages '29270sandstorm.OptionalPackage1_gah1vdar1nn7a' ``` -This command adds an app package along with its optional packages. It is an atomic operation which means that if the app or its optional packages fail to install, the deployment operation will be aborted +This command adds an app package along with its optional packages. It's an atomic operation, which +means that if the app or its optional packages fail to install, the deployment operation will be +aborted ### Example 5: Install only the required section of a streaming app + ```powershell -Add-AppxPackage -Path "C:\Users\user1\Desktop\MyApp.msixbundle" -RequiredContentGroupOnly +Add-AppxPackage -Path '.\MyApp.msixbundle' -RequiredContentGroupOnly ``` -This command adds an app package but only installs the required section of a streaming app. Calling this command again without the RequiredContentGroupOnly flag proceeds to install the rest of the application in the order defined by the AppxContentGroupMap.xml +This command adds an app package but only installs the required section of a streaming app. Calling +this command again without the **RequiredContentGroupOnly** parameter proceeds to install the rest +of the application in the order defined by the `AppxContentGroupMap.xml` ### Example 6: Install an app using the App Installer file + ```powershell Add-AppxPackage -AppInstallerFile "C:\Users\user1\Desktop\MyApp.appinstaller" ``` -This command adds an app package as outlined in the App Installer file with all update settings specified within the App Installer file, if any. +This command adds an app package as outlined in the App Installer file with all update settings +specified within the App Installer file, if any. ## PARAMETERS @@ -133,7 +165,7 @@ This command adds an app package as outlined in the App Installer file with all Allows adding an unsigned package. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: AddSet Aliases: @@ -145,11 +177,13 @@ Accept wildcard characters: False ``` ### -AppInstallerFile -Runs an appinstaller file and allows the user to install all of the defined packages with a single click. -For more information, see [Create an App Installer file manually](/windows/msix/app-installer/how-to-create-appinstaller-file). + +Runs an appinstaller file and allows the user to install all the defined packages with a single +click. For more information, see +[Create an App Installer file manually](/windows/msix/app-installer/how-to-create-appinstaller-file). ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: AddByAppInstallerSet Aliases: @@ -161,11 +195,12 @@ Accept wildcard characters: False ``` ### -DeferRegistrationWhenPackagesAreInUse -Specifies that the app will not register for a user if currently in use. The app will update on the next launch. +Specifies that the app won't register for a user if currently in use. The app will update on the +next launch. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: AddSet Aliases: @@ -177,10 +212,11 @@ Accept wildcard characters: False ``` ### -DependencyPackages + Specifies the dependency package full name or dependency package bundle full name to be registered. ```yaml -Type: String[] +Type: System.String[] Parameter Sets: RegisterByPackageFullNameSet, RegisterByPackageFamilyNameSet Aliases: @@ -192,12 +228,14 @@ Accept wildcard characters: False ``` ### -DependencyPath -Specifies an array of file paths of dependency packages that are required for the installation of the app package. -The app package has an .msix, .appx, .msixbundle, or .appxbundle file name extension. You can specify the paths to more than one dependency package. -If a package is already installed for a user, you can skip adding it to the DependencyPath. + +Specifies an array of file paths of dependency packages that are required for the installation of +the app package. The app package has an `.msix`, `.appx`, `.msixbundle`, or `.appxbundle` filename +extension. You can specify the paths to more than one dependency package. If a package is already +installed for a user, you can skip adding it to the DependencyPath. ```yaml -Type: String[] +Type: System.String[] Parameter Sets: AddSet, RegisterSet, UpdateSet, StageSet Aliases: @@ -209,13 +247,17 @@ Accept wildcard characters: False ``` ### -DisableDevelopmentMode -Indicates that this cmdlet registers an existing app package installation that has been disabled, did not register, or has become corrupted. -Use the current parameter to specify that the manifest is from an existing installation, and not from a collection of files in development mode. -You can also use this parameter to register an application that the [Package Manager API](https://go.microsoft.com/fwlink/?LinkId=245447) has staged. -Use the *Register* parameter to specify the location of the app package manifest .xml file from the installation location. + +Indicates that this cmdlet registers an existing app package installation that has been disabled, +didn't register, or has become corrupted. Use the current parameter to specify that the manifest is +from an existing installation, and not from a collection of files in development mode. You can also +use this parameter to register an application that the +[Package Manager API](https://go.microsoft.com/fwlink/?LinkId=245447) has staged. Use the +**Register** parameter to specify the location of the app package manifest `.xml` file from the +installation location. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: RegisterSet Aliases: @@ -232,7 +274,7 @@ URI path of an external disk location outside of the MSIX package where the pack reference application content. ```yaml -Type: String +Type: System.String Parameter Sets: AddSet, RegisterSet, StageSet Aliases: @@ -244,10 +286,13 @@ Accept wildcard characters: False ``` ### -ExternalPackages -Specifies an array of optional packages that must be installed along with the app package. It is an atomic operation which means that if the app or its optional packages fail to install, the deployment operation will be aborted + +Specifies an array of optional packages that must be installed along with the app package. It's an +atomic operation, which means that if the app or its optional packages fail to install, the +deployment operation will be aborted. ```yaml -Type: String[] +Type: System.String[] Parameter Sets: AddSet, StageSet Aliases: @@ -259,11 +304,13 @@ Accept wildcard characters: False ``` ### -ForceApplicationShutdown -Indicates that this cmdlet forces all active processes that are associated with the package or its dependencies to shut down. -If you specify this parameter, do not specify the *ForceTargetApplicationShutdown* parameter. + +Indicates that this cmdlet forces all active processes associated with the package or its +dependencies to shut down. If you specify this parameter, don't specify the +**ForceTargetApplicationShutdown** parameter. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: AddSet, RegisterSet, UpdateSet, RegisterByPackageFullNameSet, RegisterByPackageFamilyNameSet Aliases: @@ -275,11 +322,12 @@ Accept wildcard characters: False ``` ### -ForceTargetApplicationShutdown -Indicates that this cmdlet forces all active processes that are associated with the package to shut down. -If you specify this parameter, do not specify the *ForceApplicationShutdown* parameter. + +Indicates that this cmdlet forces all active processes associated with the package to shut down. If +you specify this parameter, don't specify the **ForceApplicationShutdown** parameter. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: AddSet, AddByAppInstallerSet, RegisterSet, UpdateSet, RegisterByPackageFullNameSet, RegisterByPackageFamilyNameSet Aliases: @@ -291,10 +339,12 @@ Accept wildcard characters: False ``` ### -ForceUpdateFromAnyVersion -This parameter is used to force a specific version of a package to be staged/registered, regardless of whether a higher version is already staged/registered. + +This parameter is used to force a specific version of a package to be staged or registered, +regardless of whether a higher version is already staged or registered. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: AddSet, RegisterSet, UpdateSet, StageSet, RegisterByPackageFullNameSet Aliases: @@ -306,12 +356,15 @@ Accept wildcard characters: False ``` ### -InstallAllResources -Indicates that this cmdlet forces the deployment of all resource packages specified from a bundle argument. -This overrides the resource applicability check of the deployment engine and forces staging of all resource packages, registration of all resource packages, or staging and registration of all resource packages. -This parameter can only be used when specifying a resource bundle or resource bundle manifest. + +Indicates that this cmdlet forces the deployment of all resource packages specified from a bundle +argument. This overrides the resource applicability check of the deployment engine and forces +staging of all resource packages, registration of all resource packages, or staging and registration +of all resource packages. This parameter can only be used when specifying a resource bundle or +resource bundle manifest. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: AddSet, AddByAppInstallerSet, RegisterSet, UpdateSet, RegisterByPackageFullNameSet, RegisterByPackageFamilyNameSet Aliases: @@ -323,10 +376,11 @@ Accept wildcard characters: False ``` ### -LimitToExistingPackages + This parameter is used to prevent missing referenced packages to be downloaded. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: AddByAppInstallerSet Aliases: @@ -338,10 +392,11 @@ Accept wildcard characters: False ``` ### -MainPackage + Specifies the main package full name or bundle full name to register. ```yaml -Type: String +Type: System.String Parameter Sets: RegisterByPackageFullNameSet, RegisterByPackageFamilyNameSet Aliases: @@ -353,10 +408,14 @@ Accept wildcard characters: False ``` ### -OptionalPackages -Specifies the PackageFamilyName of the optional packages that are in a related set that need to be installed along with the app. Unlike the external packages flag, you do not need to pass in a path to the optional package(s). It is an atomic operation which means that if the app or its optional packages fail to install, the deployment operation will be aborted + +Specifies the PackageFamilyName of the optional packages that are in a related set that need to be +installed along with the app. Unlike the external packages flag, you don't need to pass in a path +to the optional packages. It's an atomic operation, which means that if the app or its optional +packages fail to install, the deployment operation will be aborted. ```yaml -Type: String[] +Type: System.String[] Parameter Sets: AddSet, StageSet, RegisterByPackageFamilyNameSet Aliases: @@ -368,11 +427,12 @@ Accept wildcard characters: False ``` ### -Path -Specifies the file path of the app package. -An app package has an .msix, .appx, .msixbundle, or .appxbundle file name extension. + +Specifies the path to the app package file. An app package has an `.msix`, `.appx`, `.msixbundle`, +or `.appxbundle` filename extension. ```yaml -Type: String +Type: System.String Parameter Sets: AddSet, AddByAppInstallerSet, RegisterSet, UpdateSet, StageSet Aliases: PSPath @@ -384,14 +444,16 @@ Accept wildcard characters: False ``` ### -Register -Indicates that this cmdlet registers an application in development mode. -You can use development mode to install applications from a folder of unpackaged files. -You can use the current parameter to test your Windows® Store apps before you deploy them as app packages. -To register an existing app package installation, you must specify the *DisableDevelopmentMode* parameter and the *Register* parameter. -In order to specify dependency packages, specify the *DependencyPath* parameter and the *DisableDevelopmentMode* parameter. + +Indicates that this cmdlet registers an application in development mode. You can use development +mode to install applications from a folder of unpackaged files. You can use the current parameter +to test your Windows Store apps before you deploy them as app packages. To register an existing app +package installation, you must specify the **DisableDevelopmentMode** parameter and the +**Register** parameter. To specify dependency packages, use the **DependencyPath** parameter and +the **DisableDevelopmentMode** parameter. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: RegisterSet Aliases: @@ -403,7 +465,7 @@ Accept wildcard characters: False ``` ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: RegisterByPackageFullNameSet Aliases: @@ -415,10 +477,11 @@ Accept wildcard characters: False ``` ### -RegisterByFamilyName + Specifies the parameter -MainPackage that defines the family name or full name to be registered. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: RegisterByPackageFamilyNameSet Aliases: @@ -430,10 +493,12 @@ Accept wildcard characters: False ``` ### -RelatedPackages -This is an optional element that is used to specify the other optional packages that are specified in the main app package. These packages will not be installed as part of the deployment operation. + +This is an optional element that's used to specify the other optional packages that are specified +in the main app package. These packages won't be installed as part of the deployment operation. ```yaml -Type: String[] +Type: System.String[] Parameter Sets: AddSet, StageSet Aliases: @@ -445,10 +510,14 @@ Accept wildcard characters: False ``` ### -RequiredContentGroupOnly -Specifies that only the required content group that is specified in the AppxContentGroupMap.xml must be installed. At this point the app can be launched. Calling add-appxpackage specifying the path to the app, triggers the rest of the app to be installed in the order defined in the AppxContentGroupMap.xml. + +Specifies that only the required content group that's specified in the `AppxContentGroupMap.xml` +must be installed. At this point the app can be launched. Calling `Add-AppxPackage` and specifying +the path to the app triggers the rest of the app to be installed in the order defined in the +`AppxContentGroupMap.xml`. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: AddSet, AddByAppInstallerSet, UpdateSet, StageSet Aliases: @@ -460,10 +529,12 @@ Accept wildcard characters: False ``` ### -RetainFilesOnFailure -In the case of a failed deployment, if this switch is set to $true, files that have been created on the target machine during the installation process are not removed. + +In case of a failed deployment, if this switch is set to `$true`, files that have been created on +the target machine during the installation process aren't removed. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: AddSet, UpdateSet Aliases: @@ -475,10 +546,11 @@ Accept wildcard characters: False ``` ### -Stage + Stages a package to the system without registering it. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: StageSet Aliases: @@ -491,13 +563,15 @@ Accept wildcard characters: False ### -StubPackageOption -Defines the stub behavior for an app package that is being added or staged. -The acceptable values +Defines the stub behavior for an app package that's being added or staged. The acceptable values for this parameter are: -- Default: Uses the default behavior -- InstallFull: Installs as a full app -- InstallStub: Installs as a stub app -- UsePreference: Uses the current [PackageSubPreference](/uwp/api/windows.management.deployment.packagestubpreference) for the package + +- `Default`: Uses the default behavior +- `InstallFull`: Installs as a full app +- `InstallStub`: Installs as a stub app +- `UsePreference`: Uses the current + [PackageSubPreference](/uwp/api/windows.management.deployment.packagestubpreference) for the + package ```yaml Type: StubPackageOption @@ -512,13 +586,15 @@ Accept wildcard characters: False ``` ### -Update -Specifies that the package being added is a dependency package update. -A dependency package is removed from the user account when the parent app is removed. -If you do not use this parameter, the package being added is a primary package and is not removed from the user account if the parent app is removed. -To update an already installed package, the new package must have the same package family name. + +Specifies that the package being added is a dependency package update. A dependency package is +removed from the user account when the parent app is removed. If you don't use this parameter, the +package being added is a primary package and isn't removed from the user account if the parent app +is removed. To update an already installed package, the new package must have the same package +family name. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: UpdateSet Aliases: @@ -530,8 +606,9 @@ Accept wildcard characters: False ``` ### -Volume -Specifies the **AppxVolume** object to which to stage the package. -The volume also specifies the default location for user **AppData**. + +Specifies the **AppxVolume** object to stage the package in. The volume also specifies the default +location for user **AppData**. ```yaml Type: AppxVolume @@ -546,10 +623,11 @@ Accept wildcard characters: False ``` ### -Confirm + Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf @@ -561,11 +639,11 @@ Accept wildcard characters: False ``` ### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. + +Shows what would happen if the cmdlet runs. The cmdlet isn't run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi @@ -577,7 +655,11 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, +-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, +-WarningAction, and -WarningVariable. For more information, see +[about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/docset/winserver2022-ps/appx/Add-AppxVolume.md b/docset/winserver2022-ps/appx/Add-AppxVolume.md index 4ee0d3af6a..980d59ebe0 100644 --- a/docset/winserver2022-ps/appx/Add-AppxVolume.md +++ b/docset/winserver2022-ps/appx/Add-AppxVolume.md @@ -2,7 +2,7 @@ description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. external help file: Microsoft.Windows.Appx.PackageManager.Commands.dll-Help.xml Module Name: Appx -ms.date: 12/20/2016 +ms.date: 05/15/2023 online version: https://learn.microsoft.com/powershell/module/appx/add-appxvolume?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Add-AppxVolume @@ -20,28 +20,31 @@ Add-AppxVolume [-Path] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION -The **Add-AppxVolume** cmdlet adds an **AppxVolume** for the Package Manager to advertise. -After you add a volume, appx deployment operations can use that volume as a target. -This cmdlet returns the volume that it adds. -Note, the *Path* parameter must be specified as a drive letter followed by "WindowsApps" as the directory. -Not using the aforementioned format could lead to inconsistent behavior in the application model subsystems or the volume itself; for more information see the examples section. + +The `Add-AppxVolume` cmdlet adds an **AppxVolume** for the Package Manager to advertise. After you +add a volume, Appx deployment operations can use that volume as a target. This cmdlet returns the +volume that it adds. Note, the **Path** parameter must be specified as a drive letter followed by +`WindowsApps` as the directory. Not using this format could lead to inconsistent behavior in the +application model subsystems or the volume itself. For more information, see the examples section. ## EXAMPLES ### Example 1: Add a volume -``` -PS C:\> Add-AppxVolume -Path "E:\WindowsApps" + +```powershell +Add-AppxVolume -Path "E:\WindowsApps" ``` -This command adds the volume E:\WindowsApps to Package Manager. +This command adds the volume `E:\WindowsApps` to Package Manager. ## PARAMETERS ### -Path + Specifies the path of the mount point of the volume that this cmdlet adds. ```yaml -Type: String[] +Type: System.String[] Parameter Sets: (All) Aliases: PSPath @@ -53,10 +56,11 @@ Accept wildcard characters: False ``` ### -Confirm + Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf @@ -68,10 +72,11 @@ Accept wildcard characters: False ``` ### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. + +Shows what would happen if the cmdlet runs. The cmdlet isn't run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi @@ -83,13 +88,18 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, +-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, +-WarningAction, and -WarningVariable. For more information, see +[about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS ## OUTPUTS ### Microsoft.Appx.PackageManager.Commands.AppxVolume + This cmdlet returns the **AppxVolume** object that it adds. ## NOTES @@ -103,4 +113,3 @@ This cmdlet returns the **AppxVolume** object that it adds. [Mount-AppxVolume](./Mount-AppxVolume.md) [Remove-AppxVolume](./Remove-AppxVolume.md) - diff --git a/docset/winserver2022-ps/appx/Appx.md b/docset/winserver2022-ps/appx/Appx.md index d841c44244..a9ee193671 100644 --- a/docset/winserver2022-ps/appx/Appx.md +++ b/docset/winserver2022-ps/appx/Appx.md @@ -5,81 +5,105 @@ Help Version: 5.0.6.4 Locale: en-US Module Guid: aeef2bef-eba9-4a1d-a3d2-d0b52df76deb Module Name: Appx -ms.date: 03/18/2022 +ms.date: 05/15/2023 title: Appx --- # Appx Module + ## Description -The Windows PowerShell cmdlets for AppX are designed to streamline the administration of MSIX or AppX package management. + +The Windows PowerShell cmdlets for AppX are designed to streamline the administration of MSIX or +AppX package management. ## Appx Cmdlets ### [Add-AppSharedPackageContainer](Add-AppSharedPackageContainer.md) -Deploys the shared package container definiton. + +Deploys the shared package container definition. ### [Add-AppxPackage](Add-AppxPackage.md) + Adds a signed app package to a user account. ### [Add-AppxVolume](Add-AppxVolume.md) + Adds an appx volume to the Package Manager. ### [Dismount-AppxVolume](Dismount-AppxVolume.md) + Dismounts an appx volume. ### [Get-AppSharedPackageContainer](Get-AppSharedPackageContainer.md) + Gets information about the shared package container. ### [Get-AppxDefaultVolume](Get-AppxDefaultVolume.md) + Gets the default appx volume. ### [Get-AppxLastError](Get-AppxLastError.md) + Get the last error reported in the app package installation logs. ### [Get-AppxLog](Get-AppxLog.md) + Gets an app package installation log. ### [Get-AppxPackage](Get-AppxPackage.md) + Gets a list of the app packages that are installed in a user profile. ### [Get-AppxPackageAutoUpdateSettings](Get-AppxPackageAutoUpdateSettings.md) -Provides visibility to the settings configured on a Windows 10 client device for a particular Windows App. + +Provides visibility to the settings configured on a Windows 10 client device for a particular +Windows App. ### [Get-AppxPackageManifest](Get-AppxPackageManifest.md) + Gets the manifest of an app package. ### [Get-AppxVolume](Get-AppxVolume.md) + Gets appx volumes for the computer. ### [Invoke-CommandInDesktopPackage](Invoke-CommandInDesktopPackage.md) + Runs a command in the context of a specified app package. ### [Mount-AppxVolume](Mount-AppxVolume.md) + Mounts an appx volume. ### [Move-AppxPackage](Move-AppxPackage.md) + Moves a package from its current location to another appx volume. ### [Remove-AppSharedPackageContainer](Remove-AppSharedPackageContainer.md) + Removes the shared package container. ### [Remove-AppxPackage](Remove-AppxPackage.md) -Removes an app package from one or more user accounts. -### [Remove-AppxPackageAutoUpdateSettings](Remove-AppxPackageAutoUpdateSettings.md) -{{ Fill in the Synopsis }} +Removes an app package from one or more user accounts. ### [Remove-AppxVolume](Remove-AppxVolume.md) + Removes an appx volume. ### [Reset-AppSharedPackageContainer](Reset-AppSharedPackageContainer.md) + Destroys all the application data of the container. ### [Reset-AppxPackage](Reset-AppxPackage.md) + Use to reset your installed Windows Apps. Restores the Windows app to its initial configuration. ### [Set-AppxDefaultVolume](Set-AppxDefaultVolume.md) + Specifies a default appx volume. ### [Set-AppxPackageAutoUpdateSettings](Set-AppxPackageAutoUpdateSettings.md) -Provides access to configure a specific Windows App's Auto Update and Repair settings. Including pausing update checks. + +Provides access to configure a specific Windows App's Auto Update and Repair settings. Including +pausing update checks. diff --git a/docset/winserver2022-ps/appx/Dismount-AppxVolume.md b/docset/winserver2022-ps/appx/Dismount-AppxVolume.md index 214abd4447..1c9f3d0462 100644 --- a/docset/winserver2022-ps/appx/Dismount-AppxVolume.md +++ b/docset/winserver2022-ps/appx/Dismount-AppxVolume.md @@ -2,7 +2,7 @@ description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. external help file: Microsoft.Windows.Appx.PackageManager.Commands.dll-Help.xml Module Name: Appx -ms.date: 12/20/2016 +ms.date: 05/15/2023 online version: https://learn.microsoft.com/powershell/module/appx/dismount-appxvolume?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Dismount-AppxVolume @@ -20,21 +20,24 @@ Dismount-AppxVolume [-Volume] [-WhatIf] [-Confirm] [ Dismount-AppxVolume -Volume E:\ + +```powershell +Dismount-AppxVolume -Volume E:\ ``` -This command dismounts a volume at the path E:\. +This command dismounts a volume at the path `E:\`. ### Example 2: Dismount a volume by using an ID -``` -PS C:\> Dismount-AppxVolume -Volume {7e62a691-398e-4fbe-819a-64f1e407777a} + +```powershell +Dismount-AppxVolume -Volume {7e62a691-398e-4fbe-819a-64f1e407777a} ``` This command dismounts a volume that has the specified media ID. @@ -42,6 +45,7 @@ This command dismounts a volume that has the specified media ID. ## PARAMETERS ### -Volume + Specifies the **AppxVolume** object to dismount. ```yaml @@ -57,10 +61,11 @@ Accept wildcard characters: False ``` ### -Confirm + Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf @@ -72,10 +77,11 @@ Accept wildcard characters: False ``` ### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. + +Shows what would happen if the cmdlet runs. The cmdlet isn't run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi @@ -87,7 +93,11 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, +-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, +-WarningAction, and -WarningVariable. For more information, see +[about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -104,4 +114,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Mount-AppxVolume](./Mount-AppxVolume.md) [Remove-AppxVolume](./Remove-AppxVolume.md) - diff --git a/docset/winserver2022-ps/appx/Get-AppSharedPackageContainer.md b/docset/winserver2022-ps/appx/Get-AppSharedPackageContainer.md index a5e5bb283d..1c246623d2 100644 --- a/docset/winserver2022-ps/appx/Get-AppSharedPackageContainer.md +++ b/docset/winserver2022-ps/appx/Get-AppSharedPackageContainer.md @@ -1,8 +1,10 @@ --- external help file: Microsoft.Windows.Appx.PackageManager.Commands.dll-Help.xml Module Name: appx +ms.date: 05/15/2023 online version: https://learn.microsoft.com/powershell/module/appx/get-appsharedpackagecontainer?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 +title: Get-AppSharedPackageContainer --- # Get-AppSharedPackageContainer @@ -13,20 +15,24 @@ Gets information about the shared package container. ## SYNTAX ``` -Get-AppSharedPackageContainer [[-Name] ] [[-Id] ] [-AllUsers] [] +Get-AppSharedPackageContainer [[-Name] ] [[-Id] ] [-AllUsers] + [] ``` ## DESCRIPTION -The cmdlet shows information about any shared package container. -In particular, it will show what packages are inside the shared package container. + +The cmdlet shows information about any shared package container. In particular, it shows what +packages are inside the shared package container. ## EXAMPLES ### Example 1 -```powershell -PS C:\> Get-AppSharedPackageContainer -Name Contoso* +```powershell +Get-AppSharedPackageContainer -Name Contoso* +``` +```output Name : ContosoTestContainer Id : ContosoTestContainer_1 PackageFamilyNames : {Contoso.SpellCheckPlugin.1.0.0.0_7pneu3d8sswe, Notepad++.2.0.0.1_ohjis898f1} @@ -41,10 +47,11 @@ This command shows the packages in any shared package container that has a prefi ## PARAMETERS ### -AllUsers -Unsupported. Will result in "-AllUsers functionality is not yet implemented" error. + +Unsupported. Will result in `-AllUsers functionality is not yet implemented` error. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -56,10 +63,11 @@ Accept wildcard characters: False ``` ### -Id + Id of the container. Can be acquired by running `Get-AppSharedPackageContainer`. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -71,10 +79,11 @@ Accept wildcard characters: False ``` ### -Name + The name of the container. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -86,7 +95,11 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, +-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, +-WarningAction, and -WarningVariable. For more information, see +[about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -95,6 +108,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### System.Object + ## NOTES ## RELATED LINKS diff --git a/docset/winserver2022-ps/appx/Get-AppxDefaultVolume.md b/docset/winserver2022-ps/appx/Get-AppxDefaultVolume.md index b2ef82e7a6..f8db5ddfec 100644 --- a/docset/winserver2022-ps/appx/Get-AppxDefaultVolume.md +++ b/docset/winserver2022-ps/appx/Get-AppxDefaultVolume.md @@ -2,7 +2,7 @@ description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. external help file: Microsoft.Windows.Appx.PackageManager.Commands.dll-Help.xml Module Name: Appx -ms.date: 12/20/2016 +ms.date: 05/15/2023 online version: https://learn.microsoft.com/powershell/module/appx/get-appxdefaultvolume?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Get-AppxDefaultVolume @@ -20,15 +20,17 @@ Get-AppxDefaultVolume [] ``` ## DESCRIPTION -The **Get-AppxDefaultVolume** cmdlet gets the default **AppxVolume**. -The default **AppxVolume** is the default target for all deployment operations on the computer. -You cannot remove the default **AppxVolume** from the list of volumes. + +The `Get-AppxDefaultVolume` cmdlet gets the default **AppxVolume**. The default **AppxVolume** is +the default target for all deployment operations on the computer. You can't remove the default +**AppxVolume** from the list of volumes. ## EXAMPLES ### Example 1: Get the default volume -``` -PS C:\> Get-AppxDefaultVolume + +```powershell +Get-AppxDefaultVolume ``` This command gets the current default deployment target. @@ -36,7 +38,11 @@ This command gets the current default deployment target. ## PARAMETERS ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, +-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, +-WarningAction, and -WarningVariable. For more information, see +[about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -49,4 +55,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS [Set-AppxDefaultVolume](./Set-AppxDefaultVolume.md) - diff --git a/docset/winserver2022-ps/appx/Get-AppxLastError.md b/docset/winserver2022-ps/appx/Get-AppxLastError.md index b2f4ab35b3..150413658d 100644 --- a/docset/winserver2022-ps/appx/Get-AppxLastError.md +++ b/docset/winserver2022-ps/appx/Get-AppxLastError.md @@ -2,7 +2,7 @@ description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. external help file: Microsoft.Windows.Appx.PackageManager.Commands.dll-help.xml Module Name: Appx -ms.date: 12/20/2016 +ms.date: 05/15/2023 online version: https://learn.microsoft.com/powershell/module/appx/get-appxlasterror?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Get-AppxLastError @@ -20,14 +20,17 @@ Get-AppxLastError [] ``` ## DESCRIPTION -The **Get-AppxLastError** cmdlet gets the last error reported in the app package installation logs for the current Windows PowerShell® session. -An app package has an .msix or .appx file name extension. + +The `Get-AppxLastError` cmdlet gets the last error reported in the app package installation logs +for the current Windows PowerShell session. An app package has an `.msix` or `.appx` file +extension. ## EXAMPLES ### Example 1: Get the last error -``` -PS C:\> Get-AppxLastError + +```powershell +Get-AppxLastError ``` This command gets the last error reported in the app installation logs. @@ -35,7 +38,11 @@ This command gets the last error reported in the app installation logs. ## PARAMETERS ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, +-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, +-WarningAction, and -WarningVariable. For more information, see +[about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -58,4 +65,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Get-AppxPackageManifest](./Get-AppxPackageManifest.md) [Get-AppxLog](./Get-AppxLog.md) - diff --git a/docset/winserver2022-ps/appx/Get-AppxLog.md b/docset/winserver2022-ps/appx/Get-AppxLog.md index f0c55eee1f..5be4ced937 100644 --- a/docset/winserver2022-ps/appx/Get-AppxLog.md +++ b/docset/winserver2022-ps/appx/Get-AppxLog.md @@ -2,7 +2,7 @@ description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. external help file: Microsoft.Windows.Appx.PackageManager.Commands.dll-help.xml Module Name: Appx -ms.date: 12/20/2016 +ms.date: 05/15/2023 online version: https://learn.microsoft.com/powershell/module/appx/get-appxlog?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Get-AppxLog @@ -16,36 +16,44 @@ Gets an app package installation log. ## SYNTAX ### All (Default) + ``` Get-AppxLog [-All] [] ``` ### ActivityId + ``` -Get-AppxLog [-ActivityId ] [] +Get-AppxLog [-ActivityId ] [] ``` ## DESCRIPTION -The **Get-AppxLog** cmdlet gets the app package installation log created during the deployment of an app package. -An app package has an .msix or .appx file name extension. -The log contains errors, warnings, and additional information about the processes initiated by cmdlets in the Appx Windows PowerShell® module. -When Add-AppxPackage or Remove-AppxPackage report a failure, they return the **ActivityID** to use with **Get-AppxLog**. +The `Get-AppxLog` cmdlet gets the app package installation log created during the deployment of +an app package. An app package has an `.msix` or `.appx` file extension. The log contains errors, +warnings, and additional information about the processes initiated by cmdlets in the Appx Windows +PowerShell module. + +When `Add-AppxPackage` or `Remove-AppxPackage` report a failure, they return the **ActivityID** to +use with `Get-AppxLog`. -For more information about common error codes, see [Troubleshooting packaging, deployment, and query of Windows Store apps](https://go.microsoft.com/fwlink/?LinkId=271201). +For more information about common error codes, see +[Troubleshooting packaging, deployment, and query of Windows Store apps](https://go.microsoft.com/fwlink/?LinkId=271201). ## EXAMPLES ### Example 1: Get logs for the most recent deployment -``` -PS C:\> Get-AppxLog + +```powershell +Get-AppxLog ``` This command gets the logs associated with the most recent deployment operation. ### Example 2: Get logs for all logs -``` -PS C:\> Get-AppxLog -All + +```powershell +Get-AppxLog -All ``` This command gets all the app package installation logs on the computer. @@ -53,11 +61,12 @@ This command gets all the app package installation logs on the computer. ## PARAMETERS ### -ActivityId -Specifies an activity ID. -This cmdlet uses the ID to get the log for a particular app package installation. + +Specifies an activity ID. This cmdlet uses the ID to get the log for a particular app package +installation. ```yaml -Type: String +Type: System.String Parameter Sets: ActivityId Aliases: @@ -69,11 +78,12 @@ Accept wildcard characters: False ``` ### -All -Indicates that the cmdlet gets all logs on the computer. -You can get additional information when you run this cmdlets from Windows PowerShell as an administrator. + +Indicates that the cmdlet gets all logs on the computer. You can get additional information when you +run this cmdlets from Windows PowerShell as an administrator. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: All Aliases: @@ -85,11 +95,15 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, +-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, +-WarningAction, and -WarningVariable. For more information, see +[about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS -### System.String[] +### System.System.String[] ## OUTPUTS @@ -110,4 +124,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Get-AppxPackageManifest](./Get-AppxPackageManifest.md) [Get-AppxLastError](./Get-AppxLastError.md) - diff --git a/docset/winserver2022-ps/appx/Get-AppxPackage.md b/docset/winserver2022-ps/appx/Get-AppxPackage.md index c08ccc6e45..cf1ab1795a 100644 --- a/docset/winserver2022-ps/appx/Get-AppxPackage.md +++ b/docset/winserver2022-ps/appx/Get-AppxPackage.md @@ -2,7 +2,7 @@ description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. external help file: Microsoft.Windows.Appx.PackageManager.Commands.dll-Help.xml Module Name: Appx -ms.date: 12/20/2016 +ms.date: 05/15/2023 online version: https://learn.microsoft.com/powershell/module/appx/get-appxpackage?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Get-AppxPackage @@ -16,39 +16,46 @@ Gets a list of the app packages that are installed in a user profile. ## SYNTAX ``` -Get-AppxPackage [-AllUsers] [-PackageTypeFilter ] [[-Name] ] [[-Publisher] ] - [-User ] [-Volume ] [] +Get-AppxPackage [-AllUsers] [-PackageTypeFilter ] + [[-Name] ] [[-Publisher] ] [-User ] + [-Volume ] [] ``` ## DESCRIPTION -The **Get-AppxPackage** cmdlet gets a list of the app packages that are installed in a user profile. -An app package has an .msix or .appx file name extension. -To get the list of packages for a user profile other than the profile for the current user, you must run this command by using administrator permissions. + +The `Get-AppxPackage` cmdlet gets a list of the app packages that are installed in a user profile. +An app package has an `.msix` or `.appx` file extension. To get the list of packages for a user +profile other than the profile for the current user, you must run this command with administrator +permissions. ## EXAMPLES ### Example 1: Get all app packages for every user account -``` -PS C:\> Get-AppxPackage -AllUsers + +```powershell +Get-AppxPackage -AllUsers ``` This command lists the app packages that are installed for every user account on the computer. ### Example 2: Get an app package for a specific a user -``` -PS C:\> Get-AppxPackage -Name "Package17" -User "Contoso\EvanNarvaez" + +```powershell +Get-AppxPackage -Name "Package17" -User "Contoso\EvanNarvaez" ``` -This command displays information about Package17 if it is installed in the specified user profile. +This command displays information about `Package17` if it's installed in the specified user +profile. ## PARAMETERS ### -AllUsers -Indicates that this cmdlet lists app packages for all user accounts on the computer. -To use this parameter, you must run the command by using administrator permissions. + +Indicates that this cmdlet lists app packages for all user accounts on the computer. To use this +parameter, you must run the command with administrator permissions. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -60,12 +67,12 @@ Accept wildcard characters: False ``` ### -Name -Specifies the name of a particular package. -If you specify this parameter, the cmdlet returns results for this package only. -Wildcards are permitted. + +Specifies the name of a particular package. If you specify this parameter, the cmdlet returns +results for this package only. Wildcards are permitted. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -77,9 +84,11 @@ Accept wildcard characters: False ``` ### -PackageTypeFilter -Specifies one or more comma-separated types of packages that the cmdlet gets from the package repository. -By default, this cmdlet returns only packages of types Main and Framework. +Specifies one or more comma-separated types of packages that the cmdlet gets from the package +repository. + +By default, this cmdlet returns only packages of types `Main` and `Framework`. ```yaml Type: PackageTypes @@ -95,12 +104,12 @@ Accept wildcard characters: False ``` ### -Publisher -Specifies the publisher of a particular package. -If you specify this parameter, the cmdlet returns results only for this publisher. -Wildcards are permitted. + +Specifies the publisher of a particular package. If you specify this parameter, the cmdlet returns +results only for this publisher. Wildcards are permitted. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -112,18 +121,19 @@ Accept wildcard characters: False ``` ### -User -Specifies a user. -If you specify this parameter, the cmdlet returns a list of app packages that are installed for only the user that this cmdlet specifies. -To get the list of packages for a user profile other than the profile for the current user, you must run this command by using administrator permissions. -The user name can be in one of these formats: -- domain\user_name -- user_name@fqn.domain.tld -- user_name -- SID-string +Specifies a user. If you specify this parameter, the cmdlet returns a list of app packages that are +installed for only the user that this cmdlet specifies. To get the list of packages for a user +profile other than the profile for the current user, you must run this command with +administrator permissions. The user name can be in one of these formats: + +- `domain\user_name` +- `user_name@fqn.domain.tld` +- `user_name` +- `SID-string` ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -135,8 +145,9 @@ Accept wildcard characters: False ``` ### -Volume -Specifies an **AppxVolume** object. -If you specify this parameter, this cmdlet returns only packages that are relative to volume that this parameter specifies. + +Specifies an **AppxVolume** object. If you specify this parameter, this cmdlet returns only +packages that are relative to volume that this parameter specifies. ```yaml Type: AppxVolume @@ -151,7 +162,11 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, +-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, +-WarningAction, and -WarningVariable. For more information, see +[about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -160,7 +175,9 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### Microsoft.Windows.Appx.PackageManager.Commands.AppxPackage -This cmdlet returns an **AppxPackage** object that contains information, including the full name of the app package. + +This cmdlet returns an **AppxPackage** object that contains information, including the full name of +the app package. ## NOTES @@ -177,4 +194,3 @@ This cmdlet returns an **AppxPackage** object that contains information, includi [Move-AppxPackage](./Move-AppxPackage.md) [Remove-AppxPackage](./Remove-AppxPackage.md) - diff --git a/docset/winserver2022-ps/appx/Get-AppxPackageAutoUpdateSettings.md b/docset/winserver2022-ps/appx/Get-AppxPackageAutoUpdateSettings.md index 3f0c0419cb..c70846fe05 100644 --- a/docset/winserver2022-ps/appx/Get-AppxPackageAutoUpdateSettings.md +++ b/docset/winserver2022-ps/appx/Get-AppxPackageAutoUpdateSettings.md @@ -2,7 +2,7 @@ description: Provides guidance on how to view the auto-update and repair settings of a Windows App. external help file: Microsoft.Windows.Appx.PackageManager.Commands.dll-help.xml Module Name: Appx -ms.date: 06/07/2021 +ms.date: 05/15/2023 online version: https://learn.microsoft.com/powershell/module/appx/Get-AppxPackageAutoUpdateSettings?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 --- @@ -10,48 +10,58 @@ schema: 2.0.0 # Get-AppxPackageAutoUpdateSettings ## SYNOPSIS -Available in the Windows Insider Preview Builds of Windows 10, is the `Get-AppxPackageAutoUpdateSettings` PowerShell cmdlet. The `Get-AppxPackageAutoUpdateSettings` PowerShell cmdlet provides visibility to the settings configured on a Windows 10 client device for a particular Windows App. + +Provides visibility to the settings configured for a particular Windows App. ## SYNTAX ``` -Get-AppxPackageAutoUpdateSettings [[-PackageFullName] ] [-ShowUpdateAvailability] [-AllUsers] - [] +Get-AppxPackageAutoUpdateSettings [[-PackageFullName] ] [-ShowUpdateAvailability] + [-AllUsers] [] ``` ## DESCRIPTION -The `Get-AppxPackageAutoUpdateSettings` PowerShell cmdlet will return the settings configured for a specific or all installed Windows Apps in relation to Auto Update and Repair. + +The `Get-AppxPackageAutoUpdateSettings` PowerShell cmdlet returns the settings configured for a +specific or all installed Windows Apps in relation to Auto Update and Repair. ## EXAMPLES ### Example 1: Get all App Package Auto Update settings -``` -PS C:\> Get-AppxPackageAutoUpdateSettings + +```powershell +Get-AppxPackageAutoUpdateSettings ``` -This will return the Auto Update and Repair settings for all configured and installed Windows Apps on the device, and registered to the user. +This will return the Auto Update and Repair settings for all configured and installed Windows Apps +on the device, and registered to the user. ### Example 2: Get App Package Auto Update settings for all users -``` -PS C:\> Get-AppxPackageAutoUpdateSettings -AllUsers + +```powershell +Get-AppxPackageAutoUpdateSettings -AllUsers ``` -This will return the Auto Update and Repair settings for all configured and installed Windows Apps that have been registered for all users. +This will return the Auto Update and Repair settings for all configured and installed Windows Apps +that have been registered for all users. ### Example 3: Get a single App Package Auto Update setting -``` -PS C:\> Get-AppxPackageAutoUpdateSettings -PackageFullName publisher.package1_1.0.0.0_neutral__8wekyb3d8bbwe + +```powershell +Get-AppxPackageAutoUpdateSettings -PackageFullName publisher.package1_1.0.0.0_neutral__8wekyb3d8bbwe ``` -This will return the Auto Update and Repair settings for a specific Windows App that has been installed and registered to the signed-in user. +This will return the Auto Update and Repair settings for a specific Windows App that has been +installed and registered to the signed-in user. ## PARAMETERS ### -PackageFullName -Specifies the Package Full Name of the app that is being queried. + +Specifies the Package Full Name of the app that's being queried. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -63,6 +73,7 @@ Accept wildcard characters: True ``` ### -ShowUpdateAvailability + Specifies to display available update information for a specific Windows App. ```yaml @@ -78,7 +89,9 @@ Accept wildcard characters: False ``` ### -AllUsers -Specifies to display Windows App Auto Update and Repair settings for all that are installed for all users. + +Specifies to display Windows App Auto Update and Repair settings for all that are installed for all +users. ```yaml Type: SwitchParameter @@ -94,7 +107,11 @@ Accept wildcard characters: False ### CommonParameters -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). + +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). ## INPUTS @@ -105,6 +122,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### System.Object + ## NOTES ## RELATED LINKS diff --git a/docset/winserver2022-ps/appx/Get-AppxPackageManifest.md b/docset/winserver2022-ps/appx/Get-AppxPackageManifest.md index 47abf4730b..217e422481 100644 --- a/docset/winserver2022-ps/appx/Get-AppxPackageManifest.md +++ b/docset/winserver2022-ps/appx/Get-AppxPackageManifest.md @@ -2,7 +2,7 @@ description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. external help file: Microsoft.Windows.Appx.PackageManager.Commands.dll-Help.xml Module Name: Appx -ms.date: 12/20/2016 +ms.date: 05/15/2023 online version: https://learn.microsoft.com/powershell/module/appx/get-appxpackagemanifest?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Get-AppxPackageManifest @@ -20,29 +20,33 @@ Get-AppxPackageManifest [-Package] [[-User] ] [ Get-AppxPackageManifest -Package "package1_1.0.0.0_neutral__8wekyb3d8bbwe" + +```powershell +Get-AppxPackageManifest -Package "package1_1.0.0.0_neutral__8wekyb3d8bbwe" ``` This command gets the manifest for an app package named package1_1.0.0.0_neutral__8wekyb3d8bbwe. ### Example 2: Get the application ID for an app package -``` -PS C:\> (Get-AppxPackage -Name "*WinJS*" | Get-AppxPackageManifest).package.applications.application.id + +```powershell +(Get-AppxPackage -Name "*WinJS*" | Get-AppxPackageManifest).package.applications.application.id ``` This command gets the application ID for an app package that has the string WinJS in the name. ### Example 3 -``` -PS C:\> (Get-AppxPackage -Name "*ZuneMusic*" | Get-AppxPackageManifest).Package.Capabilities + +```powershell +(Get-AppxPackage -Name "*ZuneMusic*" | Get-AppxPackageManifest).Package.Capabilities ``` This command gets the capabilities for an app package that has the string ZuneMusic in the name. @@ -50,12 +54,13 @@ This command gets the capabilities for an app package that has the string ZuneMu ## PARAMETERS ### -Package -Specifies an **AppxPackage** object or the full name of a package. -To get the manifest of a package on the computer that is not installed for the current user, you must run this command by using administrator permissions. -Wildcards are permitted. + +Specifies an **AppxPackage** object or the full name of a package. To get the manifest of a package +on the computer that's not installed for the current user, you must run this command with +administrator permissions. Wildcards are permitted. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -67,18 +72,19 @@ Accept wildcard characters: False ``` ### -User -Specifies a user. -This cmdlet gets the manifest of packages that are installed for the user that this parameter specifies. -To get the list of packages for a user profile other than the profile for the current user, you must run this command by using administrator permissions. -The user name can be in one of these formats: -- domain\user_name -- user_name@fqn.domain.tld -- user_name -- SID-string +Specifies a user. This cmdlet gets the manifest of packages that are installed for the user that +this parameter specifies. To get the list of packages for a user profile other than the profile for +the current user, you must run this command with administrator permissions. The user name can be +in one of these formats: + +- `domain\user_name` +- `user_name@fqn.domain.tld` +- `user_name` +- `SID-string` ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -90,17 +96,25 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, +-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, +-WarningAction, and -WarningVariable. For more information, see +[about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS ### Microsoft.Windows.Appx.PackageManager.Commands.AppxPackage[] -This cmdlet accepts an array of **AppxPackage** objects that contain information, including the full name of the app package. + +This cmdlet accepts an array of **AppxPackage** objects that contain information, including the full +name of the app package. ## OUTPUTS ### System.XML.XMLDocument -This cmdlet returns a read-only .xml document that contains information about the app package, like the package ID. + +This cmdlet returns a read-only `.xml` document that contains information about the app package, +like the package ID. ## NOTES @@ -113,4 +127,3 @@ This cmdlet returns a read-only .xml document that contains information about th [Get-AppxPackage](./Get-AppxPackage.md) [Add-AppxPackage](./Add-AppxPackage.md) - diff --git a/docset/winserver2022-ps/appx/Get-AppxVolume.md b/docset/winserver2022-ps/appx/Get-AppxVolume.md index f8cbc9ffa1..038948e36f 100644 --- a/docset/winserver2022-ps/appx/Get-AppxVolume.md +++ b/docset/winserver2022-ps/appx/Get-AppxVolume.md @@ -2,7 +2,7 @@ description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. external help file: Microsoft.Windows.Appx.PackageManager.Commands.dll-Help.xml Module Name: Appx -ms.date: 12/20/2016 +ms.date: 05/15/2023 online version: https://learn.microsoft.com/powershell/module/appx/get-appxvolume?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Get-AppxVolume @@ -16,50 +16,58 @@ Gets appx volumes for the computer. ## SYNTAX ### DefaultParameterSet + ``` Get-AppxVolume [[-Path] ] [] ``` ### OnlineParameterSet + ``` Get-AppxVolume [[-Path] ] [-Online] [] ``` ### OfflineParameterSet + ``` Get-AppxVolume [[-Path] ] [-Offline] [] ``` ## DESCRIPTION -The **Get-AppxVolume** cmdlet gets a list of **AppxVolume** objects known to the computer. + +The `Get-AppxVolume` cmdlet gets a list of **AppxVolume** objects known to the computer. Volumes can be added by the user or a device, for instance, by using Storage Sense. ## EXAMPLES ### Example 1: Get all the volumes -``` -PS C:\> Get-AppxVolume + +```powershell +Get-AppxVolume ``` The command gets all the **AppxVolume** objects on the computer. ### Example 2: Get the volume at a path -``` -PS C:\> Get-AppxVolume -Path F:\ + +```powershell +Get-AppxVolume -Path F:\ ``` This command gets the **AppxVolume** at the path F:\. ### Example 3: Get mounted volumes -``` -PS C:\> Get-AppxVolume -Online + +```powershell +Get-AppxVolume -Online ``` This command gets only **AppxVolume** objects that are currently mounted on the computer. ### Example 4: Get volumes that are note mounted -``` -PS C:\> Get-AppxVolume -Offline + +```powershell +Get-AppxVolume -Offline ``` This command gets the **AppxVolume** objects that not currently mounted on the computer. @@ -67,10 +75,11 @@ This command gets the **AppxVolume** objects that not currently mounted on the c ## PARAMETERS ### -Offline + Indicates that this cmdlet returns only volumes that are currently dismounted. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: OfflineParameterSet Aliases: @@ -82,10 +91,11 @@ Accept wildcard characters: False ``` ### -Online + Indicates that this cmdlet returns only volumes that are currently mounted. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: OnlineParameterSet Aliases: @@ -97,8 +107,9 @@ Accept wildcard characters: False ``` ### -Path -Specifies the path of the mount point of a volume. -This cmdlet gets a volume at the location that this parameter specifies. + +Specifies the path of the mount point of a volume. This cmdlet gets a volume at the location that +this parameter specifies. ```yaml Type: String @@ -125,7 +136,11 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, +-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, +-WarningAction, and -WarningVariable. For more information, see +[about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -144,4 +159,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Mount-AppxVolume](./Mount-AppxVolume.md) [Remove-AppxVolume](./Remove-AppxVolume.md) - diff --git a/docset/winserver2022-ps/appx/Invoke-CommandInDesktopPackage.md b/docset/winserver2022-ps/appx/Invoke-CommandInDesktopPackage.md index 223ec48381..8df3e6637e 100644 --- a/docset/winserver2022-ps/appx/Invoke-CommandInDesktopPackage.md +++ b/docset/winserver2022-ps/appx/Invoke-CommandInDesktopPackage.md @@ -2,7 +2,7 @@ description: A debugging tool that creates a new process in the context of a packaged app. external help file: Microsoft.Windows.Appx.PackageManager.Commands.dll-Help.xml Module Name: Appx -ms.date: 05/19/2017 +ms.date: 05/15/2023 online version: https://learn.microsoft.com/powershell/module/appx/invoke-commandindesktoppackage?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Invoke-CommandInDesktopPackage @@ -16,43 +16,60 @@ A debugging tool that creates a new process in the context of a packaged app. ## SYNTAX ``` -Invoke-CommandInDesktopPackage [-PackageFamilyName] [-AppId] [-Command] - [[-Args] ] [-PreventBreakaway] [] +Invoke-CommandInDesktopPackage [-PackageFamilyName] [-AppId] + [-Command] [[-Args] ] [-PreventBreakaway] [] ``` ## DESCRIPTION -`Invoke-CommandInDesktopPackage` creates a new process in the context of the supplied **PackageFamilyName** and **AppId**. -The created process will have the identity of the provided **AppId** and will have access to its virtualized file system and registry (if any). The new process will have a token that is similar to, but not identical to, a real **AppId** process. +`Invoke-CommandInDesktopPackage` creates a new process in the context of the supplied +**PackageFamilyName** and **AppId**. -The primary use-case of this command is to invoke debugging or troubleshooting tools in the context of the packaged app to easily access its virtualized resources. For example, you can run the Registry Editor to see virtualized registry keys, or Notepad to read virtualized files. See the important note that follows on using tools such as the Registry Editor that require elevation. +The created process will have the identity of the provided **AppId** and will have access to its +virtualized file system and registry (if any). The new process will have a token that's similar to, +but not identical to, a real **AppId** process. -No guarantees are made about the behavior of the created process, other than it having the package identity and access to the package's virtualized resources. In particular, the new process will _not_ be created in an AppContainer even if an **AppId** process would normally be created in an AppContainer. Features such as Privacy Controls or other App Settings may or may not apply to the new process. You should not rely on any specific side-effects of using this command, as they are undefined and subject to change. +The primary use-case of this command is to invoke debugging or troubleshooting tools in the context +of the packaged app to access its virtualized resources. For example, you can run the Registry +Editor to see virtualized registry keys, or Notepad to read virtualized files. See the important +note that follows on using tools such as the Registry Editor that require elevation. + +No guarantees are made about the behavior of the created process, other than it having the package +identity and access to the package's virtualized resources. In particular, the new process will +_not_ be created in an AppContainer even if an **AppId** process would normally be created in an +AppContainer. Features such as Privacy Controls or other App Settings may or may not apply to the +new process. You shouldn't rely on any specific side-effects of using this command, as they're +undefined and subject to change. ## EXAMPLES ### Example 1: Invoke Notepad to read virtualized files -The following command invokes Notepad in the context of the `ContosoApp` app from the `Contoso.MyApp` package. This allows you to access resources such as a log file or configuration file stored in the app's virtualized filesystem. - +The following command invokes Notepad in the context of the `ContosoApp` app from the +`Contoso.MyApp` package. This allows you to access resources such as a log file or configuration +file stored in the app's virtualized filesystem. + +```powershell +$params = @{ + AppId = 'ContosoApp' + PackageFamilyName = 'Contoso.MyApp_abcdefgh23456' + Command = 'notepad.exe' +} +Invoke-CommandInDesktopPackage @params ``` -PS C:\> Invoke-CommandInDesktopPackage -AppId "ContosoApp" -PackageFamilyName "Contoso.MyApp_abcdefgh23456" -Command "notepad.exe" -``` - - ## PARAMETERS ### -AppId -**AppId** is the Application ID from the target package's manifest. -```XML - - -``` +**AppId** is the Application ID from the target package's manifest. + +For example, `MyAppName` is the Application ID in this manifest snippet: + +`` ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -64,10 +81,11 @@ Accept wildcard characters: False ``` ### -Args -Optional arguments to be passed to the new process (for example, "/foo /bar") + +Optional arguments to be passed to the new process. For example, `/foo /bar`. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -79,12 +97,16 @@ Accept wildcard characters: False ``` ### -Command -An executable to invoke (for example, `regedit.exe`). -Note that if the executable requires elevation (like `regedit`), you must call `Invoke-CommandInDesktopPackage` from an already-elevated context. Calling `Invoke-CommandInDesktopPackage` from a non-elevated context does not work as expected. The new process is created without the package context, and the PowerShell command fails. +An executable to invoke, like `regedit.exe`. + +Note that if the executable requires elevation (like `regedit`), you must call +`Invoke-CommandInDesktopPackage` from an already-elevated context. Calling +`Invoke-CommandInDesktopPackage` from a non-elevated context doesn't work as expected. The new +process is created without the package context, and the PowerShell command fails. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -96,10 +118,12 @@ Accept wildcard characters: False ``` ### -PackageFamilyName -The Package Family Name of the target package. You can retrieve this by calling [Get-AppxPackage](./Get-AppxPackage.md). + +The Package Family Name of the target package. You can retrieve this by calling +[Get-AppxPackage](./Get-AppxPackage.md). ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -111,10 +135,13 @@ Accept wildcard characters: False ``` ### -PreventBreakaway -Causes all child processes of the invoked process to also be created in the context of the **AppId**. By default, child processes are created without any context. This switch is useful for running `cmd.exe` so that you can launch multiple other tools in the package context. + +Causes all child processes of the invoked process to also be created in the context of the +**AppId**. By default, child processes are created without any context. This switch is useful for +running `cmd.exe` so that you can launch multiple other tools in the package context. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -126,12 +153,15 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, +-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, +-WarningAction, and -WarningVariable. For more information, see +[about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS ### System.String -System.Management.Automation.SwitchParameter ## OUTPUTS @@ -142,4 +172,3 @@ System.Management.Automation.SwitchParameter ## RELATED LINKS [Get-AppxPackage](./Get-AppxPackage.md) - diff --git a/docset/winserver2022-ps/appx/Mount-AppxVolume.md b/docset/winserver2022-ps/appx/Mount-AppxVolume.md index 7bfcea228f..3466eea1a1 100644 --- a/docset/winserver2022-ps/appx/Mount-AppxVolume.md +++ b/docset/winserver2022-ps/appx/Mount-AppxVolume.md @@ -2,7 +2,7 @@ description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. external help file: Microsoft.Windows.Appx.PackageManager.Commands.dll-Help.xml Module Name: Appx -ms.date: 12/20/2016 +ms.date: 05/15/2023 online version: https://learn.microsoft.com/powershell/module/appx/mount-appxvolume?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Mount-AppxVolume @@ -20,21 +20,24 @@ Mount-AppxVolume [-Volume] [-WhatIf] [-Confirm] [ Mount-AppxVolume -Volume E:\ + +```powershell +Mount-AppxVolume -Volume E:\ ``` -This command mounts a volume at the path E:\. +This command mounts a volume at the path `E:\`. ### Example 2: Mount a volume by using an ID -``` -PS C:\> Mount-AppxVolume -Volume {7e62a691-398e-4fbe-819a-64f1e407777a} + +```powershell +Mount-AppxVolume -Volume {7e62a691-398e-4fbe-819a-64f1e407777a} ``` This command mounts a volume that has the specified media ID. @@ -42,6 +45,7 @@ This command mounts a volume that has the specified media ID. ## PARAMETERS ### -Volume + Specifies the **AppxVolume** object to mount. ```yaml @@ -57,10 +61,11 @@ Accept wildcard characters: False ``` ### -Confirm + Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf @@ -72,10 +77,11 @@ Accept wildcard characters: False ``` ### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. + +Shows what would happen if the cmdlet runs. The cmdlet isn't run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi @@ -87,7 +93,11 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, +-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, +-WarningAction, and -WarningVariable. For more information, see +[about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -104,4 +114,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Get-AppxVolume](./Get-AppxVolume.md) [Remove-AppxVolume](./Remove-AppxVolume.md) - diff --git a/docset/winserver2022-ps/appx/Move-AppxPackage.md b/docset/winserver2022-ps/appx/Move-AppxPackage.md index 780b629543..1252ac2342 100644 --- a/docset/winserver2022-ps/appx/Move-AppxPackage.md +++ b/docset/winserver2022-ps/appx/Move-AppxPackage.md @@ -2,7 +2,7 @@ description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. external help file: Microsoft.Windows.Appx.PackageManager.Commands.dll-Help.xml Module Name: Appx -ms.date: 12/20/2016 +ms.date: 05/15/2023 online version: https://learn.microsoft.com/powershell/module/appx/move-appxpackage?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Move-AppxPackage @@ -16,40 +16,49 @@ Moves a package from its current location to another appx volume. ## SYNTAX ``` -Move-AppxPackage [-Package] [-Volume] [-WhatIf] [-Confirm] [] +Move-AppxPackage [-Package] [-Volume] [-WhatIf] + [-Confirm] [] ``` ## DESCRIPTION -The **Move-AppxPackage** cmdlet moves a package from its current location to another **AppxVolume**. -The new location must be a volume that Package Manager knows about and that is mounted. -This cmdlet also moves your application data to the specified volume. + +The `Move-AppxPackage` cmdlet moves a package from its current location to another **AppxVolume**. +The new location must be a volume that Package Manager knows about and that's mounted. This cmdlet +also moves your application data to the specified volume. ## EXAMPLES ### Example 1: Move a package to a volume specified by a path -``` -PS C:\> Move-AppxPackage -Package "package1_1.0.0.0_neutral__8wekyb3d8bbwe" -Volume F:\ + +```powershell +Move-AppxPackage -Package "package1_1.0.0.0_neutral__8wekyb3d8bbwe" -Volume F:\ ``` -This command moves package that has the specified name to volume F:\. -This cmdlet also moves your app data. +This command moves package that has the specified name to volume `F:\`. This cmdlet also moves your +app data. ### Example 2: Move a package to a volume specified by an ID -``` -PS C:\> Move-AppxPackage -Package "package1_1.0.0.0_neutral__8wekyb3d8bbwe" -Volume {d2a4d1f4-f45a-46f3-a419-160ab52af091} + +```powershell +$params = @{ + Package = 'package1_1.0.0.0_neutral__8wekyb3d8bbwe' + Volume = '{d2a4d1f4-f45a-46f3-a419-160ab52af091}' +} +Move-AppxPackage @params ``` -This command moves package that has the specified name to the volume that has the specified media ID. -This cmdlet also moves your app data. +This command moves package that has the specified name to the volume that has the specified media +ID. This cmdlet also moves your app data. ## PARAMETERS ### -Package -Specifies an **AppxPackage** object or the full name of a package. -This cmdlet moves the package that this parameter specifies. + +Specifies an **AppxPackage** object or the full name of a package. This cmdlet moves the package +that this parameter specifies. ```yaml -Type: String[] +Type: System.String[] Parameter Sets: (All) Aliases: @@ -61,8 +70,9 @@ Accept wildcard characters: False ``` ### -Volume -Specifies an **AppxVolume** object. -The cmdlet moves the package to the volume that this parameter specifies. + +Specifies an **AppxVolume** object. The cmdlet moves the package to the volume that this parameter +specifies. ```yaml Type: AppxVolume @@ -77,10 +87,11 @@ Accept wildcard characters: False ``` ### -Confirm + Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf @@ -92,10 +103,11 @@ Accept wildcard characters: False ``` ### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. + +Shows what would happen if the cmdlet runs. The cmdlet isn't run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi @@ -107,7 +119,11 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, +-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, +-WarningAction, and -WarningVariable. For more information, see +[about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -122,4 +138,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Get-AppxPackage](./Get-AppxPackage.md) [Remove-AppxPackage](./Remove-AppxPackage.md) - diff --git a/docset/winserver2022-ps/appx/Remove-AppSharedPackageContainer.md b/docset/winserver2022-ps/appx/Remove-AppSharedPackageContainer.md index cd186a5d53..ca91d76dd0 100644 --- a/docset/winserver2022-ps/appx/Remove-AppSharedPackageContainer.md +++ b/docset/winserver2022-ps/appx/Remove-AppSharedPackageContainer.md @@ -1,8 +1,10 @@ --- external help file: Microsoft.Windows.Appx.PackageManager.Commands.dll-Help.xml Module Name: appx +ms.date: 05/15/2023 online version: https://learn.microsoft.com/powershell/module/appx/remove-appsharedpackagecontainer?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 +title: Remove-AppSharedPackageContainer --- # Remove-AppSharedPackageContainer @@ -13,28 +15,32 @@ Removes the shared package container. ## SYNTAX ``` -Remove-AppSharedPackageContainer [-Name] [-ForceApplicationShutdown] [-AllUsers] [] +Remove-AppSharedPackageContainer [-Name] [-ForceApplicationShutdown] [-AllUsers] + [] ``` -## DESCRIPTION +## DESCRIPTION + The cmdlet removes the shared package container definition for the particular user. ## EXAMPLES ### Example 1 + ```powershell -PS C:\> Remove-AppSharedPackageContainer -Name ContosoTestContainer +Remove-AppSharedPackageContainer -Name ContosoTestContainer ``` -This command removes the shared package container definition with the name ContosoTestContainer. +This command removes the shared package container definition with the name `ContosoTestContainer`. ## PARAMETERS ### -AllUsers -Unsupported. Will result in "-AllUsers functionality is not yet implemented" error. + +Unsupported. Will result in `-AllUsers functionality is not yet implemented` error. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -46,10 +52,11 @@ Accept wildcard characters: False ``` ### -ForceApplicationShutdown + Closes all packages in the Shared Package Container. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -61,6 +68,7 @@ Accept wildcard characters: False ``` ### -Name + The name of the container. ```yaml @@ -76,7 +84,11 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, +-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, +-WarningAction, and -WarningVariable. For more information, see +[about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -85,6 +97,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### System.Object + ## NOTES ## RELATED LINKS diff --git a/docset/winserver2022-ps/appx/Remove-AppxPackage.md b/docset/winserver2022-ps/appx/Remove-AppxPackage.md index 8998d930a8..efe1afa142 100644 --- a/docset/winserver2022-ps/appx/Remove-AppxPackage.md +++ b/docset/winserver2022-ps/appx/Remove-AppxPackage.md @@ -2,7 +2,7 @@ description: Removes an app package from one or more user accounts. external help file: Microsoft.Windows.Appx.PackageManager.Commands.dll-Help.xml Module Name: Appx -ms.date: 09/01/2021 +ms.date: 05/15/2023 online version: https://learn.microsoft.com/powershell/module/appx/remove-appxpackage?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Remove-AppxPackage @@ -11,56 +11,63 @@ title: Remove-AppxPackage # Remove-AppxPackage ## SYNOPSIS - Removes an app package from one or more user accounts. ## SYNTAX ### RemoveByPackageSet (Default) + ``` -Remove-AppxPackage [-Package] [-PreserveApplicationData] [-WhatIf] [-Confirm] [] +Remove-AppxPackage [-Package] [-PreserveApplicationData] [-WhatIf] [-Confirm] + [] ``` ### RemoveByPackageForRoamingSet + ``` Remove-AppxPackage [-Package] [-PreserveRoamableApplicationData] [-WhatIf] [-Confirm] [] ``` ### AllUsersSet + ``` Remove-AppxPackage [-Package] [-AllUsers] [-WhatIf] [-Confirm] [] ``` ### UserSet + ``` Remove-AppxPackage [-Package] -User [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION -The **Remove-AppxPackage** cmdlet removes an app package from a user account. -An app package has an .msix or .appx file name extension. +The `Remove-AppxPackage` cmdlet removes an app package from a user account. An app package has an +`.msix` or `.appx` file extension. ## EXAMPLES ### Example 1: Remove an app package ```powershell -Remove-AppxPackage -Package "package1_1.0.0.0_neutral__8wekyb3d8bbwe" +Remove-AppxPackage -Package 'package1_1.0.0.0_neutral__8wekyb3d8bbwe' ``` -This command removes an app package named package1_1.0.0.0_neutral__8wekyb3d8bbwe from the account of the current user. +This command removes an app package named `package1_1.0.0.0_neutral__8wekyb3d8bbwe` from the +account of the current user. ## PARAMETERS ### -AllUsers -This parameter removes the app package for all user accounts on the computer. The parameter works off the parent package type. If it is a bundle, use -PackageTypeFilter with "Get-AppxPackage" command and specify the bundle. To use this parameter, you must run the command by using administrator permissions. - +This parameter removes the app package for all user accounts on the computer. The parameter works +off the parent package type. If it's a bundle, use **PackageTypeFilter** with the `Get-AppxPackage` +command and specify the bundle. To use this parameter, you must run the command with administrator +permissions. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: AllUsersSet Aliases: @@ -76,7 +83,7 @@ Accept wildcard characters: False Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf @@ -92,7 +99,7 @@ Accept wildcard characters: False Specifies an **AppxPackage** object or the full name of a package. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -105,11 +112,10 @@ Accept wildcard characters: False ### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +Shows what would happen if the cmdlet runs. The cmdlet isn't run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi @@ -122,13 +128,13 @@ Accept wildcard characters: False ### -PreserveApplicationData -Specifies that the cmdlet preserves the application data during the package removal. -The application data is available for later use. Note that this is only applicable -for apps that are under development so this option can only be specified for apps -that are registered from file layout (Loose file registered). +Specifies that the cmdlet preserves the application data during the package removal. The +application data is available for later use. Note that this is only applicable for apps that are +under development so this option can only be specified for apps that are registered from file +layout (Loose file registered). ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: RemoveByPackageSet Aliases: @@ -142,10 +148,10 @@ Accept wildcard characters: False ### -PreserveRoamableApplicationData Preserves the roamable portion of the app's data when the package is removed. This parameter is -incompatible with PreserveApplicationData. +incompatible with **PreserveApplicationData**. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: RemoveByPackageForRoamingSet Aliases: @@ -158,17 +164,18 @@ Accept wildcard characters: False ### -User -If you specify this parameter, the cmdlet removes the app package for only the user that this cmdlet specifies. To remove a package for a user profile other than the profile of the current user, you must run this command by using administrator permissions. +If you specify this parameter, the cmdlet removes the app package for only the user that this cmdlet +specifies. To remove a package for a user profile other than the profile of the current user, you +must run this command with administrator permissions. > [!NOTE] > -> - This parameter only accepts user SIDs -> - Use the **whoami /user** command to display the current SID of a user. See [whoami syntax](/windows-server/administration/windows-commands/whoami) for details. - - +> This parameter only accepts user SIDs. Use the **whoami /user** command to display the current +> SID of a user. See [whoami syntax](/windows-server/administration/windows-commands/whoami) for +> details. ```yaml -Type: String +Type: System.String Parameter Sets: UserSet Aliases: @@ -181,7 +188,10 @@ Accept wildcard characters: False ### CommonParameters -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). +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). ## INPUTS diff --git a/docset/winserver2022-ps/appx/Remove-AppxVolume.md b/docset/winserver2022-ps/appx/Remove-AppxVolume.md index 733f938604..bad45ec98b 100644 --- a/docset/winserver2022-ps/appx/Remove-AppxVolume.md +++ b/docset/winserver2022-ps/appx/Remove-AppxVolume.md @@ -2,7 +2,7 @@ description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. external help file: Microsoft.Windows.Appx.PackageManager.Commands.dll-Help.xml Module Name: Appx -ms.date: 12/20/2016 +ms.date: 05/15/2023 online version: https://learn.microsoft.com/powershell/module/appx/remove-appxvolume?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Remove-AppxVolume @@ -20,29 +20,33 @@ Remove-AppxVolume [-Volume] [-WhatIf] [-Confirm] [ Remove-AppxVolume -Volume {984786d3-0cae-49de-a68f-8bedb0ca260b} + +```powershell +Remove-AppxVolume -Volume {984786d3-0cae-49de-a68f-8bedb0ca260b} ``` This command removes a volume that has the specified media ID. ### Example 2: Remove a volume by using a path -``` -PS C:\> Remove-AppxVolume -Volume E:\ + +```powershell +Remove-AppxVolume -Volume E:\ ``` -This command removes a volume at the path E:\. +This command removes a volume at the path `E:\`. ## PARAMETERS ### -Volume + Specifies the **AppxVolume** object to remove. ```yaml @@ -58,10 +62,11 @@ Accept wildcard characters: False ``` ### -Confirm + Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf @@ -73,10 +78,11 @@ Accept wildcard characters: False ``` ### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. + +Shows what would happen if the cmdlet runs. The cmdlet isn't run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi @@ -88,7 +94,11 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, +-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, +-WarningAction, and -WarningVariable. For more information, see +[about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -105,4 +115,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Get-AppxVolume](./Get-AppxVolume.md) [Mount-AppxVolume](./Mount-AppxVolume.md) - diff --git a/docset/winserver2022-ps/appx/Reset-AppSharedPackageContainer.md b/docset/winserver2022-ps/appx/Reset-AppSharedPackageContainer.md index 4ba00e3105..d374357cf8 100644 --- a/docset/winserver2022-ps/appx/Reset-AppSharedPackageContainer.md +++ b/docset/winserver2022-ps/appx/Reset-AppSharedPackageContainer.md @@ -1,8 +1,10 @@ --- external help file: Microsoft.Windows.Appx.PackageManager.Commands.dll-Help.xml Module Name: appx +ms.date: 05/15/2023 online version: https://learn.microsoft.com/powershell/module/appx/reset-appsharedpackagecontainer?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 +title: Reset-AppSharedPackageContainer --- # Reset-AppSharedPackageContainer @@ -13,29 +15,34 @@ Destroys all the application data of the container. ## SYNTAX ``` -Reset-AppSharedPackageContainer [-Name] [-Force] [-WhatIf] [-Confirm] [] +Reset-AppSharedPackageContainer [-Name] [-Force] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION -The cmdlet destroys all the application data of the container, -including the virtual files and registry keys. + +The cmdlet destroys all the application data of the container, including the virtual files and +registry keys. ## EXAMPLES ### Example 1 + ```powershell -PS C:\> Reset-AppSharedPackageContainer -Name ContosoTestContainer +Reset-AppSharedPackageContainer -Name ContosoTestContainer ``` -This command clears all the application data of the shared package container ContosoTestContainer. +This command clears all the application data of the shared package container +`ContosoTestContainer`. ## PARAMETERS ### -Force + Skips asking for confirmation. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -47,6 +54,7 @@ Accept wildcard characters: False ``` ### -Name + The name of the container. ```yaml @@ -62,10 +70,11 @@ Accept wildcard characters: False ``` ### -Confirm + Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf @@ -77,11 +86,11 @@ Accept wildcard characters: False ``` ### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. + +Shows what would happen if the cmdlet runs. The cmdlet isn't run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi @@ -93,7 +102,11 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, +-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, +-WarningAction, and -WarningVariable. For more information, see +[about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -102,6 +115,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### System.Object + ## NOTES ## RELATED LINKS diff --git a/docset/winserver2022-ps/appx/Reset-AppxPackage.md b/docset/winserver2022-ps/appx/Reset-AppxPackage.md index 84ea78a76c..66d1b655e2 100644 --- a/docset/winserver2022-ps/appx/Reset-AppxPackage.md +++ b/docset/winserver2022-ps/appx/Reset-AppxPackage.md @@ -2,7 +2,7 @@ description: Restores the Windows app to its initial configuration. external help file: Microsoft.Windows.Appx.PackageManager.Commands.dll-help.xml Module Name: Appx -ms.date: 09/01/2021 +ms.date: 05/15/2023 online version: https://learn.microsoft.com/powershell/module/appx/reset-appxpackage?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Reset-AppxPackage @@ -12,13 +12,11 @@ title: Reset-AppxPackage ## SYNOPSIS -Starting at Windows 10 Insider Preview Build 20215 you get access to the `Reset-AppxPackage` PowerShell Cmdlet for use in resetting your installed Windows Apps. - Restores the Windows app to its initial configuration. ## SYNTAX -```PowerShell +``` Reset-AppxPackage [-Package] [-WhatIf] [-Confirm] @@ -26,26 +24,31 @@ Reset-AppxPackage [-Package] ``` ## DESCRIPTION -The **Reset-AppxPackage** cmdlet will reset the app to its original settings, and the app will react as a freshly installed app. + +The `Reset-AppxPackage` cmdlet resets the app to its original settings, and the app will react +as a freshly installed app. After resetting the app, any initial prompts by the app will be prompted for user input. ## EXAMPLES ### Example 1: Reset app package + ```powershell Reset-AppxPackage -Package publisher.package1_1.0.0.0_neutral__8wekyb3d8bbwe ``` -This cmdlet will reset the `publisher.package1_1.0.0.0_neutral__8wekyb3d8bbwe` application back to its original settings. +This cmdlet resets the `publisher.package1_1.0.0.0_neutral__8wekyb3d8bbwe` application back to +its original settings. ## PARAMETERS ### -Confirm + Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf @@ -57,10 +60,11 @@ Accept wildcard characters: False ``` ### -Package -Specifies the package full name (PFuN) of the app which will be reset. + +Specifies the package full name (PFuN) of the app to reset. ```yaml -Type: String +Type: System.String Parameter Sets: None Aliases: None @@ -72,10 +76,11 @@ Accept wildcard characters: False ``` ### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. + +Shows what would happen if the cmdlet runs. The cmdlet isn't run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi @@ -87,7 +92,11 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, +-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, +-WarningAction, and -WarningVariable. For more information, see +[about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/docset/winserver2022-ps/appx/Set-AppxDefaultVolume.md b/docset/winserver2022-ps/appx/Set-AppxDefaultVolume.md index 2f886a9014..9bc8d7e77c 100644 --- a/docset/winserver2022-ps/appx/Set-AppxDefaultVolume.md +++ b/docset/winserver2022-ps/appx/Set-AppxDefaultVolume.md @@ -2,7 +2,7 @@ description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. external help file: Microsoft.Windows.Appx.PackageManager.Commands.dll-Help.xml Module Name: Appx -ms.date: 12/20/2016 +ms.date: 05/15/2023 online version: https://learn.microsoft.com/powershell/module/appx/set-appxdefaultvolume?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Set-AppxDefaultVolume @@ -20,22 +20,25 @@ Set-AppxDefaultVolume [-Volume] [-WhatIf] [-Confirm] [ Set-AppxDefaultVolume -Volume F:\ + +```powershell +Set-AppxDefaultVolume -Volume F:\ ``` -This command sets the default volume to be the volume F:\. +This command sets the default volume to be the volume `F:\`. ### Example 2: Set a default volume by using an ID -``` -PS C:\> Set-AppxDefaultVolume -Volume {ef23c8d6-b13c-4c4c-ae3b-7d5a162de9b9} + +```powershell +Set-AppxDefaultVolume -Volume {ef23c8d6-b13c-4c4c-ae3b-7d5a162de9b9} ``` This command sets the default volume to be the one that has the specified media ID. @@ -43,8 +46,9 @@ This command sets the default volume to be the one that has the specified media ## PARAMETERS ### -Volume -Specifies the path a volume. -This cmdlet sets the volume that this parameter specifies to be the default deployment target for the computer. + +Specifies the path a volume. This cmdlet sets the volume that this parameter specifies to be the +default deployment target for the computer. ```yaml Type: AppxVolume @@ -59,10 +63,11 @@ Accept wildcard characters: False ``` ### -Confirm + Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf @@ -74,10 +79,11 @@ Accept wildcard characters: False ``` ### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. + +Shows what would happen if the cmdlet runs. The cmdlet isn't run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi @@ -89,7 +95,11 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, +-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, +-WarningAction, and -WarningVariable. For more information, see +[about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS @@ -100,4 +110,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS [Get-AppxDefaultVolume](./Get-AppxDefaultVolume.md) - diff --git a/docset/winserver2022-ps/appx/Set-AppxPackageAutoUpdateSettings.md b/docset/winserver2022-ps/appx/Set-AppxPackageAutoUpdateSettings.md index b23f3c0096..ac624fcc90 100644 --- a/docset/winserver2022-ps/appx/Set-AppxPackageAutoUpdateSettings.md +++ b/docset/winserver2022-ps/appx/Set-AppxPackageAutoUpdateSettings.md @@ -2,7 +2,7 @@ description: Provides guidance on how to configure the auto-update and repair settings of a Windows App. external help file: Microsoft.Windows.Appx.PackageManager.Commands.dll-help.xml Module Name: Appx -ms.date: 06/07/2021 +ms.date: 05/15/2023 online version: https://learn.microsoft.com/powershell/module/appx/reset-appxpackage?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Set-AppxPackageAutoUpdateSettings @@ -11,65 +11,91 @@ title: Set-AppxPackageAutoUpdateSettings # Set-AppxPackageAutoUpdateSettings ## SYNOPSIS -The `Get-AppxPackageAutoUpdateSettings` PowerShell cmdlet is only available in the Windows Insider Preview Builds of Windows 10. The `Set-AppxPackageAutoUpdateSettings` PowerShell cmdlet provides access to configure a specific Windows App's Auto Update and Repair settings. Including pausing update checks. + +Configures a specific Windows App's Auto Update and Repair settings. ## SYNTAX ### SetAutoUpdateOptionsSet (Default) + ``` Set-AppxPackageAutoUpdateSettings [-PackageFamilyName] -AppInstallerUri [-UpdateUris ] [-RepairUris ] [-OptionalPackages ] [-DependencyPackages ] [-EnableAutomaticBackgroundTask] [-ForceUpdateFromAnyVersion] - [-DisableAutoRepairs] [-CheckOnLaunch] [-ShowPrompt] [-UpdateBlocksActivation] [-UseSystemPolicySource] - [-HoursBetweenUpdateChecks ] [-Version ] [-WhatIf] [-Confirm] [] + [-DisableAutoRepairs] [-CheckOnLaunch] [-ShowPrompt] [-UpdateBlocksActivation] + [-UseSystemPolicySource] [-HoursBetweenUpdateChecks ] [-Version ] [-WhatIf] + [-Confirm] [] ``` ### PauseAutoUpdateOptionsSet + ``` -Set-AppxPackageAutoUpdateSettings [-PackageFamilyName] [-PauseUpdates] [-UseSystemPolicySource] - -HoursToPause [-WhatIf] [-Confirm] [] +Set-AppxPackageAutoUpdateSettings [-PackageFamilyName] [-PauseUpdates] + [-UseSystemPolicySource] -HoursToPause [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION -The **Set-AppxPackageAutoUpdateSettings** cmdlet provides access to configure a specific Windows App's Auto Update and Repair seetings. + +The `Set-AppxPackageAutoUpdateSettings` cmdlet provides access to configure a specific Windows +App's Auto Update and Repair setings. ## EXAMPLES -### Example 1: Update the Auto-Update settings for an App -``` -PS C:\> Set-AppxPackageAutoUpdateSettings -AppInstallerUri https://website.com/PackageName.appinstaller -PackageFamilyName PackageName_8h66172c634n0 -CheckOnLaunch -ForceUpdateFromAnyVersion -HoursBetweenUpdateChecks 2 -ShowPrompt -UpdateUris file://ComputerName/Share/PackageName_x64.appinstaller +### Example 1: Update the Auto Update settings for an App + +```powershell +$params = @{ + AppInstallerUri = 'https://website.com/PackageName.appinstaller ' + PackageFamilyName = 'PackageName_8h66172c634n0 ' + CheckOnLaunch = $true + ForceUpdateFromAnyVersion = $true + HoursBetweenUpdateChecks = 2 + ShowPrompt = $true + UpdateUris = 'file://ComputerName/Share/PackageName_x64.appinstaller' +} +Set-AppxPackageAutoUpdateSettings @params ``` -This cmdlet will update the Auto Update settings of the *PackageName_8h66172c634n0* Windows App to target an AppInstaller file on a network accessible file share every two hours, displaying a prompt to the user. Allowing for the Windows App to update to any version (higher or lower) despite the version of the installed Windows App. +This cmdlet will update the Auto Update settings of the `PackageName_8h66172c634n0` Windows App to +target an AppInstaller file on a network accessible file share every two hours, displaying a prompt +to the user. Allowing for the Windows App to update to any version (higher or lower) despite the +version of the installed Windows App. ### Example 2: Disable the Auto Repair setting for an App -``` -PS C:\> Set-AppxPackageAutoUpdateSettings -AppInstallerUri https://website.com/PackageName.appinstaller -PackageFamilyName PackageName_8h66172c634n0 -DisableAutoRepairs + +```powershell +$params = @{ + AppInstallerUri = 'https://website.com/PackageName.appinstaller' + PackageFamilyName = 'PackageName_8h66172c634n0' + DisableAutoRepairs = $true +} +Set-AppxPackageAutoUpdateSettings @params ``` This cmdlet will disable the automatic repair of the Windows App. ### Example 3: Pause Updates on a specific Windows App -``` -PS C:\> Set-AppxPackageAutoUpdateSettings -HoursToPause 4320 -PackageFamilyName PackageName_8h66172c634n0 -PauseUpdates -``` - -This cmdlet will pause the Windows App from checking for App updates for 4320 hours (180 Days). -### Example 3: Pause Updates on a specific Windows App -``` -PS C:\> Set-AppxPackageAutoUpdateSettings -HoursToPause 0 -PackageFamilyName PackageName_8h66172c634n0 -PauseUpdates +```powershell +$params = @{ + HoursToPause = 4320 + PackageFamilyName = 'PackageName_8h66172c634n0' + PauseUpdates = $true +} +Set-AppxPackageAutoUpdateSettings @params ``` -This cmdlet will re-enable automatic updating of the Windows App. +This cmdlet will pause the Windows App from checking for App updates for `4320` hours (180 Days). ## PARAMETERS ### -HoursToPause -Specifies the duration of time in hours that the Windows App will not check for updates. + +Specifies the duration of time in hours that the Windows App won't check for updates. ```yaml -Type: UInt32 +Type: System.UInt32 Parameter Sets: PauseAutoUpdateOptionsSet Aliases: @@ -81,10 +107,11 @@ Accept wildcard characters: False ``` ### -PauseUpdates + Specifies if the Windows App updates are to be paused. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: PauseAutoUpdateOptionsSet Aliases: @@ -96,10 +123,11 @@ Accept wildcard characters: False ``` ### -PackageFamilyName + Specifies the Package Family Name of the Windows App which is being modified. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -111,10 +139,11 @@ Accept wildcard characters: False ``` ### -AppInstallerUri -Specifies the location of the AppInstaller file targetted by this Windows App. + +Specifies the location of the AppInstaller file targeted by this Windows App. ```yaml -Type: String +Type: System.String Parameter Sets: SetAutoUpdateOptionsSet Aliases: @@ -126,10 +155,11 @@ Accept wildcard characters: False ``` ### -CheckOnLaunch + Specifies that the Windows App will check for new updates when the App is launched. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: SetAutoUpdateOptionsSet Aliases: @@ -141,10 +171,11 @@ Accept wildcard characters: False ``` ### -DependencyPackages + Specifies any Dependency Packages being used by the Windows App. ```yaml -Type: String[] +Type: System.String[] Parameter Sets: SetAutoUpdateOptionsSet Aliases: @@ -156,10 +187,11 @@ Accept wildcard characters: False ``` ### -DisableAutoRepairs + Turns off the automatic repair of a broken Windows App. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: SetAutoUpdateOptionsSet Aliases: @@ -171,10 +203,11 @@ Accept wildcard characters: False ``` ### -EnableAutomaticBackgroundTask + Specifies that the automation of updating and repairing will occur as a background task. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: SetAutoUpdateOptionsSet Aliases: @@ -186,10 +219,11 @@ Accept wildcard characters: False ``` ### -ForceUpdateFromAnyVersion + Specifies that the next update of the Windows App can be of a higher or lower version. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: SetAutoUpdateOptionsSet Aliases: @@ -201,10 +235,11 @@ Accept wildcard characters: False ``` ### -HoursBetweenUpdateChecks + Specifies the time between update checks allowed for a specific Windows App. ```yaml -Type: UInt32 +Type: System.UInt32 Parameter Sets: SetAutoUpdateOptionsSet Aliases: @@ -216,10 +251,11 @@ Accept wildcard characters: False ``` ### -OptionalPackages + Specifies the Optional Packages being used by the Windows App. ```yaml -Type: String[] +Type: System.String[] Parameter Sets: SetAutoUpdateOptionsSet Aliases: @@ -231,10 +267,11 @@ Accept wildcard characters: False ``` ### -RepairUris + Specifies the location which will be sourced from when repairing the Windows App. ```yaml -Type: String[] +Type: System.String[] Parameter Sets: SetAutoUpdateOptionsSet Aliases: @@ -246,10 +283,11 @@ Accept wildcard characters: False ``` ### -ShowPrompt + Specifies that if any action is occurring for the Windows App, a prompt will be displayed. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: SetAutoUpdateOptionsSet Aliases: @@ -261,10 +299,12 @@ Accept wildcard characters: False ``` ### -UpdateBlocksActivation -Specifies that if an update is available for a Windows App, the App will prevent launching until the update has been installed. + +Specifies that if an update is available for a Windows App, the App will prevent launching until the +update has been installed. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: SetAutoUpdateOptionsSet Aliases: @@ -276,10 +316,11 @@ Accept wildcard characters: False ``` ### -UpdateUris + Specifies the location which will be sourced from when updating the Windows App. ```yaml -Type: String[] +Type: System.String[] Parameter Sets: SetAutoUpdateOptionsSet Aliases: @@ -291,10 +332,11 @@ Accept wildcard characters: False ``` ### -UseSystemPolicySource + Specifies that an override can be applied to the Developer configured settings. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -306,10 +348,11 @@ Accept wildcard characters: False ``` ### -Version + Specifies the version of the Update Settings being applied. ```yaml -Type: String +Type: System.String Parameter Sets: SetAutoUpdateOptionsSet Aliases: @@ -321,7 +364,11 @@ Accept wildcard characters: False ``` ### CommonParameters -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). + +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). ## INPUTS @@ -330,6 +377,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### System.Object + ## NOTES ## RELATED LINKS From e6a589c12dce5a73d2f2af79e061c671a57733aa Mon Sep 17 00:00:00 2001 From: Michael Lombardi Date: Wed, 17 May 2023 09:10:06 -0500 Subject: [PATCH 442/650] (AB#4176) Add devcontainer for codespaces This change adds the devcontainer definition for the repository to support contributing in GitHub Codespaces. --- .devcontainer/Dockerfile | 4 ++++ .devcontainer/devcontainer.json | 42 +++++++++++++++++++++++++++++++++ .gitattributes | 3 +++ 3 files changed, 49 insertions(+) create mode 100644 .devcontainer/Dockerfile create mode 100644 .devcontainer/devcontainer.json diff --git a/.devcontainer/Dockerfile b/.devcontainer/Dockerfile new file mode 100644 index 0000000000..933f0c12e6 --- /dev/null +++ b/.devcontainer/Dockerfile @@ -0,0 +1,4 @@ +FROM mcr.microsoft.com/devcontainers/base:ubuntu +RUN wget https://github.com/errata-ai/vale/releases/download/v2.26.0/vale_2.26.0_Linux_64-bit.tar.gz && \ + tar -xvzf vale_2.26.0_Linux_64-bit.tar.gz -C bin && \ + export PATH=./bin:"$PATH" diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json new file mode 100644 index 0000000000..f2b24e467b --- /dev/null +++ b/.devcontainer/devcontainer.json @@ -0,0 +1,42 @@ +{ + "build": { + "dockerfile": "Dockerfile" + }, + "features": { + "ghcr.io/devcontainers/features/git:1": {}, + "ghcr.io/devcontainers/features/github-cli:1": {}, + "ghcr.io/devcontainers/features/powershell:1": { + "modules": "Documentarian,Documentarian.Vale,Documentarian.MicrosoftDocs,Documentarian.ModuleAuthor" + } + }, + "customizations": { + "vscode": { + "extensions": [ + "chrischinchilla.vale-vscode", + "davidanson.vscode-markdownlint", + "docsmsft.docs-images", + "docsmsft.docs-linting", + "docsmsft.docs-markdown", + "docsmsft.docs-preview", + "docsmsft.docs-yaml", + "eamodio.gitlens", + "marvhen.reflow-markdown", + "ms-vscode.powershell", + "ms-vscode.wordcount", + "nhoizey.gremlins", + "redhat.vscode-yaml", + "shuworks.vscode-table-formatter", + "streetsidesoftware.code-spell-checker", + "tyriar.sort-lines", + "usernamehw.errorlens", + "wmaurer.change-case" + ], + "settings": { + "terminal.integrated.defaultProfile.linux": "pwsh", + "vale.valeCLI.path": "", + "vale.valeCLI.config": "" + } + } + }, + "postStartCommand": "vale sync" +} diff --git a/.gitattributes b/.gitattributes index 9fb85ec49f..716ed37256 100644 --- a/.gitattributes +++ b/.gitattributes @@ -9,6 +9,9 @@ # Declare files that will always have CRLF line endings on checkout. *.sln text eol=crlf +# Ensure devcontainer files are always LF +.devcontainer/** eol=lf + # Denote all files that are truly binary and should not be modified. *.png binary *.jpg binary \ No newline at end of file From ea512843347b307473564a5d4132981792a44306 Mon Sep 17 00:00:00 2001 From: Xelu86 <103963494+Xelu86@users.noreply.github.com> Date: Wed, 17 May 2023 18:07:42 -0400 Subject: [PATCH 443/650] Updated description when access is granted --- .../failoverclusters/Grant-ClusterAccess.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/docset/winserver2022-ps/failoverclusters/Grant-ClusterAccess.md b/docset/winserver2022-ps/failoverclusters/Grant-ClusterAccess.md index f5be702f5f..aa0284dbe8 100644 --- a/docset/winserver2022-ps/failoverclusters/Grant-ClusterAccess.md +++ b/docset/winserver2022-ps/failoverclusters/Grant-ClusterAccess.md @@ -1,8 +1,8 @@ --- -description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. +description: Use this article to help manage Windows and Windows Server technologies with Windows PowerShell. external help file: Microsoft.FailoverClusters.PowerShell.dll-Help.xml Module Name: FailoverClusters -ms.date: 12/20/2016 +ms.date: 05/17/2023 online version: https://docs.microsoft.com/powershell/module/failoverclusters/grant-clusteraccess?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Grant-ClusterAccess @@ -21,8 +21,10 @@ Grant-ClusterAccess [-User] [-Full] [-ReadOnly] [-InputObject ``` ## DESCRIPTION -The **Grant-ClusterAccess** cmdlet grants access to a failover cluster, either full access or read-only access. -To provide someone with read-only access to the cluster, use the **ReadOnly** parameter. +The **Grant-ClusterAccess** cmdlet grants access to a failover cluster, either full access or +read-only access. To provide someone with read-only access to the cluster, use the **ReadOnly** +parameter. Granting full access to the cluster is equivalent to granting full access to each of the +cluster nodes. ## EXAMPLES From ed5a3324d7da723e2a984fa02ab13e41c126bf28 Mon Sep 17 00:00:00 2001 From: Xelu86 <103963494+Xelu86@users.noreply.github.com> Date: Wed, 17 May 2023 18:28:19 -0400 Subject: [PATCH 444/650] Resolving conflicts --- .../winserver2022-ps/failoverclusters/Grant-ClusterAccess.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docset/winserver2022-ps/failoverclusters/Grant-ClusterAccess.md b/docset/winserver2022-ps/failoverclusters/Grant-ClusterAccess.md index aa0284dbe8..17c849d317 100644 --- a/docset/winserver2022-ps/failoverclusters/Grant-ClusterAccess.md +++ b/docset/winserver2022-ps/failoverclusters/Grant-ClusterAccess.md @@ -3,7 +3,7 @@ description: Use this article to help manage Windows and Windows Server technolo external help file: Microsoft.FailoverClusters.PowerShell.dll-Help.xml Module Name: FailoverClusters ms.date: 05/17/2023 -online version: https://docs.microsoft.com/powershell/module/failoverclusters/grant-clusteraccess?view=windowsserver2022-ps&wt.mc_id=ps-gethelp +online version: https://learn.microsoft.com/powershell/module/failoverclusters/grant-clusteraccess?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Grant-ClusterAccess --- @@ -21,7 +21,7 @@ Grant-ClusterAccess [-User] [-Full] [-ReadOnly] [-InputObject ``` ## DESCRIPTION -The **Grant-ClusterAccess** cmdlet grants access to a failover cluster, either full access or +The `Grant-ClusterAccess` cmdlet grants access to a failover cluster, either full access or read-only access. To provide someone with read-only access to the cluster, use the **ReadOnly** parameter. Granting full access to the cluster is equivalent to granting full access to each of the cluster nodes. From 9de8e0b4e54e011c4d042f15c880d0801aef5188 Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Sat, 20 May 2023 12:46:33 +0530 Subject: [PATCH 445/650] Update Set-VMProcessor.md Fixed Typo --- docset/winserver2022-ps/hyper-v/Set-VMProcessor.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/hyper-v/Set-VMProcessor.md b/docset/winserver2022-ps/hyper-v/Set-VMProcessor.md index b9c15b3a94..4af1c7c4d2 100644 --- a/docset/winserver2022-ps/hyper-v/Set-VMProcessor.md +++ b/docset/winserver2022-ps/hyper-v/Set-VMProcessor.md @@ -216,7 +216,7 @@ Accept wildcard characters: False ``` ### -ExposeVirtualizationExtensions -Specifies whether the hypervisor should expose the presence of virtualization extensions to the virtual machine, which enables support for nested virtualization,. +Specifies whether the hypervisor should expose the presence of virtualization extensions to the virtual machine, which enables support for nested virtualization. ```yaml From 4e2a75066d3875ac5b59918da17700a718e9ff89 Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Sat, 20 May 2023 12:48:05 +0530 Subject: [PATCH 446/650] Update Set-VMProcessor.md Fixing 2016 --- docset/winserver2016-ps/hyper-v/Set-VMProcessor.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2016-ps/hyper-v/Set-VMProcessor.md b/docset/winserver2016-ps/hyper-v/Set-VMProcessor.md index bea9d69da6..e31f9dd011 100644 --- a/docset/winserver2016-ps/hyper-v/Set-VMProcessor.md +++ b/docset/winserver2016-ps/hyper-v/Set-VMProcessor.md @@ -216,7 +216,7 @@ Accept wildcard characters: False ``` ### -ExposeVirtualizationExtensions -Specifies whether the hypervisor should expose the presence of virtualization extensions to the virtual machine, which enables support for nested virtualization,. +Specifies whether the hypervisor should expose the presence of virtualization extensions to the virtual machine, which enables support for nested virtualization. ```yaml From 418de1ee809918ea9fd991de39f2704ad00dca87 Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Sat, 20 May 2023 12:48:24 +0530 Subject: [PATCH 447/650] Update Set-VMProcessor.md Fixing 2019 version --- docset/winserver2019-ps/hyper-v/Set-VMProcessor.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2019-ps/hyper-v/Set-VMProcessor.md b/docset/winserver2019-ps/hyper-v/Set-VMProcessor.md index 1a3cb5c34d..8e2d146e52 100644 --- a/docset/winserver2019-ps/hyper-v/Set-VMProcessor.md +++ b/docset/winserver2019-ps/hyper-v/Set-VMProcessor.md @@ -216,7 +216,7 @@ Accept wildcard characters: False ``` ### -ExposeVirtualizationExtensions -Specifies whether the hypervisor should expose the presence of virtualization extensions to the virtual machine, which enables support for nested virtualization,. +Specifies whether the hypervisor should expose the presence of virtualization extensions to the virtual machine, which enables support for nested virtualization. ```yaml From aa54230ed1687b28cfc73f273b369aab0dbbe720 Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Sat, 20 May 2023 13:18:12 +0530 Subject: [PATCH 448/650] Update Remove-ADComputer.md Changed the default value to True as it is prompts for confirmation --- docset/winserver2022-ps/activedirectory/Remove-ADComputer.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/activedirectory/Remove-ADComputer.md b/docset/winserver2022-ps/activedirectory/Remove-ADComputer.md index e081ccd18c..e30776b839 100644 --- a/docset/winserver2022-ps/activedirectory/Remove-ADComputer.md +++ b/docset/winserver2022-ps/activedirectory/Remove-ADComputer.md @@ -102,7 +102,7 @@ Aliases: cf Required: False Position: Named -Default value: False +Default value: True Accept pipeline input: False Accept wildcard characters: False ``` From 2cb7289ee07166997737d3f4faae9374a3c6f4ed Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Sat, 20 May 2023 13:19:04 +0530 Subject: [PATCH 449/650] Update Remove-ADComputer.md --- docset/winserver2012-ps/activedirectory/Remove-ADComputer.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2012-ps/activedirectory/Remove-ADComputer.md b/docset/winserver2012-ps/activedirectory/Remove-ADComputer.md index dd6864c69c..c15734100f 100644 --- a/docset/winserver2012-ps/activedirectory/Remove-ADComputer.md +++ b/docset/winserver2012-ps/activedirectory/Remove-ADComputer.md @@ -119,7 +119,7 @@ Aliases: cf Required: False Position: Named -Default value: False +Default value: True Accept pipeline input: False Accept wildcard characters: False ``` From 915dd10cb7b9ce23bf856cd809b2b618334aa2ff Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Sat, 20 May 2023 13:19:16 +0530 Subject: [PATCH 450/650] Update Remove-ADComputer.md --- docset/winserver2016-ps/activedirectory/Remove-ADComputer.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2016-ps/activedirectory/Remove-ADComputer.md b/docset/winserver2016-ps/activedirectory/Remove-ADComputer.md index 6744f689bd..e1bc2ed61c 100644 --- a/docset/winserver2016-ps/activedirectory/Remove-ADComputer.md +++ b/docset/winserver2016-ps/activedirectory/Remove-ADComputer.md @@ -102,7 +102,7 @@ Aliases: cf Required: False Position: Named -Default value: False +Default value: True Accept pipeline input: False Accept wildcard characters: False ``` From 8c01bb372a9f856858cdbc580eea0dd19fc67459 Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Sat, 20 May 2023 13:19:27 +0530 Subject: [PATCH 451/650] Update Remove-ADComputer.md --- docset/winserver2019-ps/activedirectory/Remove-ADComputer.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2019-ps/activedirectory/Remove-ADComputer.md b/docset/winserver2019-ps/activedirectory/Remove-ADComputer.md index 1519f0e889..c625bdb84e 100644 --- a/docset/winserver2019-ps/activedirectory/Remove-ADComputer.md +++ b/docset/winserver2019-ps/activedirectory/Remove-ADComputer.md @@ -102,7 +102,7 @@ Aliases: cf Required: False Position: Named -Default value: False +Default value: True Accept pipeline input: False Accept wildcard characters: False ``` From 59df696bf6949421ec0e7778c97c53bb1c83c05d Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Sat, 20 May 2023 13:19:45 +0530 Subject: [PATCH 452/650] Update Remove-ADComputer.md --- docset/winserver2012r2-ps/activedirectory/Remove-ADComputer.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2012r2-ps/activedirectory/Remove-ADComputer.md b/docset/winserver2012r2-ps/activedirectory/Remove-ADComputer.md index 4a279e1837..f1e4358d1c 100644 --- a/docset/winserver2012r2-ps/activedirectory/Remove-ADComputer.md +++ b/docset/winserver2012r2-ps/activedirectory/Remove-ADComputer.md @@ -101,7 +101,7 @@ Aliases: cf Required: False Position: Named -Default value: False +Default value: True Accept pipeline input: False Accept wildcard characters: False ``` From c592e3e4310e14838418ca4ee51571192aa9fdef Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Sat, 20 May 2023 13:21:43 +0530 Subject: [PATCH 453/650] Update Get-NetIPInterface.md Changed base reachable time default value to 30000 Fixes https://github.com/MicrosoftDocs/windows-powershell-docs/issues/3222 --- docset/winserver2022-ps/nettcpip/Get-NetIPInterface.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/nettcpip/Get-NetIPInterface.md b/docset/winserver2022-ps/nettcpip/Get-NetIPInterface.md index c0a368544b..459c983489 100644 --- a/docset/winserver2022-ps/nettcpip/Get-NetIPInterface.md +++ b/docset/winserver2022-ps/nettcpip/Get-NetIPInterface.md @@ -294,7 +294,7 @@ Accept wildcard characters: False ### -BaseReachableTimeMs Specifies an array of base values of random reachable times, in milliseconds. For more information, see [RFC 2461](https://go.microsoft.com/fwlink/p/?LinkId=84044). -The default value is 30. +The default value is 30000. ```yaml Type: UInt32[] From a3e780f43620b53f658cfe7c703876170d2015f6 Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Sat, 20 May 2023 13:45:04 +0530 Subject: [PATCH 454/650] Update Get-NetIPInterface.md --- docset/winserver2012-ps/nettcpip/Get-NetIPInterface.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2012-ps/nettcpip/Get-NetIPInterface.md b/docset/winserver2012-ps/nettcpip/Get-NetIPInterface.md index f411d6f201..a92238cea9 100644 --- a/docset/winserver2012-ps/nettcpip/Get-NetIPInterface.md +++ b/docset/winserver2012-ps/nettcpip/Get-NetIPInterface.md @@ -305,7 +305,7 @@ Accept wildcard characters: False Gets IP interface properties only for interfaces by the BaseReachableTime property. This parameter is the base for random reachable time, in milliseconds. This parameter is described in RFC 2461http://go.microsoft.com/fwlink/p/?LinkId=84044. -The default BaseReachableTime setting is `30`. +The default BaseReachableTime setting is `30000`. ```yaml Type: UInt32[] From 01400a4185880fce504da479125accdc60768222 Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Sat, 20 May 2023 13:45:26 +0530 Subject: [PATCH 455/650] Update Get-NetIPInterface.md --- docset/winserver2016-ps/nettcpip/Get-NetIPInterface.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2016-ps/nettcpip/Get-NetIPInterface.md b/docset/winserver2016-ps/nettcpip/Get-NetIPInterface.md index 6ca0bb1d5a..7973888ff6 100644 --- a/docset/winserver2016-ps/nettcpip/Get-NetIPInterface.md +++ b/docset/winserver2016-ps/nettcpip/Get-NetIPInterface.md @@ -294,7 +294,7 @@ Accept wildcard characters: False ### -BaseReachableTimeMs Specifies an array of base values of random reachable times, in milliseconds. For more information, see [RFC 2461](https://go.microsoft.com/fwlink/p/?LinkId=84044). -The default value is 30. +The default value is 30000. ```yaml Type: UInt32[] From f3f3b5e7c005e42fb21588acbed8e835c53ab0f0 Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Sat, 20 May 2023 13:45:45 +0530 Subject: [PATCH 456/650] Update Get-NetIPInterface.md --- docset/winserver2019-ps/nettcpip/Get-NetIPInterface.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2019-ps/nettcpip/Get-NetIPInterface.md b/docset/winserver2019-ps/nettcpip/Get-NetIPInterface.md index ea053ddcd1..24761fa753 100644 --- a/docset/winserver2019-ps/nettcpip/Get-NetIPInterface.md +++ b/docset/winserver2019-ps/nettcpip/Get-NetIPInterface.md @@ -294,7 +294,7 @@ Accept wildcard characters: False ### -BaseReachableTimeMs Specifies an array of base values of random reachable times, in milliseconds. For more information, see [RFC 2461](https://go.microsoft.com/fwlink/p/?LinkId=84044). -The default value is 30. +The default value is 30000. ```yaml Type: UInt32[] From e520615e07a3eaa7b80038d8a5ff39fb54a9ba17 Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Sat, 20 May 2023 13:46:15 +0530 Subject: [PATCH 457/650] Update Get-NetIPInterface.md --- docset/winserver2012r2-ps/nettcpip/Get-NetIPInterface.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2012r2-ps/nettcpip/Get-NetIPInterface.md b/docset/winserver2012r2-ps/nettcpip/Get-NetIPInterface.md index 807bb4e7f8..66db212200 100644 --- a/docset/winserver2012r2-ps/nettcpip/Get-NetIPInterface.md +++ b/docset/winserver2012r2-ps/nettcpip/Get-NetIPInterface.md @@ -293,7 +293,7 @@ Accept wildcard characters: False ### -BaseReachableTimeMs Specifies an array of base values of random reachable times, in milliseconds. For more information, see RFC 2461http://go.microsoft.com/fwlink/p/?LinkId=84044. -The default value is 30. +The default value is 30000. ```yaml Type: UInt32[] From 425b0d05f0e78c17836c1e31d5780e59714d2315 Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Sat, 20 May 2023 13:57:57 +0530 Subject: [PATCH 458/650] Update Set-VHD.md Fixed Example 3 in all versions of the document. --- docset/winserver2022-ps/hyper-v/Set-VHD.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/hyper-v/Set-VHD.md b/docset/winserver2022-ps/hyper-v/Set-VHD.md index c82765f42b..819530de46 100644 --- a/docset/winserver2022-ps/hyper-v/Set-VHD.md +++ b/docset/winserver2022-ps/hyper-v/Set-VHD.md @@ -58,7 +58,7 @@ This operation cannot be performed when the virtual disk chain is attached. ### Example 3 ``` -PS C:\> Set-VHD -Path Child1.vhd -parentpath parentcopywithnewid.vhd -IgnoreMismatchId +PS C:\> Set-VHD -Path Child1.vhd -parentpath parentcopywithnewid.vhd -IgnoreIdMismatch ``` This example sets the parent of Child1.vhd to point to parentcopywithnewid.vhd, even though parentcopywithnewid.vhd has a different ID than the original parent of child1.vhd. From b1bdd25602e8880b754d6092d6ccfe1f0b88902e Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Sat, 20 May 2023 13:59:14 +0530 Subject: [PATCH 459/650] Update Set-VHD.md --- docset/winserver2012-ps/hyper-v/Set-VHD.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2012-ps/hyper-v/Set-VHD.md b/docset/winserver2012-ps/hyper-v/Set-VHD.md index f5675a9077..c074f6b097 100644 --- a/docset/winserver2012-ps/hyper-v/Set-VHD.md +++ b/docset/winserver2012-ps/hyper-v/Set-VHD.md @@ -48,7 +48,7 @@ This operation cannot be performed when the virtual disk chain is attached. ### Example 3 ``` -PS C:\>Set-VHD -Path Child1.vhd -parentpath parentcopywithnewid.vhd -IgnoreMismatchId +PS C:\>Set-VHD -Path Child1.vhd -parentpath parentcopywithnewid.vhd -IgnoreIdMismatch ``` This example sets the parent of Child1.vhd to point to parentcopywithnewid.vhd, even though parentcopywithnewid.vhd has a different ID than the original parent of child1.vhd. From 18112c465dc7170891b6e98a11c4e89d19d474cc Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Sat, 20 May 2023 13:59:23 +0530 Subject: [PATCH 460/650] Update Set-VHD.md --- docset/winserver2016-ps/hyper-v/Set-VHD.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2016-ps/hyper-v/Set-VHD.md b/docset/winserver2016-ps/hyper-v/Set-VHD.md index 9cd20e40da..e26fd085fa 100644 --- a/docset/winserver2016-ps/hyper-v/Set-VHD.md +++ b/docset/winserver2016-ps/hyper-v/Set-VHD.md @@ -58,7 +58,7 @@ This operation cannot be performed when the virtual disk chain is attached. ### Example 3 ``` -PS C:\> Set-VHD -Path Child1.vhd -parentpath parentcopywithnewid.vhd -IgnoreMismatchId +PS C:\> Set-VHD -Path Child1.vhd -parentpath parentcopywithnewid.vhd -IgnoreIdMismatch ``` This example sets the parent of Child1.vhd to point to parentcopywithnewid.vhd, even though parentcopywithnewid.vhd has a different ID than the original parent of child1.vhd. From c6cbe11124dc6db2a8160c68e233f399a3e01122 Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Sat, 20 May 2023 13:59:33 +0530 Subject: [PATCH 461/650] Update Set-VHD.md --- docset/winserver2019-ps/hyper-v/Set-VHD.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2019-ps/hyper-v/Set-VHD.md b/docset/winserver2019-ps/hyper-v/Set-VHD.md index 8ec71d26c5..e23bb62b78 100644 --- a/docset/winserver2019-ps/hyper-v/Set-VHD.md +++ b/docset/winserver2019-ps/hyper-v/Set-VHD.md @@ -58,7 +58,7 @@ This operation cannot be performed when the virtual disk chain is attached. ### Example 3 ``` -PS C:\> Set-VHD -Path Child1.vhd -parentpath parentcopywithnewid.vhd -IgnoreMismatchId +PS C:\> Set-VHD -Path Child1.vhd -parentpath parentcopywithnewid.vhd -IgnoreIdMismatch ``` This example sets the parent of Child1.vhd to point to parentcopywithnewid.vhd, even though parentcopywithnewid.vhd has a different ID than the original parent of child1.vhd. From 04583b32ac85bacb3876b1baef72b515138dcd3a Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Sat, 20 May 2023 13:59:50 +0530 Subject: [PATCH 462/650] Update Set-VHD.md --- docset/winserver2012r2-ps/hyper-v/Set-VHD.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2012r2-ps/hyper-v/Set-VHD.md b/docset/winserver2012r2-ps/hyper-v/Set-VHD.md index c0d61601d1..f43fccbbdb 100644 --- a/docset/winserver2012r2-ps/hyper-v/Set-VHD.md +++ b/docset/winserver2012r2-ps/hyper-v/Set-VHD.md @@ -56,7 +56,7 @@ This operation cannot be performed when the virtual disk chain is attached. ### Example 3 ``` -PS C:\>Set-VHD -Path Child1.vhd -parentpath parentcopywithnewid.vhd -IgnoreMismatchId +PS C:\>Set-VHD -Path Child1.vhd -parentpath parentcopywithnewid.vhd -IgnoreIdMismatch ``` This example sets the parent of Child1.vhd to point to parentcopywithnewid.vhd, even though parentcopywithnewid.vhd has a different ID than the original parent of child1.vhd. From a1c4e3112dcd8eb299917b85243e6822b5b7704c Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Tue, 23 May 2023 11:25:38 +0530 Subject: [PATCH 463/650] Update Get-NetIPInterface.md --- docset/winserver2012-ps/nettcpip/Get-NetIPInterface.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2012-ps/nettcpip/Get-NetIPInterface.md b/docset/winserver2012-ps/nettcpip/Get-NetIPInterface.md index a92238cea9..9dca2eba59 100644 --- a/docset/winserver2012-ps/nettcpip/Get-NetIPInterface.md +++ b/docset/winserver2012-ps/nettcpip/Get-NetIPInterface.md @@ -304,7 +304,7 @@ Accept wildcard characters: False ### -BaseReachableTimeMs Gets IP interface properties only for interfaces by the BaseReachableTime property. This parameter is the base for random reachable time, in milliseconds. -This parameter is described in RFC 2461http://go.microsoft.com/fwlink/p/?LinkId=84044. +This parameter is described in RFC 2461 http://go.microsoft.com/fwlink/p/?LinkId=84044. The default BaseReachableTime setting is `30000`. ```yaml From ccdfdc2dbf635ce6a3bc5b4566fa9b527584cea4 Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Tue, 23 May 2023 11:26:26 +0530 Subject: [PATCH 464/650] Update Get-NetIPInterface.md --- docset/winserver2012-ps/nettcpip/Get-NetIPInterface.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2012-ps/nettcpip/Get-NetIPInterface.md b/docset/winserver2012-ps/nettcpip/Get-NetIPInterface.md index 9dca2eba59..dc3a0c114b 100644 --- a/docset/winserver2012-ps/nettcpip/Get-NetIPInterface.md +++ b/docset/winserver2012-ps/nettcpip/Get-NetIPInterface.md @@ -304,7 +304,7 @@ Accept wildcard characters: False ### -BaseReachableTimeMs Gets IP interface properties only for interfaces by the BaseReachableTime property. This parameter is the base for random reachable time, in milliseconds. -This parameter is described in RFC 2461 http://go.microsoft.com/fwlink/p/?LinkId=84044. +This parameter is described in [RFC 2461](https://go.microsoft.com/fwlink/p/?LinkId=84044). The default BaseReachableTime setting is `30000`. ```yaml From 7b8be00a046bacd6c99bc17a4f0162decb1238d0 Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Tue, 23 May 2023 11:27:05 +0530 Subject: [PATCH 465/650] Update Get-NetIPInterface.md --- docset/winserver2012r2-ps/nettcpip/Get-NetIPInterface.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2012r2-ps/nettcpip/Get-NetIPInterface.md b/docset/winserver2012r2-ps/nettcpip/Get-NetIPInterface.md index 66db212200..c328f345d8 100644 --- a/docset/winserver2012r2-ps/nettcpip/Get-NetIPInterface.md +++ b/docset/winserver2012r2-ps/nettcpip/Get-NetIPInterface.md @@ -292,7 +292,7 @@ Accept wildcard characters: False ### -BaseReachableTimeMs Specifies an array of base values of random reachable times, in milliseconds. -For more information, see RFC 2461http://go.microsoft.com/fwlink/p/?LinkId=84044. +For more information, see [RFC 2461](https://go.microsoft.com/fwlink/p/?LinkId=84044). The default value is 30000. ```yaml From 573fc76fc45d6998d856ae4e54aab6d97fcc3b11 Mon Sep 17 00:00:00 2001 From: Sean Wheeler Date: Thu, 25 May 2023 10:30:25 -0500 Subject: [PATCH 466/650] Fix indentation for syntax --- .../Install-ADDSDomainController.md | 94 +++++++++---------- 1 file changed, 45 insertions(+), 49 deletions(-) diff --git a/docset/winserver2022-ps/addsdeployment/Install-ADDSDomainController.md b/docset/winserver2022-ps/addsdeployment/Install-ADDSDomainController.md index 3a66bfb2e0..b1ea51a7f5 100644 --- a/docset/winserver2022-ps/addsdeployment/Install-ADDSDomainController.md +++ b/docset/winserver2022-ps/addsdeployment/Install-ADDSDomainController.md @@ -19,30 +19,27 @@ Installs a new domain controller in an Active Directory domain. ``` Install-ADDSDomainController [-SkipPreChecks] -DomainName -[-SafeModeAdministratorPassword ] [-SiteName ] -[-ADPrepCredential ] [-AllowDomainControllerReinstall] -[-ApplicationPartitionsToReplicate ] [-CreateDnsDelegation] -[-Credential ] [-CriticalReplicationOnly] [-DatabasePath ] -[-DnsDelegationCredential ] [-NoDnsOnNetwork] [-NoGlobalCatalog] -[-InstallationMediaPath ] [-InstallDns] [-LogPath ] -[-MoveInfrastructureOperationMasterRoleIfNecessary] [-NoRebootOnCompletion] -[-ReplicationSourceDC ] [-SkipAutoConfigureDns] [-SystemKey ] -[-SysvolPath ] [-Force] [-WhatIf] [-Confirm] [] + [-SafeModeAdministratorPassword ] [-SiteName ] + [-ADPrepCredential ] [-AllowDomainControllerReinstall] + [-ApplicationPartitionsToReplicate ] [-CreateDnsDelegation] [-Credential ] + [-CriticalReplicationOnly] [-DatabasePath ] [-DnsDelegationCredential ] + [-NoDnsOnNetwork] [-NoGlobalCatalog] [-InstallationMediaPath ] [-InstallDns] + [-LogPath ] [-MoveInfrastructureOperationMasterRoleIfNecessary] [-NoRebootOnCompletion] + [-ReplicationSourceDC ] [-SkipAutoConfigureDns] [-SystemKey ] + [-SysvolPath ] [-Force] [-WhatIf] [-Confirm] [] ``` ### ADDSDomainControllerReadOnly ``` Install-ADDSDomainController [-SkipPreChecks] -DomainName - [-SafeModeAdministratorPassword ] -SiteName + [-SafeModeAdministratorPassword ] -SiteName [-ADPrepCredential ] [-AllowDomainControllerReinstall] - [-AllowPasswordReplicationAccountName ] - [-ApplicationPartitionsToReplicate ] [-Credential ] - [-CriticalReplicationOnly] [-DatabasePath ] - [-DelegatedAdministratorAccountName ] - [-DenyPasswordReplicationAccountName ] [-NoDnsOnNetwork] [-NoGlobalCatalog] - [-InstallationMediaPath ] [-InstallDns] [-LogPath ] - [-MoveInfrastructureOperationMasterRoleIfNecessary] [-ReadOnlyReplica] + [-AllowPasswordReplicationAccountName ] [-ApplicationPartitionsToReplicate ] + [-Credential ] [-CriticalReplicationOnly] [-DatabasePath ] + [-DelegatedAdministratorAccountName ] [-DenyPasswordReplicationAccountName ] + [-NoDnsOnNetwork] [-NoGlobalCatalog] [-InstallationMediaPath ] [-InstallDns] + [-LogPath ] [-MoveInfrastructureOperationMasterRoleIfNecessary] [-ReadOnlyReplica] [-NoRebootOnCompletion] [-ReplicationSourceDC ] [-SkipAutoConfigureDns] [-SystemKey ] [-SysvolPath ] [-Force] [-WhatIf] [-Confirm] [] @@ -57,8 +54,7 @@ Install-ADDSDomainController [-SkipPreChecks] -DomainName [-CriticalReplicationOnly] [-DatabasePath ] [-NoDnsOnNetwork] [-InstallationMediaPath ] [-LogPath ] [-NoRebootOnCompletion] [-ReplicationSourceDC ] [-SkipAutoConfigureDns] [-SystemKey ] - [-SysvolPath ] [-UseExistingAccount] [-Force] [-WhatIf] [-Confirm] - [] + [-SysvolPath ] [-UseExistingAccount] [-Force] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -117,7 +113,7 @@ controller. Use the `Get-Credential` cmdlet to prompt the user to supply a passw ```yaml Type: System.Management.Automation.PSCredential Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -136,7 +132,7 @@ controller with the same name is found. ```yaml Type: System.Management.Automation.SwitchParameter Parameter Sets: ADDSDomainController, ADDSDomainControllerReadOnly -Aliases: +Aliases: Required: False Position: Named @@ -155,7 +151,7 @@ allowed. ```yaml Type: System.String[] Parameter Sets: ADDSDomainControllerReadOnly -Aliases: +Aliases: Required: False Position: Named @@ -173,7 +169,7 @@ Use * to replicate all application directory partitions. ```yaml Type: System.String[] Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -209,7 +205,7 @@ automatically based on the environment. ```yaml Type: System.Management.Automation.SwitchParameter Parameter Sets: ADDSDomainController -Aliases: +Aliases: Required: False Position: Named @@ -226,7 +222,7 @@ controller. Use the `Get-Credential` to prompt the user to supply a password. ```yaml Type: System.Management.Automation.PSCredential Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -246,7 +242,7 @@ replication. ```yaml Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -264,7 +260,7 @@ The default is `%SYSTEMROOT%\NTDS`. ```yaml Type: System.String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -281,7 +277,7 @@ controller. ```yaml Type: System.String Parameter Sets: ADDSDomainControllerReadOnly -Aliases: +Aliases: Required: False Position: Named @@ -303,7 +299,7 @@ Owners, the krbtgt account, and Schema Admins. ```yaml Type: System.String[] Parameter Sets: ADDSDomainControllerReadOnly -Aliases: +Aliases: Required: False Position: Named @@ -320,7 +316,7 @@ value for the **CreateDnsDelegation** parameter is either specified or computed ```yaml Type: System.Management.Automation.PSCredential Parameter Sets: ADDSDomainController -Aliases: +Aliases: Required: False Position: Named @@ -337,7 +333,7 @@ installed or added. ```yaml Type: System.String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: Named @@ -353,7 +349,7 @@ Forces the command to run without asking for user confirmation. ```yaml Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -378,7 +374,7 @@ response is `corp.contoso.com`. ```yaml Type: System.Management.Automation.SwitchParameter Parameter Sets: ADDSDomainController, ADDSDomainControllerReadOnly -Aliases: +Aliases: Required: False Position: Named @@ -394,7 +390,7 @@ Indicates the location of the installation media that is used to install a new d ```yaml Type: System.String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -412,7 +408,7 @@ that will contain the domain log files, for example, `C:\Windows\Logs`. The defa ```yaml Type: System.String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -431,7 +427,7 @@ remain where it currently is. ```yaml Type: System.Management.Automation.SwitchParameter Parameter Sets: ADDSDomainController, ADDSDomainControllerReadOnly -Aliases: +Aliases: Required: False Position: Named @@ -456,7 +452,7 @@ DNS server address. ```yaml Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -473,7 +469,7 @@ By default, the domain controller that you are installing is a global catalog se ```yaml Type: System.Management.Automation.SwitchParameter Parameter Sets: ADDSDomainController, ADDSDomainControllerReadOnly -Aliases: +Aliases: Required: False Position: Named @@ -494,7 +490,7 @@ rebooted. ```yaml Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -510,7 +506,7 @@ Indicates that the cmdlet installs the domain controller as an RODC for an exist ```yaml Type: System.Management.Automation.SwitchParameter Parameter Sets: ADDSDomainControllerReadOnly -Aliases: +Aliases: Required: False Position: Named @@ -527,7 +523,7 @@ controller. ```yaml Type: System.String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -559,7 +555,7 @@ which is also not a recommended security best practice in production deployments ```yaml Type: System.Security.SecureString Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -579,7 +575,7 @@ the site of the replication source domain controller. ```yaml Type: System.String Parameter Sets: ADDSDomainController -Aliases: +Aliases: Required: False Position: Named @@ -591,7 +587,7 @@ Accept wildcard characters: False ```yaml Type: System.String Parameter Sets: ADDSDomainControllerReadOnly -Aliases: +Aliases: Required: True Position: Named @@ -608,7 +604,7 @@ root hints. This parameter is in effect only if the DNS Server service is alread ```yaml Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -630,7 +626,7 @@ preliminary checks that the **ADDSDeployment** module performs by default when u ```yaml Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -647,7 +643,7 @@ The default is none. ```yaml Type: System.Security.SecureString Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -665,7 +661,7 @@ that will contain the Sysvol data, for example, `C:\Windows\SYSVOL`. The default ```yaml Type: System.String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -682,7 +678,7 @@ If specified, a member of the Domain Admins group or a delegated user can run th ```yaml Type: System.Management.Automation.SwitchParameter Parameter Sets: ADDSDomainControllerUseExistingAccount -Aliases: +Aliases: Required: False Position: Named From 3e49b14f6c81cb09719a6204615dd0717a8eb942 Mon Sep 17 00:00:00 2001 From: Rob Derickson Date: Tue, 23 May 2023 21:51:06 -0400 Subject: [PATCH 467/650] Fix formatting for Add-ADCentralAccessPolicy. --- .../Add-ADCentralAccessPolicyMember.md | 147 +++++++++++------- 1 file changed, 91 insertions(+), 56 deletions(-) diff --git a/docset/winserver2022-ps/activedirectory/Add-ADCentralAccessPolicyMember.md b/docset/winserver2022-ps/activedirectory/Add-ADCentralAccessPolicyMember.md index f4a63c922b..4746fd5445 100644 --- a/docset/winserver2022-ps/activedirectory/Add-ADCentralAccessPolicyMember.md +++ b/docset/winserver2022-ps/activedirectory/Add-ADCentralAccessPolicyMember.md @@ -16,46 +16,59 @@ Adds central access rules to a central access policy in Active Directory. ## SYNTAX ``` -Add-ADCentralAccessPolicyMember [-WhatIf] [-Confirm] [-AuthType ] [-Credential ] - [-Identity] [-Members] [-PassThru] [-Server ] - [] +Add-ADCentralAccessPolicyMember [-WhatIf] [-Confirm] [-AuthType ] + [-Credential ] [-Identity] + [-Members] [-PassThru] [-Server ] [] ``` ## DESCRIPTION -The **Add-ADCentralAccessPolicyMember** cmdlet adds central access rules to a central access policy in Active Directory. + +The `Add-ADCentralAccessPolicyMember` cmdlet adds central access rules to a central access policy +in Active Directory. ## EXAMPLES -### Example 1: Add central access rules to an existing central access policy -``` -PS C:\> Add-ADCentralAccessPolicyMember -Identity "Finance Policy" -Member "Finance Documents Rule","Corporate Documents Rule" +### EXAMPLE 1 + +```powershell +$params = @{ + Identity = 'Finance Policy' + Member = 'Finance Documents Rule', 'Corporate Documents Rule' +} +Add-ADCentralAccessPolicyMember @params ``` -This command adds the central access rules Finance Documents Rule and Corporate Documents Rule to the central access policy Finance Policy. +This command adds the central access rules Finance Documents Rule and Corporate Documents Rule to +the central access policy Finance Policy. -### Example 2: Add a central access rule to an existing central access policy -``` -PS C:\> Get-ADCentralAccessPolicy -Filter "Name -like 'Corporate*'" | Add-ADCentralAccessPolicyMember -Members "Corporate Documents Rule" +### EXAMPLE 2 + +```powershell +Get-ADCentralAccessPolicy -Filter "Name -like 'Corporate*'" | + Add-ADCentralAccessPolicyMember -Members 'Corporate Documents Rule' ``` -This command gets all central access policies that have a name that starts with Corporate and then passes this information to Add-ADCentralAccessPolicyMember by using the pipeline operator. -The **Add-ADCentralAccessPolicyMember** cmdlet then adds the central access rule with the name Corporate Documents Rule to it. +This command gets all central access policies that have a name that starts with `Corporate` and then +passes this information to `Add-ADCentralAccessPolicyMember` by using the pipeline operator. The +`Add-ADCentralAccessPolicyMember` cmdlet then adds the central access rule with the name +`Corporate Documents Rule` to it. ## PARAMETERS ### -AuthType + Specifies the authentication method to use. The acceptable values for this parameter are: -- Negotiate or 0 -- Basic or 1 +- `Negotiate` or `0` +- `Basic` or `1` -The default authentication method is Negotiate. +The default authentication method is `Negotiate`. -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. +A Secure Sockets Layer (SSL) connection is required for the `Basic` authentication method. ```yaml -Type: ADAuthType +Type: Microsoft.ActiveDirectory.Management.ADAuthType Parameter Sets: (All) Aliases: Accepted values: Negotiate, Basic @@ -68,10 +81,11 @@ Accept wildcard characters: False ``` ### -Confirm + Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf @@ -83,20 +97,24 @@ Accept wildcard characters: False ``` ### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory module for Windows PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. -To specify this parameter, you can type a user name, such as User1 or Domain01\User01 or you can specify a **PSCredential** object. -If you specify a user name for this parameter, the cmdlet prompts for a password. +Specifies the user account credentials to use to perform this task. The default credentials are the +credentials of the currently logged on user unless the cmdlet is run from an Active Directory module +for Windows PowerShell provider drive. If the cmdlet is run from such a provider drive, the account +associated with the drive is the default. + +To specify this parameter, you can type a user name, such as `User1` or `Domain01\User0`1 or you can +specify a **PSCredential** object. If you specify a user name for this parameter, the cmdlet prompts +for a password. -You can also create a **PSCredential** object by using a script or by using the **Get-Credential** cmdlet. -You can then set the *Credential* parameter to the **PSCredential** object. +You can also create a **PSCredential** object by using a script or by using the `Get-Credential` +cmdlet. You can then set the **Credential** parameter to the **PSCredential** object. -If the acting credentials do not have directory-level permission to perform the task, Active Directory module for Windows PowerShell returns a terminating error. +If the acting credentials do not have directory-level permission to perform the task, Active +Directory module for Windows PowerShell returns a terminating error. ```yaml -Type: PSCredential +Type: System.Management.Automation.PSCredential Parameter Sets: (All) Aliases: @@ -108,19 +126,21 @@ Accept wildcard characters: False ``` ### -Identity -Specifies an Active Directory object by providing one of the following property values. -The identifier in parentheses is the Lightweight Directory Access Protocol (LDAP) display name for the attribute. -The acceptable values for this parameter are: + +Specifies an Active Directory object by providing one of the following property values. The +identifier in parentheses is the Lightweight Directory Access Protocol (LDAP) display name for the +attribute. The acceptable values for this parameter are: - A distinguished name -- A GUID (objectGUID) -- A security identifier (objectSid) -- A SAM account name (sAMAccountName) +- A GUID (**objectGUID**) +- A security identifier (**objectSid**) +- A SAM account name (**sAMAccountName**) -This parameter can also get this object through the pipeline or you can set this parameter to an object instance. +This parameter can also get this object through the pipeline or you can set this parameter to an +object instance. ```yaml -Type: ADCentralAccessPolicy +Type: Microsoft.ActiveDirectory.Management.ADCentralAccessPolicy Parameter Sets: (All) Aliases: @@ -132,21 +152,23 @@ Accept wildcard characters: False ``` ### -Members -Specifies a set of central access rule (CAR) objects in a comma-separated list to add to a central access policy. -To identify each object, use one of the following property values: + +Specifies a set of central access rule (CAR) objects in a comma-separated list to add to a central +access policy. To identify each object, use one of the following property values: - Name - A distinguished name -- GUID (objectGUID) +- GUID (**objectGUID**) - Note: The identifier in parentheses is the LDAP display name. +> [!NOTE] +> The identifier in parentheses is the LDAP display name. You can also provide objects to this parameter directly. You cannot pass objects through the pipeline to this parameter. ```yaml -Type: ADCentralAccessRule[] +Type: Microsoft.ActiveDirectory.Management.ADCentralAccessRule[] Parameter Sets: (All) Aliases: @@ -158,11 +180,12 @@ Accept wildcard characters: False ``` ### -PassThru + Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -174,30 +197,35 @@ Accept wildcard characters: False ``` ### -Server -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory snapshot instance. -Specify the Active Directory Domain Services instance in one of the following ways: +Specifies the Active Directory Domain Services instance to connect to, by providing one of the +following values for a corresponding domain name or directory server. The service may be any of the +following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active +Directory snapshot instance. + +Specify the Active Directory Domain Services instance in one of the following ways: Domain name values: - Fully qualified domain name - NetBIOS name -Directory server values: +Directory server values: - Fully qualified directory server name - NetBIOS name - Fully qualified directory server name and port -The default value for this parameter is determined by one of the following methods in the order that they are listed: +The default value for this parameter is determined by one of the following methods in the order that +they are listed: - By using the **Server** value from objects passed through the pipeline -- By using the server information associated with the Active Directory Domain Services Windows PowerShell provider drive, when the cmdlet runs in that drive +- By using the server information associated with the Active Directory Domain Services Windows + PowerShell provider drive, when the cmdlet runs in that drive - By using the domain of the computer running Windows PowerShell ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -209,11 +237,12 @@ Accept wildcard characters: False ``` ### -WhatIf + Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi @@ -225,26 +254,32 @@ Accept wildcard characters: False ``` ### CommonParameters -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). + +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). ## INPUTS ### None or Microsoft.ActiveDirectory.Management.ADCentralAccessPolicy -An **ADCentralAccessPolicy** object is received by the *Identity* parameter. + +An **ADCentralAccessPolicy** object is received by the **Identity** parameter. ## OUTPUTS ### None or Microsoft.ActiveDirectory.ADCentralAccessPolicy -Returns the modified **ADCentralAccessPolicy** object when the *PassThru* parameter is specified. + +Returns the modified **ADCentralAccessPolicy** object when the **PassThru** parameter is specified. By default, this cmdlet does not generate any output. ## NOTES -* This cmdlet does not work with a read-only domain controller. -* This cmdlet does not work with an Active Directory snapshot. + +- This cmdlet does not work with a read-only domain controller. +- This cmdlet does not work with an Active Directory snapshot. ## RELATED LINKS [Remove-ADCentralAccessPolicyMember](./Remove-ADCentralAccessPolicyMember.md) [AD DS Administration Cmdlets in Windows PowerShell](./activedirectory.md) - From 2e0c1e256d4fd56e716b00a8f992b931dcc8b3fc Mon Sep 17 00:00:00 2001 From: Rob Derickson Date: Tue, 23 May 2023 22:04:14 -0400 Subject: [PATCH 468/650] Fix formatting for Add-ADComputerServiceAccount. --- .../Add-ADComputerServiceAccount.md | 218 +++++++++++------- 1 file changed, 130 insertions(+), 88 deletions(-) diff --git a/docset/winserver2022-ps/activedirectory/Add-ADComputerServiceAccount.md b/docset/winserver2022-ps/activedirectory/Add-ADComputerServiceAccount.md index 570e428871..5d9a916787 100644 --- a/docset/winserver2022-ps/activedirectory/Add-ADComputerServiceAccount.md +++ b/docset/winserver2022-ps/activedirectory/Add-ADComputerServiceAccount.md @@ -16,57 +16,68 @@ Adds one or more service accounts to an Active Directory computer. ## SYNTAX ``` -Add-ADComputerServiceAccount [-WhatIf] [-Confirm] [-AuthType ] [-Credential ] - [-Identity] [-Partition ] [-PassThru] [-Server ] - [-ServiceAccount] [] +Add-ADComputerServiceAccount [-WhatIf] [-Confirm] [-AuthType ] + [-Credential ] [-Identity] [-Partition ] [-PassThru] + [-Server ] [-ServiceAccount] [] ``` ## DESCRIPTION -The **Add-ADComputerServiceAccount** cmdlet adds one or more computer service accounts to an Active Directory computer. -The *Computer* parameter specifies the Active Directory computer that will host the new service accounts. -You can identify a computer by its distinguished name, GUID, security identifier (SID) or Security Accounts Manager (SAM) account name. -You can also set the *Computer* parameter to a computer object variable, such as `$`, or pass a computer object through the pipeline to the *Computer* parameter. -For example, you can use the **Get-ADComputer** cmdlet to retrieve a computer object and then pass the object through the pipeline to the **Add-ADComputerServiceAccount** cmdlet. +The `Add-ADComputerServiceAccount` cmdlet adds one or more computer service accounts to an Active +Directory computer. -The *ServiceAccount* parameter specifies the service accounts to add. -You can identify a service account by its distinguished name, GUID, Security Identifier (SID) or Security Accounts Manager (SAM) account name. -You can also specify service account object variables, such as `$`. -If you are specifying more than one account, use a comma-separated list. +The **Computer** parameter specifies the Active Directory computer that will host the new service +accounts. You can identify a computer by its distinguished name, GUID, security identifier (SID) or +Security Accounts Manager (SAM) account name. You can also set the **Computer** parameter to a +computer object variable, such as `$`, or pass a computer object through the +pipeline to the **Computer** parameter. For example, you can use the `Get-ADComputer` cmdlet to +retrieve a computer object and then pass the object through the pipeline to the +`Add-ADComputerServiceAccount` cmdlet. -Note: Adding a service account is a different operation than installing the service account locally. +The **ServiceAccount** parameter specifies the service accounts to add. You can identify a service +account by its distinguished name, GUID, Security Identifier (SID) or Security Accounts Manager +(SAM) account name. You can also specify service account object variables, such as +`$`. If you are specifying more than one account, use a comma-separated +list. + +> {!NOTE] +> Adding a service account is a different operation than installing the service account locally. ## EXAMPLES -### Example 1: Add a service account to a specified computer account -``` -PS C:\> Add-ADComputerServiceAccount -Computer ComputerAcct1 -ServiceAccount SvcAcct1 +### EXAMPLE 1 + +```powershell +Add-ADComputerServiceAccount -Computer ComputerAcct1 -ServiceAccount SvcAcct1 ``` -This command adds the service account SvcAcct1 to a Computer Account ComputerAcct1. +This command adds the service account `SvcAcct1` to a Computer Account `ComputerAcct1`. + +### EXAMPLE 2 -### Example 2: Add multiple service accounts to a specified computer account ``` -PS C:\> Add-ADComputerServiceAccount -Computer ComputerAcct1 -ServiceAccount SvcAcct1,SvcAcct2 +Add-ADComputerServiceAccount -Computer ComputerAcct1 -ServiceAccount SvcAcct1, SvcAcct2 ``` -This command adds two service accounts, SvcAcct1 and SvcAcct2, to a Computer Account ComputerAcct1. +This command adds two service accounts, `SvcAcct1` and `SvcAcct2`, to a Computer Account +`ComputerAcct1`. ## PARAMETERS ### -AuthType + Specifies the authentication method to use. The acceptable values for this parameter are: -- Negotiate or 0 -- Basic or 1 +- `Negotiate` or `0` +- `Basic` or `1` -The default authentication method is Negotiate. +The default authentication method is `Negotiate`. -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. +A Secure Sockets Layer (SSL) connection is required for the `Basic` authentication method. ```yaml -Type: ADAuthType +Type: Microsoft.ActiveDirectory.Management.ADAuthType Parameter Sets: (All) Aliases: Accepted values: Negotiate, Basic @@ -79,10 +90,11 @@ Accept wildcard characters: False ``` ### -Confirm + Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf @@ -94,20 +106,24 @@ Accept wildcard characters: False ``` ### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory module for Windows PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. -To specify this parameter, you can type a user name, such as User1 or Domain01\User01 or you can specify a **PSCredential** object. -If you specify a user name for this parameter, the cmdlet prompts for a password. +Specifies the user account credentials to use to perform this task. The default credentials are the +credentials of the currently logged on user unless the cmdlet is run from an Active Directory module +for Windows PowerShell provider drive. If the cmdlet is run from such a provider drive, the account +associated with the drive is the default. -You can also create a **PSCredential** object by using a script or by using the **Get-Credential** cmdlet. -You can then set the *Credential* parameter to the **PSCredential** object. +To specify this parameter, you can type a user name, such as `User1` or `Domain01\User01` or you can +specify a **PSCredential** object. If you specify a user name for this parameter, the cmdlet prompts +for a password. -If the acting credentials do not have directory-level permission to perform the task, Active Directory module for Windows PowerShell returns a terminating error. +You can also create a **PSCredential** object by using a script or by using the `Get-Credential` +cmdlet. You can then set the **Credential** parameter to the **PSCredential** object. + +If the acting credentials do not have directory-level permission to perform the task, Active +Directory module for Windows PowerShell returns a terminating error. ```yaml -Type: PSCredential +Type: System.Management.Automation.PSCredential Parameter Sets: (All) Aliases: @@ -119,23 +135,25 @@ Accept wildcard characters: False ``` ### -Identity -Specifies an Active Directory computer object by providing one of the following property values. -The identifier in parentheses is the Lightweight Directory Access Protocol (LDAP) display name for the attribute. -The acceptable values for this parameter are: + +Specifies an Active Directory computer object by providing one of the following property values. The +identifier in parentheses is the Lightweight Directory Access Protocol (LDAP) display name for the +attribute. The acceptable values for this parameter are: - A distinguished name -- A GUID (objectGUID) -- A security identifier (objectSid) -- Security Accounts Manager account name (sAMAccountName) +- A GUID (**objectGUID**) +- A security identifier (**objectSid**) +- Security Accounts Manager account name (**sAMAccountName**) -The cmdlet searches the default naming context or partition to find the object. -If the identifier given is a distinguished name, the partition to search is computed from that distinguished name. -If two or more objects are found, the cmdlet returns a non-terminating error. +The cmdlet searches the default naming context or partition to find the object. If the identifier +given is a distinguished name, the partition to search is computed from that distinguished name. If +two or more objects are found, the cmdlet returns a non-terminating error. -This parameter can also get this object through the pipeline or you can set this parameter to a computer object instance. +This parameter can also get this object through the pipeline or you can set this parameter to a +computer object instance. ```yaml -Type: ADComputer +Type: Microsoft.ActiveDirectory.Management.ADComputer Parameter Sets: (All) Aliases: Computer @@ -147,30 +165,40 @@ Accept wildcard characters: False ``` ### -Partition -Specifies the distinguished name of an Active Directory partition. -The distinguished name must be one of the naming contexts on the current directory server. -The cmdlet searches this partition to find the object defined by the *Identity* parameter. - -In many cases, a default value is used for the *Partition* parameter if no value is specified. -The rules for determining the default value are given below. -Note that rules listed first are evaluated first and once a default value can be determined, no further rules are evaluated. - -In Active Directory Domain Services environments, a default value for *Partition* is set in the following cases: - -- If the *Identity* parameter is set to a distinguished name, the default value of *Partition* is automatically generated from this distinguished name. -- If running cmdlets from an Active Directory provider drive, the default value of *Partition* is automatically generated from the current path in the drive. -- If none of the previous cases apply, the default value of *Partition* is set to the default partition or naming context of the target domain. -In Active Directory Lightweight Directory Services (AD LDS) environments, a default value for *Partition* is set in the following cases: - -- If the *Identity* parameter is set to a distinguished name, the default value of *Partition* is automatically generated from this distinguished name. -- If running cmdlets from an Active Directory provider drive, the default value of *Partition* is automatically generated from the current path in the drive. -- If the target AD LDS instance has a default naming context, the default value of *Partition* is set to the default naming context. -To specify a default naming context for an AD LDS environment, set the **msDS-defaultNamingContext** property of the Active Directory directory service agent (DSA) object (**nTDSDSA**) for the AD LDS instance. -- If none of the previous cases apply, the *Partition* parameter will not take any default value. +Specifies the distinguished name of an Active Directory partition. The distinguished name must be +one of the naming contexts on the current directory server. The cmdlet searches this partition to +find the object defined by the **Identity** parameter. + +In many cases, a default value is used for the **Partition** parameter if no value is specified. The +rules for determining the default value are given below. Note that rules listed first are evaluated +first and once a default value can be determined, no further rules are evaluated. + +In Active Directory Domain Services environments, a default value for **Partition** is set in the +following cases: + +- If the **Identity** parameter is set to a distinguished name, the default value of **Partition** + is automatically generated from this distinguished name. +- If running cmdlets from an Active Directory provider drive, the default value of **Partition**is + automatically generated from the current path in the drive. +- If none of the previous cases apply, the default value of **Partition**is set to the default + partition or naming context of the target domain. + +In Active Directory Lightweight Directory Services (AD LDS) environments, a default value for +**Partition**is set in the following cases: + +- If the **Identity** parameter is set to a distinguished name, the default value of **Partition**is + automatically generated from this distinguished name. +- If running cmdlets from an Active Directory provider drive, the default value of **Partition**is + automatically generated from the current path in the drive. +- If the target AD LDS instance has a default naming context, the default value of **Partition**is + set to the default naming context. To specify a default naming context for an AD LDS environment, + set the **msDS-defaultNamingContext** property of the Active Directory directory service agent + (DSA) object (**nTDSDSA**) for the AD LDS instance. +- If none of the previous cases apply, the **Partition**parameter will not take any default value. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -182,11 +210,12 @@ Accept wildcard characters: False ``` ### -PassThru + Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -198,30 +227,35 @@ Accept wildcard characters: False ``` ### -Server -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory snapshot instance. -Specify the Active Directory Domain Services instance in one of the following ways: +Specifies the Active Directory Domain Services instance to connect to, by providing one of the +following values for a corresponding domain name or directory server. The service may be any of the +following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active +Directory snapshot instance. + +Specify the Active Directory Domain Services instance in one of the following ways: Domain name values: - Fully qualified domain name - NetBIOS name -Directory server values: +Directory server values: - Fully qualified directory server name - NetBIOS name - Fully qualified directory server name and port -The default value for this parameter is determined by one of the following methods in the order that they are listed: +The default value for this parameter is determined by one of the following methods in the order that +they are listed: - By using the **Server** value from objects passed through the pipeline -- By using the server information associated with the Active Directory Domain Services Windows PowerShell provider drive, when the cmdlet runs in that drive +- By using the server information associated with the Active Directory Domain Services Windows + PowerShell provider drive, when the cmdlet runs in that drive - By using the domain of the computer running Windows PowerShell ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -233,16 +267,17 @@ Accept wildcard characters: False ``` ### -ServiceAccount + Specifies one or more Active Directory service accounts. The acceptable values for this parameter are: - A distinguished name -- A GUID (objectGUID) -- A Security Identifier (objectSid) -- SAM account name (sAMAccountName) +- A GUID (**objectGUID**) +- A Security Identifier (**objectSid**) +- SAM account name (**sAMAccountName**) ```yaml -Type: ADServiceAccount[] +Type: Microsoft.ActiveDirectory.Management.ADServiceAccount[] Parameter Sets: (All) Aliases: @@ -254,11 +289,12 @@ Accept wildcard characters: False ``` ### -WhatIf + Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi @@ -270,23 +306,30 @@ Accept wildcard characters: False ``` ### CommonParameters -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). + +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). ## INPUTS ### Microsoft.ActiveDirectory.Management.ADComputer -A computer object is received by the *Computer* parameter. + +A computer object is received by the **Computer** parameter. ## OUTPUTS ### None or Microsoft.ActiveDirectory.Management.ADComputer -This cmdlet returns the modified computer object when the *PassThru* parameter is specified. -By default, this cmdlet does not generate any output. + +This cmdlet returns the modified computer object when the **PassThru** parameter is specified. By +default, this cmdlet does not generate any output. ## NOTES -* This cmdlet does not work with AD LDS. -* This cmdlet does not work with a read-only domain controller. -* This cmdlet does not work when targeting a snapshot using the *Server* parameter. + +- This cmdlet does not work with AD LDS. +- This cmdlet does not work with a read-only domain controller. +- This cmdlet does not work when targeting a snapshot using the **Server** parameter. ## RELATED LINKS @@ -297,4 +340,3 @@ By default, this cmdlet does not generate any output. [Remove-ADComputerServiceAccount](./Remove-ADComputerServiceAccount.md) [AD DS Administration Cmdlets in Windows PowerShell](./activedirectory.md) - From bffea61980802f738c22cff5e135ba3858accf71 Mon Sep 17 00:00:00 2001 From: Rob Derickson Date: Tue, 23 May 2023 22:07:12 -0400 Subject: [PATCH 469/650] Fix formatting for Add-ADComputerServiceAccount. --- .../Add-ADComputerServiceAccount.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/docset/winserver2022-ps/activedirectory/Add-ADComputerServiceAccount.md b/docset/winserver2022-ps/activedirectory/Add-ADComputerServiceAccount.md index 5d9a916787..6f721dec44 100644 --- a/docset/winserver2022-ps/activedirectory/Add-ADComputerServiceAccount.md +++ b/docset/winserver2022-ps/activedirectory/Add-ADComputerServiceAccount.md @@ -179,23 +179,23 @@ following cases: - If the **Identity** parameter is set to a distinguished name, the default value of **Partition** is automatically generated from this distinguished name. -- If running cmdlets from an Active Directory provider drive, the default value of **Partition**is +- If running cmdlets from an Active Directory provider drive, the default value of **Partition** is automatically generated from the current path in the drive. -- If none of the previous cases apply, the default value of **Partition**is set to the default +- If none of the previous cases apply, the default value of **Partition** is set to the default partition or naming context of the target domain. In Active Directory Lightweight Directory Services (AD LDS) environments, a default value for -**Partition**is set in the following cases: +**Partition** is set in the following cases: -- If the **Identity** parameter is set to a distinguished name, the default value of **Partition**is +- If the **Identity** parameter is set to a distinguished name, the default value of **Partition** is automatically generated from this distinguished name. -- If running cmdlets from an Active Directory provider drive, the default value of **Partition**is +- If running cmdlets from an Active Directory provider drive, the default value of **Partition** is automatically generated from the current path in the drive. -- If the target AD LDS instance has a default naming context, the default value of **Partition**is +- If the target AD LDS instance has a default naming context, the default value of **Partition** is set to the default naming context. To specify a default naming context for an AD LDS environment, set the **msDS-defaultNamingContext** property of the Active Directory directory service agent (DSA) object (**nTDSDSA**) for the AD LDS instance. -- If none of the previous cases apply, the **Partition**parameter will not take any default value. +- If none of the previous cases apply, the **Partition** parameter will not take any default value. ```yaml Type: System.String From 6d82fc053303fd553bb3403a12d9dab2cdda9e4b Mon Sep 17 00:00:00 2001 From: Rob Derickson Date: Tue, 23 May 2023 22:07:50 -0400 Subject: [PATCH 470/650] Fix formatting for Add-ADComputerServiceAccount. --- .../activedirectory/Add-ADComputerServiceAccount.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docset/winserver2022-ps/activedirectory/Add-ADComputerServiceAccount.md b/docset/winserver2022-ps/activedirectory/Add-ADComputerServiceAccount.md index 6f721dec44..ecb9cc15c0 100644 --- a/docset/winserver2022-ps/activedirectory/Add-ADComputerServiceAccount.md +++ b/docset/winserver2022-ps/activedirectory/Add-ADComputerServiceAccount.md @@ -187,8 +187,8 @@ following cases: In Active Directory Lightweight Directory Services (AD LDS) environments, a default value for **Partition** is set in the following cases: -- If the **Identity** parameter is set to a distinguished name, the default value of **Partition** is - automatically generated from this distinguished name. +- If the **Identity** parameter is set to a distinguished name, the default value of **Partition** + is automatically generated from this distinguished name. - If running cmdlets from an Active Directory provider drive, the default value of **Partition** is automatically generated from the current path in the drive. - If the target AD LDS instance has a default naming context, the default value of **Partition** is From ba5e590482237db595e8dad4a9ff287f503bfa0b Mon Sep 17 00:00:00 2001 From: Rob Derickson Date: Tue, 23 May 2023 22:10:56 -0400 Subject: [PATCH 471/650] Fix formatting for Add-ADComputerServiceAccount. --- .../activedirectory/Add-ADComputerServiceAccount.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/activedirectory/Add-ADComputerServiceAccount.md b/docset/winserver2022-ps/activedirectory/Add-ADComputerServiceAccount.md index ecb9cc15c0..f34e03e27a 100644 --- a/docset/winserver2022-ps/activedirectory/Add-ADComputerServiceAccount.md +++ b/docset/winserver2022-ps/activedirectory/Add-ADComputerServiceAccount.md @@ -55,7 +55,7 @@ This command adds the service account `SvcAcct1` to a Computer Account `Computer ### EXAMPLE 2 -``` +```powershell Add-ADComputerServiceAccount -Computer ComputerAcct1 -ServiceAccount SvcAcct1, SvcAcct2 ``` From 6adc3c6d3209eaf3bfe2e660bc52cc1eb0ba938e Mon Sep 17 00:00:00 2001 From: Rob Derickson Date: Tue, 23 May 2023 22:18:55 -0400 Subject: [PATCH 472/650] Fix formatting for Add-ADDomainControllerPasswordReplicationPolicy. --- ...mainControllerPasswordReplicationPolicy.md | 215 +++++++++++------- 1 file changed, 128 insertions(+), 87 deletions(-) diff --git a/docset/winserver2022-ps/activedirectory/Add-ADDomainControllerPasswordReplicationPolicy.md b/docset/winserver2022-ps/activedirectory/Add-ADDomainControllerPasswordReplicationPolicy.md index ef5db9e042..7ef34244fb 100644 --- a/docset/winserver2022-ps/activedirectory/Add-ADDomainControllerPasswordReplicationPolicy.md +++ b/docset/winserver2022-ps/activedirectory/Add-ADDomainControllerPasswordReplicationPolicy.md @@ -16,68 +16,93 @@ Adds users, computers, and groups to the allowed or denied list of a read-only d ## SYNTAX ### AllowedPRP + ``` -Add-ADDomainControllerPasswordReplicationPolicy [-WhatIf] [-Confirm] -AllowedList - [-AuthType ] [-Credential ] [[-Identity] ] [-Server ] - [] +Add-ADDomainControllerPasswordReplicationPolicy [-WhatIf] [-Confirm] + -AllowedList [-AuthType ] [-Credential ] + [[-Identity] ] [-Server ] [] ``` ### DeniedPRP + ``` -Add-ADDomainControllerPasswordReplicationPolicy [-WhatIf] [-Confirm] [-AuthType ] - [-Credential ] -DeniedList [[-Identity] ] [-Server ] - [] +Add-ADDomainControllerPasswordReplicationPolicy [-WhatIf] [-Confirm] + [-AuthType ] [-Credential ] -DeniedList + [[-Identity] ] [-Server ] [] ``` ## DESCRIPTION -The **Add-ADDomainControllerPasswordReplicationPolicy** cmdlet adds one or more users, computers, and groups to the allowed or denied list of a read-only domain controller (RODC) password replication policy. - -The *Identity* parameter specifies the read-only domain controller (RODC) that uses the allowed and denied lists to apply the password replication policy. -You can identify a domain controller by its GUID, IPV4Address, global IPV6Address, or DNS host name. -You can also identify a domain controller by the name of the server object that represents the domain controller, the distinguished name of the NTDS settings object of the server object, the GUID of the NTDS settings object of the server object under the configuration partition, or the distinguished name of the computer object that represents the domain controller. -You can also set the *Identity* parameter to a domain controller object variable, such as `$`, or pass a domain controller object through the pipeline to the *Identity* parameter. -For example, you can use the **Get-ADDomainController** cmdlet to get a domain controller object and then pass the object through the pipeline to the **Add-ADDomainControllerPasswordReplicationPolicy** cmdlet. -You must specify a read-only domain controller. -If you specify a writeable domain controller for this parameter, the cmdlet returns a non-terminating error. - -The *AllowedList* parameter specifies the users, computers, and groups to add to the allowed list. -Similarly, the *DeniedList* parameter specifies the users, computers, and groups to add to the denied list. -You must specify either one or both of the *AllowedList* and *DeniedList* parameters. -You can identify a user, computer, or group by distinguished name, GUID, security identifier (SID) or Security Accounts Manager (SAM) account name. -You can also specify user, computer, or group variables, such as `$`. -If you are specifying more than one item, use a comma-separated list. -If a specified user, computer, or group is not on the allowed or denied list, the cmdlet does not return an error. + +The `Add-ADDomainControllerPasswordReplicationPolicy` cmdlet adds one or more users, computers, +and groups to the allowed or denied list of a read-only domain controller (RODC) password +replication policy. + +The **Identity** parameter specifies the read-only domain controller (RODC) that uses the allowed +and denied lists to apply the password replication policy. You can identify a domain controller by +its GUID, IPV4Address, global IPV6Address, or DNS host name. You can also identify a domain +controller by the name of the server object that represents the domain controller, the distinguished +name of the NTDS settings object of the server object, the GUID of the NTDS settings object of the +server object under the configuration partition, or the distinguished name of the computer object +that represents the domain controller. You can also set the **Identity** parameter to a domain +controller object variable, such as `$`, or pass a domain controller +object through the pipeline to the **Identity** parameter. For example, you can use the +`Get-ADDomainController` cmdlet to get a domain controller object and then pass the object through +the pipeline to the `Add-ADDomainControllerPasswordReplicationPolicy` cmdlet. You must specify a +read-only domain controller. If you specify a writeable domain controller for this parameter, the +cmdlet returns a non-terminating error. + +The **AllowedList** parameter specifies the users, computers, and groups to add to the allowed list. +Similarly, the **DeniedList** parameter specifies the users, computers, and groups to add to the +denied list. You must specify either one or both of the **AllowedList** and **DeniedList** +parameters. You can identify a user, computer, or group by distinguished name, GUID, security +identifier (SID) or Security Accounts Manager (SAM) account name. You can also specify user, +computer, or group variables, such as `$`. If you are specifying more than one +item, use a comma-separated list. If a specified user, computer, or group is not on the allowed or +denied list, the cmdlet does not return an error. ## EXAMPLES -### Example 1: Add user accounts with specified SamAccountNames to the allowed list -``` -PS C:\> Add-ADDomainControllerPasswordReplicationPolicy -Identity "USER01-RODC1" -AllowedList "PattiFuller", "DavidChew" +### Example 1 + +```powershell +$params = @{ + Identity = 'USER01-RODC1' + AllowedList = 'PattiFuller', 'DavidChew' +} +Add-ADDomainControllerPasswordReplicationPolicy @params ``` -This command adds user accounts with the specified SamAccountNames to the Allowed list on the RODC specified by the *Identity* parameter. +This command adds user accounts with the specified SamAccountNames to the Allowed list on the RODC +specified by the **Identity** parameter. -### Example 2: Add user accounts with specified SamAccountNames to the denied list -``` -PS C:\> Add-ADDomainControllerPasswordReplicationPolicy -Identity "USER02-RODC1" -DeniedList "ElisaDaugherty ", "EvanNarvaez" +### Example 2 + +```powershell +$params = @{ + Identity = 'USER02-RODC1' + DeniedList = 'ElisaDaugherty', 'EvanNarvaez' +} +Add-ADDomainControllerPasswordReplicationPolicy @params ``` -This command adds user accounts with the specified SamAccountNames to the Denied list on the RODC specified by the *Identity* parameter. +This command adds user accounts with the specified SamAccountNames to the Denied list on the RODC +specified by the **Identity** parameter. ## PARAMETERS ### -AllowedList -Specifies the users, computers, groups or other accounts to add to the list of accounts allowed to replicate their passwords to this RODC. -You can specify more than one value by using a comma-separated list. -The acceptable values for this parameter are: + +Specifies the users, computers, groups or other accounts to add to the list of accounts allowed to +replicate their passwords to this RODC. You can specify more than one value by using a +comma-separated list. The acceptable values for this parameter are: - A distinguished name -- A GUID (objectGUID) -- A security identifier (objectSid) -- A Security Accounts Manager (SAM) account name (sAMAccountName) +- A GUID (**objectGUID**) +- A security identifier (**objectSid**) +- A Security Accounts Manager (SAM) account name (**sAMAccountName**) ```yaml -Type: ADPrincipal[] +Type: Microsoft.ActiveDirectory.Management.ADPrincipal[] Parameter Sets: AllowedPRP Aliases: @@ -89,18 +114,19 @@ Accept wildcard characters: False ``` ### -AuthType + Specifies the authentication method to use. The acceptable values for this parameter are: -- Negotiate or 0 -- Basic or 1 +- `Negotiate` or `0` +- `Basic` or `1` -The default authentication method is Negotiate. +The default authentication method is `Negotiate`. -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. +A Secure Sockets Layer (SSL) connection is required for the `Basic` authentication method. ```yaml -Type: ADAuthType +Type: Microsoft.ActiveDirectory.Management.ADAuthType Parameter Sets: (All) Aliases: Accepted values: Negotiate, Basic @@ -113,10 +139,11 @@ Accept wildcard characters: False ``` ### -Confirm + Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf @@ -128,24 +155,24 @@ Accept wildcard characters: False ``` ### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory module for Windows PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. -To specify this parameter, you can type a user name, such as User1 or Domain01\User01 or you can specify a **PSCredential** object. -If you specify a user name for this parameter, the cmdlet prompts for a password. +Specifies the user account credentials to use to perform this task. The default credentials are the +credentials of the currently logged on user unless the cmdlet is run from an Active Directory module +for Windows PowerShell provider drive. If the cmdlet is run from such a provider drive, the account +associated with the drive is the default. -You can also create a **PSCredential** object by using a script or by using the **Get-Credential** cmdlet. -You can then set the *Credential* parameter to the **PSCredential** object. +To specify this parameter, you can type a user name, such as `User1` or `Domain01\User01` or you can +specify a **PSCredential** object. If you specify a user name for this parameter, the cmdlet prompts +for a password. -If the acting credentials do not have directory-level permission to perform the task, Active Directory module for Windows PowerShell returns a terminating error. +You can also create a **PSCredential** object by using a script or by using the `Get-Credential` +cmdlet. You can then set the **Credential** parameter to the **PSCredential** object. -Specifies the credentials for the security context under which the task is performed. -If this security context doesn't have directory level permissions to perform the task, then an error is returned by the directory. -If running under the context of an Active Directory module for Window PowerShell provider drive, the credentials information associated with the drive is used as the default value; otherwise, the currently logged on user security context is used. +If the acting credentials do not have directory-level permission to perform the task, Active +Directory module for Windows PowerShell returns a terminating error. ```yaml -Type: PSCredential +Type: System.Management.Automation.PSCredential Parameter Sets: (All) Aliases: @@ -157,17 +184,18 @@ Accept wildcard characters: False ``` ### -DeniedList -Specifies the users, computers, groups or other accounts to add to the list of accounts that are denied the right to replicate their passwords to this RODC. -You can specify more than one value by using a comma-separated list. -The acceptable values for this parameter are: + +Specifies the users, computers, groups or other accounts to add to the list of accounts that are +denied the right to replicate their passwords to this RODC. You can specify more than one value by +using a comma-separated list. The acceptable values for this parameter are: - A distinguished name -- A GUID (objectGUID) -- A security identifier (objectSid) -- A SAM account name (sAMAccountName) +- A GUID (**objectGUID**) +- A security identifier (**objectSid**) +- A Security Accounts Manager (SAM) account name (**sAMAccountName**) ```yaml -Type: ADPrincipal[] +Type: Microsoft.ActiveDirectory.Management.ADPrincipal[] Parameter Sets: DeniedPRP Aliases: @@ -179,14 +207,15 @@ Accept wildcard characters: False ``` ### -Identity -Specifies an Active Directory domain controller object by providing one of the following values. -The identifier in parentheses is the Lightweight Directory Access Protocol (LDAP) display name for the attribute. -The acceptable values for this parameter are: -- A GUID (objectGUID) +Specifies an Active Directory domain controller object by providing one of the following values. The +identifier in parentheses is the Lightweight Directory Access Protocol (LDAP) display name for the +attribute. The acceptable values for this parameter are: + +- A GUID (**objectGUID**) - An IPV4Address -- A Global IPV6Address -- A DNS Host Name (dNSHostName) +- A Global IPV6Address +- A DNS Host Name (**dNSHostName**) - A name of the server object - A distinguished name of the NTDS Settings object - A distinguished name of the server object that represents the domain controller @@ -197,10 +226,11 @@ The acceptable values for this parameter are: The cmdlet searches the default naming context or partition to find the object. If two or more objects are found, the cmdlet returns a non-terminating error. -This parameter can also get this object through the pipeline or you can set this parameter to an object instance. +This parameter can also get this object through the pipeline or you can set this parameter to an +object instance. ```yaml -Type: ADDomainController +Type: Microsoft.ActiveDirectory.Management.ADDomainController Parameter Sets: (All) Aliases: @@ -212,30 +242,35 @@ Accept wildcard characters: False ``` ### -Server -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory snapshot instance. -Specify the Active Directory Domain Services instance in one of the following ways: +Specifies the Active Directory Domain Services instance to connect to, by providing one of the +following values for a corresponding domain name or directory server. The service may be any of the +following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active +Directory snapshot instance. + +Specify the Active Directory Domain Services instance in one of the following ways: Domain name values: - Fully qualified domain name - NetBIOS name -Directory server values: +Directory server values: - Fully qualified directory server name - NetBIOS name - Fully qualified directory server name and port -The default value for this parameter is determined by one of the following methods in the order that they are listed: +The default value for this parameter is determined by one of the following methods in the order that +they are listed: - By using the **Server** value from objects passed through the pipeline -- By using the server information associated with the Active Directory Domain Services Windows PowerShell provider drive, when the cmdlet runs in that drive -- By using the domain of the computer that runs Windows PowerShell +- By using the server information associated with the Active Directory Domain Services Windows + PowerShell provider drive, when the cmdlet runs in that drive +- By using the domain of the computer running Windows PowerShell ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -247,11 +282,12 @@ Accept wildcard characters: False ``` ### -WhatIf + Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi @@ -263,25 +299,30 @@ Accept wildcard characters: False ``` ### CommonParameters -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). + +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). ## INPUTS ### Microsoft.ActiveDirectory.Management.ADDomainController -An RODC object is received by the *Identity* parameter. + +An RODC object is received by the **Identity** parameter. ## OUTPUTS -### None. +### None ## NOTES -* This cmdlet does not work with Active Directory Lightweight Directory Services. -* This cmdlet does not work with a read-only domain controller. -* This cmdlet does not work with an Active Directory snapshot. + +- This cmdlet does not work with Active Directory Lightweight Directory Services. +- This cmdlet does not work with a read-only domain controller. +- This cmdlet does not work with an Active Directory snapshot. ## RELATED LINKS [Get-ADDomainController](./Get-ADDomainController.md) [Get-ADDomainControllerPasswordReplicationPolicy](./Get-ADDomainControllerPasswordReplicationPolicy.md) - From 6be979196e4e32ebeeeb7b2e0d04805de1017baf Mon Sep 17 00:00:00 2001 From: Rob Derickson Date: Tue, 23 May 2023 22:32:02 -0400 Subject: [PATCH 473/650] Fix formatting for Add-ADFineGrainedPasswordPolicy. --- .../Add-ADFineGrainedPasswordPolicySubject.md | 241 +++++++++++------- 1 file changed, 146 insertions(+), 95 deletions(-) diff --git a/docset/winserver2022-ps/activedirectory/Add-ADFineGrainedPasswordPolicySubject.md b/docset/winserver2022-ps/activedirectory/Add-ADFineGrainedPasswordPolicySubject.md index 19c74cc223..bd9f4c3c2d 100644 --- a/docset/winserver2022-ps/activedirectory/Add-ADFineGrainedPasswordPolicySubject.md +++ b/docset/winserver2022-ps/activedirectory/Add-ADFineGrainedPasswordPolicySubject.md @@ -17,69 +17,88 @@ Applies a fine-grained password policy to one more users and groups. ``` Add-ADFineGrainedPasswordPolicySubject [-WhatIf] [-Confirm] [-AuthType ] - [-Credential ] [-Identity] [-Partition ] [-PassThru] - [-Server ] [-Subjects] [] + [-Credential ] [-Identity] + [-Partition ] [-PassThru] [-Server ] [-Subjects] + [] ``` ## DESCRIPTION -The **Add-ADFineGrainedPasswordPolicySubject** cmdlet applies a fine-grained password policy to one or more global security groups and users. -The *Identity* parameter specifies the fine-grained password policy to apply. -You can identify a fine-grained password policy by its distinguished name, GUID or name. -You can also set the *Identity* parameter to a fine-grained password policy object variable, such as `$`, or pass a fine-grained password policy object through the pipeline operator to the *Identity* parameter. -For example, you can use the **Get-ADFineGrainedPasswordPolicy** cmdlet to get a fine-grained password policy object and then pass the object through the pipeline operator to the **Add-ADFineGrainedPasswordPolicySubject** cmdlet. - -The *Subjects* parameter specifies the users and global security groups. -You can identify a user or global security group by its distinguished name (DN), GUID, security identifier (SID), or Security Account Manager (SAM) account name. -You can also specify user and global security group object variables, such as `$`. -If you are specifying more than one user or group, use a comma-separated list. -To pass user and global security group objects through the pipeline to the *Subjects* parameter, use the Get-ADUser or the **Get-ADGroup** cmdlets to retrieve the user or group objects, and then pass these objects through the pipeline operator to the **Add-ADFineGrainedPasswordPolicySubject** cmdlet. +The `Add-ADFineGrainedPasswordPolicySubject` cmdlet applies a fine-grained password policy to one or +more global security groups and users. + +The **Identity** parameter specifies the fine-grained password policy to apply. You can identify a +fine-grained password policy by its distinguished name, GUID or name. You can also set the +**Identity** parameter to a fine-grained password policy object variable, such as +`$`, or pass a fine-grained password policy object through the pipeline +operator to the **Identity** parameter. For example, you can use the +`Get-ADFineGrainedPasswordPolicy` cmdlet to get a fine-grained password policy object and then pass +the object through the pipeline operator to the `Add-ADFineGrainedPasswordPolicySubject` cmdlet. + +The **Subjects** parameter specifies the users and global security groups. You can identify a user +or global security group by its distinguished name (DN), GUID, security identifier (SID), or +Security Account Manager (SAM) account name. You can also specify user and global security group +object variables, such as `$`. If you are specifying more than one user or group, +use a comma-separated list. To pass user and global security group objects through the pipeline to +the **Subjects** parameter, use the `Get-ADUser` or the `Get-ADGroup` cmdlets to retrieve the user +or group objects, and then pass these objects through the pipeline operator to the +`Add-ADFineGrainedPasswordPolicySubject` cmdlet. ## EXAMPLES -### Example 1: Apply a fine-grained password policy to a global security group -``` -PS C:\> Add-ADFineGrainedPasswordPolicySubject -Identity DomainUsersPSO -Subjects 'Domain Users' +### EXAMPLE 1 + +```powershell +Add-ADFineGrainedPasswordPolicySubject -Identity DomainUsersPSO -Subjects 'Domain Users' ``` -This command applies the fine-grained password policy named DomainUsersPSO to the Domain Users global security group. +This command applies the fine-grained password policy named `DomainUsersPSO` to the `Domain Users` +global security group. -### Example 2: Apply a fine-grained password policy to multiple users -``` -PS C:\> Add-ADFineGrainedPasswordPolicySubject -Identity DlgtdAdminsPSO -Subjects BobKe,KimAb +### EXAMPLE 2 + +```powershell +Add-ADFineGrainedPasswordPolicySubject -Identity DlgtdAdminsPSO -Subjects BobKe, KimAb ``` -This command applies the fine-grained password policy named DlgtdAdminsPSO to users with the SAM account names BobKe and KimAb. +This command applies the fine-grained password policy named `DlgtdAdminsPSO` to users with the SAM +account names `BobKe` and `KimAb`. -### Example 3: Apply a fine-grained password policy to a security group -``` -PS C:\> Add-ADFineGrainedPasswordPolicySubject -Identity DlgtdAdminsPSO -Subjects DlgtdAdminGroup +### EXAMPLE 3 + +```powershell +Add-ADFineGrainedPasswordPolicySubject -Identity DlgtdAdminsPSO -Subjects DlgtdAdminGroup ``` -This command applies the fine-grained password policy named DlgtdAdminsPSO to the group DlgtdAdminGroup. +This command applies the fine-grained password policy named `DlgtdAdminsPSO` to the group +`DlgtdAdminGroup`. -### Example 4: Apply a fine-grained password policy to users with a specified name -``` -PS C:\> Get-ADUser -Filter "lastname -eq 'Fuller'" | Add-ADFineGrainedPasswordPolicySubject -Identity DlgtdAdminsPSO +### EXAMPLE 4 + +```powershell +Get-ADUser -Filter "lastname -eq 'Fuller'" | + Add-ADFineGrainedPasswordPolicySubject -Identity DlgtdAdminsPSO ``` -This command applies the fine-grained password policy named DlgtdAdminsPSO to any users whose last name is Fuller. +This command applies the fine-grained password policy named `DlgtdAdminsPSO` to any users whose last +name is `Fuller`. ## PARAMETERS ### -AuthType + Specifies the authentication method to use. The acceptable values for this parameter are: -- Negotiate or 0 -- Basic or 1 +- `Negotiate` or `0` +- `Basic` or `1` -The default authentication method is Negotiate. +The default authentication method is `Negotiate`. -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. +A Secure Sockets Layer (SSL) connection is required for the `Basic` authentication method. ```yaml -Type: ADAuthType +Type: Microsoft.ActiveDirectory.Management.ADAuthType Parameter Sets: (All) Aliases: Accepted values: Negotiate, Basic @@ -92,10 +111,11 @@ Accept wildcard characters: False ``` ### -Confirm + Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf @@ -107,20 +127,24 @@ Accept wildcard characters: False ``` ### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. -To specify this parameter, you can type a user name, such as User1 or Domain01\User01 or you can specify a **PSCredential** object. -If you specify a user name for this parameter, the cmdlet prompts for a password. +Specifies the user account credentials to use to perform this task. The default credentials are the +credentials of the currently logged on user unless the cmdlet is run from an Active Directory module +for Windows PowerShell provider drive. If the cmdlet is run from such a provider drive, the account +associated with the drive is the default. -You can also create a **PSCredential** object by using a script or by using the **Get-Credential** cmdlet. -You can then set the *Credential* parameter to the **PSCredential** object. +To specify this parameter, you can type a user name, such as `User1` or `Domain01\User01` or you can +specify a **PSCredential** object. If you specify a user name for this parameter, the cmdlet prompts +for a password. -If the acting credentials do not have directory-level permission to perform the task, Active Directory PowerShell returns a terminating error. +You can also create a **PSCredential** object by using a script or by using the `Get-Credential` +cmdlet. You can then set the **Credential** parameter to the **PSCredential** object. + +If the acting credentials do not have directory-level permission to perform the task, Active +Directory module for Windows PowerShell returns a terminating error. ```yaml -Type: PSCredential +Type: System.Management.Automation.PSCredential Parameter Sets: (All) Aliases: @@ -132,21 +156,23 @@ Accept wildcard characters: False ``` ### -Identity -Specifies an Active Directory fine-grained password policy object by providing one of the following property values. -The identifier in parentheses is the Lightweight Directory Access Protocol (LDAP) display name for the attribute. -The acceptable values for this parameter are: + +Specifies an Active Directory fine-grained password policy object by providing one of the following +property values. The identifier in parentheses is the Lightweight Directory Access Protocol (LDAP) +display name for the attribute. The acceptable values for this parameter are: - A distinguished name -- A GUID (objectGUID) +- A GUID (**objectGUID**) - A name (name) The cmdlet searches the default naming context or partition to find the object. If two or more objects are found, the cmdlet returns a non-terminating error. -This parameter can also get this object through the pipeline or you can set this parameter to a fine-grained password policy object instance. +This parameter can also get this object through the pipeline or you can set this parameter to a +fine-grained password policy object instance. ```yaml -Type: ADFineGrainedPasswordPolicy +Type: Microsoft.ActiveDirectory.Management.ADFineGrainedPasswordPolicy Parameter Sets: (All) Aliases: @@ -158,30 +184,40 @@ Accept wildcard characters: False ``` ### -Partition -Specifies the distinguished name of an Active Directory partition. -The distinguished name must be one of the naming contexts on the current directory server. -The cmdlet searches this partition to find the object defined by the *Identity* parameter. -In many cases, a default value is used for the *Partition* parameter if no value is specified. -The rules for determining the default value are given below. -Note that rules listed first are evaluated first and once a default value can be determined, no further rules are evaluated. - -In Active Directory Domain Services (AD DS) environments, a default value for *Partition* is set in the following cases: - -- If the *Identity* parameter is set to a distinguished name, the default value of *Partition* is automatically generated from this distinguished name. -- If running cmdlets from an Active Directory provider drive, the default value of *Partition* is automatically generated from the current path in the drive. -- If none of the previous cases apply, the default value of *Partition* is set to the default partition or naming context of the target domain. - -In Active Directory Lightweight Directory Services (AD LDS) environments, a default value for *Partition* is set in the following cases: - -- If the *Identity* parameter is set to a distinguished name, the default value of *Partition* is automatically generated from this distinguished name. -- If running cmdlets from an Active Directory provider drive, the default value of *Partition* is automatically generated from the current path in the drive. -- If the target AD LDS instance has a default naming context, the default value of *Partition* is set to the default naming context. -To specify a default naming context for an AD LDS environment, set the **msDS-defaultNamingContext** property of the Active Directory directory service agent (DSA) object (nTDSDSA) for the AD LDS instance. -- If none of the previous cases apply, the *Partition* parameter does not take any default value. +Specifies the distinguished name of an Active Directory partition. The distinguished name must be +one of the naming contexts on the current directory server. The cmdlet searches this partition to +find the object defined by the **Identity** parameter. + +In many cases, a default value is used for the **Partition** parameter if no value is specified. The +rules for determining the default value are given below. Note that rules listed first are evaluated +first and once a default value can be determined, no further rules are evaluated. + +In Active Directory Domain Services environments, a default value for **Partition** is set in the +following cases: + +- If the **Identity** parameter is set to a distinguished name, the default value of **Partition** + is automatically generated from this distinguished name. +- If running cmdlets from an Active Directory provider drive, the default value of **Partition** is + automatically generated from the current path in the drive. +- If none of the previous cases apply, the default value of **Partition** is set to the default + partition or naming context of the target domain. + +In Active Directory Lightweight Directory Services (AD LDS) environments, a default value for +**Partition** is set in the following cases: + +- If the **Identity** parameter is set to a distinguished name, the default value of **Partition** + is automatically generated from this distinguished name. +- If running cmdlets from an Active Directory provider drive, the default value of **Partition** is + automatically generated from the current path in the drive. +- If the target AD LDS instance has a default naming context, the default value of **Partition** is + set to the default naming context. To specify a default naming context for an AD LDS environment, + set the **msDS-defaultNamingContext** property of the Active Directory directory service agent + (DSA) object (**nTDSDSA**) for the AD LDS instance. +- If none of the previous cases apply, the **Partition** parameter will not take any default value. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -193,11 +229,12 @@ Accept wildcard characters: False ``` ### -PassThru + Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -209,30 +246,35 @@ Accept wildcard characters: False ``` ### -Server -Specifies the AD DS instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: AD LDS, AD DS, or Active Directory snapshot instance. -Specify the AD DS instance in one of the following ways: +Specifies the Active Directory Domain Services instance to connect to, by providing one of the +following values for a corresponding domain name or directory server. The service may be any of the +following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active +Directory snapshot instance. + +Specify the Active Directory Domain Services instance in one of the following ways: Domain name values: - Fully qualified domain name - NetBIOS name -Directory server values: +Directory server values: - Fully qualified directory server name - NetBIOS name - Fully qualified directory server name and port -The default value for this parameter is determined by one of the following methods in the order that they are listed: +The default value for this parameter is determined by one of the following methods in the order that +they are listed: - By using the **Server** value from objects passed through the pipeline -- By using the server information associated with the Active Directory Domain Services Windows PowerShell provider drive, when the cmdlet runs in that drive +- By using the server information associated with the Active Directory Domain Services Windows + PowerShell provider drive, when the cmdlet runs in that drive - By using the domain of the computer running Windows PowerShell ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -244,21 +286,22 @@ Accept wildcard characters: False ``` ### -Subjects + Specifies one or more users or groups. To specify more than one user or group, use a comma-separated list. You can identify a user or group by one of the following property values: -- Distinguished name (DN) -- GUID (objectGUID) -- Security Identifier (objectSid) -- SAM account name (sAMAccountName) +- Distinguished name (DN) +- GUID (**objectGUID**) +- Security Identifier (**objectSid**) +- SAM account name (**sAMAccountName**) Note: The identifier in parentheses is the LDAP display name for the attribute. You can also provide objects to this parameter directly. ```yaml -Type: ADPrincipal[] +Type: Microsoft.ActiveDirectory.Management.ADPrincipal[] Parameter Sets: (All) Aliases: @@ -270,11 +313,12 @@ Accept wildcard characters: False ``` ### -WhatIf + Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi @@ -286,14 +330,20 @@ Accept wildcard characters: False ``` ### CommonParameters -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). + +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). ## INPUTS ### Microsoft.ActiveDirectory.Management.ADFineGrainedPasswordPolicy, Microsoft.ActiveDirectory.Management.ADPrincipal -A fine-grained password policy object is received by the *Identity* parameter. -One or more principal objects that represent users and security group objects are received by the *Subjects* parameter. -Derived principal types, such as the following, are also accepted by the *Subjects* parameter: + +A fine-grained password policy object is received by the **Identity** parameter. One or more +principal objects that represent users and security group objects are received by the **Subjects** +parameter. Derived principal types, such as the following, are also accepted by the **Subjects** +parameter: - **Microsoft.ActiveDirectory.Management.ADGroup** - **Microsoft.ActiveDirectory.Management.ADUser** @@ -301,17 +351,18 @@ Derived principal types, such as the following, are also accepted by the *Subjec ## OUTPUTS ### None or Microsoft.ActiveDirectory.Management.ADFineGrainedPasswordPolicy -Returns the modified fine-grained password policy object when the *PassThru* parameter is specified. -By default, this cmdlet does not generate any output. + +Returns the modified fine-grained password policy object when the **PassThru** parameter is +specified. By default, this cmdlet does not generate any output. ## NOTES -* This cmdlet does not work with AD LDS. -* This cmdlet does not work with a read-only domain controller. -* This cmdlet does not work with an Active Directory snapshot. + +- This cmdlet does not work with AD LDS. +- This cmdlet does not work with a read-only domain controller. +- This cmdlet does not work with an Active Directory snapshot. ## RELATED LINKS [Get-ADFineGrainedPasswordPolicySubject](./Get-ADFineGrainedPasswordPolicySubject.md) [Remove-ADFineGrainedPasswordPolicySubject](./Remove-ADFineGrainedPasswordPolicySubject.md) - From c87a22e377f740d0288f73f1de28500cf472f8b9 Mon Sep 17 00:00:00 2001 From: Rob Derickson Date: Wed, 24 May 2023 19:33:26 -0400 Subject: [PATCH 474/650] Fix formatting for Add-ADGroupMember. Remove redundant example --- .../activedirectory/Add-ADGroupMember.md | 309 ++++++++++-------- 1 file changed, 174 insertions(+), 135 deletions(-) diff --git a/docset/winserver2022-ps/activedirectory/Add-ADGroupMember.md b/docset/winserver2022-ps/activedirectory/Add-ADGroupMember.md index ccb0af15b4..b857b7025c 100644 --- a/docset/winserver2022-ps/activedirectory/Add-ADGroupMember.md +++ b/docset/winserver2022-ps/activedirectory/Add-ADGroupMember.md @@ -16,85 +16,103 @@ Adds one or more members to an Active Directory group. ## SYNTAX ``` -Add-ADGroupMember [-WhatIf] [-Confirm] [-AuthType ] [-Credential ] - [-Identity] [-Members] [-MemberTimeToLive ] [-Partition ] - [-PassThru] [-Server ] [-DisablePermissiveModify] [] +Add-ADGroupMember [-WhatIf] [-Confirm] [-AuthType ] + [-Credential ] [-Identity] [-Members] + [-MemberTimeToLive ] [-Partition ] [-PassThru] [-Server ] + [-DisablePermissiveModify] [] ``` ## DESCRIPTION -The **Add-ADGroupMember** cmdlet adds one or more users, groups, service accounts, or computers as new members of an Active Directory group. -The *Identity* parameter specifies the Active Directory group that receives the new members. -You can identify a group by its distinguished name, GUID, security identifier, or Security Account Manager (SAM) account name. -You can also specify group object variable, such as `$`, or pass a group object through the pipeline to the *Identity* parameter. -For example, you can use the **Get-ADGroup** cmdlet to get a group object and then pass the object through the pipeline to the **Add-ADGroupMember** cmdlet. +The `Add-ADGroupMember` cmdlet adds one or more users, groups, service accounts, or computers as +new members of an Active Directory group. -The *Members* parameter specifies the new members to add to a group. -You can identify a new member by its distinguished name, GUID, security identifier, or SAM account name. -You can also specify user, computer, and group object variables, such as `$`. -If you are specifying more than one new member, use a comma-separated list. -You cannot pass user, computer, or group objects through the pipeline to this cmdlet. -To add user, computer, or group objects to a group by using the pipeline, use the **Add-ADPrincipalGroupMembership** cmdlet. +The **Identity** parameter specifies the Active Directory group that receives the new members. You +can identify a group by its distinguished name, GUID, security identifier, or Security Account +Manager (SAM) account name. You can also specify group object variable, such as +`$`, or pass a group object through the pipeline to the **Identity** parameter. +For example, you can use the `Get-ADGroup` cmdlet to get a group object and then pass the object +through the pipeline to the `Add-ADGroupMember` cmdlet. -For Active Directory Lightweight Directory Services (AD LDS) environments, the *Partition* parameter must be specified except in the following two conditions: +The **Members** parameter specifies the new members to add to a group. You can identify a new member +by its distinguished name, GUID, security identifier, or SAM account name. You can also specify +user, computer, and group object variables, such as `$`. If you are specifying more +than one new member, use a comma-separated list. You cannot pass user, computer, or group objects +through the pipeline to this cmdlet. To add user, computer, or group objects to a group by using the +pipeline, use the `Add-ADPrincipalGroupMembership` cmdlet. + +For Active Directory Lightweight Directory Services (AD LDS) environments, the **Partition** +parameter must be specified except in the following two conditions: - The cmdlet is run from an Active Directory provider drive. - A default naming context or partition is defined for the AD LDS environment. -To specify a default naming context for an AD LDS environment, set the **msDS-defaultNamingContext** property of the Active Directory directory service agent object (nTDSDSA) for the AD LDS instance. +- To specify a default naming context for an AD LDS environment, set the + **msDS-defaultNamingContext** property of the Active Directory directory service agent object + (nTDSDSA) for the AD LDS instance. ## EXAMPLES -### Example 1: Add specified user accounts to a group -``` -PS C:\> Add-ADGroupMember -Identity SvcAccPSOGroup -Members SQL01,SQL02 -``` - -This command adds the user accounts with the SAM account names SQL01 and SQL02 to the group SvcAccPSOGroup. +### EXAMPLE 1 -### Example 2: Add all user accounts to a group -``` -PS C:\> Add-ADGroupMember -cmdlet Add-ADGroupMember at command pipeline position 1 -Supply values for the following parameters: -Identity: RodcAdmins -Members[0]: DavidChew -Members[1]: PattiFuller -Members[2]: +```powershell +Add-ADGroupMember -Identity SvcAccPSOGroup -Members SQL01, SQL02 ``` -This command adds user accounts with SAM account names DavidChew and PattiFuller to the group RodcAdmins. +This command adds the user accounts with the SAM account names `SQL01` and `SQL02` to the group +`SvcAccPSOGroup`. -### Example 3: Add an account by distinguished name to a filtered group -``` -PS C:\> Get-ADGroup -Server localhost:60000 -SearchBase "OU=AccountDeptOU,DC=AppNC" -Filter "name -like 'AccountLeads'" | Add-ADGroupMember -Members "CN=PattiFuller,OU=AccountDeptOU,DC=AppNC" -``` - -This command gets a group from the organizational unit OU=AccountDeptOU,DC=AppNC in the AD LDS instance localhost:60000 that has the name AccountLeads, and then pipes it to **Add-ADGroupMember**, which then adds the user account with the distinguished name CN=PattiFuller,OU=AccountDeptOU,DC=AppNC to it. +### EXAMPLE 2 -### Example 4: Add a user from a domain to a group in another domain +```powershell +$params = @{ + Server = 'localhost:60000' + SearchBase = 'OU=AccountDeptOU,DC=AppNC' + Filter = "name -like 'AccountLeads'" +} +Get-ADGroup @params | + Add-ADGroupMember -Members 'CN=PattiFuller,OU=AccountDeptOU,DC=AppNC' ``` -PS C:\> $User = Get-ADUser -Identity "CN=Chew David,OU=UserAccounts,DC=NORTHAMERICA,DC=FABRIKAM,DC=COM" -Server "northamerica.fabrikam.com" -PS C:\> $Group = Get-ADGroup -Identity "CN=AccountLeads,OU=UserAccounts,DC=EUROPE,DC=FABRIKAM,DC=COM" -Server "europe.fabrikam.com" -PS C:\> Add-ADGroupMember -Identity $Group -Members $User -Server "europe.fabrikam.com" + +This command gets a group from the organizational unit `OU=AccountDeptOU,DC=AppNC` in the AD LDS +instance `localhost:60000` that has the name `AccountLeads`, and then pipes it to +`Add-ADGroupMember`, which then adds the user account with the distinguished name +`CN=PattiFuller,OU=AccountDeptOU,DC=AppNC` to it. + +### EXAMPLE 3 + +```powershell +$userParams = @{ + Identity = 'CN=Chew David,OU=UserAccounts,DC=NORTHAMERICA,DC=FABRIKAM,DC=COM' + Server = 'northamerica.fabrikam.com' +} +$User = Get-ADUser @userParams +$groupParams = @{ + Identity = 'CN=AccountLeads,OU=UserAccounts,DC=EUROPE,DC=FABRIKAM,DC=COM' + Server = 'europe.fabrikam.com' +} +$Group = Get-ADGroup @groupParams +Add-ADGroupMember -Identity $Group -Members $User -Server "europe.fabrikam.com" ``` -This command adds the user CN=Chew David,OU=UserAccounts from the North America domain to the group CN=AccountLeads,OU=UserAccounts in the Europe domain. +This command adds the user `CN=Chew David,OU=UserAccounts` from the North America domain to the +group `CN=AccountLeads,OU=UserAccounts` in the Europe domain. ## PARAMETERS ### -AuthType + Specifies the authentication method to use. The acceptable values for this parameter are: -- Negotiate or 0 -- Basic or 1 +- `Negotiate` or `0` +- `Basic` or `1` -The default authentication method is Negotiate. +The default authentication method is `Negotiate`. -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. +A Secure Sockets Layer (SSL) connection is required for the `Basic` authentication method. ```yaml -Type: ADAuthType +Type: Microsoft.ActiveDirectory.Management.ADAuthType Parameter Sets: (All) Aliases: Accepted values: Negotiate, Basic @@ -107,10 +125,11 @@ Accept wildcard characters: False ``` ### -Confirm + Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf @@ -122,20 +141,24 @@ Accept wildcard characters: False ``` ### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory module for Windows PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. -To specify this parameter, you can type a user name, such as User1 or Domain01\User01 or you can specify a **PSCredential** object. -If you specify a user name for this parameter, the cmdlet prompts for a password. +Specifies the user account credentials to use to perform this task. The default credentials are the +credentials of the currently logged on user unless the cmdlet is run from an Active Directory module +for Windows PowerShell provider drive. If the cmdlet is run from such a provider drive, the account +associated with the drive is the default. -You can also create a **PSCredential** object by using a script or by using the **Get-Credential** cmdlet. -You can then set the *Credential* parameter to the **PSCredential** object. +To specify this parameter, you can type a user name, such as `User1` or `Domain01\User01` or you can +specify a **PSCredential** object. If you specify a user name for this parameter, the cmdlet prompts +for a password. -If the acting credentials do not have directory-level permission to perform the task, Active Directory module for Windows PowerShell returns a terminating error. +You can also create a **PSCredential** object by using a script or by using the `Get-Credential` +cmdlet. You can then set the **Credential** parameter to the **PSCredential** object. + +If the acting credentials do not have directory-level permission to perform the task, Active +Directory module for Windows PowerShell returns a terminating error. ```yaml -Type: PSCredential +Type: System.Management.Automation.PSCredential Parameter Sets: (All) Aliases: @@ -147,14 +170,15 @@ Accept wildcard characters: False ``` ### -DisablePermissiveModify -Group membership updates use permissive modify by default. This suppresses an error when adding a member that is already member of the group. -When this parameter is used, an error "The specified account name is already a member of the group" is returned. -This parameter is available in Windows Server 2019 with the September 2020 Updates. +Group membership updates use permissive modify by default. This suppresses an error when adding a +member that is already member of the group. When this parameter is used, an error "The specified +account name is already a member of the group" is returned. +This parameter is available in Windows Server 2019 with the September 2020 Updates. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -166,22 +190,24 @@ Accept wildcard characters: False ``` ### -Identity -Specifies an Active Directory group object by providing one of the following values. -The identifier in parentheses is the Lightweight Directory Access Protocol (LDAP) display name for the attribute. + +Specifies an Active Directory group object by providing one of the following values. The identifier +in parentheses is the Lightweight Directory Access Protocol (LDAP) display name for the attribute. The acceptable values for this parameter are: - A distinguished name -- A GUID (objectGUID) -- A security identifier (objectSid) -- A Security Account Manager account name (sAMAccountName) +- A GUID (**objectGUID**) +- A security identifier (**objectSid**) +- Security Accounts Manager account name (**sAMAccountName**) -The cmdlet searches the default naming context or partition to find the object. -If two or more objects are found, the cmdlet returns a non-terminating error. +The cmdlet searches the default naming context or partition to find the object. If two or more +objects are found, the cmdlet returns a non-terminating error. -This parameter can also get this object through the pipeline or you can set this parameter to an object instance. +This parameter can also get this object through the pipeline or you can set this parameter to an +object instance. ```yaml -Type: ADGroup +Type: Microsoft.ActiveDirectory.Management.ADGroup Parameter Sets: (All) Aliases: @@ -193,10 +219,11 @@ Accept wildcard characters: False ``` ### -MemberTimeToLive + Specifies a Time to Live (TTL) for the new group members. ```yaml -Type: TimeSpan +Type: System.TimeSpan Parameter Sets: (All) Aliases: @@ -208,30 +235,33 @@ Accept wildcard characters: False ``` ### -Members + Specifies an array of user, group, and computer objects in a comma-separated list to add to a group. -To identify each object, use one of the following property values. -Note: The identifier in parentheses is the LDAP display name. -The acceptable values for this parameter are: +To identify each object, use one of the following property values. The identifier in parentheses is +the LDAP display name. The acceptable values for this parameter are: - Distinguished name -- GUID (objectGUID) -- Security identifier (objectSid) -- SAM account name (sAMAccountName) +- GUID (**objectGUID**) +- Security identifier (**objectSid**) +- SAM account name (**sAMAccountName**) You can also provide objects to this parameter directly. The following examples show how to specify this parameter. -This example specifies a user and group to add by specifying the distinguished name and the SAM account name properties. +This example specifies a user and group to add by specifying the distinguished name and the SAM +account name properties. `-Members "CN=SaraDavis,CN=employees,CN=Users,DC=contoso,DC=com", "saradavisreports"` -This example specifies a user and a group object that are defined in the current Windows PowerShell session as input for the parameter. +This example specifies a user and a group object that are defined in the current Windows PowerShell +session as input for the parameter. `-Members $userObject, $GroupObject` -The objects specified for this parameter are processed as **Microsoft.ActiveDirectory.Management.ADPrincipal** objects. -Derived types, such as the following are also received by this parameter. +The objects specified for this parameter are processed as +**Microsoft.ActiveDirectory.Management.ADPrincipal** objects. Derived types, such as the following +are also received by this parameter. - **Microsoft.ActiveDirectory.Management.ADUser** - **Microsoft.ActiveDirectory.Management.ADComputer** @@ -241,7 +271,7 @@ Derived types, such as the following are also received by this parameter. You cannot pass objects through the pipeline to this parameter. ```yaml -Type: ADPrincipal[] +Type: Microsoft.ActiveDirectory.Management.ADPrincipal[] Parameter Sets: (All) Aliases: @@ -253,30 +283,40 @@ Accept wildcard characters: False ``` ### -Partition -Specifies the distinguished name of an Active Directory partition. -The distinguished name must be one of the naming contexts on the current directory server. -The cmdlet searches this partition to find the object defined by the *Identity* parameter. - -In many cases, a default value is used for the *Partition* parameter if no value is specified. -The rules for determining the default value are given below. -Note that rules listed first are evaluated first and once a default value can be determined, no further rules are evaluated. - -In Active Directory Domain Services (AD DS) environments, a default value for *Partition* is set in the following cases: - -- If the *Identity* parameter is set to a distinguished name, the default value of *Partition* is automatically generated from this distinguished name. -- If running cmdlets from an Active Directory provider drive, the default value of *Partition* is automatically generated from the current path in the drive. -- If none of the previous cases apply, the default value of *Partition* is set to the default partition or naming context of the target domain. - -In Active Directory Lightweight Directory Services (AD LDS) environments, a default value for *Partition* is set in the following cases: -- If the *Identity* parameter is set to a distinguished name, the default value of *Partition* is automatically generated from this distinguished name. -- If running cmdlets from an Active Directory provider drive, the default value of *Partition* is automatically generated from the current path in the drive. -- If the target AD LDS instance has a default naming context, the default value of *Partition* is set to the default naming context. -To specify a default naming context for an AD LDS environment, set the **msDS-defaultNamingContext** property of the Active Directory directory service agent object (**nTDSDSA**) for the AD LDS instance. -- If none of the previous cases apply, the *Partition* parameter does not take a default value. +Specifies the distinguished name of an Active Directory partition. The distinguished name must be +one of the naming contexts on the current directory server. The cmdlet searches this partition to +find the object defined by the **Identity** parameter. + +In many cases, a default value is used for the **Partition** parameter if no value is specified. The +rules for determining the default value are given below. Note that rules listed first are evaluated +first and once a default value can be determined, no further rules are evaluated. + +In Active Directory Domain Services environments, a default value for **Partition** is set in the +following cases: + +- If the **Identity** parameter is set to a distinguished name, the default value of **Partition** + is automatically generated from this distinguished name. +- If running cmdlets from an Active Directory provider drive, the default value of **Partition** is + automatically generated from the current path in the drive. +- If none of the previous cases apply, the default value of **Partition** is set to the default + partition or naming context of the target domain. + +In Active Directory Lightweight Directory Services (AD LDS) environments, a default value for +**Partition** is set in the following cases: + +- If the **Identity** parameter is set to a distinguished name, the default value of **Partition** + is automatically generated from this distinguished name. +- If running cmdlets from an Active Directory provider drive, the default value of **Partition** is + automatically generated from the current path in the drive. +- If the target AD LDS instance has a default naming context, the default value of **Partition** is + set to the default naming context. To specify a default naming context for an AD LDS environment, + set the **msDS-defaultNamingContext** property of the Active Directory directory service agent + (DSA) object (**nTDSDSA**) for the AD LDS instance. +- If none of the previous cases apply, the **Partition** parameter will not take any default value. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -288,11 +328,12 @@ Accept wildcard characters: False ``` ### -PassThru + Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -304,10 +345,13 @@ Accept wildcard characters: False ``` ### -Server -Specifies the Active Directory Domain Services (AD DS) instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services (AD LDS), AD DS, or Active Directory snapshot instance. -Specify the AD DS instance in one of the following ways: +Specifies the Active Directory Domain Services instance to connect to, by providing one of the +following values for a corresponding domain name or directory server. The service may be any of the +following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active +Directory snapshot instance. + +Specify the Active Directory Domain Services instance in one of the following ways: Domain name values: @@ -320,14 +364,16 @@ Directory server values: - NetBIOS name - Fully qualified directory server name and port -The default value for this parameter is determined by one of the following methods in the order that they are listed: +The default value for this parameter is determined by one of the following methods in the order that +they are listed: - By using the **Server** value from objects passed through the pipeline -- By using the server information associated with the AD DS Windows PowerShell provider drive, when the cmdlet runs in that drive +- By using the server information associated with the Active Directory Domain Services Windows + PowerShell provider drive, when the cmdlet runs in that drive - By using the domain of the computer running Windows PowerShell ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -338,27 +384,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DisablePermissiveModify -Group membership updates use permissive modify by default. This suppresses an error when adding a member that is already member of the group. -When this parameter is used, an error "The specified account name is already a member of the group" is returned. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -WhatIf + Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi @@ -370,23 +402,31 @@ Accept wildcard characters: False ``` ### CommonParameters -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). + +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). ## INPUTS ### Microsoft.ActiveDirectory.Management.ADGroup -A group object is received by the *Identity* parameter. + +A group object is received by the **Identity** parameter. ## OUTPUTS ### None or Microsoft.ActiveDirectory.Management.ADGroup -Returns the modified group object when the *PassThru* parameter is specified. -By default, this cmdlet does not generate any output. + +Returns the modified group object when the **PassThru** parameter is specified. By default, this +cmdlet does not generate any output. ## NOTES -* This cmdlet does not work with a read-only domain controller. -* This cmdlet does not work with an Active Directory snapshot. -* This cmdlet will allow you to add a group as a member of itself which could lead to unstable behavior. + +- This cmdlet does not work with a read-only domain controller. +- This cmdlet does not work with an Active Directory snapshot. +- This cmdlet will allow you to add a group as a member of itself which could lead to unstable + behavior. ## RELATED LINKS @@ -401,4 +441,3 @@ By default, this cmdlet does not generate any output. [Remove-ADGroupMember](./Remove-ADGroupMember.md) [Remove-ADPrincipalGroupMembership](./Remove-ADPrincipalGroupMembership.md) - From 5292732a58a9f50c5ac1a1e1267ae3019dd8d052 Mon Sep 17 00:00:00 2001 From: Rob Derickson Date: Wed, 24 May 2023 19:48:09 -0400 Subject: [PATCH 475/650] Fix formatting for Add-ADPrincipalGroupMembership. --- .../Add-ADPrincipalGroupMembership.md | 277 ++++++++++-------- 1 file changed, 154 insertions(+), 123 deletions(-) diff --git a/docset/winserver2022-ps/activedirectory/Add-ADPrincipalGroupMembership.md b/docset/winserver2022-ps/activedirectory/Add-ADPrincipalGroupMembership.md index 3717a2f00a..b7715eb437 100644 --- a/docset/winserver2022-ps/activedirectory/Add-ADPrincipalGroupMembership.md +++ b/docset/winserver2022-ps/activedirectory/Add-ADPrincipalGroupMembership.md @@ -16,90 +16,93 @@ Adds a member to one or more Active Directory groups. ## SYNTAX ``` -Add-ADPrincipalGroupMembership [-WhatIf] [-Confirm] [-AuthType ] [-Credential ] - [-Identity] [-MemberOf] [-Partition ] [-PassThru] [-Server ] - [] +Add-ADPrincipalGroupMembership [-WhatIf] [-Confirm] [-AuthType ] + [-Credential ] [-Identity] [-MemberOf] + [-Partition ] [-PassThru] [-Server ] [] ``` ## DESCRIPTION -The **Add-ADPrincipalGroupMembership** cmdlet adds a user, group, service account, or computer as a new member to one or more Active Directory groups. -The *Identity* parameter specifies the new user, computer, or group to add. -You can identify the user, group, or computer by its distinguished name, GUID, security identifier (SID), or Security Account Manager (SAM) account name. -You can also specify a user, group, or computer object variable, such as `$`, or pass an object through the pipeline to the *Identity* parameter. -For example, you can use the **Get-ADGroup** cmdlet to get a group object and then pass the object through the pipeline to the **Add-ADPrincipalGroupMembership** cmdlet. -Similarly, you can use **Get-ADUser** or **Get-ADComputer** to get user and computer objects to pass through the pipeline. +The `Add-ADPrincipalGroupMembership` cmdlet adds a user, group, service account, or computer as a +new member to one or more Active Directory groups. -This cmdlet collects all of the user, computer and group objects from the pipeline, and then adds these objects to the specified group by using one Active Directory operation. +The **Identity** parameter specifies the new user, computer, or group to add. You can identify the +user, group, or computer by its distinguished name, GUID, security identifier (SID), or Security +Account Manager (SAM) account name. You can also specify a user, group, or computer object variable, +such as `$`, or pass an object through the pipeline to the **Identity** parameter. +For example, you can use the `Get-ADGroup` cmdlet to get a group object and then pass the object +through the pipeline to the `Add-ADPrincipalGroupMembership` cmdlet. Similarly, you can use +`Get-ADUser` or `Get-ADComputer` to get user and computer objects to pass through the pipeline. -The *MemberOf* parameter specifies the groups that receive the new member. -You can identify a group by its distinguished name, GUID, SID, or SAM account name. -You can also specify group object variable, such as `$`. -To specify more than one group, use a comma-separated list. -You cannot pass group objects through the pipeline to the *MemberOf* parameter. -To add to a group by passing the group through the pipeline, use the **Add-ADGroupMember** cmdlet. +This cmdlet collects all of the user, computer and group objects from the pipeline, and then adds +these objects to the specified group by using one Active Directory operation. -For Active Directory Lightweight Directory Services (AD LDS) environments, the *Partition* parameter must be specified except in the following two conditions: +The **MemberOf** parameter specifies the groups that receive the new member. You can identify a +group by its distinguished name, GUID, SID, or SAM account name. You can also specify group object +variable, such as `$`. To specify more than one group, use a comma-separated list. +You cannot pass group objects through the pipeline to the **MemberOf** parameter. To add to a group +by passing the group through the pipeline, use the **Add-ADGroupMember** cmdlet. -- The cmdlet is run from an Active Directory provider drive. +For Active Directory Lightweight Directory Services (AD LDS) environments, the **Partition** +parameter must be specified except in the following two conditions: + +- The cmdlet is run from an Active Directory provider drive. - A default naming context or partition is defined for the AD LDS environment. -To specify a default naming context for an AD LDS environment, set the **msDS-defaultNamingContext** property of the Active Directory directory service agent object (nTDSDSA) for the AD LDS instance. -## EXAMPLES +To specify a default naming context for an AD LDS environment, set the **msDS-defaultNamingContext** +property of the Active Directory directory service agent object (nTDSDSA) for the AD LDS instance. -### Example 1: Add a member to a group -``` -PS C:\> Add-ADPrincipalGroupMembership -Identity SQLAdmin1 -MemberOf DlgtdAdminsPSOGroup -``` +## EXAMPLES -This command adds the user with SAM account name SQLAdmin1 to the group DlgtdAdminsPSOGroup. +### EXAMPLE 1 -### Example 2: Add filtered users to a group -``` -PS C:\> Get-ADUser -Filter 'Name -like "*SvcAccount*"' | Add-ADPrincipalGroupMembership -MemberOf SvcAccPSOGroup +```powershell +Add-ADPrincipalGroupMembership -Identity SQLAdmin1 -MemberOf DlgtdAdminsPSOGroup ``` -This command gets all users with SvcAccount in their name and adds it to the group SvcAccPSOGroup. +This command adds the user with SAM account name `SQLAdmin1` to the group `DlgtdAdminsPSOGroup`. -### Example 3: Add a member to a group without specifying parameters -``` -PS C:\> Add-ADPrincipalGroupMembership -cmdlet Add-ADPrincipalGroupMembership at command pipeline position 1 -Supply values for the following parameters: -Identity: DavidChew -MemberOf[0]: RodcAdmins -MemberOf[1]: Allowed RODC Password Replication Group -MemberOf[2]: +### EXAMPLE 2 + +```powershell +Get-ADUser -Filter 'Name -like "*SvcAccount*"' | + Add-ADPrincipalGroupMembership -MemberOf SvcAccPSOGroup ``` -This command demonstrates the default behavior of this cmdlet, with no parameters specified. +This command gets all users with `SvcAccount` in their name and adds them to the group +`SvcAccPSOGroup`. -### Example 4: Add filtered users to a distinguished name group -``` -PS C:\> Get-ADUser -Server localhost:60000 -SearchBase "DC=AppNC" -Filter "Title -eq 'Account Lead' -and Office -eq 'Branch1'" | Add-ADPrincipalGroupMembership -MemberOf "CN=AccountLeads,OU=AccountDeptOU,DC=AppNC" +### EXAMPLE 3 + +```powershell +$params = @{ + Server = 'localhost:60000' + SearchBase = 'DC=AppNC' + Filter = "Title -eq 'Account Lead' -and Office -eq 'Branch1'" +} +Get-ADUser @params | + Add-ADPrincipalGroupMembership -MemberOf "CN=AccountLeads,OU=AccountDeptOU,DC=AppNC" ``` -This command adds all employees in Branch1 in the AD LDS instance localhost:60000 whose title is Account Lead to the group with the distinguished name CN=AccountLeads,OU=AccountDeptOU,DC=AppNC. +This command adds all employees in `Branch1` in the AD LDS instance `localhost:60000` whose title is +`Account Lead` to the group with the distinguished name `CN=AccountLeads,OU=AccountDeptOU,DC=AppNC`. ## PARAMETERS ### -AuthType + Specifies the authentication method to use. The acceptable values for this parameter are: -- Negotiate or 0 -- Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. +- `Negotiate` or `0` +- `Basic` or `1` -The following example shows how to set this parameter to Basic. +The default authentication method is `Negotiate`. -`-AuthType Basic` +A Secure Sockets Layer (SSL) connection is required for the `Basic` authentication method. ```yaml -Type: ADAuthType +Type: Microsoft.ActiveDirectory.Management.ADAuthType Parameter Sets: (All) Aliases: Accepted values: Negotiate, Basic @@ -112,10 +115,11 @@ Accept wildcard characters: False ``` ### -Confirm + Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf @@ -127,20 +131,24 @@ Accept wildcard characters: False ``` ### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. -To specify this parameter, you can type a user name, such as User1 or Domain01\User01 or you can specify a **PSCredential** object. -If you specify a user name for this parameter, the cmdlet prompts for a password. +Specifies the user account credentials to use to perform this task. The default credentials are the +credentials of the currently logged on user unless the cmdlet is run from an Active Directory module +for Windows PowerShell provider drive. If the cmdlet is run from such a provider drive, the account +associated with the drive is the default. + +To specify this parameter, you can type a user name, such as `User1` or `Domain01\User01` or you can +specify a **PSCredential** object. If you specify a user name for this parameter, the cmdlet prompts +for a password. -You can also create a **PSCredential** object by using a script or by using the **Get-Credential** cmdlet. -You can then set the *Credential* parameter to the **PSCredential** object. +You can also create a **PSCredential** object by using a script or by using the `Get-Credential` +cmdlet. You can then set the **Credential** parameter to the **PSCredential** object. -If the acting credentials do not have directory-level permission to perform the task, Active Directory PowerShell returns a terminating error. +If the acting credentials do not have directory-level permission to perform the task, Active +Directory module for Windows PowerShell returns a terminating error. ```yaml -Type: PSCredential +Type: System.Management.Automation.PSCredential Parameter Sets: (All) Aliases: @@ -152,19 +160,21 @@ Accept wildcard characters: False ``` ### -Identity + Specifies an Active Directory principal object by providing one of the following property values. -The identifier in parentheses is the LDAP display name for the attribute. -The acceptable values for this parameter are: +The identifier in parentheses is the LDAP display name for the attribute. The acceptable values for +this parameter are: - Distinguished name -- GUID (objectGUID) -- Security identifier (objectSid) -- A SAM account name (sAMAccountName) +- GUID (**objectGUID**) +- Security identifier (**objectSid**) +- A SAM account name (**sAMAccountName**) -The cmdlet searches the default naming context or partition to find the object. -If two or more objects are found, the cmdlet returns a non-terminating error. +The cmdlet searches the default naming context or partition to find the object. If two or more +objects are found, the cmdlet returns a non-terminating error. -This parameter can also get this object through the pipeline or you can set this parameter to an object instance. +This parameter can also get this object through the pipeline or you can set this parameter to an +object instance. Derived types, such as the following are also accepted: @@ -182,7 +192,7 @@ This example shows how to set this parameter to a principal object instance name `-Identity $principalInstance` ```yaml -Type: ADPrincipal +Type: Microsoft.ActiveDirectory.Management.ADPrincipal Parameter Sets: (All) Aliases: @@ -194,15 +204,15 @@ Accept wildcard characters: False ``` ### -MemberOf -Specifies the Active Directory groups to add a user, computer, or group to as a member. -You can identify a group by providing one of the following values. -Note: The identifier in parentheses is the LDAP display name for the attribute. -The acceptable values for this parameter are: + +Specifies the Active Directory groups to add a user, computer, or group to as a member. You can +identify a group by providing one of the following values. Note: The identifier in parentheses is +the LDAP display name for the attribute. The acceptable values for this parameter are: - Distinguished name -- GUID (objectGUID) -- Security identifier (objectSid) -- Security Account Manager (SAM) account name (sAMAccountName) +- GUID (**objectGUID**) +- Security identifier (**objectSid**) +- Security Account Manager (SAM) account name (**sAMAccountName**) If you are specifying more than one group, use commas to separate the groups in the list. @@ -211,7 +221,7 @@ The following example shows how to specify this parameter by using SAM account n `-MemberOf "SaraDavisGroup", "JohnSmithGroup"` ```yaml -Type: ADGroup[] +Type: Microsoft.ActiveDirectory.Management.ADGroup[] Parameter Sets: (All) Aliases: @@ -223,30 +233,40 @@ Accept wildcard characters: False ``` ### -Partition -Specifies the distinguished name of an Active Directory partition. -The distinguished name must be one of the naming contexts on the current directory server. -The cmdlet searches this partition to find the object defined by the *Identity* parameter. -In many cases, a default value is used for the *Partition* parameter if no value is specified. -The rules for determining the default value are given below. -Note that rules listed first are evaluated first and once a default value can be determined, no further rules are evaluated. - -In Active Directory Domain Services (AD DS) environments, a default value for *Partition* is set in the following cases: - -- If the *Identity* parameter is set to a distinguished name, the default value of *Partition* is automatically generated from this distinguished name. -- If running cmdlets from an Active Directory provider drive, the default value of *Partition* is automatically generated from the current path in the drive. -- If none of the previous cases apply, the default value of *Partition* is set to the default partition or naming context of the target domain. - -In Active Directory Lightweight Directory Services (AD LDS) environments, a default value for *Partition* is set in the following cases: - -- If the *Identity* parameter is set to a distinguished name, the default value of *Partition* is automatically generated from this distinguished name. -- If running cmdlets from an Active Directory provider drive, the default value of *Partition* is automatically generated from the current path in the drive. -- If the target AD LDS instance has a default naming context, the default value of *Partition* is set to the default naming context. -To specify a default naming context for an AD LDS environment, set the **msDS-defaultNamingContext** property of the Active Directory directory service agent object (**nTDSDSA**) for the AD LDS instance. -- If none of the previous cases apply, the *Partition* parameter does not take any default value. +Specifies the distinguished name of an Active Directory partition. The distinguished name must be +one of the naming contexts on the current directory server. The cmdlet searches this partition to +find the object defined by the **Identity** parameter. + +In many cases, a default value is used for the **Partition** parameter if no value is specified. The +rules for determining the default value are given below. Note that rules listed first are evaluated +first and once a default value can be determined, no further rules are evaluated. + +In Active Directory Domain Services environments, a default value for **Partition** is set in the +following cases: + +- If the **Identity** parameter is set to a distinguished name, the default value of **Partition** + is automatically generated from this distinguished name. +- If running cmdlets from an Active Directory provider drive, the default value of **Partition** is + automatically generated from the current path in the drive. +- If none of the previous cases apply, the default value of **Partition** is set to the default + partition or naming context of the target domain. + +In Active Directory Lightweight Directory Services (AD LDS) environments, a default value for +**Partition** is set in the following cases: + +- If the **Identity** parameter is set to a distinguished name, the default value of **Partition** + is automatically generated from this distinguished name. +- If running cmdlets from an Active Directory provider drive, the default value of **Partition** is + automatically generated from the current path in the drive. +- If the target AD LDS instance has a default naming context, the default value of **Partition** is + set to the default naming context. To specify a default naming context for an AD LDS environment, + set the **msDS-defaultNamingContext** property of the Active Directory directory service agent + (DSA) object (**nTDSDSA**) for the AD LDS instance. +- If none of the previous cases apply, the **Partition** parameter will not take any default value. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -258,11 +278,12 @@ Accept wildcard characters: False ``` ### -PassThru + Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -274,30 +295,35 @@ Accept wildcard characters: False ``` ### -Server -Specifies the AD DS instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: AD LDS, AD DS, or Active Directory snapshot instance. -Specify the AD DS instance in one of the following ways: +Specifies the Active Directory Domain Services instance to connect to, by providing one of the +following values for a corresponding domain name or directory server. The service may be any of the +following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active +Directory snapshot instance. + +Specify the Active Directory Domain Services instance in one of the following ways: Domain name values: - Fully qualified domain name - NetBIOS name -Directory server values: +Directory server values: - Fully qualified directory server name - NetBIOS name - Fully qualified directory server name and port -The default value for this parameter is determined by one of the following methods in the order that they are listed: +The default value for this parameter is determined by one of the following methods in the order that +they are listed: - By using the **Server** value from objects passed through the pipeline -- By using the server information associated with the AD DS Windows PowerShell provider drive, when the cmdlet runs in that drive +- By using the server information associated with the Active Directory Domain Services Windows + PowerShell provider drive, when the cmdlet runs in that drive - By using the domain of the computer running Windows PowerShell ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -309,11 +335,12 @@ Accept wildcard characters: False ``` ### -WhatIf + Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi @@ -325,31 +352,36 @@ Accept wildcard characters: False ``` ### CommonParameters -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). + +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). ## INPUTS ### Microsoft.ActiveDirectory.Management.ADPrincipal -A principal object (Microsoft.ActiveDirectory.Management.ADPrincipal) that represents a user, computer or group is received by the Identity parameter. -Derived types, such as the following are also received by this parameter. - -Microsoft.ActiveDirectory.Management.ADUser -Microsoft.ActiveDirectory.Management.ADComputer +A principal object (**Microsoft.ActiveDirectory.Management.ADPrincipal**) that represents a user, +computer or group is received by the Identity parameter. Derived types, such as the following are +also received by this parameter. -Microsoft.ActiveDirectory.Management.ADServiceAccount - -Microsoft.ActiveDirectory.Management.ADGroup +- **Microsoft.ActiveDirectory.Management.ADUser** +- **Microsoft.ActiveDirectory.Management.ADComputer** +- **Microsoft.ActiveDirectory.Management.ADServiceAccount** +- **Microsoft.ActiveDirectory.Management.ADGroup** ## OUTPUTS ### None or Microsoft.ActiveDirectory.Management.ADPrincipal -Returns a principal object that represents the modified user, computer or group object when the *PassThru* parameter is specified. -By default, this cmdlet does not generate any output. + +Returns a principal object that represents the modified user, computer or group object when the +**PassThru** parameter is specified. By default, this cmdlet does not generate any output. ## NOTES -* This cmdlet does not work with a read-only domain controller. -* This cmdlet does not work with an Active Directory snapshot. + +- This cmdlet does not work with a read-only domain controller. +- This cmdlet does not work with an Active Directory snapshot. ## RELATED LINKS @@ -368,4 +400,3 @@ By default, this cmdlet does not generate any output. [Remove-ADGroupMember](./Remove-ADGroupMember.md) [Remove-ADPrincipalGroupMembership](./Remove-ADPrincipalGroupMembership.md) - From b812d002a0bd3f4281ef031afa8c34ea5cd97078 Mon Sep 17 00:00:00 2001 From: Rob Derickson Date: Wed, 24 May 2023 19:57:02 -0400 Subject: [PATCH 476/650] Fix formatting for Add-ADResourcePropertyListMember. --- .../Add-ADResourcePropertyListMember.md | 154 ++++++++++-------- 1 file changed, 86 insertions(+), 68 deletions(-) diff --git a/docset/winserver2022-ps/activedirectory/Add-ADResourcePropertyListMember.md b/docset/winserver2022-ps/activedirectory/Add-ADResourcePropertyListMember.md index 524ea97c91..f7cea0cb72 100644 --- a/docset/winserver2022-ps/activedirectory/Add-ADResourcePropertyListMember.md +++ b/docset/winserver2022-ps/activedirectory/Add-ADResourcePropertyListMember.md @@ -16,59 +16,58 @@ Adds one or more resource properties to a resource property list in Active Direc ## SYNTAX ``` -Add-ADResourcePropertyListMember [-WhatIf] [-Confirm] [-AuthType ] [-Credential ] - [-Identity] [-Members] [-PassThru] [-Server ] - [] +Add-ADResourcePropertyListMember [-WhatIf] [-Confirm] [-AuthType ] + [-Credential ] [-Identity] + [-Members] [-PassThru] [-Server ] [] ``` ## DESCRIPTION -The **Add-ADResourcePropertyListMember** cmdlet adds one or more resource properties to a resource property list in Active Directory. -## EXAMPLES +The `Add-ADResourcePropertyListMember` cmdlet adds one or more resource properties to a resource +property list in Active Directory. -### Example 1: Add members to a resource property list -``` -PS C:\> Add-ADResourcePropertyListMember -Identity "Global Resource Property List" -Members Country,Authors -``` +## EXAMPLES -This command adds the resource members named Country and Authors to the list named Global Resource Property List. +### EXAMPLE 1 -### Example 2: Add members to the default resource property list -``` -PS C:\> Add-ADResourcePropertyListMember -cmdlet Add-ADResourcePropertyListMember at command pipeline position 1 -Supply values for the following parameters: -Identity: Corporate Resource Property List -Members[0]: Country -Members[1]: Authors -Members[2]: +```powershell +$params = @{ + Identity = 'Global Resource Property List' + Members = 'Country', 'Authors' +} +Add-ADResourcePropertyListMember @params ``` -This command adds the resource members named Country and Authors to the resource property list named Corporate Resource Property List. -This command demonstrates the default behavior for this cmdlet when no parameters are specified. +This command adds the resource members named `Country` and `Authors` to the list named +`Global Resource Property List`. -### Example 3: Add members to a filtered resource property list -``` -PS C:\> Get-ADResourcePropertyList -Filter "Name -like 'Corporate*'" | Add-ADResourcePropertyListMember -Members Country,Authors +### EXAMPLE 2 + +```powershell +Get-ADResourcePropertyList -Filter "Name -like 'Corporate*'" | + Add-ADResourcePropertyListMember -Members Country, Authors ``` -This command gets any resource property list that has a name that begins with Corporate and then passes it to Add-ADResourcePropertyListMember, which then adds the resource properties Country and Authors to it. +This command gets any resource property list that has a name that begins with `Corporate` and then +passes it to `Add-ADResourcePropertyListMember`, which then adds the resource properties `Country` +and `Authors` to it. ## PARAMETERS ### -AuthType + Specifies the authentication method to use. The acceptable values for this parameter are: -- Negotiate or 0 -- Basic or 1 +- `Negotiate` or `0` +- `Basic` or `1` -The default authentication method is Negotiate. +The default authentication method is `Negotiate`. -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. +A Secure Sockets Layer (SSL) connection is required for the `Basic` authentication method. ```yaml -Type: ADAuthType +Type: Microsoft.ActiveDirectory.Management.ADAuthType Parameter Sets: (All) Aliases: Accepted values: Negotiate, Basic @@ -81,10 +80,11 @@ Accept wildcard characters: False ``` ### -Confirm + Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf @@ -96,20 +96,24 @@ Accept wildcard characters: False ``` ### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory module for Windows PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. -To specify this parameter, you can type a user name, such as User1 or Domain01\User01 or you can specify a **PSCredential** object. -If you specify a user name for this parameter, the cmdlet prompts for a password. +Specifies the user account credentials to use to perform this task. The default credentials are the +credentials of the currently logged on user unless the cmdlet is run from an Active Directory module +for Windows PowerShell provider drive. If the cmdlet is run from such a provider drive, the account +associated with the drive is the default. -You can also create a **PSCredential** object by using a script or by using the **Get-Credential** cmdlet. -You can then set the *Credential* parameter to the **PSCredential** object. +To specify this parameter, you can type a user name, such as `User1` or `Domain01\User01` or you can +specify a **PSCredential** object. If you specify a user name for this parameter, the cmdlet prompts +for a password. -If the acting credentials do not have directory-level permission to perform the task, Active Directory module for Windows PowerShell returns a terminating error. +You can also create a **PSCredential** object by using a script or by using the `Get-Credential` +cmdlet. You can then set the **Credential** parameter to the **PSCredential** object. + +If the acting credentials do not have directory-level permission to perform the task, Active +Directory module for Windows PowerShell returns a terminating error. ```yaml -Type: PSCredential +Type: System.Management.Automation.PSCredential Parameter Sets: (All) Aliases: @@ -121,17 +125,19 @@ Accept wildcard characters: False ``` ### -Identity -Specifies an Active Directory object by providing one of the following property values. -The identifier in parentheses is the Lightweight Directory Access Protocol (LDAP) display name for the attribute. -The acceptable values for this parameter are: + +Specifies an Active Directory object by providing one of the following property values. The +identifier in parentheses is the Lightweight Directory Access Protocol (LDAP) display name for the +attribute. The acceptable values for this parameter are: - A distinguished name -- A GUID (objectGUID) +- A GUID (**objectGUID**) -This parameter can also get this object through the pipeline or you can set this parameter to an object instance. +This parameter can also get this object through the pipeline or you can set this parameter to an +object instance. ```yaml -Type: ADResourcePropertyList +Type: Microsoft.ActiveDirectory.Management.ADResourcePropertyList Parameter Sets: (All) Aliases: @@ -143,21 +149,20 @@ Accept wildcard characters: False ``` ### -Members -Specifies a set of **ADResourceProperty** objects in a comma-separated list to add to a resource property list. -To identify each object, use one of the following property values: + +Specifies a set of **ADResourceProperty** objects in a comma-separated list to add to a resource +property list. To identify each object, use one of the following property values: - Name - Distinguished name -- GUID (objectGUID) - -Note: The identifier in parentheses is the LDAP display name. +- GUID (**objectGUID**) You can also provide objects to this parameter directly. You cannot pass objects through the pipeline to this parameter. ```yaml -Type: ADResourceProperty[] +Type: Microsoft.ActiveDirectory.Management.ADResourceProperty[] Parameter Sets: (All) Aliases: @@ -169,11 +174,12 @@ Accept wildcard characters: False ``` ### -PassThru + Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -185,30 +191,35 @@ Accept wildcard characters: False ``` ### -Server -Specifies the Active Directory Domain Services (AD DS) instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Directory Services (AD LDS), AD DS, or Active Directory snapshot instance. -Specify the AD DS instance in one of the following ways: +Specifies the Active Directory Domain Services instance to connect to, by providing one of the +following values for a corresponding domain name or directory server. The service may be any of the +following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active +Directory snapshot instance. + +Specify the Active Directory Domain Services instance in one of the following ways: Domain name values: - Fully qualified domain name - NetBIOS name -Directory server values: +Directory server values: - Fully qualified directory server name - NetBIOS name - Fully qualified directory server name and port -The default value for this parameter is determined by one of the following methods in the order that they are listed: +The default value for this parameter is determined by one of the following methods in the order that +they are listed: - By using the **Server** value from objects passed through the pipeline -- By using the server information associated with the AD DS Windows PowerShell provider drive, when the cmdlet runs in that drive +- By using the server information associated with the Active Directory Domain Services Windows + PowerShell provider drive, when the cmdlet runs in that drive - By using the domain of the computer running Windows PowerShell ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -220,11 +231,12 @@ Accept wildcard characters: False ``` ### -WhatIf + Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi @@ -236,24 +248,30 @@ Accept wildcard characters: False ``` ### CommonParameters -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). + +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). ## INPUTS ### None or Microsoft.ActiveDirectory.Management.ADClaimTypeList -An **ADClaimTypeList** object is received by the *Identity* parameter. + +An **ADClaimTypeList** object is received by the **Identity** parameter. ## OUTPUTS ### None or Microsoft.ActiveDirectory.Management.ADClaimTypeList -Returns the modified **ADClaimTypeList** object when the *PassThru* parameter is specified. -By default, this cmdlet does not generate any output. + +Returns the modified **ADClaimTypeList** object when the **PassThru** parameter is specified. By +default, this cmdlet does not generate any output. ## NOTES -* This cmdlet does not work with a read-only domain controller. -* This cmdlet does not work with an Active Directory snapshot. + +- This cmdlet does not work with a read-only domain controller. +- This cmdlet does not work with an Active Directory snapshot. ## RELATED LINKS [Remove-ADResourcePropertyListMember](./Remove-ADResourcePropertyListMember.md) - From 93d580b911b051831abebbec47c2ca301c59bf49 Mon Sep 17 00:00:00 2001 From: Rob Derickson Date: Wed, 24 May 2023 20:04:31 -0400 Subject: [PATCH 477/650] Fix formatting for Clear-ADAccountExpiration. --- .../Clear-ADAccountExpiration.md | 200 +++++++++++------- 1 file changed, 121 insertions(+), 79 deletions(-) diff --git a/docset/winserver2022-ps/activedirectory/Clear-ADAccountExpiration.md b/docset/winserver2022-ps/activedirectory/Clear-ADAccountExpiration.md index 4bfd5190dd..4e91faf3fe 100644 --- a/docset/winserver2022-ps/activedirectory/Clear-ADAccountExpiration.md +++ b/docset/winserver2022-ps/activedirectory/Clear-ADAccountExpiration.md @@ -16,57 +16,69 @@ Clears the expiration date for an Active Directory account. ## SYNTAX ``` -Clear-ADAccountExpiration [-WhatIf] [-Confirm] [-AuthType ] [-Credential ] - [-Identity] [-Partition ] [-PassThru] [-Server ] [] +Clear-ADAccountExpiration [-WhatIf] [-Confirm] [-AuthType ] + [-Credential ] [-Identity] [-Partition ] [-PassThru] + [-Server ] [] ``` ## DESCRIPTION -The **Clear-ADAccountExpiration** cmdlet clears the expiration date for an Active Directory user or computer account. -When you clear the expiration date for an account, the account does not expire. -The *Identity* parameter specifies the user or computer account to modify. -You can identify a user or group by its distinguished name, GUID, security identifier (SID), or Security Accounts Manager (SAM) account name. -You can also set the *Identity* parameter to a user or computer object variable, such as `$`, or pass a user or computer object through the pipeline to the *Identity* parameter. -For example, you can use the Get-ADUser, Get-ADComputer, or Search-ADAccount cmdlet to retrieve an object and then pass the object through the pipeline to the Clear-ADAccountExpiration cmdlet. +The `Clear-ADAccountExpiration` cmdlet clears the expiration date for an Active Directory user or +computer account. When you clear the expiration date for an account, the account does not expire. -For Active Directory Lightweight Directory Services (AD LDS) environments, the *Partition* parameter must be specified except in the following two conditions: +The **Identity** parameter specifies the user or computer account to modify. You can identify a user +or group by its distinguished name, GUID, security identifier (SID), or Security Accounts Manager +(SAM) account name. You can also set the **Identity** parameter to a user or computer object +variable, such as `$`, or pass a user or computer object through the pipeline to +the **Identity** parameter. For example, you can use the `Get-ADUser`, `Get-ADComputer`, or +`Search-ADAccount` cmdlet to retrieve an object and then pass the object through the pipeline to the +`Clear-ADAccountExpiration` cmdlet. + +For Active Directory Lightweight Directory Services (AD LDS) environments, the **Partition** +parameter must be specified except in the following two conditions: - The cmdlet is run from an Active Directory provider drive. -- A default naming context or partition is defined for the AD LDS environment. +- A default naming context or partition is defined for the AD LDS environment. -To specify a default naming context for an AD LDS environment, set the **msDS-defaultNamingContext** property of the Active Directory directory service agent object (**nTDSDSA**) for the AD LDS instance. +To specify a default naming context for an AD LDS environment, set the **msDS-defaultNamingContext** +property of the Active Directory directory service agent object (**nTDSDSA**) for the AD LDS +instance. ## EXAMPLES -### Example 1: Clear an account expiration date for a specified user -``` -PS C:\> Clear-ADAccountExpiration -Identity PattiFuller +### EXAMPLE 1 + +```powershell +Clear-ADAccountExpiration -Identity PattiFuller ``` -This command clears the account expiration date for the user with SamAccountName PattiFuller. +This command clears the account expiration date for the user with SamAccountName `PattiFuller`. -### Example 2: Clear an account expiration date for a specified user using a distinguished name -``` -PS C:\> Clear-ADAccountExpiration -Identity "CN=PattiFuller,DC=AppNC" -Server "PATTIFU-SVR1:60000" +### EXAMPLE 2 + +```powershell +Clear-ADAccountExpiration -Identity 'CN=PattiFuller,DC=AppNC' -Server 'PATTIFU-SVR1:60000' ``` -This command clears the account expiration date for the user with DistinguishedName CN=PattiFuller,DC=AppNC on the AD LDS instance PATTIFU-SVR1:60000. +This command clears the account expiration date for the user with DistinguishedName +`CN=PattiFuller,DC=AppNC` on the AD LDS instance `PATTIFU-SVR1:60000`. ## PARAMETERS ### -AuthType + Specifies the authentication method to use. The acceptable values for this parameter are: -- Negotiate or 0 -- Basic or 1 +- `Negotiate` or `0` +- `Basic` or `1` -The default authentication method is Negotiate. +The default authentication method is `Negotiate`. -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. +A Secure Sockets Layer (SSL) connection is required for the `Basic` authentication method. ```yaml -Type: ADAuthType +Type: Microsoft.ActiveDirectory.Management.ADAuthType Parameter Sets: (All) Aliases: Accepted values: Negotiate, Basic @@ -79,10 +91,11 @@ Accept wildcard characters: False ``` ### -Confirm + Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf @@ -94,20 +107,24 @@ Accept wildcard characters: False ``` ### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory module for Windows PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. -To specify this parameter, you can type a user name, such as User1 or Domain01\User01 or you can specify a **PSCredential** object. -If you specify a user name for this parameter, the cmdlet prompts for a password. +Specifies the user account credentials to use to perform this task. The default credentials are the +credentials of the currently logged on user unless the cmdlet is run from an Active Directory module +for Windows PowerShell provider drive. If the cmdlet is run from such a provider drive, the account +associated with the drive is the default. + +To specify this parameter, you can type a user name, such as `User1` or `Domain01\User01` or you can +specify a **PSCredential** object. If you specify a user name for this parameter, the cmdlet prompts +for a password. -You can also create a **PSCredential** object by using a script or by using the **Get-Credential** cmdlet. -You can then set the *Credential* parameter to the **PSCredential** object. +You can also create a **PSCredential** object by using a script or by using the `Get-Credential` +cmdlet. You can then set the **Credential** parameter to the **PSCredential** object. -If the acting credentials do not have directory-level permission to perform the task, Active Directory module for Windows PowerShell returns a terminating error. +If the acting credentials do not have directory-level permission to perform the task, Active +Directory module for Windows PowerShell returns a terminating error. ```yaml -Type: PSCredential +Type: System.Management.Automation.PSCredential Parameter Sets: (All) Aliases: @@ -119,19 +136,21 @@ Accept wildcard characters: False ``` ### -Identity -Specifies an Active Directory account object by providing one of the following property values. -The identifier in parentheses is the Lightweight Directory Access Protocol (LDAP) display name for the attribute. -The acceptable values for this parameter are: + +Specifies an Active Directory account object by providing one of the following property values. The +identifier in parentheses is the Lightweight Directory Access Protocol (LDAP) display name for the +attribute. The acceptable values for this parameter are: - A distinguished name -- A GUID (objectGUID) -- A security identifier (objectSid) -- A SAM account name (sAMAccountName) +- A GUID (**objectGUID**) +- A security identifier (**objectSid**) +- A SAM account name (**sAMAccountName**) -The cmdlet searches the default naming context or partition to find the object. -If two or more objects are found, the cmdlet returns a non-terminating error. +The cmdlet searches the default naming context or partition to find the object. If two or more +objects are found, the cmdlet returns a non-terminating error. -This parameter can also get this object through the pipeline or you can set this parameter to an account object instance. +This parameter can also get this object through the pipeline or you can set this parameter to an +account object instance. Derived types such as the following are also accepted: @@ -140,7 +159,7 @@ Derived types such as the following are also accepted: - **Microsoft.ActiveDirectory.Management.ADUser** ```yaml -Type: ADAccount +Type: Microsoft.ActiveDirectory.Management.ADAccount Parameter Sets: (All) Aliases: @@ -152,30 +171,40 @@ Accept wildcard characters: False ``` ### -Partition -Specifies the distinguished name of an Active Directory partition. -The distinguished name must be one of the naming contexts on the current directory server. -The cmdlet searches this partition to find the object defined by the *Identity* parameter. - -In many cases, a default value is used for the *Partition* parameter if no value is specified. -The rules for determining the default value are given below. -Note that rules listed first are evaluated first and once a default value can be determined, no further rules are evaluated. -In Active Directory Domain Services (AD DS) environments, a default value for *Partition* is set in the following cases: - -- If the *Identity* parameter is set to a distinguished name, the default value of *Partition* is automatically generated from this distinguished name. -- If running cmdlets from an Active Directory provider drive, the default value of *Partition* is automatically generated from the current path in the drive. -- If none of the previous cases apply, the default value of *Partition* is set to the default partition or naming context of the target domain. - -In AD LDS environments, a default value for *Partition* is set in the following cases: - -- If the *Identity* parameter is set to a distinguished name, the default value of *Partition* is automatically generated from this distinguished name. -- If running cmdlets from an Active Directory provider drive, the default value of *Partition* is automatically generated from the current path in the drive. -- If the target AD LDS instance has a default naming context, the default value of *Partition* is set to the default naming context. -To specify a default naming context for an AD LDS environment, set the **msDS-defaultNamingContext** property of the Active Directory directory service agent (DSA) object (**nTDSDSA**) for the AD LDS instance. -- If none of the previous cases apply, the *Partition* parameter will not take any default value. +Specifies the distinguished name of an Active Directory partition. The distinguished name must be +one of the naming contexts on the current directory server. The cmdlet searches this partition to +find the object defined by the **Identity** parameter. + +In many cases, a default value is used for the **Partition** parameter if no value is specified. The +rules for determining the default value are given below. Note that rules listed first are evaluated +first and once a default value can be determined, no further rules are evaluated. + +In Active Directory Domain Services environments, a default value for **Partition** is set in the +following cases: + +- If the **Identity** parameter is set to a distinguished name, the default value of **Partition** + is automatically generated from this distinguished name. +- If running cmdlets from an Active Directory provider drive, the default value of **Partition** is + automatically generated from the current path in the drive. +- If none of the previous cases apply, the default value of **Partition** is set to the default + partition or naming context of the target domain. + +In Active Directory Lightweight Directory Services (AD LDS) environments, a default value for +**Partition** is set in the following cases: + +- If the **Identity** parameter is set to a distinguished name, the default value of **Partition** + is automatically generated from this distinguished name. +- If running cmdlets from an Active Directory provider drive, the default value of **Partition** is + automatically generated from the current path in the drive. +- If the target AD LDS instance has a default naming context, the default value of **Partition** is + set to the default naming context. To specify a default naming context for an AD LDS environment, + set the **msDS-defaultNamingContext** property of the Active Directory directory service agent + (DSA) object (**nTDSDSA**) for the AD LDS instance. +- If none of the previous cases apply, the **Partition** parameter will not take any default value. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -187,11 +216,12 @@ Accept wildcard characters: False ``` ### -PassThru + Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -203,30 +233,35 @@ Accept wildcard characters: False ``` ### -Server -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory snapshot instance. -Specify the Active Directory Domain Services instance in one of the following ways: +Specifies the Active Directory Domain Services instance to connect to, by providing one of the +following values for a corresponding domain name or directory server. The service may be any of the +following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active +Directory snapshot instance. + +Specify the Active Directory Domain Services instance in one of the following ways: Domain name values: - Fully qualified domain name - NetBIOS name -Directory server values: +Directory server values: - Fully qualified directory server name - NetBIOS name - Fully qualified directory server name and port -The default value for this parameter is determined by one of the following methods in the order that they are listed: +The default value for this parameter is determined by one of the following methods in the order that +they are listed: - By using the **Server** value from objects passed through the pipeline -- By using the server information associated with the Active Directory Domain Services Windows PowerShell provider drive, when the cmdlet runs in that drive +- By using the server information associated with the Active Directory Domain Services Windows + PowerShell provider drive, when the cmdlet runs in that drive - By using the domain of the computer running Windows PowerShell ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -238,11 +273,12 @@ Accept wildcard characters: False ``` ### -WhatIf + Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi @@ -254,12 +290,18 @@ Accept wildcard characters: False ``` ### CommonParameters -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). + +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). ## INPUTS ### Microsoft.ActiveDirectory.Management.ADAccount -An account object (**Microsoft.ActiveDirectory.Management.ADAccount**) is received by the *Identity* parameter. + +An account object (**Microsoft.ActiveDirectory.Management.ADAccount**) is received by the +**Identity** parameter. Derived types, such as the following are also accepted: @@ -272,8 +314,9 @@ Derived types, such as the following are also accepted: ### None ## NOTES -* This cmdlet does not work with an Active Directory snapshot. -* This cmdlet does not work with a read-only domain controller. + +- This cmdlet does not work with an Active Directory snapshot. +- This cmdlet does not work with a read-only domain controller. ## RELATED LINKS @@ -286,4 +329,3 @@ Derived types, such as the following are also accepted: [Get-ADComputer](./Get-ADComputer.md) [AD DS Administration Cmdlets in Windows PowerShell](./activedirectory.md) - From 2e12c31e8d843fa170cccfed30d85efed5177a1b Mon Sep 17 00:00:00 2001 From: Rob Derickson Date: Wed, 24 May 2023 20:06:28 -0400 Subject: [PATCH 478/650] Addressed line length of Add-ADDomainControllerPasswordReplicationPolicy synopsis. --- .../Add-ADDomainControllerPasswordReplicationPolicy.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/activedirectory/Add-ADDomainControllerPasswordReplicationPolicy.md b/docset/winserver2022-ps/activedirectory/Add-ADDomainControllerPasswordReplicationPolicy.md index 7ef34244fb..6ae8437781 100644 --- a/docset/winserver2022-ps/activedirectory/Add-ADDomainControllerPasswordReplicationPolicy.md +++ b/docset/winserver2022-ps/activedirectory/Add-ADDomainControllerPasswordReplicationPolicy.md @@ -11,7 +11,8 @@ title: Add-ADDomainControllerPasswordReplicationPolicy # Add-ADDomainControllerPasswordReplicationPolicy ## SYNOPSIS -Adds users, computers, and groups to the allowed or denied list of a read-only domain controller password replication policy. +Adds users, computers, and groups to the allowed or denied list of a read-only domain controller +password replication policy. ## SYNTAX From 94cd5a4a984f033c5944950705509db8613e06c7 Mon Sep 17 00:00:00 2001 From: Rob Derickson Date: Wed, 24 May 2023 20:14:55 -0400 Subject: [PATCH 479/650] Fix formatting for Clear-ADClaimTransformLink. --- .../Clear-ADClaimTransformLink.md | 152 +++++++++++------- 1 file changed, 93 insertions(+), 59 deletions(-) diff --git a/docset/winserver2022-ps/activedirectory/Clear-ADClaimTransformLink.md b/docset/winserver2022-ps/activedirectory/Clear-ADClaimTransformLink.md index e3e58d3483..80fd1a5b52 100644 --- a/docset/winserver2022-ps/activedirectory/Clear-ADClaimTransformLink.md +++ b/docset/winserver2022-ps/activedirectory/Clear-ADClaimTransformLink.md @@ -11,59 +11,74 @@ title: Clear-ADClaimTransformLink # Clear-ADClaimTransformLink ## SYNOPSIS -Removes a claims transformation from being applied to one or more cross-forest trust relationships in Active Directory. +Removes a claims transformation from being applied to one or more cross-forest trust relationships +in Active Directory. ## SYNTAX ``` -Clear-ADClaimTransformLink [-WhatIf] [-Confirm] [-AuthType ] [-Credential ] - [-Identity] [-PassThru] [-Policy ] [-Server ] - [-TrustRole ] [] +Clear-ADClaimTransformLink [-WhatIf] [-Confirm] [-AuthType ] + [-Credential ] [-Identity] [-PassThru] + [-Policy ] [-Server ] [-TrustRole ] + [] ``` ## DESCRIPTION -The **Clear-ADClaimTransformLink** cmdlet removes a claims transformation from being applied to one or more cross-forest trust relationships in Active Directory. + +The `Clear-ADClaimTransformLink` cmdlet removes a claims transformation from being applied to one or +more cross-forest trust relationships in Active Directory. ## EXAMPLES -### Example 1: Remove a specified policy from a trust relationship -``` -PS C:\> Clear-ADClaimTransformLink -Identity "corp.contoso.com" -Policy DenyAllPolicy +### Example 1 + +```powershell +Clear-ADClaimTransformLink -Identity 'corp.contoso.com' -Policy DenyAllPolicy ``` -This command removes the policy named DenyAllPolicy from the corp.contoso.com trust. +This command removes the policy named `DenyAllPolicy` from the `corp.contoso.com` trust. -### Example 2: Remove all policies that are applied to a trusted forest -``` -PS C:\> Clear-ADClaimTransformLink -Identity "corp.contoso.com" -TrustRole Trusted +### Example 2 + +```powershell +Clear-ADClaimTransformLink -Identity 'corp.contoso.com' -TrustRole Trusted ``` -This command removes any policies that are applied to where this forest acts as the trusted forest in the corp.contoso.com trust. -Effectively, this cmdlet removes any policies that are applied to claims flowing out of this forest towards it trust partner. +This command removes any policies that are applied to where this forest acts as the trusted forest +in the `corp.contoso.com` trust. Effectively, this cmdlet removes any policies that are applied to +claims flowing out of this forest towards it trust partner. -### Example 3: Remove a specified claim transformation policy from being applied to the trust relationship -``` -PS C:\> Clear-ADClaimTransformLink -Identity "corp.contoso.com" -Policy DenyAllPolicy -TrustRole Trusting +### Example 3 + +```powershell +$params = @{ + Identity = 'corp.contoso.com' + Policy = 'DenyAllPolicy' + TrustRole = 'Trusting' +} +Clear-ADClaimTransformLink @params ``` -This command removes DenyAllPolicy that is applied to where this forest acts as the trusted domain in the corp.contoso.com trust. -Effectively, this cmdlet removes DenyAllPolicy from applying to claims coming into this from its trust partner. +This command removes DenyAllPolicy that is applied to where this forest acts as the trusted domain +in the `corp.contoso.com` trust. Effectively, this cmdlet removes `DenyAllPolicy` from applying to +claims coming into this from its trust partner. ## PARAMETERS ### -AuthType + Specifies the authentication method to use. The acceptable values for this parameter are: -- Negotiate or 0 -- Basic or 1 +- `Negotiate` or `0` +- `Basic` or `1` -The default authentication method is Negotiate. +The default authentication method is `Negotiate`. -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. +A Secure Sockets Layer (SSL) connection is required for the `Basic` authentication method. ```yaml -Type: ADAuthType +Type: Microsoft.ActiveDirectory.Management.ADAuthType Parameter Sets: (All) Aliases: Accepted values: Negotiate, Basic @@ -76,10 +91,11 @@ Accept wildcard characters: False ``` ### -Confirm + Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf @@ -91,20 +107,24 @@ Accept wildcard characters: False ``` ### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory module for Windows PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. -To specify this parameter, you can type a user name, such as User1 or Domain01\User01 or you can specify a **PSCredential** object. -If you specify a user name for this parameter, the cmdlet prompts for a password. +Specifies the user account credentials to use to perform this task. The default credentials are the +credentials of the currently logged on user unless the cmdlet is run from an Active Directory module +for Windows PowerShell provider drive. If the cmdlet is run from such a provider drive, the account +associated with the drive is the default. + +To specify this parameter, you can type a user name, such as `User1` or `Domain01\User01` or you can +specify a **PSCredential** object. If you specify a user name for this parameter, the cmdlet prompts +for a password. -You can also create a **PSCredential** object by using a script or by using the **Get-Credential** cmdlet. -You can then set the *Credential* parameter to the **PSCredential** object. +You can also create a **PSCredential** object by using a script or by using the `Get-Credential` +cmdlet. You can then set the **Credential** parameter to the **PSCredential** object. -If the acting credentials do not have directory-level permission to perform the task, Active Directory module for Windows PowerShell returns a terminating error. +If the acting credentials do not have directory-level permission to perform the task, Active +Directory module for Windows PowerShell returns a terminating error. ```yaml -Type: PSCredential +Type: System.Management.Automation.PSCredential Parameter Sets: (All) Aliases: @@ -116,17 +136,19 @@ Accept wildcard characters: False ``` ### -Identity -Specifies an Active Directory trust object by providing one of the following values. -The identifier in parentheses is the Lightweight Directory Access Protocol (LDAP) display name for the attribute. + +Specifies an Active Directory trust object by providing one of the following values. The identifier +in parentheses is the Lightweight Directory Access Protocol (LDAP) display name for the attribute. The acceptable values for this parameter are: - A distinguished name -- A GUID (objectGUID) +- A GUID (**objectGUID**) -This parameter can also get this object through the pipeline or you can set this parameter to an object instance. +This parameter can also get this object through the pipeline or you can set this parameter to an +object instance. ```yaml -Type: ADTrust +Type: Microsoft.ActiveDirectory.Management.ADTrust Parameter Sets: (All) Aliases: @@ -138,11 +160,12 @@ Accept wildcard characters: False ``` ### -PassThru + Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -154,10 +177,11 @@ Accept wildcard characters: False ``` ### -Policy + Removes the specified claim transformation policy from being applied to the trust relationship. ```yaml -Type: ADClaimTransformPolicy +Type: Microsoft.ActiveDirectory.Management.ADClaimTransformPolicy Parameter Sets: (All) Aliases: @@ -169,30 +193,35 @@ Accept wildcard characters: False ``` ### -Server -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory snapshot instance. -Specify the Active Directory Domain Services instance in one of the following ways: +Specifies the Active Directory Domain Services instance to connect to, by providing one of the +following values for a corresponding domain name or directory server. The service may be any of the +following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active +Directory snapshot instance. + +Specify the Active Directory Domain Services instance in one of the following ways: Domain name values: - Fully qualified domain name - NetBIOS name -Directory server values: +Directory server values: - Fully qualified directory server name - NetBIOS name - Fully qualified directory server name and port -The default value for this parameter is determined by one of the following methods in the order that they are listed: +The default value for this parameter is determined by one of the following methods in the order that +they are listed: - By using the **Server** value from objects passed through the pipeline -- By using the server information associated with the Active Directory Domain Services Windows PowerShell provider drive, when the cmdlet runs in that drive +- By using the server information associated with the Active Directory Domain Services Windows + PowerShell provider drive, when the cmdlet runs in that drive - By using the domain of the computer running Windows PowerShell ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -204,16 +233,15 @@ Accept wildcard characters: False ``` ### -TrustRole -Specifies the role of the current forest in the trust relationship specified by the *Identity* parameter. -The allowable values for this parameter are as follows: -- Trusted. -Specify this value if the current forest is the trusted forest. -- Trusting. -Specify this value if the current forest is the trusting forest. +Specifies the role of the current forest in the trust relationship specified by the **Identity** +parameter. The allowable values for this parameter are as follows: + +- `Trusted`: Specify this value if the current forest is the trusted forest. +- `Trusting`: Specify this value if the current forest is the trusting forest. ```yaml -Type: ADTrustRole +Type: Microsoft.ActiveDirectory.Management.ADTrustRole Parameter Sets: (All) Aliases: Accepted values: Trusted, Trusting @@ -226,11 +254,12 @@ Accept wildcard characters: False ``` ### -WhatIf + Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi @@ -242,12 +271,18 @@ Accept wildcard characters: False ``` ### CommonParameters -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). + +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). ## INPUTS ### Microsoft.ActiveDirectory.Management.ADTrust -An account object (**Microsoft.ActiveDirectory.Management.ADTrust**) is received by the *Identity* parameter. + +An account object (**Microsoft.ActiveDirectory.Management.ADTrust**) is received by the **Identity** +parameter. ## OUTPUTS @@ -260,4 +295,3 @@ An account object (**Microsoft.ActiveDirectory.Management.ADTrust**) is received [Set-ADClaimTransformLink](./Set-ADClaimTransformLink.md) [AD DS Administration Cmdlets in Windows PowerShell](./activedirectory.md) - From 52a0a9a08f5189260b2b4b89eb3b9f96b61128e8 Mon Sep 17 00:00:00 2001 From: Rob Derickson Date: Wed, 24 May 2023 20:18:57 -0400 Subject: [PATCH 480/650] Capitalize EXAMPLE. --- .../activedirectory/Clear-ADClaimTransformLink.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docset/winserver2022-ps/activedirectory/Clear-ADClaimTransformLink.md b/docset/winserver2022-ps/activedirectory/Clear-ADClaimTransformLink.md index 80fd1a5b52..191f241227 100644 --- a/docset/winserver2022-ps/activedirectory/Clear-ADClaimTransformLink.md +++ b/docset/winserver2022-ps/activedirectory/Clear-ADClaimTransformLink.md @@ -30,7 +30,7 @@ more cross-forest trust relationships in Active Directory. ## EXAMPLES -### Example 1 +### EXAMPLE 1 ```powershell Clear-ADClaimTransformLink -Identity 'corp.contoso.com' -Policy DenyAllPolicy @@ -38,7 +38,7 @@ Clear-ADClaimTransformLink -Identity 'corp.contoso.com' -Policy DenyAllPolicy This command removes the policy named `DenyAllPolicy` from the `corp.contoso.com` trust. -### Example 2 +### EXAMPLE 2 ```powershell Clear-ADClaimTransformLink -Identity 'corp.contoso.com' -TrustRole Trusted @@ -48,7 +48,7 @@ This command removes any policies that are applied to where this forest acts as in the `corp.contoso.com` trust. Effectively, this cmdlet removes any policies that are applied to claims flowing out of this forest towards it trust partner. -### Example 3 +### EXAMPLE 3 ```powershell $params = @{ From 3e03d5803398427c82199b038cfee1b8d7cd4781 Mon Sep 17 00:00:00 2001 From: Rob Derickson Date: Wed, 24 May 2023 20:26:11 -0400 Subject: [PATCH 481/650] Fix formatting for Disable-ADAccount. --- .../activedirectory/Disable-ADAccount.md | 207 +++++++++++------- 1 file changed, 126 insertions(+), 81 deletions(-) diff --git a/docset/winserver2022-ps/activedirectory/Disable-ADAccount.md b/docset/winserver2022-ps/activedirectory/Disable-ADAccount.md index 76ae0f3778..17a8610b62 100644 --- a/docset/winserver2022-ps/activedirectory/Disable-ADAccount.md +++ b/docset/winserver2022-ps/activedirectory/Disable-ADAccount.md @@ -16,63 +16,79 @@ Disables an Active Directory account. ## SYNTAX ``` -Disable-ADAccount [-WhatIf] [-Confirm] [-AuthType ] [-Credential ] - [-Identity] [-Partition ] [-PassThru] [-Server ] [] +Disable-ADAccount [-WhatIf] [-Confirm] [-AuthType ] + [-Credential ] [-Identity] [-Partition ] [-PassThru] + [-Server ] [] ``` ## DESCRIPTION -The **Disable-ADAccount** cmdlet disables an Active Directory user, computer, or service account. -The *Identity* parameter specifies the Active Directory user, computer service account, or other service account that you want to disable. -You can identify an account by its distinguished name, GUID, security identifier (SID), or Security Accounts Manager (SAM) account name. -You can also set the *Identity* parameter to an object variable such as `$`, or you can pass an account object through the pipeline to the *Identity* parameter. -For example, you can use the **Get-ADUser** cmdlet to retrieve a user account object and then pass the object through the pipeline to the **Disable-ADAccount** cmdlet. -Similarly, you can use **Get-ADComputer** and **Search-ADAccount** to retrieve account objects. +The `Disable-ADAccount` cmdlet disables an Active Directory user, computer, or service account. -For Active Directory Lightweight Directory Services (AD LDS) environments, the *Partition* parameter must be specified except in the following two conditions: +The **Identity** parameter specifies the Active Directory user, computer service account, or other +service account that you want to disable. You can identify an account by its distinguished name, +GUID, security identifier (SID), or Security Accounts Manager (SAM) account name. You can also set +the **Identity** parameter to an object variable such as `$`, or you can pass +an account object through the pipeline to the **Identity** parameter. For example, you can use the +`Get-ADUser` cmdlet to retrieve a user account object and then pass the object through the +pipeline to the `Disable-ADAccount` cmdlet. Similarly, you can use `Get-ADComputer` and +`Search-ADAccount` to retrieve account objects. + +For Active Directory Lightweight Directory Services (AD LDS) environments, the **Partition** +parameter must be specified except in the following two conditions: - The cmdlet is run from an Active Directory provider drive. - A default naming context or partition is defined for the AD LDS environment. -To specify a default naming context for an AD LDS environment, set the **msDS-defaultNamingContext** property of the Active Directory directory service agent (DSA) object (**nTDSDSA**) for the AD LDS instance. + +To specify a default naming context for an AD LDS environment, set the **msDS-defaultNamingContext** +property of the Active Directory directory service agent (DSA) object (**nTDSDSA**) for the AD LDS +instance. ## EXAMPLES -### Example 1: Disable an account by identity -``` -PS C:\> Disable-ADAccount -Identity PattiFul +### EXAMPLE 1 + +```powershell +Disable-ADAccount -Identity PattiFul ``` -This command disables the account with identity SAMAccountName PattiFul. +This command disables the account with identity SAMAccountName `PattiFul`. -### Example 2: Disable an account by Distinguished Name -``` -PS C:\> Disable-ADAccount -Identity "CN=Patti Fuller,OU=Finance,OU=UserAccounts,DC=FABRIKAM,DC=COM" +### EXAMPLE 2 + +```powershell +Disable-ADAccount -Identity 'CN=Patti Fuller,OU=Finance,OU=Users,DC=FABRIKAM,DC=COM' ``` -This command disables the account with DistinguishedName CN=Patti Fuller,OU=Finance,OU=UserAccounts,DC=FABRIKAM,DC=COM. +This command disables the account with DistinguishedName +`CN=Patti Fuller,OU=Finance,OU=Users,DC=FABRIKAM,DC=COM`. -### Example 3: Disable all accounts in an organizational unit using a filter -``` -PS C:\> Get-ADUser -Filter 'Name -like "*"' -SearchBase "OU=Finance,OU=UserAccounts,DC=FABRIKAM,DC=COM" | Disable-ADAccount +### EXAMPLE 3 + +```powershell +Get-ADUser -Filter 'Name -like "*"' -SearchBase "OU=Finance,OU=Users,DC=FABRIKAM,DC=COM" | + Disable-ADAccount ``` -This command disables all accounts in the organizational unit OU=Finance,OU=UserAccounts,DC=FABRIKAM,DC=COM. +This command disables all accounts in the organizational unit +`OU=Finance,OU=Users,DC=FABRIKAM,DC=COM`. ## PARAMETERS ### -AuthType + Specifies the authentication method to use. The acceptable values for this parameter are: -- Negotiate or 0 -- Basic or 1 +- `Negotiate` or `0` +- `Basic` or `1` -The default authentication method is Negotiate. +The default authentication method is `Negotiate`. -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. +A Secure Sockets Layer (SSL) connection is required for the `Basic` authentication method. ```yaml -Type: ADAuthType +Type: Microsoft.ActiveDirectory.Management.ADAuthType Parameter Sets: (All) Aliases: Accepted values: Negotiate, Basic @@ -85,10 +101,11 @@ Accept wildcard characters: False ``` ### -Confirm + Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf @@ -100,20 +117,24 @@ Accept wildcard characters: False ``` ### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory module for Windows PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. -To specify this parameter, you can type a user name, such as User1 or Domain01\User01 or you can specify a **PSCredential** object. -If you specify a user name for this parameter, the cmdlet prompts for a password. +Specifies the user account credentials to use to perform this task. The default credentials are the +credentials of the currently logged on user unless the cmdlet is run from an Active Directory module +for Windows PowerShell provider drive. If the cmdlet is run from such a provider drive, the account +associated with the drive is the default. + +To specify this parameter, you can type a user name, such as `User1` or `Domain01\User01` or you can +specify a **PSCredential** object. If you specify a user name for this parameter, the cmdlet prompts +for a password. -You can also create a **PSCredential** object by using a script or by using the **Get-Credential** cmdlet. -You can then set the *Credential* parameter to the **PSCredential** object. +You can also create a **PSCredential** object by using a script or by using the `Get-Credential` +cmdlet. You can then set the **Credential** parameter to the **PSCredential** object. -If the acting credentials do not have directory-level permission to perform the task, Active Directory module for Windows PowerShell returns a terminating error. +If the acting credentials do not have directory-level permission to perform the task, Active +Directory module for Windows PowerShell returns a terminating error. ```yaml -Type: PSCredential +Type: System.Management.Automation.PSCredential Parameter Sets: (All) Aliases: @@ -125,28 +146,30 @@ Accept wildcard characters: False ``` ### -Identity -Specifies an Active Directory account object by providing one of the following property values. -The identifier in parentheses is the Lightweight Directory Access Protocol (LDAP) display name for the attribute. -The acceptable values for this parameter are: + +Specifies an Active Directory account object by providing one of the following property values. The +identifier in parentheses is the Lightweight Directory Access Protocol (LDAP) display name for the +attribute. The acceptable values for this parameter are: - A distinguished name -- A GUID (objectGUID) -- A Security Identifier (objectSid) -- A SAM Account Name (SAMAccountName) +- A GUID (**objectGUID**) +- A Security Identifier (**objectSid**) +- A SAM Account Name (**SAMAccountName**) The cmdlet searches the default naming context or partition to find the object. If two or more objects are found, the cmdlet returns a non-terminating error. -This parameter can also get this object through the pipeline or you can set this parameter to an account object instance. +This parameter can also get this object through the pipeline or you can set this parameter to an +account object instance. -Derived types such as the following are also accepted: +Derived types such as the following are also accepted: - **Microsoft.ActiveDirectory.Management.ADServiceAccount** - **Microsoft.ActiveDirectory.Management.ADComputer** - **Microsoft.ActiveDirectory.Management.ADUser** ```yaml -Type: ADAccount +Type: Microsoft.ActiveDirectory.Management.ADAccount Parameter Sets: (All) Aliases: @@ -158,30 +181,40 @@ Accept wildcard characters: False ``` ### -Partition -Specifies the distinguished name of an Active Directory partition. -The distinguished name must be one of the naming contexts on the current directory server. -The cmdlet searches this partition to find the object defined by the *Identity* parameter. - -In many cases, a default value is used for the *Partition* parameter if no value is specified. -The rules for determining the default value are given below. -Note that rules listed first are evaluated first and once a default value can be determined, no further rules are evaluated. - -In Active Directory Domain Services (AD DS) environments, a default value for *Partition* is set in the following cases: -- If the *Identity* parameter is set to a distinguished name, the default value of *Partition* is automatically generated from this distinguished name. -- If running cmdlets from an Active Directory provider drive, the default value of *Partition* is automatically generated from the current path in the drive. -- If none of the previous cases apply, the default value of *Partition* is set to the default partition or naming context of the target domain. - -In Active Directory Lightweight Directory Services (AD LDS) environments, a default value for *Partition* is set in the following cases: - -- If the *Identity* parameter is set to a distinguished name, the default value of *Partition* is automatically generated from this distinguished name. -- If running cmdlets from an Active Directory provider drive, the default value of *Partition* is automatically generated from the current path in the drive. -- If the target AD LDS instance has a default naming context, the default value of *Partition* is set to the default naming context. -To specify a default naming context for an AD LDS environment, set the **msDS-defaultNamingContext** property of the Active Directory directory service agent object (**nTDSDSA**) for the AD LDS instance. -- If none of the previous cases apply, the *Partition* parameter will not take any default value. +Specifies the distinguished name of an Active Directory partition. The distinguished name must be +one of the naming contexts on the current directory server. The cmdlet searches this partition to +find the object defined by the **Identity** parameter. + +In many cases, a default value is used for the **Partition** parameter if no value is specified. The +rules for determining the default value are given below. Note that rules listed first are evaluated +first and once a default value can be determined, no further rules are evaluated. + +In Active Directory Domain Services environments, a default value for **Partition** is set in the +following cases: + +- If the **Identity** parameter is set to a distinguished name, the default value of **Partition** + is automatically generated from this distinguished name. +- If running cmdlets from an Active Directory provider drive, the default value of **Partition** is + automatically generated from the current path in the drive. +- If none of the previous cases apply, the default value of **Partition** is set to the default + partition or naming context of the target domain. + +In Active Directory Lightweight Directory Services (AD LDS) environments, a default value for +**Partition** is set in the following cases: + +- If the **Identity** parameter is set to a distinguished name, the default value of **Partition** + is automatically generated from this distinguished name. +- If running cmdlets from an Active Directory provider drive, the default value of **Partition** is + automatically generated from the current path in the drive. +- If the target AD LDS instance has a default naming context, the default value of **Partition** is + set to the default naming context. To specify a default naming context for an AD LDS environment, + set the **msDS-defaultNamingContext** property of the Active Directory directory service agent + (DSA) object (**nTDSDSA**) for the AD LDS instance. +- If none of the previous cases apply, the **Partition** parameter will not take any default value. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -193,11 +226,12 @@ Accept wildcard characters: False ``` ### -PassThru + Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -209,30 +243,35 @@ Accept wildcard characters: False ``` ### -Server -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory snapshot instance. -Specify the Active Directory Domain Services instance in one of the following ways: +Specifies the Active Directory Domain Services instance to connect to, by providing one of the +following values for a corresponding domain name or directory server. The service may be any of the +following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active +Directory snapshot instance. + +Specify the Active Directory Domain Services instance in one of the following ways: Domain name values: - Fully qualified domain name - NetBIOS name -Directory server values: +Directory server values: - Fully qualified directory server name - NetBIOS name - Fully qualified directory server name and port -The default value for this parameter is determined by one of the following methods in the order that they are listed: +The default value for this parameter is determined by one of the following methods in the order that +they are listed: - By using the **Server** value from objects passed through the pipeline -- By using the server information associated with the Active Directory Domain Services Windows PowerShell provider drive, when the cmdlet runs in that drive +- By using the server information associated with the Active Directory Domain Services Windows + PowerShell provider drive, when the cmdlet runs in that drive - By using the domain of the computer running Windows PowerShell ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -244,11 +283,12 @@ Accept wildcard characters: False ``` ### -WhatIf + Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi @@ -260,12 +300,17 @@ Accept wildcard characters: False ``` ### CommonParameters -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). + +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). ## INPUTS ### Microsoft.ActiveDirectory.Management.ADAccount -An account object is received by the *Identity* parameter. + +An account object is received by the **Identity** parameter. Derived types, such as the following are also accepted: @@ -278,8 +323,9 @@ Derived types, such as the following are also accepted: ### None ## NOTES -* This cmdlet does not work with an Active Directory snapshot. -* This cmdlet does not work with a read-only domain controller. + +- This cmdlet does not work with an Active Directory snapshot. +- This cmdlet does not work with a read-only domain controller. ## RELATED LINKS @@ -300,4 +346,3 @@ Derived types, such as the following are also accepted: [Unlock-ADAccount](./Unlock-ADAccount.md) [AD DS Administration Cmdlets in Windows PowerShell](./activedirectory.md) - From 5b1df90e3cfbd3ee80a86b8e8c45be601f7e04ed Mon Sep 17 00:00:00 2001 From: "Mikey Lombardi (He/Him)" Date: Tue, 30 May 2023 12:21:48 -0500 Subject: [PATCH 482/650] Apply suggestions from review --- .../Add-ADCentralAccessPolicyMember.md | 7 +++---- .../Add-ADComputerServiceAccount.md | 5 ++--- ...DDomainControllerPasswordReplicationPolicy.md | 3 +-- .../Add-ADFineGrainedPasswordPolicySubject.md | 15 ++++++--------- .../activedirectory/Add-ADGroupMember.md | 10 ++++------ .../Add-ADPrincipalGroupMembership.md | 16 +++++++--------- .../Add-ADResourcePropertyListMember.md | 11 +++++------ .../activedirectory/Clear-ADAccountExpiration.md | 14 ++++++-------- .../Clear-ADClaimTransformLink.md | 16 +++++++--------- .../activedirectory/Disable-ADAccount.md | 16 +++++++--------- 10 files changed, 48 insertions(+), 65 deletions(-) diff --git a/docset/winserver2022-ps/activedirectory/Add-ADCentralAccessPolicyMember.md b/docset/winserver2022-ps/activedirectory/Add-ADCentralAccessPolicyMember.md index 4746fd5445..4d4c652120 100644 --- a/docset/winserver2022-ps/activedirectory/Add-ADCentralAccessPolicyMember.md +++ b/docset/winserver2022-ps/activedirectory/Add-ADCentralAccessPolicyMember.md @@ -38,8 +38,8 @@ $params = @{ Add-ADCentralAccessPolicyMember @params ``` -This command adds the central access rules Finance Documents Rule and Corporate Documents Rule to -the central access policy Finance Policy. +This command adds the central access rules `Finance Documents Rule` and `Corporate Documents Rule` +to the central access policy Finance Policy. ### EXAMPLE 2 @@ -238,8 +238,7 @@ Accept wildcard characters: False ### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +Shows what would happen if the cmdlet runs. The cmdlet isn't run. ```yaml Type: System.Management.Automation.SwitchParameter diff --git a/docset/winserver2022-ps/activedirectory/Add-ADComputerServiceAccount.md b/docset/winserver2022-ps/activedirectory/Add-ADComputerServiceAccount.md index f34e03e27a..9fb1807c0d 100644 --- a/docset/winserver2022-ps/activedirectory/Add-ADComputerServiceAccount.md +++ b/docset/winserver2022-ps/activedirectory/Add-ADComputerServiceAccount.md @@ -40,7 +40,7 @@ account by its distinguished name, GUID, Security Identifier (SID) or Security A `$`. If you are specifying more than one account, use a comma-separated list. -> {!NOTE] +> [!NOTE] > Adding a service account is a different operation than installing the service account locally. ## EXAMPLES @@ -290,8 +290,7 @@ Accept wildcard characters: False ### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +Shows what would happen if the cmdlet runs. The cmdlet isn't run. ```yaml Type: System.Management.Automation.SwitchParameter diff --git a/docset/winserver2022-ps/activedirectory/Add-ADDomainControllerPasswordReplicationPolicy.md b/docset/winserver2022-ps/activedirectory/Add-ADDomainControllerPasswordReplicationPolicy.md index 6ae8437781..6a8724dd93 100644 --- a/docset/winserver2022-ps/activedirectory/Add-ADDomainControllerPasswordReplicationPolicy.md +++ b/docset/winserver2022-ps/activedirectory/Add-ADDomainControllerPasswordReplicationPolicy.md @@ -116,8 +116,7 @@ Accept wildcard characters: False ### -AuthType -Specifies the authentication method to use. -The acceptable values for this parameter are: +Specifies the authentication method to use. The acceptable values for this parameter are: - `Negotiate` or `0` - `Basic` or `1` diff --git a/docset/winserver2022-ps/activedirectory/Add-ADFineGrainedPasswordPolicySubject.md b/docset/winserver2022-ps/activedirectory/Add-ADFineGrainedPasswordPolicySubject.md index bd9f4c3c2d..cce36e7a6d 100644 --- a/docset/winserver2022-ps/activedirectory/Add-ADFineGrainedPasswordPolicySubject.md +++ b/docset/winserver2022-ps/activedirectory/Add-ADFineGrainedPasswordPolicySubject.md @@ -87,8 +87,7 @@ name is `Fuller`. ### -AuthType -Specifies the authentication method to use. -The acceptable values for this parameter are: +Specifies the authentication method to use. The acceptable values for this parameter are: - `Negotiate` or `0` - `Basic` or `1` @@ -230,8 +229,8 @@ Accept wildcard characters: False ### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. +Returns an object representing the item with which you are working. By default, this cmdlet does +not generate any output. ```yaml Type: System.Management.Automation.SwitchParameter @@ -287,9 +286,8 @@ Accept wildcard characters: False ### -Subjects -Specifies one or more users or groups. -To specify more than one user or group, use a comma-separated list. -You can identify a user or group by one of the following property values: +Specifies one or more users or groups. To specify more than one user or group, use a +comma-separated list. You can identify a user or group by one of the following property values: - Distinguished name (DN) - GUID (**objectGUID**) @@ -314,8 +312,7 @@ Accept wildcard characters: False ### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +Shows what would happen if the cmdlet runs. The cmdlet isn't run. ```yaml Type: System.Management.Automation.SwitchParameter diff --git a/docset/winserver2022-ps/activedirectory/Add-ADGroupMember.md b/docset/winserver2022-ps/activedirectory/Add-ADGroupMember.md index b857b7025c..2f807ac657 100644 --- a/docset/winserver2022-ps/activedirectory/Add-ADGroupMember.md +++ b/docset/winserver2022-ps/activedirectory/Add-ADGroupMember.md @@ -101,8 +101,7 @@ group `CN=AccountLeads,OU=UserAccounts` in the Europe domain. ### -AuthType -Specifies the authentication method to use. -The acceptable values for this parameter are: +Specifies the authentication method to use. The acceptable values for this parameter are: - `Negotiate` or `0` - `Basic` or `1` @@ -329,8 +328,8 @@ Accept wildcard characters: False ### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. +Returns an object representing the item with which you're working. By default, this cmdlet doesn't +generate any output. ```yaml Type: System.Management.Automation.SwitchParameter @@ -386,8 +385,7 @@ Accept wildcard characters: False ### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +Shows what would happen if the cmdlet runs. The cmdlet isn't run. ```yaml Type: System.Management.Automation.SwitchParameter diff --git a/docset/winserver2022-ps/activedirectory/Add-ADPrincipalGroupMembership.md b/docset/winserver2022-ps/activedirectory/Add-ADPrincipalGroupMembership.md index b7715eb437..2403904cb2 100644 --- a/docset/winserver2022-ps/activedirectory/Add-ADPrincipalGroupMembership.md +++ b/docset/winserver2022-ps/activedirectory/Add-ADPrincipalGroupMembership.md @@ -54,7 +54,7 @@ property of the Active Directory directory service agent object (nTDSDSA) for th ## EXAMPLES -### EXAMPLE 1 +### Example 1: Add a member to a group ```powershell Add-ADPrincipalGroupMembership -Identity SQLAdmin1 -MemberOf DlgtdAdminsPSOGroup @@ -62,7 +62,7 @@ Add-ADPrincipalGroupMembership -Identity SQLAdmin1 -MemberOf DlgtdAdminsPSOGroup This command adds the user with SAM account name `SQLAdmin1` to the group `DlgtdAdminsPSOGroup`. -### EXAMPLE 2 +### Example 2: Add filtered users to a group ```powershell Get-ADUser -Filter 'Name -like "*SvcAccount*"' | @@ -72,7 +72,7 @@ Get-ADUser -Filter 'Name -like "*SvcAccount*"' | This command gets all users with `SvcAccount` in their name and adds them to the group `SvcAccPSOGroup`. -### EXAMPLE 3 +### Example 3: Add filtered users to a distinguished name group ```powershell $params = @{ @@ -91,8 +91,7 @@ This command adds all employees in `Branch1` in the AD LDS instance `localhost:6 ### -AuthType -Specifies the authentication method to use. -The acceptable values for this parameter are: +Specifies the authentication method to use. The acceptable values for this parameter are: - `Negotiate` or `0` - `Basic` or `1` @@ -279,8 +278,8 @@ Accept wildcard characters: False ### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. +Returns an object representing the item with which you're working. By default, this cmdlet doesn't +generate any output. ```yaml Type: System.Management.Automation.SwitchParameter @@ -336,8 +335,7 @@ Accept wildcard characters: False ### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +Shows what would happen if the cmdlet runs. The cmdlet isn't run. ```yaml Type: System.Management.Automation.SwitchParameter diff --git a/docset/winserver2022-ps/activedirectory/Add-ADResourcePropertyListMember.md b/docset/winserver2022-ps/activedirectory/Add-ADResourcePropertyListMember.md index f7cea0cb72..b21542782b 100644 --- a/docset/winserver2022-ps/activedirectory/Add-ADResourcePropertyListMember.md +++ b/docset/winserver2022-ps/activedirectory/Add-ADResourcePropertyListMember.md @@ -28,7 +28,7 @@ property list in Active Directory. ## EXAMPLES -### EXAMPLE 1 +### Example 1: Add members to a resource property list ```powershell $params = @{ @@ -41,7 +41,7 @@ Add-ADResourcePropertyListMember @params This command adds the resource members named `Country` and `Authors` to the list named `Global Resource Property List`. -### EXAMPLE 2 +### Example 2: Add members to a filtered resource property list ```powershell Get-ADResourcePropertyList -Filter "Name -like 'Corporate*'" | @@ -56,8 +56,7 @@ and `Authors` to it. ### -AuthType -Specifies the authentication method to use. -The acceptable values for this parameter are: +Specifies the authentication method to use. The acceptable values for this parameter are: - `Negotiate` or `0` - `Basic` or `1` @@ -175,8 +174,8 @@ Accept wildcard characters: False ### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. +Returns an object representing the item with which you're working. By default, this cmdlet doesn't +generate any output. ```yaml Type: System.Management.Automation.SwitchParameter diff --git a/docset/winserver2022-ps/activedirectory/Clear-ADAccountExpiration.md b/docset/winserver2022-ps/activedirectory/Clear-ADAccountExpiration.md index 4e91faf3fe..3cd8c72e34 100644 --- a/docset/winserver2022-ps/activedirectory/Clear-ADAccountExpiration.md +++ b/docset/winserver2022-ps/activedirectory/Clear-ADAccountExpiration.md @@ -46,7 +46,7 @@ instance. ## EXAMPLES -### EXAMPLE 1 +### Example 1: Clear an account expiration date for a specified user ```powershell Clear-ADAccountExpiration -Identity PattiFuller @@ -54,7 +54,7 @@ Clear-ADAccountExpiration -Identity PattiFuller This command clears the account expiration date for the user with SamAccountName `PattiFuller`. -### EXAMPLE 2 +### Example 2: Clear an account expiration date by using a distinguished name ```powershell Clear-ADAccountExpiration -Identity 'CN=PattiFuller,DC=AppNC' -Server 'PATTIFU-SVR1:60000' @@ -67,8 +67,7 @@ This command clears the account expiration date for the user with DistinguishedN ### -AuthType -Specifies the authentication method to use. -The acceptable values for this parameter are: +Specifies the authentication method to use. The acceptable values for this parameter are: - `Negotiate` or `0` - `Basic` or `1` @@ -217,8 +216,8 @@ Accept wildcard characters: False ### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. +Returns an object representing the item with which you're working. By default, this cmdlet doesn't +generate any output. ```yaml Type: System.Management.Automation.SwitchParameter @@ -274,8 +273,7 @@ Accept wildcard characters: False ### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +Shows what would happen if the cmdlet runs. The cmdlet isn't run. ```yaml Type: System.Management.Automation.SwitchParameter diff --git a/docset/winserver2022-ps/activedirectory/Clear-ADClaimTransformLink.md b/docset/winserver2022-ps/activedirectory/Clear-ADClaimTransformLink.md index 191f241227..345df5d4ff 100644 --- a/docset/winserver2022-ps/activedirectory/Clear-ADClaimTransformLink.md +++ b/docset/winserver2022-ps/activedirectory/Clear-ADClaimTransformLink.md @@ -30,7 +30,7 @@ more cross-forest trust relationships in Active Directory. ## EXAMPLES -### EXAMPLE 1 +### Example 1: Remove a specified policy from a trust relationship ```powershell Clear-ADClaimTransformLink -Identity 'corp.contoso.com' -Policy DenyAllPolicy @@ -38,7 +38,7 @@ Clear-ADClaimTransformLink -Identity 'corp.contoso.com' -Policy DenyAllPolicy This command removes the policy named `DenyAllPolicy` from the `corp.contoso.com` trust. -### EXAMPLE 2 +### Example 2: Remove all policies that are applied to a trusted forest ```powershell Clear-ADClaimTransformLink -Identity 'corp.contoso.com' -TrustRole Trusted @@ -48,7 +48,7 @@ This command removes any policies that are applied to where this forest acts as in the `corp.contoso.com` trust. Effectively, this cmdlet removes any policies that are applied to claims flowing out of this forest towards it trust partner. -### EXAMPLE 3 +### Example 3: Remove a claim transformation policy from being applied to the trust relationship ```powershell $params = @{ @@ -67,8 +67,7 @@ claims coming into this from its trust partner. ### -AuthType -Specifies the authentication method to use. -The acceptable values for this parameter are: +Specifies the authentication method to use. The acceptable values for this parameter are: - `Negotiate` or `0` - `Basic` or `1` @@ -161,8 +160,8 @@ Accept wildcard characters: False ### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. +Returns an object representing the item with which you're working. By default, this cmdlet doesn't +generate any output. ```yaml Type: System.Management.Automation.SwitchParameter @@ -255,8 +254,7 @@ Accept wildcard characters: False ### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +Shows what would happen if the cmdlet runs. The cmdlet isn't run. ```yaml Type: System.Management.Automation.SwitchParameter diff --git a/docset/winserver2022-ps/activedirectory/Disable-ADAccount.md b/docset/winserver2022-ps/activedirectory/Disable-ADAccount.md index 17a8610b62..dc25eb62ad 100644 --- a/docset/winserver2022-ps/activedirectory/Disable-ADAccount.md +++ b/docset/winserver2022-ps/activedirectory/Disable-ADAccount.md @@ -46,7 +46,7 @@ instance. ## EXAMPLES -### EXAMPLE 1 +### Example 1: Disable an account by identity ```powershell Disable-ADAccount -Identity PattiFul @@ -54,7 +54,7 @@ Disable-ADAccount -Identity PattiFul This command disables the account with identity SAMAccountName `PattiFul`. -### EXAMPLE 2 +### Example 2: Disable an account by Distinguished Name ```powershell Disable-ADAccount -Identity 'CN=Patti Fuller,OU=Finance,OU=Users,DC=FABRIKAM,DC=COM' @@ -63,7 +63,7 @@ Disable-ADAccount -Identity 'CN=Patti Fuller,OU=Finance,OU=Users,DC=FABRIKAM,DC= This command disables the account with DistinguishedName `CN=Patti Fuller,OU=Finance,OU=Users,DC=FABRIKAM,DC=COM`. -### EXAMPLE 3 +### Example 3: Disable all accounts in an organizational unit ```powershell Get-ADUser -Filter 'Name -like "*"' -SearchBase "OU=Finance,OU=Users,DC=FABRIKAM,DC=COM" | @@ -77,8 +77,7 @@ This command disables all accounts in the organizational unit ### -AuthType -Specifies the authentication method to use. -The acceptable values for this parameter are: +Specifies the authentication method to use. The acceptable values for this parameter are: - `Negotiate` or `0` - `Basic` or `1` @@ -227,8 +226,8 @@ Accept wildcard characters: False ### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. +Returns an object representing the item with which you're working. By default, this cmdlet doesn't +generate any output. ```yaml Type: System.Management.Automation.SwitchParameter @@ -284,8 +283,7 @@ Accept wildcard characters: False ### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +Shows what would happen if the cmdlet runs. The cmdlet isn't run. ```yaml Type: System.Management.Automation.SwitchParameter From b3d495b86d089fb606fb2fb236d7d0abfb486c29 Mon Sep 17 00:00:00 2001 From: Ruben Guerrero Date: Tue, 30 May 2023 13:30:07 -0700 Subject: [PATCH 483/650] Update Add-AppxPackage.md Typo --- docset/winserver2022-ps/appx/Add-AppxPackage.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/appx/Add-AppxPackage.md b/docset/winserver2022-ps/appx/Add-AppxPackage.md index 6a31b475b0..92eaa8dbb5 100644 --- a/docset/winserver2022-ps/appx/Add-AppxPackage.md +++ b/docset/winserver2022-ps/appx/Add-AppxPackage.md @@ -570,7 +570,7 @@ for this parameter are: - `InstallFull`: Installs as a full app - `InstallStub`: Installs as a stub app - `UsePreference`: Uses the current - [PackageSubPreference](/uwp/api/windows.management.deployment.packagestubpreference) for the + [PackageStubPreference](/uwp/api/windows.management.deployment.packagestubpreference) for the package ```yaml From 947bb84e0adf8f789ac17843448af2589215fc85 Mon Sep 17 00:00:00 2001 From: Rob Derickson Date: Thu, 1 Jun 2023 00:23:28 -0400 Subject: [PATCH 484/650] Fix formatting for Disable-ADOptionalFeature. --- .../Disable-ADOptionalFeature.md | 209 ++++++++++++------ 1 file changed, 137 insertions(+), 72 deletions(-) diff --git a/docset/winserver2022-ps/activedirectory/Disable-ADOptionalFeature.md b/docset/winserver2022-ps/activedirectory/Disable-ADOptionalFeature.md index 440fcb02a8..291067c483 100644 --- a/docset/winserver2022-ps/activedirectory/Disable-ADOptionalFeature.md +++ b/docset/winserver2022-ps/activedirectory/Disable-ADOptionalFeature.md @@ -16,72 +16,115 @@ Disables an Active Directory optional feature. ## SYNTAX ``` -Disable-ADOptionalFeature [-WhatIf] [-Confirm] [-AuthType ] [-Credential ] - [-Identity] [-PassThru] [-Scope] [-Server ] - [-Target] [] +Disable-ADOptionalFeature [-WhatIf] [-Confirm] [-AuthType ] + [-Credential ] [-Identity] [-PassThru] + [-Scope] [-Server ] [-Target] + [] ``` ## DESCRIPTION -The **Disable-ADOptionalFeature** disables an Active Directory optional feature that is associated with a particular domain mode or forest mode. -The *Identity* parameter specifies the Active Directory optional feature that you want to disable. -You can identify an optional feature by its distinguished name, feature GUID, or object GUID. -You can also set the parameter to an optional feature object variable, such as `$` or you can pass an optional feature object through the pipeline to the *Identity* parameter. -For example, you can use the **Get-ADOptionalFeature** cmdlet to retrieve an optional feature object and then pass the object through the pipeline to the **Disable-ADOptionalFeature** cmdlet. +The `Disable-ADOptionalFeature` disables an Active Directory optional feature that is associated +with a particular domain mode or forest mode. + +The **Identity** parameter specifies the Active Directory optional feature that you want to disable. +You can identify an optional feature by its distinguished name, feature GUID, or object GUID. You +can also set the parameter to an optional feature object variable, such as +`$` or you can pass an optional feature object through the pipeline to +the **Identity** parameter. For example, you can use the `Get-ADOptionalFeature` cmdlet to retrieve +an optional feature object and then pass the object through the pipeline to the +`Disable-ADOptionalFeature` cmdlet. The **Scope** parameter specifies the scope at which the optional feature is disabled. The **Target** parameter specifies the domain or forest on which the optional feature is disabled. -You can identify the domain or forest by its fully-qualified domain name (FQDN), NetBIOS name, or the distinguished name of the domain naming context. +You can identify the domain or forest by its fully-qualified domain name (FQDN), NetBIOS name, or +the distinguished name of the domain naming context. ## EXAMPLES ### Example 1: Disable a feature for a NetBIOS target -``` -PS C:\> Disable-ADOptionalFeature -Identity 'Feature 1' -Scope ForestOrConfigurationSet -Target 'fabrikam' -Server DC1 + +```powershell +$params = @{ + Identity = 'Feature 1' + Scope = 'ForestOrConfigurationSet' + Target = 'fabrikam' + Server = 'DC1' +} +Disable-ADOptionalFeature @params ``` -This command disables the optional feature named Feature 1 for the forest that has the NetBIOS name fabrikam. -This operation should be performed against the domain controller that holds the naming flexible single master operations (FSMO) role. +This command disables the optional feature named `Feature 1` for the forest that has the NetBIOS +name `fabrikam`. This operation should be performed against the domain controller that holds the +domain naming master flexible single master operations (FSMO) role. ### Example 2: Disable a feature by distinguished name -``` -PS C:\> Disable-ADOptionalFeature -Identity 'CN=Feature 1,CN=Optional Features,CN=Directory Service,CN=Windows NT,CN=Services,CN=Configuration,DC=fabrikam,DC=com' -Scope ForestOrConfigurationSet -Target 'fabrikam.com' -Server DC1 + +```powershell +$params = @{ + Identity = 'CN=Feature 1,CN=Optional Features,CN=Directory Service,CN=Windows NT,CN=Services,CN=Configuration,DC=fabrikam,DC=com' + Scope = ForestOrConfigurationSet + Target = 'fabrikam.com' + Server = 'DC1' +} +Disable-ADOptionalFeature @params ``` -This command disables the optional feature that has the distinguished name CN=Feature 1,CN=Optional Features,CN=Directory Service,CN=Windows NT,CN=Services,CN=Configuration,DC=fabrikam,DC=com, for the forest named fabrikam.com. -This operation should be performed against the domain controller that holds the naming FSMO role. +This command disables the optional feature that has the distinguished name +`CN=Feature 1,CN=Optional Features,CN=Directory Service,CN=Windows NT,CN=Services,CN=Configuration,DC=fabrikam,DC=com`, +for the forest named `fabrikam.com`. This operation should be performed against the domain +controller that holds the domain naming master FSMO role. ### Example 3: Disable a feature by GUID -``` -PS C:\> Disable-ADOptionalFeature -Identity '54ec6e43-75a8-445b-aa7b-346a1e096659' -Scope Domain -Target 'DC=fabrikam,DC=com' -Server DC1 + +```powershell +$params = @{ + Identity = '54ec6e43-75a8-445b-aa7b-346a1e096659' + Scope = 'Domain' + Target = 'DC=fabrikam,DC=com' + Server = 'DC1' +} +Disable-ADOptionalFeature @params ``` -This command disables the optional feature that has the GUID 54ec6e43-75a8-445b-aa7b-346a1e096659 for the domain with the distinguished name DC=ntdev,DC=fabrikam,DC=com. -This operation should be performed against the domain controller that holds the naming master FSMO role. +This command disables the optional feature that has the GUID `54ec6e43-75a8-445b-aa7b-346a1e096659` +for the domain with the distinguished name `DC=ntdev,DC=fabrikam,DC=com`. This operation should be +performed against the domain controller that holds the domain naming naming master FSMO role. ### Example 4: Disable a feature for an AD LDS instance -``` -PS C:\> Disable-ADOptionalFeature -Identity 'Feature 1' -Scope ForestOrConfigurationSet -Target 'CN=Configuration,CN={0241853A-6BBF-48AA-8AE0-9C35D0C91B7B}' -Server server1:50000 + +```powershell +$params = @{ + Identity = 'Feature 1' + Scope = 'ForestOrConfigurationSet' + Target = 'CN=Configuration,CN={0241853A-6BBF-48AA-8AE0-9C35D0C91B7B}' + Server = 'server1:50000' +} +Disable-ADOptionalFeature @params ``` -This command disables the optional feature Feature 1 for the Active Directory Lightweight Directory Services (AD LDS) instance that has the distinguished name CN=Configuration,CN={0241853A-6BBF-48AA-8AE0-9C35D0C91B7B}. -This operation should be performed against the AD LDS instance that holds the naming master FSMO role. +This command disables the optional feature `Feature 1` for the Active Directory Lightweight +Directory Services (AD LDS) instance that has the distinguished name +`CN=Configuration,CN={0241853A-6BBF-48AA-8AE0-9C35D0C91B7B}`. This operation should be performed +against the AD LDS instance that holds the domain naming master FSMO role. ## PARAMETERS ### -AuthType + Specifies the authentication method to use. The acceptable values for this parameter are: -- Negotiate or 0 -- Basic or 1 +- `Negotiate` or `0` +- `Basic` or `1` -The default authentication method is Negotiate. +The default authentication method is `Negotiate`. -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. +A Secure Sockets Layer (SSL) connection is required for the `Basic` authentication method. ```yaml +Type: Microsoft.ActiveDirectory.Management.ADAuthType Type: ADAuthType Parameter Sets: (All) Aliases: @@ -95,10 +138,11 @@ Accept wildcard characters: False ``` ### -Confirm + Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf @@ -110,19 +154,24 @@ Accept wildcard characters: False ``` ### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory module for Windows PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. -To specify this parameter, you can type a user name, such as User1 or Domain01\User01 or you can specify a **PSCredential** object. -If you specify a user name for this parameter, the cmdlet prompts for a password. +Specifies the user account credentials to use to perform this task. The default credentials are the +credentials of the currently logged on user unless the cmdlet is run from an Active Directory module +for Windows PowerShell provider drive. If the cmdlet is run from such a provider drive, the account +associated with the drive is the default. + +To specify this parameter, you can type a user name, such as `User1` or `Domain01\User01` or you can +specify a **PSCredential** object. If you specify a user name for this parameter, the cmdlet prompts +for a password. -You can also create a **PSCredential** object by using a script or by using the **Get-Credential** cmdlet. -You can then set the *Credential* parameter to the **PSCredential** object. +You can also create a **PSCredential** object by using a script or by using the `Get-Credential` +cmdlet. You can then set the **Credential** parameter to the **PSCredential** object. -If the acting credentials do not have directory-level permission to perform the task, Active Directory module for Windows PowerShell returns a terminating error. +If the acting credentials do not have directory-level permission to perform the task, Active +Directory module for Windows PowerShell returns a terminating error. ```yaml +Type: System.Management.Automation.PSCredential Type: PSCredential Parameter Sets: (All) Aliases: @@ -135,21 +184,23 @@ Accept wildcard characters: False ``` ### -Identity -Specifies an Active Directory optional feature object by providing one of the following values. -The identifier in parentheses is the Lightweight Directory Access Protocol (LDAP) display name for the attribute. -The acceptable values for this parameter are: + +Specifies an Active Directory optional feature object by providing one of the following values. The +identifier in parentheses is the Lightweight Directory Access Protocol (LDAP) display name for the +attribute. The acceptable values for this parameter are: - FQDN -- Feature GUID (featureGUID) -- Object GUID (objectGUID) +- Feature GUID (**featureGUID**) +- Object GUID (**objectGUID**) -The cmdlet searches the default naming context or partition to find the object. -If two or more objects are found, the cmdlet returns a non-terminating error. +The cmdlet searches the default naming context or partition to find the object. If two or more +objects are found, the cmdlet returns a non-terminating error. -This parameter can also get this object through the pipeline or you can set this parameter to an optional feature object instance. +This parameter can also get this object through the pipeline or you can set this parameter to an +optional feature object instance. ```yaml -Type: ADOptionalFeature +Type: Microsoft.ActiveDirectory.Management.ADOptionalFeature Parameter Sets: (All) Aliases: @@ -161,11 +212,12 @@ Accept wildcard characters: False ``` ### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. + +Returns an object representing the item with which you are working. By default, this cmdlet does not +generate any output. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -177,14 +229,15 @@ Accept wildcard characters: False ``` ### -Scope -Specifies the scope at which the feature is enabled or disabled. -The acceptable values for this parameter are: -- Domain or 0 -- Forest or 1 +Specifies the scope at which the feature is enabled or disabled. The acceptable values for this +parameter are: + +- `Domain` or `0` +- `Forest` or `1` ```yaml -Type: ADOptionalFeatureScope +Type: Microsoft.ActiveDirectory.Management.ADOptionalFeatureScope Parameter Sets: (All) Aliases: Accepted values: Unknown, ForestOrConfigurationSet, Domain @@ -197,29 +250,35 @@ Accept wildcard characters: False ``` ### -Server -Specifies the Active Directory Domain Services (AD DS) instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory snapshot instance. -Specify the Active Directory Domain Services instance in one of the following ways: +Specifies the Active Directory Domain Services instance to connect to, by providing one of the +following values for a corresponding domain name or directory server. The service may be any of the +following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active +Directory snapshot instance. + +Specify the Active Directory Domain Services instance in one of the following ways: Domain name values: -- FQDN +- Fully qualified domain name - NetBIOS name -Directory server values: +Directory server values: - Fully qualified directory server name - NetBIOS name - Fully qualified directory server name and port -The default value for this parameter is determined by one of the following methods in the order that they are listed: +The default value for this parameter is determined by one of the following methods in the order that +they are listed: - By using the **Server** value from objects passed through the pipeline -- By using the server information associated with the Active Directory Domain Services Windows PowerShell provider drive, when the cmdlet runs in that drive +- By using the server information associated with the Active Directory Domain Services Windows + PowerShell provider drive, when the cmdlet runs in that drive - By using the domain of the computer running Windows PowerShell ```yaml +Type: System.String Type: String Parameter Sets: (All) Aliases: @@ -232,8 +291,9 @@ Accept wildcard characters: False ``` ### -Target -Specifies the domain or forest in which to modify the optional feature. -You can identify the target domain or forest by providing one of the following values: + +Specifies the domain or forest in which to modify the optional feature. You can identify the target +domain or forest by providing one of the following values: - FQDN of the forest or domain - NetBIOS name of the forest or domain @@ -256,11 +316,11 @@ Accept wildcard characters: False ``` ### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. + +Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi @@ -272,24 +332,29 @@ Accept wildcard characters: False ``` ### CommonParameters -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). + +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). ## INPUTS ### Microsoft.ActiveDirectory.Management.ADOptionalFeature -An optional feature object is received by the *Identity* parameter. + +An optional feature object is received by the **Identity** parameter. ## OUTPUTS ### None ## NOTES -* This cmdlet does not work with an Active Directory snapshot. -* This cmdlet does not work with a read-only domain controller. + +- This cmdlet does not work with an Active Directory snapshot. +- This cmdlet does not work with a read-only domain controller. ## RELATED LINKS [Enable-ADOptionalFeature](./Enable-ADOptionalFeature.md) [Get-ADOptionalFeature](./Get-ADOptionalFeature.md) - From 0ea97502a060b2ed4bcbbbfd22884fe538ca227b Mon Sep 17 00:00:00 2001 From: Rob Derickson Date: Thu, 1 Jun 2023 00:29:09 -0400 Subject: [PATCH 485/650] Add complete namespace to ADIdentity type. --- .../activedirectory/Disable-ADOptionalFeature.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/activedirectory/Disable-ADOptionalFeature.md b/docset/winserver2022-ps/activedirectory/Disable-ADOptionalFeature.md index 291067c483..b90cde90aa 100644 --- a/docset/winserver2022-ps/activedirectory/Disable-ADOptionalFeature.md +++ b/docset/winserver2022-ps/activedirectory/Disable-ADOptionalFeature.md @@ -304,7 +304,7 @@ The following example shows how to set this parameter to a domain naming context `-Target "DC=corp,DC=Fabrikam,DC=com"` ```yaml -Type: ADEntity +Type: Microsoft.ActiveDirectory.Management.ADEntity Parameter Sets: (All) Aliases: From e3fc16e5040444821f9bb781ef2d224b2c6a8edc Mon Sep 17 00:00:00 2001 From: Rob Derickson Date: Thu, 1 Jun 2023 00:40:32 -0400 Subject: [PATCH 486/650] Add contractions. --- .../activedirectory/Disable-ADOptionalFeature.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docset/winserver2022-ps/activedirectory/Disable-ADOptionalFeature.md b/docset/winserver2022-ps/activedirectory/Disable-ADOptionalFeature.md index b90cde90aa..8d19bc724e 100644 --- a/docset/winserver2022-ps/activedirectory/Disable-ADOptionalFeature.md +++ b/docset/winserver2022-ps/activedirectory/Disable-ADOptionalFeature.md @@ -213,7 +213,7 @@ Accept wildcard characters: False ### -PassThru -Returns an object representing the item with which you are working. By default, this cmdlet does not +Returns an object representing the item with which you're working. By default, this cmdlet does not generate any output. ```yaml @@ -317,7 +317,7 @@ Accept wildcard characters: False ### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. +Shows what would happen if the cmdlet runs. The cmdlet isn't run. ```yaml Type: System.Management.Automation.SwitchParameter @@ -350,8 +350,8 @@ An optional feature object is received by the **Identity** parameter. ## NOTES -- This cmdlet does not work with an Active Directory snapshot. -- This cmdlet does not work with a read-only domain controller. +- This cmdlet doesn't work with an Active Directory snapshot. +- This cmdlet doesn't work with a read-only domain controller. ## RELATED LINKS From 2c72893c4ac8a39730fe72c19d5133353bbe3901 Mon Sep 17 00:00:00 2001 From: Rob Derickson Date: Thu, 1 Jun 2023 00:41:43 -0400 Subject: [PATCH 487/650] Fix formatting for Enable-ADAccount. --- .../activedirectory/Enable-ADAccount.md | 200 +++++++++++------- 1 file changed, 123 insertions(+), 77 deletions(-) diff --git a/docset/winserver2022-ps/activedirectory/Enable-ADAccount.md b/docset/winserver2022-ps/activedirectory/Enable-ADAccount.md index c9cf92ad87..31cc0126e1 100644 --- a/docset/winserver2022-ps/activedirectory/Enable-ADAccount.md +++ b/docset/winserver2022-ps/activedirectory/Enable-ADAccount.md @@ -16,56 +16,71 @@ Enables an Active Directory account. ## SYNTAX ``` -Enable-ADAccount [-WhatIf] [-Confirm] [-AuthType ] [-Credential ] - [-Identity] [-Partition ] [-PassThru] [-Server ] [] +Enable-ADAccount [-WhatIf] [-Confirm] [-AuthType ] + [-Credential ] [-Identity] [-Partition ] [-PassThru] + [-Server ] [] ``` ## DESCRIPTION -The **Enable-ADAccount** cmdlet enables an Active Directory user, computer, or service account. -The *Identity* parameter specifies the Active Directory user, computer, or service account that you want to enable. -You can identify an account by its distinguished name, GUID, security identifier (SID) or Security Accounts Manager (SAM) account name. -You can also set the *Identity* parameter to an object variable such as `$`, or you can pass an account object through the pipeline to the *Identity* parameter. -For example, you can use the **Get-ADUser** cmdlet to retrieve an account object and then pass the object through the pipeline to the **Enable-ADAccount** cmdlet. -Similarly, you can use **Get-ADComputer** and **Search-ADAccount** to retrieve account objects. +The `Enable-ADAccount` cmdlet enables an Active Directory user, computer, or service account. + +The **Identity** parameter specifies the Active Directory user, computer, or service account that +you want to enable. You can identify an account by its distinguished name, GUID, security identifier +(SID) or Security Accounts Manager (SAM) account name. You can also set the **Identity** parameter +to an object variable such as `$`, or you can pass an account object through +the pipeline to the **Identity** parameter. For example, you can use the `Get-ADUser` cmdlet to +retrieve an account object and then pass the object through the pipeline to the `Enable-ADAccount` +cmdlet. Similarly, you can use `Get-ADComputer` and `Search-ADAccount` to retrieve account objects. ## EXAMPLES ### Example 1: Enable an account by identity -``` -PS C:\> Enable-ADAccount -Identity "PattiFul" + +```powershell +Enable-ADAccount -Identity 'PattiFul' ``` -This command enables the account with identity SamAccountName PattiFul. +This command enables the account with identity SamAccountName `PattiFul`. ### Example 2: Enable an account by Distinguished Name -``` -PS C:\> Enable-ADAccount -Identity "CN=Patti Fuller,OU=Finance,OU=UserAccounts,DC=FABRIKAM,DC=COM" + +```powershell +Enable-ADAccount -Identity 'CN=Patti Fuller,OU=Finance,OU=UserAccounts,DC=FABRIKAM,DC=COM' ``` -This command enables the account with DistinguishedName CN=Patti Fuller,OU=Finance,OU=UserAccounts,DC=FABRIKAM,DC=COM. +This command enables the account with DistinguishedName +`CN=Patti Fuller,OU=Finance,OU=UserAccounts,DC=FABRIKAM,DC=COM`. ### Example 3: Enable all accounts in an organizational unit using a filter -``` -PS C:\> Get-ADUser -Filter 'Name -like "*"' -SearchBase "OU=Finance,OU=UserAccounts,DC=FABRIKAM,DC=COM" | Enable-ADAccount + +```powershell +$params = @{ + Filter = 'Name -like "*"' + SearchBase = 'OU=Finance,OU=UserAccounts,DC=FABRIKAM,DC=COM' +} +Get-ADUser @params | Enable-ADAccount ``` -This command enables all accounts in the organizational unit: OU=Finance,OU=UserAccounts,DC=FABRIKAM,DC=COM. +This command enables all accounts in the organizational unit: +`OU=Finance,OU=UserAccounts,DC=FABRIKAM,DC=COM`. ## PARAMETERS ### -AuthType + Specifies the authentication method to use. The acceptable values for this parameter are: -- Negotiate or 0 -- Basic or 1 +- `Negotiate` or `0` +- `Basic` or `1` -The default authentication method is Negotiate. +The default authentication method is `Negotiate`. -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. +A Secure Sockets Layer (SSL) connection is required for the `Basic` authentication method. ```yaml +Type: Microsoft.ActiveDirectory.Management.ADAuthType Type: ADAuthType Parameter Sets: (All) Aliases: @@ -79,10 +94,11 @@ Accept wildcard characters: False ``` ### -Confirm + Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf @@ -94,19 +110,24 @@ Accept wildcard characters: False ``` ### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory module for Windows PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. -To specify this parameter, you can type a user name, such as User1 or Domain01\User01 or you can specify a **PSCredential** object. -If you specify a user name for this parameter, the cmdlet prompts for a password. +Specifies the user account credentials to use to perform this task. The default credentials are the +credentials of the currently logged on user unless the cmdlet is run from an Active Directory module +for Windows PowerShell provider drive. If the cmdlet is run from such a provider drive, the account +associated with the drive is the default. -You can also create a **PSCredential** object by using a script or by using the **Get-Credential** cmdlet. -You can then set the *Credential* parameter to the **PSCredential** object. +To specify this parameter, you can type a user name, such as `User1` or `Domain01\User01` or you can +specify a **PSCredential** object. If you specify a user name for this parameter, the cmdlet prompts +for a password. -If the acting credentials do not have directory-level permission to perform the task, Active Directory module for Windows PowerShell returns a terminating error. +You can also create a **PSCredential** object by using a script or by using the `Get-Credential` +cmdlet. You can then set the **Credential** parameter to the **PSCredential** object. + +If the acting credentials do not have directory-level permission to perform the task, Active +Directory module for Windows PowerShell returns a terminating error. ```yaml +Type: System.Management.Automation.PSCredential Type: PSCredential Parameter Sets: (All) Aliases: @@ -119,19 +140,21 @@ Accept wildcard characters: False ``` ### -Identity -Specifies an Active Directory account object by providing one of the following property values. -The identifier in parentheses is the Lightweight Directory Access Protocol (LDAP) display name for the attribute. -The acceptable values for this parameter are: + +Specifies an Active Directory account object by providing one of the following property values. The +identifier in parentheses is the Lightweight Directory Access Protocol (LDAP) display name for the +attribute. The acceptable values for this parameter are: - A distinguished name -- A GUID (objectGUID) -- A Security Identifier (objectSid) -- A SAM account name (sAMAccountName) +- A GUID (**objectGUID**) +- A Security Identifier (**objectSid**) +- A SAM account name (**sAMAccountName**) -The cmdlet searches the default naming context or partition to find the object. -If two or more objects are found, the cmdlet returns a non-terminating error. +The cmdlet searches the default naming context or partition to find the object. If two or more +objects are found, the cmdlet returns a non-terminating error. -This parameter can also get this object through the pipeline or you can set this parameter to an account object instance. +This parameter can also get this object through the pipeline or you can set this parameter to an +account object instance. Derived types such as the following are also accepted: @@ -140,7 +163,7 @@ Derived types such as the following are also accepted: - **Microsoft.ActiveDirectory.Management.ADServiceAccount** ```yaml -Type: ADAccount +Type: Microsoft.ActiveDirectory.Management.ADAccount Parameter Sets: (All) Aliases: @@ -152,29 +175,40 @@ Accept wildcard characters: False ``` ### -Partition -Specifies the distinguished name of an Active Directory partition. -The distinguished name must be one of the naming contexts on the current directory server. -The cmdlet searches this partition to find the object defined by the *Identity* parameter. -In many cases, a default value is used for the *Partition* parameter if no value is specified. -The rules for determining the default value are given below. -Note that rules listed first are evaluated first and once a default value can be determined, no further rules are evaluated. - -In Active Directory Domain Services (AD DS) environments, a default value for *Partition* is set in the following cases: - -- If the *Identity* parameter is set to a distinguished name, the default value of *Partition* is automatically generated from this distinguished name. -- If running cmdlets from an Active Directory provider drive, the default value of *Partition* is automatically generated from the current path in the drive. -- If none of the previous cases apply, the default value of *Partition* is set to the default partition or naming context of the target domain. - -In Active Directory Lightweight Directory Services (AD LDS) environments, a default value for *Partition* is set in the following cases: - -- If the *Identity* parameter is set to a distinguished name, the default value of *Partition* is automatically generated from this distinguished name. -- If running cmdlets from an Active Directory provider drive, the default value of *Partition* is automatically generated from the current path in the drive. -- If the target AD LDS instance has a default naming context, the default value of *Partition* is set to the default naming context. -To specify a default naming context for an AD LDS environment, set the **msDS-defaultNamingContext** property of the Active Directory directory service agent (DSA) object (**nTDSDSA**) for the AD LDS instance. -- If none of the previous cases apply, the *Partition* parameter will not take any default value. +Specifies the distinguished name of an Active Directory partition. The distinguished name must be +one of the naming contexts on the current directory server. The cmdlet searches this partition to +find the object defined by the **Identity** parameter. + +In many cases, a default value is used for the **Partition** parameter if no value is specified. The +rules for determining the default value are given below. Note that rules listed first are evaluated +first and once a default value can be determined, no further rules are evaluated. + +In Active Directory Domain Services environments, a default value for **Partition** is set in the +following cases: + +- If the **Identity** parameter is set to a distinguished name, the default value of **Partition** + is automatically generated from this distinguished name. +- If running cmdlets from an Active Directory provider drive, the default value of **Partition** is + automatically generated from the current path in the drive. +- If none of the previous cases apply, the default value of **Partition** is set to the default + partition or naming context of the target domain. + +In Active Directory Lightweight Directory Services (AD LDS) environments, a default value for +**Partition** is set in the following cases: + +- If the **Identity** parameter is set to a distinguished name, the default value of **Partition** + is automatically generated from this distinguished name. +- If running cmdlets from an Active Directory provider drive, the default value of **Partition** is + automatically generated from the current path in the drive. +- If the target AD LDS instance has a default naming context, the default value of **Partition** is + set to the default naming context. To specify a default naming context for an AD LDS environment, + set the **msDS-defaultNamingContext** property of the Active Directory directory service agent + (DSA) object (**nTDSDSA**) for the AD LDS instance. +- If none of the previous cases apply, the **Partition** parameter will not take any default value. ```yaml +Type: System.String Type: String Parameter Sets: (All) Aliases: @@ -187,11 +221,12 @@ Accept wildcard characters: False ``` ### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. + +Returns an object representing the item with which you're working. By default, this cmdlet does not +generate any output. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -203,29 +238,35 @@ Accept wildcard characters: False ``` ### -Server -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory snapshot instance. -Specify the Active Directory Domain Services instance in one of the following ways: +Specifies the Active Directory Domain Services instance to connect to, by providing one of the +following values for a corresponding domain name or directory server. The service may be any of the +following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active +Directory snapshot instance. + +Specify the Active Directory Domain Services instance in one of the following ways: Domain name values: - Fully qualified domain name - NetBIOS name -Directory server values: +Directory server values: - Fully qualified directory server name - NetBIOS name - Fully qualified directory server name and port -The default value for this parameter is determined by one of the following methods in the order that they are listed: +The default value for this parameter is determined by one of the following methods in the order that +they are listed: - By using the **Server** value from objects passed through the pipeline -- By using the server information associated with the Active Directory Domain Services Windows PowerShell provider drive, when the cmdlet runs in that drive +- By using the server information associated with the Active Directory Domain Services Windows + PowerShell provider drive, when the cmdlet runs in that drive - By using the domain of the computer running Windows PowerShell ```yaml +Type: System.String Type: String Parameter Sets: (All) Aliases: @@ -238,11 +279,11 @@ Accept wildcard characters: False ``` ### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. + +Shows what would happen if the cmdlet runs. The cmdlet isn't run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi @@ -254,12 +295,17 @@ Accept wildcard characters: False ``` ### CommonParameters -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). + +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). ## INPUTS ### Microsoft.ActiveDirectory.Management.ADAccount -An account object is received by the *Identity* parameter. + +An account object is received by the **Identity** parameter. Derived types, such as the following, are also accepted: @@ -272,8 +318,9 @@ Derived types, such as the following, are also accepted: ### None ## NOTES -* This cmdlet does not work with an Active Directory snapshot. -* This cmdlet does not work with a read-only domain controller. + +- This cmdlet doesn't work with an Active Directory snapshot. +- This cmdlet doesn't work with a read-only domain controller. ## RELATED LINKS @@ -292,4 +339,3 @@ Derived types, such as the following, are also accepted: [Set-ADAccountPassword](./Set-ADAccountPassword.md) [Unlock-ADAccount](./Unlock-ADAccount.md) - From cc4cdbc8bccd699410e046e55c6d759ff23686a8 Mon Sep 17 00:00:00 2001 From: Rob Derickson Date: Thu, 1 Jun 2023 00:54:20 -0400 Subject: [PATCH 488/650] Fix formatting for Enable-ADOptionalFeature. --- .../Enable-ADOptionalFeature.md | 198 +++++++++++------- 1 file changed, 121 insertions(+), 77 deletions(-) diff --git a/docset/winserver2022-ps/activedirectory/Enable-ADOptionalFeature.md b/docset/winserver2022-ps/activedirectory/Enable-ADOptionalFeature.md index 2214a1bb1b..93269cc558 100644 --- a/docset/winserver2022-ps/activedirectory/Enable-ADOptionalFeature.md +++ b/docset/winserver2022-ps/activedirectory/Enable-ADOptionalFeature.md @@ -16,65 +16,83 @@ Enables an Active Directory optional feature. ## SYNTAX ``` -Enable-ADOptionalFeature [-WhatIf] [-Confirm] [-AuthType ] [-Credential ] - [-Identity] [-PassThru] [-Scope] [-Server ] - [-Target] [] +Enable-ADOptionalFeature [-WhatIf] [-Confirm] [-AuthType ] + [-Credential ] [-Identity] [-PassThru] + [-Scope] [-Server ] [-Target] + [] ``` ## DESCRIPTION -The **Enable-ADOptionalFeature** cmdlet enables an Active Directory optional feature that is associated with a particular domain mode or forest mode. -Active Directory optional features that depend on a specified domain mode or forest mode must be explicitly enabled after the domain mode or forest mode is set. -The *Identity* parameter specifies the Active Directory optional feature that you want to enable. -You can identify an optional feature by its distinguished name, feature GUID, or object GUID. -You can also set the parameter to an optional feature object variable, such as `$` or you can pass an optional feature object through the pipeline to the *Identity* parameter. -For example, you can use the **Get-ADOptionalFeature** cmdlet to retrieve an optional feature object and then pass the object through the pipeline to the **Enable-ADOptionalFeature** cmdlet. +The `Enable-ADOptionalFeature` cmdlet enables an Active Directory optional feature that is +associated with a particular domain mode or forest mode. Active Directory optional features that +depend on a specified domain mode or forest mode must be explicitly enabled after the domain mode or +forest mode is set. -The *Scope* parameter specifies the scope at which the optional feature is enabled. +The **Identity** parameter specifies the Active Directory optional feature that you want to enable. +You can identify an optional feature by its distinguished name, feature GUID, or object GUID. You +can also set the parameter to an optional feature object variable, such as +`$` or you can pass an optional feature object through the pipeline to +the **Identity** parameter. For example, you can use the `Get-ADOptionalFeature` cmdlet to retrieve +an optional feature object and then pass the object through the pipeline to the +`Enable-ADOptionalFeature` cmdlet. -The *Target* parameter specifies the domain or forest on which the optional feature is enabled. -You can identify the domain or forest by its fully-qualified domain name (FQDN), NetBIOS name, or distinguished name of the domain naming context. +The **Scope** parameter specifies the scope at which the optional feature is enabled. + +The **Target** parameter specifies the domain or forest on which the optional feature is enabled. +You can identify the domain or forest by its fully-qualified domain name (FQDN), NetBIOS name, or +distinguished name of the domain naming context. ## EXAMPLES ### Example 1: Enable the Recycle Bin feature for a forest -``` -PS C:\> Enable-ADOptionalFeature -Identity 'Recycle Bin Feature' -Scope ForestOrConfigurationSet -Target 'fabrikam.com' -Server dc1 + +```powershell +$params = @{ + Identity = 'Recycle Bin Feature' + Scope = 'ForestOrConfigurationSet' + Target = 'fabrikam.com' + Server = 'dc1' +} +Enable-ADOptionalFeature @params ``` -This command enables the optional feature Recycle Bin feature for the forest fabrikam.com. -This operation must be performed on the domain controller that holds the naming flexible single master operations (FSMO) role. +This command enables the optional feature `Recycle Bin Feature` for the forest `fabrikam.com`. This +operation must be performed on the domain controller that holds the domain naming master flexible +single master operations (FSMO) role. ### Example 2: Enable the Recycle bin for an AD LDS instance -``` -PS C:\> Enable-ADOptionalFeature -Identity 'Feature 1' -Scope ForestOrConfigurationSet -Target 'CN=Configuration,CN={0241853A-6BBF-48AA-8AE0-9C35D0C91B7B}' -Server lds.fabrikam.com:50000 -``` - -This command enables the optional feature Recycle Bin feature for the AD LDS instance lds.fabrikam.com. -This operation must be performed on the AD LDS instance that holds the naming FSMO role. -### Example 3: Set the ForestMode on an AD LDS instance -``` -PS C:\> Set-ADObject -Identity "CN=Partitions,CN=Configuration,CN={4F971828-5BE4-4E94-B532-58F2BFB6A3A5}" -Replace @{"msDS-Behavior-Version"=4} +```powershell +$params = @{ + Identity = 'Feature 1' + Scope = 'ForestOrConfigurationSet' + Target = 'CN=Configuration,CN={0241853A-6BBF-48AA-8AE0-9C35D0C91B7B}' + Server = 'lds.fabrikam.com:50000' +} +Enable-ADOptionalFeature @params ``` -This command sets the **ForestMode** (Forest Functional Level) to Windows2008R2Forest on an AD LDS instance. -The **ForestMode** must be Windows2008R2Forest or later in order to enable the Recycle Bin feature for AD LDS. +This command enables the optional feature `Feature 1` for the AD LDS instance `lds.fabrikam.com`. +This operation must be performed on the AD LDS instance that holds the domain naming master FSMO +role. ## PARAMETERS ### -AuthType + Specifies the authentication method to use. The acceptable values for this parameter are: -- Negotiate or 0 -- Basic or 1 +- `Negotiate` or `0` +- `Basic` or `1` -The default authentication method is Negotiate. +The default authentication method is `Negotiate`. -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. +A Secure Sockets Layer (SSL) connection is required for the `Basic` authentication method. ```yaml +Type: Microsoft.ActiveDirectory.Management.ADAuthType Type: ADAuthType Parameter Sets: (All) Aliases: @@ -88,10 +106,11 @@ Accept wildcard characters: False ``` ### -Confirm + Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf @@ -103,19 +122,24 @@ Accept wildcard characters: False ``` ### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory module for Windows PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. -To specify this parameter, you can type a user name, such as User1 or Domain01\User01 or you can specify a **PSCredential** object. -If you specify a user name for this parameter, the cmdlet prompts for a password. +Specifies the user account credentials to use to perform this task. The default credentials are the +credentials of the currently logged on user unless the cmdlet is run from an Active Directory module +for Windows PowerShell provider drive. If the cmdlet is run from such a provider drive, the account +associated with the drive is the default. -You can also create a **PSCredential** object by using a script or by using the **Get-Credential** cmdlet. -You can then set the *Credential* parameter to the **PSCredential** object. +To specify this parameter, you can type a user name, such as `User1` or `Domain01\User01` or you can +specify a **PSCredential** object. If you specify a user name for this parameter, the cmdlet prompts +for a password. -If the acting credentials do not have directory-level permission to perform the task, Active Directory module for Windows PowerShell returns a terminating error. +You can also create a **PSCredential** object by using a script or by using the `Get-Credential` +cmdlet. You can then set the **Credential** parameter to the **PSCredential** object. + +If the acting credentials do not have directory-level permission to perform the task, Active +Directory module for Windows PowerShell returns a terminating error. ```yaml +Type: System.Management.Automation.PSCredential Type: PSCredential Parameter Sets: (All) Aliases: @@ -128,21 +152,23 @@ Accept wildcard characters: False ``` ### -Identity -Specifies an Active Directory optional feature object by providing one of the following values. -The identifier in parentheses is the Lightweight Directory Access Protocol (LDAP) display name for the attribute. -The acceptable values for this parameter are: + +Specifies an Active Directory optional feature object by providing one of the following values. The +identifier in parentheses is the Lightweight Directory Access Protocol (LDAP) display name for the +attribute. The acceptable values for this parameter are: - A FQDN -- A feature GUID (featureGUID) -- An object GUID (objectGUID) +- A feature GUID (**featureGUID**) +- An object GUID (**objectGUID**) -The cmdlet searches the default naming context or partition to find the object. -If two or more objects are found, the cmdlet returns a non-terminating error. +The cmdlet searches the default naming context or partition to find the object. If two or more +objects are found, the cmdlet returns a non-terminating error. -This parameter can also get this object through the pipeline or you can set this parameter to an optional feature object instance. +This parameter can also get this object through the pipeline or you can set this parameter to an +optional feature object instance. ```yaml -Type: ADOptionalFeature +Type: Microsoft.ActiveDirectory.Management.ADOptionalFeature Parameter Sets: (All) Aliases: @@ -154,11 +180,12 @@ Accept wildcard characters: False ``` ### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. + +Returns an object representing the item with which you're working. By default, this cmdlet doesn't +generate any output. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -170,14 +197,15 @@ Accept wildcard characters: False ``` ### -Scope -Specifies the scope at which the feature is enabled or disabled. -The acceptable values for this parameter are: -- Domain or 0 -- Forest or 1 +Specifies the scope at which the feature is enabled or disabled. The acceptable values for this +parameter are: + +- `Domain` or `0` +- `Forest` or `1` ```yaml -Type: ADOptionalFeatureScope +Type: Microsoft.ActiveDirectory.Management.ADOptionalFeatureScope Parameter Sets: (All) Aliases: Accepted values: Unknown, ForestOrConfigurationSet, Domain @@ -190,29 +218,35 @@ Accept wildcard characters: False ``` ### -Server -Specifies the Active Directory Domain Services (AD DS) instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services (AD LDS), AD DS, or Active Directory snapshot instance. -Specify the AD DS instance in one of the following ways: +Specifies the Active Directory Domain Services instance to connect to, by providing one of the +following values for a corresponding domain name or directory server. The service may be any of the +following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active +Directory snapshot instance. + +Specify the Active Directory Domain Services instance in one of the following ways: Domain name values: -- FQDN +- Fully qualified domain name - NetBIOS name -Directory server values: +Directory server values: - Fully qualified directory server name - NetBIOS name - Fully qualified directory server name and port -The default value for this parameter is determined by one of the following methods in the order that they are listed: +The default value for this parameter is determined by one of the following methods in the order that +they are listed: - By using the **Server** value from objects passed through the pipeline -- By using the server information associated with the AD DS Windows PowerShell provider drive, when the cmdlet runs in that drive +- By using the server information associated with the Active Directory Domain Services Windows + PowerShell provider drive, when the cmdlet runs in that drive - By using the domain of the computer running Windows PowerShell ```yaml +Type: System.String Type: String Parameter Sets: (All) Aliases: @@ -225,18 +259,19 @@ Accept wildcard characters: False ``` ### -Target -Specifies the domain or forest in which to modify the optional feature. -You can identify the target domain or forest by providing one of the following values: + +Specifies the domain or forest in which to modify the optional feature. You can identify the target +domain or forest by providing one of the following values: - FQDN of the forest or domain - NetBIOS name of the forest or domain -You can also, where *Scope* is set to domain (not forest), use the following: +When **Scope** is set to `Domain`, you can use the following value: - Distinguished name of the domain naming context ```yaml -Type: ADEntity +Type: Microsoft.ActiveDirectory.Management.ADEntity Parameter Sets: (All) Aliases: @@ -248,11 +283,11 @@ Accept wildcard characters: False ``` ### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. + +Shows what would happen if the cmdlet runs. The cmdlet isn't run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi @@ -264,25 +299,34 @@ Accept wildcard characters: False ``` ### CommonParameters -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). + +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). ## INPUTS ### Microsoft.ActiveDirectory.Management.ADOptionalFeature -An optional feature object is received by the *Identity* parameter. + +An optional feature object is received by the **Identity** parameter. ## OUTPUTS ### None ## NOTES -* This cmdlet does not work with an Active Directory snapshot. -* This cmdlet does not work with a read-only domain controller. -* Recycle Bin Feature: Once the Active Directory Recycle Bin is enabled, all objects deleted before the Active Directory Recycle Bin was enabled (tombstone objects) become recycled objects. They are no longer visible in the Deleted Objects container and they cannot be recovered using Active Directory Recycle Bin. The only way to restore these objects is through an authoritative restore from an AD DS backup taken before the Active Directory Recycle Bin was enabled. + +- This cmdlet doesn't work with an Active Directory snapshot. +- This cmdlet doesn't work with a read-only domain controller. +- Recycle Bin Feature: Once the Active Directory Recycle Bin is enabled, all objects deleted before + the Active Directory Recycle Bin was enabled (tombstone objects) become recycled objects. They are + no longer visible in the Deleted Objects container and they cannot be recovered using Active + Directory Recycle Bin. The only way to restore these objects is through an authoritative restore + from an AD DS backup taken before the Active Directory Recycle Bin was enabled. ## RELATED LINKS [Disable-ADOptionalFeature](./Disable-ADOptionalFeature.md) [Get-ADOptionalFeature](./Get-ADOptionalFeature.md) - From 140ab1972a1c9faae3dd1367a90331c1f7debc0a Mon Sep 17 00:00:00 2001 From: Rob Derickson Date: Thu, 1 Jun 2023 01:07:39 -0400 Subject: [PATCH 489/650] Fix formatting for Get-ADAccountAuthorizationGroup. --- .../Get-ADAccountAuthorizationGroup.md | 199 +++++++++++------- 1 file changed, 128 insertions(+), 71 deletions(-) diff --git a/docset/winserver2022-ps/activedirectory/Get-ADAccountAuthorizationGroup.md b/docset/winserver2022-ps/activedirectory/Get-ADAccountAuthorizationGroup.md index 1267d42fe9..db369a14a0 100644 --- a/docset/winserver2022-ps/activedirectory/Get-ADAccountAuthorizationGroup.md +++ b/docset/winserver2022-ps/activedirectory/Get-ADAccountAuthorizationGroup.md @@ -16,25 +16,34 @@ Gets the accounts token group information. ## SYNTAX ``` -Get-ADAccountAuthorizationGroup [-AuthType ] [-Credential ] [-Identity] - [-Partition ] [-Server ] [] +Get-ADAccountAuthorizationGroup [-AuthType ] [-Credential ] + [-Identity] [-Partition ] [-Server ] [] ``` ## DESCRIPTION -The **Get-ADAccountAuthorizationGroup** cmdlet gets the security groups from the specified user, computer, or service accounts token. -This cmdlet requires a global catalog to perform the group search. -If the forest that contains the account does not have a global catalog, the cmdlet returns a non-terminating error. -The *Identity* parameter specifies the user, computer, or service account. -You can identify a user, computer, or service account object by its distinguished name, GUID, security identifier (SID), Security Account Manager (SAM) account name or user principal name. -You can also set the *Identity* parameter to an account object variable, such as `$`, or pass an account object through the pipeline to the *Identity* parameter. -For example, you can use the Get-ADUser, Get-ADComputer, Get-ADServiceAccount or Search-ADAccount cmdlets to retrieve an account object and then pass the object through the pipeline to the Get-ADAccountAuthorizationGroup cmdlet. +The `Get-ADAccountAuthorizationGroup` cmdlet gets the security groups from the specified user, +computer, or service accounts token. This cmdlet requires a global catalog to perform the group +search. If the forest that contains the account doesn't have a global catalog, the cmdlet returns a +non-terminating error. + +The **Identity** parameter specifies the user, computer, or service account. You can identify a +user, computer, or service account object by its distinguished name, GUID, security identifier +(SID), Security Account Manager (SAM) account name or user principal name. You can also set the +**Identity** parameter to an account object variable, such as `$`, or pass an +account object through the pipeline to the **Identity** parameter. For example, you can use the +`Get-ADUser`, `Get-ADComputer`, `Get-ADServiceAccount` or `Search-ADAccount` cmdlets to retrieve an account +object and then pass the object through the pipeline to the `Get-ADAccountAuthorizationGroup` cmdlet. ## EXAMPLES ### Example 1: Get all security groups for a specified account + +```powershell +Get-ADAccountAuthorizationGroup -Identity DavidCh ``` -PS C:\> Get-ADAccountAuthorizationGroup -Identity DavidCh + +```output GroupScope : DomainLocal objectGUID : 00000000-0000-0000-0000-000000000000 GroupCategory : Security @@ -75,11 +84,16 @@ SID : S-1-5-32-545 distinguishedName : CN=Users,CN=Builtin,DC=Fabrikam,DC=com ``` -This command returns all security groups for the specified account with SamAccountName DavidCh. +This command returns all security groups for the specified account with **SamAccountName** +`DavidCh`. ### Example 2: Get all security groups for a specified account using a distinguished name + +```powershell +Get-ADAccountAuthorizationGroup -Identity "CN=DavidCh,DC=AppNC" -Server ":50000" ``` -PS C:\> Get-ADAccountAuthorizationGroup -Identity "CN=DavidCh,DC=AppNC" -Server ":50000" + +```output distinguishedName : CN=AdminGroup,DC=AppNC GroupCategory : Security GroupScope : Global @@ -89,11 +103,18 @@ objectGUID : 4d72873f-fe09-4834-9ada-a905636d10df SamAccountName : SID : S-1-510474493-936115905-4021890855-1253703389-3958791574-3542197427 ``` -This command returns all security groups for the specified account with DistinguishedName cn=DavidCh,dc=AppNC in the AD LDS instance \:50000. +This command returns all security groups for the specified account with **DistinguishedName** +`CN=DavidCh,DC=AppNC` in the AD LDS instance `:50000`. ### Example 3: Get a filtered list of security groups + +```powershell +Get-ADAccountAuthorizationGroup -Server ":50000" -Identity Administrator | + Where-Object { $_.objectClass -ne $null } | + Select-Object name, objectClass ``` -PS C:\> Get-ADAccountAuthorizationGroup -Server ":50000" -Identity Administrator | where { $_.objectClass -ne $null } | ft name, objectClass + +```output name objectClass ---- ----------- Domain Users group @@ -107,23 +128,29 @@ Schema Admins group Denied RODC Password Replication Group group ``` -This command returns a filtered list of built-in security groups that do not have an empty or null setting for objectclass, such as Everyone or Authenticated Users. -Note: This type of filtering of groups in output can be useful when piping the output of this cmdlet to be used as input to other Active Directory cmdlets. +This command returns a filtered list of built-in security groups that do not have an empty or null +setting for **objectClass**, such as **Everyone** or **Authenticated Users**. + +> [!NOTE]: +> This type of filtering of groups in output can be useful when piping the output of this +> cmdlet to be used as input to other Active Directory cmdlets. ## PARAMETERS ### -AuthType + Specifies the authentication method to use. The acceptable values for this parameter are: -- Negotiate or 0 -- Basic or 1 +- `Negotiate` or `0` +- `Basic` or `1` -The default authentication method is Negotiate. +The default authentication method is `Negotiate`. -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. +A Secure Sockets Layer (SSL) connection is required for the `Basic` authentication method. ```yaml +Type: Microsoft.ActiveDirectory.Management.ADAuthType Type: ADAuthType Parameter Sets: (All) Aliases: @@ -137,19 +164,24 @@ Accept wildcard characters: False ``` ### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory module for Windows PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. -To specify this parameter, you can type a user name, such as User1 or Domain01\User01 or you can specify a **PSCredential** object. -If you specify a user name for this parameter, the cmdlet prompts for a password. +Specifies the user account credentials to use to perform this task. The default credentials are the +credentials of the currently logged on user unless the cmdlet is run from an Active Directory module +for Windows PowerShell provider drive. If the cmdlet is run from such a provider drive, the account +associated with the drive is the default. -You can also create a **PSCredential** object by using a script or by using the **Get-Credential** cmdlet. -You can then set the *Credential* parameter to the **PSCredential** object. +To specify this parameter, you can type a user name, such as `User1` or `Domain01\User01` or you can +specify a **PSCredential** object. If you specify a user name for this parameter, the cmdlet prompts +for a password. -If the acting credentials do not have directory-level permission to perform the task, Active Directory module for Windows PowerShell returns a terminating error. +You can also create a **PSCredential** object by using a script or by using the `Get-Credential` +cmdlet. You can then set the **Credential** parameter to the **PSCredential** object. + +If the acting credentials do not have directory-level permission to perform the task, Active +Directory module for Windows PowerShell returns a terminating error. ```yaml +Type: System.Management.Automation.PSCredential Type: PSCredential Parameter Sets: (All) Aliases: @@ -162,28 +194,30 @@ Accept wildcard characters: False ``` ### -Identity -Specifies an Active Directory account object by providing one of the following property values. -The identifier in parentheses is the Lightweight Directory Access Protocol (LDAP) display name for the attribute. -The acceptable values for this parameter are: + +Specifies an Active Directory account object by providing one of the following property values. The +identifier in parentheses is the Lightweight Directory Access Protocol (LDAP) display name for the +attribute. The acceptable values for this parameter are: - A distinguished name -- A GUID (objectGUID) -- A Security Identifier (objectSid) -- A SAM Account Name (SAMAccountName) +- A GUID (**objectGUID**) +- A Security Identifier (**objectSid**) +- A SAM Account Name (**SAMAccountName**) -The cmdlet searches the default naming context or partition to find the object. -If two or more objects are found, the cmdlet returns a non-terminating error. +The cmdlet searches the default naming context or partition to find the object. If two or more +objects are found, the cmdlet returns a non-terminating error. -This parameter can also get this object through the pipeline or you can set this parameter to an account object instance. +This parameter can also get this object through the pipeline or you can set this parameter to an +account object instance. -Derived types such as the following are also accepted: +Derived types such as the following are also accepted: - **Microsoft.ActiveDirectory.Management.ADServiceAccount** - **Microsoft.ActiveDirectory.Management.ADComputer** - **Microsoft.ActiveDirectory.Management.ADUser** ```yaml -Type: ADAccount +Type: Microsoft.ActiveDirectory.Management.ADAccount Parameter Sets: (All) Aliases: @@ -195,29 +229,40 @@ Accept wildcard characters: False ``` ### -Partition -Specifies the distinguished name of an Active Directory partition. -The distinguished name must be one of the naming contexts on the current directory server. -The cmdlet searches this partition to find the object defined by the *Identity* parameter. - -In many cases, a default value is used for the *Partition* parameter if no value is specified. -The rules for determining the default value are given below. -Note that rules listed first are evaluated first and once a default value can be determined, no further rules are evaluated. - -In Active Directory Domain Services (AD DS) environments, a default value for *Partition* is set in the following cases: -- If the *Identity* parameter is set to a distinguished name, the default value of *Partition* is automatically generated from this distinguished name. -- If running cmdlets from an Active Directory provider drive, the default value of *Partition* is automatically generated from the current path in the drive. -- If none of the previous cases apply, the default value of *Partition* is set to the default partition or naming context of the target domain. - -In Active Directory Lightweight Directory Services (AD LDS) environments, a default value for *Partition* is set in the following cases: - -- If the *Identity* parameter is set to a distinguished name, the default value of *Partition* is automatically generated from this distinguished name. -- If running cmdlets from an Active Directory provider drive, the default value of *Partition* is automatically generated from the current path in the drive. -- If the target AD LDS instance has a default naming context, the default value of *Partition* is set to the default naming context. -To specify a default naming context for an AD LDS environment, set the **msDS-defaultNamingContext** property of the Active Directory directory service agent object (**nTDSDSA**) for the AD LDS instance. -- If none of the previous cases apply, the *Partition* parameter will not take any default value. +Specifies the distinguished name of an Active Directory partition. The distinguished name must be +one of the naming contexts on the current directory server. The cmdlet searches this partition to +find the object defined by the **Identity** parameter. + +In many cases, a default value is used for the **Partition** parameter if no value is specified. The +rules for determining the default value are given below. Note that rules listed first are evaluated +first and once a default value can be determined, no further rules are evaluated. + +In Active Directory Domain Services environments, a default value for **Partition** is set in the +following cases: + +- If the **Identity** parameter is set to a distinguished name, the default value of **Partition** + is automatically generated from this distinguished name. +- If running cmdlets from an Active Directory provider drive, the default value of **Partition** is + automatically generated from the current path in the drive. +- If none of the previous cases apply, the default value of **Partition** is set to the default + partition or naming context of the target domain. + +In Active Directory Lightweight Directory Services (AD LDS) environments, a default value for +**Partition** is set in the following cases: + +- If the **Identity** parameter is set to a distinguished name, the default value of **Partition** + is automatically generated from this distinguished name. +- If running cmdlets from an Active Directory provider drive, the default value of **Partition** is + automatically generated from the current path in the drive. +- If the target AD LDS instance has a default naming context, the default value of **Partition** is + set to the default naming context. To specify a default naming context for an AD LDS environment, + set the **msDS-defaultNamingContext** property of the Active Directory directory service agent + (DSA) object (**nTDSDSA**) for the AD LDS instance. +- If none of the previous cases apply, the **Partition** parameter will not take any default value. ```yaml +Type: System.String Type: String Parameter Sets: (All) Aliases: @@ -230,29 +275,35 @@ Accept wildcard characters: False ``` ### -Server -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory snapshot instance. -Specify the Active Directory Domain Services instance in one of the following ways: +Specifies the Active Directory Domain Services instance to connect to, by providing one of the +following values for a corresponding domain name or directory server. The service may be any of the +following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active +Directory snapshot instance. + +Specify the Active Directory Domain Services instance in one of the following ways: Domain name values: - Fully qualified domain name - NetBIOS name -Directory server values: +Directory server values: - Fully qualified directory server name - NetBIOS name - Fully qualified directory server name and port -The default value for this parameter is determined by one of the following methods in the order that they are listed: +The default value for this parameter is determined by one of the following methods in the order that +they are listed: -- By using the *Server* value from objects passed through the pipeline -- By using the server information associated with the Active Directory Domain Services Windows PowerShell provider drive, when the cmdlet runs in that drive +- By using the **Server** value from objects passed through the pipeline +- By using the server information associated with the Active Directory Domain Services Windows + PowerShell provider drive, when the cmdlet runs in that drive - By using the domain of the computer running Windows PowerShell ```yaml +Type: System.String Type: String Parameter Sets: (All) Aliases: @@ -265,13 +316,18 @@ Accept wildcard characters: False ``` ### CommonParameters -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). + +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). ## INPUTS ### Microsoft.ActiveDirectory.Management.ADAccount -An account object that represents the user, computer or service account is received by the *Identity* parameter. -Derived types, such as the following are also accepted: + +An account object that represents the user, computer or service account is received by the +**Identity** parameter. Derived types, such as the following are also accepted: - **Microsoft.ActiveDirectory.Management.ADUser** - **Microsoft.ActiveDirectory.Management.ADComputer** @@ -280,10 +336,12 @@ Derived types, such as the following are also accepted: ## OUTPUTS ### Microsoft.ActiveDirectory.Management.ADGroup + Returns group objects that represent the security groups for the account. ## NOTES -* This cmdlet does not work with an Active Directory snapshot. + +- This cmdlet doesn't work with an Active Directory snapshot. ## RELATED LINKS @@ -296,4 +354,3 @@ Returns group objects that represent the security groups for the account. [Search-ADAccount](./Search-ADAccount.md) [AD DS Administration Cmdlets in Windows PowerShell](./activedirectory.md) - From c2515b74735564b681a745fe8d2a530b16a1b56e Mon Sep 17 00:00:00 2001 From: Rob Derickson Date: Sun, 4 Jun 2023 19:28:13 -0400 Subject: [PATCH 490/650] Fix formatting for Get-ADAccountAuthorizationGroup. --- .../activedirectory/Get-ADAccountAuthorizationGroup.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/docset/winserver2022-ps/activedirectory/Get-ADAccountAuthorizationGroup.md b/docset/winserver2022-ps/activedirectory/Get-ADAccountAuthorizationGroup.md index db369a14a0..3d79b45c19 100644 --- a/docset/winserver2022-ps/activedirectory/Get-ADAccountAuthorizationGroup.md +++ b/docset/winserver2022-ps/activedirectory/Get-ADAccountAuthorizationGroup.md @@ -32,8 +32,9 @@ user, computer, or service account object by its distinguished name, GUID, secur (SID), Security Account Manager (SAM) account name or user principal name. You can also set the **Identity** parameter to an account object variable, such as `$`, or pass an account object through the pipeline to the **Identity** parameter. For example, you can use the -`Get-ADUser`, `Get-ADComputer`, `Get-ADServiceAccount` or `Search-ADAccount` cmdlets to retrieve an account -object and then pass the object through the pipeline to the `Get-ADAccountAuthorizationGroup` cmdlet. +`Get-ADUser`, `Get-ADComputer`, `Get-ADServiceAccount` or `Search-ADAccount` cmdlets to retrieve an +account object and then pass the object through the pipeline to the +`Get-ADAccountAuthorizationGroup` cmdlet. ## EXAMPLES @@ -100,7 +101,8 @@ GroupScope : Global name : AdminGroup objectClass : group objectGUID : 4d72873f-fe09-4834-9ada-a905636d10df -SamAccountName : SID : S-1-510474493-936115905-4021890855-1253703389-3958791574-3542197427 +SamAccountName : AdminGroup +SID : S-1-510474493-936115905-4021890855-1253703389-3958791574-3542197427 ``` This command returns all security groups for the specified account with **DistinguishedName** From 9daba08f0ab03967a9dfaec470b93423c177963f Mon Sep 17 00:00:00 2001 From: Rob Derickson Date: Sun, 4 Jun 2023 19:49:39 -0400 Subject: [PATCH 491/650] Remove duplicate Type declaration from parameter metadata. --- .../activedirectory/Enable-ADOptionalFeature.md | 3 --- .../activedirectory/Get-ADAccountAuthorizationGroup.md | 4 ---- 2 files changed, 7 deletions(-) diff --git a/docset/winserver2022-ps/activedirectory/Enable-ADOptionalFeature.md b/docset/winserver2022-ps/activedirectory/Enable-ADOptionalFeature.md index 93269cc558..579f75d1e6 100644 --- a/docset/winserver2022-ps/activedirectory/Enable-ADOptionalFeature.md +++ b/docset/winserver2022-ps/activedirectory/Enable-ADOptionalFeature.md @@ -93,7 +93,6 @@ A Secure Sockets Layer (SSL) connection is required for the `Basic` authenticati ```yaml Type: Microsoft.ActiveDirectory.Management.ADAuthType -Type: ADAuthType Parameter Sets: (All) Aliases: Accepted values: Negotiate, Basic @@ -140,7 +139,6 @@ Directory module for Windows PowerShell returns a terminating error. ```yaml Type: System.Management.Automation.PSCredential -Type: PSCredential Parameter Sets: (All) Aliases: @@ -247,7 +245,6 @@ they are listed: ```yaml Type: System.String -Type: String Parameter Sets: (All) Aliases: diff --git a/docset/winserver2022-ps/activedirectory/Get-ADAccountAuthorizationGroup.md b/docset/winserver2022-ps/activedirectory/Get-ADAccountAuthorizationGroup.md index 3d79b45c19..f149e225a3 100644 --- a/docset/winserver2022-ps/activedirectory/Get-ADAccountAuthorizationGroup.md +++ b/docset/winserver2022-ps/activedirectory/Get-ADAccountAuthorizationGroup.md @@ -153,7 +153,6 @@ A Secure Sockets Layer (SSL) connection is required for the `Basic` authenticati ```yaml Type: Microsoft.ActiveDirectory.Management.ADAuthType -Type: ADAuthType Parameter Sets: (All) Aliases: Accepted values: Negotiate, Basic @@ -184,7 +183,6 @@ Directory module for Windows PowerShell returns a terminating error. ```yaml Type: System.Management.Automation.PSCredential -Type: PSCredential Parameter Sets: (All) Aliases: @@ -265,7 +263,6 @@ In Active Directory Lightweight Directory Services (AD LDS) environments, a defa ```yaml Type: System.String -Type: String Parameter Sets: (All) Aliases: @@ -306,7 +303,6 @@ they are listed: ```yaml Type: System.String -Type: String Parameter Sets: (All) Aliases: From c90d0e9c2afb3c50c29903a324491dc1ce034344 Mon Sep 17 00:00:00 2001 From: Rob Derickson Date: Sun, 4 Jun 2023 19:54:23 -0400 Subject: [PATCH 492/650] Remove duplicate Type declaration from parameter metadata. --- docset/winserver2022-ps/activedirectory/Enable-ADAccount.md | 4 ---- 1 file changed, 4 deletions(-) diff --git a/docset/winserver2022-ps/activedirectory/Enable-ADAccount.md b/docset/winserver2022-ps/activedirectory/Enable-ADAccount.md index 31cc0126e1..36261a20f5 100644 --- a/docset/winserver2022-ps/activedirectory/Enable-ADAccount.md +++ b/docset/winserver2022-ps/activedirectory/Enable-ADAccount.md @@ -81,7 +81,6 @@ A Secure Sockets Layer (SSL) connection is required for the `Basic` authenticati ```yaml Type: Microsoft.ActiveDirectory.Management.ADAuthType -Type: ADAuthType Parameter Sets: (All) Aliases: Accepted values: Negotiate, Basic @@ -128,7 +127,6 @@ Directory module for Windows PowerShell returns a terminating error. ```yaml Type: System.Management.Automation.PSCredential -Type: PSCredential Parameter Sets: (All) Aliases: @@ -209,7 +207,6 @@ In Active Directory Lightweight Directory Services (AD LDS) environments, a defa ```yaml Type: System.String -Type: String Parameter Sets: (All) Aliases: @@ -267,7 +264,6 @@ they are listed: ```yaml Type: System.String -Type: String Parameter Sets: (All) Aliases: From 0b910e5ba233c92cdfcc42f7bea2628fb6b230dc Mon Sep 17 00:00:00 2001 From: Rob Derickson Date: Sun, 4 Jun 2023 19:58:02 -0400 Subject: [PATCH 493/650] Remove duplicate Type declaration from parameter metadata. --- .../activedirectory/Disable-ADOptionalFeature.md | 3 --- 1 file changed, 3 deletions(-) diff --git a/docset/winserver2022-ps/activedirectory/Disable-ADOptionalFeature.md b/docset/winserver2022-ps/activedirectory/Disable-ADOptionalFeature.md index 8d19bc724e..c6025b7ba1 100644 --- a/docset/winserver2022-ps/activedirectory/Disable-ADOptionalFeature.md +++ b/docset/winserver2022-ps/activedirectory/Disable-ADOptionalFeature.md @@ -125,7 +125,6 @@ A Secure Sockets Layer (SSL) connection is required for the `Basic` authenticati ```yaml Type: Microsoft.ActiveDirectory.Management.ADAuthType -Type: ADAuthType Parameter Sets: (All) Aliases: Accepted values: Negotiate, Basic @@ -172,7 +171,6 @@ Directory module for Windows PowerShell returns a terminating error. ```yaml Type: System.Management.Automation.PSCredential -Type: PSCredential Parameter Sets: (All) Aliases: @@ -279,7 +277,6 @@ they are listed: ```yaml Type: System.String -Type: String Parameter Sets: (All) Aliases: From 2c4a5b8ae7a081fa7594ee4c7865fdd19dcc5209 Mon Sep 17 00:00:00 2001 From: Rob Derickson Date: Sun, 4 Jun 2023 19:58:47 -0400 Subject: [PATCH 494/650] Fix formatting for Get-ADAccountResultantPasswordReplicationPolicy. --- ...countResultantPasswordReplicationPolicy.md | 217 +++++++++++------- 1 file changed, 131 insertions(+), 86 deletions(-) diff --git a/docset/winserver2022-ps/activedirectory/Get-ADAccountResultantPasswordReplicationPolicy.md b/docset/winserver2022-ps/activedirectory/Get-ADAccountResultantPasswordReplicationPolicy.md index 7880f478fa..7411d9ecde 100644 --- a/docset/winserver2022-ps/activedirectory/Get-ADAccountResultantPasswordReplicationPolicy.md +++ b/docset/winserver2022-ps/activedirectory/Get-ADAccountResultantPasswordReplicationPolicy.md @@ -16,62 +16,80 @@ Gets the resultant password replication policy for an Active Directory account. ## SYNTAX ``` -Get-ADAccountResultantPasswordReplicationPolicy [-AuthType ] [-Credential ] - [-DomainController] [-Identity] [-Partition ] [-Server ] - [] +Get-ADAccountResultantPasswordReplicationPolicy [-AuthType ] + [-Credential ] [-DomainController] + [-Identity] [-Partition ] [-Server ] [] ``` ## DESCRIPTION -The **Get-ADAccountResultantPasswordReplicationPolicy** cmdlet gets the resultant password replication policy for a user, computer, or service account on the specified read-only domain controller. -The policy is one of the following values: - -- Allow or 1 -- DenyExplicit or 0 -- DenyImplicit or 2 -- Unknown or -1 +The `Get-ADAccountResultantPasswordReplicationPolicy` cmdlet gets the resultant password replication +policy for a user, computer, or service account on the specified read-only domain controller. -The *Identity* parameter specifies the account. -You can identify a user, computer, or service account object by its distinguished name, GUID, security identifier (SID), or Security Account Manager (SAM) account name. -You can also set the *Identity* parameter to an account object variable, such as `$`, or pass an account object through the pipeline to the *Identity* parameter. -For example, you can use the Get-ADUser, Get-ADComputer, Get-ADServiceAccount, or Search-ADAccount cmdlets to retrieve an account object and then pass the object through the pipeline to the Get-ADAccountResultantPasswordReplicationPolicy cmdlet. +The policy is one of the following values: -The **DomainController** parameter specifies the read-only domain controller. -You can identify a domain controller by its IPV4Address, global IPV6Address, or DNS host name. -You can also identify a domain controller by the distinguished name of the NT Directory Services (NTDS) settings object or the server object, the GUID of the NTDS settings object or the server object under the configuration partition, or the distinguished name, SamAccountName, GUID, SID of the computer object that represents the domain controller. -You can also set the *DomainController* parameter to a domain controller object variable, such as `$`. +- `Allow` or `1` +- `DenyExplicit` or `0` +- `DenyImplicit` or `2` +- `Unknown` or `-1` + +The **Identity** parameter specifies the account. You can identify a user, computer, or service +account object by its distinguished name, GUID, security identifier (SID), or Security Account +Manager (SAM) account name. You can also set the **Identity** parameter to an account object +variable, such as `$`, or pass an account object through the pipeline to the +**Identity** parameter. For example, you can use the `Get-ADUser`, `Get-ADComputer`, +`Get-ADServiceAccount`, or `Search-ADAccount` cmdlets to retrieve an account object and then pass +the object through the pipeline to the `Get-ADAccountResultantPasswordReplicationPolicy` cmdlet. + +The **DomainController** parameter specifies the read-only domain controller. You can identify a +domain controller by its IPV4Address, global IPV6Address, or DNS host name. You can also identify a +domain controller by the distinguished name of the NT Directory Services (NTDS) settings object or +the server object, the GUID of the NTDS settings object or the server object under the configuration +partition, or the distinguished name, **SamAccountName**, GUID, SID of the computer object that +represents the domain controller. You can also set the **DomainController** parameter to a domain +controller object variable, such as `$`. ## EXAMPLES ### Example 1: Get the password replication policy for a specified user -``` -PS C:\> Get-ADAccountResultantPasswordReplicationPolicy -Identity DavidChe -DomainController "DOMAIN01" + +```powershell + Get-ADAccountResultantPasswordReplicationPolicy -Identity DavidChe -DomainController DC1 ``` -This command gets the password replication policy on the domain specified by the **DomainController** parameter for the user account specified by the *Identity* parameter. +This command gets the password replication policy on the domain specified by the +**DomainController** parameter for the user account specified by the **Identity** parameter. ### Example 2: Get the password replication policy for a specified user using a distinguished name -``` -PS C:\> Get-ADAccountResultantPasswordReplicationPolicy -Identity "CN=Elisa Daugherty,OU=Europe,OU=Sales,OU=UserAccounts,DC=FABRIKAM,DC=COM" -DomainController "DOMAIN01" + +```powershell +params = @{ + Identity = 'CN=Elisa Daugherty,OU=Europe,OU=Sales,OU=UserAccounts,DC=FABRIKAM,DC=COM' + DomainController = 'DC1' +} + Get-ADAccountResultantPasswordReplicationPolicy @params ``` -This command gets the password replication policy on the domain controller specified by the *DomainController* parameter for the user account distinguished name specified by the *Identity* parameter. +This command gets the password replication policy on the domain controller specified by the +**DomainController** parameter for the user account distinguished name specified by the **Identity** +parameter. ## PARAMETERS ### -AuthType + Specifies the authentication method to use. The acceptable values for this parameter are: -- Negotiate or 0 -- Basic or 1 +- `Negotiate` or `0` +- `Basic` or `1` -The default authentication method is Negotiate. +The default authentication method is `Negotiate`. -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. +A Secure Sockets Layer (SSL) connection is required for the `Basic` authentication method. ```yaml -Type: ADAuthType +Type: Microsoft.ActiveDirectory.Management.ADAuthType Parameter Sets: (All) Aliases: Accepted values: Negotiate, Basic @@ -84,20 +102,24 @@ Accept wildcard characters: False ``` ### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory module for Windows PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. -To specify this parameter, you can type a user name, such as User1 or Domain01\User01 or you can specify a **PSCredential** object. -If you specify a user name for this parameter, the cmdlet prompts for a password. +Specifies the user account credentials to use to perform this task. The default credentials are the +credentials of the currently logged on user unless the cmdlet is run from an Active Directory module +for Windows PowerShell provider drive. If the cmdlet is run from such a provider drive, the account +associated with the drive is the default. -You can also create a **PSCredential** object by using a script or by using the **Get-Credential** cmdlet. -You can then set the *Credential* parameter to the **PSCredential** object. +To specify this parameter, you can type a user name, such as `User1` or `Domain01\User01` or you can +specify a **PSCredential** object. If you specify a user name for this parameter, the cmdlet prompts +for a password. -If the acting credentials do not have directory-level permission to perform the task, Active Directory module for Windows PowerShell returns a terminating error. +You can also create a **PSCredential** object by using a script or by using the `Get-Credential` +cmdlet. You can then set the **Credential** parameter to the **PSCredential** object. + +If the acting credentials do not have directory-level permission to perform the task, Active +Directory module for Windows PowerShell returns a terminating error. ```yaml -Type: PSCredential +Type: System.Management.Automation.PSCredential Parameter Sets: (All) Aliases: @@ -109,25 +131,28 @@ Accept wildcard characters: False ``` ### -DomainController -Specifies a read-only domain controller (RODC). -The cmdlet returns the password replication policy of the account for this RODC. -You can identify the domain controller by providing one of the following values: -- GUID (objectGUID) +Specifies a read-only domain controller (RODC). The cmdlet returns the password replication policy +of the account for this RODC. You can identify the domain controller by providing one of the +following values: + +- GUID (**objectGUID**) - IPV4Address - Global IPV6Address -- DNS Host Name (dNSHostName) +- DNS Host Name (**dNSHostName**) - Name of the server object - A distinguished name of the NTDS Settings object -- A distinguished name of the server object that represents the domain controller +- A distinguished name of the server object that represents the domain controller - GUID of NTDS settings object under the configuration partition - GUID of server object under the configuration partition - A distinguished Name of the computer object that represents the domain controller -Note: The identifier in parentheses is the Lightweight Directory Access Protocol (LDAP) display name for the attribute. +> [!NOTE] +> The identifier in parentheses is the Lightweight Directory Access Protocol (LDAP) display name for +> the attribute. ```yaml -Type: ADDomainController +Type: Microsoft.ActiveDirectory.Management.ADDomainController Parameter Sets: (All) Aliases: @@ -139,19 +164,21 @@ Accept wildcard characters: False ``` ### -Identity -Specifies an Active Directory account object by providing one of the following property values. -The identifier in parentheses is the LDAP display name for the attribute. -The acceptable values for this parameter are: + +Specifies an Active Directory account object by providing one of the following property values. The +identifier in parentheses is the LDAP display name for the attribute. The acceptable values for this +parameter are: - A distinguished name -- A GUID (objectGUID) -- A security identifier (objectSid) -- A SAM account name (sAMAccountName) +- A GUID (**objectGUID**) +- A security identifier (**objectSid**) +- A SAM account name (**sAMAccountName**) The cmdlet searches the default naming context or partition to find the object. If two or more objects are found, the cmdlet returns a non-terminating error. -This parameter can also get this object through the pipeline or you can set this parameter to an account object instance. +This parameter can also get this object through the pipeline or you can set this parameter to an +account object instance. Derived types such as the following are also accepted: @@ -160,7 +187,7 @@ Derived types such as the following are also accepted: - **Microsoft.ActiveDirectory.Management.ADServiceAccount** ```yaml -Type: ADAccount +Type: Microsoft.ActiveDirectory.Management.ADAccount Parameter Sets: (All) Aliases: @@ -172,30 +199,40 @@ Accept wildcard characters: False ``` ### -Partition -Specifies the distinguished name of an Active Directory partition. -The distinguished name must be one of the naming contexts on the current directory server. -The cmdlet searches this partition to find the object defined by the *Identity* parameter. - -In many cases, a default value is used for the *Partition* parameter if no value is specified. -The rules for determining the default value are given below. -Note that rules listed first are evaluated first and once a default value can be determined, no further rules are evaluated. - -In Active Directory Domain Services environments, a default value for *Partition* is set in the following cases: - -- If the *Identity* parameter is set to a distinguished name, the default value of *Partition* is automatically generated from this distinguished name. -- If running cmdlets from an Active Directory provider drive, the default value of *Partition* is automatically generated from the current path in the drive. -- If none of the previous cases apply, the default value of *Partition* is set to the default partition or naming context of the target domain. -In Active Directory Lightweight Directory Services (AD LDS) environments, a default value for *Partition* is set in the following cases: - -- If the *Identity* parameter is set to a distinguished name, the default value of is automatically generated from this distinguished name. -- If running cmdlets from an Active Directory provider drive, the default value of *Partition* is automatically generated from the current path in the drive. -- If the target AD LDS instance has a default naming context, the default value of *Partition* is set to the default naming context. -To specify a default naming context for an AD LDS environment, set the **msDS-defaultNamingContext** property of the Active Directory directory service agent object (**nTDSDSA**) for the AD LDS instance. -- If none of the previous cases apply, the *Partition* parameter will not take any default value. +Specifies the distinguished name of an Active Directory partition. The distinguished name must be +one of the naming contexts on the current directory server. The cmdlet searches this partition to +find the object defined by the **Identity** parameter. + +In many cases, a default value is used for the **Partition** parameter if no value is specified. The +rules for determining the default value are given below. Note that rules listed first are evaluated +first and once a default value can be determined, no further rules are evaluated. + +In Active Directory Domain Services environments, a default value for **Partition** is set in the +following cases: + +- If the **Identity** parameter is set to a distinguished name, the default value of **Partition** + is automatically generated from this distinguished name. +- If running cmdlets from an Active Directory provider drive, the default value of **Partition** is + automatically generated from the current path in the drive. +- If none of the previous cases apply, the default value of **Partition** is set to the default + partition or naming context of the target domain. + +In Active Directory Lightweight Directory Services (AD LDS) environments, a default value for +**Partition** is set in the following cases: + +- If the **Identity** parameter is set to a distinguished name, the default value of **Partition** + is automatically generated from this distinguished name. +- If running cmdlets from an Active Directory provider drive, the default value of **Partition** is + automatically generated from the current path in the drive. +- If the target AD LDS instance has a default naming context, the default value of **Partition** is + set to the default naming context. To specify a default naming context for an AD LDS environment, + set the `msDS-defaultNamingContext` property of the Active Directory directory service agent + (DSA) object (**nTDSDSA**) for the AD LDS instance. +- If none of the previous cases apply, the **Partition** parameter will not take any default value. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -207,12 +244,17 @@ Accept wildcard characters: False ``` ### -Server -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory snapshot instance. + +Specifies the Active Directory Domain Services instance to connect to, by providing one of the +following values for a corresponding domain name or directory server. The service may be any of the +following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active +Directory snapshot instance. + +Specify the Active Directory Domain Services instance in one of the following ways: Domain name values: -- Fully qualified domain name (FQDN) +- Fully qualified domain name - NetBIOS name Directory server values: @@ -221,14 +263,16 @@ Directory server values: - NetBIOS name - Fully qualified directory server name and port -The default value for the *Server* parameter is determined by one of the following methods in the order that they are listed: +The default value for this parameter is determined by one of the following methods in the order that +they are listed: -- By using Server value from objects passed through the pipeline. -- By using the server information associated with the Active Directory module for Windows PowerShell provider drive, when running under that drive. -- By using the domain of the computer running Windows PowerShell. +- By using the **Server** value from objects passed through the pipeline +- By using the server information associated with the Active Directory Domain Services Windows + PowerShell provider drive, when the cmdlet runs in that drive +- By using the domain of the computer running Windows PowerShell ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -245,7 +289,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### Microsoft.ActiveDirectory.Management.ADAccount -An account object is received by the *Identity* parameter. +An account object is received by the **Identity** parameter. Derived types, such as the following are also accepted: @@ -259,8 +303,8 @@ Derived types, such as the following are also accepted: This cmdlet returns an **ADResultantPasswordReplicationPolicy** enum value that represents the resultant password replication policy for an account on the specified domain controller. ## NOTES -* This cmdlet does not work with AD LDS. -* This cmdlet does not work with an Active Directory snapshot. +* This cmdlet doesn't work with AD LDS. +* This cmdlet doesn't work with an Active Directory snapshot. ## RELATED LINKS @@ -274,3 +318,4 @@ This cmdlet returns an **ADResultantPasswordReplicationPolicy** enum value that [AD DS Administration Cmdlets in Windows PowerShell](./activedirectory.md) + From 7c53fb6dd054805de427d2b4ecfd259f9126aa11 Mon Sep 17 00:00:00 2001 From: Rob Derickson Date: Sun, 4 Jun 2023 19:59:18 -0400 Subject: [PATCH 495/650] Fix formatting for Get-ADAccountResultantPasswordReplicationPolicy. --- ...ccountResultantPasswordReplicationPolicy.md | 18 ++++++++++++------ 1 file changed, 12 insertions(+), 6 deletions(-) diff --git a/docset/winserver2022-ps/activedirectory/Get-ADAccountResultantPasswordReplicationPolicy.md b/docset/winserver2022-ps/activedirectory/Get-ADAccountResultantPasswordReplicationPolicy.md index 7411d9ecde..065de3c1e0 100644 --- a/docset/winserver2022-ps/activedirectory/Get-ADAccountResultantPasswordReplicationPolicy.md +++ b/docset/winserver2022-ps/activedirectory/Get-ADAccountResultantPasswordReplicationPolicy.md @@ -284,11 +284,16 @@ Accept wildcard characters: False ``` ### CommonParameters -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). + +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). ## INPUTS ### Microsoft.ActiveDirectory.Management.ADAccount + An account object is received by the **Identity** parameter. Derived types, such as the following are also accepted: @@ -300,11 +305,14 @@ Derived types, such as the following are also accepted: ## OUTPUTS ### Microsoft.ActiveDirectory.Management.ADResultantPasswordReplicationPolicy -This cmdlet returns an **ADResultantPasswordReplicationPolicy** enum value that represents the resultant password replication policy for an account on the specified domain controller. + +This cmdlet returns an **ADResultantPasswordReplicationPolicy** enum value that represents the +resultant password replication policy for an account on the specified domain controller. ## NOTES -* This cmdlet doesn't work with AD LDS. -* This cmdlet doesn't work with an Active Directory snapshot. + +- This cmdlet doesn't work with AD LDS. +- This cmdlet doesn't work with an Active Directory snapshot. ## RELATED LINKS @@ -317,5 +325,3 @@ This cmdlet returns an **ADResultantPasswordReplicationPolicy** enum value that [Search-ADAccount](./Search-ADAccount.md) [AD DS Administration Cmdlets in Windows PowerShell](./activedirectory.md) - - From bea13002475fbfb942f00fd2ebce2e0e36d6b0b5 Mon Sep 17 00:00:00 2001 From: Rob Derickson Date: Sun, 4 Jun 2023 20:22:53 -0400 Subject: [PATCH 496/650] Fix formatting for Get-ADAuthenticationPolicy. --- .../Get-ADAuthenticationPolicy.md | 231 +++++++++++------- 1 file changed, 140 insertions(+), 91 deletions(-) diff --git a/docset/winserver2022-ps/activedirectory/Get-ADAuthenticationPolicy.md b/docset/winserver2022-ps/activedirectory/Get-ADAuthenticationPolicy.md index bdb5c663f6..26de53a52b 100644 --- a/docset/winserver2022-ps/activedirectory/Get-ADAuthenticationPolicy.md +++ b/docset/winserver2022-ps/activedirectory/Get-ADAuthenticationPolicy.md @@ -16,94 +16,118 @@ Gets one or more Active Directory Domain Services authentication policies. ## SYNTAX ### Filter (Default) + ``` -Get-ADAuthenticationPolicy [-AuthType ] [-Credential ] -Filter - [-Properties ] [-ResultPageSize ] [-ResultSetSize ] [-Server ] - [] +Get-ADAuthenticationPolicy [-AuthType ] [-Credential ] + -Filter [-Properties ] [-ResultPageSize ] + [-ResultSetSize ] [-Server ] [] ``` ### Identity + ``` Get-ADAuthenticationPolicy [-AuthType ] [-Credential ] - [-Identity] [-Properties ] [-Server ] [] + [-Identity] [-Properties ] [-Server ] + [] ``` ### LdapFilter + ``` -Get-ADAuthenticationPolicy [-AuthType ] [-Credential ] -LDAPFilter - [-Properties ] [-ResultPageSize ] [-ResultSetSize ] [-Server ] - [] +Get-ADAuthenticationPolicy [-AuthType ] [-Credential ] + -LDAPFilter [-Properties ] [-ResultPageSize ] + [-ResultSetSize ] [-Server ] [] ``` ## DESCRIPTION -The **Get-ADAuthenticationPolicy** cmdlet gets an authentication policy or performs a search to get authentication policies. -The *Identity* parameter specifies the Active Directory Domain Services authentication policy to get. -You can identify an authentication policy by its distinguished name, GUID or name. -You can also use the *Identity* parameter to specify a variable that contains an authentication policy object, or you can use the pipeline operator to pass an authentication policy object to the *Identity* parameter. +The `Get-ADAuthenticationPolicy` cmdlet gets an authentication policy or performs a search to get +authentication policies. + +The **Identity** parameter specifies the Active Directory Domain Services authentication policy to +get. You can identify an authentication policy by its distinguished name, GUID or name. You can also +use the **Identity** parameter to specify a variable that contains an authentication policy object, +or you can use the pipeline operator to pass an authentication policy object to the **Identity** +parameter. -You can search for and use multiple authentication policies by specifying the *Filter* parameter or the *LDAPFilter* parameter. -The *Filter* parameter uses the Windows PowerShell® expression language to write query strings for Active Directory Domain Services. -Windows PowerShell expression language syntax provides rich type conversion support for value types received by the *Filter* parameter. -For more information about the *Filter* parameter syntax, type `Get-Help about_ActiveDirectory_Filter`. -If you have existing Lightweight Directory Access Protocol (LDAP) query strings, you can use the *LDAPFilter* parameter. +You can search for and use multiple authentication policies by specifying the **Filter** parameter +or the **LDAPFilter** parameter. The **Filter** parameter uses the Windows PowerShell expression +language to write query strings for Active Directory Domain Services. Windows PowerShell expression +language syntax provides rich type conversion support for value types received by the **Filter** +parameter. For more information about the **Filter** parameter syntax, type +`Get-Help about_ActiveDirectory_Filter`. If you have existing Lightweight Directory Access Protocol +(LDAP) query strings, you can use the **LDAPFilter** parameter. ## EXAMPLES ### Example 1: Get an authentication policy -``` -PS C:\> Get-ADAuthenticationPolicy -Identity AuthenticationPolicy01 + +```powershell +Get-ADAuthenticationPolicy -Identity AuthenticationPolicy01 ``` This command gets an authentication policy object by specifying the object name. ### Example 2: Get an authentication policy by using an LDAP filter -``` -PS C:\> Get-ADAuthenticationPolicy -LDAPFilter "(name=AuthenticationPolicy*)" -Server Server01.Contoso.com + +```powershell +Get-ADAuthenticationPolicy -LDAPFilter "(name=AuthenticationPolicy*)" -Server Server01 ``` -This command gets all authentication policies that match the LDAP filter specified by the *LDAPFilter* parameter. +This command gets all authentication policies that match the LDAP filter specified by the +**LDAPFilter** parameter. ### Example 3: Get an authentication policy by using a filter -``` -PS C:\> Get-ADAuthenticationPolicy -Filter "Name -like 'AuthenticationPolicy*'" -Server Server02.Contoso.com + +```powershell +Get-ADAuthenticationPolicy -Filter "Name -like 'AuthenticationPolicy*'" -Server Server02 ``` -This command gets all authentication policies that match the filter specified by the *Filter* parameter. +This command gets all authentication policies that match the filter specified by the **Filter** +parameter. ### Example 4: Get all authentication policy objects that match a filter + +```powershell +Get-ADAuthenticationPolicy -Filter * | Format-Table Name, Enforce -AutoSize ``` -PS C:\> Get-ADAuthenticationPolicy -Filter * | Format-Table Name, Enforce -AutoSize + +```output Name Enforce ---- ------- AuthenticationPolicy1 False AuthenticationPolicy2 False ``` -This command gets all the authentication policies available. -The output is then passed to the Format-Table cmdlet to display the name of the policy and the value for **Enforce** on each policy. +This command gets all the authentication policies available. The output is then passed to the +`Format-Table` cmdlet to display the name of the policy and the value for **Enforce** on each +policy. ### Example 5: Get all properties for an authentication policy -``` -PS C:\> Get-ADAuthenticationPolicy -Identity "AuthenticationPolicy01" -Properties "*" + +```powershell +Get-ADAuthenticationPolicy -Identity "AuthenticationPolicy01" -Properties "*" ``` -This command gets all properties of the authentication policy specified by the *Identity* parameter. +This command gets all properties of the authentication policy specified by the **Identity** +parameter. ## PARAMETERS ### -AuthType + Specifies the authentication method to use. The acceptable values for this parameter are: -- Negotiate or 0 -- Basic or 1 +- `Negotiate` or `0` +- `Basic` or `1` + +The default authentication method is `Negotiate`. -The default authentication method is Negotiate. -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. +A Secure Sockets Layer (SSL) connection is required for the `Basic` authentication method. ```yaml -Type: ADAuthType +Type: Microsoft.ActiveDirectory.Management.ADAuthType Parameter Sets: (All) Aliases: Accepted values: Negotiate, Basic @@ -116,17 +140,24 @@ Accept wildcard characters: False ``` ### -Credential -Specifies a user account that has permission to perform the task. -The default is the current user. -Type a user name, such as User01 or Domain01\User01, or enter a **PSCredential** object, such as one generated by the **Get-Credential** cmdlet. -By default, the cmdlet uses the credentials of the currently logged on user unless the cmdlet is run from an Active Directory Domain Services Windows PowerShell provider drive. -If you run the cmdlet in a provider drive, the account associated with the drive is the default. +Specifies the user account credentials to use to perform this task. The default credentials are the +credentials of the currently logged on user unless the cmdlet is run from an Active Directory module +for Windows PowerShell provider drive. If the cmdlet is run from such a provider drive, the account +associated with the drive is the default. -If you specify credentials that do not have permission to perform the task, the cmdlet returns an error. +To specify this parameter, you can type a user name, such as `User1` or `Domain01\User01` or you can +specify a **PSCredential** object. If you specify a user name for this parameter, the cmdlet prompts +for a password. + +You can also create a **PSCredential** object by using a script or by using the `Get-Credential` +cmdlet. You can then set the **Credential** parameter to the **PSCredential** object. + +If the acting credentials do not have directory-level permission to perform the task, Active +Directory module for Windows PowerShell returns a terminating error. ```yaml -Type: PSCredential +Type: System.Management.Automation.PSCredential Parameter Sets: (All) Aliases: @@ -138,32 +169,36 @@ Accept wildcard characters: False ``` ### -Filter -Specifies a query string that retrieves Active Directory Domain Services objects. -This string uses the Windows PowerShell expression language syntax. -The Windows PowerShell expression language syntax provides rich type-conversion support for value types received by the *Filter* parameter. -Specify the Filter parameter in one of the following formats: +Specifies a query string that retrieves Active Directory Domain Services objects. This string uses +the Windows PowerShell expression language syntax. The Windows PowerShell expression language syntax +provides rich type-conversion support for value types received by the **Filter** parameter. -- To match a single filter element: {Attributeoperator "value"} -- To match multiple filter elements: {(Attribute1operator1 "value1") joinOperator (Attribute2operator2 "value2")} +Specify the **Filter** parameter in one of the following formats: -Windows PowerShell wildcards other than "*", such as "?" are not supported by the Filter syntax. +- To match a single filter element: `{Attribute operator "value"}` +- To match multiple filter elements: + `{(Attribute1 operator1 "value1") joinOperator (Attribute2 operator2 "value2")}` -Valid filter operators are: +Windows PowerShell wildcards other than `*`, such as `?`, are not supported by the **Filter** +syntax. - -eq, -le, -ge, -ne, -lt, -gt, -approx, -bor, -band, -recursivematch, -like, -notlike +Valid filter operators are: -Valid join operators are: + `-eq`, `-le`, `-ge`, `-ne`, `-lt`, `-gt`, `-approx`, `-bor`, `-band`, `-recursivematch`, `-like`, + `-notlike` --and, -or +Valid join operators are: -The not operator is -not +`-and`, `-or` -For a list of supported types for values, see about_ActiveDirectory_ObjectModel. -For more information about the Filter parameter, see about_ActiveDirectory_Filter. +The not operator is `-not`. + +For a list of supported types for values, see `about_ActiveDirectory_ObjectModel`. For more +information about the **Filter** parameter, see `about_ActiveDirectory_Filter`. ```yaml -Type: String +Type: System.String Parameter Sets: Filter Aliases: @@ -175,20 +210,22 @@ Accept wildcard characters: False ``` ### -Identity -Specifies an Active Directory Domain Services authentication policy object. -Specify the authentication policy object in one of the following formats: + +Specifies an Active Directory Domain Services authentication policy object. Specify the +authentication policy object in one of the following formats: - A distinguished name - GUID - Name -This parameter can also get this object through the pipeline or you can set this parameter to an object instance. +This parameter can also get this object through the pipeline or you can set this parameter to an +object instance. -The cmdlet searches the default naming context or partition to find the object. -If the cmdlet finds two or more objects, the cmdlet returns a non-terminating error. +The cmdlet searches the default naming context or partition to find the object. If the cmdlet finds +two or more objects, the cmdlet returns a non-terminating error. ```yaml -Type: ADAuthenticationPolicy +Type: Microsoft.ActiveDirectory.Management.ADAuthenticationPolicy Parameter Sets: Identity Aliases: @@ -200,11 +237,12 @@ Accept wildcard characters: False ``` ### -LDAPFilter -Specifies an LDAP query string used to filter Active Directory Domain Services objects. -Use this parameter to run your existing LDAP queries. + +Specifies a filter using the LDAP search filter syntax defined in RFC2254 to filter Active Directory +Domain Services objects. ```yaml -Type: String +Type: System.String Parameter Sets: LdapFilter Aliases: @@ -216,17 +254,16 @@ Accept wildcard characters: False ``` ### -Properties -Specifies the properties of the output object to get from the server. -Use this parameter to get properties that are not included in the default set. -Specify the properties to get as a comma separated list of names. -For properties that are not default or extended properties, you must specify the LDAP display name of the property. -To display all of the properties that are set on the object, specify an asterisk wildcard. +Specifies the properties of the output object to get from the server. Use this parameter to get +properties that are not included in the default set. -To get properties for an object and display them, you can use this cmdlet and pass the output to the [Get-Member](https://go.microsoft.com/fwlink/?LinkID=293971) cmdlet by using the pipeline operator. +Specify the properties to get as a comma separated list of names. For properties that are not +default or extended properties, you must specify the LDAP display name of the property. To display +all of the properties that are set on the object, specify an asterisk wildcard. ```yaml -Type: String[] +Type: System.String[] Parameter Sets: (All) Aliases: Property @@ -238,8 +275,9 @@ Accept wildcard characters: False ``` ### -ResultPageSize -Specifies the number of objects to include in one page for an Active Directory Domain Services query. -The default value is 256 objects per page. + +Specifies the number of objects to include in one page for an Active Directory Domain Services +query. The default value is `256` objects per page. ```yaml Type: Int32 @@ -254,11 +292,12 @@ Accept wildcard characters: False ``` ### -ResultSetSize -Specifies the maximum number of objects to return for an Active Directory Domain Services query. -If you want to get all of the objects, set this parameter to $Null. -You can use Ctrl+C to stop the query and the return of objects. -The default value is $Null. +Specifies the maximum number of objects to return for an Active Directory Domain Services query. If +you want to get all of the objects, set this parameter to `$null`. You can use Ctrl+C to stop the +query and the return of objects. + +The default value is `$null`. ```yaml Type: Int32 @@ -273,30 +312,35 @@ Accept wildcard characters: False ``` ### -Server -Specifies the Active Directory Domain Services instance to which to connect, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory snapshot instance. -Specify the Active Directory Domain Services instance in one of the following ways: +Specifies the Active Directory Domain Services instance to connect to, by providing one of the +following values for a corresponding domain name or directory server. The service may be any of the +following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active +Directory snapshot instance. + +Specify the Active Directory Domain Services instance in one of the following ways: Domain name values: - Fully qualified domain name - NetBIOS name -Directory server values: +Directory server values: - Fully qualified directory server name - NetBIOS name - Fully qualified directory server name and port -The default value for this parameter is determined by one of the following methods in the order that they are listed: +The default value for this parameter is determined by one of the following methods in the order that +they are listed: - By using the **Server** value from objects passed through the pipeline -- By using the server information associated with the Active Directory Domain Services Windows PowerShell provider drive, when the cmdlet runs in that drive +- By using the server information associated with the Active Directory Domain Services Windows + PowerShell provider drive, when the cmdlet runs in that drive - By using the domain of the computer running Windows PowerShell ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -308,19 +352,25 @@ Accept wildcard characters: False ``` ### CommonParameters -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). + +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). ## INPUTS ### None or Microsoft.ActiveDirectory.Management.ADAuthenticationPolicy + This cmdlet accepts an authentication policy object. ## OUTPUTS ### Microsoft.ActiveDirectory.Management.ADAuthenticationPolicy -This cmdlet returns one or more authentication policy objects. -This cmdlet returns a default set of **ADAuthenticationPolicy** property values. -To retrieve additional **ADAuthenticationPolicy** properties, use the *Properties* parameter. + +This cmdlet returns one or more authentication policy objects. This cmdlet returns a default set of +**ADAuthenticationPolicy** property values. To retrieve additional **ADAuthenticationPolicy** +properties, use the **Properties** parameter. ## NOTES @@ -333,4 +383,3 @@ To retrieve additional **ADAuthenticationPolicy** properties, use the *Propertie [Set-ADAuthenticationPolicy](./Set-ADAuthenticationPolicy.md) [AD DS Administration Cmdlets in Windows PowerShell](./activedirectory.md) - From 850e289e83a0feea36f0cd1dc5d2305fc2b6b339 Mon Sep 17 00:00:00 2001 From: Rob Derickson Date: Sun, 4 Jun 2023 20:28:57 -0400 Subject: [PATCH 497/650] Fix formatting for Get-ADAuthenticationPolicy. --- .../activedirectory/Get-ADAuthenticationPolicy.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docset/winserver2022-ps/activedirectory/Get-ADAuthenticationPolicy.md b/docset/winserver2022-ps/activedirectory/Get-ADAuthenticationPolicy.md index 26de53a52b..53c51cae27 100644 --- a/docset/winserver2022-ps/activedirectory/Get-ADAuthenticationPolicy.md +++ b/docset/winserver2022-ps/activedirectory/Get-ADAuthenticationPolicy.md @@ -280,7 +280,7 @@ Specifies the number of objects to include in one page for an Active Directory D query. The default value is `256` objects per page. ```yaml -Type: Int32 +Type: System.Int32 Parameter Sets: Filter, LdapFilter Aliases: @@ -300,7 +300,7 @@ query and the return of objects. The default value is `$null`. ```yaml -Type: Int32 +Type: System.Int32 Parameter Sets: Filter, LdapFilter Aliases: From 67d74b8c707abd0231a409c8d4a77e0d21a2232f Mon Sep 17 00:00:00 2001 From: Rob Derickson Date: Sun, 4 Jun 2023 20:34:12 -0400 Subject: [PATCH 498/650] Fix formatting for Get-ADAuthenticationPolicy. --- .../activedirectory/Get-ADAuthenticationPolicy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/activedirectory/Get-ADAuthenticationPolicy.md b/docset/winserver2022-ps/activedirectory/Get-ADAuthenticationPolicy.md index 53c51cae27..7a583b418a 100644 --- a/docset/winserver2022-ps/activedirectory/Get-ADAuthenticationPolicy.md +++ b/docset/winserver2022-ps/activedirectory/Get-ADAuthenticationPolicy.md @@ -260,7 +260,7 @@ properties that are not included in the default set. Specify the properties to get as a comma separated list of names. For properties that are not default or extended properties, you must specify the LDAP display name of the property. To display -all of the properties that are set on the object, specify an asterisk wildcard. +all of the properties that are set on the object, specify an asterisk (`*`) wildcard. ```yaml Type: System.String[] From 8300a8fa2e6f6f3e5a1e1df00c2a65127000e9f7 Mon Sep 17 00:00:00 2001 From: Rob Derickson Date: Sun, 4 Jun 2023 20:36:20 -0400 Subject: [PATCH 499/650] Fix formatting for Get-ADAuthenticationPolicySilo. --- .../Get-ADAuthenticationPolicySilo.md | 223 +++++++++++------- 1 file changed, 135 insertions(+), 88 deletions(-) diff --git a/docset/winserver2022-ps/activedirectory/Get-ADAuthenticationPolicySilo.md b/docset/winserver2022-ps/activedirectory/Get-ADAuthenticationPolicySilo.md index 664dcf861a..d91277588d 100644 --- a/docset/winserver2022-ps/activedirectory/Get-ADAuthenticationPolicySilo.md +++ b/docset/winserver2022-ps/activedirectory/Get-ADAuthenticationPolicySilo.md @@ -16,80 +16,100 @@ Gets one or more Active Directory Domain Services authentication policy silos. ## SYNTAX ### Filter (Default) + ``` -Get-ADAuthenticationPolicySilo [-AuthType ] [-Credential ] -Filter - [-Properties ] [-ResultPageSize ] [-ResultSetSize ] [-Server ] - [] +Get-ADAuthenticationPolicySilo [-AuthType ] [-Credential ] + -Filter [-Properties ] [-ResultPageSize ] + [-ResultSetSize ] [-Server ] [] ``` ### Identity + ``` Get-ADAuthenticationPolicySilo [-AuthType ] [-Credential ] - [-Identity] [-Properties ] [-Server ] [] + [-Identity] [-Properties ] [-Server ] + [] ``` ### LdapFilter + ``` -Get-ADAuthenticationPolicySilo [-AuthType ] [-Credential ] -LDAPFilter - [-Properties ] [-ResultPageSize ] [-ResultSetSize ] [-Server ] - [] +Get-ADAuthenticationPolicySilo [-AuthType ] [-Credential ] + -LDAPFilter [-Properties ] [-ResultPageSize ] + [-ResultSetSize ] [-Server ] [] ``` ## DESCRIPTION -The **Get-ADAuthenticationPolicySilo** cmdlet gets an authentication policy silo or performs a search to get authentication policy silos. -The *Identity* parameter specifies the Active Directory Domain Services authentication policy silo to get. -You can identify an authentication policy silo by its distinguished name (DN), GUID or name. -You can also use the *Identity* parameter to specify a variable that contains an authentication policy silo object, or you can use the pipeline operator to pass an authentication policy silo object to the *Identity* parameter. +The `Get-ADAuthenticationPolicySilo` cmdlet gets an authentication policy silo or performs a search +to get authentication policy silos. + +The **Identity** parameter specifies the Active Directory Domain Services authentication policy silo +to get. You can identify an authentication policy silo by its distinguished name (DN), GUID or name. +You can also use the **Identity** parameter to specify a variable that contains an authentication +policy silo object, or you can use the pipeline operator to pass an authentication policy silo +object to the **Identity** parameter. -You can search for and use multiple authentication policies by specifying the *Filter* parameter or the *LDAPFilter* parameter. -The *Filter* parameter uses the Windows PowerShell® expression language to write query strings for Active Directory Domain Services. -Windows PowerShell expression language syntax provides rich type conversion support for value types received by the *Filter* parameter. -For more information about the *Filter* parameter syntax, type `Get-Help about_ActiveDirectory_Filter`. -If you have existing Lightweight Directory Access Protocol (LDAP) query strings, you can use the *LDAPFilter* parameter. +You can search for and use multiple authentication policies by specifying the **Filter** parameter +or the **LDAPFilter** parameter. The **Filter** parameter uses the Windows PowerShell expression +language to write query strings for Active Directory Domain Services. Windows PowerShell expression +language syntax provides rich type conversion support for value types received by the **Filter** +parameter. For more information about the **Filter** parameter syntax, type +`Get-Help about_ActiveDirectory_Filter`. If you have existing Lightweight Directory Access Protocol +(LDAP) query strings, you can use the **LDAPFilter** parameter. ## EXAMPLES ### Example 1: Get an authentication policy silo object -``` -PS C:\> Get-ADAuthenticationPolicySilo -Identity AuthenticationPolicySilo01 + +```powershell +Get-ADAuthenticationPolicySilo -Identity AuthenticationPolicySilo01 ``` This command gets an authentication policy silo object named AuthenticationPolicySilo01. ### Example 2: Get all authentication policy silo objects that match a filter -``` -PS C:\> Get-ADAuthenticationPolicySilo -Filter 'Name -like "*AuthenticationPolicySilo*"' | Format-Table Name, Enforce -AutoSize + +```powershell +Get-ADAuthenticationPolicySilo -Filter 'Name -like "*AuthenticationPolicySilo*"' | + Format-Table Name, Enforce -AutoSize + +```output Name Enforce ---- ------- silo True silos False ``` -This command gets all the authentication policy silos that match the filter specified by the Filter parameter. -The output is then passed to the Format-Table cmdlet to display the name of the policy and the value for Enforce on each policy. +This command gets all the authentication policy silos that match the filter specified by the +**Filter** parameter. The output is then passed to the `Format-Table` cmdlet to display the name of +the policy and the value for Enforce on each policy. ### Example 3: Get all properties of a specific authentication policy silo -``` -PS C:\> Get-ADAuthenticationPolicySilo -Identity AuthenticationPolicySilo02 -Properties * + +```powershell +Get-ADAuthenticationPolicySilo -Identity AuthenticationPolicySilo02 -Properties * ``` -This command gets all properties for the authentication policy silo named AuthenticationPolicySilo02. +This command gets all properties for the authentication policy silo named +`AuthenticationPolicySilo02`. ## PARAMETERS ### -AuthType + Specifies the authentication method to use. The acceptable values for this parameter are: -- Negotiate or 0 -- Basic or 1 +- `Negotiate` or `0` +- `Basic` or `1` -The default authentication method is Negotiate. -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. +The default authentication method is `Negotiate`. + +A Secure Sockets Layer (SSL) connection is required for the `Basic` authentication method. ```yaml -Type: ADAuthType +Type: Microsoft.ActiveDirectory.Management.ADAuthType Parameter Sets: (All) Aliases: Accepted values: Negotiate, Basic @@ -102,17 +122,24 @@ Accept wildcard characters: False ``` ### -Credential -Specifies a user account that has permission to perform the task. -The default is the current user. -Type a user name, such as User01 or Domain01\User01, or enter a **PSCredential** object, such as one generated by the **Get-Credential** cmdlet. -By default, the cmdlet uses the credentials of the currently logged on user unless the cmdlet is run from an Active Directory Domain Services Windows PowerShell provider drive. -If you run the cmdlet in a provider drive, the account associated with the drive is the default. +Specifies the user account credentials to use to perform this task. The default credentials are the +credentials of the currently logged on user unless the cmdlet is run from an Active Directory module +for Windows PowerShell provider drive. If the cmdlet is run from such a provider drive, the account +associated with the drive is the default. + +To specify this parameter, you can type a user name, such as `User1` or `Domain01\User01` or you can +specify a **PSCredential** object. If you specify a user name for this parameter, the cmdlet prompts +for a password. -If you specify credentials that do not have permission to perform the task, the cmdlet returns an error. +You can also create a **PSCredential** object by using a script or by using the `Get-Credential` +cmdlet. You can then set the **Credential** parameter to the **PSCredential** object. + +If the acting credentials do not have directory-level permission to perform the task, Active +Directory module for Windows PowerShell returns a terminating error. ```yaml -Type: PSCredential +Type: System.Management.Automation.PSCredential Parameter Sets: (All) Aliases: @@ -124,32 +151,36 @@ Accept wildcard characters: False ``` ### -Filter -Specifies a query string that retrieves Active Directory Domain Services objects. -This string uses the Windows PowerShell expression language syntax. -The Windows PowerShell expression language syntax provides rich type-conversion support for value types received by the *Filter* parameter. -Specify the *Filter* parameter in one of the following formats: +Specifies a query string that retrieves Active Directory Domain Services objects. This string uses +the Windows PowerShell expression language syntax. The Windows PowerShell expression language syntax +provides rich type-conversion support for value types received by the **Filter** parameter. + +Specify the **Filter** parameter in one of the following formats: -- To match a single filter element: {Attributeoperator "value"} -- To match multiple filter elements: {(Attribute1operator1 "value1") joinOperator (Attribute2operator2 "value2")} +- To match a single filter element: `{Attribute operator "value"}` +- To match multiple filter elements: + `{(Attribute1 operator1 "value1") joinOperator (Attribute2 operator2 "value2")}` -Windows PowerShell wildcards other than "*", such as "?" are not supported by the *Filter* syntax. +Windows PowerShell wildcards other than `*`, such as `?`, are not supported by the **Filter** +syntax. -Valid filter operators are: +Valid filter operators are: - -eq, -le, -ge, -ne, -lt, -gt, -approx, -bor, -band, -recursivematch, -like, -notlike + `-eq`, `-le`, `-ge`, `-ne`, `-lt`, `-gt`, `-approx`, `-bor`, `-band`, `-recursivematch`, `-like`, + `-notlike` -Valid join operators are: +Valid join operators are: --and, -or +`-and`, `-or` -The not operator is -not +The not operator is `-not`. -For a list of supported types for values, type `Get-Help about_ActiveDirectory_ObjectModel`. -For more information about the *Filter* parameter, type `Get-Help about_ActiveDirectory_Filter`. +For a list of supported types for values, see `about_ActiveDirectory_ObjectModel`. For more +information about the **Filter** parameter, see `about_ActiveDirectory_Filter`. ```yaml -Type: String +Type: System.String Parameter Sets: Filter Aliases: @@ -161,20 +192,22 @@ Accept wildcard characters: False ``` ### -Identity -Specifies an Active Directory Domain Services authentication policy silo object. -Specify the authentication policy silo object in one of the following formats: + +Specifies an Active Directory Domain Services authentication policy silo object. Specify the +authentication policy silo object in one of the following formats: - A distinguished name - A GUID - A Name -This parameter can also get this object through the pipeline or you can set this parameter to an object instance. +This parameter can also get this object through the pipeline or you can set this parameter to an +object instance. -The cmdlet searches the default naming context or partition to find the object. -If the cmdlet finds two or more objects, the cmdlet returns a non-terminating error. +The cmdlet searches the default naming context or partition to find the object. If the cmdlet finds +two or more objects, the cmdlet returns a non-terminating error. ```yaml -Type: ADAuthenticationPolicySilo +Type: Microsoft.ActiveDirectory.Management.ADAuthenticationPolicySilo Parameter Sets: Identity Aliases: @@ -186,11 +219,12 @@ Accept wildcard characters: False ``` ### -LDAPFilter -Specifies an LDAP query string used to filter Active Directory Domain Services objects. -Use this parameter to run your existing LDAP queries. + +Specifies a filter using the LDAP search filter syntax defined in RFC2254 to filter Active Directory +Domain Services objects. ```yaml -Type: String +Type: System.String Parameter Sets: LdapFilter Aliases: @@ -202,17 +236,16 @@ Accept wildcard characters: False ``` ### -Properties -Specifies the properties of the output object to get from the server. -Use this parameter to get properties that are not included in the default set. -Specify the properties to get as a comma separated list of names. -For properties that are not default or extended properties, you must specify the LDAP display name of the property. -To display all of the properties that are set on the object, specify an asterisk wildcard. +Specifies the properties of the output object to get from the server. Use this parameter to get +properties that are not included in the default set. -To get properties for an object and display them, you can use this cmdlet and pass the output to the **Get-Member** cmdlet by using the pipeline operator. +Specify the properties to get as a comma separated list of names. For properties that are not +default or extended properties, you must specify the LDAP display name of the property. To display +all of the properties that are set on the object, specify an asterisk (`*`) wildcard. ```yaml -Type: String[] +Type: System.String[] Parameter Sets: (All) Aliases: Property @@ -224,8 +257,9 @@ Accept wildcard characters: False ``` ### -ResultPageSize -Specifies the number of objects to include in one page for an Active Directory Domain Services query. -The default value is 256 objects per page. + +Specifies the number of objects to include in one page for an Active Directory Domain Services +query. The default value is `256` objects per page. ```yaml Type: Int32 @@ -240,11 +274,12 @@ Accept wildcard characters: False ``` ### -ResultSetSize -Specifies the maximum number of objects to return for an Active Directory Domain Services query. -If you want to get all of the objects, set this parameter to $Null. -You can use Ctrl+C to stop the query and the return of objects. -The default value is $Null. +Specifies the maximum number of objects to return for an Active Directory Domain Services query. If +you want to get all of the objects, set this parameter to `$null`. You can use Ctrl+C to stop the +query and the return of objects. + +The default value is `$null`. ```yaml Type: Int32 @@ -259,28 +294,35 @@ Accept wildcard characters: False ``` ### -Server -Specifies the Active Directory Domain Services instance to which to connect, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services, or Active Directory snapshot instance. -Specify the Active Directory Domain Services instance in one of the following ways: +Specifies the Active Directory Domain Services instance to connect to, by providing one of the +following values for a corresponding domain name or directory server. The service may be any of the +following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active +Directory snapshot instance. + +Specify the Active Directory Domain Services instance in one of the following ways: + +Domain name values: -Domain name values: - Fully qualified domain name - NetBIOS name -Directory server values: +Directory server values: + - Fully qualified directory server name - NetBIOS name - Fully qualified directory server name and port -The default value for this parameter is determined by one of the following methods in the order that they are listed: +The default value for this parameter is determined by one of the following methods in the order that +they are listed: -- By using the *Server* value from objects passed through the pipeline -- By using the server information associated with the Active Directory Domain Services Windows PowerShell provider drive, when the cmdlet runs in that drive +- By using the **Server** value from objects passed through the pipeline +- By using the server information associated with the Active Directory Domain Services Windows + PowerShell provider drive, when the cmdlet runs in that drive - By using the domain of the computer running Windows PowerShell ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -292,19 +334,25 @@ Accept wildcard characters: False ``` ### CommonParameters -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). + +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). ## INPUTS ### None or Microsoft.ActiveDirectory.Management.ADAuthenticationPolicySilo + This cmdlet accepts an authentication policy silo object. ## OUTPUTS ### Microsoft.ActiveDirectory.Management.ADAuthenticationPolicySilo -Returns one or more authentication policy silo objects. -This cmdlet returns a default set of **ADAuthenticationPolicySilo** property values. -To retrieve additional **ADAuthenticationPolicySilo** properties, use the *Properties* parameter. + +Returns one or more authentication policy silo objects. This cmdlet returns a default set of +**ADAuthenticationPolicySilo** property values. To retrieve additional +**ADAuthenticationPolicySilo** properties, use the **Properties** parameter. ## NOTES @@ -317,4 +365,3 @@ To retrieve additional **ADAuthenticationPolicySilo** properties, use the *Prope [Set-ADAuthenticationPolicySilo](./Set-ADAuthenticationPolicySilo.md) [AD DS Administration Cmdlets in Windows PowerShell](./activedirectory.md) - From 1e631f3514fc0e54bcb277cd2ecd5a61c3e775c5 Mon Sep 17 00:00:00 2001 From: Rob Derickson Date: Sun, 4 Jun 2023 21:20:42 -0400 Subject: [PATCH 500/650] Fix formatting for Get-ADCentralAccessPolicy. --- .../Get-ADCentralAccessPolicy.md | 217 +++++++++--------- 1 file changed, 114 insertions(+), 103 deletions(-) diff --git a/docset/winserver2022-ps/activedirectory/Get-ADCentralAccessPolicy.md b/docset/winserver2022-ps/activedirectory/Get-ADCentralAccessPolicy.md index 84f93ecb53..1190a6af4b 100644 --- a/docset/winserver2022-ps/activedirectory/Get-ADCentralAccessPolicy.md +++ b/docset/winserver2022-ps/activedirectory/Get-ADCentralAccessPolicy.md @@ -16,66 +16,76 @@ Retrieves central access policies from Active Directory. ## SYNTAX ### Filter (Default) + ``` -Get-ADCentralAccessPolicy [-AuthType ] [-Credential ] -Filter - [-Properties ] [-ResultPageSize ] [-ResultSetSize ] [-Server ] - [] +Get-ADCentralAccessPolicy [-AuthType ] [-Credential ] + -Filter [-Properties ] [-ResultPageSize ] + [-ResultSetSize ] [-Server ] [] ``` ### Identity + ``` Get-ADCentralAccessPolicy [-AuthType ] [-Credential ] - [-Identity] [-Properties ] [-Server ] [] + [-Identity] [-Properties ] [-Server ] + [] ``` ### LdapFilter + ``` -Get-ADCentralAccessPolicy [-AuthType ] [-Credential ] -LDAPFilter - [-Properties ] [-ResultPageSize ] [-ResultSetSize ] [-Server ] - [] +Get-ADCentralAccessPolicy [-AuthType ] [-Credential ] + -LDAPFilter [-Properties ] [-ResultPageSize ] + [-ResultSetSize ] [-Server ] [] ``` ## DESCRIPTION -The **Get-ADCentralAccessPolicy** cmdlet retrieves central access policies from Active Directory. + +The `Get-ADCentralAccessPolicy` cmdlet retrieves central access policies from Active Directory. ## EXAMPLES ### Example 1: Get a list off all central access policies -``` -PS C:\> Get-ADCentralAccessPolicy -Filter * + +```powershell +Get-ADCentralAccessPolicy -Filter * ``` This command retrieves a list of all central access policies. ### Example 2: Get a list of specific central access policies using a filter -``` -PS C:\> Get-ADCentralAccessPolicy -Filter "Members -eq 'Finance Documents Rule'" + +```powershell +Get-ADCentralAccessPolicy -Filter "Members -eq 'Finance Documents Rule'" ``` -This command gets the central access policies that have the central access rule Finance Documents Rule as its members. +This command gets the central access policies that have the central access rule +`Finance Documents Rule` as its members. ### Example 3: Get information for a central access policy for a specific Active Directory object -``` -PS C:\> Get-ADCentralAccessPolicy -Identity "Finance Policy" + +```powershell +Get-ADCentralAccessPolicy -Identity "Finance Policy" ``` -This command gets information for a central access policy named Finance Policy. +This command gets information for a central access policy named `Finance Policy`. ## PARAMETERS ### -AuthType + Specifies the authentication method to use. The acceptable values for this parameter are: -- Negotiate or 0 -- Basic or 1 +- `Negotiate` or `0` +- `Basic` or `1` -The default authentication method is Negotiate. +The default authentication method is `Negotiate`. -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. +A Secure Sockets Layer (SSL) connection is required for the `Basic` authentication method. ```yaml -Type: ADAuthType +Type: Microsoft.ActiveDirectory.Management.ADAuthType Parameter Sets: (All) Aliases: Accepted values: Negotiate, Basic @@ -88,20 +98,24 @@ Accept wildcard characters: False ``` ### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory module for Windows PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. -To specify this parameter, you can type a user name, such as User1 or Domain01\User01 or you can specify a **PSCredential** object. -If you specify a user name for this parameter, the cmdlet prompts for a password. +Specifies the user account credentials to use to perform this task. The default credentials are the +credentials of the currently logged on user unless the cmdlet is run from an Active Directory module +for Windows PowerShell provider drive. If the cmdlet is run from such a provider drive, the account +associated with the drive is the default. + +To specify this parameter, you can type a user name, such as `User1` or `Domain01\User01` or you can +specify a **PSCredential** object. If you specify a user name for this parameter, the cmdlet prompts +for a password. -You can also create a **PSCredential** object by using a script or by using the **Get-Credential** cmdlet. -You can then set the *Credential* parameter to the **PSCredential** object. +You can also create a **PSCredential** object by using a script or by using the `Get-Credential` +cmdlet. You can then set the **Credential** parameter to the **PSCredential** object. -If the acting credentials do not have directory-level permission to perform the task, Active Directory module for Windows PowerShell returns a terminating error. +If the acting credentials do not have directory-level permission to perform the task, Active +Directory module for Windows PowerShell returns a terminating error. ```yaml -Type: PSCredential +Type: System.Management.Automation.PSCredential Parameter Sets: (All) Aliases: @@ -113,40 +127,36 @@ Accept wildcard characters: False ``` ### -Filter -Specifies a query string that retrieves Active Directory objects. -This string uses the PowerShell Expression Language syntax. -The PowerShell Expression Language syntax provides rich type-conversion support for value types received by the *Filter* parameter. -The syntax uses an in-order representation, which means that the operator is placed between the operand and the value. -For more information about the *Filter* parameter, type `Get-Help about_ActiveDirectory_Filter`. -Syntax: +Specifies a query string that retrieves Active Directory Domain Services objects. This string uses +the Windows PowerShell expression language syntax. The Windows PowerShell expression language syntax +provides rich type-conversion support for value types received by the **Filter** parameter. -The following syntax uses Backus-Naur form to show how to use the PowerShell Expression Language for this parameter. +Specify the **Filter** parameter in one of the following formats: -\ ::= "{" \ "}" +- To match a single filter element: `{Attribute operator "value"}` +- To match multiple filter elements: + `{(Attribute1 operator1 "value1") joinOperator (Attribute2 operator2 "value2")}` -\ ::= \ | \ \ \ | \ \ +Windows PowerShell wildcards other than `*`, such as `?`, are not supported by the **Filter** +syntax. -\ ::= \ \ \ | "(" \ ")" +Valid filter operators are: -\ ::= "-eq" | "-le" | "-ge" | "-ne" | "-lt" | "-gt"| "-approx" | "-bor" | "-band" | "-recursivematch" | "-like" | "-notlike" + `-eq`, `-le`, `-ge`, `-ne`, `-lt`, `-gt`, `-approx`, `-bor`, `-band`, `-recursivematch`, `-like`, + `-notlike` -\ ::= "-and" | "-or" +Valid join operators are: -\ ::= "-not" +`-and`, `-or` -\ ::= \ | \ +The not operator is `-not`. -\::= \ by using the specified \\> - -For a list of supported types for \, type `Get-Help about_ActiveDirectory_ObjectModel`. - -Note: PowerShell wildcards other than *, such as ?, are not supported by the *Filter* syntax. - -Note: To query using Lightweight Directory Access Protocol (LDAP) query strings, use the *LDAPFilter* parameter. +For a list of supported types for values, see `about_ActiveDirectory_ObjectModel`. For more +information about the **Filter** parameter, see `about_ActiveDirectory_Filter`. ```yaml -Type: String +Type: System.String Parameter Sets: Filter Aliases: @@ -158,16 +168,18 @@ Accept wildcard characters: False ``` ### -Identity -Specifies an Active Directory object by providing one of the following property values. -The identifier in parentheses is the LDAP display name for the attribute.The acceptable values for this parameter are: + +Specifies an Active Directory object by providing one of the following property values. The +identifier in parentheses is the LDAP display name for the attribute.The acceptable values for this +parameter are: - A distinguished name -- A GUID (objectGUID) -- A Security Identifier (objectSid) -- A SAM account name (sAMAccountName) +- A GUID (**objectGUID**) +- A Security Identifier (**objectSid**) +- A SAM account name (**sAMAccountName**) ```yaml -Type: ADCentralAccessPolicy +Type: Microsoft.ActiveDirectory.Management.ADCentralAccessPolicy Parameter Sets: Identity Aliases: @@ -179,13 +191,12 @@ Accept wildcard characters: False ``` ### -LDAPFilter -Specifies an LDAP query string that is used to filter Active Directory objects. -You can use this parameter to run your existing LDAP queries. -The Filter parameter syntax supports the same functionality as the LDAP syntax. -For more information, see the *Filter* parameter description or type `Get-Help about_ActiveDirectory_Filter`. + +Specifies a filter using the LDAP search filter syntax defined in RFC2254 to filter Active Directory +Domain Services objects. ```yaml -Type: String +Type: System.String Parameter Sets: LdapFilter Aliases: @@ -197,19 +208,18 @@ Accept wildcard characters: False ``` ### -Properties -Specifies the properties of the output object to retrieve from the server. -Use this parameter to retrieve properties that are not included in the default set. -Specify properties for this parameter as a comma-separated list of names. -To display all of the attributes that are set on the object, specify * (asterisk). +Specifies the properties of the output object to get from the server. Use this parameter to get +properties that are not included in the default set. -To specify an individual extended property, use the name of the property. -For properties that are not default or extended properties, you must specify the LDAP display name of the attribute. +Specify the properties to get as a comma separated list of names. To display +all of the properties that are set on the object, specify an asterisk (`*`) wildcard. -To retrieve properties and display them for an object, you can use the Get-* cmdlet associated with the object and pass the output to the **Get-Member** cmdlet. +To specify an individual extended property, use the name of the property. For properties that are +not default or extended properties, you must specify the LDAP display name of the attribute. ```yaml -Type: String[] +Type: System.String[] Parameter Sets: (All) Aliases: Property @@ -221,12 +231,12 @@ Accept wildcard characters: False ``` ### -ResultPageSize -Specifies the number of objects to include in one page for an Active Directory Domain Services query. -The default is 256 objects per page. +Specifies the number of objects to include in one page for an Active Directory Domain Services +query. The default value is `256` objects per page. ```yaml -Type: Int32 +Type: System.Int32 Parameter Sets: Filter, LdapFilter Aliases: @@ -238,14 +248,15 @@ Accept wildcard characters: False ``` ### -ResultSetSize -Specifies the maximum number of objects to return for an Active Directory Domain Services query. -If you want to receive all of the objects, set this parameter to $Null (null value). -You can use Ctrl+C to stop the query and return of objects. -The default is $Null. +Specifies the maximum number of objects to return for an Active Directory Domain Services query. If +you want to get all of the objects, set this parameter to `$null`. You can use Ctrl+C to stop the +query and the return of objects. + +The default value is `$null`. ```yaml -Type: Int32 +Type: System.Int32 Parameter Sets: Filter, LdapFilter Aliases: @@ -257,30 +268,35 @@ Accept wildcard characters: False ``` ### -Server -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory snapshot instance. -Specify the Active Directory Domain Services instance in one of the following ways: +Specifies the Active Directory Domain Services instance to connect to, by providing one of the +following values for a corresponding domain name or directory server. The service may be any of the +following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active +Directory snapshot instance. + +Specify the Active Directory Domain Services instance in one of the following ways: Domain name values: - Fully qualified domain name - NetBIOS name -Directory server values: +Directory server values: - Fully qualified directory server name - NetBIOS name - Fully qualified directory server name and port -The default value for this parameter is determined by one of the following methods in the order that they are listed: +The default value for this parameter is determined by one of the following methods in the order that +they are listed: -- By using the *Server* value from objects passed through the pipeline -- By using the server information associated with the Active Directory Domain Services Windows PowerShell provider drive, when the cmdlet runs in that drive +- By using the **Server** value from objects passed through the pipeline +- By using the server information associated with the Active Directory Domain Services Windows + PowerShell provider drive, when the cmdlet runs in that drive - By using the domain of the computer running Windows PowerShell ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -292,31 +308,27 @@ Accept wildcard characters: False ``` ### CommonParameters -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). + +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). ## INPUTS ### None or Microsoft.ActiveDirectory.Management.ADCentralAccessPolicy -An **ADCentralAccessPolicy** object is received by the *Identity* parameter. + +An **ADCentralAccessPolicy** object is received by the **Identity** parameter. ## OUTPUTS ### Microsoft.ActiveDirectory.Management.ADCentralAccessPolicy -This cmdlet returns one or more **ADCentralAccessPolicy** objects. - -The **Get-ADCentralAccessPolicy** cmdlet returns a default set of **ADCentralAccessPolicy** property values. -To retrieve additional **ADCentralAccessPolicy** properties, use the *Properties* parameter of the cmdlet. - -To view the properties for an **ADCentralAccessPolicy** object, see the following examples. -To run these examples, replace \ with an Active Directory object identifier. -To get a list of the default set of properties of an **ADCentralAccessPolicy** object, use the following command: - -`Get-ADCentralAccessPolicy`\ - -To get a list of all the properties of an **ADCentralAccessPolicy** object, use the following command: +This cmdlet returns one or more **ADCentralAccessPolicy** objects. -`Get-ADCentralAccessPolicy`\`-Properties *` +The cmdlet returns a default set of **ADCentralAccessPolicy** property +values. To retrieve additional **ADCentralAccessPolicy** properties, use the **Properties** +parameter of the cmdlet. ## NOTES @@ -329,4 +341,3 @@ To get a list of all the properties of an **ADCentralAccessPolicy** object, use [Set-ADCentralAccessPolicy](./Set-ADCentralAccessPolicy.md) [AD DS Administration Cmdlets in Windows PowerShell](./activedirectory.md) - From bc5c759a7f16d200c9aa37192989e580ed5af85d Mon Sep 17 00:00:00 2001 From: Rob Derickson Date: Sun, 4 Jun 2023 21:27:33 -0400 Subject: [PATCH 501/650] Fix formatting for Get-ADCentralAccessRule. --- .../Get-ADCentralAccessRule.md | 222 +++++++++--------- 1 file changed, 116 insertions(+), 106 deletions(-) diff --git a/docset/winserver2022-ps/activedirectory/Get-ADCentralAccessRule.md b/docset/winserver2022-ps/activedirectory/Get-ADCentralAccessRule.md index 935c92524c..e76553f099 100644 --- a/docset/winserver2022-ps/activedirectory/Get-ADCentralAccessRule.md +++ b/docset/winserver2022-ps/activedirectory/Get-ADCentralAccessRule.md @@ -16,66 +16,75 @@ Retrieves central access rules from Active Directory. ## SYNTAX ### Filter (Default) + ``` -Get-ADCentralAccessRule [-AuthType ] [-Credential ] -Filter - [-Properties ] [-ResultPageSize ] [-ResultSetSize ] [-Server ] - [] +Get-ADCentralAccessRule [-AuthType ] [-Credential ] + -Filter [-Properties ] [-ResultPageSize ] + [-ResultSetSize ] [-Server ] [] ``` ### Identity + ``` -Get-ADCentralAccessRule [-AuthType ] [-Credential ] [-Identity] - [-Properties ] [-Server ] [] +Get-ADCentralAccessRule [-AuthType ] [-Credential ] + [-Identity] [-Properties ] [-Server ] + [] ``` ### LdapFilter + ``` -Get-ADCentralAccessRule [-AuthType ] [-Credential ] -LDAPFilter - [-Properties ] [-ResultPageSize ] [-ResultSetSize ] [-Server ] - [] +Get-ADCentralAccessRule [-AuthType ] [-Credential ] + -LDAPFilter [-Properties ] [-ResultPageSize ] + [-ResultSetSize ] [-Server ] [] ``` ## DESCRIPTION -The **Get-ADCentralAccessRule** cmdlet retrieves central access rules from Active Directory. + +The `Get-ADCentralAccessRule` cmdlet retrieves central access rules from Active Directory. ## EXAMPLES ### Example 1: Get a list of all central access rules -``` -PS C:\> Get-ADCentralAccessRule -Filter * + +```powershell +Get-ADCentralAccessRule -Filter * ``` This command retrieves a list of all central access rules. ### Example 2: Get central access rules that have a specific resource condition -``` -PS C:\> Get-ADCentralAccessRule -Filter "ResourceCondition -like '*Department*'" + +```powershell +Get-ADCentralAccessRule -Filter "ResourceCondition -like '*Department*'" ``` -This command retrieves the central access rules that have Department in its resource condition. +This command retrieves the central access rules that have `Department` in its resource condition. ### Example 3: Get a specific central access rule by name -``` -PS C:\> Get-ADCentralAccessRule -Identity "Financial Documents Rule" + +```powershell +Get-ADCentralAccessRule -Identity "Financial Documents Rule" ``` -This command retrieves a central access rule named Finance Documents Rule. +This command retrieves a central access rule named `Finance Documents Rule`. ## PARAMETERS ### -AuthType + Specifies the authentication method to use. The acceptable values for this parameter are: -- Negotiate or 0 -- Basic or 1 +- `Negotiate` or `0` +- `Basic` or `1` -The default authentication method is Negotiate. +The default authentication method is `Negotiate`. -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. +A Secure Sockets Layer (SSL) connection is required for the `Basic` authentication method. ```yaml -Type: ADAuthType +Type: Microsoft.ActiveDirectory.Management.ADAuthType Parameter Sets: (All) Aliases: Accepted values: Negotiate, Basic @@ -88,20 +97,24 @@ Accept wildcard characters: False ``` ### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory module for Windows PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. -To specify this parameter, you can type a user name, such as User1 or Domain01\User01 or you can specify a **PSCredential** object. -If you specify a user name for this parameter, the cmdlet prompts for a password. +Specifies the user account credentials to use to perform this task. The default credentials are the +credentials of the currently logged on user unless the cmdlet is run from an Active Directory module +for Windows PowerShell provider drive. If the cmdlet is run from such a provider drive, the account +associated with the drive is the default. -You can also create a **PSCredential** object by using a script or by using the **Get-Credential** cmdlet. -You can then set the *Credential* parameter to the **PSCredential** object. +To specify this parameter, you can type a user name, such as `User1` or `Domain01\User01` or you can +specify a **PSCredential** object. If you specify a user name for this parameter, the cmdlet prompts +for a password. -If the acting credentials do not have directory-level permission to perform the task, Active Directory module for Windows PowerShell returns a terminating error. +You can also create a **PSCredential** object by using a script or by using the `Get-Credential` +cmdlet. You can then set the **Credential** parameter to the **PSCredential** object. + +If the acting credentials do not have directory-level permission to perform the task, Active +Directory module for Windows PowerShell returns a terminating error. ```yaml -Type: PSCredential +Type: System.Management.Automation.PSCredential Parameter Sets: (All) Aliases: @@ -113,40 +126,36 @@ Accept wildcard characters: False ``` ### -Filter -Specifies a query string that retrieves Active Directory objects. -This string uses the PowerShell Expression Language syntax. -The PowerShell Expression Language syntax provides rich type-conversion support for value types received by the *Filter* parameter. -The syntax uses an in-order representation, which means that the operator is placed between the operand and the value. -For more information about the *Filter* parameter, type `Get-Help about_ActiveDirectory_Filter`. - -Syntax: -The following syntax uses Backus-Naur form to show how to use the PowerShell Expression Language for this parameter. +Specifies a query string that retrieves Active Directory Domain Services objects. This string uses +the Windows PowerShell expression language syntax. The Windows PowerShell expression language syntax +provides rich type-conversion support for value types received by the **Filter** parameter. -\ ::= "{" \ "}" +Specify the **Filter** parameter in one of the following formats: -\ ::= \ | \ \ \ | \ \ +- To match a single filter element: `{Attribute operator "value"}` +- To match multiple filter elements: + `{(Attribute1 operator1 "value1") joinOperator (Attribute2 operator2 "value2")}` -\ ::= \ \ \ | "(" \ ")" +Windows PowerShell wildcards other than `*`, such as `?`, are not supported by the **Filter** +syntax. -\ ::= "-eq" | "-le" | "-ge" | "-ne" | "-lt" | "-gt"| "-approx" | "-bor" | "-band" | "-recursivematch" | "-like" | "-notlike" +Valid filter operators are: -\ ::= "-and" | "-or" + `-eq`, `-le`, `-ge`, `-ne`, `-lt`, `-gt`, `-approx`, `-bor`, `-band`, `-recursivematch`, `-like`, + `-notlike` -\ ::= "-not" +Valid join operators are: -\ ::= \ | \ +`-and`, `-or` -\::= \ by using the specified \\> +The not operator is `-not`. -For a list of supported types for \, type `Get-Help about_ActiveDirectory_ObjectModel`. - -Note: PowerShell wildcards other than *, such as ?, are not supported by the *Filter* syntax. - -Note: To query using Lightweight Directory Access Protocol (LDAP) query strings, use the *LDAPFilter* parameter. +For a list of supported types for values, see `about_ActiveDirectory_ObjectModel`. For more +information about the **Filter** parameter, see `about_ActiveDirectory_Filter`. ```yaml -Type: String +Type: System.String Parameter Sets: Filter Aliases: @@ -158,19 +167,21 @@ Accept wildcard characters: False ``` ### -Identity -Specifies an Active Directory object by providing one of the following property values. -The identifier in parentheses is the LDAP display name for the attribute. -The acceptable values for this parameter are: + +Specifies an Active Directory object by providing one of the following property values. The +identifier in parentheses is the LDAP display name for the attribute. The acceptable values for this +parameter are: - A distinguished name -- A GUID (objectGUID) -- A security identifier (objectSid) -- A SAM account name (sAMAccountName) +- A GUID (**objectGUID**) +- A security identifier (**objectSid**) +- A SAM account name (**sAMAccountName**) -This parameter can also get this object through the pipeline or you can set this parameter to an object instance. +This parameter can also get this object through the pipeline or you can set this parameter to an +object instance. ```yaml -Type: ADCentralAccessRule +Type: Microsoft.ActiveDirectory.Management.ADCentralAccessRule Parameter Sets: Identity Aliases: @@ -182,13 +193,12 @@ Accept wildcard characters: False ``` ### -LDAPFilter -Specifies an LDAP query string that is used to filter Active Directory objects. -You can use this parameter to run your existing LDAP queries. -The *Filter* parameter syntax supports the same functionality as the LDAP syntax. -For more information, see the *Filter* parameter description or type `Get-Help about_ActiveDirectory_Filter`. + +Specifies a filter using the LDAP search filter syntax defined in RFC2254 to filter Active Directory +Domain Services objects. ```yaml -Type: String +Type: System.String Parameter Sets: LdapFilter Aliases: @@ -200,19 +210,18 @@ Accept wildcard characters: False ``` ### -Properties -Specifies the properties of the output object to retrieve from the server. -You can use this parameter to retrieve properties that are not included in the default set. -Specify properties for this parameter as a comma-separated list of names. -To display all of the attributes that are set on the object, specify * (asterisk). +Specifies the properties of the output object to get from the server. Use this parameter to get +properties that are not included in the default set. -To specify an individual extended property, use the name of the property. -For properties that are not default or extended properties, you must specify the LDAP display name of the attribute. +Specify the properties to get as a comma separated list of names. To display +all of the properties that are set on the object, specify an asterisk (`*`) wildcard. -To retrieve properties and display them for an object, you can use the Get-* cmdlet associated with the object and pass the output to the **Get-Member** cmdlet. +To specify an individual extended property, use the name of the property. For properties that are +not default or extended properties, you must specify the LDAP display name of the attribute. ```yaml -Type: String[] +Type: System.String[] Parameter Sets: (All) Aliases: Property @@ -224,12 +233,12 @@ Accept wildcard characters: False ``` ### -ResultPageSize -Specifies the number of objects to include in one page for an Active Directory Domain Services query. -The default is 256 objects per page. +Specifies the number of objects to include in one page for an Active Directory Domain Services +query. The default value is `256` objects per page. ```yaml -Type: Int32 +Type: System.Int32 Parameter Sets: Filter, LdapFilter Aliases: @@ -241,14 +250,15 @@ Accept wildcard characters: False ``` ### -ResultSetSize -Specifies the maximum number of objects to return for an Active Directory Domain Services query. -If you want to receive all of the objects, set this parameter to $Null (null value). -You can use Ctrl+C to stop the query and return of objects. -The default is $Null. +Specifies the maximum number of objects to return for an Active Directory Domain Services query. If +you want to get all of the objects, set this parameter to `$null`. You can use Ctrl+C to stop the +query and the return of objects. + +The default value is `$null`. ```yaml -Type: Int32 +Type: System.Int32 Parameter Sets: Filter, LdapFilter Aliases: @@ -260,30 +270,35 @@ Accept wildcard characters: False ``` ### -Server -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory snapshot instance. -Specify the Active Directory Domain Services instance in one of the following ways: +Specifies the Active Directory Domain Services instance to connect to, by providing one of the +following values for a corresponding domain name or directory server. The service may be any of the +following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active +Directory snapshot instance. + +Specify the Active Directory Domain Services instance in one of the following ways: Domain name values: - Fully qualified domain name - NetBIOS name -Directory server values: +Directory server values: - Fully qualified directory server name - NetBIOS name - Fully qualified directory server name and port -The default value for this parameter is determined by one of the following methods in the order that they are listed: +The default value for this parameter is determined by one of the following methods in the order that +they are listed: -- By using the *Server* value from objects passed through the pipeline -- By using the server information associated with the Active Directory Domain Services Windows PowerShell provider drive, when the cmdlet runs in that drive +- By using the **Server** value from objects passed through the pipeline +- By using the server information associated with the Active Directory Domain Services Windows + PowerShell provider drive, when the cmdlet runs in that drive - By using the domain of the computer running Windows PowerShell ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -295,31 +310,27 @@ Accept wildcard characters: False ``` ### CommonParameters -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). + +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). ## INPUTS ### None or Microsoft.ActiveDirectory.Management.ADCentralAccessPolicyEntry -An **ADCentralAccessPolicyEntry** object is received by the *Identity* parameter. + +An **ADCentralAccessPolicyEntry** object is received by the **Identity** parameter. ## OUTPUTS ### Microsoft.ActiveDirectory.Management.ADCentralAccessRule -Returns one or more **ADCentralAccessRule** objects. - -The **Get-ADCentralAccessRule** cmdlet returns a default set of **ADCentralAccessRule** property values. -To retrieve additional **ADCentralAccessRule** properties, use the *Properties* parameter of the cmdlet. - -To view the properties for an **ADCentralAccessRule** object, see the following examples. -To run these examples, replace \ with an Active Directory object identifier. -To get a list of the default set of properties of an **ADCentralAccessRule** object, use the following command: - -`Get-ADCentralAccessRule`\ - -To get a list of all the properties of an **ADCentralAccessRule** object, use the following command: +Returns one or more **ADCentralAccessRule** objects. -`Get-ADCentralAccessRule`\`-Properties *` +The cmdlet returns a default set of **ADCentralAccessRule** property +values. To retrieve additional **ADCentralAccessRule** properties, use the **Properties** parameter +of the cmdlet. ## NOTES @@ -332,4 +343,3 @@ To get a list of all the properties of an **ADCentralAccessRule** object, use th [Set-ADCentralAccessRule](./Set-ADCentralAccessRule.md) [AD DS Administration Cmdlets in Windows PowerShell](./activedirectory.md) - From 3248e86f07a7591c5ebb2f854d0458f84cc1e760 Mon Sep 17 00:00:00 2001 From: Rob Derickson Date: Sun, 4 Jun 2023 21:36:10 -0400 Subject: [PATCH 502/650] Fix formatting for Get-ADClaimTransformPolicy. --- .../Get-ADClaimTransformPolicy.md | 191 ++++++++++-------- 1 file changed, 108 insertions(+), 83 deletions(-) diff --git a/docset/winserver2022-ps/activedirectory/Get-ADClaimTransformPolicy.md b/docset/winserver2022-ps/activedirectory/Get-ADClaimTransformPolicy.md index 8408ad6dde..c021847364 100644 --- a/docset/winserver2022-ps/activedirectory/Get-ADClaimTransformPolicy.md +++ b/docset/winserver2022-ps/activedirectory/Get-ADClaimTransformPolicy.md @@ -16,72 +16,86 @@ Returns one or more Active Directory claim transform objects based on a specifie ## SYNTAX ### Filter (Default) + ``` -Get-ADClaimTransformPolicy [-AuthType ] [-Credential ] -Filter - [-Properties ] [-Server ] [] +Get-ADClaimTransformPolicy [-AuthType ] [-Credential ] + -Filter [-Properties ] [-Server ] [] ``` ### Identity + ``` Get-ADClaimTransformPolicy [-AuthType ] [-Credential ] - [[-Identity] ] [-Properties ] [-Server ] [] + [[-Identity] ] [-Properties ] [-Server ] + [] ``` ### LdapFilter + ``` -Get-ADClaimTransformPolicy [-AuthType ] [-Credential ] -LDAPFilter - [-Properties ] [-Server ] [] +Get-ADClaimTransformPolicy [-AuthType ] [-Credential ] + -LDAPFilter [-Properties ] [-Server ] [] ``` ## DESCRIPTION -The **Get-ADClaimTransformPolicy** cmdlet returns one or more Active Directory claim transform objects based on a specified filter. + +The `Get-ADClaimTransformPolicy` cmdlet returns one or more Active Directory claim transform objects +based on a specified filter. ## EXAMPLES ### Example 1: Get a list of all claims transformation policies -``` -PS C:\> Get-ADClaimTransformPolicy -Filter * + +```powershell +Get-ADClaimTransformPolicy -Filter * ``` This command retrieves a list of all claims transformation policies. ### Example 2: Get all the claims transformation policies that are applied to a specific trust -``` -PS C:\> $Contoso = Get-ADTrust -Identity "corp.contoso.com" -PS C:\> Get-ADClaimTransformPolicy -Filter "IncomingTrust -eq '$Contoso' -or OutgoingTrust -eq '$Contoso'" + +```powershell +$trust = Get-ADTrust -Identity "corp.contoso.com" +$filter = "IncomingTrust -eq '$trust' -or OutgoingTrust -eq '$trust'" +Get-ADClaimTransformPolicy -Filter $filter ``` -This example gets all the claims transformation policies that are applied to trusts made with corp.contoso.com. +This example gets all the claims transformation policies that are applied to trusts made with +`corp.contoso.com`. ### Example 3: Get the claims transformation policy with a specify policy name -``` -PS C:\> Get-ADClaimTransformPolicy -Identity DenyAllPolicy + +```powershell +Get-ADClaimTransformPolicy -Identity DenyAllPolicy ``` -This command gets the claims transformation policy with the name DenyAllPolicy. +This command gets the claims transformation policy with the name `DenyAllPolicy`. ### Example 4: Get information on claims using a LDAP based query filter -``` -PS C:\> Get-ADClaimTransformPolicy -LDAPFilter "(name=DenyAll*)" + +```powershell +Get-ADClaimTransformPolicy -LDAPFilter "(name=DenyAll*)" ``` -This command gets information on any claims transformation policies using an LDAP-based query filter that looks for matches where policies have a name that starts with the word DenyAll. +This command gets information on any claims transformation policies using an LDAP-based query filter +that looks for matches where policies have a name that starts with the word `DenyAll`. ## PARAMETERS ### -AuthType + Specifies the authentication method to use. The acceptable values for this parameter are: -- Negotiate or 0 -- Basic or 1 +- `Negotiate` or `0` +- `Basic` or `1` -The default authentication method is Negotiate. +The default authentication method is `Negotiate`. -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. +A Secure Sockets Layer (SSL) connection is required for the `Basic` authentication method. ```yaml -Type: ADAuthType +Type: Microsoft.ActiveDirectory.Management.ADAuthType Parameter Sets: (All) Aliases: Accepted values: Negotiate, Basic @@ -94,20 +108,24 @@ Accept wildcard characters: False ``` ### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory module for Windows PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. -To specify this parameter, you can type a user name, such as User1 or Domain01\User01 or you can specify a **PSCredential** object. -If you specify a user name for this parameter, the cmdlet prompts for a password. +Specifies the user account credentials to use to perform this task. The default credentials are the +credentials of the currently logged on user unless the cmdlet is run from an Active Directory module +for Windows PowerShell provider drive. If the cmdlet is run from such a provider drive, the account +associated with the drive is the default. + +To specify this parameter, you can type a user name, such as `User1` or `Domain01\User01` or you can +specify a **PSCredential** object. If you specify a user name for this parameter, the cmdlet prompts +for a password. -You can also create a **PSCredential** object by using a script or by using the **Get-Credential** cmdlet. -You can then set the *Credential* parameter to the **PSCredential** object. +You can also create a **PSCredential** object by using a script or by using the `Get-Credential` +cmdlet. You can then set the **Credential** parameter to the **PSCredential** object. -If the acting credentials do not have directory-level permission to perform the task, Active Directory module for Windows PowerShell returns a terminating error. +If the acting credentials do not have directory-level permission to perform the task, Active +Directory module for Windows PowerShell returns a terminating error. ```yaml -Type: PSCredential +Type: System.Management.Automation.PSCredential Parameter Sets: (All) Aliases: @@ -119,38 +137,36 @@ Accept wildcard characters: False ``` ### -Filter -Specifies a query string that retrieves Active Directory objects. -This string uses the Windows PowerShell Expression Language syntax. -The Windows PowerShell Expression Language syntax provides rich type-conversion support for value types received by the *Filter* parameter. -The syntax uses an in-order representation, which means that the operator is placed between the operand and the value. -For more information about the *Filter* parameter, type `Get-Help about_ActiveDirectory_Filter`. -Syntax: +Specifies a query string that retrieves Active Directory Domain Services objects. This string uses +the Windows PowerShell expression language syntax. The Windows PowerShell expression language syntax +provides rich type-conversion support for value types received by the **Filter** parameter. -The following syntax uses Backus-Naur form to show how to use the Windows PowerShell Expression Language for this parameter. +Specify the **Filter** parameter in one of the following formats: -\ ::= "{" \ "}" +- To match a single filter element: `{Attribute operator "value"}` +- To match multiple filter elements: + `{(Attribute1 operator1 "value1") joinOperator (Attribute2 operator2 "value2")}` -\ ::= \ | \ \ \ | \ \ +Windows PowerShell wildcards other than `*`, such as `?`, are not supported by the **Filter** +syntax. -\ ::= \ \ \ | "(" \ ")" +Valid filter operators are: -\ ::= "-eq" | "-le" | "-ge" | "-ne" | "-lt" | "-gt"| "-approx" | "-bor" | "-band" | "-recursivematch" | "-like" | "-notlike" + `-eq`, `-le`, `-ge`, `-ne`, `-lt`, `-gt`, `-approx`, `-bor`, `-band`, `-recursivematch`, `-like`, + `-notlike` -\ ::= "-and" | "-or" +Valid join operators are: -\ ::= "-not" +`-and`, `-or` -\ ::= \ | \ +The not operator is `-not`. -\::= \ by using the specified \\> - -For a list of supported types for \, see about_ActiveDirectory_ObjectModel. - -Note: To query using Lightweight Directory Access Protocol (LDAP) query strings, use the *LDAPFilter* parameter. +For a list of supported types for values, see `about_ActiveDirectory_ObjectModel`. For more +information about the **Filter** parameter, see `about_ActiveDirectory_Filter`. ```yaml -Type: String +Type: System.String Parameter Sets: Filter Aliases: @@ -162,19 +178,21 @@ Accept wildcard characters: False ``` ### -Identity -Specifies an Active Directory object by providing one of the following property values. -The identifier in parentheses is the LDAP display name for the attribute. -The acceptable values for this parameter are: + +Specifies an Active Directory object by providing one of the following property values. The +identifier in parentheses is the LDAP display name for the attribute. The acceptable values for this +parameter are: - A distinguished name -The cmdlet searches the default naming context or partition to find the object. -If two or more objects are found, the cmdlet returns a non-terminating error. +The cmdlet searches the default naming context or partition to find the object. If two or more +objects are found, the cmdlet returns a non-terminating error. -This parameter can also get this object through the pipeline or you can set this parameter to an object instance. +This parameter can also get this object through the pipeline or you can set this parameter to an +object instance. ```yaml -Type: ADClaimTransformPolicy +Type: Microsoft.ActiveDirectory.Management.ADClaimTransformPolicy Parameter Sets: Identity Aliases: @@ -186,13 +204,12 @@ Accept wildcard characters: False ``` ### -LDAPFilter -Specifies an LDAP query string that is used to filter Active Directory objects. -You can use this parameter to run your existing LDAP queries. -The *Filter* parameter syntax supports the same functionality as the LDAP syntax. -For more information, see the *Filter* parameter description or type `Get-Help about_ActiveDirectory_Filter`. + +Specifies a filter using the LDAP search filter syntax defined in RFC2254 to filter Active Directory +Domain Services objects. ```yaml -Type: String +Type: System.String Parameter Sets: LdapFilter Aliases: @@ -204,19 +221,18 @@ Accept wildcard characters: False ``` ### -Properties -Specifies the properties of the output object to retrieve from the server. -Use this parameter to retrieve properties that are not included in the default set. -Specify properties for this parameter as a comma-separated list of names. -To display all of the attributes that are set on the object, specify * (asterisk). +Specifies the properties of the output object to get from the server. Use this parameter to get +properties that are not included in the default set. -To specify an individual extended property, use the name of the property. -For properties that are not default or extended properties, you must specify the LDAP display name of the attribute. +Specify the properties to get as a comma separated list of names. To display +all of the properties that are set on the object, specify an asterisk (`*`) wildcard. -To retrieve properties and display them for an object, you can use the Get-* cmdlet associated with the object and pass the output to the **Get-Member** cmdlet. +To specify an individual extended property, use the name of the property. For properties that are +not default or extended properties, you must specify the LDAP display name of the attribute. ```yaml -Type: String[] +Type: System.String[] Parameter Sets: (All) Aliases: Property @@ -228,30 +244,35 @@ Accept wildcard characters: False ``` ### -Server -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory snapshot instance. -Specify the Active Directory Domain Services instance in one of the following ways: +Specifies the Active Directory Domain Services instance to connect to, by providing one of the +following values for a corresponding domain name or directory server. The service may be any of the +following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active +Directory snapshot instance. + +Specify the Active Directory Domain Services instance in one of the following ways: Domain name values: - Fully qualified domain name - NetBIOS name -Directory server values: +Directory server values: - Fully qualified directory server name - NetBIOS name - Fully qualified directory server name and port -The default value for this parameter is determined by one of the following methods in the order that they are listed: +The default value for this parameter is determined by one of the following methods in the order that +they are listed: -- By using the *Server* value from objects passed through the pipeline -- By using the server information associated with the Active Directory Domain Services Windows PowerShell provider drive, when the cmdlet runs in that drive +- By using the **Server** value from objects passed through the pipeline +- By using the server information associated with the Active Directory Domain Services Windows + PowerShell provider drive, when the cmdlet runs in that drive - By using the domain of the computer running Windows PowerShell ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -263,12 +284,17 @@ Accept wildcard characters: False ``` ### CommonParameters -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). + +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). ## INPUTS ### None or Microsoft.ActiveDirectory.Management.ADClaimTransformPolicy -A claim transform policy object is received by the *Identity* parameter. + +A claim transform policy object is received by the **Identity** parameter. ## OUTPUTS @@ -285,4 +311,3 @@ A claim transform policy object is received by the *Identity* parameter. [Set-ADClaimTransformPolicy](./Set-ADClaimTransformPolicy.md) [AD DS Administration Cmdlets in Windows PowerShell](./activedirectory.md) - From 92b2453d69da56b0778d43c2b7d07065694c32bd Mon Sep 17 00:00:00 2001 From: Rob Derickson Date: Sun, 4 Jun 2023 23:48:45 -0400 Subject: [PATCH 503/650] Close code fence. --- .../activedirectory/Get-ADAuthenticationPolicySilo.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docset/winserver2022-ps/activedirectory/Get-ADAuthenticationPolicySilo.md b/docset/winserver2022-ps/activedirectory/Get-ADAuthenticationPolicySilo.md index d91277588d..213bc7ba4a 100644 --- a/docset/winserver2022-ps/activedirectory/Get-ADAuthenticationPolicySilo.md +++ b/docset/winserver2022-ps/activedirectory/Get-ADAuthenticationPolicySilo.md @@ -73,6 +73,7 @@ This command gets an authentication policy silo object named AuthenticationPolic ```powershell Get-ADAuthenticationPolicySilo -Filter 'Name -like "*AuthenticationPolicySilo*"' | Format-Table Name, Enforce -AutoSize +``` ```output Name Enforce From dd5e3a7d076f756d656d78e539a80353733c8cd1 Mon Sep 17 00:00:00 2001 From: Sean Wheeler Date: Mon, 5 Jun 2023 08:29:45 -0500 Subject: [PATCH 504/650] Link to Windows Feedback Hub --- .../winserver2016-ps/module-compatibility.md | 32 +- .../winserver2019-ps/module-compatibility.md | 32 +- .../winserver2022-ps/module-compatibility.md | 278 +++++++++--------- 3 files changed, 183 insertions(+), 159 deletions(-) diff --git a/docset/docs-conceptual/winserver2016-ps/module-compatibility.md b/docset/docs-conceptual/winserver2016-ps/module-compatibility.md index e2f0c34765..29d3a1bc07 100644 --- a/docset/docs-conceptual/winserver2016-ps/module-compatibility.md +++ b/docset/docs-conceptual/winserver2016-ps/module-compatibility.md @@ -1,25 +1,25 @@ --- description: This article lists the status of PowerShell 7 with Powershell modules published for other Microsoft products. -ms.date: 10/04/2021 +ms.date: 06/05/2023 title: PowerShell 7 module compatibility --- # PowerShell 7 module compatibility This article contains a list of PowerShell modules published by Microsoft. These modules provide -management and support for various Microsoft products and services. They have been updated -to work natively with PowerShell 7, or tested for compatibility with PowerShell 7. This list will be -updated with new information as more modules are identified and tested. +management and support for various Microsoft products and services. They have been updated to work +natively with PowerShell 7, or tested for compatibility with PowerShell 7. This list will be updated +with new information as more modules are identified and tested. -If you have information to share or issues with specific modules, please file an issue in the -[WindowsCompatibility repo](https://github.com/PowerShell/WindowsCompatibility). +If you have information to share or issues with specific modules, please submit feedback in the +Windows Feedback Hub. For more information, see +[Send feedback to Microsoft with the Feedback Hub app][06]. ## Windows management modules The Windows management modules are installed in different ways, dependent on the Edition of Windows, and how the module was packaged for that Edition. -On Windows Server, use the feature name with the -[Install-WindowsFeature](/powershell/module/servermanager/install-windowsfeature) cmdlet as an +On Windows Server, use the feature name with the [Install-WindowsFeature][05] cmdlet as an Administrator. For example: ```powershell @@ -46,8 +46,8 @@ administrator**. For more information see: - - [Get-WindowsOptionalFeature](/powershell/module/dism/get-windowsoptionalfeature) - - [Enable-WindowsOptionalFeature](/powershell/module/dism/enable-windowsoptionalfeature) + - [Get-WindowsOptionalFeature][04] + - [Enable-WindowsOptionalFeature][02] - For Windows Capabilities @@ -66,8 +66,8 @@ administrator**. For more information see: - - [Get-WindowsCapability](/powershell/module/dism/get-windowscapability) - - [Add-WindowsCapability](/powershell/module/dism/add-windowscapability) + - [Get-WindowsCapability][03] + - [Add-WindowsCapability][01] ### Module list @@ -204,3 +204,11 @@ This module has some minor compatibility issues with formatted output in PowerSh the `Get-WindowsFeature` cmdlet returns the proper object with all properties, but the default display formatting makes some properties appear to be empty. The actual values are available in the object properties using `Select-Object` or by direct member access. + + +[01]: /powershell/module/dism/add-windowscapability +[02]: /powershell/module/dism/enable-windowsoptionalfeature +[03]: /powershell/module/dism/get-windowscapability +[04]: /powershell/module/dism/get-windowsoptionalfeature +[05]: /powershell/module/servermanager/install-windowsfeature +[06]: https://support.microsoft.com/windows/send-feedback-to-microsoft-with-the-feedback-hub-app-f59187f8-8739-22d6-ba93-f66612949332 diff --git a/docset/docs-conceptual/winserver2019-ps/module-compatibility.md b/docset/docs-conceptual/winserver2019-ps/module-compatibility.md index e2f0c34765..29d3a1bc07 100644 --- a/docset/docs-conceptual/winserver2019-ps/module-compatibility.md +++ b/docset/docs-conceptual/winserver2019-ps/module-compatibility.md @@ -1,25 +1,25 @@ --- description: This article lists the status of PowerShell 7 with Powershell modules published for other Microsoft products. -ms.date: 10/04/2021 +ms.date: 06/05/2023 title: PowerShell 7 module compatibility --- # PowerShell 7 module compatibility This article contains a list of PowerShell modules published by Microsoft. These modules provide -management and support for various Microsoft products and services. They have been updated -to work natively with PowerShell 7, or tested for compatibility with PowerShell 7. This list will be -updated with new information as more modules are identified and tested. +management and support for various Microsoft products and services. They have been updated to work +natively with PowerShell 7, or tested for compatibility with PowerShell 7. This list will be updated +with new information as more modules are identified and tested. -If you have information to share or issues with specific modules, please file an issue in the -[WindowsCompatibility repo](https://github.com/PowerShell/WindowsCompatibility). +If you have information to share or issues with specific modules, please submit feedback in the +Windows Feedback Hub. For more information, see +[Send feedback to Microsoft with the Feedback Hub app][06]. ## Windows management modules The Windows management modules are installed in different ways, dependent on the Edition of Windows, and how the module was packaged for that Edition. -On Windows Server, use the feature name with the -[Install-WindowsFeature](/powershell/module/servermanager/install-windowsfeature) cmdlet as an +On Windows Server, use the feature name with the [Install-WindowsFeature][05] cmdlet as an Administrator. For example: ```powershell @@ -46,8 +46,8 @@ administrator**. For more information see: - - [Get-WindowsOptionalFeature](/powershell/module/dism/get-windowsoptionalfeature) - - [Enable-WindowsOptionalFeature](/powershell/module/dism/enable-windowsoptionalfeature) + - [Get-WindowsOptionalFeature][04] + - [Enable-WindowsOptionalFeature][02] - For Windows Capabilities @@ -66,8 +66,8 @@ administrator**. For more information see: - - [Get-WindowsCapability](/powershell/module/dism/get-windowscapability) - - [Add-WindowsCapability](/powershell/module/dism/add-windowscapability) + - [Get-WindowsCapability][03] + - [Add-WindowsCapability][01] ### Module list @@ -204,3 +204,11 @@ This module has some minor compatibility issues with formatted output in PowerSh the `Get-WindowsFeature` cmdlet returns the proper object with all properties, but the default display formatting makes some properties appear to be empty. The actual values are available in the object properties using `Select-Object` or by direct member access. + + +[01]: /powershell/module/dism/add-windowscapability +[02]: /powershell/module/dism/enable-windowsoptionalfeature +[03]: /powershell/module/dism/get-windowscapability +[04]: /powershell/module/dism/get-windowsoptionalfeature +[05]: /powershell/module/servermanager/install-windowsfeature +[06]: https://support.microsoft.com/windows/send-feedback-to-microsoft-with-the-feedback-hub-app-f59187f8-8739-22d6-ba93-f66612949332 diff --git a/docset/docs-conceptual/winserver2022-ps/module-compatibility.md b/docset/docs-conceptual/winserver2022-ps/module-compatibility.md index e2f0c34765..7a7ae20384 100644 --- a/docset/docs-conceptual/winserver2022-ps/module-compatibility.md +++ b/docset/docs-conceptual/winserver2022-ps/module-compatibility.md @@ -1,25 +1,25 @@ --- description: This article lists the status of PowerShell 7 with Powershell modules published for other Microsoft products. -ms.date: 10/04/2021 +ms.date: 06/05/2023 title: PowerShell 7 module compatibility --- # PowerShell 7 module compatibility This article contains a list of PowerShell modules published by Microsoft. These modules provide -management and support for various Microsoft products and services. They have been updated -to work natively with PowerShell 7, or tested for compatibility with PowerShell 7. This list will be -updated with new information as more modules are identified and tested. +management and support for various Microsoft products and services. They have been updated to work +natively with PowerShell 7, or tested for compatibility with PowerShell 7. This list will be updated +with new information as more modules are identified and tested. -If you have information to share or issues with specific modules, please file an issue in the -[WindowsCompatibility repo](https://github.com/PowerShell/WindowsCompatibility). +If you have information to share or issues with specific modules, please submit feedback in the +Windows Feedback Hub. For more information, see +[Send feedback to Microsoft with the Feedback Hub app][06]. ## Windows management modules The Windows management modules are installed in different ways, dependent on the Edition of Windows, and how the module was packaged for that Edition. -On Windows Server, use the feature name with the -[Install-WindowsFeature](/powershell/module/servermanager/install-windowsfeature) cmdlet as an +On Windows Server, use the feature name with the [Install-WindowsFeature][05] cmdlet as an Administrator. For example: ```powershell @@ -46,8 +46,8 @@ administrator**. For more information see: - - [Get-WindowsOptionalFeature](/powershell/module/dism/get-windowsoptionalfeature) - - [Enable-WindowsOptionalFeature](/powershell/module/dism/enable-windowsoptionalfeature) + - [Get-WindowsOptionalFeature][04] + - [Enable-WindowsOptionalFeature][02] - For Windows Capabilities @@ -66,135 +66,135 @@ administrator**. For more information see: - - [Get-WindowsCapability](/powershell/module/dism/get-windowscapability) - - [Add-WindowsCapability](/powershell/module/dism/add-windowscapability) + - [Get-WindowsCapability][03] + - [Add-WindowsCapability][01] ### Module list -| Module name | Status | Supported OS | -| ---------------------------------- | ------------------------------------ | ---------------------------------- | -| ActiveDirectory | Natively Compatible | Windows Server 1809+ with RSAT-AD-PowerShell
Windows 10 1809+ with Rsat.ActiveDirectory.DS-LDS.Tools | -| ADDSDeployment | Works with Compatibility Layer | Windows Server 2019 1809+ | -| ADFS | Untested with Compatibility Layer | | -| AppBackgroundTask | Natively Compatible | Windows 10 1903+ | -| AppLocker | Untested with Compatibility Layer | | -| AppvClient | Untested with Compatibility Layer | | -| Appx | Natively Compatible** | Windows Server 1809+
Windows 10 1809+
**Must use Compatibility Layer with PowerShell 7.1 | -| AssignedAccess | Natively Compatible | Windows 10 1809+ | -| BestPractices | Not Supported by Compatibility Layer | | -| BitLocker | Natively Compatible | Windows Server 1809+ with BitLocker
Windows 10 1809+ | -| BitsTransfer | Natively Compatible | Windows Server 20H1
Windows 10 20H1 | -| BootEventCollector | Untested with Compatibility Layer | | -| BranchCache | Natively Compatible | Windows Server 1809+
Windows 10 1809+ | -| CimCmdlets | Natively Compatible | Built into PowerShell 7 | -| ClusterAwareUpdating | Untested with Compatibility Layer | | -| ConfigCI | Untested with Compatibility Layer | | -| Defender | Natively Compatible | Windows Server 1809+
Windows 10 1809+ | -| DeliveryOptimization | Natively Compatible | Windows Server 1903+
Windows 10 1903+ | -| DFSN | Natively Compatible | Windows Server 1809+ with FS-DFS-Namespace
Windows 10 1809+ with Rsat.FailoverCluster.Management.Tools | -| DFSR | Untested with Compatibility Layer | | -| DhcpServer | Untested with Compatibility Layer | | -| DirectAccessClientComponents | Natively Compatible | Windows Server 1809+
Windows 10 1809+ | -| Dism | Natively Compatible | Windows Server 1903+
Windows 10 1903+ | -| DnsClient | Natively Compatible | Windows Server 1809+
Windows 10 1809+ | -| DnsServer | Natively Compatible | Windows Server 1809+ with DNS or RSAT-DNS-Server
Windows 10 1809+ with Rsat.Dns.Tools | -| EventTracingManagement | Natively Compatible | Windows Server 1809+
Windows 10 1809+ | -| FailoverClusters | Untested with Compatibility Layer | | -| FailoverClusterSet | Untested with Compatibility Layer | | -| FileServerResourceManager | Natively Compatible | Windows Server 1809+ with FS-Resource-Manager | -| GroupPolicy | Untested with Compatibility Layer | | -| HgsClient | Natively Compatible | Windows Server 1903+ with Hyper-V or RSAT-Shielded-VM-Tools
Windows 10 1903+ with Rsat.Shielded.VM.Tools | -| HgsDiagnostics | Natively Compatible | Windows Server 1809+ with Hyper-V or RSAT-Shielded-VM-Tools
Windows 10 1809+ with Rsat.Shielded.VM.Tools | -| Hyper-V | Natively Compatible | Windows Server 1809+ with Hyper-V-PowerShell
Windows 10 1809+ with Microsoft-Hyper-V-Management-PowerShell | -| IISAdministration | Untested with Compatibility Layer | | -| International | Natively Compatible | Windows Server 1903+
Windows 10 1903+ | -| IpamServer | Untested with Compatibility Layer | | -| iSCSI | Untested with Compatibility Layer | | -| IscsiTarget | Untested with Compatibility Layer | | -| ISE | Untested with Compatibility Layer | | -| Kds | Natively Compatible | Windows Server 20H1
Windows 10 20H1 | -| Microsoft.PowerShell.Archive | Natively Compatible | Built into PowerShell 7 | -| Microsoft.PowerShell.Diagnostics | Natively Compatible | Built into PowerShell 7 | -| Microsoft.PowerShell.Host | Natively Compatible | Built into PowerShell 7 | -| Microsoft.PowerShell.LocalAccounts | Natively Compatible | Windows Server 1809+
Windows 10 1809+ | -| Microsoft.PowerShell.Management | Natively Compatible | Built into PowerShell 7 | -| Microsoft.PowerShell.ODataUtils | Untested with Compatibility Layer | | -| Microsoft.PowerShell.Security | Natively Compatible | Built into PowerShell 7 | -| Microsoft.PowerShell.Utility | Natively Compatible | Built into PowerShell 7 | -| Microsoft.WSMan.Management | Natively Compatible | Built into PowerShell 7 | -| MMAgent | Natively Compatible | Windows Server 1809+
Windows 10 1809+ | -| MPIO | Natively Compatible | Windows Server 1809+ with Multipath-IO | -| MsDtc | Untested with Compatibility Layer | | -| NetAdapter | Natively Compatible | Windows Server 1809+
Windows 10 1809+ | -| NetConnection | Natively Compatible | Windows Server 1809+
Windows 10 1809+ | -| NetEventPacketCapture | Natively Compatible | Windows Server 1809+
Windows 10 1809+ | -| NetLbfo | Natively Compatible | Windows Server 1809+
Windows 10 1809+ | -| NetLldpAgent | Untested with Compatibility Layer | | -| NetNat | Natively Compatible | Windows Server 1809+
Windows 10 1809+ | -| NetQos | Natively Compatible | Windows Server 1809+
Windows 10 1809+ | -| NetSecurity | Natively Compatible | Windows Server 1809+
Windows 10 1809+ | -| NetSwitchTeam | Natively Compatible | Windows Server 1809+
Windows 10 1809+ | -| NetTCPIP | Natively Compatible | Windows Server 1809+
Windows 10 1809+ | -| NetWNV | Untested with Compatibility Layer | | -| NetworkConnectivityStatus | Natively Compatible | Windows Server 1809+
Windows 10 1809+ | -| NetworkController | Untested with Compatibility Layer | | -| NetworkControllerDiagnostics | Untested with Compatibility Layer | | -| NetworkLoadBalancingClusters | Untested with Compatibility Layer | | -| NetworkSwitchManager | Natively Compatible | Windows Server 1809+
Windows 10 1809+ | -| NetworkTransition | Natively Compatible | Windows Server 1809+
Windows 10 1809+ | -| NFS | Natively Compatible | Windows Server 1809+
Windows 10 1809+ with Rsat.ServerManager.Tools | -| PackageManagement | Natively Compatible | Built into PowerShell 7 | -| PcsvDevice | Natively Compatible | Windows Server 1809+
Windows 10 1809+ | -| PersistentMemory | Untested with Compatibility Layer | | -| PKI | Untested with Compatibility Layer | | -| PnpDevice | Natively Compatible | Windows Server 1809+
Windows 10 1809+ | -| PowerShellGet | Natively Compatible | Built into PowerShell 7 | -| PrintManagement | Natively Compatible | Windows Server 1903+ with Print-Services
Windows 10 1903+ | -| ProcessMitigations | Natively Compatible | Windows Server 1903+
Windows 10 1903+ | -| Provisioning | Untested with Compatibility Layer | | -| PSDesiredStateConfiguration | Partially | Built into PowerShell 7 | -| PSDiagnostics | Natively Compatible | Built into PowerShell 7 | -| PSScheduledJob | Not Supported by Compatibility Layer | Built into PowerShell 5.1 | -| PSWorkflow | Untested with Compatibility Layer | | -| PSWorkflowUtility | Untested with Compatibility Layer | | -| RemoteAccess | Untested with Compatibility Layer | | -| RemoteDesktop | Untested with Compatibility Layer | | -| ScheduledTasks | Natively Compatible | Windows Server 1809+
Windows 10 1809+ | -| SecureBoot | Natively Compatible | Windows Server 1809+
Windows 10 1809+ | -| ServerCore | Untested with Compatibility Layer | | -| ServerManager | Natively Compatible | Windows Server 1809+
Windows 10 1809+ with Rsat.ServerManager.Tools
_See notes below_ | -| ServerManagerTasks | Untested with Compatibility Layer | | -| ShieldedVMDataFile | Natively Compatible | Windows Server 1903+ with RSAT-Shielded-VM-Tools
Windows 10 1903+ with Rsat.Shielded.VM.Tools | -| ShieldedVMProvisioning | Natively Compatible | Windows Server 1809+ with HostGuardian
Windows 10 1809+ with HostGuardian | -| ShieldedVMTemplate | Natively Compatible | Windows Server 1809+ with RSAT-Shielded-VM-Tools
Windows 10 1809+ with Rsat.Shielded.VM.Tools | -| SmbShare | Natively Compatible | Windows Server 1809+
Windows 10 1809+ | -| SmbWitness | Natively Compatible | Windows Server 1809+
Windows 10 1809+ | -| SMISConfig | Natively Compatible | Windows Server 1903+ with WindowsStorageManagementService | -| SMS | Untested with Compatibility Layer | | -| SoftwareInventoryLogging | Natively Compatible | Windows Server 1809+ | -| StartLayout | Natively Compatible | Windows Server 1809+ with Desktop Experience
Windows 10 1809+ | -| Storage | Natively Compatible | Windows Server 1809+
Windows 10 1809+ | -| StorageBusCache | Untested with Compatibility Layer | | -| StorageMigrationService | Untested with Compatibility Layer | | +| Module name | Status | Supported OS | +| ---------------------------------- | ------------------------------------ | ------------------------------------------------------------------------------------------------------------------- | +| ActiveDirectory | Natively Compatible | Windows Server 1809+ with RSAT-AD-PowerShell
Windows 10 1809+ with Rsat.ActiveDirectory.DS-LDS.Tools | +| ADDSDeployment | Works with Compatibility Layer | Windows Server 2019 1809+ | +| ADFS | Untested with Compatibility Layer | | +| AppBackgroundTask | Natively Compatible | Windows 10 1903+ | +| AppLocker | Untested with Compatibility Layer | | +| AppvClient | Untested with Compatibility Layer | | +| Appx | Natively Compatible** | Windows Server 1809+
Windows 10 1809+
**Must use Compatibility Layer with PowerShell 7.1 | +| AssignedAccess | Natively Compatible | Windows 10 1809+ | +| BestPractices | Not Supported by Compatibility Layer | | +| BitLocker | Natively Compatible | Windows Server 1809+ with BitLocker
Windows 10 1809+ | +| BitsTransfer | Natively Compatible | Windows Server 20H1
Windows 10 20H1 | +| BootEventCollector | Untested with Compatibility Layer | | +| BranchCache | Natively Compatible | Windows Server 1809+
Windows 10 1809+ | +| CimCmdlets | Natively Compatible | Built into PowerShell 7 | +| ClusterAwareUpdating | Untested with Compatibility Layer | | +| ConfigCI | Untested with Compatibility Layer | | +| Defender | Natively Compatible | Windows Server 1809+
Windows 10 1809+ | +| DeliveryOptimization | Natively Compatible | Windows Server 1903+
Windows 10 1903+ | +| DFSN | Natively Compatible | Windows Server 1809+ with FS-DFS-Namespace
Windows 10 1809+ with Rsat.FailoverCluster.Management.Tools | +| DFSR | Untested with Compatibility Layer | | +| DhcpServer | Untested with Compatibility Layer | | +| DirectAccessClientComponents | Natively Compatible | Windows Server 1809+
Windows 10 1809+ | +| Dism | Natively Compatible | Windows Server 1903+
Windows 10 1903+ | +| DnsClient | Natively Compatible | Windows Server 1809+
Windows 10 1809+ | +| DnsServer | Natively Compatible | Windows Server 1809+ with DNS or RSAT-DNS-Server
Windows 10 1809+ with Rsat.Dns.Tools | +| EventTracingManagement | Natively Compatible | Windows Server 1809+
Windows 10 1809+ | +| FailoverClusters | Untested with Compatibility Layer | | +| FailoverClusterSet | Untested with Compatibility Layer | | +| FileServerResourceManager | Natively Compatible | Windows Server 1809+ with FS-Resource-Manager | +| GroupPolicy | Untested with Compatibility Layer | | +| HgsClient | Natively Compatible | Windows Server 1903+ with Hyper-V or RSAT-Shielded-VM-Tools
Windows 10 1903+ with Rsat.Shielded.VM.Tools | +| HgsDiagnostics | Natively Compatible | Windows Server 1809+ with Hyper-V or RSAT-Shielded-VM-Tools
Windows 10 1809+ with Rsat.Shielded.VM.Tools | +| Hyper-V | Natively Compatible | Windows Server 1809+ with Hyper-V-PowerShell
Windows 10 1809+ with Microsoft-Hyper-V-Management-PowerShell | +| IISAdministration | Untested with Compatibility Layer | | +| International | Natively Compatible | Windows Server 1903+
Windows 10 1903+ | +| IpamServer | Untested with Compatibility Layer | | +| iSCSI | Untested with Compatibility Layer | | +| IscsiTarget | Untested with Compatibility Layer | | +| ISE | Untested with Compatibility Layer | | +| Kds | Natively Compatible | Windows Server 20H1
Windows 10 20H1 | +| Microsoft.PowerShell.Archive | Natively Compatible | Built into PowerShell 7 | +| Microsoft.PowerShell.Diagnostics | Natively Compatible | Built into PowerShell 7 | +| Microsoft.PowerShell.Host | Natively Compatible | Built into PowerShell 7 | +| Microsoft.PowerShell.LocalAccounts | Natively Compatible | Windows Server 1809+
Windows 10 1809+ | +| Microsoft.PowerShell.Management | Natively Compatible | Built into PowerShell 7 | +| Microsoft.PowerShell.ODataUtils | Untested with Compatibility Layer | | +| Microsoft.PowerShell.Security | Natively Compatible | Built into PowerShell 7 | +| Microsoft.PowerShell.Utility | Natively Compatible | Built into PowerShell 7 | +| Microsoft.WSMan.Management | Natively Compatible | Built into PowerShell 7 | +| MMAgent | Natively Compatible | Windows Server 1809+
Windows 10 1809+ | +| MPIO | Natively Compatible | Windows Server 1809+ with Multipath-IO | +| MsDtc | Untested with Compatibility Layer | | +| NetAdapter | Natively Compatible | Windows Server 1809+
Windows 10 1809+ | +| NetConnection | Natively Compatible | Windows Server 1809+
Windows 10 1809+ | +| NetEventPacketCapture | Natively Compatible | Windows Server 1809+
Windows 10 1809+ | +| NetLbfo | Natively Compatible | Windows Server 1809+
Windows 10 1809+ | +| NetLldpAgent | Untested with Compatibility Layer | | +| NetNat | Natively Compatible | Windows Server 1809+
Windows 10 1809+ | +| NetQos | Natively Compatible | Windows Server 1809+
Windows 10 1809+ | +| NetSecurity | Natively Compatible | Windows Server 1809+
Windows 10 1809+ | +| NetSwitchTeam | Natively Compatible | Windows Server 1809+
Windows 10 1809+ | +| NetTCPIP | Natively Compatible | Windows Server 1809+
Windows 10 1809+ | +| NetWNV | Untested with Compatibility Layer | | +| NetworkConnectivityStatus | Natively Compatible | Windows Server 1809+
Windows 10 1809+ | +| NetworkController | Untested with Compatibility Layer | | +| NetworkControllerDiagnostics | Untested with Compatibility Layer | | +| NetworkLoadBalancingClusters | Untested with Compatibility Layer | | +| NetworkSwitchManager | Natively Compatible | Windows Server 1809+
Windows 10 1809+ | +| NetworkTransition | Natively Compatible | Windows Server 1809+
Windows 10 1809+ | +| NFS | Natively Compatible | Windows Server 1809+
Windows 10 1809+ with Rsat.ServerManager.Tools | +| PackageManagement | Natively Compatible | Built into PowerShell 7 | +| PcsvDevice | Natively Compatible | Windows Server 1809+
Windows 10 1809+ | +| PersistentMemory | Untested with Compatibility Layer | | +| PKI | Untested with Compatibility Layer | | +| PnpDevice | Natively Compatible | Windows Server 1809+
Windows 10 1809+ | +| PowerShellGet | Natively Compatible | Built into PowerShell 7 | +| PrintManagement | Natively Compatible | Windows Server 1903+ with Print-Services
Windows 10 1903+ | +| ProcessMitigations | Natively Compatible | Windows Server 1903+
Windows 10 1903+ | +| Provisioning | Untested with Compatibility Layer | | +| PSDesiredStateConfiguration | Partially | Built into PowerShell 7 | +| PSDiagnostics | Natively Compatible | Built into PowerShell 7 | +| PSScheduledJob | Not Supported by Compatibility Layer | Built into PowerShell 5.1 | +| PSWorkflow | Untested with Compatibility Layer | | +| PSWorkflowUtility | Untested with Compatibility Layer | | +| RemoteAccess | Untested with Compatibility Layer | | +| RemoteDesktop | Untested with Compatibility Layer | | +| ScheduledTasks | Natively Compatible | Windows Server 1809+
Windows 10 1809+ | +| SecureBoot | Natively Compatible | Windows Server 1809+
Windows 10 1809+ | +| ServerCore | Untested with Compatibility Layer | | +| ServerManager | Natively Compatible | Windows Server 1809+
Windows 10 1809+ with Rsat.ServerManager.Tools
_See notes below_ | +| ServerManagerTasks | Untested with Compatibility Layer | | +| ShieldedVMDataFile | Natively Compatible | Windows Server 1903+ with RSAT-Shielded-VM-Tools
Windows 10 1903+ with Rsat.Shielded.VM.Tools | +| ShieldedVMProvisioning | Natively Compatible | Windows Server 1809+ with HostGuardian
Windows 10 1809+ with HostGuardian | +| ShieldedVMTemplate | Natively Compatible | Windows Server 1809+ with RSAT-Shielded-VM-Tools
Windows 10 1809+ with Rsat.Shielded.VM.Tools | +| SmbShare | Natively Compatible | Windows Server 1809+
Windows 10 1809+ | +| SmbWitness | Natively Compatible | Windows Server 1809+
Windows 10 1809+ | +| SMISConfig | Natively Compatible | Windows Server 1903+ with WindowsStorageManagementService | +| SMS | Untested with Compatibility Layer | | +| SoftwareInventoryLogging | Natively Compatible | Windows Server 1809+ | +| StartLayout | Natively Compatible | Windows Server 1809+ with Desktop Experience
Windows 10 1809+ | +| Storage | Natively Compatible | Windows Server 1809+
Windows 10 1809+ | +| StorageBusCache | Untested with Compatibility Layer | | +| StorageMigrationService | Untested with Compatibility Layer | | | StorageQOS | Natively Compatible | Windows Server 1809+ with RSAT-Clustering-PowerShell
Windows 10 1809+ with Rsat.FailoverCluster.Management.Tools | -| StorageReplica | Untested with Compatibility Layer | | -| SyncShare | Natively Compatible | Windows Server 1809+ with FS-SyncShareService | -| SystemInsights | Untested with Compatibility Layer | | -| TLS | Untested with Compatibility Layer | | -| TroubleshootingPack | Natively Compatible | Windows 10 1903+ | -| TrustedPlatformModule | Natively Compatible | Windows Server 1809+
Windows 10 1809+ | -| UEV | Natively Compatible | Windows Server ??Future version of Server with Desktop Experience??
Windows 10 1903+ | -| UpdateServices | Not Supported by Compatibility Layer | | -| VpnClient | Natively Compatible | Windows Server 1809+
Windows 10 1809+ | -| Wdac | Natively Compatible | Windows Server 1809+
Windows 10 1809+ | -| WebAdministration | Untested with Compatibility Layer | | -| WHEA | Natively Compatible | Windows Server 1903+
Windows 10 1903+ | -| WindowsDeveloperLicense | Natively Compatible | Windows Server 1809+ with Desktop Experience
Windows 10 1809+ | -| WindowsErrorReporting | Natively Compatible | Windows Server 1809+
Windows 10 1809+ | -| WindowsSearch | Natively Compatible | Windows 10 1903+ | -| WindowsServerBackup | Natively Compatible | Windows Server 19H2 with Windows-Server-Backup | -| WindowsUpdate | Natively Compatible | Windows Server 1809+
Windows 10 1809+ | -| WindowsUpdateProvider | Natively Compatible | Windows Server 1809+
Windows 10 1809+ | +| StorageReplica | Untested with Compatibility Layer | | +| SyncShare | Natively Compatible | Windows Server 1809+ with FS-SyncShareService | +| SystemInsights | Untested with Compatibility Layer | | +| TLS | Untested with Compatibility Layer | | +| TroubleshootingPack | Natively Compatible | Windows 10 1903+ | +| TrustedPlatformModule | Natively Compatible | Windows Server 1809+
Windows 10 1809+ | +| UEV | Natively Compatible | Windows Server ??Future version of Server with Desktop Experience??
Windows 10 1903+ | +| UpdateServices | Not Supported by Compatibility Layer | | +| VpnClient | Natively Compatible | Windows Server 1809+
Windows 10 1809+ | +| Wdac | Natively Compatible | Windows Server 1809+
Windows 10 1809+ | +| WebAdministration | Untested with Compatibility Layer | | +| WHEA | Natively Compatible | Windows Server 1903+
Windows 10 1903+ | +| WindowsDeveloperLicense | Natively Compatible | Windows Server 1809+ with Desktop Experience
Windows 10 1809+ | +| WindowsErrorReporting | Natively Compatible | Windows Server 1809+
Windows 10 1809+ | +| WindowsSearch | Natively Compatible | Windows 10 1903+ | +| WindowsServerBackup | Natively Compatible | Windows Server 19H2 with Windows-Server-Backup | +| WindowsUpdate | Natively Compatible | Windows Server 1809+
Windows 10 1809+ | +| WindowsUpdateProvider | Natively Compatible | Windows Server 1809+
Windows 10 1809+ | ## Notes @@ -204,3 +204,11 @@ This module has some minor compatibility issues with formatted output in PowerSh the `Get-WindowsFeature` cmdlet returns the proper object with all properties, but the default display formatting makes some properties appear to be empty. The actual values are available in the object properties using `Select-Object` or by direct member access. + + +[01]: /powershell/module/dism/add-windowscapability +[02]: /powershell/module/dism/enable-windowsoptionalfeature +[03]: /powershell/module/dism/get-windowscapability +[04]: /powershell/module/dism/get-windowsoptionalfeature +[05]: /powershell/module/servermanager/install-windowsfeature +[06]: https://support.microsoft.com/windows/send-feedback-to-microsoft-with-the-feedback-hub-app-f59187f8-8739-22d6-ba93-f66612949332 From a9a55b71aeee4d3d7575ccf0bdc93628aaeaa240 Mon Sep 17 00:00:00 2001 From: Rob Derickson Date: Tue, 6 Jun 2023 07:51:14 -0400 Subject: [PATCH 505/650] Remove colon following Note callout. --- .../activedirectory/Get-ADAccountAuthorizationGroup.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/activedirectory/Get-ADAccountAuthorizationGroup.md b/docset/winserver2022-ps/activedirectory/Get-ADAccountAuthorizationGroup.md index f149e225a3..82cf72ce62 100644 --- a/docset/winserver2022-ps/activedirectory/Get-ADAccountAuthorizationGroup.md +++ b/docset/winserver2022-ps/activedirectory/Get-ADAccountAuthorizationGroup.md @@ -133,7 +133,7 @@ Denied RODC Password Replication Group group This command returns a filtered list of built-in security groups that do not have an empty or null setting for **objectClass**, such as **Everyone** or **Authenticated Users**. -> [!NOTE]: +> [!NOTE] > This type of filtering of groups in output can be useful when piping the output of this > cmdlet to be used as input to other Active Directory cmdlets. From 7a768329e2ad82328dd4699b3dbaa47dce504865 Mon Sep 17 00:00:00 2001 From: Drew McClellan Date: Tue, 13 Jun 2023 16:28:38 -0400 Subject: [PATCH 506/650] PS Server 2022 Hyper-V: Remove VM removed PS C:\> from the example 2 &3 so its not in the clipboard when copied. --- docset/winserver2022-ps/hyper-v/Remove-VM.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docset/winserver2022-ps/hyper-v/Remove-VM.md b/docset/winserver2022-ps/hyper-v/Remove-VM.md index faf23cdb2f..935d9958b6 100644 --- a/docset/winserver2022-ps/hyper-v/Remove-VM.md +++ b/docset/winserver2022-ps/hyper-v/Remove-VM.md @@ -44,14 +44,14 @@ Removes virtual machine new 1. ### Example 2 ``` -PS C:\> Remove-VM -Name "new 2" -Force +Remove-VM -Name "new 2" -Force ``` Removes virtual machine new 2, suppressing the confirmation prompt. ### Example 3 ``` -PS C:\> Get-VM -Name New* | Remove-VM -Force +Get-VM -Name New* | Remove-VM -Force ``` Removes with no confirmation prompt all virtual machines having names starting with New. From 1b7789c10fc2f29a265e419f632e4085d2a65d23 Mon Sep 17 00:00:00 2001 From: Drew McClellan Date: Tue, 13 Jun 2023 17:13:49 -0400 Subject: [PATCH 507/650] Update Add-VMDvdDrive.md removed PS C:> from examples 1-3 so it's not in the clipboard when copied. --- docset/winserver2022-ps/hyper-v/Add-VMDvdDrive.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docset/winserver2022-ps/hyper-v/Add-VMDvdDrive.md b/docset/winserver2022-ps/hyper-v/Add-VMDvdDrive.md index 04764bf137..045e8bda54 100644 --- a/docset/winserver2022-ps/hyper-v/Add-VMDvdDrive.md +++ b/docset/winserver2022-ps/hyper-v/Add-VMDvdDrive.md @@ -42,21 +42,21 @@ The **Add-VMDvdDrive** cmdlet adds a DVD drive to a virtual machine. ### Example 1 ``` -PS C:\> Add-VMDvdDrive -VMName Test -Path D:\ISOs\disc1.iso +Add-VMDvdDrive -VMName Test -Path D:\ISOs\disc1.iso ``` This example adds a virtual DVD drive using file D:\ISOs\disc1.iso to virtual machine Test. ### Example 2 ``` -PS C:\> Get-VM Test | Add-VMDvdDrive -ControllerNumber 1 +Get-VM Test | Add-VMDvdDrive -ControllerNumber 1 ``` This example adds a virtual DVD drive using controller number 1 to virtual machine Test. ### Example 3 ``` -PS C:\> Get-VMIdeController -VMName Test | Add-VMDvdDrive -Path E:\ +Get-VMIdeController -VMName Test | Add-VMDvdDrive -Path E:\ ``` This example adds virtual DVD drives using the IDE controllers from virtual machine Test. From e98e398cdd1196a2b67523ebabb519bc84d763fa Mon Sep 17 00:00:00 2001 From: Jay Simmons Date: Wed, 31 May 2023 09:38:56 -0700 Subject: [PATCH 508/650] Clarify that DN syntax can be used to set permissions on AD domain root --- docset/winserver2019-ps/laps/Find-LapsADExtendedRights.md | 2 ++ .../winserver2019-ps/laps/Set-LapsADComputerSelfPermission.md | 2 ++ .../winserver2019-ps/laps/Set-LapsADReadPasswordPermission.md | 2 ++ .../winserver2019-ps/laps/Set-LapsADResetPasswordPermission.md | 2 ++ docset/winserver2022-ps/laps/Find-LapsADExtendedRights.md | 2 ++ .../winserver2022-ps/laps/Set-LapsADComputerSelfPermission.md | 2 ++ .../winserver2022-ps/laps/Set-LapsADReadPasswordPermission.md | 2 ++ .../winserver2022-ps/laps/Set-LapsADResetPasswordPermission.md | 2 ++ 8 files changed, 16 insertions(+) diff --git a/docset/winserver2019-ps/laps/Find-LapsADExtendedRights.md b/docset/winserver2019-ps/laps/Find-LapsADExtendedRights.md index b18a92a38f..29c3fbe7d1 100644 --- a/docset/winserver2019-ps/laps/Find-LapsADExtendedRights.md +++ b/docset/winserver2019-ps/laps/Find-LapsADExtendedRights.md @@ -104,6 +104,8 @@ resultant AD search. The supported name formats are as follows: - distinguishedName (begins with a `CN=`) - name (for all other inputs) +Querying permissions on the domain root is only supported using the distinguishedName input format, for example 'DC=laps,DC=com'. + ```yaml Type: System.String[] Parameter Sets: (All) diff --git a/docset/winserver2019-ps/laps/Set-LapsADComputerSelfPermission.md b/docset/winserver2019-ps/laps/Set-LapsADComputerSelfPermission.md index 33aca11f0e..380d26acf6 100644 --- a/docset/winserver2019-ps/laps/Set-LapsADComputerSelfPermission.md +++ b/docset/winserver2019-ps/laps/Set-LapsADComputerSelfPermission.md @@ -105,6 +105,8 @@ resultant AD search. The supported name formats are as follows: - distinguishedName (begins with a `CN=`) - name (for all other inputs) +Setting permissions on the domain root is only supported using the distinguishedName input format, for example 'DC=laps,DC=com'. + ```yaml Type: System.String[] Parameter Sets: (All) diff --git a/docset/winserver2019-ps/laps/Set-LapsADReadPasswordPermission.md b/docset/winserver2019-ps/laps/Set-LapsADReadPasswordPermission.md index 47c3f012a7..21d0723273 100644 --- a/docset/winserver2019-ps/laps/Set-LapsADReadPasswordPermission.md +++ b/docset/winserver2019-ps/laps/Set-LapsADReadPasswordPermission.md @@ -177,6 +177,8 @@ resultant AD search. The supported name formats are as follows: - distinguishedName (begins with a `CN=`) - name (for all other inputs) +Setting permissions on the domain root is only supported using the distinguishedName input format, for example 'DC=laps,DC=com'. + ```yaml Type: System.String[] Parameter Sets: (All) diff --git a/docset/winserver2019-ps/laps/Set-LapsADResetPasswordPermission.md b/docset/winserver2019-ps/laps/Set-LapsADResetPasswordPermission.md index 675eae07c5..9a045d51ee 100644 --- a/docset/winserver2019-ps/laps/Set-LapsADResetPasswordPermission.md +++ b/docset/winserver2019-ps/laps/Set-LapsADResetPasswordPermission.md @@ -178,6 +178,8 @@ resultant AD search. The supported name formats are as follows: - distinguishedName (begins with a `CN=`) - name (for all other inputs) +Setting permissions on the domain root is only supported using the distinguishedName input format, for example 'DC=laps,DC=com'. + ```yaml Type: System.String[] Parameter Sets: (All) diff --git a/docset/winserver2022-ps/laps/Find-LapsADExtendedRights.md b/docset/winserver2022-ps/laps/Find-LapsADExtendedRights.md index 0df4fb363d..a3a28884b7 100644 --- a/docset/winserver2022-ps/laps/Find-LapsADExtendedRights.md +++ b/docset/winserver2022-ps/laps/Find-LapsADExtendedRights.md @@ -104,6 +104,8 @@ resultant AD search. The supported name formats are as follows: - distinguishedName (begins with a `CN=`) - name (for all other inputs) +Querying permissions on the domain root is only supported using the distinguishedName input format, for example 'DC=laps,DC=com'. + ```yaml Type: System.String[] Parameter Sets: (All) diff --git a/docset/winserver2022-ps/laps/Set-LapsADComputerSelfPermission.md b/docset/winserver2022-ps/laps/Set-LapsADComputerSelfPermission.md index 4539be98c8..7aac01e939 100644 --- a/docset/winserver2022-ps/laps/Set-LapsADComputerSelfPermission.md +++ b/docset/winserver2022-ps/laps/Set-LapsADComputerSelfPermission.md @@ -105,6 +105,8 @@ resultant AD search. The supported name formats are as follows: - distinguishedName (begins with a `CN=`) - name (for all other inputs) +Setting permissions on the domain root is only supported using the distinguishedName input format, for example 'DC=laps,DC=com'. + ```yaml Type: System.String[] Parameter Sets: (All) diff --git a/docset/winserver2022-ps/laps/Set-LapsADReadPasswordPermission.md b/docset/winserver2022-ps/laps/Set-LapsADReadPasswordPermission.md index 50971ab84e..17ab097e8d 100644 --- a/docset/winserver2022-ps/laps/Set-LapsADReadPasswordPermission.md +++ b/docset/winserver2022-ps/laps/Set-LapsADReadPasswordPermission.md @@ -177,6 +177,8 @@ resultant AD search. The supported name formats are as follows: - distinguishedName (begins with a `CN=`) - name (for all other inputs) +Setting permissions on the domain root is only supported using the distinguishedName input format, for example 'DC=laps,DC=com'. + ```yaml Type: System.String[] Parameter Sets: (All) diff --git a/docset/winserver2022-ps/laps/Set-LapsADResetPasswordPermission.md b/docset/winserver2022-ps/laps/Set-LapsADResetPasswordPermission.md index eae1ea4a3a..9fc3444604 100644 --- a/docset/winserver2022-ps/laps/Set-LapsADResetPasswordPermission.md +++ b/docset/winserver2022-ps/laps/Set-LapsADResetPasswordPermission.md @@ -178,6 +178,8 @@ resultant AD search. The supported name formats are as follows: - distinguishedName (begins with a `CN=`) - name (for all other inputs) +Setting permissions on the domain root is only supported using the distinguishedName input format, for example 'DC=laps,DC=com'. + ```yaml Type: System.String[] Parameter Sets: (All) From 6d8f31528c3cd05ca3c2c94cb7ce01130e9d032f Mon Sep 17 00:00:00 2001 From: Drew McClellan Date: Wed, 14 Jun 2023 12:04:07 -0400 Subject: [PATCH 509/650] Update Set-VMDvdDrive.md I removed PS C:\ from the examples so they are not copied to the clipboard. --- docset/winserver2022-ps/hyper-v/Set-VMDvdDrive.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docset/winserver2022-ps/hyper-v/Set-VMDvdDrive.md b/docset/winserver2022-ps/hyper-v/Set-VMDvdDrive.md index c340f55be1..eb014147d9 100644 --- a/docset/winserver2022-ps/hyper-v/Set-VMDvdDrive.md +++ b/docset/winserver2022-ps/hyper-v/Set-VMDvdDrive.md @@ -37,14 +37,14 @@ The **Set-VMDvdDrive** cmdlet configures the controller and location of a virtua ### Example 1 ``` -PS C:\> Set-VMDvdDrive -VMName TestVM -Path .\WinBuild.iso +Set-VMDvdDrive -VMName TestVM -Path .\WinBuild.iso ``` Configures the virtual DVD drive of virtual machine TestVM to use WinBuild.iso as its media. ### Example 2 ``` -PS C:\> Set-VMDvdDrive -VMName TestVM -ControllerNumber 1 -ControllerLocation 0 -Path $null +Set-VMDvdDrive -VMName TestVM -ControllerNumber 1 -ControllerLocation 0 -Path $null ``` Configures the virtual DVD drive at IDE 1,0 of virtual machine TestVM to use no media. @@ -52,7 +52,7 @@ Configures the virtual DVD drive at IDE 1,0 of virtual machine TestVM to use no ### Example 3 ``` -PS C:\> Get-VMDvdDrive -VMName TestVM -ControllerNumber 1 -ControllerLocation 0 | Set-VMDvdDrive -ToControllerLocation 1 +Get-VMDvdDrive -VMName TestVM -ControllerNumber 1 -ControllerLocation 0 | Set-VMDvdDrive -ToControllerLocation 1 ``` Moves virtual DVD drive from IDE 1,0 to IDE 1,1 on virtual machine TestVM. From 56397efa12b914b53a7ade88bb0d7eaa80bb4fc7 Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Mon, 19 Jun 2023 13:18:10 +0530 Subject: [PATCH 510/650] Update Export-VM.md Made changes to the description to avoid ambiguity Fixes https://github.com/MicrosoftDocs/windows-powershell-docs/issues/3039 --- docset/winserver2022-ps/hyper-v/Export-VM.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/hyper-v/Export-VM.md b/docset/winserver2022-ps/hyper-v/Export-VM.md index 846d5764a2..cb0ced7c36 100644 --- a/docset/winserver2022-ps/hyper-v/Export-VM.md +++ b/docset/winserver2022-ps/hyper-v/Export-VM.md @@ -31,7 +31,7 @@ Export-VM [-VM] [-Path] [-AsJob] [-Passthru] [-Captu ## DESCRIPTION The **Export-VM** cmdlet exports a virtual machine to disk. This cmdlet creates a folder at a specified location having three subfolders: Snapshots, Virtual Hard Disks, and Virtual Machines. -The Snapshots and Virtual Hard Disks folders contain the snapshots of and virtual hard disks of the specified virtual machine respectively. +Each of these folders contains the associated files. The Snapshots folder contains the associated Snapshots, and the Virtual Hard Disk folder contains the specified virtual machine's virtual disks. The Virtual Machines folder contains the configuration XML of the specified virtual machine. ## EXAMPLES From 7c8cc520e22b7a1491174418207238bc9f28acc7 Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Mon, 19 Jun 2023 13:19:24 +0530 Subject: [PATCH 511/650] Update Export-VM.md updated 2012 version of the doc --- docset/winserver2012-ps/hyper-v/Export-VM.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2012-ps/hyper-v/Export-VM.md b/docset/winserver2012-ps/hyper-v/Export-VM.md index 10f9d2c703..3954f6bf71 100644 --- a/docset/winserver2012-ps/hyper-v/Export-VM.md +++ b/docset/winserver2012-ps/hyper-v/Export-VM.md @@ -25,7 +25,7 @@ Export-VM [-VM] [-Path] [-AsJob] [-Passthru] ## DESCRIPTION The **Export-VM** cmdlet exports a virtual machine to disk. This cmdlet creates a folder at a specified location having three subfolders: Snapshots, Virtual Hard Disks, and Virtual Machines. -The Snapshots and Virtual Hard Disks folders contain the snapshots of and virtual hard disks of the specified virtual machine respectively. +Each of these folders contains the associated files. The Snapshots folder contains the associated Snapshots, and the Virtual Hard Disk folder contains the specified virtual machine's virtual disks. The Virtual Machines folder contains the configuration XML of the specified virtual machine. ## EXAMPLES From 94fc9988cfa321e4012d1758aa1b27f3b7d10bd5 Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Mon, 19 Jun 2023 13:19:44 +0530 Subject: [PATCH 512/650] Update Export-VM.md updated 2016 version --- docset/winserver2016-ps/hyper-v/Export-VM.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2016-ps/hyper-v/Export-VM.md b/docset/winserver2016-ps/hyper-v/Export-VM.md index bf77cbfbd0..e040b291bc 100644 --- a/docset/winserver2016-ps/hyper-v/Export-VM.md +++ b/docset/winserver2016-ps/hyper-v/Export-VM.md @@ -31,7 +31,7 @@ Export-VM [-VM] [-Path] [-AsJob] [-Passthru] [-Captu ## DESCRIPTION The **Export-VM** cmdlet exports a virtual machine to disk. This cmdlet creates a folder at a specified location having three subfolders: Snapshots, Virtual Hard Disks, and Virtual Machines. -The Snapshots and Virtual Hard Disks folders contain the snapshots of and virtual hard disks of the specified virtual machine respectively. +Each of these folders contains the associated files. The Snapshots folder contains the associated Snapshots, and the Virtual Hard Disk folder contains the specified virtual machine's virtual disks. The Virtual Machines folder contains the configuration XML of the specified virtual machine. ## EXAMPLES From e1bb210d6b3bdfa625080b356ccd69f01406e240 Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Mon, 19 Jun 2023 13:20:05 +0530 Subject: [PATCH 513/650] Update Export-VM.md updated 2019 version --- docset/winserver2019-ps/hyper-v/Export-VM.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2019-ps/hyper-v/Export-VM.md b/docset/winserver2019-ps/hyper-v/Export-VM.md index aa7fadcbf9..5105fea01c 100644 --- a/docset/winserver2019-ps/hyper-v/Export-VM.md +++ b/docset/winserver2019-ps/hyper-v/Export-VM.md @@ -31,7 +31,7 @@ Export-VM [-VM] [-Path] [-AsJob] [-Passthru] [-Captu ## DESCRIPTION The **Export-VM** cmdlet exports a virtual machine to disk. This cmdlet creates a folder at a specified location having three subfolders: Snapshots, Virtual Hard Disks, and Virtual Machines. -The Snapshots and Virtual Hard Disks folders contain the snapshots of and virtual hard disks of the specified virtual machine respectively. +Each of these folders contains the associated files. The Snapshots folder contains the associated Snapshots, and the Virtual Hard Disk folder contains the specified virtual machine's virtual disks. The Virtual Machines folder contains the configuration XML of the specified virtual machine. ## EXAMPLES From 9579685ecc679d6ccefe414614b98c760826185a Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Mon, 19 Jun 2023 13:20:18 +0530 Subject: [PATCH 514/650] Update Export-VM.md --- docset/winserver2012r2-ps/hyper-v/Export-VM.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2012r2-ps/hyper-v/Export-VM.md b/docset/winserver2012r2-ps/hyper-v/Export-VM.md index 5dc7bfa1d0..c80ad414d0 100644 --- a/docset/winserver2012r2-ps/hyper-v/Export-VM.md +++ b/docset/winserver2012r2-ps/hyper-v/Export-VM.md @@ -29,7 +29,7 @@ Export-VM [-Path] [-AsJob] [-Passthru] [-VM] [-WhatI ## DESCRIPTION The **Export-VM** cmdlet exports a virtual machine to disk. This cmdlet creates a folder at a specified location having three subfolders: Snapshots, Virtual Hard Disks, and Virtual Machines. -The Snapshots and Virtual Hard Disks folders contain the snapshots of and virtual hard disks of the specified virtual machine respectively. +Each of these folders contains the associated files. The Snapshots folder contains the associated Snapshots, and the Virtual Hard Disk folder contains the specified virtual machine's virtual disks. The Virtual Machines folder contains the configuration XML of the specified virtual machine. ## EXAMPLES From 1eb939757387d82925aee5cae3e74d63e6350f28 Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Mon, 19 Jun 2023 13:35:59 +0530 Subject: [PATCH 515/650] Update Reset-AppxPackage.md Made changes to the syntax formatting Fixes https://github.com/MicrosoftDocs/windows-powershell-docs/issues/3071 --- docset/winserver2022-ps/appx/Reset-AppxPackage.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/docset/winserver2022-ps/appx/Reset-AppxPackage.md b/docset/winserver2022-ps/appx/Reset-AppxPackage.md index 66d1b655e2..94157d051f 100644 --- a/docset/winserver2022-ps/appx/Reset-AppxPackage.md +++ b/docset/winserver2022-ps/appx/Reset-AppxPackage.md @@ -17,10 +17,11 @@ Restores the Windows app to its initial configuration. ## SYNTAX ``` -Reset-AppxPackage [-Package] - [-WhatIf] - [-Confirm] - [] +Reset-AppxPackage + [-Package] + [-WhatIf] + [-Confirm] + [] ``` ## DESCRIPTION From d4c6633b9635b7bd98d692fc9bbb2cb45b5e21f3 Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Mon, 19 Jun 2023 13:37:27 +0530 Subject: [PATCH 516/650] Update Reset-AppxPackage.md Fixes 2016 version of the document --- docset/winserver2016-ps/appx/Reset-AppxPackage.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/docset/winserver2016-ps/appx/Reset-AppxPackage.md b/docset/winserver2016-ps/appx/Reset-AppxPackage.md index 5a332aea5d..886a2a1111 100644 --- a/docset/winserver2016-ps/appx/Reset-AppxPackage.md +++ b/docset/winserver2016-ps/appx/Reset-AppxPackage.md @@ -19,10 +19,11 @@ Restores the Windows app to its initial configuration. ## SYNTAX ```PowerShell -Reset-AppxPackage [-Package] - [-WhatIf] - [-Confirm] - [] +Reset-AppxPackage +[-Package] +[-WhatIf] +[-Confirm] +[] ``` ## DESCRIPTION From 5bbfcb5ef2dfec172a119789971fc0c4bb6fcb0c Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Mon, 19 Jun 2023 13:37:57 +0530 Subject: [PATCH 517/650] Update Reset-AppxPackage.md Fixes 2019 Version of the document --- docset/winserver2019-ps/appx/Reset-AppxPackage.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/docset/winserver2019-ps/appx/Reset-AppxPackage.md b/docset/winserver2019-ps/appx/Reset-AppxPackage.md index a8bc5ae82e..a6bd004df9 100644 --- a/docset/winserver2019-ps/appx/Reset-AppxPackage.md +++ b/docset/winserver2019-ps/appx/Reset-AppxPackage.md @@ -19,10 +19,11 @@ Restores the Windows app to its initial configuration. ## SYNTAX ```PowerShell -Reset-AppxPackage [-Package] - [-WhatIf] - [-Confirm] - [] +Reset-AppxPackage +[-Package] +[-WhatIf] +[-Confirm] +[] ``` ## DESCRIPTION From d4da29f0e20f4563eee5906d37250873a855fb0e Mon Sep 17 00:00:00 2001 From: "Mikey Lombardi (He/Him)" Date: Wed, 21 Jun 2023 10:57:10 -0500 Subject: [PATCH 518/650] Apply suggestions from review --- docset/winserver2022-ps/smbshare/Remove-SmbShare.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/docset/winserver2022-ps/smbshare/Remove-SmbShare.md b/docset/winserver2022-ps/smbshare/Remove-SmbShare.md index 9e27520442..f60237a742 100644 --- a/docset/winserver2022-ps/smbshare/Remove-SmbShare.md +++ b/docset/winserver2022-ps/smbshare/Remove-SmbShare.md @@ -51,11 +51,12 @@ Performing operation 'Remove-Share' on Target 'Contoso-FS,Data'. This command deletes the SMB share named Data. ### Example 2: Delete a Windows Server failover cluster file server resource SMB share without confirmation -``` -PS C:\>Remove-SmbShare -Name "VMFiles" -ScopeName "Contoso-SO" -Force + +```powershell +Remove-SmbShare -Name "VMFiles" -ScopeName "Contoso-SO" -Force ``` -This command deletes the SMB share named VMFiles on the Contoso-SO file server resource without user confirmation. +This command deletes the SMB share named VMFiles on the `Contoso-SO` file server resource without user confirmation. ## PARAMETERS @@ -153,6 +154,7 @@ Accept wildcard characters: False ``` ### -ScopeName + Specifies an array of the scopes of the SMB share to delete. For use with Windows Server failover cluster file server resources. ```yaml From 07a9beae11db65fd5eacafc03cecbc91f8d8d49d Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Fri, 23 Jun 2023 14:03:52 +0530 Subject: [PATCH 519/650] Update Remove-AppxPackageAutoUpdateSettings.md Added Information for Synopsis, Description and example Fixes https://github.com/MicrosoftDocs/windows-powershell-docs/issues/3073 --- .../appx/Remove-AppxPackageAutoUpdateSettings.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docset/winserver2022-ps/appx/Remove-AppxPackageAutoUpdateSettings.md b/docset/winserver2022-ps/appx/Remove-AppxPackageAutoUpdateSettings.md index 5382d8a50e..0f8f8ab40c 100644 --- a/docset/winserver2022-ps/appx/Remove-AppxPackageAutoUpdateSettings.md +++ b/docset/winserver2022-ps/appx/Remove-AppxPackageAutoUpdateSettings.md @@ -9,7 +9,7 @@ title: Remove-AppxPackageAutoUpdateSettings # Remove-AppxPackageAutoUpdateSettings ## SYNOPSIS -{{ Fill in the Synopsis }} +Removes settings configured for a particular Windows App. ## SYNTAX @@ -19,16 +19,16 @@ Remove-AppxPackageAutoUpdateSettings [-PackageFamilyName] [-UseSystemPo ``` ## DESCRIPTION -{{ Fill in the Description }} +The 'Remove-AppxPackageAutoUpdateSettings' PowerShell cmdlet removes the settings configured for a specific or all installed Windows Apps in relation to Auto Update and Repair. ## EXAMPLES ### Example 1 ```powershell -PS C:\> {{ Add example code here }} +PS C:\> Remove-AppxPackageAutoUpdateSettings -PackageFullName publisher.package1_1.0.0.0_neutral__8wekyb3d8bbwe ``` -{{ Add example description here }} +This will remove the Auto Update and Repair settings for a specific Windows App that has been installed and registered to the signed-in user. ## PARAMETERS From 1941c7857cb94871e20715df3fa17f50424d3f85 Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Fri, 23 Jun 2023 14:07:55 +0530 Subject: [PATCH 520/650] Update Add-VpnConnection.md removed [XML] from example 5 for the cmdlet to work Fixes https://github.com/MicrosoftDocs/windows-powershell-docs/issues/3042 --- docset/winserver2022-ps/vpnclient/Add-VpnConnection.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/vpnclient/Add-VpnConnection.md b/docset/winserver2022-ps/vpnclient/Add-VpnConnection.md index 11b4853490..f94b420cce 100644 --- a/docset/winserver2022-ps/vpnclient/Add-VpnConnection.md +++ b/docset/winserver2022-ps/vpnclient/Add-VpnConnection.md @@ -153,7 +153,7 @@ For more information about custom EAP authentication methods, see the **New-EapC ### Example 5: Add a VPN connection that uses already generated EAP XML configuration ```powershell -PS C:\> $EAPXml = [xml]Get-Content -Path C:\eap-config.xml +PS C:\> $EAPXml = Get-Content -Path C:\eap-config.xml PS C:\> Add-VpnConnection -Name "Test6" -ServerAddress "10.1.1.1" -TunnelType "L2tp" -EncryptionLevel "Required" -AuthenticationMethod Eap -SplitTunneling -AllUserConnection -RememberCredential -EapConfigXmlStream $EAPXml ``` From 51fc09f3cc3ce40bb9489e7397f4f705798dbb3e Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Fri, 23 Jun 2023 14:09:12 +0530 Subject: [PATCH 521/650] Update Add-VpnConnection.md --- docset/winserver2012-ps/vpnclient/Add-VpnConnection.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2012-ps/vpnclient/Add-VpnConnection.md b/docset/winserver2012-ps/vpnclient/Add-VpnConnection.md index 2bc3606f39..bbbee7fd18 100644 --- a/docset/winserver2012-ps/vpnclient/Add-VpnConnection.md +++ b/docset/winserver2012-ps/vpnclient/Add-VpnConnection.md @@ -139,7 +139,7 @@ For more information about custom EAP authentication methods, see the **New-EapC ### Example 5: Add a VPN connection that uses already generated EAP XML configuration ```powershell -PS C:\> $EAPXml = [xml]Get-Content -Path C:\eap-config.xml +PS C:\> $EAPXml = Get-Content -Path C:\eap-config.xml PS C:\> Add-VpnConnection -Name "Test6" -ServerAddress "10.1.1.1" -TunnelType "L2tp" -EncryptionLevel "Required" -AuthenticationMethod Eap -SplitTunneling -AllUserConnection -RememberCredential -EapConfigXmlStream $EAPXml ``` From 64a4a5f01d3a0dcf5df32a04460871711fa42efe Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Fri, 23 Jun 2023 14:09:24 +0530 Subject: [PATCH 522/650] Update Add-VpnConnection.md --- docset/winserver2016-ps/vpnclient/Add-VpnConnection.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2016-ps/vpnclient/Add-VpnConnection.md b/docset/winserver2016-ps/vpnclient/Add-VpnConnection.md index 53d7f76d5e..0e8ad6f602 100644 --- a/docset/winserver2016-ps/vpnclient/Add-VpnConnection.md +++ b/docset/winserver2016-ps/vpnclient/Add-VpnConnection.md @@ -153,7 +153,7 @@ For more information about custom EAP authentication methods, see the **New-EapC ### Example 5: Add a VPN connection that uses already generated EAP XML configuration ```powershell -PS C:\> $EAPXml = [xml]Get-Content -Path C:\eap-config.xml +PS C:\> $EAPXml = Get-Content -Path C:\eap-config.xml PS C:\> Add-VpnConnection -Name "Test6" -ServerAddress "10.1.1.1" -TunnelType "L2tp" -EncryptionLevel "Required" -AuthenticationMethod Eap -SplitTunneling -AllUserConnection -RememberCredential -EapConfigXmlStream $EAPXml ``` From 4312736254cb2531570293489a658bf653dfa039 Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Fri, 23 Jun 2023 14:09:38 +0530 Subject: [PATCH 523/650] Update Add-VpnConnection.md --- docset/winserver2019-ps/vpnclient/Add-VpnConnection.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2019-ps/vpnclient/Add-VpnConnection.md b/docset/winserver2019-ps/vpnclient/Add-VpnConnection.md index 26b8c7611f..d6813a2154 100644 --- a/docset/winserver2019-ps/vpnclient/Add-VpnConnection.md +++ b/docset/winserver2019-ps/vpnclient/Add-VpnConnection.md @@ -153,7 +153,7 @@ For more information about custom EAP authentication methods, see the **New-EapC ### Example 5: Add a VPN connection that uses already generated EAP XML configuration ```powershell -PS C:\> $EAPXml = [xml]Get-Content -Path C:\eap-config.xml +PS C:\> $EAPXml = Get-Content -Path C:\eap-config.xml PS C:\> Add-VpnConnection -Name "Test6" -ServerAddress "10.1.1.1" -TunnelType "L2tp" -EncryptionLevel "Required" -AuthenticationMethod Eap -SplitTunneling -AllUserConnection -RememberCredential -EapConfigXmlStream $EAPXml ``` From 8f4065c21f516a903a451dfdfa60f58eeb179398 Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Fri, 23 Jun 2023 14:09:56 +0530 Subject: [PATCH 524/650] Update Add-VpnConnection.md --- docset/winserver2012r2-ps/vpnclient/Add-VpnConnection.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2012r2-ps/vpnclient/Add-VpnConnection.md b/docset/winserver2012r2-ps/vpnclient/Add-VpnConnection.md index 7783147379..0699f0f1ef 100644 --- a/docset/winserver2012r2-ps/vpnclient/Add-VpnConnection.md +++ b/docset/winserver2012r2-ps/vpnclient/Add-VpnConnection.md @@ -152,7 +152,7 @@ For more information about custom EAP authentication methods, see the **New-EapC ### Example 5: Add a VPN connection that uses already generated EAP XML configuration ```powershell -PS C:\> $EAPXml = [xml]Get-Content -Path C:\eap-config.xml +PS C:\> $EAPXml = Get-Content -Path C:\eap-config.xml PS C:\> Add-VpnConnection -Name "Test6" -ServerAddress "10.1.1.1" -TunnelType "L2tp" -EncryptionLevel "Required" -AuthenticationMethod Eap -SplitTunneling -AllUserConnection -RememberCredential -EapConfigXmlStream $EAPXml ``` From e6c67d6c5048f1c921b3ea2a5561d31cadce0cce Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Fri, 23 Jun 2023 14:18:42 +0530 Subject: [PATCH 525/650] Update Set-DnsServerRecursion.md Changed the default value to 8 seconds --- docset/winserver2022-ps/dnsserver/Set-DnsServerRecursion.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/dnsserver/Set-DnsServerRecursion.md b/docset/winserver2022-ps/dnsserver/Set-DnsServerRecursion.md index a37b5b25b4..2a554af411 100644 --- a/docset/winserver2022-ps/dnsserver/Set-DnsServerRecursion.md +++ b/docset/winserver2022-ps/dnsserver/Set-DnsServerRecursion.md @@ -219,7 +219,7 @@ Accept wildcard characters: False ### -Timeout Specifies the number of seconds that a DNS server waits before it stops trying to contact a remote server. The valid value is in the range of 0x1 to 0xFFFFFFFF (1 second to 15 seconds). -The default setting is 0xF (15 seconds). +The default setting is 0x8 (8 seconds). We recommend that you increase this value when recursion occurs over a slow link. ```yaml From cd6b2f23e3a11034b4050a33a118b27708ece3ef Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Fri, 23 Jun 2023 14:22:21 +0530 Subject: [PATCH 526/650] Update Set-DnsServerRecursion.md --- docset/winserver2012-ps/dnsserver/Set-DnsServerRecursion.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2012-ps/dnsserver/Set-DnsServerRecursion.md b/docset/winserver2012-ps/dnsserver/Set-DnsServerRecursion.md index 4485602761..2f01260790 100644 --- a/docset/winserver2012-ps/dnsserver/Set-DnsServerRecursion.md +++ b/docset/winserver2012-ps/dnsserver/Set-DnsServerRecursion.md @@ -197,7 +197,7 @@ Accept wildcard characters: False ### -Timeout Determines the number of seconds that a DNS server waits before it stops trying to contact a remote server. The valid value is in the range of 0x1 to 0xFFFFFFFF (1 second to 15 seconds). -The default setting is 0xF (15 seconds). +The default setting is 0x8 (8 seconds). We recommend that you increase this value when recursion occurs over a slow link. ```yaml From daa651103184f8145d59c07704ce12610b73109f Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Fri, 23 Jun 2023 14:22:34 +0530 Subject: [PATCH 527/650] Update Set-DnsServerRecursion.md --- docset/winserver2016-ps/dnsserver/Set-DnsServerRecursion.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2016-ps/dnsserver/Set-DnsServerRecursion.md b/docset/winserver2016-ps/dnsserver/Set-DnsServerRecursion.md index ba4c702dd7..9a001476fa 100644 --- a/docset/winserver2016-ps/dnsserver/Set-DnsServerRecursion.md +++ b/docset/winserver2016-ps/dnsserver/Set-DnsServerRecursion.md @@ -219,7 +219,7 @@ Accept wildcard characters: False ### -Timeout Specifies the number of seconds that a DNS server waits before it stops trying to contact a remote server. The valid value is in the range of 0x1 to 0xFFFFFFFF (1 second to 15 seconds). -The default setting is 0xF (15 seconds). +The default setting is 0x8 (8 seconds). We recommend that you increase this value when recursion occurs over a slow link. ```yaml From 80831a0a5b6ff0b496257c6ae061a2e5c29ebb1d Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Fri, 23 Jun 2023 14:22:51 +0530 Subject: [PATCH 528/650] Update Set-DnsServerRecursion.md --- docset/winserver2019-ps/dnsserver/Set-DnsServerRecursion.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2019-ps/dnsserver/Set-DnsServerRecursion.md b/docset/winserver2019-ps/dnsserver/Set-DnsServerRecursion.md index 52d436d005..c9383c2b05 100644 --- a/docset/winserver2019-ps/dnsserver/Set-DnsServerRecursion.md +++ b/docset/winserver2019-ps/dnsserver/Set-DnsServerRecursion.md @@ -219,7 +219,7 @@ Accept wildcard characters: False ### -Timeout Specifies the number of seconds that a DNS server waits before it stops trying to contact a remote server. The valid value is in the range of 0x1 to 0xFFFFFFFF (1 second to 15 seconds). -The default setting is 0xF (15 seconds). +The default setting is 0x8 (8 seconds). We recommend that you increase this value when recursion occurs over a slow link. ```yaml From 16753c8d22038e6ed35ce3d6f47088efb20345f8 Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Fri, 23 Jun 2023 14:23:12 +0530 Subject: [PATCH 529/650] Update Set-DnsServerRecursion.md --- docset/winserver2012r2-ps/dnsserver/Set-DnsServerRecursion.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2012r2-ps/dnsserver/Set-DnsServerRecursion.md b/docset/winserver2012r2-ps/dnsserver/Set-DnsServerRecursion.md index 8e04904dfb..e9b799a711 100644 --- a/docset/winserver2012r2-ps/dnsserver/Set-DnsServerRecursion.md +++ b/docset/winserver2012r2-ps/dnsserver/Set-DnsServerRecursion.md @@ -214,7 +214,7 @@ Accept wildcard characters: False ### -Timeout Determines the number of seconds that a DNS server waits before it stops trying to contact a remote server. The valid value is in the range of 0x1 to 0xFFFFFFFF (1 second to 15 seconds). -The default setting is 0xF (15 seconds). +The default setting is 0x8 (8 seconds). We recommend that you increase this value when recursion occurs over a slow link. ```yaml From cb75d924f0bc35f331f3ff1cfe13e219b5be109f Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Fri, 23 Jun 2023 17:34:20 +0530 Subject: [PATCH 530/650] Update docset/winserver2022-ps/appx/Remove-AppxPackageAutoUpdateSettings.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- .../appx/Remove-AppxPackageAutoUpdateSettings.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/appx/Remove-AppxPackageAutoUpdateSettings.md b/docset/winserver2022-ps/appx/Remove-AppxPackageAutoUpdateSettings.md index 0f8f8ab40c..de3a3272b6 100644 --- a/docset/winserver2022-ps/appx/Remove-AppxPackageAutoUpdateSettings.md +++ b/docset/winserver2022-ps/appx/Remove-AppxPackageAutoUpdateSettings.md @@ -28,7 +28,7 @@ The 'Remove-AppxPackageAutoUpdateSettings' PowerShell cmdlet removes the setting PS C:\> Remove-AppxPackageAutoUpdateSettings -PackageFullName publisher.package1_1.0.0.0_neutral__8wekyb3d8bbwe ``` -This will remove the Auto Update and Repair settings for a specific Windows App that has been installed and registered to the signed-in user. +This example removes the Auto Update and Repair settings for a specific Windows app that has been installed and registered to the signed-in user. ## PARAMETERS From 1b4c4cc91bc193306628ef100eab794d99348687 Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Fri, 23 Jun 2023 17:34:33 +0530 Subject: [PATCH 531/650] Update docset/winserver2022-ps/appx/Remove-AppxPackageAutoUpdateSettings.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- .../appx/Remove-AppxPackageAutoUpdateSettings.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/appx/Remove-AppxPackageAutoUpdateSettings.md b/docset/winserver2022-ps/appx/Remove-AppxPackageAutoUpdateSettings.md index de3a3272b6..dee84739bf 100644 --- a/docset/winserver2022-ps/appx/Remove-AppxPackageAutoUpdateSettings.md +++ b/docset/winserver2022-ps/appx/Remove-AppxPackageAutoUpdateSettings.md @@ -9,7 +9,7 @@ title: Remove-AppxPackageAutoUpdateSettings # Remove-AppxPackageAutoUpdateSettings ## SYNOPSIS -Removes settings configured for a particular Windows App. +Removes settings configured for a particular Windows app. ## SYNTAX From 2a89dee8b0e8d310d4ee0c3d9b0fb9a7898e6ae8 Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Fri, 23 Jun 2023 17:34:40 +0530 Subject: [PATCH 532/650] Update docset/winserver2022-ps/appx/Remove-AppxPackageAutoUpdateSettings.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- .../appx/Remove-AppxPackageAutoUpdateSettings.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/appx/Remove-AppxPackageAutoUpdateSettings.md b/docset/winserver2022-ps/appx/Remove-AppxPackageAutoUpdateSettings.md index dee84739bf..921490eff0 100644 --- a/docset/winserver2022-ps/appx/Remove-AppxPackageAutoUpdateSettings.md +++ b/docset/winserver2022-ps/appx/Remove-AppxPackageAutoUpdateSettings.md @@ -19,7 +19,7 @@ Remove-AppxPackageAutoUpdateSettings [-PackageFamilyName] [-UseSystemPo ``` ## DESCRIPTION -The 'Remove-AppxPackageAutoUpdateSettings' PowerShell cmdlet removes the settings configured for a specific or all installed Windows Apps in relation to Auto Update and Repair. +The 'Remove-AppxPackageAutoUpdateSettings' PowerShell cmdlet removes the settings configured for a specific or all installed Windows apps in relation to the Auto Update and Repair settings. ## EXAMPLES From fbc2f42be271c6d92f6e13c345df1f93bd9f67ec Mon Sep 17 00:00:00 2001 From: Mohit Patel <103079000+mohitp930@users.noreply.github.com> Date: Wed, 5 Jul 2023 16:51:04 -0400 Subject: [PATCH 533/650] Policheck update - Juy 5 | Bulk Update --- .../activedirectory/New-ADCentralAccessPolicy.md | 2 +- .../winserver2012-ps/activedirectory/Set-ADCentralAccessRule.md | 2 +- .../install-adcsnetworkdeviceenrollmentservice.md | 2 +- .../activedirectory/New-ADCentralAccessPolicy.md | 2 +- .../activedirectory/Set-ADCentralAccessRule.md | 2 +- .../install-adcsnetworkdeviceenrollmentservice.md | 2 +- .../activedirectory/New-ADCentralAccessPolicy.md | 2 +- .../winserver2016-ps/activedirectory/Set-ADCentralAccessRule.md | 2 +- .../Install-AdcsNetworkDeviceEnrollmentService.md | 2 +- .../activedirectory/New-ADCentralAccessPolicy.md | 2 +- .../winserver2019-ps/activedirectory/Set-ADCentralAccessRule.md | 2 +- .../Install-AdcsNetworkDeviceEnrollmentService.md | 2 +- .../activedirectory/New-ADCentralAccessPolicy.md | 2 +- .../winserver2022-ps/activedirectory/Set-ADCentralAccessRule.md | 2 +- .../Install-AdcsNetworkDeviceEnrollmentService.md | 2 +- 15 files changed, 15 insertions(+), 15 deletions(-) diff --git a/docset/winserver2012-ps/activedirectory/New-ADCentralAccessPolicy.md b/docset/winserver2012-ps/activedirectory/New-ADCentralAccessPolicy.md index 4b5a6d4adf..73b06e0b3d 100644 --- a/docset/winserver2012-ps/activedirectory/New-ADCentralAccessPolicy.md +++ b/docset/winserver2012-ps/activedirectory/New-ADCentralAccessPolicy.md @@ -61,7 +61,7 @@ Description Create a new central access rule named "Finance Documents Rule" with a new resource condition and new permissions. The new rule specifies that documents should only be read by members of the Finance department. -Members of the Finance department should only be able to access documents in their own country. +Members of the Finance department should only be able to access documents in their own country/region. Only Finance Administrators should have write access. The rule allows an exception for members of the FinanceException group. This group will have read access. diff --git a/docset/winserver2012-ps/activedirectory/Set-ADCentralAccessRule.md b/docset/winserver2012-ps/activedirectory/Set-ADCentralAccessRule.md index 11de817d6a..595d89790f 100644 --- a/docset/winserver2012-ps/activedirectory/Set-ADCentralAccessRule.md +++ b/docset/winserver2012-ps/activedirectory/Set-ADCentralAccessRule.md @@ -68,7 +68,7 @@ Description Set the central access rule named "Finance Documents Rule" with a new resource condition and new permissions. The new rule specifies that documents should only be read by members of the Finance department. -Members of the Finance department should only be able to access documents in their own country. +Members of the Finance department should only be able to access documents in their own country/region. Only Finance Administrators should have write access. The rule allows an exception for members of the FinanceException group. This group will have read access. diff --git a/docset/winserver2012-ps/adcsdeployment/install-adcsnetworkdeviceenrollmentservice.md b/docset/winserver2012-ps/adcsdeployment/install-adcsnetworkdeviceenrollmentservice.md index a54ffd8c8c..6f7876fafc 100644 --- a/docset/winserver2012-ps/adcsdeployment/install-adcsnetworkdeviceenrollmentservice.md +++ b/docset/winserver2012-ps/adcsdeployment/install-adcsnetworkdeviceenrollmentservice.md @@ -229,7 +229,7 @@ Accept wildcard characters: False ``` ### -RACountry -Specifies the country of the registration authority. +Specifies the country/region of the registration authority. ```yaml Type: String diff --git a/docset/winserver2012r2-ps/activedirectory/New-ADCentralAccessPolicy.md b/docset/winserver2012r2-ps/activedirectory/New-ADCentralAccessPolicy.md index 3f7a81d190..ff294099a9 100644 --- a/docset/winserver2012r2-ps/activedirectory/New-ADCentralAccessPolicy.md +++ b/docset/winserver2012r2-ps/activedirectory/New-ADCentralAccessPolicy.md @@ -52,7 +52,7 @@ PS C:\> Set-ADCentralAccessRule -Identity "Finance Documents Rule" -ResourceCond This command creates a central access rule named Finance Documents Rule with a new resource condition and new permissions. The new rule specifies that documents should only be read by members of the Finance department. -Members of the Finance department should only be able to access documents in their own country. +Members of the Finance department should only be able to access documents in their own country/region. Only Finance Administrators should have write access. The rule allows an exception for members of the FinanceException group. This group will have read access. diff --git a/docset/winserver2012r2-ps/activedirectory/Set-ADCentralAccessRule.md b/docset/winserver2012r2-ps/activedirectory/Set-ADCentralAccessRule.md index 78a9916e6a..085281ab17 100644 --- a/docset/winserver2012r2-ps/activedirectory/Set-ADCentralAccessRule.md +++ b/docset/winserver2012r2-ps/activedirectory/Set-ADCentralAccessRule.md @@ -59,7 +59,7 @@ PS C:\> Set-ADCentralAccessRule -Identity "Finance Documents Rule" -ResourceCond This example sets the central access rule named Finance Documents Rule with a new resource condition and new permissions. The new rule specifies that documents should only be read by members of the Finance department. -Members of the Finance department should only be able to access documents in their own country. +Members of the Finance department should only be able to access documents in their own country/region. Only Finance Administrators should have write access. The rule allows an exception for members of the FinanceException group. This group will have read access. diff --git a/docset/winserver2012r2-ps/adcsdeployment/install-adcsnetworkdeviceenrollmentservice.md b/docset/winserver2012r2-ps/adcsdeployment/install-adcsnetworkdeviceenrollmentservice.md index 7f20c5cf78..5a91ceb52b 100644 --- a/docset/winserver2012r2-ps/adcsdeployment/install-adcsnetworkdeviceenrollmentservice.md +++ b/docset/winserver2012r2-ps/adcsdeployment/install-adcsnetworkdeviceenrollmentservice.md @@ -230,7 +230,7 @@ Accept wildcard characters: False ``` ### -RACountry -Specifies the country of the registration authority. +Specifies the country/region of the registration authority. ```yaml Type: String diff --git a/docset/winserver2016-ps/activedirectory/New-ADCentralAccessPolicy.md b/docset/winserver2016-ps/activedirectory/New-ADCentralAccessPolicy.md index c1316a5295..391aa50e69 100644 --- a/docset/winserver2016-ps/activedirectory/New-ADCentralAccessPolicy.md +++ b/docset/winserver2016-ps/activedirectory/New-ADCentralAccessPolicy.md @@ -53,7 +53,7 @@ PS C:\> Set-ADCentralAccessRule -Identity "Finance Documents Rule" -ResourceCond This command creates a central access rule named Finance Documents Rule with a new resource condition and new permissions. The new rule specifies that documents should only be read by members of the Finance department. -Members of the Finance department should only be able to access documents in their own country. +Members of the Finance department should only be able to access documents in their own country/region. Only Finance Administrators should have write access. The rule allows an exception for members of the FinanceException group. This group will have read access. diff --git a/docset/winserver2016-ps/activedirectory/Set-ADCentralAccessRule.md b/docset/winserver2016-ps/activedirectory/Set-ADCentralAccessRule.md index 6fca1a1ef1..a6007577c4 100644 --- a/docset/winserver2016-ps/activedirectory/Set-ADCentralAccessRule.md +++ b/docset/winserver2016-ps/activedirectory/Set-ADCentralAccessRule.md @@ -60,7 +60,7 @@ PS C:\> Set-ADCentralAccessRule -Identity "Finance Documents Rule" -ResourceCond This example sets the central access rule named Finance Documents Rule with a new resource condition and new permissions. The new rule specifies that documents should only be read by members of the Finance department. -Members of the Finance department should only be able to access documents in their own country. +Members of the Finance department should only be able to access documents in their own country/region. Only Finance Administrators should have write access. The rule allows an exception for members of the FinanceException group. This group will have read access. diff --git a/docset/winserver2016-ps/adcsdeployment/Install-AdcsNetworkDeviceEnrollmentService.md b/docset/winserver2016-ps/adcsdeployment/Install-AdcsNetworkDeviceEnrollmentService.md index 48208d5718..87f49f4b58 100644 --- a/docset/winserver2016-ps/adcsdeployment/Install-AdcsNetworkDeviceEnrollmentService.md +++ b/docset/winserver2016-ps/adcsdeployment/Install-AdcsNetworkDeviceEnrollmentService.md @@ -226,7 +226,7 @@ Accept wildcard characters: False ``` ### -RACountry -Specifies the country of the registration authority. +Specifies the country/region of the registration authority. ```yaml Type: String diff --git a/docset/winserver2019-ps/activedirectory/New-ADCentralAccessPolicy.md b/docset/winserver2019-ps/activedirectory/New-ADCentralAccessPolicy.md index 269f96d7f0..27c434bdc1 100644 --- a/docset/winserver2019-ps/activedirectory/New-ADCentralAccessPolicy.md +++ b/docset/winserver2019-ps/activedirectory/New-ADCentralAccessPolicy.md @@ -53,7 +53,7 @@ PS C:\> Set-ADCentralAccessRule -Identity "Finance Documents Rule" -ResourceCond This command creates a central access rule named Finance Documents Rule with a new resource condition and new permissions. The new rule specifies that documents should only be read by members of the Finance department. -Members of the Finance department should only be able to access documents in their own country. +Members of the Finance department should only be able to access documents in their own country/region. Only Finance Administrators should have write access. The rule allows an exception for members of the FinanceException group. This group will have read access. diff --git a/docset/winserver2019-ps/activedirectory/Set-ADCentralAccessRule.md b/docset/winserver2019-ps/activedirectory/Set-ADCentralAccessRule.md index 1656216a39..222825d18a 100644 --- a/docset/winserver2019-ps/activedirectory/Set-ADCentralAccessRule.md +++ b/docset/winserver2019-ps/activedirectory/Set-ADCentralAccessRule.md @@ -60,7 +60,7 @@ PS C:\> Set-ADCentralAccessRule -Identity "Finance Documents Rule" -ResourceCond This example sets the central access rule named Finance Documents Rule with a new resource condition and new permissions. The new rule specifies that documents should only be read by members of the Finance department. -Members of the Finance department should only be able to access documents in their own country. +Members of the Finance department should only be able to access documents in their own country/region. Only Finance Administrators should have write access. The rule allows an exception for members of the FinanceException group. This group will have read access. diff --git a/docset/winserver2019-ps/adcsdeployment/Install-AdcsNetworkDeviceEnrollmentService.md b/docset/winserver2019-ps/adcsdeployment/Install-AdcsNetworkDeviceEnrollmentService.md index b9661cb06f..4c392bf825 100644 --- a/docset/winserver2019-ps/adcsdeployment/Install-AdcsNetworkDeviceEnrollmentService.md +++ b/docset/winserver2019-ps/adcsdeployment/Install-AdcsNetworkDeviceEnrollmentService.md @@ -226,7 +226,7 @@ Accept wildcard characters: False ``` ### -RACountry -Specifies the country of the registration authority. +Specifies the country/region of the registration authority. ```yaml Type: String diff --git a/docset/winserver2022-ps/activedirectory/New-ADCentralAccessPolicy.md b/docset/winserver2022-ps/activedirectory/New-ADCentralAccessPolicy.md index 9b0e229855..a884827549 100644 --- a/docset/winserver2022-ps/activedirectory/New-ADCentralAccessPolicy.md +++ b/docset/winserver2022-ps/activedirectory/New-ADCentralAccessPolicy.md @@ -53,7 +53,7 @@ PS C:\> Set-ADCentralAccessRule -Identity "Finance Documents Rule" -ResourceCond This command creates a central access rule named Finance Documents Rule with a new resource condition and new permissions. The new rule specifies that documents should only be read by members of the Finance department. -Members of the Finance department should only be able to access documents in their own country. +Members of the Finance department should only be able to access documents in their own country/region. Only Finance Administrators should have write access. The rule allows an exception for members of the FinanceException group. This group will have read access. diff --git a/docset/winserver2022-ps/activedirectory/Set-ADCentralAccessRule.md b/docset/winserver2022-ps/activedirectory/Set-ADCentralAccessRule.md index 6b87452760..0cda8e0aad 100644 --- a/docset/winserver2022-ps/activedirectory/Set-ADCentralAccessRule.md +++ b/docset/winserver2022-ps/activedirectory/Set-ADCentralAccessRule.md @@ -60,7 +60,7 @@ PS C:\> Set-ADCentralAccessRule -Identity "Finance Documents Rule" -ResourceCond This example sets the central access rule named Finance Documents Rule with a new resource condition and new permissions. The new rule specifies that documents should only be read by members of the Finance department. -Members of the Finance department should only be able to access documents in their own country. +Members of the Finance department should only be able to access documents in their own country/region. Only Finance Administrators should have write access. The rule allows an exception for members of the FinanceException group. This group will have read access. diff --git a/docset/winserver2022-ps/adcsdeployment/Install-AdcsNetworkDeviceEnrollmentService.md b/docset/winserver2022-ps/adcsdeployment/Install-AdcsNetworkDeviceEnrollmentService.md index 221e415954..512b93c3b8 100644 --- a/docset/winserver2022-ps/adcsdeployment/Install-AdcsNetworkDeviceEnrollmentService.md +++ b/docset/winserver2022-ps/adcsdeployment/Install-AdcsNetworkDeviceEnrollmentService.md @@ -273,7 +273,7 @@ Accept wildcard characters: False ### -RACountry -Specifies the country of the registration authority. +Specifies the country/region of the registration authority. ```yaml Type: String From eebb2d282c6a7d0242f7ef0fbd00939692195d2b Mon Sep 17 00:00:00 2001 From: Christoph Petersen Date: Wed, 19 Jul 2023 15:18:52 +0200 Subject: [PATCH 534/650] Add missing -ManagementPointNetworkType parameter --- .../failoverclusters/New-Cluster.md | 25 +++++++++++++++++-- 1 file changed, 23 insertions(+), 2 deletions(-) diff --git a/docset/winserver2022-ps/failoverclusters/New-Cluster.md b/docset/winserver2022-ps/failoverclusters/New-Cluster.md index 98a6c68fd7..7a82d8b4d2 100644 --- a/docset/winserver2022-ps/failoverclusters/New-Cluster.md +++ b/docset/winserver2022-ps/failoverclusters/New-Cluster.md @@ -17,8 +17,8 @@ Creates a new failover cluster. ``` New-Cluster [-Name] [-Node ] [-StaticAddress ] - [-IgnoreNetwork ] [-NoStorage] [-S2D] - [-AdministrativeAccessPoint ] [-Force] [] + [-IgnoreNetwork ] [-NoStorage] [-S2D] [-AdministrativeAccessPoint ] + [-Force] [-ManagementPointNetworkType ] [] ``` ## DESCRIPTION @@ -167,6 +167,27 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ManagementPointNetworkType +Specifies the network configuration used to determine IP address settings. + +The acceptable values for this parameter are: + +- Automatic: Automatically detects the appropriate setting. If SQL Server is running in Azure, uses `Distributed`. If SQL Server is running on-premises, uses `Singleton`. (Default setting) +- Singleton: The traditional method of DHCP or static IP address. +- Distributed: Uses a Distributed Network Name by using Node IP addresses. + +```yaml +Type: AdminAccessPointResType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Automatic +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Name Specifies the name of the cluster to create. From 2fc937da25e72d9d1b1f9eaa2f35acf4e6c5a6d4 Mon Sep 17 00:00:00 2001 From: Tyler D Date: Wed, 19 Jul 2023 19:16:45 -0700 Subject: [PATCH 535/650] Fix typo CertStoreLocations -> CertStoreLocation --- docset/winserver2022-ps/pki/Import-Certificate.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/pki/Import-Certificate.md b/docset/winserver2022-ps/pki/Import-Certificate.md index 9f1f8e53e4..60081c85d3 100644 --- a/docset/winserver2022-ps/pki/Import-Certificate.md +++ b/docset/winserver2022-ps/pki/Import-Certificate.md @@ -31,7 +31,7 @@ The `Import-Certificate` cmdlet imports one or more certificates into a certific ```powershell $params = @{ FilePath = 'C:\Users\Xyz\Desktop\BackupCert.cer' - CertStoreLocations = 'Cert:\CurrentUser\Root' + CertStoreLocation = 'Cert:\CurrentUser\Root' } Import-Certificate @params ``` From 5c828f9d9776d00076f177710091aa14dffb721b Mon Sep 17 00:00:00 2001 From: Xelu86 <103963494+Xelu86@users.noreply.github.com> Date: Thu, 20 Jul 2023 16:08:08 -0400 Subject: [PATCH 536/650] Updated command --- docset/winserver2022-ps/hyper-v/New-VFD.md | 58 ++++++++++++++-------- 1 file changed, 36 insertions(+), 22 deletions(-) diff --git a/docset/winserver2022-ps/hyper-v/New-VFD.md b/docset/winserver2022-ps/hyper-v/New-VFD.md index 0c9af0b9a8..25e463aac6 100644 --- a/docset/winserver2022-ps/hyper-v/New-VFD.md +++ b/docset/winserver2022-ps/hyper-v/New-VFD.md @@ -2,7 +2,7 @@ description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. external help file: Microsoft.HyperV.PowerShell.Cmdlets.dll-Help.xml Module Name: Hyper-V -ms.date: 12/20/2016 +ms.date: ms.date: 06/21/2023 online version: https://learn.microsoft.com/powershell/module/hyper-v/new-vfd?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: New-VFD @@ -21,29 +21,33 @@ New-VFD [-Path] [-CimSession ] [-ComputerName New-VFD "c:\floppy.vfd" + +```powershell +New-VFD "C:\floppy.vfd" ``` -Creates a new virtual floppy drive at the specified path. -This can be then used in the **Set-VMFloppyDiskDrive** cmdlet to attach the virtual floppy disk to a virtual machine. +Creates a new virtual floppy drive at the specified path. This can be then used in the +`Set-VMFloppyDiskDrive` cmdlet to attach the virtual floppy disk to a virtual machine. ## PARAMETERS ### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -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. -The default is the current session on the local computer. + +Runs the cmdlet in a remote session or on a remote computer. 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. The default is the +current session on the local computer. ```yaml Type: CimSession[] Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -53,15 +57,15 @@ Accept wildcard characters: False ``` ### -ComputerName + Specifies one or more virtual machine hosts on which the virtual floppy disk is to be created. -NetBIOS names, IP addresses, and fully qualified domain names are allowable. -The default is the local computer. -Use localhost or a dot (.) to specify the local computer explicitly. +NetBIOS names, IP addresses, and fully qualified domain names are allowable. The default is the +local computer. Use localhost or a dot (.) to specify the local computer explicitly. ```yaml Type: String[] Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -71,6 +75,7 @@ Accept wildcard characters: False ``` ### -Confirm + Prompts you for confirmation before running the cmdlet. ```yaml @@ -86,13 +91,14 @@ Accept wildcard characters: False ``` ### -Credential -Specifies one or more user accounts that have permission to perform this action. -The default is the current user. + +Specifies one or more user accounts that have permission to perform this action. The default is the +current user. ```yaml Type: PSCredential[] Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -102,12 +108,13 @@ Accept wildcard characters: False ``` ### -Path + Specifies the path to the new virtual floppy disk files to be created. ```yaml Type: String[] Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 0 @@ -117,8 +124,8 @@ Accept wildcard characters: False ``` ### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. + +Shows what would happen if the cmdlet runs. The cmdlet isn't run. ```yaml Type: SwitchParameter @@ -127,16 +134,22 @@ Aliases: wi Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### CommonParameters -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). + +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). ## INPUTS +### System.String[] + ## OUTPUTS ### System.IO.FileInfo @@ -145,3 +158,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS +- [Set-VMFloppyDiskDrive](set-vmfloppydiskdrive.md) From 3d5b7abada4b05c0511450d93ff6dba9f997b74e Mon Sep 17 00:00:00 2001 From: Xelu86 <103963494+Xelu86@users.noreply.github.com> Date: Thu, 20 Jul 2023 16:31:46 -0400 Subject: [PATCH 537/650] Updated command set --- .../hyper-v/Get-VHDSnapshot.md | 78 +++++++++------- .../hyper-v/Remove-VHDSnapshot.md | 89 ++++++++++++------- 2 files changed, 99 insertions(+), 68 deletions(-) diff --git a/docset/winserver2022-ps/hyper-v/Get-VHDSnapshot.md b/docset/winserver2022-ps/hyper-v/Get-VHDSnapshot.md index 0ac2930603..9da2cc9c2b 100644 --- a/docset/winserver2022-ps/hyper-v/Get-VHDSnapshot.md +++ b/docset/winserver2022-ps/hyper-v/Get-VHDSnapshot.md @@ -2,7 +2,7 @@ description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. external help file: Microsoft.HyperV.PowerShell.Cmdlets.dll-Help.xml Module Name: Hyper-V -ms.date: 12/20/2016 +ms.date: ms.date: 06/21/2023 online version: https://learn.microsoft.com/powershell/module/hyper-v/get-vhdsnapshot?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Get-VHDSnapshot @@ -16,35 +16,42 @@ Gets information about a checkpoint in a VHD set. ## SYNTAX ``` -Get-VHDSnapshot [-Path] [-GetParentPaths] [-SnapshotId ] [-CimSession ] - [-ComputerName ] [-Credential ] [] +Get-VHDSnapshot [-Path] [-GetParentPaths] [-SnapshotId ] + [-CimSession ] [-ComputerName ] [-Credential ] + [] ``` ## DESCRIPTION -The **Get-VHDSnapshot** cmdlet gets information about a checkpoint in a virtual hard disk (VHD) set file. + +The `Get-VHDSnapshot` cmdlet gets information about a checkpoint in a virtual hard disk (VHD) set +file. Checkpoint replaces the previous term, snapshot. ## EXAMPLES ### Example 1: Get information about a checkpoint -``` -PS C:\> Get-VHDSnapshot -Path "Data01.vhds" -SnapshotId 6c87351a-a39a-4581-b231-6d693b26485d + +```powershell +Get-VHDSnapshot -Path "Data01.vhds" -SnapshotId 6c87351a-a39a-4581-b231-6d693b26485d ``` -This command gets information about the checkpoint that has the specified ID from the VHD set file named Data01.vhds in the current working folder. +This command gets information about the checkpoint that has the specified ID from the VHD set file +named Data01.vhds in the current working folder. ## PARAMETERS ### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -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. -The default is the current session on the local computer. + +Runs the cmdlet in a remote session or on a remote computer. 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. The default is the +current session on the local computer. ```yaml Type: CimSession[] Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -54,15 +61,15 @@ Accept wildcard characters: False ``` ### -ComputerName -Specifies one or more Hyper-V hosts that run this command. -NetBIOS names, IP addresses, and fully qualified domain names are allowable. -The default is the local computer. -Use localhost or a dot (.) to specify the local computer explicitly. + +Specifies one or more Hyper-V hosts that run this command. NetBIOS names, IP addresses, and fully +qualified domain names are allowable. The default is the local computer. Use localhost or a dot (.) +to specify the local computer explicitly. ```yaml Type: String[] Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -72,13 +79,14 @@ Accept wildcard characters: False ``` ### -Credential -Specifies one or more user accounts that have permission to perform this action. -The default is the current user. + +Specifies one or more user accounts that have permission to perform this action. The default is the +current user. ```yaml Type: PSCredential[] Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -88,12 +96,13 @@ Accept wildcard characters: False ``` ### -GetParentPaths + Gets the paths of all files on which this VHD checkpoint depends. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -103,8 +112,10 @@ Accept wildcard characters: False ``` ### -Path -Specifies an array of paths of VHD set files from which this cmdlet gets checkpoints. -If you specify a file name or relative path, the cmdlet determines the full path relative to the current working folder. + +Specifies an array of paths of VHD set files from which this cmdlet gets checkpoints. If you specify +a file name or relative path, the cmdlet determines the full path relative to the current working +folder. ```yaml Type: String[] @@ -119,12 +130,13 @@ Accept wildcard characters: False ``` ### -SnapshotId + Specifies an array of unique IDs of VHD checkpoints that this cmdlet gets from a VHD set file. ```yaml Type: Guid[] Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -134,26 +146,24 @@ Accept wildcard characters: False ``` ### CommonParameters -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). + +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). ## INPUTS +### System.String[] + ## OUTPUTS ### Microsoft.Vhd.PowerShell.VHDSnapshotInfo + This cmdlet returns a **VHDSnapshotInfo** object. ## NOTES ## RELATED LINKS -[Export-VMSnapshot](./Export-VMSnapshot.md) - -[Get-VMSnapshot](./Get-VMSnapshot.md) - -[Rename-VMSnapshot](./Rename-VMSnapshot.md) - -[Restore-VMSnapshot](./Restore-VMSnapshot.md) - -[Get-VHDSet](./Get-VHDSet.md) - +- [Remove-VHDSnapshot](remove-vhdsnapshot.md) diff --git a/docset/winserver2022-ps/hyper-v/Remove-VHDSnapshot.md b/docset/winserver2022-ps/hyper-v/Remove-VHDSnapshot.md index a7eade58cb..af961d272b 100644 --- a/docset/winserver2022-ps/hyper-v/Remove-VHDSnapshot.md +++ b/docset/winserver2022-ps/hyper-v/Remove-VHDSnapshot.md @@ -2,7 +2,7 @@ description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. external help file: Microsoft.HyperV.PowerShell.Cmdlets.dll-Help.xml Module Name: Hyper-V -ms.date: 12/20/2016 +ms.date: ms.date: 06/21/2023 online version: https://learn.microsoft.com/powershell/module/hyper-v/remove-vhdsnapshot?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Remove-VHDSnapshot @@ -16,42 +16,49 @@ Removes a checkpoint from a VHD set file. ## SYNTAX ### Path (Default) + ``` Remove-VHDSnapshot [-Path] [-PersistReferencePoint] -SnapshotId [-AsJob] - [-CimSession ] [-ComputerName ] [-Credential ] [-WhatIf] [-Confirm] - [] + [-CimSession ] [-ComputerName ] [-Credential ] [-WhatIf] + [-Confirm] [] ``` ### VHDSnapshot + ``` Remove-VHDSnapshot [-PersistReferencePoint] [-VHDSnapshot] [-AsJob] - [-CimSession ] [-ComputerName ] [-Credential ] [-WhatIf] [-Confirm] - [] + [-CimSession ] [-ComputerName ] [-Credential ] [-WhatIf] + [-Confirm] [] ``` ## DESCRIPTION -The **Remove-VHDSnapshot** cmdlet removes a virtual hard disk (VHD) checkpoint from a VHD set file. + +The `Remove-VHDSnapshot` cmdlet removes a virtual hard disk (VHD) checkpoint from a VHD set file. Checkpoint replaces the previous term, snapshot. ## EXAMPLES + ### Example 1: Remove a checkpoint -``` -PS C:\> Remove-VHDSnapshot -Path "Data01.vhds" -SnapshotId 6c87351a-a39a-4581-b231-6d693b26485d + +```powershell +Remove-VHDSnapshot -Path "Data01.vhds" -SnapshotId 6c87351a-a39a-4581-b231-6d693b26485d ``` -This command removes the checkpoint that has the specified ID from the VHD set file named Data01.vhds. +This command removes the checkpoint that has the specified ID from the VHD set file named +Data01.vhds. ## PARAMETERS ### -AsJob + Runs the cmdlet as a background job. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -61,14 +68,16 @@ Accept wildcard characters: False ``` ### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -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. -The default is the current session on the local computer. + +Runs the cmdlet in a remote session or on a remote computer. 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. The default is the +current session on the local computer. ```yaml Type: CimSession[] Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -78,15 +87,15 @@ Accept wildcard characters: False ``` ### -ComputerName -Specifies one or more Hyper-V hosts that run this cmdlet. -NetBIOS names, IP addresses, and fully qualified domain names are allowable. -The default is the local computer. -Use localhost or a dot (.) to specify the local computer explicitly. + +Specifies one or more Hyper-V hosts that run this cmdlet. NetBIOS names, IP addresses, and fully +qualified domain names are allowable. The default is the local computer. Use localhost or a dot (.) +to specify the local computer explicitly. ```yaml Type: String[] Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -96,6 +105,7 @@ Accept wildcard characters: False ``` ### -Confirm + Prompts you for confirmation before running the cmdlet. ```yaml @@ -111,13 +121,14 @@ Accept wildcard characters: False ``` ### -Credential -Specifies one or more user accounts that have permission to perform this action. -The default is the current user. + +Specifies one or more user accounts that have permission to perform this action. The default is the +current user. ```yaml Type: PSCredential[] Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -127,9 +138,10 @@ Accept wildcard characters: False ``` ### -Path -Specifies an array of paths of VHD set files. -This cmdlet removes a checkpoint from the files that this parameter specifies. -If you specify a file name or relative path, the cmdlet determines the full path relative to the current working folder. + +Specifies an array of paths of VHD set files. This cmdlet removes a checkpoint from the files that +this parameter specifies. If you specify a file name or relative path, the cmdlet determines the +full path relative to the current working folder. ```yaml Type: String[] @@ -144,12 +156,13 @@ Accept wildcard characters: False ``` ### -PersistReferencePoint + Indicates that this cmdlet persists an RCT-only reference point after it deletes the checkpoint. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -159,12 +172,13 @@ Accept wildcard characters: False ``` ### -SnapshotId + Specifies an array of unique IDs of VHD checkpoint that this cmdlet removes from the VHD set file. ```yaml Type: Guid[] Parameter Sets: Path -Aliases: +Aliases: Required: True Position: Named @@ -174,12 +188,13 @@ Accept wildcard characters: False ``` ### -VHDSnapshot + Specifies an array of VHD checkpoints that this cmdlet removes from a VHD set file. ```yaml Type: VHDSnapshotInfo[] Parameter Sets: VHDSnapshot -Aliases: +Aliases: Required: True Position: 0 @@ -189,8 +204,8 @@ Accept wildcard characters: False ``` ### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. + +Shows what would happen if the cmdlet runs. The cmdlet isn't run. ```yaml Type: SwitchParameter @@ -199,16 +214,23 @@ Aliases: wi Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### CommonParameters -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). +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). ## INPUTS +### System.String[] + +### Microsoft.Vhd.PowerShell.VHDSnapshotInfo[] + ## OUTPUTS ### Microsoft.Vhd.PowerShell.VHDSnapshotInfo[] @@ -217,5 +239,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Get-VHDSnapshot](./Get-VHDSnapshot.md) - +- [Get-VHDSnapshot](get-vhdsnapshot.md) From 9691340b50c58880904e944b8d97b52dcdbc2b34 Mon Sep 17 00:00:00 2001 From: Dimitriy Ryazantcev Date: Tue, 25 Jul 2023 11:34:58 +0300 Subject: [PATCH 538/650] Update Set-WinUserLanguageList.md --- .../winserver2019-ps/international/Set-WinUserLanguageList.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2019-ps/international/Set-WinUserLanguageList.md b/docset/winserver2019-ps/international/Set-WinUserLanguageList.md index 3201b12f5e..739e153a83 100644 --- a/docset/winserver2019-ps/international/Set-WinUserLanguageList.md +++ b/docset/winserver2019-ps/international/Set-WinUserLanguageList.md @@ -144,7 +144,7 @@ The name of the language in the current Windows display language. The writing system of the language. - **Input methods** (READ/WRITE). A list of input method Tablet Input Panel (TIP) strings that are enabled for this language. -The enabled input methods are listed in the format `Language ID: Keyboard layout ID`. +The enabled input methods are listed in the format `Language ID: Keyboard layout ID`. See [Default input profiles (input locales) in Windows](/windows-hardware/manufacture/desktop/default-input-locales-for-windows-language-packs). - **Handwriting recognition input mode** (READ/WRITE). This value is either 0 (freehand) or 1 (write each character separately). From 8dd0a7a3533db4dab6e3ccfd9fe2e5ec479ce968 Mon Sep 17 00:00:00 2001 From: Dimitriy Ryazantcev Date: Tue, 25 Jul 2023 11:35:41 +0300 Subject: [PATCH 539/650] Update Set-WinUserLanguageList.md --- .../winserver2012r2-ps/international/Set-WinUserLanguageList.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2012r2-ps/international/Set-WinUserLanguageList.md b/docset/winserver2012r2-ps/international/Set-WinUserLanguageList.md index 59ccc89563..fbe71ab19a 100644 --- a/docset/winserver2012r2-ps/international/Set-WinUserLanguageList.md +++ b/docset/winserver2012r2-ps/international/Set-WinUserLanguageList.md @@ -122,7 +122,7 @@ The language object contains the following properties: --**English name** (LP database) (READ). The name of the language in English. --**Localized name** (LP database) (READ). The name of the language in the current Windows display language. --**Script** (LP database) (READ). The writing system of the language. ---**Input methods** (READ/WRITE). A list of input method Tablet Input Panel (TIP) strings that are enabled for this language. The enabled input methods are listed in the format Language ID: Keyboard layout ID. +--**Input methods** (READ/WRITE). A list of input method Tablet Input Panel (TIP) strings that are enabled for this language. The enabled input methods are listed in the format Language ID: Keyboard layout ID. See [Default input profiles (input locales) in Windows](/windows-hardware/manufacture/desktop/default-input-locales-for-windows-language-packs). --**Handwriting recognition input mode** (READ/WRITE). This value is either 0 (freehand) or 1 (write each character separately). ## OUTPUTS From 39c37f423b5c61eccf33ae476516b30253322299 Mon Sep 17 00:00:00 2001 From: Dimitriy Ryazantcev Date: Tue, 25 Jul 2023 11:36:39 +0300 Subject: [PATCH 540/650] Update Set-WinUserLanguageList.md --- .../winserver2016-ps/international/Set-WinUserLanguageList.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2016-ps/international/Set-WinUserLanguageList.md b/docset/winserver2016-ps/international/Set-WinUserLanguageList.md index 900dc4cc26..59fbb8dcfc 100644 --- a/docset/winserver2016-ps/international/Set-WinUserLanguageList.md +++ b/docset/winserver2016-ps/international/Set-WinUserLanguageList.md @@ -144,7 +144,7 @@ The name of the language in the current Windows display language. The writing system of the language. - **Input methods** (READ/WRITE). A list of input method Tablet Input Panel (TIP) strings that are enabled for this language. -The enabled input methods are listed in the format `Language ID: Keyboard layout ID`. +The enabled input methods are listed in the format `Language ID: Keyboard layout ID`. See [Default input profiles (input locales) in Windows](/windows-hardware/manufacture/desktop/default-input-locales-for-windows-language-packs). - **Handwriting recognition input mode** (READ/WRITE). This value is either 0 (freehand) or 1 (write each character separately). From 73fb2704c07e7bb524718cfb7d7032ebe7594e82 Mon Sep 17 00:00:00 2001 From: Dimitriy Ryazantcev Date: Tue, 25 Jul 2023 11:38:03 +0300 Subject: [PATCH 541/650] Update Set-WinUserLanguageList.md --- .../winserver2012-ps/international/Set-WinUserLanguageList.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2012-ps/international/Set-WinUserLanguageList.md b/docset/winserver2012-ps/international/Set-WinUserLanguageList.md index b89513e10b..3a3f9369ca 100644 --- a/docset/winserver2012-ps/international/Set-WinUserLanguageList.md +++ b/docset/winserver2012-ps/international/Set-WinUserLanguageList.md @@ -120,7 +120,7 @@ The language object contains the following properties: - English name (LP database) (READ). The name of the language in English. - Localized name (LP database) (READ). The name of the language in the current Windows display language. - Script (LP database) (READ). The writing system of the language. -- Input methods (READ/WRITE). A list of input method Tablet Input Panel (TIP) strings that are enabled for this language. The enabled input methods are listed in the format Language ID: Keyboard layout ID. +- Input methods (READ/WRITE). A list of input method Tablet Input Panel (TIP) strings that are enabled for this language. The enabled input methods are listed in the format `Language ID:Keyboard layout ID`. See [Default input profiles (input locales) in Windows](/windows-hardware/manufacture/desktop/default-input-locales-for-windows-language-packs). - Handwriting recognition input mode (READ/WRITE). This value is either 0 (freehand) or 1 (write each character separately). ## OUTPUTS From 8193f7f891a7440bfd3498ac2a8e94afead275b8 Mon Sep 17 00:00:00 2001 From: Dimitriy Ryazantcev Date: Tue, 25 Jul 2023 11:38:34 +0300 Subject: [PATCH 542/650] Update Set-WinUserLanguageList.md --- .../winserver2012r2-ps/international/Set-WinUserLanguageList.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2012r2-ps/international/Set-WinUserLanguageList.md b/docset/winserver2012r2-ps/international/Set-WinUserLanguageList.md index fbe71ab19a..1acc1a5fb5 100644 --- a/docset/winserver2012r2-ps/international/Set-WinUserLanguageList.md +++ b/docset/winserver2012r2-ps/international/Set-WinUserLanguageList.md @@ -122,7 +122,7 @@ The language object contains the following properties: --**English name** (LP database) (READ). The name of the language in English. --**Localized name** (LP database) (READ). The name of the language in the current Windows display language. --**Script** (LP database) (READ). The writing system of the language. ---**Input methods** (READ/WRITE). A list of input method Tablet Input Panel (TIP) strings that are enabled for this language. The enabled input methods are listed in the format Language ID: Keyboard layout ID. See [Default input profiles (input locales) in Windows](/windows-hardware/manufacture/desktop/default-input-locales-for-windows-language-packs). +--**Input methods** (READ/WRITE). A list of input method Tablet Input Panel (TIP) strings that are enabled for this language. The enabled input methods are listed in the format `Language ID:Keyboard layout ID`. See [Default input profiles (input locales) in Windows](/windows-hardware/manufacture/desktop/default-input-locales-for-windows-language-packs). --**Handwriting recognition input mode** (READ/WRITE). This value is either 0 (freehand) or 1 (write each character separately). ## OUTPUTS From a86f6b82a515344855949044197d4b45a66a30c1 Mon Sep 17 00:00:00 2001 From: Dimitriy Ryazantcev Date: Tue, 25 Jul 2023 11:38:57 +0300 Subject: [PATCH 543/650] Update Set-WinUserLanguageList.md --- .../winserver2016-ps/international/Set-WinUserLanguageList.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2016-ps/international/Set-WinUserLanguageList.md b/docset/winserver2016-ps/international/Set-WinUserLanguageList.md index 59fbb8dcfc..82f6d3a531 100644 --- a/docset/winserver2016-ps/international/Set-WinUserLanguageList.md +++ b/docset/winserver2016-ps/international/Set-WinUserLanguageList.md @@ -144,7 +144,7 @@ The name of the language in the current Windows display language. The writing system of the language. - **Input methods** (READ/WRITE). A list of input method Tablet Input Panel (TIP) strings that are enabled for this language. -The enabled input methods are listed in the format `Language ID: Keyboard layout ID`. See [Default input profiles (input locales) in Windows](/windows-hardware/manufacture/desktop/default-input-locales-for-windows-language-packs). +The enabled input methods are listed in the format `Language ID:Keyboard layout ID`. See [Default input profiles (input locales) in Windows](/windows-hardware/manufacture/desktop/default-input-locales-for-windows-language-packs). - **Handwriting recognition input mode** (READ/WRITE). This value is either 0 (freehand) or 1 (write each character separately). From 911c892a8e849fff612b56ba9f286d64928d7176 Mon Sep 17 00:00:00 2001 From: Dimitriy Ryazantcev Date: Tue, 25 Jul 2023 11:39:30 +0300 Subject: [PATCH 544/650] Update Set-WinUserLanguageList.md --- .../winserver2019-ps/international/Set-WinUserLanguageList.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2019-ps/international/Set-WinUserLanguageList.md b/docset/winserver2019-ps/international/Set-WinUserLanguageList.md index 739e153a83..4b64e52328 100644 --- a/docset/winserver2019-ps/international/Set-WinUserLanguageList.md +++ b/docset/winserver2019-ps/international/Set-WinUserLanguageList.md @@ -144,7 +144,7 @@ The name of the language in the current Windows display language. The writing system of the language. - **Input methods** (READ/WRITE). A list of input method Tablet Input Panel (TIP) strings that are enabled for this language. -The enabled input methods are listed in the format `Language ID: Keyboard layout ID`. See [Default input profiles (input locales) in Windows](/windows-hardware/manufacture/desktop/default-input-locales-for-windows-language-packs). +The enabled input methods are listed in the format `Language ID:Keyboard layout ID`. See [Default input profiles (input locales) in Windows](/windows-hardware/manufacture/desktop/default-input-locales-for-windows-language-packs). - **Handwriting recognition input mode** (READ/WRITE). This value is either 0 (freehand) or 1 (write each character separately). From 4ca0c09c773408b28d4d4d548c298990b1fd8c6e Mon Sep 17 00:00:00 2001 From: Dimitriy Ryazantcev Date: Tue, 25 Jul 2023 11:39:59 +0300 Subject: [PATCH 545/650] Update Set-WinUserLanguageList.md --- .../winserver2012-ps/international/Set-WinUserLanguageList.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2012-ps/international/Set-WinUserLanguageList.md b/docset/winserver2012-ps/international/Set-WinUserLanguageList.md index 3a3f9369ca..7fc62816c3 100644 --- a/docset/winserver2012-ps/international/Set-WinUserLanguageList.md +++ b/docset/winserver2012-ps/international/Set-WinUserLanguageList.md @@ -115,7 +115,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable A list of **WinUserLanguage** objects that contain one or more languages and associated properties from the current user account's language list. The language object contains the following properties: -- BCP-47 (READ). A standard language tag that is used to identify languages. For more information, see the Internet Engineering Task Force (IETF) BCP 47 RFChttp://go.microsoft.com/fwlink/?LinkID=242207. +- BCP-47 (READ). A standard language tag that is used to identify languages. For more information, see the [Internet Engineering Task Force (IETF) BCP 47 RFC](https://go.microsoft.com/fwlink/?LinkID=242207). - Autonym (LP database) (READ). The name of the language in the language itself. - English name (LP database) (READ). The name of the language in English. - Localized name (LP database) (READ). The name of the language in the current Windows display language. From 0b5c9aacb292fd22272d3c2f67bf1613aa259c5d Mon Sep 17 00:00:00 2001 From: Dimitriy Ryazantcev Date: Tue, 25 Jul 2023 11:40:14 +0300 Subject: [PATCH 546/650] Update Set-WinUserLanguageList.md --- .../winserver2012r2-ps/international/Set-WinUserLanguageList.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2012r2-ps/international/Set-WinUserLanguageList.md b/docset/winserver2012r2-ps/international/Set-WinUserLanguageList.md index 1acc1a5fb5..ce7e13fd83 100644 --- a/docset/winserver2012r2-ps/international/Set-WinUserLanguageList.md +++ b/docset/winserver2012r2-ps/international/Set-WinUserLanguageList.md @@ -117,7 +117,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable A list of *WinUserLanguage* objects that contain one or more languages and associated properties from the current user account's language list. The language object contains the following properties: ---**BCP-47** (READ). A standard language tag that is used to identify languages. For more information, see the Internet Engineering Task Force (IETF) BCP 47 RFChttp://go.microsoft.com/fwlink/?LinkID=242207. +--**BCP-47** (READ). A standard language tag that is used to identify languages. For more information, see the [Internet Engineering Task Force (IETF) BCP 47 RFC](https://go.microsoft.com/fwlink/?LinkID=242207). --**Autonym** (LP database) (READ). The name of the language in the language itself. --**English name** (LP database) (READ). The name of the language in English. --**Localized name** (LP database) (READ). The name of the language in the current Windows display language. From a07d3f63bf84767e56bb9a63db60e35fd0ca27eb Mon Sep 17 00:00:00 2001 From: Christoph Petersen Date: Tue, 25 Jul 2023 11:50:40 +0200 Subject: [PATCH 547/650] Fixed copy review suggestions --- docset/winserver2022-ps/failoverclusters/New-Cluster.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/failoverclusters/New-Cluster.md b/docset/winserver2022-ps/failoverclusters/New-Cluster.md index 7a82d8b4d2..5dca9a2fbd 100644 --- a/docset/winserver2022-ps/failoverclusters/New-Cluster.md +++ b/docset/winserver2022-ps/failoverclusters/New-Cluster.md @@ -172,7 +172,7 @@ Specifies the network configuration used to determine IP address settings. The acceptable values for this parameter are: -- Automatic: Automatically detects the appropriate setting. If SQL Server is running in Azure, uses `Distributed`. If SQL Server is running on-premises, uses `Singleton`. (Default setting) +- Automatic: Automatically detects the appropriate setting. If SQL Server is running in Azure, it uses `Distributed`. If SQL Server is running on-premises, uses `Singleton`. (Default setting) - Singleton: The traditional method of DHCP or static IP address. - Distributed: Uses a Distributed Network Name by using Node IP addresses. From e0c74159e0dc41d677dd3a548bec76dbdc800ab5 Mon Sep 17 00:00:00 2001 From: Xelu86 <103963494+Xelu86@users.noreply.github.com> Date: Wed, 26 Jul 2023 09:47:03 -0400 Subject: [PATCH 548/650] Text formatting, removed duplicate text --- docset/winserver2022-ps/hyper-v/Get-VHDSnapshot.md | 2 +- docset/winserver2022-ps/hyper-v/Remove-VHDSnapshot.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docset/winserver2022-ps/hyper-v/Get-VHDSnapshot.md b/docset/winserver2022-ps/hyper-v/Get-VHDSnapshot.md index 9da2cc9c2b..c47b011451 100644 --- a/docset/winserver2022-ps/hyper-v/Get-VHDSnapshot.md +++ b/docset/winserver2022-ps/hyper-v/Get-VHDSnapshot.md @@ -2,7 +2,7 @@ description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. external help file: Microsoft.HyperV.PowerShell.Cmdlets.dll-Help.xml Module Name: Hyper-V -ms.date: ms.date: 06/21/2023 +ms.date: 06/21/2023 online version: https://learn.microsoft.com/powershell/module/hyper-v/get-vhdsnapshot?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Get-VHDSnapshot diff --git a/docset/winserver2022-ps/hyper-v/Remove-VHDSnapshot.md b/docset/winserver2022-ps/hyper-v/Remove-VHDSnapshot.md index af961d272b..63e7f440f7 100644 --- a/docset/winserver2022-ps/hyper-v/Remove-VHDSnapshot.md +++ b/docset/winserver2022-ps/hyper-v/Remove-VHDSnapshot.md @@ -39,7 +39,6 @@ Checkpoint replaces the previous term, snapshot. ## EXAMPLES - ### Example 1: Remove a checkpoint ```powershell @@ -220,6 +219,7 @@ Accept wildcard characters: False ``` ### CommonParameters + This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see From 41a76ed57874075e95ca9690b3002d2b34e67b5d Mon Sep 17 00:00:00 2001 From: Xelu86 <103963494+Xelu86@users.noreply.github.com> Date: Wed, 26 Jul 2023 09:48:20 -0400 Subject: [PATCH 549/650] Text formatting, removed duplicate text --- docset/winserver2022-ps/hyper-v/Remove-VHDSnapshot.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/hyper-v/Remove-VHDSnapshot.md b/docset/winserver2022-ps/hyper-v/Remove-VHDSnapshot.md index 63e7f440f7..fe999de171 100644 --- a/docset/winserver2022-ps/hyper-v/Remove-VHDSnapshot.md +++ b/docset/winserver2022-ps/hyper-v/Remove-VHDSnapshot.md @@ -2,7 +2,7 @@ description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. external help file: Microsoft.HyperV.PowerShell.Cmdlets.dll-Help.xml Module Name: Hyper-V -ms.date: ms.date: 06/21/2023 +ms.date: 06/21/2023 online version: https://learn.microsoft.com/powershell/module/hyper-v/remove-vhdsnapshot?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Remove-VHDSnapshot From ee2da282c34ab38f8b1641597925106b2a8a90a3 Mon Sep 17 00:00:00 2001 From: Xelu86 <103963494+Xelu86@users.noreply.github.com> Date: Wed, 26 Jul 2023 10:16:49 -0400 Subject: [PATCH 550/650] Text formatting, removed duplicate text --- docset/winserver2022-ps/hyper-v/New-VFD.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/hyper-v/New-VFD.md b/docset/winserver2022-ps/hyper-v/New-VFD.md index 25e463aac6..3b17bd1234 100644 --- a/docset/winserver2022-ps/hyper-v/New-VFD.md +++ b/docset/winserver2022-ps/hyper-v/New-VFD.md @@ -2,7 +2,7 @@ description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. external help file: Microsoft.HyperV.PowerShell.Cmdlets.dll-Help.xml Module Name: Hyper-V -ms.date: ms.date: 06/21/2023 +ms.date: 06/21/2023 online version: https://learn.microsoft.com/powershell/module/hyper-v/new-vfd?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: New-VFD From 87e80523f61ccdfa1ccffbdca90fa7b9031adcf8 Mon Sep 17 00:00:00 2001 From: Xelu86 <103963494+Xelu86@users.noreply.github.com> Date: Thu, 27 Jul 2023 19:34:48 -0400 Subject: [PATCH 551/650] Applied text formatting --- docset/winserver2022-ps/hyper-v/Get-VHDSnapshot.md | 6 +++--- .../winserver2022-ps/hyper-v/Remove-VHDSnapshot.md | 14 +++++++------- 2 files changed, 10 insertions(+), 10 deletions(-) diff --git a/docset/winserver2022-ps/hyper-v/Get-VHDSnapshot.md b/docset/winserver2022-ps/hyper-v/Get-VHDSnapshot.md index c47b011451..edce0c0128 100644 --- a/docset/winserver2022-ps/hyper-v/Get-VHDSnapshot.md +++ b/docset/winserver2022-ps/hyper-v/Get-VHDSnapshot.md @@ -37,7 +37,7 @@ Get-VHDSnapshot -Path "Data01.vhds" -SnapshotId 6c87351a-a39a-4581-b231-6d693b26 ``` This command gets information about the checkpoint that has the specified ID from the VHD set file -named Data01.vhds in the current working folder. +named `Data01.vhds` in the current working folder. ## PARAMETERS @@ -63,8 +63,8 @@ Accept wildcard characters: False ### -ComputerName Specifies one or more Hyper-V hosts that run this command. NetBIOS names, IP addresses, and fully -qualified domain names are allowable. The default is the local computer. Use localhost or a dot (.) -to specify the local computer explicitly. +qualified domain names are allowable. The default is the local computer. Use `localhost` or a dot +(`.`) to specify the local computer explicitly. ```yaml Type: String[] diff --git a/docset/winserver2022-ps/hyper-v/Remove-VHDSnapshot.md b/docset/winserver2022-ps/hyper-v/Remove-VHDSnapshot.md index fe999de171..36931cc81a 100644 --- a/docset/winserver2022-ps/hyper-v/Remove-VHDSnapshot.md +++ b/docset/winserver2022-ps/hyper-v/Remove-VHDSnapshot.md @@ -19,16 +19,16 @@ Removes a checkpoint from a VHD set file. ``` Remove-VHDSnapshot [-Path] [-PersistReferencePoint] -SnapshotId [-AsJob] - [-CimSession ] [-ComputerName ] [-Credential ] [-WhatIf] - [-Confirm] [] + [-CimSession ] [-ComputerName ] [-Credential ] + [-WhatIf] [-Confirm] [] ``` ### VHDSnapshot ``` Remove-VHDSnapshot [-PersistReferencePoint] [-VHDSnapshot] [-AsJob] - [-CimSession ] [-ComputerName ] [-Credential ] [-WhatIf] - [-Confirm] [] + [-CimSession ] [-ComputerName ] [-Credential ] + [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -46,7 +46,7 @@ Remove-VHDSnapshot -Path "Data01.vhds" -SnapshotId 6c87351a-a39a-4581-b231-6d693 ``` This command removes the checkpoint that has the specified ID from the VHD set file named -Data01.vhds. +`Data01.vhds`. ## PARAMETERS @@ -88,8 +88,8 @@ Accept wildcard characters: False ### -ComputerName Specifies one or more Hyper-V hosts that run this cmdlet. NetBIOS names, IP addresses, and fully -qualified domain names are allowable. The default is the local computer. Use localhost or a dot (.) -to specify the local computer explicitly. +qualified domain names are allowable. The default is the local computer. Use `localhost` or a dot +(`.`) to specify the local computer explicitly. ```yaml Type: String[] From 8ba8aec3bb24d49fa5019ac659f4647cf1816b7d Mon Sep 17 00:00:00 2001 From: robinharwood <19212983+robinharwood@users.noreply.github.com> Date: Fri, 16 Jun 2023 16:20:07 +0100 Subject: [PATCH 552/650] Initial commit --- .../Get-ClusterAffinityRule.md | 129 +++++++++++ .../New-ClusterAffinityRule.md | 145 +++++++++++++ .../Remove-ClusterAffinityRule.md | 199 +++++++++++++++++ .../Set-ClusterAffinityRule.md | 201 ++++++++++++++++++ 4 files changed, 674 insertions(+) create mode 100644 docset/winserver2022-ps/failoverclusters/Get-ClusterAffinityRule.md create mode 100644 docset/winserver2022-ps/failoverclusters/New-ClusterAffinityRule.md create mode 100644 docset/winserver2022-ps/failoverclusters/Remove-ClusterAffinityRule.md create mode 100644 docset/winserver2022-ps/failoverclusters/Set-ClusterAffinityRule.md diff --git a/docset/winserver2022-ps/failoverclusters/Get-ClusterAffinityRule.md b/docset/winserver2022-ps/failoverclusters/Get-ClusterAffinityRule.md new file mode 100644 index 0000000000..871f33b832 --- /dev/null +++ b/docset/winserver2022-ps/failoverclusters/Get-ClusterAffinityRule.md @@ -0,0 +1,129 @@ +--- +description: Get-ClusterAffinityRule +external help file: ClusterAffinityRule.cdxml-help.xml +Module Name: FailoverClusters +ms.date: 07/26/2022 +online version: https://docs.microsoft.com/powershell/module/failoverclusters/get-clusteraffinityrule?view=windowsserver2022-ps&wt.mc_id=ps-gethelp +schema: 2.0.0 +title: Get-ClusterAffinityRule +--- + +# Get-ClusterAffinityRule + +## SYNOPSIS +This cmdlet is used to display the given rule and what type it is. + +## SYNTAX + +``` +Get-ClusterAffinityRule [[-Name] ] [-CimSession ] [-ThrottleLimit ] +[-AsJob] [] +``` + +## DESCRIPTION +This cmdlet is used to display the given rule and what type it is. If -Name is not specified, it +will list all rules. + +## EXAMPLES + +### Example 1 +```powershell +Get-ClusterAffinityRule -Name -Cluster Cluster1 +``` +## PARAMETERS + +### -AsJob +Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to +complete. + +The cmdlet immediately returns an object that represents the job and then displays the command +prompt. You can continue to work in the session while the job completes. To manage the job, use the +`*-Job` cmdlets. To get the job results, use the +[Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. + +For more information about Windows PowerShell background jobs, see +[about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CimSession +Runs the cmdlet in a remote session or on a remote computer. 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. The default is the +current session on the local computer. + +```yaml +Type: CimSession[] +Parameter Sets: (All) +Aliases: Session + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the desired affinity rule. if this is not provided, it will list all the rules. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ThrottleLimit +Specifies the maximum number of concurrent operations that can be established to run the cmdlet. 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. The throttle limit applies only to the current cmdlet, not to the session or to the +computer. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, +-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, +-WarningAction, and -WarningVariable. For more information, see +[about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String[] + +## OUTPUTS + +### Microsoft.Management.Infrastructure.CimInstance + +### Microsoft.Management.Infrastructure.CimInstance#root/MSCLUSTER/MSCluster_AffinityRule + +## NOTES + +## RELATED LINKS diff --git a/docset/winserver2022-ps/failoverclusters/New-ClusterAffinityRule.md b/docset/winserver2022-ps/failoverclusters/New-ClusterAffinityRule.md new file mode 100644 index 0000000000..bdb22cebed --- /dev/null +++ b/docset/winserver2022-ps/failoverclusters/New-ClusterAffinityRule.md @@ -0,0 +1,145 @@ +--- +description: New-ClusterAffinityRule +external help file: ClusterAffinityRule.cdxml-help.xml +Module Name: FailoverClusters +ms.date: 07/26/2022 +online version: https://docs.microsoft.com/powershell/module/failoverclusters/new-clusteraffinityrule?view=windowsserver2022-ps&wt.mc_id=ps-gethelp +schema: 2.0.0 +title: New-ClusterAffinityRule +--- + +# New-ClusterAffinityRule + +## SYNOPSIS +Creates new affinity rules. + +## SYNTAX + +``` +New-ClusterAffinityRule [-Name] [-RuleType ] [-CimSession ] + [-ThrottleLimit ] [-AsJob] [] +``` + +## DESCRIPTION +This cmdlet allows the creation of new affinity rules. There are four main types when creating a new +rule: SameFaultDomain | SameNode | DifferentFaultDomain | DifferentNode + +## EXAMPLES + +### Example 1 +```powershell +New-ClusterAffinityRule -Name -RuleType SameFaultDomain -Cluster Cluster1 +``` +## PARAMETERS + +### -AsJob +Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to +complete. + +The cmdlet immediately returns an object that represents the job and then displays the command +prompt. You can continue to work in the session while the job completes. To manage the job, use the +`*-Job` cmdlets. To get the job results, use the +[Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. + +For more information about Windows PowerShell background jobs, see +[about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CimSession +Runs the cmdlet in a remote session or on a remote computer. 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. The default is the +current session on the local computer. + +```yaml +Type: CimSession[] +Parameter Sets: (All) +Aliases: Session + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the rule to be created. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RuleType +The type of the rule to be created. + +```yaml +Type: RuleType +Parameter Sets: (All) +Aliases: +Accepted values: SameFaultDomain, SameNode, DifferentFaultDomain, DifferentNode + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ThrottleLimit +Specifies the maximum number of concurrent operations that can be established to run the cmdlet. 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. The throttle limit applies only to the current cmdlet, not to the session or to the +computer. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, +-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, +-WarningAction, and -WarningVariable. For more information, see +[about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Management.Infrastructure.CimInstance + +### Microsoft.Management.Infrastructure.CimInstance#root/MSCluster/MSCluster_AffinityRule + +## NOTES + +## RELATED LINKS diff --git a/docset/winserver2022-ps/failoverclusters/Remove-ClusterAffinityRule.md b/docset/winserver2022-ps/failoverclusters/Remove-ClusterAffinityRule.md new file mode 100644 index 0000000000..08823ad27b --- /dev/null +++ b/docset/winserver2022-ps/failoverclusters/Remove-ClusterAffinityRule.md @@ -0,0 +1,199 @@ +--- +description: Remove-ClusterAffinityRule +external help file: ClusterAffinityRule.cdxml-help.xml +Module Name: FailoverClusters +ms.date: 07/26/2022 +online version: https://docs.microsoft.com/powershell/module/failoverclusters/remove-clusteraffinityrule?view=windowsserver2022-ps&wt.mc_id=ps-gethelp +schema: 2.0.0 +title: Remove-ClusterAffinityRule +--- + +# Remove-ClusterAffinityRule + +## SYNOPSIS +Removes a specified affinity rule. + +## SYNTAX + +### Query (cdxml) (Default) +``` +Remove-ClusterAffinityRule [[-Name] ] [-CimSession ] [-ThrottleLimit ] [-AsJob] + [-PassThru] [-WhatIf] [-Confirm] [] +``` + +### InputObject (cdxml) +``` +Remove-ClusterAffinityRule -InputObject [-CimSession ] [-ThrottleLimit ] + [-AsJob] [-PassThru] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Removes a specified affinity rule. + +## EXAMPLES + +### Example 1 +```powershell +Remove-ClusterAffinityRule -Name -Cluster Cluster1 +``` +## PARAMETERS + +### -AsJob +Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to +complete. + +The cmdlet immediately returns an object that represents the job and then displays the command +prompt. You can continue to work in the session while the job completes. To manage the job, use the +`*-Job` cmdlets. To get the job results, use the +[Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. + +For more information about Windows PowerShell background jobs, see +[about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CimSession +Runs the cmdlet in a remote session or on a remote computer. 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. The default is the +current session on the local computer. + +```yaml +Type: CimSession[] +Parameter Sets: (All) +Aliases: Session + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Specifies the input object that is used in a pipeline command. + +```yaml +Type: CimInstance[] +Parameter Sets: InputObject (cdxml) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the affinity rule to delete. + +```yaml +Type: String[] +Parameter Sets: Query (cdxml) +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +Returns an object representing the item with which you are working. +By default, this cmdlet does not generate any output. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ThrottleLimit +Specifies the maximum number of concurrent operations that can be established to run the cmdlet. 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. The throttle limit applies only to the current cmdlet, not to the session or to the +computer. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, +-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, +-WarningAction, and -WarningVariable. For more information, see +[about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String[] + +### Microsoft.Management.Infrastructure.CimInstance[] + +## OUTPUTS + +### Microsoft.Management.Infrastructure.CimInstance + +### Microsoft.Management.Infrastructure.CimInstance#root/MSCLUSTER/MSCluster_AffinityRule + +## NOTES + +## RELATED LINKS diff --git a/docset/winserver2022-ps/failoverclusters/Set-ClusterAffinityRule.md b/docset/winserver2022-ps/failoverclusters/Set-ClusterAffinityRule.md new file mode 100644 index 0000000000..ccc0a5e24a --- /dev/null +++ b/docset/winserver2022-ps/failoverclusters/Set-ClusterAffinityRule.md @@ -0,0 +1,201 @@ +--- +description: Set-ClusterAffinityRule +external help file: ClusterAffinityRule.cdxml-help.xml +Module Name: FailoverClusters +ms.date: 07/26/2022 +online version: https://docs.microsoft.com/powershell/module/failoverclusters/set-clusteraffinityrule?view=windowsserver2022-ps&wt.mc_id=ps-gethelp +schema: 2.0.0 +title: Set-ClusterAffinityRule +--- + +# Set-ClusterAffinityRule + +## SYNOPSIS +Enabled or Disable an affinity rule, and update the rule type. + +## SYNTAX + +### Query (cdxml) (Default) +``` +Set-ClusterAffinityRule [[-Name] ] [-RuleType ] [-Enabled ] + [-CimSession ] [-ThrottleLimit ] [-AsJob] [-PassThru] [] +``` + +### InputObject (cdxml) +``` +Set-ClusterAffinityRule -InputObject [-RuleType ] [-Enabled ] + [-CimSession ] [-ThrottleLimit ] [-AsJob] [-PassThru] [] +``` + +## DESCRIPTION +This cmdlet is used to Enabled or Disable an affinity rule. This can also be used to change the +RuleType. + +## EXAMPLES + +### Example 1 +```powershell +Set-ClusterAffinityRule -Name MyRule -Enabled -Cluster MyCluster +``` + +## PARAMETERS + +### -AsJob +Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to +complete. + +The cmdlet immediately returns an object that represents the job and then displays the command +prompt. You can continue to work in the session while the job completes. To manage the job, use the +`*-Job` cmdlets. To get the job results, use the +[Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. + +For more information about Windows PowerShell background jobs, see +[about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CimSession +Runs the cmdlet in a remote session or on a remote computer. 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. The default is the +current session on the local computer. + +```yaml +Type: CimSession[] +Parameter Sets: (All) +Aliases: Session + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +Enables or disables the affinity rule. + +```yaml +Type: UInt32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Specifies the input object that is used in a pipeline command. + +```yaml +Type: CimInstance[] +Parameter Sets: InputObject (cdxml) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the affinity rule you want to either enable or disable. + +```yaml +Type: String[] +Parameter Sets: Query (cdxml) +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +Returns an object representing the item with which you are working. +By default, this cmdlet does not generate any output. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RuleType +The RuleType you want to set your affinity rule to. + +```yaml +Type: RuleType +Parameter Sets: (All) +Aliases: +Accepted values: SameFaultDomain, SameNode, DifferentFaultDomain, DifferentNode + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ThrottleLimit +Specifies the maximum number of concurrent operations that can be established to run the cmdlet. 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. The throttle limit applies only to the current cmdlet, not to the session or to the +computer. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, +-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, +-WarningAction, and -WarningVariable. For more information, see +[about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String[] + +### Microsoft.Management.Infrastructure.CimInstance[] + +## OUTPUTS + +### Microsoft.Management.Infrastructure.CimInstance + +### Microsoft.Management.Infrastructure.CimInstance#root/MSCLUSTER/MSCluster_AffinityRule + +## NOTES + +## RELATED LINKS From dfaa11773cea4d93f5446e550a8449d104acd620 Mon Sep 17 00:00:00 2001 From: robinharwood <19212983+robinharwood@users.noreply.github.com> Date: Tue, 11 Jul 2023 15:02:52 +0100 Subject: [PATCH 553/650] Updated examples and RuleType parameter text --- .../failoverclusters/Get-ClusterAffinityRule.md | 6 +++++- .../failoverclusters/New-ClusterAffinityRule.md | 14 ++++++++++++-- .../failoverclusters/Remove-ClusterAffinityRule.md | 2 +- .../failoverclusters/Set-ClusterAffinityRule.md | 10 ++++++++-- 4 files changed, 26 insertions(+), 6 deletions(-) diff --git a/docset/winserver2022-ps/failoverclusters/Get-ClusterAffinityRule.md b/docset/winserver2022-ps/failoverclusters/Get-ClusterAffinityRule.md index 871f33b832..f8f7405d4c 100644 --- a/docset/winserver2022-ps/failoverclusters/Get-ClusterAffinityRule.md +++ b/docset/winserver2022-ps/failoverclusters/Get-ClusterAffinityRule.md @@ -28,8 +28,12 @@ will list all rules. ### Example 1 ```powershell -Get-ClusterAffinityRule -Name -Cluster Cluster1 +Get-ClusterAffinityRule -Name AffinityRule1 -Cluster Cluster1 ``` + +This example returns information about the cluster affinity rule with the name `Rule1` from +`Cluster1`. + ## PARAMETERS ### -AsJob diff --git a/docset/winserver2022-ps/failoverclusters/New-ClusterAffinityRule.md b/docset/winserver2022-ps/failoverclusters/New-ClusterAffinityRule.md index bdb22cebed..b6a318347d 100644 --- a/docset/winserver2022-ps/failoverclusters/New-ClusterAffinityRule.md +++ b/docset/winserver2022-ps/failoverclusters/New-ClusterAffinityRule.md @@ -28,8 +28,12 @@ rule: SameFaultDomain | SameNode | DifferentFaultDomain | DifferentNode ### Example 1 ```powershell -New-ClusterAffinityRule -Name -RuleType SameFaultDomain -Cluster Cluster1 +New-ClusterAffinityRule -Name AffinityRule1 -RuleType SameFaultDomain -Cluster Cluster1 ``` + +This command creates a new affinity rule for `Cluster1` to ensure resources stay within the same +fault domain. + ## PARAMETERS ### -AsJob @@ -90,7 +94,13 @@ Accept wildcard characters: False ``` ### -RuleType -The type of the rule to be created. +The type of the rule you want to set your affinity rule to. The acceptable values for this parameter +are: + +- **SameFaultDomain**. Resources must stay within the same fault domain. +- **SameNode**. Resources must stay on the same cluster node. +- **DifferentFaultDomain**. Resources will always stay in different fault domain (anti-affinity). +- **DifferentNode**. Resources will always stay on different cluster nodes (anti-affinity). ```yaml Type: RuleType diff --git a/docset/winserver2022-ps/failoverclusters/Remove-ClusterAffinityRule.md b/docset/winserver2022-ps/failoverclusters/Remove-ClusterAffinityRule.md index 08823ad27b..af56ade30e 100644 --- a/docset/winserver2022-ps/failoverclusters/Remove-ClusterAffinityRule.md +++ b/docset/winserver2022-ps/failoverclusters/Remove-ClusterAffinityRule.md @@ -34,7 +34,7 @@ Removes a specified affinity rule. ### Example 1 ```powershell -Remove-ClusterAffinityRule -Name -Cluster Cluster1 +Remove-ClusterAffinityRule -Name AffinityRule1 -Cluster Cluster1 ``` ## PARAMETERS diff --git a/docset/winserver2022-ps/failoverclusters/Set-ClusterAffinityRule.md b/docset/winserver2022-ps/failoverclusters/Set-ClusterAffinityRule.md index ccc0a5e24a..d982bfbb4b 100644 --- a/docset/winserver2022-ps/failoverclusters/Set-ClusterAffinityRule.md +++ b/docset/winserver2022-ps/failoverclusters/Set-ClusterAffinityRule.md @@ -35,7 +35,7 @@ RuleType. ### Example 1 ```powershell -Set-ClusterAffinityRule -Name MyRule -Enabled -Cluster MyCluster +Set-ClusterAffinityRule -Name AffinityRule1 -Enabled -Cluster Cluster1 ``` ## PARAMETERS @@ -144,7 +144,13 @@ Accept wildcard characters: False ``` ### -RuleType -The RuleType you want to set your affinity rule to. +The type of the rule you want to set your affinity rule to. The acceptable values for this parameter +are: + +- **SameFaultDomain**. Resources must stay within the same fault domain. +- **SameNode**. Resources must stay on the same cluster node. +- **DifferentFaultDomain**. Resources will always stay in different fault domain (anti-affinity). +- **DifferentNode**. Resources will always stay on different cluster nodes (anti-affinity). ```yaml Type: RuleType From 940400336480910aa4c744014e8c92b6eb665184 Mon Sep 17 00:00:00 2001 From: robinharwood <19212983+robinharwood@users.noreply.github.com> Date: Thu, 27 Jul 2023 14:25:09 +0100 Subject: [PATCH 554/650] Formatting updates --- .../Get-ClusterAffinityRule.md | 15 ++++++--- .../New-ClusterAffinityRule.md | 12 +++++-- .../Remove-ClusterAffinityRule.md | 32 ++++++++++++++----- .../Set-ClusterAffinityRule.md | 21 ++++++++++-- 4 files changed, 63 insertions(+), 17 deletions(-) diff --git a/docset/winserver2022-ps/failoverclusters/Get-ClusterAffinityRule.md b/docset/winserver2022-ps/failoverclusters/Get-ClusterAffinityRule.md index f8f7405d4c..220c68f51d 100644 --- a/docset/winserver2022-ps/failoverclusters/Get-ClusterAffinityRule.md +++ b/docset/winserver2022-ps/failoverclusters/Get-ClusterAffinityRule.md @@ -3,7 +3,7 @@ description: Get-ClusterAffinityRule external help file: ClusterAffinityRule.cdxml-help.xml Module Name: FailoverClusters ms.date: 07/26/2022 -online version: https://docs.microsoft.com/powershell/module/failoverclusters/get-clusteraffinityrule?view=windowsserver2022-ps&wt.mc_id=ps-gethelp +online version: https://learn.microsoft.com/powershell/module/failoverclusters/get-clusteraffinityrule?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Get-ClusterAffinityRule --- @@ -17,16 +17,18 @@ This cmdlet is used to display the given rule and what type it is. ``` Get-ClusterAffinityRule [[-Name] ] [-CimSession ] [-ThrottleLimit ] -[-AsJob] [] + [-AsJob] [] ``` ## DESCRIPTION -This cmdlet is used to display the given rule and what type it is. If -Name is not specified, it + +This cmdlet is used to display the given rule and what type it is. If -Name isn't specified, it will list all rules. ## EXAMPLES ### Example 1 + ```powershell Get-ClusterAffinityRule -Name AffinityRule1 -Cluster Cluster1 ``` @@ -37,6 +39,7 @@ This example returns information about the cluster affinity rule with the name ` ## PARAMETERS ### -AsJob + Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. @@ -61,6 +64,7 @@ Accept wildcard characters: False ``` ### -CimSession + Runs the cmdlet in a remote session or on a remote computer. 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. The default is the @@ -79,7 +83,8 @@ Accept wildcard characters: False ``` ### -Name -The name of the desired affinity rule. if this is not provided, it will list all the rules. + +The name of the desired affinity rule. if this isn't provided, it will list all the rules. ```yaml Type: String[] @@ -94,6 +99,7 @@ Accept wildcard characters: False ``` ### -ThrottleLimit + Specifies the maximum number of concurrent operations that can be established to run the cmdlet. 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 @@ -113,6 +119,7 @@ Accept wildcard characters: False ``` ### CommonParameters + This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see diff --git a/docset/winserver2022-ps/failoverclusters/New-ClusterAffinityRule.md b/docset/winserver2022-ps/failoverclusters/New-ClusterAffinityRule.md index b6a318347d..d6889f0674 100644 --- a/docset/winserver2022-ps/failoverclusters/New-ClusterAffinityRule.md +++ b/docset/winserver2022-ps/failoverclusters/New-ClusterAffinityRule.md @@ -3,7 +3,7 @@ description: New-ClusterAffinityRule external help file: ClusterAffinityRule.cdxml-help.xml Module Name: FailoverClusters ms.date: 07/26/2022 -online version: https://docs.microsoft.com/powershell/module/failoverclusters/new-clusteraffinityrule?view=windowsserver2022-ps&wt.mc_id=ps-gethelp +online version: https://learn.microsoft.com/powershell/module/failoverclusters/new-clusteraffinityrule?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: New-ClusterAffinityRule --- @@ -11,7 +11,7 @@ title: New-ClusterAffinityRule # New-ClusterAffinityRule ## SYNOPSIS -Creates new affinity rules. +Creates new affinity rules. ## SYNTAX @@ -21,12 +21,14 @@ New-ClusterAffinityRule [-Name] [-RuleType ] [-CimSession ] [-CimSession ] [-ThrottleLimit ] [-AsJob] - [-PassThru] [-WhatIf] [-Confirm] [] +Remove-ClusterAffinityRule [[-Name] ] [-CimSession ] + [-ThrottleLimit ] [-AsJob] [-PassThru] [-WhatIf] [-Confirm] [] ``` ### InputObject (cdxml) + ``` -Remove-ClusterAffinityRule -InputObject [-CimSession ] [-ThrottleLimit ] - [-AsJob] [-PassThru] [-WhatIf] [-Confirm] [] +Remove-ClusterAffinityRule -InputObject [-CimSession ] + [-ThrottleLimit ] [-AsJob] [-PassThru] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION + Removes a specified affinity rule. ## EXAMPLES ### Example 1 + ```powershell Remove-ClusterAffinityRule -Name AffinityRule1 -Cluster Cluster1 ``` + +This example removes the cluster affinity rule named AffinityRule1. + ## PARAMETERS ### -AsJob + Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. @@ -63,6 +71,7 @@ Accept wildcard characters: False ``` ### -CimSession + Runs the cmdlet in a remote session or on a remote computer. 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. The default is the @@ -81,6 +90,7 @@ Accept wildcard characters: False ``` ### -InputObject + Specifies the input object that is used in a pipeline command. ```yaml @@ -96,6 +106,7 @@ Accept wildcard characters: False ``` ### -Name + The name of the affinity rule to delete. ```yaml @@ -111,8 +122,9 @@ Accept wildcard characters: False ``` ### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. + +Returns an object representing the item with which you are working. By default, this cmdlet doesn't +generate any output. ```yaml Type: SwitchParameter @@ -127,6 +139,7 @@ Accept wildcard characters: False ``` ### -ThrottleLimit + Specifies the maximum number of concurrent operations that can be established to run the cmdlet. 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 @@ -146,6 +159,7 @@ Accept wildcard characters: False ``` ### -Confirm + Prompts you for confirmation before running the cmdlet. ```yaml @@ -161,8 +175,9 @@ Accept wildcard characters: False ``` ### -WhatIf + Shows what would happen if the cmdlet runs. -The cmdlet is not run. +The cmdlet isn't run. ```yaml Type: SwitchParameter @@ -177,6 +192,7 @@ Accept wildcard characters: False ``` ### CommonParameters + This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see diff --git a/docset/winserver2022-ps/failoverclusters/Set-ClusterAffinityRule.md b/docset/winserver2022-ps/failoverclusters/Set-ClusterAffinityRule.md index d982bfbb4b..e1bfa8a448 100644 --- a/docset/winserver2022-ps/failoverclusters/Set-ClusterAffinityRule.md +++ b/docset/winserver2022-ps/failoverclusters/Set-ClusterAffinityRule.md @@ -3,7 +3,7 @@ description: Set-ClusterAffinityRule external help file: ClusterAffinityRule.cdxml-help.xml Module Name: FailoverClusters ms.date: 07/26/2022 -online version: https://docs.microsoft.com/powershell/module/failoverclusters/set-clusteraffinityrule?view=windowsserver2022-ps&wt.mc_id=ps-gethelp +online version: https://learn.microsoft.com/powershell/module/failoverclusters/set-clusteraffinityrule?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Set-ClusterAffinityRule --- @@ -16,31 +16,38 @@ Enabled or Disable an affinity rule, and update the rule type. ## SYNTAX ### Query (cdxml) (Default) + ``` Set-ClusterAffinityRule [[-Name] ] [-RuleType ] [-Enabled ] [-CimSession ] [-ThrottleLimit ] [-AsJob] [-PassThru] [] ``` ### InputObject (cdxml) + ``` Set-ClusterAffinityRule -InputObject [-RuleType ] [-Enabled ] [-CimSession ] [-ThrottleLimit ] [-AsJob] [-PassThru] [] ``` ## DESCRIPTION + This cmdlet is used to Enabled or Disable an affinity rule. This can also be used to change the RuleType. ## EXAMPLES ### Example 1 + ```powershell Set-ClusterAffinityRule -Name AffinityRule1 -Enabled -Cluster Cluster1 ``` +This example enables the cluster affinity rule named AffinityRule1. + ## PARAMETERS ### -AsJob + Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. @@ -65,6 +72,7 @@ Accept wildcard characters: False ``` ### -CimSession + Runs the cmdlet in a remote session or on a remote computer. 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. The default is the @@ -83,6 +91,7 @@ Accept wildcard characters: False ``` ### -Enabled + Enables or disables the affinity rule. ```yaml @@ -98,6 +107,7 @@ Accept wildcard characters: False ``` ### -InputObject + Specifies the input object that is used in a pipeline command. ```yaml @@ -113,6 +123,7 @@ Accept wildcard characters: False ``` ### -Name + The name of the affinity rule you want to either enable or disable. ```yaml @@ -128,8 +139,9 @@ Accept wildcard characters: False ``` ### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. + +Returns an object representing the item with which you are working. By default, this cmdlet doesn't +generate any output. ```yaml Type: SwitchParameter @@ -144,6 +156,7 @@ Accept wildcard characters: False ``` ### -RuleType + The type of the rule you want to set your affinity rule to. The acceptable values for this parameter are: @@ -166,6 +179,7 @@ Accept wildcard characters: False ``` ### -ThrottleLimit + Specifies the maximum number of concurrent operations that can be established to run the cmdlet. 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 @@ -185,6 +199,7 @@ Accept wildcard characters: False ``` ### CommonParameters + This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see From 1910ca49ea32f56622e79c0a82dd143f035233cf Mon Sep 17 00:00:00 2001 From: robinharwood <19212983+robinharwood@users.noreply.github.com> Date: Thu, 27 Jul 2023 14:46:39 +0100 Subject: [PATCH 555/650] Adding new commands to module file --- .../failoverclusters/FailoverClusters.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/docset/winserver2022-ps/failoverclusters/FailoverClusters.md b/docset/winserver2022-ps/failoverclusters/FailoverClusters.md index 0884b5a781..6659968e2b 100644 --- a/docset/winserver2022-ps/failoverclusters/FailoverClusters.md +++ b/docset/winserver2022-ps/failoverclusters/FailoverClusters.md @@ -101,6 +101,9 @@ Gets information about one or more failover clusters in a given domain. ### [Get-ClusterAccess](./Get-ClusterAccess.md) Gets information about permissions that control access to a failover cluster. +### [Get-ClusterAffinityRule](./Get-ClusterAffinityRule.md) +This cmdlet is used to display the given rule and what type it is. + ### [Get-ClusterAvailableDisk](./Get-ClusterAvailableDisk.md) Gets information about the disks that can support Failover Clustering and are visible to all nodes, but aren't yet part of the set of clustered disks. @@ -192,6 +195,9 @@ Moves the ownership of a clustered virtual machine to a different node. ### [New-Cluster](./New-Cluster.md) Creates a new failover cluster. +### [New-ClusterAffinityRule](./New-ClusterAffinityRule.md) +Creates new affinity rules. + ### [New-ClusterFaultDomain](./New-ClusterFaultDomain.md) Creates a fault domain in the cluster. @@ -207,6 +213,9 @@ Destroys an existing failover cluster. ### [Remove-ClusterAccess](./Remove-ClusterAccess.md) Removes a user from the access list on the cluster. +### [Remove-ClusterAffinityRule](./Remove-ClusterAffinityRule.md) +Removes new affinity rules. + ### [Remove-ClusterCheckpoint](./Remove-ClusterCheckpoint.md) Removes a cryptographic key checkpoint or registry checkpoint for a resource. @@ -257,6 +266,9 @@ Resumes a node from the paused state or brings back drained workloads to the nod ### [Resume-ClusterResource](./Resume-ClusterResource.md) Turns off maintenance for a disk resource or Cluster Shared Volume within a failover cluster. +### [Set-ClusterAffinityRule](./Set-ClusterAffinityRule.md) +Enabled or Disable an affinity rule, and update the rule type. + ### [Set-ClusterFaultDomain](./Set-ClusterFaultDomain.md) Update an existing cluster fault domain. From c9a95a9f6434ede4eab8e4b9c043199b61e619e3 Mon Sep 17 00:00:00 2001 From: robinharwood <19212983+robinharwood@users.noreply.github.com> Date: Thu, 27 Jul 2023 14:53:26 +0100 Subject: [PATCH 556/650] Updating ms.date --- .../failoverclusters/Get-ClusterAffinityRule.md | 2 +- .../failoverclusters/New-ClusterAffinityRule.md | 2 +- .../failoverclusters/Remove-ClusterAffinityRule.md | 2 +- .../failoverclusters/Set-ClusterAffinityRule.md | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docset/winserver2022-ps/failoverclusters/Get-ClusterAffinityRule.md b/docset/winserver2022-ps/failoverclusters/Get-ClusterAffinityRule.md index 220c68f51d..ae4f9ad5a3 100644 --- a/docset/winserver2022-ps/failoverclusters/Get-ClusterAffinityRule.md +++ b/docset/winserver2022-ps/failoverclusters/Get-ClusterAffinityRule.md @@ -2,7 +2,7 @@ description: Get-ClusterAffinityRule external help file: ClusterAffinityRule.cdxml-help.xml Module Name: FailoverClusters -ms.date: 07/26/2022 +ms.date: 07/27/2023 online version: https://learn.microsoft.com/powershell/module/failoverclusters/get-clusteraffinityrule?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Get-ClusterAffinityRule diff --git a/docset/winserver2022-ps/failoverclusters/New-ClusterAffinityRule.md b/docset/winserver2022-ps/failoverclusters/New-ClusterAffinityRule.md index d6889f0674..9fdcfa977c 100644 --- a/docset/winserver2022-ps/failoverclusters/New-ClusterAffinityRule.md +++ b/docset/winserver2022-ps/failoverclusters/New-ClusterAffinityRule.md @@ -2,7 +2,7 @@ description: New-ClusterAffinityRule external help file: ClusterAffinityRule.cdxml-help.xml Module Name: FailoverClusters -ms.date: 07/26/2022 +ms.date: 07/27/2023 online version: https://learn.microsoft.com/powershell/module/failoverclusters/new-clusteraffinityrule?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: New-ClusterAffinityRule diff --git a/docset/winserver2022-ps/failoverclusters/Remove-ClusterAffinityRule.md b/docset/winserver2022-ps/failoverclusters/Remove-ClusterAffinityRule.md index c030dd6044..fc7ce18c25 100644 --- a/docset/winserver2022-ps/failoverclusters/Remove-ClusterAffinityRule.md +++ b/docset/winserver2022-ps/failoverclusters/Remove-ClusterAffinityRule.md @@ -2,7 +2,7 @@ description: Remove-ClusterAffinityRule external help file: ClusterAffinityRule.cdxml-help.xml Module Name: FailoverClusters -ms.date: 07/26/2022 +ms.date: 07/27/2023 online version: https://learn.microsoft.com/powershell/module/failoverclusters/remove-clusteraffinityrule?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Remove-ClusterAffinityRule diff --git a/docset/winserver2022-ps/failoverclusters/Set-ClusterAffinityRule.md b/docset/winserver2022-ps/failoverclusters/Set-ClusterAffinityRule.md index e1bfa8a448..8fbda4ecca 100644 --- a/docset/winserver2022-ps/failoverclusters/Set-ClusterAffinityRule.md +++ b/docset/winserver2022-ps/failoverclusters/Set-ClusterAffinityRule.md @@ -2,7 +2,7 @@ description: Set-ClusterAffinityRule external help file: ClusterAffinityRule.cdxml-help.xml Module Name: FailoverClusters -ms.date: 07/26/2022 +ms.date: 07/27/2023 online version: https://learn.microsoft.com/powershell/module/failoverclusters/set-clusteraffinityrule?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Set-ClusterAffinityRule From 02773d698c6858b4da5eb469222511e5132442de Mon Sep 17 00:00:00 2001 From: Michael Lombardi Date: Mon, 31 Jul 2023 08:57:26 -0500 Subject: [PATCH 557/650] (MAINT) Fix `*-VHDSnapshot` for updateable help Prior to this change, the `*-VHDSnapshot` cmdlet reference docs included the links in the related links section as list items, which broke the updateable help build. This change returns the links to one-link-per-paragraph instead. --- docset/winserver2022-ps/hyper-v/Get-VHDSnapshot.md | 2 +- docset/winserver2022-ps/hyper-v/Remove-VHDSnapshot.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docset/winserver2022-ps/hyper-v/Get-VHDSnapshot.md b/docset/winserver2022-ps/hyper-v/Get-VHDSnapshot.md index edce0c0128..465d0e5466 100644 --- a/docset/winserver2022-ps/hyper-v/Get-VHDSnapshot.md +++ b/docset/winserver2022-ps/hyper-v/Get-VHDSnapshot.md @@ -166,4 +166,4 @@ This cmdlet returns a **VHDSnapshotInfo** object. ## RELATED LINKS -- [Remove-VHDSnapshot](remove-vhdsnapshot.md) +[Remove-VHDSnapshot](remove-vhdsnapshot.md) diff --git a/docset/winserver2022-ps/hyper-v/Remove-VHDSnapshot.md b/docset/winserver2022-ps/hyper-v/Remove-VHDSnapshot.md index 36931cc81a..fdf96ea135 100644 --- a/docset/winserver2022-ps/hyper-v/Remove-VHDSnapshot.md +++ b/docset/winserver2022-ps/hyper-v/Remove-VHDSnapshot.md @@ -239,4 +239,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -- [Get-VHDSnapshot](get-vhdsnapshot.md) +[Get-VHDSnapshot](get-vhdsnapshot.md) From 652a9c6689386e9d50dff769dbd9803c5eb41088 Mon Sep 17 00:00:00 2001 From: Xelu86 <103963494+Xelu86@users.noreply.github.com> Date: Mon, 31 Jul 2023 11:12:17 -0400 Subject: [PATCH 558/650] Additional text formatting --- docset/winserver2022-ps/hyper-v/New-VFD.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/hyper-v/New-VFD.md b/docset/winserver2022-ps/hyper-v/New-VFD.md index 3b17bd1234..47a4279312 100644 --- a/docset/winserver2022-ps/hyper-v/New-VFD.md +++ b/docset/winserver2022-ps/hyper-v/New-VFD.md @@ -60,7 +60,7 @@ Accept wildcard characters: False Specifies one or more virtual machine hosts on which the virtual floppy disk is to be created. NetBIOS names, IP addresses, and fully qualified domain names are allowable. The default is the -local computer. Use localhost or a dot (.) to specify the local computer explicitly. +local computer. Use `localhost` or a dot (`.`) to specify the local computer explicitly. ```yaml Type: String[] From 548f9659668a886a60eaa3b41ba6f4adeb2aee75 Mon Sep 17 00:00:00 2001 From: Xelu86 <103963494+Xelu86@users.noreply.github.com> Date: Mon, 31 Jul 2023 12:39:51 -0400 Subject: [PATCH 559/650] Related links formatting --- docset/winserver2022-ps/hyper-v/New-VFD.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/hyper-v/New-VFD.md b/docset/winserver2022-ps/hyper-v/New-VFD.md index 47a4279312..3716e82dfd 100644 --- a/docset/winserver2022-ps/hyper-v/New-VFD.md +++ b/docset/winserver2022-ps/hyper-v/New-VFD.md @@ -158,4 +158,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -- [Set-VMFloppyDiskDrive](set-vmfloppydiskdrive.md) +[Set-VMFloppyDiskDrive](set-vmfloppydiskdrive.md) From 2d7554c8c44a870b8470f424b3678b6176d7bbae Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Sun, 6 Aug 2023 06:36:06 +0530 Subject: [PATCH 560/650] Update Enable-WebCentralCertProvider.md Fixed description of Password --- .../webadministration/Enable-WebCentralCertProvider.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/webadministration/Enable-WebCentralCertProvider.md b/docset/winserver2022-ps/webadministration/Enable-WebCentralCertProvider.md index f103b0a664..b40ba39650 100644 --- a/docset/winserver2022-ps/webadministration/Enable-WebCentralCertProvider.md +++ b/docset/winserver2022-ps/webadministration/Enable-WebCentralCertProvider.md @@ -51,7 +51,7 @@ Accept wildcard characters: False ``` ### -Password -Specifies the name of the user account that is used to access the central certificate store. +Specifies the password of the user account that is used to access the central certificate store. ```yaml Type: String From 32f8d8519a4778028ec0b0faccf147e71946cd49 Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Sun, 6 Aug 2023 06:38:13 +0530 Subject: [PATCH 561/650] Update Enable-WebCentralCertProvider.md Fixes 2012 version --- .../webadministration/Enable-WebCentralCertProvider.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2012-ps/webadministration/Enable-WebCentralCertProvider.md b/docset/winserver2012-ps/webadministration/Enable-WebCentralCertProvider.md index 6d77260fa0..4d79e7d004 100644 --- a/docset/winserver2012-ps/webadministration/Enable-WebCentralCertProvider.md +++ b/docset/winserver2012-ps/webadministration/Enable-WebCentralCertProvider.md @@ -48,7 +48,7 @@ Accept wildcard characters: False ``` ### -Password -Name of the user account that is used to access the central certificate store. +Password of the user account that is used to access the central certificate store. ```yaml Type: String From d0f64da6f10aa527ec3d55739fe175d79ec97736 Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Sun, 6 Aug 2023 06:38:28 +0530 Subject: [PATCH 562/650] Update Enable-WebCentralCertProvider.md fixes 2016 --- .../webadministration/Enable-WebCentralCertProvider.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2016-ps/webadministration/Enable-WebCentralCertProvider.md b/docset/winserver2016-ps/webadministration/Enable-WebCentralCertProvider.md index 4785645ad1..5623848677 100644 --- a/docset/winserver2016-ps/webadministration/Enable-WebCentralCertProvider.md +++ b/docset/winserver2016-ps/webadministration/Enable-WebCentralCertProvider.md @@ -51,7 +51,7 @@ Accept wildcard characters: False ``` ### -Password -Specifies the name of the user account that is used to access the central certificate store. +Specifies the password of the user account that is used to access the central certificate store. ```yaml Type: String From 2f55d760c9e73273b8dd1cc80d9001690e4582ee Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Sun, 6 Aug 2023 06:38:45 +0530 Subject: [PATCH 563/650] Update Enable-WebCentralCertProvider.md fixes 2019 --- .../webadministration/Enable-WebCentralCertProvider.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2019-ps/webadministration/Enable-WebCentralCertProvider.md b/docset/winserver2019-ps/webadministration/Enable-WebCentralCertProvider.md index 803f80ec4d..a261f7e0b6 100644 --- a/docset/winserver2019-ps/webadministration/Enable-WebCentralCertProvider.md +++ b/docset/winserver2019-ps/webadministration/Enable-WebCentralCertProvider.md @@ -51,7 +51,7 @@ Accept wildcard characters: False ``` ### -Password -Specifies the name of the user account that is used to access the central certificate store. +Specifies the password of the user account that is used to access the central certificate store. ```yaml Type: String From 032a22446ed7ab34fd376811f09f089f85537c9c Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Sun, 6 Aug 2023 06:39:03 +0530 Subject: [PATCH 564/650] Update Enable-WebCentralCertProvider.md fixes 2012 R2 --- .../webadministration/Enable-WebCentralCertProvider.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2012r2-ps/webadministration/Enable-WebCentralCertProvider.md b/docset/winserver2012r2-ps/webadministration/Enable-WebCentralCertProvider.md index a79d8c63b0..3874146972 100644 --- a/docset/winserver2012r2-ps/webadministration/Enable-WebCentralCertProvider.md +++ b/docset/winserver2012r2-ps/webadministration/Enable-WebCentralCertProvider.md @@ -50,7 +50,7 @@ Accept wildcard characters: False ``` ### -Password -Specifies the name of the user account that is used to access the central certificate store. +Specifies the password of the user account that is used to access the central certificate store. ```yaml Type: String From 67d8ff69a503b97ed3bd6223c1aa953fae095492 Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Sun, 6 Aug 2023 06:56:39 +0530 Subject: [PATCH 565/650] Update Set-MpPreference.md Added OobeEnableRtpAndSigUpdate --- .../defender/Set-MpPreference.md | 21 +++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/docset/winserver2022-ps/defender/Set-MpPreference.md b/docset/winserver2022-ps/defender/Set-MpPreference.md index c141beece3..e2d0d26e5f 100644 --- a/docset/winserver2022-ps/defender/Set-MpPreference.md +++ b/docset/winserver2022-ps/defender/Set-MpPreference.md @@ -54,6 +54,7 @@ Set-MpPreference [-ExclusionPath ] [-ExclusionExtension ] [- [-AttackSurfaceReductionRules_Actions ] [-EnableLowCpuPriority ] [-EnableFileHashComputation ] [-EnableFullScanOnBatteryPower ] [-ProxyPacUrl ] [-ProxyServer ] [-ProxyBypass ] [-ForceUseProxyOnly ] + [-OobeEnableRtpAndSigUpdate ] [-DisableTlsParsing ] [-DisableHttpParsing ] [-DisableDnsParsing ] [-DisableDnsOverTcpParsing ] [-DisableSshParsing ] [-PlatformUpdatesChannel ] [-EngineUpdatesChannel ] @@ -1057,6 +1058,26 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -OobeEnableRtpAndSigUpdate + +This setting allows you to configure whether real-time protection and Security Intelligence Updates are enabled during OOBE (Out of Box experience). + +Valid values are: +True - If you enable this setting, real-time protection and Security Intelligence Updates are enabled during OOBE. +False - (Default) If you either disable or don't configure this setting, real-time protection and Security Intelligence Updates during OOBE aren't enabled. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -PlatformUpdatesChannel Specifies when devices receive Microsoft Defender platform updates during the monthly gradual rollout. From a2a9bad877aa20d810502ac53a8c7b14f63882f2 Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Sun, 6 Aug 2023 06:58:48 +0530 Subject: [PATCH 566/650] Update Set-MpPreference.md Fixing 2016 version of the document --- .../defender/Set-MpPreference.md | 21 +++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/docset/winserver2016-ps/defender/Set-MpPreference.md b/docset/winserver2016-ps/defender/Set-MpPreference.md index d1f05b02b8..2cdac54472 100644 --- a/docset/winserver2016-ps/defender/Set-MpPreference.md +++ b/docset/winserver2016-ps/defender/Set-MpPreference.md @@ -34,6 +34,7 @@ Set-MpPreference [-ExclusionPath ] [-ExclusionExtension ] [- [-DisableRealtimeMonitoring ] [-DisableScriptScanning ] [-DisableArchiveScanning ] [-DisableCatchupFullScan ] [-DisableCatchupQuickScan ] [-DisableCpuThrottleOnIdleScans ] [-DisableEmailScanning ] [-DisableRemovableDriveScanning ] [-DisableRestorePoint ] + [-OobeEnableRtpAndSigUpdate ] [-DisableScanningMappedNetworkDrivesForFullScan ] [-DisableScanningNetworkFiles ] [-UILockdown ] [-ThreatIDDefaultAction_Ids ] [-AllowSwitchToAsyncInspection ] [-ThreatIDDefaultAction_Actions ] [-UnknownThreatDefaultAction ] @@ -585,6 +586,26 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -OobeEnableRtpAndSigUpdate + +This setting allows you to configure whether real-time protection and Security Intelligence Updates are enabled during OOBE (Out of Box experience). + +Valid values are: +True - If you enable this setting, real-time protection and Security Intelligence Updates are enabled during OOBE. +False - (Default) If you either disable or don't configure this setting, real-time protection and Security Intelligence Updates during OOBE aren't enabled. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -PUAProtection ```yaml From fa230e00ff2353372e7e07662edc0700de977349 Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Sun, 6 Aug 2023 06:59:38 +0530 Subject: [PATCH 567/650] Update Set-MpPreference.md Fixed 2019 version of the document --- .../defender/Set-MpPreference.md | 21 +++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/docset/winserver2019-ps/defender/Set-MpPreference.md b/docset/winserver2019-ps/defender/Set-MpPreference.md index d40e8e5493..a7a2197fc3 100644 --- a/docset/winserver2019-ps/defender/Set-MpPreference.md +++ b/docset/winserver2019-ps/defender/Set-MpPreference.md @@ -37,6 +37,7 @@ Set-MpPreference [-ExclusionPath ] [-ExclusionExtension ] [- [-DisableEmailScanning ] [-DisableRemovableDriveScanning ] [-DisableRestorePoint ] [-DisableScanningMappedNetworkDrivesForFullScan ] [-DisableScanningNetworkFiles ] + [-OobeEnableRtpAndSigUpdate ] [-UILockdown ] [-ThreatIDDefaultAction_Ids ] [-ThreatIDDefaultAction_Actions ] [-UnknownThreatDefaultAction ] [-LowThreatDefaultAction ] [-ModerateThreatDefaultAction ] @@ -688,6 +689,26 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -OobeEnableRtpAndSigUpdate + +This setting allows you to configure whether real-time protection and Security Intelligence Updates are enabled during OOBE (Out of Box experience). + +Valid values are: +True - If you enable this setting, real-time protection and Security Intelligence Updates are enabled during OOBE. +False - (Default) If you either disable or don't configure this setting, real-time protection and Security Intelligence Updates during OOBE aren't enabled. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -PUAProtection ```yaml From 56dcb3cd3a53b8d9d5b221cfa52287dbdb278502 Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Sun, 6 Aug 2023 07:03:10 +0530 Subject: [PATCH 568/650] Update Get-PrintJob.md made changes to the ID description as you cannot use wild card characters on Get-PrintJob -Id --- docset/winserver2022-ps/printmanagement/Get-PrintJob.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/printmanagement/Get-PrintJob.md b/docset/winserver2022-ps/printmanagement/Get-PrintJob.md index 4c787a7829..b248274e7c 100644 --- a/docset/winserver2022-ps/printmanagement/Get-PrintJob.md +++ b/docset/winserver2022-ps/printmanagement/Get-PrintJob.md @@ -107,7 +107,7 @@ Accept wildcard characters: False ### -ID Specifies the ID of the print job to retrieve. -You can use wildcard characters. +You cannot use wildcard characters. ```yaml Type: UInt32 From e424b662e6c4cde4a6497da82bc52a31f1544870 Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Sun, 6 Aug 2023 07:04:37 +0530 Subject: [PATCH 569/650] Update Get-PrintJob.md Fixes 2012 version --- docset/winserver2012-ps/printmanagement/Get-PrintJob.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2012-ps/printmanagement/Get-PrintJob.md b/docset/winserver2012-ps/printmanagement/Get-PrintJob.md index a9c378eb7b..d13c2c4f37 100644 --- a/docset/winserver2012-ps/printmanagement/Get-PrintJob.md +++ b/docset/winserver2012-ps/printmanagement/Get-PrintJob.md @@ -104,7 +104,7 @@ Accept wildcard characters: False ### -ID Specifies the ID of the print job to retrieve. -You can use wildcard characters. +You cannot use wildcard characters. ```yaml Type: UInt32 From 8157847f648724c217e996016514dba7290c6216 Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Sun, 6 Aug 2023 07:04:52 +0530 Subject: [PATCH 570/650] Update Get-PrintJob.md Fixes 2016 --- docset/winserver2016-ps/printmanagement/Get-PrintJob.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2016-ps/printmanagement/Get-PrintJob.md b/docset/winserver2016-ps/printmanagement/Get-PrintJob.md index bc5119cf1a..a13a99add7 100644 --- a/docset/winserver2016-ps/printmanagement/Get-PrintJob.md +++ b/docset/winserver2016-ps/printmanagement/Get-PrintJob.md @@ -107,7 +107,7 @@ Accept wildcard characters: False ### -ID Specifies the ID of the print job to retrieve. -You can use wildcard characters. +You cannot use wildcard characters. ```yaml Type: UInt32 From 56848c534afa400425be0af0a56d8016c460de56 Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Sun, 6 Aug 2023 07:05:10 +0530 Subject: [PATCH 571/650] Update Get-PrintJob.md Fixes 2019 --- docset/winserver2019-ps/printmanagement/Get-PrintJob.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2019-ps/printmanagement/Get-PrintJob.md b/docset/winserver2019-ps/printmanagement/Get-PrintJob.md index 773a4f30fd..a971d566e3 100644 --- a/docset/winserver2019-ps/printmanagement/Get-PrintJob.md +++ b/docset/winserver2019-ps/printmanagement/Get-PrintJob.md @@ -107,7 +107,7 @@ Accept wildcard characters: False ### -ID Specifies the ID of the print job to retrieve. -You can use wildcard characters. +You cannot use wildcard characters. ```yaml Type: UInt32 From f6b838abb50da934ed29d6e40baafcd2622ce557 Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Sun, 6 Aug 2023 07:05:29 +0530 Subject: [PATCH 572/650] Update Get-PrintJob.md fixes 2102r2 --- docset/winserver2012r2-ps/printmanagement/Get-PrintJob.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2012r2-ps/printmanagement/Get-PrintJob.md b/docset/winserver2012r2-ps/printmanagement/Get-PrintJob.md index f81bc3b848..bbc1376b12 100644 --- a/docset/winserver2012r2-ps/printmanagement/Get-PrintJob.md +++ b/docset/winserver2012r2-ps/printmanagement/Get-PrintJob.md @@ -103,7 +103,7 @@ Accept wildcard characters: False ### -ID Specifies the ID of the print job to retrieve. -You can use wildcard characters. +You cannot use wildcard characters. ```yaml Type: UInt32 From fdd0d09404d819b986adaffba5e646d13f4f9569 Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Sun, 6 Aug 2023 07:17:40 +0530 Subject: [PATCH 573/650] Update Get-ADPrincipalGroupMembership.md Fixed partition parameter --- .../Get-ADPrincipalGroupMembership.md | 24 ++++++++++++++++--- 1 file changed, 21 insertions(+), 3 deletions(-) diff --git a/docset/winserver2016-ps/activedirectory/Get-ADPrincipalGroupMembership.md b/docset/winserver2016-ps/activedirectory/Get-ADPrincipalGroupMembership.md index 6afebebdef..2178eb3b8c 100644 --- a/docset/winserver2016-ps/activedirectory/Get-ADPrincipalGroupMembership.md +++ b/docset/winserver2016-ps/activedirectory/Get-ADPrincipalGroupMembership.md @@ -258,9 +258,27 @@ Accept wildcard characters: False ``` ### -Partition -The default authentication method is Negotiate. +Specifies the distinguished name of an Active Directory partition. +The distinguished name must be one of the naming contexts on the current directory server. +The cmdlet searches this partition to find the object defined by the **Identity** parameter. -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. +In many cases, a default value is used for the **Partition** parameter if no value is specified. +The rules for determining the default value are given below. +Note that rules listed first are evaluated first and once a default value can be determined, no further rules are evaluated. + +In Active Directory Domain Services (AD DS) environments, a default value for **Partition** is set in the following cases: + +- If the **Identity** parameter is set to a distinguished name, the default value of **Partition** is automatically generated from this distinguished name. +- If running cmdlets from an Active Directory provider drive, the default value of **Partition** is automatically generated from the current path in the drive. +- If none of the previous cases apply, the default value of **Partition** is set to the default partition or naming context of the target domain. + +In Active Directory Lightweight Directory Services (AD LDS) environments, a default value for **Partition** is set in the following cases: + +- If the **Identity** parameter is set to a distinguished name, the default value of **Partition** is automatically generated from this distinguished name. +- If running cmdlets from an Active Directory provider drive, the default value of **Partition** is automatically generated from the current path in the drive. +- If the target AD LDS instance has a default naming context, the default value of **Partition** is set to the default naming context. +To specify a default naming context for an AD LDS environment, set the **msDS-defaultNamingContext** property of the Active Directory directory service agent object (**nTDSDSA**) for the AD LDS instance. +- If none of the previous cases apply, the **Partition** parameter does not take any default value. ```yaml Type: String @@ -269,7 +287,7 @@ Aliases: Required: False Position: Named -Default value: None +Default value: DefaultNC; Provider: Default is to use the Partition that you are currently in. Else, use DefaultNC (IE: If you are in the RootDSE) Accept pipeline input: False Accept wildcard characters: False ``` From 5a7755bbd602b3bf537b564ca82e10b45fe852bf Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Sun, 6 Aug 2023 07:19:27 +0530 Subject: [PATCH 574/650] Update Get-ADPrincipalGroupMembership.md Fixes 2019 --- .../Get-ADPrincipalGroupMembership.md | 25 ++++++++++++++++--- 1 file changed, 22 insertions(+), 3 deletions(-) diff --git a/docset/winserver2019-ps/activedirectory/Get-ADPrincipalGroupMembership.md b/docset/winserver2019-ps/activedirectory/Get-ADPrincipalGroupMembership.md index 11fe58e3b8..586c4d23f0 100644 --- a/docset/winserver2019-ps/activedirectory/Get-ADPrincipalGroupMembership.md +++ b/docset/winserver2019-ps/activedirectory/Get-ADPrincipalGroupMembership.md @@ -258,9 +258,27 @@ Accept wildcard characters: False ``` ### -Partition -The default authentication method is Negotiate. +Specifies the distinguished name of an Active Directory partition. +The distinguished name must be one of the naming contexts on the current directory server. +The cmdlet searches this partition to find the object defined by the **Identity** parameter. -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. +In many cases, a default value is used for the **Partition** parameter if no value is specified. +The rules for determining the default value are given below. +Note that rules listed first are evaluated first and once a default value can be determined, no further rules are evaluated. + +In Active Directory Domain Services (AD DS) environments, a default value for **Partition** is set in the following cases: + +- If the **Identity** parameter is set to a distinguished name, the default value of **Partition** is automatically generated from this distinguished name. +- If running cmdlets from an Active Directory provider drive, the default value of **Partition** is automatically generated from the current path in the drive. +- If none of the previous cases apply, the default value of **Partition** is set to the default partition or naming context of the target domain. + +In Active Directory Lightweight Directory Services (AD LDS) environments, a default value for **Partition** is set in the following cases: + +- If the **Identity** parameter is set to a distinguished name, the default value of **Partition** is automatically generated from this distinguished name. +- If running cmdlets from an Active Directory provider drive, the default value of **Partition** is automatically generated from the current path in the drive. +- If the target AD LDS instance has a default naming context, the default value of **Partition** is set to the default naming context. +To specify a default naming context for an AD LDS environment, set the **msDS-defaultNamingContext** property of the Active Directory directory service agent object (**nTDSDSA**) for the AD LDS instance. +- If none of the previous cases apply, the **Partition** parameter does not take any default value. ```yaml Type: String @@ -269,11 +287,12 @@ Aliases: Required: False Position: Named -Default value: None +Default value: DefaultNC; Provider: Default is to use the Partition that you are currently in. Else, use DefaultNC (IE: If you are in the RootDSE) Accept pipeline input: False Accept wildcard characters: False ``` + ### -ResourceContextPartition Specifies the distinguished name of the partition of an AD or AD LDS instance to search. Use this parameter with the *ResourceContextServer* parameter to specify a partition hosted by the specified server. From 7c95d9d2b03edf2a7cc1c58062845e0522431c26 Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Sun, 6 Aug 2023 07:19:48 +0530 Subject: [PATCH 575/650] Update Get-ADPrincipalGroupMembership.md Fixes 2022 --- .../Get-ADPrincipalGroupMembership.md | 24 ++++++++++++++++--- 1 file changed, 21 insertions(+), 3 deletions(-) diff --git a/docset/winserver2022-ps/activedirectory/Get-ADPrincipalGroupMembership.md b/docset/winserver2022-ps/activedirectory/Get-ADPrincipalGroupMembership.md index cb4a561a04..e43b8d8341 100644 --- a/docset/winserver2022-ps/activedirectory/Get-ADPrincipalGroupMembership.md +++ b/docset/winserver2022-ps/activedirectory/Get-ADPrincipalGroupMembership.md @@ -258,9 +258,27 @@ Accept wildcard characters: False ``` ### -Partition -The default authentication method is Negotiate. +Specifies the distinguished name of an Active Directory partition. +The distinguished name must be one of the naming contexts on the current directory server. +The cmdlet searches this partition to find the object defined by the **Identity** parameter. -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. +In many cases, a default value is used for the **Partition** parameter if no value is specified. +The rules for determining the default value are given below. +Note that rules listed first are evaluated first and once a default value can be determined, no further rules are evaluated. + +In Active Directory Domain Services (AD DS) environments, a default value for **Partition** is set in the following cases: + +- If the **Identity** parameter is set to a distinguished name, the default value of **Partition** is automatically generated from this distinguished name. +- If running cmdlets from an Active Directory provider drive, the default value of **Partition** is automatically generated from the current path in the drive. +- If none of the previous cases apply, the default value of **Partition** is set to the default partition or naming context of the target domain. + +In Active Directory Lightweight Directory Services (AD LDS) environments, a default value for **Partition** is set in the following cases: + +- If the **Identity** parameter is set to a distinguished name, the default value of **Partition** is automatically generated from this distinguished name. +- If running cmdlets from an Active Directory provider drive, the default value of **Partition** is automatically generated from the current path in the drive. +- If the target AD LDS instance has a default naming context, the default value of **Partition** is set to the default naming context. +To specify a default naming context for an AD LDS environment, set the **msDS-defaultNamingContext** property of the Active Directory directory service agent object (**nTDSDSA**) for the AD LDS instance. +- If none of the previous cases apply, the **Partition** parameter does not take any default value. ```yaml Type: String @@ -269,7 +287,7 @@ Aliases: Required: False Position: Named -Default value: None +Default value: DefaultNC; Provider: Default is to use the Partition that you are currently in. Else, use DefaultNC (IE: If you are in the RootDSE) Accept pipeline input: False Accept wildcard characters: False ``` From 29271362415db6158baad6c0bb9f8db21369755a Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Sun, 6 Aug 2023 08:06:30 +0530 Subject: [PATCH 576/650] Update Move-ADObject.md Added a statement about password when it moves within the object is moved across domains in the forest --- docset/winserver2022-ps/activedirectory/Move-ADObject.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docset/winserver2022-ps/activedirectory/Move-ADObject.md b/docset/winserver2022-ps/activedirectory/Move-ADObject.md index 066ed4638c..e724863cb8 100644 --- a/docset/winserver2022-ps/activedirectory/Move-ADObject.md +++ b/docset/winserver2022-ps/activedirectory/Move-ADObject.md @@ -37,6 +37,8 @@ You can also use the **Get-ADGroup**, **Get-ADUser**, **Get-ADComputer**, **Get- The *TargetPath* parameter must be specified. This parameter identifies the new location for the object or container. +The Cmdlet moves the password when a user or computer object is moved across domains within a forest. + ## EXAMPLES ### Example 1: Move an OU to a new location From f3de92b9df2fe0c42d20d7c3e34b0a125704d481 Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Sun, 6 Aug 2023 08:08:42 +0530 Subject: [PATCH 577/650] Update Move-ADObject.md Fixes 2012 --- docset/winserver2012-ps/activedirectory/Move-ADObject.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docset/winserver2012-ps/activedirectory/Move-ADObject.md b/docset/winserver2012-ps/activedirectory/Move-ADObject.md index ae03b78ae3..1f3725924b 100644 --- a/docset/winserver2012-ps/activedirectory/Move-ADObject.md +++ b/docset/winserver2012-ps/activedirectory/Move-ADObject.md @@ -30,6 +30,8 @@ You can also use the Get-ADGroup, Get-ADUser, Get-ADComputer, Get-ADServiceAccou The TargetPath parameter must be specified. This parameter identifies the new location for the object or container. +The Cmdlet also moves the password when a user or computer object is moved across domains within a forest. + ## EXAMPLES ### -------------------------- EXAMPLE 1 -------------------------- From 4c1d917b84658d9166cc00e2e3e1e84351900b37 Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Sun, 6 Aug 2023 08:08:55 +0530 Subject: [PATCH 578/650] Update Move-ADObject.md Fixes 2016 --- docset/winserver2016-ps/activedirectory/Move-ADObject.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docset/winserver2016-ps/activedirectory/Move-ADObject.md b/docset/winserver2016-ps/activedirectory/Move-ADObject.md index dac51dd5d7..0ed6ca07c1 100644 --- a/docset/winserver2016-ps/activedirectory/Move-ADObject.md +++ b/docset/winserver2016-ps/activedirectory/Move-ADObject.md @@ -37,6 +37,7 @@ You can also use the **Get-ADGroup**, **Get-ADUser**, **Get-ADComputer**, **Get- The *TargetPath* parameter must be specified. This parameter identifies the new location for the object or container. +The Cmdlet also moves the password when a user or computer object is moved across domains within a forest. ## EXAMPLES ### Example 1: Move an OU to a new location From b52334ab714af6db5a6ee8c98dd9e45c1ec09c70 Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Sun, 6 Aug 2023 08:09:09 +0530 Subject: [PATCH 579/650] Update Move-ADObject.md Fixes 2019 --- docset/winserver2019-ps/activedirectory/Move-ADObject.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docset/winserver2019-ps/activedirectory/Move-ADObject.md b/docset/winserver2019-ps/activedirectory/Move-ADObject.md index 3ea888d585..dfe91ae6cb 100644 --- a/docset/winserver2019-ps/activedirectory/Move-ADObject.md +++ b/docset/winserver2019-ps/activedirectory/Move-ADObject.md @@ -36,6 +36,7 @@ You can also use the **Get-ADGroup**, **Get-ADUser**, **Get-ADComputer**, **Get- The *TargetPath* parameter must be specified. This parameter identifies the new location for the object or container. +The Cmdlet also moves the password when a user or computer object is moved across domains within a forest. ## EXAMPLES From 08990724b6ecfdf8f23695f59c007cca0586bbd8 Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Sun, 6 Aug 2023 08:09:22 +0530 Subject: [PATCH 580/650] Update Move-ADObject.md --- docset/winserver2022-ps/activedirectory/Move-ADObject.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/activedirectory/Move-ADObject.md b/docset/winserver2022-ps/activedirectory/Move-ADObject.md index e724863cb8..9f275ee48c 100644 --- a/docset/winserver2022-ps/activedirectory/Move-ADObject.md +++ b/docset/winserver2022-ps/activedirectory/Move-ADObject.md @@ -37,7 +37,8 @@ You can also use the **Get-ADGroup**, **Get-ADUser**, **Get-ADComputer**, **Get- The *TargetPath* parameter must be specified. This parameter identifies the new location for the object or container. -The Cmdlet moves the password when a user or computer object is moved across domains within a forest. +The Cmdlet also moves the password when a user or computer object is moved across domains within a forest. + ## EXAMPLES From dcedd0b5bd839cd993b0c173783572ac6c2005a3 Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Sun, 6 Aug 2023 08:09:34 +0530 Subject: [PATCH 581/650] Update Move-ADObject.md Fixes 2012R2 --- docset/winserver2012r2-ps/activedirectory/Move-ADObject.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docset/winserver2012r2-ps/activedirectory/Move-ADObject.md b/docset/winserver2012r2-ps/activedirectory/Move-ADObject.md index 63bb5a8424..63134796dd 100644 --- a/docset/winserver2012r2-ps/activedirectory/Move-ADObject.md +++ b/docset/winserver2012r2-ps/activedirectory/Move-ADObject.md @@ -31,6 +31,7 @@ You can also use the Get-ADGroup, Get-ADUser, Get-ADComputer, Get-ADServiceAccou The **TargetPath** parameter must be specified. This parameter identifies the new location for the object or container. +The Cmdlet also moves the password when a user or computer object is moved across domains within a forest. ## EXAMPLES From d6ab22ad07a5b72dad6cb9507684b5d79c387ef4 Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Sun, 6 Aug 2023 08:11:44 +0530 Subject: [PATCH 582/650] Update Move-ADObject.md Fixed description --- docset/winserver2012-ps/activedirectory/Move-ADObject.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2012-ps/activedirectory/Move-ADObject.md b/docset/winserver2012-ps/activedirectory/Move-ADObject.md index 1f3725924b..a0e19916ac 100644 --- a/docset/winserver2012-ps/activedirectory/Move-ADObject.md +++ b/docset/winserver2012-ps/activedirectory/Move-ADObject.md @@ -19,7 +19,7 @@ Move-ADObject [-WhatIf] [-Confirm] [-AuthType ] [-Credential Date: Sun, 6 Aug 2023 08:12:07 +0530 Subject: [PATCH 583/650] Update Move-ADObject.md --- docset/winserver2016-ps/activedirectory/Move-ADObject.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2016-ps/activedirectory/Move-ADObject.md b/docset/winserver2016-ps/activedirectory/Move-ADObject.md index 0ed6ca07c1..c261e1005c 100644 --- a/docset/winserver2016-ps/activedirectory/Move-ADObject.md +++ b/docset/winserver2016-ps/activedirectory/Move-ADObject.md @@ -22,7 +22,7 @@ Move-ADObject [-WhatIf] [-Confirm] [-AuthType ] [-Credential Date: Sun, 6 Aug 2023 08:12:26 +0530 Subject: [PATCH 584/650] Update Move-ADObject.md --- docset/winserver2019-ps/activedirectory/Move-ADObject.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2019-ps/activedirectory/Move-ADObject.md b/docset/winserver2019-ps/activedirectory/Move-ADObject.md index dfe91ae6cb..045510f106 100644 --- a/docset/winserver2019-ps/activedirectory/Move-ADObject.md +++ b/docset/winserver2019-ps/activedirectory/Move-ADObject.md @@ -22,7 +22,7 @@ Move-ADObject [-WhatIf] [-Confirm] [-AuthType ] [-Credential Date: Sun, 6 Aug 2023 08:12:34 +0530 Subject: [PATCH 585/650] Update Move-ADObject.md --- docset/winserver2016-ps/activedirectory/Move-ADObject.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2016-ps/activedirectory/Move-ADObject.md b/docset/winserver2016-ps/activedirectory/Move-ADObject.md index c261e1005c..440688f336 100644 --- a/docset/winserver2016-ps/activedirectory/Move-ADObject.md +++ b/docset/winserver2016-ps/activedirectory/Move-ADObject.md @@ -22,7 +22,7 @@ Move-ADObject [-WhatIf] [-Confirm] [-AuthType ] [-Credential Date: Sun, 6 Aug 2023 08:12:41 +0530 Subject: [PATCH 586/650] Update Move-ADObject.md --- docset/winserver2012-ps/activedirectory/Move-ADObject.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2012-ps/activedirectory/Move-ADObject.md b/docset/winserver2012-ps/activedirectory/Move-ADObject.md index a0e19916ac..7927036887 100644 --- a/docset/winserver2012-ps/activedirectory/Move-ADObject.md +++ b/docset/winserver2012-ps/activedirectory/Move-ADObject.md @@ -19,7 +19,7 @@ Move-ADObject [-WhatIf] [-Confirm] [-AuthType ] [-Credential Date: Sun, 6 Aug 2023 08:12:52 +0530 Subject: [PATCH 587/650] Update Move-ADObject.md --- docset/winserver2022-ps/activedirectory/Move-ADObject.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/activedirectory/Move-ADObject.md b/docset/winserver2022-ps/activedirectory/Move-ADObject.md index 9f275ee48c..56d2d32dbc 100644 --- a/docset/winserver2022-ps/activedirectory/Move-ADObject.md +++ b/docset/winserver2022-ps/activedirectory/Move-ADObject.md @@ -22,7 +22,7 @@ Move-ADObject [-WhatIf] [-Confirm] [-AuthType ] [-Credential Date: Sun, 6 Aug 2023 08:13:01 +0530 Subject: [PATCH 588/650] Update Move-ADObject.md --- docset/winserver2012r2-ps/activedirectory/Move-ADObject.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2012r2-ps/activedirectory/Move-ADObject.md b/docset/winserver2012r2-ps/activedirectory/Move-ADObject.md index 63134796dd..7d5546d75e 100644 --- a/docset/winserver2012r2-ps/activedirectory/Move-ADObject.md +++ b/docset/winserver2012r2-ps/activedirectory/Move-ADObject.md @@ -21,7 +21,7 @@ Move-ADObject [-WhatIf] [-Confirm] [-AuthType ] [-Credential Date: Sun, 6 Aug 2023 13:33:34 +0530 Subject: [PATCH 589/650] Update docset/winserver2019-ps/activedirectory/Move-ADObject.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- docset/winserver2019-ps/activedirectory/Move-ADObject.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2019-ps/activedirectory/Move-ADObject.md b/docset/winserver2019-ps/activedirectory/Move-ADObject.md index 045510f106..0b873feb60 100644 --- a/docset/winserver2019-ps/activedirectory/Move-ADObject.md +++ b/docset/winserver2019-ps/activedirectory/Move-ADObject.md @@ -36,7 +36,7 @@ You can also use the **Get-ADGroup**, **Get-ADUser**, **Get-ADComputer**, **Get- The *TargetPath* parameter must be specified. This parameter identifies the new location for the object or container. -The Cmdlet also moves the password when a user or computer object is moved across domains within a forest. +The cmdlet also moves the password when a user or computer object is moved across domains within a forest. ## EXAMPLES From 0299ca0798c8fceff2965a608569e68e6a24786c Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Sun, 6 Aug 2023 13:33:40 +0530 Subject: [PATCH 590/650] Update docset/winserver2022-ps/activedirectory/Move-ADObject.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- docset/winserver2022-ps/activedirectory/Move-ADObject.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/activedirectory/Move-ADObject.md b/docset/winserver2022-ps/activedirectory/Move-ADObject.md index 56d2d32dbc..13f2b980d7 100644 --- a/docset/winserver2022-ps/activedirectory/Move-ADObject.md +++ b/docset/winserver2022-ps/activedirectory/Move-ADObject.md @@ -37,7 +37,7 @@ You can also use the **Get-ADGroup**, **Get-ADUser**, **Get-ADComputer**, **Get- The *TargetPath* parameter must be specified. This parameter identifies the new location for the object or container. -The Cmdlet also moves the password when a user or computer object is moved across domains within a forest. +The cmdlet also moves the password when a user or computer object is moved across domains within a forest. ## EXAMPLES From 917655c2cbf834b5ec2dd69b197d8fc0fcfb9ad0 Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Sun, 6 Aug 2023 13:33:49 +0530 Subject: [PATCH 591/650] Update docset/winserver2012-ps/activedirectory/Move-ADObject.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- docset/winserver2012-ps/activedirectory/Move-ADObject.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2012-ps/activedirectory/Move-ADObject.md b/docset/winserver2012-ps/activedirectory/Move-ADObject.md index 7927036887..d6a495824b 100644 --- a/docset/winserver2012-ps/activedirectory/Move-ADObject.md +++ b/docset/winserver2012-ps/activedirectory/Move-ADObject.md @@ -30,7 +30,7 @@ You can also use the Get-ADGroup, Get-ADUser, Get-ADComputer, Get-ADServiceAccou The TargetPath parameter must be specified. This parameter identifies the new location for the object or container. -The Cmdlet also moves the password when a user or computer object is moved across domains within a forest. +The cmdlet also moves the password when a user or computer object is moved across domains within a forest. ## EXAMPLES From 51dc8ff2490146cd10f6650ee60be64d61fe79da Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Sun, 6 Aug 2023 13:34:04 +0530 Subject: [PATCH 592/650] Update docset/winserver2022-ps/defender/Set-MpPreference.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- docset/winserver2022-ps/defender/Set-MpPreference.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docset/winserver2022-ps/defender/Set-MpPreference.md b/docset/winserver2022-ps/defender/Set-MpPreference.md index e2d0d26e5f..7193577162 100644 --- a/docset/winserver2022-ps/defender/Set-MpPreference.md +++ b/docset/winserver2022-ps/defender/Set-MpPreference.md @@ -1060,11 +1060,11 @@ Accept wildcard characters: False ### -OobeEnableRtpAndSigUpdate -This setting allows you to configure whether real-time protection and Security Intelligence Updates are enabled during OOBE (Out of Box experience). +This setting allows you to configure whether real-time protection and Security Intelligence Updates are enabled during Out of Box experience (OOBE). Valid values are: -True - If you enable this setting, real-time protection and Security Intelligence Updates are enabled during OOBE. -False - (Default) If you either disable or don't configure this setting, real-time protection and Security Intelligence Updates during OOBE aren't enabled. +True - If you enable this setting, real-time protection and Security Intelligence Updates are enabled during OOBE. +False (Default) - If you either disable or don't configure this setting, real-time protection and Security Intelligence Updates during OOBE aren't enabled. ```yaml Type: Boolean From cbf608d300728f8568b3b7899002a9703ff8ec19 Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Sun, 6 Aug 2023 13:34:10 +0530 Subject: [PATCH 593/650] Update docset/winserver2016-ps/defender/Set-MpPreference.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- docset/winserver2016-ps/defender/Set-MpPreference.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2016-ps/defender/Set-MpPreference.md b/docset/winserver2016-ps/defender/Set-MpPreference.md index 2cdac54472..981b5bbfc2 100644 --- a/docset/winserver2016-ps/defender/Set-MpPreference.md +++ b/docset/winserver2016-ps/defender/Set-MpPreference.md @@ -588,7 +588,7 @@ Accept wildcard characters: False ### -OobeEnableRtpAndSigUpdate -This setting allows you to configure whether real-time protection and Security Intelligence Updates are enabled during OOBE (Out of Box experience). +This setting allows you to configure whether real-time protection and Security Intelligence Updates are enabled during Out of Box experience (OOBE). Valid values are: True - If you enable this setting, real-time protection and Security Intelligence Updates are enabled during OOBE. From fb6c4a92309274493f55d88804ca4535f8acb364 Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Sun, 6 Aug 2023 13:34:16 +0530 Subject: [PATCH 594/650] Update docset/winserver2016-ps/defender/Set-MpPreference.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- docset/winserver2016-ps/defender/Set-MpPreference.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docset/winserver2016-ps/defender/Set-MpPreference.md b/docset/winserver2016-ps/defender/Set-MpPreference.md index 981b5bbfc2..e4373df0c6 100644 --- a/docset/winserver2016-ps/defender/Set-MpPreference.md +++ b/docset/winserver2016-ps/defender/Set-MpPreference.md @@ -591,8 +591,8 @@ Accept wildcard characters: False This setting allows you to configure whether real-time protection and Security Intelligence Updates are enabled during Out of Box experience (OOBE). Valid values are: -True - If you enable this setting, real-time protection and Security Intelligence Updates are enabled during OOBE. -False - (Default) If you either disable or don't configure this setting, real-time protection and Security Intelligence Updates during OOBE aren't enabled. +True - If you enable this setting, real-time protection and Security Intelligence Updates are enabled during OOBE. +False (Default) - If you either disable or don't configure this setting, real-time protection and Security Intelligence Updates during OOBE aren't enabled. ```yaml Type: Boolean From 0aa477703209aa0c662ff2333658d1a3d9b21501 Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Sun, 6 Aug 2023 13:34:21 +0530 Subject: [PATCH 595/650] Update docset/winserver2019-ps/defender/Set-MpPreference.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- docset/winserver2019-ps/defender/Set-MpPreference.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docset/winserver2019-ps/defender/Set-MpPreference.md b/docset/winserver2019-ps/defender/Set-MpPreference.md index a7a2197fc3..a29438131f 100644 --- a/docset/winserver2019-ps/defender/Set-MpPreference.md +++ b/docset/winserver2019-ps/defender/Set-MpPreference.md @@ -691,11 +691,11 @@ Accept wildcard characters: False ### -OobeEnableRtpAndSigUpdate -This setting allows you to configure whether real-time protection and Security Intelligence Updates are enabled during OOBE (Out of Box experience). +This setting allows you to configure whether real-time protection and Security Intelligence Updates are enabled during Out of Box experience (OOBE). Valid values are: -True - If you enable this setting, real-time protection and Security Intelligence Updates are enabled during OOBE. -False - (Default) If you either disable or don't configure this setting, real-time protection and Security Intelligence Updates during OOBE aren't enabled. +True - If you enable this setting, real-time protection and Security Intelligence Updates are enabled during OOBE. +False (Default) - If you either disable or don't configure this setting, real-time protection and Security Intelligence Updates during OOBE aren't enabled. ```yaml Type: Boolean From c39c8ec28274f4c7a2e9c4398f87de1f043ff8e3 Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Mon, 7 Aug 2023 11:46:17 +0530 Subject: [PATCH 596/650] Update docset/winserver2022-ps/activedirectory/Get-ADPrincipalGroupMembership.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- .../activedirectory/Get-ADPrincipalGroupMembership.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/activedirectory/Get-ADPrincipalGroupMembership.md b/docset/winserver2022-ps/activedirectory/Get-ADPrincipalGroupMembership.md index e43b8d8341..0b87fc8a50 100644 --- a/docset/winserver2022-ps/activedirectory/Get-ADPrincipalGroupMembership.md +++ b/docset/winserver2022-ps/activedirectory/Get-ADPrincipalGroupMembership.md @@ -287,7 +287,7 @@ Aliases: Required: False Position: Named -Default value: DefaultNC; Provider: Default is to use the Partition that you are currently in. Else, use DefaultNC (IE: If you are in the RootDSE) +Default value: DefaultNC; Provider: The default is to use the Partition that you are currently in. Otherwise, use DefaultNC (that is, if you are in the RootDSE) Accept pipeline input: False Accept wildcard characters: False ``` From 5a33f0f685a9036ebcaafb73854479ef045e4b70 Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Mon, 7 Aug 2023 11:46:24 +0530 Subject: [PATCH 597/650] Update docset/winserver2016-ps/activedirectory/Get-ADPrincipalGroupMembership.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- .../activedirectory/Get-ADPrincipalGroupMembership.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2016-ps/activedirectory/Get-ADPrincipalGroupMembership.md b/docset/winserver2016-ps/activedirectory/Get-ADPrincipalGroupMembership.md index 2178eb3b8c..63722545a3 100644 --- a/docset/winserver2016-ps/activedirectory/Get-ADPrincipalGroupMembership.md +++ b/docset/winserver2016-ps/activedirectory/Get-ADPrincipalGroupMembership.md @@ -287,7 +287,7 @@ Aliases: Required: False Position: Named -Default value: DefaultNC; Provider: Default is to use the Partition that you are currently in. Else, use DefaultNC (IE: If you are in the RootDSE) +Default value: DefaultNC; Provider: The default is to use the Partition that you are currently in. Otherwise, use DefaultNC (that is, if you are in the RootDSE) Accept pipeline input: False Accept wildcard characters: False ``` From 06d6e3415562eda187fbaf2e5f04ad8dede60a05 Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Mon, 7 Aug 2023 11:46:31 +0530 Subject: [PATCH 598/650] Update docset/winserver2019-ps/activedirectory/Get-ADPrincipalGroupMembership.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- .../activedirectory/Get-ADPrincipalGroupMembership.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2019-ps/activedirectory/Get-ADPrincipalGroupMembership.md b/docset/winserver2019-ps/activedirectory/Get-ADPrincipalGroupMembership.md index 586c4d23f0..cd081f93bf 100644 --- a/docset/winserver2019-ps/activedirectory/Get-ADPrincipalGroupMembership.md +++ b/docset/winserver2019-ps/activedirectory/Get-ADPrincipalGroupMembership.md @@ -287,7 +287,7 @@ Aliases: Required: False Position: Named -Default value: DefaultNC; Provider: Default is to use the Partition that you are currently in. Else, use DefaultNC (IE: If you are in the RootDSE) +Default value: DefaultNC; Provider: The default is to use the Partition that you are currently in. Otherwise, use DefaultNC (that is, if you are in the RootDSE) Accept pipeline input: False Accept wildcard characters: False ``` From 659cc4588d110804f28e2cc46756860d8ef0f3d3 Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Mon, 7 Aug 2023 11:58:03 +0530 Subject: [PATCH 599/650] Update docset/winserver2022-ps/defender/Set-MpPreference.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- docset/winserver2022-ps/defender/Set-MpPreference.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docset/winserver2022-ps/defender/Set-MpPreference.md b/docset/winserver2022-ps/defender/Set-MpPreference.md index 7193577162..88f49250a6 100644 --- a/docset/winserver2022-ps/defender/Set-MpPreference.md +++ b/docset/winserver2022-ps/defender/Set-MpPreference.md @@ -1063,8 +1063,8 @@ Accept wildcard characters: False This setting allows you to configure whether real-time protection and Security Intelligence Updates are enabled during Out of Box experience (OOBE). Valid values are: -True - If you enable this setting, real-time protection and Security Intelligence Updates are enabled during OOBE. -False (Default) - If you either disable or don't configure this setting, real-time protection and Security Intelligence Updates during OOBE aren't enabled. +- True - If you enable this setting, real-time protection and Security Intelligence Updates are enabled during OOBE. +- False (Default) - If you either disable or don't configure this setting, real-time protection and Security Intelligence Updates during OOBE aren't enabled. ```yaml Type: Boolean From f6f7ddb70be131ebff73161f8b1665582b596713 Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Mon, 7 Aug 2023 11:58:12 +0530 Subject: [PATCH 600/650] Update docset/winserver2016-ps/defender/Set-MpPreference.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- docset/winserver2016-ps/defender/Set-MpPreference.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docset/winserver2016-ps/defender/Set-MpPreference.md b/docset/winserver2016-ps/defender/Set-MpPreference.md index e4373df0c6..f9ec6dfa92 100644 --- a/docset/winserver2016-ps/defender/Set-MpPreference.md +++ b/docset/winserver2016-ps/defender/Set-MpPreference.md @@ -591,8 +591,8 @@ Accept wildcard characters: False This setting allows you to configure whether real-time protection and Security Intelligence Updates are enabled during Out of Box experience (OOBE). Valid values are: -True - If you enable this setting, real-time protection and Security Intelligence Updates are enabled during OOBE. -False (Default) - If you either disable or don't configure this setting, real-time protection and Security Intelligence Updates during OOBE aren't enabled. +- True - If you enable this setting, real-time protection and Security Intelligence Updates are enabled during OOBE. +- False (Default) - If you either disable or don't configure this setting, real-time protection and Security Intelligence Updates during OOBE aren't enabled. ```yaml Type: Boolean From 57d37dfefe6dddb13f483ea2ad3c42ba322f1a4e Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Mon, 7 Aug 2023 11:58:17 +0530 Subject: [PATCH 601/650] Update docset/winserver2019-ps/defender/Set-MpPreference.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- docset/winserver2019-ps/defender/Set-MpPreference.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docset/winserver2019-ps/defender/Set-MpPreference.md b/docset/winserver2019-ps/defender/Set-MpPreference.md index a29438131f..54dcb71c9a 100644 --- a/docset/winserver2019-ps/defender/Set-MpPreference.md +++ b/docset/winserver2019-ps/defender/Set-MpPreference.md @@ -694,8 +694,8 @@ Accept wildcard characters: False This setting allows you to configure whether real-time protection and Security Intelligence Updates are enabled during Out of Box experience (OOBE). Valid values are: -True - If you enable this setting, real-time protection and Security Intelligence Updates are enabled during OOBE. -False (Default) - If you either disable or don't configure this setting, real-time protection and Security Intelligence Updates during OOBE aren't enabled. +- True - If you enable this setting, real-time protection and Security Intelligence Updates are enabled during OOBE. +- False (Default) - If you either disable or don't configure this setting, real-time protection and Security Intelligence Updates during OOBE aren't enabled. ```yaml Type: Boolean From be5d36151675777f562742df87ccb562bf2e4b6d Mon Sep 17 00:00:00 2001 From: Alex Buck Date: Sat, 19 Aug 2023 18:48:49 -0400 Subject: [PATCH 602/650] [BULK] DocuTune - Add ms.custom tag "has-azure-ad-ps-ref" to track Azure AD PowerShell references --- .../winserver2016-ps/adfs/New-AdfsAzureMfaTenantCertificate.md | 1 + docset/winserver2016-ps/adfs/Set-AdfsAzureMfaTenant.md | 2 +- .../winserver2019-ps/adfs/New-AdfsAzureMfaTenantCertificate.md | 1 + docset/winserver2019-ps/adfs/Set-AdfsAzureMfaTenant.md | 2 +- .../winserver2022-ps/adfs/New-AdfsAzureMfaTenantCertificate.md | 1 + docset/winserver2022-ps/adfs/Set-AdfsAzureMfaTenant.md | 2 +- 6 files changed, 6 insertions(+), 3 deletions(-) diff --git a/docset/winserver2016-ps/adfs/New-AdfsAzureMfaTenantCertificate.md b/docset/winserver2016-ps/adfs/New-AdfsAzureMfaTenantCertificate.md index d36cd22d05..88f4449005 100644 --- a/docset/winserver2016-ps/adfs/New-AdfsAzureMfaTenantCertificate.md +++ b/docset/winserver2016-ps/adfs/New-AdfsAzureMfaTenantCertificate.md @@ -3,6 +3,7 @@ description: Use this topic to help manage Windows and Windows Server technologi external help file: Microsoft.IdentityServer.Management.dll-Help.xml Module Name: ADFS ms.date: 12/20/2016 +ms.custom: has-azure-ad-ps-ref online version: https://learn.microsoft.com/powershell/module/adfs/new-adfsazuremfatenantcertificate?view=windowsserver2016-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: New-AdfsAzureMfaTenantCertificate diff --git a/docset/winserver2016-ps/adfs/Set-AdfsAzureMfaTenant.md b/docset/winserver2016-ps/adfs/Set-AdfsAzureMfaTenant.md index b8516d17ee..7579d96ac1 100644 --- a/docset/winserver2016-ps/adfs/Set-AdfsAzureMfaTenant.md +++ b/docset/winserver2016-ps/adfs/Set-AdfsAzureMfaTenant.md @@ -3,6 +3,7 @@ description: Use this topic to help manage Windows and Windows Server technologi external help file: Microsoft.IdentityServer.Management.dll-Help.xml Module Name: ADFS ms.date: 12/20/2016 +ms.custom: has-azure-ad-ps-ref online version: https://learn.microsoft.com/powershell/module/adfs/set-adfsazuremfatenant?view=windowsserver2016-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Set-AdfsAzureMfaTenant @@ -121,4 +122,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS [New-AdfsAzureMfaTenantCertificate](./New-AdfsAzureMfaTenantCertificate.md) - diff --git a/docset/winserver2019-ps/adfs/New-AdfsAzureMfaTenantCertificate.md b/docset/winserver2019-ps/adfs/New-AdfsAzureMfaTenantCertificate.md index 4b491b8d92..d964ff8f73 100644 --- a/docset/winserver2019-ps/adfs/New-AdfsAzureMfaTenantCertificate.md +++ b/docset/winserver2019-ps/adfs/New-AdfsAzureMfaTenantCertificate.md @@ -3,6 +3,7 @@ description: Use this topic to help manage Windows and Windows Server technologi external help file: Microsoft.IdentityServer.Management.dll-Help.xml Module Name: ADFS ms.date: 12/20/2016 +ms.custom: has-azure-ad-ps-ref online version: https://learn.microsoft.com/powershell/module/adfs/new-adfsazuremfatenantcertificate?view=windowsserver2019-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: New-AdfsAzureMfaTenantCertificate diff --git a/docset/winserver2019-ps/adfs/Set-AdfsAzureMfaTenant.md b/docset/winserver2019-ps/adfs/Set-AdfsAzureMfaTenant.md index d8e0a6c71b..5563a15d78 100644 --- a/docset/winserver2019-ps/adfs/Set-AdfsAzureMfaTenant.md +++ b/docset/winserver2019-ps/adfs/Set-AdfsAzureMfaTenant.md @@ -3,6 +3,7 @@ description: Use this topic to help manage Windows and Windows Server technologi external help file: Microsoft.IdentityServer.Management.dll-Help.xml Module Name: ADFS ms.date: 12/20/2016 +ms.custom: has-azure-ad-ps-ref online version: https://learn.microsoft.com/powershell/module/adfs/set-adfsazuremfatenant?view=windowsserver2019-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Set-AdfsAzureMfaTenant @@ -121,4 +122,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS [New-AdfsAzureMfaTenantCertificate](./New-AdfsAzureMfaTenantCertificate.md) - diff --git a/docset/winserver2022-ps/adfs/New-AdfsAzureMfaTenantCertificate.md b/docset/winserver2022-ps/adfs/New-AdfsAzureMfaTenantCertificate.md index ca5e889898..51749cf199 100644 --- a/docset/winserver2022-ps/adfs/New-AdfsAzureMfaTenantCertificate.md +++ b/docset/winserver2022-ps/adfs/New-AdfsAzureMfaTenantCertificate.md @@ -3,6 +3,7 @@ description: Use this topic to help manage Windows and Windows Server technologi external help file: Microsoft.IdentityServer.Management.dll-Help.xml Module Name: ADFS ms.date: 12/20/2016 +ms.custom: has-azure-ad-ps-ref online version: https://learn.microsoft.com/powershell/module/adfs/new-adfsazuremfatenantcertificate?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: New-AdfsAzureMfaTenantCertificate diff --git a/docset/winserver2022-ps/adfs/Set-AdfsAzureMfaTenant.md b/docset/winserver2022-ps/adfs/Set-AdfsAzureMfaTenant.md index b1dc8e0757..292a669981 100644 --- a/docset/winserver2022-ps/adfs/Set-AdfsAzureMfaTenant.md +++ b/docset/winserver2022-ps/adfs/Set-AdfsAzureMfaTenant.md @@ -3,6 +3,7 @@ description: Use this topic to help manage Windows and Windows Server technologi external help file: Microsoft.IdentityServer.Management.dll-Help.xml Module Name: ADFS ms.date: 12/20/2016 +ms.custom: has-azure-ad-ps-ref online version: https://learn.microsoft.com/powershell/module/adfs/set-adfsazuremfatenant?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Set-AdfsAzureMfaTenant @@ -121,4 +122,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS [New-AdfsAzureMfaTenantCertificate](./New-AdfsAzureMfaTenantCertificate.md) - From 8bd17bbd3bb5fb203a097d34358c46007b85228f Mon Sep 17 00:00:00 2001 From: Matt Ige Date: Mon, 21 Aug 2023 10:18:58 -0700 Subject: [PATCH 603/650] update with profile --- .../Get-NetFirewallHyperVProfile.md | 195 +++++++++++++++ .../netsecurity/Get-NetFirewallHyperVRule.md | 6 +- .../Get-NetFirewallHyperVVMSetting.md | 8 +- .../New-NetFirewallHyperVProfile.md | 222 ++++++++++++++++++ .../netsecurity/New-NetFirewallHyperVRule.md | 42 +++- .../New-NetFirewallHyperVVMSetting.md | 59 ++++- .../Set-NetFirewallHyperVProfile.md | 222 ++++++++++++++++++ .../Set-NetFirewallHyperVVMSetting.md | 54 ++++- 8 files changed, 785 insertions(+), 23 deletions(-) create mode 100644 docset/winserver2022-ps/netsecurity/Get-NetFirewallHyperVProfile.md create mode 100644 docset/winserver2022-ps/netsecurity/New-NetFirewallHyperVProfile.md create mode 100644 docset/winserver2022-ps/netsecurity/Set-NetFirewallHyperVProfile.md diff --git a/docset/winserver2022-ps/netsecurity/Get-NetFirewallHyperVProfile.md b/docset/winserver2022-ps/netsecurity/Get-NetFirewallHyperVProfile.md new file mode 100644 index 0000000000..e2d21c70e5 --- /dev/null +++ b/docset/winserver2022-ps/netsecurity/Get-NetFirewallHyperVProfile.md @@ -0,0 +1,195 @@ +--- +description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. +external help file: NetFirewallHyperVProfile.cmdletDefinition.cdxml-help.xml +Module Name: NetSecurity +ms.date: 12/27/2016 +online version: https://docs.microsoft.com/powershell/module/netsecurity/get-netfirewallhypervprofile?view=windowsserver2022-ps&wt.mc_id=ps-gethelp +schema: 2.0.0 +title: Get-NetFirewallHyperVProfile +--- + +# Get-NetFirewallHyperVProfile + +## SYNOPSIS +Retrieves Hyper-V firewall per-profile settings from the target computer. + +## SYNTAX + +``` +Get-NetFirewallHyperVProfile [-All] [-PolicyStore ] [-CimSession ] [-ThrottleLimit ] [-AsJob] [] +``` + +``` +Get-NetFirewallHyperVProfile [[-Name] ] [-Profile {Any | Domain | Private | Public | NotApplicable}] [-CimSession ] [-ThrottleLimit ] [-AsJob] [] +``` + +## DESCRIPTION +The **Get-NetFirewallHyperVProfile** cmdlet returns the the Hyper-V firewall profile settings on the system. These settings are applicable to all Hyper-V firewall ports created by a specific Hyper-V firewall VM creator. These settings apply to the VM only when the profile is active. + +These settings are configurable on a per-store basis. By default, this cmdlet queries the local store. + +## EXAMPLES + +### EXAMPLE 1 +``` +PS C:\> Get-NetFirewallHyperVProfile +``` + +This retrieves all of the Hyper-V firewall profile settings. With no parameters, this cmdlet queries the settings in the local store. + +### EXAMPLE 2 +``` +PS C:\> Get-NetFirewallHyperVProfile -Name '{9E288F02-CE00-4D9E-BE2B-14CE463B0298}' +``` + +This retrieves all of the Hyper-V firewall profile settings for the specified VM creator Id. + +### EXAMPLE 3 +``` +PS C:\> Get-NetFirewallHyperVProfile -PolicyStore ActiveStore +``` + +This retrieves all of the Hyper-V firewall profile settings from the ActiveStore. + +## PARAMETERS + +### -All +Specifies that all Hyper-V firewall profile settings should be retrieved. + +```yaml +Type: SwitchParameter +Parameter Sets: GetAll +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CimSession +Runs the cmdlet in a remote session or on a remote computer. +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. +The default is the current session on the local computer. + +```yaml +Type: CimSession[] +Parameter Sets: (All) +Aliases: Session +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies that only matching Hyper-V firewall profile settings of the indicated Hyper-V firewall VM creator should be retrieved. +The format for this value is a GUID enclosed in brackets: '{9E288F02-CE00-4D9E-BE2B-14CE463B0298}'. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: VMCreatorId +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Profile +Specifies that only matching Hyper-V firewall profile settings of the indicated profile should be retrieved. +Acceptable values are: Any, Domain, Private, Public. + +```yaml +Type: String +Parameter Sets: (All) +Required: False +Position: Named +Default value: Any +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PolicyStore +Targets the policy store from which to retrieve the rules. +A policy store is a container for firewall policy. +The acceptable values for this parameter are: +- PersistentStore: Sometimes called static rules, this store contains the persistent policy for the local computer. +This policy is not from GPOs, and has been created manually or programmatically (during application installation) on the computer. +Rules created in this store are attached to the ActiveStore and activated on the computer immediately. +- ActiveStore: This store contains the currently active policy, which is the sum of all policy stores that apply to the computer. +- MDM: This store contains the rules configured via MDM. + +By default, the PersistentStore is queried. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ThrottleLimit +Specifies the maximum number of concurrent operations that can be established to run the cmdlet. +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. +The throttle limit applies only to the current cmdlet, not to the session or to the computer. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +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). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Management.Infrastructure.CimInstance#root\StandardCimv2\NetFirewallHyperVProfile +The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. +The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. + +## NOTES + +## RELATED LINKS + +[Get-NetfirewallHyperVRule](./Get-NetFirewallHyperVRule.md) + +[Get-NetfirewallHyperVPort](./Get-NetFirewallHyperVPort.md) + +[Get-NetfirewallHyperVVMCreator](./Get-NetFirewallHyperVVMCreator.md) + +[New-NetFirewallHyperVVMSetting](./New-NetFirewallHyperVVMSetting.md) + +[Set-NetFirewallHyperVVMSetting](./Set-NetFirewallHyperVVMSetting.md) \ No newline at end of file diff --git a/docset/winserver2022-ps/netsecurity/Get-NetFirewallHyperVRule.md b/docset/winserver2022-ps/netsecurity/Get-NetFirewallHyperVRule.md index 4a6e162963..e996f90412 100644 --- a/docset/winserver2022-ps/netsecurity/Get-NetFirewallHyperVRule.md +++ b/docset/winserver2022-ps/netsecurity/Get-NetFirewallHyperVRule.md @@ -28,7 +28,7 @@ Get-NetFirewallHyperVRule -DisplayName [-PolicyStore ] [-CimS ``` ``` -Get-NetFirewallHyperVRule [-Direction {Inbound | Outbound}] [-VMCreatorId ] [-Protocol ] [-Action {NotConfigured | Allow | Block}] [-Enabled {True | False}] [-EnforcementStatus {Unknown | OK | PartiallyEnforced | NoApplicablePorts | ParsingError | Error}] [-PolicyStoreSourceType {None | Local | Dynamic | Hardcoded | MDM}] [-PolicyStore ] [-CimSession ] [-ThrottleLimit ] [-AsJob] [] +Get-NetFirewallHyperVRule [-Direction {Inbound | Outbound}] [-VMCreatorId ] [-Protocol ] [-Action {NotConfigured | Allow | Block}] [-Enabled {True | False}] [-EnforcementStatus {Unknown | OK | PartiallyEnforced | NoApplicablePorts | ParsingError | Error}] [-PolicyStoreSourceType {None | Local | GroupPolicy | Dynamic | Generated | Hardcoded | MDM | HostFirewallLocal | HostFirewallGroupPolicy | HostFirewallDynamic | HostFirewallMDM}] [-PolicyStore ] [-CimSession ] [-ThrottleLimit ] [-AsJob] [] ``` ## DESCRIPTION @@ -236,6 +236,10 @@ This parameter value is automatically generated and should not be modified. The acceptable values for this parameter are: - Local: The object originates from the local store. - MDM: The object originates from the MDM store. +- Dynamic: The object originates from the dynamic store. +- HostFirewallLocal: This object originates from the host windows firewall local store. +- HostFirewallGroupPolicy: This object originates from the host windows firewall group policy store. +- HostFirewallMDM: This object originates from the host windows firewall MDM store. By default, the Local store is queried. diff --git a/docset/winserver2022-ps/netsecurity/Get-NetFirewallHyperVVMSetting.md b/docset/winserver2022-ps/netsecurity/Get-NetFirewallHyperVVMSetting.md index 1323519fab..51a20d0078 100644 --- a/docset/winserver2022-ps/netsecurity/Get-NetFirewallHyperVVMSetting.md +++ b/docset/winserver2022-ps/netsecurity/Get-NetFirewallHyperVVMSetting.md @@ -178,4 +178,10 @@ The path after the pound sign (`#`) provides the namespace and class name for th [New-NetFirewallHyperVVMSetting](./New-NetFirewallHyperVVMSetting.md) -[Set-NetFirewallHyperVVMSetting](./Set-NetFirewallHyperVVMSetting.md) \ No newline at end of file +[Set-NetFirewallHyperVVMSetting](./Set-NetFirewallHyperVVMSetting.md) + +[Get-NetFirewallHyperVProfile](./Get-NetFirewallHyperVProfile.md) + +[New-NetFirewallHyperVProfile](./New-NetFirewallHyperVProfile.md) + +[Set-NetFirewallHyperVProfile](./Set-NetFirewallHyperVProfile.md) \ No newline at end of file diff --git a/docset/winserver2022-ps/netsecurity/New-NetFirewallHyperVProfile.md b/docset/winserver2022-ps/netsecurity/New-NetFirewallHyperVProfile.md new file mode 100644 index 0000000000..ddc7450503 --- /dev/null +++ b/docset/winserver2022-ps/netsecurity/New-NetFirewallHyperVProfile.md @@ -0,0 +1,222 @@ +--- +description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. +external help file: NetFirewallHyperVProfile.cmdletDefinition.cdxml-help.xml +Module Name: NetSecurity +ms.date: 12/27/2016 +online version: https://docs.microsoft.com/powershell/module/netsecurity/new-netfirewallhypervprofile?view=windowsserver2022-ps&wt.mc_id=ps-gethelp +schema: 2.0.0 +title: New-NetFirewallHyperVProfile +--- + +# New-NetFirewallHyperVProfile + +## SYNOPSIS +Configures Hyper-V firewall profile settings settings on the target computer. + +## SYNTAX + +``` +New-NetFirewallHyperVProfile [-PolicyStore ] [-GPOSession ] [-Name ] [-Profile {Any | Domain | Private | Public | NotApplicable}] [-CimSession ] [-ThrottleLimit ] [-AsJob] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The **New-NetFirewallHyperVProfile** cmdlet configures the Hyper-V firewall profile settings on the system. These settings are applicable to all Hyper-V firewall ports created by a specific Hyper-V firewall VM creator. These settings apply to the VM only when the profile is active. + +This cmdlet should be used when none of the following are true: a Hyper-V VM creator has registered its VM creator ID with the system, when another Hyper-V setting is already configured for the specified VM creator ID, or when a Hyper-V firewall port is created with the specified VM creator ID. If any of the above are true, the Set-NetFirewallHyperVProfile cmdlet should be used. In other words, this cmdlet can be used to configure policy prior to the application corresponding to the specific VM creator ID has running on the system. + +## EXAMPLES + +### EXAMPLE 1 +``` +PS C:\> New-NetFirewallHyperVProfile -Name '{9E288F02-CE00-4D9E-BE2B-14CE463B0298}' -Profile Public -Enabled True +``` + +This configures the Enabled setting on the Public profile for all Hyper-V firewall ports created by the Hyper-V firewall VM creator specified. + +## PARAMETERS + +### -AsJob +Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CimSession +Runs the cmdlet in a remote session or on a remote computer. +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. +The default is the current session on the local computer. + +```yaml +Type: CimSession[] +Parameter Sets: (All) +Aliases: Session +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultInboundAction +Specifies how to filter inbound traffic which does not match any Hyper-V firewall rules. +The acceptable values for this parameter are: NotConfigured, Allow, or Block. + +- Block: Blocks inbound network traffic that does not match an inbound rule. +- Allow: Allows all inbound network traffic, whether or not it matches an inbound rule. +- NotConfigured: Resets this value back to its default. + +The default setting is Block. + +```yaml +Type: Action +Parameter Sets: (All) +Aliases: +Accepted values: NotConfigured, Allow, Block + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultOutboundAction +Specifies how to filter outbound traffic which does not match any Hyper-V firewall rules. +The acceptable values for this parameter are: NotConfigured, Allow, or Block. + +- Block: Blocks outbound network traffic that does not match an outbound rule. +- Allow: Allows all outbound network traffic, whether or not it matches an outbound rule. +- NotConfigured: Resets this value back to its default. + +The default setting is Block. + +```yaml +Type: Action +Parameter Sets: (All) +Aliases: +Accepted values: NotConfigured, Allow, Block + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +Determines whether or not the Hyper-V firewall is active and enforced. +The acceptable values for this parameter are: False, True, or NotConfigured. + +- True: Enables Windows Hyper-V firewall. +- False: Disables Windows Hyper-V firewall. +- NotConfigured: Resets this value back to its default. + +The default setting is True. + +```yaml +Type: GpoBoolean +Parameter Sets: (All) +Aliases: +Accepted values: False, True, NotConfigured + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowLocalFirewallRules +Specifies that the local firewall rules should be merged into the effective policy. +The acceptable values for this parameter are: False, True, or NotConfigured. + +- True: The firewall rules defined by the local administrator are merged with firewall rules from MDM and are applied to the computer. +- False: The firewall rules defined by the local administrator are ignored, and only firewall rules from MDM are applied to the computer. +- NotConfigured: This resets the value back to the default. + +The default setting is True. + +```yaml +Type: GpoBoolean +Parameter Sets: (All) +Aliases: +Accepted values: False, True, NotConfigured + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies that the settings are applicable only to the Hyper-V firewall VM creator with the matching Id. +The format for this value is a GUID enclosed in brackets: '{9E288F02-CE00-4D9E-BE2B-14CE463B0298}'. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: VMCreatorId +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ThrottleLimit +Specifies the maximum number of concurrent operations that can be established to run the cmdlet. +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. +The throttle limit applies only to the current cmdlet, not to the session or to the computer. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +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). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Management.Infrastructure.CimInstance#root\StandardCimv2\NetFirewallHyperVProfile +The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. +The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. + +## NOTES + +## RELATED LINKS + +[Get-NetfirewallHyperVRule](./Get-NetFirewallHyperVRule.md) + +[Get-NetfirewallHyperVPort](./Get-NetFirewallHyperVPort.md) + +[Get-NetfirewallHyperVVMCreator](./Get-NetFirewallHyperVVMCreator.md) + +[Get-NetFirewallHyperVVMSetting](./Get-NetFirewallHyperVVMSetting.md) + +[Set-NetFirewallHyperVVMSetting](./Set-NetFirewallHyperVVMSetting.md) + +[Get-NetFirewallHyperVProfile](./Get-NetFirewallHyperVProfile.md) + +[New-NetFirewallHyperVProfile](./New-NetFirewallHyperVProfile.md) + +[Set-NetFirewallHyperVProfile](./Set-NetFirewallHyperVProfile.md) \ No newline at end of file diff --git a/docset/winserver2022-ps/netsecurity/New-NetFirewallHyperVRule.md b/docset/winserver2022-ps/netsecurity/New-NetFirewallHyperVRule.md index c7debd3090..818e0fe9a8 100644 --- a/docset/winserver2022-ps/netsecurity/New-NetFirewallHyperVRule.md +++ b/docset/winserver2022-ps/netsecurity/New-NetFirewallHyperVRule.md @@ -16,7 +16,7 @@ Creates a new inbound or outbound Hyper-V firewall rule and adds the rule to the ## SYNTAX ``` -New-NetFirewallHyperVRule -DisplayName [-Name ] [-RulePriority ] [-Direction {Inbound | Outbound}] [-VMCreatorId ] [-Protocol ] [-LocalAddresses ] [-LocalPorts ] [-RemoteAddresses ] [-RemotePorts ] [-Action {NotConfigured | Allow | Block}] [-Enabled {True | False}] [-CimSession ] [-ThrottleLimit ] [-AsJob] [-WhatIf] [-Confirm] [] +New-NetFirewallHyperVRule -DisplayName [-Name ] [-RulePriority ] [-Direction {Inbound | Outbound}] [-VMCreatorId ] [-Protocol ] [-LocalAddresses ] [-LocalPorts ] [-RemoteAddresses ] [-RemotePorts ] [-Action {NotConfigured | Allow | Block}] [-Enabled {True | False}] [-Profiles {Any | Domain | Private | Public | NotApplicable}] [-CimSession ] [-ThrottleLimit ] [-AsJob] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -315,13 +315,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -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. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. +### -VMCreatorId +Specifies that network packets originating from a VM matching this VMCreatorId matches this rule. The format for this value is a GUID enclosed in brackets: '{9E288F02-CE00-4D9E-BE2B-14CE463B0298}'. + +The default value is Any. ```yaml -Type: Int32 +Type: String Parameter Sets: (All) Aliases: Required: False @@ -331,13 +331,35 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -VMCreatorId -Specifies that network packets originating from a VM matching this VMCreatorId matches this rule. The format for this value is a GUID enclosed in brackets: '{9E288F02-CE00-4D9E-BE2B-14CE463B0298}'. - +### -Profiles +Specifies one or more profiles to which the hyper-v firewall rule is assigned. +The rule is active on the local computer only when the specified profile is currently active. +This relationship is many-to-many and can be indirectly modified by the user, by changing the Profiles field on instances of rules. +Only one profile is applied at a time. +The acceptable values for this parameter are: Any, Domain, Private, Public, or NotApplicable. The default value is Any. +Separate multiple entries with a comma and do not include any spaces. ```yaml -Type: String +Type: Profiles +Parameter Sets: (All) +Aliases: +Accepted values: Any, Domain, Private, Public, NotApplicable + +Required: False +Position: Named +Default value: Any +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ThrottleLimit +Specifies the maximum number of concurrent operations that can be established to run the cmdlet. +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. +The throttle limit applies only to the current cmdlet, not to the session or to the computer. + +```yaml +Type: Int32 Parameter Sets: (All) Aliases: Required: False diff --git a/docset/winserver2022-ps/netsecurity/New-NetFirewallHyperVVMSetting.md b/docset/winserver2022-ps/netsecurity/New-NetFirewallHyperVVMSetting.md index 119ea03023..ecaca2f5be 100644 --- a/docset/winserver2022-ps/netsecurity/New-NetFirewallHyperVVMSetting.md +++ b/docset/winserver2022-ps/netsecurity/New-NetFirewallHyperVVMSetting.md @@ -16,19 +16,19 @@ Configures Hyper-V firewall per-VM settings on the target computer. ## SYNTAX ``` -New-NetFirewallHyperVVMSetting [-PolicyStore ] [-GPOSession ] [-Name ] [-Enabled {False | True | NotConfigured}] [-DefaultInboundAction {NotConfigured | Allow | Block}] [-DefaultOutboundAction {NotConfigured | Allow | Block}] [-LoopbackEnabled {False | True | NotConfigured}] [-CimSession ] [-ThrottleLimit ] [-AsJob] [-WhatIf] [-Confirm] [] +New-NetFirewallHyperVVMSetting [-PolicyStore ] [-GPOSession ] [-Name ] [-Enabled {False | True | NotConfigured}] [-DefaultInboundAction {NotConfigured | Allow | Block}] [-DefaultOutboundAction {NotConfigured | Allow | Block}] [-LoopbackEnabled {False | True | NotConfigured}] [-AllowHostPolicyMerge {False | True | NotConfigured}] [-CimSession ] [-ThrottleLimit ] [-AsJob] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION The **New-NetFirewallHyperVVMSetting** cmdlet configures settings for the Hyper-V firewall per-VM settings on the system. These settings are applicable to all Hyper-V firewall ports created by a specific Hyper-V firewall VM creator. -This cmdlet should be used when none of the following are true: a Hyper-V VM creator has registered its VM creator ID with the system, when another Hyper-V per-VM setting is already configured for the specified VM creator ID, or when a Hyper-V firewall port is created with the specified VM creator ID. If any of the above are true, the Set-NetFirewallHyperVVMSetting cmdlet should be used. In other words, this cmdlet can be used to configure policy prior to the application corresponding to the specific VM creator ID has running on the system. +This cmdlet should be used when none of the following are true: a Hyper-V VM creator has registered its VM creator ID with the system, when another Hyper-V setting is already configured for the specified VM creator ID, or when a Hyper-V firewall port is created with the specified VM creator ID. If any of the above are true, the Set-NetFirewallHyperVVMSetting cmdlet should be used. In other words, this cmdlet can be used to configure policy prior to the application corresponding to the specific VM creator ID has running on the system. ## EXAMPLES ### EXAMPLE 1 ``` -PS C:\> New-NetFirewallHyperVVMSetting -Name '9E288F02-CE00-4D9E-BE2B-14CE463B0298}' -LoopbackEnabled True +PS C:\> New-NetFirewallHyperVVMSetting -Name '{9E288F02-CE00-4D9E-BE2B-14CE463B0298}' -LoopbackEnabled True ``` This configures the LoopbackEnabled setting for all Hyper-V firewall ports created by the Hyper-V firewall VM creator specified. @@ -69,6 +69,8 @@ Accept wildcard characters: False Specifies how to filter inbound traffic which does not match any Hyper-V firewall rules. The acceptable values for this parameter are: NotConfigured, Allow, or Block. +This setting applies the configuration to all profiles. For configuring at a per-profile granularity, use the `New-NetFirewallHyperVProfile` cmdlet. + - Block: Blocks inbound network traffic that does not match an inbound rule. - Allow: Allows all inbound network traffic, whether or not it matches an inbound rule. - NotConfigured: Resets this value back to its default. @@ -90,7 +92,9 @@ Accept wildcard characters: False ### -DefaultOutboundAction Specifies how to filter outbound traffic which does not match any Hyper-V firewall rules. -The acceptable values for this parameter are: NotConfigured, Allow, or Block. +The acceptable values for this parameter are: NotConfigured, Allow, or Block. + +This setting applies the configuration to all profiles. For configuring at a per-profile granularity, use the `New-NetFirewallHyperVProfile` cmdlet. - Block: Blocks outbound network traffic that does not match an outbound rule. - Allow: Allows all outbound network traffic, whether or not it matches an outbound rule. @@ -113,7 +117,9 @@ Accept wildcard characters: False ### -Enabled Determines whether or not the Hyper-V firewall is active and enforced. -The acceptable values for this parameter are: False, True, or NotConfigured. +The acceptable values for this parameter are: False, True, or NotConfigured. + +This setting applies the configuration to all profiles. For configuring at a per-profile granularity, use the `New-NetFirewallHyperVProfile` cmdlet. - True: Enables Windows Hyper-V firewall. - False: Disables Windows Hyper-V firewall. @@ -137,8 +143,6 @@ Accept wildcard characters: False ### -LoopbackEnabled Determines whether or not guest-host loopback traffic is allowed. -This setting is orthogonal to any existing Hyper-V firewall rules. That is, both this setting and the set of Hyper-V firewall rules must both be configured to allow guest-host communication. Furthermore, if either this setting or a Hyper-V firewall rule blocks the communication, it will be blocked. - The acceptable values for this parameter are: False, True, or NotConfigured. - True: Hyper-V firewall allows traffic between guest and host. @@ -160,6 +164,39 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -AllowHostPolicyMerge +Specifies that the host firewall policy should be merged into the effective policy. + +This setting controls whether host firewall profile settings (DefaultInboundAction, DefaultOutboundAction, Enabled, AllowLocalFirewallRules) as well as host firewall rules (only rules which are IP 5-tuple based, i.e, not having any local conditions such as application) should be applicable to Hyper-V firewall. + +Policy configurations may come from many stores. If this setting is True, the following order of precedence is used for determining the effective policy (highest priority to lowest priority): +- Host Firewall Group Policy +- Hyper-V Firewall MDM +- Host Firewall MDM +- Hyper-V Firewall Local +- Host Firewall Local + +The acceptable values for this parameter are: False, True, or NotConfigured. + +- True: Host firewall rules and settings are applied to Hyper-V Firewall. +- False: Host firewall rules and settings are not applied to Hyper-V firewall +- NotConfigured: Resets this value back to its default. + +The default setting is True. + +```yaml +Type: GpoBoolean +Parameter Sets: (All) +Aliases: +Accepted values: False, True, NotConfigured + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Name Specifies that the settings are applicable only to the Hyper-V firewall VM creator with the matching Id. The format for this value is a GUID enclosed in brackets: '{9E288F02-CE00-4D9E-BE2B-14CE463B0298}'. @@ -216,4 +253,10 @@ The path after the pound sign (`#`) provides the namespace and class name for th [Get-NetFirewallHyperVVMSetting](./Get-NetFirewallHyperVVMSetting.md) -[Set-NetFirewallHyperVVMSetting](./Set-NetFirewallHyperVVMSetting.md) \ No newline at end of file +[Set-NetFirewallHyperVVMSetting](./Set-NetFirewallHyperVVMSetting.md) + +[Get-NetFirewallHyperVProfile](./Get-NetFirewallHyperVProfile.md) + +[New-NetFirewallHyperVProfile](./New-NetFirewallHyperVProfile.md) + +[Set-NetFirewallHyperVProfile](./Set-NetFirewallHyperVProfile.md) \ No newline at end of file diff --git a/docset/winserver2022-ps/netsecurity/Set-NetFirewallHyperVProfile.md b/docset/winserver2022-ps/netsecurity/Set-NetFirewallHyperVProfile.md new file mode 100644 index 0000000000..6ede9e1388 --- /dev/null +++ b/docset/winserver2022-ps/netsecurity/Set-NetFirewallHyperVProfile.md @@ -0,0 +1,222 @@ +--- +description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. +external help file: NetFirewallHyperVProfile.cmdletDefinition.cdxml-help.xml +Module Name: NetSecurity +ms.date: 12/27/2016 +online version: https://docs.microsoft.com/powershell/module/netsecurity/set-netfirewallhypervprofile?view=windowsserver2022-ps&wt.mc_id=ps-gethelp +schema: 2.0.0 +title: Set-NetFirewallHyperVProfile +--- + +# Set-NetFirewallHyperVProfile + +## SYNOPSIS +Configures Hyper-V firewall profile settings settings on the target computer. + +## SYNTAX + +``` +Set-NetFirewallHyperVProfile [-PolicyStore ] [-GPOSession ] [-Name ] [-Profile {Any | Domain | Private | Public | NotApplicable}] [-CimSession ] [-ThrottleLimit ] [-AsJob] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +The **Set-NetFirewallHyperVProfile** cmdlet configures the Hyper-V firewall profile settings on the system. These settings are applicable to all Hyper-V firewall ports created by a specific Hyper-V firewall VM creator. These settings apply to the VM only when the profile is active. + +This cmdlet should be used when a Hyper-V VM creator has registered its VM creator ID with the system, when another Hyper-V setting is already configured for the specified VM creator ID, or when a Hyper-V firewall port is created with the specified VM creator ID. If none of the above are true, then the New-NetFirewallHyperVProfile cmdlet should be used. + +## EXAMPLES + +### EXAMPLE 1 +``` +PS C:\> Set-NetFirewallHyperVProfile -Name '{9E288F02-CE00-4D9E-BE2B-14CE463B0298}' -Profile Public -Enabled True +``` + +This configures the Enabled setting on the Public profile for all Hyper-V firewall ports created by the Hyper-V firewall VM creator specified. + +## PARAMETERS + +### -AsJob +Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CimSession +Runs the cmdlet in a remote session or on a remote computer. +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. +The default is the current session on the local computer. + +```yaml +Type: CimSession[] +Parameter Sets: (All) +Aliases: Session +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultInboundAction +Specifies how to filter inbound traffic which does not match any Hyper-V firewall rules. +The acceptable values for this parameter are: NotConfigured, Allow, or Block. + +- Block: Blocks inbound network traffic that does not match an inbound rule. +- Allow: Allows all inbound network traffic, whether or not it matches an inbound rule. +- NotConfigured: Resets this value back to its default. + +The default setting is Block. + +```yaml +Type: Action +Parameter Sets: (All) +Aliases: +Accepted values: NotConfigured, Allow, Block + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultOutboundAction +Specifies how to filter outbound traffic which does not match any Hyper-V firewall rules. +The acceptable values for this parameter are: NotConfigured, Allow, or Block. + +- Block: Blocks outbound network traffic that does not match an outbound rule. +- Allow: Allows all outbound network traffic, whether or not it matches an outbound rule. +- NotConfigured: Resets this value back to its default. + +The default setting is Block. + +```yaml +Type: Action +Parameter Sets: (All) +Aliases: +Accepted values: NotConfigured, Allow, Block + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +Determines whether or not the Hyper-V firewall is active and enforced. +The acceptable values for this parameter are: False, True, or NotConfigured. + +- True: Enables Windows Hyper-V firewall. +- False: Disables Windows Hyper-V firewall. +- NotConfigured: Resets this value back to its default. + +The default setting is True. + +```yaml +Type: GpoBoolean +Parameter Sets: (All) +Aliases: +Accepted values: False, True, NotConfigured + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AllowLocalFirewallRules +Specifies that the local firewall rules should be merged into the effective policy. +The acceptable values for this parameter are: False, True, or NotConfigured. + +- True: The firewall rules defined by the local administrator are merged with firewall rules from MDM and are applied to the computer. +- False: The firewall rules defined by the local administrator are ignored, and only firewall rules from MDM are applied to the computer. +- NotConfigured: This resets the value back to the default. + +The default setting is True. + +```yaml +Type: GpoBoolean +Parameter Sets: (All) +Aliases: +Accepted values: False, True, NotConfigured + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Specifies that the settings are applicable only to the Hyper-V firewall VM creator with the matching Id. +The format for this value is a GUID enclosed in brackets: '{9E288F02-CE00-4D9E-BE2B-14CE463B0298}'. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: VMCreatorId +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ThrottleLimit +Specifies the maximum number of concurrent operations that can be established to run the cmdlet. +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. +The throttle limit applies only to the current cmdlet, not to the session or to the computer. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +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). + +## INPUTS + +### None + +## OUTPUTS + +### Microsoft.Management.Infrastructure.CimInstance#root\StandardCimv2\NetFirewallHyperVProfile +The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. +The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. + +## NOTES + +## RELATED LINKS + +[Get-NetfirewallHyperVRule](./Get-NetFirewallHyperVRule.md) + +[Get-NetfirewallHyperVPort](./Get-NetFirewallHyperVPort.md) + +[Get-NetfirewallHyperVVMCreator](./Get-NetFirewallHyperVVMCreator.md) + +[Get-NetFirewallHyperVVMSetting](./Get-NetFirewallHyperVVMSetting.md) + +[Set-NetFirewallHyperVVMSetting](./Set-NetFirewallHyperVVMSetting.md) + +[Get-NetFirewallHyperVProfile](./Get-NetFirewallHyperVProfile.md) + +[New-NetFirewallHyperVProfile](./New-NetFirewallHyperVProfile.md) + +[Set-NetFirewallHyperVProfile](./Set-NetFirewallHyperVProfile.md) \ No newline at end of file diff --git a/docset/winserver2022-ps/netsecurity/Set-NetFirewallHyperVVMSetting.md b/docset/winserver2022-ps/netsecurity/Set-NetFirewallHyperVVMSetting.md index 4cea4b68ce..0c7c1fbd8c 100644 --- a/docset/winserver2022-ps/netsecurity/Set-NetFirewallHyperVVMSetting.md +++ b/docset/winserver2022-ps/netsecurity/Set-NetFirewallHyperVVMSetting.md @@ -26,7 +26,7 @@ Set-NetFirewallHyperVVMSetting -InputObject Date: Mon, 21 Aug 2023 10:21:54 -0700 Subject: [PATCH 604/650] update rule set with profile arg --- .../netsecurity/Set-NetFirewallHyperVRule.md | 47 ++++++++++++++----- 1 file changed, 34 insertions(+), 13 deletions(-) diff --git a/docset/winserver2022-ps/netsecurity/Set-NetFirewallHyperVRule.md b/docset/winserver2022-ps/netsecurity/Set-NetFirewallHyperVRule.md index 201dd4e29f..e99e352d38 100644 --- a/docset/winserver2022-ps/netsecurity/Set-NetFirewallHyperVRule.md +++ b/docset/winserver2022-ps/netsecurity/Set-NetFirewallHyperVRule.md @@ -16,16 +16,15 @@ Modifies existing Hyper-V firewall rules. ## SYNTAX ``` -Set-NetFirewallHyperVRule [-Name] [-NewDisplayName ] [-RulePriority ] [-Direction {Inbound | Outbound}] [-VMCreatorId ] [-Protocol ] [-LocalAddresses ] [-LocalPorts ] [-RemoteAddresses ] [-RemotePorts ] [-Action {NotConfigured | Allow | Block}] [-Enabled {True | False}] [-CimSession ] [-ThrottleLimit -] [-AsJob] [-PassThru] [-WhatIf] [-Confirm] [] +Set-NetFirewallHyperVRule [-Name] [-NewDisplayName ] [-RulePriority ] [-Direction {Inbound | Outbound}] [-VMCreatorId ] [-Protocol ] [-LocalAddresses ] [-LocalPorts ] [-RemoteAddresses ] [-RemotePorts ] [-Action {NotConfigured | Allow | Block}] [-Enabled {True | False}] [-Profiles {Any | Domain | Private | Public | NotApplicable}] [-CimSession ] [-ThrottleLimit ] [-AsJob] [-PassThru] [-WhatIf] [-Confirm] [] ``` ``` -Set-NetFirewallHyperVRule -DisplayName [-NewDisplayName ] [-RulePriority ] [-Direction {Inbound | Outbound}] [-VMCreatorId ] [-Protocol ] [-LocalAddresses ] [-LocalPorts ] [-RemoteAddresses ] [-RemotePorts ] [-Action {NotConfigured | Allow | Block}] [-Enabled {True | False}] [-CimSession ] [-ThrottleLimit ] [-AsJob] [-PassThru] [-WhatIf] [-Confirm] [] +Set-NetFirewallHyperVRule -DisplayName [-NewDisplayName ] [-RulePriority ] [-Direction {Inbound | Outbound}] [-VMCreatorId ] [-Protocol ] [-LocalAddresses ] [-LocalPorts ] [-RemoteAddresses ] [-RemotePorts ] [-Action {NotConfigured | Allow | Block}] [-Enabled {True | False}] [-Profiles {Any | Domain | Private | Public | NotApplicable}] [-CimSession ] [-ThrottleLimit ] [-AsJob] [-PassThru] [-WhatIf] [-Confirm] [] ``` ``` -Set-NetFirewallHyperVRule -InputObject [-NewDisplayName ] [-RulePriority ] [-Direction {Inbound | Outbound}] [-VMCreatorId ] [-Protocol ] [-LocalAddresses ] [-LocalPorts ] [-RemoteAddresses ] [-RemotePorts ] [-Action {NotConfigured | Allow | Block}] [-Enabled {True | False}] [-CimSession ] [-ThrottleLimit ] [-AsJob] [-PassThru] [-WhatIf] [-Confirm] [] +Set-NetFirewallHyperVRule -InputObject [-NewDisplayName ] [-RulePriority ] [-Direction {Inbound | Outbound}] [-VMCreatorId ] [-Protocol ] [-LocalAddresses ] [-LocalPorts ] [-RemoteAddresses ] [-RemotePorts ] [-Action {NotConfigured | Allow | Block}] [-Enabled {True | False}] [-Profiles {Any | Domain | Private | Public | NotApplicable}] [-CimSession ] [-ThrottleLimit ] [-AsJob] [-PassThru] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -308,13 +307,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -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. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. +### -VMCreatorId +Updates the VMCreatorId value of the matching Hyper-V firewall rules. +This parameter specifies that network packets originating from a VM matching this VMCreatorId matches this rule. The format for this value is a GUID enclosed in brackets: '{9E288F02-CE00-4D9E-BE2B-14CE463B0298}'. ```yaml -Type: Int32 +Type: String Parameter Sets: (All) Aliases: Required: False @@ -324,12 +322,35 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -VMCreatorId -Updates the VMCreatorId value of the matching Hyper-V firewall rules. -This parameter specifies that network packets originating from a VM matching this VMCreatorId matches this rule. The format for this value is a GUID enclosed in brackets: '{9E288F02-CE00-4D9E-BE2B-14CE463B0298}'. +### -Profiles +Specifies one or more profiles to which the hyper-v firewall rule is assigned. +The rule is active on the local computer only when the specified profile is currently active. +This relationship is many-to-many and can be indirectly modified by the user, by changing the Profiles field on instances of rules. +Only one profile is applied at a time. +The acceptable values for this parameter are: Any, Domain, Private, Public, or NotApplicable. +The default value is Any. +Separate multiple entries with a comma and do not include any spaces. ```yaml -Type: String +Type: Profiles +Parameter Sets: (All) +Aliases: +Accepted values: Any, Domain, Private, Public, NotApplicable + +Required: False +Position: Named +Default value: Any +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ThrottleLimit +Specifies the maximum number of concurrent operations that can be established to run the cmdlet. +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. +The throttle limit applies only to the current cmdlet, not to the session or to the computer. + +```yaml +Type: Int32 Parameter Sets: (All) Aliases: Required: False From e728e136c388fc62e89a019fe104d595283c8d86 Mon Sep 17 00:00:00 2001 From: Matt Ige Date: Fri, 25 Aug 2023 16:28:58 -0700 Subject: [PATCH 605/650] Address CR --- .../netsecurity/Disable-NetFirewallHyperVRule.md | 9 +++++++-- .../netsecurity/Enable-NetFirewallHyperVRule.md | 7 ++++++- .../netsecurity/Get-NetFirewallHyperVPort.md | 5 +++-- .../netsecurity/Get-NetFirewallHyperVProfile.md | 4 +++- .../netsecurity/Get-NetFirewallHyperVRule.md | 6 +++++- .../netsecurity/Get-NetFirewallHyperVVMCreator.md | 3 ++- .../netsecurity/Get-NetFirewallHyperVVMSetting.md | 4 +++- .../netsecurity/New-NetFirewallHyperVProfile.md | 2 +- .../netsecurity/New-NetFirewallHyperVVMSetting.md | 2 +- .../netsecurity/Remove-NetFirewallHyperVRule.md | 7 ++++++- .../netsecurity/Rename-NetFirewallHyperVRule.md | 7 ++++++- .../netsecurity/Set-NetFirewallHyperVProfile.md | 3 ++- .../netsecurity/Set-NetFirewallHyperVRule.md | 5 ++++- .../netsecurity/Set-NetFirewallHyperVVMSetting.md | 4 +++- 14 files changed, 52 insertions(+), 16 deletions(-) diff --git a/docset/winserver2022-ps/netsecurity/Disable-NetFirewallHyperVRule.md b/docset/winserver2022-ps/netsecurity/Disable-NetFirewallHyperVRule.md index c68667216e..3914ed5ef1 100644 --- a/docset/winserver2022-ps/netsecurity/Disable-NetFirewallHyperVRule.md +++ b/docset/winserver2022-ps/netsecurity/Disable-NetFirewallHyperVRule.md @@ -2,7 +2,7 @@ description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. external help file: NetFirewallHyperVRule.cmdletDefinition.cdxml-help.xml Module Name: NetSecurity -ms.date: 12/27/2016 +ms.date: 8/25/2023 online version: https://docs.microsoft.com/powershell/module/netsecurity/disable-netfirewallhypervrule?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Disable-NetFirewallHyperVRule @@ -15,22 +15,27 @@ Disables one or more Hyper-V firewall rules that match the specified criteria. ## SYNTAX +### GetAll (Default) ``` Disable-NetFirewallHyperVRule [-All] [-PolicyStore ] [-CimSession ] [-ThrottleLimit ] [-AsJob] [-PassThru] [-WhatIf] [-Confirm] [] ``` +### ByName ``` Disable-NetFirewallHyperVRule [-Name] [-PolicyStore ] [-CimSession ] [-ThrottleLimit ] [-AsJob] [-PassThru] [-WhatIf] [-Confirm] [] ``` +### ByDisplayName ``` Disable-NetFirewallHyperVRule -DisplayName [-PolicyStore ] [-CimSession ] [-ThrottleLimit ] [-AsJob] [-PassThru] [-WhatIf] [-Confirm] [] ``` +### ByQuery ``` Disable-NetFirewallHyperVRule [-Direction {Inbound | Outbound}] [-VMCreatorId ] [-Protocol ] [-Action {NotConfigured | Allow | Block}] [-Enabled {True | False}] [-EnforcementStatus {Unknown | OK | PartiallyEnforced | NoApplicablePorts | ParsingError | Error}] [-PolicyStoreSourceType {None | Local | MDM}] [-PolicyStore ] [-CimSession ] [-ThrottleLimit ] [-AsJob] [-PassThru] [-WhatIf] [-Confirm] [] ``` +### InputObject (cdxml) ``` Disable-NetFirewallHyperVRule -InputObject [-CimSession ] [-ThrottleLimit ] [-AsJob] [-PassThru] [-WhatIf] [-Confirm] [] ``` @@ -40,7 +45,7 @@ IMPORTANT NOTE: Running this cmdlet without parameters disables all Windows Hype The **Disable-NetFirewallHyperVRule** cmdlet disables a previously enabled Hyper-V firewall rule to be inactive. A Disabled rule will not actively modify system behavior, but the rule still exists on the computer so it can be re-enabled later. This is different from the Remove-NetFirewallHyperVRule cmdlet, which will permanently remove the rule. -This cmdlet gets disables one or more Hyper-V firewall rules with the Name parameter, DisplayName parameter, or rule properties. +This cmdlet disables one or more Hyper-V firewall rules with the Name parameter, DisplayName parameter, or rule properties. Disabling Hyper-V firewall rules can be useful for debugging Hyper-V firewall policy mismatch issues. diff --git a/docset/winserver2022-ps/netsecurity/Enable-NetFirewallHyperVRule.md b/docset/winserver2022-ps/netsecurity/Enable-NetFirewallHyperVRule.md index a167f68b52..e8a15000d7 100644 --- a/docset/winserver2022-ps/netsecurity/Enable-NetFirewallHyperVRule.md +++ b/docset/winserver2022-ps/netsecurity/Enable-NetFirewallHyperVRule.md @@ -2,7 +2,7 @@ description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. external help file: NetFirewallHyperVRule.cmdletDefinition.cdxml-help.xml Module Name: NetSecurity -ms.date: 12/27/2016 +ms.date: 8/25/2023 online version: https://docs.microsoft.com/powershell/module/netsecurity/enable-netfirewallhypervrule?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Enable-NetFirewallHyperVRule @@ -15,22 +15,27 @@ Enables one or more Hyper-V firewall rules that match the specified criteria. ## SYNTAX +### GetAll (Default) ``` Enable-NetFirewallHyperVRule [-All] [-PolicyStore ] [-CimSession ] [-ThrottleLimit ] [-AsJob] [-PassThru] [-WhatIf] [-Confirm] [] ``` +### ByName ``` Enable-NetFirewallHyperVRule [-Name] [-PolicyStore ] [-CimSession ] [-ThrottleLimit ] [-AsJob] [-PassThru] [-WhatIf] [-Confirm] [] ``` +### ByDisplayName ``` Enable-NetFirewallHyperVRule -DisplayName [-PolicyStore ] [-CimSession ] [-ThrottleLimit ] [-AsJob] [-PassThru] [-WhatIf] [-Confirm] [] ``` +### ByQuery ``` Enable-NetFirewallHyperVRule [-Direction {Inbound | Outbound}] [-VMCreatorId ] [-Protocol ] [-Action {NotConfigured | Allow | Block}] [-Enabled {True | False}] [-EnforcementStatus {Unknown | OK | PartiallyEnforced | NoApplicablePorts | ParsingError | Error}] [-PolicyStoreSourceType {None | Local | MDM}] [-PolicyStore ] [-CimSession ] [-ThrottleLimit ] [-AsJob] [-PassThru] [-WhatIf] [-Confirm] [] ``` +### InputObject (cdxml) ``` Enable-NetFirewallHyperVRule -InputObject [-CimSession ] [-ThrottleLimit ] [-AsJob] [-PassThru] [-WhatIf] [-Confirm] [] ``` diff --git a/docset/winserver2022-ps/netsecurity/Get-NetFirewallHyperVPort.md b/docset/winserver2022-ps/netsecurity/Get-NetFirewallHyperVPort.md index 95c1575fb6..620010d8c8 100644 --- a/docset/winserver2022-ps/netsecurity/Get-NetFirewallHyperVPort.md +++ b/docset/winserver2022-ps/netsecurity/Get-NetFirewallHyperVPort.md @@ -2,19 +2,20 @@ description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. external help file: NetFirewallHyperVPort.cmdletDefinition.cdxml-help.xml Module Name: NetSecurity -ms.date: 12/27/2016 +ms.date: 8/25/2023 online version: https://docs.microsoft.com/powershell/module/netsecurity/get-netfirewallhypervport?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Get-NetFirewallHyperVPort --- -# Get-NetFirewallHyperVRule +# Get-NetFirewallHyperVPort ## SYNOPSIS Retrieves Hyper-V firewall ports from the target computer. ## SYNTAX +### GetAll (Default) ``` Get-NetFirewallHyperVPort [-All] [-CimSession ] [-ThrottleLimit ] [-AsJob] [] ``` diff --git a/docset/winserver2022-ps/netsecurity/Get-NetFirewallHyperVProfile.md b/docset/winserver2022-ps/netsecurity/Get-NetFirewallHyperVProfile.md index e2d21c70e5..81203107d7 100644 --- a/docset/winserver2022-ps/netsecurity/Get-NetFirewallHyperVProfile.md +++ b/docset/winserver2022-ps/netsecurity/Get-NetFirewallHyperVProfile.md @@ -2,7 +2,7 @@ description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. external help file: NetFirewallHyperVProfile.cmdletDefinition.cdxml-help.xml Module Name: NetSecurity -ms.date: 12/27/2016 +ms.date: 8/25/2023 online version: https://docs.microsoft.com/powershell/module/netsecurity/get-netfirewallhypervprofile?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Get-NetFirewallHyperVProfile @@ -15,10 +15,12 @@ Retrieves Hyper-V firewall per-profile settings from the target computer. ## SYNTAX +### GetAll (Default) ``` Get-NetFirewallHyperVProfile [-All] [-PolicyStore ] [-CimSession ] [-ThrottleLimit ] [-AsJob] [] ``` +### ByName ``` Get-NetFirewallHyperVProfile [[-Name] ] [-Profile {Any | Domain | Private | Public | NotApplicable}] [-CimSession ] [-ThrottleLimit ] [-AsJob] [] ``` diff --git a/docset/winserver2022-ps/netsecurity/Get-NetFirewallHyperVRule.md b/docset/winserver2022-ps/netsecurity/Get-NetFirewallHyperVRule.md index e996f90412..07ccca8007 100644 --- a/docset/winserver2022-ps/netsecurity/Get-NetFirewallHyperVRule.md +++ b/docset/winserver2022-ps/netsecurity/Get-NetFirewallHyperVRule.md @@ -2,7 +2,7 @@ description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. external help file: NetFirewallHyperVRule.cmdletDefinition.cdxml-help.xml Module Name: NetSecurity -ms.date: 12/27/2016 +ms.date: 8/25/2023 online version: https://docs.microsoft.com/powershell/module/netsecurity/get-netfirewallhypervrule?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Get-NetFirewallHyperVRule @@ -15,18 +15,22 @@ Retrieves Hyper-V firewall rules from the target computer. ## SYNTAX +### GetAll (Default) ``` Get-NetFirewallHyperVRule [-All] [-PolicyStore ] [-CimSession ] [-ThrottleLimit ] [-AsJob] [] ``` +### ByName ``` Get-NetFirewallHyperVRule [-Name] [-PolicyStore ] [-CimSession ] [-ThrottleLimit ] [-AsJob] [] ``` +### ByDisplayName ``` Get-NetFirewallHyperVRule -DisplayName [-PolicyStore ] [-CimSession ] [-ThrottleLimit ] [-AsJob] [] ``` +### ByQuery ``` Get-NetFirewallHyperVRule [-Direction {Inbound | Outbound}] [-VMCreatorId ] [-Protocol ] [-Action {NotConfigured | Allow | Block}] [-Enabled {True | False}] [-EnforcementStatus {Unknown | OK | PartiallyEnforced | NoApplicablePorts | ParsingError | Error}] [-PolicyStoreSourceType {None | Local | GroupPolicy | Dynamic | Generated | Hardcoded | MDM | HostFirewallLocal | HostFirewallGroupPolicy | HostFirewallDynamic | HostFirewallMDM}] [-PolicyStore ] [-CimSession ] [-ThrottleLimit ] [-AsJob] [] ``` diff --git a/docset/winserver2022-ps/netsecurity/Get-NetFirewallHyperVVMCreator.md b/docset/winserver2022-ps/netsecurity/Get-NetFirewallHyperVVMCreator.md index 663aa55dc9..926fc59829 100644 --- a/docset/winserver2022-ps/netsecurity/Get-NetFirewallHyperVVMCreator.md +++ b/docset/winserver2022-ps/netsecurity/Get-NetFirewallHyperVVMCreator.md @@ -2,7 +2,7 @@ description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. external help file: NetFirewallHyperVVMCreator.cmdletDefinition.cdxml-help.xml Module Name: NetSecurity -ms.date: 12/27/2016 +ms.date: 8/25/2023 online version: https://docs.microsoft.com/powershell/module/netsecurity/get-netfirewallhypervvmcreator?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Get-NetFirewallHyperVVMCreator @@ -15,6 +15,7 @@ Retrieves Hyper-V firewall VM Creators from the target computer. ## SYNTAX +### GetAll (Default) ``` Get-NetFirewallHyperVVMCreator [-All] [-CimSession ] [-ThrottleLimit ] [-AsJob] [] ``` diff --git a/docset/winserver2022-ps/netsecurity/Get-NetFirewallHyperVVMSetting.md b/docset/winserver2022-ps/netsecurity/Get-NetFirewallHyperVVMSetting.md index 51a20d0078..7cae50c094 100644 --- a/docset/winserver2022-ps/netsecurity/Get-NetFirewallHyperVVMSetting.md +++ b/docset/winserver2022-ps/netsecurity/Get-NetFirewallHyperVVMSetting.md @@ -2,7 +2,7 @@ description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. external help file: NetFirewallHyperVVMSetting.cmdletDefinition.cdxml-help.xml Module Name: NetSecurity -ms.date: 12/27/2016 +ms.date: 8/25/2023 online version: https://docs.microsoft.com/powershell/module/netsecurity/get-netfirewallhypervvmsetting?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Get-NetFirewallHyperVVMSetting @@ -15,10 +15,12 @@ Retrieves Hyper-V firewall per-VM settings from the target computer. ## SYNTAX +### GetAll (Default) ``` Get-NetFirewallHyperVVMSetting [-All] [-PolicyStore ] [-CimSession ] [-ThrottleLimit ] [-AsJob] [] ``` +### ByName ``` Get-NetFirewallHyperVVMSetting [-Name] [-PolicyStore ] [-CimSession ] [-ThrottleLimit ] [-AsJob] [] ``` diff --git a/docset/winserver2022-ps/netsecurity/New-NetFirewallHyperVProfile.md b/docset/winserver2022-ps/netsecurity/New-NetFirewallHyperVProfile.md index ddc7450503..980261e8c4 100644 --- a/docset/winserver2022-ps/netsecurity/New-NetFirewallHyperVProfile.md +++ b/docset/winserver2022-ps/netsecurity/New-NetFirewallHyperVProfile.md @@ -2,7 +2,7 @@ description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. external help file: NetFirewallHyperVProfile.cmdletDefinition.cdxml-help.xml Module Name: NetSecurity -ms.date: 12/27/2016 +ms.date: 8/25/2023 online version: https://docs.microsoft.com/powershell/module/netsecurity/new-netfirewallhypervprofile?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: New-NetFirewallHyperVProfile diff --git a/docset/winserver2022-ps/netsecurity/New-NetFirewallHyperVVMSetting.md b/docset/winserver2022-ps/netsecurity/New-NetFirewallHyperVVMSetting.md index ecaca2f5be..47d1af30b7 100644 --- a/docset/winserver2022-ps/netsecurity/New-NetFirewallHyperVVMSetting.md +++ b/docset/winserver2022-ps/netsecurity/New-NetFirewallHyperVVMSetting.md @@ -2,7 +2,7 @@ description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. external help file: NetFirewallHyperVVMSetting.cmdletDefinition.cdxml-help.xml Module Name: NetSecurity -ms.date: 12/27/2016 +ms.date: 8/25/2023 online version: https://docs.microsoft.com/powershell/module/netsecurity/new-netfirewallhypervvmsetting?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: New-NetFirewallHyperVVMSetting diff --git a/docset/winserver2022-ps/netsecurity/Remove-NetFirewallHyperVRule.md b/docset/winserver2022-ps/netsecurity/Remove-NetFirewallHyperVRule.md index 3104d876f9..284f07ca98 100644 --- a/docset/winserver2022-ps/netsecurity/Remove-NetFirewallHyperVRule.md +++ b/docset/winserver2022-ps/netsecurity/Remove-NetFirewallHyperVRule.md @@ -2,7 +2,7 @@ description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. external help file: NetFirewallHyperVRule.cmdletDefinition.cdxml-help.xml Module Name: NetSecurity -ms.date: 12/27/2016 +ms.date: 8/25/2023 online version: https://docs.microsoft.com/powershell/module/netsecurity/remove-netfirewallhypervrule?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Remove-NetFirewallHyperVRule @@ -15,22 +15,27 @@ Deletes one or more Hyper-V firewall rules that match the specified criteria. ## SYNTAX +### GetAll (Default) ``` Remove-NetFirewallHyperVRule [-All] [-PolicyStore ] [-CimSession ] [-ThrottleLimit ] [-AsJob] [-PassThru] [-WhatIf] [-Confirm] [] ``` +### ByName ``` Remove-NetFirewallHyperVRule [-Name] [-PolicyStore ] [-CimSession ] [-ThrottleLimit ] [-AsJob] [-PassThru] [-WhatIf] [-Confirm] [] ``` +### ByDisplayName ``` Remove-NetFirewallHyperVRule -DisplayName [-PolicyStore ] [-CimSession ] [-ThrottleLimit ] [-AsJob] [-PassThru] [-WhatIf] [-Confirm] [] ``` +### ByQuery ``` Remove-NetFirewallHyperVRule [-Direction {Inbound | Outbound}] [-VMCreatorId ] [-Protocol ] [-Action {NotConfigured | Allow | Block}] [-Enabled {True | False}] [-EnforcementStatus {Unknown | OK | PartiallyEnforced | NoApplicablePorts | ParsingError | Error}] [-PolicyStoreSourceType {None | Local | MDM}] [-PolicyStore ] [-CimSession ] [-ThrottleLimit ] [-AsJob] [-PassThru] [-WhatIf] [-Confirm] [] ``` +### InputObject (cdxml) ``` Remove-NetFirewallHyperVRule -InputObject [-CimSession ] [-ThrottleLimit ] [-AsJob] [-PassThru] [-WhatIf] [-Confirm] [] ``` diff --git a/docset/winserver2022-ps/netsecurity/Rename-NetFirewallHyperVRule.md b/docset/winserver2022-ps/netsecurity/Rename-NetFirewallHyperVRule.md index 19a1c4e977..0c459fc3f0 100644 --- a/docset/winserver2022-ps/netsecurity/Rename-NetFirewallHyperVRule.md +++ b/docset/winserver2022-ps/netsecurity/Rename-NetFirewallHyperVRule.md @@ -2,7 +2,7 @@ description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. external help file: NetFirewallHyperVRule.cmdletDefinition.cdxml-help.xml Module Name: NetSecurity -ms.date: 12/27/2016 +ms.date: 8/25/2023 online version: https://docs.microsoft.com/powershell/module/netsecurity/rename-netfirewallhypervrule?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Rename-NetFirewallHyperVRule @@ -15,22 +15,27 @@ Renames a single Hyper-V firewall rule. ## SYNTAX +### GetAll (Default) ``` Rename-NetFirewallHyperVRule -NewName [-All] [-PolicyStore ] [-CimSession ] [-ThrottleLimit ] [-AsJob] [-PassThru] [-WhatIf] [-Confirm] [] ``` +### ByName ``` Rename-NetFirewallHyperVRule [-Name] -NewName [-PolicyStore ] [-CimSession ] [-ThrottleLimit ] [-AsJob] [-PassThru] [-WhatIf] [-Confirm] [] ``` +### ByDisplayName ``` Rename-NetFirewallHyperVRule -DisplayName -NewName [-PolicyStore ] [-CimSession ] [-ThrottleLimit ] [-AsJob] [-PassThru] [-WhatIf] [-Confirm] [] ``` +### ByQuery ``` Rename-NetFirewallHyperVRule -NewName [-Direction {Inbound | Outbound}] [-VMCreatorId ] [-Protocol ] [-Action {NotConfigured | Allow | Block}] [-Enabled {True | False}] [-EnforcementStatus {Unknown | OK | PartiallyEnforced | NoApplicablePorts | ParsingError | Error}] [-PolicyStoreSourceType {None | Local | MDM}] [-PolicyStore ] [-CimSession ] [-ThrottleLimit ] [-AsJob] [-PassThru] [-WhatIf] [-Confirm] [] ``` +### InputObject (cdxml) ``` Rename-NetFirewallHyperVRule -InputObject -NewName [-CimSession ] [-ThrottleLimit ] [-AsJob] [-PassThru] [-WhatIf] [-Confirm] [] ``` diff --git a/docset/winserver2022-ps/netsecurity/Set-NetFirewallHyperVProfile.md b/docset/winserver2022-ps/netsecurity/Set-NetFirewallHyperVProfile.md index 6ede9e1388..2c91bb8299 100644 --- a/docset/winserver2022-ps/netsecurity/Set-NetFirewallHyperVProfile.md +++ b/docset/winserver2022-ps/netsecurity/Set-NetFirewallHyperVProfile.md @@ -2,7 +2,7 @@ description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. external help file: NetFirewallHyperVProfile.cmdletDefinition.cdxml-help.xml Module Name: NetSecurity -ms.date: 12/27/2016 +ms.date: 8/25/2023 online version: https://docs.microsoft.com/powershell/module/netsecurity/set-netfirewallhypervprofile?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Set-NetFirewallHyperVProfile @@ -15,6 +15,7 @@ Configures Hyper-V firewall profile settings settings on the target computer. ## SYNTAX +### Query (cdxml) (Default) ``` Set-NetFirewallHyperVProfile [-PolicyStore ] [-GPOSession ] [-Name ] [-Profile {Any | Domain | Private | Public | NotApplicable}] [-CimSession ] [-ThrottleLimit ] [-AsJob] [-WhatIf] [-Confirm] [] ``` diff --git a/docset/winserver2022-ps/netsecurity/Set-NetFirewallHyperVRule.md b/docset/winserver2022-ps/netsecurity/Set-NetFirewallHyperVRule.md index e99e352d38..d9290941fd 100644 --- a/docset/winserver2022-ps/netsecurity/Set-NetFirewallHyperVRule.md +++ b/docset/winserver2022-ps/netsecurity/Set-NetFirewallHyperVRule.md @@ -2,7 +2,7 @@ description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. external help file: NetFirewallHyperVRule.cmdletDefinition.cdxml-help.xml Module Name: NetSecurity -ms.date: 12/27/2016 +ms.date: 8/25/2023 online version: https://docs.microsoft.com/powershell/module/netsecurity/set-netfirewallhypervrule?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Set-NetFirewallHyperVRule @@ -15,14 +15,17 @@ Modifies existing Hyper-V firewall rules. ## SYNTAX +### ByName ``` Set-NetFirewallHyperVRule [-Name] [-NewDisplayName ] [-RulePriority ] [-Direction {Inbound | Outbound}] [-VMCreatorId ] [-Protocol ] [-LocalAddresses ] [-LocalPorts ] [-RemoteAddresses ] [-RemotePorts ] [-Action {NotConfigured | Allow | Block}] [-Enabled {True | False}] [-Profiles {Any | Domain | Private | Public | NotApplicable}] [-CimSession ] [-ThrottleLimit ] [-AsJob] [-PassThru] [-WhatIf] [-Confirm] [] ``` +### ByDisplayName ``` Set-NetFirewallHyperVRule -DisplayName [-NewDisplayName ] [-RulePriority ] [-Direction {Inbound | Outbound}] [-VMCreatorId ] [-Protocol ] [-LocalAddresses ] [-LocalPorts ] [-RemoteAddresses ] [-RemotePorts ] [-Action {NotConfigured | Allow | Block}] [-Enabled {True | False}] [-Profiles {Any | Domain | Private | Public | NotApplicable}] [-CimSession ] [-ThrottleLimit ] [-AsJob] [-PassThru] [-WhatIf] [-Confirm] [] ``` +### InputObject (cdxml) ``` Set-NetFirewallHyperVRule -InputObject [-NewDisplayName ] [-RulePriority ] [-Direction {Inbound | Outbound}] [-VMCreatorId ] [-Protocol ] [-LocalAddresses ] [-LocalPorts ] [-RemoteAddresses ] [-RemotePorts ] [-Action {NotConfigured | Allow | Block}] [-Enabled {True | False}] [-Profiles {Any | Domain | Private | Public | NotApplicable}] [-CimSession ] [-ThrottleLimit ] [-AsJob] [-PassThru] [-WhatIf] [-Confirm] [] ``` diff --git a/docset/winserver2022-ps/netsecurity/Set-NetFirewallHyperVVMSetting.md b/docset/winserver2022-ps/netsecurity/Set-NetFirewallHyperVVMSetting.md index 0c7c1fbd8c..a1214a630f 100644 --- a/docset/winserver2022-ps/netsecurity/Set-NetFirewallHyperVVMSetting.md +++ b/docset/winserver2022-ps/netsecurity/Set-NetFirewallHyperVVMSetting.md @@ -2,7 +2,7 @@ description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. external help file: NetFirewallHyperVVMSetting.cmdletDefinition.cdxml-help.xml Module Name: NetSecurity -ms.date: 12/27/2016 +ms.date: 8/25/2023 online version: https://docs.microsoft.com/powershell/module/netsecurity/set-netfirewallhypervvmsetting?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Set-NetFirewallHyperVVMSetting @@ -15,10 +15,12 @@ Configures Hyper-V firewall per-VM settings on the target computer. ## SYNTAX +### ByName ``` Set-NetFirewallHyperVVMSetting [-Name] [-Enabled {False | True | NotConfigured}] [-DefaultInboundAction {NotConfigured | Allow | Block}] [-DefaultOutboundAction {NotConfigured | Allow | Block}] [-LoopbackEnabled {False | True | NotConfigured}] [-CimSession ] [-ThrottleLimit ] [-AsJob] [-PassThru] [-WhatIf] [-Confirm] [] ``` +### InputObject (cdxml) ``` Set-NetFirewallHyperVVMSetting -InputObject [-Enabled {False | True | NotConfigured}] [-DefaultInboundAction {NotConfigured | Allow | Block}] [-DefaultOutboundAction {NotConfigured | Allow | Block}] [-LoopbackEnabled {False | True | NotConfigured}] [-CimSession ] [-ThrottleLimit ] [-AsJob] [-PassThru] [-WhatIf] [-Confirm] [] ``` From 36c41a69bf3e59b7ab6b7876775381651e99fa80 Mon Sep 17 00:00:00 2001 From: Becca Robins <35232346+beccarobins@users.noreply.github.com> Date: Mon, 28 Aug 2023 15:41:04 -0400 Subject: [PATCH 606/650] Replaces broken link --- docset/docs-conceptual/winserver2016-ps/get-started.md | 2 +- docset/docs-conceptual/winserver2019-ps/get-started.md | 2 +- docset/docs-conceptual/winserver2022-ps/get-started.md | 2 +- docset/winserver2016-ps/adfs/Remove-AdfsFarmNode.md | 3 +-- 4 files changed, 4 insertions(+), 5 deletions(-) diff --git a/docset/docs-conceptual/winserver2016-ps/get-started.md b/docset/docs-conceptual/winserver2016-ps/get-started.md index 634c6f0c5d..e50e724708 100644 --- a/docset/docs-conceptual/winserver2016-ps/get-started.md +++ b/docset/docs-conceptual/winserver2016-ps/get-started.md @@ -71,7 +71,7 @@ computer. For more information, see | Iscsi | [iSCSI](/powershell/module/iscsi) | | IscsiTarget | [iSCSI Target](/powershell/module/iscsitarget) | | KDS | [Key Distribution Server](/powershell/module/kds) | -| Microsoft.Windows.ServerManager.Migration | [Server Migration](/powershell/module/Microsoft.Windows.ServerManager.Migration) | +| Microsoft.Windows.ServerManager.Migration | [Server Migration](../docset/winserver2016-ps/Microsoft.Windows.ServerManager.Migration.md) | | MMAgent | [Memory Management Agent](/powershell/module/mmagent) | | Mpio | [MPIO](/powershell/module/mpio) | | MSDTC | [Distributed Transaction Coordinator](/powershell/module/msdtc) | diff --git a/docset/docs-conceptual/winserver2019-ps/get-started.md b/docset/docs-conceptual/winserver2019-ps/get-started.md index 144f471026..f8f1a6464d 100644 --- a/docset/docs-conceptual/winserver2019-ps/get-started.md +++ b/docset/docs-conceptual/winserver2019-ps/get-started.md @@ -70,7 +70,7 @@ computer. For more information, see | Iscsi | [iSCSI](/powershell/module/iscsi) | | IscsiTarget | [iSCSI Target](/powershell/module/iscsitarget) | | KDS | [Key Distribution Server](/powershell/module/kds) | -| Microsoft.Windows.ServerManager.Migration | [Server Migration](/powershell/module/Microsoft.Windows.ServerManager.Migration/) | +| Microsoft.Windows.ServerManager.Migration | [Server Migration](../docset/winserver2019-ps/Microsoft.Windows.ServerManager.Migration.md) | | MMAgent | [Memory Management Agent](/powershell/module/mmagent) | | Mpio | [MPIO](/powershell/module/mpio) | | MSDTC | [Distributed Transaction Coordinator](/powershell/module/msdtc) | diff --git a/docset/docs-conceptual/winserver2022-ps/get-started.md b/docset/docs-conceptual/winserver2022-ps/get-started.md index b4a9c83434..40ad4c2a91 100644 --- a/docset/docs-conceptual/winserver2022-ps/get-started.md +++ b/docset/docs-conceptual/winserver2022-ps/get-started.md @@ -70,7 +70,7 @@ computer. For more information, see | Iscsi | [iSCSI](/powershell/module/iscsi) | | IscsiTarget | [iSCSI Target](/powershell/module/iscsitarget) | | KDS | [Key Distribution Server](/powershell/module/kds) | -| Microsoft.Windows.ServerManager.Migration | [Server Migration](/powershell/module/Microsoft.Windows.ServerManager.Migration/) | +| Microsoft.Windows.ServerManager.Migration | [Server Migration](../docset/winserver2022-ps/Microsoft.Windows.ServerManager.Migration.md) | | MMAgent | [Memory Management Agent](/powershell/module/mmagent) | | Mpio | [MPIO](/powershell/module/mpio) | | MSDTC | [Distributed Transaction Coordinator](/powershell/module/msdtc) | diff --git a/docset/winserver2016-ps/adfs/Remove-AdfsFarmNode.md b/docset/winserver2016-ps/adfs/Remove-AdfsFarmNode.md index 3e9f2d3a69..f965045a2f 100644 --- a/docset/winserver2016-ps/adfs/Remove-AdfsFarmNode.md +++ b/docset/winserver2016-ps/adfs/Remove-AdfsFarmNode.md @@ -87,5 +87,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Uninstall-WindowsFeature](/powershell/module/microsoft.windows.servermanager.migration/uninstall-windowsfeature) - +[Uninstall-WindowsFeature](/powershell/module/servermanager/uninstall-windowsfeature) From 09d7627847f79f842ae088cbd3002a88fffddec1 Mon Sep 17 00:00:00 2001 From: Becca Robins <35232346+beccarobins@users.noreply.github.com> Date: Mon, 28 Aug 2023 15:53:49 -0400 Subject: [PATCH 607/650] Tests different syntax --- docset/docs-conceptual/winserver2016-ps/get-started.md | 2 +- docset/docs-conceptual/winserver2019-ps/get-started.md | 2 +- docset/docs-conceptual/winserver2022-ps/get-started.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docset/docs-conceptual/winserver2016-ps/get-started.md b/docset/docs-conceptual/winserver2016-ps/get-started.md index e50e724708..873e811c25 100644 --- a/docset/docs-conceptual/winserver2016-ps/get-started.md +++ b/docset/docs-conceptual/winserver2016-ps/get-started.md @@ -71,7 +71,7 @@ computer. For more information, see | Iscsi | [iSCSI](/powershell/module/iscsi) | | IscsiTarget | [iSCSI Target](/powershell/module/iscsitarget) | | KDS | [Key Distribution Server](/powershell/module/kds) | -| Microsoft.Windows.ServerManager.Migration | [Server Migration](../docset/winserver2016-ps/Microsoft.Windows.ServerManager.Migration.md) | +| Microsoft.Windows.ServerManager.Migration | [Server Migration](/docset/winserver2016-ps/Microsoft.Windows.ServerManager.Migration) | | MMAgent | [Memory Management Agent](/powershell/module/mmagent) | | Mpio | [MPIO](/powershell/module/mpio) | | MSDTC | [Distributed Transaction Coordinator](/powershell/module/msdtc) | diff --git a/docset/docs-conceptual/winserver2019-ps/get-started.md b/docset/docs-conceptual/winserver2019-ps/get-started.md index f8f1a6464d..974823471c 100644 --- a/docset/docs-conceptual/winserver2019-ps/get-started.md +++ b/docset/docs-conceptual/winserver2019-ps/get-started.md @@ -70,7 +70,7 @@ computer. For more information, see | Iscsi | [iSCSI](/powershell/module/iscsi) | | IscsiTarget | [iSCSI Target](/powershell/module/iscsitarget) | | KDS | [Key Distribution Server](/powershell/module/kds) | -| Microsoft.Windows.ServerManager.Migration | [Server Migration](../docset/winserver2019-ps/Microsoft.Windows.ServerManager.Migration.md) | +| Microsoft.Windows.ServerManager.Migration | [Server Migration](/docset/winserver2019-ps/Microsoft.Windows.ServerManager.Migration) | | MMAgent | [Memory Management Agent](/powershell/module/mmagent) | | Mpio | [MPIO](/powershell/module/mpio) | | MSDTC | [Distributed Transaction Coordinator](/powershell/module/msdtc) | diff --git a/docset/docs-conceptual/winserver2022-ps/get-started.md b/docset/docs-conceptual/winserver2022-ps/get-started.md index 40ad4c2a91..cf7e99810d 100644 --- a/docset/docs-conceptual/winserver2022-ps/get-started.md +++ b/docset/docs-conceptual/winserver2022-ps/get-started.md @@ -70,7 +70,7 @@ computer. For more information, see | Iscsi | [iSCSI](/powershell/module/iscsi) | | IscsiTarget | [iSCSI Target](/powershell/module/iscsitarget) | | KDS | [Key Distribution Server](/powershell/module/kds) | -| Microsoft.Windows.ServerManager.Migration | [Server Migration](../docset/winserver2022-ps/Microsoft.Windows.ServerManager.Migration.md) | +| Microsoft.Windows.ServerManager.Migration | [Server Migration](/docset/winserver2022-ps/Microsoft.Windows.ServerManager.Migration) | | MMAgent | [Memory Management Agent](/powershell/module/mmagent) | | Mpio | [MPIO](/powershell/module/mpio) | | MSDTC | [Distributed Transaction Coordinator](/powershell/module/msdtc) | From 6e06a93d21a7dbd31aacf9d506c9fbdf25c65187 Mon Sep 17 00:00:00 2001 From: Becca Robins <35232346+beccarobins@users.noreply.github.com> Date: Mon, 28 Aug 2023 16:29:01 -0400 Subject: [PATCH 608/650] Apply suggestions from code review --- docset/docs-conceptual/winserver2016-ps/get-started.md | 2 +- docset/docs-conceptual/winserver2022-ps/get-started.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docset/docs-conceptual/winserver2016-ps/get-started.md b/docset/docs-conceptual/winserver2016-ps/get-started.md index 873e811c25..634c6f0c5d 100644 --- a/docset/docs-conceptual/winserver2016-ps/get-started.md +++ b/docset/docs-conceptual/winserver2016-ps/get-started.md @@ -71,7 +71,7 @@ computer. For more information, see | Iscsi | [iSCSI](/powershell/module/iscsi) | | IscsiTarget | [iSCSI Target](/powershell/module/iscsitarget) | | KDS | [Key Distribution Server](/powershell/module/kds) | -| Microsoft.Windows.ServerManager.Migration | [Server Migration](/docset/winserver2016-ps/Microsoft.Windows.ServerManager.Migration) | +| Microsoft.Windows.ServerManager.Migration | [Server Migration](/powershell/module/Microsoft.Windows.ServerManager.Migration) | | MMAgent | [Memory Management Agent](/powershell/module/mmagent) | | Mpio | [MPIO](/powershell/module/mpio) | | MSDTC | [Distributed Transaction Coordinator](/powershell/module/msdtc) | diff --git a/docset/docs-conceptual/winserver2022-ps/get-started.md b/docset/docs-conceptual/winserver2022-ps/get-started.md index cf7e99810d..dda4eda97a 100644 --- a/docset/docs-conceptual/winserver2022-ps/get-started.md +++ b/docset/docs-conceptual/winserver2022-ps/get-started.md @@ -70,7 +70,7 @@ computer. For more information, see | Iscsi | [iSCSI](/powershell/module/iscsi) | | IscsiTarget | [iSCSI Target](/powershell/module/iscsitarget) | | KDS | [Key Distribution Server](/powershell/module/kds) | -| Microsoft.Windows.ServerManager.Migration | [Server Migration](/docset/winserver2022-ps/Microsoft.Windows.ServerManager.Migration) | +| Microsoft.Windows.ServerManager.Migration | [Server Migration](/powershell/module/Microsoft.Windows.ServerManager.Migration) | | MMAgent | [Memory Management Agent](/powershell/module/mmagent) | | Mpio | [MPIO](/powershell/module/mpio) | | MSDTC | [Distributed Transaction Coordinator](/powershell/module/msdtc) | From 3355b4950cec4f7283f34831d0f98bb70dabaf55 Mon Sep 17 00:00:00 2001 From: Becca Robins <35232346+beccarobins@users.noreply.github.com> Date: Mon, 28 Aug 2023 16:29:42 -0400 Subject: [PATCH 609/650] Update docset/docs-conceptual/winserver2019-ps/get-started.md --- docset/docs-conceptual/winserver2019-ps/get-started.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/docs-conceptual/winserver2019-ps/get-started.md b/docset/docs-conceptual/winserver2019-ps/get-started.md index 974823471c..833b3fd807 100644 --- a/docset/docs-conceptual/winserver2019-ps/get-started.md +++ b/docset/docs-conceptual/winserver2019-ps/get-started.md @@ -70,7 +70,7 @@ computer. For more information, see | Iscsi | [iSCSI](/powershell/module/iscsi) | | IscsiTarget | [iSCSI Target](/powershell/module/iscsitarget) | | KDS | [Key Distribution Server](/powershell/module/kds) | -| Microsoft.Windows.ServerManager.Migration | [Server Migration](/docset/winserver2019-ps/Microsoft.Windows.ServerManager.Migration) | +| Microsoft.Windows.ServerManager.Migration | [Server Migration](/powershell/module/Microsoft.Windows.ServerManager.Migration) | | MMAgent | [Memory Management Agent](/powershell/module/mmagent) | | Mpio | [MPIO](/powershell/module/mpio) | | MSDTC | [Distributed Transaction Coordinator](/powershell/module/msdtc) | From 0e357e0f1c452bcea6c74b46d9adde1560e7aebf Mon Sep 17 00:00:00 2001 From: Becca Robins <35232346+beccarobins@users.noreply.github.com> Date: Mon, 28 Aug 2023 16:38:48 -0400 Subject: [PATCH 610/650] Apply suggestions from code review --- docset/docs-conceptual/winserver2019-ps/get-started.md | 2 +- docset/docs-conceptual/winserver2022-ps/get-started.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docset/docs-conceptual/winserver2019-ps/get-started.md b/docset/docs-conceptual/winserver2019-ps/get-started.md index 833b3fd807..144f471026 100644 --- a/docset/docs-conceptual/winserver2019-ps/get-started.md +++ b/docset/docs-conceptual/winserver2019-ps/get-started.md @@ -70,7 +70,7 @@ computer. For more information, see | Iscsi | [iSCSI](/powershell/module/iscsi) | | IscsiTarget | [iSCSI Target](/powershell/module/iscsitarget) | | KDS | [Key Distribution Server](/powershell/module/kds) | -| Microsoft.Windows.ServerManager.Migration | [Server Migration](/powershell/module/Microsoft.Windows.ServerManager.Migration) | +| Microsoft.Windows.ServerManager.Migration | [Server Migration](/powershell/module/Microsoft.Windows.ServerManager.Migration/) | | MMAgent | [Memory Management Agent](/powershell/module/mmagent) | | Mpio | [MPIO](/powershell/module/mpio) | | MSDTC | [Distributed Transaction Coordinator](/powershell/module/msdtc) | diff --git a/docset/docs-conceptual/winserver2022-ps/get-started.md b/docset/docs-conceptual/winserver2022-ps/get-started.md index dda4eda97a..b4a9c83434 100644 --- a/docset/docs-conceptual/winserver2022-ps/get-started.md +++ b/docset/docs-conceptual/winserver2022-ps/get-started.md @@ -70,7 +70,7 @@ computer. For more information, see | Iscsi | [iSCSI](/powershell/module/iscsi) | | IscsiTarget | [iSCSI Target](/powershell/module/iscsitarget) | | KDS | [Key Distribution Server](/powershell/module/kds) | -| Microsoft.Windows.ServerManager.Migration | [Server Migration](/powershell/module/Microsoft.Windows.ServerManager.Migration) | +| Microsoft.Windows.ServerManager.Migration | [Server Migration](/powershell/module/Microsoft.Windows.ServerManager.Migration/) | | MMAgent | [Memory Management Agent](/powershell/module/mmagent) | | Mpio | [MPIO](/powershell/module/mpio) | | MSDTC | [Distributed Transaction Coordinator](/powershell/module/msdtc) | From 03bd1e38f4eae9c0b379d7c862144becf57a9463 Mon Sep 17 00:00:00 2001 From: Chandra Kumar Date: Tue, 29 Aug 2023 11:57:30 -0700 Subject: [PATCH 611/650] DevDrive: Update Format-Volume.md Add -DevDrive switch to the help --- .../winserver2022-ps/storage/Format-Volume.md | 27 ++++++++++++++----- 1 file changed, 21 insertions(+), 6 deletions(-) diff --git a/docset/winserver2022-ps/storage/Format-Volume.md b/docset/winserver2022-ps/storage/Format-Volume.md index d0dbb01fe0..128586be6d 100644 --- a/docset/winserver2022-ps/storage/Format-Volume.md +++ b/docset/winserver2022-ps/storage/Format-Volume.md @@ -19,7 +19,7 @@ Formats one or more existing volumes or a new volume on an existing partition. ``` Format-Volume [-DriveLetter] [-FileSystem ] [-NewFileSystemLabel ] [-AllocationUnitSize ] [-Full] [-Force] [-Compress] [-ShortFileNameSupport ] - [-SetIntegrityStreams ] [-UseLargeFRS] [-DisableHeatGathering] [-IsDAX ] + [-SetIntegrityStreams ] [-UseLargeFRS] [-DisableHeatGathering] [-IsDAX ] [-DevDrive] [-CimSession ] [-ThrottleLimit ] [-AsJob] [-WhatIf] [-Confirm] [] ``` @@ -27,7 +27,7 @@ Format-Volume [-DriveLetter] [-FileSystem ] [-NewFileSystemLabe ``` Format-Volume -ObjectId [-FileSystem ] [-NewFileSystemLabel ] [-AllocationUnitSize ] [-Full] [-Force] [-Compress] [-ShortFileNameSupport ] - [-SetIntegrityStreams ] [-UseLargeFRS] [-DisableHeatGathering] [-IsDAX ] + [-SetIntegrityStreams ] [-UseLargeFRS] [-DisableHeatGathering] [-IsDAX ] [-DevDrive] [-CimSession ] [-ThrottleLimit ] [-AsJob] [-WhatIf] [-Confirm] [] ``` @@ -35,7 +35,7 @@ Format-Volume -ObjectId [-FileSystem ] [-NewFileSystemLabel < ``` Format-Volume -Path [-FileSystem ] [-NewFileSystemLabel ] [-AllocationUnitSize ] [-Full] [-Force] [-Compress] [-ShortFileNameSupport ] - [-SetIntegrityStreams ] [-UseLargeFRS] [-DisableHeatGathering] [-IsDAX ] + [-SetIntegrityStreams ] [-UseLargeFRS] [-DisableHeatGathering] [-IsDAX ] [-DevDrive] [-CimSession ] [-ThrottleLimit ] [-AsJob] [-WhatIf] [-Confirm] [] ``` @@ -43,7 +43,7 @@ Format-Volume -Path [-FileSystem ] [-NewFileSystemLabel [-FileSystem ] [-NewFileSystemLabel ] [-AllocationUnitSize ] [-Full] [-Force] [-Compress] [-ShortFileNameSupport ] - [-SetIntegrityStreams ] [-UseLargeFRS] [-DisableHeatGathering] [-IsDAX ] + [-SetIntegrityStreams ] [-UseLargeFRS] [-DisableHeatGathering] [-IsDAX ] [-DevDrive] [-CimSession ] [-ThrottleLimit ] [-AsJob] [-WhatIf] [-Confirm] [] ``` @@ -51,7 +51,7 @@ Format-Volume -FileSystemLabel [-FileSystem ] [-NewFileSystem ``` Format-Volume [-Partition ] [-FileSystem ] [-NewFileSystemLabel ] [-AllocationUnitSize ] [-Full] [-Force] [-Compress] [-ShortFileNameSupport ] - [-SetIntegrityStreams ] [-UseLargeFRS] [-DisableHeatGathering] [-IsDAX ] + [-SetIntegrityStreams ] [-UseLargeFRS] [-DisableHeatGathering] [-IsDAX ] [-DevDrive] [-CimSession ] [-ThrottleLimit ] [-AsJob] [-WhatIf] [-Confirm] [] ``` @@ -59,7 +59,7 @@ Format-Volume [-Partition ] [-FileSystem ] [-NewFileSystemL ``` Format-Volume -InputObject [-FileSystem ] [-NewFileSystemLabel ] [-AllocationUnitSize ] [-Full] [-Force] [-Compress] [-ShortFileNameSupport ] - [-SetIntegrityStreams ] [-UseLargeFRS] [-DisableHeatGathering] [-IsDAX ] + [-SetIntegrityStreams ] [-UseLargeFRS] [-DisableHeatGathering] [-IsDAX ] [-DevDrive] [-CimSession ] [-ThrottleLimit ] [-AsJob] [-WhatIf] [-Confirm] [] ``` @@ -192,6 +192,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DevDrive +Formats the volume as a [dev drive](https://learn.microsoft.com/en-us/windows/dev-drive/). A dev drive is optimized for performance of developer scenarios and gives administators control over what minifilters are attached to the volume. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -DisableHeatGathering Indicates that the cmdlet does not gather file activity on the specified tiered volume. You can override file placement based on the desired storage tier. From 7d181758a224ed9a5184bc6482bc36000567a6db Mon Sep 17 00:00:00 2001 From: Sean Wheeler Date: Wed, 30 Aug 2023 13:51:23 -0500 Subject: [PATCH 612/650] Update docset/winserver2022-ps/storage/Format-Volume.md --- docset/winserver2022-ps/storage/Format-Volume.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/storage/Format-Volume.md b/docset/winserver2022-ps/storage/Format-Volume.md index 128586be6d..f40e73d22b 100644 --- a/docset/winserver2022-ps/storage/Format-Volume.md +++ b/docset/winserver2022-ps/storage/Format-Volume.md @@ -193,7 +193,7 @@ Accept wildcard characters: False ``` ### -DevDrive -Formats the volume as a [dev drive](https://learn.microsoft.com/en-us/windows/dev-drive/). A dev drive is optimized for performance of developer scenarios and gives administators control over what minifilters are attached to the volume. +Formats the volume as a [dev drive](/windows/dev-drive/). A dev drive is optimized for performance of developer scenarios and gives administators control over what minifilters are attached to the volume. ```yaml Type: SwitchParameter From cf5cf70b034b2dea13482a85fb44468d99f1410d Mon Sep 17 00:00:00 2001 From: Becca Robins <35232346+beccarobins@users.noreply.github.com> Date: Tue, 5 Sep 2023 09:07:48 -0400 Subject: [PATCH 613/650] Fixes broken links --- docset/docs-conceptual/winserver2016-ps/get-started.md | 2 +- docset/docs-conceptual/winserver2019-ps/get-started.md | 2 +- docset/docs-conceptual/winserver2022-ps/get-started.md | 2 +- docset/winserver2022-ps/adfs/Remove-AdfsFarmNode.md | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docset/docs-conceptual/winserver2016-ps/get-started.md b/docset/docs-conceptual/winserver2016-ps/get-started.md index 634c6f0c5d..b7b69e5ef1 100644 --- a/docset/docs-conceptual/winserver2016-ps/get-started.md +++ b/docset/docs-conceptual/winserver2016-ps/get-started.md @@ -71,7 +71,7 @@ computer. For more information, see | Iscsi | [iSCSI](/powershell/module/iscsi) | | IscsiTarget | [iSCSI Target](/powershell/module/iscsitarget) | | KDS | [Key Distribution Server](/powershell/module/kds) | -| Microsoft.Windows.ServerManager.Migration | [Server Migration](/powershell/module/Microsoft.Windows.ServerManager.Migration) | +| Microsoft.Windows.ServerManager.Migration | [Server Migration](../../../winserver2022-ps/Microsoft.Windows.ServerManager.Migration/Uninstall-WindowsFeature.md) | | MMAgent | [Memory Management Agent](/powershell/module/mmagent) | | Mpio | [MPIO](/powershell/module/mpio) | | MSDTC | [Distributed Transaction Coordinator](/powershell/module/msdtc) | diff --git a/docset/docs-conceptual/winserver2019-ps/get-started.md b/docset/docs-conceptual/winserver2019-ps/get-started.md index 144f471026..fa578576a3 100644 --- a/docset/docs-conceptual/winserver2019-ps/get-started.md +++ b/docset/docs-conceptual/winserver2019-ps/get-started.md @@ -70,7 +70,7 @@ computer. For more information, see | Iscsi | [iSCSI](/powershell/module/iscsi) | | IscsiTarget | [iSCSI Target](/powershell/module/iscsitarget) | | KDS | [Key Distribution Server](/powershell/module/kds) | -| Microsoft.Windows.ServerManager.Migration | [Server Migration](/powershell/module/Microsoft.Windows.ServerManager.Migration/) | +| Microsoft.Windows.ServerManager.Migration | [Server Migration](../../../winserver2022-ps/windowsupdate/WindowsUpdate.md) | | MMAgent | [Memory Management Agent](/powershell/module/mmagent) | | Mpio | [MPIO](/powershell/module/mpio) | | MSDTC | [Distributed Transaction Coordinator](/powershell/module/msdtc) | diff --git a/docset/docs-conceptual/winserver2022-ps/get-started.md b/docset/docs-conceptual/winserver2022-ps/get-started.md index b4a9c83434..d5855d5929 100644 --- a/docset/docs-conceptual/winserver2022-ps/get-started.md +++ b/docset/docs-conceptual/winserver2022-ps/get-started.md @@ -70,7 +70,7 @@ computer. For more information, see | Iscsi | [iSCSI](/powershell/module/iscsi) | | IscsiTarget | [iSCSI Target](/powershell/module/iscsitarget) | | KDS | [Key Distribution Server](/powershell/module/kds) | -| Microsoft.Windows.ServerManager.Migration | [Server Migration](/powershell/module/Microsoft.Windows.ServerManager.Migration/) | +| Microsoft.Windows.ServerManager.Migration | [Server Migration](../../../winserver2022-ps/windowsupdate/WindowsUpdate.md) | | MMAgent | [Memory Management Agent](/powershell/module/mmagent) | | Mpio | [MPIO](/powershell/module/mpio) | | MSDTC | [Distributed Transaction Coordinator](/powershell/module/msdtc) | diff --git a/docset/winserver2022-ps/adfs/Remove-AdfsFarmNode.md b/docset/winserver2022-ps/adfs/Remove-AdfsFarmNode.md index de4f79006f..27b4c89918 100644 --- a/docset/winserver2022-ps/adfs/Remove-AdfsFarmNode.md +++ b/docset/winserver2022-ps/adfs/Remove-AdfsFarmNode.md @@ -87,5 +87,5 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Uninstall-WindowsFeature](/powershell/module/Microsoft.Windows.ServerManager.Migration/Uninstall-WindowsFeature) +[Uninstall-WindowsFeature](../../ServerManager/Uninstall-WindowsFeature.md) From 0ddf3bc2243ada15756e53784e995d60c3848237 Mon Sep 17 00:00:00 2001 From: Becca Robins <35232346+beccarobins@users.noreply.github.com> Date: Tue, 5 Sep 2023 09:33:34 -0400 Subject: [PATCH 614/650] Update Remove-AdfsFarmNode.md --- docset/winserver2022-ps/adfs/Remove-AdfsFarmNode.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/adfs/Remove-AdfsFarmNode.md b/docset/winserver2022-ps/adfs/Remove-AdfsFarmNode.md index 27b4c89918..2e1730848e 100644 --- a/docset/winserver2022-ps/adfs/Remove-AdfsFarmNode.md +++ b/docset/winserver2022-ps/adfs/Remove-AdfsFarmNode.md @@ -87,5 +87,5 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Uninstall-WindowsFeature](../../ServerManager/Uninstall-WindowsFeature.md) +[Uninstall-WindowsFeature](../winserver2022-ps/Microsoft.Windows.ServerManager.Migration/Uninstall-WindowsFeature.md) From 2f5a6f5224d19703a0f1154a6d267c30bab2448c Mon Sep 17 00:00:00 2001 From: Becca Robins <35232346+beccarobins@users.noreply.github.com> Date: Tue, 5 Sep 2023 09:46:49 -0400 Subject: [PATCH 615/650] Update Remove-AdfsFarmNode.md --- docset/winserver2022-ps/adfs/Remove-AdfsFarmNode.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/adfs/Remove-AdfsFarmNode.md b/docset/winserver2022-ps/adfs/Remove-AdfsFarmNode.md index 2e1730848e..effe9104b9 100644 --- a/docset/winserver2022-ps/adfs/Remove-AdfsFarmNode.md +++ b/docset/winserver2022-ps/adfs/Remove-AdfsFarmNode.md @@ -87,5 +87,5 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Uninstall-WindowsFeature](../winserver2022-ps/Microsoft.Windows.ServerManager.Migration/Uninstall-WindowsFeature.md) +[Uninstall-WindowsFeature](../../winserver2022-ps/Microsoft.Windows.ServerManager.Migration/Uninstall-WindowsFeature.md) From 0fad28e7eb0d23904179fe83e776ee8d70ec2a49 Mon Sep 17 00:00:00 2001 From: Becca Robins <35232346+beccarobins@users.noreply.github.com> Date: Tue, 5 Sep 2023 10:09:35 -0400 Subject: [PATCH 616/650] Apply suggestions from code review --- docset/docs-conceptual/winserver2016-ps/get-started.md | 1 - docset/docs-conceptual/winserver2019-ps/get-started.md | 1 - docset/docs-conceptual/winserver2022-ps/get-started.md | 1 - docset/winserver2022-ps/adfs/Remove-AdfsFarmNode.md | 2 +- 4 files changed, 1 insertion(+), 4 deletions(-) diff --git a/docset/docs-conceptual/winserver2016-ps/get-started.md b/docset/docs-conceptual/winserver2016-ps/get-started.md index b7b69e5ef1..76e5b003b7 100644 --- a/docset/docs-conceptual/winserver2016-ps/get-started.md +++ b/docset/docs-conceptual/winserver2016-ps/get-started.md @@ -71,7 +71,6 @@ computer. For more information, see | Iscsi | [iSCSI](/powershell/module/iscsi) | | IscsiTarget | [iSCSI Target](/powershell/module/iscsitarget) | | KDS | [Key Distribution Server](/powershell/module/kds) | -| Microsoft.Windows.ServerManager.Migration | [Server Migration](../../../winserver2022-ps/Microsoft.Windows.ServerManager.Migration/Uninstall-WindowsFeature.md) | | MMAgent | [Memory Management Agent](/powershell/module/mmagent) | | Mpio | [MPIO](/powershell/module/mpio) | | MSDTC | [Distributed Transaction Coordinator](/powershell/module/msdtc) | diff --git a/docset/docs-conceptual/winserver2019-ps/get-started.md b/docset/docs-conceptual/winserver2019-ps/get-started.md index fa578576a3..c3f0015bc5 100644 --- a/docset/docs-conceptual/winserver2019-ps/get-started.md +++ b/docset/docs-conceptual/winserver2019-ps/get-started.md @@ -70,7 +70,6 @@ computer. For more information, see | Iscsi | [iSCSI](/powershell/module/iscsi) | | IscsiTarget | [iSCSI Target](/powershell/module/iscsitarget) | | KDS | [Key Distribution Server](/powershell/module/kds) | -| Microsoft.Windows.ServerManager.Migration | [Server Migration](../../../winserver2022-ps/windowsupdate/WindowsUpdate.md) | | MMAgent | [Memory Management Agent](/powershell/module/mmagent) | | Mpio | [MPIO](/powershell/module/mpio) | | MSDTC | [Distributed Transaction Coordinator](/powershell/module/msdtc) | diff --git a/docset/docs-conceptual/winserver2022-ps/get-started.md b/docset/docs-conceptual/winserver2022-ps/get-started.md index d5855d5929..8f42ff39ac 100644 --- a/docset/docs-conceptual/winserver2022-ps/get-started.md +++ b/docset/docs-conceptual/winserver2022-ps/get-started.md @@ -70,7 +70,6 @@ computer. For more information, see | Iscsi | [iSCSI](/powershell/module/iscsi) | | IscsiTarget | [iSCSI Target](/powershell/module/iscsitarget) | | KDS | [Key Distribution Server](/powershell/module/kds) | -| Microsoft.Windows.ServerManager.Migration | [Server Migration](../../../winserver2022-ps/windowsupdate/WindowsUpdate.md) | | MMAgent | [Memory Management Agent](/powershell/module/mmagent) | | Mpio | [MPIO](/powershell/module/mpio) | | MSDTC | [Distributed Transaction Coordinator](/powershell/module/msdtc) | diff --git a/docset/winserver2022-ps/adfs/Remove-AdfsFarmNode.md b/docset/winserver2022-ps/adfs/Remove-AdfsFarmNode.md index effe9104b9..6168c042cd 100644 --- a/docset/winserver2022-ps/adfs/Remove-AdfsFarmNode.md +++ b/docset/winserver2022-ps/adfs/Remove-AdfsFarmNode.md @@ -87,5 +87,5 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Uninstall-WindowsFeature](../../winserver2022-ps/Microsoft.Windows.ServerManager.Migration/Uninstall-WindowsFeature.md) +[Uninstall-WindowsFeature](/powershell/module/servermanager/uninstall-windowsfeature) From 230275f436020e70c65fb333a13de767b3bcfcbe Mon Sep 17 00:00:00 2001 From: Matthew Ige Date: Wed, 6 Sep 2023 09:09:58 -0700 Subject: [PATCH 617/650] Apply suggestions from code review Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- .../Disable-NetFirewallHyperVRule.md | 22 ++++++++++----- .../Enable-NetFirewallHyperVRule.md | 24 ++++++++++------ .../netsecurity/Get-NetFirewallHyperVPort.md | 10 +++++-- .../Get-NetFirewallHyperVProfile.md | 9 +++--- .../netsecurity/Get-NetFirewallHyperVRule.md | 24 ++++++++++------ .../Get-NetFirewallHyperVVMCreator.md | 11 ++++++-- .../Get-NetFirewallHyperVVMSetting.md | 16 +++++++---- .../New-NetFirewallHyperVProfile.md | 9 +++--- .../netsecurity/New-NetFirewallHyperVRule.md | 11 ++++++-- .../New-NetFirewallHyperVVMSetting.md | 20 +++++++++---- .../Remove-NetFirewallHyperVRule.md | 28 +++++++++++++------ .../Rename-NetFirewallHyperVRule.md | 16 +++++++---- .../Set-NetFirewallHyperVProfile.md | 13 +++++---- .../netsecurity/Set-NetFirewallHyperVRule.md | 17 +++++++---- .../Set-NetFirewallHyperVVMSetting.md | 20 +++++++++---- 15 files changed, 168 insertions(+), 82 deletions(-) diff --git a/docset/winserver2022-ps/netsecurity/Disable-NetFirewallHyperVRule.md b/docset/winserver2022-ps/netsecurity/Disable-NetFirewallHyperVRule.md index 3914ed5ef1..58fbfd6eeb 100644 --- a/docset/winserver2022-ps/netsecurity/Disable-NetFirewallHyperVRule.md +++ b/docset/winserver2022-ps/netsecurity/Disable-NetFirewallHyperVRule.md @@ -41,9 +41,12 @@ Disable-NetFirewallHyperVRule -InputObject Disable-NetFirewallHyperVRule -PolicyStore ActiveStore ``` -This retrieves all of the Hyper-V firewall rules in the active store, which is a collection of all the policy stores that apply to the computer, and disables all of them. +This example retrieves all the Hyper-V firewall rules in the active store, which is a collection of all the policy stores that apply to the computer, and disables all of them. + ### EXAMPLE 2 ``` PS C:\> Disable-NetFirewallHyperVRule -DisplayName 'MyServerIPBlock' ``` -This retrieves all of the Hyper-V firewall rules with DisplayName 'MyServerIPBlock' and disables the rules. +This example retrieves all the Hyper-V firewall rules with DisplayName 'MyServerIPBlock' and disables the rules. + ## PARAMETERS @@ -155,7 +160,8 @@ The acceptable values for this parameter are: - True: Specifies the rule is currently enabled. - False: Specifies the rule is currently disabled. -Note, that the type of this parameter is not boolean, therefore `$true` and `$false` variables are not acceptable values here. Use "True" and "False" text strings instead. +Note that the type of this parameter is not Boolean, therefore `$true` and `$false` variables are not acceptable values here. Use "True" and "False" text strings instead. + A disabled rule will not actively modify computer behavior, but the management construct still exists on the computer so it can be re-enabled. @@ -275,7 +281,8 @@ Accept wildcard characters: False ### -ThrottleLimit Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -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. +If this parameter is omitted or a value of `0` is entered, Windows PowerShell calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. + The throttle limit applies only to the current cmdlet, not to the session or to the computer. ```yaml @@ -291,7 +298,8 @@ Accept wildcard characters: False ### -VMCreatorId Specifies that only matching Hyper-V firewall rules with the specified VMCreatorId are disabled. -The format for this value is a Guid enclosed in brackets, i.e '{9E288F02-CE00-4D9E-BE2B-14CE463B0298}' +The format for this value is a GUID enclosed in brackets, such as '{9E288F02-CE00-4D9E-BE2B-14CE463B0298}'. + ```yaml Type: String diff --git a/docset/winserver2022-ps/netsecurity/Enable-NetFirewallHyperVRule.md b/docset/winserver2022-ps/netsecurity/Enable-NetFirewallHyperVRule.md index e8a15000d7..543d1d47aa 100644 --- a/docset/winserver2022-ps/netsecurity/Enable-NetFirewallHyperVRule.md +++ b/docset/winserver2022-ps/netsecurity/Enable-NetFirewallHyperVRule.md @@ -41,9 +41,11 @@ Enable-NetFirewallHyperVRule -InputObject Enable-NetFirewallHyperVRule -PolicyStore ActiveStore ``` -This retrieves all of the Hyper-V firewall rules in the active store, which is a collection of all the policy stores that apply to the computer, and enables all of them. +This example retrieves all the Hyper-V firewall rules in the active store, which is a collection of all the policy stores that apply to the computer, and enables all of them. + ### EXAMPLE 2 ``` PS C:\> Enable-NetFirewallHyperVRule -DisplayName 'MyServerIPBlock' ``` -This retrieves all of the Hyper-V firewall rules with DisplayName 'MyServerIPBlock' and enables the rules. +This example retrieves all the Hyper-V firewall rules with DisplayName 'MyServerIPBlock' and enables the rules. + ## PARAMETERS @@ -153,7 +157,8 @@ The acceptable values for this parameter are: - True: Specifies the rule is currently enabled. - False: Specifies the rule is currently disabled. -Note, that the type of this parameter is not boolean, therefore `$true` and `$false` variables are not acceptable values here. Use "True" and "False" text strings instead. +Note, that the type of this parameter is not Boolean, therefore `$true` and `$false` variables are not acceptable values here. Use "True" and "False" text strings instead. + A disabled rule will not actively modify computer behavior, but the management construct still exists on the computer so it can be re-enabled. @@ -255,7 +260,8 @@ Accept wildcard characters: False ``` ### -Protocol -Specifies that only matching Hyper-V firewall rules with the indicated Protocol are enabled. +Specifies that only matching Hyper-V firewall rules with the indicated protocol are enabled. + The acceptable values for this parameter are: - Protocols by number: 0-255. - Protocols by name: TCP, UDP, ICMPv4, or ICMPv6. @@ -273,7 +279,8 @@ Accept wildcard characters: False ### -ThrottleLimit Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -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. +If this parameter is omitted or a value of `0` is entered, Windows PowerShell calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. + The throttle limit applies only to the current cmdlet, not to the session or to the computer. ```yaml @@ -289,7 +296,8 @@ Accept wildcard characters: False ### -VMCreatorId Specifies that only matching Hyper-V firewall rules with the specified VMCreatorId are enabled. -The format for this value is a Guid enclosed in brackets, i.e '{9E288F02-CE00-4D9E-BE2B-14CE463B0298}' +The format for this value is a GUID enclosed in brackets, such as '{9E288F02-CE00-4D9E-BE2B-14CE463B0298}'. + ```yaml Type: String diff --git a/docset/winserver2022-ps/netsecurity/Get-NetFirewallHyperVPort.md b/docset/winserver2022-ps/netsecurity/Get-NetFirewallHyperVPort.md index 620010d8c8..f1e6ed9c4f 100644 --- a/docset/winserver2022-ps/netsecurity/Get-NetFirewallHyperVPort.md +++ b/docset/winserver2022-ps/netsecurity/Get-NetFirewallHyperVPort.md @@ -21,7 +21,9 @@ Get-NetFirewallHyperVPort [-All] [-CimSession ] [-ThrottleLimit Get-NetFirewallHyperVPort ``` -This retrieves all of the Hyper-V firewall ports that are currently on the system. +This example retrieves all the Hyper-V firewall ports that are currently on the system. + ## PARAMETERS @@ -81,7 +84,8 @@ Accept wildcard characters: False ### -ThrottleLimit Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -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. +If this parameter is omitted or a value of `0` is entered, Windows PowerShell calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. + The throttle limit applies only to the current cmdlet, not to the session or to the computer. ```yaml diff --git a/docset/winserver2022-ps/netsecurity/Get-NetFirewallHyperVProfile.md b/docset/winserver2022-ps/netsecurity/Get-NetFirewallHyperVProfile.md index 81203107d7..280ca26ce1 100644 --- a/docset/winserver2022-ps/netsecurity/Get-NetFirewallHyperVProfile.md +++ b/docset/winserver2022-ps/netsecurity/Get-NetFirewallHyperVProfile.md @@ -26,6 +26,7 @@ Get-NetFirewallHyperVProfile [[-Name] ] [-Profile {Any | Domain | Priv ``` ## DESCRIPTION + The **Get-NetFirewallHyperVProfile** cmdlet returns the the Hyper-V firewall profile settings on the system. These settings are applicable to all Hyper-V firewall ports created by a specific Hyper-V firewall VM creator. These settings apply to the VM only when the profile is active. These settings are configurable on a per-store basis. By default, this cmdlet queries the local store. @@ -37,21 +38,21 @@ These settings are configurable on a per-store basis. By default, this cmdlet qu PS C:\> Get-NetFirewallHyperVProfile ``` -This retrieves all of the Hyper-V firewall profile settings. With no parameters, this cmdlet queries the settings in the local store. +This retrieves all the Hyper-V firewall profile settings. With no parameters, this cmdlet queries the settings in the local store. ### EXAMPLE 2 ``` PS C:\> Get-NetFirewallHyperVProfile -Name '{9E288F02-CE00-4D9E-BE2B-14CE463B0298}' ``` -This retrieves all of the Hyper-V firewall profile settings for the specified VM creator Id. +This example retrieves all the Hyper-V firewall profile settings for the specified VM creator ID. ### EXAMPLE 3 ``` PS C:\> Get-NetFirewallHyperVProfile -PolicyStore ActiveStore ``` -This retrieves all of the Hyper-V firewall profile settings from the ActiveStore. +This example retrieves all the Hyper-V firewall profile settings from the ActiveStore. ## PARAMETERS @@ -155,7 +156,7 @@ Accept wildcard characters: False ### -ThrottleLimit Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -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. +If this parameter is omitted or a value of `0` is entered, Windows PowerShell calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer. ```yaml diff --git a/docset/winserver2022-ps/netsecurity/Get-NetFirewallHyperVRule.md b/docset/winserver2022-ps/netsecurity/Get-NetFirewallHyperVRule.md index 07ccca8007..3aebc9f03b 100644 --- a/docset/winserver2022-ps/netsecurity/Get-NetFirewallHyperVRule.md +++ b/docset/winserver2022-ps/netsecurity/Get-NetFirewallHyperVRule.md @@ -36,9 +36,11 @@ Get-NetFirewallHyperVRule [-Direction {Inbound | Outbound}] [-VMCreatorId Get-NetFirewallHyperVRule -PolicyStore ActiveStore ``` -This retrieves all of the Hyper-V firewall rules in the active store, which is a collection of all the policy stores that apply to the computer. Running this cmdlet without specifying the policy store retrieves the persistent store. +This example retrieves all the Hyper-V firewall rules in the active store, which is a collection of all the policy stores that apply to the computer. Running this cmdlet without specifying the policy store retrieves the persistent store. + ### EXAMPLE 2 ``` PS C:\> Get-NetFirewallHyperVRule -EnforcementStatus OK ``` -This retrieves all of the Hyper-V firewall rules with EnforcementStatus OK, which means that the rule is active and being enforced. +This example retrieves all the Hyper-V firewall rules with EnforcementStatus OK, which means that the rule is active and being enforced. + ### EXAMPLE 3 ``` PS C:\> Get-NetFirewallHyperVRule -Name 'MyRuleId' ``` -This retrieves the Hyper-V firewall rule with the Name 'MyRuleId' +This example retrieves the Hyper-V firewall rule with the Name 'MyRuleId' + ## PARAMETERS @@ -155,7 +160,8 @@ The acceptable values for this parameter are: - True: Specifies the rule is currently enabled. - False: Specifies the rule is currently disabled. -Note, that the type of this parameter is not boolean, therefore `$true` and `$false` variables are not acceptable values here. Use "True" and "False" text strings instead. +Note that the type of this parameter is not Boolean, therefore `$true` and `$false` variables are not acceptable values here. Use "True" and "False" text strings instead. + A disabled rule will not actively modify computer behavior, but the management construct still exists on the computer so it can be re-enabled. @@ -261,7 +267,8 @@ Accept wildcard characters: False ``` ### -Protocol -Specifies that only matching Hyper-V firewall rules with the indicated Protocol are retrieved. +Specifies that only matching Hyper-V firewall rules with the indicated protocol are retrieved. + The acceptable values for this parameter are: - Protocols by number: 0-255. - Protocols by name: TCP, UDP, ICMPv4, or ICMPv6. @@ -279,7 +286,8 @@ Accept wildcard characters: False ### -ThrottleLimit Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -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. +If this parameter is omitted or a value of `0` is entered, Windows PowerShell calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. + The throttle limit applies only to the current cmdlet, not to the session or to the computer. ```yaml diff --git a/docset/winserver2022-ps/netsecurity/Get-NetFirewallHyperVVMCreator.md b/docset/winserver2022-ps/netsecurity/Get-NetFirewallHyperVVMCreator.md index 926fc59829..3eee9bdc2b 100644 --- a/docset/winserver2022-ps/netsecurity/Get-NetFirewallHyperVVMCreator.md +++ b/docset/winserver2022-ps/netsecurity/Get-NetFirewallHyperVVMCreator.md @@ -21,11 +21,14 @@ Get-NetFirewallHyperVVMCreator [-All] [-CimSession ] [-ThrottleLim ``` ## DESCRIPTION + The **Get-NetFirewallHyperVVMCreator** cmdlet returns the instances of the Hyper-V firewall VM creators on the system. + A Hyper-V firewall rule can be scoped to apply only to Hyper-V firewall ports created by specific Hyper-V VM creators. This cmdlet is used to query the list of creators currently on the system. -A rule can scoped to a specific VM creator even if it is not yet on the system. This can be useful when configuring policy when a particular application may be installed at an unknown point in time. +A rule can be scoped to a specific VM creator even if it is not yet on the system. This can be useful when configuring policy when a particular application may be installed at an unknown point in time. + ## EXAMPLES @@ -34,7 +37,8 @@ A rule can scoped to a specific VM creator even if it is not yet on the system. PS C:\> Get-NetFirewallHyperVVMCreator ``` -This retrieves all of the Hyper-V firewall VM creators that are currently on the system. +This example retrieves all the Hyper-V firewall VM creators that are currently on the system. + ## PARAMETERS @@ -85,7 +89,8 @@ Accept wildcard characters: False ### -ThrottleLimit Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -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. +If this parameter is omitted or a value of `0` is entered, Windows PowerShell calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. + The throttle limit applies only to the current cmdlet, not to the session or to the computer. ```yaml diff --git a/docset/winserver2022-ps/netsecurity/Get-NetFirewallHyperVVMSetting.md b/docset/winserver2022-ps/netsecurity/Get-NetFirewallHyperVVMSetting.md index 7cae50c094..02b027ca39 100644 --- a/docset/winserver2022-ps/netsecurity/Get-NetFirewallHyperVVMSetting.md +++ b/docset/winserver2022-ps/netsecurity/Get-NetFirewallHyperVVMSetting.md @@ -26,7 +26,9 @@ Get-NetFirewallHyperVVMSetting [-Name] [-PolicyStore ] [-CimS ``` ## DESCRIPTION -The **Get-NetFirewallHyperVVMSetting** cmdlet returns the the Hyper-V firewall per-VM settings on the system. These settings are applicable to all Hyper-V firewall ports created by a specific Hyper-V firewall VM creator. + +The **Get-NetFirewallHyperVVMSetting** cmdlet returns the Hyper-V firewall per-VM settings on the system. These settings are applicable to all Hyper-V firewall ports created by a specific Hyper-V firewall VM creator. + These settings are configurable on a per-store basis. By default, this cmdlet queries the local store. @@ -37,21 +39,24 @@ These settings are configurable on a per-store basis. By default, this cmdlet qu PS C:\> Get-NetFirewallHyperVVMSetting ``` -This retrieves all of the Hyper-V firewall per-VM settings. With no parameters, this cmdlet queries the settings in the local store. +This example retrieves all of the Hyper-V firewall per-VM settings. With no parameters, this cmdlet queries the settings in the local store. + ### EXAMPLE 2 ``` PS C:\> Get-NetFirewallHyperVVMSetting -Name '{9E288F02-CE00-4D9E-BE2B-14CE463B0298}' ``` -This retrieves all of the Hyper-V firewall per-VM settings for the specified VM creator Id. +This example retrieves all the Hyper-V firewall per-VM settings for the specified VM creator ID. + ### EXAMPLE 3 ``` PS C:\> Get-NetFirewallHyperVVMSetting -PolicyStore ActiveStore ``` -This retrieves all of the Hyper-V firewall per-VM settings from the ActiveStore. +This example retrieves all the Hyper-V firewall per-VM settings from the ActiveStore. + ## PARAMETERS @@ -141,7 +146,8 @@ Accept wildcard characters: False ### -ThrottleLimit Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -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. +If this parameter is omitted or a value of `0` is entered, Windows PowerShell calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. + The throttle limit applies only to the current cmdlet, not to the session or to the computer. ```yaml diff --git a/docset/winserver2022-ps/netsecurity/New-NetFirewallHyperVProfile.md b/docset/winserver2022-ps/netsecurity/New-NetFirewallHyperVProfile.md index 980261e8c4..f8b6083a38 100644 --- a/docset/winserver2022-ps/netsecurity/New-NetFirewallHyperVProfile.md +++ b/docset/winserver2022-ps/netsecurity/New-NetFirewallHyperVProfile.md @@ -20,9 +20,10 @@ New-NetFirewallHyperVProfile [-PolicyStore ] [-GPOSession ] [-Na ``` ## DESCRIPTION + The **New-NetFirewallHyperVProfile** cmdlet configures the Hyper-V firewall profile settings on the system. These settings are applicable to all Hyper-V firewall ports created by a specific Hyper-V firewall VM creator. These settings apply to the VM only when the profile is active. -This cmdlet should be used when none of the following are true: a Hyper-V VM creator has registered its VM creator ID with the system, when another Hyper-V setting is already configured for the specified VM creator ID, or when a Hyper-V firewall port is created with the specified VM creator ID. If any of the above are true, the Set-NetFirewallHyperVProfile cmdlet should be used. In other words, this cmdlet can be used to configure policy prior to the application corresponding to the specific VM creator ID has running on the system. +This cmdlet should be used when none of the following are true: a Hyper-V VM creator has registered its VM creator ID with the system, when another Hyper-V setting is already configured for the specified VM creator ID, or when a Hyper-V firewall port is created with the specified VM creator ID. If any of these is true, the Set-NetFirewallHyperVProfile cmdlet should be used. In other words, this cmdlet can be used to configure policy prior to the application corresponding to the specific VM creator ID is running on the system. ## EXAMPLES @@ -31,7 +32,7 @@ This cmdlet should be used when none of the following are true: a Hyper-V VM cre PS C:\> New-NetFirewallHyperVProfile -Name '{9E288F02-CE00-4D9E-BE2B-14CE463B0298}' -Profile Public -Enabled True ``` -This configures the Enabled setting on the Public profile for all Hyper-V firewall ports created by the Hyper-V firewall VM creator specified. +This example configures the enabled setting on the public profile for all Hyper-V firewall ports created by the Hyper-V firewall VM creator specified. ## PARAMETERS @@ -158,7 +159,7 @@ Accept wildcard characters: False ``` ### -Name -Specifies that the settings are applicable only to the Hyper-V firewall VM creator with the matching Id. +Specifies that the settings are applicable only to the Hyper-V firewall VM creator with the matching ID. The format for this value is a GUID enclosed in brackets: '{9E288F02-CE00-4D9E-BE2B-14CE463B0298}'. ```yaml @@ -174,7 +175,7 @@ Accept wildcard characters: False ### -ThrottleLimit Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -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. +If this parameter is omitted or a value of `0` is entered, Windows PowerShell calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer. ```yaml diff --git a/docset/winserver2022-ps/netsecurity/New-NetFirewallHyperVRule.md b/docset/winserver2022-ps/netsecurity/New-NetFirewallHyperVRule.md index 818e0fe9a8..1f9a005a01 100644 --- a/docset/winserver2022-ps/netsecurity/New-NetFirewallHyperVRule.md +++ b/docset/winserver2022-ps/netsecurity/New-NetFirewallHyperVRule.md @@ -20,8 +20,10 @@ New-NetFirewallHyperVRule -DisplayName [-Name ] [-RulePriority ``` ## DESCRIPTION + The **New-NetFirewallHyperVRule** cmdlet creates an inbound or outbound Hyper-V firewall rule and adds the rule to the target computer. + Some parameters are used to specify the conditions that must be matched for the rule to apply, such as the *LocalAddress* and *RemoteAddress* parameters. Rules that already exist can be managed with the Get-NetFirewallHyperVRule and Set-NetFirewallHyperVRule cmdlets. @@ -156,7 +158,8 @@ The acceptable values for this parameter are: - True: Specifies the rule is currently enabled. - False: Specifies the rule is currently disabled. -Note, that the type of this parameter is not boolean, therefore `$true` and `$false` variables are not acceptable values here. Use "True" and "False" text strings instead. +Note that the type of this parameter is not Boolean, therefore `$true` and `$false` variables are not acceptable values here. Use "True" and "False" text strings instead. + A disabled rule will not actively modify computer behavior, but the management construct still exists on the computer so it can be re-enabled. @@ -302,7 +305,8 @@ Accept wildcard characters: False ### -RulePriority Specifies the order in which rules are evaluated. A lower priority rule is evaluated before a higher priority rule. -The default value is based on the Action of the rule. A rule with Action Allow is set to priority 2, and a rule with Action Block is 1. This configures, by default, Block rules to take precedence over Allow rules. +The default value is based on the action of the rule. A rule with Action Allow is set to priority 2, and a rule with Action Block is 1. This configures, by default, Block rules to take precedence over Allow rules. + ```yaml Type: uint16 @@ -355,7 +359,8 @@ Accept wildcard characters: False ### -ThrottleLimit Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -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. +If this parameter is omitted or a value of `0` is entered, Windows PowerShell calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. + The throttle limit applies only to the current cmdlet, not to the session or to the computer. ```yaml diff --git a/docset/winserver2022-ps/netsecurity/New-NetFirewallHyperVVMSetting.md b/docset/winserver2022-ps/netsecurity/New-NetFirewallHyperVVMSetting.md index 47d1af30b7..305465efce 100644 --- a/docset/winserver2022-ps/netsecurity/New-NetFirewallHyperVVMSetting.md +++ b/docset/winserver2022-ps/netsecurity/New-NetFirewallHyperVVMSetting.md @@ -20,9 +20,12 @@ New-NetFirewallHyperVVMSetting [-PolicyStore ] [-GPOSession ] [- ``` ## DESCRIPTION + The **New-NetFirewallHyperVVMSetting** cmdlet configures settings for the Hyper-V firewall per-VM settings on the system. These settings are applicable to all Hyper-V firewall ports created by a specific Hyper-V firewall VM creator. -This cmdlet should be used when none of the following are true: a Hyper-V VM creator has registered its VM creator ID with the system, when another Hyper-V setting is already configured for the specified VM creator ID, or when a Hyper-V firewall port is created with the specified VM creator ID. If any of the above are true, the Set-NetFirewallHyperVVMSetting cmdlet should be used. In other words, this cmdlet can be used to configure policy prior to the application corresponding to the specific VM creator ID has running on the system. + +This cmdlet should be used when none of the following are true: a Hyper-V VM creator has registered its VM creator ID with the system, when another Hyper-V setting is already configured for the specified VM creator ID, or when a Hyper-V firewall port is created with the specified VM creator ID. If any of these is true, the Set-NetFirewallHyperVVMSetting cmdlet should be used. In other words, this cmdlet can be used to configure policy prior to the application corresponding to the specific VM creator ID running on the system. + ## EXAMPLES @@ -31,7 +34,8 @@ This cmdlet should be used when none of the following are true: a Hyper-V VM cre PS C:\> New-NetFirewallHyperVVMSetting -Name '{9E288F02-CE00-4D9E-BE2B-14CE463B0298}' -LoopbackEnabled True ``` -This configures the LoopbackEnabled setting for all Hyper-V firewall ports created by the Hyper-V firewall VM creator specified. +This example configures the LoopbackEnabled setting for all Hyper-V firewall ports created by the Hyper-V firewall VM creator specified. + ## PARAMETERS @@ -167,7 +171,8 @@ Accept wildcard characters: False ### -AllowHostPolicyMerge Specifies that the host firewall policy should be merged into the effective policy. -This setting controls whether host firewall profile settings (DefaultInboundAction, DefaultOutboundAction, Enabled, AllowLocalFirewallRules) as well as host firewall rules (only rules which are IP 5-tuple based, i.e, not having any local conditions such as application) should be applicable to Hyper-V firewall. +This setting controls whether host firewall profile settings (DefaultInboundAction, DefaultOutboundAction, Enabled, AllowLocalFirewallRules) as well as host firewall rules (only rules that are IP 5-tuple based, that is, not having any local conditions such as application) should be applicable to Hyper-V firewall. + Policy configurations may come from many stores. If this setting is True, the following order of precedence is used for determining the effective policy (highest priority to lowest priority): - Host Firewall Group Policy @@ -178,7 +183,8 @@ Policy configurations may come from many stores. If this setting is True, the fo The acceptable values for this parameter are: False, True, or NotConfigured. -- True: Host firewall rules and settings are applied to Hyper-V Firewall. +- True: Host firewall rules and settings are applied to the Hyper-V firewall. + - False: Host firewall rules and settings are not applied to Hyper-V firewall - NotConfigured: Resets this value back to its default. @@ -198,7 +204,8 @@ Accept wildcard characters: False ``` ### -Name -Specifies that the settings are applicable only to the Hyper-V firewall VM creator with the matching Id. +Specifies that the settings are applicable only to the Hyper-V firewall VM creator with the matching ID. + The format for this value is a GUID enclosed in brackets: '{9E288F02-CE00-4D9E-BE2B-14CE463B0298}'. ```yaml @@ -214,7 +221,8 @@ Accept wildcard characters: False ### -ThrottleLimit Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -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. +If this parameter is omitted or a value of `0` is entered, Windows PowerShell calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. + The throttle limit applies only to the current cmdlet, not to the session or to the computer. ```yaml diff --git a/docset/winserver2022-ps/netsecurity/Remove-NetFirewallHyperVRule.md b/docset/winserver2022-ps/netsecurity/Remove-NetFirewallHyperVRule.md index 284f07ca98..c3dfb45dfa 100644 --- a/docset/winserver2022-ps/netsecurity/Remove-NetFirewallHyperVRule.md +++ b/docset/winserver2022-ps/netsecurity/Remove-NetFirewallHyperVRule.md @@ -41,11 +41,14 @@ Remove-NetFirewallHyperVRule -InputObject Remove-NetFirewallHyperVRule ``` -This retrieves all of the Hyper-V firewall rules in the local store and removes all of them. +This example retrieves all the Hyper-V firewall rules in the local store and removes them. + ### EXAMPLE 2 ``` PS C:\> Remove-NetFirewallHyperVRule -DisplayName 'MyServerIPBlock' ``` -This retrieves all of the Hyper-V firewall rules with DisplayName 'MyServerIPBlock' and removes them. +This example retrieves all the Hyper-V firewall rules with DisplayName 'MyServerIPBlock' and removes them. + ## PARAMETERS @@ -153,7 +158,8 @@ The acceptable values for this parameter are: - True: Specifies the rule is currently enabled. - False: Specifies the rule is currently disabled. -Note, that the type of this parameter is not boolean, therefore `$true` and `$false` variables are not acceptable values here. Use "True" and "False" text strings instead. +Note that the type of this parameter is not Boolean, therefore `$true` and `$false` variables are not acceptable values here. Use "True" and "False" text strings instead. + A disabled rule will not actively modify computer behavior, but the management construct still exists on the computer so it can be re-enabled. @@ -239,7 +245,8 @@ The acceptable values for this parameter are: - Local: The object originates from the local store. - MDM: The object originates from the MDM store. -By default, the Local store is queried. +By default, the local store is queried. + ```yaml Type: PolicyStoreType[] @@ -255,7 +262,8 @@ Accept wildcard characters: False ``` ### -Protocol -Specifies that only matching Hyper-V firewall rules with the indicated Protocol are removed. +Specifies that only matching Hyper-V firewall rules with the indicated protocol are removed. + The acceptable values for this parameter are: - Protocols by number: 0-255. - Protocols by name: TCP, UDP, ICMPv4, or ICMPv6. @@ -273,7 +281,8 @@ Accept wildcard characters: False ### -ThrottleLimit Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -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. +If this parameter is omitted or a value of `0` is entered, Windows PowerShell calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. + The throttle limit applies only to the current cmdlet, not to the session or to the computer. ```yaml @@ -289,7 +298,8 @@ Accept wildcard characters: False ### -VMCreatorId Specifies that only matching Hyper-V firewall rules with the specified VMCreatorId are removed. -The format for this value is a Guid enclosed in brackets, i.e '{9E288F02-CE00-4D9E-BE2B-14CE463B0298}' +The format for this value is a GUID enclosed in brackets, such as '{9E288F02-CE00-4D9E-BE2B-14CE463B0298}'. + ```yaml Type: String diff --git a/docset/winserver2022-ps/netsecurity/Rename-NetFirewallHyperVRule.md b/docset/winserver2022-ps/netsecurity/Rename-NetFirewallHyperVRule.md index 0c459fc3f0..0814065533 100644 --- a/docset/winserver2022-ps/netsecurity/Rename-NetFirewallHyperVRule.md +++ b/docset/winserver2022-ps/netsecurity/Rename-NetFirewallHyperVRule.md @@ -41,9 +41,11 @@ Rename-NetFirewallHyperVRule -InputObject ] [-GPOSession ] [-Na ``` ## DESCRIPTION + The **Set-NetFirewallHyperVProfile** cmdlet configures the Hyper-V firewall profile settings on the system. These settings are applicable to all Hyper-V firewall ports created by a specific Hyper-V firewall VM creator. These settings apply to the VM only when the profile is active. This cmdlet should be used when a Hyper-V VM creator has registered its VM creator ID with the system, when another Hyper-V setting is already configured for the specified VM creator ID, or when a Hyper-V firewall port is created with the specified VM creator ID. If none of the above are true, then the New-NetFirewallHyperVProfile cmdlet should be used. @@ -32,7 +33,7 @@ This cmdlet should be used when a Hyper-V VM creator has registered its VM creat PS C:\> Set-NetFirewallHyperVProfile -Name '{9E288F02-CE00-4D9E-BE2B-14CE463B0298}' -Profile Public -Enabled True ``` -This configures the Enabled setting on the Public profile for all Hyper-V firewall ports created by the Hyper-V firewall VM creator specified. +This example configures the Enabled setting on the Public profile for all Hyper-V firewall ports created by the Hyper-V firewall VM creator specified. ## PARAMETERS @@ -67,7 +68,7 @@ Accept wildcard characters: False ``` ### -DefaultInboundAction -Specifies how to filter inbound traffic which does not match any Hyper-V firewall rules. +Specifies how to filter inbound traffic that does not match any Hyper-V firewall rules. The acceptable values for this parameter are: NotConfigured, Allow, or Block. - Block: Blocks inbound network traffic that does not match an inbound rule. @@ -90,7 +91,7 @@ Accept wildcard characters: False ``` ### -DefaultOutboundAction -Specifies how to filter outbound traffic which does not match any Hyper-V firewall rules. +Specifies how to filter outbound traffic that does not match any Hyper-V firewall rules. The acceptable values for this parameter are: NotConfigured, Allow, or Block. - Block: Blocks outbound network traffic that does not match an outbound rule. @@ -159,7 +160,7 @@ Accept wildcard characters: False ``` ### -Name -Specifies that the settings are applicable only to the Hyper-V firewall VM creator with the matching Id. +Specifies that the settings are applicable only to the Hyper-V firewall VM creator with the matching ID. The format for this value is a GUID enclosed in brackets: '{9E288F02-CE00-4D9E-BE2B-14CE463B0298}'. ```yaml @@ -175,7 +176,7 @@ Accept wildcard characters: False ### -ThrottleLimit Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -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. +If this parameter is omitted or a value of `0` is entered, Windows PowerShell calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer. ```yaml diff --git a/docset/winserver2022-ps/netsecurity/Set-NetFirewallHyperVRule.md b/docset/winserver2022-ps/netsecurity/Set-NetFirewallHyperVRule.md index d9290941fd..016e23e245 100644 --- a/docset/winserver2022-ps/netsecurity/Set-NetFirewallHyperVRule.md +++ b/docset/winserver2022-ps/netsecurity/Set-NetFirewallHyperVRule.md @@ -31,8 +31,10 @@ Set-NetFirewallHyperVRule -InputObject Set-NetFirewallHyperVVMSetting -Name '9E288F02-CE00-4D9E-BE2B-14CE463B0298}' -LoopbackEnabled True ``` -This updates the LoopbackEnabled setting for all Hyper-V firewall ports created by the Hyper-V firewall VM creator specified. +This example updates the LoopbackEnabled setting for all Hyper-V firewall ports created by the Hyper-V firewall VM creator specified. + ## PARAMETERS @@ -72,7 +75,8 @@ Accept wildcard characters: False ``` ### -DefaultInboundAction -Specifies how to filter inbound traffic which does not match any Hyper-V firewall rules. +Specifies how to filter inbound traffic that does not match any Hyper-V firewall rules. + This setting applies the configuration to all profiles. For configuring at a per-profile granularity, use the `Set-NetFirewallHyperVProfile` cmdlet. @@ -98,7 +102,8 @@ Accept wildcard characters: False ``` ### -DefaultOutboundAction -Specifies how to filter outbound traffic which does not match any Hyper-V firewall rules. +Specifies how to filter outbound traffic that does not match any Hyper-V firewall rules. + This setting applies the configuration to all profiles. For configuring at a per-profile granularity, use the `Set-NetFirewallHyperVProfile` cmdlet. @@ -178,7 +183,8 @@ Accept wildcard characters: False ### -AllowHostPolicyMerge Specifies that the host firewall policy should be merged into the effective policy. -This setting controls whether host firewall profile settings (DefaultInboundAction, DefaultOutboundAction, Enabled, AllowLocalFirewallRules) as well as host firewall rules (only rules which are IP 5-tuple based, i.e, not having any local conditions such as application) should be applicable to Hyper-V firewall. +This setting controls whether host firewall profile settings (DefaultInboundAction, DefaultOutboundAction, Enabled, and AllowLocalFirewallRules) as well as host firewall rules (only rules that are IP 5-tuple based, that is, not having any local conditions such as application) should be applicable to Hyper-V firewall. + Policy configurations may come from many stores. If this setting is True, the following order of precedence is used for determining the effective policy (highest priority to lowest priority): - Host Firewall Group Policy @@ -189,7 +195,8 @@ Policy configurations may come from many stores. If this setting is True, the fo The acceptable values for this parameter are: False, True, or NotConfigured. -- True: Host firewall rules and settings are applied to Hyper-V Firewall. +- True: Host firewall rules and settings are applied to Hyper-V firewall. + - False: Host firewall rules and settings are not applied to Hyper-V firewall - NotConfigured: Resets this value back to its default. @@ -225,7 +232,8 @@ Accept wildcard characters: False ### -ThrottleLimit Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -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. +If this parameter is omitted or a value of `0` is entered, Windows PowerShell calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. + The throttle limit applies only to the current cmdlet, not to the session or to the computer. ```yaml From d74ea5de0931642a43139c8a09fd1ad264b14722 Mon Sep 17 00:00:00 2001 From: robinharwood <19212983+robinharwood@users.noreply.github.com> Date: Mon, 11 Sep 2023 09:57:44 +0100 Subject: [PATCH 618/650] Editorial updates --- .../failoverclusters/Get-ClusterAffinityRule.md | 13 +++++++++---- .../failoverclusters/New-ClusterAffinityRule.md | 17 +++++++++++------ .../Remove-ClusterAffinityRule.md | 13 +++++++++---- .../failoverclusters/Set-ClusterAffinityRule.md | 13 +++++++++---- 4 files changed, 38 insertions(+), 18 deletions(-) diff --git a/docset/winserver2022-ps/failoverclusters/Get-ClusterAffinityRule.md b/docset/winserver2022-ps/failoverclusters/Get-ClusterAffinityRule.md index ae4f9ad5a3..472dba7550 100644 --- a/docset/winserver2022-ps/failoverclusters/Get-ClusterAffinityRule.md +++ b/docset/winserver2022-ps/failoverclusters/Get-ClusterAffinityRule.md @@ -101,10 +101,9 @@ Accept wildcard characters: False ### -ThrottleLimit Specifies the maximum number of concurrent operations that can be established to run the cmdlet. 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. The throttle limit applies only to the current cmdlet, not to the session or to the -computer. +this parameter is omitted or a value of `0` is entered, then PowerShell calculates an optimum +throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. +The throttle limit applies only to the current cmdlet, not to the session or to the computer. ```yaml Type: Int32 @@ -138,3 +137,9 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS + +[New-ClusterAffinityRule](New-ClusterAffinityRule.md) + +[Remove-ClusterAffinityRule](Remove-ClusterAffinityRule.md) + +[Set-ClusterAffinityRule](Set-ClusterAffinityRule.md) diff --git a/docset/winserver2022-ps/failoverclusters/New-ClusterAffinityRule.md b/docset/winserver2022-ps/failoverclusters/New-ClusterAffinityRule.md index 9fdcfa977c..aabb06abda 100644 --- a/docset/winserver2022-ps/failoverclusters/New-ClusterAffinityRule.md +++ b/docset/winserver2022-ps/failoverclusters/New-ClusterAffinityRule.md @@ -22,8 +22,8 @@ New-ClusterAffinityRule [-Name] [-RuleType ] [-CimSession Date: Tue, 12 Sep 2023 14:29:33 +0100 Subject: [PATCH 619/650] Applied feedback suggestions --- .../Get-ClusterAffinityRule.md | 11 ++++---- .../New-ClusterAffinityRule.md | 18 +++++++------ .../Remove-ClusterAffinityRule.md | 10 ++++---- .../Set-ClusterAffinityRule.md | 25 +++++++++---------- 4 files changed, 33 insertions(+), 31 deletions(-) diff --git a/docset/winserver2022-ps/failoverclusters/Get-ClusterAffinityRule.md b/docset/winserver2022-ps/failoverclusters/Get-ClusterAffinityRule.md index 472dba7550..29795b0d68 100644 --- a/docset/winserver2022-ps/failoverclusters/Get-ClusterAffinityRule.md +++ b/docset/winserver2022-ps/failoverclusters/Get-ClusterAffinityRule.md @@ -22,12 +22,12 @@ Get-ClusterAffinityRule [[-Name] ] [-CimSession ] [-Thro ## DESCRIPTION -This cmdlet is used to display the given rule and what type it is. If -Name isn't specified, it -will list all rules. +This cmdlet is used to display the given rule and what type it is. The cmdlet lists all rules by +default. Use the **Name** parameter to return a specific rule or rules. ## EXAMPLES -### Example 1 +### Example 1 - Get a specific affinity rule ```powershell Get-ClusterAffinityRule -Name AffinityRule1 -Cluster Cluster1 @@ -48,7 +48,7 @@ prompt. You can continue to work in the session while the job completes. To mana `*-Job` cmdlets. To get the job results, use the [Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. -For more information about Windows PowerShell background jobs, see +For more information about PowerShell background jobs, see [about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). ```yaml @@ -84,7 +84,8 @@ Accept wildcard characters: False ### -Name -The name of the desired affinity rule. if this isn't provided, it will list all the rules. +The name of the desired affinity rule. When this parameter isn't specified, the cmdlet lists every +rule. ```yaml Type: String[] diff --git a/docset/winserver2022-ps/failoverclusters/New-ClusterAffinityRule.md b/docset/winserver2022-ps/failoverclusters/New-ClusterAffinityRule.md index aabb06abda..f53798ed04 100644 --- a/docset/winserver2022-ps/failoverclusters/New-ClusterAffinityRule.md +++ b/docset/winserver2022-ps/failoverclusters/New-ClusterAffinityRule.md @@ -27,7 +27,7 @@ domain, different fault domain, same node, and different node ## EXAMPLES -### Example 1 +### Example 1 - Create a new affinity rule ```powershell New-ClusterAffinityRule -Name AffinityRule1 -RuleType SameFaultDomain -Cluster Cluster1 @@ -48,7 +48,7 @@ prompt. You can continue to work in the session while the job completes. To mana `*-Job` cmdlets. To get the job results, use the [Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. -For more information about Windows PowerShell background jobs, see +For more information about PowerShell background jobs, see [about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). ```yaml @@ -84,7 +84,7 @@ Accept wildcard characters: False ### -Name -The name of the rule to be created. +The name of the rule to create. ```yaml Type: String @@ -100,13 +100,13 @@ Accept wildcard characters: False ### -RuleType -The type of the rule you want to set your affinity rule to. The acceptable values for this parameter -are: +The affinity type for the new rule. The valid values for this parameter are: - **SameFaultDomain**. Resources must stay within the same fault domain. -- **SameNode**. Resources must stay on the same cluster node. -- **DifferentFaultDomain**. Resources will always stay in different fault domain (anti-affinity). -- **DifferentNode**. Resources will always stay on different cluster nodes (anti-affinity). +- `SameFaultDomain`. Resources must stay within the same fault domain. +- `SameNode`. Resources must stay on the same cluster node. +- `DifferentFaultDomain`. Resources must stay in different fault domain (anti-affinity). +- `DifferentNode`. Resources must stay on different cluster nodes (anti-affinity). ```yaml Type: RuleType @@ -151,6 +151,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ### None +This cmdlet doesn't accept any input from the pipeline. + ## OUTPUTS ### Microsoft.Management.Infrastructure.CimInstance diff --git a/docset/winserver2022-ps/failoverclusters/Remove-ClusterAffinityRule.md b/docset/winserver2022-ps/failoverclusters/Remove-ClusterAffinityRule.md index 2973d1aefe..b3919aa263 100644 --- a/docset/winserver2022-ps/failoverclusters/Remove-ClusterAffinityRule.md +++ b/docset/winserver2022-ps/failoverclusters/Remove-ClusterAffinityRule.md @@ -31,17 +31,17 @@ Remove-ClusterAffinityRule -InputObject [-CimSession [-RuleType ] [-En ## DESCRIPTION -This cmdlet is used to Enabled or Disable an affinity rule. This can also be used to change the -RuleType. +The `Set-ClusterAffinityRule` command can enable or disable an existing affinity rule. It can also +change the **RuleType**. ## EXAMPLES -### Example 1 +### Example 1 - Enable an affinity rule ```powershell Set-ClusterAffinityRule -Name AffinityRule1 -Enabled -Cluster Cluster1 @@ -56,7 +56,7 @@ prompt. You can continue to work in the session while the job completes. To mana `*-Job` cmdlets. To get the job results, use the [Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. -For more information about Windows PowerShell background jobs, see +For more information about PowerShell background jobs, see [about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). ```yaml @@ -108,7 +108,7 @@ Accept wildcard characters: False ### -InputObject -Specifies the input object that is used in a pipeline command. +Specifies the affinity rule object that is used in a pipeline command. ```yaml Type: CimInstance[] @@ -124,7 +124,7 @@ Accept wildcard characters: False ### -Name -The name of the affinity rule you want to either enable or disable. +The name of the affinity rule you want to change. ```yaml Type: String[] @@ -157,13 +157,12 @@ Accept wildcard characters: False ### -RuleType -The type of the rule you want to set your affinity rule to. The acceptable values for this parameter -are: +The affinity type to set the rule to. The valid values for this parameter are: -- **SameFaultDomain**. Resources must stay within the same fault domain. -- **SameNode**. Resources must stay on the same cluster node. -- **DifferentFaultDomain**. Resources will always stay in different fault domain (anti-affinity). -- **DifferentNode**. Resources will always stay on different cluster nodes (anti-affinity). +- `SameFaultDomain`. Resources must stay within the same fault domain. +- `SameNode`. Resources must stay on the same cluster node. +- `DifferentFaultDomain`. Resources must stay in different fault domain (anti-affinity). +- `DifferentNode`. Resources must stay on different cluster nodes (anti-affinity). ```yaml Type: RuleType From a016dd823940beee7554526d14ac26402320533b Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Tue, 12 Sep 2023 19:24:55 +0530 Subject: [PATCH 620/650] Update Set-ProcessMitigation.md Updated accepted values for Enable and disable Fixes https://github.com/MicrosoftDocs/windows-powershell-docs/issues/3274 --- .../processmitigations/Set-ProcessMitigation.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docset/winserver2022-ps/processmitigations/Set-ProcessMitigation.md b/docset/winserver2022-ps/processmitigations/Set-ProcessMitigation.md index 22b0647786..e629021144 100644 --- a/docset/winserver2022-ps/processmitigations/Set-ProcessMitigation.md +++ b/docset/winserver2022-ps/processmitigations/Set-ProcessMitigation.md @@ -102,7 +102,7 @@ If specified in both, it will be disabled. Type: String[] Parameter Sets: ProcessPolicy, SystemMode Aliases: d -Accepted values: DEP, EmulateAtlThunks, SEHOP, ForceRelocate, RequireInfo, BottomUp, HighEntropy, StrictHandle, DisableWin32kSystemCalls, AuditSystemCall, ExtensionPoint, DynamicCode, AuditDynamicCode, CFG, SuppressExports, StrictCFG, BlockNonMicrosoftSigned, AllowStoreSigned, AuditMicrosoftSigned, AuditStoreSigned, EnforceModuleDepencySigning, DisableNonSystemFonts, FontAuditOnly, AuditFont, BlockRemoteImages, BlockLowLabel, PreferSystem32, AuditImageLoad, EnableExportAddressFilter, AuditEnableExportAddressFilter, EnableExportAddressFilterPlus, AuditEnableExportAddressFilterPlus, EnableImportAddressFilter, AuditEnableImportAddressFilter, EnableRopStackPivot, AuditEnableRopStackPivot, EnableRopCallerCheck, AuditEnableRopCallerCheck, EnableRopSimExec, AuditEnableRopSimExec, SEHOP, AuditSEHOP, SEHOPTelemetry, TerminateOnHeapError, DisallowChildProcessCreation, AuditChildProcess, UserShadowStack, UserShadowStackStrictMode, AuditUserShadowStack +Accepted values: DEP, EmulateAtlThunks, SEHOP, ForceRelocate, RequireInfo, BottomUp, HighEntropy, StrictHandle, DisableWin32kSystemCalls, AuditSystemCall, ExtensionPoint, DynamicCode, AuditDynamicCode, CFG, SuppressExports, StrictCFG, MicrosoftSignedOnly, AllowStoreSigned, AuditMicrosoftSigned, AuditStoreSigned, EnforceModuleDepencySigning, DisableNonSystemFonts, FontAuditOnly, AuditFont, BlockRemoteImages, BlockLowLabel, PreferSystem32, AuditImageLoad, EnableExportAddressFilter, AuditEnableExportAddressFilter, EnableExportAddressFilterPlus, AuditEnableExportAddressFilterPlus, EnableImportAddressFilter, AuditEnableImportAddressFilter, EnableRopStackPivot, AuditEnableRopStackPivot, EnableRopCallerCheck, AuditEnableRopCallerCheck, EnableRopSimExec, AuditEnableRopSimExec, SEHOP, AuditSEHOP, SEHOPTelemetry, TerminateOnHeapError, DisallowChildProcessCreation, AuditChildProcess, UserShadowStack, UserShadowStackStrictMode, AuditUserShadowStack Required: False Position: Named @@ -135,7 +135,7 @@ If specified in both, it will be disabled. Type: String[] Parameter Sets: ProcessPolicy, SystemMode Aliases: e -Accepted values: DEP, EmulateAtlThunks, SEHOP, ForceRelocate, RequireInfo, BottomUp, HighEntropy, StrictHandle, DisableWin32kSystemCalls, AuditSystemCall, ExtensionPoint, DynamicCode, AuditDynamicCode, CFG, SuppressExports, StrictCFG, BlockNonMicrosoftSigned, AllowStoreSigned, AuditMicrosoftSigned, AuditStoreSigned, EnforceModuleDepencySigning, DisableNonSystemFonts, FontAuditOnly, AuditFont, BlockRemoteImages, BlockLowLabel, PreferSystem32, AuditImageLoad, EnableExportAddressFilter, EnableExportAddressFilterPlus, EnableImportAddressFilter, EnableRopStackPivot, EnableRopCallerCheck, EnableRopSimExec, SEHOP, AuditSEHOP, SEHOPTelemetry, TerminateOnHeapError, DisallowChildProcessCreation, AuditChildProcess, UserShadowStack, UserShadowStackStrictMode, AuditUserShadowStack +Accepted values: DEP, EmulateAtlThunks, SEHOP, ForceRelocate, RequireInfo, BottomUp, HighEntropy, StrictHandle, DisableWin32kSystemCalls, AuditSystemCall, ExtensionPoint, DynamicCode, AuditDynamicCode, CFG, SuppressExports, StrictCFG, MicrosoftSignedOnly, AllowStoreSigned, AuditMicrosoftSigned, AuditStoreSigned, EnforceModuleDepencySigning, DisableNonSystemFonts, FontAuditOnly, AuditFont, BlockRemoteImages, BlockLowLabel, PreferSystem32, AuditImageLoad, EnableExportAddressFilter, EnableExportAddressFilterPlus, EnableImportAddressFilter, EnableRopStackPivot, EnableRopCallerCheck, EnableRopSimExec, SEHOP, AuditSEHOP, SEHOPTelemetry, TerminateOnHeapError, DisallowChildProcessCreation, AuditChildProcess, UserShadowStack, UserShadowStackStrictMode, AuditUserShadowStack Required: False Position: Named From c9a1b3561e1da469e7a3dd285d6843f6ea4d77e3 Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Tue, 12 Sep 2023 19:28:12 +0530 Subject: [PATCH 621/650] Update Set-ProcessMitigation.md Updated values --- .../processmitigations/Set-ProcessMitigation.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docset/winserver2022-ps/processmitigations/Set-ProcessMitigation.md b/docset/winserver2022-ps/processmitigations/Set-ProcessMitigation.md index e629021144..39f2a5da75 100644 --- a/docset/winserver2022-ps/processmitigations/Set-ProcessMitigation.md +++ b/docset/winserver2022-ps/processmitigations/Set-ProcessMitigation.md @@ -102,7 +102,7 @@ If specified in both, it will be disabled. Type: String[] Parameter Sets: ProcessPolicy, SystemMode Aliases: d -Accepted values: DEP, EmulateAtlThunks, SEHOP, ForceRelocate, RequireInfo, BottomUp, HighEntropy, StrictHandle, DisableWin32kSystemCalls, AuditSystemCall, ExtensionPoint, DynamicCode, AuditDynamicCode, CFG, SuppressExports, StrictCFG, MicrosoftSignedOnly, AllowStoreSigned, AuditMicrosoftSigned, AuditStoreSigned, EnforceModuleDepencySigning, DisableNonSystemFonts, FontAuditOnly, AuditFont, BlockRemoteImages, BlockLowLabel, PreferSystem32, AuditImageLoad, EnableExportAddressFilter, AuditEnableExportAddressFilter, EnableExportAddressFilterPlus, AuditEnableExportAddressFilterPlus, EnableImportAddressFilter, AuditEnableImportAddressFilter, EnableRopStackPivot, AuditEnableRopStackPivot, EnableRopCallerCheck, AuditEnableRopCallerCheck, EnableRopSimExec, AuditEnableRopSimExec, SEHOP, AuditSEHOP, SEHOPTelemetry, TerminateOnHeapError, DisallowChildProcessCreation, AuditChildProcess, UserShadowStack, UserShadowStackStrictMode, AuditUserShadowStack +Accepted values: DEP, EmulateAtlThunks, SEHOP, ForceRelocateImages, RequireInfo, BottomUp, HighEntropy, StrictHandle, DisableWin32kSystemCalls, AuditSystemCall, DisableExtensionPoints, BlockDynamicCode, AllowThreadsToOptOut, AuditDynamicCode, CFG, SuppressExports, StrictCFG, MicrosoftSignedOnly, AllowStoreSignedBinaries, AuditMicrosoftSigned, AuditStoreSigned, EnforceModuleDependencySigning, DisableNonSystemFonts, AuditFont, BlockRemoteImageLoads, BlockLowLabelImageLoads, PreferSystem32, AuditRemoteImageLoads, AuditLowLabelImageLoads, AuditPreferSystem32, EnableExportAddressFilter, AuditEnableExportAddressFilter, EnableExportAddressFilterPlus, AuditEnableExportAddressFilterPlus, EnableImportAddressFilter, AuditEnableImportAddressFilter, EnableRopStackPivot, AuditEnableRopStackPivot, EnableRopCallerCheck, AuditEnableRopCallerCheck, EnableRopSimExec, AuditEnableRopSimExec, SEHOP, AuditSEHOP, SEHOPTelemetry, TerminateOnError, DisallowChildProcessCreation, AuditChildProcess Required: False Position: Named @@ -135,7 +135,7 @@ If specified in both, it will be disabled. Type: String[] Parameter Sets: ProcessPolicy, SystemMode Aliases: e -Accepted values: DEP, EmulateAtlThunks, SEHOP, ForceRelocate, RequireInfo, BottomUp, HighEntropy, StrictHandle, DisableWin32kSystemCalls, AuditSystemCall, ExtensionPoint, DynamicCode, AuditDynamicCode, CFG, SuppressExports, StrictCFG, MicrosoftSignedOnly, AllowStoreSigned, AuditMicrosoftSigned, AuditStoreSigned, EnforceModuleDepencySigning, DisableNonSystemFonts, FontAuditOnly, AuditFont, BlockRemoteImages, BlockLowLabel, PreferSystem32, AuditImageLoad, EnableExportAddressFilter, EnableExportAddressFilterPlus, EnableImportAddressFilter, EnableRopStackPivot, EnableRopCallerCheck, EnableRopSimExec, SEHOP, AuditSEHOP, SEHOPTelemetry, TerminateOnHeapError, DisallowChildProcessCreation, AuditChildProcess, UserShadowStack, UserShadowStackStrictMode, AuditUserShadowStack +Accepted values: DEP, EmulateAtlThunks, SEHOP, ForceRelocateImages, RequireInfo, BottomUp, HighEntropy, StrictHandle, DisableWin32kSystemCalls, AuditSystemCall, DisableExtensionPoints, BlockDynamicCode, AllowThreadsToOptOut, AuditDynamicCode, CFG, SuppressExports, StrictCFG, MicrosoftSignedOnly, AllowStoreSignedBinaries, AuditMicrosoftSigned, AuditStoreSigned, EnforceModuleDependencySigning, DisableNonSystemFonts, AuditFont, BlockRemoteImageLoads, BlockLowLabelImageLoads, PreferSystem32, AuditRemoteImageLoads, AuditLowLabelImageLoads, AuditPreferSystem32, EnableExportAddressFilter, AuditEnableExportAddressFilter, EnableExportAddressFilterPlus, AuditEnableExportAddressFilterPlus, EnableImportAddressFilter, AuditEnableImportAddressFilter, EnableRopStackPivot, AuditEnableRopStackPivot, EnableRopCallerCheck, AuditEnableRopCallerCheck, EnableRopSimExec, AuditEnableRopSimExec, SEHOP, AuditSEHOP, SEHOPTelemetry, TerminateOnError, DisallowChildProcessCreation, AuditChildProcess Required: False Position: Named From 768a4447a5b4e7563a693020acb05453dedb6cf9 Mon Sep 17 00:00:00 2001 From: robinharwood <19212983+robinharwood@users.noreply.github.com> Date: Tue, 19 Sep 2023 15:46:00 +0100 Subject: [PATCH 622/650] Edits after feedback --- .../Get-ClusterAffinityRule.md | 6 +++ .../New-ClusterAffinityRule.md | 3 ++ .../Remove-ClusterAffinityRule.md | 9 ++++ .../Set-ClusterAffinityRule.md | 44 ++++++++++++++++--- 4 files changed, 57 insertions(+), 5 deletions(-) diff --git a/docset/winserver2022-ps/failoverclusters/Get-ClusterAffinityRule.md b/docset/winserver2022-ps/failoverclusters/Get-ClusterAffinityRule.md index 29795b0d68..45cc891cce 100644 --- a/docset/winserver2022-ps/failoverclusters/Get-ClusterAffinityRule.md +++ b/docset/winserver2022-ps/failoverclusters/Get-ClusterAffinityRule.md @@ -129,12 +129,18 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ### System.String[] +When a string is piped to this cmdlet, the value is use as the name of the affinity rule to remove. + ## OUTPUTS ### Microsoft.Management.Infrastructure.CimInstance ### Microsoft.Management.Infrastructure.CimInstance#root/MSCLUSTER/MSCluster_AffinityRule +The **Microsoft.Management.Infrastructure.CimInstance** object is a wrapper class that displays +Windows Management Instrumentation (WMI) objects. The command returns an object representing an +affinity rule as a CIM instance within the `root/MSCLUSTER/MSCluster_AffinityRule` path. + ## NOTES ## RELATED LINKS diff --git a/docset/winserver2022-ps/failoverclusters/New-ClusterAffinityRule.md b/docset/winserver2022-ps/failoverclusters/New-ClusterAffinityRule.md index f53798ed04..2c2a27ce42 100644 --- a/docset/winserver2022-ps/failoverclusters/New-ClusterAffinityRule.md +++ b/docset/winserver2022-ps/failoverclusters/New-ClusterAffinityRule.md @@ -158,6 +158,9 @@ This cmdlet doesn't accept any input from the pipeline. ### Microsoft.Management.Infrastructure.CimInstance ### Microsoft.Management.Infrastructure.CimInstance#root/MSCluster/MSCluster_AffinityRule +The **Microsoft.Management.Infrastructure.CimInstance** object is a wrapper class that displays +Windows Management Instrumentation (WMI) objects. The command returns an object representing an +affinity rule as a CIM instance within the `root/MSCLUSTER/MSCluster_AffinityRule` path. ## NOTES diff --git a/docset/winserver2022-ps/failoverclusters/Remove-ClusterAffinityRule.md b/docset/winserver2022-ps/failoverclusters/Remove-ClusterAffinityRule.md index b3919aa263..82b79a7a0b 100644 --- a/docset/winserver2022-ps/failoverclusters/Remove-ClusterAffinityRule.md +++ b/docset/winserver2022-ps/failoverclusters/Remove-ClusterAffinityRule.md @@ -201,14 +201,23 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ### System.String[] +When a string is piped to this cmdlet, the value is use as the name of the affinity rule to remove. + ### Microsoft.Management.Infrastructure.CimInstance[] +This cmdlet accepts CIM instance objects representing an affinity rule like those returned by the +[Get-ClusterAffinityRule](Get-ClusterAffinityRule.md) cmdlet. + ## OUTPUTS ### Microsoft.Management.Infrastructure.CimInstance ### Microsoft.Management.Infrastructure.CimInstance#root/MSCLUSTER/MSCluster_AffinityRule +The **Microsoft.Management.Infrastructure.CimInstance** object is a wrapper class that displays +Windows Management Instrumentation (WMI) objects. The command returns an object representing an +affinity rule as a CIM instance within the `root/MSCLUSTER/MSCluster_AffinityRule` path. + ## NOTES ## RELATED LINKS diff --git a/docset/winserver2022-ps/failoverclusters/Set-ClusterAffinityRule.md b/docset/winserver2022-ps/failoverclusters/Set-ClusterAffinityRule.md index 341ee701c4..6d46d45d99 100644 --- a/docset/winserver2022-ps/failoverclusters/Set-ClusterAffinityRule.md +++ b/docset/winserver2022-ps/failoverclusters/Set-ClusterAffinityRule.md @@ -39,10 +39,28 @@ change the **RuleType**. ### Example 1 - Enable an affinity rule ```powershell -Set-ClusterAffinityRule -Name AffinityRule1 -Enabled -Cluster Cluster1 +Set-ClusterAffinityRule -Name AffinityRule1 -Enabled ``` -This example enables the cluster affinity rule named AffinityRule1. +This example enables the cluster affinity rule named `AffinityRule1`. + +### Example 2 - Disable an affinity rule + +```powershell +Set-ClusterAffinityRule -Name AffinityRule1 -Enabled:$false +``` + +This example disables the cluster affinity rule named `AffinityRule1`. + +### Example 3 - Change an affinity rule type + +```powershell +Get-ClusterAffinityRule -Name AffinityRule1 | Set-ClusterAffinityRule -RuleType DifferentNode +``` + +This example gets the affinity rule named `AffinityRule1` and pipes the affinity rule object to the +`Set-ClusterAffinityRule` cmdlet. The `Set-ClusterAffinityRule` cmdlet changes the affinity rule +type to `DifferentNode`. ## PARAMETERS @@ -92,7 +110,10 @@ Accept wildcard characters: False ### -Enabled -Enables or disables the affinity rule. +Enables or disables the affinity rule. The accepted values for this parameter are: + +- `0` or `$false`. The affinity rule is disabled. +- `1` or `$true`. The affinity rule is enabled. ```yaml Type: UInt32 @@ -140,8 +161,8 @@ Accept wildcard characters: False ### -PassThru -Returns an object representing the item with which you are working. By default, this cmdlet doesn't -generate any output. +Returns an the original object passed to the command. By default, this cmdlet doesn't generate any +output. ```yaml Type: SwitchParameter @@ -207,14 +228,27 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ### System.String[] +When a string is piped to this cmdlet, the value is use as the name of the affinity rule to remove. + ### Microsoft.Management.Infrastructure.CimInstance[] +This cmdlet accepts CIM instance objects representing an affinity rule like those returned by the +[Get-ClusterAffinityRule](Get-ClusterAffinityRule.md) cmdlet. + ## OUTPUTS +### None + +The cmdlet doesn't generate any output unless you use the **PassThru** parameter. + ### Microsoft.Management.Infrastructure.CimInstance ### Microsoft.Management.Infrastructure.CimInstance#root/MSCLUSTER/MSCluster_AffinityRule +The **Microsoft.Management.Infrastructure.CimInstance** object is a wrapper class that displays +Windows Management Instrumentation (WMI) objects. The command returns an object representing an +affinity rule as a CIM instance within the `root/MSCLUSTER/MSCluster_AffinityRule` path. + ## NOTES ## RELATED LINKS From 1e556384fd7a38e5fe77bebf75c8f2b78f568edf Mon Sep 17 00:00:00 2001 From: robinharwood <19212983+robinharwood@users.noreply.github.com> Date: Wed, 20 Sep 2023 11:56:08 +0100 Subject: [PATCH 623/650] Fixed typo --- .../failoverclusters/Remove-ClusterAffinityRule.md | 4 ++-- .../failoverclusters/Set-ClusterAffinityRule.md | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docset/winserver2022-ps/failoverclusters/Remove-ClusterAffinityRule.md b/docset/winserver2022-ps/failoverclusters/Remove-ClusterAffinityRule.md index 82b79a7a0b..bd0a9bf6b9 100644 --- a/docset/winserver2022-ps/failoverclusters/Remove-ClusterAffinityRule.md +++ b/docset/winserver2022-ps/failoverclusters/Remove-ClusterAffinityRule.md @@ -123,8 +123,8 @@ Accept wildcard characters: False ### -PassThru -Returns an object representing the item with which you are working. By default, this cmdlet doesn't -generate any output. +Returns the original object passed to the command. By default, this cmdlet doesn't generate any +output. ```yaml Type: SwitchParameter diff --git a/docset/winserver2022-ps/failoverclusters/Set-ClusterAffinityRule.md b/docset/winserver2022-ps/failoverclusters/Set-ClusterAffinityRule.md index 6d46d45d99..97baebec3f 100644 --- a/docset/winserver2022-ps/failoverclusters/Set-ClusterAffinityRule.md +++ b/docset/winserver2022-ps/failoverclusters/Set-ClusterAffinityRule.md @@ -161,7 +161,7 @@ Accept wildcard characters: False ### -PassThru -Returns an the original object passed to the command. By default, this cmdlet doesn't generate any +Returns the original object passed to the command. By default, this cmdlet doesn't generate any output. ```yaml From aad18f558dc0ffa1d007e12aa7acf8f9401d1657 Mon Sep 17 00:00:00 2001 From: Robin Harwood <19212983+robinharwood@users.noreply.github.com> Date: Wed, 20 Sep 2023 12:24:26 +0100 Subject: [PATCH 624/650] Apply suggestions from code review Co-authored-by: Mikey Lombardi (He/Him) --- .../Get-ClusterAffinityRule.md | 7 ++--- .../New-ClusterAffinityRule.md | 24 ++++++++------- .../Remove-ClusterAffinityRule.md | 13 ++++----- .../Set-ClusterAffinityRule.md | 29 ++++++++++--------- 4 files changed, 38 insertions(+), 35 deletions(-) diff --git a/docset/winserver2022-ps/failoverclusters/Get-ClusterAffinityRule.md b/docset/winserver2022-ps/failoverclusters/Get-ClusterAffinityRule.md index 45cc891cce..5a1383d11d 100644 --- a/docset/winserver2022-ps/failoverclusters/Get-ClusterAffinityRule.md +++ b/docset/winserver2022-ps/failoverclusters/Get-ClusterAffinityRule.md @@ -129,7 +129,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ### System.String[] -When a string is piped to this cmdlet, the value is use as the name of the affinity rule to remove. +When a string is piped to this cmdlet, the value is used as the name of the affinity rule to get. ## OUTPUTS @@ -137,9 +137,8 @@ When a string is piped to this cmdlet, the value is use as the name of the affin ### Microsoft.Management.Infrastructure.CimInstance#root/MSCLUSTER/MSCluster_AffinityRule -The **Microsoft.Management.Infrastructure.CimInstance** object is a wrapper class that displays -Windows Management Instrumentation (WMI) objects. The command returns an object representing an -affinity rule as a CIM instance within the `root/MSCLUSTER/MSCluster_AffinityRule` path. +The cmdlet returns an object representing an affinity rule as a CIM instance within the +`root/MSCLUSTER/MSCluster_AffinityRule` path. ## NOTES diff --git a/docset/winserver2022-ps/failoverclusters/New-ClusterAffinityRule.md b/docset/winserver2022-ps/failoverclusters/New-ClusterAffinityRule.md index 2c2a27ce42..fd517af7a7 100644 --- a/docset/winserver2022-ps/failoverclusters/New-ClusterAffinityRule.md +++ b/docset/winserver2022-ps/failoverclusters/New-ClusterAffinityRule.md @@ -22,8 +22,13 @@ New-ClusterAffinityRule [-Name] [-RuleType ] [-CimSession [-RuleType ] [-En ## DESCRIPTION -The `Set-ClusterAffinityRule` command can enable or disable an existing affinity rule. It can also +The `Set-ClusterAffinityRule` cmdlet can enable or disable an existing affinity rule. It can also change the **RuleType**. ## EXAMPLES @@ -39,7 +39,7 @@ change the **RuleType**. ### Example 1 - Enable an affinity rule ```powershell -Set-ClusterAffinityRule -Name AffinityRule1 -Enabled +Set-ClusterAffinityRule -Name AffinityRule1 -Enabled $true ``` This example enables the cluster affinity rule named `AffinityRule1`. @@ -47,7 +47,7 @@ This example enables the cluster affinity rule named `AffinityRule1`. ### Example 2 - Disable an affinity rule ```powershell -Set-ClusterAffinityRule -Name AffinityRule1 -Enabled:$false +Set-ClusterAffinityRule -Name AffinityRule1 -Enabled $false ``` This example disables the cluster affinity rule named `AffinityRule1`. @@ -129,7 +129,8 @@ Accept wildcard characters: False ### -InputObject -Specifies the affinity rule object that is used in a pipeline command. +Specifies the affinity rule object to change. The value must be an object representing an affinity +rule, like the output that the `Get-ClusterAffinityRule` cmdlet returns. ```yaml Type: CimInstance[] @@ -145,7 +146,7 @@ Accept wildcard characters: False ### -Name -The name of the affinity rule you want to change. +The name of the affinity rule to change. ```yaml Type: String[] @@ -180,10 +181,10 @@ Accept wildcard characters: False The affinity type to set the rule to. The valid values for this parameter are: -- `SameFaultDomain`. Resources must stay within the same fault domain. -- `SameNode`. Resources must stay on the same cluster node. -- `DifferentFaultDomain`. Resources must stay in different fault domain (anti-affinity). -- `DifferentNode`. Resources must stay on different cluster nodes (anti-affinity). +- `SameFaultDomain` - Resources must stay within the same fault domain. +- `SameNode` - Resources must stay on the same cluster node. +- `DifferentFaultDomain` - Resources must stay in different fault domain (anti-affinity). +- `DifferentNode` - Resources must stay on different cluster nodes (anti-affinity). ```yaml Type: RuleType @@ -228,7 +229,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ### System.String[] -When a string is piped to this cmdlet, the value is use as the name of the affinity rule to remove. +When a string is piped to this cmdlet, the value is used as the name of the affinity rule to +change. ### Microsoft.Management.Infrastructure.CimInstance[] @@ -239,15 +241,14 @@ This cmdlet accepts CIM instance objects representing an affinity rule like thos ### None -The cmdlet doesn't generate any output unless you use the **PassThru** parameter. +By default, the cmdlet doesn't return any output. ### Microsoft.Management.Infrastructure.CimInstance ### Microsoft.Management.Infrastructure.CimInstance#root/MSCLUSTER/MSCluster_AffinityRule -The **Microsoft.Management.Infrastructure.CimInstance** object is a wrapper class that displays -Windows Management Instrumentation (WMI) objects. The command returns an object representing an -affinity rule as a CIM instance within the `root/MSCLUSTER/MSCluster_AffinityRule` path. +When the **PassThru** parameter is specified, the cmdlet returns an object representing an affinity +rule as a CIM instance within the `root/MSCLUSTER/MSCluster_AffinityRule` path. ## NOTES From ce6dc6e87ebc4d6fa60eeee49e1b19445ed99dbb Mon Sep 17 00:00:00 2001 From: robinharwood <19212983+robinharwood@users.noreply.github.com> Date: Thu, 27 Jul 2023 16:38:12 +0100 Subject: [PATCH 625/650] Adding new command the FailoverClusters module --- .../Add-ClusterGroupToAffinityRule.md | 200 ++++++++++++++++++ .../failoverclusters/FailoverClusters.md | 3 + 2 files changed, 203 insertions(+) create mode 100644 docset/winserver2022-ps/failoverclusters/Add-ClusterGroupToAffinityRule.md diff --git a/docset/winserver2022-ps/failoverclusters/Add-ClusterGroupToAffinityRule.md b/docset/winserver2022-ps/failoverclusters/Add-ClusterGroupToAffinityRule.md new file mode 100644 index 0000000000..80646cd9c1 --- /dev/null +++ b/docset/winserver2022-ps/failoverclusters/Add-ClusterGroupToAffinityRule.md @@ -0,0 +1,200 @@ +--- +description: Add-ClusterGroupToAffinityRule +external help file: ClusterAffinityRule.cdxml-help.xml +Module Name: FailoverClusters +ms.date: 07/27/2023 +online version: https://learn.microsoft.com/powershell/module/failoverclusters/add-clustergrouptoaffinityrule?view=windowsserver2022-ps&wt.mc_id=ps-gethelp +schema: 2.0.0 +title: Add-ClusterGroupToAffinityRule +--- + +# Add-ClusterGroupToAffinityRule + +## SYNOPSIS +This cmdlet is used to add either a VM role or a group name to a cluster affinity rule. + +## SYNTAX + +### Query (cdxml) (Default) + +``` +Add-ClusterGroupToAffinityRule [[-Name] ] [-Groups] + [-CimSession ] [-ThrottleLimit ] [-AsJob] [-PassThru] [] +``` + +### InputObject (cdxml) + +``` +Add-ClusterGroupToAffinityRule -InputObject [-Groups] +[-CimSession ] [-ThrottleLimit ] [-AsJob] [-PassThru] [] +``` + +## DESCRIPTION + +This cmdlet is used to add either a VM role or a group name to a cluster affinity rule. When using +this cmdlet we can use both **Name** and **Groups** parameters. The former is used to choose the +desired affinity rule and the latter is for the groups to be added. + +## EXAMPLES + +### Example 1 + +```powershell +Add-ClusterGroupToAffinityRule -Groups MyGroup -Name MyRule -Cluster MyCluster +``` + +This example adds the group named MyGroup to the affinity rule named MyRule on the cluster named. + +## PARAMETERS + +### -AsJob + +Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to +complete. + +The cmdlet immediately returns an object that represents the job and then displays the command +prompt. You can continue to work in the session while the job completes. To manage the job, use the +`*-Job` cmdlets. To get the job results, use the +[Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. + +For more information about Windows PowerShell background jobs, see +[about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CimSession + +Runs the cmdlet in a remote session or on a remote computer. 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. The default is the +current session on the local computer. + +```yaml +Type: CimSession[] +Parameter Sets: (All) +Aliases: Session + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Groups + +This list of groups to be added to the affinity rule. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject + +Specifies the input object that is used in a pipeline command. + +```yaml +Type: CimInstance[] +Parameter Sets: InputObject (cdxml) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name + +The Affinity rule in question that groups will be added to. + +```yaml +Type: String[] +Parameter Sets: Query (cdxml) +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru + +Returns an object representing the item with which you are working. By default, this cmdlet doesn't +generate any output. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ThrottleLimit + +Specifies the maximum number of concurrent operations that can be established to run the cmdlet. 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. The throttle limit applies only to the current cmdlet, not to the session or to the +computer. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, +-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, +-WarningAction, and -WarningVariable. For more information, see +[about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String[] + +### Microsoft.Management.Infrastructure.CimInstance[] + +## OUTPUTS + +### Microsoft.Management.Infrastructure.CimInstance + +### Microsoft.Management.Infrastructure.CimInstance#root/MSCLUSTER/MSCluster_AffinityRule + +## NOTES + +## RELATED LINKS diff --git a/docset/winserver2022-ps/failoverclusters/FailoverClusters.md b/docset/winserver2022-ps/failoverclusters/FailoverClusters.md index 6659968e2b..6dfaaf601e 100644 --- a/docset/winserver2022-ps/failoverclusters/FailoverClusters.md +++ b/docset/winserver2022-ps/failoverclusters/FailoverClusters.md @@ -46,6 +46,9 @@ clustered resources to the group. ### [Add-ClusterGroupSetDependency](./Add-ClusterGroupSetDependency.md) Adds a dependency to a cluster set. +### [Add-ClusterGroupToAffinityRule](./Add-ClusterGroupToAffinityRule.md) +This command is used to add either a VM role or a group name to a cluster affinity rule. + ### [Add-ClusterGroupToSet](./Add-ClusterGroupToSet.md) Adds a group to a set. From 652be7270771ff94888232eb65888b9cc66f25a9 Mon Sep 17 00:00:00 2001 From: robinharwood <19212983+robinharwood@users.noreply.github.com> Date: Mon, 11 Sep 2023 09:33:49 +0100 Subject: [PATCH 626/650] Updating Add-ClusterGroupToAffinityRule synopsis and description --- .../failoverclusters/Add-ClusterGroupToAffinityRule.md | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/docset/winserver2022-ps/failoverclusters/Add-ClusterGroupToAffinityRule.md b/docset/winserver2022-ps/failoverclusters/Add-ClusterGroupToAffinityRule.md index 80646cd9c1..349d4d466d 100644 --- a/docset/winserver2022-ps/failoverclusters/Add-ClusterGroupToAffinityRule.md +++ b/docset/winserver2022-ps/failoverclusters/Add-ClusterGroupToAffinityRule.md @@ -11,7 +11,7 @@ title: Add-ClusterGroupToAffinityRule # Add-ClusterGroupToAffinityRule ## SYNOPSIS -This cmdlet is used to add either a VM role or a group name to a cluster affinity rule. +Adds a cluster group to an affinity rule. ## SYNTAX @@ -31,9 +31,7 @@ Add-ClusterGroupToAffinityRule -InputObject [-Groups] ## DESCRIPTION -This cmdlet is used to add either a VM role or a group name to a cluster affinity rule. When using -this cmdlet we can use both **Name** and **Groups** parameters. The former is used to choose the -desired affinity rule and the latter is for the groups to be added. +Adds a cluster group to a named affinity rule. ## EXAMPLES From 9f7b8bcddcde44a48b92abe94c2619f28bc57b60 Mon Sep 17 00:00:00 2001 From: robinharwood <19212983+robinharwood@users.noreply.github.com> Date: Tue, 11 Jul 2023 12:52:48 +0100 Subject: [PATCH 627/650] Introducing new command Remove-ClusterGroupFromAffinityRule --- .../Remove-ClusterGroupFromAffinityRule.md | 183 ++++++++++++++++++ 1 file changed, 183 insertions(+) create mode 100644 docset/winserver2022-ps/failoverclusters/Remove-ClusterGroupFromAffinityRule.md diff --git a/docset/winserver2022-ps/failoverclusters/Remove-ClusterGroupFromAffinityRule.md b/docset/winserver2022-ps/failoverclusters/Remove-ClusterGroupFromAffinityRule.md new file mode 100644 index 0000000000..00ad8043fa --- /dev/null +++ b/docset/winserver2022-ps/failoverclusters/Remove-ClusterGroupFromAffinityRule.md @@ -0,0 +1,183 @@ +--- +description: Remove-ClusterGroupFromAffinityRule +external help file: ClusterAffinityRule.cdxml-help.xml +Module Name: FailoverClusters +ms.date: 07/26/2022 +online version: https://docs.microsoft.com/powershell/module/failoverclusters/remove-clustergroupfromaffinityrule?view=windowsserver2022-ps&wt.mc_id=ps-gethelp +schema: 2.0.0 +title: Remove-ClusterGroupFromAffinityRule +--- + +# Remove-ClusterGroupFromAffinityRule + +## SYNOPSIS +Removes a cluster group from an affinity rule. + +## SYNTAX + +### Query (cdxml) (Default) +``` +Remove-ClusterGroupFromAffinityRule [[-Name] ] [-Groups] [-CimSession ] + [-ThrottleLimit ] [-AsJob] [-PassThru] [] +``` + +### InputObject (cdxml) +``` +Remove-ClusterGroupFromAffinityRule -InputObject [-Groups] + [-CimSession ] [-ThrottleLimit ] [-AsJob] [-PassThru] [] +``` + +## DESCRIPTION +Removes a cluster group from an affinity rule. This does not remove the rule itself + +## EXAMPLES + +### Example 1 +```powershell +Remove-ClusterGroupFromAffinityRule -Name MuRyle -Groups MyGroup -Cluster MyCluster +``` +## PARAMETERS + +### -AsJob +Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to +complete. + +The cmdlet immediately returns an object that represents the job and then displays the command +prompt. You can continue to work in the session while the job completes. To manage the job, use the +`*-Job` cmdlets. To get the job results, use the +[Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. + +For more information about Windows PowerShell background jobs, see +[about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CimSession +Runs the cmdlet in a remote session or on a remote computer. 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. The default is the +current session on the local computer. + +```yaml +Type: CimSession[] +Parameter Sets: (All) +Aliases: Session + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Groups +The groups to be removed from the affinity rule. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Specifies the input object that is used in a pipeline command. + +```yaml +Type: CimInstance[] +Parameter Sets: InputObject (cdxml) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the affinity rule to remove groups from + +```yaml +Type: String[] +Parameter Sets: Query (cdxml) +Aliases: Set + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +Returns an object representing the item with which you are working. +By default, this cmdlet does not generate any output. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ThrottleLimit +Specifies the maximum number of concurrent operations that can be established to run the cmdlet. 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. The throttle limit applies only to the current cmdlet, not to the session or to the +computer. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, +-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, +-WarningAction, and -WarningVariable. For more information, see +[about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String[] + +### Microsoft.Management.Infrastructure.CimInstance[] + +## OUTPUTS + +### Microsoft.Management.Infrastructure.CimInstance + +### Microsoft.Management.Infrastructure.CimInstance#root/MSCLUSTER/MSCluster_AffinityRule + +## NOTES + +## RELATED LINKS From cef84bab110aa6c03620859600ec52b16b3e21d2 Mon Sep 17 00:00:00 2001 From: robinharwood <19212983+robinharwood@users.noreply.github.com> Date: Thu, 27 Jul 2023 14:52:16 +0100 Subject: [PATCH 628/650] Updating text formatting and adding command to the module file --- .../failoverclusters/FailoverClusters.md | 3 ++ .../Remove-ClusterGroupFromAffinityRule.md | 29 ++++++++++++++----- 2 files changed, 25 insertions(+), 7 deletions(-) diff --git a/docset/winserver2022-ps/failoverclusters/FailoverClusters.md b/docset/winserver2022-ps/failoverclusters/FailoverClusters.md index 6dfaaf601e..2ff4b52940 100644 --- a/docset/winserver2022-ps/failoverclusters/FailoverClusters.md +++ b/docset/winserver2022-ps/failoverclusters/FailoverClusters.md @@ -228,6 +228,9 @@ Removes a fault domain. ### [Remove-ClusterGroup](./Remove-ClusterGroup.md) Removes a clustered role, also called a resource group, from a failover cluster. +### [Remove-ClusterGroupFromAffinityRule](./Remove-ClusterGroupFromAffinityRule.md) +Removes a cluster group from an affinity rule. + ### [Remove-ClusterGroupFromSet](./Remove-ClusterGroupFromSet.md) Removes a group from a set. diff --git a/docset/winserver2022-ps/failoverclusters/Remove-ClusterGroupFromAffinityRule.md b/docset/winserver2022-ps/failoverclusters/Remove-ClusterGroupFromAffinityRule.md index 00ad8043fa..059cbd39f6 100644 --- a/docset/winserver2022-ps/failoverclusters/Remove-ClusterGroupFromAffinityRule.md +++ b/docset/winserver2022-ps/failoverclusters/Remove-ClusterGroupFromAffinityRule.md @@ -2,8 +2,8 @@ description: Remove-ClusterGroupFromAffinityRule external help file: ClusterAffinityRule.cdxml-help.xml Module Name: FailoverClusters -ms.date: 07/26/2022 -online version: https://docs.microsoft.com/powershell/module/failoverclusters/remove-clustergroupfromaffinityrule?view=windowsserver2022-ps&wt.mc_id=ps-gethelp +ms.date: 07/27/2023 +online version: https://learn.microsoft.com/powershell/module/failoverclusters/remove-clustergroupfromaffinityrule?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Remove-ClusterGroupFromAffinityRule --- @@ -16,29 +16,37 @@ Removes a cluster group from an affinity rule. ## SYNTAX ### Query (cdxml) (Default) + ``` -Remove-ClusterGroupFromAffinityRule [[-Name] ] [-Groups] [-CimSession ] - [-ThrottleLimit ] [-AsJob] [-PassThru] [] +Remove-ClusterGroupFromAffinityRule [[-Name] ] [-Groups] + [-CimSession ] [-ThrottleLimit ] [-AsJob] [-PassThru] [] ``` ### InputObject (cdxml) + ``` Remove-ClusterGroupFromAffinityRule -InputObject [-Groups] [-CimSession ] [-ThrottleLimit ] [-AsJob] [-PassThru] [] ``` ## DESCRIPTION -Removes a cluster group from an affinity rule. This does not remove the rule itself + +Removes a cluster group from an affinity rule. This doesn't remove the rule itself ## EXAMPLES ### Example 1 + ```powershell Remove-ClusterGroupFromAffinityRule -Name MuRyle -Groups MyGroup -Cluster MyCluster ``` + +This example removes the cluster group MyGroup from the affinity rule named MyRule. + ## PARAMETERS ### -AsJob + Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. @@ -63,6 +71,7 @@ Accept wildcard characters: False ``` ### -CimSession + Runs the cmdlet in a remote session or on a remote computer. 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. The default is the @@ -81,6 +90,7 @@ Accept wildcard characters: False ``` ### -Groups + The groups to be removed from the affinity rule. ```yaml @@ -96,6 +106,7 @@ Accept wildcard characters: False ``` ### -InputObject + Specifies the input object that is used in a pipeline command. ```yaml @@ -111,6 +122,7 @@ Accept wildcard characters: False ``` ### -Name + The name of the affinity rule to remove groups from ```yaml @@ -126,8 +138,9 @@ Accept wildcard characters: False ``` ### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. + +Returns an object representing the item with which you are working. By default, this cmdlet doesn't +generate any output. ```yaml Type: SwitchParameter @@ -142,6 +155,7 @@ Accept wildcard characters: False ``` ### -ThrottleLimit + Specifies the maximum number of concurrent operations that can be established to run the cmdlet. 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 @@ -161,6 +175,7 @@ Accept wildcard characters: False ``` ### CommonParameters + This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see From 00633de50f1d80463748efd9e0497f84b7fa8a8d Mon Sep 17 00:00:00 2001 From: robinharwood <19212983+robinharwood@users.noreply.github.com> Date: Mon, 11 Sep 2023 09:35:45 +0100 Subject: [PATCH 629/650] Adding missing full stop --- .../failoverclusters/Remove-ClusterGroupFromAffinityRule.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/failoverclusters/Remove-ClusterGroupFromAffinityRule.md b/docset/winserver2022-ps/failoverclusters/Remove-ClusterGroupFromAffinityRule.md index 059cbd39f6..38f015b77e 100644 --- a/docset/winserver2022-ps/failoverclusters/Remove-ClusterGroupFromAffinityRule.md +++ b/docset/winserver2022-ps/failoverclusters/Remove-ClusterGroupFromAffinityRule.md @@ -31,7 +31,7 @@ Remove-ClusterGroupFromAffinityRule -InputObject [-Groups] Date: Mon, 11 Sep 2023 10:00:40 +0100 Subject: [PATCH 630/650] Adding remove command to PR --- .../failoverclusters/Add-ClusterGroupToAffinityRule.md | 2 ++ .../failoverclusters/Remove-ClusterGroupFromAffinityRule.md | 2 ++ 2 files changed, 4 insertions(+) diff --git a/docset/winserver2022-ps/failoverclusters/Add-ClusterGroupToAffinityRule.md b/docset/winserver2022-ps/failoverclusters/Add-ClusterGroupToAffinityRule.md index 349d4d466d..1a986a194e 100644 --- a/docset/winserver2022-ps/failoverclusters/Add-ClusterGroupToAffinityRule.md +++ b/docset/winserver2022-ps/failoverclusters/Add-ClusterGroupToAffinityRule.md @@ -196,3 +196,5 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS + +[Remove-ClusterGroupFromAffinityRule](Remove-ClusterGroupFromAffinityRule.md) diff --git a/docset/winserver2022-ps/failoverclusters/Remove-ClusterGroupFromAffinityRule.md b/docset/winserver2022-ps/failoverclusters/Remove-ClusterGroupFromAffinityRule.md index 38f015b77e..62dd5635b4 100644 --- a/docset/winserver2022-ps/failoverclusters/Remove-ClusterGroupFromAffinityRule.md +++ b/docset/winserver2022-ps/failoverclusters/Remove-ClusterGroupFromAffinityRule.md @@ -196,3 +196,5 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS + +[Add-ClusterGroupToAffinityRule](Add-ClusterGroupToAffinityRule.md) From 8a09997ede7eeb85db8388365d72e97f0a1fc67b Mon Sep 17 00:00:00 2001 From: Robin Harwood <19212983+robinharwood@users.noreply.github.com> Date: Tue, 12 Sep 2023 14:02:12 +0100 Subject: [PATCH 631/650] Apply suggestions from code review Co-authored-by: Mikey Lombardi (He/Him) --- .../failoverclusters/Add-ClusterGroupToAffinityRule.md | 8 ++++---- .../Remove-ClusterGroupFromAffinityRule.md | 10 +++++----- 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/docset/winserver2022-ps/failoverclusters/Add-ClusterGroupToAffinityRule.md b/docset/winserver2022-ps/failoverclusters/Add-ClusterGroupToAffinityRule.md index 1a986a194e..1b7020d1d5 100644 --- a/docset/winserver2022-ps/failoverclusters/Add-ClusterGroupToAffinityRule.md +++ b/docset/winserver2022-ps/failoverclusters/Add-ClusterGroupToAffinityRule.md @@ -41,7 +41,7 @@ Adds a cluster group to a named affinity rule. Add-ClusterGroupToAffinityRule -Groups MyGroup -Name MyRule -Cluster MyCluster ``` -This example adds the group named MyGroup to the affinity rule named MyRule on the cluster named. +This example adds the group named `MyGroup` to the affinity rule named `MyRule` on the cluster named `MyCluster`. ## PARAMETERS @@ -55,7 +55,7 @@ prompt. You can continue to work in the session while the job completes. To mana `*-Job` cmdlets. To get the job results, use the [Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. -For more information about Windows PowerShell background jobs, see +For more information about PowerShell background jobs, see [about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). ```yaml @@ -123,7 +123,7 @@ Accept wildcard characters: False ### -Name -The Affinity rule in question that groups will be added to. +The Affinity rule to add the groups to. ```yaml Type: String[] @@ -157,7 +157,7 @@ Accept wildcard characters: False ### -ThrottleLimit Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If -this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an +this parameter is omitted or a value of `0` is entered, then PowerShell calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer. diff --git a/docset/winserver2022-ps/failoverclusters/Remove-ClusterGroupFromAffinityRule.md b/docset/winserver2022-ps/failoverclusters/Remove-ClusterGroupFromAffinityRule.md index 62dd5635b4..affe0626b8 100644 --- a/docset/winserver2022-ps/failoverclusters/Remove-ClusterGroupFromAffinityRule.md +++ b/docset/winserver2022-ps/failoverclusters/Remove-ClusterGroupFromAffinityRule.md @@ -41,7 +41,7 @@ Removes a cluster group from an affinity rule. This doesn't remove the rule itse Remove-ClusterGroupFromAffinityRule -Name MuRyle -Groups MyGroup -Cluster MyCluster ``` -This example removes the cluster group MyGroup from the affinity rule named MyRule. +This example removes the cluster group `MyGroup` from the affinity rule named `MyRule`. ## PARAMETERS @@ -55,7 +55,7 @@ prompt. You can continue to work in the session while the job completes. To mana `*-Job` cmdlets. To get the job results, use the [Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. -For more information about Windows PowerShell background jobs, see +For more information about PowerShell background jobs, see [about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). ```yaml @@ -91,7 +91,7 @@ Accept wildcard characters: False ### -Groups -The groups to be removed from the affinity rule. +The groups to remove from the affinity rule. ```yaml Type: String[] @@ -123,7 +123,7 @@ Accept wildcard characters: False ### -Name -The name of the affinity rule to remove groups from +The name of the affinity rule to remove groups from. ```yaml Type: String[] @@ -157,7 +157,7 @@ Accept wildcard characters: False ### -ThrottleLimit Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If -this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an +this parameter is omitted or a value of `0` is entered, then PowerShell calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer. From d2e6d7efbe089801c8e662baaf5623f606676c03 Mon Sep 17 00:00:00 2001 From: robinharwood <19212983+robinharwood@users.noreply.github.com> Date: Tue, 12 Sep 2023 14:11:28 +0100 Subject: [PATCH 632/650] Updates post feedback --- .../failoverclusters/Add-ClusterGroupToAffinityRule.md | 7 ++++--- .../Remove-ClusterGroupFromAffinityRule.md | 4 ++-- 2 files changed, 6 insertions(+), 5 deletions(-) diff --git a/docset/winserver2022-ps/failoverclusters/Add-ClusterGroupToAffinityRule.md b/docset/winserver2022-ps/failoverclusters/Add-ClusterGroupToAffinityRule.md index 1b7020d1d5..5784cdfe30 100644 --- a/docset/winserver2022-ps/failoverclusters/Add-ClusterGroupToAffinityRule.md +++ b/docset/winserver2022-ps/failoverclusters/Add-ClusterGroupToAffinityRule.md @@ -35,13 +35,14 @@ Adds a cluster group to a named affinity rule. ## EXAMPLES -### Example 1 +### Example 1 - Add a group to an affinity rule ```powershell Add-ClusterGroupToAffinityRule -Groups MyGroup -Name MyRule -Cluster MyCluster ``` -This example adds the group named `MyGroup` to the affinity rule named `MyRule` on the cluster named `MyCluster`. +This example adds the group named `MyGroup` to the affinity rule named `MyRule` on the cluster named +`MyCluster`. ## PARAMETERS @@ -107,7 +108,7 @@ Accept wildcard characters: False ### -InputObject -Specifies the input object that is used in a pipeline command. +Specifies the affinity rule object that is used in a pipeline command. ```yaml Type: CimInstance[] diff --git a/docset/winserver2022-ps/failoverclusters/Remove-ClusterGroupFromAffinityRule.md b/docset/winserver2022-ps/failoverclusters/Remove-ClusterGroupFromAffinityRule.md index affe0626b8..3d39cbc9e0 100644 --- a/docset/winserver2022-ps/failoverclusters/Remove-ClusterGroupFromAffinityRule.md +++ b/docset/winserver2022-ps/failoverclusters/Remove-ClusterGroupFromAffinityRule.md @@ -35,7 +35,7 @@ Removes a cluster group from an affinity rule. This doesn't remove the rule itse ## EXAMPLES -### Example 1 +### Example 1 - Remove a group from an affinity rule ```powershell Remove-ClusterGroupFromAffinityRule -Name MuRyle -Groups MyGroup -Cluster MyCluster @@ -107,7 +107,7 @@ Accept wildcard characters: False ### -InputObject -Specifies the input object that is used in a pipeline command. +Specifies the affinity rule object that is used in a pipeline command. ```yaml Type: CimInstance[] From 181acf26c653d70c54113ae02a8eae656305062a Mon Sep 17 00:00:00 2001 From: robinharwood <19212983+robinharwood@users.noreply.github.com> Date: Wed, 20 Sep 2023 14:45:00 +0100 Subject: [PATCH 633/650] Updated cluster group affinity rule commands after feedback --- .../Add-ClusterGroupToAffinityRule.md | 28 +++++++++++++++++-- .../Remove-ClusterGroupFromAffinityRule.md | 26 +++++++++++++++-- 2 files changed, 50 insertions(+), 4 deletions(-) diff --git a/docset/winserver2022-ps/failoverclusters/Add-ClusterGroupToAffinityRule.md b/docset/winserver2022-ps/failoverclusters/Add-ClusterGroupToAffinityRule.md index 5784cdfe30..ace0a336e4 100644 --- a/docset/winserver2022-ps/failoverclusters/Add-ClusterGroupToAffinityRule.md +++ b/docset/winserver2022-ps/failoverclusters/Add-ClusterGroupToAffinityRule.md @@ -2,7 +2,7 @@ description: Add-ClusterGroupToAffinityRule external help file: ClusterAffinityRule.cdxml-help.xml Module Name: FailoverClusters -ms.date: 07/27/2023 +ms.date: 09/20/2023 online version: https://learn.microsoft.com/powershell/module/failoverclusters/add-clustergrouptoaffinityrule?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Add-ClusterGroupToAffinityRule @@ -44,6 +44,17 @@ Add-ClusterGroupToAffinityRule -Groups MyGroup -Name MyRule -Cluster MyCluster This example adds the group named `MyGroup` to the affinity rule named `MyRule` on the cluster named `MyCluster`. +### Example 2 - Add a group to an affinity rule using pipeline + +```powershell +Get-ClusterAffinityRule -name Rule1 | + Add-ClusterGroupToAffinityRule -Groups MyGroup +``` + +The command gets the affinity rule `Rule1` object and passes it to the +`Add-ClusterGroupToAffinityRule` command. The command adds the cluster group `MyGroup` to the +affinity rule. + ## PARAMETERS ### -AsJob @@ -140,7 +151,7 @@ Accept wildcard characters: False ### -PassThru -Returns an object representing the item with which you are working. By default, this cmdlet doesn't +Returns the original affinity rule object passed to the command. By default, this cmdlet doesn't generate any output. ```yaml @@ -186,14 +197,27 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ### System.String[] +When a string is piped to this cmdlet, the value is used as the name of the affinity rule to add the +cluster shared volume to. + ### Microsoft.Management.Infrastructure.CimInstance[] +This cmdlet accepts CIM instance objects representing an affinity rule like those returned by the +[Get-ClusterAffinityRule](Get-ClusterAffinityRule.md) cmdlet. + ## OUTPUTS +### None + +By default, the cmdlet doesn't return any output. + ### Microsoft.Management.Infrastructure.CimInstance ### Microsoft.Management.Infrastructure.CimInstance#root/MSCLUSTER/MSCluster_AffinityRule +When the **PassThru** parameter is specified, the cmdlet returns an object representing an affinity +rule as a CIM instance within the `root/MSCLUSTER/MSCluster_AffinityRule` path. + ## NOTES ## RELATED LINKS diff --git a/docset/winserver2022-ps/failoverclusters/Remove-ClusterGroupFromAffinityRule.md b/docset/winserver2022-ps/failoverclusters/Remove-ClusterGroupFromAffinityRule.md index 3d39cbc9e0..0b115171d3 100644 --- a/docset/winserver2022-ps/failoverclusters/Remove-ClusterGroupFromAffinityRule.md +++ b/docset/winserver2022-ps/failoverclusters/Remove-ClusterGroupFromAffinityRule.md @@ -2,7 +2,7 @@ description: Remove-ClusterGroupFromAffinityRule external help file: ClusterAffinityRule.cdxml-help.xml Module Name: FailoverClusters -ms.date: 07/27/2023 +ms.date: 09/20/2023 online version: https://learn.microsoft.com/powershell/module/failoverclusters/remove-clustergroupfromaffinityrule?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Remove-ClusterGroupFromAffinityRule @@ -43,6 +43,17 @@ Remove-ClusterGroupFromAffinityRule -Name MuRyle -Groups MyGroup -Cluster MyClus This example removes the cluster group `MyGroup` from the affinity rule named `MyRule`. +### Example 2 - Remove a group to an affinity rule using pipeline + +```powershell +Get-ClusterAffinityRule -name Rule1 | + Remove-ClusterGroupFromAffinityRule -Groups MyGroup +``` + +The command gets the affinity rule `Rule1` object and passes it to the +`Remove-ClusterGroupFromAffinityRule` command. The command removes the cluster group `MyGroup` from +the affinity rule. + ## PARAMETERS ### -AsJob @@ -139,7 +150,7 @@ Accept wildcard characters: False ### -PassThru -Returns an object representing the item with which you are working. By default, this cmdlet doesn't +Returns the original affinity rule object passed to the command. By default, this cmdlet doesn't generate any output. ```yaml @@ -185,14 +196,25 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ### System.String[] +When a string is piped to this cmdlet, the value is used as the name of the affinity rule to remove +the cluster shared volume from. + ### Microsoft.Management.Infrastructure.CimInstance[] +Specifies the affinity rule object to remove, as returned by the +[Get-ClusterAffinityRule](Get-ClusterAffinityRule.md) cmdlet. + ## OUTPUTS +By default, the cmdlet doesn't return any output. + ### Microsoft.Management.Infrastructure.CimInstance ### Microsoft.Management.Infrastructure.CimInstance#root/MSCLUSTER/MSCluster_AffinityRule +When the **PassThru** parameter is specified, the cmdlet returns an object representing an affinity +rule as a CIM instance within the `root/MSCLUSTER/MSCluster_AffinityRule` path. + ## NOTES ## RELATED LINKS From 8fe24f3510cde80e8c0a4c396bce36512ef89f46 Mon Sep 17 00:00:00 2001 From: robinharwood <19212983+robinharwood@users.noreply.github.com> Date: Wed, 20 Sep 2023 14:56:04 +0100 Subject: [PATCH 634/650] Fixing build validation issue --- .../failoverclusters/Remove-ClusterGroupFromAffinityRule.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docset/winserver2022-ps/failoverclusters/Remove-ClusterGroupFromAffinityRule.md b/docset/winserver2022-ps/failoverclusters/Remove-ClusterGroupFromAffinityRule.md index 0b115171d3..2aeb0d3a55 100644 --- a/docset/winserver2022-ps/failoverclusters/Remove-ClusterGroupFromAffinityRule.md +++ b/docset/winserver2022-ps/failoverclusters/Remove-ClusterGroupFromAffinityRule.md @@ -206,6 +206,8 @@ Specifies the affinity rule object to remove, as returned by the ## OUTPUTS +### None + By default, the cmdlet doesn't return any output. ### Microsoft.Management.Infrastructure.CimInstance From d07e7fd6980bb11e9c20b414508e6d45c4571d84 Mon Sep 17 00:00:00 2001 From: robinharwood <19212983+robinharwood@users.noreply.github.com> Date: Tue, 11 Jul 2023 13:08:28 +0100 Subject: [PATCH 635/650] Introducing new Add-ClusterSharedVolumeToAffinityRule command --- .../Add-ClusterSharedVolumeToAffinityRule.md | 183 ++++++++++++++++++ 1 file changed, 183 insertions(+) create mode 100644 docset/winserver2022-ps/failoverclusters/Add-ClusterSharedVolumeToAffinityRule.md diff --git a/docset/winserver2022-ps/failoverclusters/Add-ClusterSharedVolumeToAffinityRule.md b/docset/winserver2022-ps/failoverclusters/Add-ClusterSharedVolumeToAffinityRule.md new file mode 100644 index 0000000000..45c2cb6b48 --- /dev/null +++ b/docset/winserver2022-ps/failoverclusters/Add-ClusterSharedVolumeToAffinityRule.md @@ -0,0 +1,183 @@ +--- +description: Add-ClusterSharedVolumeToAffinityRule +external help file: ClusterAffinityRule.cdxml-help.xml +Module Name: FailoverClusters +ms.date: 07/26/2022 +online version: https://docs.microsoft.com/powershell/module/failoverclusters/add-clustersharedvolumetoaffinityrule?view=windowsserver2022-ps&wt.mc_id=ps-gethelp +schema: 2.0.0 +title: Add-ClusterSharedVolumeToAffinityRule +--- + +# Add-ClusterSharedVolumeToAffinityRule + +## SYNOPSIS +Adds a Cluster Shared Volume (CSV) to an existing Affinity Rule. + +## SYNTAX + +### Query (cdxml) (Default) +``` +Add-ClusterSharedVolumeToAffinityRule [[-Name] ] [-ClusterSharedVolumes] + [-CimSession ] [-ThrottleLimit ] [-AsJob] [-PassThru] [] +``` + +### InputObject (cdxml) +``` +Add-ClusterSharedVolumeToAffinityRule -InputObject [-ClusterSharedVolumes] + [-CimSession ] [-ThrottleLimit ] [-AsJob] [-PassThru] [] +``` + +## DESCRIPTION +This cmdlet gives the ability to keep VMs with the cluster shared volume(CSV) that contains its VHD. + +## EXAMPLES + +### Example 1 +```powershell +Add-ClusterSharedVolumeToAffinityRule -ClusterSharedVolumes MyVolume -Name MyRule -Cluster MyCluster +``` +## PARAMETERS + +### -AsJob +Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to +complete. + +The cmdlet immediately returns an object that represents the job and then displays the command +prompt. You can continue to work in the session while the job completes. To manage the job, use the +`*-Job` cmdlets. To get the job results, use the +[Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. + +For more information about Windows PowerShell background jobs, see +[about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CimSession +Runs the cmdlet in a remote session or on a remote computer. 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. The default is the +current session on the local computer. + +```yaml +Type: CimSession[] +Parameter Sets: (All) +Aliases: Session + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterSharedVolumes +The cluster shared volumes to be added to the affinity rule. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Specifies the input object that is used in a pipeline command. + +```yaml +Type: CimInstance[] +Parameter Sets: InputObject (cdxml) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The affinity rule in question to add cluster shared volumes to. + +```yaml +Type: String[] +Parameter Sets: Query (cdxml) +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -PassThru +Returns an object representing the item with which you are working. +By default, this cmdlet does not generate any output. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ThrottleLimit +Specifies the maximum number of concurrent operations that can be established to run the cmdlet. 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. The throttle limit applies only to the current cmdlet, not to the session or to the +computer. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, +-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, +-WarningAction, and -WarningVariable. For more information, see +[about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String[] + +### Microsoft.Management.Infrastructure.CimInstance[] + +## OUTPUTS + +### Microsoft.Management.Infrastructure.CimInstance + +### Microsoft.Management.Infrastructure.CimInstance#root/MSCLUSTER/MSCluster_AffinityRule + +## NOTES + +## RELATED LINKS From 54b61d71eec0cd71c6ad3df77fe7fe597eef9a47 Mon Sep 17 00:00:00 2001 From: robinharwood <19212983+robinharwood@users.noreply.github.com> Date: Thu, 27 Jul 2023 14:58:57 +0100 Subject: [PATCH 636/650] Updating text formatting and adding command to the module file --- .../Add-ClusterSharedVolumeToAffinityRule.md | 26 ++++++++++++++----- .../failoverclusters/FailoverClusters.md | 3 +++ 2 files changed, 23 insertions(+), 6 deletions(-) diff --git a/docset/winserver2022-ps/failoverclusters/Add-ClusterSharedVolumeToAffinityRule.md b/docset/winserver2022-ps/failoverclusters/Add-ClusterSharedVolumeToAffinityRule.md index 45c2cb6b48..2c21a50b35 100644 --- a/docset/winserver2022-ps/failoverclusters/Add-ClusterSharedVolumeToAffinityRule.md +++ b/docset/winserver2022-ps/failoverclusters/Add-ClusterSharedVolumeToAffinityRule.md @@ -2,8 +2,8 @@ description: Add-ClusterSharedVolumeToAffinityRule external help file: ClusterAffinityRule.cdxml-help.xml Module Name: FailoverClusters -ms.date: 07/26/2022 -online version: https://docs.microsoft.com/powershell/module/failoverclusters/add-clustersharedvolumetoaffinityrule?view=windowsserver2022-ps&wt.mc_id=ps-gethelp +ms.date: 07/27/2023 +online version: https://learn.microsoft.com/powershell/module/failoverclusters/add-clustersharedvolumetoaffinityrule?view=windowsserver2022-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: Add-ClusterSharedVolumeToAffinityRule --- @@ -16,29 +16,36 @@ Adds a Cluster Shared Volume (CSV) to an existing Affinity Rule. ## SYNTAX ### Query (cdxml) (Default) + ``` Add-ClusterSharedVolumeToAffinityRule [[-Name] ] [-ClusterSharedVolumes] [-CimSession ] [-ThrottleLimit ] [-AsJob] [-PassThru] [] ``` ### InputObject (cdxml) + ``` -Add-ClusterSharedVolumeToAffinityRule -InputObject [-ClusterSharedVolumes] - [-CimSession ] [-ThrottleLimit ] [-AsJob] [-PassThru] [] +Add-ClusterSharedVolumeToAffinityRule -InputObject + [-ClusterSharedVolumes] [-CimSession ] [-ThrottleLimit ] [-AsJob] + [-PassThru] + [] ``` ## DESCRIPTION + This cmdlet gives the ability to keep VMs with the cluster shared volume(CSV) that contains its VHD. ## EXAMPLES ### Example 1 + ```powershell Add-ClusterSharedVolumeToAffinityRule -ClusterSharedVolumes MyVolume -Name MyRule -Cluster MyCluster ``` ## PARAMETERS ### -AsJob + Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. @@ -63,6 +70,7 @@ Accept wildcard characters: False ``` ### -CimSession + Runs the cmdlet in a remote session or on a remote computer. 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. The default is the @@ -81,6 +89,7 @@ Accept wildcard characters: False ``` ### -ClusterSharedVolumes + The cluster shared volumes to be added to the affinity rule. ```yaml @@ -96,6 +105,7 @@ Accept wildcard characters: False ``` ### -InputObject + Specifies the input object that is used in a pipeline command. ```yaml @@ -111,6 +121,7 @@ Accept wildcard characters: False ``` ### -Name + The affinity rule in question to add cluster shared volumes to. ```yaml @@ -126,8 +137,9 @@ Accept wildcard characters: False ``` ### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. + +Returns an object representing the item with which you are working. By default, this cmdlet doesn't +generate any output. ```yaml Type: SwitchParameter @@ -142,6 +154,7 @@ Accept wildcard characters: False ``` ### -ThrottleLimit + Specifies the maximum number of concurrent operations that can be established to run the cmdlet. 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 @@ -161,6 +174,7 @@ Accept wildcard characters: False ``` ### CommonParameters + This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see diff --git a/docset/winserver2022-ps/failoverclusters/FailoverClusters.md b/docset/winserver2022-ps/failoverclusters/FailoverClusters.md index 2ff4b52940..8da4a61570 100644 --- a/docset/winserver2022-ps/failoverclusters/FailoverClusters.md +++ b/docset/winserver2022-ps/failoverclusters/FailoverClusters.md @@ -75,6 +75,9 @@ Creates a clustered file server for scale-out application data. ### [Add-ClusterSharedVolume](./Add-ClusterSharedVolume.md) Makes a volume available in Cluster Shared Volumes in a failover cluster. +### [Add-ClusterSharedVolumeToAffinityRule](./Add-ClusterSharedVolumeToAffinityRule.md) +Adds a Cluster Shared Volume (CSV) to an existing Affinity Rule. + ### [Add-ClusterVirtualMachineRole](./Add-ClusterVirtualMachineRole.md) Creates a clustered virtual machine, that is, a virtual machine that can be failed over if necessary to a different server in the failover cluster. From dd227dc1ec7a54b3ee0e6b2905a4ea96da48ac21 Mon Sep 17 00:00:00 2001 From: robinharwood <19212983+robinharwood@users.noreply.github.com> Date: Mon, 11 Sep 2023 09:41:40 +0100 Subject: [PATCH 637/650] Updating Add-ClusterSharedVolumeToAffinityRule description --- .../Add-ClusterSharedVolumeToAffinityRule.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docset/winserver2022-ps/failoverclusters/Add-ClusterSharedVolumeToAffinityRule.md b/docset/winserver2022-ps/failoverclusters/Add-ClusterSharedVolumeToAffinityRule.md index 2c21a50b35..37599680e9 100644 --- a/docset/winserver2022-ps/failoverclusters/Add-ClusterSharedVolumeToAffinityRule.md +++ b/docset/winserver2022-ps/failoverclusters/Add-ClusterSharedVolumeToAffinityRule.md @@ -11,7 +11,7 @@ title: Add-ClusterSharedVolumeToAffinityRule # Add-ClusterSharedVolumeToAffinityRule ## SYNOPSIS -Adds a Cluster Shared Volume (CSV) to an existing Affinity Rule. +Adds a Cluster Shared Volume (CSV) to an existing affinity rule. ## SYNTAX @@ -33,7 +33,8 @@ Add-ClusterSharedVolumeToAffinityRule -InputObject ## DESCRIPTION -This cmdlet gives the ability to keep VMs with the cluster shared volume(CSV) that contains its VHD. +This cmdlet allows you to add cluster shared volumes (CSVs) to an existing affinity rule, using +either the CSV name or object. ## EXAMPLES From d0602d40414013668a0656bf96393166cf4065ce Mon Sep 17 00:00:00 2001 From: robinharwood <19212983+robinharwood@users.noreply.github.com> Date: Fri, 28 Jul 2023 13:48:02 +0100 Subject: [PATCH 638/650] Added new command to the FailoverCluster module --- ...ove-ClusterSharedVolumeFromAffinityRule.md | 167 ++++++++++++++++++ 1 file changed, 167 insertions(+) create mode 100644 docset/winserver2022-ps/failoverclusters/Remove-ClusterSharedVolumeFromAffinityRule.md diff --git a/docset/winserver2022-ps/failoverclusters/Remove-ClusterSharedVolumeFromAffinityRule.md b/docset/winserver2022-ps/failoverclusters/Remove-ClusterSharedVolumeFromAffinityRule.md new file mode 100644 index 0000000000..65ab8526af --- /dev/null +++ b/docset/winserver2022-ps/failoverclusters/Remove-ClusterSharedVolumeFromAffinityRule.md @@ -0,0 +1,167 @@ +--- +description: Remove-ClusterSharedVolumeFromAffinityRule +external help file: ClusterAffinityRule.cdxml-help.xml +Module Name: FailoverClusters +ms.date: 07/28/2023 +online version: https://learn.microsoft.com/powershell/module/failoverclusters/remove-clustersharedvolumefromaffinityrule?view=windowsserver2022-ps&wt.mc_id=ps-gethelp +schema: 2.0.0 +title: Remove-ClusterSharedVolumeFromAffinityRule +--- + +# Remove-ClusterSharedVolumeFromAffinityRule + +## SYNOPSIS +Remove a cluster shared volume from an affinity rule. + +## SYNTAX + +``` +Remove-ClusterSharedVolumeFromAffinityRule [[-Name] ] [-ClusterSharedVolumes] + [-CimSession ] [-ThrottleLimit ] [-AsJob] [-PassThru] [] +``` + +## DESCRIPTION + +## EXAMPLES + +```powershell +Remove-ClusterSharedVolumeFromAffinityRule -ClusterSharedVolumes Volume -Name Rule -Cluster Cluster +``` + +This command removes the cluster shared volume _Volume_ from the affinity rule _Rule_ for the +cluster _Cluster_. + +## PARAMETERS + +mplete. + +The cmdlet immediately returns an object that represents the job and then displays the command +prompt. You can continue to work in the session while the job completes. To manage the job, use the +`*-Job` cmdlets. To get the job results, use the +[Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. + +For more information about Windows PowerShell background jobs, see +[about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +uns the cmdlet in a remote session or on a remote computer. Enter a computer name or a session +r [Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet. The default is the +current session on the local computer. + +```yaml +Type: CimSession[] +Parameter Sets: (All) +Aliases: Session + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +he clustered shared volumes that should be added to the given affinity rule + +ype: String[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +pecifies the input object that is used in a pipeline command. + +```yaml +Type: CimInstance[] +Parameter Sets: InputObject (cdxml) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +he name of the affinity rule to add groups to. + +```yaml +Type: String[] +Parameter Sets: Query (cdxml) +Aliases: Set + +Required: False +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +Returns an object representing the item with which you are working. By default, this cmdlet doesn't +generate any output. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +pecifies the maximum number of concurrent operations that can be established to run the cmdlet. 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. The throttle limit applies only to the current cmdlet, not to the session or to the +computer. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +his cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, +-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, +-WarningAction, and -WarningVariable. For more information, see +[about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String[] + +### Microsoft.Management.Infrastructure.CimInstance[] + +## OUTPUTS + +### Microsoft.Management.Infrastructure.CimInstance + +### Microsoft.Management.Infrastructure.CimInstance#root/MSCLUSTER/MSCluster_AffinityRule + +## NOTES + +## RELATED LINKS From 0ff18c9bedb64f76f7e16cfa62340b99b4f2be74 Mon Sep 17 00:00:00 2001 From: robinharwood <19212983+robinharwood@users.noreply.github.com> Date: Fri, 28 Jul 2023 13:54:54 +0100 Subject: [PATCH 639/650] Added new command to the FailoverCluster module --- ...ove-ClusterSharedVolumeFromAffinityRule.md | 60 ++++++++++++++----- 1 file changed, 46 insertions(+), 14 deletions(-) diff --git a/docset/winserver2022-ps/failoverclusters/Remove-ClusterSharedVolumeFromAffinityRule.md b/docset/winserver2022-ps/failoverclusters/Remove-ClusterSharedVolumeFromAffinityRule.md index 65ab8526af..b169a72595 100644 --- a/docset/winserver2022-ps/failoverclusters/Remove-ClusterSharedVolumeFromAffinityRule.md +++ b/docset/winserver2022-ps/failoverclusters/Remove-ClusterSharedVolumeFromAffinityRule.md @@ -15,25 +15,41 @@ Remove a cluster shared volume from an affinity rule. ## SYNTAX +### Query (cdxml) (Default) + ``` Remove-ClusterSharedVolumeFromAffinityRule [[-Name] ] [-ClusterSharedVolumes] [-CimSession ] [-ThrottleLimit ] [-AsJob] [-PassThru] [] ``` +### InputObject (cdxml) + +``` +Remove-ClusterSharedVolumeFromAffinityRule -InputObject [-ClusterSharedVolumes] + [-CimSession ] [-ThrottleLimit ] [-AsJob] [-PassThru] [] +``` + ## DESCRIPTION +Remove a cluster shared volume from an affinity rule. + ## EXAMPLES +### Example 1 + ```powershell -Remove-ClusterSharedVolumeFromAffinityRule -ClusterSharedVolumes Volume -Name Rule -Cluster Cluster +Remove-ClusterSharedVolumeFromAffinityRule -ClusterSharedVolumes MyVolume -Name MyRule -Cluster MyCluster ``` -This command removes the cluster shared volume _Volume_ from the affinity rule _Rule_ for the -cluster _Cluster_. +This command removes the cluster shared volume _MyVolume_ from the affinity rule _MyRule_ for the +cluster _MyCluster_. ## PARAMETERS -mplete. +### -AsJob + +Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to +complete. The cmdlet immediately returns an object that represents the job and then displays the command prompt. You can continue to work in the session while the job completes. To manage the job, use the @@ -55,8 +71,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -uns the cmdlet in a remote session or on a remote computer. Enter a computer name or a session -r [Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet. The default is the +### -CimSession + +Runs the cmdlet in a remote session or on a remote computer. 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. The default is the current session on the local computer. ```yaml @@ -71,9 +90,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -he clustered shared volumes that should be added to the given affinity rule +### -ClusterSharedVolumes + +The clustered shared volumes that should be added to the given affinity rule -ype: String[] +```yaml +Type: String[] Parameter Sets: (All) Aliases: @@ -84,7 +106,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -pecifies the input object that is used in a pipeline command. +### -InputObject + +Specifies the input object that is used in a pipeline command. ```yaml Type: CimInstance[] @@ -98,7 +122,9 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -he name of the affinity rule to add groups to. +### -Name + +The name of the affinity rule to add groups to. ```yaml Type: String[] @@ -112,8 +138,10 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -Returns an object representing the item with which you are working. By default, this cmdlet doesn't -generate any output. +### -PassThru + +Returns an object representing the item with which you are working. +By default, this cmdlet does not generate any output. ```yaml Type: SwitchParameter @@ -127,7 +155,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -pecifies the maximum number of concurrent operations that can be established to run the cmdlet. If +### -ThrottleLimit + +Specifies the maximum number of concurrent operations that can be established to run the cmdlet. 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. The throttle limit applies only to the current cmdlet, not to the session or to the @@ -145,7 +175,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` -his cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). From 1e496ad49ffea6ebbffe7b7810f91f3660105a12 Mon Sep 17 00:00:00 2001 From: robinharwood <19212983+robinharwood@users.noreply.github.com> Date: Mon, 11 Sep 2023 09:45:04 +0100 Subject: [PATCH 640/650] Fixing FailoverCluster.md link issue --- docset/winserver2022-ps/failoverclusters/FailoverClusters.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docset/winserver2022-ps/failoverclusters/FailoverClusters.md b/docset/winserver2022-ps/failoverclusters/FailoverClusters.md index 8da4a61570..c706ae8ab0 100644 --- a/docset/winserver2022-ps/failoverclusters/FailoverClusters.md +++ b/docset/winserver2022-ps/failoverclusters/FailoverClusters.md @@ -259,6 +259,9 @@ Removes a resource type from a failover cluster. Removes a volume from the Cluster Shared Volumes in a failover cluster, and places it in Available Storage in the cluster. +### [Remove-ClusterSharedVolumeFromAffinityRule](./Remove-ClusterSharedVolumeFromAffinityRule.md) +Remove a cluster shared volume from an affinity rule. + ### [Remove-ClusterVMMonitoredItem](./Remove-ClusterVMMonitoredItem.md) Removes monitoring of a service or event that is currently being monitored on a virtual machine. From e34c9e67839b9e8c8b785c5cd69911dcb18367fe Mon Sep 17 00:00:00 2001 From: robinharwood <19212983+robinharwood@users.noreply.github.com> Date: Mon, 11 Sep 2023 10:03:08 +0100 Subject: [PATCH 641/650] Added related links and consolidating PRs --- .../failoverclusters/Add-ClusterSharedVolumeToAffinityRule.md | 2 ++ .../Remove-ClusterSharedVolumeFromAffinityRule.md | 2 ++ 2 files changed, 4 insertions(+) diff --git a/docset/winserver2022-ps/failoverclusters/Add-ClusterSharedVolumeToAffinityRule.md b/docset/winserver2022-ps/failoverclusters/Add-ClusterSharedVolumeToAffinityRule.md index 37599680e9..a927446e43 100644 --- a/docset/winserver2022-ps/failoverclusters/Add-ClusterSharedVolumeToAffinityRule.md +++ b/docset/winserver2022-ps/failoverclusters/Add-ClusterSharedVolumeToAffinityRule.md @@ -196,3 +196,5 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS + +[Remove-ClusterSharedVolumeFromAffinityRule](Remove-ClusterSharedVolumeFromAffinityRule.md) diff --git a/docset/winserver2022-ps/failoverclusters/Remove-ClusterSharedVolumeFromAffinityRule.md b/docset/winserver2022-ps/failoverclusters/Remove-ClusterSharedVolumeFromAffinityRule.md index b169a72595..e0bf71e330 100644 --- a/docset/winserver2022-ps/failoverclusters/Remove-ClusterSharedVolumeFromAffinityRule.md +++ b/docset/winserver2022-ps/failoverclusters/Remove-ClusterSharedVolumeFromAffinityRule.md @@ -197,3 +197,5 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS + +[Add-ClusterSharedVolumeToAffinityRule](Add-ClusterSharedVolumeToAffinityRule.md) From 2efe1c95117710cc58bb816b608dd42a3d91fc9b Mon Sep 17 00:00:00 2001 From: robinharwood <19212983+robinharwood@users.noreply.github.com> Date: Mon, 11 Sep 2023 10:07:09 +0100 Subject: [PATCH 642/650] Line formatting updates --- .../Add-ClusterSharedVolumeToAffinityRule.md | 7 +++---- ...move-ClusterSharedVolumeFromAffinityRule.md | 18 +++++++++--------- 2 files changed, 12 insertions(+), 13 deletions(-) diff --git a/docset/winserver2022-ps/failoverclusters/Add-ClusterSharedVolumeToAffinityRule.md b/docset/winserver2022-ps/failoverclusters/Add-ClusterSharedVolumeToAffinityRule.md index a927446e43..389b1d3443 100644 --- a/docset/winserver2022-ps/failoverclusters/Add-ClusterSharedVolumeToAffinityRule.md +++ b/docset/winserver2022-ps/failoverclusters/Add-ClusterSharedVolumeToAffinityRule.md @@ -157,10 +157,9 @@ Accept wildcard characters: False ### -ThrottleLimit Specifies the maximum number of concurrent operations that can be established to run the cmdlet. 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. The throttle limit applies only to the current cmdlet, not to the session or to the -computer. +this parameter is omitted or a value of `0` is entered, then PowerShell calculates an optimum +throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. +The throttle limit applies only to the current cmdlet, not to the session or to the computer. ```yaml Type: Int32 diff --git a/docset/winserver2022-ps/failoverclusters/Remove-ClusterSharedVolumeFromAffinityRule.md b/docset/winserver2022-ps/failoverclusters/Remove-ClusterSharedVolumeFromAffinityRule.md index e0bf71e330..8a5d4cad8c 100644 --- a/docset/winserver2022-ps/failoverclusters/Remove-ClusterSharedVolumeFromAffinityRule.md +++ b/docset/winserver2022-ps/failoverclusters/Remove-ClusterSharedVolumeFromAffinityRule.md @@ -25,8 +25,9 @@ Remove-ClusterSharedVolumeFromAffinityRule [[-Name] ] [-ClusterSharedV ### InputObject (cdxml) ``` -Remove-ClusterSharedVolumeFromAffinityRule -InputObject [-ClusterSharedVolumes] - [-CimSession ] [-ThrottleLimit ] [-AsJob] [-PassThru] [] +Remove-ClusterSharedVolumeFromAffinityRule -InputObject + [-ClusterSharedVolumes] [-CimSession ] [-ThrottleLimit ] [-AsJob] + [-PassThru] [] ``` ## DESCRIPTION @@ -38,11 +39,11 @@ Remove a cluster shared volume from an affinity rule. ### Example 1 ```powershell -Remove-ClusterSharedVolumeFromAffinityRule -ClusterSharedVolumes MyVolume -Name MyRule -Cluster MyCluster +Remove-ClusterSharedVolumeFromAffinityRule -ClusterSharedVolumes Volume -Name Rule -Cluster Cluster ``` -This command removes the cluster shared volume _MyVolume_ from the affinity rule _MyRule_ for the -cluster _MyCluster_. +This command removes the cluster shared volume _Volume_ from the affinity rule _Rule_ for the +cluster _Cluster_. ## PARAMETERS @@ -158,10 +159,9 @@ Accept wildcard characters: False ### -ThrottleLimit Specifies the maximum number of concurrent operations that can be established to run the cmdlet. 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. The throttle limit applies only to the current cmdlet, not to the session or to the -computer. +this parameter is omitted or a value of `0` is entered, then PowerShell calculates an optimum +throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. +The throttle limit applies only to the current cmdlet, not to the session or to the computer. ```yaml Type: Int32 From cce97e0cdfdae431e2cf276387c888de724e14f2 Mon Sep 17 00:00:00 2001 From: Robin Harwood <19212983+robinharwood@users.noreply.github.com> Date: Tue, 12 Sep 2023 12:13:32 +0100 Subject: [PATCH 643/650] Apply suggestions from code review Co-authored-by: Mikey Lombardi (He/Him) --- .../Add-ClusterSharedVolumeToAffinityRule.md | 6 +++--- .../Remove-ClusterSharedVolumeFromAffinityRule.md | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docset/winserver2022-ps/failoverclusters/Add-ClusterSharedVolumeToAffinityRule.md b/docset/winserver2022-ps/failoverclusters/Add-ClusterSharedVolumeToAffinityRule.md index 389b1d3443..61b982f751 100644 --- a/docset/winserver2022-ps/failoverclusters/Add-ClusterSharedVolumeToAffinityRule.md +++ b/docset/winserver2022-ps/failoverclusters/Add-ClusterSharedVolumeToAffinityRule.md @@ -55,7 +55,7 @@ prompt. You can continue to work in the session while the job completes. To mana `*-Job` cmdlets. To get the job results, use the [Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. -For more information about Windows PowerShell background jobs, see +For more information about PowerShell background jobs, see [about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). ```yaml @@ -91,7 +91,7 @@ Accept wildcard characters: False ### -ClusterSharedVolumes -The cluster shared volumes to be added to the affinity rule. +The cluster shared volumes to add to the affinity rule. ```yaml Type: String[] @@ -123,7 +123,7 @@ Accept wildcard characters: False ### -Name -The affinity rule in question to add cluster shared volumes to. +The affinity rule to add cluster shared volumes to. ```yaml Type: String[] diff --git a/docset/winserver2022-ps/failoverclusters/Remove-ClusterSharedVolumeFromAffinityRule.md b/docset/winserver2022-ps/failoverclusters/Remove-ClusterSharedVolumeFromAffinityRule.md index 8a5d4cad8c..6dd9b7be48 100644 --- a/docset/winserver2022-ps/failoverclusters/Remove-ClusterSharedVolumeFromAffinityRule.md +++ b/docset/winserver2022-ps/failoverclusters/Remove-ClusterSharedVolumeFromAffinityRule.md @@ -57,7 +57,7 @@ prompt. You can continue to work in the session while the job completes. To mana `*-Job` cmdlets. To get the job results, use the [Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. -For more information about Windows PowerShell background jobs, see +For more information about PowerShell background jobs, see [about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). ```yaml From aec338b7dd727456b20e1de94bc5b9edd3ca19d3 Mon Sep 17 00:00:00 2001 From: robinharwood <19212983+robinharwood@users.noreply.github.com> Date: Tue, 12 Sep 2023 12:37:05 +0100 Subject: [PATCH 644/650] Updates post feedback --- .../Add-ClusterSharedVolumeToAffinityRule.md | 10 +++++++--- .../Remove-ClusterSharedVolumeFromAffinityRule.md | 6 +++--- 2 files changed, 10 insertions(+), 6 deletions(-) diff --git a/docset/winserver2022-ps/failoverclusters/Add-ClusterSharedVolumeToAffinityRule.md b/docset/winserver2022-ps/failoverclusters/Add-ClusterSharedVolumeToAffinityRule.md index 61b982f751..5a60e431a3 100644 --- a/docset/winserver2022-ps/failoverclusters/Add-ClusterSharedVolumeToAffinityRule.md +++ b/docset/winserver2022-ps/failoverclusters/Add-ClusterSharedVolumeToAffinityRule.md @@ -38,11 +38,15 @@ either the CSV name or object. ## EXAMPLES -### Example 1 +### Example 1 - Add a CSV to an affinity rule ```powershell Add-ClusterSharedVolumeToAffinityRule -ClusterSharedVolumes MyVolume -Name MyRule -Cluster MyCluster ``` + +This command adds the cluster shared volume _MyVolume_ to the affinity rule _MyRule_ for the cluster +_MyCluster_. + ## PARAMETERS ### -AsJob @@ -107,7 +111,7 @@ Accept wildcard characters: False ### -InputObject -Specifies the input object that is used in a pipeline command. +Specifies the affinity rule object that is used in a pipeline command. ```yaml Type: CimInstance[] @@ -123,7 +127,7 @@ Accept wildcard characters: False ### -Name -The affinity rule to add cluster shared volumes to. +The name of affinity rule to add cluster shared volumes to. ```yaml Type: String[] diff --git a/docset/winserver2022-ps/failoverclusters/Remove-ClusterSharedVolumeFromAffinityRule.md b/docset/winserver2022-ps/failoverclusters/Remove-ClusterSharedVolumeFromAffinityRule.md index 6dd9b7be48..3f7f673a4c 100644 --- a/docset/winserver2022-ps/failoverclusters/Remove-ClusterSharedVolumeFromAffinityRule.md +++ b/docset/winserver2022-ps/failoverclusters/Remove-ClusterSharedVolumeFromAffinityRule.md @@ -36,7 +36,7 @@ Remove a cluster shared volume from an affinity rule. ## EXAMPLES -### Example 1 +### Example 1 - Remove a CSV from an affinity rule ```powershell Remove-ClusterSharedVolumeFromAffinityRule -ClusterSharedVolumes Volume -Name Rule -Cluster Cluster @@ -93,7 +93,7 @@ Accept wildcard characters: False ### -ClusterSharedVolumes -The clustered shared volumes that should be added to the given affinity rule +The clustered shared volumes to add to the given affinity rule. ```yaml Type: String[] @@ -109,7 +109,7 @@ Accept wildcard characters: False ### -InputObject -Specifies the input object that is used in a pipeline command. +Specifies affinity rule input object that is used in a pipeline command. ```yaml Type: CimInstance[] From c2439d5ed10af6c3446af825af335574d2931fb9 Mon Sep 17 00:00:00 2001 From: robinharwood <19212983+robinharwood@users.noreply.github.com> Date: Wed, 20 Sep 2023 12:14:31 +0100 Subject: [PATCH 645/650] Updated after feedback --- .../Add-ClusterSharedVolumeToAffinityRule.md | 26 ++++++++++++++++- ...ove-ClusterSharedVolumeFromAffinityRule.md | 28 +++++++++++++++++-- 2 files changed, 51 insertions(+), 3 deletions(-) diff --git a/docset/winserver2022-ps/failoverclusters/Add-ClusterSharedVolumeToAffinityRule.md b/docset/winserver2022-ps/failoverclusters/Add-ClusterSharedVolumeToAffinityRule.md index 5a60e431a3..843ea2740c 100644 --- a/docset/winserver2022-ps/failoverclusters/Add-ClusterSharedVolumeToAffinityRule.md +++ b/docset/winserver2022-ps/failoverclusters/Add-ClusterSharedVolumeToAffinityRule.md @@ -47,6 +47,17 @@ Add-ClusterSharedVolumeToAffinityRule -ClusterSharedVolumes MyVolume -Name MyRul This command adds the cluster shared volume _MyVolume_ to the affinity rule _MyRule_ for the cluster _MyCluster_. +### Example 2 - Add a CSV to an affinity rule using pipeline + +```powershell +Get-ClusterAffinityRule -name Rule1 | + Add-ClusterSharedVolumeToAffinityRule -ClusterSharedVolumes Volume1 +``` + +The command gets the affinity rule `Rule1` object and passes it to the +`Add-ClusterSharedVolumeToAffinityRule` command. The command adds the cluster shared volume +`Volume1` to the affinity rule. + ## PARAMETERS ### -AsJob @@ -143,7 +154,7 @@ Accept wildcard characters: False ### -PassThru -Returns an object representing the item with which you are working. By default, this cmdlet doesn't +Returns the original affinity rule object passed to the command. By default, this cmdlet doesn't generate any output. ```yaml @@ -188,14 +199,27 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ### System.String[] +When a string is piped to this cmdlet, the value is used as the name of the affinity rule to add the +cluster shared volume to. + ### Microsoft.Management.Infrastructure.CimInstance[] +This cmdlet accepts CIM instance objects representing an affinity rule like those returned by the +[Get-ClusterAffinityRule](Get-ClusterAffinityRule.md) cmdlet. + ## OUTPUTS +### None + +By default, the cmdlet doesn't return any output. + ### Microsoft.Management.Infrastructure.CimInstance ### Microsoft.Management.Infrastructure.CimInstance#root/MSCLUSTER/MSCluster_AffinityRule +When the **PassThru** parameter is specified, the cmdlet returns an object representing an affinity +rule as a CIM instance within the `root/MSCLUSTER/MSCluster_AffinityRule` path. + ## NOTES ## RELATED LINKS diff --git a/docset/winserver2022-ps/failoverclusters/Remove-ClusterSharedVolumeFromAffinityRule.md b/docset/winserver2022-ps/failoverclusters/Remove-ClusterSharedVolumeFromAffinityRule.md index 3f7f673a4c..42400d9abd 100644 --- a/docset/winserver2022-ps/failoverclusters/Remove-ClusterSharedVolumeFromAffinityRule.md +++ b/docset/winserver2022-ps/failoverclusters/Remove-ClusterSharedVolumeFromAffinityRule.md @@ -45,6 +45,17 @@ Remove-ClusterSharedVolumeFromAffinityRule -ClusterSharedVolumes Volume -Name Ru This command removes the cluster shared volume _Volume_ from the affinity rule _Rule_ for the cluster _Cluster_. +### Example 2 - Remove a CSV to an affinity rule using pipeline + +```powershell +Get-ClusterAffinityRule -name Rule1 | + Remove-ClusterSharedVolumeFromAffinityRule -ClusterSharedVolumes Volume1 +``` + +The command gets the affinity rule `Rule1` object and passes it to the +`Remove-ClusterSharedVolumeFromAffinityRule` command. The command adds the cluster shared volume +`Volume1` to the affinity rule. + ## PARAMETERS ### -AsJob @@ -141,8 +152,8 @@ Accept wildcard characters: False ### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. +Returns the original affinity rule object passed to the command. By default, this cmdlet doesn't +generate any output. ```yaml Type: SwitchParameter @@ -186,14 +197,27 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ### System.String[] +When a string is piped to this cmdlet, the value is used as the name of the affinity rule to remove +the cluster shared volume from. + ### Microsoft.Management.Infrastructure.CimInstance[] +This cmdlet accepts CIM instance objects representing an affinity rule like those returned by the +[Get-ClusterAffinityRule](Get-ClusterAffinityRule.md) cmdlet. + ## OUTPUTS +### None + +By default, the cmdlet doesn't return any output. + ### Microsoft.Management.Infrastructure.CimInstance ### Microsoft.Management.Infrastructure.CimInstance#root/MSCLUSTER/MSCluster_AffinityRule +When the **PassThru** parameter is specified, the cmdlet returns an object representing an affinity +rule as a CIM instance within the `root/MSCLUSTER/MSCluster_AffinityRule` path. + ## NOTES ## RELATED LINKS From f80338b2d48101a3278c9b80b8a07e7c0a1f3cb4 Mon Sep 17 00:00:00 2001 From: robinharwood <19212983+robinharwood@users.noreply.github.com> Date: Wed, 20 Sep 2023 12:18:34 +0100 Subject: [PATCH 646/650] Updated Remove-ClusterSharedVolumeFromAffinityRule input description --- .../Remove-ClusterSharedVolumeFromAffinityRule.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2022-ps/failoverclusters/Remove-ClusterSharedVolumeFromAffinityRule.md b/docset/winserver2022-ps/failoverclusters/Remove-ClusterSharedVolumeFromAffinityRule.md index 42400d9abd..4f7d9d8886 100644 --- a/docset/winserver2022-ps/failoverclusters/Remove-ClusterSharedVolumeFromAffinityRule.md +++ b/docset/winserver2022-ps/failoverclusters/Remove-ClusterSharedVolumeFromAffinityRule.md @@ -202,7 +202,7 @@ the cluster shared volume from. ### Microsoft.Management.Infrastructure.CimInstance[] -This cmdlet accepts CIM instance objects representing an affinity rule like those returned by the +Specifies the affinity rule object to remove, as returned by the [Get-ClusterAffinityRule](Get-ClusterAffinityRule.md) cmdlet. ## OUTPUTS From f22eaf3464141260cf3a1a0f1b6ba96d8d80cfd3 Mon Sep 17 00:00:00 2001 From: robinharwood <19212983+robinharwood@users.noreply.github.com> Date: Wed, 20 Sep 2023 14:45:46 +0100 Subject: [PATCH 647/650] Correcting example --- .../Remove-ClusterSharedVolumeFromAffinityRule.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docset/winserver2022-ps/failoverclusters/Remove-ClusterSharedVolumeFromAffinityRule.md b/docset/winserver2022-ps/failoverclusters/Remove-ClusterSharedVolumeFromAffinityRule.md index 4f7d9d8886..148fd5dc2a 100644 --- a/docset/winserver2022-ps/failoverclusters/Remove-ClusterSharedVolumeFromAffinityRule.md +++ b/docset/winserver2022-ps/failoverclusters/Remove-ClusterSharedVolumeFromAffinityRule.md @@ -53,8 +53,8 @@ Get-ClusterAffinityRule -name Rule1 | ``` The command gets the affinity rule `Rule1` object and passes it to the -`Remove-ClusterSharedVolumeFromAffinityRule` command. The command adds the cluster shared volume -`Volume1` to the affinity rule. +`Remove-ClusterSharedVolumeFromAffinityRule` command. The command removes the cluster shared volume +`Volume1` from the affinity rule. ## PARAMETERS From b5c0eb2ba46b5fca17630a4691fac8522349b70b Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Mon, 2 Oct 2023 13:12:53 +0530 Subject: [PATCH 648/650] Update docset/winserver2016-ps/activedirectory/Move-ADObject.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- docset/winserver2016-ps/activedirectory/Move-ADObject.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2016-ps/activedirectory/Move-ADObject.md b/docset/winserver2016-ps/activedirectory/Move-ADObject.md index 440688f336..5a5ab059aa 100644 --- a/docset/winserver2016-ps/activedirectory/Move-ADObject.md +++ b/docset/winserver2016-ps/activedirectory/Move-ADObject.md @@ -37,7 +37,7 @@ You can also use the **Get-ADGroup**, **Get-ADUser**, **Get-ADComputer**, **Get- The *TargetPath* parameter must be specified. This parameter identifies the new location for the object or container. -The Cmdlet also moves the password when a user or computer object is moved across domains within a forest. +The cmdlet also moves the password when a user or computer object is moved across domains within a forest. ## EXAMPLES ### Example 1: Move an OU to a new location From 0b2017f1328d7b3c2bd9523eb756282ea981a0a1 Mon Sep 17 00:00:00 2001 From: Sriraman M S <45987684+msbemba@users.noreply.github.com> Date: Mon, 2 Oct 2023 13:13:03 +0530 Subject: [PATCH 649/650] Update docset/winserver2012r2-ps/activedirectory/Move-ADObject.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- docset/winserver2012r2-ps/activedirectory/Move-ADObject.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2012r2-ps/activedirectory/Move-ADObject.md b/docset/winserver2012r2-ps/activedirectory/Move-ADObject.md index 7d5546d75e..1234011f57 100644 --- a/docset/winserver2012r2-ps/activedirectory/Move-ADObject.md +++ b/docset/winserver2012r2-ps/activedirectory/Move-ADObject.md @@ -31,7 +31,7 @@ You can also use the Get-ADGroup, Get-ADUser, Get-ADComputer, Get-ADServiceAccou The **TargetPath** parameter must be specified. This parameter identifies the new location for the object or container. -The Cmdlet also moves the password when a user or computer object is moved across domains within a forest. +The cmdlet also moves the password when a user or computer object is moved across domains within a forest. ## EXAMPLES From 5868278112d8ef1d18b7a46a201ac75d9cdebbba Mon Sep 17 00:00:00 2001 From: Tina Burden Date: Mon, 2 Oct 2023 13:29:21 -0700 Subject: [PATCH 650/650] Update docset/winserver2019-ps/activedirectory/Set-ADUser.md Co-authored-by: JohanFreelancer9 <48568725+JohanFreelancer9@users.noreply.github.com> --- docset/winserver2019-ps/activedirectory/Set-ADUser.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docset/winserver2019-ps/activedirectory/Set-ADUser.md b/docset/winserver2019-ps/activedirectory/Set-ADUser.md index 80032c430f..337f0fb5e1 100644 --- a/docset/winserver2019-ps/activedirectory/Set-ADUser.md +++ b/docset/winserver2019-ps/activedirectory/Set-ADUser.md @@ -496,7 +496,7 @@ Accept wildcard characters: False Specifies the country or region code for the user's language of choice. This parameter sets the **Country** property of a user object. The LDAP display name (**ldapDisplayName**) of this property is c. -This value uses the ISO-3166 2-character code (see [Country-Name attribute](/windows/win32/adschema/a-c). +This value uses the ISO-3166 2-character code (see [Country-Name attribute](/windows/win32/adschema/a-c)). This value is not used by Windows 2000. ```yaml