Upgrade-S1Agent
SYNOPSIS
Upgrade SentinelOne agents to a specified software version.
SYNTAX
Upgrade-S1Agent [[-Name] <String[]>] [[-agentVersionsNin] <String[]>] [[-agentVersions] <String[]>]
[[-MachineType] <String[]>] [[-AgentID] <String[]>] [[-GroupID] <String[]>] [[-filterId] <String>]
[[-SiteID] <String[]>] [[-AccountID] <String[]>] [[-FilterName] <String>] [[-MaxCount] <UInt32>]
[-ProblematicAgent] [-ConnectedToManagement] [-IsActive] [[-OSTypeFilter] <String[]>] [-packageType] <String>
[-PackageVersion] <String> [[-PackageQueryString] <String>] [[-PackageFileExtension] <String>]
[[-allowDowngrade] <Boolean>] [-OSTypeData] <String> [[-isScheduled] <Boolean>] [[-ignoreConflicts] <Boolean>]
[<CommonParameters>]
DESCRIPTION
This function upgrades SentinelOne agents to a specified software version using various filters such as agent name, version, machine type, and more. It allows specifying the package type, version, operating system, and additional options like scheduling and conflict handling.
EXAMPLES
EXAMPLE 1
Upgrades the specified agent to version 3.2.1 on Windows.
EXAMPLE 2
Upgrade-S1Agent -GroupID "group1" -packageType "AgentAndRanger" -PackageVersion "3.2.1" -OSTypeData "linux" -isScheduled
Schedules an upgrade for all agents in the specified group to version 3.2.1 on Linux.
EXAMPLE 3
Upgrade-S1Agent -AgentID @("agent1", "agent2") -packageType "Ranger" -PackageVersion "3.2.1" -OSTypeData "macos" -allowDowngrade
Upgrades the specified agents to version 3.2.1 on macOS, allowing downgrades.
PARAMETERS
-Name
Filter agents by name.
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-agentVersionsNin
Exclude agents with specific versions.
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-agentVersions
Filter agents by specific versions.
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-MachineType
Filter agents by machine type. Valid values are "unknown", "desktop", "laptop", "server", "kubernetes node", or "storage".
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-AgentID
Filter agents by their IDs.
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-GroupID
Filter agents by group IDs.
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: 6
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-filterId
Use a predefined filter by ID.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 7
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-SiteID
Filter agents by site IDs.
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: 8
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-AccountID
Filter agents by account IDs.
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: 9
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-FilterName
Use a predefined filter by name.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 10
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-MaxCount
Specify the maximum number of agents to retrieve. Defaults to 100.
Type: UInt32
Parameter Sets: (All)
Aliases:
Required: False
Position: 11
Default value: 100
Accept pipeline input: False
Accept wildcard characters: False
-ProblematicAgent
Filter agents with operational issues such as "auto_partially_disabled" or "db_corruption".
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-ConnectedToManagement
Filter agents that are connected to the management console.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-IsActive
Filter agents that are currently active.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-OSTypeFilter
Filter agents by operating system type. Valid values are "windows", "windows_legacy", "linux", or "macos".
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: 12
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-packageType
Specify the type of package to use for the upgrade. Valid values are "Agent", "AgentAndRanger", or "Ranger".
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 13
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-PackageVersion
Specify the version of the package to use for the upgrade.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 14
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-PackageQueryString
Specify a query string to filter the package (e.g., "64bit"). Defaults to "64bit".
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 15
Default value: 64bit
Accept pipeline input: False
Accept wildcard characters: False
-PackageFileExtension
Specify the file extension of the package. Valid values are ".msi", ".exe", ".deb", ".rpm", ".bsx", ".pkg", ".img", ".tar", ".zip", ".gz", ".xz". Defaults to ".msi".
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 16
Default value: .msi
Accept pipeline input: False
Accept wildcard characters: False
-allowDowngrade
Allow downgrading the agent software. Defaults to `$false`.
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: 17
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-OSTypeData
Specify the operating system type for the package. Valid values are "windows", "windows_legacy", "linux", or "macos".
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 18
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-isScheduled
Schedule the upgrade for a later time.
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: 19
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-ignoreConflicts
Ignore conflicts during the upgrade process. Defaults to `$true`.
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: 20
Default value: True
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.