exports/New-CVPlanRule.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 plan rules. Request body will suggest plan against which rule need to be created and type of entities(workloads type, server groups, regions and all) that need to be referenced for applying that rule against a workload. .Description Api to create plan rules. Request body will suggest plan against which rule need to be created and type of entities(workloads type, server groups, regions and all) that need to be referenced for applying that rule against a workload. .Example PS C:\> {{ Add code here }} {{ Add output here }} .Example PS C:\> {{ Add code here }} {{ Add output here }} .Outputs Commvault.Powershell.Models.IGenericResp .Outputs Commvault.Powershell.Models.IIdName .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. GLOBALCONFIGINFOCOMMCELLS <IGlobalConfigCommcellInfo[]>: List of Service CommCells where the global configuration should be applied [Guid <String>]: [Id <Int64?>]: [Name <String>]: REGIONS <IIdNameGuid[]>: This will include list of regions that should be evaluated against workload region for plan association. [Guid <String>]: [Id <Int64?>]: [Name <String>]: SERVERGROUPS <IIdNameGuid[]>: This will include list of Server groups that should be evaluated against workload server group for plan association. [Guid <String>]: [Id <Int64?>]: [Name <String>]: SOLUTIONS <IIdName[]>: This will include list of solutions that should be evaluated against workload for plan association [Id <Int64?>]: [Name <String>]: TAGS <IPlanEntityRuleTag[]>: This will include list of tags that should be evaluated against workload for plan association [Guid <String>]: GUID for the tag [Id <Int64?>]: Id for the tag [Name <String>]: Name for the plan rule tag which need to be matched against tag of the workload. [Value <String>]: Possible value that need to matched against value of tag associated to workload. WORKLOADS <IIdName[]>: This will include list of apptypes that should be evaluated against workload apptype for plan association. [Id <Int64?>]: [Name <String>]: .Link https://docs.microsoft.com/en-us/powershell/module/commvaultpowershell/new-cvplanrule #> function New-CVPlanRule { [OutputType([Commvault.Powershell.Models.IIdName], [Commvault.Powershell.Models.IGenericResp])] [CmdletBinding(DefaultParameterSetName='CreateExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] param( [Parameter()] [Commvault.Powershell.Category('Body')] [System.Int64] # . ${CompanyId}, [Parameter()] [Commvault.Powershell.Category('Body')] [System.String] # . ${CompanyName}, [Parameter()] [Commvault.Powershell.Category('Body')] [System.String] # Action that will be taken on the local entity that has the same name as the global entity that needs to be created ${GlobalConfigInfoActionOnLocalEntity}, [Parameter()] [Commvault.Powershell.Category('Body')] [System.Management.Automation.SwitchParameter] # Decides whether the global configuration should be applied to all the Service commcells, including the newly created ones ${GlobalConfigInfoApplyOnAllCommCells}, [Parameter()] [Commvault.Powershell.Category('Body')] [Commvault.Powershell.Models.IGlobalConfigCommcellInfo[]] # List of Service CommCells where the global configuration should be applied # To construct, see NOTES section for GLOBALCONFIGINFOCOMMCELLS properties and create a hash table. ${GlobalConfigInfoCommcells}, [Parameter()] [Commvault.Powershell.Category('Body')] [System.String] # . ${GlobalConfigInfoName}, [Parameter()] [Commvault.Powershell.Category('Body')] [System.String] # The entity level at which the config has to be applied. ${GlobalConfigInfoScope}, [Parameter()] [Commvault.Powershell.Category('Body')] [System.String] # CommCellEntityCache filter query string using for filtering the scope ${GlobalConfigInfoScopeFilterQuery}, [Parameter()] [Commvault.Powershell.Category('Body')] [System.String] # . ${PlanGuid}, [Parameter()] [Commvault.Powershell.Category('Body')] [System.Int64] # . ${PlanId}, [Parameter()] [Commvault.Powershell.Category('Body')] [System.String] # . ${PlanName}, [Parameter()] [Commvault.Powershell.Category('Body')] [System.Int64] # Optional field to suggest priority/rank of the rule. # If not present, we will process rule in the same order they are created. ${Rank}, [Parameter()] [Commvault.Powershell.Category('Body')] [Commvault.Powershell.Models.IIdNameGuid[]] # This will include list of regions that should be evaluated against workload region for plan association. # To construct, see NOTES section for REGIONS properties and create a hash table. ${Regions}, [Parameter()] [Commvault.Powershell.Category('Body')] [Commvault.Powershell.Models.IIdNameGuid[]] # This will include list of Server groups that should be evaluated against workload server group for plan association. # To construct, see NOTES section for SERVERGROUPS properties and create a hash table. ${ServerGroups}, [Parameter()] [Commvault.Powershell.Category('Body')] [Commvault.Powershell.Models.IIdName[]] # This will include list of solutions that should be evaluated against workload for plan association # To construct, see NOTES section for SOLUTIONS properties and create a hash table. ${Solutions}, [Parameter()] [Commvault.Powershell.Category('Body')] [Commvault.Powershell.Models.IPlanEntityRuleTag[]] # This will include list of tags that should be evaluated against workload for plan association # To construct, see NOTES section for TAGS properties and create a hash table. ${Tags}, [Parameter()] [Commvault.Powershell.Category('Body')] [Commvault.Powershell.Models.IIdName[]] # This will include list of apptypes that should be evaluated against workload apptype for plan association. # To construct, see NOTES section for WORKLOADS properties and create a hash table. ${Workloads}, [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 = @{ CreateExpanded = 'CommvaultPowershell.private\New-CVPlanRule_CreateExpanded'; } $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 } } } |