exports/New-CVDrBackupDestination.ps1
|
# ---------------------------------------------------------------------------------- # Code generated by Microsoft (R) AutoRest Code Generator (autorest: 3.10.2, generator: @autorest/powershell@4.0.708) # Changes may cause incorrect behavior and will be lost if the code is regenerated. # ---------------------------------------------------------------------------------- <# .Synopsis Create a backup destination for CommServe DR Backups .Description Create a backup destination for CommServe DR Backups .Example {{ Add code here }} .Example {{ Add code here }} .Outputs Commvault.Powershell.Models.IGenericResp .Outputs Commvault.Powershell.Models.IPlanBackupDestinationResp .Notes COMPLEX PARAMETER PROPERTIES To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. DESTINATIONS <ICreatePlanBackupDestination[]>: List of backup destinations to create BackupDestinationName <String>: Backup destination details. Enter the name during creation. [BackupStartTime <Int64?>]: Backup start time in seconds. The time is provided in unix time format. [BackupsToCopy <String>]: All_JOBS means SYNCHRONOUS copy type, others are applicable for SELECTIVE copy Type only. [FirstExtendedRetentionRuleIsInfiniteRetention <Boolean?>]: If this is set as true, no need to specify retentionPeriodDays. [FirstExtendedRetentionRuleRetentionPeriodDays <Int64?>]: If this is set, no need to specify isInfiniteRetention as false. [FirstExtendedRetentionRuleType <String>]: All_JOBS means SYNCHRONOUS copy type, others are applicable for SELECTIVE copy Type only. [FullBackupTypesToCopy <String>]: Which type of backup type should be copied for the given backup destination when backup type is not all jobs. Default is LAST while adding new backup destination. [IsConfiguredForReplication <Boolean?>]: Used if the copy is used for replication group [IsMirrorCopy <Boolean?>]: Is this a mirror copy? Only considered when isSnapCopy is true. [IsSnapCopy <Boolean?>]: Is this a snap copy? If isMirrorCopy is not set, then default is Vault/Replica. [Mappings <List<ISnapshotCopyMapping>>]: [MappingType <String>]: Mapping type for pure storage replicaton [SourceId <Int64?>]: [SourceName <String>]: [SourceVendorId <Int64?>]: [SourceVendorName <String>]: [Subclients <List<IIdName>>]: [Id <Int64?>]: [Name <String>]: [TargetId <Int64?>]: [TargetName <String>]: [TargetVendorId <Int64?>]: [TargetVendorName <String>]: [Vendor <String>]: Snapshot vendors available for Snap Copy mappings [NetAppCloudTarget <Boolean?>]: Only for snap copy. Enabling this changes SVM Mapping to NetApp cloud targets only. [OptimizeForInstantClone <Boolean?>]: Flag to specify if primary storage is copy data management enabled. [OverrideRetentionSettings <Boolean?>]: Tells if this copy should use storage pool retention period days or the retention defined for this copy. Set as true to use retention defined on this copy. [RegionGuid <String>]: [RegionId <Int64?>]: [RegionName <String>]: [RetentionPeriodDays <Int64?>]: Retention period in days. -1 can be specified for infinite retention. If this and snapRecoveryPoints both are not specified, this takes precedence. [RetentionRuleType <String>]: Which type of retention rule should be used for the given backup destination [SecondExtendedRetentionRuleIsInfiniteRetention <Boolean?>]: If this is set as true, no need to specify retentionPeriodDays. [SecondExtendedRetentionRuleRetentionPeriodDays <Int64?>]: If this is set, no need to specify isInfiniteRetention as false. [SecondExtendedRetentionRuleType <String>]: All_JOBS means SYNCHRONOUS copy type, others are applicable for SELECTIVE copy Type only. [SnapRecoveryPoints <Int64?>]: Number of snap recovery points for snap copy for retention. Can be specified instead of retention period in Days for snap copy. [SourceCopyId <Int64?>]: [SourceCopyName <String>]: [StoragePoolId <Int64?>]: [StoragePoolName <String>]: [StorageTemplateTags <List<IIdNameValue>>]: It is used in Global config template plan creation. Needs in plan creation on global commcell [Id <Int64?>]: [Name <String>]: [Value <String>]: [StorageType <String>]: StorageType [ThirdExtendedRetentionRuleIsInfiniteRetention <Boolean?>]: If this is set as true, no need to specify retentionPeriodDays. [ThirdExtendedRetentionRuleRetentionPeriodDays <Int64?>]: If this is set, no need to specify isInfiniteRetention as false. [ThirdExtendedRetentionRuleType <String>]: All_JOBS means SYNCHRONOUS copy type, others are applicable for SELECTIVE copy Type only. [UseExtendedRetentionRules <Boolean?>]: Use extended retention rules .Link https://learn.microsoft.com/powershell/module/commvaultpowershell/new-cvdrbackupdestination #> function New-CVDrBackupDestination { [OutputType([Commvault.Powershell.Models.IPlanBackupDestinationResp], [Commvault.Powershell.Models.IGenericResp])] [CmdletBinding(DefaultParameterSetName='CreateExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] param( [Parameter()] [Commvault.Powershell.Category('Body')] [System.String] # Which type of action should be followed if backup copy falls behind ${BackupCopyOptionAction}, [Parameter()] [Commvault.Powershell.Category('Body')] [System.Int64] # Alert to throw when backup copy falls behind in hours ${BackupCopyOptionAlertInHours}, [Parameter()] [Commvault.Powershell.Category('Body')] [System.String] # Which type of backup type should be copied for the given backup destination when backup type is not all jobs. # Default is LAST while adding new backup destination. ${BackupCopyOptionBackupFullToCopy}, [Parameter()] [Commvault.Powershell.Category('Body')] [System.String] # Backup type to copy for backup copy operation ${BackupCopyOptionBackupTypeToCopy}, [Parameter()] [Commvault.Powershell.Category('Body')] [System.Management.Automation.SwitchParameter] # Flag to enable backup copy fallen behind alert ${BackupCopyOptionEnableAlert}, [Parameter()] [Commvault.Powershell.Category('Body')] [System.Int64] # The allowable delay in days before a backup copy job is considered overdue ${BackupCopyOptionSkipAfterThresholdDays}, [Parameter()] [Commvault.Powershell.Category('Body')] [System.Int64] # Snapshots to be copied from a particular time in unix time format. # By default, 0 means since the inception of the snap copy. ${BackupCopyOptionStartTime}, [Parameter()] [AllowEmptyCollection()] [Commvault.Powershell.Category('Body')] [Commvault.Powershell.Models.ICreatePlanBackupDestination[]] # List of backup destinations to create ${Destinations}, [Parameter()] [Commvault.Powershell.Category('Body')] [System.String] # . ${RegionGuid}, [Parameter()] [Commvault.Powershell.Category('Body')] [System.Int64] # . ${RegionId}, [Parameter()] [Commvault.Powershell.Category('Body')] [System.String] # . ${RegionName}, [Parameter()] [Commvault.Powershell.Category('Body')] [System.Int64] # Backup copy RPO in minutes ${SnapshotOptionBackupCopyRpoMins}, [Parameter()] [Commvault.Powershell.Category('Body')] [System.Management.Automation.SwitchParameter] # Flag to enable backup copy ${SnapshotOptionEnableBackupCopy}, [Parameter()] [Commvault.Powershell.Category('Body')] [System.Management.Automation.SwitchParameter] # Flag to enable deferred snapshot cataloging ${SnapshotOptionEnableSnapCatalog}, [Parameter()] [Commvault.Powershell.Category('Body')] [System.Int64] # Retention period in days. # -1 can be specified for infinite retention. # If this and snapRecoveryPoints both are not specified, this takes precedence. ${SnapshotOptionRetentionPeriodDays}, [Parameter()] [Commvault.Powershell.Category('Body')] [System.Int64] # Number of snap recovery points for default snap copy for retention. # Can be specified instead of retention period in Days for default snap copy. ${SnapshotOptionSnapRecoveryPoints}, [Parameter(DontShow)] [Commvault.Powershell.Category('Runtime')] [System.Management.Automation.SwitchParameter] # Wait for .NET debugger to attach ${Break}, [Parameter(DontShow)] [ValidateNotNull()] [Commvault.Powershell.Category('Runtime')] [Commvault.Powershell.Runtime.SendAsyncStep[]] # SendAsync Pipeline Steps to be appended to the front of the pipeline ${HttpPipelineAppend}, [Parameter(DontShow)] [ValidateNotNull()] [Commvault.Powershell.Category('Runtime')] [Commvault.Powershell.Runtime.SendAsyncStep[]] # SendAsync Pipeline Steps to be prepended to the front of the pipeline ${HttpPipelinePrepend}, [Parameter()] [Commvault.Powershell.Category('Runtime')] [System.Management.Automation.SwitchParameter] # Returns true when the command succeeds ${PassThru}, [Parameter(DontShow)] [Commvault.Powershell.Category('Runtime')] [System.Uri] # The URI for the proxy server to use ${Proxy}, [Parameter(DontShow)] [ValidateNotNull()] [Commvault.Powershell.Category('Runtime')] [System.Management.Automation.PSCredential] # Credentials for a proxy server to use for the remote call ${ProxyCredential}, [Parameter(DontShow)] [Commvault.Powershell.Category('Runtime')] [System.Management.Automation.SwitchParameter] # Use the default credentials for the proxy ${ProxyUseDefaultCredentials} ) begin { try { $outBuffer = $null if ($PSBoundParameters.TryGetValue('OutBuffer', [ref]$outBuffer)) { $PSBoundParameters['OutBuffer'] = 1 } $parameterSet = $PSCmdlet.ParameterSetName $mapping = @{ CreateExpanded = 'CommvaultPowerShell.private\New-CVDrBackupDestination_CreateExpanded'; } $cmdInfo = Get-Command -Name $mapping[$parameterSet] [Commvault.Powershell.Runtime.MessageAttributeHelper]::ProcessCustomAttributesAtRuntime($cmdInfo, $MyInvocation, $parameterSet, $PSCmdlet) [Commvault.Powershell.Runtime.MessageAttributeHelper]::ProcessPreviewMessageAttributesAtRuntime($cmdInfo, $MyInvocation, $parameterSet, $PSCmdlet) $wrappedCmd = $ExecutionContext.InvokeCommand.GetCommand(($mapping[$parameterSet]), [System.Management.Automation.CommandTypes]::Cmdlet) $scriptCmd = {& $wrappedCmd @PSBoundParameters} $steppablePipeline = $scriptCmd.GetSteppablePipeline($MyInvocation.CommandOrigin) $steppablePipeline.Begin($PSCmdlet) } catch { throw } } process { try { $steppablePipeline.Process($_) } catch { throw } } end { try { $steppablePipeline.End() } catch { throw } } } |