New-SCPackageMapping

New-SCPackageMapping

Creates a package mapping object.

Syntax

Parameter Set: Package
New-SCPackageMapping -TemplatePackage <Package> [-VMMServer <ServerConnection> ] [ <CommonParameters>]

Parameter Set: Path
New-SCPackageMapping -Path <String> [-PreferPackageResources] [-VMMServer <ServerConnection> ] [ <CommonParameters>]

Detailed Description

The New-SCPackageMapping cmdlet creates a package mapping object. A package mapping object binds resources to a template. For information about how to update the bindings in a package mapping object, see Set-SCPackageMapping.

Parameters

-Path<String>

Specifies the destination path for the operation.

Example formats:

Local: -Path "F:\"

UNC: -Path "\\Library\Templates"

Volume GUID: -Path "\\?\Volume{4703c1ea-8ae7-11db-b473-00123f7603e3}\"

VMware ESX: -Path "[storage1]\MyVMwareFolderForVMs\MyVM.vmx"

Citrix XenServer: -Path "Local storage[99b6212f-b63d-c676-25f9-d6c460992de7]"

Wildcards are supported for Get- cmdlets and when you specify the UNC path.

Example format:

UNC: -Path "\\VMHostServer\MyVMs\*VM*"

Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-PreferPackageResources

Indicates that the resources exported with the package are retained even if similar resources exist at the import destination.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-TemplatePackage<Package>

Specifies an exported template package that contains serialized settings of a service or virtual machine template.

Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

false

-VMMServer<ServerConnection>

Specifies a VMM server object.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

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.

  • PackageMapping

Examples

Example 1: Create a package mapping for a template package

The first command gets the template package at the specified path, and then stores the package in the $TemplatePackage variable.

The second command creates a package mapping object for the package stored in $TemplatePackage, and then stores the object in the $Mappings variable.

PS C:\> $TemplatePackage = Get-SCTemplatePackage -Path "C:\TemplateExports\VMTemplate01.xml"
PS C:\> $Mappings = New-SCPackageMapping -TemplatePackage $TemplatePackage

Set-SCPackageMapping

Get-SCTemplatePackage