API-Referenz: NSX Distributed Malware Prevention-Dienst

Dieses Referenzthema enthält Informationen zu den APIs, die zum Registrieren des NSX Distributed Malware Prevention-Diensts, zum Abrufen der Bereitstellungsspezifikationen des NSX Distributed Malware Prevention-Diensts und zum Löschen einer Bereitstellungsspezifikation einer vorhandenen NSX Distributed Malware Prevention-Dienstdefinition verwendet werden.

Registrieren des NSX Distributed Malware Prevention-Diensts

Verwenden Sie zum Registrieren des NSX Distributed Malware Prevention-Diensts die POST API. Wenn der NSX Distributed Malware Prevention-Dienst bereits registriert ist, fügt die API einer vorhandenen Dienstdefinition eine neue Bereitstellungsspezifikation hinzu.

Während der Dienstregistrierung erstellt die API intern die Dienstdefinition des NSX Distributed Malware Prevention-Diensts.

API-Anforderung

Methode: POST

URI-Pfad: napp/api/v1/malware-prevention/svm-spec

Anforderungsheader: Nicht anwendbar

Abfrageparameter: Nicht anwendbar

Tabelle 1. Parameterliste

Name	Beschreibung	Typ	Anmerkungen
deployment_spec_name	Name der Bereitstellungsspezifikation. Eine Dienstdefinition kann mehrere Bereitstellungsspezifikationen enthalten. Jeder Name einer Bereitstellungsspezifikation muss eindeutig sein.	Zeichenfolge	Erforderlich
ovf_url	Vollständiger Pfad zur OVF-Datei auf dem Webserver.	Zeichenfolge	Erforderlich
svm_version	Die Versionsnummer der Dienst-VM.	Zeichenfolge	Erforderlich

Beispielanforderung

POST https://{nsx-manager-ip}/napp/api/v1/malware-prevention/svm-spec
{
    "ovf_url" : "http://{webserver-ip}/{path-to-ovf-file}/{filename}.ovf",
    "deployment_spec_name" : "MPS_Distributed_1",
    "svm_version" : "3.2"
}

Beispielantwort Nr. 1

Beispielantwort, wenn die POST API zum Registrieren des NSX Distributed Malware Prevention-Diensts verwendet wird.

{
    "service_id": "5cd8d584-553e-4495-a112-04cdcf44064c",
    "display_name": "VMWare NSX Distributed Malware Prevention Service",
    "deployment_specs": {
        "_links": [],
        "results": [
            {
               "ovf_url": "http://{webserver-ip}/{path-to-ovf-file}/{filename}.ovf",
               "deployment_spec_name": "MPS_Distributed_1",
               "svm_version": "3.2"
            }
        ]
    }
}
}

Beispielantwort Nr. 2

Beispielantwort, wenn die POST API verwendet wird, um einer vorhandenen Dienstdefinition eine neue Dienstbereitstellungsspezifikation hinzuzufügen. In diesem Fall listet die Antwort alle Bereitstellungsspezifikationen der Dienstdefinition auf.

Wenn Sie beispielsweise die NSX Malware-Schutz-SVM in der Dienstbereitstellung jedes ESXi-Hostclusters aktualisieren möchten, führen Sie diese POST API aus, um einer vorhandenen Dienstdefinition eine neue Dienstbereitstellungsspezifikation hinzuzufügen.

{
    "service_id": "5cd8d584-553e-4495-a112-04cdcf44064c",
    "display_name": "VMWare NSX Distributed Malware Prevention Service",
    "deployment_specs": {
        "_links": [],
        "results": [
            {
                "ovf_url": "http://{webserver-ip}/{path-to-ovf-file}/{filename2}.ovf",
                "deployment_spec_name": "MPS_Distributed_2",
                "svm_version": "3.3"
            },
            {
                "ovf_url": "http://{webserver-ip}/{path-to-ovf-file}/{filename1}.ovf",
                "deployment_spec_name": "MPS_Distributed_1",
                "svm_version": "3.2"
            }
        ]
    }
}

Abrufen der Bereitstellungsspezifikationen des NSX Distributed Malware Prevention-Diensts

Verwenden Sie GET API, um die Dienstbereitstellungsspezifikationen des NSX Distributed Malware Prevention-Diensts abzurufen.

API-Anforderung

Methode: GET

URI-Pfad: napp/api/v1/malware-prevention/svm-spec

Anforderungsheader: Nicht anwendbar

Abfrageparameter: Nicht anwendbar

Anforderungstext: Nicht anwendbar

Beispielantwort

{
    "service_id": "5cd8d584-553e-4495-a112-04cdcf44064c",
    "display_name": "VMWare NSX Distributed Malware Prevention Service",
    "deployment_specs": {
        "_links": [],
        "results": [
            {
               "ovf_url": "http://{webserver-ip}/{path-to-ovf-file}/{filename}.ovf",
               "deployment_spec_name": "MPS_Distributed_1",
               "svm_version": "3.2"
            }
        ]
    }
}
}

Löschen der NSX Distributed Malware Prevention-Dienstbereitstellungsspezifikation

Verwenden Sie DELETE API zum Löschen der NSX Distributed Malware Prevention-Dienstbereitstellungsspezifikation nur dann, wenn Sie mehr als eine Bereitstellungsspezifikation für die Dienstdefinition hinzugefügt haben und eine der Bereitstellungsspezifikationen nicht mehr gültig ist oder in einer der Dienstbereitstellungen verwendet wird.

Vorsicht: Verwenden Sie DELETE API in den folgenden Situationen nicht:

• Die NSX Distributed Malware Prevention-Dienstdefinition verfügt nur über eine einzelne Bereitstellungsspezifikation.
• Die Bereitstellungsspezifikation wird in einer der Dienstbereitstellungen verwendet.

In diesen beiden Situationen schlägt DELETE API fehl.

API-Anforderung

Methode: DELETE

URI-Pfad: napp/api/v1/malware-prevention/svm-spec

Anforderungsheader: Nicht anwendbar

Abfrageparameter: deployment_spec_name

Anforderungstext: Nicht anwendbar

Beispielanforderung

DELETE  https://{nsx-manager-ip}/napp/api/v1/malware-prevention/svm-spec?deployment_spec_name=MPS_Distributed_1