Invoke ADCGetCacheobject - j81blog/J81.ADCToolkit GitHub Wiki

Invoke-ADCGetCacheobject

SYNOPSIS

Get Integrated Caching configuration object(s).

SYNTAX

GetAll (Default)

Invoke-ADCGetCacheobject [-Filter <Hashtable>] [-GetAll] [-ViewSummary] [<CommonParameters>]

GetByArgument

Invoke-ADCGetCacheobject [-Url <String>] [-Locator <Double>] [-Httpstatus <Double>] [-Hostname <String>]
 [-Port <Int32>] [-Groupname <String>] [-Httpmethod <String>] [-Group <String>] [-Ignoremarkerobjects <String>]
 [-Includenotreadyobjects <String>] [-Nodeid <Double>] [-Filter <Hashtable>] [<CommonParameters>]

Count

Invoke-ADCGetCacheobject [-Count] [-Filter <Hashtable>] [<CommonParameters>]

DESCRIPTION

Configuration for cache object resource.

EXAMPLES

EXAMPLE 1

Invoke-ADCGetCacheobject

Get data.

EXAMPLE 2

Invoke-ADCGetCacheobject -GetAll

Get all cacheobject data.

EXAMPLE 3

Invoke-ADCGetCacheobject -Count

Get the number of cacheobject objects.

EXAMPLE 4

Invoke-ADCGetCacheobject -name <string>

Get cacheobject object by specifying for example the name.

EXAMPLE 5

Invoke-ADCGetCacheobject -Filter @{ 'name'='<value>' }

Get cacheobject data with a filter.

PARAMETERS

-Url

URL of the particular object whose details is required. Parameter "host" must be specified along with the URL.

Type: String
Parameter Sets: GetByArgument
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Locator

ID of the cached object.

Type: Double
Parameter Sets: GetByArgument
Aliases:

Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-Httpstatus

HTTP status of the object.

Type: Double
Parameter Sets: GetByArgument
Aliases:

Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-Hostname

Host name of the object. Parameter "url" must be specified. NOTE: The Nitro parameter 'host' cannot be used as a PowerShell parameter, therefore an alternative Parameter name was chosen.

Type: String
Parameter Sets: GetByArgument
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Port

Host port of the object. You must also set the Host parameter.

Type: Int32
Parameter Sets: GetByArgument
Aliases:

Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-Groupname

Name of the content group to which the object belongs. It will display only the objects belonging to the specified content group. You must also set the Host parameter.

Type: String
Parameter Sets: GetByArgument
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Httpmethod

HTTP request method that caused the object to be stored. Possible values = GET, POST

Type: String
Parameter Sets: GetByArgument
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Group

Name of the content group whose objects should be listed.

Type: String
Parameter Sets: GetByArgument
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Ignoremarkerobjects

Ignore marker objects. Marker objects are created when a response exceeds the maximum or minimum response size for the content group or has not yet received the minimum number of hits for the content group. Possible values = ON, OFF

Type: String
Parameter Sets: GetByArgument
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Includenotreadyobjects

Include responses that have not yet reached a minimum number of hits before being cached. Possible values = ON, OFF

Type: String
Parameter Sets: GetByArgument
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Nodeid

Unique number that identifies the cluster node.

Type: Double
Parameter Sets: GetByArgument
Aliases:

Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-Count

If specified, the count of the cacheobject object(s) will be returned.

Type: SwitchParameter
Parameter Sets: Count
Aliases:

Required: True
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-Filter

Specify a filter. -Filter @{ 'name'='<value>' }

Type: Hashtable
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: @{ }
Accept pipeline input: False
Accept wildcard characters: False

-GetAll

Retrieve all cacheobject object(s).

Type: SwitchParameter
Parameter Sets: GetAll
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-ViewSummary

When specified, only a summary of information is returned.

Type: SwitchParameter
Parameter Sets: GetAll
Aliases:

Required: False
Position: Named
Default value: False
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.

INPUTS

OUTPUTS

NOTES

File Name : Invoke-ADCGetCacheobject Version : v2111.2521 Author : John Billekens Reference : https://developer-docs.citrix.com/projects/citrix-adc-nitro-api-reference/en/latest/configuration/cache/cacheobject/ Requires : PowerShell v5.1 and up ADC 13.x and up. ADC 12 and lower may work, not guaranteed.

RELATED LINKS

https://blog.j81.nl

⚠️ **GitHub.com Fallback** ⚠️