< Back
Add-AcmCluster
Post
NAME Add-AcmCluster
SYNOPSIS
Add an Azure cluster of VMs/VM scale sets to ACM.
SYNTAX
Add-AcmCluster [-SubscriptionId] <String> [-ResourceGroup] <String> [-AcmResourceGroup] <String> [[-Timeout]
<Int32>] [-RetainJobs] [-Return] [[-LinuxExtensionUrl] <String>] [[-WindowsExtensionUrl] <String>]
[<CommonParameters>]
DESCRIPTION
PARAMETERS
-SubscriptionId <String>
The ID of an Azure subscription containing both the ResourceGroup and AcmResourceGroup.
Required? true
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ResourceGroup <String>
The name of an Azure resource group containing the VMs/VM scale sets to test.
Required? true
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false
-AcmResourceGroup <String>
The name of an Azure resource group containing the ACM service.
Required? true
Position? 3
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Timeout <Int32>
The timeout value for adding cluster to Acm. By default, an estimated value will be set based on the number of
VMs/VM scale sets in a cluster. A value shorter than necesssary will fail the setup procedure. You could
specify a larger value to ensure the success of setup.
Required? false
Position? 4
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-RetainJobs [<SwitchParameter>]
Do not remove PowerShell jobs after. This is for checking the job state for debug purpose.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-Return [<SwitchParameter>]
Return the result. By default, the function returns nothing.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-LinuxExtensionUrl <String>
URL for the Linux VM Extension. The file name in the URL must match pattern "^.+\\-\\d+\\.\\d+\\.\\d+\\.\\d+\\.zip$".
This option is internal for development.
Required? false
Position? 5
Default value
Accept pipeline input? false
Accept wildcard characters? false
-WindowsExtensionUrl <String>
URL for the Windows VM Extension. The file name in the URL must match pattern "^.+\\-\\d+\\.\\d+\\.\\d+\\.\\d+\\.zip$".
This option is internal for development.
Required? false
Position? 6
Default value
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
NOTES
The command will log a lot to screen. So it's better to redirect them to files. Do it like
Add-AcmCluster ... 2>err_log 6>info_log
It writes errors to file err_log and other information to file info_log.
-------------------------- EXAMPLE 1 --------------------------
Add-AcmCluster -SubscriptionId a486e243-747b-42de-8c4c-379f8295a746 -ResourceGroup 'my-cluster-1'
-AcmResourceGroup 'my-acm-cluster' 2>err_log 6>info_log
Add a cluster of VMs/VM scale sets to ACM.
RELATED LINKS
CommonParameters : True
WorkflowCommonParameters : False
details : @{name=Add-AcmVm; noun=; verb=}
Syntax : @{syntaxItem=System.Object[]}
parameters : @{parameter=System.Object[]}
inputTypes : @{inputType=}
returnValues : @{returnValue=}
aliases : None
remarks : None
alertSet :
description :
examples :
Synopsis :
Add-AcmVm [-vm] <Object> [-storageAccountName] <string> [-storageAccountRG] <string>
[[-linuxExtensionUrl] <string>] [[-windowsExtensionUrl] <string>] [<CommonParameters>]
ModuleName : HPC.ACM
nonTerminatingErrors :
xmlns:command : http://schemas.microsoft.com/maml/dev/command/2004/10
xmlns:dev : http://schemas.microsoft.com/maml/dev/2004/10
xmlns:maml : http://schemas.microsoft.com/maml/2004/10
Name : Add-AcmVm
Category : Function
Component :
Role :
Functionality :
CommonParameters : True
WorkflowCommonParameters : False
details : @{name=Add-AcmVmScaleSet; noun=; verb=}
Syntax : @{syntaxItem=System.Object[]}
parameters : @{parameter=System.Object[]}
inputTypes : @{inputType=}
returnValues : @{returnValue=}
aliases : None
remarks : None
alertSet :
description :
examples :
Synopsis :
Add-AcmVmScaleSet [-vmss] <Object> [-storageAccountName] <string> [-storageAccountRG]
<string> [[-linuxExtensionUrl] <string>] [[-windowsExtensionUrl] <string>]
[<CommonParameters>]
ModuleName : HPC.ACM
nonTerminatingErrors :
xmlns:command : http://schemas.microsoft.com/maml/dev/command/2004/10
xmlns:dev : http://schemas.microsoft.com/maml/dev/2004/10
xmlns:maml : http://schemas.microsoft.com/maml/2004/10
Name : Add-AcmVmScaleSet
Category : Function
Component :
Role :
Functionality :
SYNOPSIS
Add an Azure cluster of VMs/VM scale sets to ACM.
SYNTAX
Add-AcmCluster [-SubscriptionId] <String> [-ResourceGroup] <String> [-AcmResourceGroup] <String> [[-Timeout]
<Int32>] [-RetainJobs] [-Return] [[-LinuxExtensionUrl] <String>] [[-WindowsExtensionUrl] <String>]
[<CommonParameters>]
DESCRIPTION
PARAMETERS
-SubscriptionId <String>
The ID of an Azure subscription containing both the ResourceGroup and AcmResourceGroup.
Required? true
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ResourceGroup <String>
The name of an Azure resource group containing the VMs/VM scale sets to test.
Required? true
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false
-AcmResourceGroup <String>
The name of an Azure resource group containing the ACM service.
Required? true
Position? 3
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Timeout <Int32>
The timeout value for adding cluster to Acm. By default, an estimated value will be set based on the number of
VMs/VM scale sets in a cluster. A value shorter than necesssary will fail the setup procedure. You could
specify a larger value to ensure the success of setup.
Required? false
Position? 4
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-RetainJobs [<SwitchParameter>]
Do not remove PowerShell jobs after. This is for checking the job state for debug purpose.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-Return [<SwitchParameter>]
Return the result. By default, the function returns nothing.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-LinuxExtensionUrl <String>
URL for the Linux VM Extension. The file name in the URL must match pattern "^.+\\-\\d+\\.\\d+\\.\\d+\\.\\d+\\.zip$".
This option is internal for development.
Required? false
Position? 5
Default value
Accept pipeline input? false
Accept wildcard characters? false
-WindowsExtensionUrl <String>
URL for the Windows VM Extension. The file name in the URL must match pattern "^.+\\-\\d+\\.\\d+\\.\\d+\\.\\d+\\.zip$".
This option is internal for development.
Required? false
Position? 6
Default value
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
NOTES
The command will log a lot to screen. So it's better to redirect them to files. Do it like
Add-AcmCluster ... 2>err_log 6>info_log
It writes errors to file err_log and other information to file info_log.
-------------------------- EXAMPLE 1 --------------------------
Add-AcmCluster -SubscriptionId a486e243-747b-42de-8c4c-379f8295a746 -ResourceGroup 'my-cluster-1'
-AcmResourceGroup 'my-acm-cluster' 2>err_log 6>info_log
Add a cluster of VMs/VM scale sets to ACM.
RELATED LINKS
CommonParameters : True
WorkflowCommonParameters : False
details : @{name=Add-AcmVm; noun=; verb=}
Syntax : @{syntaxItem=System.Object[]}
parameters : @{parameter=System.Object[]}
inputTypes : @{inputType=}
returnValues : @{returnValue=}
aliases : None
remarks : None
alertSet :
description :
examples :
Synopsis :
Add-AcmVm [-vm] <Object> [-storageAccountName] <string> [-storageAccountRG] <string>
[[-linuxExtensionUrl] <string>] [[-windowsExtensionUrl] <string>] [<CommonParameters>]
ModuleName : HPC.ACM
nonTerminatingErrors :
xmlns:command : http://schemas.microsoft.com/maml/dev/command/2004/10
xmlns:dev : http://schemas.microsoft.com/maml/dev/2004/10
xmlns:maml : http://schemas.microsoft.com/maml/2004/10
Name : Add-AcmVm
Category : Function
Component :
Role :
Functionality :
CommonParameters : True
WorkflowCommonParameters : False
details : @{name=Add-AcmVmScaleSet; noun=; verb=}
Syntax : @{syntaxItem=System.Object[]}
parameters : @{parameter=System.Object[]}
inputTypes : @{inputType=}
returnValues : @{returnValue=}
aliases : None
remarks : None
alertSet :
description :
examples :
Synopsis :
Add-AcmVmScaleSet [-vmss] <Object> [-storageAccountName] <string> [-storageAccountRG]
<string> [[-linuxExtensionUrl] <string>] [[-windowsExtensionUrl] <string>]
[<CommonParameters>]
ModuleName : HPC.ACM
nonTerminatingErrors :
xmlns:command : http://schemas.microsoft.com/maml/dev/command/2004/10
xmlns:dev : http://schemas.microsoft.com/maml/dev/2004/10
xmlns:maml : http://schemas.microsoft.com/maml/2004/10
Name : Add-AcmVmScaleSet
Category : Function
Component :
Role :
Functionality :