Cohesity.PowerShell

1.7.6

Scripts/Vault/Get-CohesityVault.ps1

function Get-CohesityVault {
    <#
        .SYNOPSIS
        Get cohesity vault (external targets).
        .DESCRIPTION
        List the Vaults (External Targets) registered on the Cohesity Cluster filtered by the specified parameters.
        .NOTES
        Published by Cohesity
        .LINK
        https://cohesity.github.io/cohesity-powershell-module/#/README
        .EXAMPLE
        Get-CohesityVault -VaultName "nas-archival"
        Lists the vault filtered by the vault name.
        .EXAMPLE
        Get-CohesityVault
    #>
    [CmdletBinding()]
    Param(
        [Parameter(Mandatory = $false)]
        # Specifies the vault name to filter.
        $VaultName=$null
    )
    Begin {
    }
    Process {
        $url = '/irisservices/api/v1/public/vaults'
        if ($VaultName) {
            $url = $url + '?name=' + $VaultName
        }
        $resp = Invoke-RestApi -Method Get -Uri $url
        $resp
    }
    End {
    }

}