psdocker

Powershell Cmdlets that wrap the docker client and support the interaction with containers

View the Project on GitHub abbgrade/psdocker

Remove-DockerContainer

SYNOPSIS

Remove container

SYNTAX

Remove-DockerContainer [-Name] <String> [-Force] [[-Timeout] <Int32>] [[-StopTimeout] <Int32>]
 [-ProgressAction <ActionPreference>] [<CommonParameters>]

DESCRIPTION

Removes a docker container from the service. Wraps the command `docker rm`.

EXAMPLES

EXAMPLE 1

New-DockerContainer -Image 'microsoft/nanoserver' -Name 'mycontainer' | Out-Null
PS C:\> Remove-DockerContainer -Name 'mycontainer'

EXAMPLE 2

$container = New-DockerContainer -Image 'microsoft/nanoserver'
PS C:\> $container | Remove-DockerContainer

PARAMETERS

-Name

Specifies the name of the container that should be removed.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Force

Specifies if the container should be stopped before removal.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-Timeout

Specifies the number of seconds to wait for the command to finish.

Type: Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: 2
Default value: 10
Accept pipeline input: False
Accept wildcard characters: False

-StopTimeout

Specifies the timeout of the Docker client command for the stop operation.

Type: Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: 3
Default value: 10
Accept pipeline input: False
Accept wildcard characters: False

-ProgressAction

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

https://docs.docker.com/engine/reference/commandline/rm/