Invoke ADCGetSnmpoid - j81blog/J81.ADCToolkit GitHub Wiki

Invoke-ADCGetSnmpoid

SYNOPSIS

Get SNMP configuration object(s).

SYNTAX

GetAll (Default)

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

GetByArgument

Invoke-ADCGetSnmpoid [-Entitytype <String>] [-Name <String>] [-Filter <Hashtable>] [<CommonParameters>]

DESCRIPTION

Configuration for SNMP Object Identifier resource.

EXAMPLES

EXAMPLE 1

Invoke-ADCGetSnmpoid

Get data.

EXAMPLE 2

Invoke-ADCGetSnmpoid -GetAll

Get all snmpoid data.

EXAMPLE 3

Invoke-ADCGetSnmpoid -Count

Get the number of snmpoid objects.

EXAMPLE 4

Invoke-ADCGetSnmpoid -name <string>

Get snmpoid object by specifying for example the name.

EXAMPLE 5

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

Get snmpoid data with a filter.

PARAMETERS

-Entitytype

The type of entity whose SNMP OIDs you want to displayType of entity whose SNMP OIDs you want the Citrix ADC to display. Possible values = VSERVER, SERVICE, SERVICEGROUP

Type: String
Parameter Sets: GetByArgument
Aliases:

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

-Name

Name of the entity whose SNMP OID you want the Citrix ADC to display.

Type: String
Parameter Sets: GetByArgument
Aliases:

Required: False
Position: Named
Default value: None
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 snmpoid 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-ADCGetSnmpoid Version : v2111.2521 Author : John Billekens Reference : https://developer-docs.citrix.com/projects/citrix-adc-nitro-api-reference/en/latest/configuration/snmp/snmpoid/ 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** ⚠️