Skip to main content

Resize-PContainerTTY

SYNOPSIS

SYNTAX

Resize-PContainerTTY [[-Endpoint] <String>] [[-Id] <Object[]>] [[-Session] <PortainerSession>]
[[-Height] <Int32>] [[-Width] <Int32>] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Resizes the TTY for a container

EXAMPLES

EXAMPLE 1

Resize-PContainerTTY

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: 1
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: (All)
Aliases:

Required: False
Position: 2
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: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Height

Defines the height of the TTY session

Type: Int32
Parameter Sets: (All)
Aliases:

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

-Width

Defines the width of the TTY session

Type: Int32
Parameter Sets: (All)
Aliases:

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

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

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

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

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