Skip to main content

Get-PEndpoint

SYNOPSIS​

SYNTAX​

List (Default)​

Get-PEndpoint [-Session <PortainerSession>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
Get-PEndpoint [-SearchString <String>] [-Session <PortainerSession>] [-ProgressAction <ActionPreference>]
 [<CommonParameters>]

Id​

Get-PEndpoint [-Id <Int32>] [-Session <PortainerSession>] [-ProgressAction <ActionPreference>]
 [<CommonParameters>]

DESCRIPTION​

Retreives available endpoints

EXAMPLES​

EXAMPLE 1​

Get-PEndpoint -SearchString 'local'

Retreives all endpoints containing the word local

PARAMETERS​

-SearchString​

Defines a searchstring to use for filtering endpoints

Type: String
Parameter Sets: Search
Aliases:

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

-Id​

Defines the Id of the endpoint to retreive.

Type: Int32
Parameter Sets: Id
Aliases:

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

-Session​

Optionally define a portainer session object to use. This is useful when you are connected to more than one portainer instance.

-Session $Session

Type: PortainerSession
Parameter Sets: (All)
Aliases:

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

-ProgressAction​

{{ Fill ProgressAction Description }}

Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

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

EDIT THIS DOC​

This page was auto-generated from the powershell command comment based help. To edit the content of this page, update the script file comment based help on github Github