Get-CloudCacheProvider
Module: Microsoft.FSLogix
SYNOPSIS
Shows the state of the Cloud Cache providers (remote storage providers) that are associated with specific Cloud Cache disks.
SYNTAX
LocalPath (Default)
Get-CloudCacheProvider
[-LocalPath <String>]
[<CommonParameters>]
Disk
Get-CloudCacheProvider
[-Disks <System.Collections.Generic.List[Microsoft.FSLogix.CloudCache.File]>]
[<CommonParameters>]
Name
Get-CloudCacheProvider
[-Name <String>]
[<CommonParameters>]
UniqueId
Get-CloudCacheProvider
[-UniqueId <String>]
[<CommonParameters>]
DESCRIPTION
This cmdlet shows the properties for each Cloud Cache provider (remote storage provider). Each provider will have associated properties which help indicate the state of the provider as it is related to the user session.
Properties
| Property | Value | Description |
|---|---|---|
| AccessMode | ReadWrite | Cloud Cache can read and write to this providers disk. |
| NoAccess | Cloud Cache doesn't have access to the providers disk and would indicate a problem with the remote storage provider or another machine has holds the *.lock file. |
|
| ReadOnly | Cloud Cache can only read from this providers disk. | |
| Connected | True | The Cloud Cache service is connected to the remote storage provider. |
| False | The Cloud Cache service isn't connected to the remote storage provi |
|
| Exists | Yes | The Cloud Cache disk exists on the remote storage provider. |
| No | The Cloud Cache disk doesn't exist on the remote storage provider. | |
| Unknown | The state of the Cloud Cache disk is unknown. | |
| LastLockOperation | Shows the result of the last attempted I/O operation to the *.lock file on the remote storage provider. The *.lock file is how Cloud Cache determines the viability of the remote storage provider, and the frequency of this operation is every 60 seconds (default). A provider is considered not connected when one lock operation is unsuccessful. |
|
| LocalPath | [String] |
Displays the path of the registered Cloud Cache disk as seen by the Cloud Cache service and is by default located under %ProgramData%\FSLogix\Proxy. |
| RemotePath | [String] |
Displays the location to the Cloud Cache disks on the remote storage provider based on type. |
| Name | [String] |
Displays the value for the name of the remote storage provider as specified in the CCDLocations connection string. |
| Size | [UInt64] |
Size in bytes of the Cloud Cache disk. |
| State | Valid | The Cloud Cache disk on the remote storage provider is in sync with the local Cloud Cache disk. |
| Invalid | The local Cloud Cache disk is different than the remote provider and will be synced from a valid provider. | |
| Replicating | The Cloud Cache disk on the remote storage provider is replicating from a valid Cloud Cache disk (remote provider). | |
| WaitingForFileOpen | The Cloud Cache service is waiting to access the remote Cloud Cache disk pending the local Cloud Cache disk mount process. | |
| Unknown | The remote Cloud Cache disk is unavailable and can't determine its state. | |
| Type | Smb | Remote storage provider is an SMB file share. |
| AzureBlob | Remote storage provider is an Azure Blob. | |
| UniqueId | [Int32] |
A unique ID generated for each Cloud Cache disk during the sign in operation and used in all areas of FSLogix logs and events. |
| Uptime | [Timespan] |
The duration since the first successful lock operation. This value resets when the LastLockOperation fails and then succeeds. |
| WriteQueueLength | [Int32] |
This value shows the number of changes which are pending in the queue file for the specified remote storage provider. A value of 0 indicates the remote provider in sync with the local Cloud Cache disk. |
EXAMPLES
Example 1
PS C:\> Get-CloudCacheProvider
AccessMode : ReadWrite
Connected : True
Exists : Yes
LastLockOperation : Heartbeat succeeded ('35 ms')
LocalPath : C:\ProgramData\FSLogix\Proxy\jdoe_S-1-5-21-0000000000-568058721-0000000000-1110\Profile_jdoe.VHDX
RemotePath : \\my-smb-file-share\profiles\jdoe_S-1-5-21-0000000000-568058721-0000000000-1110\Profile_jdoe.VHDX
Name : MySMBFileShare
Size : 1735573504
State : Valid
Type : Smb
UniqueId : 7011300413686398469
Uptime : 01:29:29.3830000
WriteQueueLength : 0
AccessMode : ReadWrite
Connected : True
Exists : Yes
LastLockOperation : Heartbeat succeeded ('10 ms')
LocalPath : C:\ProgramData\FSLogix\Proxy\jdoe_S-1-5-21-0000000000-568058721-0000000000-1110\Profile_jdoe.VHDX
RemotePath : https://my-azure-blob.blob.core.windows.net/jdoe-s-1-5-21-0000000000-568058721-0000000000-1110/Profile_jdoe.VHDX
Name : MyAzureBlob
Size : 1735573504
State : Valid
Type : AzureBlob
UniqueId : 10107299548795657846
Uptime : 01:29:29.3940000
WriteQueueLength : 0
The cmdlet can be run with no parameters or input, and it returns every provider for every Cloud Cache user that is signed in.
Example 2
PS C:\> Get-CloudCacheDisk -Id 25 | Get-CloudCacheProvider
AccessMode : ReadWrite
Connected : True
Exists : Yes
LastLockOperation : Heartbeat succeeded ('35 ms')
LocalPath : C:\ProgramData\FSLogix\Proxy\jdoe_S-1-5-21-0000000000-568058721-0000000000-1110\Profile_jdoe.VHDX
RemotePath : \\my-smb-file-share\profiles\jdoe_S-1-5-21-0000000000-568058721-0000000000-1110\Profile_jdoe.VHDX
Name : MySMBFileShare
Size : 1735573504
State : Valid
Type : Smb
UniqueId : 7011300413686398469
Uptime : 01:29:29.3830000
WriteQueueLength : 0
AccessMode : ReadWrite
Connected : True
Exists : Yes
LastLockOperation : Heartbeat succeeded ('10 ms')
LocalPath : C:\ProgramData\FSLogix\Proxy\jdoe_S-1-5-21-0000000000-568058721-0000000000-1110\Profile_jdoe.VHDX
RemotePath : https://my-azure-blob.blob.core.windows.net/jdoe-s-1-5-21-0000000000-568058721-0000000000-1110/Profile_jdoe.VHDX
Name : MyAzureBlob
Size : 1735573504
State : Valid
Type : AzureBlob
UniqueId : 10107299548795657846
Uptime : 01:29:29.3940000
WriteQueueLength : 0
Uses the Get-CloudCacheDisk cmdlet to narrow the scope of the results from this cmdlet. This example gets the Cloud Cache disk with ID 25 and then pipe the object to this cmdlet for the results.
PARAMETERS
-Disks
The cloud cache disk (see 'Get-CloudCacheDisk')
| Item | Value |
|---|---|
| Type | <System.Collections.Generic.List[Microsoft.FSLogix.CloudCache.File]> |
| Parameter Sets | Disk |
| Aliases | |
| Required | False |
| Position | 0 |
| Default value | None |
| Accept pipeline input | True (ByValue) |
| Accept wildcard characters | False |
-LocalPath
The cloud cache disk local path (wildcards supported).
| Item | Value |
|---|---|
| Type | [String] |
| Parameter Sets | LocalPath |
| Aliases | |
| Required | False |
| Position | 0 |
| Default value | None |
| Accept pipeline input | True (ByValue) |
| Accept wildcard characters | False |
-Name
The cloud cache provider name (wildcards supported).
| Item | Value |
|---|---|
| Type | [String] |
| Parameter Sets | Name |
| Aliases | |
| Required | False |
| Position | Named |
| Default value | None |
| Accept pipeline input | False |
| Accept wildcard characters | False |
-UniqueId
The cloud cache provider unique identifier (wildcards supported).
| Item | Value |
|---|---|
| Type | [String] |
| Parameter Sets | UniqueId |
| 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.