Abhängig vom Mandantentyp, den Sie beim Aufrufen der REST API-Methode angeben, können die folgenden Aktionen ausgeführt werden:
Methode:
POST /api/2.0/virtualization/tenants
Im Anforderungshauptteil müssen Sie die folgenden Parameter angeben:
<tenant>
<name>{Bezeichnung
}</name>
<description>{Beschreibung
}</description>
<userData><![CDATA[{zusätzliche Informationen
}]]></userData>
<preferredViisAddress>{IP-Adresse
}</preferredViisAddress>
<type>{Mandantentyp
}</type>
<!-- Die Daten im Abschnitt vKsc werden nur für Mandanten vom Typ "vollständig" angegeben -->
<vKsc>
<user>
<name>{Name des Administrators
}</name>
<password>{Administrator-Kennwort
}</password>
</user>
</vKsc>
</tenant>
wobei:
{
Bezeichnung
}
– Bezeichnung des Mandanten (Pflichtparameter).{
Beschreibung
}
– Beschreibung des Mandanten (Pflichtparameter).{
zusätzliche Informationen
}
– zusätzliche Informationen zum Mandanten (Pflichtparameter).{
IP-Adresse
}
– IP-Adresse des Integrationsservers, zu dem Light Agents, die auf den virtuellen Maschinen des Mandanten installiert sind, eine Verbindung herstellen sollen (optionaler Parameter). Die angegebene Adresse wird standardmäßig beim Erstellen einer Richtlinie für Light Agent verwendet. Wenn der Parameter nicht angegeben wird, verwendet die Richtlinie die IP-Adresse des Integrationsservers aus der Anforderung an die REST API.{
Mandantentyp
}
– Mandantentyp: "vollständig" (Complete
) oder "einfach" (Simple
) (Pflichtparameter).{
Name des Administrators
}
– Konto-Name des Administrator mit dem eine Verbindung zum Administrationsserver des virtuellen Mandanten hergestellt werden soll (Pflichtparameter beim Erstellen eines Mandanten vom Typ "vollständig"). Während des Vorgangs wird automatisch ein Konto erstellt.{
Administratorkennwort
}
– Kennwort für das mit der Base64-Methode codierte Administratorkonto (Pflichtparameter beim Erstellen eines Mandanten vom Typ "vollständig").Die Anforderung wird asynchron ausgeführt. Die REST API gibt eine Aufgaben-ID vom Typ CreateTenant zurück. Mithilfe der Aufgabe können Sie den Fortschritt der Mandantenerstellung verfolgen. Nach Abschluss der Aufgabe enthält das Feld result Informationen zum Mandanten, einschließlich der ID des erstellten Mandanten oder Informationen zum Fehler. Im Falle eines Fehlers in einem der Schritte des Vorgangs wird ein Rollback aller vorgenommenen Änderungen durchgeführt.
Rückgabecodes:
202 (Accepted)
– Anfrage wird zur Ausführung angenommen. Die Antwort gibt eine Aufgaben-ID vom Typ CreateTenant zurück.400 (Bad request) VIRMT_MandatoryParameterIsNotSpecified
– Einer der Pflichtparameter, z. B. Bezeichnung des Mandanten, ist im Anforderungshauptteil nicht angegeben.400 (Bad request) VIRMT_InvalidTenantType
– im Anforderungshauptteil ist der falsche Mandantentyp angegeben, der angegebene Typ existiert nicht.400 (Bad request) VIRMT_VKscCredentialsNotSpecified
– der Name oder das Kennwort des Administratorkontos des virtuellen Kaspersky Security Center Administrationsservers ist nicht angegeben (beim Erstellen eines Mandanten vom Typ "vollständig"). 400 (Bad request) VIRMT_InvalidViisAddressFormat
– Ungültiges Format der IP-Adresse des Integrationsservers.403 (Forbidden)
– Der Zugriff auf die Ressource wird verweigert.Mögliche Fehlercodes in der Aufgabe:
KSC_ServiceNotConfigured
– Einstellungen für die Verbindung zu Kaspersky Security Center nicht angegeben.VIRMT_TenantGroupAlreadyExists
– ein Ordner mit einem Namen, welcher der angegebenen Bezeichnung des Mandanten entspricht, ist in Kaspersky Security Center bereits vorhanden.VIRMT_TenantWithSpecifiedNameAlreadyExists
– ein Mandant mit der angegebenen Bezeichnung ist bereits in der Datenbank des Integrationsservers vorhanden.VIRMT_PasswordNotComplyPolicy
– Es konnte kein Administratorkonto für den virtuellen Kaspersky Security Center Administrationsserver erstellt werden: Das angegebene Kennwort entspricht nicht den Kennwortanforderungen in Kaspersky Security Center.VIRMT_UserWithSpecifiedNameAlreadyExists
– Es konnte kein Administratorkonto für den virtuellen Kaspersky Security Center Administrationsserver erstellt werden: In Kaspersky Security Center existiert bereits ein Benutzer mit diesem Namen.