Invoke ADCGetSmppuser - j81blog/J81.ADCToolkit GitHub Wiki

Invoke-ADCGetSmppuser

SYNOPSIS

Get Smpp configuration object(s).

SYNTAX

GetAll (Default)

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

GetByResource

Invoke-ADCGetSmppuser [-Username <String>] [-Filter <Hashtable>] [<CommonParameters>]

Count

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

Get

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

DESCRIPTION

Configuration for SMPP user resource.

EXAMPLES

EXAMPLE 1

Invoke-ADCGetSmppuser

Get data.

EXAMPLE 2

Invoke-ADCGetSmppuser -GetAll

Get all smppuser data.

EXAMPLE 3

Invoke-ADCGetSmppuser -Count

Get the number of smppuser objects.

EXAMPLE 4

Invoke-ADCGetSmppuser -name <string>

Get smppuser object by specifying for example the name.

EXAMPLE 5

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

Get smppuser data with a filter.

PARAMETERS

-Username

Name of the SMPP user. Must be the same as the user name specified in the SMPP server.

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 smppuser 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 smppuser 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-ADCGetSmppuser Version : v2111.2521 Author : John Billekens Reference : https://developer-docs.citrix.com/projects/citrix-adc-nitro-api-reference/en/latest/configuration/smpp/smppuser/ 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** ⚠️