Skip to main content
SnapCenter 5.0 cmdlets

Get-SmPolicy

Contributors

Retrieves details about one or more policy.

Syntax

Get-SmPolicy [-PolicyName]  <String>  [-DatasetName]  <String>

Detailed Description

Retrieves details about one or more policy. You can retrieve details about a specific policy or about all policies in a resource group.

Parameters

Name Description Required? Pipeline Input Default Value

PolicyName

Specifies the name of the policy for which you want details.

false

true (ByPropertyName)

DatasetName

Specifies a dataset. This parameter retrieves policy details for each policy in the dataset.

false

true (ByPropertyName)

Examples

Example 1: Retrieving information about a policy

 Get-SmPolicy -PolicyName "Full Backup with Replication"

This example syntax gets information about the specified policy.

ApplySnapvaultUpdate: True
ApplyRetention  : True
RetentionCount  : 2
RetentionDays   : 0
ApplySnapMirrorUpdate   : True
SnapVaultLabel  : OneTime
MirrorVaultUpdateRetryCount : 7
AppPolicies : {}
Description :
PreScriptPath   :
PreScriptArguments  :
PostScriptPath  :
PostScriptArguments :
ScriptTimeOut   : 60000
DateModified: 6/10/2015 7:18:50 PM
DateCreated : 6/8/2015 11:03:07 PM
Schedule: SMCoreContracts.SmSchedule
PolicyType  : Backup
PluginPolicyType: SMSQL
Name: Full Backup with Replication
Type:
Id  : 1
Host:
UserName:
Passphrase  :
Deleted : False
Auth: SMCoreContracts.SmAuth
IsClone : False
CloneLevel  : 0
SmSqlBackupType: FullBackup
CopyOnlyBackup : False
CopyOnlyLogBackup  : False
UtmType: None
UtmCounts  : 7
UtmDays: 14
RunLiveDBCCBefore  : False
RunLiveDBCCAfter   : False
RetentionType  :
TruncateLog: True
VerificationAfterBackup: False
TransLogMark   :
TransLogDescription:
AGBackupType   : UsePreferredBackupReplica
AGReplicaType  : Primary
AGBackupPriorityMin: 1
AGBackupPriorityMax: 100
VerifyLogBackup: False
MaxDbConcurrentBackup  : 35
CreateLogFolderSnapshot: True
DeleteLogFolderSnapshot: False
LogFolderSnapshotRetentionType :
LogFolderSnapshotCounts: 0
LogFolderSnapshotDays  : 0
DeleteLogInShare   : False
LogInShareRetentionType:
LogInShareCounts   :
LogInShareDays :
CopyLogToShare : False
CopyLogToShareType :
VerifyPolicy   : SMCoreContracts.SmVerificationPolicy
Name   :
Type   :
Id :
Host   :
UserName   :
Passphrase :
Deleted: False
Auth   : SMCoreContracts.SmAuth
IsClone: False
CloneLevel : 0

Example 2: Retrieving information for policies in a dataset

 Get-SmPolicy -DatasetName DB_ON_I_S_DRIVE_ds
ApplySnapvaultUpdate: True
ApplyRetention  : True
RetentionCount  : 2
RetentionDays   : 0
ApplySnapMirrorUpdate   : True
SnapVaultLabel  : OneTime
MirrorVaultUpdateRetryCount : 7
AppPolicies : {}
Description :
PreScriptPath   :
PreScriptArguments  :
PostScriptPath  :
PostScriptArguments :
ScriptTimeOut   : 60000
DateModified: 6/10/2015 7:18:50 PM
DateCreated : 6/8/2015 11:03:07 PM
Schedule: SMCoreContracts.SmSchedule
PolicyType  : Backup
PluginPolicyType: SMSQL
Name: Full Backup with Replication
Type:
Id  : 1
Host:
UserName:
Passphrase  :
Deleted : False
Auth: SMCoreContracts.SmAuth
IsClone : False
CloneLevel  : 0
SmSqlBackupType: FullBackup
CopyOnlyBackup : False
CopyOnlyLogBackup  : False
UtmType: None
UtmCounts  : 7
UtmDays: 14
RunLiveDBCCBefore  : False
RunLiveDBCCAfter   : False
RetentionType  :
TruncateLog: True
VerificationAfterBackup: False
TransLogMark   :
TransLogDescription:
AGBackupType   : UsePreferredBackupReplica
AGReplicaType  : Primary
AGBackupPriorityMin: 1
AGBackupPriorityMax: 100
VerifyLogBackup: False
MaxDbConcurrentBackup  : 35
CreateLogFolderSnapshot: True
DeleteLogFolderSnapshot: False
LogFolderSnapshotRetentionType :
LogFolderSnapshotCounts: 0
LogFolderSnapshotDays  : 0
DeleteLogInShare   : False
LogInShareRetentionType:
LogInShareCounts   :
LogInShareDays :
CopyLogToShare : False
CopyLogToShareType :
VerifyPolicy   : SMCoreContracts.SmVerificationPolicy
Name   :
Type   :
Id :
Host   :
UserName   :
Passphrase :
Deleted: False
Auth   : SMCoreContracts.SmAuth
IsClone: False
CloneLevel : 0

GetSmPolicy for custom DB2 plugin

 Get-SmPolicy -PolicyName SECONDARY_SNAPMIRROR

Custom plug-in DB2 policy with SnapMirror update enabled

BackupType  : DATA
SchedulerType   : None
RetentionCount  : 24
RetentionDays   : 0
VerificationEnabled : False
ApplyRetention  : True
ApplySnapMirrorUpdate   : True
ApplySnapvaultUpdate: False
MirrorVaultUpdateRetryCount : 3
RetentionCount  : 24
RetentionDays   : 0
SnapVaultLabel  :
AppPolicies : {}
DateCreated : 8/21/2016 4:23:20 PM
DateModified: 8/21/2016 4:23:20 PM
Description : testPolicy
PluginPolicyType: DB2
PolicyType  : Backup
PostScriptArguments :
PostScriptPath  :
PreScriptArguments  :
PreScriptPath   :
Schedules   : {}
Schedule: SMCoreContracts.SmSchedule
ScriptTimeOut   : 60
Name: SECONDARY_SNAPMIRROR
Type:
Id  : 23
Host:
UserName:
Passphrase  :
Deleted : False
Auth: SMCoreContracts.SmAuth
IsClone : False
CloneLevel  : 0
Hosts   : {}
PolicyId : 23
PluginName   : DB2
PluginParams : SMCoreContracts.SmKeyValueCollection
Name :
Type :
Id   :
Host :
UserName :
Passphrase   :
Deleted  : False
Auth : SMCoreContracts.SmAuth
IsClone  : False
CloneLevel   : 0
Hosts: {}