Get-AuvikComponent

SYNOPSIS

Get Auvik components and other related information

SYNTAX

IndexByMultiComponent (Default)

Get-AuvikComponent [-Tenants <String[]>] [-FilterModifiedAfter <DateTime>] [-FilterDeviceId <String>]
 [-FilterDeviceName <String>] [-FilterCurrentStatus <String>] [-PageFirst <Int64>] [-PageAfter <String>]
 [-PageLast <Int64>] [-PageBefore <String>] [-AllResults] [<CommonParameters>]

IndexBySingleComponent

Get-AuvikComponent -ID <String> [<CommonParameters>]

DESCRIPTION

The Get-AuvikComponent cmdlet allows you to view an inventory of components and other related information discovered by Auvik

EXAMPLES

EXAMPLE 1

Get-AuvikComponent

Gets general information about the first 100 components Auvik has discovered

EXAMPLE 2

Get-AuvikComponent -ID 123456789

Gets general information for the defined component Auvik has discovered

EXAMPLE 3

Get-AuvikComponent -PageFirst 1000 -AllResults

Gets general information for all components found by Auvik

PARAMETERS

-ID

ID of component

Type: String
Parameter Sets: IndexBySingleComponent
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-Tenants

Comma delimited list of tenant IDs to request info from

Type: String[]
Parameter Sets: IndexByMultiComponent
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-FilterModifiedAfter

Filter by date and time, only returning entities modified after provided value

Type: DateTime
Parameter Sets: IndexByMultiComponent
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-FilterDeviceId

Filter by the component’s parent device’s ID

Type: String
Parameter Sets: IndexByMultiComponent
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-FilterDeviceName

Filter by the component’s parent device’s name

Type: String
Parameter Sets: IndexByMultiComponent
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-FilterCurrentStatus

Filter by the component’s current status

Allowed values: “ok”, “degraded”, “failed”

Type: String
Parameter Sets: IndexByMultiComponent
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-PageFirst

For paginated responses, the first N elements will be returned Used in combination with page[after]

Default Value: 100

Type: Int64
Parameter Sets: IndexByMultiComponent
Aliases:

Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-PageAfter

Cursor after which elements will be returned as a page The page size is provided by page[first]

Type: String
Parameter Sets: IndexByMultiComponent
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-PageLast

For paginated responses, the last N services will be returned Used in combination with page[before]

Default Value: 100

Type: Int64
Parameter Sets: IndexByMultiComponent
Aliases:

Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-PageBefore

Cursor before which elements will be returned as a page The page size is provided by page[last]

Type: String
Parameter Sets: IndexByMultiComponent
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-AllResults

Returns all items from an endpoint

Highly recommended to only use with filters to reduce API errors\timeouts

Type: SwitchParameter
Parameter Sets: IndexByMultiComponent
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
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/Celerium.Auvik/site/Inventory/Get-AuvikComponent.html