Get-AuvikTenant

SYNOPSIS

Get Auvik tenant information

SYNTAX

IndexMultiTenant (Default)

Get-AuvikTenant [<CommonParameters>]

IndexSingleTenantDetails

Get-AuvikTenant -TenantDomainPrefix <String> -ID <String> [<CommonParameters>]

IndexMultiTenantDetails

Get-AuvikTenant -TenantDomainPrefix <String> [-FilterAvailableTenants] [<CommonParameters>]

DESCRIPTION

The Get-AuvikTenant cmdlet get Auvik general or detailed tenant information associated to your Auvik user account

EXAMPLES

EXAMPLE 1

Get-AuvikTenant

Gets general information about multiple multi-clients and clients associated with your Auvik user account

EXAMPLE 2

Get-AuvikTenant -TenantDomainPrefix CeleriumMSP

Gets detailed information about multiple multi-clients and clients associated with your main Auvik account

EXAMPLE 3

Get-AuvikTenant -TenantDomainPrefix CeleriumMSP -ID 123456789

Gets detailed information about a single tenant from your main Auvik account

PARAMETERS

-TenantDomainPrefix

Domain prefix of your main Auvik account (tenant)

Type: String
Parameter Sets: IndexSingleTenantDetails, IndexMultiTenantDetails
Aliases:

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

-FilterAvailableTenants

Filter whether or not a tenant is available, i.e. data can be gotten from them via the API

Type: SwitchParameter
Parameter Sets: IndexMultiTenantDetails
Aliases:

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

-ID

ID of tenant

Type: String
Parameter Sets: IndexSingleTenantDetails
Aliases:

Required: True
Position: Named
Default value: None
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/Celerium.Auvik/site/ClientManagement/Get-AuvikTenant.html