Remove-UxResource

NAME Remove-UxResource



SYNOPSIS

This cmdlet initates a DELETE request to remove a UX resource. For full list of valid resources refer to

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





SYNTAX

Remove-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.



You can delete any resource which supports DELETE request.





PARAMETERS

-uxSession <PSObject>



Required? false

Position? 1

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? 2

Default value

Accept pipeline input? false

Accept wildcard characters? false



-ReturnElement <String>



Required? false

Position? 3

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Arguments <String>



Required? false

Position? 4

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Index <Int32>



Required? false

Position? 5

Default value 0

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:\\>Extract the transformation table id of the table you want to delete



get-uxtransformationtable



Now execute remove-uxresource cmdlet to delete the transformation table

remove-uxresource -resource transformationtable/13









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



PS C:\\>Same as Above but if you are scripting it use -confirm:$false



get-uxtransformationtable



Now execute remove-uxresource cmdlet to delete the transformation table

remove-uxresource -resource transformationtable/13 -confirm:$false









-------------------------- EXAMPLE 3 --------------------------



PS C:\\>Extract the SIP Server table resource and find the id of the table you want to delete



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



Now execute remove-uxresource cmdlet

remove-uxresource -resource sipservertable/10











RELATED LINKS

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