Get-SmaModule
Gets a module from SMA.
Syntax
Get-SmaModule
-WebServiceEndpoint <String>
[-Port <Int32>]
[-AuthenticationType <String>]
[-Credential <PSCredential>]
[<CommonParameters>] Get-SmaModule
[-Id <String[]>]
-WebServiceEndpoint <String>
[-Port <Int32>]
[-AuthenticationType <String>]
[-Credential <PSCredential>]
[<CommonParameters>] Get-SmaModule
[-Name <String[]>]
-WebServiceEndpoint <String>
[-Port <Int32>]
[-AuthenticationType <String>]
[-Credential <PSCredential>]
[<CommonParameters>] Description
The Get-SmaModule cmdlet gets one or more modules from Service Management Automation (SMA).
Examples
Example 1: Get a module
PS C:\> Get-SmaModule -WebServiceEndpoint "https://contoso.com/app01" -Id "a65bba12-792b-44e8-8a50-1c3e40c34031"This command retrieves the module with the specified GUID.
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.
| Type: | String |
| Accepted values: | Basic, Windows |
| Position: | Named |
| Default value: | None |
| 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 an array of module IDs that this cmdlet gets SMA modules from.
| Type: | String[] |
| Aliases: | ModuleId |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Name
Specifies an array of module names that this cmdlet gets SMA modules from.
| Type: | String[] |
| Aliases: | ModuleName |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| 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 instance, http:// or https://.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |