com.vmware.vcenter.lcm.discovery

Interface AssociatedProducts

All Superinterfaces:

AssociatedProductsTypes, com.vmware.vapi.bindings.Service

All Known Implementing Classes:

AssociatedProductsStub

public interface AssociatedProducts
extends com.vmware.vapi.bindings.Service, AssociatedProductsTypes

The AssociatedProducts interface provides options to list, add, modify, and delete VMware products associated with vCenter Server. Some products can be auto-detected by the system while others can be added manually.

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.vcenter.lcm.discovery.AssociatedProductsTypes

AssociatedProductsTypes.CreateSpec, AssociatedProductsTypes.UpdateSpec

Field Summary

Fields inherited from interface com.vmware.vcenter.lcm.discovery.AssociatedProductsTypes

_VAPI_SERVICE_ID, RESOURCE_TYPE

Method Summary

Modifier and Type	Method and Description
java.lang.String	create(AssociatedProductsTypes.CreateSpec spec) Associates a VMware product with vCenter Server manually.
void	create(AssociatedProductsTypes.CreateSpec spec, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.String> asyncCallback) Associates a VMware product with vCenter Server manually.
void	create(AssociatedProductsTypes.CreateSpec spec, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.String> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Associates a VMware product with vCenter Server manually.
java.lang.String	create(AssociatedProductsTypes.CreateSpec spec, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Associates a VMware product with vCenter Server manually.
void	delete(java.lang.String product) Deletes or dissociates a VMware product associated with vCenter Server which was added manually.
void	delete(java.lang.String product, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback) Deletes or dissociates a VMware product associated with vCenter Server which was added manually.
void	delete(java.lang.String product, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deletes or dissociates a VMware product associated with vCenter Server which was added manually.
void	delete(java.lang.String product, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deletes or dissociates a VMware product associated with vCenter Server which was added manually.
Product	get(java.lang.String product) Returns the detailed information of a product associated with vCenter Server.
void	get(java.lang.String product, com.vmware.vapi.bindings.client.AsyncCallback<Product> asyncCallback) Returns the detailed information of a product associated with vCenter Server.
void	get(java.lang.String product, com.vmware.vapi.bindings.client.AsyncCallback<Product> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns the detailed information of a product associated with vCenter Server.
Product	get(java.lang.String product, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns the detailed information of a product associated with vCenter Server.
java.util.List<Product>	list() Retrieves a list of all associated VMware product deployments with vCenter Server in the environment.
void	list(com.vmware.vapi.bindings.client.AsyncCallback<java.util.List<Product>> asyncCallback) Retrieves a list of all associated VMware product deployments with vCenter Server in the environment.
void	list(com.vmware.vapi.bindings.client.AsyncCallback<java.util.List<Product>> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Retrieves a list of all associated VMware product deployments with vCenter Server in the environment.
java.util.List<Product>	list(com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Retrieves a list of all associated VMware product deployments with vCenter Server in the environment.
void	update(java.lang.String product, AssociatedProductsTypes.UpdateSpec spec) Modifies a VMware product associated with vCenter Server which was added manually.
void	update(java.lang.String product, AssociatedProductsTypes.UpdateSpec spec, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback) Modifies a VMware product associated with vCenter Server which was added manually.
void	update(java.lang.String product, AssociatedProductsTypes.UpdateSpec spec, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Modifies a VMware product associated with vCenter Server which was added manually.
void	update(java.lang.String product, AssociatedProductsTypes.UpdateSpec spec, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Modifies a VMware product associated with vCenter Server which was added manually.

Method Detail

list

java.util.List<Product> list()

Retrieves a list of all associated VMware product deployments with vCenter Server in the environment. The list contains both product deployments discovered automatically and deployments registered manually through the API.

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

Returns:

List of all the registered products with vCenter.

Throws:

Unauthenticated - if the user can not be authenticated.

Error - If there is some unknown internal error. The accompanying error message will give more details about the failure.

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

• Method execution requires VcLifecycle.View.

list

java.util.List<Product> list(com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Retrieves a list of all associated VMware product deployments with vCenter Server in the environment. The list contains both product deployments discovered automatically and deployments registered manually through the API.

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:

invocationConfig - Configuration for the method invocation.

Returns:

List of all the registered products with vCenter.

Throws:

Unauthenticated - if the user can not be authenticated.

Error - If there is some unknown internal error. The accompanying error message will give more details about the failure.

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

• Method execution requires VcLifecycle.View.

list

void list(com.vmware.vapi.bindings.client.AsyncCallback<java.util.List<Product>> asyncCallback)

Retrieves a list of all associated VMware product deployments with vCenter Server in the environment. The list contains both product deployments discovered automatically and deployments registered manually through the API.

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

Invocation Result:
List of all the registered products with vCenter.

Operation Errors:
Unauthenticated - if the user can not be authenticated.
Error - If there is some unknown internal error. The accompanying error message will give more details about the failure.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcLifecycle.View.

Parameters:

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

list

void list(com.vmware.vapi.bindings.client.AsyncCallback<java.util.List<Product>> asyncCallback,
          com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Retrieves a list of all associated VMware product deployments with vCenter Server in the environment. The list contains both product deployments discovered automatically and deployments registered manually through the API.

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:
List of all the registered products with vCenter.

Operation Errors:
Unauthenticated - if the user can not be authenticated.
Error - If there is some unknown internal error. The accompanying error message will give more details about the failure.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcLifecycle.View.

Parameters:

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

invocationConfig - Configuration for the method invocation.

create

java.lang.String create(AssociatedProductsTypes.CreateSpec spec)

Associates a VMware product with vCenter Server manually. The product must be taken from the product catalog API.

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

Parameters:

spec - Info creation specification.

Returns:

Identifier of the newly-added product. The return value will be an identifier for the resource type: com.vmware.vcenter.lcm.product.

Throws:

Unauthenticated - if the user can not be authenticated.

AlreadyExists - if this version is already added

InvalidArgument - if the spec argument is not allowed

Error - If there is some unknown internal error. The accompanying error message will give more details about the failure.

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

• Method execution requires VcLifecycle.View.

create

java.lang.String create(AssociatedProductsTypes.CreateSpec spec,
                        com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Associates a VMware product with vCenter Server manually. The product must be taken from the product catalog API.

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:

spec - Info creation specification.

invocationConfig - Configuration for the method invocation.

Returns:

Identifier of the newly-added product. The return value will be an identifier for the resource type: com.vmware.vcenter.lcm.product.

Throws:

Unauthenticated - if the user can not be authenticated.

AlreadyExists - if this version is already added

InvalidArgument - if the spec argument is not allowed

Error - If there is some unknown internal error. The accompanying error message will give more details about the failure.

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

• Method execution requires VcLifecycle.View.

create

void create(AssociatedProductsTypes.CreateSpec spec,
            com.vmware.vapi.bindings.client.AsyncCallback<java.lang.String> asyncCallback)

Associates a VMware product with vCenter Server manually. The product must be taken from the product catalog API.

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

Invocation Result:
Identifier of the newly-added product. The return value will be an identifier for the resource type: com.vmware.vcenter.lcm.product.

Operation Errors:
Unauthenticated - if the user can not be authenticated.
AlreadyExists - if this version is already added
InvalidArgument - if the spec argument is not allowed
Error - If there is some unknown internal error. The accompanying error message will give more details about the failure.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcLifecycle.View.

Parameters:

spec - Info creation specification.

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

create

void create(AssociatedProductsTypes.CreateSpec spec,
            com.vmware.vapi.bindings.client.AsyncCallback<java.lang.String> asyncCallback,
            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Associates a VMware product with vCenter Server manually. The product must be taken from the product catalog API.

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:
Identifier of the newly-added product. The return value will be an identifier for the resource type: com.vmware.vcenter.lcm.product.

Operation Errors:
Unauthenticated - if the user can not be authenticated.
AlreadyExists - if this version is already added
InvalidArgument - if the spec argument is not allowed
Error - If there is some unknown internal error. The accompanying error message will give more details about the failure.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcLifecycle.View.

Parameters:

spec - Info creation specification.

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

invocationConfig - Configuration for the method invocation.

get

Product get(java.lang.String product)

Returns the detailed information of a product associated with vCenter Server.

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

Parameters:

product - An identifier of the product to be modified. The parameter must be an identifier for the resource type: com.vmware.vcenter.lcm.product.

Returns:

Product details.

Throws:

Unauthenticated - if the user can not be authenticated.

NotFound - If there is no record associated with product in the system.

Error - If there is some unknown internal error. The accompanying error message will give more details about the failure.

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

• Method execution requires VcLifecycle.View.

get

Product get(java.lang.String product,
            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Returns the detailed information of a product associated with vCenter Server.

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:

product - An identifier of the product to be modified. The parameter must be an identifier for the resource type: com.vmware.vcenter.lcm.product.

invocationConfig - Configuration for the method invocation.

Returns:

Product details.

Throws:

Unauthenticated - if the user can not be authenticated.

NotFound - If there is no record associated with product in the system.

Error - If there is some unknown internal error. The accompanying error message will give more details about the failure.

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

• Method execution requires VcLifecycle.View.

get

void get(java.lang.String product,
         com.vmware.vapi.bindings.client.AsyncCallback<Product> asyncCallback)

Returns the detailed information of a product associated with vCenter Server.

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

Invocation Result:
Product details.

Operation Errors:
Unauthenticated - if the user can not be authenticated.
NotFound - If there is no record associated with product in the system.
Error - If there is some unknown internal error. The accompanying error message will give more details about the failure.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcLifecycle.View.

Parameters:

product - An identifier of the product to be modified. The parameter must be an identifier for the resource type: com.vmware.vcenter.lcm.product.

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

get

void get(java.lang.String product,
         com.vmware.vapi.bindings.client.AsyncCallback<Product> asyncCallback,
         com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Returns the detailed information of a product associated with vCenter Server.

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:
Product details.

Operation Errors:
Unauthenticated - if the user can not be authenticated.
NotFound - If there is no record associated with product in the system.
Error - If there is some unknown internal error. The accompanying error message will give more details about the failure.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcLifecycle.View.

Parameters:

product - An identifier of the product to be modified. The parameter must be an identifier for the resource type: com.vmware.vcenter.lcm.product.

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

invocationConfig - Configuration for the method invocation.

update

void update(java.lang.String product,
            AssociatedProductsTypes.UpdateSpec spec)

Modifies a VMware product associated with vCenter Server which was added manually. Automatically discovered VMware products cannot be modified.

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

Parameters:

product - An id of the product to be modified. The parameter must be an identifier for the resource type: com.vmware.vcenter.lcm.product.

spec -

Throws:

Unauthenticated - if the user can not be authenticated.

InvalidArgument - if the spec argument is not allowed

NotFound - If there is no record associated with product in the system.

Error - If there is some unknown internal error. The accompanying error message will give more details about the failure.

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

• Method execution requires VcLifecycle.View.

update

void update(java.lang.String product,
            AssociatedProductsTypes.UpdateSpec spec,
            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Modifies a VMware product associated with vCenter Server which was added manually. Automatically discovered VMware products cannot be modified.

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:

product - An id of the product to be modified. The parameter must be an identifier for the resource type: com.vmware.vcenter.lcm.product.

spec -

invocationConfig - Configuration for the method invocation.

Throws:

Unauthenticated - if the user can not be authenticated.

InvalidArgument - if the spec argument is not allowed

NotFound - If there is no record associated with product in the system.

Error - If there is some unknown internal error. The accompanying error message will give more details about the failure.

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

• Method execution requires VcLifecycle.View.

update

void update(java.lang.String product,
            AssociatedProductsTypes.UpdateSpec spec,
            com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)

Modifies a VMware product associated with vCenter Server which was added manually. Automatically discovered VMware products cannot be modified.

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

Operation Errors:
Unauthenticated - if the user can not be authenticated.
InvalidArgument - if the spec argument is not allowed
NotFound - If there is no record associated with product in the system.
Error - If there is some unknown internal error. The accompanying error message will give more details about the failure.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcLifecycle.View.

Parameters:

product - An id of the product to be modified. The parameter must be an identifier for the resource type: com.vmware.vcenter.lcm.product.

spec -

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

update

void update(java.lang.String product,
            AssociatedProductsTypes.UpdateSpec spec,
            com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback,
            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Modifies a VMware product associated with vCenter Server which was added manually. Automatically discovered VMware products cannot be modified.

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

Operation Errors:
Unauthenticated - if the user can not be authenticated.
InvalidArgument - if the spec argument is not allowed
NotFound - If there is no record associated with product in the system.
Error - If there is some unknown internal error. The accompanying error message will give more details about the failure.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcLifecycle.View.

Parameters:

product - An id of the product to be modified. The parameter must be an identifier for the resource type: com.vmware.vcenter.lcm.product.

spec -

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

invocationConfig - Configuration for the method invocation.

delete

void delete(java.lang.String product)

Deletes or dissociates a VMware product associated with vCenter Server which was added manually. Automatically discovered VMware products cannot be deleted or dissociated.

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

Parameters:

product - An id of the product to be removed. The parameter must be an identifier for the resource type: com.vmware.vcenter.lcm.product.

Throws:

Unauthenticated - if the user can not be authenticated.

NotFound - If there is no record associated with product in the system database.

Error - If there is some unknown internal error. The accompanying error message will give more details about the failure.

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

• Method execution requires VcLifecycle.View.

delete

void delete(java.lang.String product,
            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deletes or dissociates a VMware product associated with vCenter Server which was added manually. Automatically discovered VMware products cannot be deleted or dissociated.

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:

product - An id of the product to be removed. The parameter must be an identifier for the resource type: com.vmware.vcenter.lcm.product.

invocationConfig - Configuration for the method invocation.

Throws:

Unauthenticated - if the user can not be authenticated.

NotFound - If there is no record associated with product in the system database.

Error - If there is some unknown internal error. The accompanying error message will give more details about the failure.

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

• Method execution requires VcLifecycle.View.

delete

void delete(java.lang.String product,
            com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)

Deletes or dissociates a VMware product associated with vCenter Server which was added manually. Automatically discovered VMware products cannot be deleted or dissociated.

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

Operation Errors:
Unauthenticated - if the user can not be authenticated.
NotFound - If there is no record associated with product in the system database.
Error - If there is some unknown internal error. The accompanying error message will give more details about the failure.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcLifecycle.View.

Parameters:

product - An id of the product to be removed. The parameter must be an identifier for the resource type: com.vmware.vcenter.lcm.product.

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

delete

void delete(java.lang.String product,
            com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback,
            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deletes or dissociates a VMware product associated with vCenter Server which was added manually. Automatically discovered VMware products cannot be deleted or dissociated.

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

Operation Errors:
Unauthenticated - if the user can not be authenticated.
NotFound - If there is no record associated with product in the system database.
Error - If there is some unknown internal error. The accompanying error message will give more details about the failure.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcLifecycle.View.

Parameters:

product - An id of the product to be removed. The parameter must be an identifier for the resource type: com.vmware.vcenter.lcm.product.

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

invocationConfig - Configuration for the method invocation.