Get-AuvikComponent

SYNOPSIS

Get Auvik components and other related information

SYNTAX

indexByMultiComponentGeneral (Default)

Get-AuvikComponent [-tenants <String[]>] [-filter_modifiedAfter <DateTime>] [-filter_deviceId <String>]
 [-filter_deviceName <String>] [-filter_currentStatus <String>] [-page_first <Int64>] [-page_after <String>]
 [-page_last <Int64>] [-page_before <String>] [-allPages] [<CommonParameters>]

indexBySingleComponentGeneral

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

Pulls general information about the first 100 components Auvik has discovered

EXAMPLE 2

Get-AuvikComponent -id 123456789

Pulls general information for the defined component Auvik has discovered

EXAMPLE 3

Get-AuvikComponent -page_first 1000 -allPages

Pulls general information for all components found by Auvik.

PARAMETERS

-id

ID of component

Type: String
Parameter Sets: indexBySingleComponentGeneral
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: indexByMultiComponentGeneral
Aliases:

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

-filter_modifiedAfter

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

Type: DateTime
Parameter Sets: indexByMultiComponentGeneral
Aliases:

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

-filter_deviceId

Filter by the component’s parent device’s ID

Type: String
Parameter Sets: indexByMultiComponentGeneral
Aliases:

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

-filter_deviceName

Filter by the component’s parent device’s name

Type: String
Parameter Sets: indexByMultiComponentGeneral
Aliases:

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

-filter_currentStatus

Filter by the component’s current status

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

Type: String
Parameter Sets: indexByMultiComponentGeneral
Aliases:

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

-page_first

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

Default Value: 100

Type: Int64
Parameter Sets: indexByMultiComponentGeneral
Aliases:

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

-page_after

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

Type: String
Parameter Sets: indexByMultiComponentGeneral
Aliases:

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

-page_last

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

Default Value: 100

Type: Int64
Parameter Sets: indexByMultiComponentGeneral
Aliases:

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

-page_before

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

Type: String
Parameter Sets: indexByMultiComponentGeneral
Aliases:

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

-allPages

Returns all items from an endpoint

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

Type: SwitchParameter
Parameter Sets: indexByMultiComponentGeneral
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/Auvik-PowerShellWrapper/site/inventory/Get-AuvikComponent.html