com.vmware.appliance.tls.profiles

Interface Global

All Superinterfaces:

GlobalTypes, com.vmware.vapi.bindings.Service

All Known Implementing Classes:

GlobalStub

public interface Global
extends com.vmware.vapi.bindings.Service, GlobalTypes

Global interface provides methods APIs to configure standard TLS profile.

This is a profile based management for TLS usage on vCenter and the interface is for managing standard/built-in profiles globally in the appliance.

. This interface was added in vSphere API 8.0.3.0.

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.appliance.tls.profiles.GlobalTypes

GlobalTypes._VAPI_OPERATIONS, GlobalTypes.Info, GlobalTypes.SetSpec

Field Summary

Fields inherited from interface com.vmware.appliance.tls.profiles.GlobalTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
GlobalTypes.Info	get() Gets the name of the current TLS Profile configured globally.
void	get(com.vmware.vapi.bindings.client.AsyncCallback<GlobalTypes.Info> asyncCallback) Gets the name of the current TLS Profile configured globally.
void	get(com.vmware.vapi.bindings.client.AsyncCallback<GlobalTypes.Info> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Gets the name of the current TLS Profile configured globally.
GlobalTypes.Info	get(com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Gets the name of the current TLS Profile configured globally.
java.lang.String	set_Task(GlobalTypes.SetSpec spec) Sets any one of the standard profiles globally in the appliance.
void	set_Task(GlobalTypes.SetSpec spec, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.String> asyncCallback) Sets any one of the standard profiles globally in the appliance.
void	set_Task(GlobalTypes.SetSpec spec, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.String> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Sets any one of the standard profiles globally in the appliance.
java.lang.String	set_Task(GlobalTypes.SetSpec spec, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Sets any one of the standard profiles globally in the appliance.

Method Detail

get

GlobalTypes.Info get()

Gets the name of the current TLS Profile configured globally. This method was added in vSphere API 8.0.3.0.

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

Returns:

the name of the current global TLS Profile.

Throws:

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

Unauthenticated - if the session is not authenticated

Unauthorized - if the user is not authorized. User needs to have operator privileges.

get

GlobalTypes.Info get(com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Gets the name of the current TLS Profile configured globally. This method was added in vSphere API 8.0.3.0.

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:

the name of the current global TLS Profile.

Throws:

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

Unauthenticated - if the session is not authenticated

Unauthorized - if the user is not authorized. User needs to have operator privileges.

get

void get(com.vmware.vapi.bindings.client.AsyncCallback<GlobalTypes.Info> asyncCallback)

Gets the name of the current TLS Profile configured globally. This method was added in vSphere API 8.0.3.0.

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

Invocation Result:
the name of the current global TLS Profile.

Operation Errors:
Error - if there is some unknown internal error. The accompanying error message will give more details about the failure.
Unauthenticated - if the session is not authenticated
Unauthorized - if the user is not authorized. User needs to have operator privileges.

Parameters:

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

get

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

Gets the name of the current TLS Profile configured globally. This method was added in vSphere API 8.0.3.0.

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 name of the current global TLS Profile.

Operation Errors:
Error - if there is some unknown internal error. The accompanying error message will give more details about the failure.
Unauthenticated - if the session is not authenticated
Unauthorized - if the user is not authorized. User needs to have operator privileges.

Parameters:

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

invocationConfig - Configuration for the method invocation.

set_Task

java.lang.String set_Task(GlobalTypes.SetSpec spec)

Sets any one of the standard profiles globally in the appliance. The result of this operation can be queried by calling the cis/tasks/{task-id} with the task-id in the response of this call. In case of a VCHA enabled cluster, setting a profile expects the VCHA cluster to be healthy and in maintenance or disabled mode before proceeding with the operation. This method was added in vSphere API 8.0.3.0.

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

Parameters:

spec - Defines the name of the standard profile to be configured.

Returns:

identifier for the task created by this API invocation

Throws:

Error - if there is some unknown internal error. appropriate error in case of VCHA enabled cluster if VCHA is not healthy or if it is in enabled state. The accompanying error message will give more details about the failure.

Unauthenticated - if the session is not authenticated.

Unauthorized - if the user is not authorized. User needs to have superAdministrator privileges to perform this operation.

set_Task

java.lang.String set_Task(GlobalTypes.SetSpec spec,
                          com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Sets any one of the standard profiles globally in the appliance. The result of this operation can be queried by calling the cis/tasks/{task-id} with the task-id in the response of this call. In case of a VCHA enabled cluster, setting a profile expects the VCHA cluster to be healthy and in maintenance or disabled mode before proceeding with the operation. This method was added in vSphere API 8.0.3.0.

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:

spec - Defines the name of the standard profile to be configured.

invocationConfig - Configuration for the method invocation.

Returns:

identifier for the task created by this API invocation

Throws:

Error - if there is some unknown internal error. appropriate error in case of VCHA enabled cluster if VCHA is not healthy or if it is in enabled state. The accompanying error message will give more details about the failure.

Unauthenticated - if the session is not authenticated.

Unauthorized - if the user is not authorized. User needs to have superAdministrator privileges to perform this operation.

set_Task

void set_Task(GlobalTypes.SetSpec spec,
              com.vmware.vapi.bindings.client.AsyncCallback<java.lang.String> asyncCallback)

Sets any one of the standard profiles globally in the appliance. The result of this operation can be queried by calling the cis/tasks/{task-id} with the task-id in the response of this call. In case of a VCHA enabled cluster, setting a profile expects the VCHA cluster to be healthy and in maintenance or disabled mode before proceeding with the operation. This method was added in vSphere API 8.0.3.0.

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:
Error - if there is some unknown internal error. appropriate error in case of VCHA enabled cluster if VCHA is not healthy or if it is in enabled state. The accompanying error message will give more details about the failure.
Unauthenticated - if the session is not authenticated.
Unauthorized - if the user is not authorized. User needs to have superAdministrator privileges to perform this operation.

Parameters:

spec - Defines the name of the standard profile to be configured.

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

set_Task

void set_Task(GlobalTypes.SetSpec spec,
              com.vmware.vapi.bindings.client.AsyncCallback<java.lang.String> asyncCallback,
              com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Sets any one of the standard profiles globally in the appliance. The result of this operation can be queried by calling the cis/tasks/{task-id} with the task-id in the response of this call. In case of a VCHA enabled cluster, setting a profile expects the VCHA cluster to be healthy and in maintenance or disabled mode before proceeding with the operation. This method was added in vSphere API 8.0.3.0.

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:
Error - if there is some unknown internal error. appropriate error in case of VCHA enabled cluster if VCHA is not healthy or if it is in enabled state. The accompanying error message will give more details about the failure.
Unauthenticated - if the session is not authenticated.
Unauthorized - if the user is not authorized. User needs to have superAdministrator privileges to perform this operation.

Parameters:

spec - Defines the name of the standard profile to be configured.

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

invocationConfig - Configuration for the method invocation.