Get-CsPoolFabricState
Returns the Windows Fabric state for a Skype for Business Server pool. Windows Fabric is a Microsoft technology used for creating highly reliable, distributable, and scalable applications. This cmdlet was introduced in Lync Server 2013.
Syntax
RoutingGroup
Get-CsPoolFabricState
[-RoutingGroup] <String>
[-ReplicaBuildProgress]
[-Force]
[-MinutesToPoll <Int32>]
[-PollInterval <Int32>]
[-ReplicaBuildProgressTimeout <Int32>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Tenant
Get-CsPoolFabricState
[-Tenant] <Guid>
[-Force]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
User
Get-CsPoolFabricState
[-UserUri] <UserIdParameter>
[-Force]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
PoolFqdn
Get-CsPoolFabricState
-PoolFqdn <String>
[-HealthState <String>]
[-ShowAll]
[-OutputCsvFile <String>]
[-ServiceName <String>]
[-Force]
[-Type <String>]
[-QueryTimeout <Int32>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The Get-CsPoolFabricState cmdlet returns the Windows Fabric state for a Skype for Business Server pool. This includes information about Windows Fabric replica instances for any (or all) of the following services: MCU factory; Conference Directory; Routing; Skype for Business Server Storage Service.
The functions carried out by the Get-CsPoolFabricState cmdlet are not available in Skype for Business Server Control Panel.
Examples
Example 1
Get-CsPoolFabricState -PoolFqdn "atl-cs-001.litwareinc.com"
The command shown in Example 1 returns the fabric state for the pool atl-cs-001.litwareinc.com. Because the Type parameter was not included, state information for all the services on the pool will be returned.
Example 2
Get-CsPoolFabricState -PoolFqdn "atl-cs-001.litwareinc.com" -Type MCU
Example 2 returns the fabric state for a single service on the pool atl-cs-001.litwareinc.com: the MCU factory service. This is done by including the Type parameter and the parameter value "MCU".
Parameters
-Confirm
Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019
Prompts you for confirmation before executing the command.
Parameter properties
| Type: | System.Management.Automation.SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | cf |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Force
Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019
Suppresses the display of any non-fatal error message that might occur when running the command.
Parameter properties
| Type: | System.Management.Automation.SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-HealthState
Applicable: Skype for Business Server 2015, Skype for Business Server 2019
PARAMVALUE: String
Parameter properties
| Type: | System.String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
PoolFqdn
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-MinutesToPoll
Max number of minutes for which the cmdlet will poll cluster manager for replica build progress
Parameter properties
| Type: | System.Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
RoutingGroup
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-OutputCsvFile
Applicable: Skype for Business Server 2015, Skype for Business Server 2019
PARAMVALUE: String
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
PoolFqdn
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-PollInterval
Interval in seconds between cluster manager polls for replica build progress
Parameter properties
| Type: | System.Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
RoutingGroup
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-PoolFqdn
Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019
Fully qualified domain name of the pool being checked. You must supply the FQDN of a pool when calling this cmdlet; for example:
-PoolFqdn "atl-cs-001.litwareinc.com"
Parameter properties
| Type: | System.String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
PoolFqdn
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-QueryTimeout
Query timeout period in minutes to retrieve the state of fabric services.
Parameter properties
| Type: | System.Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
PoolFqdn
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ReplicaBuildProgress
If a replica is being built for the given RG, polls for the status of the build
Parameter properties
| Type: | System.Management.Automation.SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
RoutingGroup
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ReplicaBuildProgressTimeout
The number of seconds for which no replica build progress has been made before considering progress to be stuck
Parameter properties
| Type: | System.Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
RoutingGroup
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-RoutingGroup
Applicable: Skype for Business Server 2015, Skype for Business Server 2019
Globally unique identifier (GUID) of the Windows Fabric routing group to be returned. Routing groups are used to specify the servers that users log onto.
Parameter properties
| Type: | System.String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
RoutingGroup
| Position: | 1 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ServiceName
Applicable: Skype for Business Server 2015, Skype for Business Server 2019
PARAMVALUE: String
Parameter properties
| Type: | System.String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
PoolFqdn
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ShowAll
Applicable: Skype for Business Server 2015, Skype for Business Server 2019
PARAMVALUE: SwitchParameter
Parameter properties
| Type: | System.Management.Automation.SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
PoolFqdn
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Tenant
Applicable: Skype for Business Server 2015, Skype for Business Server 2019
Globally unique identifier (GUID) of the Skype for Business Online tenant account whose Windows Fabric pool state is being returned. For example:
-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"
You can return the tenant ID for each of your Skype for Business Online tenants by running this command:
Get-CsTenant | Select-Object DisplayName, TenantID
Parameter properties
| Type: | System.Guid |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
Tenant
| Position: | 1 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Type
Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019
Specifies the service type to be returned. Allowed values are:
- All (returns information for all services)
- MCUFactory (returns information for the MCU factory service)
- ConferenceDirectory (returns information for the Conference Directory service)
LYSS (returns information for the Lync Server Storage service)
You can only specify a single type per command.
Parameter properties
| Type: | System.String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
PoolFqdn
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-UserUri
Applicable: Skype for Business Server 2015, Skype for Business Server 2019
Enables you to check the Windows fabric state for the pool used by a specific user. For example, to check the Windows fabric state for the user Ken Myer use this syntax:
-UserUri "sip:kenmyer@litwareinc.com"
Note that you can only specify one user URI per command.
Parameter properties
| Type: | Microsoft.Rtc.Management.AD.UserIdParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
User
| Position: | 1 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-WhatIf
Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019
Describes what would happen if you executed the command without actually executing the command.
Parameter properties
| Type: | System.Management.Automation.SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | wi |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Inputs
None
Outputs
String
String value representing the fabric state.