Befehlsparameter


Voriger Abschnitt | Nächster Abschnitt


Sobald die Konfigurationsdateien eingerichtet wurden, können Sie das Benutzer-Synchronisationstool an der Befehlszeile oder in einem Skript ausführen. Führen Sie zum Ausführen des Tools den folgenden Befehl in einer Befehlszeile oder aus einem Skript aus:

user-sync [ Optionale Parameter ]

Das Tool akzeptiert optionale Parameter, die sein spezifisches Verhalten in diversen Situationen bestimmen.

Parameter und Angaben zu Argumenten Beschreibung
-h
--help
Eine Hilfemeldung wird angezeigt und der Vorgang beendet.
-v
--version
Die Versionsnummer des Programms wird angezeigt und der Vorgang beendet.
-t
--test-mode
API-Aktionsaufrufe werden im Testmodus ausgeführt (Änderungen werden nicht ausgeführt). Es werden die Aktionen protokolliert, die ausgeführt werden würden.
-c dateiname
--config-filename dateiname
Der komplette Pfad zur Hauptkonfigurationsdatei; ein absoluter Pfad oder ein Pfad relativ zum Arbeitsordner. Der Standarddateiname lautet „user-sync-config.yml“
--users all
--users file eingabepfad
--users group grp1,grp2
--users mapped
Hiermit werden die für die Synchronisation ausgewählten Benutzer angegeben. Der Standardwert ist all, d. h. alle Benutzer im Verzeichnis. Wenn file angegeben wird, werden Benutzerspezifikationen aus der vom Argument benannten CSV-Datei als Eingabe angenommen. Bei Angabe von group wird das Argument als durch Kommas getrennte Liste von Gruppen im Unternehmensverzeichnis interpretiert und es werden nur Benutzer in diesen Gruppen ausgewählt. Die Angabe von mapped entspricht der Angabe von group, wobei alle Gruppen in der Gruppenzuordnung der Konfigurationsdatei aufgelistet sind. Dies ist häufig der Fall, wenn lediglich die Benutzer in zugeordneten Gruppen synchronisiert werden sollen.
--user-filter regex-muster Beschränken Sie hiermit die Gruppe von Benutzern, die für die Synchronisation überprüft werden, auf diejenigen, die einem Muster entsprechen, welches in einem regulären Ausdruck angegeben wird. Informationen zum Erstellen regulärer Ausdrücke in Python finden Sie in der Dokumentation zu regulären Ausdrücken in Python. Der Benutzername muss vollständig dem regulären Ausdruck entsprechen.
--update-user-info Bei dieser Angabe werden Benutzerinformationen synchronisiert. Wenn sich die Informationen auf der Unternehmensverzeichnisseite und der Adobe-Seite unterscheiden, wird die Adobe-Seite aktualisiert, sodass Übereinstimmung hergestellt wird. Hierzu zählen die Felder „firstname“ und „lastname“.
--process-groups Bei dieser Angabe werden Informationen zur Gruppenmitgliedschaft synchronisiert. Wenn sich die Mitgliedschaft in zugeordneten Gruppen auf Unternehmensverzeichnisseite und Adobe-Seite unterscheiden, wird die Gruppenmitgliedschaft auf Adobe-Seite aktualisiert, sodass Übereinstimmung hergestellt wird. Dabei werden u. a. Gruppenmitgliedschaften für Adobe-Benutzer entfernt, die nicht auf der Verzeichnisseite aufgelistet sind (es sei denn, die Option --adobe-only-user-action exclude ist ebenfalls ausgewählt)
--adobe-only-user-action preserve
--adobe-only-user-action remove-adobe-groups
--adobe-only-user-action remove
--adobe-only-user-action delete

--adobe-only-user-action write-file dateiname

--adobe-only-user-action exclude
Bei dieser Angabe gilt Folgendes: Wenn Benutzerkonten auf Adobe-Seite gefunden werden, die im Verzeichnis nicht vorhanden sind, ist die angegebene Aktion auszuführen.

preserve: Es wird keine Aktion in Bezug auf die Löschung von Konten ausgeführt. Dies ist die Standardeinstellung. Möglicherweise treten dennoch Änderungen der Gruppenmitgliedschaft auf, wenn die Option --process-groups angegeben wurde.

remove-adobe-groups: Das Konto wird aus Benutzergruppen und Produktkonfigurationen entfernt, alle belegten Lizenzen werden freigegeben; es wird jedoch als aktives Konto in der Organisation beibehalten.

remove: Zusätzlich zu „remove-adobe-groups“ wird das Konto auch aus der Organisation entfernt, das Benutzerkonto verbleibt jedoch mit seinen zugeordneten Elementen in der Domäne und kann der Organisation ggf. wieder hinzugefügt werden.

delete: Neben der Aktion zum Entfernen wird das Konto entfernt, wenn seine Domäne im Besitz der Organisation ist.

write-file: Es wird keine Aktion in Bezug auf die Löschung von Konten ausgeführt. Die Liste der Benutzerkonten, die auf Adobe-Seite, jedoch nicht im Verzeichnis vorhanden sind, wird in die angegebene Datei geschrieben. Sie können diese Datei in einer späteren Ausführung an das Argument --adobe-only-user-list übergeben. Möglicherweise treten dennoch Änderungen der Gruppenmitgliedschaft auf, wenn die Option --process-groups angegeben wurde.

exclude: Es wird keine Aktualisierung, gleich welcher Art, auf die Benutzer angewendet, die lediglich auf Adobe-Seite vorhanden sind. Dies wird verwendet, wenn Aktualisierungen bestimmter Benutzer über eine Datei (–users file f) vorgenommen werden, wobei in der Datei nur Benutzer aufgelistet sind, für die ausdrücklich eine Aktualisierung benötigt wird, und alle übrigen Benutzer werden ignoriert.

Es werden nur zulässige Aktionen ausgeführt. Konten vom Typ adobeID sind im Besitz des Benutzers, sodass die Löschaktion die gleiche Wirkung wie das Entfernen hat. Dies gilt auch für Adobe-Konten, die im Besitz anderer Organisationen sind.
--adobe-only-user-list dateiname Hiermit wird eine Datei angegeben, aus der eine Liste von Benutzern gelesen wird. Diese Liste wird als definitive Liste der „Nur Adobe“-Benutzerkonten verwendet, für die Aktionen auszuführen sind. Eine der Anweisungen für --adobe-only-user-action muss ebenfalls angegeben werden und die zugehörige Aktion wird auf die Benutzerkonten in der Liste angewendet. Die Option --users ist nicht zulässig, wenn diese Option vorhanden ist: Es können nur Entfernungsaktionen verarbeitet werden.
--config-file-encoding encoding_name Optional. Legt die Zeichenkodierung für den Inhalt der Konfigurationsdateien selbst fest. Dazu zählen die Hauptkonfigurationsdatei, „user-sync-config.yml“, sowie andere Konfigurationsdateien, auf die verwiesen wird. Standard ist „utf8“ für das Benutzer-Synchronisationstool ab Version 2.2 und „ascii“ für frühere Versionen.
Die Zeichenkodierung in den Benutzerquelldaten (ob nun CSV oder LDAP) wird von den Connector-Konfigurationen deklariert. Diese Kodierung kann jedoch von der für die Konfigurationsdateien verwendeten Zeichenkodierung abweichen. (So könnte es etwa sein, dass Ihre Konfigurationsdatei in Latin-1 kodiert ist, während die CSV-Quelldatei UTF-8 verwendet.)
Welche Kodierungen verfügbar sind, hängt von der verwendeten Python-Version ab. Weitere Informationen finden Sie in der Dokumentation, und zwar hier.
--strategy sync
--strategy push
Ab Version 2.2 verfügbar. Optional. Der Standardbetriebsmodus ist --strategy sync. Bestimmt, ob das Benutzer-Synchronisationstool Informationen von Adobe liest und mit den Verzeichnisinformationen vergleicht und dann die Aktualisierung an Adobe übermittelt („sync“) oder die Verzeichniseingabe einfach an Adobe überträgt ohne die vorhandenen Benutzerinformationen bei Adobe zu berücksichtigen („push“). sync ist die Standardeinstellung und somit das Thema des überwiegenden Teils dieser Dokumentation. push eignet sich bei einer großen Anzahl an Benutzern auf Adobe-Seite (> 30.000) und wenn nur für eine kleine Anzahl von Benutzern Eränzungen oder Änderungen notwenig sind und die Liste dieser Benutzer über eine CSV-Datei oder spezifische Verzeichnisgruppe verfügbar ist.
Wird --strategy push angegeben, kann --adobe-only-user-action nicht angegeben werden, da die reinen Adobe-Benutzer nicht ermittelt wurden.
--strategy push erstellt neue Benutzer, ändert deren Gruppenmitgliedschaften nur für zugeordnete Gruppen (wenn --process-groups aktiviert ist), aktualisiert die Benutzerinformationen (wenn --update-user-info aktiviert ist) und entfernt keine Benutzer aus der Organisation und löscht auch deren Konten nicht. Wie Sie Benutzer über Push-Benachrichtigungen entfernen, erfahren Sie unter Push-Benachrichtigungen behandeln.

Voriger Abschnitt | Nächster Abschnitt