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.

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.
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.

Task method overload. Result of the invocation is a task identifier which is going to 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.

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.

Task method overload. Result of the invocation is a task identifier which is going to 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.

invocationContext - Information about a method 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.