Get-SmaModule
Applies To: System Center 2012 R2 Orchestrator, Windows Azure Pack for Windows Server
Get-SmaModule
Gets a module from Service Management Automation.
Syntax
Parameter Set: GetAll
Get-SmaModule -WebServiceEndpoint <String> [-AuthenticationType <String> ] [-Credential <PSCredential> ] [-Port <Int32> ] [ <CommonParameters>]
Parameter Set: ByModuleId
Get-SmaModule -WebServiceEndpoint <String> [-AuthenticationType <String> ] [-Credential <PSCredential> ] [-Id <String[]> ] [-Port <Int32> ] [ <CommonParameters>]
Parameter Set: ByModuleName
Get-SmaModule -WebServiceEndpoint <String> [-AuthenticationType <String> ] [-Credential <PSCredential> ] [-Name <String[]> ] [-Port <Int32> ] [ <CommonParameters>]
Detailed Description
The Get-SmaModule cmdlet gets one or more modules from Service Management Automation.
Parameters
-AuthenticationType<String>
Specifies the authentication type. Valid values are: Basic, Windows.
Windows is the default value. If you use Basic authentication, you must provide credentials by using the Credential parameter.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
Windows |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Credential<PSCredential>
Specifies user credentials, as a PSCredential object, to use for the connection to the Service Management Automation web service. To obtain a credential object, use the Get-Credential cmdlet. For more information, type Get-Help Get-Credential
.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Id<String[]>
Specifies an array of module IDs.
Aliases |
ModuleId |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
-Name<String[]>
Specifies an array of module names.
Aliases |
ModuleName |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Port<Int32>
Specifies the port number of the Service Management Automation web service.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-WebServiceEndpoint<String>
Specifies the endpoint, as a URL, of the Service Management Automation web service. Include the protocol, for example, http:// or https://.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters.
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Outputs
The output type is the type of the objects that the cmdlet emits.
Examples
Example 1: Get a module
This command retrieves the module with the specified GUID.
PS C:\> Get-SmaModule -WebServiceEndpoint "https://contoso.com/app01" -Id "a65bba12-792b-44e8-8a50-1c3e40c34031"