Get-Cache

Get-Cache

Lists all caches and regions in the cluster, and the cache host where each region resides. Without any parameters, all the cluster caches and their host-region details are returned. With Hostname and CachePort parameters provided, caches and region details are returned only for the specified host.

Syntax

Parameter Set: AllRegions
Get-Cache [[-HostName] <String> ] [[-CachePort] <Int32> ] [-MaxRegions <Int32> ] [ <CommonParameters>]

Parameters

-CachePort<Int32>

The cache port number of the cache host.

Aliases

none

Required?

false

Position?

2

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

-HostName<String>

The name of the cache host.

Aliases

none

Required?

false

Position?

1

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

-MaxRegions<Int32>

The maximum total regions to return. By default all regions are returned.

Aliases

none

Required?

false

Position?

named

Default Value

Int32.MaxValue

Accept Pipeline Input?

false

Accept Wildcard Characters?

-MaxRegionsPerCache<Int32>

Max regions to return for every cache. By default all regions are returned.

Aliases

none

Required?

false

Position?

named

Default Value

Int32.MaxValue

Accept Pipeline Input?

false

Accept Wildcard Characters?

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters

Outputs

The output type is the type of the objects that the cmdlet emits.

  • List<Microsoft.Data.Caching.AdminApi.CacheInfo>

Examples

New-Cache
Remove-Cache