Esx Settings Clusters Vms Solutions get
Returns the desired specification of a solution in a given cluster.
This operation was added in vSphere API 9.0.0.0.
Returns an authorization error if you do not have all of the privileges described as follows:
- Operation execution requires
VcIntegrity.systemVM.Read.
Identifier of the cluster.
The parameter must be an identifier for the resource type: ClusterComputeResource.
Identifier of the solution.
The parameter must be an identifier for the resource type: com.vmware.esx.settings.vms.SystemVmSolution.
The desired specification of the solution in the cluster.
{
"deployment_type": "string",
"display_name": "string",
"display_version": "string",
"vm_name_template": {
"prefix": "string",
"suffix": "string"
},
"host_solution_info": {
"prefer_host_configuration": false,
"vm_networks": [
"string"
],
"vm_datastores": [
"string"
]
},
"cluster_solution_info": {
"vm_count": 0,
"vm_placement_policies": [
"string"
],
"vm_networks": {
"vm_networks": "string"
},
"vm_datastores": [
"string"
],
"devices": {}
},
"hook_configurations": {
"hook_configurations": {
"timeout": 0
}
},
"ovf_resource": {
"location_type": "string",
"url": "string",
"ssl_certificate_validation": "string",
"certificate": "string"
},
"ovf_descriptor_properties": {
"ovf_descriptor_properties": "string"
},
"vm_clone_config": "string",
"vm_storage_policy": "string",
"vm_storage_profiles": [
"string"
],
"vm_disk_type": "string",
"vm_resource_pool": "string",
"vm_folder": "string",
"vm_resource_spec": {
"ovf_deployment_option": "string"
}
}Deployment type of the solution.
For more information see: Esx Settings Clusters Vms DeploymentType.
This property was added in vSphere API 9.0.0.0.
Display name of the solution.
This property was added in vSphere API 9.0.0.0.
Display version of the solution.
This property was added in vSphere API 9.0.0.0.
VM name template.
This property was added in vSphere API 9.0.0.0.
Information about a configuration that is only applicable to solutions with deployment type Esx Settings Clusters Vms DeploymentType.EVERY_HOST_PINNED
This property was added in vSphere API 9.0.0.0.
This property is optional and it is only relevant when the value of deployment_type is Esx Settings Clusters Vms DeploymentType.EVERY_HOST_PINNED.
Information about a configuration that is only applicable to solutions with deployment type Esx Settings Clusters Vms DeploymentType.CLUSTER_VM_SET
This property was added in vSphere API 9.0.0.0.
This property is optional and it is only relevant when the value of deployment_type is Esx Settings Clusters Vms DeploymentType.CLUSTER_VM_SET.
VM lifecycle hooks configurations. See Esx Settings Clusters Vms LifecycleHooks. The map keys represent Esx Settings Clusters Vms LifecycleStates while the map values represent their configurations.
This property was added in vSphere API 9.0.0.0.
Information about the OVF resource that is used for the VM deployments.
This property was added in vSphere API 9.0.0.0.
OVF properties that are assigned to the VMs' OVF properties when powered on. The keys of the map must not include any white-space characters. The map keys represent the names of properties while the map values represent the values of those properties.
This property was added in vSphere API 9.0.0.0.
VM cloning configuration.
For more information see: Esx Settings Clusters Vms VmCloneConfig.
This property was added in vSphere API 9.0.0.0.
Storage policies that are configured on the VMs.
For more information see: Esx Settings Clusters Vms StoragePolicy.
This property was added in vSphere API 9.0.0.0.
Storage policy profiles that are configured on the VMs. The profiles are passed to vim.vm.ConfigSpec#vmProfile without any interpretation.
This property was added in vSphere API 9.0.0.0.
This property is optional and it is only relevant when the value of vm_storage_policy is Esx Settings Clusters Vms StoragePolicy.PROFILE.
When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: com.vmware.spbm.StorageProfile. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: com.vmware.spbm.StorageProfile.
Disk provisioning type of the VMs.
For more information see: Esx Settings Clusters Vms DiskType.
This property was added in vSphere API 9.0.0.0.
Identifier of the resource pool where the VMs are deployed.
This property was added in vSphere API 9.0.0.0.
if missing or null the VMs for each compute resource will be deployed under top level nested resource pool created for the solutions. If unable to create a nested resource pool, the root resource pool of the compute resource will be used.
When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: ResourcePool. When operations return a value of this schema as a response, the property will be an identifier for the resource type: ResourcePool.
Identifier of the folder inventory object where VMs are deployed.
This property was added in vSphere API 9.0.0.0.
if missing or null the VMs are deployed inside the top level folder created in each datacenter for solutions.
When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: Folder. When operations return a value of this schema as a response, the property will be an identifier for the resource type: Folder.
VMs resource configuration.
This property was added in vSphere API 9.0.0.0.
If missing or null the default resource configuration specified in the OVF descriptor is used.
If the cluster associated with cluster is not managed by vLCM.
"Vapi Std Errors Unsupported Object"If the caller is not authenticated.
"Vapi Std Errors Unauthenticated Object"Indicates the authentication challenges applicable to the target API provider. It can be used by a client to discover the correct authentication scheme to use. The exact syntax of the value is defined by the specific provider, the protocol and authentication schemes used.
For example, a provider using REST may adhere to the WWW-Authenticate HTTP header specification, RFC7235, section 4.1. In this case an example challenge value may be: SIGN realm="27da1358-2ba4-11e9-b210-d663bd873d93",sts="http://vcenter/sso?vsphere.local", Basic realm="vCenter"
This property was added in vSphere API 7.0.0.0.
This property is optional because it was added in a newer version than its parent node.
If the user doesn't have the required privileges.
"Vapi Std Errors Unauthorized Object"If there is no cluster associated with cluster in the system or no solution associated with solution in the cluster.
"Vapi Std Errors NotFound Object"If there is an unknown internal error. The accompanying error message will give more details about the failure.
"Vapi Std Errors Error Object"Stack of one or more localizable messages for human error consumers.
The message at the top of the stack (first in the list) describes the error from the perspective of the operation the client invoked.
Each subsequent message in the stack describes the "cause" of the prior message.
Data to facilitate clients responding to the operation reporting a standard error to indicating that it was unable to complete successfully.
Operations may provide data that clients can use when responding to errors. Since the data that clients need may be specific to the context of the operation reporting the error, different operations that report the same error may provide different data in the error. The documentation for each each operation will describe what, if any, data it provides for each error it reports.
The Vapi Std Errors ArgumentLocations, Vapi Std Errors FileLocations, and Vapi Std Errors TransientIndication schemas are intended as possible values for this property. Vapi Std DynamicID may also be useful as a value for this property (although that is not its primary purpose). Some resources may provide their own specific schemas for use as the value of this property when reporting errors from their operations.
Some operations will not set this property when reporting errors.
Discriminator field to help API consumers identify the structure type.
For more information see: Vapi Std Errors Error Type.
This property was added in vSphere API 6.7.2.
Can be missing or null for compatibility with preceding implementations.
If the service is not available.
"Vapi Std Errors ServiceUnavailable Object" curl -H 'Authorization: <value>' https://{api_host}/api/esx/settings/clusters/{cluster}/vms/solutions/{solution}