Get-AuvikMetaData

SYNOPSIS

Gets various Api metadata values

SYNTAX

Get-AuvikMetaData [[-base_uri] <String>] [<CommonParameters>]

DESCRIPTION

The Get-AuvikMetaData cmdlet gets various Api metadata values from an Invoke-WebRequest to assist in various troubleshooting scenarios such as rate-limiting.

EXAMPLES

EXAMPLE 1

Get-AuvikMetaData

Gets various Api metadata values from an Invoke-WebRequest to assist in various troubleshooting scenarios such as rate-limiting.

The default full base uri test path is: https://auvikapi.us1.my.auvik.com/v1

EXAMPLE 2

Get-AuvikMetaData -base_uri http://myapi.gateway.example.com

Gets various Api metadata values from an Invoke-WebRequest to assist in various troubleshooting scenarios such as rate-limiting.

The full base uri test path in this example is: http://myapi.gateway.example.com/device

PARAMETERS

-base_uri

Define the base URI for the Auvik API connection using Auvik’s URI or a custom URI.

The default base URI is https://auvikapi.us1.my.auvik.com/v1

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 1
Default value: $Auvik_Base_URI
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

NOTES

N\A

RELATED LINKS

https://celerium.github.io/Auvik-PowerShellWrapper/site/Internal/Get-AuvikMetaData.html