Set-UxResource

NAME Set-UxResource



SYNOPSIS

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

https://support.sonus.net/display/UXAPIDOC





SYNTAX

Set-UxResource [[-uxSession] <PSObject>] [-resource] <String> [[-ReturnElement] <String>] [[-Arguments] <String>]

[-Index] <Int32> [[-Credentials] <PSCredential>] [-WhatIf] [-Confirm] [<CommonParameters>]





DESCRIPTION

Whilst primarily used by the internal functions, you can use this function with your own scripts.

As this is likely to overwrite some of your SBC settings the ConfirmPreferences have been set to HIGH!

If you would like to prevent the confirm prompt use -confirm:$false when calling this function.

This can be dangerous if you are looping consider yourself WARNED.





PARAMETERS

-uxSession <PSObject>



Required? false

Position? 6

Default value $DefaultSession

Accept pipeline input? false

Accept wildcard characters? false



-resource <String>

Enter a valid resource name here. For valid resource names refer to https://support.sonus.net/display/UXAPIDOC



Required? true

Position? 1

Default value

Accept pipeline input? false

Accept wildcard characters? false



-ReturnElement <String>



Required? false

Position? 4

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



-Index <Int32>



Required? true

Position? 2

Default value 0

Accept pipeline input? false

Accept wildcard characters? false



-Credentials <PSCredential>



Required? false

Position? 7

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:\\>Assume you want to change the description of one of the SIPServer table.



Using Get find the ID of the sip server table

((get-uxresource -resource sipservertable).sipservertable_list).sipservertable_pk



Once you have found the ID, issue the cmdlet below to modify the description

set-uxresource -args Description=SBA2 -resource sipservertable/20









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



PS C:\\>Assume you want to change Description of the transformation table.



Extract the transformation table id of the table you want to modify

get-uxtransformationtable



Once you have found the ID, issue the cmdlet below to modify the description

set-uxresource -args "Description=Test5" -resource "transformationtable/12"











RELATED LINKS

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