Get-BucketStats
This PowerShell cmdlet enables the user to retrieve and display bucket distribution and status information for the specified cache.
Get-BucketStats -CacheName [-Server] [-BucketID] [-Detailed] [-ShowOnlyUnderStateTransfer] [-NoLogo] [-Credentials]
Examples
- This command retrieves bucket statistics from demoCache.
Get-BucketStats -CacheName demoCache
- This command gets the bucket statistics from the demoCache nodes running on 20.200.20.11.
Get-BucketStats -CacheName demoCache -Server 20.200.20.11
- This command gets the bucket statistics for the bucket with ID 541.
Get-BucketStats -CacheName demoCache -BucketID 541
- This command gets detailed information regarding the buckets.
Get-BucketStats -CacheName demoCache -Detailed
- This command gets only the bucket statistics that are in state transfer.
Get-BucketStats -CacheName demoCache -ShowOnlyUnderStateTransfer
- This command retrieves bucket statistics from demoCache, using security credentials.
Get-BucketStats -CacheName demoCache -Credentials(Get-Credential john_smith)
Properties
Note
The parameters with asterisk (*) on their names are the required parameters and the rest are optional.
| Parameters |
Data Types |
Description |
Default Value |
-CacheName* |
<String> |
Specifies the name of the cache for which the bucket statistics will be fetched. Note: The cache must already exist on the source server. |
- |
-Server |
<String> |
Specifies a server name where the NCache Service is running and a cache with the specified cache-name is registered. |
IP of local machine |
-BucketID |
<String> |
Specifies a specific bucket ID or range of bucket IDs to fetch. |
|
-Detailed |
<SwitchParameter> |
Displays additional details for each bucket, such as ownership, transfer state, and data distribution information. |
False |
-ShowOnlyUnderStateTransfer |
<SwitchParameter> |
Displays only those buckets that are currently under state transfer between nodes. |
False |
-Credentials |
<pscredential> |
Specifies the user credentials required to authorize access for the specified operation. These credentials should belong to a user with the appropriate permissions at the node. |
- |
-NoLogo |
<SwitchParameter> |
Suppresses display of the logo banner. |
False |
get-bucketstats -cachename [-server] [-bucketid] [-detailed] [-showonlyunderstatetransfer] [-nologo] [-userid] [-password]
Examples
- This command retrieves bucket statistics from demoCache.
get-bucketstats -cachename demoCache
- This command gets the bucket statistics from the demoCache nodes running on 20.200.20.11.
get-bucketstats -cachename demoCache -server 20.200.20.11
- This command gets the bucket statistics for the bucket with ID 541.
get-bucketstats -cachename demoCache -bucketid 541
- This command gets detailed information regarding the buckets.
get-bucketstats -cachename demoCache -detailed
- This command gets only the bucket statistics that are in state transfer.
get-bucketstats -cachename demoCache -showonlyunderstatetransfer
- This command retrieves bucket statistics from demoCache, using security credentials.
get-bucketstats -cachename demoCache -userid john_smith -password pass123
Properties
Note
The parameters with asterisk (*) on their names are the required parameters and the rest are optional.
| Parameters |
Data Types |
Description |
Default Value |
-cachename* |
<String> |
Specifies the name of the cache for which the bucket statistics will be fetched. Note: The cache must already exist on the source server. |
- |
-server |
<String> |
Specifies a server name where the NCache Service is running and a cache with the specified cache-name is registered. |
IP of local machine |
-bucketid |
<String> |
Specifies a specific bucket ID or range of bucket IDs to fetch. |
|
-detailed |
<SwitchParameter> |
Displays additional details for each bucket, such as ownership, transfer state, and data distribution information. |
False |
-showonlyunderstatetransfer |
<SwitchParameter> |
Displays only those buckets that are currently under state transfer between nodes. |
False |
-userid |
<String> |
Specifies the user id used to authorize the user for this operation. It is required in case security is enabled on Cache Server. This user id must be the active directory user id. |
- |
-password |
<String> |
Specifies the password of the user that is used to authorize the user for this operation. It is required in case security is enabled on Cache Server. This password must be the same as the active directory user password. |
- |
-nologo |
<SwitchParameter> |
Suppresses display of the logo banner. |
False |