exports/Invoke-CVModifyBackupDestinationDetail.ps1
|
# ---------------------------------------------------------------------------------- # # Copyright Microsoft Corporation # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # http://www.apache.org/licenses/LICENSE-2.0 # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. # ---------------------------------------------------------------------------------- <# .Synopsis Modify Backup Destination details for a Plan .Description Modify Backup Destination details for a Plan .Example PS C:\> {{ Add code here }} {{ Add output here }} .Example PS C:\> {{ Add code here }} {{ Add output here }} .Inputs Commvault.Powershell.Models.ICommvaultPowerShellIdentity .Inputs Commvault.Powershell.Models.IUpdatePlanBackupDestinationDetails .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. BODY <IUpdatePlanBackupDestinationDetails>: . [BackupTypeBackupTypesCopiedFrom <Int64?>]: Tells what start date, backup types should be copied from. The date is provided in unix time format in number of seconds. -1 means initial backup date. [BackupTypeBackupTypesToCopy <String>]: All_JOBS means SYNCHRONOUS copy type, others are applicable for SELECTIVE copy Type only. [BackupTypeFullBackupTypesToCopy <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. [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. [GeneralIsActive <Boolean?>]: Toggle to keep backup destination active [Mappings <ISnapshotCopyMapping[]>]: [SourceId <Int64?>]: [SourceName <String>]: [SourceVendorId <Int64?>]: [SourceVendorName <String>]: [TargetId <Int64?>]: [TargetName <String>]: [TargetVendorId <Int64?>]: [TargetVendorName <String>]: [Vendor <String>]: Snapshot vendors available for Snap Copy mappings [NewName <String>]: New name for backup destination [RetentionRuleEnableDataAging <Boolean?>]: Tells if this copy has data aging enabled [RetentionRuleFullBackupTypesToBeRetained <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. [RetentionRuleOverrideRetentionSettings <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. [RetentionRuleRetentionPeriodDays <Int64?>]: Retention period in days [RetentionRuleSnapRecoveryPoints <Int64?>]: Number of snap recovery points for snap copy for retention [RetentionRuleType <String>]: Which type of retention rule should be used for the given backup destination [RetentionRuleUseExtendedRetentionRules <Boolean?>]: Should extended retention rules be used [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. [SourceId <Int64?>]: [SourceName <String>]: [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. 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 [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 [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 <Int64?>]: [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 [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?>]: MAPPINGS <ISnapshotCopyMapping[]>: . [SourceId <Int64?>]: [SourceName <String>]: [SourceVendorId <Int64?>]: [SourceVendorName <String>]: [TargetId <Int64?>]: [TargetName <String>]: [TargetVendorId <Int64?>]: [TargetVendorName <String>]: [Vendor <String>]: Snapshot vendors available for Snap Copy mappings .Link https://docs.microsoft.com/en-us/powershell/module/commvaultpowershell/invoke-cvmodifybackupdestinationdetail #> function Invoke-CVModifyBackupDestinationDetail { [OutputType([Commvault.Powershell.Models.IPlanBackupDestinationResp])] [CmdletBinding(DefaultParameterSetName='ModifyExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] param( [Parameter(ParameterSetName='Modify', Mandatory)] [Parameter(ParameterSetName='ModifyExpanded', Mandatory)] [Commvault.Powershell.Category('Path')] [System.Int64] # Id of the backupDestination to be modified ${BackupDestinationId}, [Parameter(ParameterSetName='Modify', Mandatory)] [Parameter(ParameterSetName='ModifyExpanded', Mandatory)] [Commvault.Powershell.Category('Path')] [System.Int64] # Id of the Plan to modify ${PlanId}, [Parameter(ParameterSetName='ModifyViaIdentity', Mandatory, ValueFromPipeline)] [Parameter(ParameterSetName='ModifyViaIdentityExpanded', Mandatory, ValueFromPipeline)] [Commvault.Powershell.Category('Path')] [Commvault.Powershell.Models.ICommvaultPowerShellIdentity] # Identity Parameter # To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ${InputObject}, [Parameter(ParameterSetName='Modify', Mandatory, ValueFromPipeline)] [Parameter(ParameterSetName='ModifyViaIdentity', Mandatory, ValueFromPipeline)] [Commvault.Powershell.Category('Body')] [Commvault.Powershell.Models.IUpdatePlanBackupDestinationDetails] # . # To construct, see NOTES section for BODY properties and create a hash table. ${Body}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.Int64] # Tells what start date, backup types should be copied from. # The date is provided in unix time format in number of seconds. # -1 means initial backup date. ${BackupTypeBackupTypesCopiedFrom}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.String] # All_JOBS means SYNCHRONOUS copy type, others are applicable for SELECTIVE copy Type only. ${BackupTypeBackupTypesToCopy}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [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. ${BackupTypeFullBackupTypesToCopy}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.Management.Automation.SwitchParameter] # If this is set as true, no need to specify retentionPeriodDays. ${FirstExtendedRetentionRuleIsInfiniteRetention}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.Int64] # If this is set, no need to specify isInfiniteRetention as false. ${FirstExtendedRetentionRuleRetentionPeriodDays}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.String] # All_JOBS means SYNCHRONOUS copy type, others are applicable for SELECTIVE copy Type only. ${FirstExtendedRetentionRuleType}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.Management.Automation.SwitchParameter] # Toggle to keep backup destination active ${GeneralIsActive}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [Commvault.Powershell.Models.ISnapshotCopyMapping[]] # . # To construct, see NOTES section for MAPPINGS properties and create a hash table. ${Mappings}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.String] # New name for backup destination ${NewName}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.Management.Automation.SwitchParameter] # Tells if this copy has data aging enabled ${RetentionRuleEnableDataAging}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [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. ${RetentionRuleFullBackupTypesToBeRetained}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.Management.Automation.SwitchParameter] # 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. ${RetentionRuleOverrideRetentionSettings}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.Int64] # Retention period in days ${RetentionRuleRetentionPeriodDays}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.Int64] # Number of snap recovery points for snap copy for retention ${RetentionRuleSnapRecoveryPoints}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.String] # Which type of retention rule should be used for the given backup destination ${RetentionRuleType}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.Management.Automation.SwitchParameter] # Should extended retention rules be used ${RetentionRuleUseExtendedRetentionRules}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.Management.Automation.SwitchParameter] # If this is set as true, no need to specify retentionPeriodDays. ${SecondExtendedRetentionRuleIsInfiniteRetention}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.Int64] # If this is set, no need to specify isInfiniteRetention as false. ${SecondExtendedRetentionRuleRetentionPeriodDays}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.String] # All_JOBS means SYNCHRONOUS copy type, others are applicable for SELECTIVE copy Type only. ${SecondExtendedRetentionRuleType}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.Int64] # . ${SourceId}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.String] # . ${SourceName}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.Management.Automation.SwitchParameter] # If this is set as true, no need to specify retentionPeriodDays. ${ThirdExtendedRetentionRuleIsInfiniteRetention}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.Int64] # If this is set, no need to specify isInfiniteRetention as false. ${ThirdExtendedRetentionRuleRetentionPeriodDays}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.String] # All_JOBS means SYNCHRONOUS copy type, others are applicable for SELECTIVE copy Type only. ${ThirdExtendedRetentionRuleType}, [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 = @{ Modify = 'CommvaultPowershell.private\Invoke-CVModifyBackupDestinationDetail_Modify'; ModifyExpanded = 'CommvaultPowershell.private\Invoke-CVModifyBackupDestinationDetail_ModifyExpanded'; ModifyViaIdentity = 'CommvaultPowershell.private\Invoke-CVModifyBackupDestinationDetail_ModifyViaIdentity'; ModifyViaIdentityExpanded = 'CommvaultPowershell.private\Invoke-CVModifyBackupDestinationDetail_ModifyViaIdentityExpanded'; } $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 } } } |