Skip to main content

Get-PContainer

SYNOPSIS​

SYNTAX​

list (Default)​

Get-PContainer [-Endpoint <String>] [-Session <PortainerSession>] [-ProgressAction <ActionPreference>]
 [<CommonParameters>]

id​

Get-PContainer [-Endpoint <String>] [-Id <Object[]>] [-Session <PortainerSession>]
 [-ProgressAction <ActionPreference>] [<CommonParameters>]

DESCRIPTION​

Retreives docker containers from Portainer

EXAMPLES​

EXAMPLE 1​

Get-PContainer

Retreives all containers from the endpoint configured on the portainer session default docker endpoint setting.

EXAMPLE 2​

"

Retreives a single container object with the specified Id

EXAMPLE 3​

Get-PContainer -Endpoint 'prod'

Retreives all containers on the prod endpoint

EXAMPLE 4​

Get-PContainer -Session $Session

Retreives all containers on the portainer instance defined

PARAMETERS​

-Endpoint​

Defines the portainer endpoint to use when retreiving containers. If not specified the portainer sessions default docker endpoint value is used.

Use Get-PSession to see what endpoint is selected

Use Select-PEndpoint to change the default docker endpoint in the portainer session.

-Endpoint 'local'

Type: String
Parameter Sets: (All)
Aliases:

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

-Id​

Defines the id of the container to retreive.

-Id '<Id>'

Type: Object[]
Parameter Sets: id
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
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