Connect-IvantiInstance

SYNOPSIS

Define connection information

SYNTAX

APIKey (Default)

Connect-IvantiInstance [-APIKey <String>] [-url] <String> [<CommonParameters>]

Credential

Connect-IvantiInstance [-Credential <PSCredential>] [-IvantiRole <String>] [-url] <String> [<CommonParameters>]

Session

Connect-IvantiInstance [-SessionID <String>] [-url] <String> [<CommonParameters>]

DESCRIPTION

Define connection information: SessionID, Credential or APIKey and url

EXAMPLES

EXAMPLE 1

Connect-IvantiInstance -APIKey '01234A56-7890-1B23-CDEF-4567890GH12I' -URL 'https://ivanti.example.local/HEAT'

Set the API key from Ivanti and the base-url (api part is automaticly added)

EXAMPLE 2

Connect-IvantiInstance -Credential (Get-Credential) -URL 'https://ivanti.example.local/HEAT'

Set the API key from Ivanti and the base-url (api part is automaticly added)

PARAMETERS

-Credential

The credential that will be used to generate SessionID

Type: PSCredential
Parameter Sets: Credential
Aliases:

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

-IvantiRole

Type: String
Parameter Sets: Credential
Aliases:

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

-SessionID

The SessionID that will be used to generate SessionID

Type: String
Parameter Sets: Session
Aliases:

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

-APIKey

The API key that will be used for authentication

Type: String
Parameter Sets: APIKey
Aliases:

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

-url

The base url from ivani tenant

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 2
Default value: None
Accept pipeline input: True (ByPropertyName)
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/2020/admin/Content/Configure/API/Authentication_of_APIs.htm https://help.ivanti.com/ht/help/en_US/ISM/2020/admin/Content/Configure/API/Session-ID-Log-In.htm https://help.ivanti.com/ht/help/en_US/ISM/2020/admin/Content/Configure/API/Using-REST-API-Key.htm