Este tema de referencia proporciona información sobre las API que se utilizan para registrar el servicio NSX Distributed Malware Prevention, recuperar las especificaciones de implementación del servicio NSX Distributed Malware Prevention y eliminar una especificación de implementación de una definición de servicio de NSX Distributed Malware Prevention existente.

Registrar el servicio de NSX Distributed Malware Prevention

Utilice la API POST para registrar el servicio NSX Distributed Malware Prevention. Si el servicio NSX Distributed Malware Prevention ya está registrado, la API agrega una nueva especificación de implementación a una definición de servicio existente.

Durante el registro del servicio, la API crea internamente la definición de servicio del servicio de NSX Distributed Malware Prevention.

Solicitud de la API

Método: POST

Ruta de URI: napp/api/v1/malware-prevention/svm-spec

Encabezados de solicitud: no aplicables

Parámetros de consulta: no aplicables

Tabla 1. Lista de parámetros
Nombre Descripción Tipo Notas
deployment_spec_name

Nombre de la especificación de implementación. Una definición de servicio puede contener varias especificaciones de implementación. Cada nombre de especificación de implementación debe ser único.

Cadena

Necesario

ovf_url

Complete la ruta al archivo OVF en el servidor web.

Cadena

Necesario

svm_version El número de versión de la máquina virtual de servicio.

Cadena

Necesario

Ejemplo de solicitud
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"
}
Ejemplo de respuesta 1
Respuesta de ejemplo cuando se utiliza la API POST para registrar el servicio NSX Distributed Malware Prevention.
{
    "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"
            }
        ]
    }
}
}
Ejemplo de respuesta 2
Respuesta de ejemplo cuando se utiliza la API POST para agregar una nueva especificación de implementación de servicio a una definición de servicio existente. En este caso, la respuesta enumera todas las especificaciones de implementación de la definición del servicio.

Por ejemplo, si desea actualizar la SVM de Prevención de malware de NSX en la implementación de servicios de cada clúster de hosts ESXi, ejecute esta API POST para agregar una nueva especificación de implementación de servicio a una definición de servicio existente.

{
    "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"
            }
        ]
    }
}

Recuperar las especificaciones de implementación del servicio NSX Distributed Malware Prevention

Utilice la API GET para recuperar las especificaciones de implementación del servicio NSX Distributed Malware Prevention.

Solicitud de la API

Método: GET

Ruta de URI: napp/api/v1/malware-prevention/svm-spec

Encabezados de solicitud: no aplicables

Parámetros de consulta: no aplicables

Cuerpo de la solicitud: no aplicable

Ejemplo de respuesta
{
    "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"
            }
        ]
    }
}
}

Eliminar la especificación de implementación del servicio NSX Distributed Malware Prevention

Utilice la API DELETE para eliminar la especificación de implementación del servicio NSX Distributed Malware Prevention solo cuando haya agregado más de una especificación de implementación para la definición del servicio y una de las especificaciones de implementación ya no sea válida ni se utilice en ninguna de las implementaciones de servicio.

Precaución: No utilice la API DELETE en las siguientes situaciones:
  • La definición del servicio NSX Distributed Malware Prevention solo tiene una especificación de implementación.
  • La especificación de implementación se utiliza en cualquiera de las implementaciones de servicio.

En estas dos situaciones, la API DELETE falla.

Solicitud de la API

Método: DELETE

Ruta de URI: napp/api/v1/malware-prevention/svm-spec

Encabezados de solicitud: no aplicables

Parámetros de consulta: deployment_spec_name

Cuerpo de la solicitud: no aplicable

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