exports/Get-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 retrieve schedule policies from the CommServe.
.Description
Method to retrieve schedule policies from the CommServe.
Output can be filtered by client/subclient or by policy name or id.
.Example
PS C:\> {{ Add code here }}
 
{{ Add output here }}
.Example
PS C:\> {{ Add code here }}
 
{{ Add output here }}
 
.Outputs
System.Management.Automation.PSObject
.Link
https://docs.microsoft.com/en-us/powershell/module/commvaultpowershell/get-cvschedulepolicy
#>

function Get-CVSchedulePolicy {
[OutputType([System.Management.Automation.PSObject])]
[CmdletBinding(DefaultParameterSetName='Default', PositionalBinding=$false)]
param(
    [Parameter()]
    [Commvault.Powershell.Category('Body')]
    [CVSchedulePolicyType]
    # Filter by ScheduleType: All (default), DataProtection, AuxiliaryCopy, BackupCopy, OfflineContentIndexing, DDBVerification, ContentIndexing, or Workflow.
    ${ScheduleType},

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

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

    [Parameter(ParameterSetName='ByName')]
    [Commvault.Powershell.Category('Body')]
    [System.String]
    # Filter output by policy Name.
    ${Name},

    [Parameter(ParameterSetName='ById')]
    [Commvault.Powershell.Category('Body')]
    [System.Int32]
    # Filter output by policy Id.
    ${Id}
)

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