Share via


Get-SmaJobOutput

Gets the output of a SMA job.

Syntax

Default (Default)

Get-SmaJobOutput
    -Id <String>
    [-StartTime <DateTime>]
    -WebServiceEndpoint <String>
    [-Port <Int32>]
    [-AuthenticationType <String>]
    [-Credential <PSCredential>]
    -Stream <String>
    [<CommonParameters>]

Description

The Get-SmaJobOutput cmdlet gets the output of a Service Management Automation (SMA) job. Specify an SMA job ID and the web service endpoint.

Examples

Example 1: Get the output of a Service Management Automation job

PS C:\> Get-SmaJobOutput -Id "2989b069-24fe-40b9-b3bd-cb7e5eac4b64" -WebServiceEndpoint "https://contoso.com/app01"

This command gets all of the output of the job with the specified GUID for the specified web service endpoint.

Parameters

-AuthenticationType

Specifies the authentication type. Valid values are:

  • Basic
  • Windows

The default value is Windows. If you use Basic authentication, you must provide credentials by using the Credential parameter.

Parameter properties

Type:String
Default value:None
Accepted values:Basic, Windows
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:PSCredential
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Id

Specifies the job ID, as a string.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:JobId

Parameter sets

(All)
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-Port

Specifies the port number of the SMA web service.

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-StartTime

Specifies a start time as a DateTime object. The cmdlet gets output created after this time. To get a DateTime object, use the Get-Date cmdlet.

Parameter properties

Type:DateTime
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Stream

Specifies the type of output. Valid values are:

-- Any -Debug

  • Error
  • Output
  • Progress
  • Verbose
  • Warning

Note: Stream values are case-sensitive. If the wrong case is used, the error "job id '<GUID>' not found" is returned.

Parameter properties

Type:String
Default value:None
Accepted values:Any, Progress, Output, Warning, Error, Debug, Verbose
Supports wildcards:False
DontShow:False
Aliases:OutputType

Parameter sets

(All)
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-WebServiceEndpoint

Specifies the endpoint, as a URL, of the SMA web service. You must include the protocol, for example, http:// or https://.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.