Get-S1Site

SYNOPSIS

Retrieve information related to SentinelOne sites.

SYNTAX

All (Default)

Get-S1Site [-AccountID <String[]>] [-State <String[]>] [<CommonParameters>]

Name

Get-S1Site -Name <String> [-AccountID <String[]>] [-State <String[]>] [<CommonParameters>]

SiteID

Get-S1Site -SiteID <String[]> [-AccountID <String[]>] [-State <String[]>] [<CommonParameters>]

RegistrationToken

Get-S1Site -RegistrationToken <String> [-AccountID <String[]>] [-State <String[]>] [<CommonParameters>]

AvailableMoveSite

Get-S1Site [-AccountID <String[]>] [-State <String[]>] [-AvailableMoveSite] [<CommonParameters>]

AdminOnly

Get-S1Site [-AccountID <String[]>] [-State <String[]>] [-AdminOnly] [<CommonParameters>]

DESCRIPTION

This function retrieves information related to SentinelOne sites. It allows filtering by site name, site ID, registration token, account ID, site state, and other parameters.

EXAMPLES

EXAMPLE 1

Get-S1Site -Name "ExampleSite"

Retrieves information for the site with the name "ExampleSite".

EXAMPLE 2

Get-S1Site -SiteID "site123"

Retrieves information for the site with the specified ID.

EXAMPLE 3

Get-S1Site -AccountID "account123" -State "active"

Retrieves all active sites for the specified account.

EXAMPLE 4

Get-S1Site -AvailableMoveSite

Retrieves all sites the user can move agents to.

EXAMPLE 5

Get-S1Site -AdminOnly

Retrieves all sites the user has admin privileges to.

PARAMETERS

-Name

Get a site based on its name.

Type: String
Parameter Sets: Name
Aliases:

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

-SiteID

Get a site by its ID.

Type: String[]
Parameter Sets: SiteID
Aliases:

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

-RegistrationToken

Get a site based on its registration token.

Type: String
Parameter Sets: RegistrationToken
Aliases:

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

-AccountID

Filter sites list by their account ID.

Type: String[]
Parameter Sets: (All)
Aliases:

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

-State

Filter sites list by the site status, e.g., "active", "expired", or "deleted".

Type: String[]
Parameter Sets: (All)
Aliases:

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

-AvailableMoveSite

Only return sites the user can move agents to.

Type: SwitchParameter
Parameter Sets: AvailableMoveSite
Aliases:

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

-AdminOnly

Only return sites the user has admin privileges to.

Type: SwitchParameter
Parameter Sets: AdminOnly
Aliases:

Required: True
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

Options that aren't implemented yet: createdAt, updatedAt, expiration, features, siteType, suite, healthStatus, isDefault, sortBy, sortOrder, externalId, countOnly, activeLicenses, totalLicenses, query