CommvaultPowerShell

0.2.20

exports/Disable-CVSchedulePolicy.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
Method to disable a schedule policy on the CommServe.
.Description
Method to disable a schedule policy on the CommServe.
.Example
PS C:\> {{ Add code here }}
 
{{ Add output here }}
.Example
PS C:\> {{ Add code here }}
 
{{ Add output here }}
 
.Inputs
System.Object
.Outputs
System.Management.Automation.PSObject
.Link
https://docs.microsoft.com/en-us/powershell/module/commvaultpowershell/disable-cvschedulepolicy
#>
function Disable-CVSchedulePolicy {
[OutputType([System.Management.Automation.PSObject])]
[CmdletBinding(DefaultParameterSetName='ByPolicyName', PositionalBinding=$false)]
param(
    [Parameter(ParameterSetName='ByPolicyName', Mandatory)]
    [Commvault.Powershell.Category('Body')]
    [System.String]
    # Specify the schedule policy to be disabled by Name.
    ${Name},

    [Parameter(ParameterSetName='ByPolicyId', Mandatory)]
    [Commvault.Powershell.Category('Body')]
    [System.Int32]
    # Specify the schedule policy to be disabled by Id (taskId).
    ${Id},

    [Parameter(ParameterSetName='ByPolicyObject', Mandatory, ValueFromPipeline, ValueFromPipelineByPropertyName)]
    [Commvault.Powershell.Category('Body')]
    [System.Object]
    # Specify the schedule policy to be disabled by piping the PolicyObject.
    ${PolicyObject},

    [Parameter(ParameterSetName='BySubclient', Mandatory)]
    [Commvault.Powershell.Category('Body')]
    [System.String]
    # Specify the ClientName associated with SubclientName.
    ${ClientName},

    [Parameter(ParameterSetName='BySubclient', Mandatory)]
    [Commvault.Powershell.Category('Body')]
    [System.String]
    # Specify the SubclientName.
    ${SubclientName}
)

begin {
    try {
        $outBuffer = $null
        if ($PSBoundParameters.TryGetValue('OutBuffer', [ref]$outBuffer)) {
            $PSBoundParameters['OutBuffer'] = 1
        }
        $parameterSet = $PSCmdlet.ParameterSetName
        $mapping = @{
            ByPolicyName = 'CommvaultPowershell.custom\Disable-CVSchedulePolicy';
            ByPolicyId = 'CommvaultPowershell.custom\Disable-CVSchedulePolicy';
            ByPolicyObject = 'CommvaultPowershell.custom\Disable-CVSchedulePolicy';
            BySubclient = 'CommvaultPowershell.custom\Disable-CVSchedulePolicy';
        }
        $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
    }
}
}