Invoke-PSCUCMAxlQuery

NAME Invoke-PSCUCMAxlQuery



SYNOPSIS

Invoke an AXL Query





SYNTAX

Invoke-PSCUCMAxlQuery [-Entity] <String> [-Parameters] <Hashtable> [-EnableException] [-OutputXml] [-WhatIf]

[-Confirm] [<CommonParameters>]





DESCRIPTION

Invoke an AXL Query against the connected server.





PARAMETERS

-Entity <String>

AXL Entity to invoke.



Required? true

Position? 1

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Parameters <Hashtable>

Parameters for the AXL Entity.



Required? true

Position? 2

Default value

Accept pipeline input? false

Accept wildcard characters? false



-EnableException [<SwitchParameter>]

Replaces user friendly yellow warnings with bloody red exceptions of doom!

Use this if you want the function to throw terminating errors you want to catch.



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-OutputXml [<SwitchParameter>]

Output XML for the query instead of invoking it.



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-WhatIf [<SwitchParameter>]

What If?



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Confirm [<SwitchParameter>]

Confirm...



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



NOTES





OutputXML does *not* need a connected CUCM server to run.



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



PS C:\\>Invoke-PSCUCMAxlQuery -Entity getUser -Parameters @{ name = 'administrator' } -OutputXML



Outputs the XML that would be sent to CUCM server.











RELATED LINKS