com.vmware.vcenter.environment_browser

Interface ConfigTargets

All Superinterfaces:

ConfigTargetsTypes, com.vmware.vapi.bindings.Service

All Known Implementing Classes:

ConfigTargetsStub

public interface ConfigTargets
extends com.vmware.vapi.bindings.Service, ConfigTargetsTypes

The ConfigTargets interface allows one to enumerate the hardware capabilities / device backings for particular set of clusters. This interface was added in vSphere API 8.0.2.00300.

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.vcenter.environment_browser.ConfigTargetsTypes

ConfigTargetsTypes.ConfigTargetSpec, ConfigTargetsTypes.GetParams, ConfigTargetsTypes.Info

Field Summary

Fields inherited from interface com.vmware.vcenter.environment_browser.ConfigTargetsTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
ConfigTargetsTypes.Info	get(ConfigTargetsTypes.GetParams params) Queries for information about a specific target, a "physical" device that can be used to back virtual devices.
void	get(ConfigTargetsTypes.GetParams params, com.vmware.vapi.bindings.client.AsyncCallback<ConfigTargetsTypes.Info> asyncCallback) Queries for information about a specific target, a "physical" device that can be used to back virtual devices.
void	get(ConfigTargetsTypes.GetParams params, com.vmware.vapi.bindings.client.AsyncCallback<ConfigTargetsTypes.Info> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Queries for information about a specific target, a "physical" device that can be used to back virtual devices.
ConfigTargetsTypes.Info	get(ConfigTargetsTypes.GetParams params, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Queries for information about a specific target, a "physical" device that can be used to back virtual devices.

Method Detail

get

ConfigTargetsTypes.Info get(ConfigTargetsTypes.GetParams params)

Queries for information about a specific target, a "physical" device that can be used to back virtual devices.

The returned vim.vm.ConfigTarget specifies the set of values that can be used for device backings to connect the virtual machine to physical, or logical, host devices.

This method requires additional api_release request parameter which must be used to guarantee compatibility with future releases of the API. Consult the vSphere Automation SDKs Programming Guide for more information.

. This method was added in vSphere API 8.0.2.00300.

Synchronous method overload. Result of the invocation will be reported as a method return value.

Parameters:

params - Search criteria and a filter to control the results.

Returns:

The VI/JSON representation of ConfigTarget (vim.vm.ConfigTarget) with the devices from the specified clusters.

Throws:

Error - if the system reports an error while responding to the request.

InvalidArgument - if invalid search criteria or filter is provided

NotFound - if one or more of the specified clusters cannot be located.

Unauthenticated - if the user cannot be authenticated.

Unauthorized - if the user doesn't have the required privileges for all the specified clusters.

Unauthorized - if you do not have all of the privileges described as follows:

• The resource ClusterComputeResource referenced by the property ConfigTargetsTypes.GetParams.getClusters() requires System.View.

get

ConfigTargetsTypes.Info get(ConfigTargetsTypes.GetParams params,
                            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Queries for information about a specific target, a "physical" device that can be used to back virtual devices.

The returned vim.vm.ConfigTarget specifies the set of values that can be used for device backings to connect the virtual machine to physical, or logical, host devices.

This method requires additional api_release request parameter which must be used to guarantee compatibility with future releases of the API. Consult the vSphere Automation SDKs Programming Guide for more information.

. This method was added in vSphere API 8.0.2.00300.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

params - Search criteria and a filter to control the results.

invocationConfig - Configuration for the method invocation.

Returns:

The VI/JSON representation of ConfigTarget (vim.vm.ConfigTarget) with the devices from the specified clusters.

Throws:

Error - if the system reports an error while responding to the request.

InvalidArgument - if invalid search criteria or filter is provided

NotFound - if one or more of the specified clusters cannot be located.

Unauthenticated - if the user cannot be authenticated.

Unauthorized - if the user doesn't have the required privileges for all the specified clusters.

Unauthorized - if you do not have all of the privileges described as follows:

• The resource ClusterComputeResource referenced by the property ConfigTargetsTypes.GetParams.getClusters() requires System.View.

get

void get(ConfigTargetsTypes.GetParams params,
         com.vmware.vapi.bindings.client.AsyncCallback<ConfigTargetsTypes.Info> asyncCallback)

Queries for information about a specific target, a "physical" device that can be used to back virtual devices.

The returned vim.vm.ConfigTarget specifies the set of values that can be used for device backings to connect the virtual machine to physical, or logical, host devices.

This method requires additional api_release request parameter which must be used to guarantee compatibility with future releases of the API. Consult the vSphere Automation SDKs Programming Guide for more information.

. This method was added in vSphere API 8.0.2.00300.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Invocation Result:
The VI/JSON representation of ConfigTarget (vim.vm.ConfigTarget) with the devices from the specified clusters.

Operation Errors:
Error - if the system reports an error while responding to the request.
InvalidArgument - if invalid search criteria or filter is provided
NotFound - if one or more of the specified clusters cannot be located.
Unauthenticated - if the user cannot be authenticated.
Unauthorized - if the user doesn't have the required privileges for all the specified clusters.
Unauthorized - if you do not have all of the privileges described as follows:

• The resource ClusterComputeResource referenced by the property ConfigTargetsTypes.GetParams.getClusters() requires System.View.

Parameters:

params - Search criteria and a filter to control the results.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

get

void get(ConfigTargetsTypes.GetParams params,
         com.vmware.vapi.bindings.client.AsyncCallback<ConfigTargetsTypes.Info> asyncCallback,
         com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Queries for information about a specific target, a "physical" device that can be used to back virtual devices.

The returned vim.vm.ConfigTarget specifies the set of values that can be used for device backings to connect the virtual machine to physical, or logical, host devices.

This method requires additional api_release request parameter which must be used to guarantee compatibility with future releases of the API. Consult the vSphere Automation SDKs Programming Guide for more information.

. This method was added in vSphere API 8.0.2.00300.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Invocation Result:
The VI/JSON representation of ConfigTarget (vim.vm.ConfigTarget) with the devices from the specified clusters.

Operation Errors:
Error - if the system reports an error while responding to the request.
InvalidArgument - if invalid search criteria or filter is provided
NotFound - if one or more of the specified clusters cannot be located.
Unauthenticated - if the user cannot be authenticated.
Unauthorized - if the user doesn't have the required privileges for all the specified clusters.
Unauthorized - if you do not have all of the privileges described as follows:

• The resource ClusterComputeResource referenced by the property ConfigTargetsTypes.GetParams.getClusters() requires System.View.

Parameters:

params - Search criteria and a filter to control the results.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.