Invoke ADCGetVxlan - j81blog/J81.ADCToolkit GitHub Wiki

Invoke-ADCGetVxlan

SYNOPSIS

Get Network configuration object(s).

SYNTAX

GetAll (Default)

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

GetByResource

Invoke-ADCGetVxlan [-Id <Double>] [-Filter <Hashtable>] [<CommonParameters>]

Count

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

Get

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

DESCRIPTION

Configuration for "VXLAN" resource.

EXAMPLES

EXAMPLE 1

Invoke-ADCGetVxlan

Get data.

EXAMPLE 2

Invoke-ADCGetVxlan -GetAll

Get all vxlan data.

EXAMPLE 3

Invoke-ADCGetVxlan -Count

Get the number of vxlan objects.

EXAMPLE 4

Invoke-ADCGetVxlan -name <string>

Get vxlan object by specifying for example the name.

EXAMPLE 5

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

Get vxlan data with a filter.

PARAMETERS

-Id

A positive integer, which is also called VXLAN Network Identifier (VNI), that uniquely identifies a VXLAN.

Type: Double
Parameter Sets: GetByResource
Aliases:

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

-Count

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