exports/Invoke-CVModifyPlan.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 Used to modify an exsiting server plan .Description Used to modify an exsiting server 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.IUpdateServerPlan .Outputs Commvault.Powershell.Models.IGenericResp .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. BACKUPFREQUENCYSCHEDULES <IPlanSchedule[]>: . BackupType <String>: Schedule Backup level SchedulePatternScheduleFrequencyType <String>: schedule frequency type [ForDatabasesOnly <Boolean?>]: Boolean to indicate if schedule is for database agents [IsRetentionBasedSyntheticFull <Boolean?>]: Boolean to indicate if synthetic full schedule is based on retention rules [PolicyId <Int64?>]: Schedule policy Id to which the schedule belongs [ScheduleId <Int64?>]: Id of the schedule if available, required for modifying, deleting schedule [ScheduleName <String>]: Name of the schedule, for modify [ScheduleOperation <String>]: Operation being performed on schedule [ScheduleOptionCommitFrequencyInHours <Int64?>]: Commit frequency in hours for disk cache backups from automatic schedules [ScheduleOptionDaysBetweenAutoConvert <Int64?>]: Number of days between auto conversion of backup level applicable for databases on incremental and differential schedules of server plan [ScheduleOptionJobRunningTimeInMins <Int64?>]: total job running time in minutes [ScheduleOptionLogFilesThreshold <Int64?>]: The min number of archived log files before a backup job should start [ScheduleOptionLogsDiskUtilizationPercent <Int64?>]: The min log destination disk threshold percentage [ScheduleOptionMinBackupIntervalInMins <Int64?>]: The min number of mins to check for file activity on automatic schedule. [ScheduleOptionO365ItemSelectionOption <String>]: item backup option for O365 V2 backup jobs [ScheduleOptionUseDiskCacheForLogBackups <Boolean?>]: Used to enable disk caching feature on databases for automatic schedules on server plan [SchedulePatternDayOfMonth <Int64?>]: Day on which to run the schedule, applicable for monthly, yearly [SchedulePatternDayOfWeek <String>]: [SchedulePatternDaysBetweenSyntheticFulls <Int64?>]: No of days between two synthetic full jobs [SchedulePatternEndDate <Int64?>]: Schedule end date in epoch format [SchedulePatternExceptions <IScheduleRunException[]>]: Exceptions to when a schedule should not run, either in dates or week of month and days [OnDates <Int64[]>]: list of dates in a month. For ex: 1, 20 [OnDayOfTheWeek <String[]>]: On which days, for ex: MONDAY, FRIDAY [OnWeekOfTheMonth <String[]>]: On which week of month, for ex: FIRST, LAST [SchedulePatternFrequency <Int64?>]: Frequency of the schedule based on schedule frequency type eg. for Hours, value 2 is 2 hours, for Minutes, 30 is 30 minutes, for Daily, 2 is 2 days. for Monthly 2 is it repeats every 2 months [SchedulePatternMaxBackupIntervalInMins <Int64?>]: The number of mins to force a backup on automatic schedule. [SchedulePatternMonthOfYear <String>]: [SchedulePatternNoOfTimes <Int64?>]: The number of times you want the schedule to run. [SchedulePatternRepeatIntervalInMinutes <Int64?>]: How often in minutes in a day the schedule runs, applicable for daily, weekly, monthly and yearly frequency types. [SchedulePatternRepeatUntilTime <Int64?>]: Until what time to repeat the schedule in a day, requires repeatIntervalInMinutes [SchedulePatternStartDate <Int64?>]: start date of schedule in epoch format [SchedulePatternStartTime <Int64?>]: start time of schedule in seconds [SchedulePatternWeekOfMonth <String>]: Specific week of a month [SchedulePatternWeeklyDays <String[]>]: Days of the week for weekly frequency [TimezoneId <Int64?>]: [TimezoneName <String>]: [VMOperationType <String>]: Type of DR operation (only applicable for Failover groups) BODY <IUpdateServerPlan>: . [AllowPlanOverride <Boolean?>]: Flag to enable overriding of plan. Once enabled, cannot be disabled. [BackupContentBackupSystemState <Boolean?>]: Do you want to back up the system state? Applicable only for Windows [BackupContentBackupSystemStateOnlyWithFullBackup <Boolean?>]: Do you want to back up system state only with full backup? Applicable only if the value of backupSystemState is true [BackupContentForceUpdateProperties <Boolean?>]: Do you want to sync properties on associated subclients even if properties are overriden at subclient level? [BackupContentMacExcludedPaths <String[]>]: Paths to exclude for Mac [BackupContentMacFilterToExcludePaths <String[]>]: Paths that are exception to excluded paths for Mac [BackupContentMacIncludedPaths <String[]>]: Paths to include for Mac [BackupContentUnixExcludedPaths <String[]>]: Paths to exclude for UNIX [BackupContentUnixFilterToExcludePaths <String[]>]: Paths that are exception to excluded paths for Unix [BackupContentUnixIncludedPaths <String[]>]: Paths to include for UNIX [BackupContentUseVssForSystemState <Boolean?>]: Do you want to back up system state with VSS? Applicable only if the value of backupSystemState is true [BackupContentWindowsExcludedPaths <String[]>]: Paths to exclude for Windows [BackupContentWindowsFilterToExcludePaths <String[]>]: Paths that are exception to excluded paths for Windows [BackupContentWindowsIncludedPaths <String[]>]: Paths to include for Windows [BackupCopyFrequency <Int64?>]: Frequency of the schedule based on schedule frequency type eg. for Hours, value 2 is 2 hours, for Minutes, 30 is 30 minutes, for Daily, 2 is 2 days. for Monthly 2 is it repeats every 2 months [BackupCopyFrequencyDayOfMonth <Int64?>]: Day on which to run the schedule, applicable for monthly, yearly [BackupCopyFrequencyDayOfWeek <String>]: [BackupCopyFrequencyMonthOfYear <String>]: [BackupCopyFrequencyScheduleFrequencyType <String>]: schedule frequency type [BackupCopyFrequencyStartTime <Int64?>]: start time of schedule in seconds for daily, weekly, monthly, yearly frequency [BackupCopyFrequencyWeekOfMonth <String>]: Specific week of a month [BackupCopyFrequencyWeeklyDays <String[]>]: Days of the week for weekly frequency [BackupDestinationIds <Int64[]>]: Primary Backup Destination Ids (which were created before plan creation). [BackupFrequencyOperationType <String>]: Operation type for the list [BackupFrequencySchedules <IPlanSchedule[]>]: BackupType <String>: Schedule Backup level SchedulePatternScheduleFrequencyType <String>: schedule frequency type [ForDatabasesOnly <Boolean?>]: Boolean to indicate if schedule is for database agents [IsRetentionBasedSyntheticFull <Boolean?>]: Boolean to indicate if synthetic full schedule is based on retention rules [PolicyId <Int64?>]: Schedule policy Id to which the schedule belongs [ScheduleId <Int64?>]: Id of the schedule if available, required for modifying, deleting schedule [ScheduleName <String>]: Name of the schedule, for modify [ScheduleOperation <String>]: Operation being performed on schedule [ScheduleOptionCommitFrequencyInHours <Int64?>]: Commit frequency in hours for disk cache backups from automatic schedules [ScheduleOptionDaysBetweenAutoConvert <Int64?>]: Number of days between auto conversion of backup level applicable for databases on incremental and differential schedules of server plan [ScheduleOptionJobRunningTimeInMins <Int64?>]: total job running time in minutes [ScheduleOptionLogFilesThreshold <Int64?>]: The min number of archived log files before a backup job should start [ScheduleOptionLogsDiskUtilizationPercent <Int64?>]: The min log destination disk threshold percentage [ScheduleOptionMinBackupIntervalInMins <Int64?>]: The min number of mins to check for file activity on automatic schedule. [ScheduleOptionO365ItemSelectionOption <String>]: item backup option for O365 V2 backup jobs [ScheduleOptionUseDiskCacheForLogBackups <Boolean?>]: Used to enable disk caching feature on databases for automatic schedules on server plan [SchedulePatternDayOfMonth <Int64?>]: Day on which to run the schedule, applicable for monthly, yearly [SchedulePatternDayOfWeek <String>]: [SchedulePatternDaysBetweenSyntheticFulls <Int64?>]: No of days between two synthetic full jobs [SchedulePatternEndDate <Int64?>]: Schedule end date in epoch format [SchedulePatternExceptions <IScheduleRunException[]>]: Exceptions to when a schedule should not run, either in dates or week of month and days [OnDates <Int64[]>]: list of dates in a month. For ex: 1, 20 [OnDayOfTheWeek <String[]>]: On which days, for ex: MONDAY, FRIDAY [OnWeekOfTheMonth <String[]>]: On which week of month, for ex: FIRST, LAST [SchedulePatternFrequency <Int64?>]: Frequency of the schedule based on schedule frequency type eg. for Hours, value 2 is 2 hours, for Minutes, 30 is 30 minutes, for Daily, 2 is 2 days. for Monthly 2 is it repeats every 2 months [SchedulePatternMaxBackupIntervalInMins <Int64?>]: The number of mins to force a backup on automatic schedule. [SchedulePatternMonthOfYear <String>]: [SchedulePatternNoOfTimes <Int64?>]: The number of times you want the schedule to run. [SchedulePatternRepeatIntervalInMinutes <Int64?>]: How often in minutes in a day the schedule runs, applicable for daily, weekly, monthly and yearly frequency types. [SchedulePatternRepeatUntilTime <Int64?>]: Until what time to repeat the schedule in a day, requires repeatIntervalInMinutes [SchedulePatternStartDate <Int64?>]: start date of schedule in epoch format [SchedulePatternStartTime <Int64?>]: start time of schedule in seconds [SchedulePatternWeekOfMonth <String>]: Specific week of a month [SchedulePatternWeeklyDays <String[]>]: Days of the week for weekly frequency [TimezoneId <Int64?>]: [TimezoneName <String>]: [VMOperationType <String>]: Type of DR operation (only applicable for Failover groups) [DatabaseOptionCommitFrequencyInHours <Int64?>]: Commit frequency in hours [DatabaseOptionLogBackupRpoMins <Int64?>]: Log backup RPO in minutes [DatabaseOptionRunFullBackupEvery <Int64?>]: Full backup frequency in days [DatabaseOptionUseDiskCacheForLogBackups <Boolean?>]: Use disk cache for log backups [FileSearchEnabled <Boolean?>]: Flag for enabling indexing [FileSearchErrors <IPlanFileSearchSetupError[]>]: File search was enabled on plan but failed to process some of the storage pool(s) with these errors [ErrorCode <Int64?>]: [ErrorMessage <String>]: Tells about the error occured during file search setup for given storage pool [StorageId <Int64?>]: [StorageName <String>]: [FileSearchStatus <String>]: Type of indexing status. [FileSearchStatusMessage <String>]: Tells what is happening behind the scene, so that user can knows why indexing is not enabled or if its in progress [FilesystemAddon <Boolean?>]: flag to enable backup content association for applicable file system workload. [MacNumberOfDataReaderCount <Int64?>]: Number of data readers. [MacNumberOfDataReaderUseOptimal <Boolean?>]: Set optimal number of data readers. if it is set to true, count will be ignored. [NewName <String>]: New plan name to update [OverrideInheritSettingBackupContent <Boolean?>]: Flag to specify if parent or derived plan backupContent should be used when inherit mode is optional. True - derived, False - Base. [OverrideInheritSettingBackupDestination <Boolean?>]: Flag to specify if parent or derived plan backupDestination should be used when inherit mode is optional. True - derived, False - Base. [OverrideInheritSettingRpo <Boolean?>]: Flag to specify if parent or derived plan rpo should be used when inherit mode is optional. True - derived, False - Base. [OverrideRestrictionBackupContent <String>]: [OverrideRestrictionRpo <String>]: [OverrideRestrictionStoragePool <String>]: [RegionToConfigureId <Int64?>]: [RegionToConfigureName <String>]: [RpoBackupWindow <IDayAndTime[]>]: Backup window for incremental backup [DayOfWeek <String[]>]: [EndTime <Int64?>]: Time in seconds since the beginning of the day [StartTime <Int64?>]: Time in seconds since the beginning of the day [RpoFullBackupWindow <IDayAndTime[]>]: Backup window for full backup [SettingEnableAdvancedView <Boolean?>]: Setting to suggest plan has some advanced settings present. Setting is OEM specific and not applicable for all cases. [SlaEnableAfterDelay <Int64?>]: Time provided in Unix format. Give 0 to reset any existing delay. [SlaExcludeFromSla <Boolean?>]: Flag to set to exclude plan from SLA [SlaExclusionReason <String>]: Reason for exclusion from SLA [SlaLogSlaMinutes <Int64?>]: Database log SLA period in Minutes [SlaPeriod <Int64?>]: SLA Period in Days [SlaUseSystemDefaultSla <Boolean?>]: Flag to set to use System Default Service Level Agreement [SnapshotOptionBackupCopyRpoMins <Int64?>]: Backup copy RPO in minutes [SnapshotOptionEnableBackupCopy <Boolean?>]: Flag to enable backup copy [UnixNumberOfDataReaderCount <Int64?>]: Number of data readers. [UnixNumberOfDataReaderUseOptimal <Boolean?>]: Set optimal number of data readers. if it is set to true, count will be ignored. [WindowNumberOfDataReaderCount <Int64?>]: Number of data readers. [WindowNumberOfDataReaderUseOptimal <Boolean?>]: Set optimal number of data readers. if it is set to true, count will be ignored. [WorkloadGroupTypes <String[]>]: [WorkloadSolutions <IIdName[]>]: [Id <Int64?>]: [Name <String>]: [WorkloadTypes <IIdName[]>]: FILESEARCHERRORS <IPlanFileSearchSetupError[]>: File search was enabled on plan but failed to process some of the storage pool(s) with these errors [ErrorCode <Int64?>]: [ErrorMessage <String>]: Tells about the error occured during file search setup for given storage pool [StorageId <Int64?>]: [StorageName <String>]: 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?>]: RPOBACKUPWINDOW <IDayAndTime[]>: Backup window for incremental backup [DayOfWeek <String[]>]: [EndTime <Int64?>]: Time in seconds since the beginning of the day [StartTime <Int64?>]: Time in seconds since the beginning of the day RPOFULLBACKUPWINDOW <IDayAndTime[]>: Backup window for full backup [DayOfWeek <String[]>]: [EndTime <Int64?>]: Time in seconds since the beginning of the day [StartTime <Int64?>]: Time in seconds since the beginning of the day WORKLOADSOLUTIONS <IIdName[]>: . [Id <Int64?>]: [Name <String>]: WORKLOADTYPES <IIdName[]>: . [Id <Int64?>]: [Name <String>]: .Link https://docs.microsoft.com/en-us/powershell/module/commvaultpowershell/invoke-cvmodifyplan #> function Invoke-CVModifyPlan { [OutputType([Commvault.Powershell.Models.IGenericResp])] [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 Plan to update ${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.IUpdateServerPlan] # . # 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.Management.Automation.SwitchParameter] # Flag to enable overriding of plan. # Once enabled, cannot be disabled. ${AllowPlanOverride}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.Management.Automation.SwitchParameter] # Do you want to back up the system state Applicable only for Windows ${BackupContentBackupSystemState}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.Management.Automation.SwitchParameter] # Do you want to back up system state only with full backup Applicable only if the value of backupSystemState is true ${BackupContentBackupSystemStateOnlyWithFullBackup}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.Management.Automation.SwitchParameter] # Do you want to sync properties on associated subclients even if properties are overriden at subclient level ${BackupContentForceUpdateProperties}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.String[]] # Paths to exclude for Mac ${BackupContentMacExcludedPaths}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.String[]] # Paths that are exception to excluded paths for Mac ${BackupContentMacFilterToExcludePaths}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.String[]] # Paths to include for Mac ${BackupContentMacIncludedPaths}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.String[]] # Paths to exclude for UNIX ${BackupContentUnixExcludedPaths}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.String[]] # Paths that are exception to excluded paths for Unix ${BackupContentUnixFilterToExcludePaths}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.String[]] # Paths to include for UNIX ${BackupContentUnixIncludedPaths}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.Management.Automation.SwitchParameter] # Do you want to back up system state with VSS Applicable only if the value of backupSystemState is true ${BackupContentUseVssForSystemState}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.String[]] # Paths to exclude for Windows ${BackupContentWindowsExcludedPaths}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.String[]] # Paths that are exception to excluded paths for Windows ${BackupContentWindowsFilterToExcludePaths}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.String[]] # Paths to include for Windows ${BackupContentWindowsIncludedPaths}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.Int64] # Frequency of the schedule based on schedule frequency type eg. # for Hours, value 2 is 2 hours, for Minutes, 30 is 30 minutes, for Daily, 2 is 2 days. # for Monthly 2 is it repeats every 2 months ${BackupCopyFrequency}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.Int64] # Day on which to run the schedule, applicable for monthly, yearly ${BackupCopyFrequencyDayOfMonth}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.String] # . ${BackupCopyFrequencyDayOfWeek}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.String] # . ${BackupCopyFrequencyMonthOfYear}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.String] # schedule frequency type ${BackupCopyFrequencyScheduleFrequencyType}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.Int64] # start time of schedule in seconds for daily, weekly, monthly, yearly frequency ${BackupCopyFrequencyStartTime}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.String] # Specific week of a month ${BackupCopyFrequencyWeekOfMonth}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.String[]] # Days of the week for weekly frequency ${BackupCopyFrequencyWeeklyDays}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.Int64[]] # Primary Backup Destination Ids (which were created before plan creation). ${BackupDestinationIds}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.String] # Operation type for the list ${BackupFrequencyOperationType}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [Commvault.Powershell.Models.IPlanSchedule[]] # . # To construct, see NOTES section for BACKUPFREQUENCYSCHEDULES properties and create a hash table. ${BackupFrequencySchedules}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.Int64] # Commit frequency in hours ${DatabaseOptionCommitFrequencyInHours}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.Int64] # Log backup RPO in minutes ${DatabaseOptionLogBackupRpoMins}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.Int64] # Full backup frequency in days ${DatabaseOptionRunFullBackupEvery}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.Management.Automation.SwitchParameter] # Use disk cache for log backups ${DatabaseOptionUseDiskCacheForLogBackups}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.Management.Automation.SwitchParameter] # Flag for enabling indexing ${FileSearchEnabled}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [Commvault.Powershell.Models.IPlanFileSearchSetupError[]] # File search was enabled on plan but failed to process some of the storage pool(s) with these errors # To construct, see NOTES section for FILESEARCHERRORS properties and create a hash table. ${FileSearchErrors}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.String] # Type of indexing status. ${FileSearchStatus}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.String] # Tells what is happening behind the scene, so that user can knows why indexing is not enabled or if its in progress ${FileSearchStatusMessage}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.Management.Automation.SwitchParameter] # flag to enable backup content association for applicable file system workload. ${FilesystemAddon}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.Int64] # Number of data readers. ${MacNumberOfDataReaderCount}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.Management.Automation.SwitchParameter] # Set optimal number of data readers. # if it is set to true, count will be ignored. ${MacNumberOfDataReaderUseOptimal}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.String] # New plan name to update ${NewName}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.Management.Automation.SwitchParameter] # Flag to specify if parent or derived plan backupContent should be used when inherit mode is optional. # True - derived, False - Base. ${OverrideInheritSettingBackupContent}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.Management.Automation.SwitchParameter] # Flag to specify if parent or derived plan backupDestination should be used when inherit mode is optional. # True - derived, False - Base. ${OverrideInheritSettingBackupDestination}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.Management.Automation.SwitchParameter] # Flag to specify if parent or derived plan rpo should be used when inherit mode is optional. # True - derived, False - Base. ${OverrideInheritSettingRpo}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.String] # . ${OverrideRestrictionBackupContent}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.String] # . ${OverrideRestrictionRpo}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.String] # . ${OverrideRestrictionStoragePool}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.Int64] # . ${RegionToConfigureId}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.String] # . ${RegionToConfigureName}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [Commvault.Powershell.Models.IDayAndTime[]] # Backup window for incremental backup # To construct, see NOTES section for RPOBACKUPWINDOW properties and create a hash table. ${RpoBackupWindow}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [Commvault.Powershell.Models.IDayAndTime[]] # Backup window for full backup # To construct, see NOTES section for RPOFULLBACKUPWINDOW properties and create a hash table. ${RpoFullBackupWindow}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.Management.Automation.SwitchParameter] # Setting to suggest plan has some advanced settings present. # Setting is OEM specific and not applicable for all cases. ${SettingEnableAdvancedView}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.Int64] # Time provided in Unix format. # Give 0 to reset any existing delay. ${SlaEnableAfterDelay}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.Management.Automation.SwitchParameter] # Flag to set to exclude plan from SLA ${SlaExcludeFromSla}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.String] # Reason for exclusion from SLA ${SlaExclusionReason}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.Int64] # Database log SLA period in Minutes ${SlaLogSlaMinutes}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.Int64] # SLA Period in Days ${SlaPeriod}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.Management.Automation.SwitchParameter] # Flag to set to use System Default Service Level Agreement ${SlaUseSystemDefaultSla}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.Int64] # Backup copy RPO in minutes ${SnapshotOptionBackupCopyRpoMins}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.Management.Automation.SwitchParameter] # Flag to enable backup copy ${SnapshotOptionEnableBackupCopy}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.Int64] # Number of data readers. ${UnixNumberOfDataReaderCount}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.Management.Automation.SwitchParameter] # Set optimal number of data readers. # if it is set to true, count will be ignored. ${UnixNumberOfDataReaderUseOptimal}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.Int64] # Number of data readers. ${WindowNumberOfDataReaderCount}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.Management.Automation.SwitchParameter] # Set optimal number of data readers. # if it is set to true, count will be ignored. ${WindowNumberOfDataReaderUseOptimal}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.String[]] # . ${WorkloadGroupTypes}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [Commvault.Powershell.Models.IIdName[]] # . # To construct, see NOTES section for WORKLOADSOLUTIONS properties and create a hash table. ${WorkloadSolutions}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [Commvault.Powershell.Models.IIdName[]] # . # To construct, see NOTES section for WORKLOADTYPES properties and create a hash table. ${WorkloadTypes}, [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-CVModifyPlan_Modify'; ModifyExpanded = 'CommvaultPowershell.private\Invoke-CVModifyPlan_ModifyExpanded'; ModifyViaIdentity = 'CommvaultPowershell.private\Invoke-CVModifyPlan_ModifyViaIdentity'; ModifyViaIdentityExpanded = 'CommvaultPowershell.private\Invoke-CVModifyPlan_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 } } } |