Share via


Import-SmaModule

Imports a module into SMA.

Syntax

Default (Default)

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.

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

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:cf

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

-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.

Parameter properties

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

Parameter sets

(All)
Position:Named
Mandatory:True
Value from pipeline:False
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

-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

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

(All)
Position:Named
Mandatory:False
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.