Invoke ADCGetNsvariable - j81blog/J81.ADCToolkit GitHub Wiki

Invoke-ADCGetNsvariable

SYNOPSIS

Get NS configuration object(s).

SYNTAX

GetAll (Default)

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

GetByResource

Invoke-ADCGetNsvariable [-Name <String>] [-Filter <Hashtable>] [<CommonParameters>]

Count

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

Get

Invoke-ADCGetNsvariable [-Filter <Hashtable>] [-ViewSummary] [<CommonParameters>]

DESCRIPTION

Configuration for variable resource.

EXAMPLES

EXAMPLE 1

Invoke-ADCGetNsvariable

Get data.

EXAMPLE 2

Invoke-ADCGetNsvariable -GetAll

Get all nsvariable data.

EXAMPLE 3

Invoke-ADCGetNsvariable -Count

Get the number of nsvariable objects.

EXAMPLE 4

Invoke-ADCGetNsvariable -name <string>

Get nsvariable object by specifying for example the name.

EXAMPLE 5

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

Get nsvariable data with a filter.

PARAMETERS

-Name

Variable name. This follows the same syntax rules as other expression entity names: It must begin with an alpha character (A-Z or a-z) or an underscore (_). The rest of the characters must be alpha, numeric (0-9) or underscores. It cannot be re or xp (reserved for regular and XPath expressions). It cannot be an expression reserved word (e.g. SYS or HTTP). It cannot be used for an existing expression object (HTTP callout, patset, dataset, stringmap, or named expression).

Type: String
Parameter Sets: GetByResource
Aliases:

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

-Count

If specified, the count of the nsvariable 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 nsvariable 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, Get
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-ADCGetNsvariable Version : v2111.2521 Author : John Billekens Reference : https://developer-docs.citrix.com/projects/citrix-adc-nitro-api-reference/en/latest/configuration/ns/nsvariable/ 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** ⚠️