Mit den Cmdlets der ACMP Public API haben Sie Zugriff auf zentrale Funktionalitäten von ACMP, z.B. Geräteinformationen, Ticketmanagement, Benutzerverwaltung oder Ereignisprotokolle. Diese Cmdlets können Sie in Ihren Skripten für PowerShell-Microservices verwenden und damit weitere Funktionalitäten automatisieren.
Aufbau von Cmdlets der ACMP Public API
Bei den Cmdlets der ACMP Public API wird zwischen dem eigentlichen Public API Command und den zugehörigen Datentypen unterschieden. Hierbei fangen alle Cmdlets mit dem Verb Acmp an und alle Datentypen mit dem Verb New.
Achtung:
Sie können nicht direkt über Parameter auf die Eigenschaften des Cmdlets (z.B. "FamilyName", "Email", usw.) zugreifen, da es sich bei den Eigenschaften nicht um Parameter handelt.
Welcher Datentyp in welchem Cmdlet verwendet werden muss, können Sie sich über die Hilfe des jeweiligen Cmdlets anzeigen lassen.
Beispiel 1
Beispiel: Get-Help
▶
2
3
4
5
6
7
8
9
10
11
12
13
14
15
NAME
Acmp-SaveContacts_V3
SYNTAX
Acmp-SaveContacts_V3 [[-ConnectionName] <string>] [-Contacts <List[TContact_V3]>] [-AcmpServerId <string>] [-Timeout <int>] [<CommonParameters>]
ALIASES
None
REMARKS
None
An diesem Output ist ersichtlich, dass das Cmdlet eine Liste von TContact_V3 erwartet. Es müssen also Kontakte mithilfe von New-TContact_V3 erstellt und befüllt werden.
Beispiel 2
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
# Erstellen einer Liste
$contacts = @()
# Erstellen eines Kontakts
$testContact = New-TContact_V3
$testContact.ID = [guid]::NewGuid().ToString()
$testContact.Name = "Max"
$testContact.FamilyName = "Musterman"
$testContact.Email = "mmusterman@testmail.de"
# Hinzufügen des Kontakts zur Liste
$contacts += $testContact
# Ausführen des Public Api commands
$result = Acmp-SaveContacts_V3 -Contacts $contacts
# Ausgabe des results
$result
FirstErrorMsg ResultCode ResultMessage
------------- ---------- -------------
0 OK
Anhand der Antwort der Public API ist eine Fehlerbehandlung möglich.