Skip to content

Update-IvantiEmployee

SYNOPSIS

Updates an employee record in Ivanti ITSM.

SYNTAX

RecID (Default)

Update-IvantiEmployee -PrimaryEmail <String> -recID <String> [-status <String>] -body <Hashtable>
 [<CommonParameters>]

PrimaryEmail

Update-IvantiEmployee -PrimaryEmail <String> [-status <String>] -body <Hashtable> [<CommonParameters>]

Filter

Update-IvantiEmployee -PrimaryEmail <String> -filter <String> [-status <String>] -body <Hashtable>
 [<CommonParameters>]
Update-IvantiEmployee -PrimaryEmail <String> -search <String> [-status <String>] -body <Hashtable>
 [<CommonParameters>]

DESCRIPTION

Updates an employee record in Ivanti ITSM using the specified details such as primary email, record ID, filter, or search parameters. The function allows updating various attributes of the employee record.

EXAMPLES

EXAMPLE 1

Update-IvantiEmployee -PrimaryEmail '[email protected]' -body @{ 'Status' = 'Active'; 'Title' = 'Manager' }

Updates the employee with the specified primary email address.

EXAMPLE 2

Update-IvantiEmployee -recID 'abc123' -body @{ 'Status' = 'Inactive'; 'Department' = 'HR' }

Updates the employee with the specified record ID.

EXAMPLE 3

Update-IvantiEmployee -filter "LastName eq 'Doe'" -status 'Active' -body @{ 'Title' = 'Director' }

Updates the employee found with the specified filter and status.

EXAMPLE 4

Update-IvantiEmployee -search 'Jane Doe' -body @{ 'Status' = 'Active'; 'Title' = 'Lead' }

Updates the employee found with the specified search criteria.

PARAMETERS

-PrimaryEmail

The primary email address of the employee to be updated.

Type: String
Parameter Sets: (All)
Aliases:

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

-recID

The record ID of the employee to be updated.

Type: String
Parameter Sets: RecID
Aliases:

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

-filter

The filter criteria to find the employee to be updated.

Type: String
Parameter Sets: Filter
Aliases:

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

The search criteria to find the employee to be updated.

Type: String
Parameter Sets: Search
Aliases:

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

-status

The status of the employee.

Type: String
Parameter Sets: (All)
Aliases:

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

-body

A hashtable of fields to be updated in the employee record.

Type: Hashtable
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: None
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

https://help.ivanti.com/ht/help/en_US/ISM/2022/admin/Content/Configure/API/Update-a-Business-Object.htm