Get-DattoAgent

SYNOPSIS

Get Datto BCDR agents from a given device

SYNTAX

index (Default)

Get-DattoAgent [-page <Int64>] [-perPage <Int64>] [-allPages] [<CommonParameters>]

indexByDevice

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

DESCRIPTION

The Get-DattoAgent cmdlet get agents from a given BCDR device or for Endpoint Backup for PC agents (EB4PC)

To get agents from the Datto BCDR the serialNumber of the BCDR needs to be defined.

Endpoints: /bcdr/Agent Used for Endpoint Backup for PC agents (EB4PC)

/bcdr/device/serialNumber/Asset/Agent Used for BCDR agents

EXAMPLES

EXAMPLE 1

Get-DattoAgent

Gets a list of Endpoint Backup for PC (EB4PC) clients and the agents under those clients.

EXAMPLE 2

Get-DattoAgent -serialNumber "12345678"

Returns the agents from the defined Datto BCDR

EXAMPLE 3

Get-DattoAgent -serialNumber "12345678" -page 2 -perPage 10

Returns the first 10 agents from page 2 from the defined Datto BCDR

PARAMETERS

-serialNumber

Defines the BCDR serial number to get agents from

Type: String
Parameter Sets: indexByDevice
Aliases:

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

-page

Defines the page number to return

The default value is 1

Type: Int64
Parameter Sets: (All)
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: (All)
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: (All)
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/Datto-PowerShellWrapper/site/BCDR/Get-DattoAgent.html