exports/Invoke-CVModifyDcPlan.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 existing data classification plan .Description Used to modify an existing data classification 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.IUpdateDcPlan .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 <IUpdateDcPlan>: Describes Input to Update Data Classification Plan [ContentAnalyzer <IIdName[]>]: [Id <Int64?>]: [Name <String>]: [ContentIndexingBackupCopy <IDcBackupCopy[]>]: [CopyId <Int64?>]: [StoragePoolId <Int64?>]: [ContentIndexingContentLanguage <String>]: OCR Languages Supported By DC Plan [ContentIndexingDomainName <String>]: Associated Domain of user having access to preview path [ContentIndexingExactSearch <Boolean?>]: Whether Exact Search is enabled or disabled [ContentIndexingExtractTextFromImage <Boolean?>]: Whether Image Extraction is Enabled [ContentIndexingPreviewPath <String>]: Describes the Preview path for Content Indexed Data when search type is METADATA_CONTENT_PREVIEW [ContentIndexingSearchType <String>]: Describes the Content Indexing Operation Type for Data Classification Plan [ContentIndexingUserName <String>]: Associated user name of user having access to preview path [EntityDetectionClassifiers <IIdName[]>]: Classifier TagId For Extraction [EntityDetectionCopyPrecendence <Int64?>]: [EntityDetectionEntities <IIdName[]>]: Entity TagId for Extraction [FileFilterExcludePaths <String[]>]: [FileFilterIncludeDocTypes <String>]: [FileFilterMaxDocSize <Int64?>]: [FileFilterMinDocSize <Int64?>]: [Name <String>]: Name of the Data Classification plan [PatternDayOfMonth <Int64?>]: Day on which to run the schedule, applicable for monthly, yearly [PatternDayOfWeek <String>]: [PatternExceptions <IScheduleRunException[]>]: Exceptions to when a schedule should not run, either in dates or week of month and day [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 [PatternFrequency <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 [PatternMonthOfYear <String>]: [PatternScheduleFrequencyType <String>]: schedule frequency type [PatternStartDate <Int64?>]: start date of schedule in epoch format [PatternStartTime <Int64?>]: start time of schedule in seconds for daily, weekly, monthly, yearly frequency [PatternWeekOfMonth <String>]: Specific week of a month [PatternWeeklyDays <String[]>]: Days of the week for weekly frequency [ScheduleName <String>]: [ThreatAnalysis <Int64?>]: Enables\Disables Threat Analysis support for DC Plan CONTENTANALYZER <IIdName[]>: . [Id <Int64?>]: [Name <String>]: CONTENTINDEXINGBACKUPCOPY <IDcBackupCopy[]>: . [CopyId <Int64?>]: [StoragePoolId <Int64?>]: ENTITYDETECTIONCLASSIFIERS <IIdName[]>: Classifier TagId For Extraction [Id <Int64?>]: [Name <String>]: ENTITYDETECTIONENTITIES <IIdName[]>: Entity TagId for Extraction [Id <Int64?>]: [Name <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?>]: PATTERNEXCEPTIONS <IScheduleRunException[]>: Exceptions to when a schedule should not run, either in dates or week of month and day [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-cvmodifydcplan #> function Invoke-CVModifyDcPlan { [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] # . ${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.IUpdateDcPlan] # Describes Input to Update Data Classification Plan # To construct, see NOTES section for BODY properties and create a hash table. ${Body}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [Commvault.Powershell.Models.IIdName[]] # . # To construct, see NOTES section for CONTENTANALYZER properties and create a hash table. ${ContentAnalyzer}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [Commvault.Powershell.Models.IDcBackupCopy[]] # . # To construct, see NOTES section for CONTENTINDEXINGBACKUPCOPY properties and create a hash table. ${ContentIndexingBackupCopy}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.String] # OCR Languages Supported By DC Plan ${ContentIndexingContentLanguage}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.String] # Associated Domain of user having access to preview path ${ContentIndexingDomainName}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.Management.Automation.SwitchParameter] # Whether Exact Search is enabled or disabled ${ContentIndexingExactSearch}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.Management.Automation.SwitchParameter] # Whether Image Extraction is Enabled ${ContentIndexingExtractTextFromImage}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.String] # Describes the Preview path for Content Indexed Data when search type is METADATA_CONTENT_PREVIEW ${ContentIndexingPreviewPath}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.String] # Describes the Content Indexing Operation Type for Data Classification Plan ${ContentIndexingSearchType}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.String] # Associated user name of user having access to preview path ${ContentIndexingUserName}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [Commvault.Powershell.Models.IIdName[]] # Classifier TagId For Extraction # To construct, see NOTES section for ENTITYDETECTIONCLASSIFIERS properties and create a hash table. ${EntityDetectionClassifiers}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.Int64] # . ${EntityDetectionCopyPrecendence}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [Commvault.Powershell.Models.IIdName[]] # Entity TagId for Extraction # To construct, see NOTES section for ENTITYDETECTIONENTITIES properties and create a hash table. ${EntityDetectionEntities}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.String[]] # . ${FileFilterExcludePaths}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.String] # . ${FileFilterIncludeDocTypes}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.Int64] # . ${FileFilterMaxDocSize}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.Int64] # . ${FileFilterMinDocSize}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.String] # Name of the Data Classification plan ${Name}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.Int64] # Day on which to run the schedule, applicable for monthly, yearly ${PatternDayOfMonth}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.String] # . ${PatternDayOfWeek}, [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 day # To construct, see NOTES section for PATTERNEXCEPTIONS properties and create a hash table. ${PatternExceptions}, [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 ${PatternFrequency}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.String] # . ${PatternMonthOfYear}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.String] # schedule frequency type ${PatternScheduleFrequencyType}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.Int64] # start date of schedule in epoch format ${PatternStartDate}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.Int64] # start time of schedule in seconds for daily, weekly, monthly, yearly frequency ${PatternStartTime}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.String] # Specific week of a month ${PatternWeekOfMonth}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.String[]] # Days of the week for weekly frequency ${PatternWeeklyDays}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.String] # . ${ScheduleName}, [Parameter(ParameterSetName='ModifyExpanded')] [Parameter(ParameterSetName='ModifyViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.Int64] # Enables\Disables Threat Analysis support for DC Plan ${ThreatAnalysis}, [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-CVModifyDcPlan_Modify'; ModifyExpanded = 'CommvaultPowershell.private\Invoke-CVModifyDcPlan_ModifyExpanded'; ModifyViaIdentity = 'CommvaultPowershell.private\Invoke-CVModifyDcPlan_ModifyViaIdentity'; ModifyViaIdentityExpanded = 'CommvaultPowershell.private\Invoke-CVModifyDcPlan_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 } } } |