exports/New-CVBackupDestination.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 a Plan .Description Create a Backup Destination for a Plan .Example {{ Add code here }} .Example {{ Add code here }} .Inputs Commvault.Powershell.Models.ICommvaultPowerShellIdentity .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 INPUTOBJECT <ICommvaultPowerShellIdentity>: Identity Parameter [AccessPathId <Int64?>]: Id of the mount path whose access path has to be deleted [AgentId <Int64?>]: Id of the agent to be modified [AlertRuleId <Int64?>]: Unique Id of the alert custom rule to get details [AppGuid <String>]: GUID of the Application to get details [AppId <Int64?>]: Commvault exchange app id [ApplicationGroupId <Int64?>]: applicationGroupId is the ID of the Kubernetes application group [ArrayId <Int64?>]: [AssetId <String>]: FQDN of the asset [BackupDestinationId <Int64?>]: Id of the backupDestination to be modified [BackupDestionationId <Int64?>]: [BackupLocationId <Int64?>]: Id of the backup location whose details have to be fetched [BlackoutWindowId <Int64?>]: Id of the Blackout Window whose details have to be fetched [BucketId <Int64?>]: Id of Bucket [ClientId <Int64?>]: [CloneId <Int64?>]: ID of the cloned bucket [CloudStorageId <Int64?>]: Id of cloud Storage [ClusterId <Int64?>]: Id of the cluster whose modifier has to be listed. [CompanyId <Int64?>]: Id of the Company whose details have to be fetched [CopyId <Int64?>]: [CredentialId <String>]: [CredentialName <String>]: [DomainId <Int64?>]: ID of the AD/LDAP domain [DrOperation <String>]: Name of DR operation. Case insensitive [DriveId <Int64?>]: Id of the Drive of which the drive details has to be displayed [EntityId <Int64?>]: Recovery entity Id [EntityType <String>]: Type of the entity [FailoverGroupId <Int64?>]: Id of the failover group [GlobalSearchEntity <String>]: name of global search entity [HfsShareId <Int64?>]: Id of the HFS Share to fetch its status [HyperScaleStorageId <Int64?>]: Id of hyperscale storage [HypervisorId <Int64?>]: Id of the HYpervisor to get [Id <Int64?>]: [IndexServerClientId <Int64?>]: Pseudo client id of the index server [InstanceId <Int64?>]: Id of the instance to modify [InventoryId <Int64?>]: Inventory id [JobId <Int64?>]: [KmsId <Int64?>]: Id of Key Management Server [LibraryId <Int64?>]: Id of the library to view the data [MediaAgentId <Int64?>]: Id of the Media Agent whose details have to be fetched [MetadataCacheId <Int64?>]: Id of metadata cache [ModifierName <String>]: Name of the modifier to be read. [Name <String>]: [NameSpace <String>]: Name of the namespace to browse for content [NodeId <Int64?>]: Id of node [PairId <Int64?>]: [PlanId <Int64?>]: Id of the object store plan to fetch details [RecoveryEntityId <Int64?>]: Recovery entity Id [RecoveryGroupId <Int64?>]: Recovery group Id [RecoveryTargetId <Int64?>]: id of recovery target [RegionId <Int64?>]: Region id to be deleted. [RegionList <String>]: List of region names/ids to be deleted. If region ids are passed, set isRegionIdList=true [ReplicationGroupId <String>]: [ReplicationPairId <Int64?>]: Replication pair id of the Pair [RequestId <Int64?>]: Unique identifier for the request [RoleId <Int64?>]: Role Id [RpsId <String>]: [RuleId <Int64?>]: Id of the rule to update in Plan [ScheduleId <Int64?>]: ID of the DR operation schedule [SchedulePolicyId <Int64?>]: [ServerGroupId <Int64?>]: Id of the serverGroupId whose details have to be fetched [ServerId <Int64?>]: Id of the server to modify [SnapEngineId <Int64?>]: Snap Engine Id [SpareGroupId <Int64?>]: Id of the Spare group whose properties need to be fetched. spareGroupId can be fetched from GET V4/Storage/Tape/{libraryId}/MediaType [StoragePoolId <Int64?>]: Id of the storage pool whose associated copies have to be fetched [SubclientId <Int64?>]: Id of the subclient to modify [TagId <Int64?>]: Id of the tag to delete [TagValue <String>]: tag value to delete [TopologyId <String>]: [UserGroupId <Int64?>]: Id of the user-group whose details have to be fetched [UserId <Int64?>]: Id of the User whose details have to be fetched [VMGroupId <Int64?>]: Id of the VMgroup to update [VMGuid <String>]: [VMUuid <String>]: The vmUUID can be obtained from GET /virtualMachines UUID property [VendorId <Int64?>]: .Link https://learn.microsoft.com/powershell/module/commvaultpowershell/new-cvbackupdestination #> function New-CVBackupDestination { [OutputType([Commvault.Powershell.Models.IPlanBackupDestinationResp])] [CmdletBinding(DefaultParameterSetName='CreateExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] param( [Parameter(ParameterSetName='CreateExpanded', Mandatory)] [Commvault.Powershell.Category('Path')] [System.Int64] # Id of the Plan to modify ${PlanId}, [Parameter(ParameterSetName='CreateViaIdentityExpanded', Mandatory, ValueFromPipeline)] [Commvault.Powershell.Category('Path')] [Commvault.Powershell.Models.ICommvaultPowerShellIdentity] # Identity Parameter ${InputObject}, [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-CVBackupDestination_CreateExpanded'; CreateViaIdentityExpanded = 'CommvaultPowerShell.private\New-CVBackupDestination_CreateViaIdentityExpanded'; } $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 } } } |