NSX-T Data Center REST API

Deploys a the Malware Prevention Service on the specified compute-collection

This will deploy the Malware Prevention Service on a given cluster.
Internally OVF will be deployed on each host that is part of the cluster.
If there are no issues in the parameters, the call returns immediately,
and the service VMs will be deployed asynchronously.
To get the overall status of the deployment or to get the status of individual service vm, please use the
MPS deployment status APIs.

Request:

Method:

POST

URI Path(s):

/api/v1/malware-prevention/compute-collection/{compute-collection-id}/svm-deployment

Request Headers:

n/a

Query Parameters:

n/a

Request Body:

MpsSvmDeploymentSpec+

MpsSvmDeploymentSpec (schema)

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
cluster_svm_property	Cluster SVM Properties Cluster SVM properties contains the deployment specification, such as the storage and network to be used on the cluster where the Malware Prevention Service VM can be deployed.	MpsSvmProperties	Required
compute_collection_id	Compute collection ID Compute collection ID.	string	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
ovf_spec_name	OVF Spec Name Name of the OVF specification to be used for deployment, which specifies the OVF of the Malware Prevention Service appliance for a particular release.	string	Required
resource_type	Must be set to the value MpsSvmDeploymentSpec	string
sub_cluster_svm_property_list	Sub-Cluster SVM Properties List Sub-Cluster SVM Property list contains the Pair of sub cluster id and deployment specification that is to be used on the sub-cluster. This is only required if you have sub-clusters created in NSX and have specific requirement for using separate storage and network on those sub-cluster overriding the settings defined for the cluster.	array of MpsSubClusterSvmPropertiesPair	Maximum items: 16
svm_config	Mps SVM Config SVM Config that are to be provided to Malware Prevention Service VM that is deployed.	MpsSvmConfig	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

Example Request:

{ "deployment_spec_name": "MPS-SVM-4.2.0", "cluster_svm_property": { "storage_id": "datastore-30", "vm_nic_info": { "network_id": "network-28", "ip_allocation_type": "DHCP" } } "svm_config": { "ssh_key" : "ssh-rsa AAAAB3N....Bl3uQ== [email protected]", } }

Successful Response:

Response Code:

201 Created

Response Headers:

Content-type: application/json

Response Body:

MpsSvmDeploymentSpec+

MpsSvmDeploymentSpec (schema)

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
cluster_svm_property	Cluster SVM Properties Cluster SVM properties contains the deployment specification, such as the storage and network to be used on the cluster where the Malware Prevention Service VM can be deployed.	MpsSvmProperties	Required
compute_collection_id	Compute collection ID Compute collection ID.	string	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
ovf_spec_name	OVF Spec Name Name of the OVF specification to be used for deployment, which specifies the OVF of the Malware Prevention Service appliance for a particular release.	string	Required
resource_type	Must be set to the value MpsSvmDeploymentSpec	string
sub_cluster_svm_property_list	Sub-Cluster SVM Properties List Sub-Cluster SVM Property list contains the Pair of sub cluster id and deployment specification that is to be used on the sub-cluster. This is only required if you have sub-clusters created in NSX and have specific requirement for using separate storage and network on those sub-cluster overriding the settings defined for the cluster.	array of MpsSubClusterSvmPropertiesPair	Maximum items: 16
svm_config	Mps SVM Config SVM Config that are to be provided to Malware Prevention Service VM that is deployed.	MpsSvmConfig	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

Example Response:

{ "deployment_spec_name": "MPS-SVM-4.2.0", "clustered_deployment_count": 1, "ssh_key" : "ssh-rsa AAAAB3N....Bl3uQ== [email protected]", "cluster_svm_property": { "storage_id": "datastore-30", "vm_nic_info": { "network_id": "network-28", "ip_allocation_type": "DHCP" } }, "svm_config": { "ssh_key" : "ssh-rsa AAAAB3N....Bl3uQ== [email protected]", } "resource_type": "MpsSvmDeploymentSpec", "id": "e6c2693f-2335-43de-8885-95db0b7c7478", "display_name": "e6c2693f-2335-43de-8885-95db0b7c7478", "_create_user": "admin", "_create_time": 1543950168765, "_last_modified_user": "admin", "_last_modified_time": 1543950168765, "_system_owned": false, "_protection": "NOT_PROTECTED", "_revision": 0 }

Required Permissions:

crud

Feature:

intrusion_services

Additional Errors:

• 301 Moved Permanently
• 307 Temporary Redirect
• 400 Bad Request
• 403 Forbidden
• 409 Conflict
• 412 Precondition Failed
• 500 Internal Server Error
• 503 Service Unavailable