|
| 1 | +--- |
| 2 | +external help file: Microsoft.Rtc.Management.dll-help.xml |
| 3 | +applicable: Skype for Business Server 2019 |
| 4 | +title: Get-CsUpgradeDomainInfo |
| 5 | +schema: 2.0.0 |
| 6 | +manager: rogupta |
| 7 | +author: hirenshah1 |
| 8 | +ms.author: hirshah |
| 9 | +ms.reviewer: |
| 10 | +--- |
| 11 | + |
| 12 | +# Get-CsUpgradeDomainInfo |
| 13 | + |
| 14 | +## SYNOPSIS |
| 15 | +Returns information indicating whether or not your Skype for Business Server Registrar pools are ready to be upgraded. |
| 16 | +The upgrade readiness state for a pool is based on the upgrade domains that have been configured for that pool. |
| 17 | + |
| 18 | +## SYNTAX |
| 19 | + |
| 20 | +``` |
| 21 | +Get-CsUpgradeDomainInfo [-Force] [-QueryTimeout <Int32>] [-WhatIf] [-Confirm] [<CommonParameters>] |
| 22 | +``` |
| 23 | + |
| 24 | +## DESCRIPTION |
| 25 | +The Get-CsUpgradeDomainInfo cmdlet returns information about the upgrade readiness for a Skype for Business Server pool. |
| 26 | +The returned information includes the number of Front End servers assigned to the pool; the number of currently active Front End servers; the name of the upgrade domain; and a True/False value that indicates whether the current state of the pool allows it to be upgraded. |
| 27 | +Note that this cmdlet must be run locally on a Front End server in the pool being checked. |
| 28 | +There are no options enabling you to run the Get-CsUpgradeDomainInfo cmdlet remotely. |
| 29 | + |
| 30 | +The functions carried out by the Get-CsUpgradeDomainInfo cmdlet are not available in the Skype for Business Server Control Panel. |
| 31 | + |
| 32 | +## EXAMPLES |
| 33 | + |
| 34 | +### -------------------------- Example 1 -------------------------- |
| 35 | +``` |
| 36 | +Get-CsUpgradeDomainInfo |
| 37 | +``` |
| 38 | + |
| 39 | +The command shown in Example 1 returns the upgrade readiness state for the local Registrar pool. |
| 40 | +Note that this command must be executed on a Front End server located within the pool. |
| 41 | + |
| 42 | +## PARAMETERS |
| 43 | + |
| 44 | +### -Confirm |
| 45 | +Prompts you for confirmation before executing the command. |
| 46 | + |
| 47 | +```yaml |
| 48 | +Type: SwitchParameter |
| 49 | +Parameter Sets: (All) |
| 50 | +Aliases: cf |
| 51 | +Applicable: Skype for Business Server 2019 |
| 52 | + |
| 53 | +Required: False |
| 54 | +Position: Named |
| 55 | +Default value: None |
| 56 | +Accept pipeline input: False |
| 57 | +Accept wildcard characters: False |
| 58 | +``` |
| 59 | +
|
| 60 | +### -Force |
| 61 | +Suppresses the display of any non-fatal error message that might occur when running the command. |
| 62 | +
|
| 63 | +```yaml |
| 64 | +Type: SwitchParameter |
| 65 | +Parameter Sets: (All) |
| 66 | +Aliases: |
| 67 | +Applicable: Skype for Business Server 2019 |
| 68 | + |
| 69 | +Required: False |
| 70 | +Position: Named |
| 71 | +Default value: None |
| 72 | +Accept pipeline input: False |
| 73 | +Accept wildcard characters: False |
| 74 | +``` |
| 75 | +
|
| 76 | +### -WhatIf |
| 77 | +Describes what would happen if you executed the command without actually executing the command. |
| 78 | +
|
| 79 | +```yaml |
| 80 | +Type: SwitchParameter |
| 81 | +Parameter Sets: (All) |
| 82 | +Aliases: wi |
| 83 | +Applicable: Skype for Business Server 2019 |
| 84 | + |
| 85 | +Required: False |
| 86 | +Position: Named |
| 87 | +Default value: None |
| 88 | +Accept pipeline input: False |
| 89 | +Accept wildcard characters: False |
| 90 | +``` |
| 91 | +
|
| 92 | +### -QueryTimeout |
| 93 | +Query timeout period in minutes to retrieve the state of fabric services. |
| 94 | +
|
| 95 | +```yaml |
| 96 | +Type: SwitchParameter |
| 97 | +Parameter Sets: (All) |
| 98 | +Aliases: |
| 99 | +Applicable: Skype for Business Server 2019 |
| 100 | + |
| 101 | +Required: False |
| 102 | +Position: Named |
| 103 | +Default value: None |
| 104 | +Accept pipeline input: False |
| 105 | +Accept wildcard characters: False |
| 106 | +``` |
| 107 | +
|
| 108 | +### CommonParameters |
| 109 | +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216). |
| 110 | +
|
| 111 | +
|
| 112 | +## INPUTS |
| 113 | +
|
| 114 | +### None |
| 115 | +
|
| 116 | +
|
| 117 | +## OUTPUTS |
| 118 | +
|
| 119 | +### Microsoft.Rtc.Management.Hadr.PoolUpgradeState |
| 120 | +
|
| 121 | +
|
| 122 | +## NOTES |
| 123 | +
|
| 124 | +
|
| 125 | +## RELATED LINKS |
| 126 | +
|
0 commit comments