< Back

Invoke-ArubaCXRestMethod

Sat Jan 18, 2020 8:33 pm

NAME Invoke-ArubaCXRestMethod



SYNOPSIS

Invoke RestMethod with ArubaCX connection (internal) variable





SYNTAX

Invoke-ArubaCXRestMethod [-uri] <String> [-method <String>] [-body <PSObject>] [-depth <Int32>]

[<CommonParameters>]



Invoke-ArubaCXRestMethod [-uri] <String> [-method <String>] [-body <PSObject>] [-depth <Int32>] [-selector

<String>] [<CommonParameters>]



Invoke-ArubaCXRestMethod [-uri] <String> [-method <String>] [-body <PSObject>] [-depth <Int32>] [-attributes

<String[]>] [<CommonParameters>]





DESCRIPTION

Invoke RestMethod with ArubaCX connection variable (token, csrf..)





PARAMETERS

-uri <String>



Required? true

Position? 2

Default value

Accept pipeline input? false

Accept wildcard characters? false



-method <String>



Required? false

Position? named

Default value get

Accept pipeline input? false

Accept wildcard characters? false



-body <PSObject>



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-depth <Int32>



Required? false

Position? named

Default value 0

Accept pipeline input? false

Accept wildcard characters? false



-selector <String>



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-attributes <String[]>



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:\\>Invoke-ArubaCXRestMethod -method "get" -uri "rest/v1/system"



Invoke-RestMethod with ArubaCX connection for get rest/v1/system









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



PS C:\\>Invoke-ArubaCXRestMethod "rest/v1/system"



Invoke-RestMethod with ArubaCX connection for get rest/v1/system uri with default GET method parameter









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



PS C:\\>Invoke-ArubaCXRestMethod -method "post" -uri "rest/v1/system" -body $body



Invoke-RestMethod with ArubaCX connection for post rest/v1/system uri with $body payload









-------------------------- EXAMPLE 4 --------------------------



PS C:\\>Invoke-ArubaCXRestMethod -method "get" -uri "rest/v1/system" -depth 1 -selector configuration



Invoke-RestMethod with ArubaCX connection for get rest/v1/system with depth 1 and select only configuration









-------------------------- EXAMPLE 5 --------------------------



PS C:\\>Invoke-ArubaCXRestMethod -method "get" -uri "rest/v1/system" -attributes hostname, dns_servers



Invoke-RestMethod with ArubaCX connection for get rest/v1/system with display only attributes hostname and

dns_servers











RELATED LINKS





CommonParameters : False

WorkflowCommonParameters : False

details : @{name=Set-ArubaCXCipherSSL; noun=; verb=}

Syntax : @{syntaxItem=System.Object[]}

parameters : @{parameter=System.Object[]}

inputTypes : @{inputType=}

returnValues : @{returnValue=}

aliases : None



remarks : None

alertSet :

description :

examples :

Synopsis :

Set-ArubaCXCipherSSL



ModuleName : PowerArubaCX

nonTerminatingErrors :

xmlns:command : http://schemas.microsoft.com/maml/dev/command/2004/10

xmlns:dev : http://schemas.microsoft.com/maml/dev/2004/10

xmlns:maml : http://schemas.microsoft.com/maml/2004/10

Name : Set-ArubaCXCipherSSL

Category : Function

Component :

Role :

Functionality :





CommonParameters : False

WorkflowCommonParameters : False

details : @{name=Set-ArubaCXuntrustedSSL; noun=; verb=}

Syntax : @{syntaxItem=System.Object[]}

parameters : @{parameter=System.Object[]}

inputTypes : @{inputType=}

returnValues : @{returnValue=}

aliases : None



remarks : None

alertSet :

description :

examples :

Synopsis :

Set-ArubaCXuntrustedSSL



ModuleName : PowerArubaCX

nonTerminatingErrors :

xmlns:command : http://schemas.microsoft.com/maml/dev/command/2004/10

xmlns:dev : http://schemas.microsoft.com/maml/dev/2004/10

xmlns:maml : http://schemas.microsoft.com/maml/2004/10

Name : Set-ArubaCXuntrustedSSL

Category : Function

Component :

Role :

Functionality :





CommonParameters : True

WorkflowCommonParameters : False

details : @{name=Show-ArubaCXException; noun=; verb=}

Syntax : @{syntaxItem=System.Object[]}

parameters : @{parameter=System.Object[]}

inputTypes : @{inputType=}

returnValues : @{returnValue=}

aliases : None



remarks : None

alertSet :

description :

examples :

Synopsis :

Show-ArubaCXException [-Exception] <Object> [<CommonParameters>]



ModuleName : PowerArubaCX

nonTerminatingErrors :

xmlns:command : http://schemas.microsoft.com/maml/dev/command/2004/10

xmlns:dev : http://schemas.microsoft.com/maml/dev/2004/10

xmlns:maml : http://schemas.microsoft.com/maml/2004/10

Name : Show-ArubaCXException

Category : Function

Component :

Role :

Functionality :