Export (0) Print
Expand All

Import-SmaModule

System Center 2012 R2

Updated: November 1, 2013

Applies To: System Center 2012 R2 Orchestrator, Windows Azure Pack for Windows Server

Import-SmaModule

Imports a module into Service Management Automation.

Syntax

Parameter Set: Default
Import-SmaModule -Path <String> -WebServiceEndpoint <String> [-AuthenticationType <String> ] [-Credential <PSCredential> ] [-Port <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]




Detailed Description

The Import-SmaModule cmdlet imports a module into Service Management Automation. 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 (.psm1, psd.1, or .dll) must match.

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

-Path<String>

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.


Aliases

ModulePath

Required?

true

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

-Confirm

Prompts you for confirmation before executing the command.


Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-WhatIf

Describes what would happen if you executed the command without actually executing the command.


Required?

false

Position?

named

Default Value

false

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: Import a module

This command imports the module named MyModule from the specified module path.


PS C:\> Import-SmaModule -WebServiceEndpoint "https://contoso.com/app01" -Path ".\MyModule.zip"

Related topics

 
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft