Import-SmaModule
Imports a module into SMA.
Syntax
Import-SmaModule
-Path <String>
-WebServiceEndpoint <String>
[-Port <Int32>]
[-AuthenticationType <String>]
[-Credential <PSCredential>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Description
The Import-SmaModule cmdlet imports a module into Service Management Automation (SMA). A module is a compressed file, with a .zip extension, that contains a folder which includes one of the following file types:
- A Windows PowerShell module (psm1 file).
- A Windows PowerShell module manifest (psd1 file).
- An assembly (dll file).
The names of the zip file, the folder in the zip file, and file in the folder must match.
Examples
Example 1: Import a module
PS C:\> Import-SmaModule -WebServiceEndpoint "https://contoso.com/app01" -Path ".\MyModule.zip"This command imports the module named MyModule from the specified module path.
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 |
-Path
Specifies the path to a module. The path must point to a compressed file, with a .zip extension, that contains a folder which includes one of the following file types:
- A Windows PowerShell module (psm1 file).
- A Windows PowerShell module manifest (psd1 file).
- An assembly (dll file).
The names of the zip file, the folder in the zip file, and the file in the folder (.psm1, psd.1, or .dll) must match.
| Type: | String |
| Aliases: | ModulePath |
| Position: | Named |
| Default value: | None |
| Required: | True |
| 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 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 |