Get-LabMachineRoleDefinition
SYNOPSIS
Get a role definition
SYNTAX
Get-LabMachineRoleDefinition [-Role] <Roles> [[-Properties] <Hashtable>] [-Syntax] [<CommonParameters>]
DESCRIPTION
Gets a role definition to be used with the parameter Roles for a new virtual machine definition
EXAMPLES
Example 1
$role = Get-LabMachineRoleDefinition -Role FirstChildDC -Properties @{ ParentDomain = 'contoso.com'; NewDomain = 'child' }
Add-LabMachineDefinition -Name Host -Role $role
Gets a role definition for the first DC of a child domain with the additional properties ParentDomain = contoso.com and the child domain name NewDomain = child
Example 2
Get-LabMachineRoleDefinition -Role RootDc -Syntax
Returns all possible parameter for the specified role
PARAMETERS
-Properties
The properties for one role definition that can be set for the role, e.g. $role = Get-LabMachineRoleDefinition -Role FirstChildDC -Properties @{ ParentDomain = 'contoso.com'; NewDomain = 'child' }
Type: Hashtable
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Role
The role names
Type: Roles
Parameter Sets: (All)
Aliases:
Accepted values: RootDC, FirstChildDC, DC, ADDS, FileServer, WebServer, DHCP, Routing, CaRoot, CaSubordinate, SQLServer2008, SQLServer2008R2, SQLServer2012, SQLServer2014, SQLServer2016, VisualStudio2013, VisualStudio2015, SharePoint2013, SharePoint2016, Orchestrator2012, SQLServer2017, SQLServer, DSCPullServer, Office2013, Office2016, ADFS, ADFSWAP, ADFSProxy, FailoverStorage, FailoverNode, Tfs2015, Tfs2017, TfsBuildWorker, Tfs2018, HyperV, AzDevOps
Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Syntax
Indicates that Property-Syntax should be returned
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
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.