psdocker

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

View the Project on GitHub abbgrade/psdocker

Invoke-DockerCommand

SYNOPSIS

Invoke command

SYNTAX

Invoke-DockerCommand [-Name] <String> [-Command] <String> [[-ArgumentList] <String[]>] [[-Timeout] <Int32>]
 [-StringOutput] [-ProgressAction <ActionPreference>] [<CommonParameters>]

DESCRIPTION

Invokes a command on a docker container. Wraps the docker `exec` command.

EXAMPLES

EXAMPLE 1

$container = New-DockerContainer -Image 'microsoft/iis' -Detach
PS C:\> Invoke-DockerCommand -Name $container.Name -Command 'hostname' -StringOutput
88eb8fa9c07f

PARAMETERS

-Name

Specifies the name of the Docker container to run the command on.

Type: String
Parameter Sets: (All)
Aliases:

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

-Command

Specifies the command to run in the Docker container.

Type: String
Parameter Sets: (All)
Aliases:

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

-ArgumentList

Specifies the arguments to pass to the command.

Type: String[]
Parameter Sets: (All)
Aliases:

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

-StringOutput

Returns the container command output as a string.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

System.string: Returns a string if the parameter StringOutput is set.

NOTES

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