J81.ADCToolkit

2210.2317

Public/Invoke-ADCNitroApi.ps1

                                function Invoke-ADCNitroApi {

    <#

    .SYNOPSIS

        Invoke ADC NITRO REST API

    .DESCRIPTION

        Invoke ADC NITRO REST API

    .PARAMETER ADCSession

        An existing custom ADC Web Request Session object returned by Connect-ADCNode

    .PARAMETER Method

        Specifies the method used for the web request

    .PARAMETER Type

        Type of the ADC appliance resource

    .PARAMETER Resource

        Name of the ADC appliance resource, optional

    .PARAMETER Action

        Name of the action to perform on the ADC appliance resource

    .PARAMETER Arguments

        One or more arguments for the web request, in hashtable format

    .PARAMETER Query

        Specifies a query that can be send  in the web request

    .PARAMETER Filters

        Specifies a filter that can be send to the remote server, in hashtable format

    .PARAMETER Payload

        Payload  of the web request, in hashtable format

    .PARAMETER GetWarning

        Switch parameter, when turned on, warning message will be sent in 'message' field and 'WARNING' value is set in severity field of the response in case there is a warning.

        Turned off by default

    .PARAMETER Summary

        Return a subset of the requested data (if supported)

    .PARAMETER NitroPath

        Specify the nitro path to the specified command.

        E.g. 'nitro/v1/config'

    .PARAMETER OnErrorAction

        Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.

        Acceptable values: "EXIT", "CONTINUE", "ROLLBACK", default to "EXIT"

    .EXAMPLE

        PS C:\>Invoke-ADCNitroApi -ADCSession $ADCSession -Method GET -Type nsip

    .EXAMPLE

        PS C:\>$Payload = @{ name = $name }; Invoke-ADCNitroApi -ADCSession $ADCSession -Method POST -NitroPath nitro/v1/config -Type lbvserver -Action enable -Payload $Payload

        Specify payload and invoke the specified api

    .NOTES

        File Name : Invoke-ADCNitroApi

        Version   : v2111.1520

        Author    : John Billekens

        Requires  : PowerShell v5.1 and up

                    ADC 11.x and up

                    Initial source https://github.com/devblackops/NetScaler

    #>

    [CmdletBinding()]

    param (

        [alias("Session")]

        [Parameter(Mandatory)]

        [PSObject]$ADCSession,

        [Parameter(Mandatory)]

        [ValidateSet('DELETE', 'GET', 'POST', 'PUT')]

        [string]$Method,

        [Parameter(Mandatory)]

        [string]$Type,

        [string]$Resource,

        [string]$Action,

        [hashtable]$Arguments = @{ },

        [ValidateCount(0, 1)]

        [hashtable]$Query = @{ },

        [ValidateScript( { $Method -in 'GET', 'GET-ALL' })]

        [hashtable]$Filters = @{ },

        [ValidateScript( { $Method -ne 'GET' })]

        [hashtable]$Payload = @{ },

        [switch]$GetWarning = $false,

        [ValidateScript( { $Method -in 'GET', 'GET-ALL' })]

        [switch]$Summary = $false,

        [ValidateSet('EXIT', 'CONTINUE', 'ROLLBACK')]

        [string]$OnErrorAction = 'EXIT',

        [ValidatePattern('^nitro\/v[0-9]\/(config|stat)$')]

        [string]$NitroPath = "nitro/v1/config",

        [Parameter(DontShow, ValueFromRemainingArguments)]

        [Object]$RemainingArguments

    )

    if ([string]::IsNullOrEmpty($($ADCSession.ManagementURL.AbsoluteUri))) {

        throw "ERROR. Probably not logged into the ADC, Connect by running `"Connect-ADCNode`""

    }

    $uri = "$($ADCSession.ManagementURL.AbsoluteUri)$($NitroPath)/$Type"

    if (-not ([string]::IsNullOrEmpty($Resource))) {

        $uri += "/$Resource"

    }

    if ($Method -ne 'GET') {

        if (-not ([string]::IsNullOrEmpty($Action))) {

            $uri += "?action=$Action"

        }

        if ($Arguments.Count -gt 0) {

            $queryPresent = $true

            if ($uri -like '*?action*') {

                $uri += '&args='

            } else {

                $uri += '?args='

            }

            $argsList = @()

            foreach ($arg in $Arguments.GetEnumerator()) {

                $argsList += "$($arg.Name):$([System.Uri]::EscapeDataString($arg.Value))"

            }

            $uri += $argsList -join ','

        }

    } else {

        $queryPresent = $false

        if ($Arguments.Count -gt 0) {

            $queryPresent = $true

            $uri += '?args='

            $argsList = @()

            foreach ($arg in $Arguments.GetEnumerator()) {

                $argsList += "$($arg.Name):$([System.Uri]::EscapeDataString($arg.Value))"

            }

            $uri += $argsList -join ','

        }

        if ($Filters.Count -gt 0) {

            $uri += if ($queryPresent) { '&filter=' } else { '?filter=' }

            $filterList = @()

            foreach ($filter in $Filters.GetEnumerator()) {

                $filterList += "$($filter.Name):$([System.Uri]::EscapeDataString($filter.Value))"

            }

            $uri += $filterList -join ','

        }

        if ($Query.Count -gt 0) {

            $uri += $Query.GetEnumerator() | ForEach-Object { "?$($_.Name)=$([System.Uri]::EscapeDataString($_.Value))" }

        }

        if ($Summary) {

            $uri += "?view=$([System.Uri]::EscapeDataString("summary"))"

        }

    }

    Write-Verbose -Message "URI: $uri"

    $jsonPayload = $null

    if ($Method -ne 'GET') {

        $warning = if ($GetWarning) { 'YES' } else { 'NO' }

        $hashtablePayload = @{ }

        $hashtablePayload.'params' = @{'warning' = $warning; 'onerror' = $OnErrorAction; <#"action"=$Action#> }

        $hashtablePayload.$Type = $Payload

        $jsonPayload = ConvertTo-Json -InputObject $hashtablePayload -Depth 100

        Write-Verbose -Message "Method: $Method | Payload:`n$jsonPayload"

    }

    $response = [PSCustomObject]@{

        errorcode = 0

        message   = "Done"

        severity  = "NONE"

    }

    $webResult = $null

    $restError = $null

    try {

        $restError = @()

        $restParams = @{

            Uri           = $uri

            ContentType   = 'application/json'

            Method        = $Method

            WebSession    = $ADCSession.WebSession

            ErrorVariable = 'restError'

            Verbose       = $false

        }

        if ($Method -ne 'GET') {

            $restParams.Add('Body', $jsonPayload)

        }

        if ((-Not ('PSEdition' -notin $PSVersionTable.Keys -or $PSVersionTable.PSEdition -eq 'Desktop')) -and ($uri -match "^https://.*?$")) {

            $restParams.Add("SkipCertificateCheck", $true)

        }

        #$response = Invoke-RestMethod @restParams

        $webResult = Invoke-WebRequest @restParams

        if (-Not [String]::IsNullOrEmpty($($webResult.Content))) {

            $response = ConvertFrom-Json $([String]::new($webResult.Content))

        }

    } catch [Exception] {

        try {

            $response = $restError.Message | ConvertFrom-Json -ErrorAction Stop

        } catch {

            $response = $restError.Message

        }

        if ($restError.InnerException.Message) {

            $response | Add-Member -MemberType NoteProperty -Name ErrorMessage -Value $restError.InnerException.Message-ErrorAction SilentlyContinue

        }

        if ($Type -eq 'reboot' -and $restError[0].Message -eq 'The underlying connection was closed: The connection wasclosed unexpectedly.') {

            Write-Warning -Message 'Connection closed due to reboot'

        } else {

            if ([String]::IsNullOrEmpty($($restError.Message)) -and -not ($ErrorActionPreference -eq "SilentlyContinue")) {

                Throw $_.Exception.Message

            }

        }

    }

    if ($response -and $type) {

        $response | Add-Member -MemberType NoteProperty -Name type -Value $Type -ErrorAction SilentlyContinue

    }

    if ($webResult.statuscode) {

        $response | Add-Member -MemberType NoteProperty -Name StatusCode -Value $webResult.statuscode -ErrorAction SilentlyContinue

    }

    if ($webResult.StatusDescription) {

        $response | Add-Member -MemberType NoteProperty -Name StatusDescription -Value $webResult.StatusDescription -ErrorAction SilentlyContinue

    }

    Write-Output $response

    if (($response.severity -eq 'ERROR') -and -not ($ErrorActionPreference -eq "SilentlyContinue")) {

        Write-Verbose "ERROR: $($response | Format-List -Property * | Out-String)"

        Throw "[$($response.errorcode)] $($response.message)"

    }

}

# SIG # Begin signature block

# MIITYgYJKoZIhvcNAQcCoIITUzCCE08CAQExDzANBglghkgBZQMEAgEFADB5Bgor

# BgEEAYI3AgEEoGswaTA0BgorBgEEAYI3AgEeMCYCAwEAAAQQH8w7YFlLCE63JNLG

# KX7zUQIBAAIBAAIBAAIBAAIBADAxMA0GCWCGSAFlAwQCAQUABCCp/PvNTDTOZ/Uv

# lANCEEwIDHKg2munBZgNZTIQ9+ABVaCCEHUwggTzMIID26ADAgECAhAsJ03zZBC0

# i/247uUvWN5TMA0GCSqGSIb3DQEBCwUAMHwxCzAJBgNVBAYTAkdCMRswGQYDVQQI

# ExJHcmVhdGVyIE1hbmNoZXN0ZXIxEDAOBgNVBAcTB1NhbGZvcmQxGDAWBgNVBAoT

# D1NlY3RpZ28gTGltaXRlZDEkMCIGA1UEAxMbU2VjdGlnbyBSU0EgQ29kZSBTaWdu

# aW5nIENBMB4XDTIxMDUwNTAwMDAwMFoXDTI0MDUwNDIzNTk1OVowWzELMAkGA1UE

# BhMCTkwxEjAQBgNVBAcMCVZlbGRob3ZlbjEbMBkGA1UECgwSSm9oYW5uZXMgQmls

# bGVrZW5zMRswGQYDVQQDDBJKb2hhbm5lcyBCaWxsZWtlbnMwggEiMA0GCSqGSIb3

# DQEBAQUAA4IBDwAwggEKAoIBAQCsfgRG81keOHalHfCUgxOa1Qy4VNOnGxB8SL8e

# rjP9SfcF13McP7F1HGka5Be495pTZ+duGbaQMNozwg/5Dg9IRJEeBabeSSJJCbZo

# SNpmUu7NNRRfidQxlPC81LxTVHxJ7In0MEfCVm7rWcri28MRCAuafqOfSE+hyb1Z

# /tKyCyQ5RUq3kjs/CF+VfMHsJn6ZT63YqewRkwHuc7UogTTZKjhPJ9prGLTer8UX

# UgvsGRbvhYZXIEuy+bmx/iJ1yRl1kX4nj6gUYzlhemOnlSDD66YOrkLDhXPMXLym

# AN7h0/W5Bo//R5itgvdGBkXkWCKRASnq/9PTcoxW6mwtgU8xAgMBAAGjggGQMIIB

# jDAfBgNVHSMEGDAWgBQO4TqoUzox1Yq+wbutZxoDha00DjAdBgNVHQ4EFgQUZWMy

# gC0i1u2NZ1msk2Mm5nJm5AswDgYDVR0PAQH/BAQDAgeAMAwGA1UdEwEB/wQCMAAw

# EwYDVR0lBAwwCgYIKwYBBQUHAwMwEQYJYIZIAYb4QgEBBAQDAgQQMEoGA1UdIARD

# MEEwNQYMKwYBBAGyMQECAQMCMCUwIwYIKwYBBQUHAgEWF2h0dHBzOi8vc2VjdGln

# by5jb20vQ1BTMAgGBmeBDAEEATBDBgNVHR8EPDA6MDigNqA0hjJodHRwOi8vY3Js

# LnNlY3RpZ28uY29tL1NlY3RpZ29SU0FDb2RlU2lnbmluZ0NBLmNybDBzBggrBgEF

# BQcBAQRnMGUwPgYIKwYBBQUHMAKGMmh0dHA6Ly9jcnQuc2VjdGlnby5jb20vU2Vj

# dGlnb1JTQUNvZGVTaWduaW5nQ0EuY3J0MCMGCCsGAQUFBzABhhdodHRwOi8vb2Nz

# cC5zZWN0aWdvLmNvbTANBgkqhkiG9w0BAQsFAAOCAQEARjv9ieRocb1DXRWm3XtY

# jjuSRjlvkoPd9wS6DNfsGlSU42BFd9LCKSyRREZVu8FDq7dN0PhD4bBTT+k6AgrY

# KG6f/8yUponOdxskv850SjN2S2FeVuR20pqActMrpd1+GCylG8mj8RGjdrLQ3QuX

# qYKS68WJ39WWYdVB/8Ftajir5p6sAfwHErLhbJS6WwmYjGI/9SekossvU8mZjZwo

# Gbu+fjZhPc4PhjbEh0ABSsPMfGjQQsg5zLFjg/P+cS6hgYI7qctToo0TexGe32DY

# fFWHrHuBErW2qXEJvzSqM5OtLRD06a4lH5ZkhojhMOX9S8xDs/ArDKgX1j1Xm4Tu

# DjCCBYEwggRpoAMCAQICEDlyRDr5IrdR19NsEN0xNZUwDQYJKoZIhvcNAQEMBQAw

# ezELMAkGA1UEBhMCR0IxGzAZBgNVBAgMEkdyZWF0ZXIgTWFuY2hlc3RlcjEQMA4G

# A1UEBwwHU2FsZm9yZDEaMBgGA1UECgwRQ29tb2RvIENBIExpbWl0ZWQxITAfBgNV

# BAMMGEFBQSBDZXJ0aWZpY2F0ZSBTZXJ2aWNlczAeFw0xOTAzMTIwMDAwMDBaFw0y

# ODEyMzEyMzU5NTlaMIGIMQswCQYDVQQGEwJVUzETMBEGA1UECBMKTmV3IEplcnNl

# eTEUMBIGA1UEBxMLSmVyc2V5IENpdHkxHjAcBgNVBAoTFVRoZSBVU0VSVFJVU1Qg

# TmV0d29yazEuMCwGA1UEAxMlVVNFUlRydXN0IFJTQSBDZXJ0aWZpY2F0aW9uIEF1

# dGhvcml0eTCCAiIwDQYJKoZIhvcNAQEBBQADggIPADCCAgoCggIBAIASZRc2DsPb

# CLPQrFcNdu3NJ9NMrVCDYeKqIE0JLWQJ3M6Jn8w9qez2z8Hc8dOx1ns3KBErR9o5

# xrw6GbRfpr19naNjQrZ28qk7K5H44m/Q7BYgkAk+4uh0yRi0kdRiZNt/owbxiBhq

# kCI8vP4T8IcUe/bkH47U5FHGEWdGCFHLhhRUP7wz/n5snP8WnRi9UY41pqdmyHJn

# 2yFmsdSbeAPAUDrozPDcvJ5M/q8FljUfV1q3/875PbcstvZU3cjnEjpNrkyKt1ya

# tLcgPcp/IjSufjtoZgFE5wFORlObM2D3lL5TN5BzQ/Myw1Pv26r+dE5px2uMYJPe

# xMcM3+EyrsyTO1F4lWeL7j1W/gzQaQ8bD/MlJmszbfduR/pzQ+V+DqVmsSl8MoRj

# VYnEDcGTVDAZE6zTfTen6106bDVc20HXEtqpSQvf2ICKCZNijrVmzyWIzYS4sT+k

# OQ/ZAp7rEkyVfPNrBaleFoPMuGfi6BOdzFuC00yz7Vv/3uVzrCM7LQC/NVV0CUnY

# SVgaf5I25lGSDvMmfRxNF7zJ7EMm0L9BX0CpRET0medXh55QH1dUqD79dGMvsVBl

# CeZYQi5DGky08CVHWfoEHpPUJkZKUIGy3r54t/xnFeHJV4QeD2PW6WK61l9VLupc

# xigIBCU5uA4rqfJMlxwHPw1S9e3vL4IPAgMBAAGjgfIwge8wHwYDVR0jBBgwFoAU

# oBEKIz6W8Qfs4q8p74Klf9AwpLQwHQYDVR0OBBYEFFN5v1qqK0rPVIDh2JvAnfKy

# A2bLMA4GA1UdDwEB/wQEAwIBhjAPBgNVHRMBAf8EBTADAQH/MBEGA1UdIAQKMAgw

# BgYEVR0gADBDBgNVHR8EPDA6MDigNqA0hjJodHRwOi8vY3JsLmNvbW9kb2NhLmNv

# bS9BQUFDZXJ0aWZpY2F0ZVNlcnZpY2VzLmNybDA0BggrBgEFBQcBAQQoMCYwJAYI

# KwYBBQUHMAGGGGh0dHA6Ly9vY3NwLmNvbW9kb2NhLmNvbTANBgkqhkiG9w0BAQwF

# AAOCAQEAGIdR3HQhPZyK4Ce3M9AuzOzw5steEd4ib5t1jp5y/uTW/qofnJYt7wNK

# fq70jW9yPEM7wD/ruN9cqqnGrvL82O6je0P2hjZ8FODN9Pc//t64tIrwkZb+/UNk

# fv3M0gGhfX34GRnJQisTv1iLuqSiZgR2iJFODIkUzqJNyTKzuugUGrxx8VvwQQuY

# AAoiAxDlDLH5zZI3Ge078eQ6tvlFEyZ1r7uq7z97dzvSxAKRPRkA0xdcOds/exgN

# Rc2ThZYvXd9ZFk8/Ub3VRRg/7UqO6AZhdCMWtQ1QcydER38QXYkqa4UxFMToqWpM

# gLxqeM+4f452cpkMnf7XkQgWoaNflTCCBfUwggPdoAMCAQICEB2iSDBvmyYY0ILg

# ln0z02owDQYJKoZIhvcNAQEMBQAwgYgxCzAJBgNVBAYTAlVTMRMwEQYDVQQIEwpO

# ZXcgSmVyc2V5MRQwEgYDVQQHEwtKZXJzZXkgQ2l0eTEeMBwGA1UEChMVVGhlIFVT

# RVJUUlVTVCBOZXR3b3JrMS4wLAYDVQQDEyVVU0VSVHJ1c3QgUlNBIENlcnRpZmlj

# YXRpb24gQXV0aG9yaXR5MB4XDTE4MTEwMjAwMDAwMFoXDTMwMTIzMTIzNTk1OVow

# fDELMAkGA1UEBhMCR0IxGzAZBgNVBAgTEkdyZWF0ZXIgTWFuY2hlc3RlcjEQMA4G

# A1UEBxMHU2FsZm9yZDEYMBYGA1UEChMPU2VjdGlnbyBMaW1pdGVkMSQwIgYDVQQD

# ExtTZWN0aWdvIFJTQSBDb2RlIFNpZ25pbmcgQ0EwggEiMA0GCSqGSIb3DQEBAQUA

# A4IBDwAwggEKAoIBAQCGIo0yhXoYn0nwli9jCB4t3HyfFM/jJrYlZilAhlRGdDFi

# xRDtsocnppnLlTDAVvWkdcapDlBipVGREGrgS2Ku/fD4GKyn/+4uMyD6DBmJqGx7

# rQDDYaHcaWVtH24nlteXUYam9CflfGqLlR5bYNV+1xaSnAAvaPeX7Wpyvjg7Y96P

# v25MQV0SIAhZ6DnNj9LWzwa0VwW2TqE+V2sfmLzEYtYbC43HZhtKn52BxHJAteJf

# 7wtF/6POF6YtVbC3sLxUap28jVZTxvC6eVBJLPcDuf4vZTXyIuosB69G2flGHNyM

# fHEo8/6nxhTdVZFuihEN3wYklX0Pp6F8OtqGNWHTAgMBAAGjggFkMIIBYDAfBgNV

# HSMEGDAWgBRTeb9aqitKz1SA4dibwJ3ysgNmyzAdBgNVHQ4EFgQUDuE6qFM6MdWK

# vsG7rWcaA4WtNA4wDgYDVR0PAQH/BAQDAgGGMBIGA1UdEwEB/wQIMAYBAf8CAQAw

# HQYDVR0lBBYwFAYIKwYBBQUHAwMGCCsGAQUFBwMIMBEGA1UdIAQKMAgwBgYEVR0g

# ADBQBgNVHR8ESTBHMEWgQ6BBhj9odHRwOi8vY3JsLnVzZXJ0cnVzdC5jb20vVVNF

# UlRydXN0UlNBQ2VydGlmaWNhdGlvbkF1dGhvcml0eS5jcmwwdgYIKwYBBQUHAQEE

# ajBoMD8GCCsGAQUFBzAChjNodHRwOi8vY3J0LnVzZXJ0cnVzdC5jb20vVVNFUlRy

# dXN0UlNBQWRkVHJ1c3RDQS5jcnQwJQYIKwYBBQUHMAGGGWh0dHA6Ly9vY3NwLnVz

# ZXJ0cnVzdC5jb20wDQYJKoZIhvcNAQEMBQADggIBAE1jUO1HNEphpNveaiqMm/EA

# AB4dYns61zLC9rPgY7P7YQCImhttEAcET7646ol4IusPRuzzRl5ARokS9At3Wpwq

# QTr81vTr5/cVlTPDoYMot94v5JT3hTODLUpASL+awk9KsY8k9LOBN9O3ZLCmI2pZ

# aFJCX/8E6+F0ZXkI9amT3mtxQJmWunjxucjiwwgWsatjWsgVgG10Xkp1fqW4w2y1

# z99KeYdcx0BNYzX2MNPPtQoOCwR/oEuuu6Ol0IQAkz5TXTSlADVpbL6fICUQDRn7

# UJBhvjmPeo5N9p8OHv4HURJmgyYZSJXOSsnBf/M6BZv5b9+If8AjntIeQ3pFMcGc

# TanwWbJZGehqjSkEAnd8S0vNcL46slVaeD68u28DECV3FTSK+TbMQ5Lkuk/xYpMo

# JVcp+1EZx6ElQGqEV8aynbG8HArafGd+fS7pKEwYfsR7MUFxmksp7As9V1DSyt39

# ngVR5UR43QHesXWYDVQk/fBO4+L4g71yuss9Ou7wXheSaG3IYfmm8SoKC6W59J7u

# mDIFhZ7r+YMp08Ysfb06dy6LN0KgaoLtO0qqlBCk4Q34F8W2WnkzGJLjtXX4oemO

# CiUe5B7xn1qHI/+fpFGe+zmAEc3btcSnqIBv5VPU4OOiwtJbGvoyJi1qV3AcPKRY

# LqPzW0sH3DJZ84enGm1YMYICQzCCAj8CAQEwgZAwfDELMAkGA1UEBhMCR0IxGzAZ

# BgNVBAgTEkdyZWF0ZXIgTWFuY2hlc3RlcjEQMA4GA1UEBxMHU2FsZm9yZDEYMBYG

# A1UEChMPU2VjdGlnbyBMaW1pdGVkMSQwIgYDVQQDExtTZWN0aWdvIFJTQSBDb2Rl

# IFNpZ25pbmcgQ0ECECwnTfNkELSL/bju5S9Y3lMwDQYJYIZIAWUDBAIBBQCggYQw

# GAYKKwYBBAGCNwIBDDEKMAigAoAAoQKAADAZBgkqhkiG9w0BCQMxDAYKKwYBBAGC

# NwIBBDAcBgorBgEEAYI3AgELMQ4wDAYKKwYBBAGCNwIBFTAvBgkqhkiG9w0BCQQx

# IgQg4tnFJQamjzJlp0SKVW1fM5NItQiZKNB48icINdCacA0wDQYJKoZIhvcNAQEB

# BQAEggEAHsjcXzPK2LhR23wr7QSU/JZnHLEFqMBGV9kMUI2pcrtJ2E4fYSfRr2Ln

# +csbgaZOfp564J2n5MKZUX0HIRT8YO8rx64OupC8CMdBWLLAheMI4Tqh1JZAVbnc

# JFXUv7FACzdy2ubANodHrMxTygwxRn+nETiOdoV+L1xNvWes7Rvc5JHqX0WpOp4z

# Z3o+xrf3pZfaVoXh1iRXevvUQ//Bny32oQg/sJ2GGKJJjcwHX2sr68eKWRySbjH0

# 9EsZRF5ElKYEzu3Etw4ZvObD4i3/BM3JrCwoaB3IXl144/cRZPHGN/P7U9fWfZ7n

# w+SYIraj3DCGKcLyEXbLTJi6/SHlDQ==

# SIG # End signature block