< Back
Test-AcmCluster
Post
NAME Test-AcmCluster
SYNOPSIS
Test Azure cluster of VMs/VM scale sets in ACM.
SYNTAX
Test-AcmCluster [-ApiBasePoint] <String> [[-IssuerUrl] <String>] [[-ClientId] <String>] [[-ClientSecret] <String>]
[[-Timeout] <Int32>] [-Return] [<CommonParameters>]
DESCRIPTION
PARAMETERS
-ApiBasePoint <String>
The URL of ACM web service. The value can be found by the result of Get-AcmAppInfo.
Required? true
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-IssuerUrl <String>
The issuer URL of ACM web service, may be empty if the ACM web service is not protected by Azure AD. The value
can be found by the result of Get-AcmAppInfo.
Required? false
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ClientId <String>
The client id of ACM web service, may be empty if the ACM web service is not protected by Azure AD. The value
can be found by the result of Get-AcmAppInfo.
Required? false
Position? 3
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ClientSecret <String>
The client secret of ACM web service, may be empty if the ACM web service is not protected by Azure AD. The
value can be found by the result of Get-AcmAppInfo.
Required? false
Position? 4
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Timeout <Int32>
The timeout value for performing test on cluster. By default, an estimated value will be set based on the
number of nodes in a cluster. A value shorter than necesssary will cause no test result, since the test can't
complete without enough time. You could specify a larger value to ensure the test to complete.
Required? false
Position? 5
Default value 0
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
<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
Test-AcmCluster ... 2>err_log 6>info_log
It writes errors to file err_log and other information to file info_log.
-------------------------- EXAMPLE 1 --------------------------
$app = Get-AcmAppInfo -SubscriptionId 'my-id' -ResourceGroup 'my-group'; Test-AcmCluster @app 2>err_log 6>info_log
RELATED LINKS
SYNOPSIS
Test Azure cluster of VMs/VM scale sets in ACM.
SYNTAX
Test-AcmCluster [-ApiBasePoint] <String> [[-IssuerUrl] <String>] [[-ClientId] <String>] [[-ClientSecret] <String>]
[[-Timeout] <Int32>] [-Return] [<CommonParameters>]
DESCRIPTION
PARAMETERS
-ApiBasePoint <String>
The URL of ACM web service. The value can be found by the result of Get-AcmAppInfo.
Required? true
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-IssuerUrl <String>
The issuer URL of ACM web service, may be empty if the ACM web service is not protected by Azure AD. The value
can be found by the result of Get-AcmAppInfo.
Required? false
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ClientId <String>
The client id of ACM web service, may be empty if the ACM web service is not protected by Azure AD. The value
can be found by the result of Get-AcmAppInfo.
Required? false
Position? 3
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ClientSecret <String>
The client secret of ACM web service, may be empty if the ACM web service is not protected by Azure AD. The
value can be found by the result of Get-AcmAppInfo.
Required? false
Position? 4
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Timeout <Int32>
The timeout value for performing test on cluster. By default, an estimated value will be set based on the
number of nodes in a cluster. A value shorter than necesssary will cause no test result, since the test can't
complete without enough time. You could specify a larger value to ensure the test to complete.
Required? false
Position? 5
Default value 0
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
<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
Test-AcmCluster ... 2>err_log 6>info_log
It writes errors to file err_log and other information to file info_log.
-------------------------- EXAMPLE 1 --------------------------
$app = Get-AcmAppInfo -SubscriptionId 'my-id' -ResourceGroup 'my-group'; Test-AcmCluster @app 2>err_log 6>info_log
RELATED LINKS