Start-VagrantEnvironment.md

external help file	Module Name	online version	schema
Vagrantey-help.xml	Vagrantey		2.0.0

Start-VagrantEnvironment

SYNOPSIS

Start a vagrant environment by specifying it's friendly name

SYNTAX

Environment

Start-VagrantEnvironment [-Environment] <String> [-Name <String>] [<CommonParameters>]

Id

Start-VagrantEnvironment -Id <String> [<CommonParameters>]

DESCRIPTION

Reads the backend path to a vagrant directory and starts that environment based on the environment's friendly name

EXAMPLES

EXAMPLE 1

Start-VagrantEnvironment -Environment CCM

Turn on all hosts defined in the CCM Vagrantfile

EXAMPLE 2

Start-VagrantEnvironment -Environment CCM -Name client

Only turn on the client defined in the CCM Vagrantfile

EXAMPLE 3

Start-VagrantEnvironment -Id a23459ef

Bring up specified vagrant ID

PARAMETERS

-Environment

The friendly name of the vagrant environment to start

Type: String
Parameter Sets: Environment
Aliases:

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

-Name

Name of host in Vagrantfile to bring online, if multiple are defined in Vagrantfile.

Type: String
Parameter Sets: Environment
Aliases:

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

-Id

Id of Vagrant environment to start, not tied to Environment parameter.

Type: String
Parameter Sets: Id
Aliases:

Required: True
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

RELATED LINKS