com.vmware.vcenter.topology

Interface Pscs

All Superinterfaces:

PscsTypes, Service

All Known Implementing Classes:

PscsStub

public interface Pscs
extends Service, PscsTypes

The Pscs interface provides methods to decommission the external Platform Services Controller node. This interface was added in vSphere API 6.7.2.

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.vcenter.topology.PscsTypes

PscsTypes.DecommissionSpec

Field Summary

Fields inherited from interface com.vmware.vcenter.topology.PscsTypes

_VAPI_SERVICE_ID

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	decommission_Task(java.lang.String hostname, PscsTypes.DecommissionSpec spec, java.lang.Boolean onlyPrecheck) Decommission the external Platform Services Controller node.
void	decommission_Task(java.lang.String hostname, PscsTypes.DecommissionSpec spec, java.lang.Boolean onlyPrecheck, AsyncCallback<java.lang.String> asyncCallback) Decommission the external Platform Services Controller node.
void	decommission_Task(java.lang.String hostname, PscsTypes.DecommissionSpec spec, java.lang.Boolean onlyPrecheck, AsyncCallback<java.lang.String> asyncCallback, InvocationConfig invocationConfig) Decommission the external Platform Services Controller node.
java.lang.String	decommission_Task(java.lang.String hostname, PscsTypes.DecommissionSpec spec, java.lang.Boolean onlyPrecheck, InvocationConfig invocationConfig) Decommission the external Platform Services Controller node.

Method Detail

decommission_Task

java.lang.String decommission_Task(java.lang.String hostname,
                                 PscsTypes.DecommissionSpec spec,
                                 java.lang.Boolean onlyPrecheck)

Decommission the external Platform Services Controller node. This method was added in vSphere API 6.7.2.

Synchronous method overload. Result of the invocation is a task identifier which will be returned by this method.

Parameters:

hostname - FQDN or IP address of external Platform Services Controller node to be decommissioned. The parameter must be an identifier for the resource type: com.vmware.vcenter.VCenter.name.

spec - Information needed to decommission the external Platform Services Controller node.

onlyPrecheck - Flag indicating whether only a pre-check should be performed. If null the full decommission will be performed.

Returns:

identifier for the task created by this API invocation

Throws:

Unsupported - if the appliance is in not a management node.

InvalidArgument - if passed arguments are invalid.

UnverifiedPeer - If the SSL certificate of the foreign external Platform Services Controller node cannot be validated.
The value of the data property of Error will be a class that contains all the properties defined in CertificateInfo.

Unauthenticated - if the caller is not authenticated.

NotAllowedInCurrentState - if the provided Platform Services Controller node doesn't qualify for decommission due to some reasons like it has some other nodes connected to it.

decommission_Task

java.lang.String decommission_Task(java.lang.String hostname,
                                 PscsTypes.DecommissionSpec spec,
                                 java.lang.Boolean onlyPrecheck,
                                 InvocationConfig invocationConfig)

Decommission the external Platform Services Controller node. This method was added in vSphere API 6.7.2.

Synchronous method overload. Result of the invocation is a task identifier which will be returned by this method. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

hostname - FQDN or IP address of external Platform Services Controller node to be decommissioned. The parameter must be an identifier for the resource type: com.vmware.vcenter.VCenter.name.

spec - Information needed to decommission the external Platform Services Controller node.

onlyPrecheck - Flag indicating whether only a pre-check should be performed. If null the full decommission will be performed.

invocationConfig - Configuration for the method invocation.

Returns:

identifier for the task created by this API invocation

Throws:

Unsupported - if the appliance is in not a management node.

InvalidArgument - if passed arguments are invalid.

UnverifiedPeer - If the SSL certificate of the foreign external Platform Services Controller node cannot be validated.
The value of the data property of Error will be a class that contains all the properties defined in CertificateInfo.

Unauthenticated - if the caller is not authenticated.

NotAllowedInCurrentState - if the provided Platform Services Controller node doesn't qualify for decommission due to some reasons like it has some other nodes connected to it.

decommission_Task

void decommission_Task(java.lang.String hostname,
                     PscsTypes.DecommissionSpec spec,
                     java.lang.Boolean onlyPrecheck,
                     AsyncCallback<java.lang.String> asyncCallback)

Decommission the external Platform Services Controller node. This method was added in vSphere API 6.7.2.

Asynchronous method overload. Result of the invocation which is a task identifier will be reported via the specified asyncCallback.

Invocation Result:
identifier for the task created by this API invocation

Operation Errors:
Unsupported - if the appliance is in not a management node.
InvalidArgument - if passed arguments are invalid.
UnverifiedPeer - If the SSL certificate of the foreign external Platform Services Controller node cannot be validated.
The value of the data property of Error will be a class that contains all the properties defined in CertificateInfo.
Unauthenticated - if the caller is not authenticated.
NotAllowedInCurrentState - if the provided Platform Services Controller node doesn't qualify for decommission due to some reasons like it has some other nodes connected to it.

Parameters:

hostname - FQDN or IP address of external Platform Services Controller node to be decommissioned. The parameter must be an identifier for the resource type: com.vmware.vcenter.VCenter.name.

spec - Information needed to decommission the external Platform Services Controller node.

onlyPrecheck - Flag indicating whether only a pre-check should be performed. If null the full decommission will be performed.

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

decommission_Task

void decommission_Task(java.lang.String hostname,
                     PscsTypes.DecommissionSpec spec,
                     java.lang.Boolean onlyPrecheck,
                     AsyncCallback<java.lang.String> asyncCallback,
                     InvocationConfig invocationConfig)

Decommission the external Platform Services Controller node. This method was added in vSphere API 6.7.2.

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

Invocation Result:
identifier for the task created by this API invocation

Operation Errors:
Unsupported - if the appliance is in not a management node.
InvalidArgument - if passed arguments are invalid.
UnverifiedPeer - If the SSL certificate of the foreign external Platform Services Controller node cannot be validated.
The value of the data property of Error will be a class that contains all the properties defined in CertificateInfo.
Unauthenticated - if the caller is not authenticated.
NotAllowedInCurrentState - if the provided Platform Services Controller node doesn't qualify for decommission due to some reasons like it has some other nodes connected to it.

Parameters:

hostname - FQDN or IP address of external Platform Services Controller node to be decommissioned. The parameter must be an identifier for the resource type: com.vmware.vcenter.VCenter.name.

spec - Information needed to decommission the external Platform Services Controller node.

onlyPrecheck - Flag indicating whether only a pre-check should be performed. If null the full decommission will be performed.

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

invocationConfig - Configuration for the method invocation.