Skip to content

Get-IvantiChange

SYNOPSIS

Retrieves change records from Ivanti ITSM.

SYNTAX

RecID (Default)

Get-IvantiChange -recID <String> [-status <String>] [-customFields <String>] [-top <Int32>] [-allFields]
 [<CommonParameters>]

ChangeNumber

Get-IvantiChange -changeNumber <Int32> [-status <String>] [-customFields <String>] [-top <Int32>] [-allFields]
 [<CommonParameters>]

Subject

Get-IvantiChange -subject <String> [-status <String>] [-customFields <String>] [-top <Int32>] [-allFields]
 [<CommonParameters>]

Filter

Get-IvantiChange -filter <String> [-status <String>] [-customFields <String>] [-top <Int32>] [-allFields]
 [<CommonParameters>]
Get-IvantiChange -search <String> [-status <String>] [-customFields <String>] [-top <Int32>] [-allFields]
 [<CommonParameters>]

DESCRIPTION

Retrieves change records from Ivanti ITSM based on specified parameters such as change number, record ID, subject, filter, or search criteria. Allows selecting specific fields, filtering by status, and limiting the number of results.

EXAMPLES

EXAMPLE 1

Get-Change -changeNumber 12345

Retrieves the change with the change number 12345.

EXAMPLE 2

Get-Change -recID 'abc123'

Retrieves the change with the record ID 'abc123'.

EXAMPLE 3

Get-Change -filter "Status eq 'Scheduled'" -status 'Scheduled'

Retrieves scheduled changes with the specified filter.

EXAMPLE 4

Get-Change -search 'Change123' -allFields

Retrieves the change with the search criteria 'Change123' and returns all fields.

PARAMETERS

-changeNumber

The change number to be retrieved.

Type: Int32
Parameter Sets: ChangeNumber
Aliases: Change

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

-recID

The record ID of the change to be retrieved.

Type: String
Parameter Sets: RecID
Aliases:

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

-subject

The subject of the change to be retrieved.

Type: String
Parameter Sets: Subject
Aliases:

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

-filter

The filter criteria to find the change to be retrieved.

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 change to be retrieved.

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 change. Valid values are 'Scheduled', 'Implemented', 'Cancelled'.

Type: String
Parameter Sets: (All)
Aliases:

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

-customFields

A comma-separated list of custom fields to be included in the result.

Type: String
Parameter Sets: (All)
Aliases:

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

-top

The maximum number of results to return.

Type: Int32
Parameter Sets: (All)
Aliases:

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

-allFields

Switch to indicate if all fields should be returned.

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

https://help.ivanti.com/ht/help/en_US/ISM/2022/admin/Content/Configure/API/Get-Business-Object-by-Filter.htm