exports/Get-CVSQLInstance.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 SQL instances protected within the CommServe.
.Description
This method is implemented with Powershell paging support.
If the Name parameter is not provided, this method will output all protected SQL instances.
If the Name parameter is provided, SQL instances matching the name will be output.
.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/get-cvsqlinstance
#>

function Get-CVSQLInstance {
[OutputType([System.Management.Automation.PSObject])]
[CmdletBinding(DefaultParameterSetName='Default', PositionalBinding=$false)]
param(
    [Parameter()]
    [Commvault.Powershell.Category('Body')]
    [CVSQLInstanceSortColumn]
    # Sort SQL instances by: insId, insName, version, cName, noDBs, or planName.
    ${SortColumn},

    [Parameter()]
    [Commvault.Powershell.Category('Body')]
    [System.Management.Automation.SwitchParameter]
    # Sort SQL instances by specified column in descending order; default is ascending order.
    ${SortDescending},

    [Parameter()]
    [Commvault.Powershell.Category('Body')]
    [System.Management.Automation.SwitchParameter]
    # Get only SQL instances with missed SLAs.
    ${OnlySLA},

    [Parameter()]
    [Commvault.Powershell.Category('Body')]
    [System.Management.Automation.SwitchParameter]
    # Get SQL instances with all properties.
    ${AllProperties},

    [Parameter(ParameterSetName='ByName')]
    [Commvault.Powershell.Category('Body')]
    [System.String]
    # Get SQL instance specified by Name.
    ${Name},

    [Parameter(ParameterSetName='ByName')]
    [Commvault.Powershell.Category('Body')]
    [System.String]
    # Get SQL instances associated with ClientName.
    ${ClientName},

    [Parameter(ParameterSetName='ByObject', ValueFromPipeline, ValueFromPipelineByPropertyName)]
    [Commvault.Powershell.Category('Body')]
    [System.Object]
    # Get SQL instances associated with piped ClientObject.
    ${ClientObject}
)

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