REST API - get

vcenter nsx deployment install recommendations: get

Gets the NSX appliance deployment sizes and recommended NSX size as per the vCenter size to which we want to install NSX. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Request:

HTTP request

GET https://{server}/api/vcenter/nsx/deployment/install-recommendations

Response:

HTTP Status Code: 200

Response Body Structure:

{
    "recommended_placement" : {
        "cluster" : "obj-103",
        "cluster_name" : "string",
        "datastore" : "obj-103",
        "network_name" : "string",
        "datastore_name" : "string",
        "network" : "obj-103"
    },
    "available_sizes" : [
        {
            "disk" : 1.5,
            "memory" : 1.5,
            "size_type" : "string",
            "cpu" : 1.5,
            "label" : "string"
        },
        {
            "disk" : 1.5,
            "memory" : 1.5,
            "size_type" : "string",
            "cpu" : 1.5,
            "label" : "string"
        }
    ],
    "management_vcenter" : "string",
    "recommended_size" : "string"
}

Headers:

None

Type:

Name	Type	Description
bold = required
-	info	Returns an Info which contains the list of available NSX deployment sizes and recommended size for current deployment based on vCenter size.
-.available_sizes	appliance_size[]	List of available NSX deployment sizes. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
-.available_sizes[].size_type	string	Name of the NSX deployment type based on the size of deployment. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
-.available_sizes[].label	string	label assigned to the NSX deployment size. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. unset no Label has been assigned.
-.available_sizes[].cpu	double	CPU requirement for the NSX deployment type. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
-.available_sizes[].memory	double	Memory requirement for the NSX deployment type.. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
-.available_sizes[].disk	double	Disk requirement for the NSX deployment type.. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
-.recommended_size	string	Recommended NSX deployment size based on current the vCenter size. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
-.recommended_placement	placement_spec	Recommended NSX deployment placement params based on the current vCenter VM placement, We need to query the management vCenter for this info. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
-.recommended_placement.cluster	string	The identifier of the cluster of which the appliance is a member. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: `ClusterComputeResource:VCenter`. When operations return a value of this structure as a result, the field will be an identifier for the resource type: `ClusterComputeResource:VCenter`.
-.recommended_placement.cluster_name	string	The name of the cluster of which the appliance is a member. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Optional. If unset, cluster ID will be used.
-.recommended_placement.network	string	The identifier of the Network object used to attach the appliance. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: `Network:VCenter`. When operations return a value of this structure as a result, the field will be an identifier for the resource type: `Network:VCenter`.
-.recommended_placement.network_name	string	The name of the Network object used to attach the appliance. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Optional. If unset, network ID will be used.
-.recommended_placement.datastore	string	The identifier of the datastore to put all the virtual disks on. The datastore must be accessible from the management vCenter. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: `Datastore:VCenter`. When operations return a value of this structure as a result, the field will be an identifier for the resource type: `Datastore:VCenter`.
-.recommended_placement.datastore_name	string	The name of the datastore. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Optional. If unset, datastore ID will be used.
-.management_vcenter	string	Management vCenter for the current vCenter. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Optional. unset if vCenter is self managed.

Errors:

HTTP Status Code	Type	Description
500	error	for any other unspecified error.
404	not_found	if either we cannot query the available NSX sizes or cannnot recommend an NSX deployment size based on vCenter size.
401	unauthenticated	if the user can not be authenticated.
403	unauthorized	if the user is not a member of the Administrators group.