Private/RestMethod.ps1
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 |
# # Copyright 2018, Alexis La Goutte <alexis dot lagoutte at gmail dot com> # # SPDX-License-Identifier: Apache-2.0 # function Invoke-FGTRestMethod { <# .SYNOPSIS Invoke RestMethod with FGT connection (internal) variable .DESCRIPTION Invoke RestMethod with FGT connection variable (token, csrf..) .EXAMPLE Invoke-FGTRestMethod -method "get" -uri "api/v2/cmdb/firewall/address" Invoke-RestMethod with FGT connection for get api/v2/cmdb/firewall/address uri .EXAMPLE Invoke-FGTRestMethod "api/v2/cmdb/firewall/address" Invoke-RestMethod with FGT connection for get api/v2/cmdb/firewall/address uri with default parameter .EXAMPLE Invoke-FGTRestMethod "-method "get" -uri api/v2/cmdb/firewall/address" -vdom vdomX Invoke-RestMethod with FGT connection for get api/v2/cmdb/firewall/address uri on vdomX .EXAMPLE Invoke-FGTRestMethod --method "post" -uri "api/v2/cmdb/firewall/address" -body $body Invoke-RestMethod with FGT connection for post api/v2/cmdb/firewall/address uri with $body payload .EXAMPLE Invoke-FGTRestMethod -method "get" -uri "api/v2/cmdb/firewall/address" -connection $fw2 Invoke-RestMethod with $fw2 connection for get api/v2/cmdb/firewall/address uri .EXAMPLE Invoke-FGTRestMethod -method "get" -uri "api/v2/cmdb/firewall/address" -filter=name==FGT Invoke-RestMethod with FGT connection for get api/v2/cmdb/firewall/address uri with only name equal FGT .EXAMPLE Invoke-FGTRestMethod -method "get" -uri "api/v2/cmdb/firewall/address" -filter_attribute name -filter_value FGT Invoke-RestMethod with FGT connection for get api/v2/cmdb/firewall/address uri with filter attribute equal name and filter value equal FGT .EXAMPLE Invoke-FGTRestMethod -method "get" -uri "api/v2/cmdb/firewall/address" -filter_attribute name -filter_type contains -filter_value FGT Invoke-RestMethod with FGT connection for get api/v2/cmdb/firewall/address uri with filter attribute equal name and filter value contains FGT #> [CmdletBinding(DefaultParameterSetName = "default")] Param( [Parameter(Mandatory = $true, position = 1)] [String]$uri, [Parameter(Mandatory = $false)] [ValidateSet("GET", "PUT", "POST", "DELETE")] [String]$method = "GET", [Parameter(Mandatory = $false)] [psobject]$body, [Parameter(Mandatory = $false)] [switch]$skip, [Parameter(Mandatory = $false)] [String[]]$vdom, [Parameter(Mandatory = $false)] [Parameter (ParameterSetName = "filter")] [String]$filter, [Parameter(Mandatory = $false)] [Parameter (ParameterSetName = "filter_build")] [string]$filter_attribute, [Parameter(Mandatory = $false)] [ValidateSet('equal', 'contains')] [Parameter (ParameterSetName = "filter_build")] [string]$filter_type, [Parameter (Mandatory = $false)] [Parameter (ParameterSetName = "filter_build")] [psobject]$filter_value, [Parameter(Mandatory = $false)] [psobject]$connection ) Begin { } Process { if ($null -eq $connection ) { if ($null -eq $DefaultFGTConnection) { Throw "Not Connected. Connect to the Fortigate with Connect-FGT" } $connection = $DefaultFGTConnection } $Server = $connection.Server $httpOnly = $connection.httpOnly $port = $connection.port $headers = $connection.headers $invokeParams = $connection.invokeParams $sessionvariable = $connection.session if ($httpOnly) { $fullurl = "http://${Server}:${port}/${uri}" } else { $fullurl = "https://${Server}:${port}/${uri}" } #Extra parameter... if ($fullurl -NotMatch "\?") { $fullurl += "?" } if ( $PsBoundParameters.ContainsKey('skip') ) { $fullurl += "&skip=1" } if ( $PsBoundParameters.ContainsKey('vdom') ) { $vdom = $vdom -Join ',' $fullurl += "&vdom=$vdom" } elseif ($connection.vdom) { $vdom = $connection.vdom -Join ',' $fullurl += "&vdom=$vdom" } #filter switch ( $filter_type ) { "equal" { $filter_value = "==" + $filter_value } "contains" { $filter_value = "=@" + $filter_value } #by default set to equal.. default { $filter_value = "==" + $filter_value } } if ($filter_attribute) { $filter = $filter_attribute + $filter_value } if ( $filter ) { $fullurl += "&filter=$filter" } try { if ($body) { Write-Verbose -message ($body | ConvertTo-Json) $response = Invoke-RestMethod $fullurl -Method $method -body ($body | ConvertTo-Json) -Headers $headers -WebSession $sessionvariable @invokeParams } else { $response = Invoke-RestMethod $fullurl -Method $method -Headers $headers -WebSession $sessionvariable @invokeParams } } catch { Show-FGTException $_ throw "Unable to use FortiGate API" } $response } } |