diff --git a/docset/docfx.json b/docset/docfx.json index a66e96e2ed..bcd6857d85 100644 --- a/docset/docfx.json +++ b/docset/docfx.json @@ -3,6 +3,11 @@ "content": [ { "files": [ "toc.yml" ], "src": "bread", "dest": "windows/bread" }, + { "files": [ "**/*.md" ], "src": "docs-conceptual/winserver2025-ps", "version": "WindowsServer2025-ps", "dest": "windows" }, + { "files": [ "toc.yml" ], "src": "docs-conceptual/winserver2025-ps", "version": "WindowsServer2025-ps", "dest": "winserver2025-ps" }, + { "files": [ "**/*.yml" ], "exclude": [ "toc.yml" ], "src": "winserver2025-ps", "version": "WindowsServer2025-ps", "dest": "module" }, + { "files": [ "toc.yml" ], "src": "winserver2025-ps", "version": "WindowsServer2025-ps", "dest": "module/WindowsServer2025-ps" }, + { "files": [ "**/*.md" ], "src": "docs-conceptual/winserver2022-ps", "version": "WindowsServer2022-ps", "dest": "windows" }, { "files": [ "toc.yml" ], "src": "docs-conceptual/winserver2022-ps", "version": "WindowsServer2022-ps", "dest": "winserver2022-ps" }, { "files": [ "**/*.yml" ], "exclude": [ "toc.yml" ], "src": "winserver2022-ps", "version": "WindowsServer2022-ps", "dest": "module" }, @@ -39,6 +44,9 @@ { "files": [ "**/*.png", "**/*.jpg" ], "exclude": [ "**/obj/**", "**/includes/**" ] } ], "versions": { + "WindowsServer2025-ps": { + "dest": "winserver2025-ps" + }, "WindowsServer2022-ps": { "dest": "winserver2022-ps" }, @@ -105,6 +113,14 @@ "https://authoring-docs-microsoft.poolparty.biz/devrel/56936876-97d9-45cc-ad1b-9d63320447c8", "https://authoring-docs-microsoft.poolparty.biz/devrel/211bc889-ad71-4c77-b1cd-8ea0d02263f9" ], + "winserver2025-ps/**/*.md": [ + "https://authoring-docs-microsoft.poolparty.biz/devrel/56936876-97d9-45cc-ad1b-9d63320447c8", + "https://authoring-docs-microsoft.poolparty.biz/devrel/56754133-c3c3-4a9f-af19-71bdbe19fccf" + ], + "winserver2025-ps/**/*.yml": [ + "https://authoring-docs-microsoft.poolparty.biz/devrel/56936876-97d9-45cc-ad1b-9d63320447c8", + "https://authoring-docs-microsoft.poolparty.biz/devrel/56754133-c3c3-4a9f-af19-71bdbe19fccf" + ], "winserver2022-ps/**/*.md": [ "https://authoring-docs-microsoft.poolparty.biz/devrel/56936876-97d9-45cc-ad1b-9d63320447c8", "https://authoring-docs-microsoft.poolparty.biz/devrel/56754133-c3c3-4a9f-af19-71bdbe19fccf" diff --git a/docset/mapping/monikerMapping.json b/docset/mapping/monikerMapping.json index d9cd905b21..b0884ce0d9 100644 --- a/docset/mapping/monikerMapping.json +++ b/docset/mapping/monikerMapping.json @@ -1,4 +1,10 @@ { + "WindowsServer2025-ps": { + "conceptualToc": "docs-conceptual/winserver2025-ps/toc.yml", + "conceptualTocUrl": "/powershell/winserver2025-ps/toc.json", + "referenceTocUrl": "/powershell/module/WindowsServer2025-ps/toc.json", + "packageRoot": "winserver2025-ps" + }, "WindowsServer2022-ps": { "conceptualToc": "docs-conceptual/winserver2022-ps/toc.yml", "conceptualTocUrl": "/powershell/winserver2022-ps/toc.json", diff --git a/docset/winserver2022-ps/adfs/Set-AdfsWebConfig.md b/docset/winserver2022-ps/adfs/Set-AdfsWebConfig.md index c60c366a2d..bb6adcbd63 100644 --- a/docset/winserver2022-ps/adfs/Set-AdfsWebConfig.md +++ b/docset/winserver2022-ps/adfs/Set-AdfsWebConfig.md @@ -17,30 +17,38 @@ Modifies web customization configuration settings. ``` Set-AdfsWebConfig [-ActiveThemeName ] [-CDCCookieReader ] [-CDCCookieWriter ] - [-HRDCookieLifetime ] [-HRDCookieEnabled ] [-ContextCookieEnabled ] [-PassThru] - [-WhatIf] [-Confirm] [] + [-HRDCookieLifetime ] [-HRDCookieEnabled ] [-ContextCookieEnabled ] + [-PassThru] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION -The **Set-AdfsWebConfig** cmdlet modifies web customization configuration settings. -These settings impact any protocol that Active Directory Federation Services (AD FS) supports where a web browser facilitates token requests for home realm discovery (HRD) and authentication. + +The `Set-AdfsWebConfig` cmdlet modifies web customization configuration settings. These settings +impact any protocol that Active Directory Federation Services (AD FS) supports where a web browser +facilitates token requests for home realm discovery (HRD) and authentication. ## EXAMPLES ### Example 1: Set customization configuration properties + +```powershell +$pSSetAdfsWebConfigSplat = @{ + ActiveThemeName = "Default" + CDCCookieReader = 'https://www.Contoso.com/reader.aspx' + CDCCookieWriter = 'https://www.Contoso.com/writer.aspx' + ContextCookieEnabled = $True + HRDCookieEnabled = $True + HRDCookieLifetime = 30 +} +PSSet-AdfsWebConfig @pSSetAdfsWebConfigSplat ``` -PS C:\> Set-AdfsWebConfig -ActiveThemeName "Default" -CDCCookieReader https://www.Contoso.com/reader.aspx -CDCCookieWriter https://www.Contoso.com/writer.aspx -ContextCookieEnabled $True -HRDCookieEnabled $True -HRDCookieLifetime 30 +```Output ActiveThemeName : Default - CDCCookieReader : - CDCCookieWriter : - HRDCookieLifetime : 30 - HRDCookieEnabled : True - ContextCookieEnabled : True ``` @@ -49,13 +57,14 @@ This command sets properties in the web customization configuration settings. ## PARAMETERS ### -ActiveThemeName -Specifies the name of a web theme to be set as the active web theme in the web customization configuration. -To create a web theme, use the **New-AdfsWebTheme** cmdlet. + +Specifies the name of a web theme to be set as the active web theme in the web customization +configuration. To create a web theme, use the `New-AdfsWebTheme` cmdlet. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -65,12 +74,13 @@ Accept wildcard characters: False ``` ### -CDCCookieReader + Specifies the Uniform Resource Identifier (URI) of the Common Domain Cookie (CDC) reader. ```yaml Type: Uri Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -80,12 +90,13 @@ Accept wildcard characters: False ``` ### -CDCCookieWriter + Specifies the URI of the CDC writer. ```yaml Type: Uri Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -95,12 +106,13 @@ Accept wildcard characters: False ``` ### -ContextCookieEnabled + Indicates whether to enable the context cookie. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -110,13 +122,15 @@ Accept wildcard characters: False ``` ### -HRDCookieEnabled -Indicates whether to enable the HRD cookie. -If you specify a value of $False, when AD FS has more than one claims provider trust enabled, end users must select the home realm in every application request. + +Indicates whether to enable the HRD cookie. If you specify a value of `$false`, when AD FS has more +than one claims provider trust enabled, end users must select the home realm in every application +request. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -126,12 +140,13 @@ Accept wildcard characters: False ``` ### -HRDCookieLifetime + Specifies the lifetime, in days, of an HRD cookie. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -141,13 +156,14 @@ 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 Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -157,6 +173,7 @@ Accept wildcard characters: False ``` ### -Confirm + Prompts you for confirmation before running the cmdlet. ```yaml @@ -172,8 +189,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 @@ -188,16 +205,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](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;System.String[];System.Uri;System.Int32;System.Boolean +### None ## OUTPUTS -### -This cmdlet generates string for a theme to save as the active theme. +### None + +By default, this cmdlet doesn't return any output. + +### AdfsWebConfig + +When you use the **PassThru** parameter, this cmdlet returns an **AdfsWebConfig** object that +represents the modified configuration settings. ## NOTES @@ -206,4 +233,3 @@ This cmdlet generates string for a theme to save as the active theme. [Get-AdfsWebConfig](./Get-AdfsWebConfig.md) [New-AdfsWebTheme](./New-AdfsWebTheme.md) - diff --git a/docset/winserver2022-ps/dnsserver/Step-DnsServerSigningKeyRollover.md b/docset/winserver2022-ps/dnsserver/Step-DnsServerSigningKeyRollover.md index 56cef42d64..5ac00e48be 100644 --- a/docset/winserver2022-ps/dnsserver/Step-DnsServerSigningKeyRollover.md +++ b/docset/winserver2022-ps/dnsserver/Step-DnsServerSigningKeyRollover.md @@ -11,57 +11,73 @@ title: Step-DnsServerSigningKeyRollover # Step-DnsServerSigningKeyRollover ## SYNOPSIS + Rolls over a KSK that is waiting for a parent DS update. ## SYNTAX ``` Step-DnsServerSigningKeyRollover [-ZoneName] [-KeyId] [-Force] [-PassThru] - [-ComputerName ] [-CimSession ] [-ThrottleLimit ] [-AsJob] [-WhatIf] [-Confirm] - [] + [-ComputerName ] [-CimSession ] [-ThrottleLimit ] [-AsJob] [-WhatIf] + [-Confirm] [] ``` ## DESCRIPTION -The **Step-DnsServerSigningKeyRollover** cmdlet rolls over a key signing key (KSK) that is waiting for an update from a parent delegation signer (DS). -If a Domain Name System (DNS) server that hosts a securely delegated zone cannot check whether the DS record in a parent is updated, use this cmdlet to force a rollover. + +The `Step-DnsServerSigningKeyRollover` cmdlet rolls over a key signing key (KSK) that is waiting +for an update from a parent delegation signer (DS). If a Domain Name System (DNS) server that hosts +a securely delegated zone cannot check whether the DS record in a parent is updated, use this cmdlet +to force a rollover. Important: You must manually update the DS record in the parent before you run this cmdlet. ## EXAMPLES ### Example 1: Force a key signing key rollover -``` + +This example gets keys for a signed zone, and then forces a KSK rollover for one of the keys in the zone. + The first command uses the **Get-DnsServerSigningKey** cmdlet to gets keys for the signed zone Sec.Contoso.com. -PS C:\> Get-DnsServerSigningKey -ZoneName "Sec.Contoso.com" + +```powershell +Get-DnsServerSigningKey -ZoneName "Sec.Contoso.com" +``` + +```Output KeyId KeyType CryptoAlgorithm KeyLength StoreKeysInAD IsRolloverEnabled ----- ------- --------------- --------- ------------- ----------------- 5fe47b29-6bf8-457a-b457-e640893ebd53 KeySigningKey RsaSha256 2048 True True aaf3301e-feb2-4ba7-8ac6-273c6bda75af KeySigningKey RsaSha1NSec3 2048 True True fbf3116f-b0ba-4bf8-bf35-68dab6d4765b ZoneSigningKey RsaSha1NSec3 1024 True True f760fcb5-577b-4237-b0b2-513e1f68ec72 ZoneSigningKey RsaSha256 1024 True True +``` -The last command forces a KSK rollover that is waiting for a parent DS update on Contoso.com. The command performs a KSK rollover for the specified key in the zone named Sec.Contoso.com. -PS C:\> Step-DnsServerSigningKeyRollover -KeyId 5fe47b29-6bf8-457a-b457-e640893ebd53 -ZoneName "Sec.Contoso.com" -Force +```powershell +Step-DnsServerSigningKeyRollover -KeyId 5fe47b29-6bf8-457a-b457-e640893ebd53 -ZoneName "Sec.Contoso.com" -Force ``` -This example gets keys for a signed zone, and then forces a KSK rollover for one of the keys in the zone. +The last command forces a KSK rollover that is waiting for a parent DS update on Contoso.com. The +command performs a KSK rollover for the specified key in the zone named Sec.Contoso.com. ## 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 Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -71,9 +87,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[] @@ -88,13 +106,14 @@ Accept wildcard characters: False ``` ### -ComputerName -Specifies a remote DNS server. -Specify the IP address or any value that resolves to an IP address, such as a fully qualified domain name (FQDN), host name, or NETBIOS name, for the DNS server. + +Specifies a remote DNS server. Specify the IP address or any value that resolves to an IP address, +such as a fully qualified domain name (FQDN), host name, or NETBIOS name, for the DNS server. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -104,6 +123,7 @@ Accept wildcard characters: False ``` ### -Confirm + Prompts you for confirmation before running the cmdlet. ```yaml @@ -119,12 +139,13 @@ Accept wildcard characters: False ``` ### -Force + Forces the command to run without asking for user confirmation. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -134,12 +155,13 @@ Accept wildcard characters: False ``` ### -KeyId + Specifies the ID of the key for which to perform the KSK rollover. ```yaml Type: Guid Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 2 @@ -149,13 +171,14 @@ 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 Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -165,14 +188,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 @@ -182,8 +208,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 @@ -198,12 +224,13 @@ Accept wildcard characters: False ``` ### -ZoneName + Specifies the name of the DNS zone in which the cmdlet performs the KSK rollover. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 1 @@ -213,13 +240,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 ## OUTPUTS -### +### Microsoft.Management.Infrastructure.CimInstance#DnsServerSigningKey[] + The output object contains the following fields: - ActiveKey @@ -250,4 +282,3 @@ The output object contains the following fields: [Invoke-DnsServerSigningKeyRollover](./Invoke-DnsServerSigningKeyRollover.md) [Disable-DnsServerSigningKeyRollover](./Disable-DnsServerSigningKeyRollover.md) - diff --git a/docset/winserver2025-ps/adfs/Set-AdfsWebConfig.md b/docset/winserver2025-ps/adfs/Set-AdfsWebConfig.md index f5b60dc841..067079e8fd 100644 --- a/docset/winserver2025-ps/adfs/Set-AdfsWebConfig.md +++ b/docset/winserver2025-ps/adfs/Set-AdfsWebConfig.md @@ -17,30 +17,38 @@ Modifies web customization configuration settings. ``` Set-AdfsWebConfig [-ActiveThemeName ] [-CDCCookieReader ] [-CDCCookieWriter ] - [-HRDCookieLifetime ] [-HRDCookieEnabled ] [-ContextCookieEnabled ] [-PassThru] - [-WhatIf] [-Confirm] [] + [-HRDCookieLifetime ] [-HRDCookieEnabled ] [-ContextCookieEnabled ] + [-PassThru] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION -The **Set-AdfsWebConfig** cmdlet modifies web customization configuration settings. -These settings impact any protocol that Active Directory Federation Services (AD FS) supports where a web browser facilitates token requests for home realm discovery (HRD) and authentication. + +The `Set-AdfsWebConfig` cmdlet modifies web customization configuration settings. These settings +impact any protocol that Active Directory Federation Services (AD FS) supports where a web browser +facilitates token requests for home realm discovery (HRD) and authentication. ## EXAMPLES ### Example 1: Set customization configuration properties + +```powershell +$pSSetAdfsWebConfigSplat = @{ + ActiveThemeName = "Default" + CDCCookieReader = 'https://www.Contoso.com/reader.aspx' + CDCCookieWriter = 'https://www.Contoso.com/writer.aspx' + ContextCookieEnabled = $True + HRDCookieEnabled = $True + HRDCookieLifetime = 30 +} +PSSet-AdfsWebConfig @pSSetAdfsWebConfigSplat ``` -PS C:\> Set-AdfsWebConfig -ActiveThemeName "Default" -CDCCookieReader https://www.Contoso.com/reader.aspx -CDCCookieWriter https://www.Contoso.com/writer.aspx -ContextCookieEnabled $True -HRDCookieEnabled $True -HRDCookieLifetime 30 +```Output ActiveThemeName : Default - CDCCookieReader : - CDCCookieWriter : - HRDCookieLifetime : 30 - HRDCookieEnabled : True - ContextCookieEnabled : True ``` @@ -49,8 +57,9 @@ This command sets properties in the web customization configuration settings. ## PARAMETERS ### -ActiveThemeName -Specifies the name of a web theme to be set as the active web theme in the web customization configuration. -To create a web theme, use the **New-AdfsWebTheme** cmdlet. + +Specifies the name of a web theme to be set as the active web theme in the web customization +configuration. To create a web theme, use the `New-AdfsWebTheme` cmdlet. ```yaml Type: String @@ -65,6 +74,7 @@ Accept wildcard characters: False ``` ### -CDCCookieReader + Specifies the Uniform Resource Identifier (URI) of the Common Domain Cookie (CDC) reader. ```yaml @@ -80,6 +90,7 @@ Accept wildcard characters: False ``` ### -CDCCookieWriter + Specifies the URI of the CDC writer. ```yaml @@ -95,6 +106,7 @@ Accept wildcard characters: False ``` ### -ContextCookieEnabled + Indicates whether to enable the context cookie. ```yaml @@ -110,8 +122,10 @@ Accept wildcard characters: False ``` ### -HRDCookieEnabled -Indicates whether to enable the HRD cookie. -If you specify a value of $False, when AD FS has more than one claims provider trust enabled, end users must select the home realm in every application request. + +Indicates whether to enable the HRD cookie. If you specify a value of `$false`, when AD FS has more +than one claims provider trust enabled, end users must select the home realm in every application +request. ```yaml Type: Boolean @@ -126,6 +140,7 @@ Accept wildcard characters: False ``` ### -HRDCookieLifetime + Specifies the lifetime, in days, of an HRD cookie. ```yaml @@ -141,8 +156,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 does not +generate any output. ```yaml Type: SwitchParameter @@ -157,6 +173,7 @@ Accept wildcard characters: False ``` ### -Confirm + Prompts you for confirmation before running the cmdlet. ```yaml @@ -172,8 +189,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 @@ -188,16 +205,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](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;System.String[];System.Uri;System.Int32;System.Boolean +### None ## OUTPUTS -### -This cmdlet generates string for a theme to save as the active theme. +### None + +By default, this cmdlet doesn't return any output. + +### AdfsWebConfig + +When you use the **PassThru** parameter, this cmdlet returns an **AdfsWebConfig** object that +represents the modified configuration settings. ## NOTES @@ -206,4 +233,3 @@ This cmdlet generates string for a theme to save as the active theme. [Get-AdfsWebConfig](./Get-AdfsWebConfig.md) [New-AdfsWebTheme](./New-AdfsWebTheme.md) - diff --git a/docset/winserver2025-ps/dnsserver/Step-DnsServerSigningKeyRollover.md b/docset/winserver2025-ps/dnsserver/Step-DnsServerSigningKeyRollover.md index 766c8b0e44..2a31da9de4 100644 --- a/docset/winserver2025-ps/dnsserver/Step-DnsServerSigningKeyRollover.md +++ b/docset/winserver2025-ps/dnsserver/Step-DnsServerSigningKeyRollover.md @@ -11,52 +11,68 @@ title: Step-DnsServerSigningKeyRollover # Step-DnsServerSigningKeyRollover ## SYNOPSIS + Rolls over a KSK that is waiting for a parent DS update. ## SYNTAX ``` Step-DnsServerSigningKeyRollover [-ZoneName] [-KeyId] [-Force] [-PassThru] - [-ComputerName ] [-CimSession ] [-ThrottleLimit ] [-AsJob] [-WhatIf] [-Confirm] - [] + [-ComputerName ] [-CimSession ] [-ThrottleLimit ] [-AsJob] [-WhatIf] + [-Confirm] [] ``` ## DESCRIPTION -The **Step-DnsServerSigningKeyRollover** cmdlet rolls over a key signing key (KSK) that is waiting for an update from a parent delegation signer (DS). -If a Domain Name System (DNS) server that hosts a securely delegated zone cannot check whether the DS record in a parent is updated, use this cmdlet to force a rollover. + +The `Step-DnsServerSigningKeyRollover` cmdlet rolls over a key signing key (KSK) that is waiting +for an update from a parent delegation signer (DS). If a Domain Name System (DNS) server that hosts +a securely delegated zone cannot check whether the DS record in a parent is updated, use this cmdlet +to force a rollover. Important: You must manually update the DS record in the parent before you run this cmdlet. ## EXAMPLES ### Example 1: Force a key signing key rollover -``` + +This example gets keys for a signed zone, and then forces a KSK rollover for one of the keys in the zone. + The first command uses the **Get-DnsServerSigningKey** cmdlet to gets keys for the signed zone Sec.Contoso.com. -PS C:\> Get-DnsServerSigningKey -ZoneName "Sec.Contoso.com" + +```powershell +Get-DnsServerSigningKey -ZoneName "Sec.Contoso.com" +``` + +```Output KeyId KeyType CryptoAlgorithm KeyLength StoreKeysInAD IsRolloverEnabled ----- ------- --------------- --------- ------------- ----------------- 5fe47b29-6bf8-457a-b457-e640893ebd53 KeySigningKey RsaSha256 2048 True True aaf3301e-feb2-4ba7-8ac6-273c6bda75af KeySigningKey RsaSha1NSec3 2048 True True fbf3116f-b0ba-4bf8-bf35-68dab6d4765b ZoneSigningKey RsaSha1NSec3 1024 True True f760fcb5-577b-4237-b0b2-513e1f68ec72 ZoneSigningKey RsaSha256 1024 True True +``` -The last command forces a KSK rollover that is waiting for a parent DS update on Contoso.com. The command performs a KSK rollover for the specified key in the zone named Sec.Contoso.com. -PS C:\> Step-DnsServerSigningKeyRollover -KeyId 5fe47b29-6bf8-457a-b457-e640893ebd53 -ZoneName "Sec.Contoso.com" -Force +```powershell +Step-DnsServerSigningKeyRollover -KeyId 5fe47b29-6bf8-457a-b457-e640893ebd53 -ZoneName "Sec.Contoso.com" -Force ``` -This example gets keys for a signed zone, and then forces a KSK rollover for one of the keys in the zone. +The last command forces a KSK rollover that is waiting for a parent DS update on Contoso.com. The +command performs a KSK rollover for the specified key in the zone named Sec.Contoso.com. ## 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 @@ -71,9 +87,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[] @@ -88,8 +106,9 @@ Accept wildcard characters: False ``` ### -ComputerName -Specifies a remote DNS server. -Specify the IP address or any value that resolves to an IP address, such as a fully qualified domain name (FQDN), host name, or NETBIOS name, for the DNS server. + +Specifies a remote DNS server. Specify the IP address or any value that resolves to an IP address, +such as a fully qualified domain name (FQDN), host name, or NETBIOS name, for the DNS server. ```yaml Type: String @@ -104,6 +123,7 @@ Accept wildcard characters: False ``` ### -Confirm + Prompts you for confirmation before running the cmdlet. ```yaml @@ -119,6 +139,7 @@ Accept wildcard characters: False ``` ### -Force + Forces the command to run without asking for user confirmation. ```yaml @@ -134,6 +155,7 @@ Accept wildcard characters: False ``` ### -KeyId + Specifies the ID of the key for which to perform the KSK rollover. ```yaml @@ -149,8 +171,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 does not +generate any output. ```yaml Type: SwitchParameter @@ -165,9 +188,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 @@ -182,8 +208,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 @@ -198,6 +224,7 @@ Accept wildcard characters: False ``` ### -ZoneName + Specifies the name of the DNS zone in which the cmdlet performs the KSK rollover. ```yaml @@ -213,13 +240,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 ## OUTPUTS -### +### Microsoft.Management.Infrastructure.CimInstance#DnsServerSigningKey[] + The output object contains the following fields: - ActiveKey @@ -250,4 +282,3 @@ The output object contains the following fields: [Invoke-DnsServerSigningKeyRollover](./Invoke-DnsServerSigningKeyRollover.md) [Disable-DnsServerSigningKeyRollover](./Disable-DnsServerSigningKeyRollover.md) - diff --git a/docset/winserver2025-ps/hyper-v/Add-VMNetworkAdapter.md b/docset/winserver2025-ps/hyper-v/Add-VMNetworkAdapter.md index d0216875a3..da92878518 100644 --- a/docset/winserver2025-ps/hyper-v/Add-VMNetworkAdapter.md +++ b/docset/winserver2025-ps/hyper-v/Add-VMNetworkAdapter.md @@ -332,8 +332,17 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### -None by default; if **PassThru** is specified, then either a **Microsoft.HyperV.PowerShell.VMInternalNetworkAdapter** if **ManagementOS** is specified, or a **Microsoft.HyperV.PowerShell.VMNetworkAdapter** if it is not. +### None + +By default, this cmdlet doesn't return any output. + +### Microsoft.HyperV.PowerShell.VMNetworkAdapter + +If **PassThru** is specified, a **Microsoft.HyperV.PowerShell.VMNetworkAdapter** object is output by default. + +### Microsoft.HyperV.PowerShell.VMInternalNetworkAdapter + +If **PassThru** and **ManagementOS** is specified, then **Microsoft.HyperV.PowerShell.VMInternalNetworkAdapter** is output. ## NOTES diff --git a/docset/winserver2025-ps/hyper-v/Add-VMSwitch.md b/docset/winserver2025-ps/hyper-v/Add-VMSwitch.md index df81afbe65..0af7174356 100644 --- a/docset/winserver2025-ps/hyper-v/Add-VMSwitch.md +++ b/docset/winserver2025-ps/hyper-v/Add-VMSwitch.md @@ -148,8 +148,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### -None by default; **Microsoft.HyperV.PowerShell.VMNetwork** if **-PassThru** is present. +### None + +By default, this cmdlet doesn't return any output. + +### Microsoft.HyperV.PowerShell.VMNetwork + +When you use the **PassThru** parameter, this cmdlet returns a **Microsoft.HyperV.PowerShell.VMNetwork** object. ## NOTES diff --git a/docset/winserver2025-ps/hyper-v/Checkpoint-VM.md b/docset/winserver2025-ps/hyper-v/Checkpoint-VM.md index 9fe209a8e3..9cbdea760d 100644 --- a/docset/winserver2025-ps/hyper-v/Checkpoint-VM.md +++ b/docset/winserver2025-ps/hyper-v/Checkpoint-VM.md @@ -216,8 +216,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### -Nothing by default; **Microsoft.HyperV.PowerShell.Snapshot** if *PassThru* is specified. +### None + +By default, this cmdlet doesn't return any output. + +### Microsoft.HyperV.PowerShell.Snapshot + +When you use the **PassThru** parameter, this cmdlet returns a **Microsoft.HyperV.PowerShell.Snapshot** object. ## NOTES diff --git a/docset/winserver2025-ps/hyper-v/Disable-VMMigration.md b/docset/winserver2025-ps/hyper-v/Disable-VMMigration.md index d873d1100c..8ce68b2ff1 100644 --- a/docset/winserver2025-ps/hyper-v/Disable-VMMigration.md +++ b/docset/winserver2025-ps/hyper-v/Disable-VMMigration.md @@ -145,8 +145,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### -None by default; **Microsoft.HyperV.PowerShell.Host** if **-PassThru** is present. +### None + +By default, this cmdlet doesn't return any output. + +### Microsoft.HyperV.PowerShell.Host + +When you use the **PassThru** parameter, this cmdlet returns a **Microsoft.HyperV.PowerShell.Host** object. ## NOTES diff --git a/docset/winserver2025-ps/hyper-v/Enable-VMRemoteFXPhysicalVideoAdapter.md b/docset/winserver2025-ps/hyper-v/Enable-VMRemoteFXPhysicalVideoAdapter.md index d39c2d4e7c..2a3eaadc59 100644 --- a/docset/winserver2025-ps/hyper-v/Enable-VMRemoteFXPhysicalVideoAdapter.md +++ b/docset/winserver2025-ps/hyper-v/Enable-VMRemoteFXPhysicalVideoAdapter.md @@ -16,25 +16,31 @@ Enables one or more RemoteFX physical video adapters for use with RemoteFX-enabl ## SYNTAX ### GPUByName (Default) + ``` Enable-VMRemoteFXPhysicalVideoAdapter [-CimSession ] [-ComputerName ] - [-Credential ] [-Name] [-Passthru] [-WhatIf] [-Confirm] [] + [-Credential ] [-Name] [-Passthru] [-WhatIf] [-Confirm] + [] ``` ### GPUByObject + ``` -Enable-VMRemoteFXPhysicalVideoAdapter [-GPU] [-Passthru] [-WhatIf] - [-Confirm] [] +Enable-VMRemoteFXPhysicalVideoAdapter [-GPU] [-Passthru] + [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION -The **Enable-VMRemoteFXPhysicalVideoAdapter** cmdlet enables one or more RemoteFX physical video adapters to be used with RemoteFX-enabled virtual machines. + +The **Enable-VMRemoteFXPhysicalVideoAdapter** cmdlet enables one or more RemoteFX physical video +adapters to be used with RemoteFX-enabled virtual machines. ## EXAMPLES ### Code Example Title -``` -PS C:\> Get-VMRemoteFXPhysicalVideoAdapter -Name *Nvidia* | Enable-VMRemoteFXPhysicalVideoAdapter + +```powershell +Get-VMRemoteFXPhysicalVideoAdapter -Name *Nvidia* | Enable-VMRemoteFXPhysicalVideoAdapter ``` Enables all RemoteFX physical video adapters which include the sequence "Nvidia" in their name. @@ -42,9 +48,11 @@ Enables all RemoteFX physical video adapters which include the sequence "Nvidia" ## 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[] @@ -59,10 +67,10 @@ Accept wildcard characters: False ``` ### -ComputerName + Specifies one or more Hyper-V hosts on which the RemoteFX physical video adapters are to be enabled. -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[] @@ -77,6 +85,7 @@ Accept wildcard characters: False ``` ### -Confirm + Prompts you for confirmation before running the cmdlet. ```yaml @@ -92,8 +101,9 @@ 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[] @@ -108,6 +118,7 @@ Accept wildcard characters: False ``` ### -GPU + Specifies the RemoteFX physical video adapters to be enabled. ```yaml @@ -123,8 +134,9 @@ Accept wildcard characters: False ``` ### -Name -Specifies an array of names of adapters. -The cmdlet enables the RemoteFX physical video adapters that you specify. + +Specifies an array of names of adapters. The cmdlet enables the RemoteFX physical video adapters +that you specify. ```yaml Type: String[] @@ -139,7 +151,10 @@ Accept wildcard characters: False ``` ### -Passthru -Specifies that one or more **Microsoft.HyperV.PowerShell.VMRemoteFXPhysicalVideoAdapter** objects are to be passed through to the pipeline representing the RemoteFX physical video adapters to be enabled. + +Specifies that one or more **Microsoft.HyperV.PowerShell.VMRemoteFXPhysicalVideoAdapter** objects +are to be passed through to the pipeline representing the RemoteFX physical video adapters to be +enabled. ```yaml Type: SwitchParameter @@ -154,8 +169,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 @@ -170,21 +185,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.HyperV.PowerShell.VMRemoteFXPhysicalVideoAdapter[] -### -System.String\[\] +### System.String[] ## OUTPUTS -### -None by default; **Microsoft.HyperV.PowerShell.VMRemoteFXPhysicalVideoAdapter\[\]** if *PassThru* is specified. +### None + +By default, this cmdlet doesn't return any output. + +### Microsoft.HyperV.PowerShell.VMRemoteFXPhysicalVideoAdapter + +What you use the **PassThru** parameter, the cmdlet returns +**Microsoft.HyperV.PowerShell.VMRemoteFXPhysicalVideoAdapter** objects. ## NOTES ## RELATED LINKS - diff --git a/docset/winserver2025-ps/hyper-v/Get-VMNetworkAdapter.md b/docset/winserver2025-ps/hyper-v/Get-VMNetworkAdapter.md index 90d3e3c20c..dd23bd621a 100644 --- a/docset/winserver2025-ps/hyper-v/Get-VMNetworkAdapter.md +++ b/docset/winserver2025-ps/hyper-v/Get-VMNetworkAdapter.md @@ -255,8 +255,17 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### -**Microsoft.HyperV.PowerShell.VMInternalNetworkAdapter** if **ManagementOS** is specified; **Microsoft.HyperV.PowerShell.VMInternalNetworkAdapter** and **Microsoft.HyperV.PowerShell.VMNetworkAdapter** if **All** is specified;**Microsoft.HyperV.PowerShell.VMNetworkAdapter** in all other cases. +### Microsoft.HyperV.PowerShell.VMNetworkAdapter + +By default, **Microsoft.HyperV.PowerShell.VMNetworkAdapter** is output. + +### Microsoft.HyperV.PowerShell.VMInternalNetworkAdapter + +**Microsoft.HyperV.PowerShell.VMInternalNetworkAdapter** if **ManagementOS** is specified. + +### Microsoft.HyperV.PowerShell.VMInternalNetworkAdapter and Microsoft.HyperV.PowerShell.VMNetworkAdapter + +**Microsoft.HyperV.PowerShell.VMInternalNetworkAdapter** and **Microsoft.HyperV.PowerShell.VMNetworkAdapter** if **All** is specified. ## NOTES diff --git a/docset/winserver2025-ps/hyper-v/Move-VM.md b/docset/winserver2025-ps/hyper-v/Move-VM.md index 3ad70de0bd..198cec2979 100644 --- a/docset/winserver2025-ps/hyper-v/Move-VM.md +++ b/docset/winserver2025-ps/hyper-v/Move-VM.md @@ -471,10 +471,17 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### -None, by default. -**Microsoft.HyperV.PowerShell.VirtualMachine** if the migration succeeds and **-PassThru** is specified. -**Microsoft.HyperV.PowerShell.CompatibilityReport** if the migration fails because of an incompatibility. +### None + +By default, this cmdlet doesn't return any output. + +### Microsoft.HyperV.PowerShell.VirtualMachine + +When you use the **PassThru** parameter, this cmdlet returns a **Microsoft.HyperV.PowerShell.VirtualMachine** object if the migration is successful. + +### Microsoft.HyperV.PowerShell.CompatibilityReport + +When you use the **PassThru** parameter, this cmdlet returns a **Microsoft.HyperV.PowerShell.CompatibilityReport** object if the migration fails because of an incompatibility. ## NOTES diff --git a/docset/winserver2025-ps/hyper-v/Remove-VMNetworkAdapter.md b/docset/winserver2025-ps/hyper-v/Remove-VMNetworkAdapter.md index 61fbbacd0b..096636341d 100644 --- a/docset/winserver2025-ps/hyper-v/Remove-VMNetworkAdapter.md +++ b/docset/winserver2025-ps/hyper-v/Remove-VMNetworkAdapter.md @@ -249,9 +249,17 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### -None by default. -if *PassThru* is specified, **Microsoft.HyperV.PowerShell.VMInternalNetworkAdapter**, if **-ManagementOS** is also specified;otherwise **Microsoft.HyperV.PowerShell.VMNetworkAdapter**. +### None + +By default, this cmdlet doesn't return any output. + +### Microsoft.HyperV.PowerShell.VMNetworkAdapter + +When you use the **PassThru** parameter, this cmdlet returns a **Microsoft.HyperV.PowerShell.VMNetworkAdapter** object. + +### Microsoft.HyperV.PowerShell.VMInternalNetworkAdapter + +When you use the **PassThru** and **-ManagementOS** parameters, this cmdlet returns a **Microsoft.HyperV.PowerShell.VMInternalNetworkAdapter**. ## NOTES diff --git a/docset/winserver2025-ps/hyper-v/Remove-VMNetworkAdapterAcl.md b/docset/winserver2025-ps/hyper-v/Remove-VMNetworkAdapterAcl.md index c7a6860b04..9b97c6366a 100644 --- a/docset/winserver2025-ps/hyper-v/Remove-VMNetworkAdapterAcl.md +++ b/docset/winserver2025-ps/hyper-v/Remove-VMNetworkAdapterAcl.md @@ -390,8 +390,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### -None by default, **Microsoft.HyperV.PowerShell.VMNetworkAdapterAclSetting** if *PassThru* is specified. +### None + +By default, this cmdlet doesn't return any output. + +### Microsoft.HyperV.PowerShell.VMNetworkAdapterAclSetting + +When you use the **PassThru** parameter, this cmdlet returns a **Microsoft.HyperV.PowerShell.VMNetworkAdapterAclSetting** object. ## NOTES diff --git a/docset/winserver2025-ps/hyper-v/Remove-VMScsiController.md b/docset/winserver2025-ps/hyper-v/Remove-VMScsiController.md index 2916f3e19b..cebbca9997 100644 --- a/docset/winserver2025-ps/hyper-v/Remove-VMScsiController.md +++ b/docset/winserver2025-ps/hyper-v/Remove-VMScsiController.md @@ -192,10 +192,14 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### -None by default; **VMScsiController** if **-PassThru** is specified. +### None + +By default, this cmdlet doesn't return any output. + +### VMScsiController + +When you use the **PassThru** parameter, this cmdlet returns a **VMScsiController** object. ## NOTES ## RELATED LINKS - diff --git a/docset/winserver2025-ps/hyper-v/Rename-VMNetworkAdapter.md b/docset/winserver2025-ps/hyper-v/Rename-VMNetworkAdapter.md index 55906e0f47..d309ecd98e 100644 --- a/docset/winserver2025-ps/hyper-v/Rename-VMNetworkAdapter.md +++ b/docset/winserver2025-ps/hyper-v/Rename-VMNetworkAdapter.md @@ -257,9 +257,17 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### -None by default. -if *PassThru* is specified, then a **Microsoft.HyperV.PowerShell.VMInternalNetworkAdapter** object is passed through to the pipeline if **-ManagementOS** is also specified; otherwise a **Microsoft.HyperV.PowerShell.VMNetworkAdapter** is passed. +### None + +By default, this cmdlet doesn't return any output. + +### Microsoft.HyperV.PowerShell.VMNetworkAdapter + +When you use the **PassThru** parameter, this cmdlet returns a **Microsoft.HyperV.PowerShell.VMNetworkAdapter** object. + +### Microsoft.HyperV.PowerShell.VMInternalNetworkAdapter + +When you use the **PassThru** and **-ManagementOS** parameters, this cmdlet returns a **Microsoft.HyperV.PowerShell.VMInternalNetworkAdapter** object. ## NOTES diff --git a/docset/winserver2025-ps/hyper-v/Restart-VM.md b/docset/winserver2025-ps/hyper-v/Restart-VM.md index 14246e607b..6b153642b1 100644 --- a/docset/winserver2025-ps/hyper-v/Restart-VM.md +++ b/docset/winserver2025-ps/hyper-v/Restart-VM.md @@ -288,10 +288,14 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### -None by default, **Microsoft.HyperV.Powershell.VirtualMachine** if *PassThru* is specified. +### None + +By default, this cmdlet doesn't return any output. + +### Microsoft.HyperV.Powershell.VirtualMachine + +When you use the **PassThru** parameter, this cmdlet returns a **Microsoft.HyperV.Powershell.VirtualMachine** object. ## NOTES ## RELATED LINKS - diff --git a/docset/winserver2025-ps/hyper-v/Set-VMNetworkAdapter.md b/docset/winserver2025-ps/hyper-v/Set-VMNetworkAdapter.md index 7e81fd09df..887df37a25 100644 --- a/docset/winserver2025-ps/hyper-v/Set-VMNetworkAdapter.md +++ b/docset/winserver2025-ps/hyper-v/Set-VMNetworkAdapter.md @@ -845,9 +845,17 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### -None by default. -if *PassThru* is specified, then a **Microsoft.HyperV.PowerShell.VMInternalNetworkAdapter** is passed through to the pipeline if **-ManagementOS** is also specified, otherwise **Microsoft.HyperV.PowerShell.VMNetworkAdapter**. +### None + +By default, this cmdlet doesn't return any output. + +### Microsoft.HyperV.PowerShell.VMNetworkAdapter + +When you use the **PassThru** parameter, this cmdlet returns a **Microsoft.HyperV.PowerShell.VMNetworkAdapter** object. + +### Microsoft.HyperV.PowerShell.VMInternalNetworkAdapter + +When you use the **PassThru** and **-ManagementOS** parameters, this cmdlet returns a **Microsoft.HyperV.PowerShell.VMInternalNetworkAdapter** object. ## NOTES diff --git a/docset/winserver2025-ps/hyper-v/Set-VMRemoteFx3dVideoAdapter.md b/docset/winserver2025-ps/hyper-v/Set-VMRemoteFx3dVideoAdapter.md index 932ea9f435..4b93bd4965 100644 --- a/docset/winserver2025-ps/hyper-v/Set-VMRemoteFx3dVideoAdapter.md +++ b/docset/winserver2025-ps/hyper-v/Set-VMRemoteFx3dVideoAdapter.md @@ -243,10 +243,14 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### -None by default; Microsoft.HyperV.PowerShell.RemoteFxVideoAdapter if *PassThru* is specified. +### None + +By default, this cmdlet doesn't return any output. + +### Microsoft.HyperV.PowerShell.RemoteFxVideoAdapter + +When you use the **PassThru** parameter, this cmdlet returns a **Microsoft.HyperV.PowerShell.RemoteFxVideoAdapter** object. ## NOTES ## RELATED LINKS - diff --git a/docset/winserver2025-ps/ipamserver/Find-IpamFreeRange.md b/docset/winserver2025-ps/ipamserver/Find-IpamFreeRange.md index 62376ccf11..a552e66871 100644 --- a/docset/winserver2025-ps/ipamserver/Find-IpamFreeRange.md +++ b/docset/winserver2025-ps/ipamserver/Find-IpamFreeRange.md @@ -151,7 +151,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### +### IpamFreeRange + The cmdlet returns an instance of the **IpamFreeRange** object. ## NOTES @@ -160,5 +161,4 @@ The cmdlet returns an instance of the **IpamFreeRange** object. [Find-IpamFreeAddress](./Find-IpamFreeAddress.md) -[Find-IpamFreeSubnet](./Find-IpamFreeSubnet.md) - +[Find-IpamFreeSubnet](./Find-IpamFreeSubnet.md) \ No newline at end of file diff --git a/docset/winserver2025-ps/ipamserver/Get-IpamDhcpScope.md b/docset/winserver2025-ps/ipamserver/Get-IpamDhcpScope.md index 8370ee4b71..1f45dc5521 100644 --- a/docset/winserver2025-ps/ipamserver/Get-IpamDhcpScope.md +++ b/docset/winserver2025-ps/ipamserver/Get-IpamDhcpScope.md @@ -162,7 +162,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### +### IpamDhcpScope + This cmdlet returns an object that represents an **IpamDhcpScope** object. ## NOTES @@ -172,4 +173,3 @@ This cmdlet returns an object that represents an **IpamDhcpScope** object. [Get-IpamDhcpServer](./Get-IpamDhcpServer.md) [Get-IpamDhcpSuperscope](./Get-IpamDhcpSuperscope.md) - diff --git a/docset/winserver2025-ps/ipamserver/Get-IpamDhcpServer.md b/docset/winserver2025-ps/ipamserver/Get-IpamDhcpServer.md index 1ecae23a57..cec0096441 100644 --- a/docset/winserver2025-ps/ipamserver/Get-IpamDhcpServer.md +++ b/docset/winserver2025-ps/ipamserver/Get-IpamDhcpServer.md @@ -124,7 +124,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### +### IpamDhcpServer + This cmdlet returns an object that represents an instance of the **IpamDhcpServer** object. ## NOTES @@ -134,4 +135,3 @@ This cmdlet returns an object that represents an instance of the **IpamDhcpServe [Get-IpamDhcpScope](./Get-IpamDhcpScope.md) [Get-IpamDhcpSuperscope](./Get-IpamDhcpSuperscope.md) - diff --git a/docset/winserver2025-ps/ipamserver/Get-IpamDhcpSuperscope.md b/docset/winserver2025-ps/ipamserver/Get-IpamDhcpSuperscope.md index 701f9602a6..f8e71b3572 100644 --- a/docset/winserver2025-ps/ipamserver/Get-IpamDhcpSuperscope.md +++ b/docset/winserver2025-ps/ipamserver/Get-IpamDhcpSuperscope.md @@ -154,7 +154,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### +### Get-IpamDhcpSuperscope + This cmdlet returns an object that represents an instance of **Get-IpamDhcpSuperscope**. ## NOTES @@ -164,4 +165,3 @@ This cmdlet returns an object that represents an instance of **Get-IpamDhcpSuper [Get-IpamDhcpScope](./Get-IpamDhcpScope.md) [Get-IpamDhcpServer](./Get-IpamDhcpServer.md) - diff --git a/docset/winserver2025-ps/ipamserver/Get-IpamDnsConditionalForwarder.md b/docset/winserver2025-ps/ipamserver/Get-IpamDnsConditionalForwarder.md index efad52986d..1b8ca2196f 100644 --- a/docset/winserver2025-ps/ipamserver/Get-IpamDnsConditionalForwarder.md +++ b/docset/winserver2025-ps/ipamserver/Get-IpamDnsConditionalForwarder.md @@ -150,7 +150,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### +### IpamDnsConditionalForwarder + This cmdlet returns an object that represents an instance of the **IpamDnsConditionalForwarder** object. ## NOTES @@ -162,4 +163,3 @@ This cmdlet returns an object that represents an instance of the **IpamDnsCondit [Get-IpamDnsServer](./Get-IpamDnsServer.md) [Get-IpamDnsZone](./Get-IpamDnsZone.md) - diff --git a/docset/winserver2025-ps/ipamserver/Get-IpamDnsResourceRecord.md b/docset/winserver2025-ps/ipamserver/Get-IpamDnsResourceRecord.md index 0ec5bbfab9..0071976643 100644 --- a/docset/winserver2025-ps/ipamserver/Get-IpamDnsResourceRecord.md +++ b/docset/winserver2025-ps/ipamserver/Get-IpamDnsResourceRecord.md @@ -186,7 +186,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### +### IpamDnsResourceRecord + This cmdlet returns an instance of the **IpamDnsResourceRecord** object. ## NOTES @@ -198,4 +199,3 @@ This cmdlet returns an instance of the **IpamDnsResourceRecord** object. [Get-IpamDnsServer](./Get-IpamDnsServer.md) [Get-IpamDnsZone](./Get-IpamDnsZone.md) - diff --git a/docset/winserver2025-ps/ipamserver/Get-IpamDnsServer.md b/docset/winserver2025-ps/ipamserver/Get-IpamDnsServer.md index b991234bd9..3aa4717eb4 100644 --- a/docset/winserver2025-ps/ipamserver/Get-IpamDnsServer.md +++ b/docset/winserver2025-ps/ipamserver/Get-IpamDnsServer.md @@ -122,7 +122,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### +### IpamDnsServer + This cmdlet returns an instance of the **IpamDnsServer** object. ## NOTES @@ -134,4 +135,3 @@ This cmdlet returns an instance of the **IpamDnsServer** object. [Get-IpamDnsResourceRecord](./Get-IpamDnsResourceRecord.md) [Get-IpamDnsZone](./Get-IpamDnsZone.md) - diff --git a/docset/winserver2025-ps/ipamserver/Get-IpamDnsZone.md b/docset/winserver2025-ps/ipamserver/Get-IpamDnsZone.md index 7e5c1ff7c8..300a891967 100644 --- a/docset/winserver2025-ps/ipamserver/Get-IpamDnsZone.md +++ b/docset/winserver2025-ps/ipamserver/Get-IpamDnsZone.md @@ -154,7 +154,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### +### IpamDnsZone + This cmdlet returns an instance of the **IpamDnsZone** object. ## NOTES @@ -166,4 +167,3 @@ This cmdlet returns an instance of the **IpamDnsZone** object. [Get-IpamDnsResourceRecord](./Get-IpamDnsResourceRecord.md) [Get-IpamDnsServer](./Get-IpamDnsServer.md) - diff --git a/docset/winserver2025-ps/nfs/Set-NfsNetgroupStore.md b/docset/winserver2025-ps/nfs/Set-NfsNetgroupStore.md index 6ad016f708..701c54b7b6 100644 --- a/docset/winserver2025-ps/nfs/Set-NfsNetgroupStore.md +++ b/docset/winserver2025-ps/nfs/Set-NfsNetgroupStore.md @@ -255,7 +255,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/NFS/MSFT_NfsNetgroupStore + Specifies the input to this cmdlet. You can use this parameter, or you can pipe the input to this cmdlet. @@ -272,4 +273,3 @@ You can use this parameter, or you can pipe the input to this cmdlet. [Get-NfsNetgroupStore](./Get-NfsNetgroupStore.md) [Set-NfsMappingStore](./Set-NfsMappingStore.md) - diff --git a/docset/winserver2025-ps/shieldedvmcmdlets/Initialize-ShieldedVM.md b/docset/winserver2025-ps/shieldedvmcmdlets/Initialize-ShieldedVM.md index d12f7c0c6f..3c8431bc8e 100644 --- a/docset/winserver2025-ps/shieldedvmcmdlets/Initialize-ShieldedVM.md +++ b/docset/winserver2025-ps/shieldedvmcmdlets/Initialize-ShieldedVM.md @@ -115,7 +115,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### +### CimInstance + This cmdlet returns a CimInstance object that represents the provisioning job for the shielded virtual machine. ## NOTES @@ -129,4 +130,3 @@ This cmdlet returns a CimInstance object that represents the provisioning job fo [New-ShieldedVMSpecializationDataFile](./New-ShieldedVMSpecializationDataFile.md) [Test-ShieldingDataApplicability](./Test-ShieldingDataApplicability.md) - diff --git a/docset/winserver2025-ps/smbshare/Get-SmbBandwidthLimit.md b/docset/winserver2025-ps/smbshare/Get-SmbBandwidthLimit.md index 80da190684..b450bc6852 100644 --- a/docset/winserver2025-ps/smbshare/Get-SmbBandwidthLimit.md +++ b/docset/winserver2025-ps/smbshare/Get-SmbBandwidthLimit.md @@ -97,7 +97,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, 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 @@ -126,7 +126,7 @@ For more information, type `Get-Help Install-WindowsFeature`. When you enable th ## RELATED LINKS -[Install-WindowsFeature](../Microsoft.Windows.ServerManager.Migration/Install-WindowsFeature.md) +[Install-WindowsFeature](xref:Microsoft.Windows.ServerManager.Migration.Install-WindowsFeature) [Set-SmbBandwidthLimit](./Set-SmbBandwidthLimit.md) diff --git a/docset/winserver2025-ps/smbshare/Remove-SmbBandwidthLimit.md b/docset/winserver2025-ps/smbshare/Remove-SmbBandwidthLimit.md index 3d60463550..e126c096f6 100644 --- a/docset/winserver2025-ps/smbshare/Remove-SmbBandwidthLimit.md +++ b/docset/winserver2025-ps/smbshare/Remove-SmbBandwidthLimit.md @@ -136,7 +136,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, 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 @@ -165,9 +165,8 @@ For more information, type `Get-Help Install-WindowsFeature`. When you enable th ## RELATED LINKS -[Install-WindowsFeature](../Microsoft.Windows.ServerManager.Migration/Install-WindowsFeature.md) +[Install-WindowsFeature](xref:Microsoft.Windows.ServerManager.Migration.Install-WindowsFeature) [Get-SmbBandwidthLimit](./Get-SmbBandwidthLimit.md) [Set-SmbBandwidthLimit](./Set-SmbBandwidthLimit.md) - diff --git a/docset/winserver2025-ps/storage/Get-FileIntegrity.md b/docset/winserver2025-ps/storage/Get-FileIntegrity.md index 1f538cc8b7..70bae3781e 100644 --- a/docset/winserver2025-ps/storage/Get-FileIntegrity.md +++ b/docset/winserver2025-ps/storage/Get-FileIntegrity.md @@ -129,18 +129,20 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -**System.IO.FileInfo**. +### System.IO.FileInfo + To obtain a **FileInfo** object, use the [Get-Item](https://go.microsoft.com/fwlink/?LinkID=290495) cmdlet for a specified file name. The cmdlet uses the **FullName** property as the value of the *FileName* parameter. -**System.IO.DirectoryInfo**. +### System.IO.DirectoryInfo + To obtain a **DirectoryInfo** object, use **Get-Item** for a specified directory name. The cmdlet uses the **FullName** property as the value of the *FileName* parameter. ## OUTPUTS ### MSFT_FileIntegrity + This cmdlet generates an **MSFT_FileIntegrity** object. ## NOTES diff --git a/docset/winserver2025-ps/storage/Optimize-Volume.md b/docset/winserver2025-ps/storage/Optimize-Volume.md index 7c0aeab5ef..dd9b9f3ed3 100644 --- a/docset/winserver2025-ps/storage/Optimize-Volume.md +++ b/docset/winserver2025-ps/storage/Optimize-Volume.md @@ -356,16 +356,18 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Storage/MSFT_Volume + You can use the pipeline operator to pass a Volume object to the *InputObject* parameter. ## OUTPUTS -### -This cmdlet does not generate output. +### None + +By default, this cmdlet doesn't return any output. ## NOTES -* When used in Failover Cluster, cmdlets from the Storage module operate on cluster level (all servers in the cluster). +- When used in Failover Cluster, cmdlets from the Storage module operate on cluster level (all servers in the cluster). ## RELATED LINKS @@ -376,4 +378,3 @@ This cmdlet does not generate output. [Repair-Volume](./Repair-Volume.md) [Set-Volume](./Set-Volume.md) - diff --git a/docset/winserver2025-ps/storage/Remove-PhysicalDisk.md b/docset/winserver2025-ps/storage/Remove-PhysicalDisk.md index 95d983bd88..644dc2be1e 100644 --- a/docset/winserver2025-ps/storage/Remove-PhysicalDisk.md +++ b/docset/winserver2025-ps/storage/Remove-PhysicalDisk.md @@ -308,18 +308,22 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Storage/MSFT_PhysicalDisks + You can use the pipeline operator to pass an array of MSFT_PhysicalDisk objects to the *PhysicalDisks* parameter ### Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Storage/MSFT_StoragePool + You can use the pipeline operator to pass an MSFT_StoragePool object to the *StoragePool* parameter. ### Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Storage/MSFT_VirtualDisk + You can use the pipeline operator to pass an MSFT_VirtualDisk object to the *VirtualDisk* parameter. ## OUTPUTS -### -This cmdlet does not generate output. +### None + +By default, this cmdlet doesn't return any output. ## NOTES @@ -338,4 +342,3 @@ This cmdlet does not generate output. [Get-StoragePool](./Get-StoragePool.md) [Get-VirtualDisk](./Get-VirtualDisk.md) - diff --git a/docset/winserver2025-ps/storage/Set-FileStorageTier.md b/docset/winserver2025-ps/storage/Set-FileStorageTier.md index f1263889f1..7fff12155d 100644 --- a/docset/winserver2025-ps/storage/Set-FileStorageTier.md +++ b/docset/winserver2025-ps/storage/Set-FileStorageTier.md @@ -213,12 +213,14 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Storage/MSFT_StorageTier + You can use the pipeline operator to pass an MSFT_StorageTier object to the *DesiredStorageTier* parameter. ## OUTPUTS -### -This cmdlet does not generate any output. +### None + +By default, this cmdlet doesn't return any output. ## NOTES @@ -231,4 +233,3 @@ This cmdlet does not generate any output. [Get-FileStorageTier](./Get-FileStorageTier.md) [Get-StorageTier](./Get-StorageTier.md) - diff --git a/docset/winserver2025-ps/syncshare/Set-SyncServerSetting.md b/docset/winserver2025-ps/syncshare/Set-SyncServerSetting.md index 0fcdc0f012..2d3a9f7a4c 100644 --- a/docset/winserver2025-ps/syncshare/Set-SyncServerSetting.md +++ b/docset/winserver2025-ps/syncshare/Set-SyncServerSetting.md @@ -241,7 +241,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### +### SyncServerSetting This cmdlet returns an object that changes the synchronization configuration on the local server. ## NOTES @@ -249,4 +249,3 @@ This cmdlet returns an object that changes the synchronization configuration on ## RELATED LINKS [Get-SyncServerSetting](./Get-SyncServerSetting.md) - diff --git a/docset/winserver2025-ps/windowssearch/Get-WindowsSearchSetting.md b/docset/winserver2025-ps/windowssearch/Get-WindowsSearchSetting.md index 9fc91fabe8..18c6237491 100644 --- a/docset/winserver2025-ps/windowssearch/Get-WindowsSearchSetting.md +++ b/docset/winserver2025-ps/windowssearch/Get-WindowsSearchSetting.md @@ -44,8 +44,9 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### -**WindowsSearchSetting**Returns the values of properties that control Windows Search: +### WindowsSearchSetting + +Returns the values of properties that control Windows Search: - EnableMeteredWebResultsSetting. Whether Windows Search displays web results and suggestions while using a metered network. @@ -56,7 +57,9 @@ The experience setting. - WindowsSafeSearchSetting. The value of SafeSearch that Windows Search uses for queries. -**SearchExperienceSetting** has the following possible values: +### SearchExperienceSetting + +Has the following possible values: - PersonalizedAndLocation. Personalize Windows Search and other Microsoft experiences by using search history, some Microsoft account information, and specific location of the user. @@ -65,7 +68,9 @@ Personalize Windows Search and other Microsoft experiences by using search histo - NotPersonalized. Do not personalize Windows Search and other Microsoft experiences or use specific location of the user. -**WindowsSafeSearchSetting** has the following possible values: +### WindowsSafeSearchSetting + +Has the following possible values: - Off. Windows Search does not remove adult content from results. @@ -79,4 +84,3 @@ Windows Search excludes adult images, videos, and text from results. ## RELATED LINKS [Set-WindowsSearchSetting](./Set-WindowsSearchSetting.md) -