Skip to content

Get-IvantiCI

SYNOPSIS

Retrieves configuration items (CIs) from Ivanti ITSM.

SYNTAX

RecID (Default)

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

CIName

Get-IvantiCI -CIName <String> [-status <String>] [-customFields <String>] [-top <Int32>] [-allFields]
 [<CommonParameters>]

Filter

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

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

DESCRIPTION

Retrieves configuration items (CIs) from Ivanti ITSM based on specified parameters such as CI name, record ID, filter, or search criteria. Allows selecting specific fields and filtering by status.

EXAMPLES

EXAMPLE 1

Get-CI -CIName 'CI123'

Retrieves the configuration item with the name 'CI123'.

EXAMPLE 2

Get-CI -recID 'abc123'

Retrieves the configuration item with the record ID 'abc123'.

EXAMPLE 3

Get-CI -filter "Category eq 'Server'" -status 'Active'

Retrieves active configuration items in the 'Server' category.

EXAMPLE 4

Get-CI -search 'CI123' -allFields

Retrieves the configuration item with the search criteria 'CI123' and returns all fields.

PARAMETERS

-CIName

The name of the configuration item to be retrieved.

Type: String
Parameter Sets: CIName
Aliases: CI, Name

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

-recID

The record ID of the configuration item to be retrieved.

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

Type: String
Parameter Sets: Filter
Aliases:

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

-search

The search criteria to find the configuration item 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 configuration item.

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