Send-UxCommand

NAME Send-UxCommand



SYNOPSIS

This cmdlet initates a POST request to send commands to the UX resource. For full list of valid resources refer to

https://support.sonus.net/display/UXAPI ... e+-+system





SYNTAX

Send-UxCommand [[-uxSession] <PSObject>] [-Command] <String> [[-Arguments] <String>] [[-OutPutFilename] <String>]

[[-ReturnElement] <String>] [[-Credentials] <PSCredential>] [-WhatIf] [-Confirm] [<CommonParameters>]





DESCRIPTION

This cmdlet initates a POST request to modify existing UX resource. For full list of valid resources refer to

https://support.sonus.net/display/UXAPI ... e+-+system





PARAMETERS

-uxSession <PSObject>



Required? false

Position? 2

Default value $DefaultSession

Accept pipeline input? false

Accept wildcard characters? false



-Command <String>



Required? true

Position? 1

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Arguments <String>



Required? false

Position? 3

Default value

Accept pipeline input? false

Accept wildcard characters? false



-OutPutFilename <String>



Required? false

Position? 4

Default value

Accept pipeline input? false

Accept wildcard characters? false



-ReturnElement <String>



Required? false

Position? 5

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Credentials <PSCredential>



Required? false

Position? 6

Default value

Accept pipeline input? false

Accept wildcard characters? false



-WhatIf [<SwitchParameter>]



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Confirm [<SwitchParameter>]



Required? false

Position? named

Default value

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



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



PS C:\\>Send-UxCommand -command reboot













-------------------------- EXAMPLE 2 --------------------------



PS C:\\>Send-UxCommand -command reboot -uxSession $1stGateway















RELATED LINKS

To find all the resources which can be queried, please refer to https://support.sonus.net/display/UXAPIDOC