PowerCLI Reference

Import-SpbmStoragePolicy

Synopsis

This cmdlet imports a storage policy from a file.

Syntax

Import-SpbmStoragePolicy [-FilePath] <String> [-Name] <String> [-Description <String>] [-Server <VIServer>] [-WhatIf] [-Confirm] [<CommonParameters>]

Related Commands

Online version
Export-SpbmStoragePolicy
Get-SpbmStoragePolicy
New-SpbmStoragePolicy
Remove-SpbmStoragePolicy
Set-SpbmStoragePolicy

Detailed Description

This cmdlet imports a storage policy from a file. The file path must be accessible from the VMware PowerCLI client side.

Parameters

Name	Type	Description	Required?	Pipeline Input
FilePath	String	Specifies the path to the file, from which you want to import a storage policy. If relative, it is relative to the current PS provider path.	true	false
Name	String	Specifies a name of the imported storage policy. The maximum length of the name is 80 characters.	true	false
Confirm	SwitchParameter	If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.	false	false
Description	String	Specifies a description for the imported storage policy.	false	false
Server	VIServer	Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.	false	false
WhatIf	SwitchParameter	Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.	false	false

Return Type

SpbmStoragePolicy

Notes

Works only with vCenter Server 5.5 or later. For more information, see the VMware Storage Policy API Reference: https://pubs.vmware.com/vsphere-60/index.jsp#com.vmware.vspsdk.apiref.doc/right-pane.html

Examples

-------------- Example 1 --------------

Import-SpbmStoragePolicy -Name "MyPolicy" -Description "PolicyDescription" -FilePath C:\policy.xml

Imports a storage policy with name "MyPolicy" and description "PolicyDescription" from the policy.xml file to a server. A new storage policy is created on the server.