Get-DattoBCDR

SYNOPSIS

Gets Datto BCDR devices and assets

SYNTAX

index_Devices (Default)

Get-DattoBCDR [-endpoint_Devices] [-showHiddenDevices <String>] [-showChildResellerDevices <String>]
 [-page <Int64>] [-perPage <Int64>] [-allPages] [<CommonParameters>]

index_Agents

Get-DattoBCDR [-endpoint_Agents] [-page <Int64>] [-perPage <Int64>] [-allPages] [<CommonParameters>]

index_byDevice

Get-DattoBCDR [-endpoint_byDevice] -serialNumber <String> [<CommonParameters>]

index_byDeviceAgent

Get-DattoBCDR [-endpoint_byDeviceAgent] -serialNumber <String> [-page <Int64>] [-perPage <Int64>] [-allPages]
 [<CommonParameters>]

index_byDeviceAlert

Get-DattoBCDR [-endpoint_byDeviceAlert] -serialNumber <String> [-page <Int64>] [-perPage <Int64>] [-allPages]
 [<CommonParameters>]

index_byDeviceAsset

Get-DattoBCDR [-endpoint_byDeviceAsset] -serialNumber <String> [-page <Int64>] [-perPage <Int64>] [-allPages]
 [<CommonParameters>]

index_byDeviceShare

Get-DattoBCDR [-endpoint_byDeviceShare] -serialNumber <String> [-page <Int64>] [-perPage <Int64>] [-allPages]
 [<CommonParameters>]

index_byDeviceVolume

Get-DattoBCDR [-endpoint_byDeviceVolume] -serialNumber <String> -volumeName <String> [<CommonParameters>]

DESCRIPTION

The Get-DattoBCDR cmdlet gets Datto BCDR devices and assets by combing all endpoints into a single command.

This unique function does not contain any Reporting or SaaS endpoints. This function was added to simply testing & generating reports

EXAMPLES

EXAMPLE 1

Get-DattoBCDR

Gets the first 100 Datto BCDR devices

This function uses the -endpoint_Devices switch by default

EXAMPLE 2

Get-DattoBCDR -endpoint_Agents -serialNumber '12345678'

Returns a list of BCDR clients and the agents under those clients

As of 2022-04 this endpoint always returns no data

EXAMPLE 3

Get-DattoBCDR -endpoint_byDevice -serialNumber '12345678'

Returns a single BCDR device registered under your portal

EXAMPLE 4

Get-DattoBCDR -endpoint_byDeviceAgent -serialNumber '12345678'

Returns a list BCDR agents from a given device

EXAMPLE 5

Get-DattoBCDR -endpoint_byDeviceAlert -serialNumber '12345678'

Returns a list BCDR alerts from a given device

EXAMPLE 6

Get-DattoBCDR -endpoint_byDeviceAsset -serialNumber '12345678'

Returns a list BCDR agents & shares from a given device

EXAMPLE 7

Get-DattoBCDR -endpoint_byDeviceShare -serialNumber '12345678'

Returns a list BCDR shares from a given device

EXAMPLE 8

Get-DattoBCDR -endpoint_byDeviceVolume -serialNumber '12345678'

Returns a list BCDR volumes from a given device

PARAMETERS

-endpoint_Agents

Returns a list of BCDR clients and the agents under those clients

As of 2022-04 this endpoint always returns no data

Endpoint = /bcdr/agent

Type: SwitchParameter
Parameter Sets: index_Agents
Aliases:

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

-endpoint_Devices

Returns a list of BCDR devices registered under your portal

Endpoint = /bcdr/device

Type: SwitchParameter
Parameter Sets: index_Devices
Aliases:

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

-endpoint_byDevice

Returns a single BCDR device registered under your portal

Endpoint = /bcdr/device/{serialNumber}

Type: SwitchParameter
Parameter Sets: index_byDevice
Aliases:

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

-endpoint_byDeviceAgent

Returns a list BCDR agents from a given device

Endpoint = /bcdr/device/{serialNumber}/asset/agent

Type: SwitchParameter
Parameter Sets: index_byDeviceAgent
Aliases:

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

-endpoint_byDeviceAlert

Returns a list BCDR alerts from a given device

Endpoint = /bcdr/device/{serialNumber}/alert

Type: SwitchParameter
Parameter Sets: index_byDeviceAlert
Aliases:

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

-endpoint_byDeviceAsset

Returns a list BCDR agents & shares from a given device

Endpoint = /bcdr/device/{serialNumber}/asset

Type: SwitchParameter
Parameter Sets: index_byDeviceAsset
Aliases:

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

-endpoint_byDeviceShare

Returns a list BCDR shares from a given device

Endpoint = /bcdr/device/{serialNumber}/asset/share

Type: SwitchParameter
Parameter Sets: index_byDeviceShare
Aliases:

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

-endpoint_byDeviceVolume

Returns a list BCDR volumes from a given device

Endpoint = /bcdr/device/{serialNumber}/asset/volume

Type: SwitchParameter
Parameter Sets: index_byDeviceVolume
Aliases:

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

-serialNumber

Defines the BCDR serial number to get information from

The parameter is mandatory if you want to get a specific device.

Type: String
Parameter Sets: index_byDevice, index_byDeviceAgent, index_byDeviceAlert, index_byDeviceAsset, index_byDeviceShare, index_byDeviceVolume
Aliases:

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

-showHiddenDevices

Whether hidden devices should be included in your results

Acceptable values are: ‘0’, ‘1’

By default ‘1’ is returned by the API which shows hidden devices.

Type: String
Parameter Sets: index_Devices
Aliases:

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

-showChildResellerDevices

Whether child reseller devices should be included in your results

Acceptable values are: ‘0’, ‘1’

By default ‘1’ is returned by the API which shows child reseller devices.

Type: String
Parameter Sets: index_Devices
Aliases:

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

-volumeName

Gets an asset(s)(agent or share) for a specific volume on a device

Type: String
Parameter Sets: index_byDeviceVolume
Aliases:

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

-page

Defines the page number to return

The default value is 1

Type: Int64
Parameter Sets: index_Devices, index_Agents, index_byDeviceAgent, index_byDeviceAlert, index_byDeviceAsset, index_byDeviceShare
Aliases:

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

-perPage

Defines the amount of items to return with each page

The default value is 100

Type: Int64
Parameter Sets: index_Devices, index_Agents, index_byDeviceAgent, index_byDeviceAlert, index_byDeviceAsset, index_byDeviceShare
Aliases:

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

-allPages

Returns all items from an endpoint

When using this parameter there is no need to use either the page or perPage parameters

Type: SwitchParameter
Parameter Sets: index_Devices, index_Agents, index_byDeviceAgent, index_byDeviceAlert, index_byDeviceAsset, index_byDeviceShare
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.