exports/Invoke-CVModifyFailoverGroupSchedule.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 API to create failover group DR operation schedule .Description API to create failover group DR operation schedule .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.IPlanSchedule .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. BODY <IPlanSchedule>: Used to describe single plan schedule information BackupType <String>: Schedule Backup level SchedulePatternScheduleFrequencyType <String>: schedule frequency type [ForDatabasesOnly <Boolean?>]: Boolean to indicate if schedule is for database agents [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 [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) 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?>]: [CloudStorageId <Int64?>]: Id of cloud Storage [ClusterId <Int64?>]: [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?>]: Unique id for the entity [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 [Name <String>]: [NameSpace <String>]: Name of the namespace to browse for content [NodeId <Int64?>]: Id of node [PairId <Int64?>]: [PlanId <Int64?>]: Id of the plan to fetch details [RecoveryTargetId <Int64?>]: id of recovery target [RegionId <Int64?>]: [RegionList <String>]: List of region names/ids to be deleted. If region ids are passed, set isRegionIdList=true [ReplicationGroupId <String>]: [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>]: GUID of the Provisioned VM [VMUuid <String>]: The vmUUID can be obtained from GET /virtualMachines UUID property [VendorId <Int64?>]: 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 .Link https://docs.microsoft.com/en-us/powershell/module/commvaultpowershell/invoke-cvmodifyfailovergroupschedule #> function Invoke-CVModifyFailoverGroupSchedule { [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 failover group ${FailoverGroupId}, [Parameter(ParameterSetName='Modify', Mandatory)] [Parameter(ParameterSetName='ModifyExpanded', Mandatory)] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Path')] [System.Int64] # ID of the DR operation schedule ${ScheduleId}, [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.IPlanSchedule] # Used to describe single plan schedule information # To construct, see NOTES section for BODY properties and create a hash table. ${Body}, [Parameter(ParameterSetName='ModifyExpanded', Mandatory)] [Parameter(ParameterSetName='ModifyViaIdentityExpanded', Mandatory)] [Commvault.Powershell.Category('Body')] [System.String] # Schedule Backup level ${BackupType}, [Parameter(ParameterSetName='ModifyExpanded', Mandatory)] [Parameter(ParameterSetName='ModifyViaIdentityExpanded', Mandatory)] [Commvault.Powershell.Category('Body')] [System.String] # schedule frequency type ${SchedulePatternScheduleFrequencyType}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.Management.Automation.SwitchParameter] # Boolean to indicate if schedule is for database agents ${ForDatabasesOnly}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.Int64] # Schedule policy Id to which the schedule belongs ${PolicyId}, [Parameter(ParameterSetName='ModifyExpanded')] [Commvault.Powershell.Category('Body')] [System.Int64] # Id of the schedule if available, required for modifying, deleting schedule ${ScheduleId1}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.String] # Name of the schedule, for modify ${ScheduleName}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.String] # Operation being performed on schedule ${ScheduleOperation}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.Int64] # Commit frequency in hours for disk cache backups from automatic schedules ${ScheduleOptionCommitFrequencyInHours}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.Int64] # Number of days between auto conversion of backup level applicable for databases on incremental and differential schedules of server plan ${ScheduleOptionDaysBetweenAutoConvert}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.Int64] # total job running time in minutes ${ScheduleOptionJobRunningTimeInMins}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.String] # item backup option for O365 V2 backup jobs ${ScheduleOptionO365ItemSelectionOption}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.Management.Automation.SwitchParameter] # Used to enable disk caching feature on databases for automatic schedules on server plan ${ScheduleOptionUseDiskCacheForLogBackups}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.Int64] # Day on which to run the schedule, applicable for monthly, yearly ${SchedulePatternDayOfMonth}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.String] # . ${SchedulePatternDayOfWeek}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.Int64] # No of days between two synthetic full jobs ${SchedulePatternDaysBetweenSyntheticFulls}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.Int64] # Schedule end date in epoch format ${SchedulePatternEndDate}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [Commvault.Powershell.Models.IScheduleRunException[]] # Exceptions to when a schedule should not run, either in dates or week of month and days # To construct, see NOTES section for SCHEDULEPATTERNEXCEPTIONS properties and create a hash table. ${SchedulePatternExceptions}, [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 ${SchedulePatternFrequency}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.Int64] # The number of mins to force a backup on automatic schedule. ${SchedulePatternMaxBackupIntervalInMins}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.String] # . ${SchedulePatternMonthOfYear}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.Int64] # The number of times you want the schedule to run. ${SchedulePatternNoOfTimes}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.Int64] # How often in minutes in a day the schedule runs, applicable for daily, weekly, monthly and yearly frequency types. ${SchedulePatternRepeatIntervalInMinutes}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.Int64] # Until what time to repeat the schedule in a day, requires repeatIntervalInMinutes ${SchedulePatternRepeatUntilTime}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.Int64] # start date of schedule in epoch format ${SchedulePatternStartDate}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.Int64] # start time of schedule in seconds ${SchedulePatternStartTime}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.String] # Specific week of a month ${SchedulePatternWeekOfMonth}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.String[]] # Days of the week for weekly frequency ${SchedulePatternWeeklyDays}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.Int64] # . ${TimezoneId}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.String] # . ${TimezoneName}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.String] # Type of DR operation (only applicable for Failover groups) ${VMOperationType}, [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(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-CVModifyFailoverGroupSchedule_Modify'; ModifyExpanded = 'CommvaultPowershell.private\Invoke-CVModifyFailoverGroupSchedule_ModifyExpanded'; ModifyViaIdentity = 'CommvaultPowershell.private\Invoke-CVModifyFailoverGroupSchedule_ModifyViaIdentity'; ModifyViaIdentityExpanded = 'CommvaultPowershell.private\Invoke-CVModifyFailoverGroupSchedule_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 } } } |