Scripts/Vlan/Get-CohesityVlan.ps1
|
function Get-CohesityVlan { <# .SYNOPSIS Request to fetch all Vlan configuration filtered by specified parameters. .DESCRIPTION The Get-CohesityVlan function is used to fetch list of all configured Vlan information using REST API or specific Vlan information based on specified parameters. .EXAMPLE Get-CohesityVlan List all configured Vlans .EXAMPLE Get-CohesityVlan -SkipPrimaryAndBondIface "true" SkipPrimaryAndBondIface is to filter interfaces entries which are primary interface or bond interfaces .EXAMPLE Get-CohesityVlan -VlanId 222 Returns the VLAN corresponding to the specified VLAN ID or a specified vlan interface group name. .EXAMPLE Get-CohesityVlan -TenantIds 333 Retuns the Vlan that are configured for the specific tenant. TenantIds contains list of/specific id(s) of the tenants for which configured Vlans are to be returned. #> [CmdletBinding()] Param( # Filter interfaces entries which are primary interface or bond interfaces. [Parameter(Mandatory = $false)][ValidateSet("true", "false")] [String]$SkipPrimaryAndBondIface, # TenantIds contains ids of the tenants for which objects are to be returned. [Parameter(Mandatory = $false)] [String[]]$TenantIds = $null, [Parameter(Mandatory = $false)] # Specifies the vlan Id. [Int64]$VlanId ) Begin { } Process { # Form query parameters $Parameters = [ordered]@{} $Parameters.Add('allUnderHierarchy', $true) if ($SkipPrimaryAndBondIface) { $Parameters.Add('skipPrimaryAndBondIface', [System.Convert]::ToBoolean($SkipPrimaryAndBondIface)) } if ($null -ne $TenantIds) { $Parameters.Add('tenantIds', $TenantIds -join ',') } $queryString = $null if ($null -ne $Parameters.Keys) { $queryString = '?' + ($Parameters.Keys.ForEach({"$_=$($Parameters.$_)"}) -join '&') } # Construct URL & header $url = '/irisservices/api/v1/public/vlans' if($VlanId) { $url = $url + '/' + $VlanId } $url = $url + $queryString $vlanList = Invoke-RestApi -Method 'Get' -Uri $url $vlanList if ($null -eq $vlanList) { if ($Global:CohesityAPIError) { if ($Global:CohesityAPIError.StatusCode -eq 'NotFound') { $errorMsg = "Vlan doesn't exist." Write-Warning $errorMsg } else { $errorMsg = "Failed to fetch Vlan information with an error : " + $Global:CohesityAPIError } } else { $errorMsg = "Vlan doesn't exist." Write-Warning $errorMsg } CSLog -Message $errorMsg } } # End of process } # End of function |