Invoke-SDWNitroRestApi

NAME Invoke-SDWNitroRestApi



SYNOPSIS

Invoke SDWAN NITRO REST API





SYNTAX

Invoke-SDWNitroRestApi [-SDWSession] <PSObject> [-OperationMethod] <String> [-ResourceType] <String>

[-ResourceName] <String> [[-SubResource] <String>] [[-Action] <String>] [[-Arguments] <Hashtable>] [[-Payload]

<Hashtable>] [-GetWarning] [[-OnErrorAction] <String>] [<CommonParameters>]





DESCRIPTION

Invoke SDWAN NITRO REST API





PARAMETERS

-SDWSession <PSObject>

An existing custom SDWAN Web Request Session object returned by Connect-SDWAppliance



Required? true

Position? 1

Default value

Accept pipeline input? false

Accept wildcard characters? false



-OperationMethod <String>

Specifies the method used for the web request (e.g. POST, PUT, GET, ADD, MODIFY, DELETE)



Required? true

Position? 2

Default value

Accept pipeline input? false

Accept wildcard characters? false



-ResourceType <String>

Type of the SDWAN appliance resource (e.g. config, monitor, config_editor, diag, download, mobile_broadband)



Required? true

Position? 3

Default value

Accept pipeline input? false

Accept wildcard characters? false



-ResourceName <String>

Name of the SDWAN appliance resource, optional (e.g. mangement_ip, config_packages, remote_licnese,

interface_groups, etc)



Required? true

Position? 4

Default value

Accept pipeline input? false

Accept wildcard characters? false



-SubResource <String>



Required? false

Position? 5

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Action <String>

Name of the action to perform on the SDWAN appliance resource (e.g. compile, enable_remote_server,

export_to_cm)



Required? false

Position? 6

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Arguments <Hashtable>



Required? false

Position? 7

Default value @{}

Accept pipeline input? false

Accept wildcard characters? false



-Payload <Hashtable>

Payload of the web request, in hashtable format



Required? false

Position? 8

Default value @{}

Accept pipeline input? false

Accept wildcard characters? false



-GetWarning [<SwitchParameter>]

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



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-OnErrorAction <String>

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

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



Required? false

Position? 9

Default value EXIT

Accept pipeline input? false

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



OUTPUTS

Only when the OperationMethod is GET:

PSCustomObject that represents the JSON response content. This object can be manipulated using the ConvertTo-Json

Cmdlet.





NOTES





Copyright (c) Citrix Systems, Inc. All rights reserved.



-------------------------- EXAMPLE 1 --------------------------



PS C:\\>#Invoke NITRO REST API to manaually set the management IP address.



@{gateway="172.30.200.1";netmask="255.255.255.0";ip_address="172.30.200.150"}

Invoke-SDWNitroRestApi -SDWSession $mySDWSession -OperationMethod PUT -ResourceType config -ResourceName

management_ip -Payload $ReqPayload











RELATED LINKS