Suspend-SmaJob
Suspends an SMA job.
Syntax
Suspend-SmaJob
-Id <String>
-WebServiceEndpoint <String>
[-Port <Int32>]
[-AuthenticationType <String>]
[-Credential <PSCredential>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The Suspend-SmaJob cmdlet suspends a Service Management Automation (SMA) job. Specify an SMA job and the web service endpoint. If necessary, specify the port of the SMA web service.
To resume a suspended job, use Resume-SmaJob cmdlet.
Examples
Example 1: Suspend a Service Management Automation job
PS C:\> Suspend-SmaJob -JobId "2989b069-24fe-40b9-b3bd-cb7e5eac4b64" -WebServiceEndpoint "https://localhost"
This command suspends the job with the ID of 2989b069-24fe-40b9-b3bd-cb7e5eac4b64.
Parameters
-AuthenticationType
Specifies the authentication type. Valid values are:
- Basic
- Windows
The default value for this parameter is Windows. If you use Basic authentication, you must provide credentials by using the Credential parameter.
Type: | String |
Accepted values: | Basic, Windows |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
Type: | SwitchParameter |
Aliases: | cf |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Credential
Specifies a PSCredential object for the connection to the SMA web service.
To obtain a credential object, use the Get-Credential cmdlet.
For more information, type Get-Help Get-Credential
.
Type: | PSCredential |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Id
Specifies the ID, as a string, of an SMA job.
Type: | String |
Aliases: | JobId |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Port
Specifies the port number of the SMA web service.
Type: | Int32 |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-WebServiceEndpoint
Specifies the endpoint, as a URL, of the SMA web service. You must include the protocol, for example, http:// or https://.
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: | SwitchParameter |
Aliases: | wi |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |